class TCPSocket

TCPSocket 代表一个 TCP/IP 客户端套接字。

一个简单的客户端可能看起来像这样

require 'socket'

s = TCPSocket.new 'localhost', 2000

while line = s.gets # Read lines from socket
  puts line         # and print them
end

s.close             # close socket when done

公共类方法

gethostbyname(hostname) → [official_hostname, alias_hostnames, address_family, *address_list] 点击切换源代码

请改用 Addrinfo.getaddrinfo。此方法因以下原因而被弃用

  • 结果的第 3 个元素是第一个地址的地址族。其余地址的地址族不返回。

  • gethostbyname() 可能需要很长时间,并且可能会阻塞其他线程。(由于 gethostbyname() 不是线程安全的,因此无法释放 GVL。)

  • 此方法使用已从 POSIX 中删除的 gethostbyname() 函数。

此方法通过hostname查找主机信息。

TCPSocket.gethostbyname("localhost")
#=> ["localhost", ["hal"], 2, "127.0.0.1"]
static VALUE
tcp_s_gethostbyname(VALUE obj, VALUE host)
{
    rb_warn("TCPSocket.gethostbyname is deprecated; use Addrinfo.getaddrinfo instead.");
    struct rb_addrinfo *res =
        rsock_addrinfo(host, Qnil, AF_UNSPEC, SOCK_STREAM, AI_CANONNAME);
    return rsock_make_hostent(host, res, tcp_sockaddr);
}
new(remote_host, remote_port, local_host=nil, local_port=nil, resolv_timeout: nil, connect_timeout: nil, fast_fallback: true) 点击切换源代码

remote_port 上打开到 remote_host 的 TCP 连接。如果指定了 local_hostlocal_port,则这些参数在本地端用于建立连接。

从 Ruby 3.4 开始,默认情况下,此方法根据 Happy Eyeballs Version 2(RFC 8305)算法运行,Windows 除外。

有关 Happy Eyeballs Version 2 的详细信息,请参阅 Socket.tcp_fast_fallback=

要使其行为与 Ruby 3.3 及更早版本相同,请显式指定选项 fast_fallback:false。或者,设置 Socket.tcp_fast_fallback=false 不仅会禁用此方法的 Happy Eyeballs Version 2,还会全局禁用所有 Socket

在 Windows 上使用 TCPSocket.new 时,不提供 Happy Eyeballs Version 2,其行为与 Ruby 3.3 及更早版本相同。

:resolv_timeout

指定从主机名解析开始的超时时间(以秒为单位)。

:connect_timeout

此方法按顺序尝试连接到所有候选目标地址。
connect_timeout 指定从连接尝试开始到最后一个候选的超时时间(以秒为单位)。
默认情况下,所有连接尝试都会持续到超时发生。
当显式指定 fast_fallback:false 时,
会为每次连接尝试设置超时时间,并且任何超出其超时时间的连接尝试都将被取消。

:fast_fallback

启用 Happy Eyeballs Version 2 算法(默认启用)。

static VALUE
tcp_init(int argc, VALUE *argv, VALUE sock)
{
    VALUE remote_host, remote_serv;
    VALUE local_host, local_serv;
    VALUE opt;
    static ID keyword_ids[4];
    VALUE kwargs[4];
    VALUE resolv_timeout = Qnil;
    VALUE connect_timeout = Qnil;
    VALUE fast_fallback = Qnil;
    VALUE test_mode_settings = Qnil;

    if (!keyword_ids[0]) {
        CONST_ID(keyword_ids[0], "resolv_timeout");
        CONST_ID(keyword_ids[1], "connect_timeout");
        CONST_ID(keyword_ids[2], "fast_fallback");
        CONST_ID(keyword_ids[3], "test_mode_settings");
    }

    rb_scan_args(argc, argv, "22:", &remote_host, &remote_serv,
                        &local_host, &local_serv, &opt);

    if (!NIL_P(opt)) {
        rb_get_kwargs(opt, keyword_ids, 0, 4, kwargs);
        if (kwargs[0] != Qundef) { resolv_timeout = kwargs[0]; }
        if (kwargs[1] != Qundef) { connect_timeout = kwargs[1]; }
        if (kwargs[2] != Qundef) { fast_fallback = kwargs[2]; }
        if (kwargs[3] != Qundef) { test_mode_settings = kwargs[3]; }
    }

    if (fast_fallback == Qnil) {
        fast_fallback = rb_ivar_get(rb_cSocket, tcp_fast_fallback);
        if (fast_fallback == Qnil) fast_fallback = Qtrue;
    }

    return rsock_init_inetsock(sock, remote_host, remote_serv,
                               local_host, local_serv, INET_CLIENT,
                               resolv_timeout, connect_timeout, fast_fallback,
                               test_mode_settings);
}