Project

General

Profile

Bug #7088

Documentation of Timeout::timeout is wrong about which thread executes the block

Added by rklemme (Robert Klemme) almost 8 years ago. Updated almost 8 years ago.

Status:
Closed
Priority:
Normal
Target version:
ruby -v:
ruby 1.9.3p194 (2012-04-20) [i686-linux]
Backport:
[ruby-core:47739]

Description

See http://rubydoc.info/stdlib/timeout/Timeout#timeout-class_method - it reads "The block will be executed on another thread and will be given one argument: sec." If you make the source code visible or look into the file timeout.rb in the library you'll see that the block is invoked from the current (calling) thread. The comment reads as if the author had wanted to do an implementation like this:

def timeout_1(timeout, &code)
raise ArgumentError, "Invalid timeout: %p" % [timeout] unless timeout > 0
raise ArgumentError, "No code to execute" if code.nil?

worker = Thread.new(&code)
worker.join(timeout) and worker.value
end

Note: this avoids bug #4285 at the expense of a potentially longer running thread. Killing the background thread would suffer the same issues.

Also available in: Atom PDF