FD.io VPP  v21.06-3-gbb25fbf28
Vector Packet Processing
lldp_binding_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 lldp_binding_cmds {
22 
24  const handle_t& itf,
25  const std::string& port_desc)
26  : rpc_cmd(item)
27  , m_itf(itf)
28  , m_port_desc(port_desc)
29 {}
30 
31 bool
32 bind_cmd::operator==(const bind_cmd& other) const
33 {
34  return ((m_itf == other.m_itf) && (m_port_desc == other.m_port_desc));
35 }
36 
37 rc_t
39 {
40  msg_t req(con.ctx(), std::ref(*this));
41 
42  auto& payload = req.get_request().get_payload();
43  payload.sw_if_index = m_itf.value();
44  payload.enable = 1;
45 
46  memcpy(payload.port_desc.buf, m_port_desc.c_str(), m_port_desc.length());
47  payload.port_desc.length = m_port_desc.length();
48 
49  VAPI_CALL(req.execute());
50 
51  return (wait());
52 }
53 
56 {
57  std::ostringstream s;
58  s << "Lldp-bind: " << m_hw_item.to_string() << " itf:" << m_itf.to_string()
59  << " port_desc:" << m_port_desc;
60 
61  return (s.str());
62 }
63 
65  : rpc_cmd(item)
66  , m_itf(itf)
67 {}
68 
69 bool
71 {
72  return (m_itf == other.m_itf);
73 }
74 
75 rc_t
77 {
78  msg_t req(con.ctx(), std::ref(*this));
79 
80  auto& payload = req.get_request().get_payload();
81  payload.sw_if_index = m_itf.value();
82  payload.enable = 0;
83 
84  VAPI_CALL(req.execute());
85 
86  wait();
88 
89  return rc_t::OK;
90 }
91 
94 {
95  std::ostringstream s;
96  s << "Lldp-unbind: " << m_hw_item.to_string() << " itf:" << m_itf.to_string();
97 
98  return (s.str());
99 }
100 
101 }; // namespace lldp_binding_cmds
102 }; // namespace VOM
103 
104 /*
105  * fd.io coding-style-patch-verification: OFF
106  *
107  * Local Variables:
108  * eval: (c-set-style "mozilla")
109  * End:
110  */
VOM::lldp_binding_cmds::unbind_cmd::unbind_cmd
unbind_cmd(HW::item< bool > &item, const handle_t &itf)
Constructor.
Definition: lldp_binding_cmds.cpp:64
VOM::HW::item< bool >
VOM::rpc_cmd< HW::item< bool >, vapi::Sw_interface_set_lldp >::wait
rc_t wait()
Wait on the commands promise.
Definition: rpc_cmd.hpp:82
VOM::HW::item::set
void set(const rc_t &rc)
Set the HW return code - should only be called from the family of Command objects.
Definition: hw.hpp:125
VOM
The VPP Object Model (VOM) library.
Definition: acl_binding.cpp:19
VOM::rc_t::OK
const static rc_t OK
The HW write was successfull.
Definition: types.hpp:109
VOM::lldp_binding_cmds::unbind_cmd
A cmd class that Unbinds Lldp Config from an interface.
Definition: lldp_binding_cmds.hpp:70
VOM::handle_t::value
uint32_t value() const
get the value of the handle
Definition: types.cpp:93
VOM::rpc_cmd
A base class for all RPC commands to VPP.
Definition: rpc_cmd.hpp:40
VOM::lldp_binding_cmds::unbind_cmd::issue
rc_t issue(connection &con)
Issue the command to VPP/HW.
Definition: lldp_binding_cmds.cpp:76
con
Connection con
Definition: vapi_cpp_test.cpp:56
DEFINE_VAPI_MSG_IDS_LLDP_API_JSON
DEFINE_VAPI_MSG_IDS_LLDP_API_JSON
Definition: lldp_binding_cmds.cpp:18
lldp_binding_cmds.hpp
VOM::rpc_cmd< HW::item< bool >, vapi::Sw_interface_set_lldp >::m_hw_item
HW::item< bool > & m_hw_item
A reference to an object's HW::item that the command will update.
Definition: rpc_cmd.hpp:134
VAPI_CALL
#define VAPI_CALL(_stmt)
Convenince wrapper macro for error handling in VAPI sends.
Definition: types.hpp:29
VOM::connection
A representation of the connection to VPP.
Definition: connection.hpp:33
VOM::lldp_binding_cmds::bind_cmd::bind_cmd
bind_cmd(HW::item< bool > &item, const handle_t &itf, const std::string &port_desc)
Constructor.
Definition: lldp_binding_cmds.cpp:23
VOM::rc_t::NOOP
const static rc_t NOOP
The HW write/update action was/has not been attempted.
Definition: types.hpp:104
VOM::lldp_binding_cmds::bind_cmd::to_string
std::string to_string() const
convert to string format for debug purposes
Definition: lldp_binding_cmds.cpp:55
VOM::handle_t
A type declaration of an interface handle in VPP.
Definition: types.hpp:233
VOM::HW::item::to_string
std::string to_string() const
convert to string format for debug purposes
Definition: hw.hpp:161
VOM::lldp_binding_cmds::unbind_cmd::to_string
std::string to_string() const
convert to string format for debug purposes
Definition: lldp_binding_cmds.cpp:93
VOM::rpc_cmd< HW::item< bool >, vapi::Sw_interface_set_lldp >::msg_t
vapi::Sw_interface_set_lldp msg_t
convenient typedef
Definition: rpc_cmd.hpp:46
VOM::lldp_binding_cmds::bind_cmd
A command class that binds the LLDP config to the interface.
Definition: lldp_binding_cmds.hpp:31
VOM::handle_t::to_string
std::string to_string() const
convert to string format for debug purposes
Definition: types.cpp:69
VOM::lldp_binding_cmds::bind_cmd::operator==
bool operator==(const bind_cmd &i) const
Comparison operator - only used for UT.
Definition: lldp_binding_cmds.cpp:32
item
cJSON * item
Definition: cJSON.h:222
VOM::lldp_binding_cmds::unbind_cmd::operator==
bool operator==(const unbind_cmd &i) const
Comparison operator - only used for UT.
Definition: lldp_binding_cmds.cpp:70
VOM::rc_t
Error codes that VPP will return during a HW write.
Definition: types.hpp:89
VOM::lldp_binding_cmds::bind_cmd::issue
rc_t issue(connection &con)
Issue the command to VPP/HW.
Definition: lldp_binding_cmds.cpp:38
string
const char *const string
Definition: cJSON.h:172