X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fman%2Fmemcached_result_length.3;h=4a03e44f8923923cdda457e3cf0a1b5474f2b56d;hb=bc9a024d4d2292b68be5d3a90063ea0193c7770f;hp=f6353d637d82afcd9f55756b700aeaca8513a2f2;hpb=4d82f8155a803e987352e9d6758df4d0449ecf5a;p=m6w6%2Flibmemcached diff --git a/docs/man/memcached_result_length.3 b/docs/man/memcached_result_length.3 index f6353d63..4a03e44f 100644 --- a/docs/man/memcached_result_length.3 +++ b/docs/man/memcached_result_length.3 @@ -1,4 +1,4 @@ -.TH "MEMCACHED_RESULT_LENGTH" "3" "June 02, 2011" "0.47" "libmemcached" +.TH "MEMCACHED_RESULT_LENGTH" "3" "September 26, 2011" "0.53" "libmemcached" .SH NAME memcached_result_length \- Working with result sets . @@ -30,13 +30,15 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .. .\" Man page generated from reStructeredText. . -.sp -Work with memcached_result_st .SH SYNOPSIS .sp #include .INDENT 0.0 .TP +.B memcached_result_st +.UNINDENT +.INDENT 0.0 +.TP .B memcached_result_st * memcached_result_create (memcached_st *ptr, memcached_result_st *result); .UNINDENT .INDENT 0.0 @@ -61,7 +63,7 @@ Work with memcached_result_st .UNINDENT .INDENT 0.0 .TP -.B uint32_t memcached_result_flags(const memcached_result_st\fI\ *result\fP) +.B uint32_t memcached_result_flags(const \fI\%memcached_result_st\fP\fI\ *result\fP) .UNINDENT .INDENT 0.0 .TP @@ -69,65 +71,64 @@ Work with memcached_result_st .UNINDENT .INDENT 0.0 .TP -.B memcached_return_t memcached_result_set_value(memcached_result_st\fI\ *ptr\fP, const char\fI\ *value\fP, size_t\fI\ length\fP) +.B memcached_return_t memcached_result_set_value(\fI\%memcached_result_st\fP\fI\ *ptr\fP, const char\fI\ *value\fP, size_t\fI\ length\fP) .UNINDENT .INDENT 0.0 .TP -.B void memcached_result_set_flags(memcached_result_st\fI\ *ptr\fP, uint32_t\fI\ flags\fP) +.B void memcached_result_set_flags(\fI\%memcached_result_st\fP\fI\ *ptr\fP, uint32_t\fI\ flags\fP) .UNINDENT .INDENT 0.0 .TP -.B void memcached_result_set_expiration(memcached_result_st\fI\ *ptr\fP, time_t) +.B void memcached_result_set_expiration(\fI\%memcached_result_st\fP\fI\ *ptr\fP, time_t) .UNINDENT .sp Compile and link with \-lmemcachedutil \-lmemcached .SH DESCRIPTION .sp -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 -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. +libmemcached(3) can optionally return a \fI\%memcached_result_st\fP 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 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. .sp -The structure of memcached_result_st has been encapsulated, you should not -write code to directly access members of the structure. +The structure of \fI\%memcached_result_st\fP has been encapsulated, you should +not write code to directly access members of the structure. .sp -memcached_result_create() will either allocate memory for a -memcached_result_st or will initialize a structure passed to it. +\fBmemcached_result_create()\fP will either allocate memory for a +\fI\%memcached_result_st\fP or will initialize a structure passed to it. .sp -memcached_result_free() will deallocate any memory attached to the +\fBmemcached_result_free()\fP will deallocate any memory attached to the structure. If the structure was also allocated, it will deallocate it. .sp -memcached_result_key_value() returns the key value associated with the +\fBmemcached_result_key_value()\fP returns the key value associated with the current result object. .sp -memcached_result_key_length() returns the key length associated with the -current result object. +\fBmemcached_result_key_length()\fP returns the key length associated with +the current result object. .sp -memcached_result_value() returns the result value associated with the +\fBmemcached_result_value()\fP returns the result value associated with the current result object. .sp -memcached_result_length() returns the result length associated with the -current result object. +\fBmemcached_result_length()\fP returns the result length associated with +the current result object. .sp -memcached_result_flags() returns the flags associated with the +\fI\%memcached_result_flags()\fP returns the flags associated with the current result object. .sp -memcached_result_cas() returns the cas associated with the +\fBmemcached_result_cas()\fP returns the cas associated with the current result object. This value will only be available if the server tests it. .sp -memcached_result_set_value() takes a byte array and a size and sets +\fI\%memcached_result_set_value()\fP takes a byte array and a size and sets the result to this value. This function is used for trigger responses. .sp -void memcached_result_set_flags() takes a result structure and stores +\fBvoid memcached_result_set_flags()\fP takes a result structure and stores a new value for the flags field. .sp -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). +\fBvoid memcached_result_set_expiration(A)()\fP takes a result structure and stores a new value for the expiration field (this is only used by read +through triggers). .sp You may wish to avoid using memcached_result_create(3) with a stack based allocation. The most common issues related to ABI safety involve @@ -135,8 +136,8 @@ heap allocated structures. .SH RETURN .sp Varies, see particular functions. All structures must have -memcached_result_free() called on them for cleanup purposes. Failure to -do this will result in leaked memory. +\fBmemcached_result_free()\fP called on them for cleanup purposes. Failure +to do this will result in leaked memory. .SH HOME .sp To find out more information please check: