X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fsource%2Flibmemcached%2Fmemcached_auto.rst;h=de8bd092eb60260848eadc95ecd9413e7bae7451;hb=1419585ea96c095448da2a455580f5905ddd2177;hp=61ffa124c1d6106d8939705d750a87381f441caa;hpb=bdf3398dac90a54d82aed65099290d51e92d4601;p=awesomized%2Flibmemcached diff --git a/docs/source/libmemcached/memcached_auto.rst b/docs/source/libmemcached/memcached_auto.rst index 61ffa124..de8bd092 100644 --- a/docs/source/libmemcached/memcached_auto.rst +++ b/docs/source/libmemcached/memcached_auto.rst @@ -1,14 +1,11 @@ -==================================== Incrementing and Decrementing Values ==================================== -.. index:: object: memcached_st - --------- SYNOPSIS -------- #include + Compile and link with -lmemcached .. function:: memcached_return_t memcached_increment (memcached_st *ptr, const char *key, size_t key_length, uint32_t offset, uint64_t *value) @@ -18,7 +15,7 @@ SYNOPSIS .. 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) -.. 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) +.. 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) .. 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) @@ -26,9 +23,17 @@ SYNOPSIS .. 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) -Compile and link with -lmemcached + :param ptr: pointer to an initialized `memcached_st` struct + :param group_key: key namespace + :param group_key_length: length of the key namespace without any terminating zero + :param key: the key + :param key_length: length of the key without any terminating zero + :param offset: offset to increment/decrement + :param initial: initial value if `key` does not exist and `expiration` is not `MEMCACHED_EXPIRATION_NOT_ADD` + :param expiration: expiration as a unix timestamp or as relative expiration time in seconds + :param value: the resulting value after initialization/increment/decrement + :returns: `memcached_return_t` indicating success ------------ DESCRIPTION ----------- @@ -36,51 +41,57 @@ DESCRIPTION (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 key length 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 uint32_t -value pointer you pass to it. - -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 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 -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 uint32_t -value pointer you pass to it. memcached_decrement_with_initial is only available -when using the binary protocol. - -:func:`memcached_increment_by_key`, :func:`memcached_decrement_by_key`, -:func:`memcached_increment_with_initial_by_key`, and -:func:`memcached_decrement_with_initial_by_key` are master key equivalents of the above. - ------- -RETURN ------- - - -A value of type :type:`memcached_return_t` is returned. +`memcached_increment` takes a ``key`` and ``key_length`` 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 ``key_length`` 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 ``key_length`` 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 :c:macro:`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 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 ``key_length`` 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 :c:macro:`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 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. + +RETURN VALUE +------------ + +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. +Use `memcached_strerror` to translate this value to a printable string. --------- SEE ALSO -------- .. only:: man - :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` + :manpage:`memcached(1)` + :manpage:`libmemcached(3)` + :manpage:`memcached_strerror(3)` + +.. only:: html + + * :manpage:`memcached(1)` + * :doc:`../libmemcached` + * :doc:`memcached_strerror`