Libreria client del servizio Web PubSub di Azure per .NET

Articolo
10/26/2023

Il servizio Web PubSub di Azure è un servizio gestito da Azure che consente agli sviluppatori di creare facilmente applicazioni Web con funzionalità in tempo reale e modello di pubblicazione-sottoscrizione. Qualsiasi scenario che richiede la messaggistica di pubblicazione-sottoscrizione in tempo reale tra server e client o tra i client può usare il servizio Web PubSub di Azure. Le funzionalità tradizionali in tempo reale che spesso richiedono il polling dal server o l'invio di richieste HTTP possono usare anche il servizio PubSub Web di Azure.

È possibile usare questa libreria sul lato server dell'app per gestire le connessioni client WebSocket, come illustrato nel diagramma seguente:

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

Usare questa libreria per:

Inviare messaggi a hub e gruppi.
Inviare messaggi a utenti e connessioni specifici.
Organizzare utenti e connessioni in gruppi.
Chiudere le connessioni
Concedere, revocare e controllare le autorizzazioni per una connessione esistente

Documentazione di riferimento dell'API del pacchetto | del codice | sorgente Esempi di documentazione | | del prodotto

Introduzione

Installare il pacchetto

Installare la libreria client da NuGet:

dotnet add package Azure.Messaging.WebPubSub

Prerequisiti

Una sottoscrizione di Azure.
Istanza del servizio Web PubSub di Azure esistente.

Creare ed autenticare un `WebPubSubServiceClient`

Per interagire con il servizio, è necessario creare un'istanza della WebPubSubServiceClient classe . Per rendere possibile questa operazione, è necessario il stringa di connessione o una chiave, a cui è possibile accedere nella portale di Azure.

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

Esempi

Trasmettere un SMS a tutti i client

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

serviceClient.SendToAll("Hello World!");

Trasmettere un messaggio JSON a tutti i client

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

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

Trasmettere un messaggio binario a tutti i client

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