Azure Web PubSub-serviceclientbibliotheek voor .NET

Artikel
10/26/2023

Azure Web PubSub Service is een door Azure beheerde service waarmee ontwikkelaars eenvoudig webtoepassingen kunnen bouwen met realtime functies en een patroon voor publiceren/abonneren. Elk scenario waarvoor realtime berichten voor publiceren/abonneren tussen server en clients of clients zijn vereist, kunnen de Azure Web PubSub-service gebruiken. Traditionele realtime-functies die vaak polling vereisen van de server of het verzenden van HTTP-aanvragen, kunnen ook gebruikmaken van de Azure Web PubSub-service.

U kunt deze bibliotheek aan de serverzijde van uw app gebruiken om de WebSocket-clientverbindingen te beheren, zoals wordt weergegeven in het onderstaande diagram:

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

Gebruik deze bibliotheek om:

Berichten verzenden naar hubs en groepen.
Berichten verzenden naar bepaalde gebruikers en verbindingen.
Organiseer gebruikers en verbindingen in groepen.
Verbindingen sluiten
Machtigingen voor een bestaande verbinding verlenen, intrekken en controleren

Voorbeelden van productdocumentatie over broncodepakket-API-referentiedocumentatie | | | |

Aan de slag

Het pakket installeren

Installeer de clientbibliotheek vanuit NuGet:

dotnet add package Azure.Messaging.WebPubSub

Vereisten

Een Azure-abonnement.
Een bestaand Exemplaar van de Azure Web PubSub-service.

Een maken en verifiëren `WebPubSubServiceClient`

Als u wilt communiceren met de service, moet u een exemplaar van de WebPubSubServiceClient klasse maken. Om dit mogelijk te maken, hebt u de verbindingsreeks of een sleutel nodig, waartoe u toegang hebt in Azure Portal.

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

Voorbeelden

Een sms-bericht uitzenden naar alle clients

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

serviceClient.SendToAll("Hello World!");

Een JSON-bericht uitzenden naar alle clients

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

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

Een binair bericht uitzenden naar alle clients

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