Project

General

Profile

Bug #4791 ยป 0001-Clarifying-timeout-documentation-to-make-it-clear-th.patch

amikula (Alf Mikula), 05/28/2011 08:22 AM

View differences:

lib/net/http.rb
# 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
lib/timeout.rb
# 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
#
    (1-1/1)