FD.io VPP  v19.04.1-1-ge4a0f9f
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 #include "vom/dump_cmd.hpp"
21 
22 #include <vapi/ip.api.vapi.hpp>
23 
24 namespace VOM {
25 namespace arp_proxy_binding_cmds {
26 /**
27  * A command class that binds the LLDP config to the interface
28  */
29 class bind_cmd
30  : public rpc_cmd<HW::item<bool>, vapi::Proxy_arp_intfc_enable_disable>
31 {
32 public:
33  /**
34  * Constructor
35  */
36  bind_cmd(HW::item<bool>& item, const handle_t& itf);
37 
38  /**
39  * Issue the command to VPP/HW
40  */
41  rc_t issue(connection& con);
42  /**
43  * convert to string format for debug purposes
44  */
45  std::string to_string() const;
46 
47  /**
48  * Comparison operator - only used for UT
49  */
50  bool operator==(const bind_cmd& i) const;
51 
52 private:
53  /**
54  * Reference to the HW::item of the interface to bind
55  */
56  const handle_t& m_itf;
57 };
58 
59 /**
60  * A cmd class that Unbinds ArpProxy Config from an interface
61  */
63  : public rpc_cmd<HW::item<bool>, vapi::Proxy_arp_intfc_enable_disable>
64 {
65 public:
66  /**
67  * Constructor
68  */
69  unbind_cmd(HW::item<bool>& item, const handle_t& itf);
70 
71  /**
72  * Issue the command to VPP/HW
73  */
74  rc_t issue(connection& con);
75  /**
76  * convert to string format for debug purposes
77  */
78  std::string to_string() const;
79 
80  /**
81  * Comparison operator - only used for UT
82  */
83  bool operator==(const unbind_cmd& i) const;
84 
85 private:
86  /**
87  * Reference to the HW::item of the interface to unbind
88  */
89  const handle_t& m_itf;
90 };
91 
92 /**
93  * A cmd class that Dumps all the Proxy ARP configs
94  */
95 class dump_cmd : public VOM::dump_cmd<vapi::Proxy_arp_intfc_dump>
96 {
97 public:
98  /**
99  * Constructor
100  */
101  dump_cmd() = default;
102 
103  /**
104  * Issue the command to VPP/HW
105  */
106  rc_t issue(connection& con);
107  /**
108  * convert to string format for debug purposes
109  */
110  std::string to_string() const;
111 
112  /**
113  * Comparison operator - only used for UT
114  */
115  bool operator==(const dump_cmd& i) const;
116 
117 private:
118  /**
119  * HW reutrn code
120  */
122 };
123 
124 }; // namespace cmds
125 }; // namespace VOM
126 
127 /*
128  * fd.io coding-style-patch-verification: ON
129  *
130  * Local Variables:
131  * eval: (c-set-style "mozilla")
132  * End:
133  */
134 
135 #endif
int i
Error codes that VPP will return during a HW write.
Definition: types.hpp:89
bind_cmd(HW::item< bool > &item, const handle_t &itf)
Constructor.
A cmd class that Dumps all the Proxy ARP configs.
A representation of the connection to VPP.
Definition: connection.hpp:33
A base class for all RPC commands to VPP.
Definition: rpc_cmd.hpp:40
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:233
A command class that binds the LLDP config to the interface.
The VPP Object Model (VOM) library.
Definition: acl_binding.cpp:19
A base class for VPP dump commands.
Definition: dump_cmd.hpp:43
rc_t issue(connection &con)
Issue the command to VPP/HW.
HW::item< bool > & item()
return the HW item the command updates
Definition: rpc_cmd.hpp:66