The dgram module provides an implementation of UDP Datagram sockets.\n\n
const dgram = require('dgram');\nconst server = dgram.createSocket('udp4');\n\nserver.on('error', (err) => {\n console.log(`server error:\\n${err.stack}`);\n server.close();\n});\n\nserver.on('message', (msg, rinfo) => {\n console.log(`server got: ${msg} from ${rinfo.address}:${rinfo.port}`);\n});\n\nserver.on('listening', () => {\n var address = server.address();\n console.log(`server listening ${address.address}:${address.port}`);\n});\n\nserver.bind(41234);\n// server listening 0.0.0.0:41234The dgram.Socket object is an [EventEmitter][] that encapsulates the\ndatagram functionality.\n\n
New instances of dgram.Socket are created using [dgram.createSocket()][].\nThe new keyword is not to be used to create dgram.Socket instances.\n\n
The 'close' event is emitted after a socket is closed with [close()][].\nOnce triggered, no new 'message' events will be emitted on this socket.\n\n
The 'error' event is emitted whenever any error occurs. The event handler\nfunction is passed a single Error object.\n\n
The 'listening' event is emitted whenever a socket begins listening for\ndatagram messages. This occurs as soon as UDP sockets are created.\n\n
The 'message' event is emitted when a new datagram is available on a socket.\nThe event handler function is passed two arguments: msg and rinfo. The\nmsg argument is a [Buffer][] and rinfo is an object with the sender's\naddress information provided by the address, family and port properties:\n\n
socket.on('message', (msg, rinfo) => {\n console.log('Received %d bytes from %s:%d\\n',\n msg.length, rinfo.address, rinfo.port);\n});Tells the kernel to join a multicast group at the given multicastAddress\nusing the IP_ADD_MEMBERSHIP socket option. If the multicastInterface\nargument is not specified, the operating system will try to add membership to\nall valid networking interfaces.\n\n
Returns an object containing the address information for a socket.\nFor UDP sockets, this object will contain address, family and port\nproperties.\n\n
For UDP sockets, causes the dgram.Socket to listen for datagram messages on a\nnamed port and optional address. If port is not specified, the operating\nsystem will attempt to bind to a random port. If address is not specified,\nthe operating system will attempt to listen on all addresses. Once binding is\ncomplete, a 'listening' event is emitted and the optional callback function\nis called.\n\n
Note that specifying both a 'listening' event listener and passing a\ncallback to the socket.bind() method is not harmful but not very\nuseful.\n\n
A bound datagram socket keeps the Node.js process running to receive\ndatagram messages.\n\n
\nIf binding fails, an 'error' event is generated. In rare case (e.g.\nattempting to bind with a closed socket), an [Error][] may be thrown.\n\n
Example of a UDP server listening on port 41234:\n\n
\nconst dgram = require('dgram');\nconst server = dgram.createSocket('udp4');\n\nserver.on('error', (err) => {\n console.log(`server error:\\n${err.stack}`);\n server.close();\n});\n\nserver.on('message', (msg, rinfo) => {\n console.log(`server got: ${msg} from ${rinfo.address}:${rinfo.port}`);\n});\n\nserver.on('listening', () => {\n var address = server.address();\n console.log(`server listening ${address.address}:${address.port}`);\n});\n\nserver.bind(41234);\n// server listening 0.0.0.0:41234For UDP sockets, causes the dgram.Socket to listen for datagram messages on a\nnamed port and optional address that are passed as properties of an\noptions object passed as the first argument. If port is not specified, the\noperating system will attempt to bind to a random port. If address is not\nspecified, the operating system will attempt to listen on all addresses. Once\nbinding is complete, a 'listening' event is emitted and the optional\ncallback function is called.\n\n
The options object may contain an additional exclusive property that is\nuse when using dgram.Socket objects with the [cluster] module. When\nexclusive is set to false (the default), cluster workers will use the same\nunderlying socket handle allowing connection handling duties to be shared.\nWhen exclusive is true, however, the handle is not shared and attempted\nport sharing results in an error.\n\n
An example socket listening on an exclusive port is shown below.\n\n
\nsocket.bind({\n address: 'localhost',\n port: 8000,\n exclusive: true\n});Close the underlying socket and stop listening for data on it. If a callback is\nprovided, it is added as a listener for the ['close'][] event.\n\n
Instructs the kernel to leave a multicast group at multicastAddress using the\nIP_DROP_MEMBERSHIP socket option. This method is automatically called by the\nkernel when the socket is closed or the process terminates, so most apps will\nnever have reason to call this.\n\n
If multicastInterface is not specified, the operating system will attempt to\ndrop membership on all valid interfaces.\n\n
Broadcasts a datagram on the socket. The destination port and address must\nbe specified.\n\n
The msg argument contains the message to be sent.\nDepending on its type, different behavior can apply. If msg is a Buffer,\nthe offset and length specify the offset within the Buffer where the\nmessage begins and the number of bytes in the message, respectively.\nIf msg is a String, then it is automatically converted to a Buffer\nwith 'utf8' encoding. With messages that\ncontain multi-byte characters, offset and length will be calculated with\nrespect to [byte length][] and not the character position.\nIf msg is an array, offset and length must not be specified.\n\n
The address argument is a string. If the value of address is a host name,\nDNS will be used to resolve the address of the host. If the address is not\nspecified or is an empty string, '127.0.0.1' or '::1' will be used instead.\n\n
If the socket has not been previously bound with a call to bind, the socket\nis assigned a random port number and is bound to the "all interfaces" address\n('0.0.0.0' for udp4 sockets, '::0' for udp6 sockets.)\n\n
An optional callback function may be specified to as a way of reporting\nDNS errors or for determining when it is safe to reuse the buf object.\nNote that DNS lookups delay the time to send for at least one tick of the\nNode.js event loop.\n\n
The only way to know for sure that the datagram has been sent is by using a\ncallback. If an error occurs and a callback is given, the error will be\npassed as the first argument to the callback. If a callback is not given,\nthe error is emitted as an 'error' event on the socket object.\n\n
Offset and length are optional, but if you specify one you would need to\nspecify the other. Also, they are supported only when the first\nargument is a Buffer.\n\n
Example of sending a UDP packet to a random port on localhost;\n\n
const dgram = require('dgram');\nconst message = new Buffer('Some bytes');\nconst client = dgram.createSocket('udp4');\nclient.send(message, 41234, 'localhost', (err) => {\n client.close();\n});Example of sending a UDP packet composed of multiple buffers to a random port on localhost;\n\n
const dgram = require('dgram');\nconst buf1 = new Buffer('Some ');\nconst buf2 = new Buffer('bytes');\nconst client = dgram.createSocket('udp4');\nclient.send([buf1, buf2], 41234, 'localhost', (err) => {\n client.close();\n});Sending multiple buffers might be faster or slower depending on your\napplication and operating system: benchmark it. Usually it is faster.\n\n
\nA Note about UDP datagram size\n\n
\nThe maximum size of an IPv4/v6 datagram depends on the MTU\n(Maximum Transmission Unit) and on the Payload Length field size.\n\n
The Payload Length field is 16 bits wide, which means that a normal\npayload exceed 64K octets including the internet header and data\n(65,507 bytes = 65,535 − 8 bytes UDP header − 20 bytes IP header);\nthis is generally true for loopback interfaces, but such long datagram\nmessages are impractical for most hosts and networks.
The MTU is the largest size a given link layer technology can support for\ndatagram messages. For any link, IPv4 mandates a minimum MTU of 68\noctets, while the recommended MTU for IPv4 is 576 (typically recommended\nas the MTU for dial-up type applications), whether they arrive whole or in\nfragments.
For IPv6, the minimum MTU is 1280 octets, however, the mandatory minimum\nfragment reassembly buffer size is 1500 octets. The value of 68 octets is\nvery small, since most current link layer technologies, like Ethernet, have a\nminimum MTU of 1500.
It is impossible to know in advance the MTU of each link through which\na packet might travel. Sending a datagram greater than the receiver MTU will\nnot work because the packet will get silently dropped without informing the\nsource that the data did not reach its intended recipient.\n\n
Sets or clears the SO_BROADCAST socket option. When set to true, UDP\npackets may be sent to a local interface's broadcast address.\n\n
Sets or clears the IP_MULTICAST_LOOP socket option. When set to true,\nmulticast packets will also be received on the local interface.\n\n
Sets the IP_MULTICAST_TTL socket option. While TTL generally stands for\n"Time to Live", in this context it specifies the number of IP hops that a\npacket is allowed to travel through, specifically for multicast traffic. Each\nrouter or gateway that forwards a packet decrements the TTL. If the TTL is\ndecremented to 0 by a router, it will not be forwarded.\n\n
The argument passed to to socket.setMulticastTTL() is a number of hops\nbetween 0 and 255. The default on most systems is 1 but can vary.\n\n
Sets the IP_TTL socket option. While TTL generally stands for "Time to Live",\nin this context it specifies the number of IP hops that a packet is allowed to\ntravel through. Each router or gateway that forwards a packet decrements the\nTTL. If the TTL is decremented to 0 by a router, it will not be forwarded.\nChanging TTL values is typically done for network probes or when multicasting.\n\n
The argument to socket.setTTL() is a number of hops between 1 and 255.\nThe default on most systems is 64 but can vary.\n\n
By default, binding a socket will cause it to block the Node.js process from\nexiting as long as the socket is open. The socket.unref() method can be used\nto exclude the socket from the reference counting that keeps the Node.js\nprocess active. The socket.ref() method adds the socket back to the reference\ncounting and restores the default behavior.\n\n
Calling socket.ref() multiples times will have no additional effect.\n\n
The socket.ref() method returns a reference to the socket so calls can be\nchained.\n\n
By default, binding a socket will cause it to block the Node.js process from\nexiting as long as the socket is open. The socket.unref() method can be used\nto exclude the socket from the reference counting that keeps the Node.js\nprocess active, allowing the process to exit even if the socket is still\nlistening.\n\n
Calling socket.unref() multiple times will have no addition effect.\n\n
The socket.unref() method returns a reference to the socket so calls can be\nchained.\n\n
As of Node.js v0.10, [dgram.Socket#bind()][] changed to an asynchronous\nexecution model. Legacy code that assumes synchronous behavior, as in the\nfollowing example:\n\n
const s = dgram.createSocket('udp4');\ns.bind(1234);\ns.addMembership('224.0.0.114');Must be changed to pass a callback function to the [dgram.Socket#bind()][]\nfunction:\n\n
const s = dgram.createSocket('udp4');\ns.bind(1234, () => {\n s.addMembership('224.0.0.114');\n});Creates a dgram.Socket object. The options argument is an object that\nshould contain a type field of either udp4 or udp6 and an optional\nboolean reuseAddr field.\n\n
When reuseAddr is true [socket.bind()][] will reuse the address, even if\nanother process has already bound a socket on it. reuseAddr defaults to\nfalse. An optional callback function can be passed specified which is added\nas a listener for 'message' events.\n\n
Once the socket is created, calling [socket.bind()][] will instruct the\nsocket to begin listening for datagram messages. When address and port are\nnot passed to [socket.bind()][] the method will bind the socket to the "all\ninterfaces" address on a random port (it does the right thing for both udp4\nand udp6 sockets). The bound address and port can be retrieved using\n[socket.address().address][] and [socket.address().port][].\n\n
Creates a dgram.Socket object of the specified type. The type argument\ncan be either udp4 or udp6. An optional callback function can be passed\nwhich is added as a listener for 'message' events.\n\n
Once the socket is created, calling [socket.bind()][] will instruct the\nsocket to begin listening for datagram messages. When address and port are\nnot passed to [socket.bind()][] the method will bind the socket to the "all\ninterfaces" address on a random port (it does the right thing for both udp4\nand udp6 sockets). The bound address and port can be retrieved using\n[socket.address().address][] and [socket.address().port][].\n\n