misc: deprecate VOM

[vpp.git] / extras / deprecated / vom / vom / ra_config.hpp

diff --git a/extras/deprecated/vom/vom/ra_config.hpp b/extras/deprecated/vom/vom/ra_config.hpp
new file mode 100644 (file)
index 0000000..f5b782a
--- /dev/null
+++ b/extras/deprecated/vom/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/ip6_nd.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: OFF
+ *
+ * Local Variables:
+ * eval: (c-set-style "mozilla")
+ * End:
+ */
+
+#endif