← Back to branch summary

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

« back to all changes in this revision

Viewing changes to docs/man/man3/gearman_con_create.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/man3/gearman_con_create.3
 
1
.TH gearman_con_create 3 2009-09-29 "Gearman" "Gearman"
 
2
.SH NAME
 
3
gearman_con_create \- Gearman Core Interface
 
4
.SH SYNOPSIS
 
5
.B #include <libgearman/gearman.h>
 
6
.sp
 
7
.BI " gearman_con_st *gearman_con_create(gearman_st " *gearman ", gearman_con_st *con);"
 
8
.SH DESCRIPTION
 
9
Initialize a connection structure. Always check the return value even if
 
10
passing in a pre-allocated structure. Some other initialization may have
 
11
failed.
 
12
*
 
13
.SH PARAMETERS
 
14
.TP
 
15
.BR 
 
16
[in] gearman Structure previously initialized with gearman_create() or
 
17
gearman_clone().
 
18
.TP
 
19
.BR 
 
20
[in] con Caller allocated structure, or NULL to allocate one.
 
21
.SH "RETURN VALUE"
 
22
On success, a pointer to the (possibly allocated) structure. On
 
23
failure this will be NULL.
 
24
.SH "SEE ALSO"
 
25
The Gearman homepage: http://www.gearman.org/
 
26
.SH BUGS
 
27
Bugs should be reported at https://bugs.launchpad.net/gearmand
 
28
.SH COPYING
 
29
Copyright (C) 2008 Brian Aker, Eric Day. All rights reserved.
 
30
 
 
31
Use and distribution licensed under the BSD license. See the COPYING file in the original source for full text.