gearman_client_create(3)

gearman_client_create3

Gearmand documentation, https://gearman.org/gearmand/

Usage

#include <libgearman/gearman.h>

gearman_client_st *gearman_client_create(gearman_client_st *client)
gearman_client_st *gearman_client_clone(gearman_client_st *client, const gearman_client_st *from)
void gearman_client_free(gearman_client_st *client)

Link with -lgearman

Overview

gearman_client_create() is used to create a c:type:gearman_client_st structure that will then be used by other libgearman client functions to communicate with the server. You should either pass a statically declared gearman_client_st to gearman_client_create() or a NULL. If a NULL passed in then a structure is allocated for you.

gearman_client_clone() is similar to gearman_client_create() but it copies the defaults and list of servers from the source gearman_client_st . If you pass a null as the argument for the source to clone, it is the same as a call to gearman_client_create. If the destination argument is NULL a gearman_client_st will be allocated for you.

To clean up memory associated with a gearman_client_st structure you should pass it to gearman_client_free when you are finished using it. gearman_client_free() is the only way to make sure all memory is deallocated when you finish using the structure.

WARNING:

You may wish to avoid using gearman_client_create() or gearman_client_clone() with a stack based allocation, ie the first parameter. The most common issues related to ABI safety involve stack allocated structures.

Return value

gearman_client_create returns a pointer to the gearman_client_st that was created (or initialized). On an allocation failure, it returns NULL.

gearman_client_clone returns a pointer to the gearman_client_st that was created (or initialized). On an allocation failure, it returns NULL.

Home

To find out more information please check: https://gearman.org/gearmand/

SEE ALSO:

Releases

9 releases since Debian 6.0 (Squeeze); the text changed 7 times.

  1. 6.0
  2. 7
  3. 8–9
  4. 10
  5. 11
  6. 12
  7. 13
  8. Arch

Author

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

From gearmand 2.2.0-1 in Arch Linux 2026-11-01. Parsed by carta from the page's man source.