X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fmemcached_cas.rst;h=a796f303f5c5a13a772c559c4d1bc15320659cf4;hb=cfe08f8ecd0fd090430c417ac99999644041ba17;hp=c2138bc8979d18263acd91a46321bbfa6a17a2f5;hpb=7c12c89412585d136f8572f0ff3aee26427769de;p=m6w6%2Flibmemcached diff --git a/docs/memcached_cas.rst b/docs/memcached_cas.rst index c2138bc8..a796f303 100644 --- a/docs/memcached_cas.rst +++ b/docs/memcached_cas.rst @@ -12,9 +12,9 @@ SYNOPSIS #include -.. c:function:: memcached_return_t memcached_cas(memcached_st *ptr, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags, uint64_t cas); +.. c:function:: memcached_return_t memcached_cas(memcached_st *ptr, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags, uint64_t cas) -.. c:function:: memcached_return_t memcached_cas_by_key(memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags, uint64_t cas); +.. c:function:: memcached_return_t memcached_cas_by_key(memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags, uint64_t cas) Compile and link with -lmemcached @@ -23,17 +23,17 @@ Compile and link with -lmemcached DESCRIPTION ----------- -:c:func:`memcached_cas()` overwrites data in the server as long as the "cas" +:c:func:`memcached_cas` overwrites data in the server as long as the "cas" value is still the same in the server. You can get the cas value of a result -by calling :c:func:`memcached_result_cas()` on a memcached_result_st(3) +by calling :c:func:`memcached_result_cas` on a memcached_result_st(3) structure. At the point that this note was written cas is still buggy in memached. Turning on tests for it in libmemcached(3) is optional. Please see -:c:func:`memcached_set()` for information on how to do this. +:c:func:`memcached_set` for information on how to do this. -:c:func:`memcached_cas_by_key()` method behaves in a similar method as the non -key methods. The difference is that it uses the :c:type:`group_key` parameter +:c:func:`memcached_cas_by_key` method behaves in a similar method as the non +key methods. The difference is that it uses the group_key parameter to map objects to particular servers. -:c:func:`memcached_cas()` is testsed with the :c:type:`MEMCACHED_BEHAVIOR_USE_UDP` behavior enabled. However, when using these operations with this behavior +:c:func:`memcached_cas` is testsed with the :c:type:`MEMCACHED_BEHAVIOR_USE_UDP` behavior enabled. However, when using these operations with this behavior on, there are limits to the size of the payload being sent to the server. The reason for these limits is that the Memcached Server does not allow multi-datagram requests and the current server implementation sets a datagram @@ -56,7 +56,7 @@ RETURN All methods return a value of type :c:type:`memcached_return_t`. On success the value will be :c:type:`MEMCACHED_SUCCESS`. -Use :c:func:`memcached_strerror()` to translate this value to a printable +Use :c:func:`memcached_strerror` to translate this value to a printable string.