File Coverage

blib/lib/Gearman/Job.pm

Criterion	Covered	Total	%
statement	32	33	96.9
branch	1	4	25.0
condition			n/a
subroutine	11	11	100.0
pod	4	5	80.0
total	48	53	90.5

package Gearman::Job;
use version ();
$Gearman::Job::VERSION = version->declare("2.003_001");

use strict;
use warnings;

use Gearman::Util ();
use Carp ();

=head1 NAME

Gearman::Job - Job in gearman distributed job system

=head1 DESCRIPTION


I is the object that's handed to the worker subrefs

=head1 METHODS

=cut

use fields (
    'func',
    'argref',
    'handle',

    # job server's socket
    'jss',

    # job server
    'js',
);

sub new {
    my ($self, %arg) = @_;
    unless (ref $self) {
        $self = fields::new($self);
    }

    while(my ($k, $v) = each(%arg)) {
      $self->{$k} = $v;
    }

    return $self;
} ## end sub new

=head2 set_status($numerator, $denominator)

Updates the status of the job (most likely, a long-running job) and sends
it back to the job server. I<$numerator> and I<$denominator> should
represent the percentage completion of the job.

=cut

sub set_status {
    my $self = shift;
    my ($nu, $de) = @_;

    my $req = Gearman::Util::pack_req_command("work_status",
        join("\0", $self->{handle}, $nu, $de));

    Carp::croak "work_status write failed"
        unless Gearman::Util::send_req($self->{jss}, \$req);

    return 1;
} ## end sub set_status

=head2 argref()

=cut

sub argref {
    return shift->{argref};
}

=head2 arg()

B the scalar argument that the client sent to the job server.

=cut

sub arg {
    return ${ shift->{argref} };
}

=head2 handle()

B handle

=cut

sub handle {
    return shift->{handle};
}

1;