The GearmanClient class

(PECL gearman >= 0.5.0)

Introduction

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

GearmanClient {

/* Methods */

public bool addOptions ( int $options )

public bool addServer ([ string $host = 127.0.0.1 [, int $port = 4730 ]] )

public bool addServers ([ string $servers = 127.0.0.1:4730 ] )

public GearmanTask addTask ( string $function_name , string $workload [, mixed &$context [, string $unique ]] )

public GearmanTask addTaskBackground ( string $function_name , string $workload [, mixed &$context [, string $unique ]] )

public GearmanTask addTaskHigh ( string $function_name , string $workload [, mixed &$context [, string $unique ]] )

public GearmanTask addTaskHighBackground ( string $function_name , string $workload [, mixed &$context [, string $unique ]] )

public GearmanTask addTaskLow ( string $function_name , string $workload [, mixed &$context [, string $unique ]] )

public GearmanTask addTaskLowBackground ( string $function_name , string $workload [, mixed &$context [, string $unique ]] )

public GearmanTask addTaskStatus ( string $job_handle [, string &$context ] )

public bool clearCallbacks ( void )

public GearmanClient clone ( void )

public __construct ( void )

public string context ( void )

public string data ( void )

public string do ( string $function_name , string $workload [, string $unique ] )

public string doBackground ( string $function_name , string $workload [, string $unique ] )

public string doHigh ( string $function_name , string $workload [, string $unique ] )

public string doHighBackground ( string $function_name , string $workload [, string $unique ] )

public string doJobHandle ( void )

public string doLow ( string $function_name , string $workload [, string $unique ] )

public string doLowBackground ( string $function_name , string $workload [, string $unique ] )

public string doNormal ( string $function_name , string $workload [, string $unique ] )

public array doStatus ( void )

public bool echo ( string $workload )

public string error ( void )

public int getErrno ( void )

public array jobStatus ( string $job_handle )

public bool ping ( string $workload )

public bool removeOptions ( int $options )

public int returnCode ( void )

public bool runTasks ( void )

public void setClientCallback ( callable $callback )

public bool setCompleteCallback ( callable $callback )

public bool setContext ( string $context )

public bool setCreatedCallback ( string $callback )

public bool setData ( string $data )

public bool setDataCallback ( callable $callback )

public bool setExceptionCallback ( callable $callback )

public bool setFailCallback ( callable $callback )

public bool setOptions ( int $options )

public bool setStatusCallback ( callable $callback )

public bool setTimeout ( int $timeout )

public bool setWarningCallback ( callable $callback )

public bool setWorkloadCallback ( callable $callback )

public int timeout ( void )

}

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::__construct — Create a GearmanClient instance
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

User Contributed Notes

There are no user contributed notes for this page.

The GearmanClient class

Introduction

Class synopsis

Table of Contents

User Contributed Notes