WebPubSubClientProtocol interface

Paquet:

@azure/web-pubsub-client

Interface à implémenter pour un sous-protocole pubsub web

Propriétés

isReliableSubProtocol	True si le protocole prend en charge des fonctionnalités fiables
name	Nom du sous-protocole. Le nom sera utilisé dans le sous-protocole websocket

Méthodes

parseMessages(string | ArrayBuffer | Buffer)	Crée des objets WebPubSubMessage à partir de la représentation sérialisée spécifiée.
writeMessage(WebPubSubMessage)	Écrire WebPubSubMessage dans chaîne ou ArrayBuffer

Détails de la propriété

isReliableSubProtocol

True si le protocole prend en charge des fonctionnalités fiables

isReliableSubProtocol: boolean

Valeur de propriété

boolean

name

Nom du sous-protocole. Le nom sera utilisé dans le sous-protocole websocket

name: string

Valeur de propriété

string

Détails de la méthode

parseMessages(string | ArrayBuffer | Buffer)

Crée des objets WebPubSubMessage à partir de la représentation sérialisée spécifiée.

function parseMessages(input: string | ArrayBuffer | Buffer): null | WebPubSubMessage | WebPubSubMessage[]

Paramètres

input

string | ArrayBuffer | Buffer

Représentation sérialisée

Retours

null | WebPubSubMessage | WebPubSubMessage[]

writeMessage(WebPubSubMessage)

Écrire WebPubSubMessage dans chaîne ou ArrayBuffer

function writeMessage(message: WebPubSubMessage): string | ArrayBuffer

Paramètres

message

WebPubSubMessage

Message à écrire

Retours

string | ArrayBuffer