← Back to branch summary

~trond-norbye/libmemcached/compile-fixes

« back to all changes in this revision

Viewing changes to docs/memcached_quit.rst

  • Committer: Brian Aker
  • Date: 2011-06-24 20:09:30 UTC
  • mfrom: (929.1.155 libmemcached-build)
  • Revision ID: brian@tangent.org-20110624200930-m268yogmnpyzs3qj
Merge in trunk. Updates to manual/update to latest libtest.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/memcached_quit.rst
19
19
-----------
20
20
 
21
21
 
22
 
memcached_quit() will disconnect you from all currently connected servers.
23
 
It will also reset the state of the connection (ie, any memcached_fetch() you
24
 
are in the middle of will be terminated). This function is called
25
 
automatically when you call memcached_free() on the \ ``memcached_st``\  structure.
 
22
:c:func:`memcached_quit()` will disconnect you from all currently connected 
 
23
servers. It will also reset the state of the connection (ie, any :c:func:`memcached_fetch()` you are in the middle of will be terminated). This function is 
 
24
called automatically when you call :c:func:`memcached_free()` on the :c:type:`memcached_st` structure.
26
25
 
27
26
You do not need to call this on your own. All operations to change server
28
27
hashes and parameters will handle connections to the server for you. This
29
28
function is provided mainly so that you can timeout your connections or
30
 
reset connections during the middle of a memcached_fetch().
 
29
reset connections during the middle of a :c:func:`memcached_fetch()`.
31
30
 
32
31
 
33
32
------
35
34
------
36
35
 
37
36
 
38
 
A value of type \ ``memcached_return``\  is returned
39
 
On success that value will be \ ``MEMCACHED_SUCCESS``\ .
40
 
Use memcached_strerror() to translate this value to a printable string.
 
37
A value of type :c:type:`memcached_return` is returned
 
38
On success that value will be :c:type:`MEMCACHED_SUCCESS`.
 
39
Use :c:func:`memcached_strerror()` to translate this value to a printable string.
41
40
 
42
41
 
43
42
----