Node.js v25.0.0 ドキュメンテーション

IPC 接続のパスを特定する#

net.connect()、net.createConnection()、server.listen()、および socket.connect() は、IPC エンドポイントを特定するために path パラメータを取ります。

Unix では、ローカルドメインは Unix ドメインとしても知られています。パスはファイルシステムのパス名です。パス名の長さが sizeof(sockaddr_un.sun_path) の長さを超えるとエラーがスローされます。典型的な値は、Linux では 107 バイト、macOS では 103 バイトです。Node.js API の抽象化が Unix ドメインソケットを作成する場合、その Unix ドメインソケットもアンリンクします。例えば、net.createServer() は Unix ドメインソケットを作成し、server.close() がそれをアンリンクします。しかし、ユーザーがこれらの抽象化の外で Unix ドメインソケットを作成した場合、ユーザーがそれを削除する必要があります。Node.js API が Unix ドメインソケットを作成したものの、プログラムがクラッシュした場合も同様です。要するに、Unix ドメインソケットはファイルシステム上で見え、アンリンクされるまで持続します。Linux では、パスの先頭に \0 を追加することで Unix 抽象ソケットを使用できます (例: \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'。

start (含む) から end (含む) までの IP アドレスの範囲をブロックするルールを追加します。

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>

指定された IP アドレスが BlockList に追加されたいずれかのルールに一致する場合、true を返します。

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 値
• value が net.BlockList の場合、true を返します。

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 文字列としてのネットワークアドレス。デフォルト: family が 'ipv4' の場合は '127.0.0.1'、family が 'ipv6' の場合は '::'。
  • family <string> 'ipv4' または 'ipv6' のいずれか。デフォルト: 'ipv4'。
  • flowlabel <number> family が 'ipv6' の場合にのみ使用される 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 とは異なり、server.close() が手動で呼び出されない限り、'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>

IP ソケットでリスニングしている場合、オペレーティングシステムによって報告されたバインド済み address、アドレス family 名、およびサーバーの port を返します (OS によって割り当てられたアドレスを取得するときにどのポートが割り当てられたかを見つけるのに便利です): { 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() は 'listening' イベントが発行される前、または server.close() を呼び出した後は null を返します。

server.close([callback])#

• callback <Function> サーバーが閉じられたときに呼び出されます。
• 戻り値: <net.Server>

サーバーが新しい接続を受け入れるのを停止し、既存の接続を維持します。この関数は非同期であり、すべての接続が終了し、サーバーが 'close' イベントを発行したときにサーバーは最終的に閉じられます。オプションの callback は 'close' イベントが発生したときに一度呼び出されます。そのイベントとは異なり、サーバーが閉じられたときに開いていなかった場合、唯一の引数として Error と共に呼び出されます。

server[Symbol.asyncDispose]()#

server.close()を呼び出し、サーバーがクローズしたときに解決されるpromiseを返します。

server.getConnections(callback)#

• callback <Function>
• 戻り値: <net.Server>

サーバー上の同時接続数を非同期に取得します。ソケットがフォークに送信された場合にも機能します。

コールバックは 2 つの引数 err と count を取る必要があります。

server.listen()#

接続を待機するサーバーを開始します。net.Server は、何にリッスンするかに応じて、TCP または IPC サーバーにすることができます。

可能なシグネチャ

• server.listen(handle[, backlog][, callback])
• server.listen(options[, callback])
• IPC サーバー用の server.listen(path[, backlog][, callback])
• TCP サーバー用の server.listen([port[, host[, backlog]]][, callback])

この関数は非同期です。サーバーがリスニングを開始すると、'listening' イベントが発行されます。最後のパラメータ callback は、'listening' イベントのリスナーとして追加されます。

すべての listen() メソッドは、保留中の接続キューの最大長を指定するために backlog パラメータを取ることができます。実際の長さは、Linux の tcp_max_syn_backlog や somaxconn などの sysctl 設定を通じて OS によって決定されます。このパラメータのデフォルト値は 511 (512 ではありません) です。

すべての net.Socket は SO_REUSEADDR に設定されます (詳細は socket(7) を参照)。

server.listen() メソッドは、最初の server.listen() 呼び出し中にエラーがあった場合、または server.close() が呼び出された場合にのみ、再度呼び出すことができます。それ以外の場合は、ERR_SERVER_ALREADY_LISTEN エラーがスローされます。

リスニング時に発生する最も一般的なエラーの 1 つは EADDRINUSE です。これは、別のサーバーが要求された port/path/handle で既にリスニングしている場合に発生します。これを処理する 1 つの方法は、一定時間後に再試行することです。

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>

接続数が [server.maxConnections][] のしきい値に達したら接続を閉じ始めるには、このプロパティを true に設定します。この設定はクラスターモードでのみ有効です。

server.ref()#

• 戻り値: <net.Server>

unref() の反対で、以前に unref されたサーバーで ref() を呼び出すと、それが残っている唯一のサーバーである場合、プログラムは終了し*ません* (デフォルトの動作)。サーバーが 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> この関数は、着信データのチャンクごとに呼び出されます。2つの引数が渡されます: buffer に書き込まれたバイト数と buffer への参照。この関数から false を返すと、ソケットが暗黙的に pause() されます。この関数はグローバルコンテキストで実行されます。
  • readable <boolean> fd が渡されたときにソケットでの読み取りを許可します。それ以外の場合は無視されます。デフォルト: false。
  • signal <AbortSignal> ソケットを破棄するために使用できる Abort シグナル。
  • writable <boolean> fd が渡されたときにソケットでの書き込みを許可します。それ以外の場合は無視されます。デフォルト: false。
• 戻り値: <net.Socket>

新しいソケットオブジェクトを作成します。

新しく作成されたソケットは、connect() する対象に応じて、TCP ソケットまたはストリーミング IPC エンドポイントのいずれかになります。

イベント: 'close'#

• hadError <boolean> ソケットに送信エラーがあった場合は true。

ソケットが完全に閉じられると一度発行されます。引数 hadError は、ソケットが送信エラーのために閉じられたかどうかを示すブール値です。

イベント: 'connect'#

ソケット接続が正常に確立されたときに発行されます。net.createConnection() を参照してください。

イベント: 'connectionAttempt'#

• ip <string> ソケットが接続を試みている IP。
• port <number> ソケットが接続を試みているポート。
• family <number> IP のファミリー。IPv6 の場合は 6、IPv4 の場合は 4 です。

socket.connect(options) でファミリー自動選択アルゴリズムが有効になっている場合、新しい接続試行が開始されると発行されます。これは複数回発行される可能性があります。

イベント: 'connectionAttemptFailed'#

• ip <string> ソケットが接続を試みた IP。
• port <number> ソケットが接続を試みたポート。
• family <number> IP のファミリー。IPv6 の場合は 6、IPv4 の場合は 4 です。
• error <Error> 失敗に関連するエラー。

接続試行が失敗したときに発行されます。socket.connect(options) でファミリー自動選択アルゴリズムが有効になっている場合、複数回発行される可能性があります。

イベント: 'connectionAttemptTimeout'#

• ip <string> ソケットが接続を試みた IP。
• port <number> ソケットが接続を試みたポート。
• family <number> IP のファミリー。IPv6 の場合は 6、IPv4 の場合は 4 です。

接続試行がタイムアウトしたときに発行されます。これは socket.connect(options) でファミリー自動選択アルゴリズムが有効になっている場合にのみ発行され、複数回発行される可能性があります。

イベント: 'data'#

• 型: <Buffer> | <string>

データが受信されたときに発行されます。引数 data は Buffer または String です。データのエンコーディングは socket.setEncoding() によって設定されます。

Socket が 'data' イベントを発行したときにリスナーがない場合、データは失われます。

イベント: 'drain'#

書き込みバッファが空になったときに発行されます。アップロードをスロットルするために使用できます。

参照: socket.write() の戻り値。

イベント: 'end'#

ソケットのもう一方の端が送信終了を通知したときに発行され、ソケットの読み取り可能な側が終了します。

デフォルトでは (allowHalfOpen が false)、ソケットは送信終了パケットを返し、保留中の書き込みキューを書き出した後、ファイルディスクリプタを破棄します。しかし、allowHalfOpen が true に設定されている場合、ソケットは自動的に書き込み側を end() せず、ユーザーが任意の量のデータを書き込むことを許可します。ユーザーは接続を閉じるために明示的に end() を呼び出す必要があります (つまり、FIN パケットを返送します)。

イベント: '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])
• IPC 接続用の socket.connect(path[, connectListener])。
• TCP 接続用の socket.connect(port[, host][, connectListener])。
• 戻り値: <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>

このソケットでこれ以上 I/O アクティビティが発生しないことを保証します。ストリームを破棄し、接続を閉じます。

詳細については 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>

.connect() がまだ呼び出されていないか、接続中であるため ( socket.connecting を参照)、ソケットがまだ接続されていない場合は true です。

socket.ref()#

• 戻り値: <net.Socket> ソケット自体。

unref() の反対で、以前に unref されたソケットで ref() を呼び出すと、それが残っている唯一のソケットである場合、プログラムは終了し*ません* (デフォルトの動作)。ソケットが 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>

RST パケットを送信して TCP 接続を閉じ、ストリームを破棄します。この TCP ソケットが接続中の場合、接続が確立されると RST パケットを送信してこの TCP ソケットを破棄します。それ以外の場合は、ERR_SOCKET_CLOSED エラーで socket.destroy を呼び出します。これが TCP ソケットでない場合 (例えば、パイプ)、このメソッドを呼び出すとすぐに ERR_INVALID_HANDLE_TYPE エラーがスローされます。

socket.resume()#

• 戻り値: <net.Socket> ソケット自体。

socket.pause() の呼び出し後に読み取りを再開します。

socket.setEncoding([encoding])#

• encoding <string>
• 戻り値: <net.Socket> ソケット自体。

Readable Stream としてソケットのエンコーディングを設定します。詳細については readable.setEncoding() を参照してください。

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

• enable <boolean> デフォルト: false
• initialDelay <number> デフォルト: 0
• 戻り値: <net.Socket> ソケット自体。

キープアライブ機能を有効/無効にし、オプションでアイドルソケットで最初のキープアライブプローブが送信されるまでの初期遅延を設定します。

initialDelay (ミリ秒単位) を設定して、最後のデータパケットが受信されてから最初のキープアライブプローブまでの遅延を設定します。initialDelay に 0 を設定すると、値はデフォルト (または以前の) 設定から変更されません。

キープアライブ機能を有効にすると、次のソケットオプションが設定されます。

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

socket.setNoDelay([noDelay])#

• noDelay <boolean> デフォルト: true
• 戻り値: <net.Socket> ソケット自体。

Nagle のアルゴリズムの使用を有効/無効にします。

TCP 接続が作成されると、Nagle のアルゴリズムが有効になります。

Nagle のアルゴリズムは、データがネットワーク経由で送信される前に遅延させます。レイテンシを犠牲にしてスループットを最適化しようとします。

noDelay に true を渡すか、引数を渡さない場合、ソケットの Nagle のアルゴリズムは無効になります。noDelay に false を渡すと、Nagle のアルゴリズムが有効になります。

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> data が string の場合にのみ使用されます。デフォルト: utf8。
• callback <Function>
• 戻り値: <boolean>

ソケット上でデータを送信します。第2引数は、文字列の場合のエンコーディングを指定します。デフォルトはUTF8エンコーディングです。

データ全体がカーネルバッファに正常にフラッシュされた場合は true を返します。データの一部または全部がユーザーメモリにキューイングされた場合は false を返します。バッファが再び空になったときに 'drain' イベントが発生します。

オプションの callback パラメータは、データが最終的に書き出されたときに実行されます。これは即時ではない場合があります。

詳細については、Writable ストリームの write() メソッドを参照してください。

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');
});copy

ソケット /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));
    },
  },
});copy

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 を返します。