aboutsummaryrefslogtreecommitdiffstats
path: root/src/vpp-api/vom/ra_config.hpp
blob: 505ccb3c4993692801b1d0ed3eb0f4f9cae57803 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
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