Predefined Constants
The constants below are defined by this extension, and will only be available when the extension has either been compiled into PHP or dynamically loaded at runtime.
Return values. Always check GearmanClient::error() or GearmanWorker() for a string error, as it may contain more details:
-
GEARMAN_SUCCESS
(integer) - Whatever action was taken was successful.
-
GEARMAN_IO_WAIT
(integer) - When in non-blocking mode, an event is hit that would have blocked.
-
GEARMAN_ERRNO
(integer) - A system error. Check GearmanClient::errno() or GearmanWorker::errno() for the system error code that was returned.
-
GEARMAN_NO_ACTIVE_FDS
(integer) - GearmanClient::wait() or GearmanWorker() was called with no connections.
-
GEARMAN_UNEXPECTED_PACKET
(integer) - Indicates something going very wrong in gearmand. Applies only to GearmanWorker.
-
GEARMAN_GETADDRINFO
(integer) - DNS resolution failed (invalid host, port, etc).
-
GEARMAN_NO_SERVERS
(integer) - Did not call GearmanClient::addServer() before submitting jobs or tasks.
-
GEARMAN_LOST_CONNECTION
(integer) - Lost a connection during a request.
-
GEARMAN_MEMORY_ALLOCATION_FAILURE
(integer) - Memory allocation failed (ran out of memory).
-
GEARMAN_SERVER_ERROR
(integer) - Something went wrong in the Gearman server and it could not handle the request gracefully.
-
GEARMAN_WORK_DATA
(integer) - Notice return code obtained with GearmanClient::returnCode() when using GearmanClient::do(). Sent to update the client with data from a running job. A worker uses this when it needs to send updates, send partial results, or flush data during long running jobs.
-
GEARMAN_WORK_WARNING
(integer) -
Notice return code obtained with GearmanClient::returnCode()
when using GearmanClient::do(). Updates the client with
a warning. The behavior is just like
GEARMAN_WORK_DATA
, but should be treated as a warning instead of normal response data. -
GEARMAN_WORK_STATUS
(integer) - Notice return code obtained with GearmanClient::returnCode() when using GearmanClient::do(). Sent to update the status of a long running job. Use GearmanClient::doStatus() to obtain the percentage complete of the task.
-
GEARMAN_WORK_EXCEPTION
(integer) - Notice return code obtained with GearmanClient::returnCode() when using GearmanClient::do(). Indicates that a job failed with a given exception.
-
GEARMAN_WORK_FAIL
(integer) - Notice return code obtained with GearmanClient::returnCode() when using GearmanClient::do(). Indicates that the job failed.
-
GEARMAN_COULD_NOT_CONNECT
(integer) - Failed to connect to servers.
-
GEARMAN_INVALID_FUNCTION_NAME
(integer) - Trying to register a function name of NULL or using the callback interface without specifying callbacks.
-
GEARMAN_INVALID_WORKER_FUNCTION
(integer) - Trying to register a function with a NULL callback function.
-
GEARMAN_NO_REGISTERED_FUNCTIONS
(integer) - When a worker gets a job for a function it did not register.
-
GEARMAN_NO_JOBS
(integer) - For a non-blocking worker, when GearmanWorker::work() does not have any active jobs.
-
GEARMAN_ECHO_DATA_CORRUPTION
(integer) - After GearmanClient::echo() or GearmanWorker::echo() the data returned doesn't match the data sent.
-
GEARMAN_NEED_WORKLOAD_FN
(integer) - When the client opted to stream the workload of a task, but did not specify a workload callback function.
-
GEARMAN_PAUSE
(integer) - For the non-blocking client task interface, can be returned from the task callback to "pause" the call and return from GearmanClient::runTasks(). Call GearmanClient::runTasks() again to continue.
-
GEARMAN_UNKNOWN_STATE
(integer) - Internal client/worker state error.
-
GEARMAN_SEND_BUFFER_TOO_SMALL
(integer) - Internal error: trying to flush more data in one atomic chunk than is possible due to hard-coded buffer sizes.
-
GEARMAN_TIMEOUT
(integer) - Hit the timeout limit set by the client/worker.
GearmanClient options:
-
GEARMAN_CLIENT_GENERATE_UNIQUE
(integer) - Generate a unique id (UUID) for each task.
-
GEARMAN_CLIENT_NON_BLOCKING
(integer) - Run the cient in a non-blocking mode.
-
GEARMAN_CLIENT_UNBUFFERED_RESULT
(integer) - Allow the client to read data in chunks rather than have the library buffer the entire data result and pass that back.
-
GEARMAN_CLIENT_FREE_TASKS
(integer) - Automatically free task objects once they are complete. This is the default setting in this extension to prevent memory leaks.
GearmanWorker options:
-
GEARMAN_WORKER_NON_BLOCKING
(integer) - Run the worker in non-blocking mode.
-
GEARMAN_WORKER_GRAB_UNIQ
(integer) - Return the client assigned unique ID in addition to the job handle.
Base Gearman configuration:
-
GEARMAN_DEFAULT_TCP_HOST
(string) -
GEARMAN_DEFAULT_TCP_PORT
(integer) -
GEARMAN_DEFAULT_SOCKET_TIMEOUT
(integer) -
GEARMAN_DEFAULT_SOCKET_SEND_SIZE
(integer) -
GEARMAN_DEFAULT_SOCKET_RECV_SIZE
(integer) -
GEARMAN_MAX_ERROR_SIZE
(integer) -
GEARMAN_PACKET_HEADER_SIZE
(integer) -
GEARMAN_JOB_HANDLE_SIZE
(integer) -
GEARMAN_OPTION_SIZE
(integer) -
GEARMAN_UNIQUE_SIZE
(integer) -
GEARMAN_MAX_COMMAND_ARGS
(integer) -
GEARMAN_ARGS_BUFFER_SIZE
(integer) -
GEARMAN_SEND_BUFFER_SIZE
(integer) -
GEARMAN_RECV_BUFFER_SIZE
(integer) -
GEARMAN_WORKER_WAIT_TIMEOUT
(integer)
English translation
You have asked to visit this site in English. For now, only the interface is translated, but not all the content yet.If you want to help me in translations, your contribution is welcome. All you need to do is register on the site, and send me a message asking me to add you to the group of translators, which will give you the opportunity to translate the pages you want. A link at the bottom of each translated page indicates that you are the translator, and has a link to your profile.
Thank you in advance.
Document created the 30/01/2003, last modified the 26/10/2018
Source of the printed document:https://www.gaudry.be/en/php-rf-gearman.constants.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.