← Back to branch summary

~mordred/gearmand/cancel-job

« back to all changes in this revision

Viewing changes to docs/libgearman/gearman_client_do_background.rst

  • Committer: Brian Aker
  • Date: 2012-05-04 03:46:04 UTC
  • Revision ID: brian@tangent.org-20120504034604-5t22ae4v2o45zjkq
Update for libtest, documentation, and fix for root bzr dir.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/libgearman/gearman_client_do_background.rst
8
8
 
9
9
#include <libgearman/gearman.h>
10
10
 
11
 
.. c:function:: 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);
 
11
.. c:type:: gearman_priority_t
 
12
 
 
13
.. c:function:: 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)
12
14
 
13
15
.. versionchanged:: 0.21
14
16
   :c:type:`GEARMAN_PAUSE` will no longer be returned. A do operation will now run until it has been submitted.
15
17
 
16
 
.. c:function:: 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);
 
18
.. c:function:: 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)
17
19
 
18
 
.. c:function:: 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);
 
20
.. c:function:: 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)
19
21
 
20
22
-----------
21
23
DESCRIPTION
22
24
-----------
23
25
 
24
26
 
25
 
:c:func:`gearman_client_do_background()` executes a single request to the
 
27
:c:func:`gearman_client_do_background` executes a single request to the
26
28
gearmand server and returns the status via :c:type:`gearman_return_t`. 
27
29
 
28
 
:c:func:`gearman_client_do_background_high()` and
29
 
:c:func:`gearman_client_do_background_low()` are identical to
30
 
:c:func:`gearman_client_do_background()`, only they set the :c:type:`gearman_priority_t` to either
31
 
high or low. 
 
30
:c:func:`gearman_client_add_task_high_background` and :c:func:`gearman_client_add_task_low_background` are identical to
 
31
:c:func:`gearman_client_do_background`, only they set the :c:type:`gearman_priority_t` to either high or low. 
32
32
 
33
33
 
34
34
If job_handle is not NULL, it will be populated with the name of the job_handle