Hard to believe I documented the entire thing... this is a first.
[awesomized/libmemcached] / 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 memcached_increment(memcached_st *ptr,
14 char *key, size_t key_length,
15 unsigned int offset,
16 unsigned int *value);
17 memcached_return memcached_decrement(memcached_st *ptr,
18 char *key, size_t key_length,
19 unsigned int offset,
20 unsigned int *value);
21 =head1 DESCRIPTION
22
23 memcached(1) servers have the ability to increment and decrement keys
24 (overflow and underflow are not detected). This gives you the ability to use
25 servers to generate sequences of values.
26
27 memcached_increment() takes a key and keylength and increments the value by
28 the offset passed to it. The value is then returned via the unsigned int
29 value pointer you pass to it.
30
31 memcached_decrement() takes a key and keylength and decrements 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 =head1 RETURN
36
37 memcached_increment() and memcached_decrement() return a memcached_return
38 value. For information on this value see memcached_strerr(3).
39
40 =head1 HOME
41
42 To find out more information please check: http://tangent.org/552/libmemcached.html
43
44 =head1 AUTHOR
45
46 Brian Aker, brian@tangent.org
47
48 =head1 SEE ALSO
49
50 memcached(1) libmemcached(3) memcached_strerror(3)
51
52 =cut
53