git.m6w6.name Git - m6w6/libmemcached/blob - libmemcached/types.h

   1 /* LibMemcached
   2  * Copyright (C) 2006-2009 Brian Aker
   3  * All rights reserved.
   4  *
   5  * Use and distribution licensed under the BSD license.  See
   6  * the COPYING file in the parent directory for full text.
   7  *
   8  * Summary: Types for libmemcached
   9  *
  10  */
  11
  12 #ifndef __LIBMEMCACHED_TYPES_H__
  13 #define __LIBMEMCACHED_TYPES_H__
  14
  15 typedef struct memcached_st memcached_st;
  16 typedef struct memcached_stat_st memcached_stat_st;
  17 typedef struct memcached_analysis_st memcached_analysis_st;
  18 typedef struct memcached_result_st memcached_result_st;
  19
  20 // All of the flavors of memcache_server_st
  21 typedef struct memcached_server_st memcached_server_st;
  22 typedef const struct memcached_server_st *memcached_server_instance_st;
  23 typedef struct memcached_server_st *memcached_server_list_st;
  24
  25 typedef struct memcached_callback_st memcached_callback_st;
  26
  27 // The following two structures are internal, and never exposed to users.
  28 typedef struct memcached_string_st memcached_string_st;
  29 typedef struct memcached_continuum_item_st memcached_continuum_item_st;
  30
  31
  32 #ifdef __cplusplus
  33 extern "C" {
  34 #endif
  35
  36 typedef memcached_return_t (*memcached_clone_fn)(memcached_st *destination, const memcached_st *source);
  37 typedef memcached_return_t (*memcached_cleanup_fn)(const memcached_st *ptr);
  38
  39 /**
  40   Memory allocation functions.
  41 */
  42 typedef void (*memcached_free_fn)(const memcached_st *ptr, void *mem, void *context);
  43 typedef void *(*memcached_malloc_fn)(const memcached_st *ptr, const size_t size, void *context);
  44 typedef void *(*memcached_realloc_fn)(const memcached_st *ptr, void *mem, const size_t size, void *context);
  45 typedef void *(*memcached_calloc_fn)(const memcached_st *ptr, size_t nelem, const size_t elsize, void *context);
  46
  47
  48 typedef memcached_return_t (*memcached_execute_fn)(const memcached_st *ptr, memcached_result_st *result, void *context);
  49 typedef memcached_return_t (*memcached_server_fn)(const memcached_st *ptr, memcached_server_instance_st server, void *context);
  50
  51 /**
  52   Trigger functions.
  53 */
  54 typedef memcached_return_t (*memcached_trigger_key_fn)(const memcached_st *ptr,
  55                                                        const char *key, size_t key_length,
  56                                                        memcached_result_st *result);
  57 typedef memcached_return_t (*memcached_trigger_delete_key_fn)(const memcached_st *ptr,
  58                                                               const char *key, size_t key_length);
  59
  60 typedef memcached_return_t (*memcached_dump_fn)(const memcached_st *ptr,
  61                                                 const char *key,
  62                                                 size_t key_length,
  63                                                 void *context);
  64
  65 #ifdef __cplusplus
  66 }
  67 #endif
  68
  69 /**
  70   @note The following definitions are just here for backwards compatibility.
  71 */
  72 typedef memcached_return_t memcached_return;
  73 typedef memcached_server_distribution_t memcached_server_distribution;
  74 typedef memcached_behavior_t memcached_behavior;
  75 typedef memcached_callback_t memcached_callback;
  76 typedef memcached_hash_t memcached_hash;
  77 typedef memcached_connection_t memcached_connection;
  78 typedef memcached_clone_fn memcached_clone_func;
  79 typedef memcached_cleanup_fn memcached_cleanup_func;
  80 typedef memcached_execute_fn memcached_execute_function;
  81 typedef memcached_server_fn memcached_server_function;
  82 typedef memcached_trigger_key_fn memcached_trigger_key;
  83 typedef memcached_trigger_delete_key_fn memcached_trigger_delete_key;
  84 typedef memcached_dump_fn memcached_dump_func;
  85
  86 #endif /* __LIBMEMCACHED_TYPES_H__ */