FD.io VPP  v19.01.3-6-g70449b9b9
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 
32 bool
33 bind_cmd::operator==(const bind_cmd& other) const
34 {
35  return ((m_itf == other.m_itf) && (m_port_desc == other.m_port_desc));
36 }
37 
38 rc_t
40 {
41  msg_t req(con.ctx(), std::ref(*this));
42 
43  auto& payload = req.get_request().get_payload();
44  payload.sw_if_index = m_itf.value();
45  payload.enable = 1;
46 
47  memcpy(payload.port_desc, m_port_desc.c_str(),
48  std::min(sizeof(payload.port_desc), m_port_desc.length()));
49 
50  VAPI_CALL(req.execute());
51 
52  return (wait());
53 }
54 
55 std::string
57 {
58  std::ostringstream s;
59  s << "Lldp-bind: " << m_hw_item.to_string() << " itf:" << m_itf.to_string()
60  << " port_desc:" << m_port_desc;
61 
62  return (s.str());
63 }
64 
66  : rpc_cmd(item)
67  , m_itf(itf)
68 {
69 }
70 
71 bool
73 {
74  return (m_itf == other.m_itf);
75 }
76 
77 rc_t
79 {
80  msg_t req(con.ctx(), std::ref(*this));
81 
82  auto& payload = req.get_request().get_payload();
83  payload.sw_if_index = m_itf.value();
84  payload.enable = 0;
85 
86  VAPI_CALL(req.execute());
87 
88  wait();
90 
91  return rc_t::OK;
92 }
93 
94 std::string
96 {
97  std::ostringstream s;
98  s << "Lldp-unbind: " << m_hw_item.to_string() << " itf:" << m_itf.to_string();
99 
100  return (s.str());
101 }
102 
103 }; // namespace lldp_binding_cmds
104 }; // namespace VOM
105 
106 /*
107  * fd.io coding-style-patch-verification: ON
108  *
109  * Local Variables:
110  * eval: (c-set-style "mozilla")
111  * End:
112  */
static const rc_t NOOP
The HW write/update action was/has not been attempted.
Definition: types.hpp:104
std::string to_string() const
convert to string format for debug purposes
uint32_t value() const
get the value of the handle
Definition: types.cpp:93
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
bool operator==(const unbind_cmd &i) const
Comparison operator - only used for UT.
A representation of the connection to VPP.
Definition: connection.hpp:33
bool operator==(const bind_cmd &i) const
Comparison operator - only used for UT.
unbind_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
bind_cmd(HW::item< bool > &item, const handle_t &itf, const std::string &port_desc)
Constructor.
DEFINE_VAPI_MSG_IDS_LLDP_API_JSON
A cmd class that Unbinds Lldp Config from an interface.
std::string to_string() const
convert to string format for debug purposes
Definition: types.cpp:69
A type declaration of an interface handle in VPP.
Definition: types.hpp:233
static const rc_t OK
The HW write was successfull.
Definition: types.hpp:109
A command class that binds the LLDP config to the interface.
vapi::Connection & ctx()
Retrun the VAPI context the commands will use.
Definition: connection.cpp:49
rc_t issue(connection &con)
Issue the command to VPP/HW.
The VPP Object Model (VOM) library.
Definition: acl_binding.cpp:19
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
rc_t issue(connection &con)
Issue the command to VPP/HW.
std::string to_string() const
convert to string format for debug purposes
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::Sw_interface_set_lldp msg_t
convenient typedef
Definition: rpc_cmd.hpp:46