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,
45 const std::string& hostname,
46 bool set_broadcast_flag = true);
49 * Construct a new object matching the desried state
51 dhcp_config(const interface& itf,
52 const std::string& hostname,
53 const l2_address_t& client_id,
54 bool set_broadcast_flag = true);
59 dhcp_config(const dhcp_config& o);
67 * Comparison operator - for UT
69 bool operator==(const dhcp_config& d) const;
72 * Return the object's key
74 const key_t& key() const;
77 * Return the 'singular' of the DHCP config that matches this object
79 std::shared_ptr<dhcp_config> singular() const;
82 * convert to string format for debug purposes
84 std::string to_string() const;
87 * Dump all DHCP configs into the stream provided
89 static void dump(std::ostream& os);
92 * Find a DHCP config from its key
94 static std::shared_ptr<dhcp_config> find(const key_t& k);
97 * A class that listens to DHCP Events
108 * listener's virtual function invoked when a DHCP event is
111 virtual void handle_dhcp_event(dhcp_config_cmds::events_cmd* cmd) = 0;
114 * Return the HW::item associated with this command
116 HW::item<bool>& status();
120 * The HW::item associated with this command
122 HW::item<bool> m_status;
127 * Class definition for listeners to OM events
129 class event_handler : public OM::listener, public inspect::command_handler
133 virtual ~event_handler() = default;
136 * Handle a populate event
138 void handle_populate(const client_db::key_t& key);
141 * Handle a replay event
143 void handle_replay();
146 * Show the object in the Singular DB
148 void show(std::ostream& os);
151 * Get the sortable Id of the listener
153 dependency_t order() const;
157 * event_handler to register with OM
159 static event_handler m_evh;
162 * Enquue commonds to the VPP command Q for the update
164 void update(const dhcp_config& obj);
167 * Find or add DHCP config to the OM
169 static std::shared_ptr<dhcp_config> find_or_add(const dhcp_config& temp);
172 * It's the OM class that calls singular()
177 * It's the singular_db class that calls replay()
179 friend class singular_db<key_t, dhcp_config>;
182 * Sweep/reap the object if still stale
187 * replay the object to create it in hardware
192 * A reference counting pointer to the interface on which DHCP config
193 * resides. By holding the reference here, we can guarantee that
194 * this object will outlive the interface
196 const std::shared_ptr<interface> m_itf;
199 * The hostname in the DHCP configuration
201 const std::string m_hostname;
204 * The option-61 client_id in the DHCP configuration
206 const l2_address_t m_client_id;
209 * Flag to control the setting the of DHCP discover's broadcast flag
211 const bool m_set_broadcast_flag;
214 * HW configuration for the binding. The bool representing the
217 HW::item<bool> m_binding;
220 * A map of all Dhcp configs keyed against the interface.
222 static singular_db<key_t, dhcp_config> m_db;
227 * fd.io coding-style-patch-verification: ON
230 * eval: (c-set-style "mozilla")