La classe GearmanClient

(PECL gearman >= 0.5.0)

Introduction

Représente une classe pour se connecter à un serveur de tâches Gearman et lui soumettre des requêtes pour appliquer des fonctions sur les données fournies. La fonction appliquée doit faire partie de celles référencées par un agent Gearman et les données traitées restent opaques du point de vue du serveur de tâches.

Synopsis de la classe

class GearmanClient {

/* Méthodes */

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

}

Sommaire

GearmanClient::addOptions — Ajoute des options au client
GearmanClient::addServer — Ajoute un serveur de tâches au client
GearmanClient::addServers — Ajoute une liste de serveurs de tâches au client
GearmanClient::addTask — Ajoute une tâche à exécuter en parallèle
GearmanClient::addTaskBackground — Ajoute une tâche d'arrière-plan pour une exécution en parallèle
GearmanClient::addTaskHigh — Ajoute une tâche de forte priorité à effectuer en parallèle
GearmanClient::addTaskHighBackground — Ajoute une tâche de fond de forte priorité à effectuer en parallèle
GearmanClient::addTaskLow — Ajoute une tâche de faible priorité à effectuer en parallèle
GearmanClient::addTaskLowBackground — Ajoute une tâche de fond de faible priorité à effectuer en parallèle
GearmanClient::addTaskStatus — Ajoute une tâche pour obtenir le statut
GearmanClient::clearCallbacks — Efface toutes les fonctions de rappel des tâches
GearmanClient::clone — Crée une copie de l'objet GearmanClient
GearmanClient::__construct — Crée une instance GearmanClient
GearmanClient::context — Récupère le contexte de l'application
GearmanClient::data — Récupère les données de l'application (obsolète)
GearmanClient::do — Exécute une seule tâche et retourne le résultat (obsolète)
GearmanClient::doBackground — Exécute une tâche en arrière-plan
GearmanClient::doHigh — Exécute une seule tâche en priorité haute
GearmanClient::doHighBackground — Exécute une tâche en priorité haute en arrière plan
GearmanClient::doJobHandle — Récupère le gestionnaire de travaux pour la tâche en cours
GearmanClient::doLow — Exécute une seule tâche en priorité basse
GearmanClient::doLowBackground — Exécute une tâche en priorité basse en arrière-plan
GearmanClient::doNormal — Exécute une tâche et retourne le résultat
GearmanClient::doStatus — Récupère le statut de la tâche en cours
GearmanClient::echo — Envoie des données à tous les serveurs de travaux afin de vérifier qu'ils les affichent en retour (obsolète)
GearmanClient::error — Retourne la dernière erreur rencontrée sous forme de chaîne de caractères
GearmanClient::getErrno — Récupère la valeur d'errno
GearmanClient::jobStatus — Récupère le statut d'un travail en arrière-plan
GearmanClient::ping — Envoie des données à tous les serveurs de tâches pour s'assurer qu'ils sont toujours en fonctionnement
GearmanClient::removeOptions — Supprime les options du client
GearmanClient::returnCode — Récupère le dernier code Gearman retourné
GearmanClient::runTasks — Exécute une liste de tâches en parallèle
GearmanClient::setClientCallback — Définit une fonction de rappel lorsqu'un paquet de données est reçu pour une tâche (obsolète)
GearmanClient::setCompleteCallback — Définit une fonction à appeler une fois la tâche terminée
GearmanClient::setContext — Définit le contexte d'une application
GearmanClient::setCreatedCallback — Définit une fonction de rappel à appeler lorsqu'une tâche est placée dans la file d'attente
GearmanClient::setData — Définit les données de l'application (obsolète)
GearmanClient::setDataCallback — Définit une fonction de rappel à appeler lorsqu'un paquet de données est reçu pour une tâche
GearmanClient::setExceptionCallback — Définit une fonction de rappel pour les exceptions émises par l'agent
GearmanClient::setFailCallback — Définit une fonction de rappel à appeler lorsqu'un travail échoue
GearmanClient::setOptions — Définit les options du client
GearmanClient::setStatusCallback — Définit une fonction de rappel pour collecter les statuts d'une tâche
GearmanClient::setTimeout — Définit le délai d'attente d'une activité du socket I/O
GearmanClient::setWarningCallback — Définit une fonction de rappel lors de l'émission d'alerte depuis l'agent
GearmanClient::setWorkloadCallback — Définit une fonction de rappel lors de la réception de mises à jour de données incrémentales
GearmanClient::timeout — Récupère la valeur du délai d'activité du socket I/O
GearmanClient::wait — Attend l'activité d'E/S sur toutes les connexions d'un client