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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
16 #ifndef __VOM_TAP_INTERFACE_H__
17 #define __VOM_TAP_INTERFACE_H__
19 #include "vom/interface.hpp"
23 * A tap-interface. e.g. a tap interface
25 class tap_interface : public interface
28 tap_interface(const std::string& name,
30 route::prefix_t prefix);
32 tap_interface(const std::string& name,
34 route::prefix_t prefix,
35 const l2_address_t& l2_address);
38 tap_interface(const tap_interface& o);
41 * Return the matching 'singular instance' of the TAP interface
43 std::shared_ptr<tap_interface> singular() const;
46 * A functor class that creates an interface
48 class create_cmd : public interface::create_cmd<vapi::Tap_connect>
51 create_cmd(HW::item<handle_t>& item,
52 const std::string& name,
53 route::prefix_t& prefix,
54 const l2_address_t& l2_address);
57 * Issue the command to VPP/HW
59 rc_t issue(connection& con);
61 * convert to string format for debug purposes
63 std::string to_string() const;
66 route::prefix_t& m_prefix;
67 const l2_address_t& m_l2_address;
73 class delete_cmd : public interface::delete_cmd<vapi::Tap_delete>
76 delete_cmd(HW::item<handle_t>& item);
79 * Issue the command to VPP/HW
81 rc_t issue(connection& con);
83 * convert to string format for debug purposes
85 std::string to_string() const;
89 * A cmd class that Dumps all the Vpp Interfaces
91 class dump_cmd : public VOM::dump_cmd<vapi::Sw_interface_tap_dump>
100 * Issue the command to VPP/HW
102 rc_t issue(connection& con);
104 * convert to string format for debug purposes
106 std::string to_string() const;
109 * Comparison operator - only used for UT
111 bool operator==(const dump_cmd& i) const;
116 * Class definition for listeners to OM events
118 class event_handler : public OM::listener, public inspect::command_handler
122 virtual ~event_handler() = default;
125 * Handle a populate event
127 void handle_populate(const client_db::key_t& key);
130 * Handle a replay event
132 void handle_replay();
135 * Show the object in the Singular DB
137 void show(std::ostream& os);
140 * Get the sortable Id of the listener
142 dependency_t order() const;
144 static event_handler m_evh;
147 * Construct with a handle
149 tap_interface(const handle_t& hdl,
150 const std::string& name,
152 route::prefix_t prefix);
157 route::prefix_t m_prefix;
159 l2_address_t m_l2_address;
162 * interface is a friend so it can construct with handles
164 friend class interface;
167 * Return the matching 'instance' of the sub-interface
168 * over-ride from the base class
170 std::shared_ptr<interface> singular_i() const;
173 * Virtual functions to construct an interface create commands.
175 virtual std::queue<cmd*>& mk_create_cmd(std::queue<cmd*>& cmds);
178 * Virtual functions to construct an interface delete commands.
180 virtual std::queue<cmd*>& mk_delete_cmd(std::queue<cmd*>& cmds);
183 * It's the OM class that call singular()
190 * fd.io coding-style-patch-verification: ON
193 * eval: (c-set-style "mozilla")