aboutsummaryrefslogtreecommitdiffstats
path: root/lib/net/ftp.rb
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/ftp.rb
parentc5fe7eb6f688c90208ff95da5bf4e86e54f62edf (diff)
downloadruby-c25aa9f5d6b81d406a0a009f90a6cd87d62ccc1c.tar.gz
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/ftp.rb')
-rw-r--r--lib/net/ftp.rb4
1 files changed, 2 insertions, 2 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.