uexWebSocket

1、简介

webSocket 插件

1.1、说明

webSocket 是HTML5一种新的协议，它实现了浏览器与服务器全双工通信。一开始的握手需要借助HTTP请求完成。该插件可用来实现长连接，推送。

插件集成使用说明：（已集成到平台公共插件，直接勾选打包）

1.2、UI展示

暂无

1.3、开源源码

插件测试用例与源码下载:点击 插件中心至插件详情页 (插件测试用例与插件源码已经提供)

小贴士：集成接口请先下载测试用例与参考文档。

1.4、平台版本支持

本插件的所有API默认支持Android4.0+和iOS7.0+操作系统

有特殊版本要求的API会在文档中额外说明

1.5、接口有效性

本插件所有API默认在插件版本4.0.0+可用

在后续版本中新添加的接口会在文档中额外说明

2、API概览

2.1、方法

open //开启一个webSocket连接

uexWebSocket.open(param)

说明:

创建上传对象

参数:

参数名称 参数类型 是否必选 说明
param JSON string 是 包含目标url的参数 
var param = {
    url:// 以 ws:// 开头的url.
}

返回值: 无

示例:

 var data = {
    url: "ws://192.168.1.69:8887" 
}
uexWebSocket.open(data);
send //向服务端发送数据

uexWebSocket.send(info)

说明:

向服务端发送数据

参数:

参数名称 参数类型 是否必选 说明
info JSON String 是 待发送的数据

info的数据结构如下:

var info = {
    data:, //String, 待发送的数据
}

返回值: 无

示例:


var info = {
    data: 'text'
}
uexWebSocket.send(info);
close //关闭webSocket链接

uexWebSocket.close()

说明:

关闭webSocket链接

参数: 无

返回值: 无

示例:

uexWebSocket.close()

2.2 监听方法

onConnect //和服务器建立连接的监听

uexWebSocket.onConnect()

参数 无

示例

uexWebSocket.onConnect = function() {
    console.log('[onConnect]');
}
onMessage //接收到消息的监听

uexWebSocket.onMessage(data)

参数

参数名称 参数类型 是否必选 说明
data String 是 接收到的消息数据

示例

uexWebSocket.onMessage = function(data) {
    console.log('[received]' + data);
}
onClose //关闭webSocket链接的监听

uexWebSocket.onClose()

参数 无

示例

uexWebSocket.onClose = function() {
    console.log('[close]');
}

3、更新历史

iOS

API版本: uexWebSocket-4.0.0

最近更新时间:2016-11-23

历史发布版本 更新内容
Android

API版本: uexWebSocket-4.0.0

最近更新时间:2016-11-23

最近更新时间:2016-11-23

| 历史发布版本 | 更新内容 | | ------ | ------ |

还需要帮助吗? 联系我们
最新更新 8th Jul 2021