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

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