FD.io VPP  v18.04-17-g3a0d853
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  m_hw_item.set(wait());
46 
47  return (rc_t::OK);
48 }
49 
50 std::string
52 {
53  std::ostringstream s;
54  s << "L2-emulation-enable: " << m_hw_item.to_string()
55  << " itf:" << m_itf.to_string();
56 
57  return (s.str());
58 }
59 
61  : rpc_cmd(item)
62  , m_itf(itf)
63 {
64 }
65 
66 bool
68 {
69  return (m_itf == other.m_itf);
70 }
71 
72 rc_t
74 {
75  msg_t req(con.ctx(), std::ref(*this));
76 
77  auto& payload = req.get_request().get_payload();
78  payload.sw_if_index = m_itf.value();
79  payload.enable = 0;
80 
81  VAPI_CALL(req.execute());
82 
83  wait();
84 
85  return (rc_t::OK);
86 }
87 
88 std::string
90 {
91  std::ostringstream s;
92  s << "L2-emulation-disable: " << m_hw_item.to_string()
93  << " itf:" << m_itf.to_string();
94 
95  return (s.str());
96 }
97 
98 }; // namespace l2_emulation_cmds
99 }; // namespace VOM
100 
101 /*
102  * fd.io coding-style-patch-verification: ON
103  *
104  * Local Variables:
105  * eval: (c-set-style "mozilla")
106  * End:
107  */
HW::item< bool > & m_hw_item
A reference to an object&#39;s HW::item that the command will update.
Definition: rpc_cmd.hpp:135
rc_t issue(connection &con)
Issue the command to VPP/HW.
uint32_t value() const
get the value of the handle
Definition: types.cpp:96
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:90
std::string to_string() const
convert to string format for debug purposes
Definition: hw.hpp:160
std::string to_string() const
convert to string format for debug purposes
Definition: types.cpp:72
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.
HW::item< bool > & item()
return the HW item the command updates
Definition: rpc_cmd.hpp:64
A base class for all RPC commands to VPP.
Definition: rpc_cmd.hpp:38
#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:236
A functor class that enable L2 emulation to an interface.
static const rc_t OK
The HW write was successfull.
Definition: types.hpp:112
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.
void set(const rc_t &rc)
Set the HW return code - should only be called from the family of Command objects.
Definition: hw.hpp:124
bool operator==(const disable_cmd &i) const
Comparison operator - only used for UT.
vapi::L2_emulation msg_t
convenient typedef
Definition: rpc_cmd.hpp:44
A cmd class that Unbinds L2 configuration from an interface.
rc_t wait()
Wait on the commands promise.
Definition: rpc_cmd.hpp:89