NodeWebSocket class
ISocket 的实现，用于 NodeWebSocketFactory 以创建 WebSocket 服务器。
构造函数
| Node |
创建新的 NodeWebSocket 实例。 |
属性
| is |
指示“ws”WebSocket 当前是否已连接并准备好发送消息。 |
方法
| close(number, string) | 关闭套接字。 |
| connect(string, number) | 使用 WebSocket 协议连接到支持套接字。 |
| create(INode |
使用 HTTP 请求、套接字和缓冲区创建和设置 |
| set |
设置在遇到套接字关闭时要调用的回调。 |
| set |
设置在遇到错误时要调用的回调。 |
| set |
设置 |
| write(INode |
将缓冲区写入套接字并发送它。 |
构造函数详细信息
NodeWebSocket(WebSocket)
创建新的 NodeWebSocket 实例。
new NodeWebSocket(wsSocket?: WebSocket)参数
- wsSocket
-
WebSocket
要 ws 建立此连接的 WebSocket 实例。
属性详细信息
isConnected
指示“ws”WebSocket 当前是否已连接并准备好发送消息。
boolean isConnected属性值
boolean
true 如果基础 websocket 已准备好并可用于发送消息，则为 ;否则为 false。
方法详细信息
close(number, string)
关闭套接字。
function close(code?: number, data?: string)参数
- code
-
number
可选状态代码，用于说明连接已关闭的原因。
- data
-
string
用于解释连接关闭原因的可选附加数据。
注解
（可选）传入说明连接关闭原因的状态代码和字符串。
connect(string, number)
使用 WebSocket 协议连接到支持套接字。
function connect(serverAddress: string, port?: number): Promise<void>参数
- serverAddress
-
string
服务器正在侦听的地址。
- port
-
number
服务器正在侦听的端口，默认为 8082。
返回
Promise<void>
在 Websocket 连接关闭或错误时拒绝时解决的 Promise。
create(INodeIncomingMessage, INodeSocket, INodeBuffer)
使用 HTTP 请求、套接字和缓冲区创建和设置 ws WebSocket。
function create(req: INodeIncomingMessage, socket: INodeSocket, head: INodeBuffer): Promise<void>参数
与 INodeIncomingMessage 接口匹配的 HTTP 请求。
- socket
- INodeSocket
套接字 INodeSocket 接口。
- head
- INodeBuffer
缓冲区 INodeBuffer 接口。
返回
Promise<void>
处理 WebSocket 升级后解决的 Promise，否则拒绝并引发错误。
setOnCloseHandler((x: any) => void)
设置在遇到套接字关闭时要调用的回调。
function setOnCloseHandler(handler: (x: any) => void)参数
- handler
-
(x: any) => void
用于处理“close”事件的回调。
setOnErrorHandler((x: any) => void)
设置在遇到错误时要调用的回调。
function setOnErrorHandler(handler: (x: any) => void)参数
- handler
-
(x: any) => void
用于处理“error”事件的回调。
setOnMessageHandler((x: any) => void)
设置 'data' 套接字上收到的 和 'message' 事件的处理程序。
function setOnMessageHandler(handler: (x: any) => void)参数
- handler
-
(x: any) => void
用于处理“message”事件的回调。