Merge up for version.
[awesomized/libmemcached] / libmemcached / get.h
1 /* vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
2 *
3 * Libmemcached library
4 *
5 * Copyright (C) 2011 Data Differential, http://datadifferential.com/
6 * Copyright (C) 2010 Brian Aker All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions are
10 * met:
11 *
12 * * Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 *
15 * * Redistributions in binary form must reproduce the above
16 * copyright notice, this list of conditions and the following disclaimer
17 * in the documentation and/or other materials provided with the
18 * distribution.
19 *
20 * * The names of its contributors may not be used to endorse or
21 * promote products derived from this software without specific prior
22 * written permission.
23 *
24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
25 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
26 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
27 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
28 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
29 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
30 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
31 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
32 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
33 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
34 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35 *
36 */
37
38 #pragma once
39
40
41 #ifdef __cplusplus
42 extern "C" {
43 #endif
44
45 /* Public defines */
46 LIBMEMCACHED_API
47 char *memcached_get(memcached_st *ptr,
48 const char *key, size_t key_length,
49 size_t *value_length,
50 uint32_t *flags,
51 memcached_return_t *error);
52
53 LIBMEMCACHED_API
54 memcached_return_t memcached_mget(memcached_st *ptr,
55 const char * const *keys,
56 const size_t *key_length,
57 size_t number_of_keys);
58
59 LIBMEMCACHED_API
60 char *memcached_get_by_key(memcached_st *ptr,
61 const char *group_key, size_t group_key_length,
62 const char *key, size_t key_length,
63 size_t *value_length,
64 uint32_t *flags,
65 memcached_return_t *error);
66
67 LIBMEMCACHED_API
68 memcached_return_t memcached_mget_by_key(memcached_st *ptr,
69 const char *group_key,
70 size_t group_key_length,
71 const char * const *keys,
72 const size_t *key_length,
73 const size_t number_of_keys);
74
75 LIBMEMCACHED_API
76 char *memcached_fetch(memcached_st *ptr,
77 char *key,
78 size_t *key_length,
79 size_t *value_length,
80 uint32_t *flags,
81 memcached_return_t *error);
82
83 LIBMEMCACHED_API
84 memcached_result_st *memcached_fetch_result(memcached_st *ptr,
85 memcached_result_st *result,
86 memcached_return_t *error);
87
88 LIBMEMCACHED_API
89 memcached_return_t memcached_mget_execute(memcached_st *ptr,
90 const char * const *keys,
91 const size_t *key_length,
92 const size_t number_of_keys,
93 memcached_execute_fn *callback,
94 void *context,
95 const uint32_t number_of_callbacks);
96
97 LIBMEMCACHED_API
98 memcached_return_t memcached_mget_execute_by_key(memcached_st *ptr,
99 const char *group_key,
100 size_t group_key_length,
101 const char * const *keys,
102 const size_t *key_length,
103 size_t number_of_keys,
104 memcached_execute_fn *callback,
105 void *context,
106 const uint32_t number_of_callbacks);
107
108 #ifdef __cplusplus
109 }
110 #endif