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_NEIGHBOUR_H__
17 #define __VOM_NEIGHBOUR_H__
19 #include "vom/interface.hpp"
20 #include "vom/singular_db.hpp"
21 #include "vom/types.hpp"
25 * A entry in the neighbour entry (ARP or IPv6 ND)
27 class neighbour : public object_base
31 * The key for a neighbour entry;
32 * the interface and IP address
34 typedef std::pair<interface::key_t, boost::asio::ip::address> key_t;
37 * Construct an ARP entry
39 neighbour(const interface& itf,
40 const boost::asio::ip::address& ip_addr,
41 const mac_address_t& mac);
46 neighbour(const neighbour& r);
54 * Return the object's key
56 const key_t key() const;
61 bool operator==(const neighbour& n) const;
64 * Return the matching 'singular instance'
66 std::shared_ptr<neighbour> singular() const;
69 * Find the neighbour fromits key
71 static std::shared_ptr<neighbour> find(const key_t& k);
74 * Dump all neighbours into the stream provided
76 static void dump(std::ostream& os);
79 * replay the object to create it in hardware
84 * Convert to string for debugging
86 std::string to_string() const;
90 * Class definition for listeners to OM events
92 class event_handler : public OM::listener, public inspect::command_handler
96 virtual ~event_handler() = default;
99 * Handle a populate event
101 void handle_populate(const client_db::key_t& key);
104 * Handle a replay event
106 void handle_replay();
109 * Show the object in the Singular DB
111 void show(std::ostream& os);
114 * Get the sortable Id of the listener
116 dependency_t order() const;
120 * event_handler to register with OM
122 static event_handler m_evh;
125 * Commit the acculmulated changes into VPP. i.e. to a 'HW" write.
127 void update(const neighbour& obj);
130 * Do the populate work
132 static void populate_i(const client_db::key_t& key,
133 std::shared_ptr<interface> itf,
134 const l3_proto_t& proto);
137 * Find or add the instnace of the neighbour in the OM
139 static std::shared_ptr<neighbour> find_or_add(const neighbour& temp);
142 * It's the VPPHW class that updates the objects in HW
147 * It's the singular_db class that calls replay()
149 friend class singular_db<key_t, neighbour>;
152 * Sweep/reap the object if still stale
157 * HW configuration for the result of creating the bridge_domain
162 * The bridge_domain domain the bridge_domain is in.
164 std::shared_ptr<interface> m_itf;
169 boost::asio::ip::address m_ip_addr;
177 * A map of all bridge_domains
179 static singular_db<key_t, neighbour> m_db;
182 std::ostream& operator<<(std::ostream& os, const neighbour::key_t& key);
186 * fd.io coding-style-patch-verification: ON
189 * eval: (c-set-style "mozilla")