1 .TH "LIBMEMCACHED" "3" "April 12, 2011" "0.47" "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
40 "Memcached is a high\-performance, distributed memory object caching
41 system, generic in nature, but intended for use in speeding up dynamic web
42 applications by alleviating database load." \fI\%http://danga.com/memcached/\fP
44 \fBlibmemcached\fP is a small, thread\-safe client library for the
45 memcached protocol. The code has all been written with an eye to allow
46 for both web and embedded usage. It handles the work behind routing
47 particular keys to specific servers that you specify (and values are
48 matched based on server order as supplied by you). It implements both
49 a modula and consistent method of object distribution.
51 There are multiple implemented routing and hashing methods. See the
52 memcached_behavior_set() manpage.
54 All operations are performed against a \fBmemcached_st\fP structure.
55 These structures can either be dynamically allocated or statically
56 allocated and then initialized by memcached_create(). Functions have been
57 written in order to encapsulate the \fBmemcached_st\fP. It is not
58 recommended that you operate directly against the structure.
60 Nearly all functions return a \fBmemcached_return_t\fP value.
61 This value can be translated to a printable string with memcached_strerror(3).
63 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.
65 Group keys can be optionally used to group sets of objects with servers.
67 Namespaces are supported, and can be used to partition caches so that multiple applications can use the same memcached servers.
69 \fBmemcached_st\fP structures are thread\-safe, but each thread must
70 contain its own structure (that is, if you want to share these among
71 threads you must provide your own locking). No global variables are
74 If you are working with GNU autotools you will want to add the following to
75 your COPYING to properly include libmemcached in your application.
77 PKG_CHECK_MODULES(DEPS, libmemcached >= 0.8.0)
81 Some features of the library must be enabled through memcached_behavior_set().
86 A number of constants have been provided for in the library.
89 .B MEMCACHED_DEFAULT_PORT
91 The default port used by memcached(3).
97 Default maximum size of a key (which includes the null pointer). Master keys
98 have no limit, this only applies to keys used for storage.
104 Default size of key (which includes the null pointer).
110 This is the "stride" used in the consistent hash used between replicas.
114 .B MEMCACHED_MAX_HOST_LENGTH
116 Maximum allowed size of the hostname.
120 .B LIBMEMCACHED_VERSION_STRING
122 String value of libmemcached version such as "1.23.4"
126 .B LIBMEMCACHED_VERSION_HEX
128 Hex value of the version number. "0x00048000" This can be used for comparing versions based on number.
130 .SH THREADS AND PROCESSES
132 When using threads or forked processes it is important to keep an instance
133 of \fBmemcached_st\fP per process or thread. Without creating your own locking
134 structures you can not share a single \fBmemcached_st\fP. You can though call
135 memcached_quit(3) on a \fBmemcached_st\fP and then use the resulting cloned
139 To find out more information please check:
140 \fI\%https://launchpad.net/libmemcached\fP
143 \fImemcached(1)\fP \fIlibmemcached_examples(3)\fP \fIlibmemcached(1)\fP \fImemcat(1)\fP \fImemcp(1)\fP \fImemflush(1)\fP \fImemrm(1)\fP \fImemslap(1)\fP \fImemstat(1)\fP \fImemcached_fetch(3)\fP \fImemcached_replace(3)\fP \fImemcached_server_list_free(3)\fP \fIlibmemcached_examples(3)\fP \fImemcached_clone(3)\fP \fImemcached_free(3)\fP
144 \fImemcached_server_add(3)\fP \fImemcached_server_push(3)\fP \fImemcached_add(3)\fP \fImemcached_get(3)\fP \fImemcached_server_count(3)\fP \fImemcached_servers_parse(3)\fP \fImemcached_create(3)\fP \fImemcached_increment(3)\fP \fImemcached_server_list(3)\fP \fImemcached_set(3)\fP
145 \fImemcached_decrement(3)\fP \fImemcached_mget(3)\fP \fImemcached_server_list_append(3)\fP \fImemcached_strerror(3)\fP \fImemcached_delete(3)\fP \fImemcached_quit(3)\fP \fImemcached_server_list_count(3)\fP \fImemcached_verbosity(3)\fP \fImemcached_server_add_unix_socket(3)\fP \fImemcached_result_create(3)\fP \fImemcached_result_free(3)\fP
146 \fImemcached_result_key_value(3)\fP \fImemcached_result_key_length(3)\fP \fImemcached_result_value(3)\fP \fImemcached_result_length(3)\fP \fImemcached_result_flags(3)\fP
147 \fImemcached_result_cas(3)\fP \fImemcached_result_st(3)\fP \fImemcached_append(3)\fP \fImemcached_prepend(3)\fP \fImemcached_fetch_result(3)\fP
148 \fImemerror(1)\fP \fImemcached_get_by_key(3)\fP \fImemcached_mget_by_key(3)\fP \fImemcached_delete_by_key(3)\fP
149 \fImemcached_fetch_execute(3)\fP \fImemcached_callback_get(3)\fP \fImemcached_callback_set(3)\fP \fImemcached_version(3)\fP
150 \fImemcached_lib_version(3)\fP \fImemcached_result_set_value(3)\fP \fImemcached_dump(3)\fP \fImemdump(1)\fP
151 \fImemcached_set_memory_allocators(3)\fP \fImemcached_get_memory_allocators(3)\fP \fImemcached_get_user_data(3)\fP \fImemcached_set_user_data(3)\fP
155 2011, Brian Aker DataDifferential, http://datadifferential.com/
156 .\" Generated by docutils manpage writer.