/ 
Resque-0.42
River stage one • 3 direct dependents • 3 total dependents
/ Resque::WorkerClass

NAME

Resque::WorkerClass - Resque adaptor to create moose based jobs

VERSION

version 0.42

SYNOPSIS

Resque::WorkerClass let you write Moose based job classes that will expect to be called with a single argument that should be a hashref to be pased to the constructor. Something like this:

use Resque;
Resque->new->push( some_queue => {
    class => 'Task::SayHello',
    args => [{ name => 'Ambar', email => 'her@mail.com' }]
});

Using this class, you can declare your attributes as any normal Moose class, use roles and everything moosey. The only requirement is that you should implement a run() method that's the entry point of your background job:

package Task::SayHello;
use Resque::WorkingClass; # This will load Moose for you
with 'Task::Role::Sendmail'; # a role to send emails

has name  => is => 'ro', isa => 'Str', required => 1;
has email => is => 'ro', isa => 'Str', required => 1;

sub run {
    my $self = shift;

    $self->sendmail(
        to      => $self->email,
        subject => sprintf('Hello %s', $self->name)
    );
}

1;

DESCRIPTION

Writting resque background jobs usually requires a lot of boilerplate to be able to validate arguments, share things as database conections, configuration or just load and configure other modules. By using this class you can use all what we love about Moose for attribute validation, use roles to be able to share functionality among your job clases and even use method modifiers on your jobs.

The only thing you should do to start writing moose background jobs is to use() this class instead of Moose itself and implement the mandatory run() method that will be called on a fresh instance of you class initialized with the job only argument (see SYNOPSIS).

Your class will get injected 3 attributes: job, resque and redis that you can use to access the job object passed to perform(), the resque system running the job and the redis object used by the resque system.

METHODS

perform

This will be called by Resque::Worker to perform() your job. This is the glue implementation that will initialize an instance of your class and call your run() method on it.

AUTHOR

Diego Kuperman <diego@freekeylabs.com>

COPYRIGHT AND LICENSE

This software is copyright (c) 2021 by Diego Kuperman.

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