NAME
MCE::Shared::Queue - Hybrid-queue helper class
VERSION
This document describes MCE::Shared::Queue version 1.699_007
SYNOPSIS
use MCE::Shared;
my $qu = MCE::Shared->queue( await => 1, fast => 0, queue => [ "." ] );
use MCE::Shared;
use MCE::Shared::Queue;
my $qu = MCE::Shared->queue(
porder => $MCE::Shared::Queue::HIGHEST,
type => $MCE::Shared::Queue::FIFO,
fast => 0
);
# Possible values for "porder" and "type".
porder =>
$MCE::Shared::Queue::HIGHEST # Highest priority items dequeue first
$MCE::Shared::Queue::LOWEST # Lowest priority items dequeue first
type =>
$MCE::Shared::Queue::FIFO # First in, first out
$MCE::Shared::Queue::LIFO # Last in, first out
$MCE::Shared::Queue::LILO # Synonym for FIFO
$MCE::Shared::Queue::FILO # Synonym for LIFO
# Below, [ ... ] denotes optional parameters.
$qu->await( [ $pending_threshold ] );
$qu->clear();
$qu->enqueue( $item [, $item, ... ] );
$qu->enqueuep( $priority, $item [, $item, ... ] );
$item = $qu->dequeue();
@items = $qu->dequeue( $count );
$item = $qu->dequeue_nb();
@items = $qu->dequeue_nb( $count );
$qu->insert( $index, $item [, $item, ... ] );
$qu->insertp( $priority, $index, $item [, $item, ... ] );
$count = $qu->pending();
$item = $qu->peek( [ $index ] );
$item = $qu->peekp( $priority [, $index ] );
@array = $qu->heap();
DESCRIPTION
Helper class for MCE::Shared.
This module is compatible with MCE::Queue except for the gather
option which is not supported in this context.
API DOCUMENTATION
To be completed before the final 1.700 release.
- new
- await
- clear
- dequeue
- dequeue_nb
- enqueue
- enqueuep
- heap
- insert
- insertp
- peek
- peekp
- peekh
- pending
INDEX
AUTHOR
Mario E. Roy, <marioeroy AT gmail DOT com>