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

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