misc: deprecate VOM

[vpp.git] / extras / deprecated / vom / vom / tap_interface.hpp

diff --git a/extras/deprecated/vom/vom/tap_interface.hpp b/extras/deprecated/vom/vom/tap_interface.hpp
new file mode 100644 (file)
index 0000000..b167810
--- /dev/null
+++ b/extras/deprecated/vom/vom/tap_interface.hpp
@@ -0,0 +1,118 @@
+/*
+ * 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_TAP_INTERFACE_H__
+#define __VOM_TAP_INTERFACE_H__
+
+#include "vom/interface.hpp"
+
+namespace VOM {
+/**
+ * A tap-interface. e.g. a tap interface
+ */
+class tap_interface : public interface
+{
+public:
+  tap_interface(const std::string& name,
+                const admin_state_t& state,
+                const route::prefix_t& prefix);
+
+  tap_interface(const std::string& name,
+                const admin_state_t& state,
+                const route::prefix_t& prefix,
+                const l2_address_t& l2_address);
+
+  ~tap_interface();
+  tap_interface(const tap_interface& o);
+
+  /**
+   * Return the matching 'singular instance' of the TAP interface
+   */
+  std::shared_ptr<tap_interface> singular() const;
+
+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;
+  };
+  static event_handler m_evh;
+
+  /**
+   * host Ip Prefix
+   */
+  route::prefix_t m_prefix;
+
+  /**
+   * host mac address
+   */
+  l2_address_t m_l2_address;
+
+  /**
+   * Return the matching 'instance' of the sub-interface
+   *  over-ride from the base class
+   */
+  std::shared_ptr<interface> singular_i() const;
+
+  /**
+   * Virtual functions to construct an interface create commands.
+   */
+  virtual std::queue<cmd*>& mk_create_cmd(std::queue<cmd*>& cmds);
+
+  /**
+   * Virtual functions to construct an interface delete commands.
+   */
+  virtual std::queue<cmd*>& mk_delete_cmd(std::queue<cmd*>& cmds);
+
+  /*
+   * It's the OM class that call singular()
+   */
+  friend class OM;
+};
+}
+
+/*
+ * fd.io coding-style-patch-verification: OFF
+ *
+ * Local Variables:
+ * eval: (c-set-style "mozilla")
+ * End:
+ */
+
+#endif