FD.io VPP  v18.10-34-gcce845e
Vector Packet Processing
nat_static_cmds.hpp
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2017 Cisco and/or its affiliates.
3  * Licensed under the Apache License, Version 2.0 (the "License");
4  * you may not use this file except in compliance with the License.
5  * You may obtain a copy of the License at:
6  *
7  * http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14  */
15 
16 #ifndef __VOM_NAT_STATIC_CMDS_H__
17 #define __VOM_NAT_STATIC_CMDS_H__
18 
19 #include "nat_static.hpp"
20 #include "vom/dump_cmd.hpp"
21 
22 #include <vapi/nat.api.vapi.hpp>
23 
24 namespace VOM {
25 namespace nat_static_cmds {
26 
27 /**
28  * A command class that creates NAT 44 static mapping
29  */
31  : public rpc_cmd<HW::item<bool>, vapi::Nat44_add_del_static_mapping>
32 {
33 public:
34  /**
35  * Constructor
36  */
39  const boost::asio::ip::address_v4& inside,
40  const boost::asio::ip::address_v4& outside);
41 
42  /**
43  * Issue the command to VPP/HW
44  */
45  rc_t issue(connection& con);
46 
47  /**
48  * convert to string format for debug purposes
49  */
50  std::string to_string() const;
51 
52  /**
53  * Comparison operator - only used for UT
54  */
55  bool operator==(const create_44_cmd& i) const;
56 
57 private:
58  route::table_id_t m_id;
59  const boost::asio::ip::address_v4 m_inside;
60  const boost::asio::ip::address_v4 m_outside;
61 };
62 
63 /**
64  * A cmd class that deletes a NAT 44 static mapping
65  */
67  : public rpc_cmd<HW::item<bool>, vapi::Nat44_add_del_static_mapping>
68 {
69 public:
70  /**
71  * Constructor
72  */
75  const boost::asio::ip::address_v4& inside,
76  const boost::asio::ip::address_v4& outside);
77 
78  /**
79  * Issue the command to VPP/HW
80  */
81  rc_t issue(connection& con);
82 
83  /**
84  * convert to string format for debug purposes
85  */
86  std::string to_string() const;
87 
88  /**
89  * Comparison operator - only used for UT
90  */
91  bool operator==(const delete_44_cmd& i) const;
92 
93 private:
94  route::table_id_t m_id;
95  const boost::asio::ip::address_v4 m_inside;
96  const boost::asio::ip::address_v4 m_outside;
97 };
98 
99 /**
100  * A cmd class that Dumps all the nat_statics
101  */
102 class dump_44_cmd : public dump_cmd<vapi::Nat44_static_mapping_dump>
103 {
104 public:
105  /**
106  * Constructor
107  */
108  dump_44_cmd() = default;
109  ~dump_44_cmd() = default;
110 
111  /**
112  * Issue the command to VPP/HW
113  */
114  rc_t issue(connection& con);
115  /**
116  * convert to string format for debug purposes
117  */
118  std::string to_string() const;
119 
120  /**
121  * Comparison operator - only used for UT
122  */
123  bool operator==(const dump_44_cmd& i) const;
124 
125 private:
126  /**
127  * HW reutrn code
128  */
130 };
131 
132 /**
133  * A command class that creates NAT 66 static mapping
134  */
136  : public rpc_cmd<HW::item<bool>, vapi::Nat66_add_del_static_mapping>
137 {
138 public:
139  /**
140  * Constructor
141  */
144  const boost::asio::ip::address_v6& inside,
145  const boost::asio::ip::address_v6& outside);
146 
147  /**
148  * Issue the command to VPP/HW
149  */
150  rc_t issue(connection& con);
151 
152  /**
153  * convert to string format for debug purposes
154  */
155  std::string to_string() const;
156 
157  /**
158  * Comparison operator - only used for UT
159  */
160  bool operator==(const create_66_cmd& i) const;
161 
162 private:
163  route::table_id_t m_id;
164  const boost::asio::ip::address_v6 m_inside;
165  const boost::asio::ip::address_v6 m_outside;
166 };
167 
168 /**
169  * A cmd class that deletes a NAT 66 static mapping
170  */
172  : public rpc_cmd<HW::item<bool>, vapi::Nat66_add_del_static_mapping>
173 {
174 public:
175  /**
176  * Constructor
177  */
180  const boost::asio::ip::address_v6& inside,
181  const boost::asio::ip::address_v6& outside);
182 
183  /**
184  * Issue the command to VPP/HW
185  */
186  rc_t issue(connection& con);
187 
188  /**
189  * convert to string format for debug purposes
190  */
191  std::string to_string() const;
192 
193  /**
194  * Comparison operator - only used for UT
195  */
196  bool operator==(const delete_66_cmd& i) const;
197 
198 private:
199  route::table_id_t m_id;
200  const boost::asio::ip::address_v6 m_inside;
201  const boost::asio::ip::address_v6 m_outside;
202 };
203 
204 /**
205  * A cmd class that Dumps all the nat_statics
206  */
207 class dump_66_cmd : public dump_cmd<vapi::Nat66_static_mapping_dump>
208 {
209 public:
210  /**
211  * Constructor
212  */
213  dump_66_cmd() = default;
214  ~dump_66_cmd() = default;
215 
216  /**
217  * Issue the command to VPP/HW
218  */
219  rc_t issue(connection& con);
220  /**
221  * convert to string format for debug purposes
222  */
223  std::string to_string() const;
224 
225  /**
226  * Comparison operator - only used for UT
227  */
228  bool operator==(const dump_66_cmd& i) const;
229 
230 private:
231  /**
232  * HW reutrn code
233  */
235 };
236 
237 }; // namespace nat_static_cmds
238 }; // namespace vom
239 
240 /*
241  * fd.io coding-style-patch-verification: ON
242  *
243  * Local Variables:
244  * eval: (c-set-style "mozilla")
245  * End:
246  */
247 
248 #endif
A cmd class that deletes a NAT 44 static mapping.
uint32_t table_id_t
type def the table-id
Definition: prefix.hpp:82
A command class that creates NAT 44 static mapping.
rc_t issue(connection &con)
Issue the command to VPP/HW.
create_44_cmd(HW::item< bool > &item, route::table_id_t id, const boost::asio::ip::address_v4 &inside, const boost::asio::ip::address_v4 &outside)
Constructor.
int i
Error codes that VPP will return during a HW write.
Definition: types.hpp:84
std::string to_string() const
convert to string format for debug purposes
A representation of the connection to VPP.
Definition: connection.hpp:33
A base class for all RPC commands to VPP.
Definition: rpc_cmd.hpp:38
A cmd class that deletes a NAT 66 static mapping.
A cmd class that Dumps all the nat_statics.
bool operator==(const create_44_cmd &i) const
Comparison operator - only used for UT.
A cmd class that Dumps all the nat_statics.
The VPP Object Model (VOM) library.
Definition: acl_binding.cpp:19
A command class that creates NAT 66 static mapping.
A base class for VPP dump commands.
Definition: dump_cmd.hpp:43
HW::item< bool > & item()
return the HW item the command updates
Definition: rpc_cmd.hpp:64