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

   1 .TH "LIBMEMCACHED" "3" "April 07, 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 .sp
  92 MEMCACHED_DEFAULT_PORT
  93 .INDENT 0.0
  94 .INDENT 3.5
  95 .sp
  96 The default port used by memcached(3).
  97 .UNINDENT
  98 .UNINDENT
  99 .sp
 100 MEMCACHED_MAX_KEY
 101 .INDENT 0.0
 102 .INDENT 3.5
 103 .sp
 104 Default maximum size of a key (which includes the null pointer). Master keys
 105 have no limit, this only applies to keys used for storage.
 106 .UNINDENT
 107 .UNINDENT
 108 .sp
 109 MEMCACHED_MAX_KEY
 110 .INDENT 0.0
 111 .INDENT 3.5
 112 .sp
 113 Default size of key (which includes the null pointer).
 114 .UNINDENT
 115 .UNINDENT
 116 .sp
 117 MEMCACHED_STRIDE
 118 .INDENT 0.0
 119 .INDENT 3.5
 120 .sp
 121 This is the "stride" used in the consistent hash used between replicas.
 122 .UNINDENT
 123 .UNINDENT
 124 .sp
 125 MEMCACHED_MAX_HOST_LENGTH
 126 .INDENT 0.0
 127 .INDENT 3.5
 128 .sp
 129 Maximum allowed size of the hostname.
 130 .UNINDENT
 131 .UNINDENT
 132 .sp
 133 MEMCACHED_VERSION_STRING
 134 .INDENT 0.0
 135 .INDENT 3.5
 136 .sp
 137 String value of libmemcached version such as "1.23.4"
 138 .UNINDENT
 139 .UNINDENT
 140 .sp
 141 MEMCACHED_MAJOR_VERSION
 142 .INDENT 0.0
 143 .INDENT 3.5
 144 .sp
 145 Major version value. Such as 1.23.4, would be 1
 146 .UNINDENT
 147 .UNINDENT
 148 .sp
 149 MEMCACHED_MINOR_VERSION
 150 .INDENT 0.0
 151 .INDENT 3.5
 152 .sp
 153 Major version value. Such as 1.23.4, would be 23
 154 .UNINDENT
 155 .UNINDENT
 156 .sp
 157 MEMCACHED_MICRO_VERSION
 158 .INDENT 0.0
 159 .INDENT 3.5
 160 .sp
 161 Major version value. Such as 1.23.4, would be 4
 162 .UNINDENT
 163 .UNINDENT
 164 .SH THREADS AND PROCESSES
 165 .sp
 166 When using threads or forked processes it is important to keep an instance
 167 of \fBmemcached_st\fP per process or thread. Without creating your own locking
 168 structures you can not share a single \fBmemcached_st\fP. You can though call
 169 memcached_quit(3) on a \fBmemcached_st\fP and then use the resulting cloned
 170 structure.
 171 .SH HOME
 172 .sp
 173 To find out more information please check:
 174 \fI\%https://launchpad.net/libmemcached\fP
 175 .SH AUTHOR
 176 .sp
 177 Brian Aker, <\fI\%brian@tangent.org\fP>
 178 .SH SEE ALSO
 179 .sp
 180 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)
 181 .SH AUTHOR
 182 Brian Aker
 183 .SH COPYRIGHT
 184 2011, Brian Aker
 185 .\" Generated by docutils manpage writer.
 186 .\"
 187 .