对象 WebSocketMessage

websocket 消息对象

创建方法:

var ws = require("ws");

var msg = new ws.Message();

继承关系

构造函数

WebSocketMessage

包处理消息对象构造函数

new WebSocketMessage(Integer type = ws.BINARY,
    Boolean masked = true,
    Integer maxSize = 67108864);

调用参数:

常量

TEXT

指定消息类型 1,代表一个文本类型

const WebSocketMessage.TEXT = 1;

BINARY

指定消息类型 2,代表一个二进制类型

const WebSocketMessage.BINARY = 2;

成员属性

masked

Boolean, 查询和读取 websocket 掩码标记,缺省为 true

Boolean WebSocketMessage.masked;

maxSize

Integer, 查询和设置最大包尺寸,以字节为单位,缺省为 67108864(64M)

Integer WebSocketMessage.maxSize;

value

String, 消息的基本内容

String WebSocketMessage.value;

params

List, 消息的基本参数

List WebSocketMessage.params;

type

Integer, 消息类型

Integer WebSocketMessage.type;

data

Value, 查询消息的数据

readonly Value WebSocketMessage.data;

body

SeekableStream, 包含消息数据部分的流对象

SeekableStream WebSocketMessage.body;

length

Long, 消息数据部分的长度

readonly Long WebSocketMessage.length;

stream

Stream, 查询消息 readFrom 时的流对象

readonly Stream WebSocketMessage.stream;

response

Message, 获取响应消息对象

readonly Message WebSocketMessage.response;

lastError

String, 查询和设置消息处理的最后错误

String WebSocketMessage.lastError;

成员函数

read

从流内读取指定大小的数据,此方法为 body 相应方法的别名

Buffer WebSocketMessage.read(Integer bytes = -1) async;

调用参数:

返回结果:


readAll

从流内读取剩余的全部数据,此方法为 body 相应方法的别名

Buffer WebSocketMessage.readAll() async;

返回结果:


write

写入给定的数据,此方法为 body 相应方法的别名

WebSocketMessage.write(Buffer data) async;

调用参数:


end

设置当前消息处理结束,Chain 处理器不再继续后面的事务

WebSocketMessage.end();

isEnded

查询当前消息是否结束

Boolean WebSocketMessage.isEnded();

返回结果:


clear

清除消息的内容

WebSocketMessage.clear();

sendTo

发送格式化消息到给定的流对象

WebSocketMessage.sendTo(Stream stm) async;

调用参数:


readFrom

从给定的缓存流对象中读取格式化消息,并解析填充对象

WebSocketMessage.readFrom(Stream stm) async;

调用参数:


dispose

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

WebSocketMessage.dispose();

equals

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

Boolean WebSocketMessage.equals(object expected);

调用参数:

返回结果:


toString

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

String WebSocketMessage.toString();

返回结果:


toJSON

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

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

调用参数:

返回结果:


valueOf

返回对象本身的数值

Value WebSocketMessage.valueOf();

返回结果: