~brianaker/libmemcached/1164440

« back to all changes in this revision

Viewing changes to docs/man/memcached_increment_with_initial.3

  • Committer: Continuous Integration
  • Date: 2012-03-14 16:53:36 UTC
  • mfrom: (990.2.1 workspace)
  • Revision ID: ci@tangent.org-20120314165336-mjrg2hwmb6sx1er2
jenkins-promote-staging-trunk-libmemcached-3

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
.TH "MEMCACHED_INCREMENT_WITH_INITIAL" "3" "January 26, 2012" "1.0.4" "libmemcached"
 
1
.TH "MEMCACHED_INCREMENT_WITH_INITIAL" "3" "March 14, 2012" "1.0.5" "libmemcached"
2
2
.SH NAME
3
3
memcached_increment_with_initial \- Incrementing and Decrementing Values
4
4
.
35
35
#include <libmemcached/memcached.h>
36
36
.INDENT 0.0
37
37
.TP
38
 
.B memcached_return_t memcached_increment (memcached_st *ptr, const char *key, size_t key_length, unsigned int offset, uint64_t *value);
39
 
.UNINDENT
40
 
.INDENT 0.0
41
 
.TP
42
 
.B memcached_return_t memcached_decrement (memcached_st *ptr, const char *key, size_t key_length, unsigned int offset, uint64_t *value);
43
 
.UNINDENT
44
 
.INDENT 0.0
45
 
.TP
46
 
.B 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);
47
 
.UNINDENT
48
 
.INDENT 0.0
49
 
.TP
50
 
.B 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);
51
 
.UNINDENT
52
 
.INDENT 0.0
53
 
.TP
54
 
.B 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, unsigned int offset, uint64_t *value);
55
 
.UNINDENT
56
 
.INDENT 0.0
57
 
.TP
58
 
.B 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, unsigned int offset, uint64_t *value);
59
 
.UNINDENT
60
 
.INDENT 0.0
61
 
.TP
62
 
.B memcached_return_t memcached_increment_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);
63
 
.UNINDENT
64
 
.INDENT 0.0
65
 
.TP
66
 
.B 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);
 
38
.B memcached_return_t memcached_increment(memcached_st\fI\ *ptr\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, uint32_t\fI\ offset\fP, uint64_t\fI\ *value\fP)
 
39
.UNINDENT
 
40
.INDENT 0.0
 
41
.TP
 
42
.B memcached_return_t memcached_decrement(memcached_st\fI\ *ptr\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, uint32_t\fI\ offset\fP, uint64_t\fI\ *value\fP)
 
43
.UNINDENT
 
44
.INDENT 0.0
 
45
.TP
 
46
.B memcached_return_t memcached_increment_with_initial(memcached_st\fI\ *ptr\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, uint64_t\fI\ offset\fP, uint64_t\fI\ initial\fP, time_t\fI\ expiration\fP, uint64_t\fI\ *value\fP)
 
47
.UNINDENT
 
48
.INDENT 0.0
 
49
.TP
 
50
.B memcached_return_t memcached_decrement_with_initial(memcached_st\fI\ *ptr\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, uint64_t\fI\ offset\fP, uint64_t\fI\ initial\fP, time_t\fI\ expiration\fP, uint64_t\fI\ *value\fP)
 
51
.UNINDENT
 
52
.INDENT 0.0
 
53
.TP
 
54
.B memcached_return_t memcached_increment_by_key(memcached_st\fI\ *ptr\fP, const char\fI\ *group_key\fP, size_t\fI\ group_key_length\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, uint32_t\fI\ offset\fP, uint64_t\fI\ *value\fP)
 
55
.UNINDENT
 
56
.INDENT 0.0
 
57
.TP
 
58
.B memcached_return_t memcached_decrement_by_key(memcached_st\fI\ *ptr\fP, const char\fI\ *group_key\fP, size_t\fI\ group_key_length\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, uint32_t\fI\ offset\fP, uint64_t\fI\ *value\fP)
 
59
.UNINDENT
 
60
.INDENT 0.0
 
61
.TP
 
62
.B memcached_return_t memcached_increment_with_initial_by_key(memcached_st\fI\ *ptr\fP, const char\fI\ *group_key\fP, size_t\fI\ group_key_length\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, uint64_t\fI\ offset\fP, uint64_t\fI\ initial\fP, time_t\fI\ expiration\fP, uint64_t\fI\ *value\fP)
 
63
.UNINDENT
 
64
.INDENT 0.0
 
65
.TP
 
66
.B memcached_return_t memcached_decrement_with_initial_by_key(memcached_st\fI\ *ptr\fP, const char\fI\ *group_key\fP, size_t\fI\ group_key_length\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, uint64_t\fI\ offset\fP, uint64_t\fI\ initial\fP, time_t\fI\ expiration\fP, uint64_t\fI\ *value\fP)
67
67
.UNINDENT
68
68
.sp
69
69
Compile and link with \-lmemcached
73
73
(overflow and underflow are not detected). This gives you the ability to use
74
74
memcached to generate shared sequences of values.
75
75
.sp
76
 
memcached_increment() takes a key and keylength and increments the value by
77
 
the offset passed to it. The value is then returned via the unsigned int
78
 
value pointer you pass to it.
79
 
.sp
80
 
memcached_decrement() takes a key and keylength and decrements the value by
81
 
the offset passed to it. The value is then returned via the unsigned int
82
 
value pointer you pass to it.
83
 
.sp
84
 
memcached_increment_with_initial() takes a key and keylength and increments
85
 
the value by the offset passed to it. If the object specified by key does
86
 
not exist, one of two things may happen: If the expiration value is
87
 
MEMCACHED_EXPIRATION_NOT_ADD, the operation will fail. For all other
88
 
expiration values, the operation will succeed by seeding the value for that
89
 
key with a initial value to expire with the provided expiration time. The
90
 
flags will be set to zero.The value is then returned via the unsigned int
91
 
value pointer you pass to it.
92
 
.sp
93
 
memcached_decrement_with_initial() takes a key and keylength and decrements
94
 
the value by the offset passed to it. If the object specified by key does
95
 
not exist, one of two things may happen: If the expiration value is
96
 
MEMCACHED_EXPIRATION_NOT_ADD, the operation will fail. For all other
97
 
expiration values, the operation will succeed by seeding the value for that
98
 
key with a initial value to expire with the provided expiration time. The
99
 
flags will be set to zero.The value is then returned via the unsigned int
100
 
value pointer you pass to it.
101
 
.sp
102
 
memcached_increment_by_key(), memcached_decrement_by_key(),
103
 
memcached_increment_with_initial_by_key(), and
104
 
memcached_decrement_with_initial_by_key() are master key equivalents of the
105
 
above.
 
76
memcached_increment takes a key and keylength and increments the value by
 
77
the offset passed to it. The value is then returned via the uint32_t
 
78
value pointer you pass to it.
 
79
.sp
 
80
memcached_decrement takes a key and keylength and decrements the value by
 
81
the offset passed to it. The value is then returned via the uint32_t
 
82
value pointer you pass to it.
 
83
.sp
 
84
memcached_increment_with_initial takes a key and keylength and increments
 
85
the value by the offset passed to it. If the object specified by key does
 
86
not exist, one of two things may happen: If the expiration value is
 
87
MEMCACHED_EXPIRATION_NOT_ADD, the operation will fail. For all other
 
88
expiration values, the operation will succeed by seeding the value for that
 
89
key with a initial value to expire with the provided expiration time. The
 
90
flags will be set to zero.The value is then returned via the uint32_t
 
91
value pointer you pass to it.
 
92
.sp
 
93
memcached_decrement_with_initial takes a key and keylength and decrements
 
94
the value by the offset passed to it. If the object specified by key does
 
95
not exist, one of two things may happen: If the expiration value is
 
96
MEMCACHED_EXPIRATION_NOT_ADD, the operation will fail. For all other
 
97
expiration values, the operation will succeed by seeding the value for that
 
98
key with a initial value to expire with the provided expiration time. The
 
99
flags will be set to zero.The value is then returned via the uint32_t
 
100
value pointer you pass to it.
 
101
.sp
 
102
\fI\%memcached_increment_by_key()\fP, \fI\%memcached_decrement_by_key()\fP,
 
103
\fI\%memcached_increment_with_initial_by_key()\fP, and
 
104
\fI\%memcached_decrement_with_initial_by_key()\fP are master key equivalents of the above.
106
105
.SH RETURN
107
106
.sp
108
 
A value of type \fBmemcached_return_t\fP is returned.
 
107
A value of type \fBmemcached_return_t\fP  is returned.
109
108
On success that value will be \fBMEMCACHED_SUCCESS\fP.
110
 
Use memcached_strerror() to translate this value to a printable string.
 
109
Use memcached_strerror to translate this value to a printable string.
111
110
.SH HOME
112
111
.sp
113
112
To find out more information please check: