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

   1 .TH "MEMCACHED" "3" "May 03, 2012" "1.0.7" "libmemcached"
   2 .SH NAME
   3 memcached \- 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 .SH SYNOPSIS
  34 .sp
  35 #include <libmemcached\-1.0/memcached.h>
  36 .INDENT 0.0
  37 .TP
  38 .B LIBMEMCACHED
  39 .UNINDENT
  40 .INDENT 0.0
  41 .TP
  42 .B memcached_st *memcached(const char\fI\ *string\fP, size_t\fI\ string_length\fP)
  43 .UNINDENT
  44 .INDENT 0.0
  45 .TP
  46 .B memcached_return_t libmemcached_check_configuration(const char\fI\ *option_string\fP, size_t\fI\ length\fP, char\fI\ *error_buffer\fP, size_t\fI\ error_buffer_size\fP)
  47 .UNINDENT
  48 .sp
  49 Compile and link with \-lmemcached
  50 .SH DESCRIPTION
  51 .sp
  52 Libmemcached implements a custom language for configuring and modifying
  53 servers. By passing in an option string you can generate a \fBmemcached_st\fP object
  54 that you can use in your application directly.
  55 .INDENT 0.0
  56 .TP
  57 .B \-\-SERVER=<servername>:<optional_port>/?<optional_weight>
  58 .UNINDENT
  59 .sp
  60 Provide a servername to be used by the client. Providing a weight will cause weighting to occur with all hosts with each server getting a default weight of 1.
  61 .INDENT 0.0
  62 .TP
  63 .B \-\-SOCKET="<filepath>/?<optional_weight>"
  64 .UNINDENT
  65 .sp
  66 Provide a filepath to a UNIX socket file. Providing a weight will cause weighting to occur with all hosts with each server getting a default weight of 1.
  67 .INDENT 0.0
  68 .TP
  69 .B \-\-VERIFY\-KEY
  70 .UNINDENT
  71 .sp
  72 Verify that keys that are being used fit within the design of the protocol being used.
  73 .INDENT 0.0
  74 .TP
  75 .B \-\-REMOVE_FAILED_SERVERS
  76 .UNINDENT
  77 .sp
  78 Enable the behavior MEMCACHED_BEHAVIOR_REMOVE_FAILED_SERVERS.
  79 .INDENT 0.0
  80 .TP
  81 .B \-\-BINARY\-PROTOCOL
  82 .UNINDENT
  83 .sp
  84 Force all connections to use the binary protocol.
  85 .INDENT 0.0
  86 .TP
  87 .B \-\-BUFFER\-REQUESTS
  88 .UNINDENT
  89 .sp
  90 Enable MEMCACHED_BEHAVIOR_BUFFER_REQUESTS.
  91 .INDENT 0.0
  92 .TP
  93 .B \-\-CONFIGURE\-FILE=
  94 .UNINDENT
  95 .sp
  96 Provide a configuration file to be used to load requests. Beware that by using a configuration file libmemcached will reset memcached_st based on information only contained in the file.
  97 .INDENT 0.0
  98 .TP
  99 .B \-\-CONNECT\-TIMEOUT=
 100 .UNINDENT
 101 .sp
 102 Enable MEMCACHED_BEHAVIOR_CONNECT_TIMEOUT.
 103 .INDENT 0.0
 104 .TP
 105 .B \-\-DISTRIBUTION=
 106 .UNINDENT
 107 .sp
 108 Set the distribution model used by the client.  See :manpage:\(ga\(ga for more details.
 109 .INDENT 0.0
 110 .TP
 111 .B \-\-HASH=
 112 .UNINDENT
 113 .sp
 114 Set the hashing alogrthm used for placing keys on servers.
 115 .INDENT 0.0
 116 .TP
 117 .B \-\-HASH\-WITH\-NAMESPACE
 118 .UNINDENT
 119 .sp
 120 When enabled the prefix key will be added to the key when determining which
 121 server to store the data in.
 122 .INDENT 0.0
 123 .TP
 124 .B \-\-NOREPLY
 125 .UNINDENT
 126 .sp
 127 Enable "no reply" for all calls that support this. It is highly recommended
 128 that you use this option with the binary protocol only.
 129 .INDENT 0.0
 130 .TP
 131 .B \-\-NUMBER\-OF\-REPLICAS=
 132 .UNINDENT
 133 .sp
 134 Set the nummber of servers that keys will be replicated to.
 135 .INDENT 0.0
 136 .TP
 137 .B \-\-RANDOMIZE\-REPLICA\-READ
 138 .UNINDENT
 139 .sp
 140 Select randomly the server within the replication pool to read from.
 141 .INDENT 0.0
 142 .TP
 143 .B \-\-SORT\-HOSTS
 144 .UNINDENT
 145 .sp
 146 When adding new servers always calculate their distribution based on sorted naming order.
 147 .INDENT 0.0
 148 .TP
 149 .B \-\-SUPPORT\-CAS
 150 .UNINDENT
 151 .sp
 152 See \fImemcached_behavior_set(3)\fP for MEMCACHED_BEHAVIOR_SUPPORT_CAS
 153 .INDENT 0.0
 154 .TP
 155 .B \-\-USE\-UDP
 156 .UNINDENT
 157 .sp
 158 See \fImemcached_behavior_set(3)\fP for MEMCACHED_BEHAVIOR_USE_UDP
 159 .INDENT 0.0
 160 .TP
 161 .B \-\-NAMESPACE=
 162 .UNINDENT
 163 .sp
 164 A namespace is a container that provides context for keys, only other
 165 requests that know the namespace can access these values. This is
 166 accomplished by prepending the namespace value to all keys.
 167 .SS Mecached Pool Options:
 168 .INDENT 0.0
 169 .TP
 170 .B \-\-POOL\-MIN
 171 .UNINDENT
 172 .sp
 173 Initial size of pool.
 174 .INDENT 0.0
 175 .TP
 176 .B \-\-POOL\-MAX
 177 .UNINDENT
 178 .sp
 179 Maximize size of the pool.
 180 .SS I/O Options:
 181 .INDENT 0.0
 182 .TP
 183 .B \-\-TCP\-NODELAY
 184 .UNINDENT
 185 .sp
 186 See \fImemcached_behavior_set(3)\fP for MEMCACHED_BEHAVIOR_TCP_NODELAY
 187 .INDENT 0.0
 188 .TP
 189 .B \-\-TCP\-KEEPALIVE
 190 .UNINDENT
 191 .sp
 192 See \fImemcached_behavior_set(3)\fP for MEMCACHED_BEHAVIOR_TCP_KEEPALIVE
 193 .INDENT 0.0
 194 .TP
 195 .B \-\-RETRY\-TIMEOUT=
 196 .UNINDENT
 197 .sp
 198 See \fImemcached_behavior_set(3)\fP for MEMCACHED_BEHAVIOR_RETRY_TIMEOUT
 199 .INDENT 0.0
 200 .TP
 201 .B \-\-SERVER\-FAILURE\-LIMIT=
 202 .UNINDENT
 203 .sp
 204 See \fImemcached_behavior_set(3)\fP for MEMCACHED_BEHAVIOR_SERVER_FAILURE_LIMIT
 205 .INDENT 0.0
 206 .TP
 207 .B \-\-SND\-TIMEOUT=
 208 .UNINDENT
 209 .sp
 210 See \fImemcached_behavior_set(3)\fP for MEMCACHED_BEHAVIOR_SND_TIMEOUT
 211 .INDENT 0.0
 212 .TP
 213 .B \-\-SOCKET\-RECV\-SIZE=
 214 .UNINDENT
 215 .sp
 216 See \fImemcached_behavior_set(3)\fP for MEMCACHED_BEHAVIOR_SOCKET_RECV_SIZE
 217 .INDENT 0.0
 218 .TP
 219 .B \-\-SOCKET\-SEND\-SIZE=
 220 .UNINDENT
 221 .sp
 222 See \fImemcached_behavior_set(3)\fP for MEMCACHED_BEHAVIOR_SOCKET_SEND_SIZE
 223 .INDENT 0.0
 224 .TP
 225 .B \-\-POLL\-TIMEOUT=
 226 .UNINDENT
 227 .sp
 228 That sets the value of the timeout used by :manpage: \fIpoll()\fP.
 229 .INDENT 0.0
 230 .TP
 231 .B \-\-IO\-BYTES\-WATERMARK=
 232 .UNINDENT
 233 .INDENT 0.0
 234 .TP
 235 .B \-\-IO\-KEY\-PREFETCH=
 236 .UNINDENT
 237 .INDENT 0.0
 238 .TP
 239 .B \-\-IO\-MSG\-WATERMARK=
 240 .UNINDENT
 241 .INDENT 0.0
 242 .TP
 243 .B \-\-TCP\-KEEPIDLE
 244 .UNINDENT
 245 .INDENT 0.0
 246 .TP
 247 .B \-\-RCV\-TIMEOUT=
 248 .UNINDENT
 249 .SS Other:
 250 .INDENT 0.0
 251 .TP
 252 .B INCLUDE
 253 .UNINDENT
 254 .sp
 255 Include a file in configuration. Unlike \-\-CONFIGURE\-FILE= this will not reset memcached_st
 256 .INDENT 0.0
 257 .TP
 258 .B RESET
 259 .UNINDENT
 260 .sp
 261 Reset memcached_st and continue to process.
 262 .INDENT 0.0
 263 .TP
 264 .B END
 265 .UNINDENT
 266 .sp
 267 End configutation processing.
 268 .INDENT 0.0
 269 .TP
 270 .B ERROR
 271 .UNINDENT
 272 .sp
 273 End configutation processing and throw an error.
 274 .SH RETURN
 275 .sp
 276 \fI\%memcached()\fP returns a pointer to the memcached_st that was
 277 created (or initialized).  On an allocation failure, it returns NULL.
 278 .SH EXAMPLE
 279 .sp
 280 .nf
 281 .ft C
 282 const char *config_string= "\-\-SERVER=host10.example.com \-\-SERVER=host11.example.com \-\-SERVER=host10.example.com"
 283 memcached_st *memc= memcached(config_string, strlen(config_string);
 284 {
 285  ...
 286 }
 287 memcached_free(memc);
 288 .ft P
 289 .fi
 290 .SH HOME
 291 .sp
 292 To find out more information please check:
 293 \fI\%http://libmemcached.org/\fP
 294 .SH SEE ALSO
 295 .sp
 296 \fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP
 297 .SH AUTHOR
 298 Brian Aker
 299 .SH COPYRIGHT
 300 2011, Brian Aker DataDifferential, http://datadifferential.com/
 301 .\" Generated by docutils manpage writer.
 302 .\"
 303 .