WebSocketTransport class

套件:

botframework-streaming

Web 套接字型傳輸。

建構函式

WebSocketTransport(ISocket)

建立 WebSocketTransport 類別的新實例。

屬性

isConnected

如果傳輸連接到套接字，則傳回 true。

方法

close()	關閉此傳輸所連接的套接字。
onReceive(INodeBuffer)	設定傳輸以嘗試接收尚未抵達的傳入數據。
receive(number)	嘗試從連接的套接字接收傳入數據。
send(INodeBuffer)	透過套接字的連線，將指定的緩衝區送出。

建構函式詳細資料

WebSocketTransport(ISocket)

建立 WebSocketTransport 類別的新實例。

new WebSocketTransport(ws: ISocket)

參數

ws

ISocket

要建置此傳輸的 ISocket。

屬性詳細資料

isConnected

如果傳輸連接到套接字，則傳回 true。

boolean isConnected

屬性值

boolean

如果傳輸已連線且已準備好傳送數據，則 true 否則為 false。

方法詳細資料

close()

關閉此傳輸所連接的套接字。

function close()

onReceive(INodeBuffer)

設定傳輸以嘗試接收尚未抵達的傳入數據。

function onReceive(data: INodeBuffer)

參數

data

INodeBuffer

要儲存傳入數據的緩衝區。

receive(number)

嘗試從連接的套接字接收傳入數據。

function receive(count: number): Promise<INodeBuffer>

參數

count

number

要嘗試接收的位元組數目。

傳回

Promise<INodeBuffer>

填入已接收數據的緩衝區。

send(INodeBuffer)

透過套接字的連線，將指定的緩衝區送出。

function send(buffer: INodeBuffer): number

參數

buffer

INodeBuffer

要透過連線傳送的緩衝數據。

傳回

number

數位，指出成功傳送數據時所傳送數據的長度，否則為0。