kotovalexarian-likes-github/ruby--ruby
1
0
Fork 0
mirror of https://github.com/ruby/ruby.git synced 2022-11-09 12:17:21 -05:00
Code Releases Activity

Document the default Net timeout values by @toolmantim [GH fixes #269]

Browse source 
* lib/net/{ftp,http,pop,smtp}.rb: added documentation for default values.



git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@40014 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
This commit is contained in:
hsbt 2013-03-31 01:47:47 +00:00
parent c5fe7eb6f6
commit c25aa9f5d6
4 changed files with 11 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
lib/net/ftp.rb
View file

@ -97,13 +97,13 @@ module Net
# Number of seconds to wait for the connection to open. Any number # Number of seconds to wait for the connection to open. Any number
# may be used, including Floats for fractional seconds. If the FTP # may be used, including Floats for fractional seconds. If the FTP
# object cannot open a connection in this many seconds, it raises a # object cannot open a connection in this many seconds, it raises a
# Net::OpenTimeout exception. # Net::OpenTimeout exception. The default value is +nil+.
attr_accessor :open_timeout attr_accessor :open_timeout
# Number of seconds to wait for one block to be read (via one read(2) # Number of seconds to wait for one block to be read (via one read(2)
# call). Any number may be used, including Floats for fractional # call). Any number may be used, including Floats for fractional
# seconds. If the FTP object cannot read data in this many seconds, # seconds. If the FTP object cannot read data in this many seconds,
# it raises a TimeoutError exception. # it raises a TimeoutError exception. The default value is 60 seconds.
attr_reader :read_timeout attr_reader :read_timeout
# Setter for the read_timeout attribute. # Setter for the read_timeout attribute.

9
lib/net/http.rb
View file

@ -701,13 +701,13 @@ module Net #:nodoc:
# Number of seconds to wait for the connection to open. Any number # Number of seconds to wait for the connection to open. Any number
# may be used, including Floats for fractional seconds. If the HTTP # may be used, including Floats for fractional seconds. If the HTTP
# object cannot open a connection in this many seconds, it raises a # object cannot open a connection in this many seconds, it raises a
# Net::OpenTimeout exception. # Net::OpenTimeout exception. The default value is +nil+.
attr_accessor :open_timeout attr_accessor :open_timeout
# Number of seconds to wait for one block to be read (via one read(2) # Number of seconds to wait for one block to be read (via one read(2)
# call). Any number may be used, including Floats for fractional # call). Any number may be used, including Floats for fractional
# seconds. If the HTTP object cannot read data in this many seconds, # seconds. If the HTTP object cannot read data in this many seconds,
# it raises a Net::ReadTimeout exception. # it raises a Net::ReadTimeout exception. The default value is 60 seconds.
attr_reader :read_timeout attr_reader :read_timeout
# Setter for the read_timeout attribute. # Setter for the read_timeout attribute.
@ -716,8 +716,9 @@ module Net #:nodoc:
@read_timeout = sec @read_timeout = sec
end end
# Seconds to wait for 100 Continue response. If the HTTP object does not # Seconds to wait for 100 Continue response. If the HTTP object does not
# receive a response in this many seconds it sends the request body. # receive a response in this many seconds it sends the request body. The
# default value is +nil+.
attr_reader :continue_timeout attr_reader :continue_timeout
# Setter for the continue_timeout attribute. # Setter for the continue_timeout attribute.

4
lib/net/pop.rb
View file

@ -496,12 +496,12 @@ module Net
# Seconds to wait until a connection is opened. # Seconds to wait until a connection is opened.
# If the POP3 object cannot open a connection within this time, # If the POP3 object cannot open a connection within this time,
# it raises a Net::OpenTimeout exception. # it raises a Net::OpenTimeout exception. The default value is 30 seconds.
attr_accessor :open_timeout attr_accessor :open_timeout
# Seconds to wait until reading one block (by one read(1) call). # Seconds to wait until reading one block (by one read(1) call).
# If the POP3 object cannot complete a read() within this time, # If the POP3 object cannot complete a read() within this time,
# it raises a Net::ReadTimeout exception. # it raises a Net::ReadTimeout exception. The default value is 60 seconds.
attr_reader :read_timeout attr_reader :read_timeout
# Set the read timeout. # Set the read timeout.

4
lib/net/smtp.rb
View file

@ -362,12 +362,12 @@ module Net
# Seconds to wait while attempting to open a connection. # Seconds to wait while attempting to open a connection.
# If the connection cannot be opened within this time, a # If the connection cannot be opened within this time, a
# Net::OpenTimeout is raised. # Net::OpenTimeout is raised. The default value is 30 seconds.
attr_accessor :open_timeout attr_accessor :open_timeout
# Seconds to wait while reading one block (by one read(2) call). # Seconds to wait while reading one block (by one read(2) call).
# If the read(2) call does not complete within this time, a # If the read(2) call does not complete within this time, a
# Net::ReadTimeout is raised. # Net::ReadTimeout is raised. The default value is 60 seconds.
attr_reader :read_timeout attr_reader :read_timeout
# Set the number of seconds to wait until timing-out a read(2) # Set the number of seconds to wait until timing-out a read(2)