UDP / Datagram Sockets

稳定度: 2 - 稳定

数据报socket通过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 String. 'udp4'或'udp6'，两者之一
• callback Function. 可选，会被添加为message事件的监听器
• Returns: socket对象

创建一个指定类型的数据报socket。可用类型是 udp4 和 udp6.

接受一个可选的回调函数，它会被自动添加为message事件的监听器。

如果你想要接收数据报，调用socket.bind()。socket.bind()将会到所有网络接口地址中的一个随机端口（不论 udp4 和 upd6 socket，它都可以正常工作）。你可以从socket.address().address和socket.address().port中获取地址和端口。

dgram.createSocket(options[, callback])

• options Object
• callback Function. 会被添加为message事件的监听器
• Returns: socket对象

options对象必须包含一个type属性，可是 udp4 或 udp6。还有一个可选的reuseAddr布尔值属性。

当reuseAddr为true时，socket.bind()会重用地址，甚至是当另一个进程已经在这之上绑定了一个socket时。默认为false。

接受一个可选的回调函数，它会被自动添加为message事件的监听器。

如果你想要接收数据报，调用socket.bind()。socket.bind()将会到所有网络接口地址中的一个随机端口（不论 udp4 和 upd6 socket，它都可以正常工作）。你可以从socket.address().address和socket.address().port中获取地址和端口。

Class: dgram.Socket

dgram.Socket类封装了数据报的功能。它必须被dgram.createSocket(...)创建。

Event: 'message'

• msg Buffer object. 消息
• rinfo Object. 远程地址信息

当在socket中一个新的数据报可用时触发。msg是一个buffer并且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开始监听数据报时触发。在 UDP socket被创建时触发。

Event: 'close'

在一个socket通过close()被关闭时触发。这个socket中不会再触发新的message事件。

Event: 'error'

• exception Error object

当错误发生时触发。

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

• buf Buffer object or string. 要被发送的信息。
• offset Integer. 信息在buffer里的初始偏移位置。
• length Integer. 信息的字节数。
• port Integer. 目标端口。
• address String. 目标主机或 IP 地址。
• callback Function. 可选，当信息被发送后调用。

对于 UDP socket，目标端口和地址都必须被指定。address参数需要提供一个字符串，并且它会被DNS 解析。

如果address被忽略，或者是一个空字符串。将会使用'0.0.0.0'或'::0'。这取决于网络配置，这些默认值 可能会 或 可能不会 正常工作；所以最好还是明确指定目标地址。

如果一个socket先前没有被调用bind来绑定，它将会赋于一个随机端口数并且被绑定到“所有网络接口”地址（udp4 socket为'0.0.0.0'，udp6则为'::0'）。

一个可选的回调函数可以被指定，用来检测 DNS 错误，或决定重用buf对象是否安全。注意，DNS 查找至少会延迟一个事件循环。唯一能确定数据报被发送的方法就是使用一个回调函数。

出于对多字节字符的考虑，offset和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 数据报大小的注意事项

IPv4/v6 数据报的最大大小取决于MTU（最大传输单位），和Payload Length字段大小。

• Payload Length是16字节宽的，意味着一个正常的负载不能超过64 K 八位字节，包括网络头和数据（65,507 字节 = 65,535 − 8 字节 UDP 头 − 20 字节 IP 头）；对于环回接口总是true，但是如此大的数据报对于大多数主机和网络来说都是不现实的。

• MTU是指定的链路层技术支持的报文的最大大小。对于所有连接，IPv4 允许最小MTU为68八位字节，而推荐的 IPv4 MTU是576（通常作为拨号类应用的推荐MTU），无论它们是完整的还是以碎片形式到达。

• 对于 IPv6，最小 MTU 是1280八位字节，但是，允许的最小buffer重组大小是1500八位字节。68八位字节非常小，所以大多数的当前链路层技术的最小MTU都是1500（如Ethernet）。

注意，不可能提前知道一个报文可能经过的每一个连接MTU，并且通常不能发送一个大于（接收者）MTU的数据报（报文会被默默丢弃，不会通知源头：这个数据没有到达已定的接收方）。

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

• port Integer
• address String, 可选
• callback Function 可选，没有参数。当绑定完毕后触发。

对于 UDP socket，监听一个具名的端口和一个可选的地址上的数据报。如果address没有被指定，操作系统将会试图监听所有端口。在绑定完毕后，listening事件会被吃法，并且回调函数（如果指定了）会被调用。同时指定listening事件的监听器和callback没有危险，但是不是很有用。

一个绑定的数据报socket将会保持io.js进程的运行，来接受数据报。

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

一个监听41234端口的 UDP 服务器：

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 Object - 必选，支持以下属性：
  • port Number - 必须
  • address String - 可选
  • exclusive Boolean - 可选
• callback Function - 可选

options的prot和address属性，以及可选的回调函数，与socket.bind(port, [address], [callback])中它们的表现一致。

如exclusive为false（默认），那么集群的工作进程将会使用相同的底层句柄，允许共享处理连接的职责。当为true时，句柄不被共享，企图共享端口会导致一个错误。一个监听一个exclusive端口的例子：

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

socket.close([callback])

关闭底层socket，并且停止监听新数据。如果提供了回调函数，它会被添加为close事件的监听器。

socket.address()

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

socket.setBroadcast(flag)

• flag Boolean

设置或清除SO_BROADCAST socket设置。当这个选项被设置，UDP报文将会被送至本地接口的广播地址。

socket.setTTL(ttl)

• ttl Integer

设置IP_TTL socket选项。TTL的意思是“生存时间（Time to Live）”，但是在这里的上下文中，它值一个报文通过的 IP 跃点数。每转发报文的路由或网关都会递减TTL。如果TTL被一个路由递减为0，它将不再被转发。改变TTL值常用于网络探测器或多播。

setTTL()的参数是一个1到225之间的跃点数。多数系统中的默认值为64。

socket.setMulticastTTL(ttl)

• ttl Integer

设置IP_MULTICAST_TTL socket选项。TTL的意思是“生存时间（Time to Live）”，但是在这里的上下文中，它值一个报文通过的 IP 跃点数，特别是组播流量。每转发报文的路由或网关都会递减TTL。如果TTL被一个路由递减为0，它将不再被转发。

setMulticastTTL()的参数是一个0到225之间的跃点数。多数系统中的默认值为1。

socket.setMulticastLoopback(flag)

• flag Boolean

设置或清除IP_MULTICAST_LOOP socket选项。当这个选项被设置，组播报文也将会在本地接口上接收。

socket.addMembership(multicastAddress[, multicastInterface])

• multicastAddress String
• multicastInterface String, 可选

告诉内核加入一个组播分组，通过IP_ADD_MEMBERSHIP socket选项。

如果multicastInterface没有被指定，那么操作系统将会尝试加入成为所有可用的接口的成员。

socket.dropMembership(multicastAddress[, multicastInterface])

• multicastAddress String
• multicastInterface String, 可选

与addMembership相反 - 告诉内核离开一个组播分组，通过IP_DROP_MEMBERSHIP socket选项。当socket被关闭或进程结束时，它会被内核自动调用。所以大多数应用不需要亲自调用它。

如果multicastInterface没有被指定，那么操作系统将会尝试脱离所有可用的接口。

socket.unref()

在一个socket上调用unref将会在它是事件系统中唯一活跃的socket时，允许程序退出。如果socket已经被unref，再次调用将不会有任何效果。

返回一个socket。

socket.ref()

与unref相反，在一个先前被unref的socket上调用ref，那么在它是唯一的剩余的socket（默认行为）时，将不允许程序退出。如果socket已经被ref，再次调用将不会有任何效果。

返回一个socket。