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。