X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fmemcached_auto.pod;h=bd6da19242e707cca39c022e835eab779b13a236;hb=55b5455291498ef63c1c34976552d58708a74732;hp=df0a8b58b4352dc7da9020e96bc2684d95177b40;hpb=571fad579922f2b10873193500dfd0652f4fdc37;p=awesomized%2Flibmemcached diff --git a/docs/memcached_auto.pod b/docs/memcached_auto.pod old mode 100755 new mode 100644 index df0a8b58..bd6da192 --- a/docs/memcached_auto.pod +++ b/docs/memcached_auto.pod @@ -1,6 +1,8 @@ =head1 NAME -memcached_increment, memcached_decrement +memcached_increment, memcached_decrement, +memcached_increment_with_initial, memcached_decrement_with_initial - Manipulate +counters =head1 LIBRARY @@ -10,18 +12,72 @@ C Client Library for memcached (libmemcached, -lmemcached) #include - memcached_return + memcached_return_t memcached_increment (memcached_st *ptr, const char *key, size_t key_length, unsigned int offset, uint64_t *value); - memcached_return + 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); + =head1 DESCRIPTION memcached(1) servers have the ability to increment and decrement keys @@ -36,16 +92,39 @@ 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 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 unsigned int +value pointer you pass to it. + +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. + +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. + =head1 RETURN -A value of type C is returned. +A value of type C is returned. On success that value will be C. Use memcached_strerror() to translate this value to a printable string. =head1 HOME To find out more information please check: -L +L =head1 AUTHOR