diff options
Diffstat (limited to 'src/vpp-api/vom/dhcp_config.hpp')
-rw-r--r-- | src/vpp-api/vom/dhcp_config.hpp | 234 |
1 files changed, 0 insertions, 234 deletions
diff --git a/src/vpp-api/vom/dhcp_config.hpp b/src/vpp-api/vom/dhcp_config.hpp deleted file mode 100644 index 8ea608d809d..00000000000 --- a/src/vpp-api/vom/dhcp_config.hpp +++ /dev/null @@ -1,234 +0,0 @@ -/* - * Copyright (c) 2017 Cisco and/or its affiliates. - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at: - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -#ifndef __VOM_DHCP_CONFIG_H__ -#define __VOM_DHCP_CONFIG_H__ - -#include "vom/hw.hpp" -#include "vom/inspect.hpp" -#include "vom/interface.hpp" -#include "vom/object_base.hpp" -#include "vom/om.hpp" -#include "vom/singular_db.hpp" - -namespace VOM { -namespace dhcp_config_cmds { -class events_cmd; -}; -/** - * A representation of DHCP client configuration on an interface - */ -class dhcp_config : public object_base -{ -public: - /** - * typedef for the DHCP config key type - */ - typedef interface::key_t key_t; - - /** - * Construct a new object matching the desried state - */ - dhcp_config(const interface& itf, - const std::string& hostname, - bool set_broadcast_flag = true); - - /** - * Construct a new object matching the desried state - */ - dhcp_config(const interface& itf, - const std::string& hostname, - const l2_address_t& client_id, - bool set_broadcast_flag = true); - - /** - * Copy Constructor - */ - dhcp_config(const dhcp_config& o); - - /** - * Destructor - */ - ~dhcp_config(); - - /** - * Comparison operator - for UT - */ - bool operator==(const dhcp_config& d) const; - - /** - * Return the object's key - */ - const key_t& key() const; - - /** - * Return the 'singular' of the DHCP config that matches this object - */ - std::shared_ptr<dhcp_config> singular() const; - - /** - * convert to string format for debug purposes - */ - std::string to_string() const; - - /** - * Dump all DHCP configs into the stream provided - */ - static void dump(std::ostream& os); - - /** - * Find a DHCP config from its key - */ - static std::shared_ptr<dhcp_config> find(const key_t& k); - - /** - * A class that listens to DHCP Events - */ - class event_listener - { - public: - /** - * Constructor - */ - event_listener(); - - /** - * listener's virtual function invoked when a DHCP event is - * available to read - */ - virtual void handle_dhcp_event(dhcp_config_cmds::events_cmd* cmd) = 0; - - /** - * Return the HW::item associated with this command - */ - HW::item<bool>& status(); - - protected: - /** - * The HW::item associated with this command - */ - HW::item<bool> m_status; - }; - -private: - /** - * Class definition for listeners to OM events - */ - class event_handler : public OM::listener, public inspect::command_handler - { - public: - event_handler(); - virtual ~event_handler() = default; - - /** - * Handle a populate event - */ - void handle_populate(const client_db::key_t& key); - - /** - * Handle a replay event - */ - void handle_replay(); - - /** - * Show the object in the Singular DB - */ - void show(std::ostream& os); - - /** - * Get the sortable Id of the listener - */ - dependency_t order() const; - }; - - /** - * event_handler to register with OM - */ - static event_handler m_evh; - - /** - * Enquue commonds to the VPP command Q for the update - */ - void update(const dhcp_config& obj); - - /** - * Find or add DHCP config to the OM - */ - static std::shared_ptr<dhcp_config> find_or_add(const dhcp_config& temp); - - /* - * It's the OM class that calls singular() - */ - friend class OM; - - /** - * It's the singular_db class that calls replay() - */ - friend class singular_db<key_t, dhcp_config>; - - /** - * Sweep/reap the object if still stale - */ - void sweep(void); - - /** - * replay the object to create it in hardware - */ - void replay(void); - - /** - * A reference counting pointer to the interface on which DHCP config - * resides. By holding the reference here, we can guarantee that - * this object will outlive the interface - */ - const std::shared_ptr<interface> m_itf; - - /** - * The hostname in the DHCP configuration - */ - const std::string m_hostname; - - /** - * The option-61 client_id in the DHCP configuration - */ - const l2_address_t m_client_id; - - /** - * Flag to control the setting the of DHCP discover's broadcast flag - */ - const bool m_set_broadcast_flag; - - /** - * HW configuration for the binding. The bool representing the - * do/don't bind. - */ - HW::item<bool> m_binding; - - /** - * A map of all Dhcp configs keyed against the interface. - */ - static singular_db<key_t, dhcp_config> m_db; -}; -}; - -/* - * fd.io coding-style-patch-verification: ON - * - * Local Variables: - * eval: (c-set-style "mozilla") - * End: - */ - -#endif |