Определение путей для IPC-соединений

Для указания конечных точек IPC параметр path принимают net.connect(), net.createConnection(), server.listen() и socket.connect().

В Unix локальный домен также известен как домен Unix. Путь представляет собой имя файла в файловой системе. Его длина ограничена зависящим от ОС значением sizeof(sockaddr_un.sun_path) - 1. Типичные значения — 107 байт в Linux и 103 байта в macOS. Если абстракция API Node.js создает сокет домена Unix, она также удалит его. Например, net.createServer() может создать сокет домена Unix, а server.close() удалит его. Но если пользователь создает сокет домена Unix вне этих абстракций, ему потребуется удалить его самостоятельно. То же самое относится к ситуации, когда API Node.js создает сокет домена Unix, но затем программа аварийно завершается. Иными словами, сокет домена Unix будет виден в файловой системе и сохранится там, пока его не удалят. В Linux можно использовать абстрактный сокет Unix, добавив \0 в начало пути, например \0abstract. Путь к абстрактному сокету Unix не виден в файловой системе, и сокет автоматически исчезнет, когда будут закрыты все открытые ссылки на него.

В Windows локальный домен реализован с помощью именованного канала. Путь должен указывать на запись в \\?\pipe\ или \\.\pipe\. Допускаются любые символы, однако последний вариант может выполнять обработку имен каналов, например разрешать последовательности ... Несмотря на внешний вид, пространство имен каналов является плоским. Каналы не сохраняются. Они удаляются после закрытия последней ссылки на них. В отличие от сокетов домена Unix, Windows закрывает и удаляет канал при завершении процесса-владельца.

Для экранирования строк JavaScript пути необходимо указывать с дополнительным экранированием обратной косой черты, например:

net.createServer().listen(
  path.join('\\\\?\\pipe', process.cwd(), 'myctl')); copy

blockList.addAddress(address[, type])

• address <string> | <net.SocketAddress> IPv4- или IPv6-адрес.
• type <string> Либо 'ipv4', либо 'ipv6'. По умолчанию: 'ipv4'.

Добавляет правило, запрещающее указанный IP-адрес.

blockList.addRange(start, end[, type])

• start <string> | <net.SocketAddress> Начальный IPv4- или IPv6-адрес диапазона.
• end <string> | <net.SocketAddress> Конечный IPv4- или IPv6-адрес диапазона.
• type <string> Либо 'ipv4', либо 'ipv6'. По умолчанию: 'ipv4'.

Добавляет правило, запрещающее диапазон IP-адресов от start (включительно) до end (включительно).

blockList.addSubnet(net, prefix[, type])

• net <string> | <net.SocketAddress> Сетевой IPv4- или IPv6-адрес.
• prefix <number> Количество бит префикса CIDR. Для IPv4 значение должно быть в диапазоне от 0 до 32. Для IPv6 — в диапазоне от 0 до 128.
• type <string> Либо 'ipv4', либо 'ipv6'. По умолчанию: 'ipv4'.

Добавляет правило, запрещающее диапазон IP-адресов, заданный маской подсети.

blockList.check(address[, type])

• address <string> | <net.SocketAddress> IP-адрес для проверки
• type <string> Либо 'ipv4', либо 'ipv6'. По умолчанию: 'ipv4'.
• Возвращает: <boolean>

Возвращает true, если указанный IP-адрес соответствует одному из правил, добавленных в BlockList.

const blockList = new net.BlockList();
blockList.addAddress('123.123.123.123');
blockList.addRange('10.0.0.1', '10.0.0.10');
blockList.addSubnet('8592:757c:efae:4e45::', 64, 'ipv6');

console.log(blockList.check('123.123.123.123'));  // Prints: true
console.log(blockList.check('10.0.0.3'));  // Prints: true
console.log(blockList.check('222.111.111.222'));  // Prints: false

// IPv6 notation for IPv4 addresses works:
console.log(blockList.check('::ffff:7b7b:7b7b', 'ipv6')); // Prints: true
console.log(blockList.check('::ffff:123.123.123.123', 'ipv6')); // Prints: true copy

blockList.rules

• Тип: <string[]>

Список правил, добавленных в список блокировки.

BlockList.isBlockList(value)

• value <any> Любое значение JS
• Возвращает true, если value является net.BlockList.

blockList.fromJSON(value)

const blockList = new net.BlockList();
const data = [
  'Subnet: IPv4 192.168.1.0/24',
  'Address: IPv4 10.0.0.5',
  'Range: IPv4 192.168.2.1-192.168.2.10',
  'Range: IPv4 10.0.0.1-10.0.0.10',
];
blockList.fromJSON(data);
blockList.fromJSON(JSON.stringify(data)); copy

• value Blocklist.rules

blockList.toJSON()

• Возвращает Blocklist.rules

new net.SocketAddress([options])

• options <Object>
  • address <string> Сетевой адрес в виде строки IPv4 или IPv6. По умолчанию: '127.0.0.1', если family — 'ipv4'; '::', если family — 'ipv6'.
  • family <string> Одно из значений: 'ipv4' или 'ipv6'. По умолчанию: 'ipv4'.
  • flowlabel <number> Метка потока IPv6, используемая только в том случае, если family — 'ipv6'.
  • port <number> IP-порт.

socketaddress.address

• Тип: <string>

socketaddress.family

• Тип: <string> Либо 'ipv4', либо 'ipv6'.

socketaddress.flowlabel

• Тип: <number>

socketaddress.port

• Тип: <number>

SocketAddress.parse(input)

• input <string> Входная строка с IP-адресом и необязательным портом, например 123.1.2.3:1234 или [1::1]:1234.
• Возвращает: <net.SocketAddress> Возвращает SocketAddress, если разбор выполнен успешно. В противном случае возвращает undefined.

new net.Server([options][, connectionListener])

• options <Object> См. net.createServer([options][, connectionListener]).
• connectionListener <Function> Автоматически устанавливается как слушатель события 'connection'.
• Возвращает: <net.Server>

net.Server — это EventEmitter со следующими событиями:

Событие: 'close'

Генерируется при закрытии сервера. Если имеются соединения, это событие генерируется только после завершения всех соединений.

Событие: 'connection'

• Тип: <net.Socket> Объект соединения

Генерируется при установлении нового соединения. socket является экземпляром net.Socket.

Событие: 'error'

• Тип: <Error>

Генерируется при возникновении ошибки. В отличие от net.Socket, событие 'close' не будет сгенерировано непосредственно после этого события, если только не вызвать вручную server.close(). См. пример в описании server.listen().

Событие: 'listening'

Генерируется после привязки сервера при вызове server.listen().

Событие: 'drop'

Когда количество соединений достигает порогового значения server.maxConnections, сервер будет отклонять новые соединения и вместо этого генерировать событие 'drop'. Если это TCP-сервер, аргумент будет следующим; в противном случае аргументом будет undefined.

• data <Object> Аргумент, передаваемый обработчику события.
  • localAddress <string> Локальный адрес.
  • localPort <number> Локальный порт.
  • localFamily <string> Локальное семейство адресов.
  • remoteAddress <string> Удалённый адрес.
  • remotePort <number> Удалённый порт.
  • remoteFamily <string> Семейство удалённого IP-адреса. 'IPv4' или 'IPv6'.

server.address()

• Возвращает: <Object> | <string> | <null>

Возвращает привязанный address, имя адреса family и port сервера, сообщённые операционной системой, если сервер прослушивает IP-сокет (это полезно для определения назначенного ОС порта): { port: 12346, family: 'IPv4', address: '127.0.0.1' }.

Для сервера, прослушивающего канал или доменный сокет Unix, имя возвращается в виде строки.

const server = net.createServer((socket) => {
  socket.end('goodbye\n');
}).on('error', (err) => {
  // Handle errors here.
  throw err;
});

// Grab an arbitrary unused port.
server.listen(() => {
  console.log('opened server on', server.address());
}); copy

server.address() возвращает null до генерации события 'listening' или после вызова server.close().

server.close([callback])

• callback <Function> Вызывается при закрытии сервера.
• Возвращает: <net.Server>

Прекращает приём новых соединений сервером, сохраняя существующие соединения. Эта функция асинхронная; сервер окончательно закрывается после завершения всех соединений и генерирует событие 'close'. Необязательный параметр callback будет вызван при возникновении события 'close'. В отличие от этого события, он будет вызван с объектом Error в качестве единственного аргумента, если сервер не был открыт на момент закрытия.

server[Symbol.asyncDispose]()

Вызывает server.close() и возвращает промис, который выполняется после закрытия сервера.

server.getConnections(callback)

• callback <Function>
• Возвращает: <net.Server>

Асинхронно получает количество одновременных соединений с сервером. Работает, если сокеты были переданы дочерним процессам.

Функция обратного вызова должна принимать два аргумента: err и count.

server.listen()

Запускает сервер, чтобы он прослушивал соединения. В зависимости от того, что он прослушивает, net.Server может быть TCP-сервером или сервером IPC.

Возможные сигнатуры:

• server.listen(handle[, backlog][, callback])
• server.listen(options[, callback])
• server.listen(path[, backlog][, callback]) для серверов IPC
• server.listen([port[, host[, backlog]]][, callback]) для TCP-серверов

Эта функция асинхронная. Когда сервер начинает прослушивать соединения, генерируется событие 'listening'. Последний параметр callback будет добавлен как обработчик события 'listening'.

Все методы listen() могут принимать параметр backlog, задающий максимальную длину очереди ожидающих соединений. Фактическую длину определяет ОС с помощью параметров sysctl, таких как tcp_max_syn_backlog и somaxconn в Linux. Значение этого параметра по умолчанию — 511 (не 512).

Для всех net.Socket устанавливается значение SO_REUSEADDR (подробности см. в socket(7)).

Метод server.listen() можно вызвать повторно только в том случае, если при первом вызове server.listen() произошла ошибка или был вызван server.close(). В противном случае будет выброшена ошибка ERR_SERVER_ALREADY_LISTEN.

Одна из наиболее частых ошибок при начале прослушивания — EADDRINUSE. Она возникает, когда другой сервер уже прослушивает запрошенные port/path/handle. Один из способов её обработки — повторить попытку через некоторое время:

server.on('error', (e) => {
  if (e.code === 'EADDRINUSE') {
    console.error('Address in use, retrying...');
    setTimeout(() => {
      server.close();
      server.listen(PORT, HOST);
    }, 1000);
  }
}); copy

server.listen({
  host: 'localhost',
  port: 80,
  exclusive: true,
}); copy

const controller = new AbortController();
server.listen({
  host: 'localhost',
  port: 80,
  signal: controller.signal,
});
// Later, when you want to close the server.
controller.abort(); copy

server.listening

• Тип: <boolean> Указывает, прослушивает ли сервер соединения.

server.maxConnections

• Тип: <integer>

Когда количество соединений достигает порогового значения server.maxConnections:

1. Если процесс не работает в режиме кластера, Node.js закроет соединение.

2. Если процесс работает в режиме кластера, Node.js по умолчанию направит соединение другому рабочему процессу. Чтобы вместо этого закрыть соединение, установите [server.dropMaxConnection][] в true.

Не рекомендуется использовать этот параметр после передачи сокета дочернему процессу с помощью child_process.fork().

server.dropMaxConnection

• Тип: <boolean>

Установите для этого свойства значение true, чтобы начать закрывать соединения, когда их количество достигнет порогового значения [server.maxConnections][]. Этот параметр действует только в режиме кластера.

server.ref()

• Возвращает: <net.Server>

Противоположность unref(): вызов ref() для сервера, ранее помеченного как unref, не позволит программе завершиться, если это единственный оставшийся сервер (поведение по умолчанию). Если сервер уже помечен как ref, повторный вызов ref() не повлияет на результат.

server.unref()

• Возвращает: <net.Server>

Вызов unref() для сервера позволит программе завершиться, если это единственный активный сервер в системе событий. Если сервер уже помечен как unref, повторный вызов unref() не повлияет на результат.

new net.Socket([options])

• options <Object> Доступны следующие параметры:
  • allowHalfOpen <boolean> Если задано значение false, сокет автоматически завершит записываемую сторону, когда завершится читаемая сторона. Подробнее см. в описании net.createServer() и события 'end'. По умолчанию: false.
  • fd <number> Если указано, оборачивает существующий сокет с заданным файловым дескриптором; в противном случае создаётся новый сокет.
  • onread <Object> Если указано, входящие данные сохраняются в одном buffer и передаются указанному callback при поступлении данных в сокет. При этом потоковая функциональность не будет предоставлять данные. Сокет будет, как обычно, испускать такие события, как 'error', 'end' и 'close'. Такие методы, как pause() и resume(), также будут работать ожидаемым образом.
    • buffer <Buffer> | <Uint8Array> | <Function> Повторно используемый фрагмент памяти для хранения входящих данных либо функция, возвращающая такой фрагмент.
    • callback <Function> Эта функция вызывается для каждого фрагмента входящих данных. Ей передаются два аргумента: число байтов, записанных в buffer, и ссылка на buffer. Возвратите из этой функции false, чтобы неявно pause() сокет. Эта функция выполняется в глобальном контексте.
  • readable <boolean> Разрешает чтение из сокета, если передан fd; в противном случае игнорируется. По умолчанию: false.
  • signal <AbortSignal> Сигнал Abort, который можно использовать для уничтожения сокета.
  • writable <boolean> Разрешает запись в сокет, если передан fd; в противном случае игнорируется. По умолчанию: false.
• Возвращает: <net.Socket>

Создаёт новый объект сокета.

Созданный сокет может быть TCP-сокетом или потоковой конечной точкой IPC — это зависит от того, к чему он connect().

Событие: 'close'

• hadError <boolean> true, если в сокете произошла ошибка передачи данных.

Испускается после полного закрытия сокета. Аргумент hadError — это логическое значение, указывающее, был ли сокет закрыт из-за ошибки передачи данных.

Событие: 'connect'

Испускается при успешном установлении соединения сокета. См. net.createConnection().

Событие: 'connectionAttempt'

• ip <string> IP-адрес, к которому сокет пытается подключиться.
• port <number> Порт, к которому сокет пытается подключиться.
• family <number> Семейство IP-адреса. Может быть 6 для IPv6 или 4 для IPv4.

Испускается при начале новой попытки подключения. Событие может испускаться несколько раз, если алгоритм автоматического выбора семейства включён в socket.connect(options).

Событие: 'connectionAttemptFailed'

• ip <string> IP-адрес, к которому сокет пытался подключиться.
• port <number> Порт, к которому сокет пытался подключиться.
• family <number> Семейство IP-адреса. Может быть 6 для IPv6 или 4 для IPv4.
• error <Error> Ошибка, связанная со сбоем.

Испускается при неудачной попытке подключения. Событие может испускаться несколько раз, если алгоритм автоматического выбора семейства включён в socket.connect(options).

Событие: 'connectionAttemptTimeout'

• ip <string> IP-адрес, к которому сокет пытался подключиться.
• port <number> Порт, к которому сокет пытался подключиться.
• family <number> Семейство IP-адреса. Может быть 6 для IPv6 или 4 для IPv4.

Испускается при истечении времени ожидания попытки подключения. Событие испускается только в том случае (и может испускаться несколько раз), если алгоритм автоматического выбора семейства включён в socket.connect(options).

Событие: 'data'

• Тип: <Buffer> | <string>

Испускается при получении данных. Аргумент data будет иметь тип Buffer или String. Кодировка данных задаётся методом socket.setEncoding().

Данные будут потеряны, если в момент испускания события 'data' объектом Socket не будет зарегистрирован обработчик.

Событие: 'drain'

Испускается, когда буфер записи становится пустым. Можно использовать для ограничения скорости отправки данных.

См. также возвращаемые значения метода socket.write().

Событие: 'end'

Испускается, когда другая сторона сокета сигнализирует о завершении передачи, тем самым завершая читаемую сторону сокета.

По умолчанию (allowHalfOpen равно false) сокет отправит ответный пакет завершения передачи и уничтожит файловый дескриптор после отправки всех ожидающих данных из очереди записи. Однако если allowHalfOpen задано как true, сокет не будет автоматически end() записываемую сторону, позволяя пользователю записать произвольный объём данных. Чтобы закрыть соединение (то есть отправить ответный пакет FIN), пользователь должен явно вызвать end().

Событие: 'error'

• Тип: <Error>

Испускается при возникновении ошибки. Событие 'close' вызывается непосредственно после этого события.

Событие: 'lookup'

Испускается после разрешения имени хоста, но до подключения. Не применяется к сокетам Unix.

• err <Error> | <null> Объект ошибки. См. dns.lookup().
• address <string> IP-адрес.
• family <number> | <null> Тип адреса. См. dns.lookup().
• host <string> Имя хоста.

Событие: 'ready'

Испускается, когда сокет готов к использованию.

Вызывается сразу после 'connect'.

Событие: 'timeout'

Испускается, если время ожидания сокета истекает из-за отсутствия активности. Это событие лишь уведомляет о том, что сокет бездействовал. Пользователь должен закрыть соединение вручную.

См. также: socket.setTimeout().

socket.address()

• Возвращает: <Object>

Возвращает привязанный address, имя адреса family и port сокета в соответствии с данными операционной системы: { port: 12346, family: 'IPv4', address: '127.0.0.1' }

socket.autoSelectFamilyAttemptedAddresses

• Тип: <string[]>

Это свойство присутствует только в том случае, если алгоритм автоматического выбора семейства включён в socket.connect(options). Оно содержит массив адресов, для которых предпринимались попытки подключения.

Каждый адрес представлен строкой в формате $IP:$PORT. Если подключение выполнено успешно, последний адрес — это адрес, к которому в данный момент подключён сокет.

socket.bufferSize

• Тип: <integer>

Это свойство показывает количество символов, буферизованных для записи. Буфер может содержать строки, длина которых после кодирования ещё неизвестна. Поэтому это число лишь приблизительно соответствует количеству байтов в буфере.

У net.Socket есть свойство: socket.write() всегда работает. Это упрощает пользователям начало работы. Компьютер не всегда может обрабатывать данные с той же скоростью, с какой они записываются в сокет. Сетевое соединение может быть слишком медленным. Node.js будет помещать данные, записанные в сокет, во внутреннюю очередь и отправлять их по сети, когда это станет возможно.

Из-за такой внутренней буферизации объём используемой памяти может расти. Пользователям, у которых наблюдается большое или растущее значение bufferSize, следует попытаться ограничить потоки данных в программе с помощью socket.pause() и socket.resume().

socket.bytesRead

• Тип: <integer>

Количество полученных байтов.

socket.bytesWritten

• Тип: <integer>

Количество отправленных байтов.

socket.connect()

Инициирует соединение для заданного сокета.

Возможные сигнатуры:

• socket.connect(options[, connectListener])
• socket.connect(path[, connectListener]) для соединений IPC.
• socket.connect(port[, host][, connectListener]) для TCP-соединений.
• Возвращает: <net.Socket> Сам сокет.

Эта функция асинхронная. После установления соединения будет испущено событие 'connect'. Если подключиться не удастся, вместо события 'connect' будет испущено событие 'error', а ошибка будет передана обработчику события 'error'. Если указан последний параметр connectListener, он будет добавлен как обработчик события 'connect' и вызван один раз.

Эту функцию следует использовать только для повторного подключения сокета после испускания события 'close'; в противном случае поведение может быть неопределённым.

socket.connecting

• Тип: <boolean>

Если true, был вызван метод socket.connect(options[, connectListener]), выполнение которого ещё не завершилось. Значение останется true, пока сокет не подключится; затем оно изменится на false и будет испущено событие 'connect'. Обратите внимание, что обратный вызов socket.connect(options[, connectListener]) является обработчиком события 'connect'.

socket.destroy([error])

• error <Object>
• Возвращает: <net.Socket>

Гарантирует, что для этого сокета больше не будет выполняться ввод-вывод. Уничтожает поток и закрывает соединение.

Подробнее см. в описании writable.destroy().

socket.destroyed

• Тип: <boolean> Указывает, уничтожено ли соединение. После уничтожения соединения передача данных через него невозможна.

Подробнее см. в описании writable.destroyed.

socket.destroySoon()

Уничтожает сокет после записи всех данных. Если событие 'finish' уже было отправлено, сокет уничтожается немедленно. Если сокет всё ещё доступен для записи, неявно вызывается socket.end().

socket.end([data[, encoding]][, callback])

• data <string> | <Buffer> | <Uint8Array>
• encoding <string> Используется только в том случае, если данные имеют тип string. По умолчанию: 'utf8'.
• callback <Function> Необязательная функция обратного вызова, вызываемая после завершения работы с сокетом.
• Возвращает: <net.Socket> Сам сокет.

Выполняет полузакрытие сокета, то есть отправляет пакет FIN. Сервер всё ещё может отправить некоторые данные.

Дополнительные сведения см. в разделе writable.end().

socket.localAddress

• Тип: <string>

Строковое представление локального IP-адреса, к которому подключается удалённый клиент. Например, если сервер прослушивает '0.0.0.0', а клиент подключается к '192.168.1.1', значением socket.localAddress будет '192.168.1.1'.

socket.localPort

• Тип: <integer>

Числовое представление локального порта. Например, 80 или 21.

socket.localFamily

• Тип: <string>

Строковое представление локального семейства IP-адресов: 'IPv4' или 'IPv6'.

socket.pause()

• Возвращает: <net.Socket> Сам сокет.

Приостанавливает чтение данных. Это означает, что события 'data' отправляться не будут. Полезно для ограничения скорости отправки данных.

socket.pending

• Тип: <boolean>

Значение равно true, если сокет ещё не подключён: либо потому, что .connect() ещё не был вызван, либо потому, что подключение всё ещё выполняется (см. socket.connecting).

socket.ref()

• Возвращает: <net.Socket> Сам сокет.

Противоположность unref(): вызов ref() для ранее unref-нутого сокета не позволит программе завершиться, если это последний оставшийся сокет (поведение по умолчанию). Если сокет уже ref-нут, повторный вызов ref ни на что не повлияет.

socket.remoteAddress

• Тип: <string>

Строковое представление удалённого IP-адреса. Например, '74.125.127.100' или '2001:4860:a005::68'. Значение может быть undefined, если сокет уничтожен (например, если клиент отключился).

socket.remoteFamily

• Тип: <string>

Строковое представление удалённого семейства IP-адресов: 'IPv4' или 'IPv6'. Значение может быть undefined, если сокет уничтожен (например, если клиент отключился).

socket.remotePort

• Тип: <integer>

Числовое представление удалённого порта. Например, 80 или 21. Значение может быть undefined, если сокет уничтожен (например, если клиент отключился).

socket.resetAndDestroy()

• Возвращает: <net.Socket>

Закрывает TCP-соединение, отправляя пакет RST, и уничтожает поток. Если TCP-сокет находится в процессе подключения, пакет RST будет отправлен, а сокет уничтожен после установления соединения. В противном случае будет вызван socket.destroy с ошибкой ERR_SOCKET_CLOSED. Если это не TCP-сокет (например, канал), вызов этого метода немедленно приведёт к ошибке ERR_INVALID_HANDLE_TYPE.

socket.resume()

• Возвращает: <net.Socket> Сам сокет.

Возобновляет чтение после вызова socket.pause().

socket.setEncoding([encoding])

• encoding <string>
• Возвращает: <net.Socket> Сам сокет.

Задаёт кодировку сокета как потока для чтения. Дополнительные сведения см. в разделе readable.setEncoding().

socket.setKeepAlive([enable][, initialDelay])

• enable <boolean> По умолчанию: false
• initialDelay <number> По умолчанию: 0
• Возвращает: <net.Socket> Сам сокет.

Включает или отключает функцию keep-alive и, при необходимости, задаёт начальную задержку перед отправкой первого keepalive-зонда для простаивающего сокета.

Задайте initialDelay (в миллисекундах), чтобы установить задержку между получением последнего пакета данных и отправкой первого keepalive-зонда. Если для initialDelay указано значение 0, текущее значение останется без изменений (значение по умолчанию или ранее заданное).

При включении функции keep-alive задаются следующие параметры сокета:

• SO_KEEPALIVE=1
• TCP_KEEPIDLE=initialDelay
• TCP_KEEPCNT=10
• TCP_KEEPINTVL=1

socket.setNoDelay([noDelay])

• noDelay <boolean> По умолчанию: true
• Возвращает: <net.Socket> Сам сокет.

Включает или отключает алгоритм Нейгла.

При создании TCP-соединения алгоритм Нейгла включён.

Алгоритм Нейгла задерживает отправку данных по сети. Он стремится оптимизировать пропускную способность за счёт увеличения задержки.

Передача true для noDelay или отсутствие аргумента отключает алгоритм Нейгла для сокета. Передача false для noDelay включает алгоритм Нейгла.

socket.setTimeout(timeout[, callback])

• timeout <number>
• callback <Function>
• Возвращает: <net.Socket> Сам сокет.

Устанавливает тайм-аут сокета, который срабатывает после timeout миллисекунд бездействия. По умолчанию у net.Socket нет тайм-аута.

При срабатывании тайм-аута бездействия сокет получит событие 'timeout', но соединение не будет разорвано. Чтобы завершить соединение, пользователь должен вручную вызвать socket.end() или socket.destroy().

socket.setTimeout(3000);
socket.on('timeout', () => {
  console.log('socket timeout');
  socket.end();
}); copy

Если timeout равно 0, существующий тайм-аут бездействия отключается.

Необязательный параметр callback будет добавлен как одноразовый обработчик события 'timeout'.

socket.timeout

• Тип: <number> | <undefined>

Тайм-аут сокета в миллисекундах, установленный с помощью socket.setTimeout(). Значение равно undefined, если тайм-аут не задан.

socket.unref()

• Возвращает: <net.Socket> Сам сокет.

Вызов unref() для сокета позволит программе завершиться, если этот сокет — единственный активный сокет в системе событий. Если сокет уже unref-нут, повторный вызов unref() ни на что не повлияет.

socket.write(data[, encoding][, callback])

• data <string> | <Buffer> | <Uint8Array>
• encoding <string> Используется только в том случае, если данные имеют тип string. По умолчанию: utf8.
• callback <Function>
• Возвращает: <boolean>

Отправляет данные через сокет. Второй параметр задаёт кодировку, если передана строка. По умолчанию используется кодировка UTF8.

Возвращает true, если все данные успешно переданы в буфер ядра. Возвращает false, если часть или все данные поставлены в очередь в памяти пользователя. Событие 'drain' будет отправлено, когда буфер снова освободится.

Необязательный параметр callback будет вызван после фактической записи данных, которая может произойти не сразу.

Дополнительные сведения см. в описании метода write() потока Writable.

socket.readyState

• Тип: <string>

Это свойство представляет состояние соединения в виде строки.

• Если поток подключается, socket.readyState имеет значение opening.
• Если поток доступен для чтения и записи, его значение — open.
• Если поток доступен для чтения, но не для записи, его значение — readOnly.
• Если поток недоступен ни для чтения, ни для записи, его значение — writeOnly.

net.connect(options[, connectListener])

• options <Object>
• connectListener <Function>
• Возвращает: <net.Socket>

Псевдоним для net.createConnection(options[, connectListener]).

net.connect(path[, connectListener])

• path <string>
• connectListener <Function>
• Возвращает: <net.Socket>

Псевдоним для net.createConnection(path[, connectListener]).

net.connect(port[, host][, connectListener])

• port <number>
• host <string>
• connectListener <Function>
• Возвращает: <net.Socket>

Псевдоним для net.createConnection(port[, host][, connectListener]).

net.createConnection(options[, connectListener])

• options <Object> Обязательный параметр. Передаётся как в вызов new net.Socket([options]), так и в метод socket.connect(options[, connectListener]).
• connectListener <Function> Общий параметр функций net.createConnection(). Если он указан, будет добавлен как обработчик события 'connect' на возвращённом сокете и вызван один раз.
• Возвращает: <net.Socket> Новый сокет, используемый для начала соединения.

Доступные параметры см. в разделах new net.Socket([options]) и socket.connect(options[, connectListener]).

Дополнительные параметры:

• timeout <number> Если задан, будет использоваться для вызова socket.setTimeout(timeout) после создания сокета, но до начала установления соединения.

Ниже приведён пример клиента для эхо-сервера, описанного в разделе net.createServer():

import net from 'node:net';
const client = net.createConnection({ port: 8124 }, () => {
  // 'connect' listener.
  console.log('connected to server!');
  client.write('world!\r\n');
});
client.on('data', (data) => {
  console.log(data.toString());
  client.end();
});
client.on('end', () => {
  console.log('disconnected from server');
});

const net = require('node:net');
const client = net.createConnection({ port: 8124 }, () => {
  // 'connect' listener.
  console.log('connected to server!');
  client.write('world!\r\n');
});
client.on('data', (data) => {
  console.log(data.toString());
  client.end();
});
client.on('end', () => {
  console.log('disconnected from server');
});

Чтобы подключиться к сокету /tmp/echo.sock:

const client = net.createConnection({ path: '/tmp/echo.sock' }); copy

Ниже приведён пример клиента, использующего параметры port и onread. В этом случае параметр onread будет использоваться только для вызова new net.Socket([options]), а параметр port — для вызова socket.connect(options[, connectListener]).

import net from 'node:net';
import { Buffer } from 'node:buffer';
net.createConnection({
  port: 8124,
  onread: {
    // Reuses a 4KiB Buffer for every read from the socket.
    buffer: Buffer.alloc(4 * 1024),
    callback: function(nread, buf) {
      // Received data is available in `buf` from 0 to `nread`.
      console.log(buf.toString('utf8', 0, nread));
    },
  },
});

const net = require('node:net');
net.createConnection({
  port: 8124,
  onread: {
    // Reuses a 4KiB Buffer for every read from the socket.
    buffer: Buffer.alloc(4 * 1024),
    callback: function(nread, buf) {
      // Received data is available in `buf` from 0 to `nread`.
      console.log(buf.toString('utf8', 0, nread));
    },
  },
});

net.createConnection(path[, connectListener])

• path <string> Путь, по которому должен подключиться сокет. Передаётся в socket.connect(path[, connectListener]). См. раздел Определение путей для IPC-соединений.
• connectListener <Function> Общий параметр функций net.createConnection(), обработчик события 'connect', вызываемый один раз для инициирующего сокета. Передаётся в socket.connect(path[, connectListener]).
• Возвращает: <net.Socket> Новый сокет, используемый для начала соединения.

Инициирует соединение IPC.

Эта функция создаёт новый net.Socket со всеми параметрами по умолчанию, немедленно инициирует соединение с помощью socket.connect(path[, connectListener]) и возвращает net.Socket, инициирующий соединение.

net.createConnection(port[, host][, connectListener])

• port <number> Порт, к которому должен подключиться сокет. Передаётся в socket.connect(port[, host][, connectListener]).
• host <string> Узел, к которому должен подключиться сокет. Передаётся в socket.connect(port[, host][, connectListener]). По умолчанию: 'localhost'.
• connectListener <Function> Общий параметр функций net.createConnection(), обработчик события 'connect', вызываемый один раз для инициирующего сокета. Передаётся в socket.connect(port[, host][, connectListener]).
• Возвращает: <net.Socket> Новый сокет, используемый для начала соединения.

Инициирует TCP-соединение.

Эта функция создаёт новый net.Socket со всеми параметрами по умолчанию, немедленно инициирует соединение с помощью socket.connect(port[, host][, connectListener]) и возвращает net.Socket, инициирующий соединение.