git.m6w6.name Git - awesomized/libmemcached/blob - docs/source/libmemcached/memcached_cas.rst

   1 ====================================================
   2 Working with data on the server in an atomic fashion
   3 ====================================================
   4
   5 .. index:: object: memcached_st
   6
   7
   8 --------
   9 SYNOPSIS
  10 --------
  11
  12 #include <libmemcached/memcached.h>
  13
  14 .. 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)
  15
  16 .. 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)
  17
  18 Compile and link with -lmemcached
  19
  20 -----------
  21 DESCRIPTION
  22 -----------
  23
  24 :func:`memcached_cas` overwrites data in the server as long as the "cas"
  25 value is still the same in the server. You can get the cas value of a result
  26 by calling :func:`memcached_result_cas` on a memcached_result_st(3)
  27 structure. At the point that this note was written cas is still buggy in memcached.
  28 Turning on tests for it in libmemcached(3) is optional. Please see
  29 :func:`memcached_set` for information on how to do this.
  30
  31 :func:`memcached_cas_by_key` method behaves in a similar method as the non
  32 key methods. The difference is that it uses the group_key parameter
  33 to map objects to particular servers.
  34
  35 :func:`memcached_cas` is tested with the `MEMCACHED_BEHAVIOR_USE_UDP` behavior enabled. However, when using these operations with this behavior
  36 on, there are limits to the size of the payload being sent to the server.  The
  37 reason for these limits is that the Memcached Server does not allow
  38 multi-datagram requests and the current server implementation sets a datagram
  39 size to 1400 bytes. Due to protocol overhead, the actual limit of the user
  40 supplied data is less than 1400 bytes and depends on the protocol in use as,
  41 well as the operation being executed. When running with the binary protocol,
  42 `MEMCACHED_BEHAVIOR_BINARY_PROTOCOL`, the size of the key,value,
  43 flags and expiry combined may not exceed 1368 bytes. When running with the
  44 ASCII protocol, the exact limit fluctuates depending on which function is
  45 being executed and whether the function is a cas operation or not. For
  46 non-cas ASCII set operations, there are at least 1335 bytes available to
  47 split among the key, key_prefix, and value; for cas ASCII operations there
  48 are at least 1318 bytes available to split among the key, key_prefix and value. If the total size of the command, including overhead, exceeds 1400 bytes, a `MEMCACHED_WRITE_FAILURE` will be returned.
  49
  50 ------
  51 RETURN
  52 ------
  53
  54 All methods return a value of type :type:`memcached_return_t`.
  55 On success the value will be `MEMCACHED_SUCCESS`.
  56 Use :func:`memcached_strerror` to translate this value to a printable
  57 string.
  58
  59 --------
  60 SEE ALSO
  61 --------
  62
  63 .. only:: man
  64
  65   :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` :manpage:`memcached_set(3)` :manpage:`memcached_append(3)` :manpage:`memcached_add(3)` :manpage:`memcached_prepend(3)` :manpage:`memcached_replace(3)`
  66