diff options
Diffstat (limited to 'src/vpp-api/vom/l3_binding.hpp')
-rw-r--r-- | src/vpp-api/vom/l3_binding.hpp | 214 |
1 files changed, 0 insertions, 214 deletions
diff --git a/src/vpp-api/vom/l3_binding.hpp b/src/vpp-api/vom/l3_binding.hpp deleted file mode 100644 index 0177e56ea2b..00000000000 --- a/src/vpp-api/vom/l3_binding.hpp +++ /dev/null @@ -1,214 +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_L3_BINDING_H__ -#define __VOM_L3_BINDING_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 { -/** - * A representation of L3 configuration on an interface - */ -class l3_binding : public object_base -{ -public: - /** - * The key type for l3_bindings - */ - typedef std::pair<interface::key_t, route::prefix_t> key_t; - - /** - * Construct a new object matching the desried state - */ - l3_binding(const interface& itf, const route::prefix_t& pfx); - - /** - * Copy Constructor - */ - l3_binding(const l3_binding& o); - - /** - * Destructor - */ - ~l3_binding(); - - /** - * Comparison operator - */ - bool operator==(const l3_binding& l) const; - - /** - * Get the object's key - */ - const key_t key() const; - - /** - * The iterator type - */ - typedef singular_db<key_t, l3_binding>::const_iterator const_iterator_t; - - static const_iterator_t cbegin(); - static const_iterator_t cend(); - - /** - * Return the 'singular instance' of the L3-Config that matches this - * object - */ - std::shared_ptr<l3_binding> singular() const; - - /** - * convert to string format for debug purposes - */ - std::string to_string() const; - - /** - * Return the prefix associated with this L3 binding - */ - const route::prefix_t& prefix() const; - - /** - * Return the interface associated with this L3 binding - */ - const interface& itf() const; - - /** - * Dump all l3_bindings into the stream provided - */ - static void dump(std::ostream& os); - - /** - * Find all bindings in the DB for the interface passed - */ - static std::deque<std::shared_ptr<l3_binding>> find(const interface& i); - - /** - * Find a binding from its key - */ - static std::shared_ptr<l3_binding> find(const key_t& k); - -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 l3_binding& obj); - - /** - * Find or add the singular instance in the DB - */ - static std::shared_ptr<l3_binding> find_or_add(const l3_binding& temp); - - /* - * It's the VPPHW class that updates the objects in HW - */ - friend class OM; - - /** - e* It's the singular_db class that calls replay() - */ - friend class singular_db<key_t, l3_binding>; - - /** - * Sweep/reap the object if still stale - */ - void sweep(void); - - /** - * replay the object to create it in hardware - */ - void replay(void); - - friend class interface; - - /** - * A reference counting pointer the interface that this L3 layer - * represents. By holding the reference here, we can guarantee that - * this object will outlive the interface - */ - const std::shared_ptr<interface> m_itf; - - /** - * The prefix for this L3 configuration - */ - const route::prefix_t m_pfx; - - /** - * HW configuration for the binding. The bool representing the - * do/don't bind. - */ - HW::item<bool> m_binding; - - /** - * A map of all L3 configs keyed against a combination of the interface - * and subnet's keys. - */ - static singular_db<key_t, l3_binding> m_db; -}; - -/** - * Ostream output for the key - */ -std::ostream& operator<<(std::ostream& os, const l3_binding::key_t& key); -}; - -/* - * fd.io coding-style-patch-verification: ON - * - * Local Variables: - * eval: (c-set-style "mozilla") - * End: - */ - -#endif |