1 .TH "LIBMEMCACHED" "3" "June 17, 2011" "0.49" "libmemcached"
3 libmemcached \- Introducing the C Client Library for memcached
5 .nr rst2man-indent-level 0
9 level \\n[rst2man-indent-level]
10 level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
17 .\" .rstReportMargin pre:
19 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
20 . nr rst2man-indent-level +1
21 .\" .rstReportMargin post:
25 .\" indent \\n[an-margin]
26 .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
27 .nr rst2man-indent-level -1
28 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
29 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
31 .\" Man page generated from reStructeredText.
35 #include <libmemcached/memcached.h>
37 Compile and link with \-lmemcached
39 libMemcached is an open source C/C++ client library and tools for the memcached server (\fI\%http://danga.com/memcached\fP). It has been designed to be light on memory usage, thread safe, and provide full access to server side methods.
41 libMemcached was designed to provide the greatest number of options to use Memcached. Some of the features provided:
45 Asynchronous and Synchronous Transport Support.
48 Consistent Hashing and Distribution.
51 Tunable Hashing algorithm to match keys.
54 Access to large object support.
60 A complete reference guide and documentation to the API.
63 Tools to Manage your Memcached networks.
67 "Memcached is a high\-performance, distributed memory object caching
68 system, generic in nature, but intended for use in speeding up dynamic web
69 applications by alleviating database load." \fI\%http://danga.com/memcached/\fP
71 \fBlibmemcached\fP is a small, thread\-safe client library for the
72 memcached protocol. The code has all been written to allow
73 for both web and embedded usage. It handles the work behind routing
74 individual keys to specific servers specified by the developer (and values are
75 matched based on server order as supplied by the user). It implements
76 a modular and consistent method of object distribution.
78 There are multiple implemented routing and hashing methods. See the
79 memcached_behavior_set() manpage for more information.
81 All operations are performed against a \fBmemcached_st\fP structure.
82 These structures can either be dynamically allocated or statically
83 allocated and then initialized by memcached_create(). Functions have been
84 written in order to encapsulate the \fBmemcached_st\fP. It is not
85 recommended that you operate directly against the structure.
87 Nearly all functions return a \fBmemcached_return_t\fP value.
88 This value can be translated to a printable string with memcached_strerror(3).
90 Objects are stored on servers by hashing keys. The hash value maps the key to a particular server. All clients understand how this hashing works, so it is possibly to reliably both push data to a server and retrieve data from a server.
92 Group keys can be optionally used to group sets of objects with servers.
94 Namespaces are supported, and can be used to partition caches so that multiple applications can use the same memcached servers.
96 \fBmemcached_st\fP structures are thread\-safe, but each thread must
97 contain its own structure (that is, if you want to share these among
98 threads you must provide your own locking). No global variables are
101 If you are working with GNU autotools you will want to add the following to
102 your COPYING to properly include libmemcached in your application.
104 PKG_CHECK_MODULES(DEPS, libmemcached >= 0.8.0)
105 AC_SUBST(DEPS_CFLAGS)
108 Some features of the library must be enabled through memcached_behavior_set().
113 A number of constants have been provided for in the library.
116 .B MEMCACHED_DEFAULT_PORT
118 The default port used by memcached(3).
124 Default maximum size of a key (which includes the null pointer). Master keys
125 have no limit, this only applies to keys used for storage.
131 Default size of key (which includes the null pointer).
137 This is the "stride" used in the consistent hash used between replicas.
141 .B MEMCACHED_MAX_HOST_LENGTH
143 Maximum allowed size of the hostname.
147 .B LIBMEMCACHED_VERSION_STRING
149 String value of libmemcached version such as "1.23.4"
153 .B LIBMEMCACHED_VERSION_HEX
155 Hex value of the version number. "0x00048000" This can be used for comparing versions based on number.
157 .SH THREADS AND PROCESSES
159 When using threads or forked processes it is important to keep one instance
160 of \fBmemcached_st\fP per process or thread. Without creating your own locking
161 structures you can not share a single \fBmemcached_st\fP. However, you can call
162 memcached_quit(3) on a \fBmemcached_st\fP and then use the resulting cloned
166 To find out more information please check:
167 \fI\%http://libmemcached.org/\fP
170 \fImemcached(1)\fP \fIlibmemcached_examples(3)\fP
171 \fIlibmemcached(1)\fP \fImemcat(1)\fP \fImemcp(1)\fP
172 \fImemflush(1)\fP \fImemrm(1)\fP \fImemslap(1)\fP
173 \fImemstat(1)\fP \fImemcached_fetch(3)\fP
174 \fImemcached_replace(3)\fP \fImemcached_server_list_free(3)\fP
175 \fIlibmemcached_examples(3)\fP \fImemcached_clone(3)\fP
176 \fImemcached_free(3)\fP \fImemcached_server_add(3)\fP
177 \fImemcached_server_push(3)\fP \fImemcached_add(3)\fP
178 \fImemcached_get(3)\fP \fImemcached_server_count(3)\fP
179 \fImemcached_create(3)\fP \fImemcached_increment(3)\fP
180 \fImemcached_server_list(3)\fP \fImemcached_set(3)\fP
181 \fImemcached_decrement(3)\fP \fImemcached_mget(3)\fP
182 \fImemcached_server_list_append(3)\fP \fImemcached_strerror(3)\fP
183 \fImemcached_delete(3)\fP \fImemcached_quit(3)\fP
184 \fImemcached_server_list_count(3)\fP \fImemcached_verbosity(3)\fP
185 \fImemcached_server_add_unix_socket(3)\fP
186 \fImemcached_result_create(3)\fP \fImemcached_result_free(3)\fP
187 \fImemcached_result_key_value(3)\fP
188 \fImemcached_result_key_length(3)\fP
189 \fImemcached_result_value(3)\fP \fImemcached_result_length(3)\fP
190 \fImemcached_result_flags(3)\fP \fImemcached_result_cas(3)\fP
191 \fImemcached_result_st(3)\fP \fImemcached_append(3)\fP
192 \fImemcached_prepend(3)\fP \fImemcached_fetch_result(3)\fP
193 \fImemerror(1)\fP \fImemcached_get_by_key(3)\fP
194 \fImemcached_mget_by_key(3)\fP \fImemcached_delete_by_key(3)\fP
195 \fImemcached_fetch_execute(3)\fP \fImemcached_callback_get(3)\fP
196 \fImemcached_callback_set(3)\fP \fImemcached_version(3)\fP
197 \fImemcached_lib_version(3)\fP \fImemcached_result_set_value(3)\fP
198 \fImemcached_dump(3)\fP \fImemdump(1)\fP
199 \fImemcached_set_memory_allocators(3)\fP
200 \fImemcached_get_memory_allocators(3)\fP
201 \fImemcached_get_user_data(3)\fP \fImemcached_set_user_data(3)\fP
205 2011, Brian Aker DataDifferential, http://datadifferential.com/
206 .\" Generated by docutils manpage writer.