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 .. index:: object: memcached_st
   9
  10
  11 --------
  12 SYNOPSIS
  13 --------
  14
  15
  16 #include <libmemcached/memcached.h>
  17
  18 .. c:function:: memcached_return_t memcached_dump (memcached_st *ptr, memcached_dump_fn *function, void *context, uint32_t number_of_callbacks);
  19
  20 .. c:function::  typedef memcached_return_t (*memcached_dump_fn)(memcached_st *ptr,  const char *key, size_t key_length, void *context);
  21
  22 Compile and link with -lmemcached
  23
  24
  25
  26 -----------
  27 DESCRIPTION
  28 -----------
  29
  30
  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 of callbacks that it will use to execute on keys as they are found.
  35
  36 Currently the binary protocol is not testsed.
  37
  38
  39 ------
  40 RETURN
  41 ------
  42
  43
  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.
  48
  49
  50 ----
  51 HOME
  52 ----
  53
  54
  55 To find out more information please check:
  56 `http://libmemcached.org/ <http://libmemcached.org/>`_
  57
  58
  59 ------
  60 AUTHOR
  61 ------
  62
  63
  64 Brian Aker, <brian@tangent.org>
  65
  66
  67 --------
  68 SEE ALSO
  69 --------
  70
  71
  72 :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`