From 812ed39f9da336310e815c361ab5a9f118657d94 Mon Sep 17 00:00:00 2001
From: Neale Ranns <neale.ranns@cisco.com>
Date: Mon, 16 Oct 2017 04:20:13 -0700
Subject: VPP Object Model (VOM)

The VOM is a C++ library for use by clients/agents of VPP for programming
state. It uses the binary APIs to do so. Various other common client side
functions are also provided. Please see om.hpp for a more detailed description.

Change-Id: Ib756bfe99817093815a9e26ccf464aa5583fc523
Signed-off-by: Neale Ranns <neale.ranns@cisco.com>
Co-authored-by: Mohsin Kazmi <sykazmi@cisco.com>
---
 src/vpp-api/vom/connection.hpp | 76 ++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 76 insertions(+)
 create mode 100644 src/vpp-api/vom/connection.hpp

(limited to 'src/vpp-api/vom/connection.hpp')

diff --git a/src/vpp-api/vom/connection.hpp b/src/vpp-api/vom/connection.hpp
new file mode 100644
index 00000000000..0dc01845eb8
--- /dev/null
+++ b/src/vpp-api/vom/connection.hpp
@@ -0,0 +1,76 @@
+/*
+ * 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_CONNECTION_H__
+#define __VOM_CONNECTION_H__
+
+#include <string>
+
+#include <vapi/vapi.hpp>
+
+namespace VOM {
+/**
+ * A representation of the connection to VPP
+ */
+class connection
+{
+public:
+  /**
+   * Constructor
+   */
+  connection();
+  /**
+   * Destructor
+   */
+  ~connection();
+
+  /**
+   * Blocking [re]connect call - always eventually succeeds, or the
+   * universe expires. Not much this system can do without one.
+   */
+  void connect();
+
+  /**
+   * Blocking disconnect
+   */
+  void disconnect();
+
+  /**
+   * Retrun the VAPI context the commands will use
+   */
+  vapi::Connection& ctx();
+
+private:
+  /**
+   * The VAPI connection context
+   */
+  vapi::Connection m_vapi_conn;
+
+  /**
+   * The name of this application
+   */
+  const std::string m_app_name;
+};
+};
+
+/*
+ * fd.io coding-style-patch-verification: ON
+ *
+ * Local Variables:
+ * eval: (c-set-style "mozilla")
+ * End:
+ */
+
+#endif
-- 
cgit 1.2.3-korg