对象 WebSocket

WebSocket 包协议转换处理器

用以将 Http 协议转换为 WebSocket 包协议消息。创建方式:

var ws = require("ws");

var sock = new ws.WebSocket(...);

继承关系

构造函数

WebSocket

WebSocket 构造函数

new WebSocket(String url,
    String protocol = "",
    String origin = "");

调用参数:

静态属性

defaultMaxListeners

Integer, 默认全局最大监听器数

static Integer WebSocket.defaultMaxListeners;

成员属性

url

String, 查询当前对象连接的服务器

readonly String WebSocket.url;

protocol

String, 查询当前对象连接时的协议

readonly String WebSocket.protocol;

origin

String, 查询当前对象连接的源

readonly String WebSocket.origin;

readyState

Integer, 查询当前对象的连接状态,参见 ws

readonly Integer WebSocket.readyState;

onopen

Function, 查询和绑定连接成功事件,相当于 on("open", func);

Function WebSocket.onopen;

onmessage

Function, 查询和绑定接受到对方消息的事件,相当于 on("message", func);

Function WebSocket.onmessage;

onclose

Function, 查询和绑定连接关闭的事件,相当于 on("close", func);

Function WebSocket.onclose;

onerror

Function, 查询和绑定错误发生的事件,相当于 on("error", func);

Function WebSocket.onerror;

成员函数

close

关闭当前连接,此操作会向对方发送 CLOSE 数据包,并等待对方响应

WebSocket.close(Integer code = 1000,
    String reason = "");

调用参数:


send

向对方发送一段文本

WebSocket.send(String data);

调用参数:


向对方发送一段二进制数据

WebSocket.send(Buffer data);

调用参数:


on

绑定一个事件处理函数到对象

Object WebSocket.on(String ev,
    Function func);

调用参数:

返回结果:


绑定一个事件处理函数到对象

Object WebSocket.on(Object map);

调用参数:

返回结果:


addListener

绑定一个事件处理函数到对象

Object WebSocket.addListener(String ev,
    Function func);

调用参数:

返回结果:


绑定一个事件处理函数到对象

Object WebSocket.addListener(Object map);

调用参数:

返回结果:


prependListener

绑定一个事件处理函数到对象起始

Object WebSocket.prependListener(String ev,
    Function func);

调用参数:

返回结果:


绑定一个事件处理函数到对象起始

Object WebSocket.prependListener(Object map);

调用参数:

返回结果:


once

绑定一个一次性事件处理函数到对象,一次性处理函数只会触发一次

Object WebSocket.once(String ev,
    Function func);

调用参数:

返回结果:


绑定一个一次性事件处理函数到对象,一次性处理函数只会触发一次

Object WebSocket.once(Object map);

调用参数:

返回结果:


prependOnceListener

绑定一个事件处理函数到对象起始

Object WebSocket.prependOnceListener(String ev,
    Function func);

调用参数:

返回结果:


绑定一个事件处理函数到对象起始

Object WebSocket.prependOnceListener(Object map);

调用参数:

返回结果:


off

从对象处理队列中取消指定函数

Object WebSocket.off(String ev,
    Function func);

调用参数:

返回结果:


取消对象处理队列中的全部函数

Object WebSocket.off(String ev);

调用参数:

返回结果:


从对象处理队列中取消指定函数

Object WebSocket.off(Object map);

调用参数:

返回结果:


removeListener

从对象处理队列中取消指定函数

Object WebSocket.removeListener(String ev,
    Function func);

调用参数:

返回结果:


取消对象处理队列中的全部函数

Object WebSocket.removeListener(String ev);

调用参数:

返回结果:


从对象处理队列中取消指定函数

Object WebSocket.removeListener(Object map);

调用参数:

返回结果:


removeAllListeners

从对象处理队列中取消所有事件的所有监听器, 如果指定事件,则移除指定事件的所有监听器。

Object WebSocket.removeAllListeners(Array evs = []);

调用参数:

返回结果:


setMaxListeners

监听器的默认限制的数量,仅用于兼容

WebSocket.setMaxListeners(Integer n);

调用参数:


getMaxListeners

获取监听器的默认限制的数量,仅用于兼容

Integer WebSocket.getMaxListeners();

返回结果:


listeners

查询对象指定事件的监听器数组

Array WebSocket.listeners(String ev);

调用参数:

返回结果:


listenerCount

查询对象指定事件的监听器数量

Integer WebSocket.listenerCount(String ev);

调用参数:

返回结果:


eventNames

查询监听器事件名称

Array WebSocket.eventNames();

返回结果:


emit

主动触发一个事件

Boolean WebSocket.emit(String ev,
    ...);

调用参数:

返回结果:


dispose

强制回收对象,调用此方法后,对象资源将立即释放

WebSocket.dispose();

equals

比较当前对象与给定的对象是否相等

Boolean WebSocket.equals(object expected);

调用参数:

返回结果:


toString

返回对象的字符串表示,一般返回 "[Native Object]",对象可以根据自己的特性重新实现

String WebSocket.toString();

返回结果:


toJSON

返回对象的 JSON 格式表示,一般返回对象定义的可读属性集合

Value WebSocket.toJSON(String key = "");

调用参数:

返回结果:


valueOf

返回对象本身的数值

Value WebSocket.valueOf();

返回结果: