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              Param ptr
16                     pointer to memcached_st object
17
18              Param key
19                     key string being dumped
20
21              Param key_length
22                     length of the key without any terminating zero
23
24              Param context
25                     pointer to the user supplied context
26
27              Returns
28                     memcached_return_t indicating success
29
30       memcached_return_t memcached_dump(memcached_st *ptr,  memcached_dump_fn
31       *function, void *context, uint32_t number_of_callbacks)
32
33              Parameters
34
35                     • ptr -- pointer to initialized memcached_st struct
36
37                     • function     --    pointer    to    number_of_callbacks
38                       memcached_dump_fn callbacks
39
40                     • context -- pointer to a user managed context
41
42                     • number_of_callbacks  --  number  of  callbacks  in  the
43                       function array
44
45              Returns
46                     memcached_return_t indicating success
47

DESCRIPTION

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

RETURN VALUE

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

SEE ALSO

63       memcached(1) libmemcached(3) memcached_strerror(3)
64
65
66
67
681.1                              Jul 20, 2023                MEMCACHED_DUMP(3)
Impressum