Add MessagePack support (#53)

Author: BrennanConroy

.azure/default-build.yml

@@ -45,7 +45,7 @@ jobs:
 
     - task: CMake@1
       inputs:
-        cmakeArgs: .. ${{ parameters.cMakeRunArgs }} -DCMAKE_TOOLCHAIN_FILE=../submodules/vcpkg/scripts/buildsystems/vcpkg.cmake -DCMAKE_BUILD_TYPE=${{ parameters.configuration }} -DUSE_CPPRESTSDK=${{ parameters.useCppRestSDK }}
+        cmakeArgs: .. ${{ parameters.cMakeRunArgs }} -DCMAKE_TOOLCHAIN_FILE=../submodules/vcpkg/scripts/buildsystems/vcpkg.cmake -DCMAKE_BUILD_TYPE=${{ parameters.configuration }} -DUSE_CPPRESTSDK=${{ parameters.useCppRestSDK }} -DUSE_MSGPACK=true
         workingDirectory: 'build.${{ parameters.configuration }}'
       displayName: Create build files
     - task: CMake@1

CMakeLists.txt

@@ -19,6 +19,10 @@ else()
   set(EXTRA_FLAGS "-DSIGNALRCLIENT_EXPORTS")
 endif()
 
+if(USE_MSGPACK)
+  string(APPEND EXTRA_FLAGS " -DUSE_MSGPACK")
+endif()
+
 if(INJECT_HEADER_AFTER_STDAFX)
   string(APPEND EXTRA_FLAGS " -DINJECT_HEADER_AFTER_STDAFX=${INJECT_HEADER_AFTER_STDAFX}")
 endif()
@@ -39,6 +43,11 @@ if(NOT INCLUDE_JSONCPP)
   set(JSONCPP_LIB "jsoncpp_lib" CACHE STRING "jsoncpp target name")
 endif()
 
+if(USE_MSGPACK)
+  find_package(msgpack CONFIG REQUIRED)
+  set(MSGPACK_LIB "msgpackc-cxx")
+endif()
+
 include_directories (include)
 
 if(USE_CPPRESTSDK)

CMakeSettings.json

@@ -7,7 +7,7 @@
       "inheritEnvironments": [ "msvc_x64_x64" ],
       "buildRoot": "${projectDir}\\out\\build\\${name}",
       "installRoot": "${projectDir}\\out\\install\\${name}",
-      "cmakeCommandArgs": "-DBUILD_SAMPLES=true -DUSE_CPPRESTSDK=true",
+      "cmakeCommandArgs": "-DBUILD_SAMPLES=true -DUSE_CPPRESTSDK=true -DUSE_MSGPACK=true",
       "buildCommandArgs": "-v",
       "ctestCommandArgs": "",
       "cmakeToolchain": "${projectDir}\\submodules\\vcpkg\\scripts\\buildsystems\\vcpkg.cmake",
@@ -19,7 +19,7 @@
       "configurationType": "Release",
       "buildRoot": "${projectDir}\\out\\build\\${name}",
       "installRoot": "${projectDir}\\out\\install\\${name}",
-      "cmakeCommandArgs": "-DBUILD_SAMPLES=true -DUSE_CPPRESTSDK=true",
+      "cmakeCommandArgs": "-DBUILD_SAMPLES=true -DUSE_CPPRESTSDK=true -DUSE_MSGPACK=true",
       "buildCommandArgs": "-v",
       "ctestCommandArgs": "",
       "cmakeToolchain": "${projectDir}\\submodules\\vcpkg\\scripts\\buildsystems\\vcpkg.cmake",

README.md

@@ -20,7 +20,8 @@ Below are instructions to build on different OS's. You can also use the followin
 | --- | --- | --- |
 | -DBUILD_SAMPLES | Build the included sample project | false |
 | -DBUILD_TESTING | Builds the test project | true |
-| -DUSE_CPPRESTSDK | Includes the CppRestSDK (default http stack) | false |
+| -DUSE_CPPRESTSDK | Includes the CppRestSDK (default http stack) (requires cpprestsdk to be installed) | false |
+| -DUSE_MSGPACK | Adds an option to use the MessagePack Hub Protocol (requires msgpack-c to be installed) | false |
 | -DINCLUDE_JSONCPP | Builds jsoncpp source code as part of the output binary | true |
 | -DWERROR | Enables warnings as errors | true |
 | -DWALL | Enables all warnings | true |

azure-pipelines.yml

@@ -37,7 +37,7 @@ stages:
       - powershell: "& ./submodules/vcpkg/bootstrap-vcpkg.bat"
         condition: ne(variables.CACHE_RESTORED, 'true')
         displayName: Bootstrap vcpkg
-      - powershell: "& ./submodules/vcpkg/vcpkg.exe install cpprestsdk:x64-windows --vcpkg-root ./submodules/vcpkg"
+      - powershell: "& ./submodules/vcpkg/vcpkg.exe install cpprestsdk:x64-windows msgpack:x64-windows --vcpkg-root ./submodules/vcpkg"
         condition: ne(variables.CACHE_RESTORED, 'true')
         displayName: vcpkg install dependencies
 
@@ -50,7 +50,7 @@ stages:
       - bash: "./submodules/vcpkg/bootstrap-vcpkg.sh --allowAppleClang"
         condition: ne(variables.CACHE_RESTORED, 'true')
         displayName: Bootstrap vcpkg
-      - bash: "./submodules/vcpkg/vcpkg install cpprestsdk"
+      - bash: "./submodules/vcpkg/vcpkg install cpprestsdk msgpack"
         condition: ne(variables.CACHE_RESTORED, 'true')
         displayName: vcpkg install dependencies
 
@@ -63,7 +63,7 @@ stages:
       - bash: "./submodules/vcpkg/bootstrap-vcpkg.sh"
         condition: ne(variables.CACHE_RESTORED, 'true')
         displayName: Bootstrap vcpkg
-      - bash: "./submodules/vcpkg/vcpkg install cpprestsdk boost-system boost-chrono boost-thread --vcpkg-root ./submodules/vcpkg"
+      - bash: "./submodules/vcpkg/vcpkg install cpprestsdk boost-system boost-chrono boost-thread msgpack --vcpkg-root ./submodules/vcpkg"
         condition: ne(variables.CACHE_RESTORED, 'true')
         displayName: vcpkg install dependencies
       - bash: "sudo apt-get update && sudo apt install valgrind"
@@ -75,6 +75,12 @@ stages:
       jobName: Linux_Build_Test
       useCppRestSDK: false
       beforeBuild:
+      - bash: "./submodules/vcpkg/bootstrap-vcpkg.sh"
+        condition: ne(variables.CACHE_RESTORED, 'true')
+        displayName: Bootstrap vcpkg
+      - bash: "./submodules/vcpkg/vcpkg install msgpack --vcpkg-root ./submodules/vcpkg"
+        condition: ne(variables.CACHE_RESTORED, 'true')
+        displayName: vcpkg install dependencies
       - bash: "sudo apt-get update && sudo apt install valgrind"
         displayName: install valgrind
 
@@ -84,6 +90,13 @@ stages:
       jobName: Windows_Build_Test
       useCppRestSDK: false
       cMakeRunArgs: '-A x64'
+      beforeBuild:
+      - powershell: "& ./submodules/vcpkg/bootstrap-vcpkg.bat"
+        condition: ne(variables.CACHE_RESTORED, 'true')
+        displayName: Bootstrap vcpkg
+      - powershell: "& ./submodules/vcpkg/vcpkg.exe install msgpack:x64-windows --vcpkg-root ./submodules/vcpkg"
+        condition: ne(variables.CACHE_RESTORED, 'true')
+        displayName: vcpkg install dependencies
 
   - template: .azure/default-build.yml
     parameters:
@@ -93,6 +106,12 @@ stages:
       beforeBuild:
       - script: brew install gcc
         displayName: Install gcc
+      - bash: "./submodules/vcpkg/bootstrap-vcpkg.sh"
+        condition: ne(variables.CACHE_RESTORED, 'true')
+        displayName: Bootstrap vcpkg
+      - bash: "./submodules/vcpkg/vcpkg install msgpack"
+        condition: ne(variables.CACHE_RESTORED, 'true')
+        displayName: vcpkg install dependencies
 
 - ${{ if and(ne(variables['System.TeamProject'], 'public'), notin(variables['Build.Reason'], 'PullRequest')) }}:
   - stage: post_build

include/signalrclient/hub_connection.h

@@ -19,6 +19,7 @@ namespace signalr
     class websocket_client;
     class hub_connection_impl;
     class hub_connection_builder;
+    class hub_protocol;
 
     class hub_connection
     {
@@ -54,9 +55,11 @@ namespace signalr
     private:
         friend class hub_connection_builder;
 
-        explicit hub_connection(const std::string& url, trace_level trace_level = trace_level::info,
-            std::shared_ptr<log_writer> log_writer = nullptr, std::function<std::shared_ptr<http_client>(const signalr_client_config&)> http_client_factory = nullptr,
-            std::function<std::shared_ptr<websocket_client>(const signalr_client_config&)> websocket_factory = nullptr, bool skip_negotiation = false);
+        explicit hub_connection(const std::string& url, std::unique_ptr<hub_protocol>&& hub_protocol,
+            trace_level trace_level = trace_level::info, std::shared_ptr<log_writer> log_writer = nullptr,
+            std::function<std::shared_ptr<http_client>(const signalr_client_config&)> http_client_factory = nullptr,
+            std::function<std::shared_ptr<websocket_client>(const signalr_client_config&)> websocket_factory = nullptr,
+            bool skip_negotiation = false);
 
         std::shared_ptr<hub_connection_impl> m_pImpl;
     };

include/signalrclient/hub_connection_builder.h

@@ -35,6 +35,10 @@ namespace signalr
 
         SIGNALRCLIENT_API hub_connection_builder& skip_negotiation(bool skip = true);
 
+#ifdef USE_MSGPACK
+        SIGNALRCLIENT_API hub_connection_builder& with_messagepack_hub_protocol();
+#endif
+
         SIGNALRCLIENT_API hub_connection build();
     private:
         hub_connection_builder(const std::string& url);
@@ -45,5 +49,6 @@ namespace signalr
         std::function<std::shared_ptr<websocket_client>(const signalr_client_config&)> m_websocket_factory;
         std::function<std::shared_ptr<http_client>(const signalr_client_config&)> m_http_client_factory;
         bool m_skip_negotiation = false;
+        bool m_use_messagepack = false;
     };
 }

include/signalrclient/signalr_exception.h

@@ -14,5 +14,9 @@ namespace signalr
         explicit signalr_exception(const std::string &what)
             : runtime_error(what)
         {}
+
+        explicit signalr_exception(const char* what)
+            : runtime_error(what)
+        {}
     };
 }

src/signalrclient/CMakeLists.txt

@@ -25,6 +25,14 @@ set (SOURCES
   ../../third_party_code/cpprestsdk/uri_builder.cpp
 )
 
+if(USE_MSGPACK)
+  list (APPEND SOURCES
+    binary_message_formatter.cpp
+    binary_message_parser.cpp
+    messagepack_hub_protocol.cpp
+  )
+endif()
+
 include_directories(
   ../../third_party_code/cpprestsdk
 )
@@ -90,6 +98,12 @@ else()
   endif()
 endif() # USE_CPPRESTSDK
 
+if(USE_MSGPACK)
+  target_link_libraries(microsoft-signalr
+    PRIVATE ${MSGPACK_LIB}
+  )
+endif() # USE_MSGPACK
+
 include(GNUInstallDirs)
 
 install(TARGETS microsoft-signalr

src/signalrclient/binary_message_formatter.cpp

@@ -0,0 +1,45 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+// See the LICENSE file in the project root for more information.
+
+#include "stdafx.h"
+
+#ifdef USE_MSGPACK
+#include "binary_message_formatter.h"
+#include <cassert>
+#include <signalrclient/signalr_exception.h>
+
+namespace signalr
+{
+    namespace binary_message_formatter
+    {
+        void write_length_prefix(std::string& payload)
+        {
+            // We support payloads up to 2GB so the biggest number we support is 7fffffff which when encoded as
+            // VarInt is 0xFF 0xFF 0xFF 0xFF 0x07 - hence the maximum length prefix is 5 bytes.
+            char buffer[5];
+
+            size_t length = payload.length();
+            size_t length_num_bytes = 0;
+            do
+            {
+                buffer[length_num_bytes] = (char)(length & 0x7f);
+                length >>= 7;
+                if (length > 0)
+                {
+                    buffer[length_num_bytes] |= 0x80;
+                }
+                length_num_bytes++;
+            } while (length > 0 && length_num_bytes < 5);
+
+            if (length_num_bytes == 5 && buffer[4] != 0x07)
+            {
+                throw signalr_exception("messages over 2GB are not supported.");
+            }
+
+            payload.insert(0, buffer, length_num_bytes);
+        }
+    }
+}
+
+#endif