SocketTask

---

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

SocketTask.send(Object object)

通过 WebSocket 连接发送数据，发送成功会触发 onMessage 事件，请在相应的回调函数中处理。

参数

Object object

属性	类型	默认值	必填	说明
data	string		是	需要发送的内容
fail	function		否	接口调用失败的回调函数

SocketTask.close(Object object)

关闭 WebSocket 连接，关闭成功会触发 onClose 事件，请在相应的回调函数中处理。

参数

Object object

属性	类型	默认值	必填	说明
code	number	1000（表示正常关闭连接）	否	一个数字值表示关闭连接的状态号，表示连接被关闭的原因。
reason	string		否	一个可读的字符串，表示连接被关闭的原因。这个字符串必须是不长于 123 字节的 UTF-8 文本（不是字符）。
fail	function		否	接口调用失败的回调函数。

SocketTask.onOpen(function callback)

监听 WebSocket 连接打开事件。

参数

function callback

WebSocket 连接打开事件的回调函数，回调函数无参数。

SocketTask.onMessage(function callback)

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

参数

function callback

WebSocket 接受到服务器的消息事件的回调函数。

参数

Object res

属性	类型	说明
data	string	服务器返回的消息

SocketTask.onClose(function callback)

监听 WebSocket 连接关闭事件。

参数

function callback

WebSocket 连接关闭事件的回调函数。

参数

Object res

属性	类型	说明
code	number	一个数字值表示关闭连接的状态号，表示连接被关闭的原因。
reason	string	一个可读的字符串，表示连接被关闭的原因。

SocketTask.onError(function callback)

监听 WebSocket 错误事件。

参数

function callback

WebSocket 错误事件的回调函数。

参数

Object res

属性	类型	说明
errMsg	string	错误信息