X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fmemcached_result_st.rst;h=e8aba51842a009d50d6c2b982c13036806e59223;hb=0f16555031c7f44d1acd034ff74e628c51a72dac;hp=058b743f7eb7496986854a8bb1e12df338710e70;hpb=281c398ba3a10af677494c4453cd09d85ca921e0;p=m6w6%2Flibmemcached diff --git a/docs/memcached_result_st.rst b/docs/memcached_result_st.rst index 058b743f..e8aba518 100644 --- a/docs/memcached_result_st.rst +++ b/docs/memcached_result_st.rst @@ -6,9 +6,9 @@ Working with result sets Work with memcached_result_st -******* +------- LIBRARY -******* +------- C Client Library for memcached (libmemcached, -lmemcached) @@ -59,9 +59,9 @@ 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 -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 -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. @@ -72,7 +72,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 -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. @@ -91,7 +91,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 -testss 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. @@ -108,9 +108,9 @@ stack based allocation. The most common issues related to ABI safety involve heap allocated structures. -****** +------ RETURN -****** +------ Varies, see particular functions. All structures must have @@ -118,21 +118,13 @@ memcached_result_free() called on them for cleanup purposes. Failure to do this will result in leaked memory. -**** +---- HOME -**** +---- To find out more information please check: -`https://launchpad.net/libmemcached `_ - - -****** -AUTHOR -****** - - -Brian Aker, +`http://libmemcached.org/ `_ --------