Project

General

Profile

Feature #6088

Add Net::ReadTimeout to distinguish which operation failed

Added by drbrain (Eric Hodel) almost 6 years ago. Updated over 5 years ago.

Status:
Closed
Priority:
Normal
Target version:
[ruby-core:42938]

Description

This relates to #5765 which improves use of timeout in net/ and #6001 which introduces Net::HTTP::OpenTimeout.

This patch introduces Net::ReadTimeout as a subclass of Timeout::Error and raises it when a read operation takes too long. Users may use this to distinguish between timeouts for reading and timeouts for connecting to a remote host. For a read timeout the user may wish to retry the operation.

net.protocol.read_timeout.patch (1.58 KB) net.protocol.read_timeout.patch drbrain (Eric Hodel), 02/26/2012 07:14 AM
net.modernize_timeout_usage.open_timeout.patch (4.56 KB) net.modernize_timeout_usage.open_timeout.patch drbrain (Eric Hodel), 02/26/2012 07:24 AM
net.read_timeout.patch (6.74 KB) net.read_timeout.patch Updated combined patch including documentation changes drbrain (Eric Hodel), 03/30/2012 05:23 AM

Related issues

Related to Ruby trunk - Bug #5765: [PATCH] modernize Timeout usage in net/{http,pop,smtp,telnet}Closed2011-12-15

Associated revisions

Revision 35304
Added by drbrain (Eric Hodel) over 5 years ago

  • lib/net/protocol.rb (module Net): Added ReadTimeout to match OpenTimeout. ReadTimeout is now raised by rbuf_fill instead of Timeout::Error to help users distinguish what type of timeout occurred. [ruby-trunk - Feature #6088]
  • lib/net/pop.rb (module Net): Updated documentation for ReadTimeout and OpenTimeout.
  • lib/net/http.rb (module Net): ditto
  • lib/net/smtp.rb (module Net): ditto
  • lib/net/telnet.rb (module Net): Net::ReadTimeout is now raised in waitfor to match Net::Protocol.
  • test/net/http/test_http.rb: Updated Timeout::Error expectation to Net::ReadTimeout.
  • test/net/ftp/test_ftp.rb: ditto

Revision 35304
Added by drbrain (Eric Hodel) over 5 years ago

  • lib/net/protocol.rb (module Net): Added ReadTimeout to match OpenTimeout. ReadTimeout is now raised by rbuf_fill instead of Timeout::Error to help users distinguish what type of timeout occurred. [ruby-trunk - Feature #6088]
  • lib/net/pop.rb (module Net): Updated documentation for ReadTimeout and OpenTimeout.
  • lib/net/http.rb (module Net): ditto
  • lib/net/smtp.rb (module Net): ditto
  • lib/net/telnet.rb (module Net): Net::ReadTimeout is now raised in waitfor to match Net::Protocol.
  • test/net/http/test_http.rb: Updated Timeout::Error expectation to Net::ReadTimeout.
  • test/net/ftp/test_ftp.rb: ditto

Revision 35304
Added by drbrain (Eric Hodel) over 5 years ago

  • lib/net/protocol.rb (module Net): Added ReadTimeout to match OpenTimeout. ReadTimeout is now raised by rbuf_fill instead of Timeout::Error to help users distinguish what type of timeout occurred. [ruby-trunk - Feature #6088]
  • lib/net/pop.rb (module Net): Updated documentation for ReadTimeout and OpenTimeout.
  • lib/net/http.rb (module Net): ditto
  • lib/net/smtp.rb (module Net): ditto
  • lib/net/telnet.rb (module Net): Net::ReadTimeout is now raised in waitfor to match Net::Protocol.
  • test/net/http/test_http.rb: Updated Timeout::Error expectation to Net::ReadTimeout.
  • test/net/ftp/test_ftp.rb: ditto

Revision 35304
Added by drbrain (Eric Hodel) over 5 years ago

  • lib/net/protocol.rb (module Net): Added ReadTimeout to match OpenTimeout. ReadTimeout is now raised by rbuf_fill instead of Timeout::Error to help users distinguish what type of timeout occurred. [ruby-trunk - Feature #6088]
  • lib/net/pop.rb (module Net): Updated documentation for ReadTimeout and OpenTimeout.
  • lib/net/http.rb (module Net): ditto
  • lib/net/smtp.rb (module Net): ditto
  • lib/net/telnet.rb (module Net): Net::ReadTimeout is now raised in waitfor to match Net::Protocol.
  • test/net/http/test_http.rb: Updated Timeout::Error expectation to Net::ReadTimeout.
  • test/net/ftp/test_ftp.rb: ditto

History

#2 [ruby-core:43751] Updated by naruse (Yui NARUSE) over 5 years ago

I don't object the direction but it should have more document about the new Exception.

#3 [ruby-core:43886] Updated by mame (Yusuke Endoh) over 5 years ago

  • Status changed from Open to Assigned
  • Assignee set to drbrain (Eric Hodel)

Drbrain-san

Could you respond to Naruse's comment?

--
Yusuke Endoh mame@tsg.ne.jp

#4 [ruby-core:43898] Updated by drbrain (Eric Hodel) over 5 years ago

I have updated all the documentation for OpenTimeout and ReadTimeout along with the addition of Net::ReadTimeout.

#5 [ruby-core:43901] Updated by mame (Yusuke Endoh) over 5 years ago

  • Assignee changed from drbrain (Eric Hodel) to naruse (Yui NARUSE)

#6 [ruby-core:43927] Updated by naruse (Yui NARUSE) over 5 years ago

  • Assignee changed from naruse (Yui NARUSE) to drbrain (Eric Hodel)

You can commit it.

#7 Updated by drbrain (Eric Hodel) over 5 years ago

  • Status changed from Assigned to Closed
  • % Done changed from 0 to 100

This issue was solved with changeset r35304.
Eric, thank you for reporting this issue.
Your contribution to Ruby is greatly appreciated.
May Ruby be with you.


  • lib/net/protocol.rb (module Net): Added ReadTimeout to match OpenTimeout. ReadTimeout is now raised by rbuf_fill instead of Timeout::Error to help users distinguish what type of timeout occurred. [ruby-trunk - Feature #6088]
  • lib/net/pop.rb (module Net): Updated documentation for ReadTimeout and OpenTimeout.
  • lib/net/http.rb (module Net): ditto
  • lib/net/smtp.rb (module Net): ditto
  • lib/net/telnet.rb (module Net): Net::ReadTimeout is now raised in waitfor to match Net::Protocol.
  • test/net/http/test_http.rb: Updated Timeout::Error expectation to Net::ReadTimeout.
  • test/net/ftp/test_ftp.rb: ditto

Also available in: Atom PDF