WebSocketTransport class

基于 Web 套接字的传输。

构造函数

WebSocketTransport(ISocket)

创建 WebSocketTransport 类的新实例。

属性

isConnected

如果传输连接到套接字,则返回 true。

方法

close()

关闭此传输连接到的套接字。

onReceive(INodeBuffer)

设置传输以尝试接收尚未到达的传入数据。

receive(number)

尝试从连接的套接字接收传入数据。

send(INodeBuffer)

通过套接字的连接发送给定缓冲区。

构造函数详细信息

WebSocketTransport(ISocket)

创建 WebSocketTransport 类的新实例。

new WebSocketTransport(ws: ISocket)

参数

ws
ISocket

要在上面构建此传输的 ISocket。

属性详细信息

isConnected

如果传输连接到套接字,则返回 true。

boolean isConnected

属性值

boolean

如果传输已连接并准备好发送数据,true 否则 false

方法详细信息

close()

关闭此传输连接到的套接字。

function close()

onReceive(INodeBuffer)

设置传输以尝试接收尚未到达的传入数据。

function onReceive(data: INodeBuffer)

参数

data
INodeBuffer

要在其中存储传入数据的缓冲区。

receive(number)

尝试从连接的套接字接收传入数据。

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

参数

count

number

要尝试接收的字节数。

返回

Promise<INodeBuffer>

用收到的数据填充的缓冲区。

send(INodeBuffer)

通过套接字的连接发送给定缓冲区。

function send(buffer: INodeBuffer): number

参数

buffer
INodeBuffer

要通过连接发送的缓冲数据。

返回

number

一个数字,指示成功发送数据时发送的数据长度,否则为 0。