Tar Archive: /hpux/Misc/libmemcached-0.46/libmemcached-0.46-hppa_32-11.23.depot.gz
Filename: libmemcached/libmemcached-MAN/usr/local/share/man/man3/memcached_increment_with_initial.3
.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.07)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings. \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote. \*(C+ will
.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
. ds -- \(*W-
. ds PI pi
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
. ds L" ""
. ds R" ""
. ds C` ""
. ds C' ""
'br\}
.el\{\
. ds -- \|\(em\|
. ds PI \(*p
. ds L" ``
. ds R" ''
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.ie \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. nr % 0
. rr F
.\}
.el \{\
. de IX
..
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff
.if n \{\
. ds #H 0
. ds #V .8m
. ds #F .3m
. ds #[ \f1
. ds #] \fP
.\}
.if t \{\
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
. ds #V .6m
. ds #F 0
. ds #[ \&
. ds #] \&
.\}
. \" simple accents for nroff and troff
.if n \{\
. ds ' \&
. ds ` \&
. ds ^ \&
. ds , \&
. ds ~ ~
. ds /
.\}
.if t \{\
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
. \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
. \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
. \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
. ds : e
. ds 8 ss
. ds o a
. ds d- d\h'-1'\(ga
. ds D- D\h'-1'\(hy
. ds th \o'bp'
. ds Th \o'LP'
. ds ae ae
. ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "memcached_increment_with_initial.pop 3"
.TH memcached_increment_with_initial.pop 3 "2010-06-28" "" "memcached_increment_with_initial"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
memcached_increment, memcached_decrement,
memcached_increment_with_initial, memcached_decrement_with_initial \- Manipulate
counters
.SH "LIBRARY"
.IX Header "LIBRARY"
C Client Library for memcached (libmemcached, \-lmemcached)
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& #include
\&
\& memcached_return_t
\& memcached_increment (memcached_st *ptr,
\& const char *key, size_t key_length,
\& unsigned int offset,
\& uint64_t *value);
\&
\& 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);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\fImemcached\fR\|(1) servers have the ability to increment and decrement keys
(overflow and underflow are not detected). This gives you the ability to use
memcached to generate shared sequences of values.
.PP
\&\fImemcached_increment()\fR takes a key and keylength and increments the value by
the offset passed to it. The value is then returned via the unsigned int
value pointer you pass to it.
.PP
\&\fImemcached_decrement()\fR 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.
.PP
\&\fImemcached_increment_with_initial()\fR 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
\&\s-1MEMCACHED_EXPIRATION_NOT_ADD\s0, 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.
.PP
\&\fImemcached_decrement_with_initial()\fR 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
\&\s-1MEMCACHED_EXPIRATION_NOT_ADD\s0, 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.
.PP
\&\fImemcached_increment_by_key()\fR, \fImemcached_decrement_by_key()\fR,
\&\fImemcached_increment_with_initial_by_key()\fR, and
\&\fImemcached_decrement_with_initial_by_key()\fR are master key equivalents of the
above.
.SH "RETURN"
.IX Header "RETURN"
A value of type \f(CW\*(C`memcached_return_t\*(C'\fR is returned.
On success that value will be \f(CW\*(C`MEMCACHED_SUCCESS\*(C'\fR.
Use \fImemcached_strerror()\fR to translate this value to a printable string.
.SH "HOME"
.IX Header "HOME"
To find out more information please check:
.SH "AUTHOR"
.IX Header "AUTHOR"
Brian Aker,
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fImemcached\fR\|(1) \fIlibmemcached\fR\|(3) \fImemcached_strerror\fR\|(3)