X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fmemcached_set.rst;h=db668b22c7439a028d28cf2514176362d8a7490b;hb=a6c3e3a3d04f379b1480c8c88a8eae17e54b1449;hp=4cdbd99440a706ebed6a76ffa01f47c01fecfb0a;hpb=0f16555031c7f44d1acd034ff74e628c51a72dac;p=m6w6%2Flibmemcached diff --git a/docs/memcached_set.rst b/docs/memcached_set.rst index 4cdbd994..db668b22 100644 --- a/docs/memcached_set.rst +++ b/docs/memcached_set.rst @@ -1,9 +1,8 @@ -========================== -Storing and Replacing Data -========================== +========================================================= +Store, replace, add, or atomically add data to the server +========================================================= - -Store value on server +.. index:: object: memcached_st -------- @@ -11,7 +10,6 @@ SYNOPSIS -------- - #include .. 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); @@ -20,24 +18,12 @@ SYNOPSIS .. 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); -.. c:function:: memcached_return_t memcached_prepend(memcached_st *ptr, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags) - -.. c:function:: memcached_return_t memcached_append(memcached_st *ptr, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags) - -.. 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_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); .. 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); .. 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); -.. c:function:: memcached_return_t memcached_prepend_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); - -.. c:function:: memcached_return_t memcached_append_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); - -.. 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 @@ -48,10 +34,10 @@ DESCRIPTION memcached_set(), memcached_add(), and 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 by the -memcached(1) server. You must supply both a value and a length. Optionally you +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 may test an expiration time for the object and a 16 byte value (it is -meant to be used as a bitmap). +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. memcached_set() will write an object to the server. If an object already exists it will overwrite what is in the server. If the object does not exist @@ -64,12 +50,6 @@ found on the server an error occurs. memcached_add() adds an object to the server. If the object is found on the server an error occurs, otherwise the value is stored. -memcached_prepend() places a segment of data before the last piece of data -stored. Currently expiration and key are not used in the server. - -memcached_append() places a segment of data at the end of the last piece of -data stored. Currently expiration and key are not used in the server. - 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 memcached_result_cas() on a memcached_result_st(3) structure. At the point @@ -77,9 +57,8 @@ that this note was written cas is still buggy in memached. Turning on tests for it in libmemcached(3) is optional. Please see memcached_set() for information on how to do this. -memcached_set_by_key(), memcached_add_by_key(), memcached_replace_by_key(), -memcached_prepend_by_key(), memcached_append_by_key_by_key(), -memcached_cas_by_key() methods all behave in a similar method as the non key +memcached_set_by_key(), memcached_add_by_key(), and memcached_replace_by_key() +methods all behave in a similar method as the non key methods. The difference is that they use their group_key parameter to map objects to particular servers. @@ -131,5 +110,5 @@ SEE ALSO -------- -memcached(1) libmemached(3) memcached_strerror(3) +memcached(1) libmemached(3) memcached_strerror(3) memcached_prepend(3) memcached_cas(3) memcached_append(3)