FD.io VPP  v19.01.3-6-g70449b9b9
Vector Packet Processing
gbp_endpoint_group_cmds.hpp
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2018 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_GROUP_CMDS_H__
17 #define __VOM_GBP_ENDPOINT_GROUP_CMDS_H__
18 
19 #include "vom/dump_cmd.hpp"
21 
22 #include <vapi/gbp.api.vapi.hpp>
23 
24 namespace VOM {
25 namespace gbp_endpoint_group_cmds {
26 
27 /**
28 * A command class that creates or updates the GBP endpoint_group
29 */
30 class create_cmd : public rpc_cmd<HW::item<bool>, vapi::Gbp_endpoint_group_add>
31 {
32 public:
33  /**
34  * Constructor
35  */
38  uint32_t bd_id,
40  const handle_t& itf);
41 
42  /**
43  * Issue the command to VPP/HW
44  */
45  rc_t issue(connection& con);
46 
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  const epg_id_t m_epg_id;
59  const uint32_t m_bd_id;
60  const route::table_id_t m_rd_id;
61  const handle_t m_itf;
62 };
63 
64 /**
65  * A cmd class that deletes a GBP endpoint_group
66  */
67 class delete_cmd : public rpc_cmd<HW::item<bool>, vapi::Gbp_endpoint_group_del>
68 {
69 public:
70  /**
71  * Constructor
72  */
74 
75  /**
76  * Issue the command to VPP/HW
77  */
78  rc_t issue(connection& con);
79 
80  /**
81  * convert to string format for debug purposes
82  */
83  std::string to_string() const;
84 
85  /**
86  * Comparison operator - only used for UT
87  */
88  bool operator==(const delete_cmd& i) const;
89 
90 private:
91  const epg_id_t m_epg_id;
92 };
93 
94 /**
95  * A cmd class that Dumps all the GBP endpoint_groups
96  */
97 class dump_cmd : public VOM::dump_cmd<vapi::Gbp_endpoint_group_dump>
98 {
99 public:
100  /**
101  * Constructor
102  */
103  dump_cmd();
104  dump_cmd(const dump_cmd& d);
105 
106  /**
107  * Issue the command to VPP/HW
108  */
109  rc_t issue(connection& con);
110  /**
111  * convert to string format for debug purposes
112  */
113  std::string to_string() const;
114 
115  /**
116  * Comparison operator - only used for UT
117  */
118  bool operator==(const dump_cmd& i) const;
119 
120 private:
121  /**
122  * HW reutrn code
123  */
125 };
126 }; // namespace gbp_enpoint_cms
127 }; // namespace VOM
128 
129 /*
130  * fd.io coding-style-patch-verification: ON
131  *
132  * Local Variables:
133  * eval: (c-set-style "mozilla")
134  * End:
135  */
136 
137 #endif
bool operator==(const create_cmd &i) const
Comparison operator - only used for UT.
uint32_t table_id_t
type def the table-id
Definition: prefix.hpp:82
uint32_t epg_id_t
EPG IDs are 32 bit integers.
A cmd class that deletes a GBP endpoint_group.
rc_t issue(connection &con)
Issue the command to VPP/HW.
int i
u32 rd_id
Definition: gbp.api:261
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
create_cmd(HW::item< bool > &item, epg_id_t epg_id, uint32_t bd_id, route::table_id_t rd_id, const handle_t &itf)
Constructor.
A cmd class that Dumps all the GBP endpoint_groups.
A representation of the connection to VPP.
Definition: connection.hpp:33
u32 bd_id
Definition: gbp.api:260
u16 epg_id
Definition: gbp.api:116
A base class for all RPC commands to VPP.
Definition: rpc_cmd.hpp:40
A type declaration of an interface handle in VPP.
Definition: types.hpp:233
The VPP Object Model (VOM) library.
Definition: acl_binding.cpp:19
A base class for VPP dump commands.
Definition: dump_cmd.hpp:43
HW::item< bool > & item()
return the HW item the command updates
Definition: rpc_cmd.hpp:66
A command class that creates or updates the GBP endpoint_group.