Added support for MessagePack

The ASIO based network classes can now serialize and deserialize network messages using MessagePack. MessagePack 7.0.0 is included with Core

Author: dac1976

.vscode/launch.json

@@ -21,9 +21,9 @@
       "request": "launch",
       "program": "${input:unitTestProgramWin}",
       "args": [
-        "--gtest_filter=AsioTest.testCase_TestSimpleSync_Large",
-        "--gtest_break_on_failure",
-        "--gtest_catch_exceptions=0"
+        //"--gtest_filter=",
+        //"--gtest_break_on_failure",
+        //"--gtest_catch_exceptions=0"
       ],
       "cwd": "${workspaceFolder}",
       "console": "integratedTerminal"
@@ -34,9 +34,9 @@
       "request": "launch",
       "program": "${input:unitTestProgramLinux}",
       "args": [
-        "--gtest_filter=",
-        "--gtest_break_on_failure",
-        "--gtest_catch_exceptions=0"
+        //"--gtest_filter=",
+        // "--gtest_break_on_failure",
+        // "--gtest_catch_exceptions=0"
       ],
       "cwd": "${workspaceFolder}",
       "MIMode": "gdb",

Include/Serialization/SerializeToVector.h

@@ -38,8 +38,9 @@
 #include <span>
 #include <boost/throw_exception.hpp>
 #include <cereal/types/vector.hpp>
+#include <msgpack/msgpack.hpp>
 #if defined(USE_FLATBUFFERS)
-#include "flatbuffers/flatbuffers.h"
+#include <flatbuffers/flatbuffers.h>
 #endif
 
 #define SERIALIZE_TO_STREAM_ARCHIVE(osa, o) osa(CEREAL_NVP(o))
@@ -79,6 +80,16 @@ struct CORE_LIBRARY_DLL_SHARED_API protobuf_oarchive
 {
 };
 
+/*! \brief In archive placeholder struct for serializing MessagePack. */
+struct CORE_LIBRARY_DLL_SHARED_API msgpack_iarchive
+{
+};
+
+/*! \brief Out archive placeholder struct for serializing MessagePack. */
+struct CORE_LIBRARY_DLL_SHARED_API msgpack_oarchive
+{
+};
+
 /*! \brief The archives namespace. */
 namespace archives
 {
@@ -94,6 +105,8 @@ using out_json_t = cereal::JSONOutputArchive;
 using out_raw_t = raw_oarchive;
 /*! \brief Typedef to output using Google protocol buffers. */
 using out_protobuf_t = protobuf_oarchive;
+/*! \brief Typedef to output using MessagePack. */
+using out_msgpack_t = msgpack_oarchive;
 /*! \brief Typedef to input portable binary archive. */
 using in_port_bin_t = cereal::PortableBinaryInputArchive;
 /*! \brief Typedef to input binary archive. */
@@ -106,6 +119,8 @@ using in_json_t = cereal::JSONInputArchive;
 using in_raw_t = raw_iarchive;
 /*! \brief Typedef to input using Google protocol buffers. */
 using in_protobuf_t = protobuf_iarchive;
+/*! \brief Typedef to input using MessagePack. */
+using in_msgpack_t = msgpack_iarchive;
 
 } // namespace archives
 
@@ -252,6 +267,41 @@ template <typename T> struct ToCharVectorImpl<T, archives::out_protobuf_t>
     }
 };
 
+/*! \brief Serialization to char vector implementation, specialization for Messagepack bufs. */
+template <typename T>
+struct ToCharVectorImpl<T, archives::out_msgpack_t>
+{
+    /*!
+     * \brief Function operator
+     * \param[in] object - Object to serialize
+     * \return Char vector containing serialized object
+     *
+     * This overload creates new memory.
+     */
+    char_vector_t operator()(const T& object) const
+    {
+        msgpack::sbuffer buffer;
+        msgpack::pack(buffer, object);
+
+        return char_vector_t(buffer.data(), buffer.data() + buffer.size());
+    }
+
+    /*!
+     * \brief Function operator
+     * \param[in] object - Object to serialize
+     * \param[out] result - Char vector containing serialized object
+     *
+     * This overload uses the memory passed in and resizes if necessary.
+     */
+    void operator()(const T& object, char_vector_t& result) const
+    {
+        msgpack::sbuffer buffer;
+        msgpack::pack(buffer, object);
+
+        result.assign(buffer.data(), buffer.data() + buffer.size());
+    }
+};
+
 /*!
  * \brief Deserialization to object implementation.
  *
@@ -330,6 +380,31 @@ template <typename T> struct ToObjectImpl<T, archives::in_protobuf_t>
     }
 };
 
+/*! \brief Deserialization to object implementation, specialization for Google protocol buffers. */
+template <typename T>
+struct ToObjectImpl<T, archives::in_msgpack_t>
+{
+    /*!
+     * \brief Function operator
+     * \param[in] charSpan - Char span containing serialized object
+     * \return Deserialized object
+     */
+    T operator()(char_cspan_buf_t charSpan) const
+    {
+        if (charSpan.empty())
+        {
+            BOOST_THROW_EXCEPTION(std::runtime_error("Cannot deserialize MessagePack object from empty buffer."));
+        }
+
+        msgpack::object_handle oh = msgpack::unpack(charSpan.data(), charSpan.size());
+
+        T object;
+        oh.get().convert(object);
+
+        return object;
+    }
+};
+
 } // namespace impl
 
 /*!
@@ -416,7 +491,7 @@ char_vector_t ToCharVectorFlatBuf(const T& object, PackFunc packFunc)
 
 /*!
 * \brief Function to serialize object via flatbuffers
-* \param[in] builder - A falttbuffer builder already initialised with the message fields.
+* \param[in] builder - A flatbuffer builder already initialised with the message fields.
 * \return Char vector containing serialized object
 *
 * This overload creates new memory but has best performance regarding creating a message view object

Include/msgpack/msgpack.hpp

@@ -0,0 +1,22 @@
+//
+// MessagePack for C++
+//
+// Copyright (C) 2008-2009 FURUHASHI Sadayuki
+//
+//    Distributed under the Boost Software License, Version 1.0.
+//    (See accompanying file LICENSE_1_0.txt or copy at
+//    http://www.boost.org/LICENSE_1_0.txt)
+//
+#include "msgpack/object.hpp"
+#include "msgpack/iterator.hpp"
+#include "msgpack/zone.hpp"
+#include "msgpack/pack.hpp"
+#include "msgpack/null_visitor.hpp"
+#include "msgpack/parse.hpp"
+#include "msgpack/unpack.hpp"
+#include "msgpack/x3_parse.hpp"
+#include "msgpack/x3_unpack.hpp"
+#include "msgpack/sbuffer.hpp"
+#include "msgpack/vrefbuffer.hpp"
+#include "msgpack/version.hpp"
+#include "msgpack/type.hpp"

Include/msgpack/msgpack/adaptor/adaptor_base.hpp

@@ -0,0 +1,19 @@
+//
+// MessagePack for C++ static resolution routine
+//
+// Copyright (C) 2015-2016 KONDO Takatoshi
+//
+//    Distributed under the Boost Software License, Version 1.0.
+//    (See accompanying file LICENSE_1_0.txt or copy at
+//    http://www.boost.org/LICENSE_1_0.txt)
+//
+#ifndef MSGPACK_ADAPTOR_BASE_HPP
+#define MSGPACK_ADAPTOR_BASE_HPP
+
+#include "msgpack/adaptor/adaptor_base_decl.hpp"
+
+#include "msgpack/v1/adaptor/adaptor_base.hpp"
+#include "msgpack/v2/adaptor/adaptor_base.hpp"
+#include "msgpack/v3/adaptor/adaptor_base.hpp"
+
+#endif // MSGPACK_ADAPTOR_BASE_HPP

Include/msgpack/msgpack/adaptor/adaptor_base_decl.hpp

@@ -0,0 +1,17 @@
+//
+// MessagePack for C++ static resolution routine
+//
+// Copyright (C) 2016 KONDO Takatoshi
+//
+//    Distributed under the Boost Software License, Version 1.0.
+//    (See accompanying file LICENSE_1_0.txt or copy at
+//    http://www.boost.org/LICENSE_1_0.txt)
+//
+#ifndef MSGPACK_ADAPTOR_BASE_DECL_HPP
+#define MSGPACK_ADAPTOR_BASE_DECL_HPP
+
+#include "msgpack/v1/adaptor/adaptor_base_decl.hpp"
+#include "msgpack/v2/adaptor/adaptor_base_decl.hpp"
+#include "msgpack/v3/adaptor/adaptor_base_decl.hpp"
+
+#endif // MSGPACK_ADAPTOR_BASE_DECL_HPP

Include/msgpack/msgpack/adaptor/array_ref.hpp

@@ -0,0 +1,17 @@
+//
+// MessagePack for C++ static resolution routine
+//
+// Copyright (C) 2008-2016 FURUHASHI Sadayuki and KONDO Takatoshi
+//
+//    Distributed under the Boost Software License, Version 1.0.
+//    (See accompanying file LICENSE_1_0.txt or copy at
+//    http://www.boost.org/LICENSE_1_0.txt)
+//
+#ifndef MSGPACK_TYPE_ARRAY_REF_HPP
+#define MSGPACK_TYPE_ARRAY_REF_HPP
+
+#include "msgpack/adaptor/array_ref_decl.hpp"
+
+#include "msgpack/v1/adaptor/array_ref.hpp"
+
+#endif // MSGPACK_TYPE_ARRAY_REFL_HPP

Include/msgpack/msgpack/adaptor/array_ref_decl.hpp

@@ -0,0 +1,17 @@
+//
+// MessagePack for C++ static resolution routine
+//
+// Copyright (C) 2008-2016 FURUHASHI Sadayuki and KONDO Takatoshi
+//
+//    Distributed under the Boost Software License, Version 1.0.
+//    (See accompanying file LICENSE_1_0.txt or copy at
+//    http://www.boost.org/LICENSE_1_0.txt)
+//
+#ifndef MSGPACK_TYPE_ARRAY_REF_DECL_HPP
+#define MSGPACK_TYPE_ARRAY_REF_DECL_HPP
+
+#include "msgpack/v1/adaptor/array_ref_decl.hpp"
+#include "msgpack/v2/adaptor/array_ref_decl.hpp"
+#include "msgpack/v3/adaptor/array_ref_decl.hpp"
+
+#endif // MSGPACK_TYPE_ARRAY_REF_DECL_HPP

Include/msgpack/msgpack/adaptor/bool.hpp

@@ -0,0 +1,15 @@
+//
+// MessagePack for C++ static resolution routine
+//
+// Copyright (C) 2008-2016 FURUHASHI Sadayuki and KONDO Takatoshi
+//
+//    Distributed under the Boost Software License, Version 1.0.
+//    (See accompanying file LICENSE_1_0.txt or copy at
+//    http://www.boost.org/LICENSE_1_0.txt)
+//
+#ifndef MSGPACK_TYPE_BOOL_HPP
+#define MSGPACK_TYPE_BOOL_HPP
+
+#include "msgpack/v1/adaptor/bool.hpp"
+
+#endif // MSGPACK_TYPE_BOOL_HPP

Include/msgpack/msgpack/adaptor/boost/fusion.hpp

@@ -0,0 +1,15 @@
+//
+// MessagePack for C++ static resolution routine
+//
+// Copyright (C) 2015 KONDO Takatoshi
+//
+//    Distributed under the Boost Software License, Version 1.0.
+//    (See accompanying file LICENSE_1_0.txt or copy at
+//    http://www.boost.org/LICENSE_1_0.txt)
+//
+#ifndef MSGPACK_TYPE_BOOST_FUSION_HPP
+#define MSGPACK_TYPE_BOOST_FUSION_HPP
+
+#include "msgpack/v1/adaptor/boost/fusion.hpp"
+
+#endif // MSGPACK_TYPE_BOOST_FUSION_HPP

Include/msgpack/msgpack/adaptor/boost/msgpack_variant.hpp

@@ -0,0 +1,18 @@
+//
+// MessagePack for C++ static resolution routine
+//
+// Copyright (C) 2015-2016 KONDO Takatoshi
+//
+//    Distributed under the Boost Software License, Version 1.0.
+//    (See accompanying file LICENSE_1_0.txt or copy at
+//    http://www.boost.org/LICENSE_1_0.txt)
+//
+#ifndef MSGPACK_TYPE_BOOST_MSGPACK_VARIANT_HPP
+#define MSGPACK_TYPE_BOOST_MSGPACK_VARIANT_HPP
+
+#include "msgpack/adaptor/boost/msgpack_variant_decl.hpp"
+
+#include "msgpack/v1/adaptor/boost/msgpack_variant.hpp"
+//#include "msgpack/v2/adaptor/boost/msgpack_variant.hpp"
+
+#endif // MSGPACK_TYPE_BOOST_MSGPACK_VARIANT_HPP