FD.io VPP  v21.10.1-2-g0a485f517
Vector Packet Processing
vxlan_tunnel_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_VXLAN_TUNNEL_CMDS_H__
17 #define __VOM_VXLAN_TUNNEL_CMDS_H__
18 
19 #include "vom/dump_cmd.hpp"
20 #include "vom/rpc_cmd.hpp"
21 #include "vom/vxlan_tunnel.hpp"
22 
23 #include <vapi/vapi.hpp>
24 #include <vapi/vxlan.api.vapi.hpp>
25 
26 namespace VOM {
27 namespace vxlan_tunnel_cmds {
28 
29 /**
30  * A Command class that creates an VXLAN tunnel
31  */
32 class create_cmd : public interface::create_cmd<vapi::Vxlan_add_del_tunnel>
33 {
34 public:
35  /**
36  * Create command constructor taking HW item to update and the
37  * endpoint values
38  */
40  const std::string& name,
41  const vxlan_tunnel::endpoint_t& ep,
42  handle_t mcast_itf);
43 
44  /**
45  * Issue the command to VPP/HW
46  */
48  /**
49  * convert to string format for debug purposes
50  */
51  std::string to_string() const;
52 
53  /**
54  * Comparison operator - only used for UT
55  */
56  bool operator==(const create_cmd& i) const;
57 
58 private:
59  /**
60  * Enpoint values of the tunnel to be created
61  */
62  const vxlan_tunnel::endpoint_t m_ep;
63  handle_t m_mcast_itf;
64 };
65 
66 /**
67  * A functor class that creates an VXLAN tunnel
68  */
69 class delete_cmd : public interface::delete_cmd<vapi::Vxlan_add_del_tunnel>
70 {
71 public:
72  /**
73  * delete command constructor taking HW item to update and the
74  * endpoint values
75  */
77 
78  /**
79  * Issue the command to VPP/HW
80  */
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_cmd& i) const;
92 
93 private:
94  /**
95  * Enpoint values of the tunnel to be deleted
96  */
97  const vxlan_tunnel::endpoint_t m_ep;
98 };
99 
100 /**
101  * A cmd class that Dumps all the Vpp interfaces
102  */
103 class dump_cmd : public VOM::dump_cmd<vapi::Vxlan_tunnel_dump>
104 {
105 public:
106  /**
107  * Default Constructor
108  */
109  dump_cmd();
110 
111  /**
112  * Issue the command to VPP/HW
113  */
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_cmd& i) const;
124 };
125 
126 }; // namespace vxlan_tunnel_cmds
127 }; // namespace VOM
128 
129 /*
130  * fd.io coding-style-patch-verification: OFF
131  *
132  * Local Variables:
133  * eval: (c-set-style "mozilla")
134  * End:
135  */
136 
137 #endif
VOM::vxlan_tunnel_cmds::create_cmd::to_string
std::string to_string() const
convert to string format for debug purposes
Definition: vxlan_tunnel_cmds.cpp:68
VOM::HW::item< handle_t >
VOM::vxlan_tunnel_cmds::dump_cmd::operator==
bool operator==(const dump_cmd &i) const
Comparison operator - only used for UT.
Definition: vxlan_tunnel_cmds.cpp:128
VOM::vxlan_tunnel_cmds::dump_cmd
A cmd class that Dumps all the Vpp interfaces.
Definition: vxlan_tunnel_cmds.hpp:103
VOM
The VPP Object Model (VOM) library.
Definition: acl_binding.cpp:19
name
string name[64]
Definition: fib.api:25
VOM::vxlan_tunnel_cmds::dump_cmd::dump_cmd
dump_cmd()
Default Constructor.
Definition: vxlan_tunnel_cmds.cpp:125
VOM::vxlan_tunnel_cmds::delete_cmd::to_string
std::string to_string() const
convert to string format for debug purposes
Definition: vxlan_tunnel_cmds.cpp:117
VOM::vxlan_tunnel_cmds::delete_cmd::issue
rc_t issue(connection &con)
Issue the command to VPP/HW.
Definition: vxlan_tunnel_cmds.cpp:90
VOM::vxlan_tunnel_cmds::dump_cmd::issue
rc_t issue(connection &con)
Issue the command to VPP/HW.
Definition: vxlan_tunnel_cmds.cpp:134
con
Connection con
Definition: vapi_cpp_test.cpp:56
VOM::interface::delete_cmd
Base class for intterface Delete commands.
Definition: interface.hpp:376
VOM::vxlan_tunnel_cmds::create_cmd
A Command class that creates an VXLAN tunnel.
Definition: vxlan_tunnel_cmds.hpp:32
VOM::vxlan_tunnel_cmds::create_cmd::issue
rc_t issue(connection &con)
Issue the command to VPP/HW.
Definition: vxlan_tunnel_cmds.cpp:39
VOM::vxlan_tunnel_cmds::create_cmd::create_cmd
create_cmd(HW::item< handle_t > &item, const std::string &name, const vxlan_tunnel::endpoint_t &ep, handle_t mcast_itf)
Create command constructor taking HW item to update and the endpoint values.
Definition: vxlan_tunnel_cmds.cpp:23
VOM::connection
A representation of the connection to VPP.
Definition: connection.hpp:33
VOM::vxlan_tunnel_cmds::delete_cmd
A functor class that creates an VXLAN tunnel.
Definition: vxlan_tunnel_cmds.hpp:69
VOM::handle_t
A type declaration of an interface handle in VPP.
Definition: types.hpp:233
VOM::vxlan_tunnel_cmds::delete_cmd::delete_cmd
delete_cmd(HW::item< handle_t > &item, const vxlan_tunnel::endpoint_t &ep)
delete command constructor taking HW item to update and the endpoint values
Definition: vxlan_tunnel_cmds.cpp:77
VOM::interface::create_cmd
A base class for interface Create commands.
Definition: interface.hpp:309
dump_cmd.hpp
VOM::rpc_cmd< HW::item< handle_t >, vapi::Vxlan_add_del_tunnel >::item
HW::item< handle_t > & item()
return the HW item the command updates
Definition: rpc_cmd.hpp:66
VOM::vxlan_tunnel_cmds::create_cmd::operator==
bool operator==(const create_cmd &i) const
Comparison operator - only used for UT.
Definition: vxlan_tunnel_cmds.cpp:33
VOM::vxlan_tunnel_cmds::delete_cmd::operator==
bool operator==(const delete_cmd &i) const
Comparison operator - only used for UT.
Definition: vxlan_tunnel_cmds.cpp:84
vapi.hpp
C++ VPP API.
VOM::vxlan_tunnel_cmds::dump_cmd::to_string
std::string to_string() const
convert to string format for debug purposes
Definition: vxlan_tunnel_cmds.cpp:149
i
int i
Definition: flowhash_template.h:376
vxlan_tunnel.hpp
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::vxlan_tunnel::endpoint_t
Combaintion of attributes that are a unique key for a VXLAN tunnel.
Definition: vxlan_tunnel.hpp:39
rpc_cmd.hpp
string
const char *const string
Definition: cJSON.h:172