示例代码
var tcp = require('tcp');
function onConnect() {
tcpClient.send({
message: 'hello, this is tcp client test',
success: function() {
console.log('tcp send success');
},
fail: function() {
console.log('tcp send failed');
}
});
}
var tcpClient = tcp.createClient({
host: '47.101.151.113',
port: 50020,
success: function() {
console.log('tcp client connect success');
},
fail: function() {
console.log('tcp client connect failed');
}
});
tcpClient.on('message', function(data) {
console.log('tcp receive data: ' + data);
tcpClient.close();
});
tcpClient.on('connect', function() {
console.log('tcp client connected');
onConnect();
});
tcpClient.on('close', function() {
console.log('tcp client closed');
});
tcpClient.on('error', function(err) {
console.log('tcp client error: ' + err);
});
createClient(Object options)
创建一个 TCPClient 实例,创建TCP客户端时会连接TCP Server。
入参
Object类型,其属性有:
属性 | 类型 | 必填 | 描述 |
host | String | 是 | 需要连接的IP地址或者域名 |
port | Number | 是 | 需要连接的端口号 |
success | Function | 否 | 连接成功的回调函数 |
fail | Function | 否 | 连接失败的回调函数 |
返回值
- 一个 TCPClient 实例。
TCPClient 实例
事件
当socket关闭时,触发'close'事件。
当连接到socket服务器时,触发'connect'事件。
当连接断开时,触发'disconnect'事件。
当socket接收到数据时,触发'message'事件。
当socket通信过程中遇到错误时,触发'error'事件。
属性
本地绑定的端口号。
方法
向TCP Server 发送消息。
关闭 TCP Client 实例,相当于销毁。
注册 TCP Client 事件回调函数。
事件:'close'
当socket关闭时,'close'事件触发。
事件:'connect'
当连接到socket服务器时,'connect'事件触发。
事件:'disconnect'
当连接断开时,'disconnect'事件触发。服务端断开连接、主动断开连接、网络发生异常等都会触发。
事件:'message'
当socket接收到数据时,'message'事件触发。回调函数的参数有:
属性 | 类型 | 描述 |
message | ArrayBuffer | 接收到的tcp数据。 |
事件:'error'
当socket通信过程中遇到错误时,'error'事件触发。'error'事件的回调函数参数有:
属性 | 类型 | 描述 |
error | String | 错误信息 |
TCPClient.localPort
本地绑定的端口号,该端口号为系统自动分配。
TCPClient.send(Object option)
向TCP Server 发送消息。
入参
入参为 Object 类型,属性有:
属性 | 类型 | 必填 | 描述 |
message | String | ArrayBuffer | 是 | 要发送的数据 |
success | Function | 否 | 发送成功的回调函数 |
fail | Function | 否 | 发送失败的回调函数 |
TCPClient.reconnect()
当发生 'disconnect'事件 时,可以使用该接口主动连接。
TCPClient.close()
关闭 UDP Socket 实例,断开连接。
TCPClient.on(String event, Function callback)
监听事件。
入参
属性 | 类型 | 必填 | 描述 |
event | String | 是 | 注册的事件名称 |
callback | Function | 是 | 监听事件的回调函数 |
在文档使用中是否遇到以下问题
更多建议
匿名提交