6 Client library for memcached
14 C Client Library for memcached (libmemcached, -lmemcached)
25 #include <libmemcached/memcached.h>
34 "Memcached is a high-performance, distributed memory object caching
35 system, generic in nature, but intended for use in speeding up dynamic web
36 applications by alleviating database load." `http://danga.com/memcached/ <http://danga.com/memcached/>`_
38 \ **libmemcached**\ is a small, thread-safe client library for the
39 memcached protocol. The code has all been written with an eye to allow
40 for both web and embedded usage. It handles the work behind routing
41 particular keys to specific servers that you specify (and values are
42 matched based on server order as supplied by you). It implements both
43 a modula and consistent method of object distribution.
45 There are multiple implemented routing and hashing methods. See the
46 memcached_behavior_set() manpage.
48 All operations are performed against a \ ``memcached_st``\ structure.
49 These structures can either be dynamically allocated or statically
50 allocated and then initialized by memcached_create(). Functions have been
51 written in order to encapsulate the \ ``memcached_st``\ . It is not
52 recommended that you operate directly against the structure.
54 Nearly all functions return a \ ``memcached_return_t``\ value.
55 This value can be translated to a printable string with memcached_strerror(3).
57 Partitioning based on keys is testsed in the library. Using the key partioning
58 functions it is possible to group sets of object onto servers.
60 \ ``memcached_st``\ structures are thread-safe, but each thread must
61 contain its own structure (that is, if you want to share these among
62 threads you must provide your own locking). No global variables are
65 If you are working with GNU autotools you will want to add the following to
66 your COPYING to properly include libmemcached in your application.
68 PKG_CHECK_MODULES(DEPS, libmemcached >= 0.8.0)
72 Some features of the library must be enabled through memcached_behavior_set().
82 A number of constants have been provided for in the library.
85 .. c:var:: MEMCACHED_DEFAULT_PORT
87 The default port used by memcached(3).
91 .. c:var:: MEMCACHED_MAX_KEY
93 Default maximum size of a key (which includes the null pointer). Master keys
94 have no limit, this only applies to keys used for storage.
98 .. c:var:: MEMCACHED_MAX_KEY
100 Default size of key (which includes the null pointer).
104 .. c:var:: MEMCACHED_STRIDE
106 This is the "stride" used in the consistent hash used between replicas.
110 .. c:var:: MEMCACHED_MAX_HOST_LENGTH
112 Maximum allowed size of the hostname.
115 .. c:var:: LIBMEMCACHED_VERSION_STRING
117 String value of libmemcached version such as "1.23.4"
120 .. c:var:: LIBMEMCACHED_VERSION_HEX
122 Hex value of the version number. "0x00048000" This can be used for comparing versions based on number.
127 ---------------------
128 THREADS AND PROCESSES
129 ---------------------
132 When using threads or forked processes it is important to keep an instance
133 of \ ``memcached_st``\ per process or thread. Without creating your own locking
134 structures you can not share a single \ ``memcached_st``\ . You can though call
135 memcached_quit(3) on a \ ``memcached_st``\ and then use the resulting cloned
144 To find out more information please check:
145 `https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
153 :manpage:`memcached(1)` :manpage:`libmemcached_examples(3)` :manpage:`libmemcached(1)` :manpage:`memcat(1)` :manpage:`memcp(1)` :manpage:`memflush(1)` :manpage:`memrm(1)` :manpage:`memslap(1)` :manpage:`memstat(1)` :manpage:`memcached_fetch(3)` :manpage:`memcached_replace(3)` :manpage:`memcached_server_list_free(3)` :manpage:`libmemcached_examples(3)` :manpage:`memcached_clone(3)` :manpage:`memcached_free(3)`
154 :manpage:`memcached_server_add(3)` :manpage:`memcached_server_push(3)` :manpage:`memcached_add(3)` :manpage:`memcached_get(3)` :manpage:`memcached_server_count(3)` :manpage:`memcached_servers_parse(3)` :manpage:`memcached_create(3)` :manpage:`memcached_increment(3)` :manpage:`memcached_server_list(3)` :manpage:`memcached_set(3)`
155 :manpage:`memcached_decrement(3)` :manpage:`memcached_mget(3)` :manpage:`memcached_server_list_append(3)` :manpage:`memcached_strerror(3)` :manpage:`memcached_delete(3)` :manpage:`memcached_quit(3)` :manpage:`memcached_server_list_count(3)` :manpage:`memcached_verbosity(3)` :manpage:`memcached_server_add_unix_socket(3)` :manpage:`memcached_result_create(3)` :manpage:`memcached_result_free(3)`
156 :manpage:`memcached_result_key_value(3)` :manpage:`memcached_result_key_length(3)` :manpage:`memcached_result_value(3)` :manpage:`memcached_result_length(3)` :manpage:`memcached_result_flags(3)`
157 :manpage:`memcached_result_cas(3)` :manpage:`memcached_result_st(3)` :manpage:`memcached_append(3)` :manpage:`memcached_prepend(3)` :manpage:`memcached_fetch_result(3)`
158 :manpage:`memerror(1)` :manpage:`memcached_get_by_key(3)` :manpage:`memcached_mget_by_key(3)` :manpage:`memcached_delete_by_key(3)`
159 :manpage:`memcached_fetch_execute(3)` :manpage:`memcached_callback_get(3)` :manpage:`memcached_callback_set(3)` :manpage:`memcached_version(3)`
160 :manpage:`memcached_lib_version(3)` :manpage:`memcached_result_set_value(3)` :manpage:`memcached_dump(3)` :manpage:`memdump(1)`
161 :manpage:`memcached_set_memory_allocators(3)` :manpage:`memcached_get_memory_allocators(3)` :manpage:`memcached_get_user_data(3)` :manpage:`memcached_set_user_data(3)`