Full CAS support now enabled in the library.

[awesomized/libmemcached] / docs / memcached_set.pod

diff --git a/docs/memcached_set.pod b/docs/memcached_set.pod
index 93037c14ce60473097dde66008c9875e0a0ff235..0578d17f3b372c39db2e3a1f39e36b1efb758dac 100755 (executable)
--- a/docs/memcached_set.pod
+++ b/docs/memcached_set.pod
@@ -31,6 +31,27 @@ C Client Library for memcached (libmemcached, -lmemcached)
                        time_t expiration,
                        uint16_t flags);
 
+  memcached_return 
+    memcached_prepend(memcached_st *ptr, 
+                      char *key, size_t key_length,
+                      char *value, size_t value_length, 
+                      time_t expiration,
+                      uint16_t flags)
+
+  memcached_return 
+    memcached_append(memcached_st *ptr, 
+                     char *key, size_t key_length,
+                      char *value, size_t value_length, 
+                      time_t expiration,
+                      uint16_t flags)
+  memcached_return 
+    memcached_cas(memcached_st *ptr, 
+                  char *key, size_t key_length,
+                  char *value, size_t value_length, 
+                  time_t expiration,
+                  uint16_t flags,
+                  uint64_t cas);
+
 =head1 DESCRIPTION
 
 memcached_set(), memcached_add(), and memcached_replace() are all used to
@@ -51,8 +72,21 @@ found on the server an error occurs.
 memcached_add() adds an object to the server. If the object is found on the
 server an error occurs, otherwise the value is stored.
 
-memcached_set() with non-blocking IO is the fastest way to store data on the
-server.
+memcached_prepend() places a segment of data before the last piece of data 
+stored. Currently expiration and key are not used in the server.
+
+memcached_append() places a segment of data at the end of the last piece of 
+data stored. Currently expiration and key are not used in the server.
+
+memcached_cas() overwrites data in the server as long as the "cas" value is 
+still the same in the server. You can get the cas value of a result by 
+calling memcached_result_cas() on a memcached_result_st(3) structure. At the point 
+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.
+
+If you are looking for performance, memcached_set() with non-blocking IO is 
+the fastest way to store data on the server.
 
 =head1 RETURN