1
.TH "LIBMEMCACHED_CONFIGURATION" "3" "September 16, 2012" "1.0.10" "libmemcached"
3
libmemcached_configuration \- libmemcached Documentation
5
.nr rst2man-indent-level 0
9
level \\n[rst2man-indent-level]
10
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
17
.\" .rstReportMargin pre:
19
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
20
. nr rst2man-indent-level +1
21
.\" .rstReportMargin post:
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
31
.\" Man page generated from reStructeredText.
35
#include <libmemcached\-1.0/memcached.h>
42
.B memcached_st *memcached(const char\fI\ *string\fP, size_t\fI\ string_length\fP)
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)
49
Compile and link with \-lmemcached
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.
57
.B \-\-SERVER=<servername>:<optional_port>/?<optional_weight>
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.
63
.B \-\-SOCKET="<filepath>/?<optional_weight>"
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.
72
Verify that keys that are being used fit within the design of the protocol being used.
75
.B \-\-REMOVE_FAILED_SERVERS
78
Enable the behavior \fBMEMCACHED_BEHAVIOR_REMOVE_FAILED_SERVERS\fP.
81
.B \-\-BINARY\-PROTOCOL
84
Force all connections to use the binary protocol.
87
.B \-\-BUFFER\-REQUESTS
90
Please see \fBMEMCACHED_BEHAVIOR_BUFFER_REQUESTS\fP.
93
.B \-\-CONFIGURE\-FILE=
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.
99
.B \-\-CONNECT\-TIMEOUT=
102
Please see \fBMEMCACHED_BEHAVIOR_CONNECT_TIMEOUT\fP.
108
Set the distribution model used by the client. See :manpage:\(ga\(ga for more details.
114
Set the hashing alogrthm used for placing keys on servers.
117
.B \-\-HASH\-WITH\-NAMESPACE
120
When enabled the prefix key will be added to the key when determining which
121
server to store the data in.
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.
131
.B \-\-NUMBER\-OF\-REPLICAS=
134
Set the nummber of servers that keys will be replicated to.
137
.B \-\-RANDOMIZE\-REPLICA\-READ
140
Select randomly the server within the replication pool to read from.
146
When adding new servers always calculate their distribution based on sorted naming order.
152
See \fImemcached_behavior_set(3)\fP for \fBMEMCACHED_BEHAVIOR_SUPPORT_CAS\fP
158
See \fImemcached_behavior_set(3)\fP for \fBMEMCACHED_BEHAVIOR_USE_UDP\fP
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:
173
Initial size of pool.
179
Maximize size of the pool.
186
See \fImemcached_behavior_set(3)\fP for MEMCACHED_BEHAVIOR_TCP_NODELAY
189
.B \-\-TCP\-KEEPALIVE
192
See \fImemcached_behavior_set(3)\fP for MEMCACHED_BEHAVIOR_TCP_KEEPALIVE
195
.B \-\-RETRY\-TIMEOUT=
198
See \fImemcached_behavior_set(3)\fP for MEMCACHED_BEHAVIOR_RETRY_TIMEOUT
201
.B \-\-SERVER\-FAILURE\-LIMIT=
204
See \fImemcached_behavior_set(3)\fP for MEMCACHED_BEHAVIOR_SERVER_FAILURE_LIMIT
210
See \fImemcached_behavior_set(3)\fP for MEMCACHED_BEHAVIOR_SND_TIMEOUT
213
.B \-\-SOCKET\-RECV\-SIZE=
216
See \fImemcached_behavior_set(3)\fP for MEMCACHED_BEHAVIOR_SOCKET_RECV_SIZE
219
.B \-\-SOCKET\-SEND\-SIZE=
222
See \fImemcached_behavior_set(3)\fP for MEMCACHED_BEHAVIOR_SOCKET_SEND_SIZE
225
.B \-\-POLL\-TIMEOUT=
228
That sets the value of the timeout used by :manpage: \fIpoll()\fP.
231
.B \-\-IO\-BYTES\-WATERMARK=
235
.B \-\-IO\-KEY\-PREFETCH=
239
.B \-\-IO\-MSG\-WATERMARK=
255
Include a file in configuration. Unlike \-\-CONFIGURE\-FILE= this will not reset memcached_st
261
Reset memcached_st and continue to process.
267
End configutation processing.
273
End configutation processing and throw an error.
276
\fI\%memcached()\fP returns a pointer to the memcached_st that was
277
created (or initialized). On an allocation failure, it returns NULL.
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);
287
memcached_free(memc);
292
To find out more information please check:
293
\fI\%http://libmemcached.org/\fP
296
\fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP
300
2011-2012, Brian Aker DataDifferential, http://datadifferential.com/
301
.\" Generated by docutils manpage writer.
added
removed
docs/man/libmemcached_configuration.3
