Merge in docs.
[m6w6/libmemcached] / libmemcached / result.cc
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
39 /*
40 memcached_result_st are used to internally represent the return values from
41 memcached. We use a structure so that long term as identifiers are added
42 to memcached we will be able to absorb new attributes without having
43 to addjust the entire API.
44 */
45 #include <libmemcached/common.h>
46
47 static inline void _result_init(memcached_result_st *self,
48 memcached_st *memc)
49 {
50 self->item_flags= 0;
51 self->item_expiration= 0;
52 self->key_length= 0;
53 self->item_cas= 0;
54 self->root= memc;
55 self->count= 0;
56 self->item_key[0]= 0;
57 }
58
59 memcached_result_st *memcached_result_create(const memcached_st *memc,
60 memcached_result_st *ptr)
61 {
62 WATCHPOINT_ASSERT(memc);
63
64 /* Saving malloc calls :) */
65 if (ptr)
66 {
67 ptr->options.is_allocated= false;
68 }
69 else
70 {
71 ptr= static_cast<memcached_result_st *>(libmemcached_malloc(memc, sizeof(memcached_result_st)));
72
73 if (not ptr)
74 {
75 return NULL;
76 }
77
78 ptr->options.is_allocated= true;
79 }
80
81 ptr->options.is_initialized= true;
82
83 _result_init(ptr, (memcached_st *)memc);
84
85 WATCHPOINT_SET(ptr->value.options.is_initialized= false);
86 memcached_string_create((memcached_st*)memc, &ptr->value, 0);
87 WATCHPOINT_ASSERT_INITIALIZED(&ptr->value);
88 WATCHPOINT_ASSERT(ptr->value.string == NULL);
89
90 return ptr;
91 }
92
93 void memcached_result_reset(memcached_result_st *ptr)
94 {
95 ptr->key_length= 0;
96 memcached_string_reset(&ptr->value);
97 ptr->item_flags= 0;
98 ptr->item_cas= 0;
99 ptr->item_expiration= 0;
100 }
101
102 void memcached_result_free(memcached_result_st *ptr)
103 {
104 if (not ptr)
105 return;
106
107 memcached_string_free(&ptr->value);
108
109 if (memcached_is_allocated(ptr))
110 {
111 WATCHPOINT_ASSERT(ptr->root); // Without a root, that means that result was not properly initialized.
112 libmemcached_free(ptr->root, ptr);
113 }
114 else
115 {
116 ptr->count= 0;
117 ptr->options.is_initialized= false;
118 }
119 }
120
121 memcached_return_t memcached_result_set_value(memcached_result_st *ptr,
122 const char *value,
123 size_t length)
124 {
125 if (memcached_failed(memcached_string_append(&ptr->value, value, length)))
126 {
127 return memcached_set_errno(*ptr->root, errno, MEMCACHED_AT);
128 }
129
130 return MEMCACHED_SUCCESS;
131 }
132
133 const char *memcached_result_key_value(const memcached_result_st *self)
134 {
135 return self->key_length ? self->item_key : NULL;
136 }
137
138 size_t memcached_result_key_length(const memcached_result_st *self)
139 {
140 return self->key_length;
141 }
142
143 const char *memcached_result_value(const memcached_result_st *self)
144 {
145 const memcached_string_st *sptr= &self->value;
146 return memcached_string_value(sptr);
147 }
148
149 size_t memcached_result_length(const memcached_result_st *self)
150 {
151 const memcached_string_st *sptr= &self->value;
152 return memcached_string_length(sptr);
153 }
154
155 uint32_t memcached_result_flags(const memcached_result_st *self)
156 {
157 return self->item_flags;
158 }
159
160 uint64_t memcached_result_cas(const memcached_result_st *self)
161 {
162 return self->item_cas;
163 }
164
165 void memcached_result_set_flags(memcached_result_st *self, uint32_t flags)
166 {
167 self->item_flags= flags;
168 }
169
170 void memcached_result_set_expiration(memcached_result_st *self, time_t expiration)
171 {
172 self->item_expiration= expiration;
173 }