Updated .spec file for release.

[awesomized/libmemcached] / docs / memcached_result_st.pod

diff --git a/docs/memcached_result_st.pod b/docs/memcached_result_st.pod
old mode 100755 (executable)
new mode 100644 (file)
index a8f3977..ab69f26
--- a/docs/memcached_result_st.pod
+++ b/docs/memcached_result_st.pod
@@ -3,7 +3,7 @@
 memcached_result_create, memcached_result_free,
 memcached_result_key_value, memcached_result_key_length,
 memcached_result_value, memcached_result_length,
-memcached_result_flags, memcached_result_cas
+memcached_result_flags, memcached_result_cas - Work with results
 
 
 =head1 LIBRARY
@@ -14,33 +14,35 @@ C Client Library for memcached (libmemcached, -lmemcached)
 
   #include <memcached.h>
 
-  memcached_result_st *memcached_result_create(memcached_st *ptr, 
-                                               memcached_result_st *result);
+  memcached_result_st *
+    memcached_result_create (memcached_st *ptr,
+                             memcached_result_st *result);
 
   void memcached_result_free(memcached_result_st *result);
 
-  char * memcached_result_key_value(memcached_result_st *result);
+  char * memcached_result_key_value (memcached_result_st *result);
 
-  size_t memcached_result_key_length(memcached_result_st *result);
+  size_t memcached_result_key_length (memcached_result_st *result);
 
-  char *memcached_result_value(memcached_result_st *ptr);
+  char *memcached_result_value (memcached_result_st *ptr);
 
-  size_t memcached_result_length(memcached_result_st *ptr);
+  size_t memcached_result_length (memcached_result_st *ptr);
 
-  uint32_t memcached_result_flags(memcached_result_st *result)
+  uint32_t memcached_result_flags (memcached_result_st *result)
 
-  uint64_t memcached_result_cas(memcached_result_st *result);
+  uint64_t memcached_result_cas (memcached_result_st *result);
 
-  memcached_return memcached_result_set_value (memcached_result_st *ptr, 
-                                              char *value, size_t length)
+  memcached_return_t
+    memcached_result_set_value (memcached_result_st *ptr,
+                                char *value, size_t length)
 
-  void memcached_result_set_flags(memcached_result_st *ptr, uint32_t flags)
+  void memcached_result_set_flags (memcached_result_st *ptr, uint32_t flags)
 
-  void memcached_result_set_expiration(memcached_result_st *ptr, time_t)
+  void memcached_result_set_expiration (memcached_result_st *ptr, time_t)
 
 =head1 DESCRIPTION
 
-libmemcached(3) can optionally return a memcached_result_st which acts as a 
+libmemcached(3) can optionally return a memcached_result_st which acts as a
 result object. The result objects have added benefits over the character
 pointer returns in that they are forward compatible with new return items
 that future memcached servers may implement (the best current example of
@@ -64,13 +66,13 @@ memcached_result_key_length() returns the key length associated with the
 current result object.
 
 memcached_result_value() returns the result value associated with the
-current result object. 
+current result object.
 
 memcached_result_length() returns the result length associated with the
-current result object. 
+current result object.
 
 memcached_result_flags() returns the flags associated with the
-current result object. 
+current result object.
 
 memcached_result_cas() returns the cas associated with the
 current result object. This value will only be available if the server
@@ -82,21 +84,24 @@ the result to this value. This function is used for trigger responses.
 void memcached_result_set_flags() takes a result structure and stores
 a new value for the flags field.
 
-void memcached_result_set_expiration(A) takes a result structure and stores 
+void memcached_result_set_expiration(A) takes a result structure and stores
 a new value for the expiration field (this is only used by read through
 triggers).
 
+You may wish to avoid using memcached_result_create(3) with a
+stack based allocation. The most common issues related to ABI safety involve
+heap allocated structures.
 
 =head1 RETURN
 
 Varies, see particular functions. All structures must have
-memcached_result_free() called on them for cleanup purposes. Failure to 
+memcached_result_free() called on them for cleanup purposes. Failure to
 do this will result in leaked memory.
 
 =head1 HOME
 
 To find out more information please check:
-L<http://tangent.org/552/libmemcached.html>
+L<https://launchpad.net/libmemcached>
 
 =head1 AUTHOR