udp

说明

硬件平台支持

硬件平台

是否支持

说明

HaaS600-EC100Y

HaaS600-EC600S

HaaS510

HaaS531

HaaS100

开发中

HaaS EDU K1

开发中

HaaS200

开发中

示例代码

var udp = require('udp');

var udpSocket = udp.createSocket();

// bind port
udpSocket.bind(8061);

udpSocket.on('send', function() {
  console.log('udp data send');
});

udpSocket.on('message', function(data, rinfo) {
  console.log('receive data from ' + rinfo.host + ' port: ' + rinfo.port);
  console.log('udp socket just receive data is: ' + data);
  udpSocket.close();
});

udpSocket.on('close', function() {
  console.log('udp close');
});

udpSocket.on('error', function(err) {
  console.log('udp error ' + err);
});

udpSocket.send({
  address: '192.168.193.2',
  port: 8848,
  message: 'hello, this is amp'
});

createSocket()

创建一个 UDP Socket 实例。

返回值

  • UDPSocket

一个 UDP Socket 实例。

UDPSocket 实例

事件

  • 事件:'close'

socket关闭时,会触发close事件。

  • 事件:'send'

socket数据发送成功后,会触发send事件。

  • 事件:'message'

接收到新的数据包时,会触发message事件。

  • 事件:'error'

发生错误时,会触发error事件。

属性

  • UDPSocket.localPort

本地绑定的端口。

方法

  • UDPSocket.bind(Number port)

绑定一个系统随机分配的可用端口,或绑定一个指定的端口号。

  • UDPSocket.send(Object target)

向指定的 IP 和 port 发送消息。

  • UDPSocket.close()

关闭 UDP Socket 实例,相当于销毁。

  • UDPSocket.on(String event, function callback)

注册 UDP Socket 事件回调函数。

事件:'close'

socket关闭时,会触发'close'事件。

事件:'sent'

socket数据发送成功后,会触发'sent'事件。

事件:'message'

接收到新的数据包时,会触发'message'事件。'message'事件的回调函数参数有:

属性

类型

描述

message

ArrayBuffer

接受到的UDP数据

rinfo

Object

发送端地址信息,详细属性见下面

rinfo属性说明:

属性

类型

描述

host

String

发送端IP地址

port

Number

发送端端口

事件:'error'

发生错误时,会触发'error'事件。'error'事件的回调函数参数有:

属性

类型

描述

error

String

错误信息

UDPSocket.localPort

本地绑定的端口。

UDPSocket.bind(Number port)

绑定一个系统随机分配的可用端口,或绑定一个指定的端口号。

入参

属性

类型

必填

描述

port

Number

指定要绑定的端口号,不传则返回系统随机分配的可用端口

返回值

  • 端口号,Number类型。

UDPSocket.send(Object target)

向指定的 ip地址 和 port 发送消息。

入参

入参为 Object 类型,属性如下:

属性

类型

必填

描述

address

String

要发消息的地址,可以是ip地址,也可以是域名

port

Number

要发送消息的端口号

message

String | Array

要发送的数据

success

Function

发送成功时的回调函数

fail

Function

发送失败时的回调函数

UDPSocket.close()

关闭 UDP Socket 实例,相当于销毁。

UDPSocket.on(String event, Function callback)

监听事件。