GEARMAN_CLIENT_DO_LOW(3)

📦
version 1.1.21 · 8 versions
, in ubuntu resolute, ubuntu stonking

💖 GEARMAN_CLIENT_DO_LOW(3) 💖

okay bestie, gather round, because we're reading the Gearmand docs together and honestly? this one's a whole vibe. it lives in the Gearmand manual, section 3, and it's all about sending one job and waiting ever so patiently for the answer like the main character you are. ✨

🌸 NAME 🌸

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

🎀 SYNOPSIS 🎀

first up, you gotta invite the library in:

#include <libgearman/gearman.h>

then, the trio of icons 💅:

void *gearman_client_do(gearman_client_st <#c.gearman_client_st>
*client, const char *function_name, const char *unique, const void
*workload, size_t <#c.size_t> workload_size, size_t <#c.size_t>
*result_size, gearman_return_t <#c.gearman_return_t> *ret_ptr)

Changed in version 0.21: GEARMAN_PAUSE <#c.GEARMAN_PAUSE> will no longer be returned. A do operation will now run till completion or error. no take-backs, no pauses, it's giving commitment. 😤

void *gearman_client_do_high(gearman_client_st <#c.gearman_client_st>
*client, const char *function_name, const char *unique, const void
*workload, size_t <#c.size_t> workload_size, size_t <#c.size_t>
*result_size, gearman_return_t <#c.gearman_return_t> *ret_ptr)
void *gearman_client_do_low(gearman_client_st <#c.gearman_client_st>
*client, const char *function_name, const char *unique, const void
*workload, size_t <#c.size_t> workload_size, size_t <#c.size_t>
*result_size, gearman_return_t <#c.gearman_return_t> *ret_ptr)

🦋 DESCRIPTION 🦋

okay so gearman_client_do() executes a single request to the gearmand server and waits for a reply. one request, one reply, that's it, that's the whole plot. 🫶

gearman_client_do_high() and gearman_client_do_low() are identical to gearman_client_do() — like, twins fr fr — only they set the priority to either high or low. that's the entire difference. lowkey iconic.

and all of the functions will block until either a response or an error is returned. no multitasking, no sneaking off, they're locked in. 🔥

💜 RETURN VALUE 💜

gearman_client_do() returns a pointer to a value that the caller must release. (yes you, bestie, you gotta free it, don't leave it hanging 🙈)

if ret_ptr is provided, any errors that have occurred will be stored in it. and here's the plot twist: since a NULL/zero value is a valid value, you will always need to check ret_ptr if you are concerned with errors. like, a zero result is not an error, so don't come for it. 💀

⚠️ fr fr check ret_ptr — NULL/zero is legit output, not a red flag by itself.

🌈 EXAMPLE 🌈

look at this gorgeous little program, she's perfect, no notes:

/*
# 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 <libgearman/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;
  }

  size_t result_size;
  gearman_return_t rc;
  void *value= gearman_client_do(client, "reverse_function", "unique_value",
                                 "my string to reverse", strlen("my string to reverse"),
                                 &result_size, &rc);

  if (gearman_success(rc))
  {
    // Make use of value
  }
  free(value);

  gearman_client_free(client);

  return 0;
}

🏠 HOME 🏠

to find out more information please check: <http://gearman.info/>

see also, the whole friend group:

👑 Author 👑

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

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

and that's the page, bestie — this was libgearman version 1.1.21+ds, dated Feb 04, 2026, and honestly it ate. go forth and gearman_client_do_low() responsibly, mwah 💖🧚✨

📦 where this page comes from