Added documentation for memcached_mget_execute
[m6w6/libmemcached] / libmemcached / memcached_get.h
1 /*
2 * Summary: Get functions for libmemcached
3 *
4 * Copy: See Copyright for the status of this software.
5 *
6 * Author: Brian Aker
7 */
8
9 #ifndef LIBMEMCACHED_MEMCACHED_GET_H
10 #define LIBMEMCACHED_MEMCACHED_GET_H
11
12 #ifdef __cplusplus
13 extern "C" {
14 #endif
15
16 /* Public defines */
17 LIBMEMCACHED_API
18 char *memcached_get(memcached_st *ptr,
19 const char *key, size_t key_length,
20 size_t *value_length,
21 uint32_t *flags,
22 memcached_return *error);
23
24 LIBMEMCACHED_API
25 memcached_return memcached_mget(memcached_st *ptr,
26 const char **keys, size_t *key_length,
27 size_t number_of_keys);
28
29 LIBMEMCACHED_API
30 char *memcached_get_by_key(memcached_st *ptr,
31 const char *master_key, size_t master_key_length,
32 const char *key, size_t key_length,
33 size_t *value_length,
34 uint32_t *flags,
35 memcached_return *error);
36
37 LIBMEMCACHED_API
38 memcached_return memcached_mget_by_key(memcached_st *ptr,
39 const char *master_key, size_t
40 master_key_length,
41 const char **keys,
42 size_t *key_length,
43 size_t number_of_keys);
44
45 LIBMEMCACHED_API
46 char *memcached_fetch(memcached_st *ptr,
47 char *key, size_t *key_length,
48 size_t *value_length, uint32_t *flags,
49 memcached_return *error);
50
51 LIBMEMCACHED_API
52 memcached_result_st *memcached_fetch_result(memcached_st *ptr,
53 memcached_result_st *result,
54 memcached_return *error);
55
56 LIBMEMCACHED_API
57 memcached_return memcached_mget_execute(memcached_st *ptr,
58 const char *master_key,
59 size_t master_key_length,
60 const char **keys,
61 size_t *key_length,
62 size_t number_of_keys,
63 memcached_execute_function *callback,
64 void *context,
65 unsigned int number_of_callbacks);
66
67 #ifdef __cplusplus
68 }
69 #endif
70
71 #endif /* LIBMEMCACHED_MEMCACHED_GET_H */