class Thread::SizedQueue

aliases: SizedQueue

要約

サイズの最大値を指定できる Thread::Queue です。

例

[ruby-list:283] より。q をサイズ 1 の SizedQueue オブジェクトにすることによって、入力される行と出力される行が同じ順序になります。 q = [] にすると入力と違った順序で行が出力されます。

require 'thread'

q = SizedQueue.new(1)

th = Thread.start {
  while line = q.pop
    print line
  end
}

while l = gets
  q.push(l)
end
q.push(l)

th.join

目次

特異メソッド

• new

インスタンスメソッド

• <<
• close
• deq
• empty?
• enq
• length
• max
• max=
• pop
• push
• shift
• size

継承しているメソッド

Thread::Queueから継承しているメソッド

• clear
• closed?
• num_waiting

特異メソッド

new(max) -> Thread::SizedQueue[permalink][rdoc][edit]

Thread::SizedQueue オブジェクトを生成します。

[PARAM] max:

キューのサイズの最大値です。

インスタンスメソッド

push(obj, non_block = false) -> ()[permalink][rdoc][edit]

enq(obj, non_block = false) -> ()

self << obj -> ()

キューに与えられたオブジェクトを追加します。

キューのサイズが Thread::SizedQueue#max に達している場合は、 non_block が真でなければ、キューのサイズが Thread::SizedQueue#max より小さくなるまで他のスレッドに実行を譲ります。その後、キューに与えられたオブジェクトを追加します。

[PARAM] obj:

キューに追加したいオブジェクトを指定します。

[PARAM] non_block:

true を与えると、キューが一杯の時に例外 ThreadError が発生します。

[SEE_ALSO] Thread::Queue#push

close -> self[permalink][rdoc][edit]

キューを close します。詳しくは Thread::Queue#close を参照してください。

Thread::Queue とはキューにオブジェクトを追加するスレッドの動作が異なります。キューにオブジェクトを追加するスレッドを待機している場合は ClosedQueueError が発生して中断されます。

例

q = SizedQueue.new(4)

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

q.closed? # => false
q.close
q.closed? # => true

[SEE_ALSO] Thread::Queue#close

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

shift(non_block = false) -> object

deq(non_block = false) -> object

キューからひとつ値を取り出します。キューに push しようと待っているスレッドがあれば、実行を再開させます。

[PARAM] non_block:

true を与えると、キューが空の時に例外 ThreadError が発生します。

例

require 'thread'

q = SizedQueue.new(4)

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

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

th1.join
# => resource1
# resource2
# resource3

例: nonblock = true

require 'thread'

q = SizedQueue.new(4)

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

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

begin
  th1.join
  q.pop(true)
rescue => e
  p e
  p e.message
end

# => resource1
# resource2
# resource3
# => #<ThreadError: queue empty>
# => "queue empty"

[SEE_ALSO] Thread::Queue#pop

empty? -> bool[permalink][rdoc][edit]

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

length -> Integer[permalink][rdoc][edit]

size -> Integer

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

max -> Integer[permalink][rdoc][edit]

キューの最大サイズを返します。

例

q = SizedQueue.new(4)
q.max # => 4

max=(n)[permalink][rdoc][edit]

キューの最大サイズを設定します。

[PARAM] n:

キューの最大サイズを指定します。

例

q = SizedQueue.new(4)
q.max # => 4
q.max = 5
q.max # => 5