diff options
Diffstat (limited to 'ext/socket/tcpsocket.c')
| -rw-r--r-- | ext/socket/tcpsocket.c | 57 |
1 files changed, 23 insertions, 34 deletions
diff --git a/ext/socket/tcpsocket.c b/ext/socket/tcpsocket.c index e091d75e5d..7ce536e0af 100644 --- a/ext/socket/tcpsocket.c +++ b/ext/socket/tcpsocket.c @@ -12,7 +12,7 @@ /* * call-seq: - * TCPSocket.new(remote_host, remote_port, local_host=nil, local_port=nil, resolv_timeout: nil, connect_timeout: nil, fast_fallback: true) + * TCPSocket.new(remote_host, remote_port, local_host=nil, local_port=nil, resolv_timeout: nil, connect_timeout: nil, open_timeout: nil, fast_fallback: true) * * Opens a TCP connection to +remote_host+ on +remote_port+. If +local_host+ * and +local_port+ are specified, then those parameters are used on the local @@ -22,33 +22,21 @@ * Happy Eyeballs Version 2 ({RFC 8305}[https://datatracker.ietf.org/doc/html/rfc8305]) * algorithm by default, except on Windows. * + * For details on Happy Eyeballs Version 2, + * see {Socket.tcp_fast_fallback=}[rdoc-ref:Socket.tcp_fast_fallback=]. + * * To make it behave the same as in Ruby 3.3 and earlier, - * explicitly specify the option +fast_fallback:false+. + * explicitly specify the option fast_fallback:false. + * Or, setting Socket.tcp_fast_fallback=false will disable + * Happy Eyeballs Version 2 not only for this method but for all Socket globally. * - * Happy Eyeballs Version 2 is not provided on Windows, + * When using TCPSocket.new on Windows, Happy Eyeballs Version 2 is not provided, * and it behaves the same as in Ruby 3.3 and earlier. * * [:resolv_timeout] Specifies the timeout in seconds from when the hostname resolution starts. * [:connect_timeout] This method sequentially attempts connecting to all candidate destination addresses.<br>The +connect_timeout+ specifies the timeout in seconds from the start of the connection attempt to the last candidate.<br>By default, all connection attempts continue until the timeout occurs.<br>When +fast_fallback:false+ is explicitly specified,<br>a timeout is set for each connection attempt and any connection attempt that exceeds its timeout will be canceled. + * [:open_timeout] Specifies the timeout in seconds from the start of the method execution.<br>If this timeout is reached while there are still addresses that have not yet been attempted for connection, no further attempts will be made.<br>If this option is specified together with other timeout options, an +ArgumentError+ will be raised. * [:fast_fallback] Enables the Happy Eyeballs Version 2 algorithm (enabled by default). - * - * === Happy Eyeballs Version 2 - * Happy Eyeballs Version 2 ({RFC 8305}[https://datatracker.ietf.org/doc/html/rfc8305]) - * is an algorithm designed to improve client socket connectivity.<br> - * It aims for more reliable and efficient connections by performing hostname resolution - * and connection attempts in parallel, instead of serially. - * - * Starting from Ruby 3.4, this method operates as follows with this algorithm except on Windows: - * - * 1. Start resolving both IPv6 and IPv4 addresses concurrently. - * 2. Start connecting to the one of the addresses that are obtained first.<br>If IPv4 addresses are obtained first, - * the method waits 50 ms for IPv6 name resolution to prioritize IPv6 connections. - * 3. After starting a connection attempt, wait 250 ms for the connection to be established.<br> - * If no connection is established within this time, a new connection is started every 250 ms<br> - * until a connection is established or there are no more candidate addresses.<br> - * (Although RFC 8305 strictly specifies sorting addresses,<br> - * this method only alternates between IPv6 / IPv4 addresses due to the performance concerns) - * 4. Once a connection is established, all remaining connection attempts are canceled. */ static VALUE tcp_init(int argc, VALUE *argv, VALUE sock) @@ -56,42 +44,43 @@ 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]; + static ID keyword_ids[5]; + VALUE kwargs[5]; VALUE resolv_timeout = Qnil; VALUE connect_timeout = Qnil; + VALUE open_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"); + CONST_ID(keyword_ids[2], "open_timeout"); + CONST_ID(keyword_ids[3], "fast_fallback"); + CONST_ID(keyword_ids[4], "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); + rb_get_kwargs(opt, keyword_ids, 0, 5, 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 (kwargs[2] != Qundef) { open_timeout = kwargs[2]; } + if (kwargs[3] != Qundef) { fast_fallback = kwargs[3]; } + if (kwargs[4] != Qundef) { test_mode_settings = kwargs[4]; } } if (fast_fallback == Qnil) { - VALUE socket_class = rb_const_get(rb_cObject, rb_intern("Socket")); - ID var_id = rb_intern("@tcp_fast_fallback"); - fast_fallback = rb_ivar_get(socket_class, var_id); + 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); + resolv_timeout, connect_timeout, open_timeout, + fast_fallback, test_mode_settings); } static VALUE @@ -124,7 +113,7 @@ 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); + rsock_addrinfo(host, Qnil, AF_UNSPEC, SOCK_STREAM, AI_CANONNAME, Qnil); return rsock_make_hostent(host, res, tcp_sockaddr); } |