La clase GearmanClient

(PECL gearman >= 0.5.0)

Introducción

Representa una clase para conectarse a un servidor de tareas Gearman y someterle peticiones para aplicar funciones sobre los datos proporcionados. La función aplicada debe formar parte de las referenciadas por un agente Gearman y los datos procesados permanecen opacos desde el punto de vista del servidor de tareas.

Sinopsis de la Clase

class GearmanClient {

/* Métodos */

public __construct()

public addOptions(int $option): bool

public addServer(string $host = null, int $port = 0, bool $setupExceptionHandler = true): bool

public addServers(string $servers = null, bool $setupExceptionHandler = true): bool

public addTask(
    string $function_name,
    string|int|float $workload,
    mixed $context = null,
    ?string $unique_key = null
): GearmanTask|false

public addTaskBackground(
    string $function_name,
    string|int|float $workload,
    mixed $context = null,
    ?string $unique_key = null
): GearmanTask|false

public addTaskHigh(
    string $function_name,
    string|int|float $workload,
    mixed $context = null,
    ?string $unique_key = null
): GearmanTask|false

public addTaskHighBackground(
    string $function_name,
    string|int|float $workload,
    mixed $context = null,
    ?string $unique_key = null
): GearmanTask|false

public addTaskLow(
    string $function_name,
    string|int|float $workload,
    mixed $context = null,
    ?string $unique_key = null
): GearmanTask|false

public addTaskLowBackground(
    string $function_name,
    string|int|float $workload,
    mixed $context = null,
    ?string $unique_key = null
): GearmanTask|false

public addTaskStatus(string $job_handle, mixed $context = null): GearmanTask|false

public clearCallbacks(): bool

public context(): string

public doBackground(string $function, string $workload, ?string $unique = null): string

public doHigh(string $function, string $workload, ?string $unique = null): string

public doHighBackground(string $function, string $workload, ?string $unique = null): string

public doJobHandle(): string

public doLow(string $function, string $workload, ?string $unique = null): string

public doLowBackground(string $function, string $workload, ?string $unique = null): string

public doNormal(string $function, string $workload, ?string $unique = null): string

public doStatus(): array

public error(): string|false

public getErrno(): int

public jobStatus(string $job_handle): array

public ping(string $workload): bool

public removeOptions(int $option): bool

public returnCode(): int

public runTasks(): bool

public setCompleteCallback(callable $callback): bool

public setContext(string $data): bool

public setCreatedCallback(callable $callback): bool

public setDataCallback(callable $callback): bool

public setExceptionCallback(callable $callback): bool

public setFailCallback(callable $callback): bool

public setOptions(int $option): bool

public setStatusCallback(callable $callback): bool

public setTimeout(int $timeout): bool

public setWarningCallback(callable $callback): bool

public setWorkloadCallback(callable $callback): bool

public timeout(): int

public wait(): bool

}

Tabla de contenidos

GearmanClient::addOptions — Añade opciones al cliente
GearmanClient::addServer — Añade un servidor de tareas al cliente
GearmanClient::addServers — Añade una lista de servidores de tareas al cliente
GearmanClient::addTask — Añade una tarea para ser ejecutada en paralelo
GearmanClient::addTaskBackground — Añade una tarea de fondo para su ejecución en paralelo
GearmanClient::addTaskHigh — Añade una tarea de alta prioridad para ser ejecutada en paralelo
GearmanClient::addTaskHighBackground — Añade una tarea de fondo de alta prioridad para ser ejecutada en paralelo
GearmanClient::addTaskLow — Añade una tarea de baja prioridad para ser ejecutada en paralelo
GearmanClient::addTaskLowBackground — Añade una tarea de fondo de baja prioridad para ser ejecutada en paralelo
GearmanClient::addTaskStatus — Añade una tarea para obtener el estado
GearmanClient::clearCallbacks — Elimina todas las funciones de retrollamada de las tareas
GearmanClient::clone — Crea una copia de un objeto GearmanClient
GearmanClient::__construct — Crea una instancia GearmanClient
GearmanClient::context — Recupera el contexto de la aplicación
GearmanClient::data — Retorna los datos de aplicación (obsoleto)
GearmanClient::do — Ejecuta una sola tarea y retorna el resultado [obsoleto]
GearmanClient::doBackground — Ejecuta una tarea en segundo plano
GearmanClient::doHigh — Ejecuta una sola tarea con prioridad alta
GearmanClient::doHighBackground — Ejecuta una tarea con prioridad alta en segundo plano
GearmanClient::doJobHandle — Obtiene el manejador de trabajos para la tarea en curso
GearmanClient::doLow — Ejecuta una sola tarea con prioridad baja
GearmanClient::doLowBackground — Ejecuta una tarea en prioridad baja en segundo plano
GearmanClient::doNormal — Ejecuta una tarea y devuelve el resultado
GearmanClient::doStatus — Recupera el estado de la tarea en curso
GearmanClient::echo — Envía datos a todos los servidores de trabajo para ver si retornan [obsoleto]
GearmanClient::error — Devuelve el último error encontrado en forma de string
GearmanClient::getErrno — Obtiene el valor de errno
GearmanClient::jobStatus — Recupera el estado de un trabajo en segundo plano
GearmanClient::ping — Envío de datos a todos los servidores de tareas para verificar que siguen en funcionamiento
GearmanClient::removeOptions — Elimina las opciones del cliente
GearmanClient::returnCode — Obtiene el último código Gearman devuelto
GearmanClient::runTasks — Ejecuta una lista de tareas en paralelo
GearmanClient::setClientCallback — Define una función de retrollamada cuando se recibe un paquete de datos para una tarea (obsoleto)
GearmanClient::setCompleteCallback — Define una función a llamar una vez finalizada la tarea
GearmanClient::setContext — Define el contexto de una aplicación
GearmanClient::setCreatedCallback — Define una función de retrollamada a llamar cuando una tarea es colocada en la cola
GearmanClient::setData — Establece los datos de aplicación (obsoleto)
GearmanClient::setDataCallback — Define una función de retrollamada a llamar cuando se recibe un paquete de datos para una tarea
GearmanClient::setExceptionCallback — Define una función de retrollamada para las excepciones emitidas por el agente
GearmanClient::setFailCallback — Define una función de retrollamada a llamar cuando un trabajo falla
GearmanClient::setOptions — Define las opciones del cliente
GearmanClient::setStatusCallback — Define una función de retorno para recolectar los estados de una tarea
GearmanClient::setTimeout — Establece el tiempo de espera de una actividad del socket I/O
GearmanClient::setWarningCallback — Define una función de retrollamada al emitir una alerta desde el agente
GearmanClient::setWorkloadCallback — Define una función de retrollamada al recibir actualizaciones de datos incrementales
GearmanClient::timeout — Obtiene el valor del tiempo de espera de actividad del socket I/O
GearmanClient::wait — Espera la actividad de E/S en todas las conexiones de un cliente