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

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