通过

StreamManager class

  • 参考
包:
botframework-streaming

协调和管理流。

构造函数

StreamManager((contentStreamAssembler: PayloadAssembler) => void)

初始化 StreamManager 类的新实例。

方法

closeStream(string)

使用给定 ID 关闭分配给 SubscribableStream 的 PayloadAssembler。
getPayloadAssembler(string)

检索具有给定 ID 的 PayloadAssembler （如果存在），否则会创建一个新实例并分配给定 ID。
getPayloadStream(IHeader)

从此管理器管理的 PayloadAssembler 检索 SubscribableStream。
onReceive(IHeader, SubscribableStream, number)

用于在收到数据时设置托管 PayloadAssembler 的行为。

构造函数详细信息

StreamManager((contentStreamAssembler: PayloadAssembler) => void)

初始化 StreamManager 类的新实例。

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

参数

onCancelStream

(contentStreamAssembler: PayloadAssembler) => void

取消托管流时触发的函数。

方法详细信息

closeStream(string)

使用给定 ID 关闭分配给 SubscribableStream 的 PayloadAssembler。

function closeStream(id: string)

参数

id

string

要关闭的 SubscribableStream 的 ID。

getPayloadAssembler(string)

检索具有给定 ID 的 PayloadAssembler （如果存在），否则会创建一个新实例并分配给定 ID。

function getPayloadAssembler(id: string): PayloadAssembler

参数

id

string

要检索或创建的 PayloadAssembler 的 ID。

返回

PayloadAssembler

具有给定 ID 的 PayloadAssembler 。

getPayloadStream(IHeader)

从此管理器管理的 PayloadAssembler 检索 SubscribableStream。

function getPayloadStream(header: IHeader): SubscribableStream

参数

header
IHeader

要检索的 SubscribableStream 的标头。

返回

SubscribableStream

具有给定标头的 SubscribableStream 。

onReceive(IHeader, SubscribableStream, number)

用于在收到数据时设置托管 PayloadAssembler 的行为。

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

参数

header
IHeader

流的标头。

contentStream
SubscribableStream

要向其写入传入数据的 SubscribableStream 。

contentLength

number

要写入 contentStream 的数据量。