FD.io VPP  v18.07-rc0-415-g6c78436
Vector Packet Processing
gbp_subnet_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_SUBNET_CMDS_H__
17 #define __VOM_GBP_SUBNET_CMDS_H__
18 
19 #include "vom/dump_cmd.hpp"
20 #include "vom/gbp_subnet.hpp"
21 
22 #include <vapi/gbp.api.vapi.hpp>
23 
24 namespace VOM {
25 namespace gbp_subnet_cmds {
26 
27 /**
28 * A command class that creates or updates the GBP subnet
29 */
31  : public rpc_cmd<HW::item<bool>, rc_t, vapi::Gbp_subnet_add_del>
32 {
33 public:
34  /**
35  * Constructor
36  */
39  const route::prefix_t& prefix,
40  bool internal,
41  const handle_t& itf,
42  epg_id_t epg_id);
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 route::table_id_t m_rd;
61  const route::prefix_t m_prefix;
62  const bool m_internal;
63  const handle_t m_itf;
64  const epg_id_t m_epg_id;
65 };
66 
67 /**
68  * A cmd class that deletes a GBP subnet
69  */
71  : public rpc_cmd<HW::item<bool>, rc_t, vapi::Gbp_subnet_add_del>
72 {
73 public:
74  /**
75  * Constructor
76  */
79  const route::prefix_t& prefix);
80 
81  /**
82  * Issue the command to VPP/HW
83  */
84  rc_t issue(connection& con);
85 
86  /**
87  * convert to string format for debug purposes
88  */
89  std::string to_string() const;
90 
91  /**
92  * Comparison operator - only used for UT
93  */
94  bool operator==(const delete_cmd& i) const;
95 
96 private:
97  const route::table_id_t m_rd;
98  const route::prefix_t m_prefix;
99 };
100 
101 /**
102  * A cmd class that Dumps all the GBP subnets
103  */
104 class dump_cmd : public VOM::dump_cmd<vapi::Gbp_subnet_dump>
105 {
106 public:
107  /**
108  * Constructor
109  */
110  dump_cmd();
111  dump_cmd(const dump_cmd& d);
112 
113  /**
114  * Issue the command to VPP/HW
115  */
116  rc_t issue(connection& con);
117  /**
118  * convert to string format for debug purposes
119  */
120  std::string to_string() const;
121 
122  /**
123  * Comparison operator - only used for UT
124  */
125  bool operator==(const dump_cmd& i) const;
126 
127 private:
128  /**
129  * HW reutrn code
130  */
132 };
133 }; // namespace gbp_enpoint_cms
134 }; // namespace VOM
135 
136 /*
137  * fd.io coding-style-patch-verification: ON
138  *
139  * Local Variables:
140  * eval: (c-set-style "mozilla")
141  * End:
142  */
143 
144 #endif
uint32_t table_id_t
type def the table-id
Definition: prefix.hpp:83
bool operator==(const create_cmd &i) const
Comparison operator - only used for UT.
uint32_t epg_id_t
EPG IDs are 32 bit integers.
int i
Error codes that VPP will return during a HW write.
Definition: types.hpp:90
A cmd class that Dumps all the GBP subnets.
create_cmd(HW::item< bool > &item, route::table_id_t rd, const route::prefix_t &prefix, bool internal, const handle_t &itf, epg_id_t epg_id)
Constructor.
A representation of the connection to VPP.
Definition: connection.hpp:33
HW::item< bool > & item()
return the HW item the command updates
Definition: rpc_cmd.hpp:64
A base class for all RPC commands to VPP.
Definition: rpc_cmd.hpp:38
std::string to_string() const
convert to string format for debug purposes
A cmd class that deletes a GBP subnet.
A type declaration of an interface handle in VPP.
Definition: types.hpp:236
A command class that creates or updates the GBP subnet.
The VPP Object Model (VOM) library.
Definition: acl_binding.cpp:19
rc_t issue(connection &con)
Issue the command to VPP/HW.
A base class for VPP dump commands.
Definition: dump_cmd.hpp:43
A prefix defintion.
Definition: prefix.hpp:93