← Back to branch summary

~clint-fewbar/ubuntu/precise/gearmand/drop-unneeded-patches

« back to all changes in this revision

Viewing changes to docs/man/libgearman.3

  • Committer: Bazaar Package Importer
  • Author(s): Monty Taylor
  • Date: 2009-09-28 21:43:31 UTC
  • mto: (1.2.3 upstream) (6.1.1 sid)
  • mto: This revision was merged to the branch mainline in revision 5.
  • Revision ID: james.westby@ubuntu.com-20090928214331-9bku0d3v1b1ypgp4
Import upstream version 0.10

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/man/libgearman.3
1
 
.TH "LIBGEARMAN" "3" "December 15, 2011" "0.26" "Gearmand"
2
 
.SH NAME
3
 
libgearman \- Gearmand Documentation, http://gearman.info/
4
 
.
5
 
.nr rst2man-indent-level 0
6
 
.
7
 
.de1 rstReportMargin
8
 
\\$1 \\n[an-margin]
9
 
level \\n[rst2man-indent-level]
10
 
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
11
 
-
12
 
\\n[rst2man-indent0]
13
 
\\n[rst2man-indent1]
14
 
\\n[rst2man-indent2]
15
 
..
16
 
.de1 INDENT
17
 
.\" .rstReportMargin pre:
18
 
. RS \\$1
19
 
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
20
 
. nr rst2man-indent-level +1
21
 
.\" .rstReportMargin post:
22
 
..
23
 
.de UNINDENT
24
 
. RE
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
30
 
..
31
 
.\" Man page generated from reStructeredText.
32
 
.
33
 
.SH SYNOPSIS
34
 
.sp
35
 
#include <libgearman/gearman.h>
36
 
.sp
37
 
Link \-lgearman
38
 
.SH DESCRIPTION
39
 
.sp
40
 
\fBlibgearman\fP is a small, thread\-safe client library for the
41
 
gearman protocol. The code has all been written with an eye to allow
42
 
for both web and embedded usage. It handles the work behind routing
43
 
particular keys to specific servers that you specify (and values are
44
 
matched based on server order as supplied by you). It implements both
45
 
the \fIclient\fP and \fIworker\fP interfaces.
46
 
.sp
47
 
All operations are performed against either a client, ie \fBgearman_client_st\fP
48
 
or worker, ie \fBgearman_worker_st\fP.
49
 
.sp
50
 
Client and Worker structures can either be dynamically allocated or statically
51
 
allocated. They must then b initialized by \fBgearman_client_create()\fP or \fBgearman_worker_create()\fP.
52
 
.sp
53
 
Functions have been written in order to encapsulate all structures in the library. It is
54
 
recommended that you do not operate directly against the structure.
55
 
.sp
56
 
Nearly all functions return a \fBgearman_return_t\fP value.
57
 
This value can be translated to a printable string with \fBgearman_strerror()\fP.
58
 
.sp
59
 
\fBgearman_client_st\fP and \fBgearman_worker_st\fP structures are thread\-safe, but each thread must
60
 
contain its own structure (that is, if you want to share these among
61
 
threads you must provide your own locking). No global variables are
62
 
used in this library.
63
 
.sp
64
 
If you are working with GNU autotools you will want to add the following to
65
 
your configure.ac to properly include libgearman in your application.
66
 
.sp
67
 
PKG_CHECK_MODULES(DEPS, libgearman >= 0.8.0)
68
 
AC_SUBST(DEPS_CFLAGS)
69
 
AC_SUBST(DEPS_LIBS)
70
 
.sp
71
 
Hope you enjoy it!
72
 
.SH CONSTANTS
73
 
.sp
74
 
A number of constants have been provided for in the library.
75
 
.INDENT 0.0
76
 
.TP
77
 
.B GEARMAN_DEFAULT_TCP_PORT
78
 
.UNINDENT
79
 
.sp
80
 
The default port used by gearmand(3).
81
 
.INDENT 0.0
82
 
.TP
83
 
.B GEARMAN_DEFAULT_TCP_PORT
84
 
.UNINDENT
85
 
.sp
86
 
The default service used by gearmand(3).
87
 
.INDENT 0.0
88
 
.TP
89
 
.B LIBGEARMAN_VERSION_STRING
90
 
.UNINDENT
91
 
.sp
92
 
String value of the libgearman version such as "0.20.4"
93
 
.INDENT 0.0
94
 
.TP
95
 
.B LIBGEARMAN_VERSION_HEX
96
 
.UNINDENT
97
 
.sp
98
 
Hex value of the version number. "0x00048000" This can be used for comparing versions based on number.
99
 
.INDENT 0.0
100
 
.TP
101
 
.B GEARMAN_UNIQUE_SIZE
102
 
.UNINDENT
103
 
.sp
104
 
Largest number of characters that can be used for a unique value.
105
 
.INDENT 0.0
106
 
.TP
107
 
.B GEARMAN_JOB_HANDLE_SIZE
108
 
.UNINDENT
109
 
.sp
110
 
Largest number of characters that can will be used for a job handle. Please
111
 
see \fBgearman_job_handle_t\fP for additional information.
112
 
.SH THREADS AND PROCESSES
113
 
.sp
114
 
When using threads or forked processes it is important to keep an instance
115
 
of \fBgearman_client_st\fP or \fBgearman_worker_st\fP  per process
116
 
or thread.  Without creating your own locking structures you can not share
117
 
a single \fBgearman_client_st\fP or \fBgearman_worker_st\fP.
118
 
.SH HOME
119
 
.sp
120
 
To find out more information please check:
121
 
\fI\%https://launchpad.net/libgearman\fP
122
 
.SH SEE ALSO
123
 
.sp
124
 
\fIgearmand(8)\fP \fIlibgearman_examples(3)\fP
125
 
.SH AUTHOR
126
 
Data Differential http://datadifferential.com/
127
 
.SH COPYRIGHT
128
 
2011, Data Differential, http://datadifferential.com/
129
 
.\" Generated by docutils manpage writer.
130
 
.\" 
131
 
.