名前¶

Thread::Queue::Any - 任意のデータ構造に対するスレッドセーフなキュー

概要¶

    use Thread::Queue::Any;
    my $q = Thread::Queue::Any->new;
    $q->enqueue("foo", ["bar"], {"zoo"});
    my ($foo,$bar,$zoo) = $q->dequeue;
    my ($foo,$bar,$zoo) = $q->dequeue_dontwait;
    my ($iffoo,$ifbar,$ifzoo) = $q->dequeue_keep;
    my $left = $q->pending;

説明¶

                    *** A note of CAUTION ***

 This module only functions on Perl versions 5.8.0-RC3 and later.
 And then only when threads are enabled with -Dusethreads.  It is
 of no use with any version of Perl before 5.8.0-RC3 or without
 threads enabled.

                    *************************

                    *** 注   意   書   き ***

 このモジュールはPerl 5.8.0-RC3とそれ以降でのみ機能する。
 かつ、-Dusethreadsでスレッドが有効になっている場合だけである。
 5.8.0-RC3より前のバージョン、あるいはスレッド機能が有効になって
 いない場合は、利用できない。

                    *************************

A queue, as implemented by Thread::Queue::Any is a thread-safe data structure that inherits from Thread::Queue. But unlike the standard Thread::Queue, you can pass (a reference to) any data structure to the queue.

Thread::Queue::Anyによって実装されるキューは、スレッドセーフなデータ構造であり、Thread::Queueを継承している。しかし、標準的な Thread::Queueと違って、どんなデータ構造（へのリファレンス）でもこのキューに渡すことができる。

Apart from the fact that the parameters to enqueue are considered to be a set that needs to be enqueued together and that dequeue returns all of the parameters that were enqueued together, this module is a drop-in replacement for Thread::Queue in every other aspect.

enqueueに渡すパラメータは一度にenqueueされてしまうセットであることと、 dequeueはその一度にenqueueしたパラメータを全て返すという事実を別にして、このモジュールは多くの面でThread::Queueの差し込み式の代替となる。

Any number of threads can safely add elements to the end of the list, or remove elements from the head of the list. (Queues don't permit adding or removing elements from the middle of the list).

任意の数のスレッドが、安全にリストの最後に要素を加えたり、あるいは、リストの先頭から要素を取り除ける（キューはリストの途中に要素を加えたり取り除いたりはできない）。

クラスメソッド¶

new¶

 $queue = Thread::Queue::Any->new;

The new function creates a new empty queue.

new関数は新たな空キューを生成する。

オブジェクトメソッド¶

enqueue LIST¶

 $queue->enqueue( 'string',$scalar,[],{} );

The enqueue method adds a reference to all the specified parameters on to the end of the queue. The queue will grow as needed.

enqueueメソッドは、キューの最後尾に指定した全パラメータへのリファレンスを加える。キューは必要に応じて成長する。

dequeue¶

 ($string,$scalar,$listref,$hashref) = $queue->dequeue;

The dequeue method removes a reference from the head of the queue, dereferences it and returns the resulting values. If the queue is currently empty, dequeue will block the thread until another thread enqueues.

dequeueメソッドは、キューの先頭からリファレンスを一つ取り除き、デリファレンスしてその結果の値を返す。もしその時キューが空なら、他のスレッドがenqueueするまでdequeueはブロックする。

dequeue_dontwait¶

 ($string,$scalar,$listref,$hashref) = $queue->dequeue_dontwait;

The dequeue_dontwait method, like the dequeue method, removes a reference from the head of the queue, dereferences it and returns the resulting values. Unlike dequeue, though, dequeue_dontwait won't wait if the queue is empty, instead returning an empty list if the queue is empty.

dequeue_dontwaitメソッドは、dequeueと同様、キューの先頭から一つリファレンスを取り除き、デリファレンスしてその結果の値を返す。しかし、 dequeueと違って、dequeue_dontwaitはキューが空でも待ちに入らない。その代わりに空リストが返される。

For compatibility with Thread::Queue, the name "dequeue_nb" is available as a synonym for this method.

Thread::Queueとの互換性のため、"dequeue_nb"がこのメソッドの同義語として利用可能。

dequeue_keep¶

 ($string,$scalar,$listref,$hashref) = $queue->dequeue_keep;

The dequeue_keep method, like the dequeue_dontwait method, takes a reference from the head of the queue, dereferences it and returns the resulting values. Unlike dequeue_dontwait, though, the dequeue_keep won't remove the set from the queue. It can therefore be used to test if the next set to be returned from the queue with dequeue or dequeue_dontwait will have a specific value.

dequeue_keepメソッドは、dequeue_dontwait同様、キューの先頭からリファレンスを一つ取り、デリファレンスしてその結果の値を返す。しかしdequeue_dontwaitと違って、dequeue_keepはキューからそのセットを 取り除かない。よって、dequeue_dontwaitが特定の値を持つことになるかどうかテストするのに使える。

pending¶

 $pending = $queue->pending;

The pending method returns the number of items still in the queue.

pendingメソッドはまだキューに残っているアイテムの数を返す。

必要なモジュール¶

 Storable (バージョンはどれでも)
 Thread::Queue (バージョンはどれでも)

警告¶

Passing unshared values between threads is accomplished by serializing the specified values using Storable when enqueuing and de-serializing the queued value on dequeuing. This allows for great flexibility at the expense of more CPU usage. It also limits what can be passed, as e.g. code references can not be serialized and therefore not be passed.

スレッド間で非共有な値を渡す処理は、Storableを利用して指定の値をシリアライズすることによって達成している（これを利用するのはenqueue時と、キューされた値をdequeueする際のデシリアライズの時）。これは、より多くの CPU消費を犠牲にする代わりに、大きな柔軟性を考慮したためである。また、キューに渡せるものにも制限がある。例えば、コードリファレンスはシリアライズ化できないので、渡すことはできない。

作者¶

Elizabeth Mattijsen, <liz@dijkmat.nl>.

Please report bugs to <perlbugs@dijkmat.nl>.

著作権¶

参考¶

threads, threads::shared, Thread::Queue, Storable.