Azure Web PubSub protobuf protocol client library for .NET

This library adds the protobuf subprotocols protobuf.reliable.webpubsub.azure.v1 and protobuf.webpubsub.azure.v1 to the Azure.Messaging.WebPubSub.Client library.

Prerequisites

• An Azure subscription.
• An existing Web PubSub instance. Create Web PubSub instance

Getting started

• Install the Azure.Messaging.WebPubSub.Client package from NuGet:

dotnet add package Azure.Messaging.WebPubSub.Client

• Install this package from NuGet:

dotnet add package WebPubSub.Protobuf.Protocols

You can find more info about the Web PubSub client library here.

• Import the WebPubSub.Client.Protobuf namespace

using WebPubSub.Client.Protobuf

Examples

Specify protobuf subprotocol

You can specify the protobuf subprotocol to be used by the client choosing between protobuf.reliable.webpubsub.azure.v1 or protobuf.webpubsub.azure.v1 after referencing the library.

var client = new WebPubSubClient(new Uri("<client-access-uri>"), new WebPubSubClientOptions
{
    Protocol = new WebPubSubProtobufReliableProtocol()
});

var client = new WebPubSubClient(new Uri("<client-access-uri>"), new WebPubSubClientOptions
{
    Protocol = new WebPubSubProtobufProtocol()
});

Send to groups

// Send message to group "testGroup"
await client.SendToGroupAsync("testGroup", BinaryData.FromString("hello world"), WebPubSubDataType.Text);

Send events to event handler

// Send custom event to server
await client.SendEventAsync("testEvent", BinaryData.FromString("hello world"), WebPubSubDataType.Text);

Other examples

You can see other examples at the project repository.