FD.io VPP  v19.08.3-2-gbabecb413
Vector Packet Processing
vxlan_gbp_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_GBP_TUNNEL_CMDS_H__
17 #define __VOM_VXLAN_GBP_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/vxlan_gbp.api.vapi.hpp>
24 
25 namespace VOM {
26 namespace vxlan_gbp_tunnel_cmds {
27 
28 /**
29  * A Command class that creates an VXLAN tunnel
30  */
31 class create_cmd : public interface::create_cmd<vapi::Vxlan_gbp_tunnel_add_del>
32 {
33 public:
34  /**
35  * Create command constructor taking HW item to update and the
36  * endpoint values
37  */
39  const std::string& name,
40  const vxlan_tunnel::endpoint_t& ep,
41  bool is_l2,
42  handle_t mcast_itf);
43 
44  /**
45  * Issue the command to VPP/HW
46  */
47  rc_t issue(connection& con);
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  bool m_is_l2;
64  handle_t m_mcast_itf;
65 };
66 
67 /**
68  * A functor class that creates an VXLAN tunnel
69  */
70 class delete_cmd : public interface::delete_cmd<vapi::Vxlan_gbp_tunnel_add_del>
71 {
72 public:
73  /**
74  * delete command constructor taking HW item to update and the
75  * endpoint values
76  */
78 
79  /**
80  * Issue the command to VPP/HW
81  */
82  rc_t issue(connection& con);
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  /**
96  * Enpoint values of the tunnel to be deleted
97  */
98  const vxlan_tunnel::endpoint_t m_ep;
99 };
100 
101 /**
102  * A cmd class that Dumps all the Vpp interfaces
103  */
104 class dump_cmd : public VOM::dump_cmd<vapi::Vxlan_gbp_tunnel_dump>
105 {
106 public:
107  /**
108  * Default Constructor
109  */
110  dump_cmd();
111 
112  /**
113  * Issue the command to VPP/HW
114  */
115  rc_t issue(connection& con);
116  /**
117  * convert to string format for debug purposes
118  */
119  std::string to_string() const;
120 
121  /**
122  * Comparison operator - only used for UT
123  */
124  bool operator==(const dump_cmd& i) const;
125 };
126 
127 }; // namespace vxlan_tunnel_cmds
128 }; // namespace VOM
129 
130 /*
131  * fd.io coding-style-patch-verification: ON
132  *
133  * Local Variables:
134  * eval: (c-set-style "mozilla")
135  * End:
136  */
137 
138 #endif
A Command class that creates an VXLAN tunnel.
rc_t issue(connection &con)
Issue the command to VPP/HW.
bool operator==(const create_cmd &i) const
Comparison operator - only used for UT.
Combaintion of attributes that are a unique key for a VXLAN tunnel.
int i
Error codes that VPP will return during a HW write.
Definition: types.hpp:89
std::string to_string() const
convert to string format for debug purposes
A representation of the connection to VPP.
Definition: connection.hpp:33
u8 name[64]
Definition: memclnt.api:152
create_cmd(HW::item< handle_t > &item, const std::string &name, const vxlan_tunnel::endpoint_t &ep, bool is_l2, handle_t mcast_itf)
Create command constructor taking HW item to update and the endpoint values.
Base class for intterface Delete commands.
Definition: interface.hpp:376
A type declaration of an interface handle in VPP.
Definition: types.hpp:233
A base class for interface Create commands.
Definition: interface.hpp:309
The VPP Object Model (VOM) library.
Definition: acl_binding.cpp:19
A functor class that creates an VXLAN tunnel.
A cmd class that Dumps all the Vpp interfaces.
A base class for VPP dump commands.
Definition: dump_cmd.hpp:43
HW::item< handle_t > & item()
return the HW item the command updates
Definition: rpc_cmd.hpp:66