function createSocket
Jump to headingcreateSocket(type: SocketType,callback?: (msg: Buffer,rinfo: RemoteInfo,) => void,): Socket
Creates a dgram.Socket
object. Once the socket is created, calling socket.bind()
will instruct the socket to begin listening for datagram
messages. When address
and port
are not passed to socket.bind()
the
method will bind the socket to the "all interfaces" address on a random port
(it does the right thing for both udp4
and udp6
sockets). The bound address
and port can be retrieved using socket.address().address
and socket.address().port
.
If the signal
option is enabled, calling .abort()
on the corresponding AbortController
is similar to calling .close()
on the socket:
const controller = new AbortController();
const { signal } = controller;
const server = dgram.createSocket({ type: 'udp4', signal });
server.on('message', (msg, rinfo) => {
console.log(`server got: ${msg} from ${rinfo.address}:${rinfo.port}`);
});
// Later, when you want to close the server.
controller.abort();
Parameters Jump to heading
optional
Jump to headingcallback: (msg: Buffer,rinfo: RemoteInfo,) => void
Attached as a listener for 'message'
events. Optional.
Return Type Jump to heading
Jump to headingcreateSocket(options: SocketOptions,callback?: (msg: Buffer,rinfo: RemoteInfo,) => void,): Socket
Parameters Jump to heading
Jump to headingoptions: SocketOptions
optional
Jump to headingcallback: (msg: Buffer,rinfo: RemoteInfo,) => void