FD.io VPP  v18.04-17-g3a0d853
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 
43  /**
44  * Issue the command to VPP/HW
45  */
46  rc_t issue(connection& con);
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_cmd& i) const;
56 
57 private:
58  /**
59  * Enpoint values of the tunnel to be created
60  */
61  const vxlan_tunnel::endpoint_t m_ep;
62 };
63 
64 /**
65  * A functor class that creates an VXLAN tunnel
66  */
67 class delete_cmd : public interface::delete_cmd<vapi::Vxlan_add_del_tunnel>
68 {
69 public:
70  /**
71  * delete command constructor taking HW item to update and the
72  * endpoint values
73  */
75 
76  /**
77  * Issue the command to VPP/HW
78  */
79  rc_t issue(connection& con);
80 
81  /**
82  * convert to string format for debug purposes
83  */
84  std::string to_string() const;
85 
86  /**
87  * Comparison operator - only used for UT
88  */
89  bool operator==(const delete_cmd& i) const;
90 
91 private:
92  /**
93  * Enpoint values of the tunnel to be deleted
94  */
95  const vxlan_tunnel::endpoint_t m_ep;
96 };
97 
98 /**
99  * A cmd class that Dumps all the Vpp interfaces
100  */
101 class dump_cmd : public VOM::dump_cmd<vapi::Vxlan_tunnel_dump>
102 {
103 public:
104  /**
105  * Default Constructor
106  */
107  dump_cmd();
108 
109  /**
110  * Issue the command to VPP/HW
111  */
112  rc_t issue(connection& con);
113  /**
114  * convert to string format for debug purposes
115  */
116  std::string to_string() const;
117 
118  /**
119  * Comparison operator - only used for UT
120  */
121  bool operator==(const dump_cmd& i) const;
122 };
123 
124 }; // namespace vxlan_tunnel_cmds
125 }; // namespace VOM
126 
127 /*
128  * fd.io coding-style-patch-verification: ON
129  *
130  * Local Variables:
131  * eval: (c-set-style "mozilla")
132  * End:
133  */
134 
135 #endif
bool operator==(const create_cmd &i) const
Comparison operator - only used for UT.
rc_t issue(connection &con)
Issue the command to VPP/HW.
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:90
A Command class that creates an VXLAN tunnel.
C++ VPP API.
A representation of the connection to VPP.
Definition: connection.hpp:33
A functor class that creates an VXLAN tunnel.
A cmd class that Dumps all the Vpp interfaces.
HW::item< handle_t > & item()
return the HW item the command updates
Definition: rpc_cmd.hpp:64
std::string to_string() const
convert to string format for debug purposes
Base class for intterface Delete commands.
Definition: interface.hpp:337
A base class for interface Create commands.
Definition: interface.hpp:269
create_cmd(HW::item< handle_t > &item, const std::string &name, const vxlan_tunnel::endpoint_t &ep)
Create command constructor taking HW item to update and the endpoint values.
The VPP Object Model (VOM) library.
Definition: acl_binding.cpp:19
A base class for VPP dump commands.
Definition: dump_cmd.hpp:43