From c580a00aac271a524e5a75b35f4b91c174ed227b Mon Sep 17 00:00:00 2001
From: michele papalini <micpapal+fdio@cisco.com>
Date: Thu, 23 Feb 2017 17:01:34 +0100
Subject: Initial commit: sb-forwarder, metis.

Change-Id: I65ee3c851a6901929ef4417ad80d34bca0dce445
Signed-off-by: michele papalini <micpapal+fdio@cisco.com>
---
 .../metis/config/metis_CommandLineInterface.h      | 80 ++++++++++++++++++++++
 1 file changed, 80 insertions(+)
 create mode 100644 metis/ccnx/forwarder/metis/config/metis_CommandLineInterface.h

(limited to 'metis/ccnx/forwarder/metis/config/metis_CommandLineInterface.h')

diff --git a/metis/ccnx/forwarder/metis/config/metis_CommandLineInterface.h b/metis/ccnx/forwarder/metis/config/metis_CommandLineInterface.h
new file mode 100644
index 00000000..f4ab85dc
--- /dev/null
+++ b/metis/ccnx/forwarder/metis/config/metis_CommandLineInterface.h
@@ -0,0 +1,80 @@
+/*
+ * 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.
+ */
+
+/**
+ * @file metis_CommandLineInterface.h
+ * @brief A telnet-like server for management interface
+ *
+ *
+ * We do not start the CLI until metisCommandLineInterface_Start() is called.  This allows us to always create it in
+ * metisForwarder_Create(), but not bind the port until needed.  Binding the port in metisForwarder_Create()
+ * causes severe issues in rapid execution of unit tests.
+ *
+ *
+ */
+
+#ifndef Metis_metis_CommandLineInterface_h
+#define Metis_metis_CommandLineInterface_h
+
+#include <ccnx/forwarder/metis/core/metis_Forwarder.h>
+
+struct metis_command_line_interface;
+typedef struct metis_command_line_interface MetisCommandLineInterface;
+
+/**
+ * Creates a CLI on the given port.
+ *
+ *   A telnet-style interface.  Creating it will not bind the port or start
+ *   the service.  You need to call <code>metisCli_Start()</code>
+ *
+ * @param port the command port, in host byte order
+ *
+ * @return NULL if cannot be created on the port
+ *
+ * Example:
+ * @code
+ * <#example#>
+ * @endcode
+ */
+MetisCommandLineInterface *metisCommandLineInterface_Create(MetisForwarder *metis, uint16_t port);
+
+/**
+ * Stops and destroys the CLI.  Existing sessions are destroyed.
+ *
+ *   <#Discussion#>
+ *
+ * @param cliPtr
+ *
+ * Example:
+ * @code
+ * <#example#>
+ * @endcode
+ */
+void metisCommandLineInterface_Destroy(MetisCommandLineInterface **cliPtr);
+
+/*
+ * Binds the port and starts the CLI service
+ *
+ *   <#Discussion#>
+ *
+ * @param cli
+ *
+ * Example:
+ * @code
+ * <#example#>
+ * @endcode
+ */
+void metisCommandLineInterface_Start(MetisCommandLineInterface *cli);
+#endif // Metis_metis_CommandLineInterface_h
-- 
cgit 1.2.3-korg