FD.io VPP  v21.10.1-2-g0a485f517
Vector Packet Processing
l2_emulation_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_L2_EMULATION_CMDS_H__
17 #define __VOM_L2_EMULATION_CMDS_H__
18 
19 #include "vom/l2_emulation.hpp"
20 #include "vom/rpc_cmd.hpp"
21 
22 #include <vapi/l2e.api.vapi.hpp>
23 
24 namespace VOM {
25 namespace l2_emulation_cmds {
26 
27 /**
28  * A functor class that enable L2 emulation to an interface
29  */
30 class enable_cmd : public rpc_cmd<HW::item<bool>, vapi::L2_emulation>
31 {
32 public:
33  /**
34  * Constructor
35  */
36  enable_cmd(HW::item<bool>& item, const handle_t& itf);
37 
38  /**
39  * Issue the command to VPP/HW
40  */
42  /**
43  * convert to string format for debug purposes
44  */
45  std::string to_string() const;
46 
47  /**
48  * Comparison operator - only used for UT
49  */
50  bool operator==(const enable_cmd& i) const;
51 
52 private:
53  /**
54  * The interface to bind
55  */
56  const handle_t m_itf;
57 };
58 
59 /**
60  * A cmd class that Unbinds L2 configuration from an interface
61  */
62 class disable_cmd : public rpc_cmd<HW::item<bool>, vapi::L2_emulation>
63 {
64 public:
65  /**
66  * Constructor
67  */
69 
70  /**
71  * Issue the command to VPP/HW
72  */
74  /**
75  * convert to string format for debug purposes
76  */
77  std::string to_string() const;
78 
79  /**
80  * Comparison operator - only used for UT
81  */
82  bool operator==(const disable_cmd& i) const;
83 
84 private:
85  /**
86  * The interface to bind
87  */
88  const handle_t m_itf;
89 };
90 
91 }; // namespace l2_emulation_cmds
92 }; // namespace VOM
93 
94 /*
95  * fd.io coding-style-patch-verification: OFF
96  *
97  * Local Variables:
98  * eval: (c-set-style "mozilla")
99  * End:
100  */
101 
102 #endif
VOM::HW::item< bool >
VOM
The VPP Object Model (VOM) library.
Definition: acl_binding.cpp:19
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
l2_emulation.hpp
VOM::connection
A representation of the connection to VPP.
Definition: connection.hpp:33
VOM::l2_emulation_cmds::disable_cmd::disable_cmd
disable_cmd(HW::item< bool > &item, const handle_t &itf)
Constructor.
Definition: l2_emulation_cmds.cpp:58
VOM::handle_t
A type declaration of an interface handle in VPP.
Definition: types.hpp:233
VOM::l2_emulation_cmds::enable_cmd
A functor class that enable L2 emulation to an interface.
Definition: l2_emulation_cmds.hpp:30
VOM::l2_emulation_cmds::disable_cmd::to_string
std::string to_string() const
convert to string format for debug purposes
Definition: l2_emulation_cmds.cpp:87
VOM::rpc_cmd< HW::item< bool >, vapi::L2_emulation >::item
HW::item< bool > & item()
return the HW item the command updates
Definition: rpc_cmd.hpp:66
VOM::l2_emulation_cmds::enable_cmd::to_string
std::string to_string() const
convert to string format for debug purposes
Definition: l2_emulation_cmds.cpp:49
VOM::l2_emulation_cmds::disable_cmd
A cmd class that Unbinds L2 configuration from an interface.
Definition: l2_emulation_cmds.hpp:62
VOM::l2_emulation_cmds::enable_cmd::enable_cmd
enable_cmd(HW::item< bool > &item, const handle_t &itf)
Constructor.
Definition: l2_emulation_cmds.cpp:22
VOM::l2_emulation_cmds::disable_cmd::operator==
bool operator==(const disable_cmd &i) const
Comparison operator - only used for UT.
Definition: l2_emulation_cmds.cpp:65
VOM::l2_emulation_cmds::enable_cmd::issue
rc_t issue(connection &con)
Issue the command to VPP/HW.
Definition: l2_emulation_cmds.cpp:35
i
int i
Definition: flowhash_template.h:376
VOM::l2_emulation_cmds::disable_cmd::issue
rc_t issue(connection &con)
Issue the command to VPP/HW.
Definition: l2_emulation_cmds.cpp:71
VOM::rc_t
Error codes that VPP will return during a HW write.
Definition: types.hpp:89
VOM::l2_emulation_cmds::enable_cmd::operator==
bool operator==(const enable_cmd &i) const
Comparison operator - only used for UT.
Definition: l2_emulation_cmds.cpp:29
rpc_cmd.hpp
string
const char *const string
Definition: cJSON.h:172