Pipeline

Pipeline

数据通道服务接口。

Constructor

new Pipeline(name)

Parameters:
Name Type Description
name string

Classes

Pipeline

Members

address :string

服务器地址。

Type:
  • string

kernel :Kernel

内核对象。

Type:

listenerMap :FastMap.<string, (PipelineListener|function())>

监听器。

Type:

name :string

名称。

Type:
  • string

(protected) opened :boolean

是否执行过开启操作。

Type:
  • boolean

port :number

服务器端口。

Type:
  • number

stateListenerList :Array.<PipelineListener>

状态监听器。

Type:

tokenCode :string

有效的令牌编码。

Type:
  • string

Methods

addListener(destination, listener)

添加监听器。

Parameters:
Name Type Description
destination string

指定监听的目标或识别串。
listener PipelineListener

指定通道监听器。

addStateListener(listener)

添加状态监听器。

Parameters:
Name Type Description
listener PipelineListener

指定通道监听器。

close()

关闭数据通道。

(protected) getListeners(destination) → {Array.<PipelineListener>}

获取目标的监听器列表。

Parameters:
Name Type Description
destination string
Returns:

返回目标的监听器列表。

Type
Array.<PipelineListener>

getName() → {string}

获取通道名称。

Returns:

返回通道名称。

Type
string

isReady() → {boolean}

数据通道是否就绪。

Returns:

如果就绪返回 true 。

Type
boolean

open()

启动数据通道。

removeListener(destination, listener)

移除监听器。

Parameters:
Name Type Description
destination string

指定监听的目标或识别串。
listener PipelineListener

指定通道监听器。

removeStateListener(listener)

移除状态监听器。

Parameters:
Name Type Description
listener PipelineListener

指定通道监听器。

send(destination, packet, handleResponseopt)

发送数据。

Parameters:
Name Type Attributes Description
destination string

指定通道的发送目标或接收端识别串。
packet Packet

指定待发送的数据包。
handleResponse ResponseCallback <optional>

本次数据发送对应的应答回调。

setRemoteAddress(address, portopt)

设置服务的地址和端口。

Parameters:
Name Type Attributes Description
address string

服务器访问地址。
port number <optional>

服务器访问端口。

setTokenCode(tokenCode)

设置令牌代码。

Parameters:
Name Type Description
tokenCode string

(protected) touchCallback(source, packet, callback)

触发对应请求的应答。

Parameters:
Name Type Description
source string

来自通道的描述串。
packet Packet

来自服务器的数据包。
callback ResponseCallback

回调函数。

(protected) triggerListeners(source, packet)

触发来自服务器的数据回调。

Parameters:
Name Type Description
source string

通道的描述串。
packet Packet

服务器的数据包。