FD.io VPP  v19.01.3-6-g70449b9b9
Vector Packet Processing
gbp_vxlan_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_VXLAN_CMDS_H__
17 #define __VOM_GBP_VXLAN_CMDS_H__
18 
19 #include "vom/dump_cmd.hpp"
20 #include "vom/gbp_vxlan.hpp"
21 #include "vom/interface.hpp"
22 
23 #include <vapi/gbp.api.vapi.hpp>
24 
25 namespace VOM {
26 namespace gbp_vxlan_cmds {
27 /**
28  * A command class that creates an Bridge-Domain
29  */
30 class create_cmd : public interface::create_cmd<vapi::Gbp_vxlan_tunnel_add>
31 {
32 public:
33  /**
34  * Constructor
35  */
37  const std::string& name,
38  uint32_t vni,
39  bool is_l2,
40  uint32_t bd_rd);
41 
42  /**
43  * Issue the command to VPP/HW
44  */
45  rc_t issue(connection& con);
46  /**
47  * convert to string format for debug purposes
48  */
49  std::string to_string() const;
50 
51  /**
52  * Comparison operator - only used for UT
53  */
54  bool operator==(const create_cmd& i) const;
55 
56 private:
57  uint32_t m_vni;
58  bool m_is_l2;
59  uint32_t m_bd_rd;
60 };
61 
62 /**
63  * A cmd class that Delete an Bridge-Domain
64  */
65 class delete_cmd : public interface::delete_cmd<vapi::Gbp_vxlan_tunnel_del>
66 {
67 public:
68  /**
69  * Constructor
70  */
72 
73  /**
74  * Issue the command to VPP/HW
75  */
76  rc_t issue(connection& con);
77  /**
78  * convert to string format for debug purposes
79  */
80  std::string to_string() const;
81 
82  /**
83  * Comparison operator - only used for UT
84  */
85  bool operator==(const delete_cmd& i) const;
86 
87 private:
88  uint32_t m_vni;
89 };
90 
91 /**
92  * A cmd class that Dumps all the bridge domains
93  */
94 class dump_cmd : public VOM::dump_cmd<vapi::Gbp_vxlan_tunnel_dump>
95 {
96 public:
97  /**
98  * Constructor
99  */
100  dump_cmd();
101  dump_cmd(const dump_cmd& d);
102 
103  /**
104  * Issue the command to VPP/HW
105  */
106  rc_t issue(connection& con);
107  /**
108  * convert to string format for debug purposes
109  */
110  std::string to_string() const;
111 
112  /**
113  * Comparison operator - only used for UT
114  */
115  bool operator==(const dump_cmd& i) const;
116 
117 private:
118  /**
119  * HW reutrn code
120  */
122 };
123 
124 }; // gbp_vxlan_cmds
125 }; // 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
int i
A cmd class that Dumps all the bridge domains.
Error codes that VPP will return during a HW write.
Definition: types.hpp:89
A command class that creates an Bridge-Domain.
rc_t issue(connection &con)
Issue the command to VPP/HW.
A representation of the connection to VPP.
Definition: connection.hpp:33
bool operator==(const create_cmd &i) const
Comparison operator - only used for UT.
std::string to_string() const
convert to string format for debug purposes
u8 name[64]
Definition: memclnt.api:152
A cmd class that Delete an Bridge-Domain.
create_cmd(HW::item< handle_t > &item, const std::string &name, uint32_t vni, bool is_l2, uint32_t bd_rd)
Constructor.
Base class for intterface Delete commands.
Definition: interface.hpp:368
A base class for interface Create commands.
Definition: interface.hpp:301
The VPP Object Model (VOM) library.
Definition: acl_binding.cpp:19
u32 vni
Definition: vxlan_gbp.api:36
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