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

   1 .TH "LIBMEMCACHED" "3" "April 14, 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 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.
  64 .sp
  65 Group keys can be optionally used to group sets of objects with servers.
  66 .sp
  67 Namespaces are supported, and can be used to partition caches so that multiple applications can use the same memcached servers.
  68 .sp
  69 \fBmemcached_st\fP structures are thread\-safe, but each thread must
  70 contain its own structure (that is, if you want to share these among
  71 threads you must provide your own locking). No global variables are
  72 used in this library.
  73 .sp
  74 If you are working with GNU autotools you will want to add the following to
  75 your COPYING to properly include libmemcached in your application.
  76 .sp
  77 PKG_CHECK_MODULES(DEPS, libmemcached >= 0.8.0)
  78 AC_SUBST(DEPS_CFLAGS)
  79 AC_SUBST(DEPS_LIBS)
  80 .sp
  81 Some features of the library must be enabled through memcached_behavior_set().
  82 .sp
  83 Hope you enjoy it!
  84 .SH CONSTANTS
  85 .sp
  86 A number of constants have been provided for in the library.
  87 .INDENT 0.0
  88 .TP
  89 .B MEMCACHED_DEFAULT_PORT
  90 .
  91 The default port used by memcached(3).
  92 .UNINDENT
  93 .INDENT 0.0
  94 .TP
  95 .B MEMCACHED_MAX_KEY
  96 .
  97 Default maximum size of a key (which includes the null pointer). Master keys
  98 have no limit, this only applies to keys used for storage.
  99 .UNINDENT
 100 .INDENT 0.0
 101 .TP
 102 .B MEMCACHED_MAX_KEY
 103 .
 104 Default size of key (which includes the null pointer).
 105 .UNINDENT
 106 .INDENT 0.0
 107 .TP
 108 .B MEMCACHED_STRIDE
 109 .
 110 This is the "stride" used in the consistent hash used between replicas.
 111 .UNINDENT
 112 .INDENT 0.0
 113 .TP
 114 .B MEMCACHED_MAX_HOST_LENGTH
 115 .
 116 Maximum allowed size of the hostname.
 117 .UNINDENT
 118 .INDENT 0.0
 119 .TP
 120 .B LIBMEMCACHED_VERSION_STRING
 121 .
 122 String value of libmemcached version such as "1.23.4"
 123 .UNINDENT
 124 .INDENT 0.0
 125 .TP
 126 .B LIBMEMCACHED_VERSION_HEX
 127 .
 128 Hex value of the version number. "0x00048000" This can be used for comparing versions based on number.
 129 .UNINDENT
 130 .SH THREADS AND PROCESSES
 131 .sp
 132 When using threads or forked processes it is important to keep an instance
 133 of \fBmemcached_st\fP per process or thread. Without creating your own locking
 134 structures you can not share a single \fBmemcached_st\fP. You can though call
 135 memcached_quit(3) on a \fBmemcached_st\fP and then use the resulting cloned
 136 structure.
 137 .SH HOME
 138 .sp
 139 To find out more information please check:
 140 \fI\%http://libmemcached.org/\fP
 141 .SH SEE ALSO
 142 .sp
 143 \fImemcached(1)\fP \fIlibmemcached_examples(3)\fP
 144 \fIlibmemcached(1)\fP \fImemcat(1)\fP \fImemcp(1)\fP
 145 \fImemflush(1)\fP \fImemrm(1)\fP \fImemslap(1)\fP
 146 \fImemstat(1)\fP \fImemcached_fetch(3)\fP
 147 \fImemcached_replace(3)\fP \fImemcached_server_list_free(3)\fP
 148 \fIlibmemcached_examples(3)\fP \fImemcached_clone(3)\fP
 149 \fImemcached_free(3)\fP \fImemcached_server_add(3)\fP
 150 \fImemcached_server_push(3)\fP \fImemcached_add(3)\fP
 151 \fImemcached_get(3)\fP \fImemcached_server_count(3)\fP
 152 \fImemcached_create(3)\fP \fImemcached_increment(3)\fP
 153 \fImemcached_server_list(3)\fP \fImemcached_set(3)\fP
 154 \fImemcached_decrement(3)\fP \fImemcached_mget(3)\fP
 155 \fImemcached_server_list_append(3)\fP \fImemcached_strerror(3)\fP
 156 \fImemcached_delete(3)\fP \fImemcached_quit(3)\fP
 157 \fImemcached_server_list_count(3)\fP \fImemcached_verbosity(3)\fP
 158 \fImemcached_server_add_unix_socket(3)\fP
 159 \fImemcached_result_create(3)\fP  \fImemcached_result_free(3)\fP
 160 \fImemcached_result_key_value(3)\fP
 161 \fImemcached_result_key_length(3)\fP
 162 \fImemcached_result_value(3)\fP  \fImemcached_result_length(3)\fP
 163 \fImemcached_result_flags(3)\fP  \fImemcached_result_cas(3)\fP
 164 \fImemcached_result_st(3)\fP \fImemcached_append(3)\fP
 165 \fImemcached_prepend(3)\fP \fImemcached_fetch_result(3)\fP
 166 \fImemerror(1)\fP \fImemcached_get_by_key(3)\fP
 167 \fImemcached_mget_by_key(3)\fP \fImemcached_delete_by_key(3)\fP
 168 \fImemcached_fetch_execute(3)\fP \fImemcached_callback_get(3)\fP
 169 \fImemcached_callback_set(3)\fP \fImemcached_version(3)\fP
 170 \fImemcached_lib_version(3)\fP \fImemcached_result_set_value(3)\fP
 171 \fImemcached_dump(3)\fP \fImemdump(1)\fP
 172 \fImemcached_set_memory_allocators(3)\fP
 173 \fImemcached_get_memory_allocators(3)\fP
 174 \fImemcached_get_user_data(3)\fP \fImemcached_set_user_data(3)\fP
 175 .SH AUTHOR
 176 Brian Aker
 177 .SH COPYRIGHT
 178 2011, Brian Aker DataDifferential, http://datadifferential.com/
 179 .\" Generated by docutils manpage writer.
 180 .\"
 181 .