define the configuration to handle communication settings

2021-08-10 08:42:36 +02:00
parent 81edcdcea2
commit 3c4acffbb9
2 changed files with 37 additions and 0 deletions
--- a/include/aman/types/Communication.h
+++ b/include/aman/types/Communication.h
@@ -0,0 +1,33 @@
+/*
+ * @brief Defines the communication configuration
+ * @file aman/types/Communication.h
+ * @author Sven Czarnian <devel@svcz.de>
+ * @copyright Copyright 2021 Sven Czarnian
+ * @license This project is published under the GNU General Public License v3 (GPLv3)
+ */
+
+#pragma once
+
+#include <string>
+
+namespace aman {
+    /**
+     * @brief Defines the communication structure
+     * @ingroup types
+     */
+    struct Communication {
+        bool          valid;      /**< Marks if the configuration is valid */
+        std::string   url;        /**< The URL of the backend */
+        std::uint16_t port;       /**< The port of the backend */
+        std::string   identifier; /**< The user's identifier for the connection */
+
+        /**
+         * @brief Initializes an invalid configuration
+         */
+        Communication() :
+                valid(false),
+                url(),
+                port(0),
+                identifier() { }
+    };
+}