eap::ui_context class for inter-process exchange introduced

2017-02-01 14:23:08 +01:00
parent 386d852859
commit 191e4abd9c
5 changed files with 213 additions and 0 deletions
--- a/lib/EAPBase/include/UIContext.h
+++ b/lib/EAPBase/include/UIContext.h
@@ -0,0 +1,103 @@
+/*
+    Copyright 2015-2017 Amebis
+    Copyright 2016-2017 GÉANT
+
+    This file is part of GÉANTLink.
+
+    GÉANTLink is free software: you can redistribute it and/or modify it
+    under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    GÉANTLink is distributed in the hope that it will be useful, but
+    WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with GÉANTLink. If not, see <http://www.gnu.org/licenses/>.
+*/
+
+namespace eap
+{
+    class ui_context;
+}
+
+#pragma once
+
+#include "Config.h"
+#include "Credentials.h"
+#include "Module.h"
+
+#include "../../../include/Version.h"
+
+
+namespace eap
+{
+    ///
+    /// \defgroup EAPBaseUICtx  UI Context
+    /// Back and front-end inter-process data exchange
+    ///
+    /// @{
+
+    ///
+    /// UI context
+    ///
+    class ui_context : public config
+    {
+    public:
+        ///
+        /// Constructs context
+        ///
+        /// \param[in] mod   EAP module to use for global services
+        /// \param[in] cfg   Connection configuration
+        /// \param[in] cred  Connection credentials
+        ///
+        ui_context(_In_ module &mod, _In_ config_connection &cfg, _In_ credentials_connection &cred);
+
+        ///
+        /// Copies context
+        ///
+        /// \param[in] other  Credentials to copy from
+        ///
+        ui_context(_In_ const ui_context &other);
+
+        ///
+        /// Moves context
+        ///
+        /// \param[in] other  Credentials to move from
+        ///
+        ui_context(_Inout_ ui_context &&other);
+
+        ///
+        /// Copies context
+        ///
+        /// \param[in] other  Credentials to copy from
+        ///
+        /// \returns Reference to this object
+        ///
+        ui_context& operator=(_In_ const ui_context &other);
+
+        ///
+        /// Moves context
+        ///
+        /// \param[in] other  Configuration to move from
+        ///
+        /// \returns Reference to this object
+        ///
+        ui_context& operator=(_Inout_ ui_context &&other);
+
+        /// \name BLOB management
+        /// @{
+        virtual void operator<<(_Inout_ cursor_out &cursor) const;
+        virtual size_t get_pk_size() const;
+        virtual void operator>>(_Inout_ cursor_in &cursor);
+        /// @}
+
+    public:
+        config_connection &m_cfg;       ///< Connection configuration
+        credentials_connection &m_cred; ///< Connection credentials
+    };
+
+    /// @}
+}