projects / m6w6 / libmemcached / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree | github
raw | inline | side by side
KBDocs2
[m6w6/libmemcached] / docs / memcached_result_st.rst
diff --git a/docs/memcached_result_st.rst b/docs/memcached_result_st.rst
index 7c3c6d9cc8d3458d1c14bd542620ac542c3045bb..fab6c4a41b0c93f1a398efb30c2f7293d33600e7 100644 (file)
--- a/docs/memcached_result_st.rst
+++ b/docs/memcached_result_st.rst
@@ -1,69 +1,54 @@
-.. highlight:: perl
+========================
+Working with result sets
+========================
 
 
+.. index:: object: memcached_result_st
 
 
-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
-******************************************************************************************************************************************************************************************************
+Work with memcached_result_st
 
 
 
 
-Work with memcached_result_st
+--------
+SYNOPSIS
+--------
 
 
+#include <libmemcached/memcached_pool.h>
 
 
-*******
-LIBRARY
-*******
+.. c:function:: memcached_result_st * memcached_result_create (memcached_st *ptr, memcached_result_st *result);
 
 
+.. c:function:: void memcached_result_free (memcached_result_st *result);
 
 
-C Client Library for memcached (libmemcached, -lmemcached)
+.. c:function:: const char * memcached_result_key_value (memcached_result_st *result);
 
 
+.. c:function:: size_t memcached_result_key_length (const memcached_result_st *result);
 
 
-********
-SYNOPSIS
-********
-
-
-
-.. code-block:: perl
-
-   #include <memcached.h>
- 
-   memcached_result_st *
-     memcached_result_create (memcached_st *ptr,
-                              memcached_result_st *result);
- 
-   void memcached_result_free (memcached_result_st *result);
- 
-   const char * memcached_result_key_value (memcached_result_st *result);
- 
-   size_t memcached_result_key_length (const memcached_result_st *result);
- 
-   const char *memcached_result_value (memcached_result_st *ptr);
- 
-   size_t memcached_result_length (const memcached_result_st *ptr);
- 
-   uint32_t memcached_result_flags (const memcached_result_st *result)
- 
-   uint64_t memcached_result_cas (const memcached_result_st *result);
- 
-   memcached_return_t
-     memcached_result_set_value (memcached_result_st *ptr,
-                                 const char *value, size_t length)
- 
-   void memcached_result_set_flags (memcached_result_st *ptr, uint32_t flags)
- 
-   void memcached_result_set_expiration (memcached_result_st *ptr, time_t)
-
-
-
-***********
+.. c:function:: const char *memcached_result_value (memcached_result_st *ptr);
+
+.. c:function:: size_t memcached_result_length (const memcached_result_st *ptr);
+
+.. c:function:: uint32_t memcached_result_flags (const memcached_result_st *result)
+
+.. c:function:: uint64_t memcached_result_cas (const memcached_result_st *result);
+
+.. c:function:: memcached_return_t memcached_result_set_value (memcached_result_st *ptr, const char *value, size_t length)
+
+.. c:function:: void memcached_result_set_flags (memcached_result_st *ptr, uint32_t flags)
+
+.. c:function:: void memcached_result_set_expiration (memcached_result_st *ptr, time_t)
+
+Compile and link with -lmemcachedutil -lmemcached
+
+
+
+-----------
 DESCRIPTION
 DESCRIPTION
-***********
+-----------
 
 
 libmemcached(3) can optionally return a memcached_result_st which acts as a
 result object. The result objects have added benefits over the character
 
 
 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
+pointer returns, in that they are forward compatible with new return items
 that future memcached servers may implement (the best current example of
 that future memcached servers may implement (the best current example of
-this is the CAS return item). The structures can also be reused which will
+this is the CAS return item). The structures can also be reused, which will
 save on calls to malloc(3). It is suggested that you use result objects over
 char \* return functions.
 
 save on calls to malloc(3). It is suggested that you use result objects over
 char \* return functions.
 
@@ -74,7 +59,7 @@ memcached_result_create() will either allocate memory for a
 memcached_result_st or will initialize a structure passed to it.
 
 memcached_result_free() will deallocate any memory attached to the
 memcached_result_st or will initialize a structure passed to it.
 
 memcached_result_free() will deallocate any memory attached to the
-structure. If the structure was also alloacted, it will deallocate it.
+structure. If the structure was also allocated, it will deallocate it.
 
 memcached_result_key_value() returns the key value associated with the
 current result object.
 
 memcached_result_key_value() returns the key value associated with the
 current result object.
@@ -93,7 +78,7 @@ current result object.
 
 memcached_result_cas() returns the cas associated with the
 current result object. This value will only be available if the server
 
 memcached_result_cas() returns the cas associated with the
 current result object. This value will only be available if the server
-supports it.
+tests it.
 
 memcached_result_set_value() takes a byte array and a size and sets
 the result to this value. This function is used for trigger responses.
 
 memcached_result_set_value() takes a byte array and a size and sets
 the result to this value. This function is used for trigger responses.
@@ -110,9 +95,9 @@ stack based allocation. The most common issues related to ABI safety involve
 heap allocated structures.
 
 
 heap allocated structures.
 
 
-******
+------
 RETURN
 RETURN
-******
+------
 
 
 Varies, see particular functions. All structures must have
 
 
 Varies, see particular functions. All structures must have
@@ -120,27 +105,17 @@ memcached_result_free() called on them for cleanup purposes. Failure to
 do this will result in leaked memory.
 
 
 do this will result in leaked memory.
 
 
-****
+----
 HOME
 HOME
-****
+----
 
 
 To find out more information please check:
 
 
 To find out more information please check:
-`https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
-
+`http://libmemcached.org/ <http://libmemcached.org/>`_
 
 
-******
-AUTHOR
-******
 
 
-
-Brian Aker, <brian@tangent.org>
-
-
-********
+--------
 SEE ALSO
 SEE ALSO
-********
-
-
-memcached(1) libmemcached(3) memcached_strerror(3)
+--------
 
 
+:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
Resurrection of libmemcached https://launchpad.net/libmemcached