Updating for 1.0.2 release
[awesomized/libmemcached] / libmemcached-1.0 / result.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) 2006-2009 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 struct memcached_result_st {
41 uint32_t item_flags;
42 time_t item_expiration;
43 size_t key_length;
44 uint64_t item_cas;
45 memcached_st *root;
46 memcached_string_st value;
47 uint64_t count;
48 char item_key[MEMCACHED_MAX_KEY];
49 struct {
50 bool is_allocated:1;
51 bool is_initialized:1;
52 } options;
53 /* Add result callback function */
54 };
55
56 #ifdef __cplusplus
57 extern "C" {
58 #endif
59
60 /* Result Struct */
61 LIBMEMCACHED_API
62 void memcached_result_free(memcached_result_st *result);
63
64 LIBMEMCACHED_API
65 void memcached_result_reset(memcached_result_st *ptr);
66
67 LIBMEMCACHED_API
68 memcached_result_st *memcached_result_create(const memcached_st *ptr,
69 memcached_result_st *result);
70
71 LIBMEMCACHED_API
72 const char *memcached_result_key_value(const memcached_result_st *self);
73
74 LIBMEMCACHED_API
75 size_t memcached_result_key_length(const memcached_result_st *self);
76
77 LIBMEMCACHED_API
78 const char *memcached_result_value(const memcached_result_st *self);
79
80 LIBMEMCACHED_API
81 size_t memcached_result_length(const memcached_result_st *self);
82
83 LIBMEMCACHED_API
84 uint32_t memcached_result_flags(const memcached_result_st *self);
85
86 LIBMEMCACHED_API
87 uint64_t memcached_result_cas(const memcached_result_st *self);
88
89 LIBMEMCACHED_API
90 memcached_return_t memcached_result_set_value(memcached_result_st *ptr, const char *value, size_t length);
91
92 LIBMEMCACHED_API
93 void memcached_result_set_flags(memcached_result_st *self, uint32_t flags);
94
95 LIBMEMCACHED_API
96 void memcached_result_set_expiration(memcached_result_st *self, time_t expiration);
97
98 #ifdef __cplusplus
99 } // extern "C"
100 #endif