PayloadReceiver class

用于流式传输的有效负载接收器。

属性

disconnected
isConnected

获取当前连接状态

方法

connect(ITransportReceiver)

连接到传输接收器

disconnect(TransportDisconnectedEvent)

强制此接收器断开连接。

subscribe((header: IHeader) => SubscribableStream, (header: IHeader, stream: SubscribableStream, count: number) => void)

允许订阅此接收方,以便在新数据传入时收到通知。

属性详细信息

disconnected

disconnected?: TransportDisconnectedEventHandler

属性值

isConnected

获取当前连接状态

boolean isConnected

属性值

boolean

如果连接到传输发送方,则为 true。

方法详细信息

connect(ITransportReceiver)

连接到传输接收器

function connect(receiver: ITransportReceiver): Promise<void>

参数

receiver
ITransportReceiver

要从中拉取传入数据的 ITransportReceiver 对象。

返回

Promise<void>

在接收方完成时解析的承诺

disconnect(TransportDisconnectedEvent)

强制此接收器断开连接。

function disconnect(event?: TransportDisconnectedEvent)

参数

event
TransportDisconnectedEvent

广播断开连接事件时要包括的事件参数。

subscribe((header: IHeader) => SubscribableStream, (header: IHeader, stream: SubscribableStream, count: number) => void)

允许订阅此接收方,以便在新数据传入时收到通知。

function subscribe(getStream: (header: IHeader) => SubscribableStream, receiveAction: (header: IHeader, stream: SubscribableStream, count: number) => void)

参数

getStream

(header: IHeader) => SubscribableStream

收到新流时回调。

receiveAction

(header: IHeader, stream: SubscribableStream, count: number) => void

收到新消息时回调。