微信小程序API Websocket


当前第2页 返回上一页

CALLBACK返回参数:

参数 类型 说明
data String/ArrayBuffer 服务器返回的消息

示例代码:

wx.connectSocket({
  url: 'test.php'
})

wx.onSocketMessage(function(res) {
  console.log('收到服务器内容:' + res.data)
})

wx.closeSocket(OBJECT)


关闭WebSocket连接。

参数 类型 必填 说明 最低版本
code Number 一个数字值表示关闭连接的状态号,表示连接被关闭的原因。如果这个参数没有被指定,默认的取值是1000 (表示正常连接关闭) 1.4.0
reason String 一个可读的字符串,表示连接被关闭的原因。这个字符串必须是不长于123字节的UTF-8 文本(不是字符) 1.4.0
success Function 接口调用成功的回调函数  
fail Function 接口调用失败的回调函数  
complete Function 接口调用结束的回调函数(调用成功、失败都会执行)  

wx.onSocketClose(CALLBACK)


监听WebSocket关闭。

wx.connectSocket({
  url: 'test.php'
})

//注意这里有时序问题,
//如果 wx.connectSocket 还没回调 wx.onSocketOpen,而先调用 wx.closeSocket,那么就做不到关闭 WebSocket 的目的。
//必须在 WebSocket 打开期间调用 wx.closeSocket 才能关闭。
wx.onSocketOpen(function() {
  wx.closeSocket()
})

wx.onSocketClose(function(res) {
  console.log('WebSocket 已关闭!')
})

返回值:

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

返回一个 SocketTask。

Bug & Tip

  1. tip: createSocket 链接默认和最大超时时间都是 60s
  2. tip: 网络请求的 referer 是不可以设置的,格式固定为 https://servicewechat.com/{appid}/{version}/page-frame.html,其中{appid}为小程序的 appid,{version}为小程序的版本号,版本号为 0 表示为开发版。

SocketTask

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

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

方法

SocketTask.send(OBJECT)

通过 WebSocket 连接发送数据。

OBJECT参数说明:

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

关闭 WebSocket 连接。

OBJECT参数说明:

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

监听 WebSocket 连接打开事件。

SocketTask.onClose(CALLBACK)

监听 WebSocket 连接关闭事件。

SocketTask.onError(CALLBACK)

监听 WebSocket 错误。

CALLBACK返回参数:

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

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

CALLBACK返回参数:

参数 类型 说明
data String/ArrayBuffer 服务器返回的消息

标签:微信小程序

返回前面的内容

相关阅读 >>

微信小程序开放数据 ad-custom

sdk数据库 database索引

微信小程序云开发服务端数据库api 地理位置构造器

微信小程序特有页面间传参方式

微信小程序云开发服务端数据库api 指定返回结果中记录需返回的字段

微信小程序云开发存储

微信小程序 消息-位置消息

微信小程序api-设备-扫码

微信小程序 多人音视频对话

微信小程序api 在设置界面中修改对该小程序的授权信息

更多相关阅读请进入《微信小程序》频道 >>




打赏

取消

感谢您的支持,我会继续努力的!

扫码支持
扫码打赏,您说多少就多少

打开支付宝扫一扫,即可进行扫码打赏哦

分享从这里开始,精彩与您同在

评论

管理员已关闭评论功能...