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