~piotr-sikora/libmemcached/fix-tests-on-openbsd

« back to all changes in this revision

Viewing changes to docs/memcached_quit.rst

Merge in all of build.

Show diffs side-by-side

added added

removed removed

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