c262b58d94f8f68e5f9d46bb1b590cf31f13f5c8
[m6w6/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_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 typedef struct memcached_server_st memcached_server_st;
20 typedef struct memcached_callback_st memcached_callback_st;
21
22 typedef struct memcached_string_st memcached_string_st;
23 typedef struct memcached_continuum_item_st memcached_continuum_item_st;
24
25 typedef memcached_return_t (*memcached_clone_fn)(memcached_st *destination, const memcached_st *source);
26 typedef memcached_return_t (*memcached_cleanup_fn)(const memcached_st *ptr);
27
28 /**
29 Memory allocation functions.
30 */
31 typedef void (*memcached_free_fn)(const memcached_st *ptr, void *mem, void *context);
32 typedef void *(*memcached_malloc_fn)(const memcached_st *ptr, const size_t size, void *context);
33 typedef void *(*memcached_realloc_fn)(const memcached_st *ptr, void *mem, const size_t size, void *context);
34 typedef void *(*memcached_calloc_fn)(const memcached_st *ptr, size_t nelem, const size_t elsize, void *context);
35
36 typedef memcached_return_t (*memcached_execute_fn)(const memcached_st *ptr, memcached_result_st *result, void *context);
37 typedef memcached_return_t (*memcached_server_fn)(const memcached_st *ptr, memcached_server_st *server, void *context);
38
39 /**
40 Trigger functions.
41 */
42 typedef memcached_return_t (*memcached_trigger_key_fn)(const memcached_st *ptr,
43 const char *key, size_t key_length,
44 memcached_result_st *result);
45 typedef memcached_return_t (*memcached_trigger_delete_key_fn)(const memcached_st *ptr,
46 const char *key, size_t key_length);
47
48 typedef memcached_return_t (*memcached_dump_fn)(const memcached_st *ptr,
49 const char *key,
50 size_t key_length,
51 void *context);
52
53
54 /**
55 @note The following definitions are just here for backwards compatibility.
56 */
57 typedef memcached_return_t memcached_return;
58 typedef memcached_server_distribution_t memcached_server_distribution;
59 typedef memcached_behavior_t memcached_behavior;
60 typedef memcached_callback_t memcached_callback;
61 typedef memcached_hash_t memcached_hash;
62 typedef memcached_connection_t memcached_connection;
63 typedef memcached_clone_fn memcached_clone_func;
64 typedef memcached_cleanup_fn memcached_cleanup_func;
65 typedef memcached_execute_fn memcached_execute_function;
66 typedef memcached_server_fn memcached_server_function;
67 typedef memcached_trigger_key_fn memcached_trigger_key;
68 typedef memcached_trigger_delete_key_fn memcached_trigger_delete_key;
69 typedef memcached_dump_fn memcached_dump_func;
70
71 #endif /* __LIBMEMCACHED_TYPES_H__ */