Using message pack with ASP.NET Core SignalR

Posted by Anuraj on Tuesday, September 4, 2018 Reading time :1 minute

ASPNET Core SignalR MessagePack

This post is about using MessagePack protocol in SignalR. MessagePack is an efficient binary serialization format. It lets you exchange data among multiple languages like JSON. But it’s faster and smaller. Small integers are encoded into a single byte, and typical short strings require only one extra byte in addition to the strings themselves.

To use MessagePack, you need to install a nuget package - Microsoft.AspNetCore.SignalR.Protocols.MessagePack. You can install the package using dotnet add package Microsoft.AspNetCore.SignalR.Protocols.MessagePack --version 1.1.0-preview1-35029 command.

ASP.NET Core MessagePack NuGet package

Once you install, you can modify the startup code like this.

public void ConfigureServices(IServiceCollection services)
{
    services.Configure<CookiePolicyOptions>(options =>
    {
        options.CheckConsentNeeded = context => true;
        options.MinimumSameSitePolicy = SameSiteMode.None;
    });

    services.AddSignalR()
        .AddMessagePackProtocol();

    services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_2);
}

In this post I am using simple chat implementation of SignalR. Next you need to install the client packages. You need to MessagePack protocol implementation of javascript as well. Here is the project.json file, you can either install the packages individually or you run npm install command to install the packages.

{
  "name": "signalrmessagepackdemo",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "author": "anuraj",
  "license": "MIT",
  "dependencies": {
    "@aspnet/signalr": "^1.0.3",
    "@aspnet/signalr-protocol-msgpack": "^1.0.3"
  }
}

And you can modify the _layout.cshtml file like this. Please note the order of script files is important. If signalr-protocol-msgpack.js is referenced before msgpack5.js, an error occurs when trying to connect with MessagePack. signalr.js is also required before signalr-protocol-msgpack.js.

<script src="~/lib/signalr/signalr.min.js"></script>
<script src="~/lib/msgpack5/msgpack5.min.js"></script>
<script src="~/lib/signalr/signalr-protocol-msgpack.min.js"></script>

To copy the files from node_modules folder, I am using the MSBuild steps, like this.

<Target Name="CopyScriptFiles" AfterTargets="BeforeBuild">
    <Copy SourceFiles="node_modules/@aspnet/signalr/dist/browser/signalr.min.js" DestinationFolder="wwwroot/lib/signalr" />
    <Copy SourceFiles="node_modules/msgpack5/dist/msgpack5.min.js" DestinationFolder="wwwroot/lib/msgpack5" />
    <Copy SourceFiles="node_modules/@aspnet/signalr-protocol-msgpack/dist/browser/signalr-protocol-msgpack.min.js" DestinationFolder="wwwroot/lib/signalr" />
</Target>

You need to modify the script like this, to connect to MessagePack enabled SignalR hub.

const connection = new signalR.HubConnectionBuilder()
    .withUrl("/chatHub")
    .withHubProtocol(new signalR.protocols.msgpack.MessagePackHubProtocol())
    .build();

As of now there are no configuration options for the MessagePack protocol on the JavaScript client.

Happy Programming :)


Similar Posts


Did you like this article? Share it with your friends

Facebook Twitter Google+ LinkedIn Reddit StumbleUpon



Translate
Subscribe
BMC logoBuy me a coffee


Copyright © 2018 - Anuraj P. Blog content licensed under the Creative Commons CC BY 2.5 | Unless otherwise stated or granted, code samples licensed under the MIT license. This is a personal blog. The opinions expressed here represent my own and not those of my employer. Hosted with ❤ by GitHub