d70d225c6dc34ecd663956d6c249b0d648b0dc11
[m6w6/libmemcached] / docs / man / libmemcached.3
1 .TH "LIBMEMCACHED" "3" "April 09, 2011" "0.47" "libmemcached"
2 .SH NAME
3 libmemcached \- Introducing the C Client Library for memcached
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 .SH SYNOPSIS
34 .sp
35 #include <libmemcached/memcached.h>
36 .sp
37 Compile and link with \-lmemcached
38 .SH DESCRIPTION
39 .sp
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
43 .sp
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.
50 .sp
51 There are multiple implemented routing and hashing methods. See the
52 memcached_behavior_set() manpage.
53 .sp
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.
59 .sp
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).
62 .sp
63 Partitioning based on keys is testsed in the library. Using the key partioning
64 functions it is possible to group sets of object onto servers.
65 .sp
66 \fBmemcached_st\fP structures are thread\-safe, but each thread must
67 contain its own structure (that is, if you want to share these among
68 threads you must provide your own locking). No global variables are
69 used in this library.
70 .sp
71 If you are working with GNU autotools you will want to add the following to
72 your COPYING to properly include libmemcached in your application.
73 .sp
74 PKG_CHECK_MODULES(DEPS, libmemcached >= 0.8.0)
75 AC_SUBST(DEPS_CFLAGS)
76 AC_SUBST(DEPS_LIBS)
77 .sp
78 Some features of the library must be enabled through memcached_behavior_set().
79 .sp
80 Hope you enjoy it!
81 .SH CONSTANTS
82 .sp
83 A number of constants have been provided for in the library.
84 .INDENT 0.0
85 .TP
86 .B MEMCACHED_DEFAULT_PORT
87 .
88 The default port used by memcached(3).
89 .UNINDENT
90 .INDENT 0.0
91 .TP
92 .B MEMCACHED_MAX_KEY
93 .
94 Default maximum size of a key (which includes the null pointer). Master keys
95 have no limit, this only applies to keys used for storage.
96 .UNINDENT
97 .INDENT 0.0
98 .TP
99 .B MEMCACHED_MAX_KEY
100 .
101 Default size of key (which includes the null pointer).
102 .UNINDENT
103 .INDENT 0.0
104 .TP
105 .B MEMCACHED_STRIDE
106 .
107 This is the "stride" used in the consistent hash used between replicas.
108 .UNINDENT
109 .INDENT 0.0
110 .TP
111 .B MEMCACHED_MAX_HOST_LENGTH
112 .
113 Maximum allowed size of the hostname.
114 .UNINDENT
115 .INDENT 0.0
116 .TP
117 .B LIBMEMCACHED_VERSION_STRING
118 .
119 String value of libmemcached version such as "1.23.4"
120 .UNINDENT
121 .INDENT 0.0
122 .TP
123 .B LIBMEMCACHED_VERSION_HEX
124 .
125 Hex value of the version number. "0x00048000" This can be used for comparing versions based on number.
126 .UNINDENT
127 .SH THREADS AND PROCESSES
128 .sp
129 When using threads or forked processes it is important to keep an instance
130 of \fBmemcached_st\fP per process or thread. Without creating your own locking
131 structures you can not share a single \fBmemcached_st\fP. You can though call
132 memcached_quit(3) on a \fBmemcached_st\fP and then use the resulting cloned
133 structure.
134 .SH HOME
135 .sp
136 To find out more information please check:
137 \fI\%https://launchpad.net/libmemcached\fP
138 .SH SEE ALSO
139 .sp
140 \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
141 \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
142 \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
143 \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
144 \fImemcached_result_cas(3)\fP \fImemcached_result_st(3)\fP \fImemcached_append(3)\fP \fImemcached_prepend(3)\fP \fImemcached_fetch_result(3)\fP
145 \fImemerror(1)\fP \fImemcached_get_by_key(3)\fP \fImemcached_mget_by_key(3)\fP \fImemcached_delete_by_key(3)\fP
146 \fImemcached_fetch_execute(3)\fP \fImemcached_callback_get(3)\fP \fImemcached_callback_set(3)\fP \fImemcached_version(3)\fP
147 \fImemcached_lib_version(3)\fP \fImemcached_result_set_value(3)\fP \fImemcached_dump(3)\fP \fImemdump(1)\fP
148 \fImemcached_set_memory_allocators(3)\fP \fImemcached_get_memory_allocators(3)\fP \fImemcached_get_user_data(3)\fP \fImemcached_set_user_data(3)\fP
149 .SH AUTHOR
150 Brian Aker
151 .SH COPYRIGHT
152 2011, Brian Aker DataDifferential, http://datadifferential.com/
153 .\" Generated by docutils manpage writer.
154 .\"
155 .