共用方式為

NodeWebSocket class

  • 參考
套件:
botframework-streaming

要與 NodeWebSocketFactory 搭配使用的 ISocket 實作，以建立 WebSocket 伺服器。

建構函式

NodeWebSocket(WebSocket)

建立新的 NodeWebSocket 實例。

屬性

isConnected

指出 『ws』 WebSocket 目前是否已連線並準備好傳送訊息。

方法

close(number, string)

關閉套接字。
connect(string, number)

使用 WebSocket 通訊協定連線到支援套接字。
create(INodeIncomingMessage, INodeSocket, INodeBuffer)

使用 HTTP 要求、套接字和緩衝區建立及設定 ws WebSocket。
setOnCloseHandler((x: any) => void)

設定在遇到套接字關閉時要呼叫的回呼。
setOnErrorHandler((x: any) => void)

設定回呼以在發生錯誤時呼叫。
setOnMessageHandler((x: any) => void)

設定套接字上所接收 'data' 和 'message' 事件的處理程式。
write(INodeBuffer)

將緩衝區寫入套接字，並將它傳送。

建構函式詳細資料

NodeWebSocket(WebSocket)

建立新的 NodeWebSocket 實例。

new NodeWebSocket(wsSocket?: WebSocket)

參數

wsSocket

WebSocket

要建置此連線的webSocket實例 ws。

屬性詳細資料

isConnected

指出 『ws』 WebSocket 目前是否已連線並準備好傳送訊息。

boolean isConnected

屬性值

boolean

如果基礎 websocket 已就緒且可供傳送訊息，則 true，否則 false。

方法詳細資料

close(number, string)

關閉套接字。

function close(code?: number, data?: string)

參數

code

number

選擇性狀態代碼，說明連線關閉的原因。

data

string

選擇性的其他數據，說明連線為何已關閉。

備註

選擇性地傳入狀態代碼和字串，說明連接關閉的原因。

connect(string, number)

使用 WebSocket 通訊協定連線到支援套接字。

function connect(serverAddress: string, port?: number): Promise<void>

參數

serverAddress

string

伺服器正在接聽的位址。

port

number

伺服器正在接聽的埠預設為8082。

傳回

Promise<void>

當 Websocket 連線關閉或拒絕錯誤時解決的 Promise。

create(INodeIncomingMessage, INodeSocket, INodeBuffer)

使用 HTTP 要求、套接字和緩衝區建立及設定 ws WebSocket。

function create(req: INodeIncomingMessage, socket: INodeSocket, head: INodeBuffer): Promise<void>

參數

req
INodeIncomingMessage

符合 INodeIncomingMessage 介面的 HTTP 要求。

socket
INodeSocket

套接字 INodeSocket 介面。

head
INodeBuffer

緩衝區 INodeBuffer 介面。

傳回

Promise<void>

在處理 WebSocket 升級之後解決的 Promise，否則會拒絕並出現擲回的錯誤。

setOnCloseHandler((x: any) => void)

設定在遇到套接字關閉時要呼叫的回呼。

function setOnCloseHandler(handler: (x: any) => void)

參數

handler

(x: any) => void

要處理「close」 事件的回呼。

setOnErrorHandler((x: any) => void)

設定回呼以在發生錯誤時呼叫。

function setOnErrorHandler(handler: (x: any) => void)

參數

handler

(x: any) => void

要處理「錯誤」事件的回呼。

setOnMessageHandler((x: any) => void)

設定套接字上所接收 'data' 和 'message' 事件的處理程式。

function setOnMessageHandler(handler: (x: any) => void)

參數

handler

(x: any) => void

要處理「訊息」事件的回呼。

write(INodeBuffer)

將緩衝區寫入套接字，並將它傳送。

function write(buffer: INodeBuffer)

參數

buffer
INodeBuffer

要跨連線傳送的數據緩衝區。