3f8dc5857591481c67036c5c8ce06bbd5a0476d6
[m6w6/libmemcached] / docs / man / libmemcached.3
1 .TH "LIBMEMCACHED" "3" "April 08, 2011" "0.47" "libmemcached"
2 .SH NAME
3 libmemcached \- libmemcached Documentation
4 .
5 .nr rst2man-indent-level 0
6 .
7 .de1 rstReportMargin
8 \\$1 \\n[an-margin]
9 level \\n[rst2man-indent-level]
10 level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
11 -
12 \\n[rst2man-indent0]
13 \\n[rst2man-indent1]
14 \\n[rst2man-indent2]
15 ..
16 .de1 INDENT
17 .\" .rstReportMargin pre:
18 . RS \\$1
19 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
20 . nr rst2man-indent-level +1
21 .\" .rstReportMargin post:
22 ..
23 .de UNINDENT
24 . RE
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
30 ..
31 .\" Man page generated from reStructeredText.
32 .
33 .sp
34 Client library for memcached
35 .SH LIBRARY
36 .sp
37 C Client Library for memcached (libmemcached, \-lmemcached)
38 .SH SYNOPSIS
39 .sp
40 .nf
41 .ft C
42 #include <libmemcached/memcached.h>
43 .ft P
44 .fi
45 .SH DESCRIPTION
46 .sp
47 "Memcached is a high\-performance, distributed memory object caching
48 system, generic in nature, but intended for use in speeding up dynamic web
49 applications by alleviating database load." \fI\%http://danga.com/memcached/\fP
50 .sp
51 \fBlibmemcached\fP is a small, thread\-safe client library for the
52 memcached protocol. The code has all been written with an eye to allow
53 for both web and embedded usage. It handles the work behind routing
54 particular keys to specific servers that you specify (and values are
55 matched based on server order as supplied by you). It implements both
56 a modula and consistent method of object distribution.
57 .sp
58 There are multiple implemented routing and hashing methods. See the
59 memcached_behavior_set() manpage.
60 .sp
61 All operations are performed against a \fBmemcached_st\fP structure.
62 These structures can either be dynamically allocated or statically
63 allocated and then initialized by memcached_create(). Functions have been
64 written in order to encapsulate the \fBmemcached_st\fP. It is not
65 recommended that you operate directly against the structure.
66 .sp
67 Nearly all functions return a \fBmemcached_return_t\fP value.
68 This value can be translated to a printable string with memcached_strerror(3).
69 .sp
70 Partitioning based on keys is supported in the library. Using the key partioning
71 functions it is possible to group sets of object onto servers.
72 .sp
73 \fBmemcached_st\fP structures are thread\-safe, but each thread must
74 contain its own structure (that is, if you want to share these among
75 threads you must provide your own locking). No global variables are
76 used in this library.
77 .sp
78 If you are working with GNU autotools you will want to add the following to
79 your configure.ac to properly include libmemcached in your application.
80 .sp
81 PKG_CHECK_MODULES(DEPS, libmemcached >= 0.8.0)
82 AC_SUBST(DEPS_CFLAGS)
83 AC_SUBST(DEPS_LIBS)
84 .sp
85 Some features of the library must be enabled through memcached_behavior_set().
86 .sp
87 Hope you enjoy it!
88 .SH CONSTANTS
89 .sp
90 A number of constants have been provided for in the library.
91 .INDENT 0.0
92 .TP
93 .B MEMCACHED_DEFAULT_PORT
94 .
95 The default port used by memcached(3).
96 .UNINDENT
97 .INDENT 0.0
98 .TP
99 .B MEMCACHED_MAX_KEY
100 .
101 Default maximum size of a key (which includes the null pointer). Master keys
102 have no limit, this only applies to keys used for storage.
103 .UNINDENT
104 .INDENT 0.0
105 .TP
106 .B MEMCACHED_MAX_KEY
107 .
108 Default size of key (which includes the null pointer).
109 .UNINDENT
110 .INDENT 0.0
111 .TP
112 .B MEMCACHED_STRIDE
113 .
114 This is the "stride" used in the consistent hash used between replicas.
115 .UNINDENT
116 .INDENT 0.0
117 .TP
118 .B MEMCACHED_MAX_HOST_LENGTH
119 .
120 Maximum allowed size of the hostname.
121 .UNINDENT
122 .INDENT 0.0
123 .TP
124 .B LIBMEMCACHED_VERSION_STRING
125 .
126 String value of libmemcached version such as "1.23.4"
127 .UNINDENT
128 .INDENT 0.0
129 .TP
130 .B LIBMEMCACHED_VERSION_HEX
131 .
132 Hex value of the version number. "0x00048000" This can be used for comparing versions based on number.
133 .UNINDENT
134 .SH THREADS AND PROCESSES
135 .sp
136 When using threads or forked processes it is important to keep an instance
137 of \fBmemcached_st\fP per process or thread. Without creating your own locking
138 structures you can not share a single \fBmemcached_st\fP. You can though call
139 memcached_quit(3) on a \fBmemcached_st\fP and then use the resulting cloned
140 structure.
141 .SH HOME
142 .sp
143 To find out more information please check:
144 \fI\%https://launchpad.net/libmemcached\fP
145 .SH AUTHOR
146 .sp
147 Brian Aker, <\fI\%brian@tangent.org\fP>
148 .SH SEE ALSO
149 .sp
150 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)
151 .SH AUTHOR
152 Brian Aker
153 .SH COPYRIGHT
154 2011, Brian Aker
155 .\" Generated by docutils manpage writer.
156 .\"
157 .