X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fmemcached_auto.rst;h=0f78e6e7d8d1a7610a358293d81b7d6ad8049cbe;hb=dbc62573e1a6dc8cbcc97d0898e8615b0916d6ab;hp=1f35e4e7c4d0c9b2e6bcb0ac08d0502badefef72;hpb=281c398ba3a10af677494c4453cd09d85ca921e0;p=awesomized%2Flibmemcached diff --git a/docs/memcached_auto.rst b/docs/memcached_auto.rst index 1f35e4e7..0f78e6e7 100644 --- a/docs/memcached_auto.rst +++ b/docs/memcached_auto.rst @@ -1,95 +1,32 @@ -========================================================= -Incrementing and Decrementing values stored in the server -========================================================= +==================================== +Incrementing and Decrementing Values +==================================== +.. index:: object: memcached_st -Manipulate counters +-------- +SYNOPSIS +-------- +#include + +.. c:function:: memcached_return_t memcached_increment (memcached_st *ptr, const char *key, size_t key_length, uint32_t offset, uint64_t *value) -******* -LIBRARY -******* +.. c:function:: memcached_return_t memcached_decrement (memcached_st *ptr, const char *key, size_t key_length, uint32_t offset, uint64_t *value) +.. c:function:: memcached_return_t memcached_increment_with_initial (memcached_st *ptr, const char *key, size_t key_length, uint64_t offset, uint64_t initial, time_t expiration, uint64_t *value) -C Client Library for memcached (libmemcached, -lmemcached) +.. c:function:: memcached_return_t memcached_decrement_with_initial (memcached_st *ptr, const char *key, size_t key_length, uint64_t offset, uint64_t initial, time_t expiration, uint64_t *value) +.. c:function:: memcached_return_t memcached_increment_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, uint32_t offset, uint64_t *value) --------- -SYNOPSIS --------- +.. c:function:: memcached_return_t memcached_decrement_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, uint32_t offset, uint64_t *value) +.. c:function:: memcached_return_t memcached_increment_with_initial_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, uint64_t offset, uint64_t initial, time_t expiration, uint64_t *value) +.. c:function:: memcached_return_t memcached_decrement_with_initial_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, uint64_t offset, uint64_t initial, time_t expiration, uint64_t *value) -.. code-block:: perl - - #include - - memcached_return_t - memcached_increment (memcached_st *ptr, - const char *key, size_t key_length, - unsigned int offset, - uint64_t *value); - - memcached_return_t - memcached_decrement (memcached_st *ptr, - const char *key, size_t key_length, - unsigned int offset, - uint64_t *value); - - memcached_return_t - memcached_increment_with_initial (memcached_st *ptr, - const char *key, - size_t key_length, - uint64_t offset, - uint64_t initial, - time_t expiration, - uint64_t *value); - - memcached_return_t - memcached_decrement_with_initial (memcached_st *ptr, - const char *key, - size_t key_length, - uint64_t offset, - uint64_t initial, - time_t expiration, - uint64_t *value); - - memcached_return_t - memcached_increment_by_key (memcached_st *ptr, - const char *master_key, size_t master_key_length, - const char *key, size_t key_length, - unsigned int offset, - uint64_t *value); - - memcached_return_t - memcached_decrement_by_key (memcached_st *ptr, - const char *master_key, size_t master_key_length, - const char *key, size_t key_length, - unsigned int offset, - uint64_t *value); - - memcached_return_t - memcached_increment_with_initial_by_key (memcached_st *ptr, - const char *master_key, - size_t master_key_length, - const char *key, - size_t key_length, - uint64_t offset, - uint64_t initial, - time_t expiration, - uint64_t *value); - - memcached_return_t - memcached_decrement_with_initial_by_key (memcached_st *ptr, - const char *master_key, - size_t master_key_length, - const char *key, - size_t key_length, - uint64_t offset, - uint64_t initial, - time_t expiration, - uint64_t *value); - +Compile and link with -lmemcached ----------- @@ -97,67 +34,60 @@ DESCRIPTION ----------- -memcached(1) servers have the ability to increment and decrement keys +:manpage:`memcached(1)` servers have the ability to increment and decrement keys (overflow and underflow are not detected). This gives you the ability to use memcached to generate shared sequences of values. -memcached_increment() takes a key and keylength and increments the value by -the offset passed to it. The value is then returned via the unsigned int +memcached_increment takes a key and keylength and increments the value by +the offset passed to it. The value is then returned via the uint32_t value pointer you pass to it. -memcached_decrement() takes a key and keylength and decrements the value by -the offset passed to it. The value is then returned via the unsigned int +memcached_decrement takes a key and keylength and decrements the value by +the offset passed to it. The value is then returned via the uint32_t value pointer you pass to it. -memcached_increment_with_initial() takes a key and keylength and increments +memcached_increment_with_initial takes a key and keylength and increments the value by the offset passed to it. If the object specified by key does not exist, one of two things may happen: If the expiration value is MEMCACHED_EXPIRATION_NOT_ADD, the operation will fail. For all other expiration values, the operation will succeed by seeding the value for that key with a initial value to expire with the provided expiration time. The -flags will be set to zero.The value is then returned via the unsigned int -value pointer you pass to it. +flags will be set to zero.The value is then returned via the uint32_t +value pointer you pass to it. memcached_increment_with_initial is only available +when using the binary protocol. -memcached_decrement_with_initial() takes a key and keylength and decrements +memcached_decrement_with_initial takes a key and keylength and decrements the value by the offset passed to it. If the object specified by key does not exist, one of two things may happen: If the expiration value is MEMCACHED_EXPIRATION_NOT_ADD, the operation will fail. For all other expiration values, the operation will succeed by seeding the value for that key with a initial value to expire with the provided expiration time. The -flags will be set to zero.The value is then returned via the unsigned int -value pointer you pass to it. +flags will be set to zero.The value is then returned via the uint32_t +value pointer you pass to it. memcached_decrement_with_initial is only available +when using the binary protocol. -memcached_increment_by_key(), memcached_decrement_by_key(), -memcached_increment_with_initial_by_key(), and -memcached_decrement_with_initial_by_key() are master key equivalents of the -above. +:c:func:`memcached_increment_by_key`, :c:func:`memcached_decrement_by_key`, +:c:func:`memcached_increment_with_initial_by_key`, and +:c:func:`memcached_decrement_with_initial_by_key` are master key equivalents of the above. -****** +------ RETURN -****** +------ -A value of type \ ``memcached_return_t``\ is returned. -On success that value will be \ ``MEMCACHED_SUCCESS``\ . -Use memcached_strerror() to translate this value to a printable string. +A value of type :c:type:`memcached_return_t` is returned. +On success that value will be :c:type:`MEMCACHED_SUCCESS`. +Use memcached_strerror to translate this value to a printable string. -**** +---- HOME -**** +---- To find out more information please check: -`https://launchpad.net/libmemcached `_ - - -****** -AUTHOR -****** - - -Brian Aker, +`http://libmemcached.org/ `_ --------