aboutsummaryrefslogtreecommitdiffstats
path: root/src/vpp-api/vom/ra_config.hpp
diff options
context:
space:
mode:
authorNeale Ranns <neale.ranns@cisco.com>2017-10-16 04:20:13 -0700
committerDamjan Marion <dmarion.lists@gmail.com>2017-11-01 09:28:06 +0000
commit812ed39f9da336310e815c361ab5a9f118657d94 (patch)
tree9d8cddc917acbb65b3dc401d880d5eb2a7f392c6 /src/vpp-api/vom/ra_config.hpp
parent14edd97c20735ffd1c24000a7df78e154ac61478 (diff)
VPP Object Model (VOM)
The VOM is a C++ library for use by clients/agents of VPP for programming state. It uses the binary APIs to do so. Various other common client side functions are also provided. Please see om.hpp for a more detailed description. Change-Id: Ib756bfe99817093815a9e26ccf464aa5583fc523 Signed-off-by: Neale Ranns <neale.ranns@cisco.com> Co-authored-by: Mohsin Kazmi <sykazmi@cisco.com>
Diffstat (limited to 'src/vpp-api/vom/ra_config.hpp')
-rw-r--r--src/vpp-api/vom/ra_config.hpp145
1 files changed, 145 insertions, 0 deletions
diff --git a/src/vpp-api/vom/ra_config.hpp b/src/vpp-api/vom/ra_config.hpp
new file mode 100644
index 00000000000..505ccb3c499
--- /dev/null
+++ b/src/vpp-api/vom/ra_config.hpp
@@ -0,0 +1,145 @@
+/*
+ * Copyright (c) 2017 Cisco and/or its affiliates.
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at:
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#ifndef __VOM_RA_CONFIG_H__
+#define __VOM_RA_CONFIG_H__
+
+#include <vapi/ip.api.vapi.hpp>
+
+namespace VOM {
+/**
+ * A representation of Router Advertisement configuration
+ */
+class ra_config
+{
+public:
+ /**
+ * Construct a new object matching the desried state
+ */
+ ra_config(uint8_t suppress,
+ uint8_t send_unicast,
+ uint8_t default_router,
+ uint32_t max_interval);
+
+ /**
+ * Copy Constructor
+ */
+ ra_config(const ra_config& o) = default;
+
+ /**
+ * Destructor
+ */
+ ~ra_config() = default;
+
+ /**
+ * convert to string format for debug purposes
+ */
+ std::string to_string() const;
+
+ /**
+ * Comparison operator - only used for UT
+ */
+ bool operator==(const ra_config& ra_config) const;
+
+ /**
+ * convert the ra config to VPP API
+ */
+ void to_vpp(vapi_payload_sw_interface_ip6nd_ra_config& ra_config) const;
+
+private:
+ /**
+ * Disables sending ICMPv6 router-advertisement messages.
+ */
+ uint8_t m_suppress;
+
+ /**
+ * Advertises in ICMPv6 router-advertisement messages to use
+ * stateful address auto-configuration to obtain address information.
+ */
+ uint8_t m_managed;
+
+ /**
+ * Indicates in ICMPv6 router-advertisement messages that
+ * hosts use stateful auto configuration to obtain nonaddress
+ * related information.
+ */
+ uint8_t m_other;
+
+ /**
+ * Indicates not to include the optional source link-layer
+ * address in the ICMPv6 router-advertisement messages.
+ */
+ uint8_t m_ll_option;
+
+ /**
+ * Use the source address of the router-solicitation message if
+ * availiable.
+ */
+ uint8_t m_send_unicast;
+
+ /**
+ * Cease sending ICMPv6 router-advertisement messages.
+ */
+ uint8_t m_cease;
+
+ /**
+ * .... ?
+ */
+ uint8_t m_default_router;
+
+ /**
+ * Configures the interval between sending ICMPv6 router-advertisement
+ * messages. The range for max-interval is from 4 to 200 seconds.
+ */
+ uint32_t m_max_interval;
+
+ /**
+ * min-interval can not be more than 75% of max-interval.
+ * If not set, min-interval will be set to 75% of max-interval.
+ * The range for min-interval is from 3 to 150 seconds.
+ */
+ uint32_t m_min_interval;
+
+ /**
+ * Advertises the lifetime of a default router in ICMPv6
+ * router-advertisement messages. The range is from 0 to 9000 seconds.
+ * '<lifetime>' must be greater than '<max-interval>'.
+ * The default value is 600 seconds
+ */
+ uint32_t m_lifetime;
+
+ /**
+ * Number of initial ICMPv6 router-advertisement messages sent.
+ * Range for count is 1 - 3 and default is 3.
+ */
+ uint32_t m_initial_count;
+
+ /**
+ * The interval between each initial messages.
+ * Range for interval is 1 to 16 seconds, and default is 16 seconds.
+ */
+ uint32_t m_initial_interval;
+};
+};
+
+/*
+ * fd.io coding-style-patch-verification: ON
+ *
+ * Local Variables:
+ * eval: (c-set-style "mozilla")
+ * End:
+ */
+
+#endif