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