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_LLDP_BINDING_H__
17 #define __VOM_LLDP_BINDING_H__
20 #include "vom/inspect.hpp"
21 #include "vom/interface.hpp"
22 #include "vom/object_base.hpp"
24 #include "vom/singular_db.hpp"
28 * A representation of LLDP client configuration on an interface
30 class lldp_binding : public object_base
34 * Construct a new object matching the desried state
36 lldp_binding(const interface& itf, const std::string& hostname);
41 lldp_binding(const lldp_binding& o);
48 * Return the 'singular' of the LLDP binding that matches this object
50 std::shared_ptr<lldp_binding> singular() const;
53 * convert to string format for debug purposes
55 std::string to_string() const;
58 * Dump all LLDP bindings into the stream provided
60 static void dump(std::ostream& os);
64 * Class definition for listeners to OM events
66 class event_handler : public OM::listener, public inspect::command_handler
70 virtual ~event_handler() = default;
73 * Handle a populate event
75 void handle_populate(const client_db::key_t& key);
78 * Handle a replay event
83 * Show the object in the Singular DB
85 void show(std::ostream& os);
88 * Get the sortable Id of the listener
90 dependency_t order() const;
94 * event_handler to register with OM
96 static event_handler m_evh;
99 * Enquue commonds to the VPP command Q for the update
101 void update(const lldp_binding& obj);
104 * Find or add LLDP binding to the OM
106 static std::shared_ptr<lldp_binding> find_or_add(const lldp_binding& temp);
109 * It's the OM class that calls singular()
114 * It's the singular_db class that calls replay()
116 friend class singular_db<interface::key_type, lldp_binding>;
119 * Sweep/reap the object if still stale
124 * replay the object to create it in hardware
129 * A reference counting pointer to the interface on which LLDP config
130 * resides. By holding the reference here, we can guarantee that
131 * this object will outlive the interface
133 const std::shared_ptr<interface> m_itf;
136 * The port-description in the LLDP configuration
138 const std::string m_port_desc;
141 * HW configuration for the binding. The bool representing the
144 HW::item<bool> m_binding;
147 * A map of all Lldp bindings keyed against the interface.
149 static singular_db<interface::key_type, lldp_binding> m_db;
154 * fd.io coding-style-patch-verification: ON
157 * eval: (c-set-style "mozilla")