1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
|
==============================================
Introducing the C Client Library for memcached
==============================================
--------
SYNOPSIS
--------
#include <libmemcached/memcached.h>
Compile and link with -lmemcached
=======
libMemcached is an open source C/C++ client library and tools for the memcached server (http://memcached.org/). It has been designed to be light on memory usage, thread safe, and provide full access to server side methods.
libMemcached was designed to provide the greatest number of options to use Memcached. Some of the features provided:
1. Asynchronous and Synchronous Transport Support.
2. Consistent Hashing and Distribution.
3. Tunable Hashing algorithm to match keys.
4. Access to large object support.
5. Local replication.
6. A complete reference guide and documentation to the API.
7. Tools to Manage your Memcached networks.
-----------
DESCRIPTION
-----------
"Memcached is a high-performance, distributed memory object caching
system, generic in nature, but intended for use in speeding up dynamic web
applications by alleviating database load." `http://memcached.org/ <http://memcached.org/>`_
:program:`libmemcached` is a small, thread-safe client library for the
memcached protocol. The code has all been written to allow
for both web and embedded usage. It handles the work behind routing
individual keys to specific servers specified by the developer (and values are
matched based on server order as supplied by the user). It implements
a modular and consistent method of object distribution.
There are multiple implemented routing and hashing methods. See the
:c:func:`memcached_behavior_set` manpage for more information.
All operations are performed against a :c:type:`memcached_st` structure.
These structures can either be dynamically allocated or statically
allocated and then initialized by :c:func:`memcached_create`. Functions have
been written in order to encapsulate the :c:type:`memcached_st`. It is not
recommended that you operate directly against the structure.
Nearly all functions return a :c:type:`memcached_return_t` value.
This value can be translated to a printable string with
:c:type:`memcached_strerror`.
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.
Group keys can be optionally used to group sets of objects with servers.
Namespaces are supported, and can be used to partition caches so that multiple applications can use the same memcached servers.
:c:type:`memcached_st` structures are thread-safe, but each thread must
contain its own structure (that is, if you want to share these among
threads you must provide your own locking). No global variables are
used in this library.
If you are working with GNU autotools you will want to add the following to
your COPYING to properly include libmemcached in your application.
PKG_CHECK_MODULES(DEPS, libmemcached >= 0.8.0)
AC_SUBST(DEPS_CFLAGS)
AC_SUBST(DEPS_LIBS)
Some features of the library must be enabled through :c:func:`memcached_behavior_set`.
Hope you enjoy it!
---------
CONSTANTS
---------
A number of constants have been provided for in the library.
.. c:macro:: MEMCACHED_DEFAULT_PORT
The default port used by memcached(3).
.. c:macro:: MEMCACHED_MAX_KEY
Default maximum size of a key (which includes the null pointer). Master keys
have no limit, this only applies to keys used for storage.
.. c:macro:: MEMCACHED_MAX_KEY
Default size of key (which includes the null pointer).
.. c:macro:: MEMCACHED_STRIDE
This is the "stride" used in the consistent hash used between replicas.
.. c:macro:: MEMCACHED_MAX_HOST_LENGTH
Maximum allowed size of the hostname.
.. c:macro:: LIBMEMCACHED_VERSION_STRING
String value of libmemcached version such as "1.23.4"
.. c:macro:: LIBMEMCACHED_VERSION_HEX
Hex value of the version number. "0x00048000" This can be used for comparing versions based on number.
.. c:macro:: MEMCACHED_PREFIX_KEY_MAX_SIZE
Maximum length allowed for namespacing of a key.
---------------------
THREADS AND PROCESSES
---------------------
When using threads or forked processes it is important to keep one instance
of :c:type:`memcached_st` per process or thread. Without creating your own
locking structures you can not share a single :c:type:`memcached_st`. However,
you can call :c:func:`memcached_quit` on a :c:type:`memcached_st` and then use the resulting cloned structure.
----
HOME
----
To find out more information please check:
`http://libmemcached.org/ <http://libmemcached.org/>`_
--------
SEE ALSO
--------
: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)` :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_create(3)` :manpage:`memcached_increment(3)`
:manpage:`memcached_server_list(3)` :manpage:`memcached_set(3)`
: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)`
: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)` :manpage:`memcached_result_cas(3)`
:manpage:`memcached_result_st(3)` :manpage:`memcached_append(3)`
:manpage:`memcached_prepend(3)` :manpage:`memcached_fetch_result(3)`
:manpage:`memerror(1)` :manpage:`memcached_get_by_key(3)`
:manpage:`memcached_mget_by_key(3)` :manpage:`memcached_delete_by_key(3)`
:manpage:`memcached_fetch_execute(3)` :manpage:`memcached_callback_get(3)`
:manpage:`memcached_callback_set(3)` :manpage:`memcached_version(3)`
:manpage:`memcached_lib_version(3)` :manpage:`memcached_result_set_value(3)`
:manpage:`memcached_dump(3)` :manpage:`memdump(1)`
:manpage:`memcached_set_memory_allocators(3)`
:manpage:`memcached_get_memory_allocators(3)`
:manpage:`memcached_get_user_data(3)` :manpage:`memcached_set_user_data(3)`
|
