git.m6w6.name Git - awesomized/libmemcached/blob - docs/man/memcached_set_by_key.3

   1 .TH "MEMCACHED_SET_BY_KEY" "3" "June 10, 2011" "0.47" "libmemcached"
   2 .SH NAME
   3 memcached_set_by_key \- Storing and Replacing Data
   4 .
   5 .nr rst2man-indent-level 0
   6 .
   7 .de1 rstReportMargin
   8 \\$1 \\n[an-margin]
   9 level \\n[rst2man-indent-level]
  10 level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
  11 -
  12 \\n[rst2man-indent0]
  13 \\n[rst2man-indent1]
  14 \\n[rst2man-indent2]
  15 ..
  16 .de1 INDENT
  17 .\" .rstReportMargin pre:
  18 . RS \\$1
  19 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
  20 . nr rst2man-indent-level +1
  21 .\" .rstReportMargin post:
  22 ..
  23 .de UNINDENT
  24 . RE
  25 .\" indent \\n[an-margin]
  26 .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
  27 .nr rst2man-indent-level -1
  28 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
  29 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
  30 ..
  31 .\" Man page generated from reStructeredText.
  32 .
  33 .SH SYNOPSIS
  34 .sp
  35 #include <libmemcached/memcached.h>
  36 .INDENT 0.0
  37 .TP
  38 .B 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);
  39 .UNINDENT
  40 .INDENT 0.0
  41 .TP
  42 .B 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);
  43 .UNINDENT
  44 .INDENT 0.0
  45 .TP
  46 .B 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);
  47 .UNINDENT
  48 .INDENT 0.0
  49 .TP
  50 .B 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);
  51 .UNINDENT
  52 .INDENT 0.0
  53 .TP
  54 .B 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);
  55 .UNINDENT
  56 .INDENT 0.0
  57 .TP
  58 .B 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);
  59 .UNINDENT
  60 .sp
  61 Compile and link with \-lmemcached
  62 .SH DESCRIPTION
  63 .sp
  64 memcached_set(), memcached_add(), and memcached_replace() are all used to
  65 store information on the server. All methods take a key, and its length to
  66 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.
  67 You must supply both a value and a length. Optionally you
  68 may test an expiration time for the object and a 16 byte value (it is
  69 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.
  70 .sp
  71 memcached_set() will write an object to the server. If an object already
  72 exists it will overwrite what is in the server. If the object does not exist
  73 it will be written. If you are using the non\-blocking mode this function
  74 will always return true unless a network error occurs.
  75 .sp
  76 memcached_replace() replaces an object on the server. If the object is not
  77 found on the server an error occurs.
  78 .sp
  79 memcached_add() adds an object to the server. If the object is found on the
  80 server an error occurs, otherwise the value is stored.
  81 .sp
  82 memcached_cas() overwrites data in the server as long as the "cas" value is
  83 still the same in the server. You can get the cas value of a result by
  84 calling memcached_result_cas() on a memcached_result_st(3) structure. At the point
  85 that this note was written cas is still buggy in memached. Turning on tests
  86 for it in libmemcached(3) is optional. Please see memcached_set() for
  87 information on how to do this.
  88 .sp
  89 memcached_set_by_key(), memcached_add_by_key(), and memcached_replace_by_key()
  90 methods all behave in a similar method as the non key
  91 methods. The difference is that they use their group_key parameter to map
  92 objects to particular servers.
  93 .sp
  94 If you are looking for performance, memcached_set() with non\-blocking IO is
  95 the fastest way to store data on the server.
  96 .sp
  97 All of the above functions are testsed with the \fBMEMCACHED_BEHAVIOR_USE_UDP\fPbehavior enabled. However, when using these operations with this behavior on, there
  98 are limits to the size of the payload being sent to the server.  The reason for
  99 these limits is that the Memcached Server does not allow multi\-datagram requests
 100 and the current server implementation sets a datagram size to 1400 bytes. Due
 101 to protocol overhead, the actual limit of the user supplied data is less than
 102 1400 bytes and depends on the protocol in use as, well as the operation being
 103 executed. When running with the binary protocol, \(ga\(ga MEMCACHED_BEHAVIOR_BINARY_PROTOCOL\(ga\(ga,
 104 the size of the key,value, flags and expiry combined may not exceed 1368 bytes.
 105 When running with the ASCII protocol, the exact limit fluctuates depending on
 106 which function is being executed and whether the function is a cas operation
 107 or not. For non\-cas ASCII set operations, there are at least 1335 bytes available
 108 to split among the key, key_prefix, and value; for cas ASCII operations there are
 109 at least 1318 bytes available to split among the key, key_prefix and value. If the
 110 total size of the command, including overhead, exceeds 1400 bytes, a \fBMEMCACHED_WRITE_FAILURE\fPwill be returned.
 111 .SH RETURN
 112 .sp
 113 All methods return a value of type \fBmemcached_return_t\fP.
 114 On success the value will be \fBMEMCACHED_SUCCESS\fP.
 115 Use memcached_strerror() to translate this value to a printable string.
 116 .sp
 117 For memcached_replace() and memcached_add(), \fBMEMCACHED_NOTSTORED\fP is a
 118 legitmate error in the case of a collision.
 119 .SH HOME
 120 .sp
 121 To find out more information please check:
 122 \fI\%http://libmemcached.org/\fP
 123 .SH SEE ALSO
 124 .sp
 125 memcached(1) libmemached(3) memcached_strerror(3) memcached_prepend(3) memcached_cas(3) memcached_append(3)
 126 .SH AUTHOR
 127 Brian Aker
 128 .SH COPYRIGHT
 129 2011, Brian Aker DataDifferential, http://datadifferential.com/
 130 .\" Generated by docutils manpage writer.
 131 .\"
 132 .