NAME
Minion::Backend::File - File backend
SYNOPSIS
use Minion::Backend::File;
my $backend = Minion::Backend::File->new('/Users/sri/minion.data');
DESCRIPTION
Minion::Backend::File is a highly portable file-based backend for Minion.
ATTRIBUTES
Minion::Backend::File inherits all attributes from Minion::Backend and implements the following new ones.
deserialize
my $cb = $backend->deserialize;
$backend = $backend->deserialize(sub {...});
A callback used to deserialize data, defaults to using Storable with gzip compression.
$backend->deserialize(sub {
my $bytes = shift;
return {};
});
file
my $file = $backend->file;
$backend = $backend->file('/Users/sri/minion.data');
File all data is stored in.
serialize
my $cb = $backend->serialize;
$backend = $backend->serialize(sub {...});
A callback used to serialize data, defaults to using Storable with gzip compression.
$backend->serialize(sub {
my $hash = shift;
return '';
});
METHODS
Minion::Backend::File inherits all methods from Minion::Backend and implements the following new ones.
dequeue
my $info = $backend->dequeue($worker_id);
Dequeue job and transition from inactive
to active
state or return undef
if queue was empty.
enqueue
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. You can also append a callback to perform operation non-blocking.
$backend->enqueue(foo => sub {
my ($backend, $err, $job_id) = @_;
...
});
Mojo::IOLoop->start unless Mojo::IOLoop->is_running;
fail_job
my $bool = $backend->fail_job($job_id);
my $bool = $backend->fail_job($job_id, 'Something went wrong!');
Transition from active
to failed
state.
finish_job
my $bool = $backend->finish_job($job_id);
Transition from active
to finished
state.
job_info
my $info = $backend->job_info($job_id);
Get information about a job or return undef
if job does not exist.
list_jobs
my $batch = $backend->list_jobs($skip, $limit);
Returns the same information as "job_info" but in batches.
list_workers
my $batch = $backend->list_workers($skip, $limit);
Returns the same information as "worker_info" but in batches.
new
my $backend = Minion::Backend::File->new('/Users/sri/minion.data');
Construct a new Minion::Backend::File object.
register_worker
my $worker_id = $backend->register_worker;
Register worker.
remove_job
my $bool = $backend->remove_job($job_id);
Remove failed
, finished
or inactive
job from queue.
repair
$backend->repair;
Repair worker registry and job queue.
reset
$backend->reset;
Reset job queue.
restart_job
my $bool = $backend->restart_job($job_id);
Transition from failed
or finished
state back to inactive
.
stats
my $stats = $backend->stats;
Get statistics for jobs and workers.
unregister_worker
$backend->unregister_worker($worker_id);
Unregister worker.
worker_info
my $info = $backend->worker_info($worker_id);
Get information about a worker or return undef
if worker does not exist.