WebPubSubClientProtocol interface
Web pubsub サブプロトコル用に実装されるインターフェイス
プロパティ
| is |
プロトコルが信頼性の高い機能をサポートしている場合は True |
| name | サブプロトコルの名前。 名前は websocket サブプロトコルで使用されます |
メソッド
| parse |
指定したシリアル化表現から WebPubSubMessage オブジェクトを作成します。 |
| write |
WebPubSubMessage を文字列または ArrayBuffer に書き込む |
プロパティの詳細
isReliableSubProtocol
プロトコルが信頼性の高い機能をサポートしている場合は True
isReliableSubProtocol: boolean
プロパティ値
boolean
name
サブプロトコルの名前。 名前は websocket サブプロトコルで使用されます
name: string
プロパティ値
string
メソッドの詳細
parseMessages(string | ArrayBuffer | Buffer)
指定したシリアル化表現から WebPubSubMessage オブジェクトを作成します。
function parseMessages(input: string | ArrayBuffer | Buffer): null | WebPubSubMessage | WebPubSubMessage[]
パラメーター
- input
-
string | ArrayBuffer | Buffer
シリアル化された表現
戻り値
null | WebPubSubMessage | WebPubSubMessage[]
writeMessage(WebPubSubMessage)
WebPubSubMessage を文字列または ArrayBuffer に書き込む
function writeMessage(message: WebPubSubMessage): string | ArrayBuffer
パラメーター
- message
- WebPubSubMessage
書き込むメッセージ
戻り値
string | ArrayBuffer