Biblioteca de clientes do serviço Azure Web PubSub para .NET

Artigo
06/01/2023

O serviço Azure Web PubSub é um serviço gerenciado do Azure que ajuda os desenvolvedores a criar aplicativos Web facilmente com recursos em tempo real e padrão de publicação/assinatura. Qualquer cenário que exija mensagens de publicação/assinatura em tempo real entre o servidor e os clientes ou entre clientes pode usar o serviço Azure Web PubSub. Os recursos tradicionais em tempo real que geralmente exigem a sondagem do servidor ou o envio de solicitações HTTP também podem usar o serviço Azure Web PubSub.

Você pode usar essa biblioteca no lado do servidor de aplicativos para gerenciar as conexões de cliente WebSocket, conforme mostrado no diagrama abaixo:

The overflow diagram shows the overflow of using the service client library.

Use essa biblioteca para:

Enviar mensagens para hubs e grupos.
Enviar mensagens para usuários e conexões específicos.
Organizar usuários e conexões em grupos.
Fechar conexões
Conceder, revogar e verificar permissões para uma conexão existente

Código-fonte | Pacote | Documentação de referência da API | Documentação do produto | Exemplos

Introdução

Instalar o pacote

Instale a biblioteca de clientes do NuGet:

dotnet add package Azure.Messaging.WebPubSub

Pré-requisitos

Uma assinatura do Azure.
Uma instância de serviço existente do Azure Web PubSub.

Criar e autenticar um `WebPubSubServiceClient`

Para interagir com o serviço, você precisará criar uma instância da classe WebPubSubServiceClient. Para tornar isso possível, você precisará da cadeia de conexão ou de uma chave, que pode ser acessada no portal do Azure.

var serviceClient = new WebPubSubServiceClient(new Uri(endpoint), "some_hub", new AzureKeyCredential(key));

Exemplos

Transmitir uma mensagem de texto para todos os clientes

var serviceClient = new WebPubSubServiceClient(new Uri(endpoint), "some_hub", new AzureKeyCredential(key));

serviceClient.SendToAll("Hello World!");

Transmitir uma mensagem JSON para todos os clientes

var serviceClient = new WebPubSubServiceClient(new Uri(endpoint), "some_hub", new AzureKeyCredential(key));

serviceClient.SendToAll(RequestContent.Create(
        new
        {
            Foo = "Hello World!",
            Bar = 42
        }),
        ContentType.ApplicationJson);

Transmitir uma mensagem binária para todos os clientes

var serviceClient = new WebPubSubServiceClient(new Uri(endpoint), "some_hub", new AzureKeyCredential(key));

Stream stream = BinaryData.FromString("Hello World!").ToStream();
serviceClient.SendToAll(RequestContent.Create(stream), ContentType.ApplicationOctetStream);