File Coverage

blib/lib/MangoX/Queue/Job.pm

Criterion	Covered	Total	%
statement	3	9	33.3
branch	0	2	0.0
condition			n/a
subroutine	1	3	33.3
pod	1	1	100.0
total	5	15	33.3

package MangoX::Queue::Job;

use Mojo::Base 'Mojo::EventEmitter';

has 'has_finished' => sub { 0 };

sub DESTROY {
    my ($self) = @_;

    $self->finished;
}

sub finished {
    my ($self) = @_;

    return if $self->has_finished;
    $self->has_finished(1);
    $self->emit_safe("finished");
}

1;

=encoding utf8

=head1 NAME

MangoX::Queue::Job - A job consumed from L

=head1 DESCRIPTION

L is an object representing a job that has been consumed from L.
The object is just a document/job retrieved from the queue that is blessed, with an added desructor
method.

This class is used internally by L

=head1 SYNOPSIS

    use MangoX::Queue::Job;

    my $doc = {...};

    my $job = new MangoX::Queue::Job($doc);

=head1 ATTRIBUTES

L implements the following attributes:

=head2 has_finished

    my $finished = $job->has_finished;
    $job->has_finished(1);

Is set to C<1> when the job has finished, either through the C or C methods.

=head1 METHODS

L implements the following methods:

=head2 DESTROY

Called automatically when C<$job> goes out of scope, undef'd, or refcount goes to 0.

Calls C, emitting a C event if it hasn't already been emitted.

=head2 finished

Emits a C event if it hasn't already been emitted.

=head1 SEE ALSO

L, L, L

=cut