FD.io VPP  v21.06-3-gbb25fbf28
Vector Packet Processing
gbp_endpoint_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_GBP_ENDPOINT_CMDS_H__
17 #define __VOM_GBP_ENDPOINT_CMDS_H__
18 
19 #include "vom/dump_cmd.hpp"
20 #include "vom/gbp_endpoint.hpp"
21 
22 #include <vapi/gbp.api.vapi.hpp>
23 
24 namespace VOM {
25 namespace gbp_endpoint_cmds {
26 
27 /**
28  * A command class that creates or updates the GBP endpoint
29  */
30 class create_cmd : public rpc_cmd<HW::item<handle_t>, vapi::Gbp_endpoint_add>
31 {
32 public:
33  /**
34  * Constructor
35  */
37  const handle_t& itf,
38  const std::vector<boost::asio::ip::address>& ip_addrs,
39  const mac_address_t& mac,
42 
43  /**
44  * Issue the command to VPP/HW
45  */
47 
48  /**
49  * convert to string format for debug purposes
50  */
51  std::string to_string() const;
52 
53  virtual vapi_error_e operator()(vapi::Gbp_endpoint_add& reply);
54 
55  /**
56  * Comparison operator - only used for UT
57  */
58  bool operator==(const create_cmd& i) const;
59 
60 private:
61  const handle_t m_itf;
62  const std::vector<boost::asio::ip::address> m_ip_addrs;
63  const mac_address_t m_mac;
64  const sclass_t m_sclass;
65  const gbp_endpoint::flags_t m_flags;
66 };
67 
68 /**
69  * A cmd class that deletes a GBP endpoint
70  */
71 class delete_cmd : public rpc_cmd<HW::item<handle_t>, vapi::Gbp_endpoint_del>
72 {
73 public:
74  /**
75  * Constructor
76  */
78 
79  /**
80  * Issue the command to VPP/HW
81  */
83 
84  /**
85  * convert to string format for debug purposes
86  */
87  std::string to_string() const;
88 
89  /**
90  * Comparison operator - only used for UT
91  */
92  bool operator==(const delete_cmd& i) const;
93 
94 private:
95  const handle_t m_hdl;
96 };
97 
98 /**
99  * A cmd class that Dumps all the GBP endpoints
100  */
101 class dump_cmd : public VOM::dump_cmd<vapi::Gbp_endpoint_dump>
102 {
103 public:
104  /**
105  * Constructor
106  */
107  dump_cmd();
108  dump_cmd(const dump_cmd& d);
109 
110  /**
111  * Issue the command to VPP/HW
112  */
114  /**
115  * convert to string format for debug purposes
116  */
117  std::string to_string() const;
118 
119  /**
120  * Comparison operator - only used for UT
121  */
122  bool operator==(const dump_cmd& i) const;
123 
124 private:
125  /**
126  * HW reutrn code
127  */
128  HW::item<bool> item;
129 };
130 }; // namespace gbp_enpoint_cms
131 }; // namespace VOM
132 
133 /*
134  * fd.io coding-style-patch-verification: OFF
135  *
136  * Local Variables:
137  * eval: (c-set-style "mozilla")
138  * End:
139  */
140 
141 #endif
vapi_error_e
vapi_error_e
Definition: vapi_common.h:25
VOM::HW::item< handle_t >
mac
vl_api_mac_address_t mac
Definition: l2.api:559
VOM::gbp_endpoint_cmds::delete_cmd::delete_cmd
delete_cmd(HW::item< handle_t > &item)
Constructor.
Definition: gbp_endpoint_cmds.cpp:122
VOM
The VPP Object Model (VOM) library.
Definition: acl_binding.cpp:19
VOM::gbp_endpoint_cmds::delete_cmd::issue
rc_t issue(connection &con)
Issue the command to VPP/HW.
Definition: gbp_endpoint_cmds.cpp:134
VOM::gbp_endpoint_cmds::create_cmd
A command class that creates or updates the GBP endpoint.
Definition: gbp_endpoint_cmds.hpp:30
VOM::gbp_endpoint_cmds::dump_cmd::issue
rc_t issue(connection &con)
Issue the command to VPP/HW.
Definition: gbp_endpoint_cmds.cpp:166
VOM::gbp_endpoint_cmds::dump_cmd::dump_cmd
dump_cmd()
Constructor.
Definition: gbp_endpoint_cmds.cpp:155
VOM::rpc_cmd
A base class for all RPC commands to VPP.
Definition: rpc_cmd.hpp:40
con
Connection con
Definition: vapi_cpp_test.cpp:56
VOM::sclass_t
uint16_t sclass_t
Definition: gbp_types.hpp:27
VOM::gbp_endpoint_cmds::delete_cmd
A cmd class that deletes a GBP endpoint.
Definition: gbp_endpoint_cmds.hpp:71
VOM::gbp_endpoint_cmds::dump_cmd::operator==
bool operator==(const dump_cmd &i) const
Comparison operator - only used for UT.
Definition: gbp_endpoint_cmds.cpp:160
VOM::gbp_endpoint_cmds::create_cmd::create_cmd
create_cmd(HW::item< handle_t > &item, const handle_t &itf, const std::vector< boost::asio::ip::address > &ip_addrs, const mac_address_t &mac, sclass_t sclass, const gbp_endpoint::flags_t &flags)
Constructor.
Definition: gbp_endpoint_cmds.cpp:41
VOM::gbp_endpoint_cmds::delete_cmd::operator==
bool operator==(const delete_cmd &i) const
Comparison operator - only used for UT.
Definition: gbp_endpoint_cmds.cpp:128
VOM::gbp_endpoint_cmds::create_cmd::issue
rc_t issue(connection &con)
Issue the command to VPP/HW.
Definition: gbp_endpoint_cmds.cpp:65
VOM::connection
A representation of the connection to VPP.
Definition: connection.hpp:33
VOM::gbp_endpoint::flags_t
Endpoint flags.
Definition: gbp_endpoint.hpp:36
i
sll srl srl sll sra u16x4 i
Definition: vector_sse42.h:261
VOM::handle_t
A type declaration of an interface handle in VPP.
Definition: types.hpp:233
VOM::gbp_endpoint_cmds::dump_cmd
A cmd class that Dumps all the GBP endpoints.
Definition: gbp_endpoint_cmds.hpp:101
sclass
u16 sclass
Definition: gbp.api:131
dump_cmd.hpp
VOM::rpc_cmd< HW::item< handle_t >, vapi::Gbp_endpoint_add >::item
HW::item< handle_t > & item()
return the HW item the command updates
Definition: rpc_cmd.hpp:66
VOM::gbp_endpoint_cmds::create_cmd::operator==
bool operator==(const create_cmd &i) const
Comparison operator - only used for UT.
Definition: gbp_endpoint_cmds.cpp:57
VOM::gbp_endpoint_cmds::create_cmd::operator()
virtual vapi_error_e operator()(vapi::Gbp_endpoint_add &reply)
call operator used as a callback by VAPI when the reply is available
Definition: gbp_endpoint_cmds.cpp:88
VOM::mac_address_t
Type def of a Ethernet address.
Definition: types.hpp:295
VOM::gbp_endpoint_cmds::create_cmd::to_string
std::string to_string() const
convert to string format for debug purposes
Definition: gbp_endpoint_cmds.cpp:108
VOM::gbp_endpoint_cmds::dump_cmd::to_string
std::string to_string() const
convert to string format for debug purposes
Definition: gbp_endpoint_cmds.cpp:178
VOM::rc_t
Error codes that VPP will return during a HW write.
Definition: types.hpp:89
VOM::dump_cmd
A base class for VPP dump commands.
Definition: dump_cmd.hpp:43
VOM::gbp_endpoint_cmds::delete_cmd::to_string
std::string to_string() const
convert to string format for debug purposes
Definition: gbp_endpoint_cmds.cpp:147
gbp_endpoint.hpp
string
const char *const string
Definition: cJSON.h:172
flags
vl_api_wireguard_peer_flags_t flags
Definition: wireguard.api:105