From 15ad172a847fa667c57a4594ef4158405db9a984 Mon Sep 17 00:00:00 2001
From: Angelo Mantellini <angelo.mantellini@cisco.com>
Date: Tue, 31 Mar 2020 17:50:43 +0200
Subject: [HICN-554] hicn-light refactoring
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Change-Id: I36f2d393741d4502ce14d3791158e43e3e9cd4cf
Signed-off-by: Jordan Augé <jordan.auge+fdio@cisco.com>
---
 hicn-light/src/hicn/config/configuration_file.h | 93 +++++++++++++++++++++++++
 1 file changed, 93 insertions(+)
 create mode 100644 hicn-light/src/hicn/config/configuration_file.h

(limited to 'hicn-light/src/hicn/config/configuration_file.h')

diff --git a/hicn-light/src/hicn/config/configuration_file.h b/hicn-light/src/hicn/config/configuration_file.h
new file mode 100644
index 000000000..eedcbc6bd
--- /dev/null
+++ b/hicn-light/src/hicn/config/configuration_file.h
@@ -0,0 +1,93 @@
+/*
+ * Copyright (c) 2017-2019 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 configuration_file.h
+ * @brief Accepts a filename and provides a means to read it into Configuration
+ *
+ * Reads a configuration file and converts the lines in to configuration
+ * commands for use in Configuration.
+ *
+ * Accepts '#' lines as comments.  Skips blank and whitespace-only lines.
+ *
+ */
+
+#ifndef configuration_file_h
+#define configuration_file_h
+
+#include <hicn/core/forwarder.h>
+
+struct configuration_file;
+typedef struct configuration_file configuration_file_t;
+
+/**
+ * Creates a configuration_file_t to prepare to process the file
+ *
+ * Prepares the object and opens the file.  Makes sure we can read the file.
+ * Does not read the file or process any commands from the file.
+ *
+ * @param [in] hicn-light An allocated forwarder_t * to configure with the file
+ * @param [in] filename The file to use
+ *
+ * @retval non-null An allocated configuration_file_t that is readable
+ * @retval null An error
+ *
+ * Example:
+ * @code
+ * <#example#>
+ * @endcode
+ */
+configuration_file_t * configuration_file_create(forwarder_t * forwarder, const
+        char * filename);
+
+/**
+ * Reads the configuration file line-by-line and issues commands to
+ * Configuration
+ *
+ * Reads the file line by line.  Skips '#' and blank lines.
+ *
+ * Will stop on the first error.  Lines already processed will not be un-done.
+ *
+ * @param [in] configFile An allocated configuration_file_t
+ *
+ * @retval true The entire files was processed without error.
+ * @retval false There was an error in the file.
+ *
+ * Example:
+ * @code
+ * <#example#>
+ * @endcode
+ */
+bool configuration_file_process(configuration_file_t *configFile);
+
+// void configuration_file_ProcessForwardingStrategies(Configuration * config,
+// configuration_file_t * configFile);
+
+/**
+ * Closes the underlying file and releases memory
+ *
+ * <#Paragraphs Of Explanation#>
+ *
+ * @param [in,out] configFilePtr An allocated configuration_file_t that will be
+ * NULL'd as output
+ *
+ * Example:
+ * @code
+ * <#example#>
+ * @endcode
+ */
+void configuration_file_free(configuration_file_t * configFile);
+
+#endif /* defined(configuration_file_h) */
-- 
cgit 1.2.3-korg