Kevin L. Esteb > XAS-0.04 > XAS::Lib::Gearman::Client::Status

Download:
XAS-0.04.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 0.02   Source   Latest Release: XAS-0.05

NAME ^

XAS::Lib::Gearman::Client::Status - Return the clients status.

SYNOPSIS ^

 use XAS:::Lib::Gearman::Client::Status;

 my $status = XAS::Lib::Gearman::Client::Status->new(
     -jobid  => $jobid,
     -handle => $handle
 );

DESCRIPTION ^

This module is a wrapper around the Gearman Admin protocol. If returns an object for the status information returned by the gearman job_status call.

METHODS ^

new

The initializes the module and retireves the status of the job. It takes two parameters:

-jobid

The id of the background job.

-handle

The handle to the gearman interface.

known

Returns wither the job is known to gearman.

status

Returns the status of the job.

numerator

Returns the numerator of the status.

denominator

Returns the denominator of the status.

SEE ALSO ^

 Gearman::XS
 Gearman::XS::Client
 Gearman::XS::Worker

XAS

AUTHOR ^

Kevin L. Esteb, <kevin@kesteb.us>

COPYRIGHT AND LICENSE ^

Copyright (C) 2012 by Kevin L. Esteb

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8.8 or, at your option, any later version of Perl 5 you may have available.

syntax highlighting: