FD.io VPP  v19.08.3-2-gbabecb413
Vector Packet Processing
gbp_ext_itf_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_EXT_ITF_CMDS_H__
17 #define __VOM_GBP_EXT_ITF_CMDS_H__
18 
19 #include "vom/dump_cmd.hpp"
20 #include "vom/gbp_ext_itf.hpp"
21 
22 #include <vapi/gbp.api.vapi.hpp>
23 
24 namespace VOM {
25 namespace gbp_ext_itf_cmds {
26 
27 /**
28 * A command class that creates or updates the GBP ext_itf
29 */
30 class create_cmd : public rpc_cmd<HW::item<bool>, vapi::Gbp_ext_itf_add_del>
31 {
32 public:
33  /**
34  * Constructor
35  */
37  const handle_t& itf,
38  uint32_t bd_id,
39  uint32_t rd_id);
40 
41  /**
42  * Issue the command to VPP/HW
43  */
44  rc_t issue(connection& con);
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  const uint32_t m_bd_id;
59  const uint32_t m_rd_id;
60 };
61 
62 /**
63  * A cmd class that deletes a GBP ext_itf
64  */
65 class delete_cmd : public rpc_cmd<HW::item<bool>, vapi::Gbp_ext_itf_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  */
76  rc_t issue(connection& con);
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 ext_itfs
94  */
95 class dump_cmd : public VOM::dump_cmd<vapi::Gbp_ext_itf_dump>
96 {
97 public:
98  /**
99  * Constructor
100  */
101  dump_cmd() = default;
102 
103  /**
104  * Issue the command to VPP/HW
105  */
106  rc_t issue(connection& con);
107  /**
108  * convert to string format for debug purposes
109  */
110  std::string to_string() const;
111 
112  /**
113  * Comparison operator - only used for UT
114  */
115  bool operator==(const dump_cmd& i) const;
116 
117 private:
118  /**
119  * HW reutrn code
120  */
122 };
123 }; // namespace gbp_ext_itf_cmds
124 }; // namespace VOM
125 
126 /*
127  * fd.io coding-style-patch-verification: ON
128  *
129  * Local Variables:
130  * eval: (c-set-style "mozilla")
131  * End:
132  */
133 
134 #endif
create_cmd(HW::item< bool > &item, const handle_t &itf, uint32_t bd_id, uint32_t rd_id)
Constructor.
A cmd class that Dumps all the GBP ext_itfs.
int i
u32 rd_id
Definition: gbp.api:34
Error codes that VPP will return during a HW write.
Definition: types.hpp:89
rc_t issue(connection &con)
Issue the command to VPP/HW.
A representation of the connection to VPP.
Definition: connection.hpp:33
u32 bd_id
Definition: gbp.api:274
A base class for all RPC commands to VPP.
Definition: rpc_cmd.hpp:40
std::string to_string() const
convert to string format for debug purposes
A type declaration of an interface handle in VPP.
Definition: types.hpp:233
bool operator==(const create_cmd &i) const
Comparison operator - only used for UT.
The VPP Object Model (VOM) library.
Definition: acl_binding.cpp:19
A cmd class that deletes a GBP ext_itf.
A command class that creates or updates the GBP ext_itf.
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