Алексей Пастухов > Gearman > Gearman::Task

Download:
Gearman-2.002.004.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 2.002.004   Source  

NAME ^

Gearman::Task - a task in Gearman, from the point of view of a client

SYNOPSIS ^

    my $task = Gearman::Task->new("add", "1+2", {
            ...
    });

    $taskset->add_task($task);
    $client->do_task($task);
    $client->dispatch_background($task);

DESCRIPTION ^

Gearman::Task is a Gearman::Client's representation of a task to be done.

USAGE ^

Gearman::Task->new($func, $arg, \%options)

Creates a new Gearman::Task object, and returns the object.

$func is the function name to be run. (that you have a worker registered to process)

$arg is an opaque scalar or scalarref representing the argument(s) to pass to the distributed function. If you want to pass multiple arguments, you must encode them somehow into this one. That's up to you and your worker.

%options can contain:

METHODS ^

run_hook($name)

run a hook callback if defined

add_hook($name, $cb)

add a hook

is_finished()

return bool: whether or not task is totally done (on_failure or on_complete callback has been called)

taskset()

getter

taskset($ts)

setter

return Gearman::Taskset

hash()

return undef on non-uniq packet, or the hash value (0-32767) if uniq

pack_submit_packet($client)

return Gearman::Util::pack_req_command(mode, func, uniq, argref)

fail($reason)

final_fail($reason)

run if !is_finished

exception($exc_ref)

$exc_ref may be a Storable serialized value

run on_exception if defined

complete($result)

$result a reference profided to on_complete cb

status()

handle()

getter

handle($handle)

setter for the fully-qualified handle of form "IP:port//shandle" where

shandle is an opaque handle specific to the job server running on IP:port

set_on_post_hooks($code)

wipe()

cleanup

func()

timeout()

getter

timeout($t)

setter

return timeout

mode()

return mode in depends of background and hight_priority

syntax highlighting: