@azure/web-pubsub-client package

Classi

InvocationError

Errore lanciato quando un'invocazione fallisce o viene annullata.

SendMessageError

Errore durante l'invio del messaggio non riuscito

WebPubSubClient

Client WebPubSub

Interfacce

AbortGroupStreamOptions

Annulla le opzioni di stream di gruppo.

AckMessage

Messaggio ack

AckMessageError

Dettagli errore in AckMessage

CancelInvocationMessage

Annulla messaggio di invocazione

ConnectedMessage

Messaggio connesso

DisconnectedMessage

Messaggio disconnesso

EndGroupStreamOptions

Termina le opzioni di stream di gruppo.

GetClientAccessUrlOptions

Opzioni di avvio

GroupDataMessage

Messaggio di raggruppamento dei dati

GroupStateItem

L'ingresso di stato di una singola connessione all'interno di un gruppo

GroupStateSnapshotMessage

Messaggio snapshot dello stato del gruppo, inviato dopo un subscribeGroupState riuscito

GroupStateUpdateMessage

Messaggio di aggiornamento dello stato del gruppo, inviato quando lo stato di una connessione cambia

GroupStream

Un singolo flusso di gruppo in ingresso.

GroupStreamMessage

Un frammento in entrata di un flusso di gruppo.

GroupStreamSubscription

Abbonamento restituito da client.onGroupStream(...).

GroupStreamWriteOptions

Opzioni di scrittura del flusso di gruppo.

GroupStreamWriter

Astrazione dello scrittore di flusso di gruppo per inviare un flusso logico a un gruppo.

InvocationErrorOptions
InvokeEventOptions

Opzioni di operazione dell'evento di invocazione

InvokeEventResult

Risultato di invokeEvent

InvokeMessage

Invoca il messaggio

InvokeResponseError

Dettagli sull'errore di risposta di invocazione

InvokeResponseMessage

Invoca il messaggio di risposta

JoinGroupMessage

Messaggio del gruppo di join

JoinGroupOptions

Opzioni per l'operazione di join del gruppo

LeaveGroupMessage

Lasciare il messaggio di gruppo

LeaveGroupOptions

Lasciare le opzioni per l'operazione di gruppo

OnConnectedArgs

Parametro del callback OnConnected

OnDisconnectedArgs

Parametro del callback OnDisconnected

OnGroupDataMessageArgs

Parametro del callback OnGroupDataMessage

OnGroupStreamOptions

Opzioni che controllano come vengono tracciati e inviati i flussi di gruppo in entrata per un singolo callback registrati tramite client.onGroupStream(callback, options).

La granularità è a due livelli:

  • I valori delle opzioni sono assegnati alla registrazione (cioè per handler): ogni onGroupStream chiamata porta i propri valori, e diversi handler possono usare valori differenti.
  • Gli effetti delle opzioni vengono applicati indipendentemente a ciascun flusso, identificati dalla sua (group, streamId) coppia. I flussi concorrenti — anche due flussi nello stesso gruppo osservati dallo stesso gestore — hanno ciascuno il proprio timer inattivo e il proprio handleFromStart gate. Nulla viene condiviso o aggregato tra flussi o gruppi.
OnRejoinGroupFailedArgs

Parametro del callback RejoinGroupFailed

OnServerDataMessageArgs

Parametro del callback OnDataMessage

OnStoppedArgs

Parametro del callback onStopped

OpenGroupStreamOptions

opzioni operative openGroupStream.

PingMessage

Messaggio ping

PongMessage

Il messaggio del pong

SendEventMessage

Inviare un messaggio di evento personalizzato

SendEventOptions

Opzioni di invio dell'operazione di evento

SendMessageErrorOptions
SendToGroupMessage

Invia al messaggio di gruppo

SendToGroupOptions

Opzioni di invio all'operazione di gruppo

SequenceAckMessage

Messaggio sequenza ack

ServerDataMessage

Messaggio dati server

SetGroupStateMessage

Imposta il messaggio di stato del gruppo

StartOptions

Opzioni di avvio

StartStreamOptions

Descrittore di flusso collegato a un frame di controllo sendToGroup che apre uno stream.

StreamAckMessage

Messaggio di streaming.

StreamClosedMessage

Messaggio chiuso dello stream.

StreamDataError

Dettaglio errore di streaming.

StreamDataMessage

Messaggio dati in streaming. Un carico utile con rappresenta solo streamId un keepalive.

StreamEndError

Errore di fine flusso che un flusso in uscita può inviare al servizio. Il servizio decide la classificazione dei nomi di errore di alto livello.

StreamEndMessage

Fine messaggio dello streaming.

StreamInfo

Metadati del flusso allegati a un messaggio di dati a valle.

StreamNackMessage

Stream messaggio di nack.

SubscribeGroupStateMessage

Messaggio di stato Subscribe group

UnsubscribeGroupStateMessage

Messaggio di disiscrizione dello stato del gruppo

WebPubSubClientCredential

Credenziali WebPubSubClient

WebPubSubClientOptions

Opzioni client

WebPubSubClientProtocol

Interfaccia da implementare per un sottoprotocolo pubub Web

WebPubSubMessageBase

Il comune dei messaggi pubub web

WebPubSubResult

Risultato dell'ack

WebPubSubRetryOptions

Opzioni di ripetizione dei tentativi

Alias tipo

DownstreamMessageType

Tipi per i messaggi downstream

JSONTypes

Tipi che possono essere serializzati e inviati come JSON.

RetryMode

Descrive il tipo di modalità di ripetizione dei tentativi

UpstreamMessageType

Tipi per i messaggi upstream

WebPubSubDataType

Tipo di dati

WebPubSubMessage

Messaggio pubub web

Funzioni

WebPubSubJsonProtocol()

Restituire il protocollo "json.webpubsub.azure.v1"

WebPubSubJsonReliableProtocol()

Restituire il protocollo "json.reliable.webpubsub.azure.v1"

Dettagli funzione

WebPubSubJsonProtocol()

Restituire il protocollo "json.webpubsub.azure.v1"

function WebPubSubJsonProtocol(): WebPubSubClientProtocol

Valori restituiti

WebPubSubJsonReliableProtocol()

Restituire il protocollo "json.reliable.webpubsub.azure.v1"

function WebPubSubJsonReliableProtocol(): WebPubSubClientProtocol

Valori restituiti