class Thread::Queue

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

インスタンスメソッド

• <<
• clear
• deq
• empty?
• enq
• length
• num_waiting
• pop
• push
• shift
• size

特異メソッド

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

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

インスタンスメソッド

push(value) -> ()[permalink][rdoc]

self << value -> ()

enq(value) -> ()

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

clear -> ()[permalink][rdoc]

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

例

require 'thread'
q = Queue.new

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

q.length # => 4
q.clear
q.length # => 0

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]

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

例

require 'thread'
q = Queue.new
q.empty? # => true
q.push(:resource)
q.empty? # => false

length -> Integer[permalink][rdoc]

size -> Integer

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

例

require 'thread'
q = Queue.new

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

q.length # => 4

num_waiting -> Integer[permalink][rdoc]

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