libgearman man page

libgearman — Gearmand Documentation, http://gearman.info/

Synopsis

#include <libgearman/gearman.h>

Link -lgearman

Description

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 (and values are matched based on server order as supplied by you). It implements both the client and worker interfaces.

All operations are performed against either a client, ie gearman_client_st or worker, ie gearman_worker_st.

Client and Worker structures can either be dynamically allocated or statically allocated. They must then b initialized by gearman_client_create() or gearman_worker_create().

Functions have been written in order to encapsulate all structures in the library. It is recommended that you do not operate directly against the structure.

Nearly all functions return a gearman_return_t value. This value can be translated to a printable string with gearman_strerror().

gearman_client_st and gearman_worker_st structures are thread-safe, but each thread must contain its own structure (that is, if you want to share these among threads you must provide your own locking). No global variables are used in this library.

If you are working with GNU autotools you will want to add the following to your configure.ac to properly include libgearman in your application.

PKG_CHECK_MODULES(DEPS, libgearman >= 0.8.0) AC_SUBST(DEPS_CFLAGS) AC_SUBST(DEPS_LIBS)

Hope you enjoy it!

Constants

A number of constants have been provided for in the library.

GEARMAN_DEFAULT_TCP_PORT

The default port used by gearmand(3).

GEARMAN_DEFAULT_TCP_PORT

The default service used by gearmand(3).

LIBGEARMAN_VERSION_STRING

String value of the libgearman version such as "0.20.4"

LIBGEARMAN_VERSION_HEX

Hex value of the version number. "0x00048000" This can be used for comparing versions based on number.

GEARMAN_UNIQUE_SIZE

Largest number of characters that can be used for a unique value.

GEARMAN_JOB_HANDLE_SIZE

Largest number of characters that can will be used for a job handle. Please see gearman_job_handle_t for additional information.

Threads and Processes

When using threads or forked processes it is important to keep an instance of gearman_client_st or gearman_worker_st per process or thread. Without creating your own locking structures you can not share a single gearman_client_st or gearman_worker_st.

Home

To find out more information please check: https://launchpad.net/libgearman <https://launchpad.net/gearmand>

See Also

gearmand(8) libgearman_examples(3)

Author

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

Referenced By

gearadmin(1), gearman(1), gearman_actions_t(3), gearman_allocator_t(3), gearman_argument_make(3), gearman_argument_t(3), gearman_bugreport(3), gearman_client_add_options(3), gearman_client_add_server(3), gearman_client_add_servers(3), gearman_client_add_task(3), gearman_client_add_task_background(3), gearman_client_add_task_high(3), gearman_client_add_task_high_background(3), gearman_client_add_task_low(3), gearman_client_add_task_low_background(3), gearman_client_add_task_status(3), gearman_client_clear_fn(3), gearman_client_clone(3), gearman_client_context(3), gearman_client_create(3), gearman_client_do(3), gearman_client_do_background(3), gearman_client_do_high(3), gearman_client_do_high_background(3), gearman_client_do_job_handle(3), gearman_client_do_low(3), gearman_client_do_low_background(3), gearman_client_do_status(3), gearman_client_echo(3), gearman_client_errno(3), gearman_client_error(3), gearman_client_free(3), gearman_client_has_option(3), gearman_client_job_status(3), gearman_client_options(3), gearman_client_options_t(3), gearman_client_remove_options(3), gearman_client_remove_servers(3), gearman_client_run_tasks(3), gearman_client_set_complete_fn(3), gearman_client_set_context(3), gearman_client_set_created_fn(3), gearman_client_set_data_fn(3), gearman_client_set_exception_fn(3), gearman_client_set_fail_fn(3), gearman_client_set_log_fn(3), gearman_client_set_memory_allocators(3), gearman_client_set_namespace(3), gearman_client_set_options(3), gearman_client_set_status_fn(3), gearman_client_set_task_context_free_fn(3), gearman_client_set_timeout(3), gearman_client_set_warning_fn(3), gearman_client_set_workload_fn(3), gearman_client_set_workload_free_fn(3), gearman_client_set_workload_malloc_fn(3), gearman_client_st(3), gearman_client_task_free_all(3), gearman_client_timeout(3), gearman_client_wait(3), gearman_continue(3), gearman_execute(3), gearman_failed(3), gearman_job_free(3), gearman_job_free_all(3), gearman_job_function_name(3), gearman_job_handle(3), gearman_job_handle_t(3), gearman_job_send_complete(3), gearman_job_send_data(3), gearman_job_send_exception(3), gearman_job_send_fail(3), gearman_job_send_status(3), gearman_job_send_warning(3), gearman_job_st(3), gearman_job_take_workload(3), gearman_job_unique(3), gearman_job_use_client(3), gearman_job_workload(3), gearman_job_workload_size(3), gearman_log_fn(3), gearman_parse_servers(3), gearman_result_boolean(3), gearman_result_integer(3), gearman_result_is_null(3), gearman_result_size(3), gearman_result_store_integer(3), gearman_result_store_string(3), gearman_result_store_value(3), gearman_result_string(3), gearman_return_t(3), gearman_strerror(3), gearman_string_t(3), gearman_success(3), gearman_task_attr_init(3), gearman_task_attr_init_background(3), gearman_task_attr_init_epoch(3), gearman_task_attr_t(3), gearman_task_context(3), gearman_task_data(3), gearman_task_data_size(3), gearman_task_denominator(3), gearman_task_error(3), gearman_task_free(3), gearman_task_function_name(3), gearman_task_give_workload(3), gearman_task_is_known(3), gearman_task_is_running(3), gearman_task_job_handle(3), gearman_task_numerator(3), gearman_task_recv_data(3), gearman_task_return(3), gearman_task_send_workload(3), gearman_task_set_context(3), gearman_task_st(3), gearman_task_take_data(3), gearman_task_unique(3), gearman_verbose_name(3), gearman_verbose_t(3), gearman_version(3), gearman_worker_add_function(3), gearman_worker_add_options(3), gearman_worker_clone(3), gearman_worker_context(3), gearman_worker_create(3), gearman_worker_define_function(3), gearman_worker_echo(3), gearman_worker_errno(3), gearman_worker_error(3), gearman_worker_free(3), gearman_worker_function_exist(3), gearman_worker_grab_job(3), gearman_worker_options(3), gearman_worker_register(3), gearman_worker_remove_options(3), gearman_worker_set_context(3), gearman_worker_set_log_fn(3), gearman_worker_set_memory_allocators(3), gearman_worker_set_namespace(3), gearman_worker_set_options(3), gearman_worker_set_timeout(3), gearman_worker_set_workload_free_fn(3), gearman_worker_set_workload_malloc_fn(3), gearman_worker_st(3), gearman_worker_timeout(3), gearman_worker_unregister(3), gearman_worker_unregister_all(3), gearman_worker_wait(3), gearman_worker_work(3).

February 11, 2014 1.1.12 Gearmand