FD.io VPP  v19.04.1-1-ge4a0f9f
Vector Packet Processing
neighbour_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_NEIGHBOUR_CMDS_H__
17 #define __VOM_NEIGHBOUR_CMDS_H__
18 
19 #include "vom/dump_cmd.hpp"
20 #include "neighbour.hpp"
21 
22 #include <vapi/ip.api.vapi.hpp>
23 
24 namespace VOM {
25 namespace neighbour_cmds {
26 
27 /**
28  * A command class that creates or updates the bridge domain ARP Entry
29  */
30 class create_cmd : public rpc_cmd<HW::item<bool>,
31  vapi::Ip_neighbor_add_del>
32 {
33 public:
34  /**
35  * Constructor
36  */
38  handle_t itf,
39  const mac_address_t& mac,
40  const boost::asio::ip::address& ip_addr,
41  const neighbour::flags_t &flags);
42 
43  /**
44  * Issue the command to VPP/HW
45  */
46  rc_t issue(connection& con);
47 
48  /**
49  * convert to string format for debug purposes
50  */
51  std::string to_string() const;
52 
53  /**
54  * Comparison operator - only used for UT
55  */
56  bool operator==(const create_cmd& i) const;
57 
58 private:
59  handle_t m_itf;
60  mac_address_t m_mac;
61  boost::asio::ip::address m_ip_addr;
62  const neighbour::flags_t &m_flags;
63 };
64 
65 /**
66  * A cmd class that deletes a bridge domain ARP entry
67  */
68 class delete_cmd : public rpc_cmd<HW::item<bool>,
69  vapi::Ip_neighbor_add_del>
70 {
71 public:
72  /**
73  * Constructor
74  */
76  handle_t itf,
77  const mac_address_t& mac,
78  const boost::asio::ip::address& ip_addr,
79  const neighbour::flags_t &flags);
80 
81  /**
82  * Issue the command to VPP/HW
83  */
84  rc_t issue(connection& con);
85 
86  /**
87  * convert to string format for debug purposes
88  */
89  std::string to_string() const;
90 
91  /**
92  * Comparison operator - only used for UT
93  */
94  bool operator==(const delete_cmd& i) const;
95 
96 private:
97  handle_t m_itf;
98  mac_address_t m_mac;
99  boost::asio::ip::address m_ip_addr;
100  const neighbour::flags_t &m_flags;
101 };
102 
103 /**
104  * A cmd class that Dumps all the neighbours
105  */
106 class dump_cmd : public VOM::dump_cmd<vapi::Ip_neighbor_dump>
107 {
108 public:
109  /**
110  * Constructor
111  */
112  dump_cmd(const handle_t& itf, const l3_proto_t& proto);
113  dump_cmd(const dump_cmd& d);
114 
115  /**
116  * Issue the command to VPP/HW
117  */
118  rc_t issue(connection& con);
119  /**
120  * convert to string format for debug purposes
121  */
122  std::string to_string() const;
123 
124  /**
125  * Comparison operator - only used for UT
126  */
127  bool operator==(const dump_cmd& i) const;
128 
129 private:
130  /**
131  * HW reutrn code
132  */
134 
135  /**
136  * The interface to dump
137  */
138  handle_t m_itf;
139 
140  /**
141  * V4 or V6
142  */
143  l3_proto_t m_proto;
144 };
145 
146 }; // namespace neighbour_cmds
147 }; // namespace vom
148 #endif
149 
typedef address
Definition: ip_types.api:30
u32 flags
Definition: vhost_user.h:115
A cmd class that deletes a bridge domain ARP entry.
int i
Error codes that VPP will return during a HW write.
Definition: types.hpp:89
create_cmd(HW::item< bool > &item, handle_t itf, const mac_address_t &mac, const boost::asio::ip::address &ip_addr, const neighbour::flags_t &flags)
Constructor.
An L3 protocol can be used to construct a prefix that is used to match packets are part of a route...
Definition: prefix.hpp:52
bool operator==(const create_cmd &i) const
Comparison operator - only used for UT.
rc_t issue(connection &con)
Issue the command to VPP/HW.
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 type declaration of an interface handle in VPP.
Definition: types.hpp:233
A cmd class that Dumps all the neighbours.
The VPP Object Model (VOM) library.
Definition: acl_binding.cpp:19
A command class that creates or updates the bridge domain ARP Entry.
Type def of a Ethernet address.
Definition: types.hpp:295
vl_api_mac_address_t mac
Definition: gbp.api:120
A base class for VPP dump commands.
Definition: dump_cmd.hpp:43
HW::item< bool > & item()
return the HW item the command updates
Definition: rpc_cmd.hpp:66