git.m6w6.name Git - awesomized/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 #pragma once
  13 #ifndef __LIBMEMCACHED_TYPES_H__
  14 #define __LIBMEMCACHED_TYPES_H__
  15
  16 typedef struct memcached_st memcached_st;
  17 typedef struct memcached_stat_st memcached_stat_st;
  18 typedef struct memcached_analysis_st memcached_analysis_st;
  19 typedef struct memcached_result_st memcached_result_st;
  20 typedef struct memcached_array_st memcached_array_st;
  21 typedef struct memcached_error_t memcached_error_t;
  22
  23 // All of the flavors of memcache_server_st
  24 typedef struct memcached_server_st memcached_server_st;
  25 typedef const struct memcached_server_st *memcached_server_instance_st;
  26 typedef struct memcached_server_st *memcached_server_list_st;
  27
  28 typedef struct memcached_callback_st memcached_callback_st;
  29
  30 // The following two structures are internal, and never exposed to users.
  31 typedef struct memcached_string_st memcached_string_st;
  32 typedef struct memcached_string_t memcached_string_t;
  33 typedef struct memcached_continuum_item_st memcached_continuum_item_st;
  34
  35
  36 #ifdef __cplusplus
  37 extern "C" {
  38 #endif
  39
  40 typedef memcached_return_t (*memcached_clone_fn)(memcached_st *destination, const memcached_st *source);
  41 typedef memcached_return_t (*memcached_cleanup_fn)(const memcached_st *ptr);
  42
  43 /**
  44   Memory allocation functions.
  45 */
  46 typedef void (*memcached_free_fn)(const memcached_st *ptr, void *mem, void *context);
  47 typedef void *(*memcached_malloc_fn)(const memcached_st *ptr, const size_t size, void *context);
  48 typedef void *(*memcached_realloc_fn)(const memcached_st *ptr, void *mem, const size_t size, void *context);
  49 typedef void *(*memcached_calloc_fn)(const memcached_st *ptr, size_t nelem, const size_t elsize, void *context);
  50
  51
  52 typedef memcached_return_t (*memcached_execute_fn)(const memcached_st *ptr, memcached_result_st *result, void *context);
  53 typedef memcached_return_t (*memcached_server_fn)(const memcached_st *ptr, memcached_server_instance_st server, void *context);
  54 typedef memcached_return_t (*memcached_stat_fn)(memcached_server_instance_st server,
  55                                                 const char *key, size_t key_length,
  56                                                 const char *value, size_t value_length,
  57                                                 void *context);
  58
  59 /**
  60   Trigger functions.
  61 */
  62 typedef memcached_return_t (*memcached_trigger_key_fn)(const memcached_st *ptr,
  63                                                        const char *key, size_t key_length,
  64                                                        memcached_result_st *result);
  65 typedef memcached_return_t (*memcached_trigger_delete_key_fn)(const memcached_st *ptr,
  66                                                               const char *key, size_t key_length);
  67
  68 typedef memcached_return_t (*memcached_dump_fn)(const memcached_st *ptr,
  69                                                 const char *key,
  70                                                 size_t key_length,
  71                                                 void *context);
  72
  73 #ifdef __cplusplus
  74 }
  75 #endif
  76
  77 /**
  78   @note The following definitions are just here for backwards compatibility.
  79 */
  80 typedef memcached_return_t memcached_return;
  81 typedef memcached_server_distribution_t memcached_server_distribution;
  82 typedef memcached_behavior_t memcached_behavior;
  83 typedef memcached_callback_t memcached_callback;
  84 typedef memcached_hash_t memcached_hash;
  85 typedef memcached_connection_t memcached_connection;
  86 typedef memcached_clone_fn memcached_clone_func;
  87 typedef memcached_cleanup_fn memcached_cleanup_func;
  88 typedef memcached_execute_fn memcached_execute_function;
  89 typedef memcached_server_fn memcached_server_function;
  90 typedef memcached_trigger_key_fn memcached_trigger_key;
  91 typedef memcached_trigger_delete_key_fn memcached_trigger_delete_key;
  92 typedef memcached_dump_fn memcached_dump_func;
  93
  94 #endif /* __LIBMEMCACHED_TYPES_H__ */