Libgearman

libgearman is a small, thread-safe client library for the gearman protocol. The code has all been written with an eye to allow for both web and embedded usage. It handles the work behind routing particular keys to specific servers that you specify. By default jobs go to the first idle server in the order you added them; a client can opt into routing by the job’s unique instead, see gearman_client_set_server_selection_by_unique(). It implements both the client and worker interfaces.

Getting Started

• Worker Basics

Examples

• libgearman examples

Client Functions

• Creating a Gearman Client Connections
• Adding Servers
• Setting Options
• Selecting a Server by Job Unique
• Issuing a single request
• Issuing a single background task
• Executing Work
• Errors reported to the client
• Logging Workers
• Retrieving the status of a job

Creating Tasks

• Creating tasks
• Running tasks
• Creating background tasks
• Adding a task to monitor a previously created task

Worker Functions

• Creating Gearman Worker Connections
• Adding Servers
• Worker Options
• Create a function with a callback
• Creating workers with gearman_worker_define_function()
• Errors returned to the worker
• Logging Clients and Workers
• Setting a worker’s identifier

Misc

• Misc libgearman Functions
  • Parsing server lists
  • gearman_bugreport()
  • gearman_version()
• Using namespaces
• Sleeping until client is has I/O.
• Testing Clients and Workers

Structures

• Client (gearman_client_st)
• Job (gearman_job_st)
• Task (gearman_task_st)
• Worker (gearman_worker_st)
• Job handle (gearman_job_handle_t)
• Arguments (gearman_argument_t)
• Strings (gearman_string_t)
• Arguments (gearman_result_st)
• Describing Workload (gearman_work_t)

Types

• Defining custom allocators (gearman_allocator_t)
• Error Codes (gearman_return_t)
• Client callbacks (gearman_actions_t)
• Logging callback (gearman_log_fn)
• Verbose levels for logs (gearman_verbose_t)

Extra

• List of client/worker errors
  • GEARMAN_SUCCESS
  • GEARMAN_IO_WAIT
  • GEARMAN_SHUTDOWN
  • GEARMAN_SHUTDOWN_GRACEFUL
  • GEARMAN_ERRNO
  • GEARMAN_EVENT
  • GEARMAN_TOO_MANY_ARGS
  • GEARMAN_NO_ACTIVE_FDS
  • GEARMAN_INVALID_MAGIC
  • GEARMAN_INVALID_COMMAND
  • GEARMAN_INVALID_PACKET
  • GEARMAN_UNEXPECTED_PACKET
  • GEARMAN_GETADDRINFO
  • GEARMAN_NO_SERVERS
  • GEARMAN_LOST_CONNECTION
  • GEARMAN_MEMORY_ALLOCATION_FAILURE
  • GEARMAN_JOB_EXISTS
  • GEARMAN_JOB_QUEUE_FULL
  • GEARMAN_SERVER_ERROR
  • GEARMAN_WORK_ERROR
  • GEARMAN_WORK_DATA
  • GEARMAN_WORK_WARNING
  • GEARMAN_WORK_STATUS
  • GEARMAN_WORK_EXCEPTION
  • GEARMAN_WORK_FAIL
  • GEARMAN_NOT_CONNECTED
  • GEARMAN_COULD_NOT_CONNECT
  • GEARMAN_SEND_IN_PROGRESS
  • GEARMAN_RECV_IN_PROGRESS
  • GEARMAN_NOT_FLUSHING
  • GEARMAN_DATA_TOO_LARGE
  • GEARMAN_INVALID_FUNCTION_NAME
  • GEARMAN_INVALID_WORKER_FUNCTION
  • GEARMAN_NO_REGISTERED_FUNCTION
  • GEARMAN_NO_REGISTERED_FUNCTIONS
  • GEARMAN_NO_JOBS
  • GEARMAN_ECHO_DATA_CORRUPTION
  • GEARMAN_NEED_WORKLOAD_FN
  • GEARMAN_PAUSE
  • GEARMAN_UNKNOWN_STATE
  • GEARMAN_PTHREAD
  • GEARMAN_PIPE_EOF
  • GEARMAN_QUEUE_ERROR
  • GEARMAN_FLUSH_DATA
  • GEARMAN_SEND_BUFFER_TOO_SMALL
  • GEARMAN_IGNORE_PACKET
  • GEARMAN_UNKNOWN_OPTION
  • GEARMAN_TIMEOUT
  • GEARMAN_ARGUMENT_TOO_LARGE
  • GEARMAN_INVALID_ARGUMENT
  • GEARMAN_IN_PROGRESS
  • GEARMAN_FATAL
  • GEARMAN_FATAL
  • GEARMAN_ERROR
  • GEARMAN_MAX_RETURN
• Required C types