FD.io VPP  v19.04.2-12-g66b1689
Vector Packet Processing
l2_emulation_cmds.cpp
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 
17 
19 
20 namespace VOM {
21 namespace l2_emulation_cmds {
23  : rpc_cmd(item)
24  , m_itf(itf)
25 {
26 }
27 
28 bool
30 {
31  return (m_itf == other.m_itf);
32 }
33 
34 rc_t
36 {
37  msg_t req(con.ctx(), std::ref(*this));
38 
39  auto& payload = req.get_request().get_payload();
40  payload.sw_if_index = m_itf.value();
41  payload.enable = 1;
42 
43  VAPI_CALL(req.execute());
44 
45  return (wait());
46 }
47 
48 std::string
50 {
51  std::ostringstream s;
52  s << "L2-emulation-enable: " << m_hw_item.to_string()
53  << " itf:" << m_itf.to_string();
54 
55  return (s.str());
56 }
57 
59  : rpc_cmd(item)
60  , m_itf(itf)
61 {
62 }
63 
64 bool
66 {
67  return (m_itf == other.m_itf);
68 }
69 
70 rc_t
72 {
73  msg_t req(con.ctx(), std::ref(*this));
74 
75  auto& payload = req.get_request().get_payload();
76  payload.sw_if_index = m_itf.value();
77  payload.enable = 0;
78 
79  VAPI_CALL(req.execute());
80 
81  wait();
82 
83  return (rc_t::OK);
84 }
85 
86 std::string
88 {
89  std::ostringstream s;
90  s << "L2-emulation-disable: " << m_hw_item.to_string()
91  << " itf:" << m_itf.to_string();
92 
93  return (s.str());
94 }
95 
96 }; // namespace l2_emulation_cmds
97 }; // namespace VOM
98 
99 /*
100  * fd.io coding-style-patch-verification: ON
101  *
102  * Local Variables:
103  * eval: (c-set-style "mozilla")
104  * End:
105  */
rc_t issue(connection &con)
Issue the command to VPP/HW.
uint32_t value() const
get the value of the handle
Definition: types.cpp:93
disable_cmd(HW::item< bool > &item, const handle_t &itf)
Constructor.
DEFINE_VAPI_MSG_IDS_L2E_API_JSON
Error codes that VPP will return during a HW write.
Definition: types.hpp:89
std::string to_string() const
convert to string format for debug purposes
Definition: hw.hpp:161
rc_t wait()
Wait on the commands promise.
Definition: rpc_cmd.hpp:82
std::string to_string() const
convert to string format for debug purposes
Definition: types.cpp:69
A representation of the connection to VPP.
Definition: connection.hpp:33
std::string to_string() const
convert to string format for debug purposes
std::string to_string() const
convert to string format for debug purposes
enable_cmd(HW::item< bool > &item, const handle_t &itf)
Constructor.
A base class for all RPC commands to VPP.
Definition: rpc_cmd.hpp:40
#define VAPI_CALL(_stmt)
Convenince wrapper macro for error handling in VAPI sends.
Definition: types.hpp:29
bool operator==(const enable_cmd &i) const
Comparison operator - only used for UT.
A type declaration of an interface handle in VPP.
Definition: types.hpp:233
A functor class that enable L2 emulation to an interface.
static const rc_t OK
The HW write was successfull.
Definition: types.hpp:109
vapi::Connection & ctx()
Retrun the VAPI context the commands will use.
Definition: connection.cpp:49
The VPP Object Model (VOM) library.
Definition: acl_binding.cpp:19
rc_t issue(connection &con)
Issue the command to VPP/HW.
bool operator==(const disable_cmd &i) const
Comparison operator - only used for UT.
A cmd class that Unbinds L2 configuration from an interface.
HW::item< bool > & m_hw_item
A reference to an object&#39;s HW::item that the command will update.
Definition: rpc_cmd.hpp:134
HW::item< bool > & item()
return the HW item the command updates
Definition: rpc_cmd.hpp:66
vapi::L2_emulation msg_t
convenient typedef
Definition: rpc_cmd.hpp:46