← Back to branch summary

~brianaker/gearmand/gearmnan_job_use_client

« back to all changes in this revision

Viewing changes to docs/libgearman/gearman_job_st.rst

Fix missing man pages

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/libgearman/gearman_job_st.rst
36
36
 
37
37
.. c:function:: void *gearman_job_take_workload(gearman_job_st *job, size_t *data_size)
38
38
 
 
39
.. c:function:: gearman_client_st *gearman_job_use_client(gearman_job_st *job)
 
40
 
39
41
Link with -lgearman
40
42
 
41
43
-----------
54
56
 
55
57
:c:func:`gearman_job_unique` return the unique value that was used for :c:type:`gearman_job_st`. 
56
58
 
57
 
returns the :c:type:`gearman_job_st` workload. The size of it can be determined with :c:func:`gearman_job_workload_size`.
 
59
gearman_job_take_workload returns the :c:type:`gearman_job_st` workload. The size of it can be determined with :c:func:`gearman_job_workload_size`.
58
60
:c:func:`gearman_job_take_workload` is the same as :c:func:`gearman_job_workload` with the exception that the result must be
59
61
:manpage:`free(3)` by the caller.
60
62
 
 
63
gearman_job_use_client returns a :c:type:`gearman_client_st` configured from gearman_job_st. The gearman_client_st can be used to communicate client API commands to the server.
 
64
You do not, and should not, call :c:func:`gearman_client_free` on the gearman_client_st. It is cleaned up when job is cleaned up.
 
65
 
61
66
------------
62
67
RETURN VALUE
63
68
------------