Merge Thomason's cork patch.

[awesomized/libmemcached] / docs / memcached_auto.pod

diff --git a/docs/memcached_auto.pod b/docs/memcached_auto.pod
index 177bb4c89986558f51b7be7714540ce7ee5b1166..bd6da19242e707cca39c022e835eab779b13a236 100644 (file)
--- a/docs/memcached_auto.pod
+++ b/docs/memcached_auto.pod
@@ -1,7 +1,8 @@
 =head1 NAME
 
 memcached_increment, memcached_decrement,
 =head1 NAME
 
 memcached_increment, memcached_decrement,

-memcached_increment_with_initial, memcached_decrement_with_initial
+memcached_increment_with_initial, memcached_decrement_with_initial - Manipulate
+counters

 
 =head1 LIBRARY
 
 
 =head1 LIBRARY
 


@@ -11,19 +12,19 @@ C Client Library for memcached (libmemcached, -lmemcached)
 
   #include <memcached.h>
 
 
   #include <memcached.h>
 

-  memcached_return
+  memcached_return_t

     memcached_increment (memcached_st *ptr, 
                          const char *key, size_t key_length,
                          unsigned int offset,
                          uint64_t *value);
 
     memcached_increment (memcached_st *ptr, 
                          const char *key, size_t key_length,
                          unsigned int offset,
                          uint64_t *value);
 

-  memcached_return
+  memcached_return_t

     memcached_decrement (memcached_st *ptr, 
                          const char *key, size_t key_length,
                          unsigned int offset,
                          uint64_t *value);
 
     memcached_decrement (memcached_st *ptr, 
                          const char *key, size_t key_length,
                          unsigned int offset,
                          uint64_t *value);
 

-  memcached_return
+  memcached_return_t

     memcached_increment_with_initial (memcached_st *ptr,
                                       const char *key,
                                       size_t key_length,
     memcached_increment_with_initial (memcached_st *ptr,
                                       const char *key,
                                       size_t key_length,


@@ -32,7 +33,7 @@ C Client Library for memcached (libmemcached, -lmemcached)
                                       time_t expiration,
                                       uint64_t *value);
 
                                       time_t expiration,
                                       uint64_t *value);
 

-  memcached_return
+  memcached_return_t

     memcached_decrement_with_initial (memcached_st *ptr,
                                       const char *key,
                                       size_t key_length,
     memcached_decrement_with_initial (memcached_st *ptr,
                                       const char *key,
                                       size_t key_length,


@@ -41,6 +42,42 @@ C Client Library for memcached (libmemcached, -lmemcached)
                                       time_t expiration,
                                       uint64_t *value);
 
                                       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);
+

 =head1 DESCRIPTION
 
 memcached(1) servers have the ability to increment and decrement keys
 =head1 DESCRIPTION
 
 memcached(1) servers have the ability to increment and decrement keys


@@ -73,16 +110,21 @@ 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.
 
 flags will be set to zero.The value is then returned via the unsigned int
 value pointer you pass to it.
 

+memcached_increment_by_key(), memcached_decrement_by_key(),
+memcached_increment_with_initial_by_key(), and
+memcached_decrement_with_initial_by_key() are master key equivalents of the
+above.
+

 =head1 RETURN
 
 =head1 RETURN
 

-A value of type C<memcached_return> is returned.
+A value of type C<memcached_return_t> is returned.

 On success that value will be C<MEMCACHED_SUCCESS>.
 Use memcached_strerror() to translate this value to a printable string.
 
 =head1 HOME
 
 To find out more information please check:
 On success that value will be C<MEMCACHED_SUCCESS>.
 Use memcached_strerror() to translate this value to a printable string.
 
 =head1 HOME
 
 To find out more information please check:

-L<http://tangent.org/552/libmemcached.html>
+L<https://launchpad.net/libmemcached>

 
 =head1 AUTHOR
 
 
 =head1 AUTHOR