X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fmemcached_behavior.pod;h=2dd6ae2d9e6f944aef300cac1cdaa5ae47f2cb80;hb=79ad5be1d7ef80332ec9b06da733b862dc35e46f;hp=e5058de353efa627bce1a0e453cd53bb2a71f732;hpb=90c4182ab1eb7f2da203258f62cf33a229ba1346;p=m6w6%2Flibmemcached diff --git a/docs/memcached_behavior.pod b/docs/memcached_behavior.pod index e5058de3..2dd6ae2d 100755 --- a/docs/memcached_behavior.pod +++ b/docs/memcached_behavior.pod @@ -10,14 +10,14 @@ C Client Library for memcached (libmemcached, -lmemcached) #include - unsigned long long + uint64_t memcached_behavior_get (memcached_st *ptr, memcached_behavior flag); memcached_return memcached_behavior_set (memcached_st *ptr, memcached_behavior flag, - void *data); + uint64_t data); =head1 DESCRIPTION @@ -59,7 +59,9 @@ 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. +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 @@ -73,6 +75,35 @@ Support CAS operations (this is not enabled by default at this point in the serv 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. +=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 @@ -80,7 +111,12 @@ Modify the timeout value that is used by poll(). The default value is -1. An sig 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