socket.connect(options[, connectListener])
options<Object>connectListener<Function>socket.connect()方法的常用参数。将作为监听器添加到'connect'事件中,仅添加一次。- 返回:<net.Socket> 插座本身。
在指定的套接字上发起连接。通常不需要使用此方法,套接字应通过 net.createConnection() 创建并打开。仅在实现自定义套接字时使用此方法。
🌐 Initiate a connection on a given socket. Normally this method is not needed,
the socket should be created and opened with net.createConnection(). Use
this only when implementing a custom Socket.
对于 TCP 连接,可用的 options 有:
🌐 For TCP connections, available options are:
port<number> 必填。套接字应连接的端口。host<string> 主机应连接到的套接字。默认值:'localhost'。localAddress<string> 套接字应连接的本地地址。localPort<number> 套接字应连接的本地端口。family<number>IP 协议栈的版本。必须是4、6或0。值0表示允许 IPv4 和 IPv6 地址。默认值:0。hints<number> 可选dns.lookup()提示。lookup<Function> 自定义查找函数。默认:dns.lookup()。noDelay<boolean> 如果设置为true,则在套接字建立后立即禁用 Nagle 算法。默认值:false。keepAlive<boolean> 如果设置为true,则在连接建立后立即在套接字上启用保持连接功能,这与socket.setKeepAlive([enable][, initialDelay])中所做的类似。默认值:false。keepAliveInitialDelay<number> 如果设置为正数,它会在空闲套接字上发送第一次保活探测之前设置初始延迟。默认值:0。autoSelectFamily<boolean>: 如果设置为true,则启用一个家庭自动检测算法,该算法大致实现了 RFC 8305 第 5 节的内容。传递给 lookup 的all选项被设置为true,套接字会依次尝试连接所有获取到的 IPv6 和 IPv4 地址,直到建立连接。首先尝试返回的第一个 AAAA 地址,然后是返回的第一个 A 地址,然后是返回的第二个 AAAA 地址,以此类推。每次连接尝试的超时时间由autoSelectFamilyAttemptTimeout选项指定,超时后尝试下一个地址。如果family选项不是0或者localAddress被设置,则会被忽略。如果至少有一次连接成功,则不会发出连接错误。默认值: 初始为false,但可以在运行时通过net.setDefaultAutoSelectFamily(value)或命令行选项--enable-network-family-autoselection更改。autoSelectFamilyAttemptTimeout<number>:使用autoSelectFamily选项时,等待连接尝试完成的时间(以毫秒为单位),然后再尝试下一个地址。如果设置为小于10的正整数,则将使用10值。默认值: 最初为250,但可以在运行时使用net.setDefaultAutoSelectFamilyAttemptTimeout(value)进行更改
对于 IPC 连接,可用的 options 有:
🌐 For IPC connections, available options are:
path<string> 必需。客户端应该连接的路径。见 识别 IPC 连接的路径。如果提供,以上 TCP 特定选项将被忽略。
对于这两种类型,可用的 options 包括:
🌐 For both types, available options include:
onread<Object> 如果指定,传入的数据将存储在单个buffer中,并在数据到达套接字时传递给提供的callback。这将导致流功能无法提供任何数据。套接字将像往常一样发出'error'、'end'和'close'等事件。像pause()和resume()这样的方法也将按预期运行。buffer<Buffer> | <Uint8Array> | <Function> 要么是一个可重复使用的内存块,用于存储传入的数据,要么是返回这样的内存块的函数。callback<Function> 此函数会在每块传入数据到达时被调用。它会接收两个参数:写入到buffer的字节数,以及buffer的引用。从此函数返回false以隐式地pause()套接字。此函数将在全局上下文中执行。
以下是一个使用 onread 选项的客户端示例:
🌐 Following is an example of a client using the onread option:
const net = require('node:net');
net.connect({
port: 80,
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));
},
},
});