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

Artigo
10/26/2023

O Serviço Azure Web PubSub é um serviço gerenciado pelo Azure que ajuda os desenvolvedores a criar facilmente aplicativos Web 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 os clientes pode usar o serviço Azure Web PubSub. Recursos tradicionais em tempo real que geralmente exigem sondagem do servidor ou 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 do cliente WebSocket, conforme mostrado no diagrama abaixo:

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

Use esta biblioteca para:

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

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

Introdução

Instalar o pacote

Instale a biblioteca de cliente do NuGet:

dotnet add package Azure.Messaging.WebPubSub

Pré-requisitos

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

Criar e autenticar um `WebPubSubServiceClient`

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

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

Exemplos

Difundir 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);