diff options
author | drbrain <drbrain@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2011-06-16 05:24:12 +0000 |
---|---|---|
committer | drbrain <drbrain@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2011-06-16 05:24:12 +0000 |
commit | dbf9baeddf8679c0dfeb905d720a64e657861675 (patch) | |
tree | f7f7e3c48fa07119c4d21e0ea9d2952796951baa /lib | |
parent | b7528b5edb1f9148ea00ebb6151720e5943b3f0b (diff) | |
download | ruby-dbf9baeddf8679c0dfeb905d720a64e657861675.tar.gz |
* lib/timeout.rb: Clarify timeout duration types. Patch by Alf Mikula.
[Ruby 1.9 - Bug #4791]
* lib/net/http.rb: ditto
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@32116 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'lib')
-rw-r--r-- | lib/net/http.rb | 10 | ||||
-rw-r--r-- | lib/timeout.rb | 3 |
2 files changed, 8 insertions, 5 deletions
diff --git a/lib/net/http.rb b/lib/net/http.rb index 36fb418777..045967caa3 100644 --- a/lib/net/http.rb +++ b/lib/net/http.rb @@ -619,13 +619,15 @@ module Net #:nodoc: # The port number to connect to. attr_reader :port - # Number of seconds to wait for the connection to open. - # If the HTTP object cannot open a connection in this many seconds, - # it raises a TimeoutError exception. + # Number of seconds to wait for the connection to open. Any number + # may be used, including Floats for fractional seconds. If the HTTP + # object cannot open a connection in this many seconds, it raises a + # TimeoutError exception. attr_accessor :open_timeout # Number of seconds to wait for one block to be read (via one read(2) - # call). If the HTTP object cannot read data in this many seconds, + # call). Any number may be used, including Floats for fractional + # seconds. If the HTTP object cannot read data in this many seconds, # it raises a TimeoutError exception. attr_reader :read_timeout diff --git a/lib/timeout.rb b/lib/timeout.rb index 4e4612bf08..91d120a113 100644 --- a/lib/timeout.rb +++ b/lib/timeout.rb @@ -36,7 +36,8 @@ module Timeout # Perform an operation in a block, timing it out if it takes longer # than +sec+ seconds to complete. # - # +sec+:: number of seconds to wait for the block to terminate + # +sec+:: Number of seconds to wait for the block to terminate. Any number + # may be used, including Floats to specify fractional seconds. # +klass+:: Exception Class to raise if the block fails to terminate # in +sec+ seconds. Omitting will use the default, Timeout::Error # |