Merge in updates to the documentation.
[awesomized/libmemcached] / libmemcached / get.h
1 /* LibMemcached
2 * Copyright (C) 2006-2009 Brian Aker
3 * All rights reserved.
4 *
5 * Use and distribution licensed under the BSD license. See
6 * the COPYING file in the parent directory for full text.
7 *
8 * Summary: Get functions for libmemcached
9 *
10 */
11
12 #ifndef __LIBMEMCACHED_GET_H__
13 #define __LIBMEMCACHED_GET_H__
14
15 #ifdef __cplusplus
16 extern "C" {
17 #endif
18
19 /* Public defines */
20 LIBMEMCACHED_API
21 char *memcached_get(memcached_st *ptr,
22 const char *key, size_t key_length,
23 size_t *value_length,
24 uint32_t *flags,
25 memcached_return_t *error);
26
27 LIBMEMCACHED_API
28 memcached_return_t memcached_mget(memcached_st *ptr,
29 const char * const *keys,
30 const size_t *key_length,
31 size_t number_of_keys);
32
33 LIBMEMCACHED_API
34 char *memcached_get_by_key(memcached_st *ptr,
35 const char *group_key, size_t group_key_length,
36 const char *key, size_t key_length,
37 size_t *value_length,
38 uint32_t *flags,
39 memcached_return_t *error);
40
41 LIBMEMCACHED_API
42 memcached_return_t memcached_mget_by_key(memcached_st *ptr,
43 const char *group_key,
44 size_t group_key_length,
45 const char * const *keys,
46 const size_t *key_length,
47 const size_t number_of_keys);
48
49 LIBMEMCACHED_API
50 char *memcached_fetch(memcached_st *ptr,
51 char *key,
52 size_t *key_length,
53 size_t *value_length,
54 uint32_t *flags,
55 memcached_return_t *error);
56
57 LIBMEMCACHED_API
58 memcached_result_st *memcached_fetch_result(memcached_st *ptr,
59 memcached_result_st *result,
60 memcached_return_t *error);
61
62 LIBMEMCACHED_API
63 memcached_return_t memcached_mget_execute(memcached_st *ptr,
64 const char * const *keys,
65 const size_t *key_length,
66 const size_t number_of_keys,
67 memcached_execute_fn *callback,
68 void *context,
69 const uint32_t number_of_callbacks);
70
71 LIBMEMCACHED_API
72 memcached_return_t memcached_mget_execute_by_key(memcached_st *ptr,
73 const char *group_key,
74 size_t group_key_length,
75 const char * const *keys,
76 const size_t *key_length,
77 size_t number_of_keys,
78 memcached_execute_fn *callback,
79 void *context,
80 const uint32_t number_of_callbacks);
81
82 #ifdef __cplusplus
83 }
84 #endif
85
86 #endif /* __LIBMEMCACHED_GET_H__ */