Mike Eldridge > Hopkins-0.9.2 > Hopkins::Queue

Download:
Hopkins-0.9.2.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  1
Open  0
View/Report Bugs
Source  

NAME ^

Hopkins::Queue - hopkins queue states and methods

DESCRIPTION ^

Hopkins::Queue contains all of the POE event handlers and supporting methods for the initialization and management of each configured hopkins queue.

STATES ^

new
contents
find
enqueue
dequeue
write_state

write the queue's state to disk.

stop

stops the queue, shutting down the PoCo::JobQueue session if running by sending a stop event to it.

spawn_worker
fetch_and_spawn_worker
prioritize
is_running
status
status_string
num_queued
start
halt

halts the queue. no tasks will be executed, although tasks may still be enqueued.

continue

reverses the action of halt by starting the queue back up. the existing state of the frozen flag will be preserved.

freeze

freezes the queue. no more tasks will be enqueued, but currently queued tasks will be allowed to execute.

thaw

reverses the action of freeze by unsetting the frozen flag. tasks will not be queable. the existing halt state will be preserved.

shutdown

shuts the queue down. this is basically a shortcut for the freeze and halt actions. no more tasks will be executed and no further tasks may be enqueud.

flush

flush the queue of any tasks waiting to execute. stops the PoCo::JobQueue session (if running) and clears the internal list of tasks. if the queue was running prior to the flush, the PoCo::JobQueue session is spun back up.

DESTROY

AUTHOR ^

Mike Eldridge <diz@cpan.org>

LICENSE ^

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

syntax highlighting: