FD.io VPP  v18.10-34-gcce845e
Vector Packet Processing
gbp_contract_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_CONTRACT_CMDS_H__
17 #define __VOM_GBP_CONTRACT_CMDS_H__
18 
19 #include "vom/dump_cmd.hpp"
20 #include "vom/gbp_contract.hpp"
21 
22 #include <vapi/gbp.api.vapi.hpp>
23 
24 namespace VOM {
25 namespace gbp_contract_cmds {
26 
27 /**
28 * A command class that creates or updates the GBP contract
29 */
30 class create_cmd : public rpc_cmd<HW::item<bool>, vapi::Gbp_contract_add_del>
31 {
32 public:
33  /**
34  * Constructor
35  */
37  epg_id_t src_epg_id,
38  epg_id_t dst_epg_id,
39  const handle_t& acl);
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 epg_id_t m_src_epg_id;
58  const epg_id_t m_dst_epg_id;
59  const handle_t m_acl;
60 };
61 
62 /**
63  * A cmd class that deletes a GBP contract
64  */
65 class delete_cmd : public rpc_cmd<HW::item<bool>, vapi::Gbp_contract_add_del>
66 {
67 public:
68  /**
69  * Constructor
70  */
71  delete_cmd(HW::item<bool>& item, epg_id_t src_epg_id, epg_id_t dst_epg_id);
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 epg_id_t m_src_epg_id;
90  const epg_id_t m_dst_epg_id;
91 };
92 
93 /**
94  * A cmd class that Dumps all the GBP endpoints
95  */
96 class dump_cmd : public VOM::dump_cmd<vapi::Gbp_contract_dump>
97 {
98 public:
99  /**
100  * Constructor
101  */
102  dump_cmd() = default;
103 
104  /**
105  * Issue the command to VPP/HW
106  */
107  rc_t issue(connection& con);
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  */
123 };
124 }; // namespace gbp_contract_cmds
125 }; // namespace VOM
126 
127 /*
128  * fd.io coding-style-patch-verification: ON
129  *
130  * Local Variables:
131  * eval: (c-set-style "mozilla")
132  * End:
133  */
134 
135 #endif
std::string to_string() const
convert to string format for debug purposes
uint32_t epg_id_t
EPG IDs are 32 bit integers.
int i
A cmd class that Dumps all the GBP endpoints.
Error codes that VPP will return during a HW write.
Definition: types.hpp:84
A representation of the connection to VPP.
Definition: connection.hpp:33
A base class for all RPC commands to VPP.
Definition: rpc_cmd.hpp:38
bool operator==(const create_cmd &i) const
Comparison operator - only used for UT.
rc_t issue(connection &con)
Issue the command to VPP/HW.
A type declaration of an interface handle in VPP.
Definition: types.hpp:228
A command class that creates or updates the GBP contract.
create_cmd(HW::item< bool > &item, epg_id_t src_epg_id, epg_id_t dst_epg_id, const handle_t &acl)
Constructor.
The VPP Object Model (VOM) library.
Definition: acl_binding.cpp:19
A cmd class that deletes a GBP contract.
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:64