WebPubSubClientProtocol interface
Rozhraní, které se má implementovat pro subprotocol podsítě webové pubsub
Vlastnosti
| is |
Hodnota True, pokud protokol podporuje spolehlivé funkce |
| name | Název subprotocolu. Název se použije v podprotokolce protokolu websocket. |
Metody
| parse |
Vytvoří WebPubSubMessage objekty ze zadané serializované reprezentace. |
| write |
Zápis WebPubSubMessage do řetězce nebo ArrayBufferu |
Podrobnosti vlastnosti
isReliableSubProtocol
Hodnota True, pokud protokol podporuje spolehlivé funkce
isReliableSubProtocol: boolean
Hodnota vlastnosti
boolean
name
Název subprotocolu. Název se použije v podprotokolce protokolu websocket.
name: string
Hodnota vlastnosti
string
Podrobnosti metody
parseMessages(string | ArrayBuffer | Buffer)
Vytvoří WebPubSubMessage objekty ze zadané serializované reprezentace.
function parseMessages(input: string | ArrayBuffer | Buffer): null | WebPubSubMessage | WebPubSubMessage[]
Parametry
- input
-
string | ArrayBuffer | Buffer
Serializovaná reprezentace
Návraty
null | WebPubSubMessage | WebPubSubMessage[]
writeMessage(WebPubSubMessage)
Zápis WebPubSubMessage do řetězce nebo ArrayBufferu
function writeMessage(message: WebPubSubMessage): string | ArrayBuffer
Parametry
- message
- WebPubSubMessage
Zpráva, která se má zapsat
Návraty
string | ArrayBuffer