summaryrefslogtreecommitdiff
path: root/lib/net
diff options
context:
space:
mode:
authorhsbt <hsbt@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2013-03-31 01:47:47 +0000
committerhsbt <hsbt@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2013-03-31 01:47:47 +0000
commitc25aa9f5d6b81d406a0a009f90a6cd87d62ccc1c (patch)
treee5f7048c35789e03ad65e743bf7ee344de467b2f /lib/net
parentc5fe7eb6f688c90208ff95da5bf4e86e54f62edf (diff)
Document the default Net timeout values by @toolmantim [GH fixes #269]
* 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
Diffstat (limited to 'lib/net')
-rw-r--r--lib/net/ftp.rb4
-rw-r--r--lib/net/http.rb9
-rw-r--r--lib/net/pop.rb4
-rw-r--r--lib/net/smtp.rb4
4 files changed, 11 insertions, 10 deletions
diff --git a/lib/net/ftp.rb b/lib/net/ftp.rb
index d22fe19746..07cb548406 100644
--- a/lib/net/ftp.rb
+++ b/lib/net/ftp.rb
@@ -97,13 +97,13 @@ module Net
# Number of seconds to wait for the connection to open. Any number
# may be used, including Floats for fractional seconds. If the FTP
# 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
# 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
# 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
# Setter for the read_timeout attribute.
diff --git a/lib/net/http.rb b/lib/net/http.rb
index 4cb0408139..973998fdc3 100644
--- a/lib/net/http.rb
+++ b/lib/net/http.rb
@@ -701,13 +701,13 @@ module Net #:nodoc:
# 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
- # Net::OpenTimeout exception.
+ # Net::OpenTimeout exception. The default value is +nil+.
attr_accessor :open_timeout
# 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
# 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
# Setter for the read_timeout attribute.
@@ -716,8 +716,9 @@ module Net #:nodoc:
@read_timeout = sec
end
- # 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.
+ # 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. The
+ # default value is +nil+.
attr_reader :continue_timeout
# Setter for the continue_timeout attribute.
diff --git a/lib/net/pop.rb b/lib/net/pop.rb
index 600e093fa5..74a53951c7 100644
--- a/lib/net/pop.rb
+++ b/lib/net/pop.rb
@@ -496,12 +496,12 @@ module Net
# Seconds to wait until a connection is opened.
# 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
# Seconds to wait until reading one block (by one read(1) call).
# 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
# Set the read timeout.
diff --git a/lib/net/smtp.rb b/lib/net/smtp.rb
index 29862eac12..01f8b2b1f0 100644
--- a/lib/net/smtp.rb
+++ b/lib/net/smtp.rb
@@ -362,12 +362,12 @@ module Net
# Seconds to wait while attempting to open a connection.
# 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
# Seconds to wait while reading one block (by one read(2) call).
# 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
# Set the number of seconds to wait until timing-out a read(2)