X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fmemcached_behavior.pod;h=c33b2af59a4d9330997eb22efc05aabbd9cf99d0;hb=42b674b747eae466d9ca0d766555c53ae75dc367;hp=3b33d7bf76543d22416bd3e2522235e08377507c;hpb=a11143256264a00e7437fa23ec8ff5196c5a5c0b;p=awesomized%2Flibmemcached diff --git a/docs/memcached_behavior.pod b/docs/memcached_behavior.pod index 3b33d7bf..c33b2af5 100755 --- a/docs/memcached_behavior.pod +++ b/docs/memcached_behavior.pod @@ -8,54 +8,130 @@ C Client Library for memcached (libmemcached, -lmemcached) =head1 SYNOPSIS -#include + #include -unsigned long long memcached_behavior_get(memcached_st *ptr, memcached_behavior flag); -memcached_return memcached_behavior_set(memcached_st *ptr, memcached_behavior flag, void *data); + uint64_t + memcached_behavior_get (memcached_st *ptr, + memcached_behavior flag); -=head1 DESCRIPTION + memcached_return + memcached_behavior_set (memcached_st *ptr, + memcached_behavior flag, + uint64_t data); +=head1 DESCRIPTION libmemcached(3) behavior can be modified by use memcached_behavior_set(). Default behavior is the library strives to be quick and accurate. Some -behavior, like , while being faster can also result in not entirely accurate -behavior (for instance memcached_set will always respond with -MEMCACHED_SUCCES). +behavior, while being faster, can also result in not entirely accurate +behavior (for instance, memcached_set() will always respond with +C). memcached_behavior_get() takes a behavior flag and returns whether or not that behavior is currently enabled in the client. memcached_behavior_set() changes the value of a particular option of the client. It takes both a flag (listed below) and a value. For simple on or -off options you just need to pass in a value of 1. +off options you just need to pass in a value of 1. Calls to +memcached_behavior_set() will flush and reset all connections. -=item MEMCACHED_BEHAVIOR_NO_BLOCK, +=over 4 -Causes libmemcached(3) to use asycronous IO. This is the fastest transport -available. +=item MEMCACHED_BEHAVIOR_NO_BLOCK -=item MEMCACHED_BEHAVIOR_TCP_NODELAY, +Causes libmemcached(3) to use asychronous IO. This is the fastest transport +available for storage functions. For read operations it is currently +similar in performance to the non-blocking method (this is being +looked into). + +=item MEMCACHED_BEHAVIOR_TCP_NODELAY Turns on the no-delay feature for connecting sockets (may be faster in some -setups). +environments). + +=item MEMCACHED_BEHAVIOR_HASH + +Makes the default hashing algorithm for keys use MD5. The value can be set +to either MEMCACHED_HASH_DEFAULT, MEMCACHED_HASH_MD5, MEMCACHED_HASH_CRC, MEMCACHED_HASH_FNV1_64, MEMCACHED_HASH_FNV1A_64, MEMCACHED_HASH_FNV1_32, and MEMCACHED_HASH_FNV1A_32. The behavior for all hashes but MEMCACHED_HASH_DEFAULT is identitical to the Java driver written by Dustin Sallings. + +=item MEMCACHED_BEHAVIOR_DISTRIBUTION + +Using this you can enable different means of distributing values to servers. +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. + +=item MEMCACHED_BEHAVIOR_CACHE_LOOKUPS + +Memcached can cache named lookups so that DNS lookups are made only once. + +=item MEMCACHED_BEHAVIOR_SUPPORT_CAS + +Support CAS operations (this is not enabled by default at this point in the server since it imposes a slight performance penalty). + +=item MEMCACHED_BEHAVIOR_KETAMA + +Sets the default distribution to MEMCACHED_DISTRIBUTION_CONSISTENT_KETAMA +and the hash to MEMCACHED_HASH_MD5. + +=item MEMCACHED_BEHAVIOR_POLL_TIMEOUT -=item MEMCACHED_BEHAVIOR_MD5_HASHING, +Modify the timeout value that is used by poll(). The default value is -1. An signed int pointer must be passed to memcached_behavior_set() to change this value. For memcached_behavior_get() a signed int value will be cast and returned as the unsigned long long. -Makes the default hashing algorithm for keys use RSA's MD5. +=item MEMCACHED_BEHAVIOR_USER_DATA + +This allows you to store a pointer to a specifc piece of data. This can be +retrieved from inside of memcached_fetch_execute(). Cloning a memcached_st + +will copy the pointer to the clone. This was deprecated in 0.14 in favor +of memcached_callback_set(3). This will be removed in 0.15. + +=item MEMCACHED_BEHAVIOR_BUFFER_REQUESTS + +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. + +=item MEMCACHED_BEHAVIOR_VERIFY_KEY + +Enabling this will cause libmemcached(3) to test all keys to verify that they +are valid keys. + +=item MEMCACHED_BEHAVIOR_SORT_HOSTS + +Enabling this will cause hosts that are added to be placed in the host list in +sorted order. This will defeat consisten hashing. + +=item MEMCACHED_BEHAVIOR_CONNECT_TIMEOUT + +In non-blocking mode this changes the value of the timeout during socket +connection. + +=back =head1 RETURN memcached_behavior_get() returns either the current value of the get, or 0 or 1 on simple flag behaviors (1 being enabled). memcached_behavior_set() -returns whether or not the behavior was enabled. +returns failure or success. + +=head1 NOTES + +memcached_behavior_set() in version .17 was changed from taking a pointer +to data value, to taking a uin64_t. =head1 HOME -To find out more information please check: http://tangent.org/552/libmemcached.html +To find out more information please check: +L =head1 AUTHOR -Brian Aker, brian@tangent.org +Brian Aker, Ebrian@tangent.orgE =head1 SEE ALSO