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,
29 const admin_state_t& state,
30 const route::prefix_t& prefix);
32 tap_interface(const std::string& name,
33 const admin_state_t& state,
34 const 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;
47 * Class definition for listeners to OM events
49 class event_handler : public OM::listener, public inspect::command_handler
53 virtual ~event_handler() = default;
56 * Handle a populate event
58 void handle_populate(const client_db::key_t& key);
61 * Handle a replay event
66 * Show the object in the Singular DB
68 void show(std::ostream& os);
71 * Get the sortable Id of the listener
73 dependency_t order() const;
75 static event_handler m_evh;
80 route::prefix_t m_prefix;
85 l2_address_t m_l2_address;
88 * Return the matching 'instance' of the sub-interface
89 * over-ride from the base class
91 std::shared_ptr<interface> singular_i() const;
94 * Virtual functions to construct an interface create commands.
96 virtual std::queue<cmd*>& mk_create_cmd(std::queue<cmd*>& cmds);
99 * Virtual functions to construct an interface delete commands.
101 virtual std::queue<cmd*>& mk_delete_cmd(std::queue<cmd*>& cmds);
104 * It's the OM class that call singular()
111 * fd.io coding-style-patch-verification: ON
114 * eval: (c-set-style "mozilla")