Ruby 2.1.0 リファレンスマニュアル > ライブラリ一覧 > 組み込みライブラリ > ThreadGroupクラス

class ThreadGroup

クラスの継承リスト: ThreadGroup < Object < Kernel < BasicObject

要約

スレッドグループを表すクラスです。グループに属する Thread をまとめて操作することができます。

Thread は必ずいずれかひとつのスレッドグループに属します。生成されたばかりの Thread は、生成した Thread のグループを引き継ぎます。メインスレッドはデフォルトでは ThreadGroup::Default に属します。

例:

生成したすべてのThreadが終了するのを待つ

5.times {
   Thread.new { sleep 1; puts "#{Thread.current} finished" }
}

(ThreadGroup::Default.list - [Thread.current]).each {|th| th.join}

puts "all threads finished"

対象の Thread が Thread を起こす可能性がある場合 (Thread.exclusive参照)

Thread.exclusive do
  (ThreadGroup::Default.list - [Thread.current]).each {|th| th.join}
end

ThreadGroup#freeze と ThreadGroup#enclose の違い

どちらのメソッドでも ThreadGroup#add によるスレッドの追加ができなくなる点は同じですが、 Thread.new に関して違いがあります。現在のスレッドが属する ThreadGroup が freeze されている場合、Thread.new{ ... } はエラーになります。ThreadGroup が enclose されているだけでは、 Thread.new{ ... } はエラーになりません。生成されたスレッドは従来通り親スレッドの ThreadGroup に属します。

特異メソッド

new -> ThreadGroup[permalink][rdoc]: 新たな ThreadGroup を生成して返します。

インスタンスメソッド

add(thread) -> self[permalink][rdoc]

スレッド thread が属するグループを自身に変更します。

[PARAM] thread:: 自身に加えたいスレッドを指定します。
[EXCEPTION] ThreadError:: 自身が freeze されているか enclose されている場合に、発生します。また引数 thread が属する ThreadGroup が freeze されているか enclose されている場合にも発生します。

enclose -> self[permalink][rdoc]

自身への ThreadGroup#add によるスレッドの追加・削除を禁止します。 enclose された ThreadGroup に追加や削除を行うと例外 ThreadError が発生します。

ただし、Thread.new によるスレッドの追加は禁止されません。enclose されたスレッドグループ A に属するスレッドが新たにスレッドを生成した場合、生成されたスレッドはスレッドグループ A に属します。

追加の例:

thg = ThreadGroup.new.enclose
thg.add Thread.new {}

=> -:2:in `add': can't move to the enclosed thread group (ThreadError)

削除の例:

thg1 = ThreadGroup.new
thg2 = ThreadGroup.new

th = Thread.new {sleep 1}

thg1.add th
thg1.enclose
thg2.add th

=> -:8:in `add': can't move from the enclosed thread group (ThreadError)

enclosed? -> bool[permalink][rdoc]

自身が enclose されているなら true を返します。そうでないなら false を返します。デフォルトは false です。

freeze された ThreadGroup には Thread の追加/削除ができませんが、enclosed? は false を返します。

thg = ThreadGroup.new
p thg.enclosed?         # => false
thg.enclose
p thg.enclosed?         # => true

thg = ThreadGroup.new
p thg.enclosed?         # => false
thg.freeze
p thg.enclosed?         # => false

[SEE_ALSO] ThreadGroup#enclose

list -> [Thread][permalink][rdoc]

self に属するスレッドの配列を返します。 version 1.8 では、aborting 状態であるスレッドも要素に含まれます。つまり「生きている」スレッドの配列を返します。

定数

Default -> ThreadGroup[permalink][rdoc]: デフォルトで定義されている ThreadGroup です。メインスレッドは最初このグループに属します。

class ThreadGroup

要約

ThreadGroup#freeze と ThreadGroup#enclose の違い

目次

特異メソッド

インスタンスメソッド

定数