X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fmemcached_auto.pod;h=f877405ed21fdd7be1d53bf6deff1ec747ac663d;hb=f2fabd2f29fa624e4d48b1605bd46b233e7ce408;hp=27332e93ee7fe41ef028450130cc9862eaedf3e1;hpb=24a2ae8e311f1598bd06f3ae60999d80ae770d03;p=awesomized%2Flibmemcached diff --git a/docs/memcached_auto.pod b/docs/memcached_auto.pod old mode 100755 new mode 100644 index 27332e93..f877405e --- 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 @@ -12,16 +14,34 @@ C Client Library for memcached (libmemcached, -lmemcached) memcached_return memcached_increment (memcached_st *ptr, - char *key, size_t key_length, + const char *key, size_t key_length, unsigned int offset, uint64_t *value); memcached_return memcached_decrement (memcached_st *ptr, - char *key, size_t key_length, + const char *key, size_t key_length, unsigned int offset, uint64_t *value); + memcached_return + 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 + 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); + =head1 DESCRIPTION memcached(1) servers have the ability to increment and decrement keys @@ -36,6 +56,24 @@ 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. + =head1 RETURN A value of type C is returned.