FD.io VPP  v21.10.1-2-g0a485f517
Vector Packet Processing
pipe_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_PIPE_CMDS_H__
17 #define __VOM_PIPE_CMDS_H__
18 
19 #include "vom/dump_cmd.hpp"
20 #include "vom/pipe.hpp"
21 #include "vom/rpc_cmd.hpp"
22 
23 #include <vapi/pipe.api.vapi.hpp>
24 
25 namespace VOM {
26 namespace pipe_cmds {
27 /**
28  * A functor class that creates an interface
29  */
30 class create_cmd : public interface::create_cmd<vapi::Pipe_create>
31 {
32 public:
33  /**
34  * Cstrunctor taking the reference to the parent
35  * and the sub-interface's VLAN
36  */
38  const std::string& name,
39  uint32_t instance,
41 
42  /**
43  * Issue the command to VPP/HW
44  */
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  virtual vapi_error_e operator()(vapi::Pipe_create& reply);
58 
59 private:
61  uint32_t m_instance;
62 };
63 
64 /**
65  * A cmd class that Delete an interface
66  */
67 class delete_cmd : public interface::delete_cmd<vapi::Pipe_delete>
68 {
69 public:
70  /**
71  * Constructor
72  */
74 
75  /**
76  * Issue the command to VPP/HW
77  */
79 
80  /**
81  * convert to string format for debug purposes
82  */
83  std::string to_string() const;
84 
85  /**
86  * Comparison operator - only used for UT
87  */
88  bool operator==(const delete_cmd& i) const;
89 
90 private:
92 };
93 
94 /**
95  * A cmd class that Dumps all the Vpp interfaces
96  */
97 class dump_cmd : public VOM::dump_cmd<vapi::Pipe_dump>
98 {
99 public:
100  /**
101  * Default Constructor
102  */
103  dump_cmd() = default;
104 
105  /**
106  * Issue the command to VPP/HW
107  */
109  /**
110  * convert to string format for debug purposes
111  */
112  std::string to_string() const;
113 
114  /**
115  * Comparison operator - only used for UT
116  */
117  bool operator==(const dump_cmd& i) const;
118 };
119 
120 }; // namespace pipe_cmds
121 }; // namespace VOM
122 
123 /*
124  * fd.io coding-style-patch-verification: OFF
125  *
126  * Local Variables:
127  * eval: (c-set-style "mozilla")
128  * End:
129  */
130 
131 #endif
VOM::pipe_cmds::create_cmd
A functor class that creates an interface.
Definition: pipe_cmds.hpp:30
vapi_error_e
vapi_error_e
Definition: vapi_common.h:25
VOM::HW::item< handle_t >
VOM::pipe_cmds::dump_cmd::issue
rc_t issue(connection &con)
Issue the command to VPP/HW.
Definition: pipe_cmds.cpp:126
VOM
The VPP Object Model (VOM) library.
Definition: acl_binding.cpp:19
name
string name[64]
Definition: fib.api:25
VOM::pipe_cmds::create_cmd::operator()
virtual vapi_error_e operator()(vapi::Pipe_create &reply)
call operator used as a callback by VAPI when the reply is available
Definition: pipe_cmds.cpp:39
con
Connection con
Definition: vapi_cpp_test.cpp:56
VOM::pipe_cmds::dump_cmd
A cmd class that Dumps all the Vpp interfaces.
Definition: pipe_cmds.hpp:97
VOM::interface::delete_cmd
Base class for intterface Delete commands.
Definition: interface.hpp:376
VOM::pipe_cmds::delete_cmd::operator==
bool operator==(const delete_cmd &i) const
Comparison operator - only used for UT.
Definition: pipe_cmds.cpp:92
VOM::pipe_cmds::delete_cmd::delete_cmd
delete_cmd(HW::item< handle_t > &item, HW::item< pipe::handle_pair_t > &end_pair)
Constructor.
Definition: pipe_cmds.cpp:85
VOM::connection
A representation of the connection to VPP.
Definition: connection.hpp:33
VOM::pipe_cmds::create_cmd::issue
rc_t issue(connection &con)
Issue the command to VPP/HW.
Definition: pipe_cmds.cpp:57
pipe.hpp
VOM::interface::create_cmd
A base class for interface Create commands.
Definition: interface.hpp:309
dump_cmd.hpp
VOM::pipe_cmds::dump_cmd::dump_cmd
dump_cmd()=default
Default Constructor.
VOM::rpc_cmd< HW::item< handle_t >, vapi::Pipe_create >::item
HW::item< handle_t > & item()
return the HW item the command updates
Definition: rpc_cmd.hpp:66
VOM::pipe_cmds::create_cmd::operator==
bool operator==(const create_cmd &i) const
Comparison operator - only used for UT.
Definition: pipe_cmds.cpp:33
VOM::pipe_cmds::delete_cmd
A cmd class that Delete an interface.
Definition: pipe_cmds.hpp:67
instance
u32 instance
Definition: gre.api:51
VOM::pipe_cmds::create_cmd::create_cmd
create_cmd(HW::item< handle_t > &item, const std::string &name, uint32_t instance, HW::item< pipe::handle_pair_t > &ends)
Cstrunctor taking the reference to the parent and the sub-interface's VLAN.
Definition: pipe_cmds.cpp:23
i
int i
Definition: flowhash_template.h:376
VOM::pipe_cmds::dump_cmd::operator==
bool operator==(const dump_cmd &i) const
Comparison operator - only used for UT.
Definition: pipe_cmds.cpp:120
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::pipe_cmds::create_cmd::to_string
std::string to_string() const
convert to string format for debug purposes
Definition: pipe_cmds.cpp:76
VOM::pipe_cmds::delete_cmd::to_string
std::string to_string() const
convert to string format for debug purposes
Definition: pipe_cmds.cpp:114
VOM::pipe_cmds::delete_cmd::issue
rc_t issue(connection &con)
Issue the command to VPP/HW.
Definition: pipe_cmds.cpp:98
rpc_cmd.hpp
VOM::pipe_cmds::dump_cmd::to_string
std::string to_string() const
convert to string format for debug purposes
Definition: pipe_cmds.cpp:138
string
const char *const string
Definition: cJSON.h:172