From 883fb2bbfc1b2653cdb56346cd47b05550c85099 Mon Sep 17 00:00:00 2001 From: drbrain Date: Sun, 22 May 2011 02:27:09 +0000 Subject: [PATCH] * lib/timeout.rb: Improve documentation. Patch by David Copeland. [Ruby 1.9 - Bug #4755] git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@31687 b2dd03c8-39d4-4d8f-98ff-823fe69b080e --- ChangeLog | 5 +++++ lib/timeout.rb | 47 +++++++++++++++++++++++++++-------------------- 2 files changed, 32 insertions(+), 20 deletions(-) diff --git a/ChangeLog b/ChangeLog index 20a6e3d595..19a4fae7b7 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,8 @@ +Sun May 22 11:26:39 2011 Eric Hodel + + * lib/timeout.rb: Improve documentation. Patch by David Copeland. + [Ruby 1.9 - Bug #4755] + Sun May 22 11:21:41 2011 Eric Hodel * lib/ipaddr.rb: Improve documentation. Patch by Sandor Szucs. diff --git a/lib/timeout.rb b/lib/timeout.rb index f9d52abda6..4e4612bf08 100644 --- a/lib/timeout.rb +++ b/lib/timeout.rb @@ -1,23 +1,22 @@ -# = timeout.rb +# Timeout long-running blocks # -# execution timeout -# -# = Synopsis +# == Synopsis # # require 'timeout' # status = Timeout::timeout(5) { -# # Something that should be interrupted if it takes too much time... +# # Something that should be interrupted if it takes more than 5 seconds... # } # -# = Description +# == Description # -# A way of performing a potentially long-running operation in a thread, and terminating -# it's execution if it hasn't finished by a fixed amount of time. +# Timeout provides a way to auto-terminate a potentially long-running +# operation if it hasn't finished in a fixed amount of time. # -# Previous versions of timeout didn't provide use a module for namespace. This version -# provides both Timeout.timeout, and a backwards-compatible #timeout. +# Previous versions didn't use a module for namespacing, however +# #timeout is provided for backwards compatibility. You +# should prefer Timeout#timeout instead. # -# = Copyright +# == Copyright # # Copyright:: (C) 2000 Network Applied Communication Laboratory, Inc. # Copyright:: (C) 2000 Information-technology Promotion Agency, Japan @@ -34,14 +33,22 @@ module Timeout CALLER_OFFSET = ((c = caller[0]) && THIS_FILE =~ c) ? 1 : 0 # :startdoc: - # Executes the method's block. If the block execution terminates before - # +sec+ seconds has passed, it returns the result value of the block. - # If not, it terminates the execution and raises +exception+ (which defaults - # to Timeout::Error). + # Perform an operation in a block, timing it out if it takes longer + # than +sec+ seconds to complete. # - # Note that this is both a method of module Timeout, so you can 'include Timeout' - # into your classes so they have a #timeout method, as well as a module method, - # so you can call it directly as Timeout.timeout(). + # +sec+:: number of seconds to wait for the block to terminate + # +klass+:: Exception Class to raise if the block fails to terminate + # in +sec+ seconds. Omitting will use the default, Timeout::Error + # + # The block will be executed on another thread and will be given one + # argument: +sec+. + # + # Returns the result of the block *if* the block completed before + # +sec+ seconds, otherwise throws an exception, based on the value of +klass+. + # + # Note that this is both a method of module Timeout, so you can include + # Timeout into your classes so they have a #timeout method, as well as + # a module method, so you can call it directly as Timeout.timeout(). def timeout(sec, klass = nil) #:yield: +sec+ return yield(sec) if sec == nil or sec.zero? exception = klass || Class.new(ExitException) @@ -85,8 +92,8 @@ end # # Timeout::timeout(n, e, &block). # -# Defined for backwards compatibility with earlier versions of timeout.rb, see -# Timeout#timeout. +# This method is deprecated and provided only for backwards compatibility. +# You should use Timeout#timeout instead. def timeout(n, e = nil, &block) Timeout::timeout(n, e, &block) end