The net module provides an asynchronous network API for creating stream-based\nTCP or IPC servers (net.createServer()) and clients\n(net.createConnection()).
It can be accessed using:
\nconst net = require('net');\nThe net module supports IPC with named pipes on Windows, and UNIX domain\nsockets on other operating systems.
net.connect(), net.createConnection(), server.listen() and\nsocket.connect() take a path parameter to identify IPC endpoints.
On UNIX, the local domain is also known as the UNIX domain. The path is a\nfilesystem path name. It gets truncated to sizeof(sockaddr_un.sun_path) - 1,\nwhich varies on different operating system between 91 and 107 bytes.\nThe typical values are 107 on Linux and 103 on macOS. The path is\nsubject to the same naming conventions and permissions checks as would be done\non file creation. It will be visible in the filesystem, and will persist until\nunlinked.
On Windows, the local domain is implemented using a named pipe. The path must\nrefer to an entry in \\\\?\\pipe\\ or \\\\.\\pipe\\. Any characters are permitted,\nbut the latter may do some processing of pipe names, such as resolving ..\nsequences. Despite appearances, the pipe name space is flat. Pipes will not\npersist, they are removed when the last reference to them is closed. Do not\nforget JavaScript string escaping requires paths to be specified with\ndouble-backslashes, such as:
net.createServer().listen(\n path.join('\\\\\\\\?\\\\pipe', process.cwd(), 'myctl'));\nThis class is used to create a TCP or IPC server.
\n", "methods": [ { "textRaw": "new net.Server([options][, connectionListener])", "type": "method", "name": "Server", "signatures": [ { "return": { "textRaw": "Returns: {net.Server} ", "name": "return", "type": "net.Server" }, "params": [ { "name": "options", "optional": true }, { "name": "connectionListener", "optional": true } ] }, { "params": [ { "name": "options", "optional": true }, { "name": "connectionListener", "optional": true } ] } ], "desc": "See net.createServer([options][, connectionListener]).
net.Server is an EventEmitter with the following events:
Returns the bound address, the address family name, and port of the server\nas reported by the operating system if listening on an IP socket.\nUseful to find which port was assigned when getting an OS-assigned address.\nReturns an object with port, family, and address properties:\n{ port: 12346, family: 'IPv4', address: '127.0.0.1' }
For a server listening on a pipe or UNIX domain socket, the name is returned\nas a string.
\nExample:
\nconst server = net.createServer((socket) => {\n socket.end('goodbye\\n');\n}).on('error', (err) => {\n // handle errors here\n throw err;\n});\n\n// grab an arbitrary unused port.\nserver.listen(() => {\n console.log('opened server on', server.address());\n});\nDon't call server.address() until the 'listening' event has been emitted.
Stops the server from accepting new connections and keeps existing\nconnections. This function is asynchronous, the server is finally\nclosed when all connections are ended and the server emits a 'close' event.\nThe optional callback will be called once the 'close' event occurs. Unlike\nthat event, it will be called with an Error as its only argument if the server\nwas not open when it was closed.
Returns server.
Asynchronously get the number of concurrent connections on the server. Works\nwhen sockets were sent to forks.
\nCallback should take two arguments err and count.
Start a server listening for connections. A net.Server can be a TCP or\na IPC server depending on what it listens to.
Possible signatures:
\nserver.listen(handle[, backlog][, callback])server.listen(options[, callback])server.listen(path[, backlog][, callback])\nfor IPC serversserver.listen([port][, host][, backlog][, callback])\nfor TCP serversThis function is asynchronous. When the server starts listening, the\n'listening' event will be emitted. The last parameter callback\nwill be added as a listener for the 'listening' event.
All listen() methods can take a backlog parameter to specify the maximum\nlength of the queue of pending connections. The actual length will be determined\nby the OS through sysctl settings such as tcp_max_syn_backlog and somaxconn\non Linux. The default value of this parameter is 511 (not 512).
Note:
\nAll net.Socket are set to SO_REUSEADDR (See socket(7) for\ndetails).
The server.listen() method may be called multiple times. Each\nsubsequent call will re-open the server using the provided options.
One of the most common errors raised when listening is EADDRINUSE.\nThis happens when another server is already listening on the requested\nport / path / handle. One way to handle this would be to retry\nafter a certain amount of time:
server.on('error', (e) => {\n if (e.code === 'EADDRINUSE') {\n console.log('Address in use, retrying...');\n setTimeout(() => {\n server.close();\n server.listen(PORT, HOST);\n }, 1000);\n }\n});\nStart a server listening for connections on a given handle that has\nalready been bound to a port, a UNIX domain socket, or a Windows named pipe.
The handle object can be either a server, a socket (anything with an\nunderlying _handle member), or an object with an fd member that is a\nvalid file descriptor.
Note: Listening on a file descriptor is not supported on Windows.
\n" }, { "textRaw": "server.listen(options[, callback])", "type": "method", "name": "listen", "meta": { "added": [ "v0.11.14" ], "changes": [] }, "signatures": [ { "return": { "textRaw": "Returns: {net.Server} ", "name": "return", "type": "net.Server" }, "params": [ { "textRaw": "`options` {Object} Required. Supports the following properties: ", "options": [ { "textRaw": "`port` {number} ", "name": "port", "type": "number" }, { "textRaw": "`host` {string} ", "name": "host", "type": "string" }, { "textRaw": "`path` {string} Will be ignored if `port` is specified. See [Identifying paths for IPC connections][]. ", "name": "path", "type": "string", "desc": "Will be ignored if `port` is specified. See [Identifying paths for IPC connections][]." }, { "textRaw": "`backlog` {number} Common parameter of [`server.listen()`][] functions ", "name": "backlog", "type": "number", "desc": "Common parameter of [`server.listen()`][] functions" }, { "textRaw": "`exclusive` {boolean} Default to `false` ", "name": "exclusive", "type": "boolean", "desc": "Default to `false`" } ], "name": "options", "type": "Object", "desc": "Required. Supports the following properties:" }, { "textRaw": "`callback` {Function} Common parameter of [`server.listen()`][] functions ", "name": "callback", "type": "Function", "desc": "Common parameter of [`server.listen()`][] functions", "optional": true } ] }, { "params": [ { "name": "options" }, { "name": "callback", "optional": true } ] } ], "desc": "If port is specified, it behaves the same as\nserver.listen([port][, hostname][, backlog][, callback]).\nOtherwise, if path is specified, it behaves the same as\nserver.listen(path[, backlog][, callback]).\nIf none of them is specified, an error will be thrown.
If exclusive is false (default), then cluster workers will use the same\nunderlying handle, allowing connection handling duties to be shared. When\nexclusive is true, the handle is not shared, and attempted port sharing\nresults in an error. An example which listens on an exclusive port is\nshown below.
server.listen({\n host: 'localhost',\n port: 80,\n exclusive: true\n});\nStart a IPC server listening for connections on the given path.
Start a TCP server listening for connections on the given port and host.
If port is omitted or is 0, the operating system will assign an arbitrary\nunused port, which can be retrieved by using server.address().port\nafter the 'listening' event has been emitted.
If host is omitted, the server will accept connections on the\nunspecified IPv6 address (::) when IPv6 is available, or the\nunspecified IPv4 address (0.0.0.0) otherwise.
Note: In most operating systems, listening to the\nunspecified IPv6 address (::) may cause the net.Server to also listen on\nthe unspecified IPv4 address (0.0.0.0).
Opposite of unref, calling ref on a previously unrefd server will not\nlet the program exit if it's the only server left (the default behavior). If\nthe server is refd calling ref again will have no effect.
Calling unref on a server will allow the program to exit if this is the only\nactive server in the event system. If the server is already unrefd calling\nunref again will have no effect.
Emitted when the server closes. Note that if connections exist, this\nevent is not emitted until all connections are ended.
\n", "params": [] }, { "textRaw": "Event: 'connection'", "type": "event", "name": "connection", "meta": { "added": [ "v0.1.90" ], "changes": [] }, "params": [], "desc": "Emitted when a new connection is made. socket is an instance of\nnet.Socket.
Emitted when an error occurs. Unlike net.Socket, the 'close'\nevent will not be emitted directly following this event unless\nserver.close() is manually called. See the example in discussion of\nserver.listen().
Emitted when the server has been bound after calling server.listen().
The number of concurrent connections on the server.
\nThis becomes null when sending a socket to a child with\nchild_process.fork(). To poll forks and get current number of active\nconnections use asynchronous server.getConnections() instead.
A Boolean indicating whether or not the server is listening for\nconnections.
\n" }, { "textRaw": "server.maxConnections", "name": "maxConnections", "meta": { "added": [ "v0.2.0" ], "changes": [] }, "desc": "Set this property to reject connections when the server's connection count gets\nhigh.
\nIt is not recommended to use this option once a socket has been sent to a child\nwith child_process.fork().
This class is an abstraction of a TCP socket or a streaming IPC endpoint\n(uses named pipes on Windows, and UNIX domain sockets otherwise). A\nnet.Socket is also a duplex stream, so it can be both readable and\nwritable, and it is also a EventEmitter.
A net.Socket can be created by the user and used directly to interact with\na server. For example, it is returned by net.createConnection(),\nso the user can use it to talk to the server.
It can also be created by Node.js and passed to the user when a connection\nis received. For example, it is passed to the listeners of a\n'connection' event emitted on a net.Server, so the user can use\nit to interact with the client.
Creates a new socket object.
\noptions {Object} Available options are:fd: {number} If specified, wrap around an existing socket with\nthe given file descriptor, otherwise a new socket will be created.allowHalfOpen {boolean} Indicates whether half-opened TCP connections\nare allowed. See net.createServer() and the 'end' event\nfor details. Defaults to false.readable {boolean} Allow reads on the socket when an fd is passed,\notherwise ignored. Defaults to false.writable {boolean} Allow writes on the socket when an fd is passed,\notherwise ignored. Defaults to false.The newly created socket can be either a TCP socket or a streaming IPC\nendpoint, depending on what it connect() to.
Returns the bound address, the address family name and port of the\nsocket as reported by the operating system. Returns an object with\nthree properties, e.g.\n{ port: 12346, family: 'IPv4', address: '127.0.0.1' }
Initiate a connection on a given socket.
\nPossible signatures:
\nThis function is asynchronous. When the connection is established, the\n'connect' event will be emitted. If there is a problem connecting,\ninstead of a 'connect' event, an 'error' event will be emitted with\nthe error passed to the 'error' listener.\nThe last parameter connectListener, if supplied, will be added as a listener\nfor the 'connect' event once.
Initiate a connection on a given socket. Normally this method is not needed,\nthe socket should be created and opened with net.createConnection(). Use\nthis only when implementing a custom Socket.
For TCP connections, available options are:
port {number} Required. Port the socket should connect to.host {string} Host the socket should connect to. Defaults to 'localhost'.localAddress {string} Local address the socket should connect from.localPort {number} Local port the socket should connect from.family {number}: Version of IP stack, can be either 4 or 6. Defaults to 4.hints {number} Optional dns.lookup() hints.lookup {Function} Custom lookup function. Defaults to dns.lookup().For IPC connections, available options are:
path {string} Required. Path the client should connect to.\nSee Identifying paths for IPC connections. If provided, the TCP-specific\noptions above are ignored.Returns socket.
Initiate an IPC connection on the given socket.
\nAlias to\nsocket.connect(options[, connectListener])\ncalled with { path: path } as options.
Returns socket.
Initiate a TCP connection on the given socket.
\nAlias to\nsocket.connect(options[, connectListener])\ncalled with {port: port, host: host} as options.
Returns socket.
Ensures that no more I/O activity happens on this socket. Only necessary in\ncase of errors (parse error or so).
\nIf exception is specified, an 'error' event will be emitted and any\nlisteners for that event will receive exception as an argument.
Half-closes the socket. i.e., it sends a FIN packet. It is possible the\nserver will still send some data.
\nIf data is specified, it is equivalent to calling\nsocket.write(data, encoding) followed by socket.end().
Pauses the reading of data. That is, 'data' events will not be emitted.\nUseful to throttle back an upload.
Opposite of unref, calling ref on a previously unrefd socket will not\nlet the program exit if it's the only socket left (the default behavior). If\nthe socket is refd calling ref again will have no effect.
Resumes reading after a call to socket.pause().
Set the encoding for the socket as a Readable Stream. See\nstream.setEncoding() for more information.
Enable/disable keep-alive functionality, and optionally set the initial\ndelay before the first keepalive probe is sent on an idle socket.\nenable defaults to false.
Set initialDelay (in milliseconds) to set the delay between the last\ndata packet received and the first keepalive probe. Setting 0 for\ninitialDelay will leave the value unchanged from the default\n(or previous) setting. Defaults to 0.
Disables the Nagle algorithm. By default TCP connections use the Nagle\nalgorithm, they buffer data before sending it off. Setting true for\nnoDelay will immediately fire off data each time socket.write() is called.\nnoDelay defaults to true.
Sets the socket to timeout after timeout milliseconds of inactivity on\nthe socket. By default net.Socket do not have a timeout.
When an idle timeout is triggered the socket will receive a 'timeout'\nevent but the connection will not be severed. The user must manually call\nsocket.end() or socket.destroy() to end the connection.
socket.setTimeout(3000);\nsocket.on('timeout', () => {\n console.log('socket timeout');\n socket.end();\n});\nIf timeout is 0, then the existing idle timeout is disabled.
The optional callback parameter will be added as a one time listener for the\n'timeout' event.
Calling unref on a socket will allow the program to exit if this is the only\nactive socket in the event system. If the socket is already unrefd calling\nunref again will have no effect.
Sends data on the socket. The second parameter specifies the encoding in the\ncase of a string--it defaults to UTF8 encoding.
\nReturns true if the entire data was flushed successfully to the kernel\nbuffer. Returns false if all or part of the data was queued in user memory.\n'drain' will be emitted when the buffer is again free.
The optional callback parameter will be executed when the data is finally\nwritten out - this may not be immediately.
Emitted once the socket is fully closed. The argument had_error is a boolean\nwhich says if the socket was closed due to a transmission error.
Emitted when a socket connection is successfully established.\nSee net.createConnection().
Emitted when data is received. The argument data will be a Buffer or\nString. Encoding of data is set by socket.setEncoding().\n(See the Readable Stream section for more information.)
Note that the data will be lost if there is no listener when a Socket\nemits a 'data' event.
Emitted when the write buffer becomes empty. Can be used to throttle uploads.
\nSee also: the return values of socket.write()
Emitted when the other end of the socket sends a FIN packet, thus ending the\nreadable side of the socket.
\nBy default (allowHalfOpen is false) the socket will send a FIN packet\nback and destroy its file descriptor once it has written out its pending\nwrite queue. However, if allowHalfOpen is set to true, the socket will\nnot automatically end() its writable side, allowing the\nuser to write arbitrary amounts of data. The user must call\nend() explicitly to close the connection (i.e. sending a\nFIN packet back).
Emitted when an error occurs. The 'close' event will be called directly\nfollowing this event.
Emitted after resolving the hostname but before connecting.\nNot applicable to UNIX sockets.
\nerr {Error|null} The error object. See dns.lookup().address {string} The IP address.family {string|null} The address type. See dns.lookup().host {string} The hostname.Emitted if the socket times out from inactivity. This is only to notify that\nthe socket has been idle. The user must manually close the connection.
\nSee also: socket.setTimeout()
net.Socket has the property that socket.write() always works. This is to\nhelp users get up and running quickly. The computer cannot always keep up\nwith the amount of data that is written to a socket - the network connection\nsimply might be too slow. Node.js will internally queue up the data written to a\nsocket and send it out over the wire when it is possible. (Internally it is\npolling on the socket's file descriptor for being writable).
The consequence of this internal buffering is that memory may grow. This\nproperty shows the number of characters currently buffered to be written.\n(Number of characters is approximately equal to the number of bytes to be\nwritten, but the buffer may contain strings, and the strings are lazily\nencoded, so the exact number of bytes is not known.)
\nUsers who experience large or growing bufferSize should attempt to\n"throttle" the data flows in their program with\nsocket.pause() and socket.resume().
The amount of received bytes.
\n" }, { "textRaw": "socket.bytesWritten", "name": "bytesWritten", "meta": { "added": [ "v0.5.3" ], "changes": [] }, "desc": "The amount of bytes sent.
\n" }, { "textRaw": "socket.connecting", "name": "connecting", "meta": { "added": [ "v6.1.0" ], "changes": [] }, "desc": "If true -\nsocket.connect(options[, connectListener])\nwas called and haven't yet finished. Will be set to false before emitting\nconnect event and/or calling\nsocket.connect(options[, connectListener])'s\ncallback.
A Boolean value that indicates if the connection is destroyed or not. Once a\nconnection is destroyed no further data can be transferred using it.
\n" }, { "textRaw": "socket.localAddress", "name": "localAddress", "meta": { "added": [ "v0.9.6" ], "changes": [] }, "desc": "The string representation of the local IP address the remote client is\nconnecting on. For example, in a server listening on '0.0.0.0', if a client\nconnects on '192.168.1.1', the value of socket.localAddress would be\n'192.168.1.1'.
The numeric representation of the local port. For example,\n80 or 21.
The string representation of the remote IP address. For example,\n'74.125.127.100' or '2001:4860:a005::68'. Value may be undefined if\nthe socket is destroyed (for example, if the client disconnected).
The string representation of the remote IP family. 'IPv4' or 'IPv6'.
The numeric representation of the remote port. For example,\n80 or 21.
Aliases to\nnet.createConnection().
Possible signatures:
\nnet.connect(options[, connectListener])net.connect(path[, connectListener]) for IPC\nconnections.net.connect(port[, host][, connectListener])\nfor TCP connections.Alias to\nnet.createConnection(options[, connectListener]).
Alias to\nnet.createConnection(path[, connectListener]).
Alias to\nnet.createConnection(port[, host][, connectListener]).
A factory function, which creates a new net.Socket,\nimmediately initiates connection with socket.connect(),\nthen returns the net.Socket that starts the connection.
When the connection is established, a 'connect' event will be emitted\non the returned socket. The last parameter connectListener, if supplied,\nwill be added as a listener for the 'connect' event once.
Possible signatures:
\nnet.createConnection(options[, connectListener])net.createConnection(path[, connectListener])\nfor IPC connections.net.createConnection(port[, host][, connectListener])\nfor TCP connections.Note: The net.connect() function is an alias to this function.
For available options, see\nnew net.Socket([options])\nand socket.connect(options[, connectListener]).
Additional options:
\ntimeout {number} If set, will be used to call\nsocket.setTimeout(timeout) after the socket is created, but before\nit starts the connection.Following is an example of a client of the echo server described\nin the net.createServer() section:
const net = require('net');\nconst client = net.createConnection({ port: 8124 }, () => {\n //'connect' listener\n console.log('connected to server!');\n client.write('world!\\r\\n');\n});\nclient.on('data', (data) => {\n console.log(data.toString());\n client.end();\n});\nclient.on('end', () => {\n console.log('disconnected from server');\n});\nTo connect on the socket /tmp/echo.sock the second line would just be\nchanged to
const client = net.createConnection({ path: '/tmp/echo.sock' });\nInitiates an IPC connection.
\nThis function creates a new net.Socket with all options set to default,\nimmediately initiates connection with\nsocket.connect(path[, connectListener]),\nthen returns the net.Socket that starts the connection.
Initiates a TCP connection.
\nThis function creates a new net.Socket with all options set to default,\nimmediately initiates connection with\nsocket.connect(port[, host][, connectListener]),\nthen returns the net.Socket that starts the connection.
Creates a new TCP or IPC server.
\noptions {Object}allowHalfOpen {boolean} Default to false. Indicates whether half-opened\nTCP connections are allowed.pauseOnConnect {boolean} Default to false. Indicates whether the socket\nshould be paused on incoming connections.connectionListener {Function} Automatically set as a listener for the\n'connection' eventIf allowHalfOpen is set to true, when the other end of the socket\nsends a FIN packet, the server will only send a FIN packet back when\nsocket.end() is explicitly called, until then the connection is\nhalf-closed (non-readable but still writable). See 'end' event\nand RFC 1122 (section 4.2.2.13) for more information.
If pauseOnConnect is set to true, then the socket associated with each\nincoming connection will be paused, and no data will be read from its handle.\nThis allows connections to be passed between processes without any data being\nread by the original process. To begin reading data from a paused socket, call\nsocket.resume().
The server can be a TCP server or a IPC server, depending on what it\nlisten() to.
Here is an example of an TCP echo server which listens for connections\non port 8124:
\nconst net = require('net');\nconst server = net.createServer((c) => {\n // 'connection' listener\n console.log('client connected');\n c.on('end', () => {\n console.log('client disconnected');\n });\n c.write('hello\\r\\n');\n c.pipe(c);\n});\nserver.on('error', (err) => {\n throw err;\n});\nserver.listen(8124, () => {\n console.log('server bound');\n});\nTest this by using telnet:
$ telnet localhost 8124\nTo listen on the socket /tmp/echo.sock the third line from the last would\njust be changed to
server.listen('/tmp/echo.sock', () => {\n console.log('server bound');\n});\nUse nc to connect to a UNIX domain socket server:
$ nc -U /tmp/echo.sock\nTests if input is an IP address. Returns 0 for invalid strings,\nreturns 4 for IP version 4 addresses, and returns 6 for IP version 6 addresses.
\n", "signatures": [ { "params": [ { "name": "input" } ] } ] }, { "textRaw": "net.isIPv4(input)", "type": "method", "name": "isIPv4", "meta": { "added": [ "v0.3.0" ], "changes": [] }, "desc": "Returns true if input is a version 4 IP address, otherwise returns false.
\n", "signatures": [ { "params": [ { "name": "input" } ] } ] }, { "textRaw": "net.isIPv6(input)", "type": "method", "name": "isIPv6", "meta": { "added": [ "v0.3.0" ], "changes": [] }, "desc": "Returns true if input is a version 6 IP address, otherwise returns false.
\n", "signatures": [ { "params": [ { "name": "input" } ] } ] } ], "type": "module", "displayName": "Net" } ] }