SocketTask-WebSocket 任务

基础库 1.7.0 开始支持,低版本需做兼容处理

WebSocket 任务,可通过 wx.connectSocket() 接口创建返回。

方法

SocketTask.send(OBJECT)

通过 WebSocket 连接发送数据。

OBJECT参数说明:

参数类型必填说明
dataString/ArrayBuffer需要发送的内容
successFunction接口调用成功的回调函数
failFunction接口调用失败的回调函数
completeFunction接口调用结束的回调函数(调用成功、失败都会执行)
SocketTask.close(OBJECT)

关闭 WebSocket 连接。

OBJECT参数说明:

参数类型必填说明
codeNumber一个数字值表示关闭连接的状态号,表示连接被关闭的原因。如果这个参数没有被指定,默认的取值是1000 (表示正常连接关闭)
reasonString一个可读的字符串,表示连接被关闭的原因。这个字符串必须是不长于123字节的UTF-8 文本(不是字符)
successFunction接口调用成功的回调函数
failFunction接口调用失败的回调函数
completeFunction接口调用结束的回调函数(调用成功、失败都会执行)
SocketTask.onOpen(CALLBACK)

监听 WebSocket 连接打开事件。

SocketTask.onClose(CALLBACK)

监听 WebSocket 连接关闭事件。

SocketTask.onError(CALLBACK)

监听 WebSocket 错误。

CALLBACK返回参数:

参数类型说明
errMsgString错误信息
SocketTask.onMessage(CALLBACK)

监听WebSocket接受到服务器的消息事件。

CALLBACK返回参数:

参数类型说明
dataString/ArrayBuffer