FD.io VPP  v19.08-27-gf4dcae4
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  */
37  vnid_t vnid,
38  uint16_t sclass,
39  uint32_t bd_id,
41  const gbp_endpoint_group::retention_t& retention,
42  const handle_t& itf);
43 
44  /**
45  * Issue the command to VPP/HW
46  */
47  rc_t issue(connection& con);
48 
49  /**
50  * convert to string format for debug purposes
51  */
52  std::string to_string() const;
53 
54  /**
55  * Comparison operator - only used for UT
56  */
57  bool operator==(const create_cmd& i) const;
58 
59 private:
60  const vnid_t m_vnid;
61  const uint16_t m_sclass;
62  const uint32_t m_bd_id;
63  const route::table_id_t m_rd_id;
64  const handle_t m_itf;
65  const gbp_endpoint_group::retention_t m_retention;
66 };
67 
68 /**
69  * A cmd class that deletes a GBP endpoint_group
70  */
71 class delete_cmd : public rpc_cmd<HW::item<bool>, vapi::Gbp_endpoint_group_del>
72 {
73 public:
74  /**
75  * Constructor
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  const sclass_t m_sclass;
96 };
97 
98 /**
99  * A cmd class that Dumps all the GBP endpoint_groups
100  */
101 class dump_cmd : public VOM::dump_cmd<vapi::Gbp_endpoint_group_dump>
102 {
103 public:
104  /**
105  * Constructor
106  */
107  dump_cmd();
108  dump_cmd(const dump_cmd& d);
109 
110  /**
111  * Issue the command to VPP/HW
112  */
113  rc_t issue(connection& con);
114  /**
115  * convert to string format for debug purposes
116  */
117  std::string to_string() const;
118 
119  /**
120  * Comparison operator - only used for UT
121  */
122  bool operator==(const dump_cmd& i) const;
123 
124 private:
125  /**
126  * HW reutrn code
127  */
129 };
130 }; // namespace gbp_enpoint_cms
131 }; // namespace VOM
132 
133 /*
134  * fd.io coding-style-patch-verification: ON
135  *
136  * Local Variables:
137  * eval: (c-set-style "mozilla")
138  * End:
139  */
140 
141 #endif
uint32_t table_id_t
type def the table-id
Definition: prefix.hpp:121
uint16_t sclass_t
Definition: gbp_types.hpp:27
A cmd class that deletes a GBP endpoint_group.
Endpoint Retention Policy Settings.
rc_t issue(connection &con)
Issue the command to VPP/HW.
int i
u32 rd_id
Definition: gbp.api:34
Error codes that VPP will return during a HW write.
Definition: types.hpp:89
bool operator==(const create_cmd &i) const
Comparison operator - only used for UT.
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:274
u16 sclass
Definition: gbp.api:122
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
create_cmd(HW::item< bool > &item, vnid_t vnid, uint16_t sclass, uint32_t bd_id, route::table_id_t rd_id, const gbp_endpoint_group::retention_t &retention, const handle_t &itf)
Constructor.
The VPP Object Model (VOM) library.
Definition: acl_binding.cpp:19
uint32_t vnid_t
EPG IDs are 32 bit integers.
Definition: gbp_types.hpp:26
std::string to_string() const
convert to string format for debug purposes
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.