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