Class: ThreadsWait
Relationships & Source Files | |
Super Chains via Extension / Inclusion / Inheritance | |
Class Chain:
self,
Exception2MessageMapper
|
|
Inherits: | Object |
Defined in: | lib/thwait.rb |
Overview
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_waits(thr1, thr2, ...) do |t|
STDERR.puts "Thread #{t} has terminated."
end
th = ThreadsWait.new(thread1,...)
th.next_wait # next one to be done
Class Method Summary
-
.all_waits(*threads)
Waits until all specified threads have terminated.
-
.new(*threads) ⇒ ThreadsWait
constructor
Creates a
ThreadsWait
object, specifying the threads to wait on.
Instance Attribute Summary
-
#empty? ⇒ Boolean
readonly
Returns
true
if there are no threads in the pool still running. -
#finished? ⇒ Boolean
readonly
Returns
true
if any thread has terminated and is ready to be collected. -
#threads
readonly
Returns the array of threads that have not terminated yet.
Instance Method Summary
-
#all_waits
Waits until all of the specified threads are terminated.
-
#join(*threads)
Waits for specified threads to terminate, and returns when one of the threads terminated.
-
#join_nowait(*threads)
Specifies the threads that this object will wait for, but does not actually wait.
-
#next_wait(nonblock = nil)
Waits until any of the specified threads has terminated, and returns the one that does.
Constructor Details
.new(*threads) ⇒ ThreadsWait
Creates a ThreadsWait
object, specifying the threads to wait on. Non-blocking.
# File 'lib/thwait.rb', line 52
def initialize(*threads) @threads = [] @wait_queue = Queue.new join_nowait(*threads) unless threads.empty? end
Class Method Details
.all_waits(*threads)
Waits until all specified threads have terminated. If a block is provided, it is executed for each thread as they terminate.
Instance Attribute Details
#empty? ⇒ Boolean
(readonly)
Returns true
if there are no threads in the pool still running.
# File 'lib/thwait.rb', line 64
def empty? @threads.empty? end
#finished? ⇒ Boolean
(readonly)
Returns true
if any thread has terminated and is ready to be collected.
# File 'lib/thwait.rb', line 71
def finished? !@wait_queue.empty? end
#threads (readonly)
Returns the array of threads that have not terminated yet.
# File 'lib/thwait.rb', line 59
attr_reader :threads
Instance Method Details
#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.
#join(*threads)
Waits for specified threads to terminate, and returns when one of the threads terminated.
# File 'lib/thwait.rb', line 79
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.
#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
.
# File 'lib/thwait.rb', line 109
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