diff options
-rw-r--r-- | lib/.document | 2 | ||||
-rw-r--r-- | lib/rinda/.document | 3 | ||||
-rw-r--r-- | lib/timeout.rb | 48 |
3 files changed, 37 insertions, 16 deletions
diff --git a/lib/.document b/lib/.document index 98dadba57f..14bb46deec 100644 --- a/lib/.document +++ b/lib/.document @@ -28,6 +28,7 @@ optionparser.rb pathname.rb pstore.rb rational.rb +rinda resolv.rb set.rb shellwords.rb @@ -37,5 +38,6 @@ test/unit.rb thread.rb thwait.rb time.rb +timeout.rb uri yaml.rb diff --git a/lib/rinda/.document b/lib/rinda/.document new file mode 100644 index 0000000000..598977af68 --- /dev/null +++ b/lib/rinda/.document @@ -0,0 +1,3 @@ +rinda.rb +ring.rb +tuplespace.rb diff --git a/lib/timeout.rb b/lib/timeout.rb index 36811a1040..dc92964c0b 100644 --- a/lib/timeout.rb +++ b/lib/timeout.rb @@ -1,39 +1,49 @@ +#-- # = timeout.rb # # execution timeout # -# = Synopsis +# = Copyright # -# require 'timeout' -# status = Timeout::timeout(5) { -# # Something that should be interrupted if it takes too much time... -# } +# Copyright:: (C) 2000 Network Applied Communication Laboratory, Inc. +# Copyright:: (C) 2000 Information-technology Promotion Agency, Japan +# +#++ # # = 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. +# A way of performing a potentially long-running operation in a thread, and +# terminating it's execution if it hasn't finished within fixed amount of +# time. # -# Previous versions of timeout didn't provide use a module for namespace. This version +# Previous versions of timeout didn't use a module for namespace. This version # provides both Timeout.timeout, and a backwards-compatible #timeout. # -# = Copyright +# = Synopsis +# +# require 'timeout' +# status = Timeout::timeout(5) { +# # Something that should be interrupted if it takes too much time... +# } # -# Copyright:: (C) 2000 Network Applied Communication Laboratory, Inc. -# Copyright:: (C) 2000 Information-technology Promotion Agency, Japan module Timeout + + ## # Raised by Timeout#timeout when the block times out. + class Error<Interrupt end + ## # Executes the method's block. If the block execution terminates before +sec+ # seconds has passed, it returns true. If not, it terminates the execution # and raises +exception+ (which defaults to Timeout::Error). # - # 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(). + # 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, exception=Error) return yield if sec == nil or sec.zero? raise ThreadError, "timeout within critical session" if Thread.critical @@ -51,21 +61,26 @@ module Timeout end module_function :timeout + end +## # Identical to: # # Timeout::timeout(n, e, &block). # # Defined for backwards compatibility with earlier versions of timeout.rb, see # Timeout#timeout. -def timeout(n, e=Timeout::Error, &block) + +def timeout(n, e=Timeout::Error, &block) # :nodoc: Timeout::timeout(n, e, &block) end +## # Another name for Timeout::Error, defined for backwards compatibility with # earlier versions of timeout.rb. -TimeoutError = Timeout::Error + +TimeoutError = Timeout::Error # :nodoc: if __FILE__ == $0 p timeout(5) { @@ -87,3 +102,4 @@ if __FILE__ == $0 } } end + |