StreamManager class

パッケージ:

botframework-streaming

ストリームを調整および管理します。

コンストラクター

StreamManager((contentStreamAssembler: PayloadAssembler) => void)

StreamManager クラスの新しいインスタンスを初期化します。

メソッド

closeStream(string)	SubscriptionableStream に割り当てられた PayloadAssembler を、指定された ID で閉じます。
getPayloadAssembler(string)	指定した ID が存在する場合は PayloadAssembler を取得します。それ以外の場合は、新しいインスタンスが作成され、指定された ID が割り当てられます。
getPayloadStream(IHeader)	このマネージャーが管理する PayloadAssembler から、サブスクライブ可能ストリームを取得します。
onReceive(IHeader, SubscribableStream, number)	データを受信したときの Managed PayloadAssembler の動作を設定するために使用されます。

コンストラクターの詳細

StreamManager((contentStreamAssembler: PayloadAssembler) => void)

StreamManager クラスの新しいインスタンスを初期化します。

new StreamManager(onCancelStream: (contentStreamAssembler: PayloadAssembler) => void)

パラメーター

onCancelStream

(contentStreamAssembler: PayloadAssembler) => void

マネージド ストリームが取り消された場合にトリガーする関数。

メソッドの詳細

closeStream(string)

SubscriptionableStream に割り当てられた PayloadAssembler を、指定された ID で閉じます。

function closeStream(id: string)

パラメーター

id

string

閉じる SubscriptionableStream の ID。

getPayloadAssembler(string)

指定した ID が存在する場合は PayloadAssembler を取得します。それ以外の場合は、新しいインスタンスが作成され、指定された ID が割り当てられます。

function getPayloadAssembler(id: string): PayloadAssembler

パラメーター

id

string

取得または作成する PayloadAssembler の ID。

戻り値

PayloadAssembler

指定された ID を持つ PayloadAssembler 。

getPayloadStream(IHeader)

このマネージャーが管理する PayloadAssembler から、サブスクライブ可能ストリームを取得します。

function getPayloadStream(header: IHeader): SubscribableStream

パラメーター

header

IHeader

取得する サブスクライブ可能ストリーム のヘッダー。

戻り値

SubscribableStream

指定されたヘッダーを持つ サブスクライブ可能ストリーム 。

onReceive(IHeader, SubscribableStream, number)

データを受信したときの Managed PayloadAssembler の動作を設定するために使用されます。

function onReceive(header: IHeader, contentStream: SubscribableStream, contentLength: number)

パラメーター

header

IHeader

ストリームのヘッダー。

contentStream

SubscribableStream

受信データを書き込む サブスクライブ可能ストリーム 。

contentLength

number

contentStream に書き込むデータの量。