FD.io VPP  v20.09-64-g4f7b92f0a
Vector Packet Processing
tap_interface.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_H__
17 #define __VOM_TAP_INTERFACE_H__
18 
19 #include "vom/interface.hpp"
20 
21 namespace VOM {
22 /**
23  * A tap-interface. e.g. a tap interface
24  */
25 class tap_interface : public interface
26 {
27 public:
28  tap_interface(const std::string& name,
29  const admin_state_t& state,
30  const route::prefix_t& prefix);
31 
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);
36 
38  tap_interface(const tap_interface& o);
39 
40  /**
41  * Return the matching 'singular instance' of the TAP interface
42  */
43  std::shared_ptr<tap_interface> singular() const;
44 
45 private:
46  /**
47  * Class definition for listeners to OM events
48  */
50  {
51  public:
52  event_handler();
53  virtual ~event_handler() = default;
54 
55  /**
56  * Handle a populate event
57  */
58  void handle_populate(const client_db::key_t& key);
59 
60  /**
61  * Handle a replay event
62  */
63  void handle_replay();
64 
65  /**
66  * Show the object in the Singular DB
67  */
68  void show(std::ostream& os);
69 
70  /**
71  * Get the sortable Id of the listener
72  */
73  dependency_t order() const;
74  };
75  static event_handler m_evh;
76 
77  /**
78  * host Ip Prefix
79  */
80  route::prefix_t m_prefix;
81 
82  /**
83  * host mac address
84  */
85  l2_address_t m_l2_address;
86 
87  /**
88  * Return the matching 'instance' of the sub-interface
89  * over-ride from the base class
90  */
91  std::shared_ptr<interface> singular_i() const;
92 
93  /**
94  * Virtual functions to construct an interface create commands.
95  */
96  virtual std::queue<cmd*>& mk_create_cmd(std::queue<cmd*>& cmds);
97 
98  /**
99  * Virtual functions to construct an interface delete commands.
100  */
101  virtual std::queue<cmd*>& mk_delete_cmd(std::queue<cmd*>& cmds);
102 
103  /*
104  * It's the OM class that call singular()
105  */
106  friend class OM;
107 };
108 }
109 
110 /*
111  * fd.io coding-style-patch-verification: ON
112  *
113  * Local Variables:
114  * eval: (c-set-style "mozilla")
115  * End:
116  */
117 
118 #endif
A tap-interface.
const std::string key_t
In the opflex world each entity is known by a URI which can be converted into a string.
Definition: client_db.hpp:51
vl_api_prefix_t prefix
Definition: ip.api:144
const l2_address_t & l2_address() const
Return the L2 Address.
Definition: interface.cpp:158
Type def of a L2 address as read from VPP.
Definition: types.hpp:339
const std::string & name() const
Return the interface type.
Definition: interface.cpp:271
The admin state of the interface.
Definition: interface.hpp:138
A representation of an interface in VPP.
Definition: interface.hpp:41
Class definition for listeners to OM events.
Definition: om.hpp:284
inspect command handler Handler
Definition: inspect.hpp:54
void event_handler(void *tls_async)
Definition: tls_async.c:334
dependency_t
There needs to be a strict order in which object types are read from VPP (at boot time) and replayed ...
Definition: types.hpp:43
The interface to writing objects into VPP OM.
Definition: om.hpp:140
tap_interface(const std::string &name, const admin_state_t &state, const route::prefix_t &prefix)
Construct a new object matching the desried state.
The VPP Object Model (VOM) library.
Definition: acl_binding.cpp:19
void show(char *chroot_path, int verbose)
Definition: svmtool.c:105
vl_api_dhcp_client_state_t state
Definition: dhcp.api:201
const key_t & key() const
Return the interface type.
Definition: interface.cpp:277
std::shared_ptr< tap_interface > singular() const
Return the matching &#39;singular instance&#39; of the TAP interface.
A prefix defintion.
Definition: prefix.hpp:131