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

   1 =========================================================
   2 Store, replace, add, or atomically add data to the server
   3 =========================================================
   4
   5 .. index:: object: memcached_st
   6
   7
   8 --------
   9 SYNOPSIS
  10 --------
  11
  12
  13 #include <libmemcached/memcached.h>
  14
  15 .. c:function:: memcached_return_t memcached_set (memcached_st *ptr, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags);
  16
  17 .. c:function:: memcached_return_t memcached_add (memcached_st *ptr, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags);
  18
  19 .. c:function:: memcached_return_t memcached_replace (memcached_st *ptr, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags);
  20
  21 .. c:function:: memcached_return_t memcached_set_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);
  22
  23 .. c:function:: memcached_return_t memcached_add_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);
  24
  25 .. c:function:: memcached_return_t memcached_replace_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);
  26
  27 Compile and link with -lmemcached
  28
  29
  30 -----------
  31 DESCRIPTION
  32 -----------
  33
  34
  35 :c:func:`memcached_set()`, :c:func:`memcached_add()`, and :c:func:`memcached_replace()` are all used to store information on the server. All methods take a key, and its length to store the object. Keys are currently limited to 250 characters when using either a version of memcached(1) which is 1.4 or below, or when using the text protocol. You must supply both a value and a length. Optionally you
  36 store the object. Keys are currently limited to 250 characters by the
  37 memcached(1) server. You must supply both a value and a length. Optionally you
  38 may test an expiration time for the object and a 16 byte value (it is meant to be used as a bitmap). "flags" is a 4byte space that is stored alongside of the main value. Many sub libraries make use of this field, so in most cases users should avoid making use of it.
  39
  40 :c:func:`memcached_set()` will write an object to the server. If an object
  41 already exists it will overwrite what is in the server. If the object does not
  42 exist it will be written. If you are using the non-blocking mode this function
  43 will always return true unless a network error occurs.
  44
  45 :c:func:`memcached_replace()` replaces an object on the server. If the object is not found on the server an error occurs.
  46
  47 :c:func:`memcached_add()` adds an object to the server. If the object is found on the server an error occurs, otherwise the value is stored.
  48
  49 :c:func:`memcached_cas()` overwrites data in the server as long as the "cas"
  50 value is still the same in the server. You can get the cas value of a result by
  51 calling :c:func:`memcached_result_cas()` on a memcached_result_st(3) structure. At the point
  52 that this note was written cas is still buggy in memached. Turning on tests
  53 for it in libmemcached(3) is optional. Please see memcached_set() for
  54 information on how to do this.
  55
  56 :c:func:`memcached_set_by_key()`, :c:func:`memcached_add_by_key()`, and :c:func:`memcached_replace_by_key()` methods all behave in a similar method as the non
  57 key methods. The difference is that they use their group_key parameter to map
  58 objects to particular servers.
  59
  60 If you are looking for performance, :c:func:`memcached_set()` with non-blocking IO is the fastest way to store data on the server.
  61
  62 All of the above functions are testsed with the :c:type:`MEMCACHED_BEHAVIOR_USE_UDP` behavior enabled. However, when using these operations with this behavior
  63 on, there are limits to the size of the payload being sent to the server.
  64 The reason for these limits is that the Memcached Server does not allow
  65 multi-datagram requests and the current server implementation sets a datagram
  66 size to 1400 bytes. Due to protocol overhead, the actual limit of the user supplied data is less than 1400 bytes and depends on the protocol in use as, well as the operation being
  67 executed. When running with the binary protocol, :c:type:`MEMCACHED_BEHAVIOR_BINARY_PROTOCOL`, the size of the key,value, flags and expiry combined may not
  68 exceed 1368 bytes. When running with the ASCII protocol, the exact limit fluctuates depending on which function is being executed and whether the function is a cas operation or not. For non-cas ASCII set operations, there are at least
  69 1335 bytes available to split among the key, key_prefix, and value; for cas
  70 ASCII operations there are at least 1318 bytes available to split among the key, key_prefix and value. If the total size of the command, including overhead,
  71 exceeds 1400 bytes, a :c:type:`MEMCACHED_WRITE_FAILURE` will be returned.
  72
  73
  74 ------
  75 RETURN
  76 ------
  77
  78
  79 All methods return a value of type :c:type:`memcached_return_t`.
  80 On success the value will be :c:type:`MEMCACHED_SUCCESS`.
  81 Use :c:func:`memcached_strerror()` to translate this value to a printable string.
  82
  83 For :c:func:`memcached_replace()` and :c:func:`memcached_add()`, :c:type:`MEMCACHED_NOTSTORED` is a legitmate error in the case of a collision.
  84
  85
  86 ----
  87 HOME
  88 ----
  89
  90
  91 To find out more information please check:
  92 `http://libmemcached.org/ <http://libmemcached.org/>`_
  93
  94
  95 --------
  96 SEE ALSO
  97 --------
  98
  99
 100 :manpage:`memcached(1)` :manpage:`libmemached(3)` :manpage:`memcached_strerror(3)` :manpage:`memcached_prepend(3)` :manpage:`memcached_cas(3)` :manpage:`memcached_append(3)`
 101