FD.io VPP  v19.08.3-2-gbabecb413
Vector Packet Processing
qos_mark_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_MARK_CMDS_H__
17 #define __VOM_QOS_MARK_CMDS_H__
18 
19 #include "vom/dump_cmd.hpp"
20 #include "vom/qos_mark.hpp"
21 
22 #include <vapi/qos.api.vapi.hpp>
23 
24 namespace VOM {
25 namespace QoS {
26 namespace mark_cmds {
27 
28 /**
29  * A command class that creates or updates the GBP endpoint
30  */
31 class create_cmd : public rpc_cmd<HW::item<bool>, vapi::Qos_mark_enable_disable>
32 {
33 public:
34  /**
35  * Constructor
36  */
38  const handle_t& itf,
39  uint32_t map_id,
40  const source_t& src);
41 
42  /**
43  * Issue the command to VPP/HW
44  */
45  rc_t issue(connection& con);
46 
47  /**
48  * convert to string format for debug purposes
49  */
50  std::string to_string() const;
51 
52  /**
53  * Comparison operator - only used for UT
54  */
55  bool operator==(const create_cmd& i) const;
56 
57 private:
58  handle_t m_itf;
59  uint32_t m_map_id;
60  const source_t& m_src;
61 };
62 
63 /**
64  * A cmd class that deletes a GBP endpoint
65  */
66 class delete_cmd : public rpc_cmd<HW::item<bool>, vapi::Qos_mark_enable_disable>
67 {
68 public:
69  /**
70  * Constructor
71  */
72  delete_cmd(HW::item<bool>& item, const handle_t& itf, const source_t& src);
73 
74  /**
75  * Issue the command to VPP/HW
76  */
77  rc_t issue(connection& con);
78 
79  /**
80  * convert to string format for debug purposes
81  */
82  std::string to_string() const;
83 
84  /**
85  * Comparison operator - only used for UT
86  */
87  bool operator==(const delete_cmd& i) const;
88 
89 private:
90  const handle_t m_itf;
91  const source_t& m_src;
92 };
93 
94 /**
95  * A cmd class that Dumps all the GBP endpoints
96  */
97 class dump_cmd : public VOM::dump_cmd<vapi::Qos_mark_dump>
98 {
99 public:
100  /**
101  * Constructor
102  */
103  dump_cmd();
104  dump_cmd(const dump_cmd& d);
105 
106  /**
107  * Issue the command to VPP/HW
108  */
109  rc_t issue(connection& con);
110  /**
111  * convert to string format for debug purposes
112  */
113  std::string to_string() const;
114 
115  /**
116  * Comparison operator - only used for UT
117  */
118  bool operator==(const dump_cmd& i) const;
119 
120 private:
121  /**
122  * HW reutrn code
123  */
125 };
126 }; // namespace mark_cmds
127 }; // namespace Qos
128 }; // namespace VOM
129 
130 /*
131  * fd.io coding-style-patch-verification: ON
132  *
133  * Local Variables:
134  * eval: (c-set-style "mozilla")
135  * End:
136  */
137 
138 #endif
A command class that creates or updates the GBP endpoint.
vl_api_address_t src
Definition: gre.api:51
int i
u32 map_id
Definition: qos.api:213
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 cmd class that deletes a GBP endpoint.
A representation of the connection to VPP.
Definition: connection.hpp:33
create_cmd(HW::item< bool > &item, const handle_t &itf, uint32_t map_id, const source_t &src)
Constructor.
bool operator==(const create_cmd &i) const
Comparison operator - only used for UT.
A base class for all RPC commands to VPP.
Definition: rpc_cmd.hpp:40
The Source of the QoS classification (i.e.
Definition: qos_types.hpp:33
A type declaration of an interface handle in VPP.
Definition: types.hpp:233
The VPP Object Model (VOM) library.
Definition: acl_binding.cpp:19
std::string to_string() const
convert to string format for debug purposes
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
A cmd class that Dumps all the GBP endpoints.