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_BRIDGE_DOMAIN_H__
17 #define __VOM_BRIDGE_DOMAIN_H__
19 #include "vom/enum_base.hpp"
21 #include "vom/inspect.hpp"
22 #include "vom/object_base.hpp"
24 #include "vom/singular_db.hpp"
28 * A base class for all object_base in the VPP object_base-Model.
29 * provides the abstract interface.
31 class bridge_domain : public object_base
35 * The value of the defaultbridge domain
37 const static uint32_t DEFAULT_TABLE = 0;
40 * Construct a new object matching the desried state
42 bridge_domain(uint32_t id);
46 bridge_domain(const bridge_domain& o);
53 * Return the matchin 'singular' instance of the bridge-domain
55 std::shared_ptr<bridge_domain> singular() const;
58 * convert to string format for debug purposes
60 std::string to_string(void) const;
63 * Return VPP's handle for this obejct
68 * Static function to find the bridge_domain in the model
70 static std::shared_ptr<bridge_domain> find(uint32_t id);
73 * Dump all bridge-doamin into the stream provided
75 static void dump(std::ostream& os);
79 * Class definition for listeners to OM events
81 class event_handler : public OM::listener, public inspect::command_handler
85 virtual ~event_handler() = default;
88 * Handle a populate event
90 void handle_populate(const client_db::key_t& key);
93 * Handle a replay event
98 * Show the object in the Singular DB
100 void show(std::ostream& os);
103 * Get the sortable Id of the listener
105 dependency_t order() const;
109 * Instance of the event handler to register with OM
111 static event_handler m_evh;
114 * Commit the acculmulated changes into VPP. i.e. to a 'HW" write.
116 void update(const bridge_domain& obj);
119 * Find or add an singular of a Bridge-Domain in the object_base Model
121 static std::shared_ptr<bridge_domain> find_or_add(const bridge_domain& temp);
124 * It's the OM class that calls singular()
129 * It's the singular_db class that calls replay()
131 friend class singular_db<uint32_t, bridge_domain>;
134 * Sweep/reap the object if still stale
139 * replay the object to create it in hardware
144 * The ID we assign to this BD and the HW result in VPP
146 HW::item<uint32_t> m_id;
149 * A map of all interfaces key against the interface's name
151 static singular_db<uint32_t, bridge_domain> m_db;
156 * fd.io coding-style-patch-verification: ON
159 * eval: (c-set-style "mozilla")