FD.io VPP  v19.04.4-rc0-5-ge88582fac
Vector Packet Processing
tap_interface_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_TAP_INTERFACE_CMDS_H__
17 #define __VOM_TAP_INTERFACE_CMDS_H__
18 
19 #include "vom/interface.hpp"
20 #include "vom/tap_interface.hpp"
21 #include "vom/dump_cmd.hpp"
22 #include "vom/rpc_cmd.hpp"
23 
24 #include <vapi/interface.api.vapi.hpp>
25 #include <vapi/tapv2.api.vapi.hpp>
26 
27 namespace VOM {
28 namespace tap_interface_cmds {
29 
30 /**
31  * A functor class that creates an interface
32  */
33 class tapv2_create_cmd : public interface::create_cmd<vapi::Tap_create_v2>
34 {
35 public:
37  const std::string& name,
38  const route::prefix_t& prefix,
39  const l2_address_t& l2_address);
40 
41  /**
42  * Issue the command to VPP/HW
43  */
44  rc_t issue(connection& con);
45  /**
46  * convert to string format for debug purposes
47  */
48  std::string to_string() const;
49 
50 private:
51  const route::prefix_t& m_prefix;
52  const l2_address_t& m_l2_address;
53 };
54 
55 /**
56  * A functor class that deletes a Tap interface
57  */
58 class tapv2_delete_cmd : public interface::delete_cmd<vapi::Tap_delete_v2>
59 {
60 public:
62 
63  /**
64  * Issue the command to VPP/HW
65  */
66  rc_t issue(connection& con);
67  /**
68  * convert to string format for debug purposes
69  */
70  std::string to_string() const;
71 };
72 
73 /**
74  * A cmd class that Dumps all the Vpp Interfaces
75  */
76 class tapv2_dump_cmd : public VOM::dump_cmd<vapi::Sw_interface_tap_v2_dump>
77 {
78 public:
79  /**
80  * Default Constructor
81  */
83 
84  /**
85  * Issue the command to VPP/HW
86  */
87  rc_t issue(connection& con);
88  /**
89  * convert to string format for debug purposes
90  */
91  std::string to_string() const;
92 
93  /**
94  * Comparison operator - only used for UT
95  */
96  bool operator==(const tapv2_dump_cmd& i) const;
97 };
98 
99 }; // namespace tap_interface_cmds
100 }; // namespace VOM
101 
102 #endif
A functor class that creates an interface.
int i
Error codes that VPP will return during a HW write.
Definition: types.hpp:89
Type def of a L2 address as read from VPP.
Definition: types.hpp:339
A cmd class that Dumps all the Vpp Interfaces.
std::string to_string() const
convert to string format for debug purposes
A representation of the connection to VPP.
Definition: connection.hpp:33
u8 name[64]
Definition: memclnt.api:152
Base class for intterface Delete commands.
Definition: interface.hpp:371
virtual bool operator==(const create_cmd &o) const
Comparison operator - only used for UT.
Definition: interface.hpp:321
A base class for interface Create commands.
Definition: interface.hpp:304
The VPP Object Model (VOM) library.
Definition: acl_binding.cpp:19
rc_t issue(connection &con)
Issue the command to VPP/HW.
A functor class that deletes a Tap interface.
typedef prefix
Definition: ip_types.api:35
tapv2_create_cmd(HW::item< handle_t > &item, const std::string &name, const route::prefix_t &prefix, const l2_address_t &l2_address)
A base class for VPP dump commands.
Definition: dump_cmd.hpp:43
A prefix defintion.
Definition: prefix.hpp:92
HW::item< handle_t > & item()
return the HW item the command updates
Definition: rpc_cmd.hpp:66