Update for docs
[m6w6/libmemcached] / docs / memcached_quit.rst
1 .. highlight:: perl
2
3
4 memcached_quit
5 **************
6
7
8 Disconnect from all servers
9
10
11 *******
12 LIBRARY
13 *******
14
15
16 C Client Library for memcached (libmemcached, -lmemcached)
17
18
19 ********
20 SYNOPSIS
21 ********
22
23
24
25 .. code-block:: perl
26
27 #include <libmemcached/memcached.h>
28
29 void memcached_quit (memcached_st *ptr);
30
31
32
33 ***********
34 DESCRIPTION
35 ***********
36
37
38 memcached_quit() will disconnect you from all currently connected servers.
39 It will also reset the state of the connection (ie, any memcached_fetch() you
40 are in the middle of will be terminated). This function is called
41 automatically when you call memcached_free() on the \ ``memcached_st``\ structure.
42
43 You do not need to call this on your own. All operations to change server
44 hashes and parameters will handle connections to the server for you. This
45 function is provided mainly so that you can timeout your connections or
46 reset connections during the middle of a memcached_fetch().
47
48
49 ******
50 RETURN
51 ******
52
53
54 A value of type \ ``memcached_return``\ is returned
55 On success that value will be \ ``MEMCACHED_SUCCESS``\ .
56 Use memcached_strerror() to translate this value to a printable string.
57
58
59 ****
60 HOME
61 ****
62
63
64 To find out more information please check:
65 `https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
66
67
68 ******
69 AUTHOR
70 ******
71
72
73 Brian Aker, <brian@tangent.org>
74
75
76 ********
77 SEE ALSO
78 ********
79
80
81 memcached(1) libmemcached(3) memcached_strerror(3)
82