socketServerClient

startServer stopServer sendMessage getAddress startHttpFileServer stopHttpFileServer clientConnect clientSend

概述

socketServerClient 建立Socket服务端原生插件，建立Socket服务监听端口与Socket客户端实现局域网长连接通讯。以及建立文件服务，使其他设备可以再局域网内通过http下载分享的文件

startServer

开启服务

startServer({params}, callback(ret, err))

params

charset:

  • 类型：字符串类型
  • 描述：(可选)编码格式
  • 默认值：‘UTF-8’

port:

  • 类型：（可选）数字类型
  • 描述：端口号
  • 默认值：2199

heart：

  • 类型：JSON 对象
  • 描述：心跳设置
{ heartTime:3,             //数字类型; 心跳间隔 单位：s
  sendHeartMsg:'',        //字符串; 心跳数据
  receiveHeartMsg:''       //字符串; 心跳数据 
}

send：

  • 类型：JSON 对象
  • 描述：(可选)发送包设置
{ head:'',              //（可选) 字符串; 数据包头
end:'',                 //(可选)  字符串; 数包尾 
outTime:5,             //（可选） 数字类型;  发送超时时间 单位：s
sendByLength:{ 	       //（可选）JSON 对象
  length:8             //分包长度 数字类型
    } 
}

receive：

  • 类型：JSON 对象
  • 描述：(可选)接收包设置
{ head:'',        //（可选）字符串; 数据包头
end:'' ,          //( 可选)字符串;  数包尾按包尾接收时有效 默认：\n
outTime:5,        //（可选） 数字类型; 接收超时时间 单位：s
 receiveByLength:{ //（可选）JSON 对象;  默认按包尾结束符接收 有此设置则按照包长度接收
 length:8        //数字类型; 分包长度
    } 
}

single：

  • 类型：布尔类型
  • 描述：以单例模式打开服务
  • 默认：true

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
{
   status: true,           //布尔型；true||false 服务创建/停止
   receiveMsg:'',          //字符串; 接收数据
   link:true,              //布尔型; true||false 链接/断开 建立链接回调
   clientId:1,             //数字类型 客户端id  
    heartMsg:''        //字符串; 心跳返回数据

  }

err：

  • 类型：JSON 对象
  • 内部字段：
{
   msg:''//开启服务失败信息	
  }

示例代码

var socketServerClient= api.require('socketServerClient');
socketServerClient.startServer({
port:3445,
heart:{
  heartTime:3,
  heartMsg:'heart',
  receiveMsg:'heart'
},send:{
   head:'head', 
   end:'end', 
   outTime:5,
   sendByLength:{
     length:8
},receive:{
   head:'head', 
   end:'end' , 
   outTime:5, 
   sendByLength:{
     length:8
}},function(ret, err) {
});

可用性

Android系统，iOS系统

可提供的1.0.0及更高版本

stopServer

停止服务

stopServer({params})

parameter

single：

  • 类型：布尔类型
  • 描述：单例模式下操作
  • 默认：true

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
{
status: true      //布尔型；true||false
}

err：

  • 类型：JSON 对象
  • 内部字段：
{
   msg:''//错误信息
  }

示例代码

var socketServerClient= api.require('socketServerClient');
socketServerClient.stopServer(function(ret, err) {
});

可用性

Android系统，iOS系统

可提供的1.0.0及更高版本

sendMessage

发送消息

sendMessage({params})

params

id:

  • 类型：数字类型
  • 描述：客户端id，客户端连接到服务端时，在服务端的startServer回调中获取需要自己保存 clientId以供发送消息时使用。

data:

  • 类型：字符串
  • 描述：发送消息的数据

single：

  • 类型：布尔类型
  • 描述：单例模式下操作
  • 默认：true

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
{
status: true ,//布尔型；true||false
}

err：

  • 类型：JSON 对象
  • 内部字段：
{
   msg:''//错误信息
  }

示例代码

var socketServerClient= api.require('socketServerClient');
socketServerClient.sendMessage();

可用性

Android系统，iOS系统

可提供的1.0.0及更高版本

getAddress

获取接收ip、端口号

getAddress({params})

params

single：

  • 类型：布尔类型
  • 描述：单例模式下操作
  • 默认：true

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
{
status: true ,     //布尔型；true||false
ip:'',                 //字符串；服务链接ip  
port:80           //数字类型；服务端口号  
}

err：

  • 类型：JSON 对象
  • 内部字段：
{
msg:''//错误信息
}

示例代码

var socketServerClient= api.require('socketServerClient');
socketServerClient.getAddress(function(ret,err){
api.alert({msg:ret});
});

可用性

Android系统，iOS系统

可提供的1.0.0及更高版本

startHttpFileServer

开启文件服务，返回链接地址，可通过返回地址下载文件

startHttpFileServer({params})

params

filePath:

  • 类型：字符串
  • 描述：文件目录 支持fs目录以及绝对路径

port:

  • 类型：数字类型
  • 描述：（可选）端口号
  • 默认：8080

single：

  • 类型：布尔类型
  • 描述：以单例模式开启服务
  • 默认：true

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
{
status: true ,     //布尔型；true||false
url:''               //文件下载地址  字符串
}

err：

  • 类型：JSON 对象
  • 内部字段：
{
msg:''//错误信息
}

示例代码

var socketServerClient= api.require('socketServerClient');
socketServerClient.startHttpFileServer({
filePath:'/storage/emulated/0/Download/yonbuilder.jpg',
port:5566
}function(ret,err){
api.alert({msg:ret});
});

可用性

Android系统，iOS系统

可提供的1.0.0及更高版本

stopHttpFileServer

停止文件服务，关闭后不可通过http下载此设备文件

stopHttpFileServer({params})

params

single：

  • 类型：布尔类型
  • 描述：单例模式下操作
  • 默认：true

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
{
status: true ,     //布尔型；true||false
}

err：

  • 类型：JSON 对象
  • 内部字段：
{
    msg:''//错误信息
}

示例代码

var socketServerClient= api.require('socketServerClient');
socketServerClient.getAddress(function(ret,err){
api.alert({msg:ret});
});

可用性

Android系统，iOS系统

可提供的1.0.0及更高版本

clientConnect

创建客户端链接到服务端

clientConnect({params})

params

ip：

  • 类型：字符串类型
  • 描述：服务端的ip地址，startServer之后可以通过服务端的getAddress方法获取

port：

  • 类型：数字类型
  • 描述：服务端的端口号，可以通过服务端的getAddress获取
  • 默认：2099

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
{
status: true ,     //布尔型；true||false 是否链接到服务端
receiveMsg:'',     //字符串; 接收服务端发送的数据
}

err：

  • 类型：JSON 对象
  • 内部字段：
{
    msg:''//错误信息
}

示例代码

var ArgFace = api.require('socketServerClient');
ArgFace.clientConnect({
    ip:"192.168.43.1",
    port:42462
},function(ret,err){
    if(ret.receiveMsg){
        alert(ret.receiveMsg);
    }
});

可用性

Android系统，iOS系统

可提供的1.0.0及更高版本

clientSend

发送消息

clientSend({params})

params

data:

  • 类型：字符串
  • 描述：发送消息的数据

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
{
status: true ,//布尔型；true||false 
}

err：

  • 类型：JSON 对象
  • 内部字段：
{
   msg:''//错误信息
  }

示例代码

var ArgFace = api.require('socketServerClient');
ArgFace.clientSend({
    data:'123456',
},function(ret,err){
    api.alert({msg:ret});
});

可用性

Android系统，iOS系统

可提供的1.0.0及更高版本

是否仍需要帮助？ 请保持联络！
最后更新于 2025/09/15