Minion::Backend - Backend base class
package Minion::Backend::MyBackend; use Mojo::Base 'Minion::Backend'; sub dequeue {...} sub enqueue {...} sub fail_job {...} sub finish_job {...} sub job_info {...} sub list_jobs {...} sub list_workers {...} sub register_worker {...} sub remove_job {...} sub repair {...} sub reset {...} sub retry_job {...} sub stats {...} sub unregister_worker {...} sub worker_info {...}
Minion::Backend is an abstract base class for Minion backends.
Minion::Backend implements the following attributes.
my $minion = $backend->minion; $backend = $backend->minion(Minion->new);
Minion object this backend belongs to.
Minion::Backend inherits all methods from Mojo::Base and implements the following new ones.
my $job_info = $backend->dequeue($worker_id, 0.5);
Wait for job, dequeue it and transition from inactive to active state or return undef if queue was empty. Meant to be overloaded in a subclass.
inactive
active
undef
my $job_id = $backend->enqueue('foo'); my $job_id = $backend->enqueue(foo => [@args]); my $job_id = $backend->enqueue(foo => [@args] => {priority => 1});
Enqueue a new job with inactive state. Meant to be overloaded in a subclass.
These options are currently available:
delay => 10
Delay job for this many seconds from now.
priority => 5
Job priority, defaults to 0.
0
my $bool = $backend->fail_job($job_id); my $bool = $backend->fail_job($job_id, 'Something went wrong!'); my $bool = $backend->fail_job($job_id, {msg => 'Something went wrong!'});
Transition from active to failed state. Meant to be overloaded in a subclass.
failed
my $bool = $backend->finish_job($job_id); my $bool = $backend->finish_job($job_id, 'All went well!'); my $bool = $backend->finish_job($job_id, {msg => 'All went well!'});
Transition from active to finished state. Meant to be overloaded in a subclass.
finished
my $job_info = $backend->job_info($job_id);
Get information about a job or return undef if job does not exist. Meant to be overloaded in a subclass.
my $batch = $backend->list_jobs($offset, $limit); my $batch = $backend->list_jobs($offset, $limit, {state => 'inactive'});
Returns the same information as "job_info" but in batches. Meant to be overloaded in a subclass.
state => 'inactive'
List only jobs in this state.
task => 'test'
List only jobs for this task.
my $batch = $backend->list_workers($offset, $limit);
Returns the same information as "worker_info" but in batches. Meant to be overloaded in a subclass.
my $worker_id = $backend->register_worker; my $worker_id = $backend->register_worker($worker_id);
Register worker or send heartbeat to show that this worker is still alive. Meant to be overloaded in a subclass.
my $bool = $backend->remove_job($job_id);
Remove failed, finished or inactive job from queue. Meant to be overloaded in a subclass.
$backend->repair;
Repair worker registry and job queue if necessary. Meant to be overloaded in a subclass.
$backend->reset;
Reset job queue. Meant to be overloaded in a subclass.
my $bool = $backend->retry_job($job_id);
Transition from failed or finished state back to inactive. Meant to be overloaded in a subclass.
my $stats = $backend->stats;
Get statistics for jobs and workers. Meant to be overloaded in a subclass.
$backend->unregister_worker($worker_id);
Unregister worker. Meant to be overloaded in a subclass.
my $worker_info = $backend->worker_info($worker_id);
Get information about a worker or return undef if worker does not exist. Meant to be overloaded in a subclass.
Minion, Mojolicious::Guides, http://mojolicio.us.
To install Minion, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Minion
CPAN shell
perl -MCPAN -e shell install Minion
For more information on module installation, please visit the detailed CPAN module installation guide.