php8.5
Home/ Manual/ reference / gearman/ The GearmanClient class

The GearmanClient class

Represents a class for connecting to a Gearman job server and making requests to perform some function on provided data. The function performed must be one registered by a Gearman worker and the data passed is opaque to the job server.

Intro

Represents a class for connecting to a Gearman job server and making requests to perform some function on provided data. The function performed must be one registered by a Gearman worker and the data passed is opaque to the job server.

Class synopsis

class GearmanClient { }

Gearmanclient

In this section

GearmanClient::__construct

Create a GearmanClient instance

GearmanClient::addOptions

Add client options

GearmanClient::addServer

Add a job server to the client

GearmanClient::addServers

Add a list of job servers to the client

GearmanClient::addTask

Add a task to be run in parallel

GearmanClient::addTaskBackground

Add a background task to be run in parallel

GearmanClient::addTaskHigh

Add a high priority task to run in parallel

GearmanClient::addTaskHighBackground

Add a high priority background task to be run in parallel

GearmanClient::addTaskLow

Add a low priority task to run in parallel

GearmanClient::addTaskLowBackground

Add a low priority background task to be run in parallel

GearmanClient::addTaskStatus

Add a task to get status

GearmanClient::clearCallbacks

Clear all task callback functions

GearmanClient::clone

Create a copy of a GearmanClient object

GearmanClient::context

Get the application context

GearmanClient::data

Get the application data (deprecated)

GearmanClient::do

Run a single task and return a result [deprecated]

GearmanClient::doBackground

Run a task in the background

GearmanClient::doHigh

Run a single high priority task

GearmanClient::doHighBackground

Run a high priority task in the background

GearmanClient::doJobHandle

Get the job handle for the running task

GearmanClient::doLow

Run a single low priority task

GearmanClient::doLowBackground

Run a low priority task in the background

GearmanClient::doNormal

Run a single task and return a result

GearmanClient::doStatus

Get the status for the running task

GearmanClient::echo

Send data to all job servers to see if they echo it back [deprecated]

GearmanClient::error

Returns an error string for the last error encountered

GearmanClient::getErrno

Get an errno value

GearmanClient::jobStatus

Get the status of a background job

GearmanClient::ping

Send data to all job servers to see if they echo it back

GearmanClient::removeOptions

Remove client options

GearmanClient::returnCode

Get the last Gearman return code

GearmanClient::runTasks

Run a list of tasks in parallel

GearmanClient::setClientCallback

Callback function when there is a data packet for a task (deprecated)

GearmanClient::setCompleteCallback

Set a function to be called on task completion

GearmanClient::setContext

Set application context

GearmanClient::setCreatedCallback

Set a callback for when a task is queued

GearmanClient::setData

Set application data (deprecated)

GearmanClient::setDataCallback

Callback function when there is a data packet for a task

GearmanClient::setExceptionCallback

Set a callback for worker exceptions

GearmanClient::setFailCallback

Set callback for job failure

GearmanClient::setOptions

Set client options

GearmanClient::setStatusCallback

Set a callback for collecting task status

GearmanClient::setTimeout

Set socket I/O activity timeout

GearmanClient::setWarningCallback

Set a callback for worker warnings

GearmanClient::setWorkloadCallback

Set a callback for accepting incremental data updates

GearmanClient::timeout

Get current socket I/O activity timeout value

GearmanClient::wait

Wait for I/O activity on all connections in a client

Source: reference/gearman/gearmanclient.xml · from the official PHP manual (php/doc-en)