WebPubSubClientProtocol interface

Interfaz que se va a implementar para un subprotocolo de web pubsub

Propiedades

isReliableSubProtocol

True si el protocolo admite características confiables

name

Nombre del subprotocolo. Name se usará en el subprotocolo websocket.

Métodos

parseMessages(string | ArrayBuffer | Buffer)

Crea objetos WebPubSubMessage a partir de la representación serializada especificada.

writeMessage(WebPubSubMessage)

Escribir WebPubSubMessage en string o ArrayBuffer

Detalles de las propiedades

isReliableSubProtocol

True si el protocolo admite características confiables

isReliableSubProtocol: boolean

Valor de propiedad

boolean

name

Nombre del subprotocolo. Name se usará en el subprotocolo websocket.

name: string

Valor de propiedad

string

Detalles del método

parseMessages(string | ArrayBuffer | Buffer)

Crea objetos WebPubSubMessage a partir de la representación serializada especificada.

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

Parámetros

input

string | ArrayBuffer | Buffer

Representación serializada

Devoluciones

writeMessage(WebPubSubMessage)

Escribir WebPubSubMessage en string o ArrayBuffer

function writeMessage(message: WebPubSubMessage): string | ArrayBuffer

Parámetros

message
WebPubSubMessage

Mensaje que se va a escribir

Devoluciones

string | ArrayBuffer