← Back to branch summary

~mordred/gearmand/cancel-job

« back to all changes in this revision

Viewing changes to docs/man/gearman_task_data.3

  • 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/man/gearman_task_data.3
1
 
.TH "GEARMAN_TASK_DATA" "3" "April 17, 2012" "0.32" "Gearmand"
 
1
.TH "GEARMAN_TASK_DATA" "3" "May 03, 2012" "0.33" "Gearmand"
2
2
.SH NAME
3
3
gearman_task_data \- Gearmand Documentation, http://gearman.info/
4
4
.
119
119
.sp
120
120
A \fI\%gearman_task_st\fP represents a \fItask\fP.  Work that is sent by a \fIclient\fP to a gearman server is seen as a task (a \fIworker\fP recieves a task in the form of a \fIjob\fP.
121
121
.sp
122
 
Tasks, i.e. \fI\%gearman_task_st\fP are created by calling either
123
 
\fBgearman_execute()\fP, \fBgearman_client_add_task()\fP, or
124
 
\fBgearman_client_add_task_background()\fP.
 
122
Tasks, i.e. \fI\%gearman_task_st\fP are created by calling either \fBgearman_execute()\fP, \fBgearman_client_add_task()\fP, or \fBgearman_client_add_task_background()\fP.
125
123
.sp
126
124
\fBgearman_client_add_task_status()\fP can also create \fI\%gearman_task_st\fP, these tasks will be used to
127
125
monitor a previously created \fI\%gearman_task_st\fP.
140
138
\fI\%gearman_task_error()\fP return the last error message that the
141
139
\fI\%gearman_task_st\fP encountered. \fI\%gearman_task_return()\fP
142
140
return the last \fBgearman_return_t\fP stored. A value of
143
 
\fBGEARMAN_UNKNOWN_STATE\fP means that the task has not been submitted to server yet.
 
141
\fBGEARMAN_UNKNOWN_STATE\fP means that the task has not been submitted to
 
142
server yet, or that no function was available if the job has been submitted.
144
143
.SH RETURN VALUE
145
144
.sp
146
145
Various. Values that are returned by \fI\%gearman_task_take_data()\fP must have \fIfree(3)\fP called on them.