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_DHCP_CONFIG_H__
17 #define __VOM_DHCP_CONFIG_H__
20 #include "vom/inspect.hpp"
21 #include "vom/interface.hpp"
22 #include "vom/object_base.hpp"
24 #include "vom/singular_db.hpp"
27 namespace dhcp_config_cmds {
31 * A representation of DHCP client configuration on an interface
33 class dhcp_config : public object_base
37 * typedef for the DHCP config key type
39 typedef interface::key_t key_t;
42 * Construct a new object matching the desried state
44 dhcp_config(const interface& itf, const std::string& hostname);
47 * Construct a new object matching the desried state
49 dhcp_config(const interface& itf,
50 const std::string& hostname,
51 const l2_address_t& client_id);
56 dhcp_config(const dhcp_config& o);
64 * Comparison operator - for UT
66 bool operator==(const dhcp_config& d) const;
69 * Return the object's key
71 const key_t& key() const;
74 * Return the 'singular' of the DHCP config that matches this object
76 std::shared_ptr<dhcp_config> singular() const;
79 * convert to string format for debug purposes
81 std::string to_string() const;
84 * Dump all DHCP configs into the stream provided
86 static void dump(std::ostream& os);
89 * Find a DHCP config from its key
91 static std::shared_ptr<dhcp_config> find(const key_t& k);
94 * A class that listens to DHCP Events
105 * listener's virtual function invoked when a DHCP event is
108 virtual void handle_dhcp_event(dhcp_config_cmds::events_cmd* cmd) = 0;
111 * Return the HW::item associated with this command
113 HW::item<bool>& status();
117 * The HW::item associated with this command
119 HW::item<bool> m_status;
124 * Class definition for listeners to OM events
126 class event_handler : public OM::listener, public inspect::command_handler
130 virtual ~event_handler() = default;
133 * Handle a populate event
135 void handle_populate(const client_db::key_t& key);
138 * Handle a replay event
140 void handle_replay();
143 * Show the object in the Singular DB
145 void show(std::ostream& os);
148 * Get the sortable Id of the listener
150 dependency_t order() const;
154 * event_handler to register with OM
156 static event_handler m_evh;
159 * Enquue commonds to the VPP command Q for the update
161 void update(const dhcp_config& obj);
164 * Find or add DHCP config to the OM
166 static std::shared_ptr<dhcp_config> find_or_add(const dhcp_config& temp);
169 * It's the OM class that calls singular()
174 * It's the singular_db class that calls replay()
176 friend class singular_db<key_t, dhcp_config>;
179 * Sweep/reap the object if still stale
184 * replay the object to create it in hardware
189 * A reference counting pointer to the interface on which DHCP config
190 * resides. By holding the reference here, we can guarantee that
191 * this object will outlive the interface
193 const std::shared_ptr<interface> m_itf;
196 * The hostname in the DHCP configuration
198 const std::string m_hostname;
201 * The option-61 client_id in the DHCP configuration
203 const l2_address_t m_client_id;
206 * HW configuration for the binding. The bool representing the
209 HW::item<bool> m_binding;
212 * A map of all Dhcp configs keyed against the interface.
214 static singular_db<key_t, dhcp_config> m_db;
219 * fd.io coding-style-patch-verification: ON
222 * eval: (c-set-style "mozilla")