← Back to branch summary

~avsej/libmemcached/touch-command

« back to all changes in this revision

Viewing changes to docs/memcached_dump.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_dump.rst
28
28
-----------
29
29
 
30
30
 
31
 
memcached_dump() is used to get a list of keys found in memcached(1) servers.
32
 
Because memcached(1) does not guarentee to dump all keys you can not assume
33
 
you have fetched all keys from the server. The function takes an array
 
31
:c:func:`memcached_dump()` is used to get a list of keys found in memcached(1) 
 
32
servers. Because memcached(1) does not guarentee to dump all keys you can not 
 
33
assume you have fetched all keys from the server. The function takes an array
34
34
of callbacks that it will use to execute on keys as they are found.
35
35
 
36
36
Currently the binary protocol is not testsed.
41
41
------
42
42
 
43
43
 
44
 
A value of type \ ``memcached_return_t``\  is returned
45
 
On success that value will be \ ``MEMCACHED_SUCCESS``\ .
46
 
Use memcached_strerror() to translate this value to a printable string.
 
44
A value of type :c:type:`memcached_return_t` is returned
 
45
On success that value will be :c:type:`MEMCACHED_SUCCESS`.
 
46
Use :c:func:`memcached_strerror()` to translate this value to a printable 
 
47
string.
47
48
 
48
49
 
49
50
----