UDP/Datagram Sockets

稳定性: 3 - 稳定

Node.js的dgram模块提供了UDP数据报套接字的实现。

使用数据报文sockets(Datagram sockets)的方式是调用require('dgram')。

重要提醒：dgram.Socket#bind()的行为在v0.10做了改动 ，它总是异步的。如果你的代码像下面的一样：

var s = dgram.createSocket('udp4');
s.bind(1234);
s.addMembership('224.0.0.114');

现在需要改为：

var s = dgram.createSocket('udp4');
s.bind(1234, function() {
  s.addMembership('224.0.0.114');
});

dgram.createSocket(type[, callback])

• type字符串。 'udp4'或'udp6'
• callback函数。附加到message事件的监听器。可选参数。
• 返回：Socket对象

创建指定类型的数据报文(datagram) Socket。有效类型是udp4和udp6

接受一个可选的回调，会被添加为message的监听事件。

如果你想接收数据报文(datagram)可以调用socket.bind()。socket.bind()将会绑定到所有接口（"all interfaces"）的随机端口上（udp4和udp6 sockets都适用）。你可以通过socket.address().address和socket.address().port获取地址和端口。

dgram.createSocket(options[, callback])

• options对象
• callback函数。给message事件添加事件监听器。
• 返回：Socket对象

参数options必须包含type值(udp4或udp6)，或可选的boolean值reuseAddr。

当reuseAddr为 true 时，socket.bind()将会重用地址，即使另一个进程已经绑定socket。reuseAddr默认为false。

回调函数为可选参数，作为message事件的监听器。

如果你想接受数据报文(datagram)，可以调用socket.bind()。socket.bind()将会绑定到所有接口（"all interfaces"）地址的随机端口上（udp4和udp6 sockets都适用）。你可以通过socket.address().address和socket.address().port获取地址和端口。

Class: dgram.Socket

报文数据Socket类封装了数据报文(datagram)函数。必须通过dgram.createSocket(...)函数创建。

Event: 'message'

• msg缓存对象. 消息。
• rinfo对象. 远程地址信息。

当socket上新的数据报文(datagram)可用的时候，会触发这个事件。msg是一个缓存，rinfo是一个包含发送者地址信息的对象。

socket.on('message', function(msg, rinfo) {
  console.log('Received %d bytes from %s:%d\n',
              msg.length, rinfo.address, rinfo.port);
});

Event: 'listening'

当socket开始监听数据报文(datagram)时触发。在UDP socket创建时触发。

Event: 'close'

当socket使用close()关闭时触发。在这个socket上不会触发新的消息事件。

Event: 'error'

• exceptionError对象

当发生错误时触发。

socket.send(buf, offset, length, port, address[, callback])

• buf缓存对象或字符串. 要发送的消息。
• offset整数。消息在缓存中得偏移量。
• length整数。消息的比特数。
• port整数。端口的描述。
• address字符串。目标的主机名或IP地址。
• callback函数。当消息发送完毕的时候调用。可选。

对于UDP socket，必须指定目标端口和地址。address参数可能是字符串，它会被DNS解析。

如果忽略地址或者地址是空字符串，将使用'0.0.0.0'或'::0'替代。依赖于网络配置，这些默认值有可能行也可能不行。

如果socket之前没被调用bind绑定，则它会被分配一个随机端口并绑定到所有接口（"all interfaces"）地址(udp4sockets的'0.0.0.0' ，udp6sockets的'::0')

回调函数可能用来检测DNS错误，或用来确定什么时候重用buf对象。注意，DNS查询会导致发送tick延迟。通过回调函数能确认数据报文(datagram)是否已经发送的。

考虑到多字节字符串情况，偏移量和长度是字节长度byte length，而不是字符串长度。

下面的例子是在localhost上发送一个UDP包给随机端口：

var dgram = require('dgram');
var message = new Buffer("Some bytes");
var client = dgram.createSocket("udp4");
client.send(message, 0, message.length, 41234, "localhost", function(err) {
  client.close();
});

关于UDP数据报文(datagram) 尺寸

IPv4/v6数据报文(datagram)的最大长度依赖于MTU (Maximum Transmission Unit)和Payload Length的长度。

• Payload Length内容为16位宽，它意味着Payload的最大字节说不超过64k，其中包括了头信息和数据（65,507字节 = 65,535 − 8字节UDP头 − 20字节IP 头）；对于环回接口（loopback interfaces）这是真的，但对于多数主机和网络来说不太现实。

• MTU能支持数据报文(datagram)的最大值（以目前链路层技术来说）。对于任何连接，IPv4允许的最小值为68的MTU，推荐值为576（通常推荐作拨号应用的MTU）,无论他们是完整接收还是碎片接收。

  对于IPv6，MTU的最小值为1280字节，最小碎片缓存大小为1500字节。16字节实在是太小，所以目前链路层一般最小MTU大小为1500。

我们不可能知道一个包可能进过的每个连接的MTU。通常发送一个超过接收端MTU大小的数据报文(datagram)会失效。（数据包会被悄悄的抛弃，不会通知发送端数据包没有到达接收端）。

socket.bind(port[, address][, callback])

• port整数
• address字符串，可选
• callback没有参数的函数，可选。绑定时会调用回调。

对于UDP socket，在一个端口和可选地址上监听数据报文(datagram)。如果没有指定地点，系统将会参数监听所有的地址。绑定完毕后，会触发"listening" 事件，并会调用传入的回调函数。指定监听事件和回调函数非常有用。

一个绑定了的数据报文socket会保持node进程运行来接收数据。

如果绑定失败，会产生错误事件。极少数情况（比如绑定一个关闭的socket）。这个方法会抛出一个错误。

以下是UDP服务器监听端口41234的例子：

var dgram = require("dgram");

var server = dgram.createSocket("udp4");

server.on("error", function (err) {
  console.log("server error:\n" + err.stack);
  server.close();
});

server.on("message", function (msg, rinfo) {
  console.log("server got: " + msg + " from " +
    rinfo.address + ":" + rinfo.port);
});

server.on("listening", function () {
  var address = server.address();
  console.log("server listening " +
      address.address + ":" + address.port);
});

server.bind(41234);
// server listening 0.0.0.0:41234

socket.bind(options[, callback])

• options{对象} - 必需. 有以下的属性:
  • port{Number} - 必需.
  • address{字符串} - 可选.
  • exclusive{Boolean} - 可选.
• callback{函数} - 可选.

options的可选参数port和 address，以及可选参数callback，好像在调用socket.bind(port, [address], [callback])。

如果exclusive是false（默认），集群进程将会使用相同的底层句柄，允许连接处理共享的任务。当exclusive为true时，句柄不会共享，尝试共享端口也会失败。监听exclusive端口的例子如下：

socket.bind({
  address: 'localhost',
  port: 8000,
  exclusive: true
});

socket.close()

关闭底层socket并且停止监听数据。

socket.address()

返回一个包含套接字地址信息的对象。对于UDP socket，这个对象会包含address，family和port。

socket.setBroadcast(flag)

• flagBoolean

设置或清除SO_BROADCASTsocket选项。设置这个选项后，UDP包可能会发送给一个本地的接口广播地址。

socket.setTTL(ttl)

• ttl整数

设置IP_TTLsocket选项。TTL表示生存时间（Time to Live），但是在这个上下文中它指的是报文允许通过的IP跃点数。各个转发报文的路由器或者网关都会递减 TTL。如果TTL被路由器递减为0，则它将不会被转发。改变TTL的值通常用于网络探测器或多播。

setTTL()的参数为1到255的跃点数。多数系统默认值为64。

socket.setMulticastTTL(ttl)

• ttl整数

设置IP_MULTICAST_TTLsocket选项。TTL表示生存时间（Time to Live），但是在这个上下文中它指的是报文允许通过的IP跃点数。各个转发报文的路由器或者网关都会递减TTL。如果TTL被路由器递减为0，则它将不会被转发。改变TTL的值通常用于网络探测器或多播。

setMulticastTTL()的参数为1到255的跃点数。多数系统默认值为1。

socket.setMulticastLoopback(flag)

• flag Boolean

设置或清空IP_MULTICAST_LOOPsocket选项。设置完这个选项后，当该选项被设置时，组播报文也会被本地接口收到。

socket.addMembership(multicastAddress[, multicastInterface])

• multicastAddress字符串
• multicastInterface字符串，可选

告诉内核加入广播组，选项为IP_ADD_MEMBERSHIPsocket

如果没有指定multicastInterface，操作系统会给所有可用的接口添加关系。

socket.dropMembership(multicastAddress[, multicastInterface])

• multicastAddress字符串
• multicastInterface字符串，可选

和addMembership相反 - 用IP_DROP_MEMBERSHIP选项告诉内核离开广播组 。如果没有指定multicastInterface，操作系统会移除所有可用的接口关系。

socket.unref()

在socket上调用unref允许程序退出，如果这是在事件系统中唯一的活动socket。如果socket已经unref，再次调用unref将会无效。

socket.ref()

和unref相反，如果这是唯一的socket，在一个之前被unref了的socket上调用ref将不会让程序退出（缺省行为）。如果一个socket已经被ref，则再次调用ref将会无效。