1
.TH "MEMCACHED_CREATE_WITH_OPTIONS" "3" "April 12, 2011" "0.47" "libmemcached"
3
memcached_create_with_options \- 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.
36
.B memcached_st *memcached_create_with_options(const char\fI\ *string\fP, size_t\fI\ string_length\fP)
40
.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)
43
Compile and link with \-lmemcached
46
Libmemcached implements a custom language for configuring and modifying
47
servers. By passing in an option string you can generate a memcached_st object
48
that you can use in your application directly.
51
.B \-\-SERVER=<servername>:<optional_port>/?<optional_weight>
54
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.
60
Verify that keys that are being used fit within the design of the protocol being used.
63
.B \-\-REMOVE_FAILED_SERVERS
66
Enable the behavior MEMCACHED_BEHAVIOR_REMOVE_FAILED_SERVERS.
69
.B \-\-BINARY\-PROTOCOL
72
Force all connections to use the binary protocol.
75
.B \-\-BUFFER\-REQUESTS
78
Enable MEMCACHED_BEHAVIOR_BUFFER_REQUESTS.
81
.B \-\-CONFIGURE\-FILE=
84
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.
87
.B \-\-CONNECT\-TIMEOUT=
90
Enable MEMCACHED_BEHAVIOR_CONNECT_TIMEOUT.
96
Set the distribution model used by the client. See :manpage:\(ga\(ga for more details.
102
Set the hashing alogrthm used for placing keys on servers.
105
.B \-\-HASH\-WITH\-NAMESPACE
108
When enabled the prefix key will be added to the key when determining which
109
server to store the data in.
115
Enable "no reply" for all calls that support this. It is highly recommended
116
that you use this option with the binary protocol only.
119
.B \-\-NUMBER\-OF\-REPLICAS=
122
Set the nummber of servers that keys will be replicated to.
125
.B \-\-RANDOMIZE\-REPLICA\-READ
128
Select randomly the server within the replication pool to read from.
134
When adding new servers always calculate their distribution based on sorted naming order.
140
See \fImemcached_behavior_set(3)\fP for MEMCACHED_BEHAVIOR_SUPPORT_CAS
146
See \fImemcached_behavior_set(3)\fP for MEMCACHED_BEHAVIOR_USE_UDP
152
A namespace is a container that provides context for keys, only other
153
requests that know the namespace can access these values. This is
154
accomplished by prepending the namespace value to all keys.
155
.SS Mecached Pool Options:
161
Initial size of pool.
167
Maximize size of the pool.
174
See \fImemcached_behavior_set(3)\fP for MEMCACHED_BEHAVIOR_TCP_NODELAY
177
.B \-\-TCP\-KEEPALIVE
180
See \fImemcached_behavior_set(3)\fP for MEMCACHED_BEHAVIOR_TCP_KEEPALIVE
183
.B \-\-RETRY\-TIMEOUT=
186
See \fImemcached_behavior_set(3)\fP for MEMCACHED_BEHAVIOR_RETRY_TIMEOUT
189
.B \-\-SERVER\-FAILURE\-LIMIT=
192
See \fImemcached_behavior_set(3)\fP for MEMCACHED_BEHAVIOR_SERVER_FAILURE_LIMIT
198
See \fImemcached_behavior_set(3)\fP for MEMCACHED_BEHAVIOR_SND_TIMEOUT
201
.B \-\-SOCKET\-RECV\-SIZE=
204
See \fImemcached_behavior_set(3)\fP for MEMCACHED_BEHAVIOR_SOCKET_RECV_SIZE
207
.B \-\-SOCKET\-SEND\-SIZE=
210
See \fImemcached_behavior_set(3)\fP for MEMCACHED_BEHAVIOR_SOCKET_SEND_SIZE
213
.B \-\-POLL\-TIMEOUT=
216
That sets the value of the timeout used by :manpage: \fIpoll()\fP.
219
.B \-\-IO\-BYTES\-WATERMARK=
223
.B \-\-IO\-KEY\-PREFETCH=
227
.B \-\-IO\-MSG\-WATERMARK=
243
Include a file in configuration. Unlike \-\-CONFIGURE\-FILE= this will not reset memcached_st
249
Reset memcached_st and continue to process.
255
End configutation processing.
261
End configutation processing and throw an error.
264
memcached_create_with_options() returns a pointer to the memcached_st that was
265
created (or initialized). On an allocation failure, it returns NULL.
270
const char *config_string= "\-\-SERVER=host10.example.com \-\-SERVER=host11.example.com \-\-SERVER=host10.example.com"
271
memcached_st *memc= memcached_create_with_options(config_string, strlen(config_string);
275
memcached_free(memc);
280
To find out more information please check:
281
\fI\%https://launchpad.net/libmemcached\fP
284
\fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP
288
2011, Brian Aker DataDifferential, http://datadifferential.com/
289
.\" Generated by docutils manpage writer.
added
removed
docs/man/memcached_create_with_options.3
