9 libmemcached - Client library for memcached
17 C Client Library for memcached (libmemcached, -lmemcached)
28 #include <memcached.h>
37 "Memcached is a high-performance, distributed memory object caching
38 system, generic in nature, but intended for use in speeding up dynamic web
39 applications by alleviating database load." `http://danga.com/memcached/ <http://danga.com/memcached/>`_
41 \ **libmemcached**\ is a small, thread-safe client library for the
42 memcached protocol. The code has all been written with an eye to allow
43 for both web and embedded usage. It handles the work behind routing
44 particular keys to specific servers that you specify (and values are
45 matched based on server order as supplied by you). It implements both
46 a modula and consistent method of object distribution.
48 There are multiple implemented routing and hashing methods. See the
49 memcached_behavior_set() manpage.
51 All operations are performed against a \ ``memcached_st``\ structure.
52 These structures can either be dynamically allocated or statically
53 allocated and then initialized by memcached_create(). Functions have been
54 written in order to encapsulate the \ ``memcached_st``\ . It is not
55 recommended that you operate directly against the structure.
57 Nearly all functions return a \ ``memcached_return_t``\ value.
58 This value can be translated to a printable string with memcached_strerror(3).
60 Partitioning based on keys is supported in the library. Using the key partioning
61 functions it is possible to group sets of object onto servers.
63 \ ``memcached_st``\ structures are thread-safe, but each thread must
64 contain its own structure (that is, if you want to share these among
65 threads you must provide your own locking). No global variables are
68 If you are working with GNU autotools you will want to add the following to
69 your configure.ac to properly include libmemcached in your application.
71 PKG_CHECK_MODULES(DEPS, libmemcached >= 0.8.0)
75 Some features of the library must be enabled through memcached_behavior_set().
85 A number of constants have been provided for in the library.
88 MEMCACHED_DEFAULT_PORT
90 The default port used by memcached(3).
96 Default maximum size of a key (which includes the null pointer). Master keys
97 have no limit, this only applies to keys used for storage.
103 Default size of key (which includes the null pointer).
109 This is the "stride" used in the consistent hash used between replicas.
113 MEMCACHED_MAX_HOST_LENGTH
115 Maximum allowed size of the hostname.
119 MEMCACHED_VERSION_STRING
121 String value of libmemcached version such as "1.23.4"
125 MEMCACHED_MAJOR_VERSION
127 Major version value. Such as 1.23.4, would be 1
131 MEMCACHED_MINOR_VERSION
133 Major version value. Such as 1.23.4, would be 23
137 MEMCACHED_MICRO_VERSION
139 Major version value. Such as 1.23.4, would be 4
144 *********************
145 THREADS AND PROCESSES
146 *********************
149 When using threads or forked processes it is important to keep an instance
150 of \ ``memcached_st``\ per process or thread. Without creating your own locking
151 structures you can not share a single \ ``memcached_st``\ . You can though call
152 memcached_quit(3) on a \ ``memcached_st``\ and then use the resulting cloned
161 To find out more information please check:
162 `https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
170 Brian Aker, <brian@tangent.org>
178 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)