FD.io VPP  v21.10.1-2-g0a485f517
Vector Packet Processing
qos_store_cmds.hpp
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2019 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_QOS_STORE_CMDS_H__
17 #define __VOM_QOS_STORE_CMDS_H__
18 
19 #include "vom/dump_cmd.hpp"
20 #include "vom/qos_store.hpp"
21 
22 #include <vapi/qos.api.vapi.hpp>
23 
24 namespace VOM {
25 namespace QoS {
26 namespace store_cmds {
27 
28 /**
29  * A command class that creates or updates the GBP endpoint
30  */
32  : public rpc_cmd<HW::item<bool>, vapi::Qos_store_enable_disable>
33 {
34 public:
35  /**
36  * Constructor
37  */
39  const handle_t& itf,
40  const source_t& src,
41  bits_t value);
42 
43  /**
44  * Issue the command to VPP/HW
45  */
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  handle_t m_itf;
60  const source_t& m_src;
61  bits_t m_value;
62 };
63 
64 /**
65  * A cmd class that deletes a GBP endpoint
66  */
68  : public rpc_cmd<HW::item<bool>, vapi::Qos_store_enable_disable>
69 {
70 public:
71  /**
72  * Constructor
73  */
74  delete_cmd(HW::item<bool>& item, const handle_t& itf, const source_t& src);
75 
76  /**
77  * Issue the command to VPP/HW
78  */
80 
81  /**
82  * convert to string format for debug purposes
83  */
84  std::string to_string() const;
85 
86  /**
87  * Comparison operator - only used for UT
88  */
89  bool operator==(const delete_cmd& i) const;
90 
91 private:
92  const handle_t m_itf;
93  const source_t& m_src;
94 };
95 
96 /**
97  * A cmd class that Dumps all the GBP endpoints
98  */
99 class dump_cmd : public VOM::dump_cmd<vapi::Qos_store_dump>
100 {
101 public:
102  /**
103  * Constructor
104  */
105  dump_cmd();
106  dump_cmd(const dump_cmd& d);
107 
108  /**
109  * Issue the command to VPP/HW
110  */
112  /**
113  * convert to string format for debug purposes
114  */
115  std::string to_string() const;
116 
117  /**
118  * Comparison operator - only used for UT
119  */
120  bool operator==(const dump_cmd& i) const;
121 
122 private:
123  /**
124  * HW reutrn code
125  */
126  HW::item<bool> item;
127 };
128 }; // namespace store_cmds
129 }; // namespace Qos
130 }; // namespace VOM
131 
132 /*
133  * fd.io coding-style-patch-verification: OFF
134  *
135  * Local Variables:
136  * eval: (c-set-style "mozilla")
137  * End:
138  */
139 
140 #endif
VOM::HW::item< bool >
VOM::QoS::store_cmds::dump_cmd::issue
rc_t issue(connection &con)
Issue the command to VPP/HW.
Definition: qos_store_cmds.cpp:116
VOM
The VPP Object Model (VOM) library.
Definition: acl_binding.cpp:19
VOM::QoS::store_cmds::dump_cmd::dump_cmd
dump_cmd()
Constructor.
Definition: qos_store_cmds.cpp:105
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::QoS::store_cmds::dump_cmd
A cmd class that Dumps all the GBP endpoints.
Definition: qos_store_cmds.hpp:99
VOM::QoS::store_cmds::create_cmd::create_cmd
create_cmd(HW::item< bool > &item, const handle_t &itf, const source_t &src, bits_t value)
Constructor.
Definition: qos_store_cmds.cpp:23
VOM::QoS::store_cmds::delete_cmd::delete_cmd
delete_cmd(HW::item< bool > &item, const handle_t &itf, const source_t &src)
Constructor.
Definition: qos_store_cmds.cpp:66
VOM::QoS::store_cmds::delete_cmd::issue
rc_t issue(connection &con)
Issue the command to VPP/HW.
Definition: qos_store_cmds.cpp:83
qos_store.hpp
VOM::QoS::store_cmds::create_cmd
A command class that creates or updates the GBP endpoint.
Definition: qos_store_cmds.hpp:31
VOM::connection
A representation of the connection to VPP.
Definition: connection.hpp:33
VOM::QoS::bits_t
uint8_t bits_t
Definition: qos_types.hpp:27
VOM::QoS::store_cmds::delete_cmd::to_string
std::string to_string() const
convert to string format for debug purposes
Definition: qos_store_cmds.cpp:97
VOM::QoS::store_cmds::create_cmd::to_string
std::string to_string() const
convert to string format for debug purposes
Definition: qos_store_cmds.cpp:57
VOM::QoS::store_cmds::delete_cmd
A cmd class that deletes a GBP endpoint.
Definition: qos_store_cmds.hpp:67
VOM::handle_t
A type declaration of an interface handle in VPP.
Definition: types.hpp:233
VOM::QoS::store_cmds::delete_cmd::operator==
bool operator==(const delete_cmd &i) const
Comparison operator - only used for UT.
Definition: qos_store_cmds.cpp:76
src
vl_api_address_t src
Definition: gre.api:54
dump_cmd.hpp
VOM::QoS::store_cmds::create_cmd::issue
rc_t issue(connection &con)
Issue the command to VPP/HW.
Definition: qos_store_cmds.cpp:42
VOM::rpc_cmd< HW::item< bool >, vapi::Qos_store_enable_disable >::item
HW::item< bool > & item()
return the HW item the command updates
Definition: rpc_cmd.hpp:66
VOM::QoS::store_cmds::create_cmd::operator==
bool operator==(const create_cmd &i) const
Comparison operator - only used for UT.
Definition: qos_store_cmds.cpp:35
value
u8 value
Definition: qos.api:54
VOM::QoS::store_cmds::dump_cmd::operator==
bool operator==(const dump_cmd &i) const
Comparison operator - only used for UT.
Definition: qos_store_cmds.cpp:110
i
int i
Definition: flowhash_template.h:376
VOM::QoS::store_cmds::dump_cmd::to_string
std::string to_string() const
convert to string format for debug purposes
Definition: qos_store_cmds.cpp:128
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
VOM::QoS::source_t
The Source of the QoS classification (i.e.
Definition: qos_types.hpp:33
string
const char *const string
Definition: cJSON.h:172