GEARMAN_CLIENT_DO_LOW_BACKGROUND(3)

💖 GEARMAN_CLIENT_DO_LOW_BACKGROUND 💖

okay bestie, so this is a page from the Gearmand docs — like, libgearman, the C client library for Gearman? yeah. this particular man page lives in the Gearmand manual section and the official home base is <http://gearman.info/>. let's get into it, no cap. 🦋

---

✨ NAME ✨

gearman_client_do_low_background — Gearmand Documentation, <http://gearman.info/>

---

🌸 SYNOPSIS 🌸

first things first, you gotta pull in the header:

#include <libgearman/gearman.h>

also hi, there's a type you should know about:

type gearman_priority_t

and here are the three functions, in all their glory:

gearman_return_t gearman_client_do_background(gearman_client_st *client,
                                              const char *function_name,
                                              const char *unique,
                                              const void *workload,
                                              size_t workload_size,
                                              char *job_handle)

💅 Changed in version 0.21: GEARMAN_PAUSE will no longer be returned. A do operation will now run until it has been submitted.

gearman_return_t gearman_client_do_high_background(gearman_client_st *client,
                                                   const char *function_name,
                                                   const char *unique,
                                                   const void *workload,
                                                   size_t workload_size,
                                                   gearman_job_handle_t job_handle)

gearman_return_t gearman_client_do_low_background(gearman_client_st *client,
                                                  const char *function_name,
                                                  const char *unique,
                                                  const void *workload,
                                                  size_t workload_size,
                                                  gearman_job_handle_t job_handle)

---

💜 DESCRIPTION 💜

so here's the tea, bestie. 🍓 gearman_client_do_background() fires off a single request to the gearmand server, and it hands you back the status situation via gearman_return_t. that's the whole vibe.

now, gearman_client_add_task_high_background() and gearman_client_add_task_low_background() are identical to gearman_client_do_background() — literally twins — except they set the gearman_priority_t to either high or low. that's the only difference, iykyk. 👑

and about that job_handle, okay: if job_handle is not NULL, it gets populated with the name of the job_handle for the task that got created. important part 🚨 — the job handle needs to be the size of GEARMAN_JOB_HANDLE_SIZE. don't skimp on the buffer, she needs room to breathe. for more deets, go peek at gearman_job_handle_t. 💖

---

⭐ RETURN VALUE ⭐

gearman_return_t — that's what you're getting back, periodt.

---

🎀 EXAMPLE 🎀

here's a whole little program, copy it, love it, run it. note the Gearman server and library copyright header at the top of the file — that's part of the example, not the page's own copyright, and it says all rights reserved, use and distribution licensed under the BSD license, and to see the COPYING file in that directory for full text.

/*
# Gearman server and library
# Copyright (C) 2012 Data Differential, http://datadifferential.com/
# All rights reserved.
#
# Use and distribution licensed under the BSD license.  See
# the COPYING file in this directory for full text.
*/

#include <string.h>
#include <stdlib.h>
#include <stdio.h>
#include <libgearman-1.0/gearman.h>

int main(void)
{
  gearman_client_st *client= gearman_client_create(NULL);

  gearman_return_t ret= gearman_client_add_server(client, "localhost", 0);
  if (gearman_failed(ret))
  {
    return EXIT_FAILURE;
  }

  gearman_job_handle_t job_handle;
  gearman_return_t rc= gearman_client_do_background(client,
                                                    "reverse_function",
                                                    "unique_value",
                                                    "my string to reverse", strlen("my string to reverse"),
                                                    job_handle);

  if (gearman_success(rc))
  {
    // Make use of value
    printf("%s\n", job_handle);
  }

  gearman_client_free(client);

  return 0;
}

---

🏠 HOME 🏠

want more? obviously you do. go check out: <http://gearman.info/>

and the see-also squad, besties fr fr:

• gearmand(8)
• libgearman(3)
• gearman_strerror(3)

---

👑 Author

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

💜 Copyright

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

---

okay that's the whole page, you ate it, you understood it, you're basically a Gearman main character now. 🌈 this one's from Gearmand version 1.1.21+ds, dated Feb 04, 20 — sending you off with all the love, mwah. 💅✨🫶