WebPubSub.Protobuf 1.0.0

dotnet add package WebPubSub.Protobuf --version 1.0.0                
NuGet\Install-Package WebPubSub.Protobuf -Version 1.0.0                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="WebPubSub.Protobuf" Version="1.0.0" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add WebPubSub.Protobuf --version 1.0.0                
#r "nuget: WebPubSub.Protobuf, 1.0.0"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install WebPubSub.Protobuf as a Cake Addin
#addin nuget:?package=WebPubSub.Protobuf&version=1.0.0

// Install WebPubSub.Protobuf as a Cake Tool
#tool nuget:?package=WebPubSub.Protobuf&version=1.0.0                

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

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.

Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.0.0 137 7/24/2023