FD.io VPP  v21.10.1-2-g0a485f517
Vector Packet Processing
gbp_recirc_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_RECIRC_CMDS_H__
17 #define __VOM_GBP_RECIRC_CMDS_H__
18 
19 #include "vom/dump_cmd.hpp"
20 #include "vom/gbp_recirc.hpp"
21 
22 #include <vapi/gbp.api.vapi.hpp>
23 
24 namespace VOM {
25 namespace gbp_recirc_cmds {
26 
27 /**
28 * A command class that creates or updates the GBP recirc
29 */
30 class create_cmd : public rpc_cmd<HW::item<bool>, vapi::Gbp_recirc_add_del>
31 {
32 public:
33  /**
34  * Constructor
35  */
37  const handle_t& itf,
38  bool is_ext,
40 
41  /**
42  * Issue the command to VPP/HW
43  */
45 
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  const handle_t m_itf;
58  bool m_is_ext;
59  const sclass_t m_sclass;
60 };
61 
62 /**
63  * A cmd class that deletes a GBP recirc
64  */
65 class delete_cmd : public rpc_cmd<HW::item<bool>, vapi::Gbp_recirc_add_del>
66 {
67 public:
68  /**
69  * Constructor
70  */
71  delete_cmd(HW::item<bool>& item, const handle_t& itf);
72 
73  /**
74  * Issue the command to VPP/HW
75  */
77 
78  /**
79  * convert to string format for debug purposes
80  */
81  std::string to_string() const;
82 
83  /**
84  * Comparison operator - only used for UT
85  */
86  bool operator==(const delete_cmd& i) const;
87 
88 private:
89  const handle_t m_itf;
90 };
91 
92 /**
93  * A cmd class that Dumps all the GBP recircs
94  */
95 class dump_cmd : public VOM::dump_cmd<vapi::Gbp_recirc_dump>
96 {
97 public:
98  /**
99  * Constructor
100  */
101  dump_cmd();
102  dump_cmd(const dump_cmd& d);
103 
104  /**
105  * Issue the command to VPP/HW
106  */
108  /**
109  * convert to string format for debug purposes
110  */
111  std::string to_string() const;
112 
113  /**
114  * Comparison operator - only used for UT
115  */
116  bool operator==(const dump_cmd& i) const;
117 
118 private:
119  /**
120  * HW reutrn code
121  */
122  HW::item<bool> item;
123 };
124 }; // namespace gbp_enpoint_cms
125 }; // namespace VOM
126 
127 /*
128  * fd.io coding-style-patch-verification: OFF
129  *
130  * Local Variables:
131  * eval: (c-set-style "mozilla")
132  * End:
133  */
134 
135 #endif
VOM::HW::item< bool >
VOM
The VPP Object Model (VOM) library.
Definition: acl_binding.cpp:19
gbp_recirc.hpp
VOM::gbp_recirc_cmds::delete_cmd::delete_cmd
delete_cmd(HW::item< bool > &item, const handle_t &itf)
Constructor.
Definition: gbp_recirc_cmds.cpp:65
VOM::rpc_cmd
A base class for all RPC commands to VPP.
Definition: rpc_cmd.hpp:40
con
Connection con
Definition: vapi_cpp_test.cpp:56
VOM::sclass_t
uint16_t sclass_t
Definition: gbp_types.hpp:27
is_ext
bool is_ext
Definition: gbp.api:227
VOM::gbp_recirc_cmds::create_cmd::to_string
std::string to_string() const
convert to string format for debug purposes
Definition: gbp_recirc_cmds.cpp:56
VOM::gbp_recirc_cmds::dump_cmd::to_string
std::string to_string() const
convert to string format for debug purposes
Definition: gbp_recirc_cmds.cpp:124
VOM::gbp_recirc_cmds::dump_cmd::issue
rc_t issue(connection &con)
Issue the command to VPP/HW.
Definition: gbp_recirc_cmds.cpp:112
VOM::connection
A representation of the connection to VPP.
Definition: connection.hpp:33
VOM::gbp_recirc_cmds::delete_cmd::operator==
bool operator==(const delete_cmd &i) const
Comparison operator - only used for UT.
Definition: gbp_recirc_cmds.cpp:72
VOM::gbp_recirc_cmds::dump_cmd::dump_cmd
dump_cmd()
Constructor.
Definition: gbp_recirc_cmds.cpp:101
VOM::handle_t
A type declaration of an interface handle in VPP.
Definition: types.hpp:233
VOM::gbp_recirc_cmds::delete_cmd::to_string
std::string to_string() const
convert to string format for debug purposes
Definition: gbp_recirc_cmds.cpp:93
sclass
u16 sclass
Definition: gbp.api:131
VOM::gbp_recirc_cmds::create_cmd::create_cmd
create_cmd(HW::item< bool > &item, const handle_t &itf, bool is_ext, sclass_t sclass)
Constructor.
Definition: gbp_recirc_cmds.cpp:21
VOM::gbp_recirc_cmds::create_cmd::operator==
bool operator==(const create_cmd &i) const
Comparison operator - only used for UT.
Definition: gbp_recirc_cmds.cpp:33
dump_cmd.hpp
VOM::gbp_recirc_cmds::delete_cmd::issue
rc_t issue(connection &con)
Issue the command to VPP/HW.
Definition: gbp_recirc_cmds.cpp:78
VOM::gbp_recirc_cmds::delete_cmd
A cmd class that deletes a GBP recirc.
Definition: gbp_recirc_cmds.hpp:65
VOM::rpc_cmd< HW::item< bool >, vapi::Gbp_recirc_add_del >::item
HW::item< bool > & item()
return the HW item the command updates
Definition: rpc_cmd.hpp:66
VOM::gbp_recirc_cmds::dump_cmd::operator==
bool operator==(const dump_cmd &i) const
Comparison operator - only used for UT.
Definition: gbp_recirc_cmds.cpp:106
VOM::gbp_recirc_cmds::create_cmd
A command class that creates or updates the GBP recirc.
Definition: gbp_recirc_cmds.hpp:30
VOM::gbp_recirc_cmds::dump_cmd
A cmd class that Dumps all the GBP recircs.
Definition: gbp_recirc_cmds.hpp:95
i
int i
Definition: flowhash_template.h:376
VOM::gbp_recirc_cmds::create_cmd::issue
rc_t issue(connection &con)
Issue the command to VPP/HW.
Definition: gbp_recirc_cmds.cpp:40
VOM::rc_t
Error codes that VPP will return during a HW write.
Definition: types.hpp:89
VOM::dump_cmd
A base class for VPP dump commands.
Definition: dump_cmd.hpp:43
string
const char *const string
Definition: cJSON.h:172