git.m6w6.name Git - awesomized/libmemcached/blob - docs/man/memcached_increment_with_initial.3

   1 .TH "MEMCACHED_INCREMENT_WITH_INITIAL" "3" "April 10, 2011" "0.47" "libmemcached"
   2 .SH NAME
   3 memcached_increment_with_initial \- Incrementing and Decrementing Values
   4 .
   5 .nr rst2man-indent-level 0
   6 .
   7 .de1 rstReportMargin
   8 \\$1 \\n[an-margin]
   9 level \\n[rst2man-indent-level]
  10 level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
  11 -
  12 \\n[rst2man-indent0]
  13 \\n[rst2man-indent1]
  14 \\n[rst2man-indent2]
  15 ..
  16 .de1 INDENT
  17 .\" .rstReportMargin pre:
  18 . RS \\$1
  19 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
  20 . nr rst2man-indent-level +1
  21 .\" .rstReportMargin post:
  22 ..
  23 .de UNINDENT
  24 . RE
  25 .\" indent \\n[an-margin]
  26 .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
  27 .nr rst2man-indent-level -1
  28 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
  29 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
  30 ..
  31 .\" Man page generated from reStructeredText.
  32 .
  33 .SH SYNOPSIS
  34 .sp
  35 #include <libmemcached/memcached.h>
  36 .INDENT 0.0
  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 *master_key, size_t master_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 *master_key, size_t master_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 *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);
  63 .UNINDENT
  64 .INDENT 0.0
  65 .TP
  66 .B 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);
  67 .UNINDENT
  68 .sp
  69 Compile and link with \-lmemcached
  70 .SH DESCRIPTION
  71 .sp
  72 \fImemcached(1)\fP servers have the ability to increment and decrement keys
  73 (overflow and underflow are not detected). This gives you the ability to use
  74 memcached to generate shared sequences of values.
  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.
 106 .SH RETURN
 107 .sp
 108 A value of type \fBmemcached_return_t\fP is returned.
 109 On success that value will be \fBMEMCACHED_SUCCESS\fP.
 110 Use memcached_strerror() to translate this value to a printable string.
 111 .SH HOME
 112 .sp
 113 To find out more information please check:
 114 \fI\%https://launchpad.net/libmemcached\fP
 115 .SH SEE ALSO
 116 .sp
 117 \fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP
 118 .SH AUTHOR
 119 Brian Aker
 120 .SH COPYRIGHT
 121 2011, Brian Aker DataDifferential, http://datadifferential.com/
 122 .\" Generated by docutils manpage writer.
 123 .\"
 124 .