Gearman
PHP Manual

The GearmanClient class

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 registerd by a Gearman worker and the data passed is opaque to the job server.

Class synopsis

GearmanClient
GearmanClient {
/* Methods */
public boolean addServer ([ string $host [, int $port ]] )
public boolean addServers ([ string $servers ] )
public GearmanTask addTask ( string $function_name , string $workload [, mixed &$data [, string $unique ]] )
public GearmanTask addTaskBackground ( string $function_name , string $workload [, mixed &$data [, string $unique ]] )
public GearmanTask addTaskHigh ( string $function_name , string $workload [, mixed &$data [, string $unique ]] )
public GearmanTask addTaskHighBackground ( string $function_name , string $workload [, mixed &$data [, string $unique ]] )
public GearmanTask addTaskLow ( string $function_name , string $workload [, mixed &$data [, string $unique ]] )
public GearmanTask addTaskLowBackground ( string $function_name , string $workload [, mixed &$data [, string $unique ]] )
public GearmanTask addTaskStatus ( string $job_handle [, string $data ] )
public boolean clearCallbacks ( void )
public GearmanClient clone ( void )
__construct ( 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 array doStatus ( void )
public boolean echo ( string $workload )
public void error ( void )
public integer getErrno ( void )
public array jobStatus ( string $job_handle )
public integer returnCode ( void )
public boolean runTasks ( void )
public void setClientCallback ( callback $callback )
public boolean setCompleteCallback ( callback $callback )
public boolean setCreatedCallback ( string $callback )
public boolean setData ( string $data )
public boolean setExceptionCallback ( callback $callback )
public boolean setFailCallback ( callback $callback )
public boolean setOptions ( integer $options , integer $data )
public boolean setStatusCallback ( callback $callback )
public boolean setWarningCallback ( callback $callback )
public boolean setWorkloadCallback ( callback $callback )
}

Table of Contents


Gearman
PHP Manual