acWebsocket

立即使用

open close send getSocketReadyState addEventListener

WebSocket简介

WebSocket是一种在单个TCP连接上进行全双工通信的协议。WebSocket通信协议于2011年被IETF定为标准RFC 6455，并由RFC7936补充规范。WebSocket API也被W3C定为标准。 WebSocket使得客户端和服务器之间的数据交换变得更加简单，允许服务端主动向客户端推送数据。在WebSocket API中，浏览器和服务器只需要完成一次握手，两者之间就直接可以创建持久性的连接，并进行双向数据传输。

概述

本模块封装了的WebSocket通信

open

连接websocket

open({params})

params

url:

  • 类型：字符串
  • 描述：连接地址

heartInterval:

  • 类型：数字
  • 描述：（可选项）发送心跳包间隔
  • 默认：0（不发送）

heartData:

  • 类型：字符串
  • 描述：（可选项）发送心跳包内容，heartInterval大于0有效
  • 默认：'heartData'

示例代码

var acWebsocket = api.require('acWebsocket');
acWebsocket.open({
   url :''
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

close

断开连接websocket

close()

示例代码

var acWebsocket= api.require('acWebsocket');
acWebsocket.close();

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

send

发送消息

send({params})

params

content:

  • 类型：字符串
  • 描述：发送的消息内容

示例代码

var acWebsocket = api.require('acWebsocket');
acWebsocket.send({
   content :''
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

getSocketReadyState

获取WebSocket连接状态

getSocketReadyState(callback(ret))

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
{
     state:'',      //字符串类型；连接状态
                    //none（未连接）
                    //connecting（连接中）
                    //open（已连接） 
                    //closing（断开连接中）   
                    //closed（已断开连接）                      
}

示例代码

var acWebsocket = api.require('acWebsocket');
acWebsocket.getSocketReadyState(function(ret, err) {
   alert(JSON.stringify(ret));
});

可用性

Android系统，iOS系统

可提供的1.0.0及更高版本

addEventListener

添加监听

addEventListener(callback(ret))

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
{
     eventType:,    //字符串类型；账号事件类型
                    //open（连接）
                    //close（断开连接）
                    //receiveMessage（收到消息）  
     message:''     //收到的消息内容                   
}

示例代码

var acWebsocket = api.require('acWebsocket');
acWebsocket.addEventListener(function(ret, err) {
   alert(JSON.stringify(ret));
});

可用性

Android系统，iOS系统

可提供的1.0.0及更高版本