.\" Man page generated from reStructuredText.
.
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "GEARMAN_CLIENT_DO_JOB_HANDLE" "3" "Mar 29, 2024" "1.1.20+ds" "Gearmand"
.SH NAME
gearman_client_do_job_handle \- Gearmand Documentation, http://gearman.info/
.SH SYNOPSIS
.sp
#include <libgearman/gearman.h>
.INDENT 0.0
.TP
.B type gearman_client_st 
.UNINDENT
.INDENT 0.0
.TP
.B type gearman_task_context_free_fn 
.UNINDENT
.INDENT 0.0
.TP
.B int gearman_client_timeout(\fI\%gearman_client_st\fP *client) 
.UNINDENT
.INDENT 0.0
.TP
.B void gearman_client_set_timeout(\fI\%gearman_client_st\fP *client, int timeout) 
.UNINDENT
.INDENT 0.0
.TP
.B void *gearman_client_context(const \fI\%gearman_client_st\fP *client) 
.UNINDENT
.INDENT 0.0
.TP
.B void gearman_client_set_context(\fI\%gearman_client_st\fP *client, void *context) 
.UNINDENT
.INDENT 0.0
.TP
.B void gearman_client_set_workload_malloc_fn(\fI\%gearman_client_st\fP *client, \fI\%gearman_malloc_fn\fP *function, void *context) 
.UNINDENT
.sp
Deprecated since version 0.23: Use \fI\%gearman_allocator_t\fP

.INDENT 0.0
.TP
.B void gearman_client_set_workload_free_fn(\fI\%gearman_client_st\fP *client, \fI\%gearman_free_fn\fP *function, void *context) 
.UNINDENT
.sp
Deprecated since version 0.23: Use \fI\%gearman_allocator_t\fP

.INDENT 0.0
.TP
.B void gearman_client_task_free_all(\fI\%gearman_client_st\fP *client) 
.UNINDENT
.INDENT 0.0
.TP
.B void gearman_client_set_task_context_free_fn(\fI\%gearman_client_st\fP *client, \fI\%gearman_task_context_free_fn\fP *function) 
.UNINDENT
.sp
Link with \-lgearman
.SH DESCRIPTION
.sp
\fI\%gearman_client_st\fP is used for \fI\%client\fP communication with the server.
.sp
\fI\%gearman_client_context()\fP and \fI\%gearman_client_set_context()\fP can be used to store an arbitrary object for the user.
.sp
\fI\%gearman_client_set_task_context_free_fn()\fP sets a trigger that will be called when a \fI\%gearman_task_st\fP is released.
.sp
\fI\%gearman_client_timeout()\fP and \fI\%gearman_client_set_timeout()\fP get and set the current connection timeout value, in milliseconds, for the client.
.sp
Normally \fBmalloc(3)\fP and \fBfree(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 \fI\%gearman_allocator_t\fP for the updated interface.
.sp
\fI\%gearman_client_task_free_all()\fP is used to free all current \fI\%gearman_task_st\fP that have been created with the \fI\%gearman_client_st\fP\&.
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
By calling \fI\%gearman_client_task_free_all()\fP you can end up with a SEGFAULT if you try to use any \fI\%gearman_task_st\fP that you have kept pointers too.
.UNINDENT
.UNINDENT
.SH RETURN VALUE
.sp
\fI\%gearman_client_timeout()\fP returns an integer representing the amount of time in milliseconds to wait for a connection before throwing an error. A value of \-1 means an infinite timeout value.
.SH HOME
.sp
To find out more information please check:
\fI\%http://gearman.info/\fP
.sp
\fBSEE ALSO:\fP
.INDENT 0.0
.INDENT 3.5
\fBgearmand(8)\fP \fBlibgearman(3)\fP \fBgearman_client_create(3)\fP
.UNINDENT
.UNINDENT
.SH AUTHOR
Data Differential http://www.datadifferential.com/
.SH COPYRIGHT
2011-2024, Data Differential, http://www.datadifferential.com/
.\" Generated by docutils manpage writer.
.