~kent/libmemcached/KBDocs4

« back to all changes in this revision

Viewing changes to docs/man/memcached_quit.3

Merge in all of build.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.TH "MEMCACHED_QUIT" "3" "April 09, 2011" "0.47" "libmemcached"
 
2
.SH NAME
 
3
memcached_quit \- libmemcached Documentation
 
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 <libmemcached/memcached.h>
 
36
.INDENT 0.0
 
37
.TP
 
38
.B void memcached_quit (memcached_st *ptr);
 
39
.UNINDENT
 
40
.sp
 
41
Compile and link with \-lmemcached
 
42
.SH DESCRIPTION
 
43
.sp
 
44
memcached_quit() will disconnect you from all currently connected servers.
 
45
It will also reset the state of the connection (ie, any memcached_fetch() you
 
46
are in the middle of will be terminated). This function is called
 
47
automatically when you call memcached_free() on the \fBmemcached_st\fP structure.
 
48
.sp
 
49
You do not need to call this on your own. All operations to change server
 
50
hashes and parameters will handle connections to the server for you. This
 
51
function is provided mainly so that you can timeout your connections or
 
52
reset connections during the middle of a memcached_fetch().
 
53
.SH RETURN
 
54
.sp
 
55
A value of type \fBmemcached_return\fP is returned
 
56
On success that value will be \fBMEMCACHED_SUCCESS\fP.
 
57
Use memcached_strerror() to translate this value to a printable string.
 
58
.SH HOME
 
59
.sp
 
60
To find out more information please check:
 
61
\fI\%https://launchpad.net/libmemcached\fP
 
62
.SH AUTHOR
 
63
.sp
 
64
Brian Aker, <\fI\%brian@tangent.org\fP>
 
65
.SH SEE ALSO
 
66
.sp
 
67
\fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP
 
68
.SH AUTHOR
 
69
Brian Aker
 
70
.SH COPYRIGHT
 
71
2011, Brian Aker DataDifferential, http://datadifferential.com/
 
72
.\" Generated by docutils manpage writer.
 
73
.\" 
 
74
.