Updates to libhashkit.
[awesomized/libmemcached] / 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_MEMCACHED_TYPES_H
13 #define LIBMEMCACHED_MEMCACHED_TYPES_H
14
15 #ifdef __cplusplus
16 extern "C" {
17 #endif
18
19 typedef struct memcached_st memcached_st;
20 typedef struct memcached_stat_st memcached_stat_st;
21 typedef struct memcached_analysis_st memcached_analysis_st;
22 typedef struct memcached_result_st memcached_result_st;
23 typedef struct memcached_string_st memcached_string_st;
24 typedef struct memcached_server_st memcached_server_st;
25 typedef struct memcached_continuum_item_st memcached_continuum_item_st;
26
27 typedef memcached_return_t (*memcached_clone_fn)(memcached_st *parent, memcached_st *clone);
28 typedef memcached_return_t (*memcached_cleanup_fn)(const memcached_st *ptr);
29
30 /**
31 Memory allocation functions.
32 */
33 typedef void (*memcached_free_fn)(const memcached_st *ptr, void *mem, void *context);
34 typedef void *(*memcached_malloc_fn)(const memcached_st *ptr, const size_t size, void *context);
35 typedef void *(*memcached_realloc_fn)(const memcached_st *ptr, void *mem, const size_t size, void *context);
36 typedef void *(*memcached_calloc_fn)(const memcached_st *ptr, size_t nelem, const size_t elsize, void *context);
37
38 typedef memcached_return_t (*memcached_execute_fn)(const memcached_st *ptr, memcached_result_st *result, void *context);
39 typedef memcached_return_t (*memcached_server_fn)(const memcached_st *ptr, memcached_server_st *server, void *context);
40
41 /**
42 Trigger functions.
43 */
44 typedef memcached_return_t (*memcached_trigger_key_fn)(const memcached_st *ptr,
45 const char *key, size_t key_length,
46 memcached_result_st *result);
47 typedef memcached_return_t (*memcached_trigger_delete_key_fn)(const memcached_st *ptr,
48 const char *key, size_t key_length);
49
50 typedef memcached_return_t (*memcached_dump_fn)(const memcached_st *ptr,
51 const char *key,
52 size_t key_length,
53 void *context);
54
55 typedef struct {
56 memcached_execute_fn *callback;
57 void *context;
58 uint32_t number_of_callback;
59 } memcached_callback_st;
60
61
62 /**
63 @note The following definitions are just here for backwards compatibility.
64 */
65 typedef memcached_return_t memcached_return;
66 typedef memcached_server_distribution_t memcached_server_distribution;
67 typedef memcached_behavior_t memcached_behavior;
68 typedef memcached_callback_t memcached_callback;
69 typedef memcached_hash_t memcached_hash;
70 typedef memcached_connection_t memcached_connection;
71 typedef memcached_clone_fn memcached_clone_func;
72 typedef memcached_cleanup_fn memcached_cleanup_func;
73 typedef memcached_free_fn memcached_free_function;
74 typedef memcached_malloc_fn memcached_malloc_function;
75 typedef memcached_realloc_fn memcached_realloc_function;
76 typedef memcached_calloc_fn memcached_calloc_function;
77 typedef memcached_execute_fn memcached_execute_function;
78 typedef memcached_server_fn memcached_server_function;
79 typedef memcached_trigger_key_fn memcached_trigger_key;
80 typedef memcached_trigger_delete_key_fn memcached_trigger_delete_key;
81 typedef memcached_dump_fn memcached_dump_func;
82
83
84 #ifdef __cplusplus
85 }
86 #endif
87
88 #endif /* LIBMEMCACHED_MEMCACHED_TYPES_H */