git.m6w6.name Git - awesomized/libmemcached/blob - docs/man/libmemcached.3

   1 .TH "LIBMEMCACHED" "3" "October 18, 2011" "1.01" "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
  39 .sp
  40 .ce
  41 ----
  42
  43 .ce 0
  44 .sp
  45 .sp
  46 libMemcached is an open source C/C++ client library and tools for the memcached server (\fI\%http://memcached.org/\fP). It has been designed to be light on memory usage, thread safe, and provide full access to server side methods.
  47 .sp
  48 libMemcached was designed to provide the greatest number of options to use Memcached. Some of the features provided:
  49 .INDENT 0.0
  50 .IP 1. 3
  51 .
  52 Asynchronous and Synchronous Transport Support.
  53 .IP 2. 3
  54 .
  55 Consistent Hashing and Distribution.
  56 .IP 3. 3
  57 .
  58 Tunable Hashing algorithm to match keys.
  59 .IP 4. 3
  60 .
  61 Access to large object support.
  62 .IP 5. 3
  63 .
  64 Local replication.
  65 .IP 6. 3
  66 .
  67 A complete reference guide and documentation to the API.
  68 .IP 7. 3
  69 .
  70 Tools to Manage your Memcached networks.
  71 .UNINDENT
  72 .SH DESCRIPTION
  73 .sp
  74 "Memcached is a high\-performance, distributed memory object caching
  75 system, generic in nature, but intended for use in speeding up dynamic web
  76 applications by alleviating database load." \fI\%http://memcached.org/\fP
  77 .sp
  78 \fBlibmemcached\fP is a small, thread\-safe client library for the
  79 memcached protocol. The code has all been written to allow
  80 for both web and embedded usage. It handles the work behind routing
  81 individual keys to specific servers specified by the developer (and values are
  82 matched based on server order as supplied by the user). It implements
  83 a modular and consistent method of object distribution.
  84 .sp
  85 There are multiple implemented routing and hashing methods. See the
  86 \fBmemcached_behavior_set()\fP manpage for more information.
  87 .sp
  88 All operations are performed against a \fBmemcached_st\fP structure.
  89 These structures can either be dynamically allocated or statically
  90 allocated and then initialized by \fBmemcached_create()\fP. Functions have
  91 been written in order to encapsulate the \fBmemcached_st\fP. It is not
  92 recommended that you operate directly against the structure.
  93 .sp
  94 Nearly all functions return a \fBmemcached_return_t\fP value.
  95 This value can be translated to a printable string with
  96 \fBmemcached_strerror()\fP.
  97 .sp
  98 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.
  99 .sp
 100 Group keys can be optionally used to group sets of objects with servers.
 101 .sp
 102 Namespaces are supported, and can be used to partition caches so that multiple applications can use the same memcached servers.
 103 .sp
 104 \fBmemcached_st\fP structures are thread\-safe, but each thread must
 105 contain its own structure (that is, if you want to share these among
 106 threads you must provide your own locking). No global variables are
 107 used in this library.
 108 .sp
 109 If you are working with GNU autotools you will want to add the following to
 110 your COPYING to properly include libmemcached in your application.
 111 .sp
 112 PKG_CHECK_MODULES(DEPS, libmemcached >= 0.8.0)
 113 AC_SUBST(DEPS_CFLAGS)
 114 AC_SUBST(DEPS_LIBS)
 115 .sp
 116 Some features of the library must be enabled through \fBmemcached_behavior_set()\fP.
 117 .sp
 118 Hope you enjoy it!
 119 .SH CONSTANTS
 120 .sp
 121 A number of constants have been provided for in the library.
 122 .INDENT 0.0
 123 .TP
 124 .B MEMCACHED_DEFAULT_PORT
 125 .
 126 The default port used by memcached(3).
 127 .UNINDENT
 128 .INDENT 0.0
 129 .TP
 130 .B MEMCACHED_MAX_KEY
 131 .
 132 Default maximum size of a key (which includes the null pointer). Master keys
 133 have no limit, this only applies to keys used for storage.
 134 .UNINDENT
 135 .INDENT 0.0
 136 .TP
 137 .B MEMCACHED_MAX_KEY
 138 .
 139 Default size of key (which includes the null pointer).
 140 .UNINDENT
 141 .INDENT 0.0
 142 .TP
 143 .B MEMCACHED_STRIDE
 144 .
 145 This is the "stride" used in the consistent hash used between replicas.
 146 .UNINDENT
 147 .INDENT 0.0
 148 .TP
 149 .B MEMCACHED_MAX_HOST_LENGTH
 150 .
 151 Maximum allowed size of the hostname.
 152 .UNINDENT
 153 .INDENT 0.0
 154 .TP
 155 .B LIBMEMCACHED_VERSION_STRING
 156 .
 157 String value of libmemcached version such as "1.23.4"
 158 .UNINDENT
 159 .INDENT 0.0
 160 .TP
 161 .B LIBMEMCACHED_VERSION_HEX
 162 .
 163 Hex value of the version number. "0x00048000" This can be used for comparing versions based on number.
 164 .UNINDENT
 165 .SH THREADS AND PROCESSES
 166 .sp
 167 When using threads or forked processes it is important to keep one instance
 168 of \fBmemcached_st\fP per process or thread. Without creating your own
 169 locking structures you can not share a single \fBmemcached_st\fP. However,
 170 you can call \fBmemcached_quit()\fP on a \fBmemcached_st\fP and then use the resulting cloned structure.
 171 .SH HOME
 172 .sp
 173 To find out more information please check:
 174 \fI\%http://libmemcached.org/\fP
 175 .SH SEE ALSO
 176 .sp
 177 \fImemcached(1)\fP \fIlibmemcached_examples(3)\fP
 178 \fIlibmemcached(1)\fP \fImemcat(1)\fP \fImemcp(1)\fP
 179 \fImemflush(1)\fP \fImemrm(1)\fP \fImemslap(1)\fP
 180 \fImemstat(1)\fP \fImemcached_fetch(3)\fP
 181 \fImemcached_replace(3)\fP \fImemcached_server_list_free(3)\fP
 182 \fIlibmemcached_examples(3)\fP \fImemcached_clone(3)\fP
 183 \fImemcached_free(3)\fP \fImemcached_server_add(3)\fP
 184 \fImemcached_server_push(3)\fP \fImemcached_add(3)\fP
 185 \fImemcached_get(3)\fP \fImemcached_server_count(3)\fP
 186 \fImemcached_create(3)\fP \fImemcached_increment(3)\fP
 187 \fImemcached_server_list(3)\fP \fImemcached_set(3)\fP
 188 \fImemcached_decrement(3)\fP \fImemcached_mget(3)\fP
 189 \fImemcached_server_list_append(3)\fP \fImemcached_strerror(3)\fP
 190 \fImemcached_delete(3)\fP \fImemcached_quit(3)\fP
 191 \fImemcached_server_list_count(3)\fP \fImemcached_verbosity(3)\fP
 192 \fImemcached_server_add_unix_socket(3)\fP
 193 \fImemcached_result_create(3)\fP  \fImemcached_result_free(3)\fP
 194 \fImemcached_result_key_value(3)\fP
 195 \fImemcached_result_key_length(3)\fP
 196 \fImemcached_result_value(3)\fP  \fImemcached_result_length(3)\fP
 197 \fImemcached_result_flags(3)\fP  \fImemcached_result_cas(3)\fP
 198 \fImemcached_result_st(3)\fP \fImemcached_append(3)\fP
 199 \fImemcached_prepend(3)\fP \fImemcached_fetch_result(3)\fP
 200 \fImemerror(1)\fP \fImemcached_get_by_key(3)\fP
 201 \fImemcached_mget_by_key(3)\fP \fImemcached_delete_by_key(3)\fP
 202 \fImemcached_fetch_execute(3)\fP \fImemcached_callback_get(3)\fP
 203 \fImemcached_callback_set(3)\fP \fImemcached_version(3)\fP
 204 \fImemcached_lib_version(3)\fP \fImemcached_result_set_value(3)\fP
 205 \fImemcached_dump(3)\fP \fImemdump(1)\fP
 206 \fImemcached_set_memory_allocators(3)\fP
 207 \fImemcached_get_memory_allocators(3)\fP
 208 \fImemcached_get_user_data(3)\fP \fImemcached_set_user_data(3)\fP
 209 .SH AUTHOR
 210 Brian Aker
 211 .SH COPYRIGHT
 212 2011, Brian Aker DataDifferential, http://datadifferential.com/
 213 .\" Generated by docutils manpage writer.
 214 .\"
 215 .