1
.TH "MEMCACHED_BEHAVIOR_SET" "3" "September 16, 2012" "1.0.10" "libmemcached"
3
memcached_behavior_set \- 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.
34
Manipulate the behavior of a memcached_st structure.
37
#include <libmemcached/memcached.h>
40
.B memcached_behavior_t
44
.B uint64_t memcached_behavior_get(memcached_st\fI\ *ptr\fP, \fI\%memcached_behavior_t\fP\fI\ flag\fP)
48
.B memcached_return_t memcached_behavior_set(memcached_st\fI\ *ptr\fP, \fI\%memcached_behavior_t\fP\fI\ flag\fP, uint64_t\fI\ data\fP)
51
Compile and link with \-lmemcached
54
\fIlibmemcached(3)\fP behavior can be modified by using \fI\%memcached_behavior_set()\fP. Default behavior is the library strives to be quick and
55
accurate. Some behavior, while being faster, can also result in not entirely
56
accurate behavior (for instance, \fBmemcached_set()\fP will always respond
57
with \fBMEMCACHED_SUCCESS\fP).
59
\fI\%memcached_behavior_get()\fP takes a behavior flag and returns whether or not that behavior is currently enabled in the client.
61
\fI\%memcached_behavior_set()\fP changes the value of a particular option
62
of the client. It takes both a flag (listed below) and a value. For simple
63
on or off options you just need to pass in a value of 1. Calls to
64
\fI\%memcached_behavior_set()\fP will flush and reset all connections.
67
.B MEMCACHED_BEHAVIOR_USE_UDP
70
Causes \fIlibmemcached(3)\fP to use the UDP transport when communicating
71
with a memcached server. Not all I/O operations are testsed
72
when this behavior is enababled. The following operations will return
73
\fBMEMCACHED_NOT_SUPPORTED\fP when executed with the
74
\fI\%MEMCACHED_BEHAVIOR_USE_UDP\fP enabled: \fBmemcached_version()\fP,
75
\fBmemcached_stat()\fP, \fBmemcached_get()\fP,
76
\fBmemcached_get_by_key()\fP, \fBmemcached_mget()\fP,
77
\fBmemcached_mget_by_key()\fP, \fBmemcached_fetch()\fP,
78
\fBmemcached_fetch_result()\fP, \fBmemcached_fetch_execute()\fP.
80
All other operations are testsed but are executed in a \(aqfire\-and\-forget\(aq
81
mode, in which once the client has executed the operation, no attempt
82
will be made to ensure the operation has been received and acted on by the
85
\fIlibmemcached(3)\fP does not allow TCP and UDP servers to be shared
86
within the same libmemached(3) client \(aqinstance\(aq. An attempt to add a TCP
87
server when this behavior is enabled will result in a \fBMEMCACHED_INVALID_HOST_PROTOCOL\fP, as will attempting to add a UDP server when this behavior has
91
.B MEMCACHED_BEHAVIOR_NO_BLOCK
94
Causes \fIlibmemcached(3)\fP to use asychronous IO. This is the fastest
95
transport available for storage functions.
98
.B MEMCACHED_BEHAVIOR_SND_TIMEOUT
101
This sets the microsecond behavior of the socket against the SO_SNDTIMEO flag. In cases where you cannot use non\-blocking IO this will allow you to still have timeouts on the sending of data.
104
.B MEMCACHED_BEHAVIOR_RCV_TIMEOUT
107
This sets the microsecond behavior of the socket against the SO_RCVTIMEO flag.
109
In cases where you cannot use non\-blocking IO this will allow you to still have timeouts on the reading of data.
112
.B MEMCACHED_BEHAVIOR_TCP_NODELAY
115
Turns on the no\-delay feature for connecting sockets (may be faster in some
119
.B MEMCACHED_BEHAVIOR_HASH
122
Makes the default hashing algorithm for keys use MD5. The value can be set to either \fBMEMCACHED_HASH_DEFAULT\fP, \fBMEMCACHED_HASH_MD5\fP, \fBMEMCACHED_HASH_CRC\fP, \fBMEMCACHED_HASH_FNV1_64\fP, \fBMEMCACHED_HASH_FNV1A_64\fP, \fBMEMCACHED_HASH_FNV1_32\fP, \fBMEMCACHED_HASH_FNV1A_32\fP, \fBMEMCACHED_HASH_JENKINS\fP, \fBMEMCACHED_HASH_HSIEH\fP, and \fBMEMCACHED_HASH_MURMUR\fP.
124
Each hash has it\(aqs advantages and it\(aqs weaknesses. If you don\(aqt know or don\(aqt
125
care, just go with the default.
127
Support for \fBMEMCACHED_HASH_HSIEH\fP is a compile time option that is disabled by default. To enable tests for this hashing algorithm, configure and build libmemcached with the \-\-enable\-hash_hsieh.
130
.B MEMCACHED_BEHAVIOR_DISTRIBUTION
133
Using this you can enable different means of distributing values to servers.
135
The default method is MEMCACHED_DISTRIBUTION_MODULA. You can enable consistent hashing by setting MEMCACHED_DISTRIBUTION_CONSISTENT. Consistent hashing delivers better distribution and allows servers to be added to the cluster with minimal cache losses. Currently MEMCACHED_DISTRIBUTION_CONSISTENT is an alias for the value MEMCACHED_DISTRIBUTION_CONSISTENT_KETAMA.
138
.B MEMCACHED_BEHAVIOR_CACHE_LOOKUPS
141
Deprecated since version 0.46(?): DNS lookups are now always cached until an error occurs with the server.
143
Memcached can cache named lookups so that DNS lookups are made only once.
147
.B MEMCACHED_BEHAVIOR_SUPPORT_CAS
150
Support CAS operations (this is not enabled by default at this point in the server since it imposes a slight performance penalty).
153
.B MEMCACHED_BEHAVIOR_KETAMA
156
Sets the default distribution to MEMCACHED_DISTRIBUTION_CONSISTENT_KETAMA and
157
the hash to \fBMEMCACHED_HASH_MD5\fP.
160
.B MEMCACHED_BEHAVIOR_KETAMA_WEIGHTED
161
Sets the default distribution to MEMCACHED_DISTRIBUTION_CONSISTENT_KETAMA with the weighted tests. and the hash to MEMCACHED_HASH_MD5.
165
.B MEMCACHED_BEHAVIOR_KETAMA_HASH
168
Sets the hashing algorithm for host mapping on continuum. The value can be set
169
to either \fBMEMCACHED_HASH_DEFAULT\fP, \fBMEMCACHED_HASH_MD5\fP,
170
\fBMEMCACHED_HASH_CRC\fP, \fBMEMCACHED_HASH_FNV1_64\fP,
171
\fBMEMCACHED_HASH_FNV1A_64\fP, \fBMEMCACHED_HASH_FNV1_32\fP, and
172
\fBMEMCACHED_HASH_FNV1A_32\fP.
175
.B MEMCACHED_BEHAVIOR_KETAMA_COMPAT
178
Sets the compatibility mode. The value can be set to either MEMCACHED_KETAMA_COMPAT_LIBMEMCACHED (this is the default) or MEMCACHED_KETAMA_COMPAT_SPY to be compatible with the SPY Memcached client for Java.
181
.B MEMCACHED_BEHAVIOR_POLL_TIMEOUT
184
Modify the timeout value that is used by poll. The default value is \-1. An signed int must be passed to memcached_behavior_set to change this value (this requires casting). For memcached_behavior_get a signed int value will be cast and returned as the unsigned long long.
187
.B MEMCACHED_BEHAVIOR_USER_DATA
190
Deprecated since version <: 0.30
193
.B MEMCACHED_BEHAVIOR_BUFFER_REQUESTS
196
Enabling buffered IO causes commands to "buffer" instead of being sent. Any action that gets data causes this buffer to be be sent to the remote connection. Quiting the connection or closing down the connection will also cause the buffered data to be pushed to the remote connection.
199
.B MEMCACHED_BEHAVIOR_VERIFY_KEY
202
Enabling this will cause \fIlibmemcached(3)\fP to test all keys to verify that they are valid keys.
205
.B MEMCACHED_BEHAVIOR_SORT_HOSTS
208
Enabling this will cause hosts that are added to be placed in the host list in sorted order. This will defeat consisten hashing.
211
.B MEMCACHED_BEHAVIOR_CONNECT_TIMEOUT
214
In non\-blocking mode this changes the value of the timeout during socket connection in milliseconds. Specifying \-1 means an infinite time‐out.
217
.B MEMCACHED_BEHAVIOR_BINARY_PROTOCOL
220
Enable the use of the binary protocol. Please note that you cannot toggle this flag on an open connection.
223
.B MEMCACHED_BEHAVIOR_SERVER_FAILURE_LIMIT
226
Set this value to enable the server be removed after continuous MEMCACHED_BEHAVIOR_SERVER_FAILURE_LIMIT times connection failure.
229
.B MEMCACHED_BEHAVIOR_IO_MSG_WATERMARK
232
Set this value to tune the number of messages that may be sent before libmemcached should start to automatically drain the input queue. Setting this value to high, may cause libmemcached to deadlock (trying to send data, but the send will block because the input buffer in the kernel is full).
235
.B MEMCACHED_BEHAVIOR_IO_BYTES_WATERMARK
238
Set this value to tune the number of bytes that may be sent before libmemcached should start to automatically drain the input queue (need at least 10 IO requests sent without reading the input buffer). Setting this value to high, may cause libmemcached to deadlock (trying to send data, but the send will block because the input buffer in the kernel is full).
241
.B MEMCACHED_BEHAVIOR_IO_KEY_PREFETCH
244
The binary protocol works a bit different than the textual protocol in that a multiget is implemented as a pipe of single get\-operations which are sent to the server in a chunk. If you are using large multigets from your application, you may improve the latency of the gets by setting this value so you send out the first chunk of requests when you hit the specified limit. It allows the servers to start processing the requests to send the data back while the rest of the requests are created and sent to the server.
247
.B MEMCACHED_BEHAVIOR_NOREPLY
250
Set this value to specify that you really don\(aqt care about the result from your storage commands (set, add, replace, append, prepend).
253
.B MEMCACHED_BEHAVIOR_NUMBER_OF_REPLICAS
256
If you just want "a poor mans HA", you may specify the numbers of replicas libmemcached should store of each item (on different servers). This replication does not dedicate certain memcached servers to store the replicas in, but instead it will store the replicas together with all of the other objects (on the \(aqn\(aq next servers specified in your server list).
259
.B MEMCACHED_BEHAVIOR_RANDOMIZE_REPLICA_READ
262
Allows randomizing the replica reads starting point. Normally the read is done from primary server and in case of miss the read is done from primary + 1, then primary + 2 all the way to \(aqn\(aq replicas. If this option is set on the starting point of the replica reads is randomized between the servers. This allows distributing read load to multiple servers with the expense of more write traffic.
265
.B MEMCACHED_BEHAVIOR_CORK
268
This open has been deprecated with the behavior now built and used appropriately on selected platforms.
271
.B MEMCACHED_BEHAVIOR_KEEPALIVE
274
Enable TCP_KEEPALIVE behavior.
277
.B MEMCACHED_BEHAVIOR_KEEPALIVE_IDLE
280
Specify time, in seconds, to mark a connection as idle. This is only available as an option Linux.
283
.B MEMCACHED_BEHAVIOR_SOCKET_SEND_SIZE
286
Find the current size of SO_SNDBUF. A value of 0 means either an error occured or no hosts were available. It is safe to assume system default if this occurs. If an error occurs you can checked the last cached errno statement to find the specific error.
289
.B MEMCACHED_BEHAVIOR_SOCKET_RECV_SIZE
292
Find the current size of SO_RCVBUF. A value of 0 means either an error occured or no hosts were available. It is safe to assume system default if this occurs. If an error occurs you can checked the last cached errno statement to find the specific error.
295
.B MEMCACHED_BEHAVIOR_SERVER_FAILURE_LIMIT
298
Deprecated since version 0.48: See \fI\%MEMCACHED_BEHAVIOR_REMOVE_FAILED_SERVERS\fP
300
This number of times a host can have an error before it is disabled.
304
.B MEMCACHED_BEHAVIOR_AUTO_EJECT_HOSTS
307
Deprecated since version 0.48: See \fI\%MEMCACHED_BEHAVIOR_REMOVE_FAILED_SERVERS\fP
309
If enabled any hosts which have been flagged as disabled will be removed from the list of servers in the memcached_st structure. This must be used in combination with MEMCACHED_BEHAVIOR_SERVER_FAILURE_LIMIT.
313
.B MEMCACHED_BEHAVIOR_REMOVE_FAILED_SERVERS
314
If enabled any hosts which have been flagged as disabled will be removed from the list of servers in the memcached_st structure.
318
.B MEMCACHED_BEHAVIOR_RETRY_TIMEOUT
321
When enabled a host which is problematic will only be checked for usage based on the amount of time set by this behavior. The value is in seconds.
324
.B MEMCACHED_BEHAVIOR_HASH_WITH_PREFIX_KEY
327
When enabled the prefix key will be added to the key when determining server
328
by hash. See \fBMEMCACHED_CALLBACK_NAMESPACE\fP for additional
332
memcached_behavior_get returns either the current value of the get, or 0
333
or 1 on simple flag behaviors (1 being enabled). memcached_behavior_set
334
returns failure or success.
337
memcached_behavior_set in version .17 was changed from taking a pointer
338
to data value, to taking a uin64_t.
341
To find out more information please check:
342
\fI\%http://libmemcached.org/\fP
345
\fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP
349
2011-2012, Brian Aker DataDifferential, http://datadifferential.com/
350
.\" Generated by docutils manpage writer.
added
removed
docs/man/memcached_behavior_set.3
