Biblioteca cliente del servicio Azure Web PubSub para .NET

Artículo
10/26/2023

Azure Web PubSub es un servicio administrado de Azure que ayuda a los desarrolladores a compilar fácilmente aplicaciones web con características en tiempo real y patrón de publicación-suscripción. Cualquier escenario que requiera mensajería de publicación y suscripción en tiempo real entre el servidor y los clientes o entre clientes, puede usar el servicio Azure Web PubSub. Las características tradicionales en tiempo real que a menudo requieren tener que sondear desde el servidor o enviar solicitudes HTTP, también pueden usar el servicio Azure Web PubSub.

Puede usar esta biblioteca en el lado del servidor de aplicaciones para administrar las conexiones de cliente de WebSocket, como se muestra en el diagrama siguiente:

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

Use esta biblioteca para:

Enviar mensajes a centros y grupos.
Enviar mensajes a determinados usuarios y conexiones.
Organizar usuarios y conexiones en grupos.
Cerrar conexiones.
Conceder, revocar y comprobar permisos para una conexión existente.

Código fuente | Paquete | Documentación de referencia de API | Documentación del producto | Ejemplos

Introducción

Instalar el paquete

Instale la biblioteca cliente desde NuGet:

dotnet add package Azure.Messaging.WebPubSub

Requisitos previos

Una suscripción de Azure.
Una instancia existente del servicio Azure Web PubSub.

Crear y autenticar una `WebPubSubServiceClient`

Para interactuar con el servicio, tiene que crear una instancia de la clase WebPubSubServiceClient. Para que esto sea posible, necesitará la cadena de conexión o una clave, a las que puede acceder en Azure Portal.

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

Ejemplos

Difusión de un mensaje de texto a todos los clientes

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

serviceClient.SendToAll("Hello World!");

Difusión de un mensaje JSON a todos los 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);

Difusión de un mensaje binario a todos los 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);