WebSocketServer class

要用作流式传输的基于 Web 套接字的服务器。

构造函数

WebSocketServer(ISocket, RequestHandler)

创建 WebSocketServer 类的新实例。

属性

isConnected

检查存储的 ISocket ,并在套接字连接处于打开状态时返回 true

方法

disconnect()

停止此服务器。

send(StreamingRequest)

用于通过此服务器连接发送数据的任务。

start()

用于建立此服务器所使用的连接并开始侦听传入消息。

构造函数详细信息

WebSocketServer(ISocket, RequestHandler)

创建 WebSocketServer 类的新实例。

new WebSocketServer(socket: ISocket, requestHandler?: RequestHandler)

参数

socket
ISocket

基础 Web 套接字。

requestHandler
RequestHandler

可选 RequestHandler ,用于处理此服务器收到的传入消息。

属性详细信息

isConnected

检查存储的 ISocket ,并在套接字连接处于打开状态时返回 true

boolean isConnected

属性值

boolean

true 如果基础 websocket 已准备好并可用于发送消息,则为 ;否则为 false

方法详细信息

disconnect()

停止此服务器。

function disconnect()

send(StreamingRequest)

用于通过此服务器连接发送数据的任务。

function send(request: StreamingRequest): Promise<IReceiveResponse>

参数

request
StreamingRequest

要发送的流式处理请求。

返回

Promise<IReceiveResponse>

一个承诺,该承诺将在发送操作完成后生成接收响应的实例。

start()

用于建立此服务器所使用的连接并开始侦听传入消息。

function start(): Promise<string>

返回

Promise<string>

处理服务器侦听操作的承诺。 只要服务器正在运行,此任务就不会解析。