FD.io VPP  v20.09-64-g4f7b92f0a
Vector Packet Processing
igmp_binding_cmds.cpp
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2018 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 
18 namespace VOM {
19 namespace igmp_binding_cmds {
20 
22  : rpc_cmd(item)
23  , m_itf(itf)
24 {
25 }
26 
27 bool
28 bind_cmd::operator==(const bind_cmd& other) const
29 {
30  return (m_itf == other.m_itf);
31 }
32 
33 rc_t
35 {
36  msg_t req(con.ctx(), std::ref(*this));
37 
38  auto& payload = req.get_request().get_payload();
39  payload.sw_if_index = m_itf.value();
40  payload.enable = 1;
41  payload.mode = 1;
42 
43  VAPI_CALL(req.execute());
44 
45  return (wait());
46 }
47 
48 std::string
50 {
51  std::ostringstream s;
52  s << "igmp-bind: " << m_hw_item.to_string() << " itf:" << m_itf.to_string();
53 
54  return (s.str());
55 }
56 
58  : rpc_cmd(item)
59  , m_itf(itf)
60 {
61 }
62 
63 bool
65 {
66  return (m_itf == other.m_itf);
67 }
68 
69 rc_t
71 {
72  msg_t req(con.ctx(), std::ref(*this));
73 
74  auto& payload = req.get_request().get_payload();
75  payload.sw_if_index = m_itf.value();
76  payload.enable = 0;
77  payload.mode = 1;
78 
79  VAPI_CALL(req.execute());
80 
81  wait();
83 
84  return rc_t::OK;
85 }
86 
87 std::string
89 {
90  std::ostringstream s;
91  s << "igmp-unbind: " << m_hw_item.to_string() << " itf:" << m_itf.to_string();
92 
93  return (s.str());
94 }
95 
96 }; // namespace igmp_binding_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  */
static const rc_t NOOP
The HW write/update action was/has not been attempted.
Definition: types.hpp:104
uint32_t value() const
get the value of the handle
Definition: types.cpp:93
rc_t issue(connection &con)
Issue the command to VPP/HW.
bool operator==(const unbind_cmd &i) const
Comparison operator - only used for UT.
Error codes that VPP will return during a HW write.
Definition: types.hpp:89
A command class that binds the IGMP config to the interface.
bind_cmd(HW::item< bool > &item, const handle_t &itf)
Constructor.
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: hw.hpp:161
bool operator==(const bind_cmd &i) const
Comparison operator - only used for UT.
A representation of the connection to VPP.
Definition: connection.hpp:33
std::string to_string() const
convert to string format for debug purposes
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
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 cmd class that Unbinds IGMP Config from an interface.
vapi::Connection & ctx()
Retrun the VAPI context the commands will use.
Definition: connection.cpp:49
std::string to_string() const
convert to string format for debug purposes
The VPP Object Model (VOM) library.
Definition: acl_binding.cpp:19
unbind_cmd(HW::item< bool > &item, const handle_t &itf)
Constructor.
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.
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::Igmp_enable_disable msg_t
convenient typedef
Definition: rpc_cmd.hpp:46