Feature #6088: Add Net::ReadTimeout to distinguish which operation failed

• Status: Closed
• Assignee: drbrain (Eric Hodel)
• Target version: 2.0.0

[drbrain (Eric Hodel)]

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.

[drbrain (Eric Hodel)]

• File net.modernize_timeout_usage.open_timeout.patch net.modernize_timeout_usage.open_timeout.patch added

The attached patch adds Net::ReadTimeout to Net::Telnet.

[naruse (Yui NARUSE)]

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

[mame (Yusuke Endoh)]

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

Drbrain-san

Could you respond to Naruse's comment?

--
Yusuke Endoh [e-mail]

[drbrain (Eric Hodel)]

• File net.read_timeout.patch net.read_timeout.patch added

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

[mame (Yusuke Endoh)]

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

[naruse (Yui NARUSE)]

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

You can commit it.

[drbrain (Eric Hodel)]

• 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