Peter Karman > SWISH-Prog-0.73 > SWISH::Prog::Queue

Download:
SWISH-Prog-0.73.tar.gz

Dependencies

Annotate this POD

Website

CPAN RT

Open  0
View/Report Bugs
Module Version: 0.73   Source   Latest Release: SWISH-Prog-0.75

NAME ^

SWISH::Prog::Queue - simple in-memory FIFO queue class

SYNOPSIS ^

 use SWISH::Prog::Queue;
 my $queue = SWISH::Prog::Queue->new;
 
 $queue->put( 'foo' );
 $queue->size;          # returns number of items in queue (1)
 $queue->peek;          # returns 'foo' (next value for get())
 $queue->get;           # returns 'foo' locks it in queue (no one else can get it)
 $queue->remove('foo'); # returns 'foo' and removes it from queue
 $queue->clean;         # removes all completed items from queue

DESCRIPTION ^

SWISH::Prog::Queue is basically a Perl array, but it defines an API that can be implemented using any kind of storage and logic you want. One example would be a database that tracks items to be evaluated, or a flat file list.

METHODS ^

See SWISH::Prog::Class.

init

Overrides base method.

put( item )

Add item to the queue. Default is to push() it to end of queue.

get

Returns the next item. Default is to shift() it from the front of the queue.

remove( item )

Removes item from the queue (unlocks it).

clean

Removes all locked items from the queue.

peek

Returns the next item value, but leaves it on the stack.

size

Returns the number of items currently in the queue.

AUTHOR ^

Peter Karman, <perl@peknet.com>

BUGS ^

Please report any bugs or feature requests to bug-swish-prog at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=SWISH-Prog. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT ^

You can find documentation for this module with the perldoc command.

    perldoc SWISH::Prog

You can also look for information at:

COPYRIGHT AND LICENSE ^

Copyright 2008-2009 by Peter Karman

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

SEE ALSO ^

http://swish-e.org/

syntax highlighting: