GEARMAN_FAILED(3)

💖 NAME 💖

okay so bestie, this one is gearman_failed — part of the GEARMAN_FAILED(3) manual page, aka the Gearmand Documentation, which lives over at http://gearman.info/ 🦋

---

✨ SYNOPSIS ✨

#include <libgearman/gearman.h>

type gearman_return_t

const char *gearman_strerror(gearman_return_t rc)

bool gearman_success(gearman_return_t rc)

bool gearman_failed(gearman_return_t rc)

bool gearman_continue(gearman_return_t rc)

and when you build, you compile and link with -lgearman 🫶 (do not forget the link flag, she will not link herself)

---

🌸 DESCRIPTION 🌸

gearman_return_t is the return/error type for literal every single call you make with gearman_client_st and gearman_worker_st. When things go right you get GEARMAN_SUCCESS back, and when they don't, you get an error instead. 😭

• gearman_failed() — use this to see if the return value is a failing value, i.e. it's giving "something went wrong".
• gearman_strerror() — use this to print a text version of the error message, so you actually know what happened instead of just vibing with a mystery number.

Then the vibe check trio, fr fr:

• gearman_success() returns true if GEARMAN_SUCCESS, or if GEARMAN_NO_PENDING_TASKS tests true. ✅
• gearman_failed() returns true if any value other than GEARMAN_SUCCESS was provided. 💀
• gearman_continue() returns true if any error related to non-blocking IO occurred. This one is the one you use for testing loops — no cap, that's literally its whole job.

🎀 Possible values of gearman_return_t: 🎀

• GEARMAN_SUCCESS — success, the moment we all live for ✨
• GEARMAN_NO_PENDING_TASKS — gearman_client_run_tasks() was called and it has completed all tasks assigned to the client. she's done, she's finished, periodt 💅
• GEARMAN_IO_WAIT — blocking IO was found. gearman_continue() can be used to test for this. 👀
• GEARMAN_ERRNO — a system error occurred. Use either gearman_client_errno() or gearman_worker_errno(). 🔥
• GEARMAN_NO_ACTIVE_FDS — no active connections were available. gearman_continue() can be used to test for this. 🫠
• GEARMAN_GETADDRINFO — name resolution failed for a host. 😵
• GEARMAN_NO_SERVERS — no servers have been provided for the client/worker. she's alone in the group chat 😭
• GEARMAN_LOST_CONNECTION — connection was lost to the given server. it's giving ghosted 👻
• GEARMAN_MEMORY_ALLOCATION_FAILURE — memory allocation failed. 💀
• GEARMAN_SERVER_ERROR — an error occurred on the server.
• GEARMAN_NOT_CONNECTED — client/worker is not currently connected to the server.
• GEARMAN_COULD_NOT_CONNECT — server name was valid, but a connection could not be made. so close yet so far 🌧️
• GEARMAN_ECHO_DATA_CORRUPTION — either gearman_client_echo() or gearman_worker_echo() echo was unsuccessful because the data was returned from gearmand corrupted. 🚩
• GEARMAN_UNKNOWN_STATE — the gearman_return_t was never set. mystery era 🙈
• GEARMAN_FLUSH_DATA — internal state, should never be seen by either client or worker. do not perceive her 🫣
• GEARMAN_SEND_BUFFER_TOO_SMALL — send buffer was too small.
• GEARMAN_TIMEOUT — a timeout occurred when making a request to the server. ⏰
• GEARMAN_ARGUMENT_TOO_LARGE — argument was too large for the current buffer.
• GEARMAN_INVALID_ARGUMENT — one of the arguments to the given API call was invalid. EINVAL will be set if gearman_client_error() or gearman_worker_error() were not settable. This can also be returned if GEARMAN_CLIENT_UNBUFFERED_RESULT was set, but the client is not handling the data correctly. 🚨

👑 CLIENT ONLY 👑

• GEARMAN_NEED_WORKLOAD_FN — a client was asked for work, but no gearman_workload_fn callback was specified. See gearman_client_set_workload_fn(). 🙈
• GEARMAN_WORK_FAIL — a task has failed, and the worker has exited with an error or it called gearman_job_send_fail(). 💔
• GEARMAN_IN_PROGRESS — gearman_client_job_status() has been called for a gearman_job_handle_t and the Job is currently being run by a worker. she's busy bestie 🏃♀️
• GEARMAN_JOB_EXISTS — gearman_client_job_status() has been called for a gearman_job_handle_t and the Job is currently known by a server, but is not being run by a worker.

🧚 WORKER ONLY 🧚

• GEARMAN_INVALID_FUNCTION_NAME — a worker was sent a request for a job that it did not have a valid function for. wrong number energy 📵
• GEARMAN_INVALID_WORKER_FUNCTION — no callback was provided by the worker for a given function.
• GEARMAN_NO_REGISTERED_FUNCTION — a request for removing a given function from a worker was invalid since that function did not exist.
• GEARMAN_NO_REGISTERED_FUNCTIONS — the worker has not registered any functions. not one. zero. nada. 😶
• GEARMAN_NO_JOBS — no jobs were found for the worker. This error code is only returned if the worker has just made a request for jobs. ⭐

💅 WORKER TO CLIENT 💅

Clients which have registered a custom gearman_actions_t may use these values as return values to the calling client. iykyk 🎀

• GEARMAN_WORK_DATA — worker has sent a chunked piece of data to the client via gearman_job_send_data(). 📦
• GEARMAN_WORK_WARNING — worker has issued a warning to the client via gearman_job_send_warning(). ⚠️
• GEARMAN_WORK_STATUS — status has been updated by the worker via gearman_job_send_status(). 📊
• GEARMAN_WORK_EXCEPTION — worker has sent an exception the client via gearman_job_send_exception(). 😱
• GEARMAN_WORK_FAIL — a task has failed, and the worker has exited with an error or it called gearman_job_send_fail(). 💔
• GEARMAN_WORK_ERROR — a task has had an error and will be retried. 🔁
• GEARMAN_PAUSE — used only in custom application for client return based on GEARMAN_WORK_DATA, GEARMAN_WORK_WARNING, GEARMAN_WORK_EXCEPTION, GEARMAN_WORK_FAIL, or GEARMAN_WORK_STATUS. gearman_continue() can be used to check for this value. ⏸️

💅 WORKER TO CLIENT 💅 (yes, again, she said it twice 💀)

Any function defined by gearman_worker_define_function() may, and can only, return the following gearman_return_t values. that's the whole menu, no substitutions 🍽️

• GEARMAN_SUCCESS — the function successfully completed the job. slay ✨
• GEARMAN_FATAL — (no description given, she's just standing there 🧍)
• GEARMAN_FAIL — the function failed to complete the job. GEARMAN_FATAL is the deprecated name for GEARMAN_FAIL. 💀
• GEARMAN_ERROR — a task has had an error and will be retried. 🔁
• GEARMAN_SHUTDOWN — GEARMAN_SHUTDOWN is a special case. If it is returned the client will be sent GEARMAN_SUCCESS, but gearman_worker_work() will exit with GEARMAN_SHUTDOWN. plot twist 🎭

🍓 TASK ONLY 🍓

• GEARMAN_NOT_FLUSHING — gearman_task_send_workload() failed, it was not in the correct state. 🚫
• GEARMAN_DATA_TOO_LARGE — gearman_task_send_workload() failed, the data was too large to be sent. 🐘
• GEARMAN_UNKNOWN_OPTION — default state of task return value.

🌈 PROTOCOL 🌈

bestie listen. If any of these errors occurred, the connection will be dropped/reset. no negotiating. 💥

• GEARMAN_INVALID_MAGIC
• GEARMAN_INVALID_COMMAND
• GEARMAN_INVALID_PACKET
• GEARMAN_UNEXPECTED_PACKET
• GEARMAN_TOO_MANY_ARGS

🌧️ DEPRECATED 🌧️

• GEARMAN_IGNORE_PACKET
• GEARMAN_MAX_RETURN

---

⭐ SEE ALSO ⭐

gearmand(8) · libgearman(3) · gearman_client_error() or gearman_worker_error() 🌈

---

👑 Author 👑

Data Differential — http://www.datadifferential.com/

💜 Copyright 💜

2011-2014, Data Differential, http://www.datadifferential.com/

---

and that's the whole page bestie, you ate 💅 mwah 🫶

this was version 1.1.21+ds, dated Feb 04, 2026 — love that for us, see u next time ✨🎀