WebPubSubClientProtocol interface

Pakiet:

@azure/web-pubsub-client

Interfejs, który ma zostać zaimplementowany dla podprotokolu pubsub sieci Web

Właściwości

isReliableSubProtocol	Prawda, jeśli protokół obsługuje niezawodne funkcje
name	Nazwa podprotokolu. Nazwa będzie używana w podprotocol zestawu websocket

Metody

parseMessages(string | ArrayBuffer | Buffer)	Tworzy obiekty WebPubSubMessage na podstawie określonej serializowanej reprezentacji.
writeMessage(WebPubSubMessage)	Zapisywanie elementu WebPubSubMessage w ciągu lub arrayBuffer

Szczegóły właściwości

isReliableSubProtocol

Prawda, jeśli protokół obsługuje niezawodne funkcje

isReliableSubProtocol: boolean

Wartość właściwości

boolean

name

Nazwa podprotokolu. Nazwa będzie używana w podprotocol zestawu websocket

name: string

Wartość właściwości

string

Szczegóły metody

parseMessages(string | ArrayBuffer | Buffer)

Tworzy obiekty WebPubSubMessage na podstawie określonej serializowanej reprezentacji.

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

Parametry

input

string | ArrayBuffer | Buffer

Serializowana reprezentacja

Zwraca

null | WebPubSubMessage | WebPubSubMessage[]

writeMessage(WebPubSubMessage)

Zapisywanie elementu WebPubSubMessage w ciągu lub arrayBuffer

function writeMessage(message: WebPubSubMessage): string | ArrayBuffer

Parametry

message

WebPubSubMessage

Wiadomość do zapisania

Zwraca

string | ArrayBuffer