package Thread::Queue::Any; # initializations @ISA= qw( Thread::Queue ); $VERSION= '0.16'; # be as strict as possble use strict; # modules that we need use Storable (); # no need to pollute namespace use Thread::Queue (); # no need to pollute namespace # synonym for dequeue_dontwait { no warnings 'once'; *dequeue_nb = \&dequeue_dontwait; } # satisfy -require- 1; #------------------------------------------------------------------------------- # IN: 1 instantiated object # 2..N parameters to be passed as a set onto the queue sub enqueue { return shift->SUPER::enqueue( Storable::freeze( \@_ ) ); } #enqueue #------------------------------------------------------------------------------- # IN: 1 instantiated object # OUT: 1..N parameters returned from a set on the queue sub dequeue { return @{ Storable::thaw( shift->SUPER::dequeue ) }; } #dequeue #------------------------------------------------------------------------------- # IN: 1 instantiated object # OUT: 1..N parameters returned from a set on the queue sub dequeue_dontwait { my $ref= shift->SUPER::dequeue_nb or return; return @{ Storable::thaw($ref) }; } #dequeue_dontwait #------------------------------------------------------------------------------- # IN: 1 instantiated object # OUT: 1..N parameters returned from a set on the queue sub dequeue_keep { lock( @{ $_[0] } ); # make sure we're the only my $ref= shift->[0] or return; return @{ Storable::thaw($ref) }; } #dequeue_keep #------------------------------------------------------------------------------- __END__ =head1 NAME Thread::Queue::Any - thread-safe queues for any data-structure =head1 SYNOPSIS 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; =head1 VERSION This documentation describes version 0.16. =head1 DESCRIPTION *** A note of CAUTION *** This module only functions on threaded perl or an unthreaded perl with the "forks" module installed. Please also note that this documentation describes the "maint" version of this code. This version is essentially frozen. Please use a 5.14 or higher version of perl for the "blead" version of this code. ************************* A queue, as implemented by C is a thread-safe data structure that inherits from C. But unlike the standard C, you can pass (a reference to) any data structure to the queue. Apart from the fact that the parameters to C are considered to be a set that needs to be enqueued together and that C returns all of the parameters that were enqueued together, this module is a drop-in replacement for C in every other aspect. 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). =head1 CLASS METHODS =head2 new $queue= Thread::Queue::Any->new; The C function creates a new empty queue. =head1 OBJECT METHODS =head2 enqueue LIST $queue->enqueue( 'string', $scalar, [], {} ); The C method adds a reference to all the specified parameters on to the end of the queue. The queue will grow as needed. =head2 dequeue ( $string, $scalar, $listref, $hashref )= $queue->dequeue; The C method removes a reference from the head of the queue, dereferences it and returns the resulting values. If the queue is currently empty, C will block the thread until another thread Cs. =head2 dequeue_dontwait ( $string, $scalar, $listref, $hashref )= $queue->dequeue_dontwait; The C method, like the C method, removes a reference from the head of the queue, dereferences it and returns the resulting values. Unlike C, though, C won't wait if the queue is empty, instead returning an empty list if the queue is empty. For compatibility with L, the name "dequeue_nb" is available as a synonym for this method. =head2 dequeue_keep ( $string, $scalar, $listref, $hashref )= $queue->dequeue_keep; The C method, like the C method, takes a reference from the head of the queue, dereferences it and returns the resulting values. Unlike C, though, the C B the set from the queue. It can therefore be used to test if the next set to be returned from the queue with C or C will have a specific value. =head2 pending $pending= $queue->pending; The C method returns the number of items still in the queue. =head1 REQUIRED MODULES Thread::Queue (any) =head1 CAVEATS Passing unshared values between threads is accomplished by serializing the specified values using C 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 B be serialized and therefore not be passed. =head1 AUTHOR Elizabeth Mattijsen, . Please report bugs to . =head1 COPYRIGHT Copyright (c) 2002, 2003, 2007, 2012 Elizabeth Mattijsen . All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. =head1 SEE ALSO L, L, L, L. =cut