misc: deprecate VOM
[vpp.git] / extras / vom / vom / lldp_global.hpp
diff --git a/extras/vom/vom/lldp_global.hpp b/extras/vom/vom/lldp_global.hpp
deleted file mode 100644 (file)
index f545a28..0000000
+++ /dev/null
@@ -1,183 +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_LLDP_GLOBAL_H__
-#define __VOM_LLDP_GLOBAL_H__
-
-#include "vom/hw.hpp"
-#include "vom/inspect.hpp"
-#include "vom/object_base.hpp"
-#include "vom/om.hpp"
-#include "vom/singular_db.hpp"
-
-namespace VOM {
-/**
- * A representation of LLDP global configuration
- */
-class lldp_global : public object_base
-{
-public:
-  /**
-   * The key for the global conifugration is the 'system' namse
-   */
-  typedef std::string key_t;
-
-  /**
-   * Construct a new object matching the desried state
-   */
-  lldp_global(const std::string& system_name,
-              uint32_t tx_hold,
-              uint32_t tx_interval);
-
-  /**
-   * Copy Constructor
-   */
-  lldp_global(const lldp_global& o);
-
-  /**
-   * Destructor
-   */
-  ~lldp_global();
-
-  /**
-   * Get this objects key
-   */
-  const key_t& key() const;
-
-  /**
-   * Comparison operator
-   */
-  bool operator==(const lldp_global& l) const;
-
-  /**
-   * Return the 'singular' of the LLDP global that matches this object
-   */
-  std::shared_ptr<lldp_global> singular() const;
-
-  /**
-   * convert to string format for debug purposes
-   */
-  std::string to_string() const;
-
-  /**
-   * Dump all LLDP globals into the stream provided
-   */
-  static void dump(std::ostream& os);
-
-  /**
-   * Find LLDP global config from its key
-   */
-  static std::shared_ptr<lldp_global> 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 lldp_global& obj);
-
-  /**
-   * Find or add LLDP global to the OM
-   */
-  static std::shared_ptr<lldp_global> find_or_add(const lldp_global& 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, lldp_global>;
-
-  /**
-   * Sweep/reap the object if still stale
-   */
-  void sweep(void);
-
-  /**
-   * replay the object to create it in hardware
-   */
-  void replay(void);
-
-  /**
-   * The system name
-   */
-  const std::string m_system_name;
-
-  /**
-   * TX timer configs
-   */
-  uint32_t m_tx_hold;
-  uint32_t m_tx_interval;
-
-  /**
-   * HW globaluration for the binding. The bool representing the
-   * do/don't bind.
-   */
-  HW::item<bool> m_binding;
-
-  /**
-   * A map of all Lldp globals keyed against the system name.
-   *  there needs to be some sort of key, that will do.
-   */
-  static singular_db<key_t, lldp_global> m_db;
-};
-};
-
-/*
- * fd.io coding-style-patch-verification: ON
- *
- * Local Variables:
- * eval: (c-set-style "mozilla")
- * End:
- */
-
-#endif