Pushing weighted ketama code.

[m6w6/libmemcached] / docs / memcached_set.pod

diff --git a/docs/memcached_set.pod b/docs/memcached_set.pod
index 0578d17f3b372c39db2e3a1f39e36b1efb758dac..5e7ac18626e2ef8bccc660c86b2a5182bc8cdc2e 100755 (executable)
--- a/docs/memcached_set.pod
+++ b/docs/memcached_set.pod
@@ -12,46 +12,95 @@ C Client Library for memcached (libmemcached, -lmemcached)
 
   memcached_return
     memcached_set (memcached_st *ptr,
-                   char *key, size_t key_length, 
-                   char *value, size_t value_length, 
+                   const char *key, size_t key_length, 
+                   const char *value, size_t value_length, 
                    time_t expiration,
-                   uint16_t flags);
+                   uint32_t flags);
 
   memcached_return
     memcached_add (memcached_st *ptr,
-                   char *key, size_t key_length,
-                   char *value, size_t value_length, 
+                   const char *key, size_t key_length,
+                   const char *value, size_t value_length, 
                    time_t expiration,
-                   uint16_t flags);
+                   uint32_t flags);
 
   memcached_return
     memcached_replace (memcached_st *ptr,
-                       char *key, size_t key_length,
-                       char *value, size_t value_length, 
+                       const char *key, size_t key_length,
+                       const char *value, size_t value_length, 
                        time_t expiration,
-                       uint16_t flags);
+                       uint32_t flags);
 
   memcached_return 
     memcached_prepend(memcached_st *ptr, 
-                      char *key, size_t key_length,
-                      char *value, size_t value_length, 
+                      const char *key, size_t key_length,
+                      const char *value, size_t value_length, 
                       time_t expiration,
-                      uint16_t flags)
+                      uint32_t flags)
 
   memcached_return 
     memcached_append(memcached_st *ptr, 
-                     char *key, size_t key_length,
-                      char *value, size_t value_length, 
+                     const char *key, size_t key_length,
+                      const char *value, size_t value_length, 
                       time_t expiration,
-                      uint16_t flags)
+                      uint32_t flags)
   memcached_return 
     memcached_cas(memcached_st *ptr, 
-                  char *key, size_t key_length,
-                  char *value, size_t value_length, 
+                  const char *key, size_t key_length,
+                  const char *value, size_t value_length, 
                   time_t expiration,
-                  uint16_t flags,
+                  uint32_t flags,
                   uint64_t cas);
 
+  memcached_return 
+    memcached_set_by_key(memcached_st *ptr, 
+                         const char *master_key, size_t master_key_length, 
+                         const char *key, size_t key_length, 
+                         const char *value, size_t value_length, 
+                         time_t expiration,
+                         uint32_t flags);
+
+  memcached_return 
+    memcached_add_by_key(memcached_st *ptr, 
+                         const char *master_key, size_t master_key_length,
+                         const char *key, size_t key_length,
+                         const char *value, size_t value_length, 
+                         time_t expiration,
+                         uint32_t flags);
+
+  memcached_return 
+    memcached_replace_by_key(memcached_st *ptr, 
+                             const char *master_key, size_t master_key_length,
+                             const char *key, size_t key_length,
+                             const char *value, size_t value_length, 
+                             time_t expiration,
+                             uint32_t flags);
+
+  memcached_return 
+    memcached_prepend_by_key(memcached_st *ptr, 
+                             const char *master_key, size_t master_key_length,
+                             const char *key, size_t key_length,
+                             const char *value, size_t value_length, 
+                             time_t expiration,
+                             uint32_t flags);
+
+  memcached_return 
+    memcached_append_by_key(memcached_st *ptr, 
+                            const char *master_key, size_t master_key_length,
+                            const char *key, size_t key_length,
+                            const char *value, size_t value_length, 
+                            time_t expiration,
+                            uint32_t flags);
+
+  memcached_return 
+    memcached_cas_by_key(memcached_st *ptr, 
+                         const char *master_key, size_t master_key_length,
+                         const char *key, size_t key_length,
+                         const char *value, size_t value_length, 
+                         time_t expiration,
+                         uint32_t flags,
+                         uint64_t cas);
+
 =head1 DESCRIPTION
 
 memcached_set(), memcached_add(), and memcached_replace() are all used to
@@ -85,6 +134,12 @@ that this note was written cas is still buggy in memached. Turning on support
 for it in libmemcached(3) is optional. Please see memcached_set() for 
 information on how to do this.
 
+memcached_set_by_key(), memcached_add_by_key(), memcached_replace_by_key(), 
+memcached_prepend_by_key(), memcached_append_by_key_by_key(), 
+memcached_cas_by_key() methods all behave in a similar method as the non key 
+methods. The difference is that they use their master_key parameter to map
+objects to particular servers.
+
 If you are looking for performance, memcached_set() with non-blocking IO is 
 the fastest way to store data on the server.