Ruby 2.4.0 リファレンスマニュアル > ライブラリ一覧 > 組み込みライブラリ > Thread::Queueクラス

class Thread::Queue

クラスの継承リスト: Thread::Queue < Object < Kernel < BasicObject
aliases: Queue

要約

Queue はスレッド間の FIFO(first in first out) の通信路です。ス レッドが空のキューを読み出そうとすると停止します。キューになんら かの情報が書き込まれると実行は再開されます。

最大サイズが指定できる Queue のサブクラス Thread::SizedQueue も提供されています。

require 'thread'

q = Queue.new

th1 = Thread.start do
  while resource = q.pop
    puts resource
  end
end

[:resource1, :resource2, :resource3, nil].each{|r|
  q.push(r)
}

th1.join

実行すると以下のように出力します。

$ ruby que.rb
resource1
resource2
resource3

目次

特異メソッド
new
インスタンスメソッド
<< enq push clear close closed? deq pop shift empty? length size num_waiting

特異メソッド

new -> Thread::Queue[permalink][rdoc]

新しいキューオブジェクトを生成します。

インスタンスメソッド

push(value) -> ()[permalink][rdoc]
self << value -> ()
enq(value) -> ()

キューの値を追加します。待っているスレッドがいれば実行を再開 させます。返り値は不定です。

clear -> ()[permalink][rdoc]

キューを空にします。返り値は不定です。

close -> self[permalink][rdoc]

キューを close します。close 済みのキューを再度 open することはできません。

close 後は以下のように動作します。

また、ClosedQueueErrorStopIteration を継承しているため、 close する事でループから脱出する事もできます。

例:

q = Queue.new
Thread.new{
  while e = q.deq # wait for nil to break loop
    # ...
  end
}
q.close
closed? -> bool[permalink][rdoc]

キューが close されている時に true を返します。

pop(non_block = false) -> object[permalink][rdoc]
shift(non_block = false) -> object
deq(non_block = false) -> object

キューからひとつ値を取り出します。キューが空の時、呼出元のスレッドは停止します。

[PARAM] non_block:
true を与えると、キューが空の時に例外 ThreadError が発生します。
empty? -> bool[permalink][rdoc]

キューが空の時、真を返します。

length -> Fixnum[permalink][rdoc]
size -> Fixnum

キューの長さを返します。

num_waiting -> Fixnum[permalink][rdoc]

キューを待っているスレッドの数を返します。