2 * Copyright (c) 2018 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_IGMP_BINDING_H__
17 #define __VOM_IGMP_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 IGMP binding on an interface
30 class igmp_binding : public object_base
34 * A binding is tied to a given interface, hence its key is
35 * that of the interface
37 typedef interface::key_t key_t;
40 * Construct a new object matching the desried state
42 igmp_binding(const interface& itf);
47 igmp_binding(const igmp_binding& o);
57 bool operator==(const igmp_binding& l) const;
60 * Get the object's key
62 const key_t key() const;
65 * Return the 'singular' of the IGMP binding that matches this object
67 std::shared_ptr<igmp_binding> singular() const;
70 * convert to string format for debug purposes
72 std::string to_string() const;
75 * Return the matching'singular' of the interface
77 std::shared_ptr<interface> itf() const;
80 * Dump all IGMP bindings into the stream provided
82 static void dump(std::ostream& os);
85 * Find a listen from its key
87 static std::shared_ptr<igmp_binding> find(const key_t& k);
91 * Class definition for listeners to OM events
93 class event_handler : public OM::listener, public inspect::command_handler
97 virtual ~event_handler() = default;
100 * Handle a populate event
102 void handle_populate(const client_db::key_t& key);
105 * Handle a replay event
107 void handle_replay();
110 * Show the object in the Singular DB
112 void show(std::ostream& os);
115 * Get the sortable Id of the listener
117 dependency_t order() const;
121 * event_handler to register with OM
123 static event_handler m_evh;
126 * Enquue commonds to the VPP command Q for the update
128 void update(const igmp_binding& obj);
131 * Find or add IGMP binding to the OM
133 static std::shared_ptr<igmp_binding> find_or_add(const igmp_binding& temp);
136 * It's the OM class that calls singular()
141 * It's the singular_db class that calls replay()
143 friend class singular_db<key_t, igmp_binding>;
146 * Sweep/reap the object if still stale
151 * replay the object to create it in hardware
156 * A reference counting pointer to the interface on which IGMP config
157 * resides. By holding the reference here, we can guarantee that
158 * this object will outlive the interface
160 const std::shared_ptr<interface> m_itf;
163 * HW configuration for the binding. The bool representing the
166 HW::item<bool> m_binding;
169 * A map of all IGMP bindings keyed against the interface.
171 static singular_db<key_t, igmp_binding> m_db;
176 * fd.io coding-style-patch-verification: ON
179 * eval: (c-set-style "mozilla")