7 uap mobile api reference uap_plug_api uexsocketmgr

1、uexSocketMgr1、简介 2、API概览 3、更新历史 1、简介 socket插件 1.1 、说明 socket管理接口API,该对象主要封装了tcp,udp的创建以及传输数据文件等接口.1.2 、UI展示1.3 、开源源码 插件测试用例与源码下载:点击插件中心至插件详情页 (插件测试用例与插件源码已经提供)1.4 、平台版本支持 本插件的所有API默认支持Android4.0+和iOS7.0+操作系统. 有特殊版本要求的API会在文档中额外说明.1.5 、接口有效性 本插件所有API默认在插件版本4.0.0+ 用.在后续版本中新添加的接口会在文档中额外说明.2、API概览2.1、方法

2、 createUDP /创建UDP对象 uexSocketMgr.createUDP(param,onData)说明:创建一个UDP对象. 参数:参数名称参数类型是否必选说明 paramObject是包含创建UDP对象所需的参数 onDataFunct on是收到数据的函数 var param port:, dataType:各字段含义如下:createUDPsendcreateTCPconnectwr tec ose参数名称 参数类型 是否必选 说明portNumber是要绑定的本地端口 dataTypeNumber通讯数据类型 取值范围0,1,2,详见附录-DataType .默认为0否回

3、调参数:var onDatafunct on( nfo)类型参数名称 说明nfoObject收到的数据信息,形式见下:var nfo port:, host:, data:各字段含义如下:说明参数名称 参数类型 是否必选 portNumber是数据来源的端 hostStr ng是数据来源的主机地址 dataStr ng是收到的数据内容 返回值:创建的UDP对象,若创建失败,返回nu .示例:var udpuexSocketMgr.createUDP( data Type: 0,port: 10000,funct on( nfo) aert(JSON.str ngfy( nfo););f(!ud

4、p)aert(创建udp对象失败);send /UDP对象发送数据uexSocketMgr.send(udp,param,cb)说明:UDP对象发送数据。参数:参数类型说明参数名称 是否必选 udpUDP对象由createUDP方法创建得到的UDP对象 是paramOb ect是 是否必选 说包含明发送数据所需数据参数类型参数名称 cbFunct on是发送数据的回调函数 var param host:,port:,data:,t meout:各字段含义如下:说明参数名称 参数类型 是否必选 hostStr ng标IP地址是portNumber是标端dataStr ng是要发送的数据t meo

5、utNumber发送超时时限,单位毫秒.不传或者传小于等于0的值表示没有超时时限 否回调参数:var cb funct on(error)说明参数名称 类型errorNumber为0时表示发送成功,非0时表示发生错误,发送失败示例:var udp ./之前由createUDP方法创建得到的UDP对象uexSocketMgr.send(udp,host: 192.168.1.4,port: 30001, data: udp数据, t meout: 10000,funct on(error)aert(error ? 发送失败 : 发送成功);createTCP /创建TCP对象uexSocketM

6、gr.createTCP(param,onStatus,onData)说明:创建一个TCP对象.参数:参数类型说明参数名称 是否必选 paramObject包含创建TCP对象所需的参数是onStatusFunct onTCP连接状态发生变化的是函数onDataFunct on是收到数据的函数 var param dataType:各字段含义如下:参数名称 参数类型 是否必选 说明dataTypeNumber通讯数据类型 取值范围0,1,2,详见附录-DataType .默认为0否回调参数:var onStatusfunct on(status)类型说明参数名称 statusNumber0 -

7、已连接 服务器 1 - 连接中断 var onDatafunct on( nfo)类型参数名称 说明nfoObject收到的数据信息,形式如下:var nfo data:各字段含义如下:参数名称 参数类型 说明dataStr ng收到的数据内容 返回值:创建的TCP对象,若创建失败,返回nu .示例:var tcp uexSocketMgr.createTCP(dataType: 2, funct on(status)aert(status0 ? 已连接上服务器 : 连接中断);,funct on( nfo) aert( nfo.data););f(!tcp)aert(创建tcp对象失败);c

8、onnect /TCP对象连接至指定的TCP服务器 uexSocketMgr.connect(tcp,param,cb)说明:TCP对象连接至指定的TCP服务器.参数:参数类型说明参数名称 是否必选 tcpTCP对象由createTCP方法创建得到的TCP对象 是paramObject是包含接口所需的参数 cbFunct on是连接的回调函数 var param host:,port:,t meout:各字段详细解释如下:说明参数名称 参数类型 是否必选 hostStr ngTCP服务器IP地址是portNumberTCP服务器端是t meoutNumber发送超时时限,单位毫秒.不传或者传小

9、于等于0的值表示没有超时时限 否回调参数:var cb funct on(error)参数名称 类型 说明errorNumber为0时表示发送成功,非0时表示发生错误,发送失败,连接成功时,也会触发TCP对象本身的onStatus 示例:var tcp ./之前由createTCP方法创建得到的tcp对象uexSocketMgr.connect(tcp,host: 192.168.1.4,port: 30000,t meout: 10000,funct on(error)aert(error ? 连接失败 : 连接成功);write /TCP对象写入数据uexSocketMgr.wr te(t

10、cp,param,cb)说明:TCP对象写入数据.参数:参数类型说明参数名称 是否必选 tcp是 是否必选 TCP对象由createTCP方法创建得到的TCP对象 参数类型说明参数名称 paramObject是写入时所需参数 cbFunct on是写入数据的回调函数 var param data:,t meout:各字段详细解释如下:说明参数名称 参数类型 是否必选 dataStr ng是要写入的数据t meoutNumber写入超时时限,单位毫秒.不传或者传小于等于0的值表示没有超时时限 否回调参数:var cb funct on(error)说明参数名称 类型errorNumber为0时表

11、示写入成功,非0时表示发生错误,写入失败示例:var tcp ./之前由createTCP方法创建得到的tcp对象uexSocketMgr.wr te(tcp,data: tcp数据, t meout: 10000,funct on(error)aert(error ? 写入失败 : 写入成功);close /关闭SocketuexSocketMgr.c ose(socket,param,cb)说明:关闭Socket.参数:说明参数名称 参数类型 是否必选 socketObject由createUDP方法创建得到的UDP对象,或是由createTCP方法创建得到的TCP对象 是paramObj

12、ect是接口所需数据cbFunct on关闭Socket的回调函数 是var param fag:各字段详细解释如下:参数类型参数名称 是否必选 说明f agnumber0 - 立即关闭socket(默认) 1 - 如果存在当前正在进行的读写操作,会等待这些操作结束后再关闭 socket否回调参数:var cb funct on(error)说明参数名称 类型errorNumber为0时表示关闭成功,非0时表示发生错误,关闭失败示例:var socket./之前由createTCP方法创建得到的tcp对象,或者是由createUDP方法创建得到的UDP对象 uexSocketMgr.c ose(socket,fag: 0,funct on(error)aert(error ? 关闭失败 : 关闭成功);3、附录 dataType 通讯数据类型 此值表示与对方(TCP服务端,或者其他UDP客户端)通讯时采用的数据类型,是一个Number类型的枚举值数据类型dataType说明0utf-8双方均采用utf-8编码的字符串进行通讯1base 64此选项多用于二进制流通讯.前端应传入base64编码后的字符串,插件会对其进行解码并发送给对方;收到数据 时,插件会对数据进行base64编码,并将编码后的字符串返回给前端.2gbk当对方要求gbk编码时选择此项.前端应传