Merging support for by_key operations.

[awesomized/libmemcached] / docs / memcached_auto.pod

diff --git a/docs/memcached_auto.pod b/docs/memcached_auto.pod
old mode 100755 (executable)
new mode 100644 (file)
index 177bb4c..482ac77
--- 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
 


@@ -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
+    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
+    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
+    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
+    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,6 +110,11 @@ 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
 
 A value of type C<memcached_return> is returned.
 =head1 RETURN
 
 A value of type C<memcached_return> is returned.