NamedPipeTransport class

  • リファレンス
パッケージ:
botframework-streaming

名前付きパイプ ベースのトランスポート送信者と受信者の抽象化

コンストラクター

NamedPipeTransport(INodeSocket)

NamedPipeTransport クラスの新しいインスタンスを作成します。

プロパティ

isConnected

現在接続されている場合は true を返します。
PipePath
ServerIncomingPath
ServerOutgoingPath

メソッド

close()

トランスポートを閉じます。
receive(number)

トランスポートからバッファーに受信します。
send(INodeBuffer)

パイプに書き込み、送信します。

コンストラクターの詳細

NamedPipeTransport(INodeSocket)

NamedPipeTransport クラスの新しいインスタンスを作成します。

new NamedPipeTransport(socket: INodeSocket)

パラメーター

socket
INodeSocket

この接続を構築するソケット オブジェクト。

プロパティの詳細

isConnected

現在接続されている場合は true を返します。

boolean isConnected

プロパティ値

boolean

トランスポートが接続されていて、データを送信する準備ができている場合は true します。それ以外の場合は false。

PipePath 

static PipePath: string

プロパティ値

string

ServerIncomingPath 

static ServerIncomingPath: string

プロパティ値

string

ServerOutgoingPath 

static ServerOutgoingPath: string

プロパティ値

string

メソッドの詳細

close()

トランスポートを閉じます。

function close()

receive(number)

トランスポートからバッファーに受信します。

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

パラメーター

count

number

バッファーに書き込む最大バイト数。

戻り値

Promise<INodeBuffer>

トランスポートからのデータを格納しているバッファー。

send(INodeBuffer)

パイプに書き込み、送信します。

function send(buffer: INodeBuffer): number

パラメーター

buffer
INodeBuffer

ソケット間で送信するデータがいっぱいのバッファー。

戻り値

number

データが正常に送信された場合に送信されたデータの長さを示す数値。それ以外の場合は 0。