FD.io VPP  v18.04-17-g3a0d853
Vector Packet Processing
arp_proxy_binding_cmds.hpp
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 
16 #ifndef __VOM_ARP_PROXY_BINDING_CMDS_H__
17 #define __VOM_ARP_PROXY_BINDING_CMDS_H__
18 
20 
21 #include <vapi/vpe.api.vapi.hpp>
22 
23 namespace VOM {
24 namespace arp_proxy_binding_cmds {
25 /**
26  * A command class that binds the LLDP config to the interface
27  */
28 class bind_cmd
29  : public rpc_cmd<HW::item<bool>, rc_t, vapi::Proxy_arp_intfc_enable_disable>
30 {
31 public:
32  /**
33  * Constructor
34  */
35  bind_cmd(HW::item<bool>& item, const handle_t& itf);
36 
37  /**
38  * Issue the command to VPP/HW
39  */
40  rc_t issue(connection& con);
41  /**
42  * convert to string format for debug purposes
43  */
44  std::string to_string() const;
45 
46  /**
47  * Comparison operator - only used for UT
48  */
49  bool operator==(const bind_cmd& i) const;
50 
51 private:
52  /**
53  * Reference to the HW::item of the interface to bind
54  */
55  const handle_t& m_itf;
56 };
57 
58 /**
59  * A cmd class that Unbinds ArpProxy Config from an interface
60  */
62  : public rpc_cmd<HW::item<bool>, rc_t, vapi::Proxy_arp_intfc_enable_disable>
63 {
64 public:
65  /**
66  * Constructor
67  */
68  unbind_cmd(HW::item<bool>& item, const handle_t& itf);
69 
70  /**
71  * Issue the command to VPP/HW
72  */
73  rc_t issue(connection& con);
74  /**
75  * convert to string format for debug purposes
76  */
77  std::string to_string() const;
78 
79  /**
80  * Comparison operator - only used for UT
81  */
82  bool operator==(const unbind_cmd& i) const;
83 
84 private:
85  /**
86  * Reference to the HW::item of the interface to unbind
87  */
88  const handle_t& m_itf;
89 };
90 };
91 };
92 
93 /*
94  * fd.io coding-style-patch-verification: ON
95  *
96  * Local Variables:
97  * eval: (c-set-style "mozilla")
98  * End:
99  */
100 
101 #endif
int i
Error codes that VPP will return during a HW write.
Definition: types.hpp:90
bind_cmd(HW::item< bool > &item, const handle_t &itf)
Constructor.
A representation of the connection to VPP.
Definition: connection.hpp:33
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
std::string to_string() const
convert to string format for debug purposes
A cmd class that Unbinds ArpProxy Config from an interface.
bool operator==(const bind_cmd &i) const
Comparison operator - only used for UT.
A type declaration of an interface handle in VPP.
Definition: types.hpp:236
A command class that binds the LLDP config to the interface.
The VPP Object Model (VOM) library.
Definition: acl_binding.cpp:19
rc_t issue(connection &con)
Issue the command to VPP/HW.