目录

• dgram (数据报)
  • dgram.Socket 类
    • 'close' 事件
    • 'error' 事件
    • 'listening' 事件
    • 'message' 事件
    • socket.addMembership(multicastAddress[, multicastInterface])
    • socket.address()
    • socket.bind([port][, address][, callback])
    • socket.bind(options[, callback])
    • socket.close([callback])
    • socket.dropMembership(multicastAddress[, multicastInterface])
    • socket.getRecvBufferSize()
    • socket.getSendBufferSize()
    • socket.ref()
    • socket.send(msg, [offset, length,] port [, address] [, callback])
    • socket.setBroadcast(flag)
    • socket.setMulticastInterface(multicastInterface)
      • Examples: IPv6 Outgoing Multicast Interface
      • Example: IPv4 Outgoing Multicast Interface
      • Call Results
    • socket.setMulticastLoopback(flag)
    • socket.setMulticastTTL(ttl)
    • socket.setRecvBufferSize(size)
    • socket.setSendBufferSize(size)
    • socket.setTTL(ttl)
    • socket.unref()
    • Change to asynchronous socket.bind() behavior
  • dgram module functions
    • dgram.createSocket(options[, callback])
    • dgram.createSocket(type[, callback])

dgram (数据报)#

dgram模块提供了 UDP 数据包 socket 的实现。

const dgram = require('dgram');
const server = dgram.createSocket('udp4');

server.on('error', (err) => {
  console.log(`服务器异常：\n${err.stack}`);
  server.close();
});

server.on('message', (msg, rinfo) => {
  console.log(`服务器收到：${msg} 来自 ${rinfo.address}:${rinfo.port}`);
});

server.on('listening', () => {
  const address = server.address();
  console.log(`服务器监听 ${address.address}:${address.port}`);
});

server.bind(41234);
// 服务器监听 0.0.0.0:41234

dgram.Socket 类#

dgram.Socket对象是一个封装了数据包函数功能的[EventEmitter][]。

dgram.Socket实例是由[dgram.createSocket()][]创建的。创建dgram.Socket实例不需要使用new关键字。

'close' 事件#

'close'事件将在使用[close()][]关闭一个 socket 之后触发。该事件一旦触发，这个 socket 上将不会触发新的'message'事件。

'error' 事件#

• exception <Error>

当有任何错误发生时，'error'事件将被触发。事件发生时，事件处理函数仅会接收到一个 Error 参数。

'listening' 事件#

当一个 socket 开始监听数据包信息时，'listening'事件将被触发。该事件会在创建 UDP socket 之后被立即触发。

'message' 事件#

当有新的数据包被 socket 接收时，'message'事件会被触发。msg和rinfo会作为参数传递到该事件的处理函数中。

• msg <Buffer> - 消息
• rinfo <Object> - 远程地址信息
  • address <string> 发送方地址
  • family <string> 地址类型 ('IPv4' or 'IPv6')
  • port <number> 发送者端口
  • size <number> 消息大小

socket.addMembership(multicastAddress[, multicastInterface])#

• multicastAddress <string>
• multicastInterface <string>

通知内核将multicastAddress和multicastInterface提供的多路传送集合通过IP_ADD_MEMBERSHIP这个 socket 选项结合起来。若multicastInterface参数未指定，操作系统将会选择一个接口并向其添加成员。要为所有可用的接口添加成员，可以在每个接口上调用一次addMembership方法。

socket.address()#

返回一个包含 socket 地址信息的对象。对于 UDP socket，该对象将包含address、family和port属性。

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

• port <number> 整数。
• address <string>
• callback <Function> 没有参数。当绑定完成时会被调用。

对于 UDP socket，该方法会令dgram.Socket在指定的port和可选的address上监听数据包信息。若port未指定或为 0，操作系统会尝试绑定一个随机的端口。若address未指定，操作系统会尝试在所有地址上监听。绑定完成时会触发一个'listening'事件，并会调用callback方法。

注意，同时监听'listening'事件和在socket.bind()方法中传入callback参数并不会带来坏处，但也不是很有用。

一个被绑定的数据包 socket 会令 Node.js 进程保持运行以接收数据包信息。

若绑定失败，一个'error'事件会被触发。在极少数的情况下（例如尝试绑定一个已关闭的 socket），一个 [Error][] 会被抛出。

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

const dgram = require('dgram');
const server = dgram.createSocket('udp4');

server.on('error', (err) => {
  console.log(`服务器异常：\n${err.stack}`);
  server.close();
});

server.on('message', (msg, rinfo) => {
  console.log(`服务器收到：${msg} 来自 ${rinfo.address}:${rinfo.port}`);
});

server.on('listening', () => {
  const address = server.address();
  console.log(`服务器监听 ${address.address}:${address.port}`);
});

server.bind(41234);
// 服务器监听 0.0.0.0:41234

socket.bind(options[, callback])#

• options <Object> 必要的。包含以下属性：
  • port <integer>
  • address <string>
  • exclusive <boolean>
• callback <Function>

对于 UDP socket，该方法会令dgram.Socket在指定的port和可选的address上监听数据包信息。若port未指定或为 0，操作系统会尝试绑定一个随机的端口。若address未指定，操作系统会尝试在所有地址上监听。绑定完成时会触发一个'listening'事件，并会调用callback方法。

Note that specifying both a 'listening' event listener and passing a callback to the socket.bind() method is not harmful but not very useful.

在配合[cluster]模块使用dgram.Socket对象时，options对象可能包含一个附加的exclusive属性。当exclusive被设为false(默认值)时，集群工作单元会使用相同的 socket 句柄来共享连接处理作业。当exclusive被设为true时，该句柄将不会被共享，而尝试共享端口则会造成错误。

一个绑定的数据报 socket 会使 Node.js 进程持续运行以接受数据报消息。

如果绑定失败，一个 'error' 事件会产生。在极少数情况下（例如尝试绑定一个已经关闭的 socket）， 一个 [Error][] 可能抛出。

一个不共享端口的 socket 的例子如下文所示。

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

socket.close([callback])#

关闭该 socket 并停止监听其上的数据。如果提供了一个回调函数，它就相当于为['close'][]事件添加了一个监听器。

socket.dropMembership(multicastAddress[, multicastInterface])#

• multicastAddress <string>
• multicastInterface <string>

引导内核通过IP_DROP_MEMBERSHIP这个 socket 选项删除multicastAddress指定的多路传送集合。当 socket 被关闭或进程被终止时，该方法会被内核自动调用，所以大多数的应用都不用自行调用该方法。

若multicastInterface未指定，操作系统会尝试删除所有可用接口上的成员。

socket.getRecvBufferSize()#

• Returns <number> socket 接收到的字节大小。

socket.getSendBufferSize()#

• Returns <number> socket 发送的字节大小。

socket.ref()#

默认情况下，绑定一个 socket 会在 socket 运行时阻止 Node.js 进程退出。 socket.unref() 方法用于将 socket 从维持 Node.js 进程的引用列表中解除。 socket.ref() 方法用于将 socket 重新添加到这个引用列表中，并恢复其默认行为。

多次调用 socket.ref() 不会有额外的作用。

socket.ref() 方法返回一个对 socket 的引用，所以可以链式调用。

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

• msg <Buffer> | <Uint8Array> | <string> | <Array> 要发送的消息。
• offset <number> 整数。指定消息的开头在 buffer 中的偏移量。
• length <number> 整数。消息的字节数。
• port <number> 整数。目标端口。
• address <string> 目标主机名或 IP 地址。
• callback <Function> 当消息被发送时会被调用。

在 socket 上发送一个数据包。目标port和address须被指定。

msg参数包含了要发送的消息。根据消息的类型可以有不同的做法。如果msg是一个Buffer 或 Uint8Array，则offset和length指定了消息在Buffer中对应的偏移量和字节数。如果msg是一个String，那么它会被自动地按照utf8编码转换为Buffer。对于包含了多字节字符的消息，offset和length会根据对应的[byte length][]进行计算，而不是根据字符的位置。如果msg是一个数组，那么offset和length必须都不能被指定。

address参数是一个字符串。若address的值是一个主机名，则 DNS 会被用来解析主机的地址。若address未提供或是非真值，则'127.0.0.1'（用于 udp4 socket）或'::1'（用于 udp6 socket）会被使用。

若在之前 socket 未通过调用bind方法进行绑定，socket 将会被一个随机的端口号赋值并绑定到“所有接口”的地址上（对于udp4 socket 是'0.0.0.0'，对于udp6 socket 是'::0'）。

可以指定一个可选的callback方法来汇报 DNS 错误或判断可以安全地重用buf对象的时机。注意，在 Node.js 事件循环中，DNS 查询会对发送造成至少 1 tick 的延迟。

确定数据包被发送的唯一方式就是指定callback。若在callback被指定的情况下有错误发生，该错误会作为callback的第一个参数。若callback未被指定，该错误会以'error'事件的方式投射到socket对象上。

偏移量和长度是可选的，但如其中一个被指定则另一个也必须被指定。另外，他们只在第一个参数是Buffer 或 Uint8Array 的情况下才能被使用。

一个发送 UDP 包到localhost上的某个随机端口的例子：

const dgram = require('dgram');
const message = Buffer.from('Some bytes');
const client = dgram.createSocket('udp4');
client.send(message, 41234, 'localhost', (err) => {
  client.close();
});

一个发送包含多个 buffer 的 UDP 包到 127.0.0.1 上的某个随机端口的例子：

const dgram = require('dgram');
const buf1 = Buffer.from('Some ');
const buf2 = Buffer.from('bytes');
const client = dgram.createSocket('udp4');
client.send([buf1, buf2], 41234, (err) => {
  client.close();
});

发送多个 buffer 的速度取决于应用和操作系统。 逐案运行基准来确定最佳策略是很重要的。但是一般来说，发送多个 buffer 速度更快。

关于 UDP 包大小的注意事项

IPv4/v6数据包的最大尺寸取决于MTU(Maximum Transmission Unit, 最大传输单元)与Payload Length字段大小。

• Payload Length字段有16 位宽，指一个超过 64K 的_包含_ IP 头部和数据的负载 (65,507 字节 = 65,535 − 8 字节 UDP 头 − 20 字节 IP 头部)；通常对于环回地址来说是这样，但这个长度的数据包对于大多数的主机和网络来说不切实际。

• MTU指的是数据链路层为数据包提供的最大大小。对于任意链路，IPv4所托管的MTU最小为68个字节，推荐为576（典型地，作为拨号上网应用的推荐值），无论它们是完整地还是分块地抵达。

  对于IPv6，MTU的最小值是1280个字节，然而，受托管的最小的碎片重组缓冲大小为1500个字节。现今大多数的数据链路层技术（如以太网），都有1500的MTU最小值，因而68个字节显得非常小。

要提前知道数据包可能经过的每个链路的 MTU 是不可能的。发送大于接受者MTU大小的数据包将不会起作用，因为数据包会被静默地丢失，而不会通知发送者该包未抵达目的地。

socket.setBroadcast(flag)#

• flag <boolean>

设置或清除 SO_BROADCAST socket 选项。当设置为 true, UDP包可能会被发送到一个本地接口的广播地址

socket.setMulticastInterface(multicastInterface)#

• multicastInterface <string>

Note: All references to scope in this section are referring to [IPv6 Zone Indices][], which are defined by [RFC 4007][]. In string form, an IP with a scope index is written as 'IP%scope' where scope is an interface name or interface number.

Sets the default outgoing multicast interface of the socket to a chosen interface or back to system interface selection. The multicastInterface must be a valid string representation of an IP from the socket's family.

For IPv4 sockets, this should be the IP configured for the desired physical interface. All packets sent to multicast on the socket will be sent on the interface determined by the most recent successful use of this call.

For IPv6 sockets, multicastInterface should include a scope to indicate the interface as in the examples that follow. In IPv6, individual send calls can also use explicit scope in addresses, so only packets sent to a multicast address without specifying an explicit scope are affected by the most recent successful use of this call.

Examples: IPv6 Outgoing Multicast Interface#

On most systems, where scope format uses the interface name:

const socket = dgram.createSocket('udp6');

socket.bind(1234, () => {
  socket.setMulticastInterface('::%eth1');
});

On Windows, where scope format uses an interface number:

const socket = dgram.createSocket('udp6');

socket.bind(1234, () => {
  socket.setMulticastInterface('::%2');
});

Example: IPv4 Outgoing Multicast Interface#

All systems use an IP of the host on the desired physical interface:

const socket = dgram.createSocket('udp4');

socket.bind(1234, () => {
  socket.setMulticastInterface('10.0.0.2');
});

Call Results#

A call on a socket that is not ready to send or no longer open may throw a Not running [Error][].

If multicastInterface can not be parsed into an IP then an EINVAL [System Error][] is thrown.

On IPv4, if multicastInterface is a valid address but does not match any interface, or if the address does not match the family then a [System Error][] such as EADDRNOTAVAIL or EPROTONOSUP is thrown.

On IPv6, most errors with specifying or omitting scope will result in the socket continuing to use (or returning to) the system's default interface selection.

A socket's address family's ANY address (IPv4 '0.0.0.0' or IPv6 '::') can be used to return control of the sockets default outgoing interface to the system for future multicast packets.

socket.setMulticastLoopback(flag)#

• flag <boolean>

设置或清除 IP_MULTICAST_LOOP socket 选项。当设置为 true, 多播数据包也将在本地接口接收。

socket.setMulticastTTL(ttl)#

• ttl <number> Integer

设置IP_MULTICAST_TTL套接字选项。 一般来说，TTL表示"生存时间"。这里特指一个IP数据包传输时允许的最大跳步数，尤其是对多播传输。 当IP数据包每向前经过一个路由或网关时，TTL值减1，若经过某个路由时，TTL值被减至0，便不再继续向前传输。

传给 socket.setMulticastTTL() 的参数是一个范围为0-255的跳步数。大多数系统的默认值是 1 ，但是可以变化。

socket.setRecvBufferSize(size)#

• size <number> Integer

设置 SO_RCVBUF 套接字选项。设置最大的套接字接收缓冲字节。

socket.setSendBufferSize(size)#

• size <number> Integer

设置 SO_SNDBUF 套接字选项。设置最大的套接字发送缓冲字节。

socket.setTTL(ttl)#

• ttl <number> Integer

设置 IP_TTL 套接字选项。 一般来说，TTL表示"生存时间"，这里特指一个IP数据包传输时允许的最大跳步数。 当IP数据包每向前经过一个路由或网关时，TTL值减1，若经过某个路由时，TTL值被减至0，便不再继续向前传输。 比较有代表性的是，为了进行网络情况嗅探或者多播而修改TTL值。

传给 socket.setTTL() 的参数是一个范围为0-255的跳步数。大多数系统的默认值是 1 ，但是可以变化。

socket.unref()#

默认情况下，只要socket是打开的，绑定一个socket将导致它阻塞Node.js进程退出。使用socket.unref()方法可以从保持Node.js进程活动的引用计数中排除socket，从而允许进程退出，尽管这个socket仍然在侦听。

多次调用socket.unref()方法将不会有任何新增的作用。

socket.unref()方法返回当前socket的引用，因此可以链式调用。

Change to asynchronous socket.bind() behavior#

从Node.js v0.10开始，[dgram.Socket＃bind（）][]更改为异步执行模型。旧代码采用同步行为，如下例所示：

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

必须改为传递一个回调函数到[dgram.Socket＃bind（）][]：

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

dgram module functions#

dgram.createSocket(options[, callback])#

• options <Object> 允许的选项是:
  • type <string> 套接字族. 必须是 'udp4' 或 'udp6'. 必需填.
  • reuseAddr <boolean> 若设置为 true [socket.bind()][] ，则会 重用地址，即时另一个进程已经在其上面绑定了一个套接字。 默认是 false.
  • recvBufferSize <number> - 设置 SO_RCVBUF 套接字值。
  • sendBufferSize <number> - 设置 SO_SNDBUF 套接字值。
  • lookup <Function> 惯常的查询函数. 默认是 [dns.lookup()][]。
• callback <Function> 为 'message' 事件绑定一个监听器。可选。
• 返回: <dgram.Socket>

创建一个 dgram.Socket 对象. 一旦创建了套接字，调用 [socket.bind()][] 会指示套接字开始监听数据报消息。如果 address 和 port 没传给 [socket.bind()][]， 那么这个方法会把这个套接字绑定到 "全部接口" 地址的一个随机端口(这适用于 udp4 和 udp6 套接字)。 绑定的地址和端口可以通过 [socket.address().address][] 和[socket.address().port][] 来获取。

dgram.createSocket(type[, callback])#

• type <string> - 'udp4' 或 'udp6'.
• callback <Function> - 为 'message' 事件添加一个监听器。
• 返回: <dgram.Socket>

创建一个特定 type 的dgram.Socket 对象。type参数是udp4 或 udp6。 可选传一个回调函数，作为 'message' 事件的监听器。

一旦套接字被创建。调用[socket.bind()][] 会指示套接字开始监听数据报消息。如果 address 和 port 没传给 [socket.bind()][]， 那么这个方法会把这个套接字绑定到 "全部接口" 地址的一个随机端口(这适用于 udp4 和 udp6 套接字)。 绑定的地址和端口可以通过 [socket.address().address][] 和[socket.address().port][] 来获取。 ['close']: #dgram_event_close [Error]: errors.html#errors_class_error [EventEmitter]: events.html [close()]: #dgram_socket_close_callback [cluster]: cluster.html [dgram.Socket#bind()]: #dgram_socket_bind_options_callback [dgram.createSocket()]: #dgram_dgram_createsocket_options_callback [dns.lookup()]: dns.html#dns_dns_lookup_hostname_options_callback [socket.address().address]: #dgram_socket_address [socket.address().port]: #dgram_socket_address [socket.bind()]: #dgram_socket_bind_port_address_callback [System Error]: errors.html#errors_class_systemerror [byte length]: buffer.html#buffer_class_method_buffer_bytelength_string_encoding [IPv6 Zone Indices]: https://en.wikipedia.org/wiki/IPv6_address#Scoped_literal_IPv6_addresses [RFC 4007]: https://tools.ietf.org/html/rfc4007