---
name: "Gearman::Task"
section: "3pm"
platform: "linux"
package: "libgearman-client-perl"
version: "2.004.015-1"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/Gearman::Task"
---

# Gearman::Task(3pm)

a task in Gearman, from the point of view of a client

## 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:

- •

  uniq

  A key which indicates to the server that other tasks with the same function name and key will be merged into one.  That is, the task will be run just once, but all the listeners waiting on that job will get the response multiplexed back to them.

  Uniq may also contain the magic value "-" (a single hyphen) which means the uniq key is the contents of the args.

- •

  on\_complete

  A subroutine reference to be invoked when the task is completed. The subroutine will be passed a reference to the return value from the worker process.

- •

  on\_fail

  A subroutine reference to be invoked when the task fails (or fails for the last time, if retries were specified). The reason could be passed to this callback as an argument. This callback won't be called after a failure if more retries are still possible.

- •

  on\_retry

  A subroutine reference to be invoked when the task fails, but is about to be retried.

  Is passed one argument, what retry attempt number this is.  (starts with 1)

- •

  on\_status

  A subroutine reference to be invoked if the task emits status updates. Arguments passed to the subref are ($numerator, `$denominator`), where those are left up to the client and job to determine.

- •

  on\_warning

  A subroutine reference to be invoked if the task emits status updates. Arguments passed to the subref are ($numerator, `$denominator`), where those are left up to the client and job to determine.

- •

  retry\_count

  Number of times job will be retried if there are failures.  Defaults to 0.

- •

  high\_priority

  **the option high\_priority is deprecated**. Use `"priority => high"` instead. Boolean, whether this job should take priority over other jobs already enqueued.

- •

  priority

  valid value:

  - •

    high

  - •

    normal (defaul)

  - •

    low

- •

  timeout

  Automatically fail, calling your on\_fail callback, after this many seconds have elapsed without an on\_fail or on\_complete being called. Defaults to 0, which means never.  Bypasses any retry\_count remaining.

- •

  try\_timeout

  Automatically fail, calling your on\_retry callback (or on\_fail if out of retries), after this many seconds have elapsed. Defaults to 0, which means never.