1
.TH "GEARMAN_CLIENT_SET_WORKLOAD_FREE_FN" "3" "September 14, 2012" "0.38" "Gearmand"
3
gearman_client_set_workload_free_fn \- Gearmand Documentation, http://gearman.info/
5
.nr rst2man-indent-level 0
9
level \\n[rst2man-indent-level]
10
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
17
.\" .rstReportMargin pre:
19
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
20
. nr rst2man-indent-level +1
21
.\" .rstReportMargin post:
25
.\" indent \\n[an-margin]
26
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
27
.nr rst2man-indent-level -1
28
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
29
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
31
.\" Man page generated from reStructeredText.
35
#include <libgearman/gearman.h>
42
.B gearman_task_context_free_fn
46
.B int gearman_client_timeout(\fI\%gearman_client_st\fP\fI\ *client\fP)
50
.B void gearman_client_set_timeout(\fI\%gearman_client_st\fP\fI\ *client\fP, int\fI\ timeout\fP)
54
.B void *gearman_client_context(const \fI\%gearman_client_st\fP\fI\ *client\fP)
58
.B void gearman_client_set_context(\fI\%gearman_client_st\fP\fI\ *client\fP, void\fI\ *context\fP)
62
.B void gearman_client_set_workload_malloc_fn(\fI\%gearman_client_st\fP\fI\ *client\fP, gearman_malloc_fn\fI\ *function\fP, void\fI\ *context\fP)
65
Deprecated since version 0.23: Use \fBgearman_allocator_t\fP
68
.B void gearman_client_set_workload_free_fn(\fI\%gearman_client_st\fP\fI\ *client\fP, gearman_free_fn\fI\ *function\fP, void\fI\ *context\fP)
71
Deprecated since version 0.23: Use \fBgearman_allocator_t\fP
74
.B void gearman_client_task_free_all(\fI\%gearman_client_st\fP\fI\ *client\fP)
78
.B void gearman_client_set_task_context_free_fn(\fI\%gearman_client_st\fP\fI\ *client\fP, \fI\%gearman_task_context_free_fn\fP\fI\ *function\fP)
84
\fI\%gearman_client_st\fP is used for \fIclient\fP communication with the server.
86
\fI\%gearman_client_context()\fP and \fI\%gearman_client_set_context()\fP can be used to store an arbitrary object for the user.
88
\fI\%gearman_client_set_task_context_free_fn()\fP sets a trigger that will be called when a \fBgearman_task_st\fP is released.
90
\fI\%gearman_client_timeout()\fP and \fI\%gearman_client_set_timeout()\fP get and set the current timeout value, in milliseconds, for the client.
92
Normally \fImalloc(3)\fP and \fIfree(3)\fP are used for allocation and releasing workloads. \fI\%gearman_client_set_workload_malloc_fn()\fP and \fI\%gearman_client_set_workload_free_fn()\fP can be used to replace these with custom functions. (These have been deprecated, please see \fBgearman_allocator_t\fP for the updated interface.
94
\fI\%gearman_client_task_free_all()\fP is used to free all current \fBgearman_task_st\fP that have been created with the \fI\%gearman_client_st\fP.
96
By calling \fI\%gearman_client_task_free_all()\fP you can end up with a SEGFAULT if you try to use any \fBgearman_task_st\fP that you have kept pointers too.
100
\fI\%gearman_client_timeout()\fP returns an integer representing the amount of time in milliseconds. A value of \-1 means an infinite timeout value. See \fIpoll(3)\fP for more details.
103
To find out more information please check:
104
\fI\%http://gearman.info/\fP
107
\fIgearmand(8)\fP \fIlibgearman(3)\fP \fIgearman_client_create(3)\fP
110
Data Differential http://www.datadifferential.com/
112
2012, Data Differential, http://www.datadifferential.com/
113
.\" Generated by docutils manpage writer.