Add new method which allows someone to "take" a value from a result object.
[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 * 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 #include <libmemcached-1.0/struct/result.h>
39
40 #pragma once
41
42 #ifdef __cplusplus
43 extern "C" {
44 #endif
45
46 /* Result Struct */
47 LIBMEMCACHED_API
48 void memcached_result_free(memcached_result_st *result);
49
50 LIBMEMCACHED_API
51 void memcached_result_reset(memcached_result_st *ptr);
52
53 LIBMEMCACHED_API
54 memcached_result_st *memcached_result_create(const memcached_st *ptr,
55 memcached_result_st *result);
56
57 LIBMEMCACHED_API
58 const char *memcached_result_key_value(const memcached_result_st *self);
59
60 LIBMEMCACHED_API
61 size_t memcached_result_key_length(const memcached_result_st *self);
62
63 LIBMEMCACHED_API
64 const char *memcached_result_value(const memcached_result_st *self);
65
66 LIBMEMCACHED_API
67 char *memcached_result_take_value(memcached_result_st *self);
68
69 LIBMEMCACHED_API
70 size_t memcached_result_length(const memcached_result_st *self);
71
72 LIBMEMCACHED_API
73 uint32_t memcached_result_flags(const memcached_result_st *self);
74
75 LIBMEMCACHED_API
76 uint64_t memcached_result_cas(const memcached_result_st *self);
77
78 LIBMEMCACHED_API
79 memcached_return_t memcached_result_set_value(memcached_result_st *ptr, const char *value, size_t length);
80
81 LIBMEMCACHED_API
82 void memcached_result_set_flags(memcached_result_st *self, uint32_t flags);
83
84 LIBMEMCACHED_API
85 void memcached_result_set_expiration(memcached_result_st *self, time_t expiration);
86
87 #ifdef __cplusplus
88 } // extern "C"
89 #endif