1MEMCACHED_DUMP(3)            libmemcached-awesome            MEMCACHED_DUMP(3)
2
3
4

NAME

6       memcached_dump - libmemcached Documentation
7

SYNOPSIS

9       #include <libmemcached/memcached.h>
10              Compile and link with -lmemcached
11
12       typedef   memcached_return_t   (*memcached_dump_fn)(memcached_st  *ptr,
13       const char *key, size_t key_length, void *context)
14
15              Parameters
16
17                     • ptr -- pointer to memcached_st object
18
19                     • key -- key string being dumped
20
21                     • key_length -- length of the key without any terminating
22                       zero
23
24                     • context -- pointer to the user supplied context
25
26              Returns
27                     memcached_return_t indicating success
28
29       memcached_return_t  memcached_dump(memcached_st *ptr, memcached_dump_fn
30       *function, void *context, uint32_t number_of_callbacks)
31
32              Parameters
33
34                     • ptr -- pointer to initialized memcached_st struct
35
36                     • function    --    pointer    to     number_of_callbacks
37                       memcached_dump_fn callbacks
38
39                     • context -- pointer to a user managed context
40
41                     • number_of_callbacks  --  number  of  callbacks  in  the
42                       function array
43
44              Returns
45                     memcached_return_t indicating success
46

DESCRIPTION

48       memcached_dump() is used to get a list of keys  found  in  memcached(1)
49       servers.  Because memcached does not guarantee to dump all keys you can
50       not assume you have fetched all keys  from  the  server.  The  function
51       takes an array of callbacks that it will use to execute on keys as they
52       are found.
53
54       Currently the binary protocol is not tested.
55

RETURN VALUE

57       A value of type memcached_return_t is returned.  On success that  value
58       will  be MEMCACHED_SUCCESS.  Use memcached_strerror() to translate this
59       value to a printable string.
60

SEE ALSO

62       memcached(1) libmemcached(3) memcached_strerror(3)
63
64
65
66
671.1                              Sep 20, 2021                MEMCACHED_DUMP(3)
Impressum