git.m6w6.name Git - awesomized/libmemcached/blob - libmemcached/types.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
  39 #pragma once
  40 #ifndef __LIBMEMCACHED_TYPES_H__
  41 #define __LIBMEMCACHED_TYPES_H__
  42
  43 typedef struct memcached_st memcached_st;
  44 typedef struct memcached_stat_st memcached_stat_st;
  45 typedef struct memcached_analysis_st memcached_analysis_st;
  46 typedef struct memcached_result_st memcached_result_st;
  47 typedef struct memcached_array_st memcached_array_st;
  48 typedef struct memcached_error_t memcached_error_t;
  49
  50 // All of the flavors of memcache_server_st
  51 typedef struct memcached_server_st memcached_server_st;
  52 typedef const struct memcached_server_st *memcached_server_instance_st;
  53 typedef struct memcached_server_st *memcached_server_list_st;
  54
  55 typedef struct memcached_callback_st memcached_callback_st;
  56
  57 // The following two structures are internal, and never exposed to users.
  58 typedef struct memcached_string_st memcached_string_st;
  59 typedef struct memcached_string_t memcached_string_t;
  60 typedef struct memcached_continuum_item_st memcached_continuum_item_st;
  61
  62
  63 #ifdef __cplusplus
  64 extern "C" {
  65 #endif
  66
  67 typedef memcached_return_t (*memcached_clone_fn)(memcached_st *destination, const memcached_st *source);
  68 typedef memcached_return_t (*memcached_cleanup_fn)(const memcached_st *ptr);
  69
  70 /**
  71   Memory allocation functions.
  72 */
  73 typedef void (*memcached_free_fn)(const memcached_st *ptr, void *mem, void *context);
  74 typedef void *(*memcached_malloc_fn)(const memcached_st *ptr, const size_t size, void *context);
  75 typedef void *(*memcached_realloc_fn)(const memcached_st *ptr, void *mem, const size_t size, void *context);
  76 typedef void *(*memcached_calloc_fn)(const memcached_st *ptr, size_t nelem, const size_t elsize, void *context);
  77
  78
  79 typedef memcached_return_t (*memcached_execute_fn)(const memcached_st *ptr, memcached_result_st *result, void *context);
  80 typedef memcached_return_t (*memcached_server_fn)(const memcached_st *ptr, memcached_server_instance_st server, void *context);
  81 typedef memcached_return_t (*memcached_stat_fn)(memcached_server_instance_st server,
  82                                                 const char *key, size_t key_length,
  83                                                 const char *value, size_t value_length,
  84                                                 void *context);
  85
  86 /**
  87   Trigger functions.
  88 */
  89 typedef memcached_return_t (*memcached_trigger_key_fn)(const memcached_st *ptr,
  90                                                        const char *key, size_t key_length,
  91                                                        memcached_result_st *result);
  92 typedef memcached_return_t (*memcached_trigger_delete_key_fn)(const memcached_st *ptr,
  93                                                               const char *key, size_t key_length);
  94
  95 typedef memcached_return_t (*memcached_dump_fn)(const memcached_st *ptr,
  96                                                 const char *key,
  97                                                 size_t key_length,
  98                                                 void *context);
  99
 100 #ifdef __cplusplus
 101 }
 102 #endif
 103
 104 /**
 105   @note The following definitions are just here for backwards compatibility.
 106 */
 107 typedef memcached_return_t memcached_return;
 108 typedef memcached_server_distribution_t memcached_server_distribution;
 109 typedef memcached_behavior_t memcached_behavior;
 110 typedef memcached_callback_t memcached_callback;
 111 typedef memcached_hash_t memcached_hash;
 112 typedef memcached_connection_t memcached_connection;
 113 typedef memcached_clone_fn memcached_clone_func;
 114 typedef memcached_cleanup_fn memcached_cleanup_func;
 115 typedef memcached_execute_fn memcached_execute_function;
 116 typedef memcached_server_fn memcached_server_function;
 117 typedef memcached_trigger_key_fn memcached_trigger_key;
 118 typedef memcached_trigger_delete_key_fn memcached_trigger_delete_key;
 119 typedef memcached_dump_fn memcached_dump_func;
 120
 121 #endif /* __LIBMEMCACHED_TYPES_H__ */