git.m6w6.name Git - awesomized/libmemcached/blob - docs/memcached_auto.pod

   1 =head1 NAME
   2
   3 memcached_increment, memcached_decrement
   4
   5 =head1 LIBRARY
   6
   7 C Client Library for memcached (libmemcached, -lmemcached)
   8
   9 =head1 SYNOPSIS
  10
  11   #include <memcached.h>
  12
  13   memcached_return
  14     memcached_increment (memcached_st *ptr,
  15                          const char *key, size_t key_length,
  16                          unsigned int offset,
  17                          uint64_t *value);
  18
  19   memcached_return
  20     memcached_decrement (memcached_st *ptr,
  21                          const char *key, size_t key_length,
  22                          unsigned int offset,
  23                          uint64_t *value);
  24
  25 =head1 DESCRIPTION
  26
  27 memcached(1) servers have the ability to increment and decrement keys
  28 (overflow and underflow are not detected). This gives you the ability to use
  29 memcached to generate shared sequences of values.
  30
  31 memcached_increment() takes a key and keylength and increments the value by
  32 the offset passed to it. The value is then returned via the unsigned int
  33 value pointer you pass to it.
  34
  35 memcached_decrement() takes a key and keylength and decrements the value by
  36 the offset passed to it. The value is then returned via the unsigned int
  37 value pointer you pass to it.
  38
  39 =head1 RETURN
  40
  41 A value of type C<memcached_return> is returned.
  42 On success that value will be C<MEMCACHED_SUCCESS>.
  43 Use memcached_strerror() to translate this value to a printable string.
  44
  45 =head1 HOME
  46
  47 To find out more information please check:
  48 L<http://tangent.org/552/libmemcached.html>
  49
  50 =head1 AUTHOR
  51
  52 Brian Aker, E<lt>brian@tangent.orgE<gt>
  53
  54 =head1 SEE ALSO
  55
  56 memcached(1) libmemcached(3) memcached_strerror(3)
  57
  58 =cut
  59