This class watches for termination of multiple threads. Basic functionality (wait until specified threads have terminated) can be accessed through the class method ::all_waits. Finer control can be gained using instance methods.

Example:

ThreadsWait.all_wait(thr1, thr2, ...) do |t|
  STDERR.puts "Thread #{t} has terminated."
end

th = ThreadsWait.new(thread1,...)
th.next_wait # next one to be done
Methods
A
E
F
J
N
Constants
RCS_ID = '-$Id: thwait.rb,v 1.3 1998/06/26 03:19:34 keiju Exp keiju $-'
 
Attributes
[R] threads

Returns the array of threads that have not terminated yet.
Class Public methods
all_waits(*threads)

Waits until all specified threads have terminated. If a block is provided, it is executed for each thread as they terminate.

Source: show | on GitHub 

# File lib/thwait.rb, line 38
def ThreadsWait.all_waits(*threads) # :yield: thread
  tw = ThreadsWait.new(*threads)
  if block_given?
    tw.all_waits do |th|
      yield th
    end
  else
    tw.all_waits
  end
end
new(*threads)

Creates a ThreadsWait object, specifying the threads to wait on. Non-blocking.

Source: show | on GitHub 

# File lib/thwait.rb, line 53
def initialize(*threads)
  @threads = []
  @wait_queue = Queue.new
  join_nowait(*threads) unless threads.empty?
end
Instance Public methods
all_waits()

Waits until all of the specified threads are terminated. If a block is supplied for the method, it is executed for each thread termination.

Raises exceptions in the same manner as next_wait.

Source: show | on GitHub 

# File lib/thwait.rb, line 126
def all_waits
  until @threads.empty?
    th = next_wait
    yield th if block_given?
  end
end
empty?()

Returns true if there are no threads in the pool still running.

Source: show | on GitHub 

# File lib/thwait.rb, line 65
def empty?
  @threads.empty?
end
finished?()

Returns true if any thread has terminated and is ready to be collected.

Source: show | on GitHub 

# File lib/thwait.rb, line 72
def finished?
  !@wait_queue.empty?
end
join(*threads)

Waits for specified threads to terminate, and returns when one of the threads terminated.

Source: show | on GitHub 

# File lib/thwait.rb, line 80
def join(*threads)
  join_nowait(*threads)
  next_wait
end
join_nowait(*threads)

Specifies the threads that this object will wait for, but does not actually wait.

Source: show | on GitHub 

# File lib/thwait.rb, line 89
def join_nowait(*threads)
  threads.flatten!
  @threads.concat threads
  for th in threads
    Thread.start(th) do |t|
      begin
        t.join
      ensure
        @wait_queue.push t
      end
    end
  end
end
next_wait(nonblock = nil)

Waits until any of the specified threads has terminated, and returns the one that does.

If there is no thread to wait, raises ErrNoWaitingThread. If nonblock is true, and there is no terminated thread, raises ErrNoFinishedThread.

Source: show | on GitHub 

# File lib/thwait.rb, line 110
def next_wait(nonblock = nil)
  ThreadsWait.fail ErrNoWaitingThread if @threads.empty?
  begin
    @threads.delete(th = @wait_queue.pop(nonblock))
    th
  rescue ThreadError
    ThreadsWait.fail ErrNoFinishedThread
  end
end