git.m6w6.name Git - awesomized/libmemcached/blob - docs/memcached_dump.rst

   1 .. highlight:: perl
   2
   3
   4 memcached_dump
   5 **************
   6
   7
   8 Get a list of keys found on memcached 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    memcached_return_t
  30      memcached_dump (memcached_st *ptr,
  31                      memcached_dump_fn *function,
  32                      void *context,
  33                      uint32_t number_of_callbacks);
  34
  35    typedef memcached_return_t (*memcached_dump_fn)(memcached_st *ptr,
  36                                                    const char *key,
  37                                                    size_t key_length,
  38                                                    void *context);
  39
  40
  41
  42 ***********
  43 DESCRIPTION
  44 ***********
  45
  46
  47 memcached_dump() is used to get a list of keys found  memcached(1) servers.
  48 Because memcached(1) does not guarentee to dump all keys you can not assume
  49 you have fetched all keys from the server. The function takes an array
  50 of callbacks that it will use to execute on keys as they are found.
  51
  52 Currently the binar protocol is not supported.
  53
  54
  55 ******
  56 RETURN
  57 ******
  58
  59
  60 A value of type \ ``memcached_return_t``\  is returned
  61 On success that value will be \ ``MEMCACHED_SUCCESS``\ .
  62 Use memcached_strerror() to translate this value to a printable string.
  63
  64
  65 ****
  66 HOME
  67 ****
  68
  69
  70 To find out more information please check:
  71 `https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
  72
  73
  74 ******
  75 AUTHOR
  76 ******
  77
  78
  79 Brian Aker, <brian@tangent.org>
  80
  81
  82 ********
  83 SEE ALSO
  84 ********
  85
  86
  87 :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`