FD.io VPP  v19.08.3-2-gbabecb413
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  */
30 class create_cmd : public rpc_cmd<HW::item<bool>, vapi::Gbp_subnet_add_del>
31 {
32 public:
33  /**
34  * Constructor
35  */
38  const route::prefix_t& prefix,
39  const gbp_subnet::type_t& type,
40  const handle_t& itf,
42 
43  /**
44  * Issue the command to VPP/HW
45  */
46  rc_t issue(connection& con);
47 
48  /**
49  * convert to string format for debug purposes
50  */
51  std::string to_string() const;
52 
53  /**
54  * Comparison operator - only used for UT
55  */
56  bool operator==(const create_cmd& i) const;
57 
58 private:
59  const route::table_id_t m_rd;
60  const route::prefix_t m_prefix;
61  const gbp_subnet::type_t& m_type;
62  const handle_t m_itf;
63  const sclass_t m_sclass;
64 };
65 
66 /**
67  * A cmd class that deletes a GBP subnet
68  */
69 class delete_cmd : public rpc_cmd<HW::item<bool>, vapi::Gbp_subnet_add_del>
70 {
71 public:
72  /**
73  * Constructor
74  */
77  const route::prefix_t& prefix);
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 route::table_id_t m_rd;
96  const route::prefix_t m_prefix;
97 };
98 
99 /**
100  * A cmd class that Dumps all the GBP subnets
101  */
102 class dump_cmd : public VOM::dump_cmd<vapi::Gbp_subnet_dump>
103 {
104 public:
105  /**
106  * Constructor
107  */
108  dump_cmd();
109  dump_cmd(const dump_cmd& d);
110 
111  /**
112  * Issue the command to VPP/HW
113  */
114  rc_t issue(connection& con);
115  /**
116  * convert to string format for debug purposes
117  */
118  std::string to_string() const;
119 
120  /**
121  * Comparison operator - only used for UT
122  */
123  bool operator==(const dump_cmd& i) const;
124 
125 private:
126  /**
127  * HW reutrn code
128  */
130 };
131 }; // namespace gbp_enpoint_cms
132 }; // namespace VOM
133 
134 /*
135  * fd.io coding-style-patch-verification: ON
136  *
137  * Local Variables:
138  * eval: (c-set-style "mozilla")
139  * End:
140  */
141 
142 #endif
uint32_t table_id_t
type def the table-id
Definition: prefix.hpp:121
uint16_t sclass_t
Definition: gbp_types.hpp:27
create_cmd(HW::item< bool > &item, route::table_id_t rd, const route::prefix_t &prefix, const gbp_subnet::type_t &type, const handle_t &itf, sclass_t sclass)
Constructor.
int i
Error codes that VPP will return during a HW write.
Definition: types.hpp:89
vl_api_mprefix_t prefix
Definition: ip.api:456
A cmd class that Dumps all the GBP subnets.
A representation of the connection to VPP.
Definition: connection.hpp:33
vl_api_fib_path_type_t type
Definition: fib_types.api:123
u16 sclass
Definition: gbp.api:122
A base class for all RPC commands to VPP.
Definition: rpc_cmd.hpp:40
bool operator==(const create_cmd &i) const
Comparison operator - only used for UT.
A cmd class that deletes a GBP subnet.
A type declaration of an interface handle in VPP.
Definition: types.hpp:233
std::string to_string() const
convert to string format for debug purposes
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:131
HW::item< bool > & item()
return the HW item the command updates
Definition: rpc_cmd.hpp:66