-1.0.5
+1.0.5 Tue Mar 13 22:56:47 PDT 2012
+* Fixes for OSX.
* Version is now parsed directly in the parser, which makes buffered operations now work with it..
* memstat has been extended so that it can be used to find the version of the server.
* Update documentation.
* Fixes for compile issues on Debian and Ubuntu
-
1.0.4 Thu Jan 26 22:33:54 PST 2012
* Fix for memcached_dump().
* Additional testing for memcached_stat_execute().
-.TH "HASHKIT_CLONE" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "HASHKIT_CLONE" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
hashkit_clone \- libhashkit Documentation
.
.UNINDENT
.INDENT 0.0
.TP
-.B hashkit_st *hashkit_create(hashkit_st *hash);
+.B \fI\%hashkit_st\fP *hashkit_create(\fI\%hashkit_st\fP\fI\ *hash\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B hashkit_st *hashkit_clone(hashkit_st *destination, const hashkit_st *ptr);
+.B \fI\%hashkit_st\fP *hashkit_clone(\fI\%hashkit_st\fP\fI\ *destination\fP, const \fI\%hashkit_st\fP\fI\ *ptr\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B void hashkit_free(hashkit_st *hash);
+.B void hashkit_free(\fI\%hashkit_st\fP\fI\ *hash\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B bool hashkit_is_allocated(const hashkit_st *hash);
+.B bool hashkit_is_allocated(const \fI\%hashkit_st\fP\fI\ *hash\fP)
.UNINDENT
.sp
Compile and link with \-lhashkit
.SH DESCRIPTION
.sp
-The \fBhashkit_create()\fP function initializes a hashkit object for use. If
+The \fI\%hashkit_create()\fP function initializes a hashkit object for use. If
you pass a NULL argument for hash, then the memory for the object is
allocated. If you specify a pre\-allocated piece of memory, that is
initialized for use.
.sp
-The \fBhashkit_clone()\fP function initializes a hashkit object much like
-\fBhashkit_create()\fP, but instead of using default settings it will use
+The \fI\%hashkit_clone()\fP function initializes a hashkit object much like
+\fI\%hashkit_create()\fP, but instead of using default settings it will use
the settings of the ptr hashkit object.
.sp
-The \fBhashkit_free()\fP frees any resources being consumed by the hashkit
-objects that were initialized with \fBhashkit_create()\fP or \fBhashkit_clone()\fP.
+The \fI\%hashkit_free()\fP frees any resources being consumed by the hashkit
+objects that were initialized with \fI\%hashkit_create()\fP or \fI\%hashkit_clone()\fP.
.sp
-The \fBhashkit_is_allocated()\fP reports where the memory was allocated
+The \fI\%hashkit_is_allocated()\fP reports where the memory was allocated
for a hashkit object.
.SH RETURN VALUE
.sp
-\fBhashkit_create()\fP and \fBhashkit_clone()\fP will return NULL on
+\fI\%hashkit_create()\fP and \fI\%hashkit_clone()\fP will return NULL on
failure or non\-NULL on success.
.sp
-\fBhashkit_is_allocated()\fP returns true if the memory for the hashkit
-object was allocated inside of \fBhashkit_create()\fP or
-\fBhashkit_clone()\fP, otherwise it is false and was user\-supplied memory.
+\fI\%hashkit_is_allocated()\fP returns true if the memory for the hashkit
+object was allocated inside of \fI\%hashkit_create()\fP or
+\fI\%hashkit_clone()\fP, otherwise it is false and was user\-supplied memory.
.SH HOME
.sp
To find out more information please check:
-.TH "HASHKIT_CRC32" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "HASHKIT_CRC32" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
hashkit_crc32 \- libhashkit Documentation
.
#include <libhashkit/hashkit.h>
.INDENT 0.0
.TP
-.B uint32_t hashkit_default(const char *key, size_t key_length);
+.B uint32_t hashkit_default(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B uint32_t hashkit_fnv1_64(const char *key, size_t key_length);
+.B uint32_t hashkit_fnv1_64(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B uint32_t hashkit_fnv1a_64(const char *key, size_t key_length);
+.B uint32_t hashkit_fnv1a_64(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B uint32_t hashkit_fnv1_32(const char *key, size_t key_length);
+.B uint32_t hashkit_fnv1_32(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B uint32_t hashkit_fnv1a_32(const char *key, size_t key_length);
+.B uint32_t hashkit_fnv1a_32(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B uint32_t hashkit_crc32(const char *key, size_t key_length);
+.B uint32_t hashkit_crc32(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B uint32_t hashkit_hsieh(const char *key, size_t key_length);
+.B uint32_t hashkit_hsieh(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B uint32_t hashkit_murmur(const char *key, size_t key_length);
+.B uint32_t hashkit_murmur(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B uint32_t hashkit_jenkins(const char *key, size_t key_length);
+.B uint32_t hashkit_jenkins(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B uint32_t hashkit_md5(const char *key, size_t key_length);
+.B uint32_t hashkit_md5(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.sp
Compile and link with \-lhashkit
algorithms. These functions can be used standalone, or as arguments
to hashkit_set_hash_fn(3) or hashkit_set_continuum_hash_fn(3).
.sp
-The hashkit_hsieh() is only available if the library is built with
+The hashkit_hsieh is only available if the library is built with
the appropriate flag enabled.
.SH RETURN VALUE
.sp
-.TH "HASHKIT_CREATE" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "HASHKIT_CREATE" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
hashkit_create \- libhashkit Documentation
.
.UNINDENT
.INDENT 0.0
.TP
-.B hashkit_st *hashkit_create(hashkit_st *hash);
+.B \fI\%hashkit_st\fP *hashkit_create(\fI\%hashkit_st\fP\fI\ *hash\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B hashkit_st *hashkit_clone(hashkit_st *destination, const hashkit_st *ptr);
+.B \fI\%hashkit_st\fP *hashkit_clone(\fI\%hashkit_st\fP\fI\ *destination\fP, const \fI\%hashkit_st\fP\fI\ *ptr\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B void hashkit_free(hashkit_st *hash);
+.B void hashkit_free(\fI\%hashkit_st\fP\fI\ *hash\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B bool hashkit_is_allocated(const hashkit_st *hash);
+.B bool hashkit_is_allocated(const \fI\%hashkit_st\fP\fI\ *hash\fP)
.UNINDENT
.sp
Compile and link with \-lhashkit
.SH DESCRIPTION
.sp
-The \fBhashkit_create()\fP function initializes a hashkit object for use. If
+The \fI\%hashkit_create()\fP function initializes a hashkit object for use. If
you pass a NULL argument for hash, then the memory for the object is
allocated. If you specify a pre\-allocated piece of memory, that is
initialized for use.
.sp
-The \fBhashkit_clone()\fP function initializes a hashkit object much like
-\fBhashkit_create()\fP, but instead of using default settings it will use
+The \fI\%hashkit_clone()\fP function initializes a hashkit object much like
+\fI\%hashkit_create()\fP, but instead of using default settings it will use
the settings of the ptr hashkit object.
.sp
-The \fBhashkit_free()\fP frees any resources being consumed by the hashkit
-objects that were initialized with \fBhashkit_create()\fP or \fBhashkit_clone()\fP.
+The \fI\%hashkit_free()\fP frees any resources being consumed by the hashkit
+objects that were initialized with \fI\%hashkit_create()\fP or \fI\%hashkit_clone()\fP.
.sp
-The \fBhashkit_is_allocated()\fP reports where the memory was allocated
+The \fI\%hashkit_is_allocated()\fP reports where the memory was allocated
for a hashkit object.
.SH RETURN VALUE
.sp
-\fBhashkit_create()\fP and \fBhashkit_clone()\fP will return NULL on
+\fI\%hashkit_create()\fP and \fI\%hashkit_clone()\fP will return NULL on
failure or non\-NULL on success.
.sp
-\fBhashkit_is_allocated()\fP returns true if the memory for the hashkit
-object was allocated inside of \fBhashkit_create()\fP or
-\fBhashkit_clone()\fP, otherwise it is false and was user\-supplied memory.
+\fI\%hashkit_is_allocated()\fP returns true if the memory for the hashkit
+object was allocated inside of \fI\%hashkit_create()\fP or
+\fI\%hashkit_clone()\fP, otherwise it is false and was user\-supplied memory.
.SH HOME
.sp
To find out more information please check:
-.TH "HASHKIT_FNV1_32" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "HASHKIT_FNV1_32" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
hashkit_fnv1_32 \- libhashkit Documentation
.
#include <libhashkit/hashkit.h>
.INDENT 0.0
.TP
-.B uint32_t hashkit_default(const char *key, size_t key_length);
+.B uint32_t hashkit_default(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B uint32_t hashkit_fnv1_64(const char *key, size_t key_length);
+.B uint32_t hashkit_fnv1_64(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B uint32_t hashkit_fnv1a_64(const char *key, size_t key_length);
+.B uint32_t hashkit_fnv1a_64(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B uint32_t hashkit_fnv1_32(const char *key, size_t key_length);
+.B uint32_t hashkit_fnv1_32(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B uint32_t hashkit_fnv1a_32(const char *key, size_t key_length);
+.B uint32_t hashkit_fnv1a_32(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B uint32_t hashkit_crc32(const char *key, size_t key_length);
+.B uint32_t hashkit_crc32(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B uint32_t hashkit_hsieh(const char *key, size_t key_length);
+.B uint32_t hashkit_hsieh(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B uint32_t hashkit_murmur(const char *key, size_t key_length);
+.B uint32_t hashkit_murmur(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B uint32_t hashkit_jenkins(const char *key, size_t key_length);
+.B uint32_t hashkit_jenkins(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B uint32_t hashkit_md5(const char *key, size_t key_length);
+.B uint32_t hashkit_md5(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.sp
Compile and link with \-lhashkit
algorithms. These functions can be used standalone, or as arguments
to hashkit_set_hash_fn(3) or hashkit_set_continuum_hash_fn(3).
.sp
-The hashkit_hsieh() is only available if the library is built with
+The hashkit_hsieh is only available if the library is built with
the appropriate flag enabled.
.SH RETURN VALUE
.sp
-.TH "HASHKIT_FNV1_64" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "HASHKIT_FNV1_64" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
hashkit_fnv1_64 \- libhashkit Documentation
.
#include <libhashkit/hashkit.h>
.INDENT 0.0
.TP
-.B uint32_t hashkit_default(const char *key, size_t key_length);
+.B uint32_t hashkit_default(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B uint32_t hashkit_fnv1_64(const char *key, size_t key_length);
+.B uint32_t hashkit_fnv1_64(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B uint32_t hashkit_fnv1a_64(const char *key, size_t key_length);
+.B uint32_t hashkit_fnv1a_64(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B uint32_t hashkit_fnv1_32(const char *key, size_t key_length);
+.B uint32_t hashkit_fnv1_32(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B uint32_t hashkit_fnv1a_32(const char *key, size_t key_length);
+.B uint32_t hashkit_fnv1a_32(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B uint32_t hashkit_crc32(const char *key, size_t key_length);
+.B uint32_t hashkit_crc32(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B uint32_t hashkit_hsieh(const char *key, size_t key_length);
+.B uint32_t hashkit_hsieh(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B uint32_t hashkit_murmur(const char *key, size_t key_length);
+.B uint32_t hashkit_murmur(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B uint32_t hashkit_jenkins(const char *key, size_t key_length);
+.B uint32_t hashkit_jenkins(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B uint32_t hashkit_md5(const char *key, size_t key_length);
+.B uint32_t hashkit_md5(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.sp
Compile and link with \-lhashkit
algorithms. These functions can be used standalone, or as arguments
to hashkit_set_hash_fn(3) or hashkit_set_continuum_hash_fn(3).
.sp
-The hashkit_hsieh() is only available if the library is built with
+The hashkit_hsieh is only available if the library is built with
the appropriate flag enabled.
.SH RETURN VALUE
.sp
-.TH "HASHKIT_FNV1A_32" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "HASHKIT_FNV1A_32" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
hashkit_fnv1a_32 \- libhashkit Documentation
.
#include <libhashkit/hashkit.h>
.INDENT 0.0
.TP
-.B uint32_t hashkit_default(const char *key, size_t key_length);
+.B uint32_t hashkit_default(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B uint32_t hashkit_fnv1_64(const char *key, size_t key_length);
+.B uint32_t hashkit_fnv1_64(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B uint32_t hashkit_fnv1a_64(const char *key, size_t key_length);
+.B uint32_t hashkit_fnv1a_64(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B uint32_t hashkit_fnv1_32(const char *key, size_t key_length);
+.B uint32_t hashkit_fnv1_32(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B uint32_t hashkit_fnv1a_32(const char *key, size_t key_length);
+.B uint32_t hashkit_fnv1a_32(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B uint32_t hashkit_crc32(const char *key, size_t key_length);
+.B uint32_t hashkit_crc32(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B uint32_t hashkit_hsieh(const char *key, size_t key_length);
+.B uint32_t hashkit_hsieh(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B uint32_t hashkit_murmur(const char *key, size_t key_length);
+.B uint32_t hashkit_murmur(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B uint32_t hashkit_jenkins(const char *key, size_t key_length);
+.B uint32_t hashkit_jenkins(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B uint32_t hashkit_md5(const char *key, size_t key_length);
+.B uint32_t hashkit_md5(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.sp
Compile and link with \-lhashkit
algorithms. These functions can be used standalone, or as arguments
to hashkit_set_hash_fn(3) or hashkit_set_continuum_hash_fn(3).
.sp
-The hashkit_hsieh() is only available if the library is built with
+The hashkit_hsieh is only available if the library is built with
the appropriate flag enabled.
.SH RETURN VALUE
.sp
-.TH "HASHKIT_FNV1A_64" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "HASHKIT_FNV1A_64" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
hashkit_fnv1a_64 \- libhashkit Documentation
.
#include <libhashkit/hashkit.h>
.INDENT 0.0
.TP
-.B uint32_t hashkit_default(const char *key, size_t key_length);
+.B uint32_t hashkit_default(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B uint32_t hashkit_fnv1_64(const char *key, size_t key_length);
+.B uint32_t hashkit_fnv1_64(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B uint32_t hashkit_fnv1a_64(const char *key, size_t key_length);
+.B uint32_t hashkit_fnv1a_64(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B uint32_t hashkit_fnv1_32(const char *key, size_t key_length);
+.B uint32_t hashkit_fnv1_32(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B uint32_t hashkit_fnv1a_32(const char *key, size_t key_length);
+.B uint32_t hashkit_fnv1a_32(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B uint32_t hashkit_crc32(const char *key, size_t key_length);
+.B uint32_t hashkit_crc32(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B uint32_t hashkit_hsieh(const char *key, size_t key_length);
+.B uint32_t hashkit_hsieh(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B uint32_t hashkit_murmur(const char *key, size_t key_length);
+.B uint32_t hashkit_murmur(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B uint32_t hashkit_jenkins(const char *key, size_t key_length);
+.B uint32_t hashkit_jenkins(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B uint32_t hashkit_md5(const char *key, size_t key_length);
+.B uint32_t hashkit_md5(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.sp
Compile and link with \-lhashkit
algorithms. These functions can be used standalone, or as arguments
to hashkit_set_hash_fn(3) or hashkit_set_continuum_hash_fn(3).
.sp
-The hashkit_hsieh() is only available if the library is built with
+The hashkit_hsieh is only available if the library is built with
the appropriate flag enabled.
.SH RETURN VALUE
.sp
-.TH "HASHKIT_FREE" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "HASHKIT_FREE" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
hashkit_free \- libhashkit Documentation
.
.UNINDENT
.INDENT 0.0
.TP
-.B hashkit_st *hashkit_create(hashkit_st *hash);
+.B \fI\%hashkit_st\fP *hashkit_create(\fI\%hashkit_st\fP\fI\ *hash\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B hashkit_st *hashkit_clone(hashkit_st *destination, const hashkit_st *ptr);
+.B \fI\%hashkit_st\fP *hashkit_clone(\fI\%hashkit_st\fP\fI\ *destination\fP, const \fI\%hashkit_st\fP\fI\ *ptr\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B void hashkit_free(hashkit_st *hash);
+.B void hashkit_free(\fI\%hashkit_st\fP\fI\ *hash\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B bool hashkit_is_allocated(const hashkit_st *hash);
+.B bool hashkit_is_allocated(const \fI\%hashkit_st\fP\fI\ *hash\fP)
.UNINDENT
.sp
Compile and link with \-lhashkit
.SH DESCRIPTION
.sp
-The \fBhashkit_create()\fP function initializes a hashkit object for use. If
+The \fI\%hashkit_create()\fP function initializes a hashkit object for use. If
you pass a NULL argument for hash, then the memory for the object is
allocated. If you specify a pre\-allocated piece of memory, that is
initialized for use.
.sp
-The \fBhashkit_clone()\fP function initializes a hashkit object much like
-\fBhashkit_create()\fP, but instead of using default settings it will use
+The \fI\%hashkit_clone()\fP function initializes a hashkit object much like
+\fI\%hashkit_create()\fP, but instead of using default settings it will use
the settings of the ptr hashkit object.
.sp
-The \fBhashkit_free()\fP frees any resources being consumed by the hashkit
-objects that were initialized with \fBhashkit_create()\fP or \fBhashkit_clone()\fP.
+The \fI\%hashkit_free()\fP frees any resources being consumed by the hashkit
+objects that were initialized with \fI\%hashkit_create()\fP or \fI\%hashkit_clone()\fP.
.sp
-The \fBhashkit_is_allocated()\fP reports where the memory was allocated
+The \fI\%hashkit_is_allocated()\fP reports where the memory was allocated
for a hashkit object.
.SH RETURN VALUE
.sp
-\fBhashkit_create()\fP and \fBhashkit_clone()\fP will return NULL on
+\fI\%hashkit_create()\fP and \fI\%hashkit_clone()\fP will return NULL on
failure or non\-NULL on success.
.sp
-\fBhashkit_is_allocated()\fP returns true if the memory for the hashkit
-object was allocated inside of \fBhashkit_create()\fP or
-\fBhashkit_clone()\fP, otherwise it is false and was user\-supplied memory.
+\fI\%hashkit_is_allocated()\fP returns true if the memory for the hashkit
+object was allocated inside of \fI\%hashkit_create()\fP or
+\fI\%hashkit_clone()\fP, otherwise it is false and was user\-supplied memory.
.SH HOME
.sp
To find out more information please check:
-.TH "HASHKIT_FUNCTIONS" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "HASHKIT_FUNCTIONS" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
hashkit_functions \- libhashkit Documentation
.
#include <libhashkit/hashkit.h>
.INDENT 0.0
.TP
-.B uint32_t hashkit_default(const char *key, size_t key_length);
+.B uint32_t hashkit_default(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B uint32_t hashkit_fnv1_64(const char *key, size_t key_length);
+.B uint32_t hashkit_fnv1_64(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B uint32_t hashkit_fnv1a_64(const char *key, size_t key_length);
+.B uint32_t hashkit_fnv1a_64(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B uint32_t hashkit_fnv1_32(const char *key, size_t key_length);
+.B uint32_t hashkit_fnv1_32(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B uint32_t hashkit_fnv1a_32(const char *key, size_t key_length);
+.B uint32_t hashkit_fnv1a_32(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B uint32_t hashkit_crc32(const char *key, size_t key_length);
+.B uint32_t hashkit_crc32(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B uint32_t hashkit_hsieh(const char *key, size_t key_length);
+.B uint32_t hashkit_hsieh(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B uint32_t hashkit_murmur(const char *key, size_t key_length);
+.B uint32_t hashkit_murmur(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B uint32_t hashkit_jenkins(const char *key, size_t key_length);
+.B uint32_t hashkit_jenkins(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B uint32_t hashkit_md5(const char *key, size_t key_length);
+.B uint32_t hashkit_md5(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.sp
Compile and link with \-lhashkit
algorithms. These functions can be used standalone, or as arguments
to hashkit_set_hash_fn(3) or hashkit_set_continuum_hash_fn(3).
.sp
-The hashkit_hsieh() is only available if the library is built with
+The hashkit_hsieh is only available if the library is built with
the appropriate flag enabled.
.SH RETURN VALUE
.sp
-.TH "HASHKIT_HSIEH" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "HASHKIT_HSIEH" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
hashkit_hsieh \- libhashkit Documentation
.
#include <libhashkit/hashkit.h>
.INDENT 0.0
.TP
-.B uint32_t hashkit_default(const char *key, size_t key_length);
+.B uint32_t hashkit_default(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B uint32_t hashkit_fnv1_64(const char *key, size_t key_length);
+.B uint32_t hashkit_fnv1_64(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B uint32_t hashkit_fnv1a_64(const char *key, size_t key_length);
+.B uint32_t hashkit_fnv1a_64(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B uint32_t hashkit_fnv1_32(const char *key, size_t key_length);
+.B uint32_t hashkit_fnv1_32(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B uint32_t hashkit_fnv1a_32(const char *key, size_t key_length);
+.B uint32_t hashkit_fnv1a_32(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B uint32_t hashkit_crc32(const char *key, size_t key_length);
+.B uint32_t hashkit_crc32(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B uint32_t hashkit_hsieh(const char *key, size_t key_length);
+.B uint32_t hashkit_hsieh(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B uint32_t hashkit_murmur(const char *key, size_t key_length);
+.B uint32_t hashkit_murmur(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B uint32_t hashkit_jenkins(const char *key, size_t key_length);
+.B uint32_t hashkit_jenkins(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B uint32_t hashkit_md5(const char *key, size_t key_length);
+.B uint32_t hashkit_md5(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.sp
Compile and link with \-lhashkit
algorithms. These functions can be used standalone, or as arguments
to hashkit_set_hash_fn(3) or hashkit_set_continuum_hash_fn(3).
.sp
-The hashkit_hsieh() is only available if the library is built with
+The hashkit_hsieh is only available if the library is built with
the appropriate flag enabled.
.SH RETURN VALUE
.sp
-.TH "HASHKIT_IS_ALLOCATED" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "HASHKIT_IS_ALLOCATED" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
hashkit_is_allocated \- libhashkit Documentation
.
.UNINDENT
.INDENT 0.0
.TP
-.B hashkit_st *hashkit_create(hashkit_st *hash);
+.B \fI\%hashkit_st\fP *hashkit_create(\fI\%hashkit_st\fP\fI\ *hash\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B hashkit_st *hashkit_clone(hashkit_st *destination, const hashkit_st *ptr);
+.B \fI\%hashkit_st\fP *hashkit_clone(\fI\%hashkit_st\fP\fI\ *destination\fP, const \fI\%hashkit_st\fP\fI\ *ptr\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B void hashkit_free(hashkit_st *hash);
+.B void hashkit_free(\fI\%hashkit_st\fP\fI\ *hash\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B bool hashkit_is_allocated(const hashkit_st *hash);
+.B bool hashkit_is_allocated(const \fI\%hashkit_st\fP\fI\ *hash\fP)
.UNINDENT
.sp
Compile and link with \-lhashkit
.SH DESCRIPTION
.sp
-The \fBhashkit_create()\fP function initializes a hashkit object for use. If
+The \fI\%hashkit_create()\fP function initializes a hashkit object for use. If
you pass a NULL argument for hash, then the memory for the object is
allocated. If you specify a pre\-allocated piece of memory, that is
initialized for use.
.sp
-The \fBhashkit_clone()\fP function initializes a hashkit object much like
-\fBhashkit_create()\fP, but instead of using default settings it will use
+The \fI\%hashkit_clone()\fP function initializes a hashkit object much like
+\fI\%hashkit_create()\fP, but instead of using default settings it will use
the settings of the ptr hashkit object.
.sp
-The \fBhashkit_free()\fP frees any resources being consumed by the hashkit
-objects that were initialized with \fBhashkit_create()\fP or \fBhashkit_clone()\fP.
+The \fI\%hashkit_free()\fP frees any resources being consumed by the hashkit
+objects that were initialized with \fI\%hashkit_create()\fP or \fI\%hashkit_clone()\fP.
.sp
-The \fBhashkit_is_allocated()\fP reports where the memory was allocated
+The \fI\%hashkit_is_allocated()\fP reports where the memory was allocated
for a hashkit object.
.SH RETURN VALUE
.sp
-\fBhashkit_create()\fP and \fBhashkit_clone()\fP will return NULL on
+\fI\%hashkit_create()\fP and \fI\%hashkit_clone()\fP will return NULL on
failure or non\-NULL on success.
.sp
-\fBhashkit_is_allocated()\fP returns true if the memory for the hashkit
-object was allocated inside of \fBhashkit_create()\fP or
-\fBhashkit_clone()\fP, otherwise it is false and was user\-supplied memory.
+\fI\%hashkit_is_allocated()\fP returns true if the memory for the hashkit
+object was allocated inside of \fI\%hashkit_create()\fP or
+\fI\%hashkit_clone()\fP, otherwise it is false and was user\-supplied memory.
.SH HOME
.sp
To find out more information please check:
-.TH "HASHKIT_JENKINS" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "HASHKIT_JENKINS" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
hashkit_jenkins \- libhashkit Documentation
.
#include <libhashkit/hashkit.h>
.INDENT 0.0
.TP
-.B uint32_t hashkit_default(const char *key, size_t key_length);
+.B uint32_t hashkit_default(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B uint32_t hashkit_fnv1_64(const char *key, size_t key_length);
+.B uint32_t hashkit_fnv1_64(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B uint32_t hashkit_fnv1a_64(const char *key, size_t key_length);
+.B uint32_t hashkit_fnv1a_64(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B uint32_t hashkit_fnv1_32(const char *key, size_t key_length);
+.B uint32_t hashkit_fnv1_32(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B uint32_t hashkit_fnv1a_32(const char *key, size_t key_length);
+.B uint32_t hashkit_fnv1a_32(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B uint32_t hashkit_crc32(const char *key, size_t key_length);
+.B uint32_t hashkit_crc32(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B uint32_t hashkit_hsieh(const char *key, size_t key_length);
+.B uint32_t hashkit_hsieh(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B uint32_t hashkit_murmur(const char *key, size_t key_length);
+.B uint32_t hashkit_murmur(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B uint32_t hashkit_jenkins(const char *key, size_t key_length);
+.B uint32_t hashkit_jenkins(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B uint32_t hashkit_md5(const char *key, size_t key_length);
+.B uint32_t hashkit_md5(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.sp
Compile and link with \-lhashkit
algorithms. These functions can be used standalone, or as arguments
to hashkit_set_hash_fn(3) or hashkit_set_continuum_hash_fn(3).
.sp
-The hashkit_hsieh() is only available if the library is built with
+The hashkit_hsieh is only available if the library is built with
the appropriate flag enabled.
.SH RETURN VALUE
.sp
-.TH "HASHKIT_MD5" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "HASHKIT_MD5" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
hashkit_md5 \- libhashkit Documentation
.
#include <libhashkit/hashkit.h>
.INDENT 0.0
.TP
-.B uint32_t hashkit_default(const char *key, size_t key_length);
+.B uint32_t hashkit_default(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B uint32_t hashkit_fnv1_64(const char *key, size_t key_length);
+.B uint32_t hashkit_fnv1_64(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B uint32_t hashkit_fnv1a_64(const char *key, size_t key_length);
+.B uint32_t hashkit_fnv1a_64(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B uint32_t hashkit_fnv1_32(const char *key, size_t key_length);
+.B uint32_t hashkit_fnv1_32(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B uint32_t hashkit_fnv1a_32(const char *key, size_t key_length);
+.B uint32_t hashkit_fnv1a_32(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B uint32_t hashkit_crc32(const char *key, size_t key_length);
+.B uint32_t hashkit_crc32(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B uint32_t hashkit_hsieh(const char *key, size_t key_length);
+.B uint32_t hashkit_hsieh(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B uint32_t hashkit_murmur(const char *key, size_t key_length);
+.B uint32_t hashkit_murmur(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B uint32_t hashkit_jenkins(const char *key, size_t key_length);
+.B uint32_t hashkit_jenkins(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B uint32_t hashkit_md5(const char *key, size_t key_length);
+.B uint32_t hashkit_md5(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.sp
Compile and link with \-lhashkit
algorithms. These functions can be used standalone, or as arguments
to hashkit_set_hash_fn(3) or hashkit_set_continuum_hash_fn(3).
.sp
-The hashkit_hsieh() is only available if the library is built with
+The hashkit_hsieh is only available if the library is built with
the appropriate flag enabled.
.SH RETURN VALUE
.sp
-.TH "HASHKIT_MURMUR" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "HASHKIT_MURMUR" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
hashkit_murmur \- libhashkit Documentation
.
#include <libhashkit/hashkit.h>
.INDENT 0.0
.TP
-.B uint32_t hashkit_default(const char *key, size_t key_length);
+.B uint32_t hashkit_default(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B uint32_t hashkit_fnv1_64(const char *key, size_t key_length);
+.B uint32_t hashkit_fnv1_64(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B uint32_t hashkit_fnv1a_64(const char *key, size_t key_length);
+.B uint32_t hashkit_fnv1a_64(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B uint32_t hashkit_fnv1_32(const char *key, size_t key_length);
+.B uint32_t hashkit_fnv1_32(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B uint32_t hashkit_fnv1a_32(const char *key, size_t key_length);
+.B uint32_t hashkit_fnv1a_32(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B uint32_t hashkit_crc32(const char *key, size_t key_length);
+.B uint32_t hashkit_crc32(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B uint32_t hashkit_hsieh(const char *key, size_t key_length);
+.B uint32_t hashkit_hsieh(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B uint32_t hashkit_murmur(const char *key, size_t key_length);
+.B uint32_t hashkit_murmur(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B uint32_t hashkit_jenkins(const char *key, size_t key_length);
+.B uint32_t hashkit_jenkins(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B uint32_t hashkit_md5(const char *key, size_t key_length);
+.B uint32_t hashkit_md5(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.sp
Compile and link with \-lhashkit
algorithms. These functions can be used standalone, or as arguments
to hashkit_set_hash_fn(3) or hashkit_set_continuum_hash_fn(3).
.sp
-The hashkit_hsieh() is only available if the library is built with
+The hashkit_hsieh is only available if the library is built with
the appropriate flag enabled.
.SH RETURN VALUE
.sp
-.TH "HASHKIT_VALUE" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "HASHKIT_VALUE" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
hashkit_value \- libhashkit Documentation
.
#include <libhashkit/hashkit.h>
.INDENT 0.0
.TP
-.B uint32_t hashkit_value(hashkit_st *hash, const char *key, size_t key_length);
+.B uint32_t hashkit_value(hashkit_st\fI\ *hash\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP)
.UNINDENT
.sp
Compile and link with \-lhashkit
.SH DESCRIPTION
.sp
-The \fBhashkit_value()\fP function generates a 32\-bit hash value from the
+The \fI\%hashkit_value()\fP function generates a 32\-bit hash value from the
given key and key_length. The hash argument is an initialized hashkit
object, and distribution type and hash function is used from this
object while generating the value.
-.TH "LIBHASHKIT" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "LIBHASHKIT" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
libhashkit \- libhashkit Documentation
.
-.TH "LIBMEMCACHED" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "LIBMEMCACHED" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
libmemcached \- Introducing the C Client Library for memcached
.
.sp
Nearly all functions return a \fBmemcached_return_t\fP value.
This value can be translated to a printable string with
-\fBmemcached_strerror()\fP.
+\fBmemcached_strerror\fP.
.sp
Objects are stored on servers by hashing keys. The hash value maps the key to a particular server. All clients understand how this hashing works, so it is possibly to reliably both push data to a server and retrieve data from a server.
.sp
.B LIBMEMCACHED_VERSION_HEX
Hex value of the version number. "0x00048000" This can be used for comparing versions based on number.
.UNINDENT
+.INDENT 0.0
+.TP
+.B MEMCACHED_PREFIX_KEY_MAX_SIZE
+Maximum length allowed for namespacing of a key.
+.UNINDENT
.SH THREADS AND PROCESSES
.sp
When using threads or forked processes it is important to keep one instance
-.TH "LIBMEMCACHED_CHECK_CONFIGURATION" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "LIBMEMCACHED_CHECK_CONFIGURATION" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
libmemcached_check_configuration \- libmemcached Documentation
.
-.TH "LIBMEMCACHED_CONFIGURATION" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "LIBMEMCACHED_CONFIGURATION" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
libmemcached_configuration \- libmemcached Documentation
.
-.TH "LIBMEMCACHED_EXAMPLES" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "LIBMEMCACHED_EXAMPLES" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
libmemcached_examples \- libmemcached Documentation
.
.fi
.sp
In the above code you create a \fBmemcached_st\fP object with three server
-by making use of \fBmemcached_create_with_options()\fP.
+by making use of \fBmemcached_create()\fP.
.SH CREATING A POOL OF SERVERS
.sp
.nf
-.TH "LIBMEMCACHEDUTIL" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "LIBMEMCACHEDUTIL" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
libmemcachedutil \- libmemcached Documentation
.
-.TH "MEMASLAP" "1" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMASLAP" "1" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memaslap \- libmemcached Documentation
.
.TP
.B \-\-help
.UNINDENT
+.INDENT 0.0
+.TP
+.B MEMCACHED_SERVERS
+.UNINDENT
.SH DESCRIPTION
.sp
\fBmemaslap\fP is a load generation and benchmark tool for memcached
connections in each thread. Each connection keeps key size distribution,
value size distribution, and command distribution by itself.
.sp
-You can specify servers via the \fI\-\-servers\fP option or via the
-environment variable \fBMEMCACHED_SERVERS\fP.
+You can specify servers via the \fImemslap \-\-servers\fP option or via the
+environment variable \fI\%MEMCACHED_SERVERS\fP.
.SH FEATURES
.sp
Memslap is developed to for the following purposes:
-.TH "MEMCACHED" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached \- libmemcached Documentation
.
-.TH "MEMCACHED_ADD" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_ADD" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_add \- Storing and Replacing Data
.
#include <libmemcached/memcached.h>
.INDENT 0.0
.TP
-.B memcached_return_t memcached_set (memcached_st *ptr, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags);
+.B memcached_return_t memcached_set(memcached_st\fI\ *ptr\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, const char\fI\ *value\fP, size_t\fI\ value_length\fP, time_t\fI\ expiration\fP, uint32_t\fI\ flags\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_add (memcached_st *ptr, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags);
+.B memcached_return_t memcached_add(memcached_st\fI\ *ptr\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, const char\fI\ *value\fP, size_t\fI\ value_length\fP, time_t\fI\ expiration\fP, uint32_t\fI\ flags\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_replace (memcached_st *ptr, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags);
+.B memcached_return_t memcached_replace(memcached_st\fI\ *ptr\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, const char\fI\ *value\fP, size_t\fI\ value_length\fP, time_t\fI\ expiration\fP, uint32_t\fI\ flags\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_set_by_key(memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags);
+.B memcached_return_t memcached_set_by_key(memcached_st\fI\ *ptr\fP, const char\fI\ *group_key\fP, size_t\fI\ group_key_length\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, const char\fI\ *value\fP, size_t\fI\ value_length\fP, time_t\fI\ expiration\fP, uint32_t\fI\ flags\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_add_by_key(memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags);
+.B memcached_return_t memcached_add_by_key(memcached_st\fI\ *ptr\fP, const char\fI\ *group_key\fP, size_t\fI\ group_key_length\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, const char\fI\ *value\fP, size_t\fI\ value_length\fP, time_t\fI\ expiration\fP, uint32_t\fI\ flags\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_replace_by_key(memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags);
+.B memcached_return_t memcached_replace_by_key(memcached_st\fI\ *ptr\fP, const char\fI\ *group_key\fP, size_t\fI\ group_key_length\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, const char\fI\ *value\fP, size_t\fI\ value_length\fP, time_t\fI\ expiration\fP, uint32_t\fI\ flags\fP)
.UNINDENT
.sp
Compile and link with \-lmemcached
.SH DESCRIPTION
.sp
-\fBmemcached_set()\fP, \fBmemcached_add()\fP, and \fBmemcached_replace()\fP are all used to store information on the server. All methods take a key, and its length to store the object. Keys are currently limited to 250 characters when using either a version of memcached(1) which is 1.4 or below, or when using the text protocol. You must supply both a value and a length. Optionally you
+\fI\%memcached_set()\fP, \fI\%memcached_add()\fP, and \fI\%memcached_replace()\fP are all used to store information on the server. All methods take a key, and its length to store the object. Keys are currently limited to 250 characters when using either a version of memcached(1) which is 1.4 or below, or when using the text protocol. You must supply both a value and a length. Optionally you
store the object. Keys are currently limited to 250 characters by the
memcached(1) server. You must supply both a value and a length. Optionally you
may test an expiration time for the object and a 16 byte value (it is meant to be used as a bitmap). "flags" is a 4byte space that is stored alongside of the main value. Many sub libraries make use of this field, so in most cases users should avoid making use of it.
.sp
-\fBmemcached_set()\fP will write an object to the server. If an object
+\fI\%memcached_set()\fP will write an object to the server. If an object
already exists it will overwrite what is in the server. If the object does not
exist it will be written. If you are using the non\-blocking mode this function
will always return true unless a network error occurs.
.sp
-\fBmemcached_replace()\fP replaces an object on the server. If the object is not found on the server an error occurs.
+\fI\%memcached_replace()\fP replaces an object on the server. If the object is not found on the server an error occurs.
.sp
-\fBmemcached_add()\fP adds an object to the server. If the object is found on the server an error occurs, otherwise the value is stored.
+\fI\%memcached_add()\fP adds an object to the server. If the object is found on the server an error occurs, otherwise the value is stored.
.sp
\fBmemcached_cas()\fP 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 \fBmemcached_result_cas()\fP on a memcached_result_st(3) structure. At the point
that this note was written cas is still buggy in memached. Turning on tests
-for it in libmemcached(3) is optional. Please see memcached_set() for
+for it in libmemcached(3) is optional. Please see memcached_set for
information on how to do this.
.sp
-\fBmemcached_set_by_key()\fP, \fBmemcached_add_by_key()\fP, and \fBmemcached_replace_by_key()\fP methods all behave in a similar method as the non
+\fI\%memcached_set_by_key()\fP, \fI\%memcached_add_by_key()\fP, and \fI\%memcached_replace_by_key()\fP methods all behave in a similar method as the non
key methods. The difference is that they use their group_key parameter to map
objects to particular servers.
.sp
-If you are looking for performance, \fBmemcached_set()\fP with non\-blocking IO is the fastest way to store data on the server.
+If you are looking for performance, \fI\%memcached_set()\fP with non\-blocking IO is the fastest way to store data on the server.
.sp
All of the above functions are testsed with the \fBMEMCACHED_BEHAVIOR_USE_UDP\fP behavior enabled. However, when using these operations with this behavior
on, there are limits to the size of the payload being sent to the server.
On success the value will be \fBMEMCACHED_SUCCESS\fP.
Use \fBmemcached_strerror()\fP to translate this value to a printable string.
.sp
-For \fBmemcached_replace()\fP and \fBmemcached_add()\fP, \fBMEMCACHED_NOTSTORED\fP is a legitmate error in the case of a collision.
+For \fI\%memcached_replace()\fP and \fI\%memcached_add()\fP, \fBMEMCACHED_NOTSTORED\fP is a legitmate error in the case of a collision.
.SH HOME
.sp
To find out more information please check:
-.TH "MEMCACHED_ADD_BY_KEY" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_ADD_BY_KEY" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_add_by_key \- Storing and Replacing Data
.
#include <libmemcached/memcached.h>
.INDENT 0.0
.TP
-.B memcached_return_t memcached_set (memcached_st *ptr, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags);
+.B memcached_return_t memcached_set(memcached_st\fI\ *ptr\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, const char\fI\ *value\fP, size_t\fI\ value_length\fP, time_t\fI\ expiration\fP, uint32_t\fI\ flags\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_add (memcached_st *ptr, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags);
+.B memcached_return_t memcached_add(memcached_st\fI\ *ptr\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, const char\fI\ *value\fP, size_t\fI\ value_length\fP, time_t\fI\ expiration\fP, uint32_t\fI\ flags\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_replace (memcached_st *ptr, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags);
+.B memcached_return_t memcached_replace(memcached_st\fI\ *ptr\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, const char\fI\ *value\fP, size_t\fI\ value_length\fP, time_t\fI\ expiration\fP, uint32_t\fI\ flags\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_set_by_key(memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags);
+.B memcached_return_t memcached_set_by_key(memcached_st\fI\ *ptr\fP, const char\fI\ *group_key\fP, size_t\fI\ group_key_length\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, const char\fI\ *value\fP, size_t\fI\ value_length\fP, time_t\fI\ expiration\fP, uint32_t\fI\ flags\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_add_by_key(memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags);
+.B memcached_return_t memcached_add_by_key(memcached_st\fI\ *ptr\fP, const char\fI\ *group_key\fP, size_t\fI\ group_key_length\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, const char\fI\ *value\fP, size_t\fI\ value_length\fP, time_t\fI\ expiration\fP, uint32_t\fI\ flags\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_replace_by_key(memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags);
+.B memcached_return_t memcached_replace_by_key(memcached_st\fI\ *ptr\fP, const char\fI\ *group_key\fP, size_t\fI\ group_key_length\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, const char\fI\ *value\fP, size_t\fI\ value_length\fP, time_t\fI\ expiration\fP, uint32_t\fI\ flags\fP)
.UNINDENT
.sp
Compile and link with \-lmemcached
.SH DESCRIPTION
.sp
-\fBmemcached_set()\fP, \fBmemcached_add()\fP, and \fBmemcached_replace()\fP are all used to store information on the server. All methods take a key, and its length to store the object. Keys are currently limited to 250 characters when using either a version of memcached(1) which is 1.4 or below, or when using the text protocol. You must supply both a value and a length. Optionally you
+\fI\%memcached_set()\fP, \fI\%memcached_add()\fP, and \fI\%memcached_replace()\fP are all used to store information on the server. All methods take a key, and its length to store the object. Keys are currently limited to 250 characters when using either a version of memcached(1) which is 1.4 or below, or when using the text protocol. You must supply both a value and a length. Optionally you
store the object. Keys are currently limited to 250 characters by the
memcached(1) server. You must supply both a value and a length. Optionally you
may test an expiration time for the object and a 16 byte value (it is meant to be used as a bitmap). "flags" is a 4byte space that is stored alongside of the main value. Many sub libraries make use of this field, so in most cases users should avoid making use of it.
.sp
-\fBmemcached_set()\fP will write an object to the server. If an object
+\fI\%memcached_set()\fP will write an object to the server. If an object
already exists it will overwrite what is in the server. If the object does not
exist it will be written. If you are using the non\-blocking mode this function
will always return true unless a network error occurs.
.sp
-\fBmemcached_replace()\fP replaces an object on the server. If the object is not found on the server an error occurs.
+\fI\%memcached_replace()\fP replaces an object on the server. If the object is not found on the server an error occurs.
.sp
-\fBmemcached_add()\fP adds an object to the server. If the object is found on the server an error occurs, otherwise the value is stored.
+\fI\%memcached_add()\fP adds an object to the server. If the object is found on the server an error occurs, otherwise the value is stored.
.sp
\fBmemcached_cas()\fP 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 \fBmemcached_result_cas()\fP on a memcached_result_st(3) structure. At the point
that this note was written cas is still buggy in memached. Turning on tests
-for it in libmemcached(3) is optional. Please see memcached_set() for
+for it in libmemcached(3) is optional. Please see memcached_set for
information on how to do this.
.sp
-\fBmemcached_set_by_key()\fP, \fBmemcached_add_by_key()\fP, and \fBmemcached_replace_by_key()\fP methods all behave in a similar method as the non
+\fI\%memcached_set_by_key()\fP, \fI\%memcached_add_by_key()\fP, and \fI\%memcached_replace_by_key()\fP methods all behave in a similar method as the non
key methods. The difference is that they use their group_key parameter to map
objects to particular servers.
.sp
-If you are looking for performance, \fBmemcached_set()\fP with non\-blocking IO is the fastest way to store data on the server.
+If you are looking for performance, \fI\%memcached_set()\fP with non\-blocking IO is the fastest way to store data on the server.
.sp
All of the above functions are testsed with the \fBMEMCACHED_BEHAVIOR_USE_UDP\fP behavior enabled. However, when using these operations with this behavior
on, there are limits to the size of the payload being sent to the server.
On success the value will be \fBMEMCACHED_SUCCESS\fP.
Use \fBmemcached_strerror()\fP to translate this value to a printable string.
.sp
-For \fBmemcached_replace()\fP and \fBmemcached_add()\fP, \fBMEMCACHED_NOTSTORED\fP is a legitmate error in the case of a collision.
+For \fI\%memcached_replace()\fP and \fI\%memcached_add()\fP, \fBMEMCACHED_NOTSTORED\fP is a legitmate error in the case of a collision.
.SH HOME
.sp
To find out more information please check:
-.TH "MEMCACHED_ANALYZE" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_ANALYZE" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_analyze \- libmemcached Documentation
.
#include <libmemcached/memcached.h>
.INDENT 0.0
.TP
-.B memcached_analysis_st * memcached_analyze (memcached_st *ptr, memcached_stat_st *stat, memcached_return_t *error);
+.B memcached_analysis_st
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \fI\%memcached_analysis_st\fP * memcached_analyze(memcached_st\fI\ *ptr\fP, memcached_stat_st\fI\ *stat\fP, memcached_return_t\fI\ *error\fP)
.UNINDENT
.sp
Compile and link with \-lmemcached
.sp
\fBlibmemcached\fP has the ability to query a memcached server (or
collection of servers) for their current state. Queries to find state return a
-\fBmemcached_analysis_st\fP structure. You are responsible for freeing this structure.
+\fI\%memcached_analysis_st\fP structure. You are responsible for freeing this structure.
.sp
-\fBmemcached_analyze()\fP analyzes useful information based on the
-provided servers and sets the result to the \fBmemcached_analysis_st\fP
+\fI\%memcached_analyze()\fP analyzes useful information based on the
+provided servers and sets the result to the \fI\%memcached_analysis_st\fP
structure. The return value must be freed by the calling application.
.sp
-A command line tool, \fBmemstat()\fP with the option \fI\-\-analyze\fP,
+A command line tool, \fBmemstat\fP with the option \fImemstat \-\-analyze\fP,
is provided so that you do not have to write an application to use this method.
.SH RETURN
.sp
-A pointer to the allocated \fBmemcached_analysis_st\fP structure on
+A pointer to the allocated \fI\%memcached_analysis_st\fP structure on
success and a NULL pointer on failure. You may inspect the error detail by
checking the \fBmemcached_return_t\fP value.
.sp
-Any method returning a \fBmemcached_analysis_st\fP expects you to free the
+Any method returning a \fI\%memcached_analysis_st\fP expects you to free the
memory allocated for it.
.SH HOME
.sp
-.TH "MEMCACHED_APPEND" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_APPEND" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_append \- Appending to or Prepending to data on the server
.
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_prepend_by_key(memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags);
+.B memcached_return_t memcached_prepend_by_key(memcached_st\fI\ *ptr\fP, const char\fI\ *group_key\fP, size_t\fI\ group_key_length\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, const char\fI\ *value\fP, size_t\fI\ value_length\fP, time_t\fI\ expiration\fP, uint32_t\fI\ flags\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_append_by_key(memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags);
+.B memcached_return_t memcached_append_by_key(memcached_st\fI\ *ptr\fP, const char\fI\ *group_key\fP, size_t\fI\ group_key_length\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, const char\fI\ *value\fP, size_t\fI\ value_length\fP, time_t\fI\ expiration\fP, uint32_t\fI\ flags\fP)
.UNINDENT
.sp
Compile and link with \-lmemcached
\fI\%memcached_append()\fP 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.
.sp
-\fBmemcached_prepend_by_key()\fP and
-\fBmemcached_append_by_key_by_key()\fP methods both behave in a similar
+\fI\%memcached_prepend_by_key()\fP and
+\fI\%memcached_append_by_key()\fP methods both behave in a similar
method as the non key methods. The difference is that they use their
group_key parameter to map objects to particular servers.
.sp
-.TH "MEMCACHED_APPEND_BY_KEY" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_APPEND_BY_KEY" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_append_by_key \- Appending to or Prepending to data on the server
.
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_prepend_by_key(memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags);
+.B memcached_return_t memcached_prepend_by_key(memcached_st\fI\ *ptr\fP, const char\fI\ *group_key\fP, size_t\fI\ group_key_length\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, const char\fI\ *value\fP, size_t\fI\ value_length\fP, time_t\fI\ expiration\fP, uint32_t\fI\ flags\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_append_by_key(memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags);
+.B memcached_return_t memcached_append_by_key(memcached_st\fI\ *ptr\fP, const char\fI\ *group_key\fP, size_t\fI\ group_key_length\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, const char\fI\ *value\fP, size_t\fI\ value_length\fP, time_t\fI\ expiration\fP, uint32_t\fI\ flags\fP)
.UNINDENT
.sp
Compile and link with \-lmemcached
\fI\%memcached_append()\fP 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.
.sp
-\fBmemcached_prepend_by_key()\fP and
-\fBmemcached_append_by_key_by_key()\fP methods both behave in a similar
+\fI\%memcached_prepend_by_key()\fP and
+\fI\%memcached_append_by_key()\fP methods both behave in a similar
method as the non key methods. The difference is that they use their
group_key parameter to map objects to particular servers.
.sp
-.TH "MEMCACHED_AUTO" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_AUTO" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_auto \- Incrementing and Decrementing Values
.
#include <libmemcached/memcached.h>
.INDENT 0.0
.TP
-.B memcached_return_t memcached_increment (memcached_st *ptr, const char *key, size_t key_length, unsigned int offset, uint64_t *value);
+.B memcached_return_t memcached_increment(memcached_st\fI\ *ptr\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, uint32_t\fI\ offset\fP, uint64_t\fI\ *value\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_decrement (memcached_st *ptr, const char *key, size_t key_length, unsigned int offset, uint64_t *value);
+.B memcached_return_t memcached_decrement(memcached_st\fI\ *ptr\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, uint32_t\fI\ offset\fP, uint64_t\fI\ *value\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_increment_with_initial (memcached_st *ptr, const char *key, size_t key_length, uint64_t offset, uint64_t initial, time_t expiration, uint64_t *value);
+.B memcached_return_t memcached_increment_with_initial(memcached_st\fI\ *ptr\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, uint64_t\fI\ offset\fP, uint64_t\fI\ initial\fP, time_t\fI\ expiration\fP, uint64_t\fI\ *value\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_decrement_with_initial (memcached_st *ptr, const char *key, size_t key_length, uint64_t offset, uint64_t initial, time_t expiration, uint64_t *value);
+.B memcached_return_t memcached_decrement_with_initial(memcached_st\fI\ *ptr\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, uint64_t\fI\ offset\fP, uint64_t\fI\ initial\fP, time_t\fI\ expiration\fP, uint64_t\fI\ *value\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_increment_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, unsigned int offset, uint64_t *value);
+.B memcached_return_t memcached_increment_by_key(memcached_st\fI\ *ptr\fP, const char\fI\ *group_key\fP, size_t\fI\ group_key_length\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, uint32_t\fI\ offset\fP, uint64_t\fI\ *value\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_decrement_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, unsigned int offset, uint64_t *value);
+.B memcached_return_t memcached_decrement_by_key(memcached_st\fI\ *ptr\fP, const char\fI\ *group_key\fP, size_t\fI\ group_key_length\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, uint32_t\fI\ offset\fP, uint64_t\fI\ *value\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_increment_with_initial_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, uint64_t offset, uint64_t initial, time_t expiration, uint64_t *value);
+.B memcached_return_t memcached_increment_with_initial_by_key(memcached_st\fI\ *ptr\fP, const char\fI\ *group_key\fP, size_t\fI\ group_key_length\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, uint64_t\fI\ offset\fP, uint64_t\fI\ initial\fP, time_t\fI\ expiration\fP, uint64_t\fI\ *value\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_decrement_with_initial_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, uint64_t offset, uint64_t initial, time_t expiration, uint64_t *value);
+.B memcached_return_t memcached_decrement_with_initial_by_key(memcached_st\fI\ *ptr\fP, const char\fI\ *group_key\fP, size_t\fI\ group_key_length\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, uint64_t\fI\ offset\fP, uint64_t\fI\ initial\fP, time_t\fI\ expiration\fP, uint64_t\fI\ *value\fP)
.UNINDENT
.sp
Compile and link with \-lmemcached
(overflow and underflow are not detected). This gives you the ability to use
memcached to generate shared sequences of values.
.sp
-memcached_increment() takes a key and keylength and increments the value by
-the offset passed to it. The value is then returned via the unsigned int
+memcached_increment takes a key and keylength and increments the value by
+the offset passed to it. The value is then returned via the uint32_t
value pointer you pass to it.
.sp
-memcached_decrement() takes a key and keylength and decrements the value by
-the offset passed to it. The value is then returned via the unsigned int
+memcached_decrement takes a key and keylength and decrements the value by
+the offset passed to it. The value is then returned via the uint32_t
value pointer you pass to it.
.sp
-memcached_increment_with_initial() takes a key and keylength and increments
+memcached_increment_with_initial takes a key and keylength and increments
the value by the offset passed to it. If the object specified by key does
not exist, one of two things may happen: If the expiration value is
MEMCACHED_EXPIRATION_NOT_ADD, the operation will fail. For all other
expiration values, the operation will succeed by seeding the value for that
key with a initial value to expire with the provided expiration time. The
-flags will be set to zero.The value is then returned via the unsigned int
+flags will be set to zero.The value is then returned via the uint32_t
value pointer you pass to it.
.sp
-memcached_decrement_with_initial() takes a key and keylength and decrements
+memcached_decrement_with_initial takes a key and keylength and decrements
the value by the offset passed to it. If the object specified by key does
not exist, one of two things may happen: If the expiration value is
MEMCACHED_EXPIRATION_NOT_ADD, the operation will fail. For all other
expiration values, the operation will succeed by seeding the value for that
key with a initial value to expire with the provided expiration time. The
-flags will be set to zero.The value is then returned via the unsigned int
+flags will be set to zero.The value is then returned via the uint32_t
value pointer you pass to it.
.sp
-memcached_increment_by_key(), memcached_decrement_by_key(),
-memcached_increment_with_initial_by_key(), and
-memcached_decrement_with_initial_by_key() are master key equivalents of the
-above.
+\fI\%memcached_increment_by_key()\fP, \fI\%memcached_decrement_by_key()\fP,
+\fI\%memcached_increment_with_initial_by_key()\fP, and
+\fI\%memcached_decrement_with_initial_by_key()\fP are master key equivalents of the above.
.SH RETURN
.sp
-A value of type \fBmemcached_return_t\fP is returned.
+A value of type \fBmemcached_return_t\fP is returned.
On success that value will be \fBMEMCACHED_SUCCESS\fP.
-Use memcached_strerror() to translate this value to a printable string.
+Use memcached_strerror to translate this value to a printable string.
.SH HOME
.sp
To find out more information please check:
-.TH "MEMCACHED_BEHAVIOR" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_BEHAVIOR" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_behavior \- libmemcached Documentation
.
#include <libmemcached/memcached.h>
.INDENT 0.0
.TP
-.B uint64_t memcached_behavior_get (memcached_st *ptr, memcached_behavior flag);
+.B memcached_behavior_t
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_behavior_set (memcached_st *ptr, memcached_behavior flag, uint64_t data);
+.B uint64_t memcached_behavior_get(memcached_st\fI\ *ptr\fP, \fI\%memcached_behavior_t\fP\fI\ flag\fP)
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_return_t memcached_behavior_set(memcached_st\fI\ *ptr\fP, \fI\%memcached_behavior_t\fP\fI\ flag\fP, uint64_t\fI\ data\fP)
.UNINDENT
.sp
Compile and link with \-lmemcached
.SH DESCRIPTION
.sp
-\fIlibmemcached(3)\fP behavior can be modified by using \fBmemcached_behavior_set()\fP. Default behavior is the library strives to be quick and
+\fIlibmemcached(3)\fP behavior can be modified by using \fI\%memcached_behavior_set()\fP. Default behavior is the library strives to be quick and
accurate. Some behavior, while being faster, can also result in not entirely
accurate behavior (for instance, \fBmemcached_set()\fP will always respond
with \fBMEMCACHED_SUCCESS\fP).
.sp
-\fBmemcached_behavior_get()\fP takes a behavior flag and returns whether or not that behavior is currently enabled in the client.
+\fI\%memcached_behavior_get()\fP takes a behavior flag and returns whether or not that behavior is currently enabled in the client.
.sp
-\fBmemcached_behavior_set()\fP changes the value of a particular option
+\fI\%memcached_behavior_set()\fP changes the value of a particular option
of the client. It takes both a flag (listed below) and a value. For simple
on or off options you just need to pass in a value of 1. Calls to
-\fBmemcached_behavior_set()\fP will flush and reset all connections.
+\fI\%memcached_behavior_set()\fP will flush and reset all connections.
.INDENT 0.0
.TP
.B MEMCACHED_BEHAVIOR_USE_UDP
Causes \fIlibmemcached(3)\fP to use the UDP transport when communicating
with a memcached server. Not all I/O operations are testsed
when this behavior is enababled. The following operations will return
-\fBMEMCACHED_NOT_SUPPORTED\fP when executed with the \fI\%MEMCACHED_BEHAVIOR_USE_UDP\fP enabled: \fBmemcached_version()\fP, \fBmemcached_stat()\fP, \fBmemcached_get()\fP, \fBmemcached_get_by_key()\fP, \fBmemcached_mget()\fP, \fBmemcached_mget_by_key()\fP, \fBmemcached_fetch()\fP, \fBmemcached_fetch_result()\fP, \fBmemcached_value_fetch()\fP.
+\fBMEMCACHED_NOT_SUPPORTED\fP when executed with the
+\fI\%MEMCACHED_BEHAVIOR_USE_UDP\fP enabled: \fBmemcached_version()\fP,
+\fBmemcached_stat()\fP, \fBmemcached_get()\fP,
+\fBmemcached_get_by_key()\fP, \fBmemcached_mget()\fP,
+\fBmemcached_mget_by_key()\fP, \fBmemcached_fetch()\fP,
+\fBmemcached_fetch_result()\fP, \fBmemcached_fetch_execute()\fP.
.sp
All other operations are testsed but are executed in a \(aqfire\-and\-forget\(aq
mode, in which once the client has executed the operation, no attempt
.B MEMCACHED_BEHAVIOR_KETAMA
.UNINDENT
.sp
-Sets the default distribution to MEMCACHED_DISTRIBUTION_CONSISTENT_KETAMA and the hash to MEMCACHED_HASH_MD5.
+Sets the default distribution to MEMCACHED_DISTRIBUTION_CONSISTENT_KETAMA and
+the hash to \fBMEMCACHED_HASH_MD5\fP.
.INDENT 0.0
.TP
.B MEMCACHED_BEHAVIOR_KETAMA_WEIGHTED
.B MEMCACHED_BEHAVIOR_KETAMA_HASH
.UNINDENT
.sp
-Sets the hashing algorithm for host mapping on continuum. The value can be set to either MEMCACHED_HASH_DEFAULT, MEMCACHED_HASH_MD5, MEMCACHED_HASH_CRC, MEMCACHED_HASH_FNV1_64, MEMCACHED_HASH_FNV1A_64, MEMCACHED_HASH_FNV1_32, and MEMCACHED_HASH_FNV1A_32.
+Sets the hashing algorithm for host mapping on continuum. The value can be set
+to either \fBMEMCACHED_HASH_DEFAULT\fP, \fBMEMCACHED_HASH_MD5\fP,
+\fBMEMCACHED_HASH_CRC\fP, \fBMEMCACHED_HASH_FNV1_64\fP,
+\fBMEMCACHED_HASH_FNV1A_64\fP, \fBMEMCACHED_HASH_FNV1_32\fP, and
+\fBMEMCACHED_HASH_FNV1A_32\fP.
.INDENT 0.0
.TP
.B MEMCACHED_BEHAVIOR_KETAMA_COMPAT
.B MEMCACHED_BEHAVIOR_POLL_TIMEOUT
.UNINDENT
.sp
-Modify the timeout value that is used by poll(). The default value is \-1. An signed int pointer must be passed to memcached_behavior_set() to change this value. For memcached_behavior_get() a signed int value will be cast and returned as the unsigned long long.
+Modify the timeout value that is used by poll. The default value is \-1. An signed int pointer must be passed to memcached_behavior_set to change this value. For memcached_behavior_get a signed int value will be cast and returned as the unsigned long long.
.INDENT 0.0
.TP
.B MEMCACHED_BEHAVIOR_USER_DATA
information.
.SH RETURN
.sp
-memcached_behavior_get() returns either the current value of the get, or 0
-or 1 on simple flag behaviors (1 being enabled). memcached_behavior_set()
+memcached_behavior_get returns either the current value of the get, or 0
+or 1 on simple flag behaviors (1 being enabled). memcached_behavior_set
returns failure or success.
.SH NOTES
.sp
-memcached_behavior_set() in version .17 was changed from taking a pointer
+memcached_behavior_set in version .17 was changed from taking a pointer
to data value, to taking a uin64_t.
.SH HOME
.sp
-.TH "MEMCACHED_BEHAVIOR_GET" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_BEHAVIOR_GET" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_behavior_get \- libmemcached Documentation
.
#include <libmemcached/memcached.h>
.INDENT 0.0
.TP
-.B uint64_t memcached_behavior_get (memcached_st *ptr, memcached_behavior flag);
+.B memcached_behavior_t
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_behavior_set (memcached_st *ptr, memcached_behavior flag, uint64_t data);
+.B uint64_t memcached_behavior_get(memcached_st\fI\ *ptr\fP, \fI\%memcached_behavior_t\fP\fI\ flag\fP)
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_return_t memcached_behavior_set(memcached_st\fI\ *ptr\fP, \fI\%memcached_behavior_t\fP\fI\ flag\fP, uint64_t\fI\ data\fP)
.UNINDENT
.sp
Compile and link with \-lmemcached
.SH DESCRIPTION
.sp
-\fIlibmemcached(3)\fP behavior can be modified by using \fBmemcached_behavior_set()\fP. Default behavior is the library strives to be quick and
+\fIlibmemcached(3)\fP behavior can be modified by using \fI\%memcached_behavior_set()\fP. Default behavior is the library strives to be quick and
accurate. Some behavior, while being faster, can also result in not entirely
accurate behavior (for instance, \fBmemcached_set()\fP will always respond
with \fBMEMCACHED_SUCCESS\fP).
.sp
-\fBmemcached_behavior_get()\fP takes a behavior flag and returns whether or not that behavior is currently enabled in the client.
+\fI\%memcached_behavior_get()\fP takes a behavior flag and returns whether or not that behavior is currently enabled in the client.
.sp
-\fBmemcached_behavior_set()\fP changes the value of a particular option
+\fI\%memcached_behavior_set()\fP changes the value of a particular option
of the client. It takes both a flag (listed below) and a value. For simple
on or off options you just need to pass in a value of 1. Calls to
-\fBmemcached_behavior_set()\fP will flush and reset all connections.
+\fI\%memcached_behavior_set()\fP will flush and reset all connections.
.INDENT 0.0
.TP
.B MEMCACHED_BEHAVIOR_USE_UDP
Causes \fIlibmemcached(3)\fP to use the UDP transport when communicating
with a memcached server. Not all I/O operations are testsed
when this behavior is enababled. The following operations will return
-\fBMEMCACHED_NOT_SUPPORTED\fP when executed with the \fI\%MEMCACHED_BEHAVIOR_USE_UDP\fP enabled: \fBmemcached_version()\fP, \fBmemcached_stat()\fP, \fBmemcached_get()\fP, \fBmemcached_get_by_key()\fP, \fBmemcached_mget()\fP, \fBmemcached_mget_by_key()\fP, \fBmemcached_fetch()\fP, \fBmemcached_fetch_result()\fP, \fBmemcached_value_fetch()\fP.
+\fBMEMCACHED_NOT_SUPPORTED\fP when executed with the
+\fI\%MEMCACHED_BEHAVIOR_USE_UDP\fP enabled: \fBmemcached_version()\fP,
+\fBmemcached_stat()\fP, \fBmemcached_get()\fP,
+\fBmemcached_get_by_key()\fP, \fBmemcached_mget()\fP,
+\fBmemcached_mget_by_key()\fP, \fBmemcached_fetch()\fP,
+\fBmemcached_fetch_result()\fP, \fBmemcached_fetch_execute()\fP.
.sp
All other operations are testsed but are executed in a \(aqfire\-and\-forget\(aq
mode, in which once the client has executed the operation, no attempt
.B MEMCACHED_BEHAVIOR_KETAMA
.UNINDENT
.sp
-Sets the default distribution to MEMCACHED_DISTRIBUTION_CONSISTENT_KETAMA and the hash to MEMCACHED_HASH_MD5.
+Sets the default distribution to MEMCACHED_DISTRIBUTION_CONSISTENT_KETAMA and
+the hash to \fBMEMCACHED_HASH_MD5\fP.
.INDENT 0.0
.TP
.B MEMCACHED_BEHAVIOR_KETAMA_WEIGHTED
.B MEMCACHED_BEHAVIOR_KETAMA_HASH
.UNINDENT
.sp
-Sets the hashing algorithm for host mapping on continuum. The value can be set to either MEMCACHED_HASH_DEFAULT, MEMCACHED_HASH_MD5, MEMCACHED_HASH_CRC, MEMCACHED_HASH_FNV1_64, MEMCACHED_HASH_FNV1A_64, MEMCACHED_HASH_FNV1_32, and MEMCACHED_HASH_FNV1A_32.
+Sets the hashing algorithm for host mapping on continuum. The value can be set
+to either \fBMEMCACHED_HASH_DEFAULT\fP, \fBMEMCACHED_HASH_MD5\fP,
+\fBMEMCACHED_HASH_CRC\fP, \fBMEMCACHED_HASH_FNV1_64\fP,
+\fBMEMCACHED_HASH_FNV1A_64\fP, \fBMEMCACHED_HASH_FNV1_32\fP, and
+\fBMEMCACHED_HASH_FNV1A_32\fP.
.INDENT 0.0
.TP
.B MEMCACHED_BEHAVIOR_KETAMA_COMPAT
.B MEMCACHED_BEHAVIOR_POLL_TIMEOUT
.UNINDENT
.sp
-Modify the timeout value that is used by poll(). The default value is \-1. An signed int pointer must be passed to memcached_behavior_set() to change this value. For memcached_behavior_get() a signed int value will be cast and returned as the unsigned long long.
+Modify the timeout value that is used by poll. The default value is \-1. An signed int pointer must be passed to memcached_behavior_set to change this value. For memcached_behavior_get a signed int value will be cast and returned as the unsigned long long.
.INDENT 0.0
.TP
.B MEMCACHED_BEHAVIOR_USER_DATA
information.
.SH RETURN
.sp
-memcached_behavior_get() returns either the current value of the get, or 0
-or 1 on simple flag behaviors (1 being enabled). memcached_behavior_set()
+memcached_behavior_get returns either the current value of the get, or 0
+or 1 on simple flag behaviors (1 being enabled). memcached_behavior_set
returns failure or success.
.SH NOTES
.sp
-memcached_behavior_set() in version .17 was changed from taking a pointer
+memcached_behavior_set in version .17 was changed from taking a pointer
to data value, to taking a uin64_t.
.SH HOME
.sp
-.TH "MEMCACHED_BEHAVIOR_SET" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_BEHAVIOR_SET" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_behavior_set \- libmemcached Documentation
.
#include <libmemcached/memcached.h>
.INDENT 0.0
.TP
-.B uint64_t memcached_behavior_get (memcached_st *ptr, memcached_behavior flag);
+.B memcached_behavior_t
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_behavior_set (memcached_st *ptr, memcached_behavior flag, uint64_t data);
+.B uint64_t memcached_behavior_get(memcached_st\fI\ *ptr\fP, \fI\%memcached_behavior_t\fP\fI\ flag\fP)
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_return_t memcached_behavior_set(memcached_st\fI\ *ptr\fP, \fI\%memcached_behavior_t\fP\fI\ flag\fP, uint64_t\fI\ data\fP)
.UNINDENT
.sp
Compile and link with \-lmemcached
.SH DESCRIPTION
.sp
-\fIlibmemcached(3)\fP behavior can be modified by using \fBmemcached_behavior_set()\fP. Default behavior is the library strives to be quick and
+\fIlibmemcached(3)\fP behavior can be modified by using \fI\%memcached_behavior_set()\fP. Default behavior is the library strives to be quick and
accurate. Some behavior, while being faster, can also result in not entirely
accurate behavior (for instance, \fBmemcached_set()\fP will always respond
with \fBMEMCACHED_SUCCESS\fP).
.sp
-\fBmemcached_behavior_get()\fP takes a behavior flag and returns whether or not that behavior is currently enabled in the client.
+\fI\%memcached_behavior_get()\fP takes a behavior flag and returns whether or not that behavior is currently enabled in the client.
.sp
-\fBmemcached_behavior_set()\fP changes the value of a particular option
+\fI\%memcached_behavior_set()\fP changes the value of a particular option
of the client. It takes both a flag (listed below) and a value. For simple
on or off options you just need to pass in a value of 1. Calls to
-\fBmemcached_behavior_set()\fP will flush and reset all connections.
+\fI\%memcached_behavior_set()\fP will flush and reset all connections.
.INDENT 0.0
.TP
.B MEMCACHED_BEHAVIOR_USE_UDP
Causes \fIlibmemcached(3)\fP to use the UDP transport when communicating
with a memcached server. Not all I/O operations are testsed
when this behavior is enababled. The following operations will return
-\fBMEMCACHED_NOT_SUPPORTED\fP when executed with the \fI\%MEMCACHED_BEHAVIOR_USE_UDP\fP enabled: \fBmemcached_version()\fP, \fBmemcached_stat()\fP, \fBmemcached_get()\fP, \fBmemcached_get_by_key()\fP, \fBmemcached_mget()\fP, \fBmemcached_mget_by_key()\fP, \fBmemcached_fetch()\fP, \fBmemcached_fetch_result()\fP, \fBmemcached_value_fetch()\fP.
+\fBMEMCACHED_NOT_SUPPORTED\fP when executed with the
+\fI\%MEMCACHED_BEHAVIOR_USE_UDP\fP enabled: \fBmemcached_version()\fP,
+\fBmemcached_stat()\fP, \fBmemcached_get()\fP,
+\fBmemcached_get_by_key()\fP, \fBmemcached_mget()\fP,
+\fBmemcached_mget_by_key()\fP, \fBmemcached_fetch()\fP,
+\fBmemcached_fetch_result()\fP, \fBmemcached_fetch_execute()\fP.
.sp
All other operations are testsed but are executed in a \(aqfire\-and\-forget\(aq
mode, in which once the client has executed the operation, no attempt
.B MEMCACHED_BEHAVIOR_KETAMA
.UNINDENT
.sp
-Sets the default distribution to MEMCACHED_DISTRIBUTION_CONSISTENT_KETAMA and the hash to MEMCACHED_HASH_MD5.
+Sets the default distribution to MEMCACHED_DISTRIBUTION_CONSISTENT_KETAMA and
+the hash to \fBMEMCACHED_HASH_MD5\fP.
.INDENT 0.0
.TP
.B MEMCACHED_BEHAVIOR_KETAMA_WEIGHTED
.B MEMCACHED_BEHAVIOR_KETAMA_HASH
.UNINDENT
.sp
-Sets the hashing algorithm for host mapping on continuum. The value can be set to either MEMCACHED_HASH_DEFAULT, MEMCACHED_HASH_MD5, MEMCACHED_HASH_CRC, MEMCACHED_HASH_FNV1_64, MEMCACHED_HASH_FNV1A_64, MEMCACHED_HASH_FNV1_32, and MEMCACHED_HASH_FNV1A_32.
+Sets the hashing algorithm for host mapping on continuum. The value can be set
+to either \fBMEMCACHED_HASH_DEFAULT\fP, \fBMEMCACHED_HASH_MD5\fP,
+\fBMEMCACHED_HASH_CRC\fP, \fBMEMCACHED_HASH_FNV1_64\fP,
+\fBMEMCACHED_HASH_FNV1A_64\fP, \fBMEMCACHED_HASH_FNV1_32\fP, and
+\fBMEMCACHED_HASH_FNV1A_32\fP.
.INDENT 0.0
.TP
.B MEMCACHED_BEHAVIOR_KETAMA_COMPAT
.B MEMCACHED_BEHAVIOR_POLL_TIMEOUT
.UNINDENT
.sp
-Modify the timeout value that is used by poll(). The default value is \-1. An signed int pointer must be passed to memcached_behavior_set() to change this value. For memcached_behavior_get() a signed int value will be cast and returned as the unsigned long long.
+Modify the timeout value that is used by poll. The default value is \-1. An signed int pointer must be passed to memcached_behavior_set to change this value. For memcached_behavior_get a signed int value will be cast and returned as the unsigned long long.
.INDENT 0.0
.TP
.B MEMCACHED_BEHAVIOR_USER_DATA
information.
.SH RETURN
.sp
-memcached_behavior_get() returns either the current value of the get, or 0
-or 1 on simple flag behaviors (1 being enabled). memcached_behavior_set()
+memcached_behavior_get returns either the current value of the get, or 0
+or 1 on simple flag behaviors (1 being enabled). memcached_behavior_set
returns failure or success.
.SH NOTES
.sp
-memcached_behavior_set() in version .17 was changed from taking a pointer
+memcached_behavior_set in version .17 was changed from taking a pointer
to data value, to taking a uin64_t.
.SH HOME
.sp
-.TH "MEMCACHED_CALLBACK" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_CALLBACK" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_callback \- libmemcached Documentation
.
#include <libmemcached/memcached.h>
.INDENT 0.0
.TP
-.B memcached_return_t memcached_callback_set (memcached_st *ptr, memcached_callback_t flag, const void *data);
+.B memcached_callback_t
.UNINDENT
.INDENT 0.0
.TP
-.B void * memcached_callback_get (memcached_st *ptr, memcached_callback_t flag, memcached_return_t *error);
+.B memcached_return_t memcached_callback_set(memcached_st\fI\ *ptr\fP, \fI\%memcached_callback_t\fP\fI\ flag\fP, const void\fI\ *data\fP)
+.UNINDENT
+.INDENT 0.0
+.TP
+.B void * memcached_callback_get(memcached_st\fI\ *ptr\fP, \fI\%memcached_callback_t\fP\fI\ flag\fP, memcached_return_t\fI\ *error\fP)
.UNINDENT
.sp
Compile and link with \-lmemcached
provide function calls at points in the code, or return pointers to
structures for particular usages.
.sp
-\fBmemcached_callback_get()\fP takes a callback flag and returns the
-structure or function set by \fBmemcached_callback_set()\fP.
+\fI\%memcached_callback_get()\fP takes a callback flag and returns the
+structure or function set by \fI\%memcached_callback_set()\fP.
.sp
-\fBmemcached_callback_set()\fP changes the function/structure assigned by a
+\fI\%memcached_callback_set()\fP changes the function/structure assigned by a
callback flag. No connections are reset.
.sp
You can use \fI\%MEMCACHED_CALLBACK_USER_DATA\fP to provide custom context
.sp
You can set a value which will be used to create a domain for your keys.
The value specified here will be prefixed to each of your keys. The value can
-not be greater then \fBMEMCACHED_PREFIX_KEY_MAX_SIZE \- 1\fP and will
+not be greater then \fBMEMCACHED_PREFIX_KEY_MAX_SIZE\fP \- 1 and will
reduce \fBMEMCACHED_MAX_KEY\fP by the value of your key.
.sp
The prefix key is only applied to the primary key, not the master key.
.UNINDENT
.SH RETURN
.sp
-\fBmemcached_callback_get()\fP return the function or structure that was
+\fI\%memcached_callback_get()\fP return the function or structure that was
provided. Upon error, nothing is set, null is returned, and the
\fBmemcached_return_t\fP argument is set to \fBMEMCACHED_FAILURE\fP.
.sp
-\fBmemcached_callback_set()\fP returns \fBMEMCACHED_SUCCESS\fP upon
+\fI\%memcached_callback_set()\fP returns \fBMEMCACHED_SUCCESS\fP upon
successful setting, otherwise \fBMEMCACHED_FAILURE\fP on error.
.SH HOME
.sp
-.TH "MEMCACHED_CALLBACK_GET" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_CALLBACK_GET" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_callback_get \- libmemcached Documentation
.
#include <libmemcached/memcached.h>
.INDENT 0.0
.TP
-.B memcached_return_t memcached_callback_set (memcached_st *ptr, memcached_callback_t flag, const void *data);
+.B memcached_callback_t
.UNINDENT
.INDENT 0.0
.TP
-.B void * memcached_callback_get (memcached_st *ptr, memcached_callback_t flag, memcached_return_t *error);
+.B memcached_return_t memcached_callback_set(memcached_st\fI\ *ptr\fP, \fI\%memcached_callback_t\fP\fI\ flag\fP, const void\fI\ *data\fP)
+.UNINDENT
+.INDENT 0.0
+.TP
+.B void * memcached_callback_get(memcached_st\fI\ *ptr\fP, \fI\%memcached_callback_t\fP\fI\ flag\fP, memcached_return_t\fI\ *error\fP)
.UNINDENT
.sp
Compile and link with \-lmemcached
provide function calls at points in the code, or return pointers to
structures for particular usages.
.sp
-\fBmemcached_callback_get()\fP takes a callback flag and returns the
-structure or function set by \fBmemcached_callback_set()\fP.
+\fI\%memcached_callback_get()\fP takes a callback flag and returns the
+structure or function set by \fI\%memcached_callback_set()\fP.
.sp
-\fBmemcached_callback_set()\fP changes the function/structure assigned by a
+\fI\%memcached_callback_set()\fP changes the function/structure assigned by a
callback flag. No connections are reset.
.sp
You can use \fI\%MEMCACHED_CALLBACK_USER_DATA\fP to provide custom context
.sp
You can set a value which will be used to create a domain for your keys.
The value specified here will be prefixed to each of your keys. The value can
-not be greater then \fBMEMCACHED_PREFIX_KEY_MAX_SIZE \- 1\fP and will
+not be greater then \fBMEMCACHED_PREFIX_KEY_MAX_SIZE\fP \- 1 and will
reduce \fBMEMCACHED_MAX_KEY\fP by the value of your key.
.sp
The prefix key is only applied to the primary key, not the master key.
.UNINDENT
.SH RETURN
.sp
-\fBmemcached_callback_get()\fP return the function or structure that was
+\fI\%memcached_callback_get()\fP return the function or structure that was
provided. Upon error, nothing is set, null is returned, and the
\fBmemcached_return_t\fP argument is set to \fBMEMCACHED_FAILURE\fP.
.sp
-\fBmemcached_callback_set()\fP returns \fBMEMCACHED_SUCCESS\fP upon
+\fI\%memcached_callback_set()\fP returns \fBMEMCACHED_SUCCESS\fP upon
successful setting, otherwise \fBMEMCACHED_FAILURE\fP on error.
.SH HOME
.sp
-.TH "MEMCACHED_CALLBACK_SET" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_CALLBACK_SET" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_callback_set \- libmemcached Documentation
.
#include <libmemcached/memcached.h>
.INDENT 0.0
.TP
-.B memcached_return_t memcached_callback_set (memcached_st *ptr, memcached_callback_t flag, const void *data);
+.B memcached_callback_t
.UNINDENT
.INDENT 0.0
.TP
-.B void * memcached_callback_get (memcached_st *ptr, memcached_callback_t flag, memcached_return_t *error);
+.B memcached_return_t memcached_callback_set(memcached_st\fI\ *ptr\fP, \fI\%memcached_callback_t\fP\fI\ flag\fP, const void\fI\ *data\fP)
+.UNINDENT
+.INDENT 0.0
+.TP
+.B void * memcached_callback_get(memcached_st\fI\ *ptr\fP, \fI\%memcached_callback_t\fP\fI\ flag\fP, memcached_return_t\fI\ *error\fP)
.UNINDENT
.sp
Compile and link with \-lmemcached
provide function calls at points in the code, or return pointers to
structures for particular usages.
.sp
-\fBmemcached_callback_get()\fP takes a callback flag and returns the
-structure or function set by \fBmemcached_callback_set()\fP.
+\fI\%memcached_callback_get()\fP takes a callback flag and returns the
+structure or function set by \fI\%memcached_callback_set()\fP.
.sp
-\fBmemcached_callback_set()\fP changes the function/structure assigned by a
+\fI\%memcached_callback_set()\fP changes the function/structure assigned by a
callback flag. No connections are reset.
.sp
You can use \fI\%MEMCACHED_CALLBACK_USER_DATA\fP to provide custom context
.sp
You can set a value which will be used to create a domain for your keys.
The value specified here will be prefixed to each of your keys. The value can
-not be greater then \fBMEMCACHED_PREFIX_KEY_MAX_SIZE \- 1\fP and will
+not be greater then \fBMEMCACHED_PREFIX_KEY_MAX_SIZE\fP \- 1 and will
reduce \fBMEMCACHED_MAX_KEY\fP by the value of your key.
.sp
The prefix key is only applied to the primary key, not the master key.
.UNINDENT
.SH RETURN
.sp
-\fBmemcached_callback_get()\fP return the function or structure that was
+\fI\%memcached_callback_get()\fP return the function or structure that was
provided. Upon error, nothing is set, null is returned, and the
\fBmemcached_return_t\fP argument is set to \fBMEMCACHED_FAILURE\fP.
.sp
-\fBmemcached_callback_set()\fP returns \fBMEMCACHED_SUCCESS\fP upon
+\fI\%memcached_callback_set()\fP returns \fBMEMCACHED_SUCCESS\fP upon
successful setting, otherwise \fBMEMCACHED_FAILURE\fP on error.
.SH HOME
.sp
-.TH "MEMCACHED_CAS" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_CAS" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_cas \- Working with data on the server in an atomic fashion
.
#include <libmemcached/memcached.h>
.INDENT 0.0
.TP
-.B memcached_return_t memcached_cas(memcached_st *ptr, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags, uint64_t cas);
+.B memcached_return_t memcached_cas(memcached_st\fI\ *ptr\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, const char\fI\ *value\fP, size_t\fI\ value_length\fP, time_t\fI\ expiration\fP, uint32_t\fI\ flags\fP, uint64_t\fI\ cas\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_cas_by_key(memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags, uint64_t cas);
+.B memcached_return_t memcached_cas_by_key(memcached_st\fI\ *ptr\fP, const char\fI\ *group_key\fP, size_t\fI\ group_key_length\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, const char\fI\ *value\fP, size_t\fI\ value_length\fP, time_t\fI\ expiration\fP, uint32_t\fI\ flags\fP, uint64_t\fI\ cas\fP)
.UNINDENT
.sp
Compile and link with \-lmemcached
.SH DESCRIPTION
.sp
-\fBmemcached_cas()\fP overwrites data in the server as long as the "cas"
+\fI\%memcached_cas()\fP 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 \fBmemcached_result_cas()\fP on a memcached_result_st(3)
structure. At the point that this note was written cas is still buggy in memached. Turning on tests for it in libmemcached(3) is optional. Please see
\fBmemcached_set()\fP for information on how to do this.
.sp
-\fBmemcached_cas_by_key()\fP method behaves in a similar method as the non
-key methods. The difference is that it uses the \fBgroup_key\fP parameter
+\fI\%memcached_cas_by_key()\fP method behaves in a similar method as the non
+key methods. The difference is that it uses the group_key parameter
to map objects to particular servers.
.sp
-\fBmemcached_cas()\fP is testsed with the \fBMEMCACHED_BEHAVIOR_USE_UDP\fP behavior enabled. However, when using these operations with this behavior
+\fI\%memcached_cas()\fP is testsed with the \fBMEMCACHED_BEHAVIOR_USE_UDP\fP behavior enabled. However, when using these operations with this behavior
on, there are limits to the size of the payload being sent to the server. The
reason for these limits is that the Memcached Server does not allow
multi\-datagram requests and the current server implementation sets a datagram
-.TH "MEMCACHED_CAS_BY_KEY" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_CAS_BY_KEY" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_cas_by_key \- Storing and Replacing Data
.
#include <libmemcached/memcached.h>
.INDENT 0.0
.TP
-.B memcached_return_t memcached_cas(memcached_st *ptr, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags, uint64_t cas);
+.B memcached_return_t memcached_cas(memcached_st\fI\ *ptr\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, const char\fI\ *value\fP, size_t\fI\ value_length\fP, time_t\fI\ expiration\fP, uint32_t\fI\ flags\fP, uint64_t\fI\ cas\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_cas_by_key(memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags, uint64_t cas);
+.B memcached_return_t memcached_cas_by_key(memcached_st\fI\ *ptr\fP, const char\fI\ *group_key\fP, size_t\fI\ group_key_length\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, const char\fI\ *value\fP, size_t\fI\ value_length\fP, time_t\fI\ expiration\fP, uint32_t\fI\ flags\fP, uint64_t\fI\ cas\fP)
.UNINDENT
.sp
Compile and link with \-lmemcached
.SH DESCRIPTION
.sp
-\fBmemcached_cas()\fP overwrites data in the server as long as the "cas"
+\fI\%memcached_cas()\fP 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 \fBmemcached_result_cas()\fP on a memcached_result_st(3)
structure. At the point that this note was written cas is still buggy in memached. Turning on tests for it in libmemcached(3) is optional. Please see
\fBmemcached_set()\fP for information on how to do this.
.sp
-\fBmemcached_cas_by_key()\fP method behaves in a similar method as the non
-key methods. The difference is that it uses the \fBgroup_key\fP parameter
+\fI\%memcached_cas_by_key()\fP method behaves in a similar method as the non
+key methods. The difference is that it uses the group_key parameter
to map objects to particular servers.
.sp
-\fBmemcached_cas()\fP is testsed with the \fBMEMCACHED_BEHAVIOR_USE_UDP\fP behavior enabled. However, when using these operations with this behavior
+\fI\%memcached_cas()\fP is testsed with the \fBMEMCACHED_BEHAVIOR_USE_UDP\fP behavior enabled. However, when using these operations with this behavior
on, there are limits to the size of the payload being sent to the server. The
reason for these limits is that the Memcached Server does not allow
multi\-datagram requests and the current server implementation sets a datagram
-.TH "MEMCACHED_CLONE" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_CLONE" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_clone \- libmemcached Documentation
.
#include <libmemcached/memcached.h>
.INDENT 0.0
.TP
-.B memcachd_st
+.B memcached_st
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_st* memcached_create(memcached_st\fI\ *ptr\fP)
+.B \fI\%memcached_st\fP* memcached_create(\fI\%memcached_st\fP\fI\ *ptr\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B void memcached_free(memcached_st\fI\ *ptr\fP)
+.B void memcached_free(\fI\%memcached_st\fP\fI\ *ptr\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_st* memcached_clone(memcached_st\fI\ *destination\fP, memcached_st\fI\ *source\fP)
+.B \fI\%memcached_st\fP* memcached_clone(\fI\%memcached_st\fP\fI\ *destination\fP, \fI\%memcached_st\fP\fI\ *source\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B void memcached_servers_reset(memcached_st)
+.B void memcached_servers_reset(\fI\%memcached_st\fP)
.UNINDENT
.sp
Compile and link with \-lmemcached
.SH DESCRIPTION
.sp
-\fI\%memcached_create()\fP is used to create a \fBmemcached_st\fP
+\fI\%memcached_create()\fP is used to create a \fI\%memcached_st\fP
structure that will then be used by other libmemcached(3) functions to
communicate with the server. You should either pass a statically declared
-\fBmemcached_st\fP to \fI\%memcached_create()\fP or
+\fI\%memcached_st\fP to \fI\%memcached_create()\fP or
a NULL. If a NULL passed in then a structure is allocated for you.
.sp
Please note, when you write new application use
-\fBmemcached_create_with_options()\fP over
+\fBmemcached()\fP over
\fI\%memcached_create()\fP.
.sp
\fI\%memcached_clone()\fP is similar to \fI\%memcached_create()\fP but
it copies the defaults and list of servers from the source
-\fBmemcached_st\fP. If you pass a null as the argument for the source
+\fI\%memcached_st\fP. If you pass a null as the argument for the source
to clone, it is the same as a call to \fI\%memcached_create()\fP.
-If the destination argument is NULL a \fBmemcached_st\fP will be allocated
+If the destination argument is NULL a \fI\%memcached_st\fP will be allocated
for you.
.sp
\fI\%memcached_servers_reset()\fP allows you to zero out the list of
-servers that the \fBmemcached_st\fP has.
+servers that the \fI\%memcached_st\fP has.
.sp
-To clean up memory associated with a \fBmemcached_st\fP structure you
+To clean up memory associated with a \fI\%memcached_st\fP structure you
should pass it to \fI\%memcached_free()\fP when you are finished using it.
\fI\%memcached_free()\fP is the only way to make sure all memory is
deallocated when you finish using the structure.
heap allocated structures.
.SH RETURN
.sp
-\fI\%memcached_create()\fP returns a pointer to the \fBmemcached_st\fP
+\fI\%memcached_create()\fP returns a pointer to the \fI\%memcached_st\fP
that was created (or initialized). On an allocation failure, it returns NULL.
.sp
-\fI\%memcached_clone()\fP returns a pointer to the \fBmemcached_st\fP
+\fI\%memcached_clone()\fP returns a pointer to the \fI\%memcached_st\fP
that was created (or initialized). On an allocation failure, it returns NULL.
.SH HOME
.sp
-.TH "MEMCACHED_CREATE" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_CREATE" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_create \- libmemcached Documentation
.
#include <libmemcached/memcached.h>
.INDENT 0.0
.TP
-.B memcachd_st
+.B memcached_st
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_st* memcached_create(memcached_st\fI\ *ptr\fP)
+.B \fI\%memcached_st\fP* memcached_create(\fI\%memcached_st\fP\fI\ *ptr\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B void memcached_free(memcached_st\fI\ *ptr\fP)
+.B void memcached_free(\fI\%memcached_st\fP\fI\ *ptr\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_st* memcached_clone(memcached_st\fI\ *destination\fP, memcached_st\fI\ *source\fP)
+.B \fI\%memcached_st\fP* memcached_clone(\fI\%memcached_st\fP\fI\ *destination\fP, \fI\%memcached_st\fP\fI\ *source\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B void memcached_servers_reset(memcached_st)
+.B void memcached_servers_reset(\fI\%memcached_st\fP)
.UNINDENT
.sp
Compile and link with \-lmemcached
.SH DESCRIPTION
.sp
-\fI\%memcached_create()\fP is used to create a \fBmemcached_st\fP
+\fI\%memcached_create()\fP is used to create a \fI\%memcached_st\fP
structure that will then be used by other libmemcached(3) functions to
communicate with the server. You should either pass a statically declared
-\fBmemcached_st\fP to \fI\%memcached_create()\fP or
+\fI\%memcached_st\fP to \fI\%memcached_create()\fP or
a NULL. If a NULL passed in then a structure is allocated for you.
.sp
Please note, when you write new application use
-\fBmemcached_create_with_options()\fP over
+\fBmemcached()\fP over
\fI\%memcached_create()\fP.
.sp
\fI\%memcached_clone()\fP is similar to \fI\%memcached_create()\fP but
it copies the defaults and list of servers from the source
-\fBmemcached_st\fP. If you pass a null as the argument for the source
+\fI\%memcached_st\fP. If you pass a null as the argument for the source
to clone, it is the same as a call to \fI\%memcached_create()\fP.
-If the destination argument is NULL a \fBmemcached_st\fP will be allocated
+If the destination argument is NULL a \fI\%memcached_st\fP will be allocated
for you.
.sp
\fI\%memcached_servers_reset()\fP allows you to zero out the list of
-servers that the \fBmemcached_st\fP has.
+servers that the \fI\%memcached_st\fP has.
.sp
-To clean up memory associated with a \fBmemcached_st\fP structure you
+To clean up memory associated with a \fI\%memcached_st\fP structure you
should pass it to \fI\%memcached_free()\fP when you are finished using it.
\fI\%memcached_free()\fP is the only way to make sure all memory is
deallocated when you finish using the structure.
heap allocated structures.
.SH RETURN
.sp
-\fI\%memcached_create()\fP returns a pointer to the \fBmemcached_st\fP
+\fI\%memcached_create()\fP returns a pointer to the \fI\%memcached_st\fP
that was created (or initialized). On an allocation failure, it returns NULL.
.sp
-\fI\%memcached_clone()\fP returns a pointer to the \fBmemcached_st\fP
+\fI\%memcached_clone()\fP returns a pointer to the \fI\%memcached_st\fP
that was created (or initialized). On an allocation failure, it returns NULL.
.SH HOME
.sp
-.TH "MEMCACHED_DECREMENT" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_DECREMENT" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_decrement \- Incrementing and Decrementing Values
.
#include <libmemcached/memcached.h>
.INDENT 0.0
.TP
-.B memcached_return_t memcached_increment (memcached_st *ptr, const char *key, size_t key_length, unsigned int offset, uint64_t *value);
+.B memcached_return_t memcached_increment(memcached_st\fI\ *ptr\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, uint32_t\fI\ offset\fP, uint64_t\fI\ *value\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_decrement (memcached_st *ptr, const char *key, size_t key_length, unsigned int offset, uint64_t *value);
+.B memcached_return_t memcached_decrement(memcached_st\fI\ *ptr\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, uint32_t\fI\ offset\fP, uint64_t\fI\ *value\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_increment_with_initial (memcached_st *ptr, const char *key, size_t key_length, uint64_t offset, uint64_t initial, time_t expiration, uint64_t *value);
+.B memcached_return_t memcached_increment_with_initial(memcached_st\fI\ *ptr\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, uint64_t\fI\ offset\fP, uint64_t\fI\ initial\fP, time_t\fI\ expiration\fP, uint64_t\fI\ *value\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_decrement_with_initial (memcached_st *ptr, const char *key, size_t key_length, uint64_t offset, uint64_t initial, time_t expiration, uint64_t *value);
+.B memcached_return_t memcached_decrement_with_initial(memcached_st\fI\ *ptr\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, uint64_t\fI\ offset\fP, uint64_t\fI\ initial\fP, time_t\fI\ expiration\fP, uint64_t\fI\ *value\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_increment_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, unsigned int offset, uint64_t *value);
+.B memcached_return_t memcached_increment_by_key(memcached_st\fI\ *ptr\fP, const char\fI\ *group_key\fP, size_t\fI\ group_key_length\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, uint32_t\fI\ offset\fP, uint64_t\fI\ *value\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_decrement_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, unsigned int offset, uint64_t *value);
+.B memcached_return_t memcached_decrement_by_key(memcached_st\fI\ *ptr\fP, const char\fI\ *group_key\fP, size_t\fI\ group_key_length\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, uint32_t\fI\ offset\fP, uint64_t\fI\ *value\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_increment_with_initial_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, uint64_t offset, uint64_t initial, time_t expiration, uint64_t *value);
+.B memcached_return_t memcached_increment_with_initial_by_key(memcached_st\fI\ *ptr\fP, const char\fI\ *group_key\fP, size_t\fI\ group_key_length\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, uint64_t\fI\ offset\fP, uint64_t\fI\ initial\fP, time_t\fI\ expiration\fP, uint64_t\fI\ *value\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_decrement_with_initial_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, uint64_t offset, uint64_t initial, time_t expiration, uint64_t *value);
+.B memcached_return_t memcached_decrement_with_initial_by_key(memcached_st\fI\ *ptr\fP, const char\fI\ *group_key\fP, size_t\fI\ group_key_length\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, uint64_t\fI\ offset\fP, uint64_t\fI\ initial\fP, time_t\fI\ expiration\fP, uint64_t\fI\ *value\fP)
.UNINDENT
.sp
Compile and link with \-lmemcached
(overflow and underflow are not detected). This gives you the ability to use
memcached to generate shared sequences of values.
.sp
-memcached_increment() takes a key and keylength and increments the value by
-the offset passed to it. The value is then returned via the unsigned int
+memcached_increment takes a key and keylength and increments the value by
+the offset passed to it. The value is then returned via the uint32_t
value pointer you pass to it.
.sp
-memcached_decrement() takes a key and keylength and decrements the value by
-the offset passed to it. The value is then returned via the unsigned int
+memcached_decrement takes a key and keylength and decrements the value by
+the offset passed to it. The value is then returned via the uint32_t
value pointer you pass to it.
.sp
-memcached_increment_with_initial() takes a key and keylength and increments
+memcached_increment_with_initial takes a key and keylength and increments
the value by the offset passed to it. If the object specified by key does
not exist, one of two things may happen: If the expiration value is
MEMCACHED_EXPIRATION_NOT_ADD, the operation will fail. For all other
expiration values, the operation will succeed by seeding the value for that
key with a initial value to expire with the provided expiration time. The
-flags will be set to zero.The value is then returned via the unsigned int
+flags will be set to zero.The value is then returned via the uint32_t
value pointer you pass to it.
.sp
-memcached_decrement_with_initial() takes a key and keylength and decrements
+memcached_decrement_with_initial takes a key and keylength and decrements
the value by the offset passed to it. If the object specified by key does
not exist, one of two things may happen: If the expiration value is
MEMCACHED_EXPIRATION_NOT_ADD, the operation will fail. For all other
expiration values, the operation will succeed by seeding the value for that
key with a initial value to expire with the provided expiration time. The
-flags will be set to zero.The value is then returned via the unsigned int
+flags will be set to zero.The value is then returned via the uint32_t
value pointer you pass to it.
.sp
-memcached_increment_by_key(), memcached_decrement_by_key(),
-memcached_increment_with_initial_by_key(), and
-memcached_decrement_with_initial_by_key() are master key equivalents of the
-above.
+\fI\%memcached_increment_by_key()\fP, \fI\%memcached_decrement_by_key()\fP,
+\fI\%memcached_increment_with_initial_by_key()\fP, and
+\fI\%memcached_decrement_with_initial_by_key()\fP are master key equivalents of the above.
.SH RETURN
.sp
-A value of type \fBmemcached_return_t\fP is returned.
+A value of type \fBmemcached_return_t\fP is returned.
On success that value will be \fBMEMCACHED_SUCCESS\fP.
-Use memcached_strerror() to translate this value to a printable string.
+Use memcached_strerror to translate this value to a printable string.
.SH HOME
.sp
To find out more information please check:
-.TH "MEMCACHED_DECREMENT_WITH_INITIAL" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_DECREMENT_WITH_INITIAL" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_decrement_with_initial \- Incrementing and Decrementing Values
.
#include <libmemcached/memcached.h>
.INDENT 0.0
.TP
-.B memcached_return_t memcached_increment (memcached_st *ptr, const char *key, size_t key_length, unsigned int offset, uint64_t *value);
+.B memcached_return_t memcached_increment(memcached_st\fI\ *ptr\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, uint32_t\fI\ offset\fP, uint64_t\fI\ *value\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_decrement (memcached_st *ptr, const char *key, size_t key_length, unsigned int offset, uint64_t *value);
+.B memcached_return_t memcached_decrement(memcached_st\fI\ *ptr\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, uint32_t\fI\ offset\fP, uint64_t\fI\ *value\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_increment_with_initial (memcached_st *ptr, const char *key, size_t key_length, uint64_t offset, uint64_t initial, time_t expiration, uint64_t *value);
+.B memcached_return_t memcached_increment_with_initial(memcached_st\fI\ *ptr\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, uint64_t\fI\ offset\fP, uint64_t\fI\ initial\fP, time_t\fI\ expiration\fP, uint64_t\fI\ *value\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_decrement_with_initial (memcached_st *ptr, const char *key, size_t key_length, uint64_t offset, uint64_t initial, time_t expiration, uint64_t *value);
+.B memcached_return_t memcached_decrement_with_initial(memcached_st\fI\ *ptr\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, uint64_t\fI\ offset\fP, uint64_t\fI\ initial\fP, time_t\fI\ expiration\fP, uint64_t\fI\ *value\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_increment_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, unsigned int offset, uint64_t *value);
+.B memcached_return_t memcached_increment_by_key(memcached_st\fI\ *ptr\fP, const char\fI\ *group_key\fP, size_t\fI\ group_key_length\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, uint32_t\fI\ offset\fP, uint64_t\fI\ *value\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_decrement_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, unsigned int offset, uint64_t *value);
+.B memcached_return_t memcached_decrement_by_key(memcached_st\fI\ *ptr\fP, const char\fI\ *group_key\fP, size_t\fI\ group_key_length\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, uint32_t\fI\ offset\fP, uint64_t\fI\ *value\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_increment_with_initial_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, uint64_t offset, uint64_t initial, time_t expiration, uint64_t *value);
+.B memcached_return_t memcached_increment_with_initial_by_key(memcached_st\fI\ *ptr\fP, const char\fI\ *group_key\fP, size_t\fI\ group_key_length\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, uint64_t\fI\ offset\fP, uint64_t\fI\ initial\fP, time_t\fI\ expiration\fP, uint64_t\fI\ *value\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_decrement_with_initial_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, uint64_t offset, uint64_t initial, time_t expiration, uint64_t *value);
+.B memcached_return_t memcached_decrement_with_initial_by_key(memcached_st\fI\ *ptr\fP, const char\fI\ *group_key\fP, size_t\fI\ group_key_length\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, uint64_t\fI\ offset\fP, uint64_t\fI\ initial\fP, time_t\fI\ expiration\fP, uint64_t\fI\ *value\fP)
.UNINDENT
.sp
Compile and link with \-lmemcached
(overflow and underflow are not detected). This gives you the ability to use
memcached to generate shared sequences of values.
.sp
-memcached_increment() takes a key and keylength and increments the value by
-the offset passed to it. The value is then returned via the unsigned int
+memcached_increment takes a key and keylength and increments the value by
+the offset passed to it. The value is then returned via the uint32_t
value pointer you pass to it.
.sp
-memcached_decrement() takes a key and keylength and decrements the value by
-the offset passed to it. The value is then returned via the unsigned int
+memcached_decrement takes a key and keylength and decrements the value by
+the offset passed to it. The value is then returned via the uint32_t
value pointer you pass to it.
.sp
-memcached_increment_with_initial() takes a key and keylength and increments
+memcached_increment_with_initial takes a key and keylength and increments
the value by the offset passed to it. If the object specified by key does
not exist, one of two things may happen: If the expiration value is
MEMCACHED_EXPIRATION_NOT_ADD, the operation will fail. For all other
expiration values, the operation will succeed by seeding the value for that
key with a initial value to expire with the provided expiration time. The
-flags will be set to zero.The value is then returned via the unsigned int
+flags will be set to zero.The value is then returned via the uint32_t
value pointer you pass to it.
.sp
-memcached_decrement_with_initial() takes a key and keylength and decrements
+memcached_decrement_with_initial takes a key and keylength and decrements
the value by the offset passed to it. If the object specified by key does
not exist, one of two things may happen: If the expiration value is
MEMCACHED_EXPIRATION_NOT_ADD, the operation will fail. For all other
expiration values, the operation will succeed by seeding the value for that
key with a initial value to expire with the provided expiration time. The
-flags will be set to zero.The value is then returned via the unsigned int
+flags will be set to zero.The value is then returned via the uint32_t
value pointer you pass to it.
.sp
-memcached_increment_by_key(), memcached_decrement_by_key(),
-memcached_increment_with_initial_by_key(), and
-memcached_decrement_with_initial_by_key() are master key equivalents of the
-above.
+\fI\%memcached_increment_by_key()\fP, \fI\%memcached_decrement_by_key()\fP,
+\fI\%memcached_increment_with_initial_by_key()\fP, and
+\fI\%memcached_decrement_with_initial_by_key()\fP are master key equivalents of the above.
.SH RETURN
.sp
-A value of type \fBmemcached_return_t\fP is returned.
+A value of type \fBmemcached_return_t\fP is returned.
On success that value will be \fBMEMCACHED_SUCCESS\fP.
-Use memcached_strerror() to translate this value to a printable string.
+Use memcached_strerror to translate this value to a printable string.
.SH HOME
.sp
To find out more information please check:
-.TH "MEMCACHED_DELETE" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_DELETE" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_delete \- libmemcached Documentation
.
#include <libmemcached/memcached.h>
.INDENT 0.0
.TP
-.B memcached_return_t memcached_delete (memcached_st *ptr, const char *key, size_t key_length, time_t expiration);
+.B memcached_return_t memcached_delete(memcached_st\fI\ *ptr\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, time_t\fI\ expiration\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_delete_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, time_t expiration);
+.B memcached_return_t memcached_delete_by_key(memcached_st\fI\ *ptr\fP, const char\fI\ *group_key\fP, size_t\fI\ group_key_length\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, time_t\fI\ expiration\fP)
.UNINDENT
.sp
Compile and link with \-lmemcached
.SH DESCRIPTION
.sp
-\fBmemcached_delete()\fP is used to delete a particular key.
-\fBmemcached_delete_by_key()\fP works the same, but it takes a master key
+\fI\%memcached_delete()\fP is used to delete a particular key.
+\fI\%memcached_delete_by_key()\fP works the same, but it takes a master key
to find the given value.
.sp
Expiration works by placing the item into a delete queue, which means that
-.TH "MEMCACHED_DELETE_BY_KEY" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_DELETE_BY_KEY" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_delete_by_key \- libmemcached Documentation
.
#include <libmemcached/memcached.h>
.INDENT 0.0
.TP
-.B memcached_return_t memcached_delete (memcached_st *ptr, const char *key, size_t key_length, time_t expiration);
+.B memcached_return_t memcached_delete(memcached_st\fI\ *ptr\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, time_t\fI\ expiration\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_delete_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, time_t expiration);
+.B memcached_return_t memcached_delete_by_key(memcached_st\fI\ *ptr\fP, const char\fI\ *group_key\fP, size_t\fI\ group_key_length\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, time_t\fI\ expiration\fP)
.UNINDENT
.sp
Compile and link with \-lmemcached
.SH DESCRIPTION
.sp
-\fBmemcached_delete()\fP is used to delete a particular key.
-\fBmemcached_delete_by_key()\fP works the same, but it takes a master key
+\fI\%memcached_delete()\fP is used to delete a particular key.
+\fI\%memcached_delete_by_key()\fP works the same, but it takes a master key
to find the given value.
.sp
Expiration works by placing the item into a delete queue, which means that
-.TH "MEMCACHED_DESTROY_SASL_AUTH_DATA" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_DESTROY_SASL_AUTH_DATA" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_destroy_sasl_auth_data \- libmemcached Documentation
.
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return memcached_set_sasl_auth_data(memcached_st\fI\ *ptr\fP, const char\fI\ *username\fP, const char\fI\ *password\fP)
+.B memcached_return_t memcached_set_sasl_auth_data(memcached_st\fI\ *ptr\fP, const char\fI\ *username\fP, const char\fI\ *password\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return memcached_destroy_sasl_auth_data(memcached_st\fI\ *ptr\fP)
+.B memcached_return_t memcached_destroy_sasl_auth_data(memcached_st\fI\ *ptr\fP)
.UNINDENT
.sp
Compile and link with \-lmemcached
\fBmemcached_free\fP to avoid a memory leak. You should NOT call
\fI\%memcached_destroy_sasl_auth_data\fP if you specify your own callback
function with \fI\%memcached_set_sasl_callbacks()\fP.
-.sp
-You as a client user have to initialize libsasl by using \fBsasl_client_init\fP before enabling it in libmemcached, and you have to shut down libsasl by
-calling \fBsasl_done()\fP when you are done using SASL from libmemcached.
.SH RETURN
.sp
-\fI\%memcached_get_sasl_callbacks()\fP returns the callbacks currently used
-by this memcached handle. \fBmemcached_get_sasl_set_auth_data()\fP returns \fBMEMCACHED_SUCCESS\fP upon success.
+\fI\%memcached_get_sasl_callbacks()\fP returns the callbacks currently used by
+this memcached handle. \fI\%memcached_set_sasl_auth_data()\fP returns
+\fBMEMCACHED_SUCCESS\fP upon success.
.SH HOME
.sp
To find out more information please check:
-.TH "MEMCACHED_DUMP" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_DUMP" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_dump \- libmemcached Documentation
.
#include <libmemcached/memcached.h>
.INDENT 0.0
.TP
-.B memcached_return_t memcached_dump (memcached_st *ptr, memcached_dump_fn *function, void *context, uint32_t number_of_callbacks);
+.B memcached_return_t memcached_dump(memcached_st\fI\ *ptr\fP, \fI\%memcached_dump_fn\fP\fI\ *function\fP, void\fI\ *context\fP, uint32_t\fI\ number_of_callbacks\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B typedef memcached_return_t (*memcached_dump_fn)(memcached_st *ptr, const char *key, size_t key_length, void *context);
+.B memcached_return_t (*memcached_dump_fn)(memcached_st\fI\ *ptr\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, void\fI\ *context\fP)
.UNINDENT
.sp
Compile and link with \-lmemcached
.SH DESCRIPTION
.sp
-\fBmemcached_dump()\fP is used to get a list of keys found in memcached(1)
+\fI\%memcached_dump()\fP is used to get a list of keys found in memcached(1)
servers. Because memcached(1) does not guarentee to dump all keys you can not
assume you have fetched all keys from the server. The function takes an array
of callbacks that it will use to execute on keys as they are found.
-.TH "MEMCACHED_EXIST" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_EXIST" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_exist \- libmemcached Documentation
.
-.TH "MEMCACHED_EXIST_BY_KEY" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_EXIST_BY_KEY" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_exist_by_key \- libmemcached Documentation
.
-.TH "MEMCACHED_FETCH" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_FETCH" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_fetch \- Retrieving data from the server
.
three pointer variables which will give you the state of the returned
object. A \fBuint32_t\fP pointer to contain whatever flags you stored with the value, a \fBsize_t\fP pointer which will be filled with size of of the
object, and a \fBmemcached_return_t\fP pointer to hold any error. The
-object will be returned upon success and NULL will be returned on failure. \fBMEMCACHD_END\fP is returned by the *error value when all objects that have been found are returned. The final value upon \fBMEMCACHED_END\fP is null.
+object will be returned upon success and NULL will be returned on failure. \fBMEMCACHED_END\fP is returned by the *error value when all objects that have been found are returned. The final value upon \fBMEMCACHED_END\fP is null.
.sp
Values returned by \fI\%memcached_fetch()\fP must be freed by the caller.
.sp
to \fBMEMCACHED_END\fP upon successful conclusion.
\fBMEMCACHED_NOTFOUND\fP will be return if no keys at all were found.
.sp
-\fBMEMCACHED_KEY_TOO_BIG\fP is set to error whenever :c:\fBmemcached_fetch()\fP was used
+\fBMEMCACHED_KEY_TOO_BIG\fP is set to error whenever \fI\%memcached_fetch()\fP was used
and the key was set larger then \fBMEMCACHED_MAX_KEY\fP, which was the largest
key allowed for the original memcached ascii server.
.SH HOME
-.TH "MEMCACHED_FETCH_EXECUTE" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_FETCH_EXECUTE" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_fetch_execute \- Retrieving data from the server
.
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_fetch_execute(memcached_st\fI\ *ptr\fP, memcached_execute_fn\fI\ *callback\fP, void\fI\ *context\fP, uint32_t\fI\ number_of_callbacks\fP)
+.B memcached_return_t memcached_fetch_execute(memcached_st\fI\ *ptr\fP, \fI\%memcached_execute_fn\fP\fI\ *callback\fP, void\fI\ *context\fP, uint32_t\fI\ number_of_callbacks\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_mget_execute(memcached_st\fI\ *ptr\fP, const char * const\fI\ *keys\fP, const size_t\fI\ *key_length\fP, size_t\fI\ number_of_keys\fP, memcached_execute_fn\fI\ *callback\fP, void\fI\ *context\fP, uint32_t\fI\ number_of_callbacks\fP)
+.B memcached_return_t memcached_mget_execute(memcached_st\fI\ *ptr\fP, const char * const\fI\ *keys\fP, const size_t\fI\ *key_length\fP, size_t\fI\ number_of_keys\fP, \fI\%memcached_execute_fn\fP\fI\ *callback\fP, void\fI\ *context\fP, uint32_t\fI\ number_of_callbacks\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_mget_execute_by_key(memcached_st\fI\ *ptr\fP, const char\fI\ *group_key\fP, size_t\fI\ group_key_length\fP, const char * const\fI\ *keys\fP, const size_t\fI\ *key_length\fP, size_t\fI\ number_of_keys\fP, memcached_execute_fn\fI\ *callback\fP, void\fI\ *context\fP, uint32_t\fI\ number_of_callbacks\fP)
+.B memcached_return_t memcached_mget_execute_by_key(memcached_st\fI\ *ptr\fP, const char\fI\ *group_key\fP, size_t\fI\ group_key_length\fP, const char * const\fI\ *keys\fP, const size_t\fI\ *key_length\fP, size_t\fI\ number_of_keys\fP, \fI\%memcached_execute_fn\fP\fI\ *callback\fP, void\fI\ *context\fP, uint32_t\fI\ number_of_callbacks\fP)
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_return_t (*memcached_execute_fn)(const memcached_st\fI\ *ptr\fP, memcached_result_st\fI\ *result\fP, void\fI\ *context\fP)
.UNINDENT
.sp
Compile and link with \-lmemcached
three pointer variables which will give you the state of the returned
object. A \fBuint32_t\fP pointer to contain whatever flags you stored with the value, a \fBsize_t\fP pointer which will be filled with size of of the
object, and a \fBmemcached_return_t\fP pointer to hold any error. The
-object will be returned upon success and NULL will be returned on failure. \fBMEMCACHD_END\fP is returned by the *error value when all objects that have been found are returned. The final value upon \fBMEMCACHED_END\fP is null.
+object will be returned upon success and NULL will be returned on failure. \fBMEMCACHED_END\fP is returned by the *error value when all objects that have been found are returned. The final value upon \fBMEMCACHED_END\fP is null.
.sp
\fI\%memcached_fetch_result()\fP is used to return a \fBmemcached_result_st\fP structure from a memcached server. The result object is forward compatible
with changes to the server. For more information please refer to the
-.TH "MEMCACHED_FETCH_RESULT" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_FETCH_RESULT" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_fetch_result \- Retrieving data from the server
.
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_fetch_execute(memcached_st\fI\ *ptr\fP, memcached_execute_fn\fI\ *callback\fP, void\fI\ *context\fP, uint32_t\fI\ number_of_callbacks\fP)
+.B memcached_return_t memcached_fetch_execute(memcached_st\fI\ *ptr\fP, \fI\%memcached_execute_fn\fP\fI\ *callback\fP, void\fI\ *context\fP, uint32_t\fI\ number_of_callbacks\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_mget_execute(memcached_st\fI\ *ptr\fP, const char * const\fI\ *keys\fP, const size_t\fI\ *key_length\fP, size_t\fI\ number_of_keys\fP, memcached_execute_fn\fI\ *callback\fP, void\fI\ *context\fP, uint32_t\fI\ number_of_callbacks\fP)
+.B memcached_return_t memcached_mget_execute(memcached_st\fI\ *ptr\fP, const char * const\fI\ *keys\fP, const size_t\fI\ *key_length\fP, size_t\fI\ number_of_keys\fP, \fI\%memcached_execute_fn\fP\fI\ *callback\fP, void\fI\ *context\fP, uint32_t\fI\ number_of_callbacks\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_mget_execute_by_key(memcached_st\fI\ *ptr\fP, const char\fI\ *group_key\fP, size_t\fI\ group_key_length\fP, const char * const\fI\ *keys\fP, const size_t\fI\ *key_length\fP, size_t\fI\ number_of_keys\fP, memcached_execute_fn\fI\ *callback\fP, void\fI\ *context\fP, uint32_t\fI\ number_of_callbacks\fP)
+.B memcached_return_t memcached_mget_execute_by_key(memcached_st\fI\ *ptr\fP, const char\fI\ *group_key\fP, size_t\fI\ group_key_length\fP, const char * const\fI\ *keys\fP, const size_t\fI\ *key_length\fP, size_t\fI\ number_of_keys\fP, \fI\%memcached_execute_fn\fP\fI\ *callback\fP, void\fI\ *context\fP, uint32_t\fI\ number_of_callbacks\fP)
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_return_t (*memcached_execute_fn)(const memcached_st\fI\ *ptr\fP, memcached_result_st\fI\ *result\fP, void\fI\ *context\fP)
.UNINDENT
.sp
Compile and link with \-lmemcached
three pointer variables which will give you the state of the returned
object. A \fBuint32_t\fP pointer to contain whatever flags you stored with the value, a \fBsize_t\fP pointer which will be filled with size of of the
object, and a \fBmemcached_return_t\fP pointer to hold any error. The
-object will be returned upon success and NULL will be returned on failure. \fBMEMCACHD_END\fP is returned by the *error value when all objects that have been found are returned. The final value upon \fBMEMCACHED_END\fP is null.
+object will be returned upon success and NULL will be returned on failure. \fBMEMCACHED_END\fP is returned by the *error value when all objects that have been found are returned. The final value upon \fBMEMCACHED_END\fP is null.
.sp
\fI\%memcached_fetch_result()\fP is used to return a \fBmemcached_result_st\fP structure from a memcached server. The result object is forward compatible
with changes to the server. For more information please refer to the
-.TH "MEMCACHED_FLUSH" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_FLUSH" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_flush \- libmemcached Documentation
.
#include <libmemcached/memcached.h>
.INDENT 0.0
.TP
-.B memcached_return_t memcached_flush (memcached_st *ptr, time_t expiration);
+.B memcached_return_t memcached_flush(memcached_st\fI\ *ptr\fP, time_t\fI\ expiration\fP)
.UNINDENT
.sp
Compile and link with \-lmemcached
.SH DESCRIPTION
.sp
-:c:func::\fImemcached_flush()\fP is used to wipe clean the contents of \fBmemcached\fP servers.
+:c:func::\fImemcached_flush\fP is used to wipe clean the contents of \fBmemcached\fP servers.
It will either do this immediately or expire the content based on the
expiration time passed to the method (a value of zero causes an immediate
flush). The operation is not atomic to multiple servers, just atomic to a
.sp
A value of type \fBmemcached_return_t\fP is returned
On success that value will be \fBMEMCACHED_SUCCESS\fP.
-Use \fBmemcached_strerror()\fP to translate this value to a printable string.
+Use \fBmemcached_strerror\fP to translate this value to a printable string.
.SH HOME
.sp
To find out more information please check:
-.TH "MEMCACHED_FLUSH_BUFFERS" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_FLUSH_BUFFERS" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_flush_buffers \- libmemcached Documentation
.
#include <libmemcached/memcached.h>
.INDENT 0.0
.TP
-.B memcached_return_t memcached_flush_buffers (memcached_st *ptr);
+.B memcached_return_t memcached_flush_buffers(memcached_st\fI\ *ptr\fP)
.UNINDENT
.sp
Compile and link with \-lmemcached
.SH DESCRIPTION
.sp
-\fBmemcached_flush_buffers()\fP is used in conjunction with
+\fI\%memcached_flush_buffers()\fP is used in conjunction with
\fBMEMCACHED_BEHAVIOR_BUFFER_REQUESTS\fP (see memcached_behavior(3)) to flush all buffers by sending the buffered commands to the server for processing.
.SH RETURN
.sp
-.TH "MEMCACHED_FREE" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_FREE" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_free \- libmemcached Documentation
.
#include <libmemcached/memcached.h>
.INDENT 0.0
.TP
-.B memcachd_st
+.B memcached_st
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_st* memcached_create(memcached_st\fI\ *ptr\fP)
+.B \fI\%memcached_st\fP* memcached_create(\fI\%memcached_st\fP\fI\ *ptr\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B void memcached_free(memcached_st\fI\ *ptr\fP)
+.B void memcached_free(\fI\%memcached_st\fP\fI\ *ptr\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_st* memcached_clone(memcached_st\fI\ *destination\fP, memcached_st\fI\ *source\fP)
+.B \fI\%memcached_st\fP* memcached_clone(\fI\%memcached_st\fP\fI\ *destination\fP, \fI\%memcached_st\fP\fI\ *source\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B void memcached_servers_reset(memcached_st)
+.B void memcached_servers_reset(\fI\%memcached_st\fP)
.UNINDENT
.sp
Compile and link with \-lmemcached
.SH DESCRIPTION
.sp
-\fI\%memcached_create()\fP is used to create a \fBmemcached_st\fP
+\fI\%memcached_create()\fP is used to create a \fI\%memcached_st\fP
structure that will then be used by other libmemcached(3) functions to
communicate with the server. You should either pass a statically declared
-\fBmemcached_st\fP to \fI\%memcached_create()\fP or
+\fI\%memcached_st\fP to \fI\%memcached_create()\fP or
a NULL. If a NULL passed in then a structure is allocated for you.
.sp
Please note, when you write new application use
-\fBmemcached_create_with_options()\fP over
+\fBmemcached()\fP over
\fI\%memcached_create()\fP.
.sp
\fI\%memcached_clone()\fP is similar to \fI\%memcached_create()\fP but
it copies the defaults and list of servers from the source
-\fBmemcached_st\fP. If you pass a null as the argument for the source
+\fI\%memcached_st\fP. If you pass a null as the argument for the source
to clone, it is the same as a call to \fI\%memcached_create()\fP.
-If the destination argument is NULL a \fBmemcached_st\fP will be allocated
+If the destination argument is NULL a \fI\%memcached_st\fP will be allocated
for you.
.sp
\fI\%memcached_servers_reset()\fP allows you to zero out the list of
-servers that the \fBmemcached_st\fP has.
+servers that the \fI\%memcached_st\fP has.
.sp
-To clean up memory associated with a \fBmemcached_st\fP structure you
+To clean up memory associated with a \fI\%memcached_st\fP structure you
should pass it to \fI\%memcached_free()\fP when you are finished using it.
\fI\%memcached_free()\fP is the only way to make sure all memory is
deallocated when you finish using the structure.
heap allocated structures.
.SH RETURN
.sp
-\fI\%memcached_create()\fP returns a pointer to the \fBmemcached_st\fP
+\fI\%memcached_create()\fP returns a pointer to the \fI\%memcached_st\fP
that was created (or initialized). On an allocation failure, it returns NULL.
.sp
-\fI\%memcached_clone()\fP returns a pointer to the \fBmemcached_st\fP
+\fI\%memcached_clone()\fP returns a pointer to the \fI\%memcached_st\fP
that was created (or initialized). On an allocation failure, it returns NULL.
.SH HOME
.sp
-.TH "MEMCACHED_GENERATE_HASH" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_GENERATE_HASH" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_generate_hash \- Generating hash values directly
.
#include <libmemcached/memcached.h>
.INDENT 0.0
.TP
-.B uint32_t memcached_generate_hash_value (const char *key, size_t key_length, memcached_hash_t hash_algorithm);
+.B memcached_hash_t
.UNINDENT
.INDENT 0.0
.TP
-.B uint32_t memcached_generate_hash (memcached_st *ptr, const char *key, size_t key_length);
+.B uint32_t memcached_generate_hash_value(const char\fI\ *key\fP, size_t\fI\ key_length\fP, \fI\%memcached_hash_t\fP\fI\ hash_algorithm\fP)
+.UNINDENT
+.INDENT 0.0
+.TP
+.B uint32_t memcached_generate_hash(memcached_st\fI\ *ptr\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP)
+.UNINDENT
+.INDENT 0.0
+.TP
+.B MEMCACHED_HASH_DEFAULT
+.UNINDENT
+.INDENT 0.0
+.TP
+.B MEMCACHED_HASH_MD5
+.UNINDENT
+.INDENT 0.0
+.TP
+.B MEMCACHED_HASH_CRC
+.UNINDENT
+.INDENT 0.0
+.TP
+.B MEMCACHED_HASH_FNV1_64
+.UNINDENT
+.INDENT 0.0
+.TP
+.B MEMCACHED_HASH_FNV1A_64
+.UNINDENT
+.INDENT 0.0
+.TP
+.B MEMCACHED_HASH_FNV1_32
+.UNINDENT
+.INDENT 0.0
+.TP
+.B MEMCACHED_HASH_FNV1A_32
+.UNINDENT
+.INDENT 0.0
+.TP
+.B MEMCACHED_HASH_JENKINS
+.UNINDENT
+.INDENT 0.0
+.TP
+.B MEMCACHED_HASH_MURMUR
+.UNINDENT
+.INDENT 0.0
+.TP
+.B MEMCACHED_HASH_HSIEH
.UNINDENT
.sp
Compile and link with \-lmemcachedutil \-lmemcached
.SH DESCRIPTION
.sp
-\fBmemcached_generate_hash_value()\fP allows you to hash a key using one of
+\fI\%memcached_generate_hash_value()\fP allows you to hash a key using one of
the hash functions defined in the library. This method is provided for
the convenience of higher\-level language bindings and is not necessary
for normal memcache operations.
The allowed hash algorithm constants are listed in the manpage for
\fBmemcached_behavior_set()\fP.
.sp
-\fBmemcached_generate_hash()\fP takes a \fBmemcached_st\fP struture
+\fI\%memcached_generate_hash()\fP takes a \fBmemcached_st\fP struture
and produces the hash value that would have been generated based on the
-defaults of the \fBmemcached_st structure\fP.
+defaults of \fBmemcached_st\fP.
.sp
As of version 0.36 all hash methods have been placed into the library
libhashkit(3) which is linked with libmemcached(3). For more information please see its documentation.
-.TH "MEMCACHED_GENERATE_HASH_VALUE" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_GENERATE_HASH_VALUE" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_generate_hash_value \- Generating hash values directly
.
#include <libmemcached/memcached.h>
.INDENT 0.0
.TP
-.B uint32_t memcached_generate_hash_value (const char *key, size_t key_length, memcached_hash_t hash_algorithm);
+.B memcached_hash_t
.UNINDENT
.INDENT 0.0
.TP
-.B uint32_t memcached_generate_hash (memcached_st *ptr, const char *key, size_t key_length);
+.B uint32_t memcached_generate_hash_value(const char\fI\ *key\fP, size_t\fI\ key_length\fP, \fI\%memcached_hash_t\fP\fI\ hash_algorithm\fP)
+.UNINDENT
+.INDENT 0.0
+.TP
+.B uint32_t memcached_generate_hash(memcached_st\fI\ *ptr\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP)
+.UNINDENT
+.INDENT 0.0
+.TP
+.B MEMCACHED_HASH_DEFAULT
+.UNINDENT
+.INDENT 0.0
+.TP
+.B MEMCACHED_HASH_MD5
+.UNINDENT
+.INDENT 0.0
+.TP
+.B MEMCACHED_HASH_CRC
+.UNINDENT
+.INDENT 0.0
+.TP
+.B MEMCACHED_HASH_FNV1_64
+.UNINDENT
+.INDENT 0.0
+.TP
+.B MEMCACHED_HASH_FNV1A_64
+.UNINDENT
+.INDENT 0.0
+.TP
+.B MEMCACHED_HASH_FNV1_32
+.UNINDENT
+.INDENT 0.0
+.TP
+.B MEMCACHED_HASH_FNV1A_32
+.UNINDENT
+.INDENT 0.0
+.TP
+.B MEMCACHED_HASH_JENKINS
+.UNINDENT
+.INDENT 0.0
+.TP
+.B MEMCACHED_HASH_MURMUR
+.UNINDENT
+.INDENT 0.0
+.TP
+.B MEMCACHED_HASH_HSIEH
.UNINDENT
.sp
Compile and link with \-lmemcachedutil \-lmemcached
.SH DESCRIPTION
.sp
-\fBmemcached_generate_hash_value()\fP allows you to hash a key using one of
+\fI\%memcached_generate_hash_value()\fP allows you to hash a key using one of
the hash functions defined in the library. This method is provided for
the convenience of higher\-level language bindings and is not necessary
for normal memcache operations.
The allowed hash algorithm constants are listed in the manpage for
\fBmemcached_behavior_set()\fP.
.sp
-\fBmemcached_generate_hash()\fP takes a \fBmemcached_st\fP struture
+\fI\%memcached_generate_hash()\fP takes a \fBmemcached_st\fP struture
and produces the hash value that would have been generated based on the
-defaults of the \fBmemcached_st structure\fP.
+defaults of \fBmemcached_st\fP.
.sp
As of version 0.36 all hash methods have been placed into the library
libhashkit(3) which is linked with libmemcached(3). For more information please see its documentation.
-.TH "MEMCACHED_GET" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_GET" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_get \- Retrieving data from the server
.
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_fetch_execute(memcached_st\fI\ *ptr\fP, memcached_execute_fn\fI\ *callback\fP, void\fI\ *context\fP, uint32_t\fI\ number_of_callbacks\fP)
+.B memcached_return_t memcached_fetch_execute(memcached_st\fI\ *ptr\fP, \fI\%memcached_execute_fn\fP\fI\ *callback\fP, void\fI\ *context\fP, uint32_t\fI\ number_of_callbacks\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_mget_execute(memcached_st\fI\ *ptr\fP, const char * const\fI\ *keys\fP, const size_t\fI\ *key_length\fP, size_t\fI\ number_of_keys\fP, memcached_execute_fn\fI\ *callback\fP, void\fI\ *context\fP, uint32_t\fI\ number_of_callbacks\fP)
+.B memcached_return_t memcached_mget_execute(memcached_st\fI\ *ptr\fP, const char * const\fI\ *keys\fP, const size_t\fI\ *key_length\fP, size_t\fI\ number_of_keys\fP, \fI\%memcached_execute_fn\fP\fI\ *callback\fP, void\fI\ *context\fP, uint32_t\fI\ number_of_callbacks\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_mget_execute_by_key(memcached_st\fI\ *ptr\fP, const char\fI\ *group_key\fP, size_t\fI\ group_key_length\fP, const char * const\fI\ *keys\fP, const size_t\fI\ *key_length\fP, size_t\fI\ number_of_keys\fP, memcached_execute_fn\fI\ *callback\fP, void\fI\ *context\fP, uint32_t\fI\ number_of_callbacks\fP)
+.B memcached_return_t memcached_mget_execute_by_key(memcached_st\fI\ *ptr\fP, const char\fI\ *group_key\fP, size_t\fI\ group_key_length\fP, const char * const\fI\ *keys\fP, const size_t\fI\ *key_length\fP, size_t\fI\ number_of_keys\fP, \fI\%memcached_execute_fn\fP\fI\ *callback\fP, void\fI\ *context\fP, uint32_t\fI\ number_of_callbacks\fP)
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_return_t (*memcached_execute_fn)(const memcached_st\fI\ *ptr\fP, memcached_result_st\fI\ *result\fP, void\fI\ *context\fP)
.UNINDENT
.sp
Compile and link with \-lmemcached
three pointer variables which will give you the state of the returned
object. A \fBuint32_t\fP pointer to contain whatever flags you stored with the value, a \fBsize_t\fP pointer which will be filled with size of of the
object, and a \fBmemcached_return_t\fP pointer to hold any error. The
-object will be returned upon success and NULL will be returned on failure. \fBMEMCACHD_END\fP is returned by the *error value when all objects that have been found are returned. The final value upon \fBMEMCACHED_END\fP is null.
+object will be returned upon success and NULL will be returned on failure. \fBMEMCACHED_END\fP is returned by the *error value when all objects that have been found are returned. The final value upon \fBMEMCACHED_END\fP is null.
.sp
\fI\%memcached_fetch_result()\fP is used to return a \fBmemcached_result_st\fP structure from a memcached server. The result object is forward compatible
with changes to the server. For more information please refer to the
-.TH "MEMCACHED_GET_BY_KEY" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_GET_BY_KEY" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_get_by_key \- Retrieving data from the server
.
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_fetch_execute(memcached_st\fI\ *ptr\fP, memcached_execute_fn\fI\ *callback\fP, void\fI\ *context\fP, uint32_t\fI\ number_of_callbacks\fP)
+.B memcached_return_t memcached_fetch_execute(memcached_st\fI\ *ptr\fP, \fI\%memcached_execute_fn\fP\fI\ *callback\fP, void\fI\ *context\fP, uint32_t\fI\ number_of_callbacks\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_mget_execute(memcached_st\fI\ *ptr\fP, const char * const\fI\ *keys\fP, const size_t\fI\ *key_length\fP, size_t\fI\ number_of_keys\fP, memcached_execute_fn\fI\ *callback\fP, void\fI\ *context\fP, uint32_t\fI\ number_of_callbacks\fP)
+.B memcached_return_t memcached_mget_execute(memcached_st\fI\ *ptr\fP, const char * const\fI\ *keys\fP, const size_t\fI\ *key_length\fP, size_t\fI\ number_of_keys\fP, \fI\%memcached_execute_fn\fP\fI\ *callback\fP, void\fI\ *context\fP, uint32_t\fI\ number_of_callbacks\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_mget_execute_by_key(memcached_st\fI\ *ptr\fP, const char\fI\ *group_key\fP, size_t\fI\ group_key_length\fP, const char * const\fI\ *keys\fP, const size_t\fI\ *key_length\fP, size_t\fI\ number_of_keys\fP, memcached_execute_fn\fI\ *callback\fP, void\fI\ *context\fP, uint32_t\fI\ number_of_callbacks\fP)
+.B memcached_return_t memcached_mget_execute_by_key(memcached_st\fI\ *ptr\fP, const char\fI\ *group_key\fP, size_t\fI\ group_key_length\fP, const char * const\fI\ *keys\fP, const size_t\fI\ *key_length\fP, size_t\fI\ number_of_keys\fP, \fI\%memcached_execute_fn\fP\fI\ *callback\fP, void\fI\ *context\fP, uint32_t\fI\ number_of_callbacks\fP)
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_return_t (*memcached_execute_fn)(const memcached_st\fI\ *ptr\fP, memcached_result_st\fI\ *result\fP, void\fI\ *context\fP)
.UNINDENT
.sp
Compile and link with \-lmemcached
three pointer variables which will give you the state of the returned
object. A \fBuint32_t\fP pointer to contain whatever flags you stored with the value, a \fBsize_t\fP pointer which will be filled with size of of the
object, and a \fBmemcached_return_t\fP pointer to hold any error. The
-object will be returned upon success and NULL will be returned on failure. \fBMEMCACHD_END\fP is returned by the *error value when all objects that have been found are returned. The final value upon \fBMEMCACHED_END\fP is null.
+object will be returned upon success and NULL will be returned on failure. \fBMEMCACHED_END\fP is returned by the *error value when all objects that have been found are returned. The final value upon \fBMEMCACHED_END\fP is null.
.sp
\fI\%memcached_fetch_result()\fP is used to return a \fBmemcached_result_st\fP structure from a memcached server. The result object is forward compatible
with changes to the server. For more information please refer to the
-.TH "MEMCACHED_GET_MEMORY_ALLOCATORS" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_GET_MEMORY_ALLOCATORS" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_get_memory_allocators \- libmemcached Documentation
.
#include <libmemcached/memcached.h>
.INDENT 0.0
.TP
-.B memcached_return_t memcached_set_memory_allocators (memcached_st *ptr, memcached_malloc_fn mem_malloc, memcached_free_fn mem_free, memcached_realloc_fn mem_realloc, memcached_calloc_fn mem_calloc, void *context);
+.B memcached_return_t memcached_set_memory_allocators(memcached_st\fI\ *ptr\fP, \fI\%memcached_malloc_fn\fP\fI\ mem_malloc\fP, \fI\%memcached_free_fn\fP\fI\ mem_free\fP, \fI\%memcached_realloc_fn\fP\fI\ mem_realloc\fP, \fI\%memcached_calloc_fn\fP\fI\ mem_calloc\fP, void\fI\ *context\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B void memcached_get_memory_allocators (memcached_st *ptr, memcached_malloc_fn *mem_malloc, memcached_free_fn *mem_free, memcached_realloc_fn *mem_realloc, memcached_calloc_fn *mem_calloc);
+.B void memcached_get_memory_allocators(memcached_st\fI\ *ptr\fP, \fI\%memcached_malloc_fn\fP\fI\ *mem_malloc\fP, \fI\%memcached_free_fn\fP\fI\ *mem_free\fP, \fI\%memcached_realloc_fn\fP\fI\ *mem_realloc\fP, \fI\%memcached_calloc_fn\fP\fI\ *mem_calloc\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B void * memcached_get_memory_allocators_context(const memcached_st *ptr);
+.B void * memcached_get_memory_allocators_context(const memcached_st\fI\ *ptr\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B void * (*memcached_malloc_fn) (memcached_st *ptr, const size_t size, void *context);
+.B void * (*memcached_malloc_fn)(memcached_st\fI\ *ptr\fP, const size_t\fI\ size\fP, void\fI\ *context\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B void * (*memcached_realloc_fn) (memcached_st *ptr, void *mem, const size_t size, void *context);
+.B void * (*memcached_realloc_fn)(memcached_st\fI\ *ptr\fP, void\fI\ *mem\fP, const size_t\fI\ size\fP, void\fI\ *context\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B void (*memcached_free_fn) (memcached_st *ptr, void *mem, void *context);
+.B void (*memcached_free_fn)(memcached_st\fI\ *ptr\fP, void\fI\ *mem\fP, void\fI\ *context\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B void * (*memcached_calloc_fn) (memcached_st *ptr, size_t nelem, const size_t elsize, void *context);
+.B void * (*memcached_calloc_fn)(memcached_st\fI\ *ptr\fP, size_t\fI\ nelem\fP, const size_t\fI\ elsize\fP, void\fI\ *context\fP)
.UNINDENT
.sp
Compile and link with \-lmemcached
libmemcached(3) allows you to specify your own memory allocators, optimized
for your application. This enables libmemcached to be used inside of applications that have their own malloc implementation.
.sp
-\fBmemcached_set_memory_allocators()\fP is used to set the memory
+\fI\%memcached_set_memory_allocators()\fP is used to set the memory
allocators used by the memcached instance specified by ptr. Please note that
you cannot override only one of the memory allocators, you have to specify a
complete new set if you want to override one of them. All of the memory
allocation functions should behave as specified in the C99 standard. Specify
NULL as all functions to reset them to the default values.
.sp
-\fBmemcached_get_memory_allocators()\fP is used to get the currently used
+\fI\%memcached_get_memory_allocators()\fP is used to get the currently used
memory allocators by a mamcached handle.
.sp
-\fBmemcached_get_memory_allocators_context()\fP returns the void * that
-was passed in during the call to \fBmemcached_set_memory_allocators()\fP.
+\fI\%memcached_get_memory_allocators_context()\fP returns the void * that
+was passed in during the call to \fI\%memcached_set_memory_allocators()\fP.
.sp
The first argument to the memory allocator functions is a pointer to a
memcached structure, the is passed as const and you will need to clone
own space for memory.
.SH RETURN
.sp
-\fBmemcached_set_memory_allocators()\fP return \fBMEMCACHED_SUCCESS\fP
+\fI\%memcached_set_memory_allocators()\fP return \fBMEMCACHED_SUCCESS\fP
upon success, and \fBMEMCACHED_FAILURE\fP if you don\(aqt pass a complete set
of function pointers.
.SH HOME
-.TH "MEMCACHED_GET_SASL_CALLBACKS" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_GET_SASL_CALLBACKS" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_get_sasl_callbacks \- libmemcached Documentation
.
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return memcached_set_sasl_auth_data(memcached_st\fI\ *ptr\fP, const char\fI\ *username\fP, const char\fI\ *password\fP)
+.B memcached_return_t memcached_set_sasl_auth_data(memcached_st\fI\ *ptr\fP, const char\fI\ *username\fP, const char\fI\ *password\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return memcached_destroy_sasl_auth_data(memcached_st\fI\ *ptr\fP)
+.B memcached_return_t memcached_destroy_sasl_auth_data(memcached_st\fI\ *ptr\fP)
.UNINDENT
.sp
Compile and link with \-lmemcached
\fBmemcached_free\fP to avoid a memory leak. You should NOT call
\fI\%memcached_destroy_sasl_auth_data\fP if you specify your own callback
function with \fI\%memcached_set_sasl_callbacks()\fP.
-.sp
-You as a client user have to initialize libsasl by using \fBsasl_client_init\fP before enabling it in libmemcached, and you have to shut down libsasl by
-calling \fBsasl_done()\fP when you are done using SASL from libmemcached.
.SH RETURN
.sp
-\fI\%memcached_get_sasl_callbacks()\fP returns the callbacks currently used
-by this memcached handle. \fBmemcached_get_sasl_set_auth_data()\fP returns \fBMEMCACHED_SUCCESS\fP upon success.
+\fI\%memcached_get_sasl_callbacks()\fP returns the callbacks currently used by
+this memcached handle. \fI\%memcached_set_sasl_auth_data()\fP returns
+\fBMEMCACHED_SUCCESS\fP upon success.
.SH HOME
.sp
To find out more information please check:
-.TH "MEMCACHED_GET_USER_DATA" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_GET_USER_DATA" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_get_user_data \- libmemcached Documentation
.
.sp
.nf
.ft C
-#include <libmemcached/memcached.h>
-
-void *memcached_get_user_data (memcached_st *ptr);
-void *memcached_set_user_data (memcached_st *ptr, void *data);
.ft P
.fi
+.sp
+#include <libmemcached/memcached.h>
+.INDENT 0.0
+.TP
+.B void *memcached_get_user_data(memcached_st\fI\ *ptr\fP)
+.UNINDENT
+.INDENT 0.0
+.TP
+.B void *memcached_set_user_data(memcached_st\fI\ *ptr\fP, void\fI\ *data\fP)
+.UNINDENT
+.sp
+Compile and link with \-lmemcached
.SH DESCRIPTION
.sp
libmemcached(3) allows you to store a pointer to a user specific data inside
the memcached_st structure.
.sp
-\fBmemcached_set_user_data()\fP is used to set the user specific data in the
+\fI\%memcached_set_user_data()\fP is used to set the user specific data in the
\fBmemcached_st\fP structure.
.sp
-\fBmemcached_get_user_data()\fP is used to retrieve the user specific data in the \fBmemcached_st\fP structure.
+\fI\%memcached_get_user_data()\fP is used to retrieve the user specific data in the \fBmemcached_st\fP structure.
.SH RETURN
.sp
-\fBmemcached_set_user_data()\fP returns the previous value of the user specific data.
+\fI\%memcached_set_user_data()\fP returns the previous value of the user specific data.
.sp
-\fBmemcached_get_user_data()\fP returns the current value uf the user specific data.
+\fI\%memcached_get_user_data()\fP returns the current value uf the user specific data.
.SH HOME
.sp
To find out more information please check:
-.TH "MEMCACHED_INCREMENT" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_INCREMENT" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_increment \- Incrementing and Decrementing Values
.
#include <libmemcached/memcached.h>
.INDENT 0.0
.TP
-.B memcached_return_t memcached_increment (memcached_st *ptr, const char *key, size_t key_length, unsigned int offset, uint64_t *value);
+.B memcached_return_t memcached_increment(memcached_st\fI\ *ptr\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, uint32_t\fI\ offset\fP, uint64_t\fI\ *value\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_decrement (memcached_st *ptr, const char *key, size_t key_length, unsigned int offset, uint64_t *value);
+.B memcached_return_t memcached_decrement(memcached_st\fI\ *ptr\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, uint32_t\fI\ offset\fP, uint64_t\fI\ *value\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_increment_with_initial (memcached_st *ptr, const char *key, size_t key_length, uint64_t offset, uint64_t initial, time_t expiration, uint64_t *value);
+.B memcached_return_t memcached_increment_with_initial(memcached_st\fI\ *ptr\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, uint64_t\fI\ offset\fP, uint64_t\fI\ initial\fP, time_t\fI\ expiration\fP, uint64_t\fI\ *value\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_decrement_with_initial (memcached_st *ptr, const char *key, size_t key_length, uint64_t offset, uint64_t initial, time_t expiration, uint64_t *value);
+.B memcached_return_t memcached_decrement_with_initial(memcached_st\fI\ *ptr\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, uint64_t\fI\ offset\fP, uint64_t\fI\ initial\fP, time_t\fI\ expiration\fP, uint64_t\fI\ *value\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_increment_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, unsigned int offset, uint64_t *value);
+.B memcached_return_t memcached_increment_by_key(memcached_st\fI\ *ptr\fP, const char\fI\ *group_key\fP, size_t\fI\ group_key_length\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, uint32_t\fI\ offset\fP, uint64_t\fI\ *value\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_decrement_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, unsigned int offset, uint64_t *value);
+.B memcached_return_t memcached_decrement_by_key(memcached_st\fI\ *ptr\fP, const char\fI\ *group_key\fP, size_t\fI\ group_key_length\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, uint32_t\fI\ offset\fP, uint64_t\fI\ *value\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_increment_with_initial_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, uint64_t offset, uint64_t initial, time_t expiration, uint64_t *value);
+.B memcached_return_t memcached_increment_with_initial_by_key(memcached_st\fI\ *ptr\fP, const char\fI\ *group_key\fP, size_t\fI\ group_key_length\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, uint64_t\fI\ offset\fP, uint64_t\fI\ initial\fP, time_t\fI\ expiration\fP, uint64_t\fI\ *value\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_decrement_with_initial_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, uint64_t offset, uint64_t initial, time_t expiration, uint64_t *value);
+.B memcached_return_t memcached_decrement_with_initial_by_key(memcached_st\fI\ *ptr\fP, const char\fI\ *group_key\fP, size_t\fI\ group_key_length\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, uint64_t\fI\ offset\fP, uint64_t\fI\ initial\fP, time_t\fI\ expiration\fP, uint64_t\fI\ *value\fP)
.UNINDENT
.sp
Compile and link with \-lmemcached
(overflow and underflow are not detected). This gives you the ability to use
memcached to generate shared sequences of values.
.sp
-memcached_increment() takes a key and keylength and increments the value by
-the offset passed to it. The value is then returned via the unsigned int
+memcached_increment takes a key and keylength and increments the value by
+the offset passed to it. The value is then returned via the uint32_t
value pointer you pass to it.
.sp
-memcached_decrement() takes a key and keylength and decrements the value by
-the offset passed to it. The value is then returned via the unsigned int
+memcached_decrement takes a key and keylength and decrements the value by
+the offset passed to it. The value is then returned via the uint32_t
value pointer you pass to it.
.sp
-memcached_increment_with_initial() takes a key and keylength and increments
+memcached_increment_with_initial takes a key and keylength and increments
the value by the offset passed to it. If the object specified by key does
not exist, one of two things may happen: If the expiration value is
MEMCACHED_EXPIRATION_NOT_ADD, the operation will fail. For all other
expiration values, the operation will succeed by seeding the value for that
key with a initial value to expire with the provided expiration time. The
-flags will be set to zero.The value is then returned via the unsigned int
+flags will be set to zero.The value is then returned via the uint32_t
value pointer you pass to it.
.sp
-memcached_decrement_with_initial() takes a key and keylength and decrements
+memcached_decrement_with_initial takes a key and keylength and decrements
the value by the offset passed to it. If the object specified by key does
not exist, one of two things may happen: If the expiration value is
MEMCACHED_EXPIRATION_NOT_ADD, the operation will fail. For all other
expiration values, the operation will succeed by seeding the value for that
key with a initial value to expire with the provided expiration time. The
-flags will be set to zero.The value is then returned via the unsigned int
+flags will be set to zero.The value is then returned via the uint32_t
value pointer you pass to it.
.sp
-memcached_increment_by_key(), memcached_decrement_by_key(),
-memcached_increment_with_initial_by_key(), and
-memcached_decrement_with_initial_by_key() are master key equivalents of the
-above.
+\fI\%memcached_increment_by_key()\fP, \fI\%memcached_decrement_by_key()\fP,
+\fI\%memcached_increment_with_initial_by_key()\fP, and
+\fI\%memcached_decrement_with_initial_by_key()\fP are master key equivalents of the above.
.SH RETURN
.sp
-A value of type \fBmemcached_return_t\fP is returned.
+A value of type \fBmemcached_return_t\fP is returned.
On success that value will be \fBMEMCACHED_SUCCESS\fP.
-Use memcached_strerror() to translate this value to a printable string.
+Use memcached_strerror to translate this value to a printable string.
.SH HOME
.sp
To find out more information please check:
-.TH "MEMCACHED_INCREMENT_WITH_INITIAL" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_INCREMENT_WITH_INITIAL" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_increment_with_initial \- Incrementing and Decrementing Values
.
#include <libmemcached/memcached.h>
.INDENT 0.0
.TP
-.B memcached_return_t memcached_increment (memcached_st *ptr, const char *key, size_t key_length, unsigned int offset, uint64_t *value);
+.B memcached_return_t memcached_increment(memcached_st\fI\ *ptr\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, uint32_t\fI\ offset\fP, uint64_t\fI\ *value\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_decrement (memcached_st *ptr, const char *key, size_t key_length, unsigned int offset, uint64_t *value);
+.B memcached_return_t memcached_decrement(memcached_st\fI\ *ptr\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, uint32_t\fI\ offset\fP, uint64_t\fI\ *value\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_increment_with_initial (memcached_st *ptr, const char *key, size_t key_length, uint64_t offset, uint64_t initial, time_t expiration, uint64_t *value);
+.B memcached_return_t memcached_increment_with_initial(memcached_st\fI\ *ptr\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, uint64_t\fI\ offset\fP, uint64_t\fI\ initial\fP, time_t\fI\ expiration\fP, uint64_t\fI\ *value\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_decrement_with_initial (memcached_st *ptr, const char *key, size_t key_length, uint64_t offset, uint64_t initial, time_t expiration, uint64_t *value);
+.B memcached_return_t memcached_decrement_with_initial(memcached_st\fI\ *ptr\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, uint64_t\fI\ offset\fP, uint64_t\fI\ initial\fP, time_t\fI\ expiration\fP, uint64_t\fI\ *value\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_increment_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, unsigned int offset, uint64_t *value);
+.B memcached_return_t memcached_increment_by_key(memcached_st\fI\ *ptr\fP, const char\fI\ *group_key\fP, size_t\fI\ group_key_length\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, uint32_t\fI\ offset\fP, uint64_t\fI\ *value\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_decrement_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, unsigned int offset, uint64_t *value);
+.B memcached_return_t memcached_decrement_by_key(memcached_st\fI\ *ptr\fP, const char\fI\ *group_key\fP, size_t\fI\ group_key_length\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, uint32_t\fI\ offset\fP, uint64_t\fI\ *value\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_increment_with_initial_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, uint64_t offset, uint64_t initial, time_t expiration, uint64_t *value);
+.B memcached_return_t memcached_increment_with_initial_by_key(memcached_st\fI\ *ptr\fP, const char\fI\ *group_key\fP, size_t\fI\ group_key_length\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, uint64_t\fI\ offset\fP, uint64_t\fI\ initial\fP, time_t\fI\ expiration\fP, uint64_t\fI\ *value\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_decrement_with_initial_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, uint64_t offset, uint64_t initial, time_t expiration, uint64_t *value);
+.B memcached_return_t memcached_decrement_with_initial_by_key(memcached_st\fI\ *ptr\fP, const char\fI\ *group_key\fP, size_t\fI\ group_key_length\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, uint64_t\fI\ offset\fP, uint64_t\fI\ initial\fP, time_t\fI\ expiration\fP, uint64_t\fI\ *value\fP)
.UNINDENT
.sp
Compile and link with \-lmemcached
(overflow and underflow are not detected). This gives you the ability to use
memcached to generate shared sequences of values.
.sp
-memcached_increment() takes a key and keylength and increments the value by
-the offset passed to it. The value is then returned via the unsigned int
+memcached_increment takes a key and keylength and increments the value by
+the offset passed to it. The value is then returned via the uint32_t
value pointer you pass to it.
.sp
-memcached_decrement() takes a key and keylength and decrements the value by
-the offset passed to it. The value is then returned via the unsigned int
+memcached_decrement takes a key and keylength and decrements the value by
+the offset passed to it. The value is then returned via the uint32_t
value pointer you pass to it.
.sp
-memcached_increment_with_initial() takes a key and keylength and increments
+memcached_increment_with_initial takes a key and keylength and increments
the value by the offset passed to it. If the object specified by key does
not exist, one of two things may happen: If the expiration value is
MEMCACHED_EXPIRATION_NOT_ADD, the operation will fail. For all other
expiration values, the operation will succeed by seeding the value for that
key with a initial value to expire with the provided expiration time. The
-flags will be set to zero.The value is then returned via the unsigned int
+flags will be set to zero.The value is then returned via the uint32_t
value pointer you pass to it.
.sp
-memcached_decrement_with_initial() takes a key and keylength and decrements
+memcached_decrement_with_initial takes a key and keylength and decrements
the value by the offset passed to it. If the object specified by key does
not exist, one of two things may happen: If the expiration value is
MEMCACHED_EXPIRATION_NOT_ADD, the operation will fail. For all other
expiration values, the operation will succeed by seeding the value for that
key with a initial value to expire with the provided expiration time. The
-flags will be set to zero.The value is then returned via the unsigned int
+flags will be set to zero.The value is then returned via the uint32_t
value pointer you pass to it.
.sp
-memcached_increment_by_key(), memcached_decrement_by_key(),
-memcached_increment_with_initial_by_key(), and
-memcached_decrement_with_initial_by_key() are master key equivalents of the
-above.
+\fI\%memcached_increment_by_key()\fP, \fI\%memcached_decrement_by_key()\fP,
+\fI\%memcached_increment_with_initial_by_key()\fP, and
+\fI\%memcached_decrement_with_initial_by_key()\fP are master key equivalents of the above.
.SH RETURN
.sp
-A value of type \fBmemcached_return_t\fP is returned.
+A value of type \fBmemcached_return_t\fP is returned.
On success that value will be \fBMEMCACHED_SUCCESS\fP.
-Use memcached_strerror() to translate this value to a printable string.
+Use memcached_strerror to translate this value to a printable string.
.SH HOME
.sp
To find out more information please check:
-.TH "MEMCACHED_LAST_ERROR_MESSAGE" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_LAST_ERROR_MESSAGE" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_last_error_message \- libmemcached Documentation
.
#include <libmemcached/memcached.h>
.INDENT 0.0
.TP
-.B const char *memcached_last_error_message(memcached_st *);
+.B const char *memcached_last_error_message(memcached_st\fI\ *\fP)
.UNINDENT
.sp
Compile and link with \-lmemcached
.SH DESCRIPTION
.sp
-\fBmemcached_last_error_message()\fP is used to return the last error
+\fI\%memcached_last_error_message()\fP is used to return the last error
message that the server responded too. If this error came from a specific
server, its hostname and port will be provided in the error message.
.SH RETURN
.sp
-memcached_last_error_message() returns a const char* which does not need to be
+memcached_last_error_message returns a const char* which does not need to be
de\-allocated. If no error has occurred then it will return NULL.
.SH HOME
.sp
-.TH "MEMCACHED_LIB_VERSION" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_LIB_VERSION" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_lib_version \- libmemcached Documentation
.
.sp
\fI\%memcached_lib_version()\fP returns a string with the version of the libmemcached driver.
.sp
-A value of \fBmemcached_return_t\fP is returned from :c:func:\(aqmemcached_version()\(aq
+A value of \fBmemcached_return_t\fP is returned from :c:func:\(aqmemcached_version\(aq
.sp
On success that value will be \fBMEMCACHED_SUCCESS\fP.
.sp
-.TH "MEMCACHED_MEMORY_ALLOCATORS" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_MEMORY_ALLOCATORS" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_memory_allocators \- libmemcached Documentation
.
#include <libmemcached/memcached.h>
.INDENT 0.0
.TP
-.B memcached_return_t memcached_set_memory_allocators (memcached_st *ptr, memcached_malloc_fn mem_malloc, memcached_free_fn mem_free, memcached_realloc_fn mem_realloc, memcached_calloc_fn mem_calloc, void *context);
+.B memcached_return_t memcached_set_memory_allocators(memcached_st\fI\ *ptr\fP, \fI\%memcached_malloc_fn\fP\fI\ mem_malloc\fP, \fI\%memcached_free_fn\fP\fI\ mem_free\fP, \fI\%memcached_realloc_fn\fP\fI\ mem_realloc\fP, \fI\%memcached_calloc_fn\fP\fI\ mem_calloc\fP, void\fI\ *context\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B void memcached_get_memory_allocators (memcached_st *ptr, memcached_malloc_fn *mem_malloc, memcached_free_fn *mem_free, memcached_realloc_fn *mem_realloc, memcached_calloc_fn *mem_calloc);
+.B void memcached_get_memory_allocators(memcached_st\fI\ *ptr\fP, \fI\%memcached_malloc_fn\fP\fI\ *mem_malloc\fP, \fI\%memcached_free_fn\fP\fI\ *mem_free\fP, \fI\%memcached_realloc_fn\fP\fI\ *mem_realloc\fP, \fI\%memcached_calloc_fn\fP\fI\ *mem_calloc\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B void * memcached_get_memory_allocators_context(const memcached_st *ptr);
+.B void * memcached_get_memory_allocators_context(const memcached_st\fI\ *ptr\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B void * (*memcached_malloc_fn) (memcached_st *ptr, const size_t size, void *context);
+.B void * (*memcached_malloc_fn)(memcached_st\fI\ *ptr\fP, const size_t\fI\ size\fP, void\fI\ *context\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B void * (*memcached_realloc_fn) (memcached_st *ptr, void *mem, const size_t size, void *context);
+.B void * (*memcached_realloc_fn)(memcached_st\fI\ *ptr\fP, void\fI\ *mem\fP, const size_t\fI\ size\fP, void\fI\ *context\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B void (*memcached_free_fn) (memcached_st *ptr, void *mem, void *context);
+.B void (*memcached_free_fn)(memcached_st\fI\ *ptr\fP, void\fI\ *mem\fP, void\fI\ *context\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B void * (*memcached_calloc_fn) (memcached_st *ptr, size_t nelem, const size_t elsize, void *context);
+.B void * (*memcached_calloc_fn)(memcached_st\fI\ *ptr\fP, size_t\fI\ nelem\fP, const size_t\fI\ elsize\fP, void\fI\ *context\fP)
.UNINDENT
.sp
Compile and link with \-lmemcached
libmemcached(3) allows you to specify your own memory allocators, optimized
for your application. This enables libmemcached to be used inside of applications that have their own malloc implementation.
.sp
-\fBmemcached_set_memory_allocators()\fP is used to set the memory
+\fI\%memcached_set_memory_allocators()\fP is used to set the memory
allocators used by the memcached instance specified by ptr. Please note that
you cannot override only one of the memory allocators, you have to specify a
complete new set if you want to override one of them. All of the memory
allocation functions should behave as specified in the C99 standard. Specify
NULL as all functions to reset them to the default values.
.sp
-\fBmemcached_get_memory_allocators()\fP is used to get the currently used
+\fI\%memcached_get_memory_allocators()\fP is used to get the currently used
memory allocators by a mamcached handle.
.sp
-\fBmemcached_get_memory_allocators_context()\fP returns the void * that
-was passed in during the call to \fBmemcached_set_memory_allocators()\fP.
+\fI\%memcached_get_memory_allocators_context()\fP returns the void * that
+was passed in during the call to \fI\%memcached_set_memory_allocators()\fP.
.sp
The first argument to the memory allocator functions is a pointer to a
memcached structure, the is passed as const and you will need to clone
own space for memory.
.SH RETURN
.sp
-\fBmemcached_set_memory_allocators()\fP return \fBMEMCACHED_SUCCESS\fP
+\fI\%memcached_set_memory_allocators()\fP return \fBMEMCACHED_SUCCESS\fP
upon success, and \fBMEMCACHED_FAILURE\fP if you don\(aqt pass a complete set
of function pointers.
.SH HOME
-.TH "MEMCACHED_MGET" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_MGET" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_mget \- Retrieving data from the server
.
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_fetch_execute(memcached_st\fI\ *ptr\fP, memcached_execute_fn\fI\ *callback\fP, void\fI\ *context\fP, uint32_t\fI\ number_of_callbacks\fP)
+.B memcached_return_t memcached_fetch_execute(memcached_st\fI\ *ptr\fP, \fI\%memcached_execute_fn\fP\fI\ *callback\fP, void\fI\ *context\fP, uint32_t\fI\ number_of_callbacks\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_mget_execute(memcached_st\fI\ *ptr\fP, const char * const\fI\ *keys\fP, const size_t\fI\ *key_length\fP, size_t\fI\ number_of_keys\fP, memcached_execute_fn\fI\ *callback\fP, void\fI\ *context\fP, uint32_t\fI\ number_of_callbacks\fP)
+.B memcached_return_t memcached_mget_execute(memcached_st\fI\ *ptr\fP, const char * const\fI\ *keys\fP, const size_t\fI\ *key_length\fP, size_t\fI\ number_of_keys\fP, \fI\%memcached_execute_fn\fP\fI\ *callback\fP, void\fI\ *context\fP, uint32_t\fI\ number_of_callbacks\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_mget_execute_by_key(memcached_st\fI\ *ptr\fP, const char\fI\ *group_key\fP, size_t\fI\ group_key_length\fP, const char * const\fI\ *keys\fP, const size_t\fI\ *key_length\fP, size_t\fI\ number_of_keys\fP, memcached_execute_fn\fI\ *callback\fP, void\fI\ *context\fP, uint32_t\fI\ number_of_callbacks\fP)
+.B memcached_return_t memcached_mget_execute_by_key(memcached_st\fI\ *ptr\fP, const char\fI\ *group_key\fP, size_t\fI\ group_key_length\fP, const char * const\fI\ *keys\fP, const size_t\fI\ *key_length\fP, size_t\fI\ number_of_keys\fP, \fI\%memcached_execute_fn\fP\fI\ *callback\fP, void\fI\ *context\fP, uint32_t\fI\ number_of_callbacks\fP)
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_return_t (*memcached_execute_fn)(const memcached_st\fI\ *ptr\fP, memcached_result_st\fI\ *result\fP, void\fI\ *context\fP)
.UNINDENT
.sp
Compile and link with \-lmemcached
three pointer variables which will give you the state of the returned
object. A \fBuint32_t\fP pointer to contain whatever flags you stored with the value, a \fBsize_t\fP pointer which will be filled with size of of the
object, and a \fBmemcached_return_t\fP pointer to hold any error. The
-object will be returned upon success and NULL will be returned on failure. \fBMEMCACHD_END\fP is returned by the *error value when all objects that have been found are returned. The final value upon \fBMEMCACHED_END\fP is null.
+object will be returned upon success and NULL will be returned on failure. \fBMEMCACHED_END\fP is returned by the *error value when all objects that have been found are returned. The final value upon \fBMEMCACHED_END\fP is null.
.sp
\fI\%memcached_fetch_result()\fP is used to return a \fBmemcached_result_st\fP structure from a memcached server. The result object is forward compatible
with changes to the server. For more information please refer to the
-.TH "MEMCACHED_MGET_BY_KEY" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_MGET_BY_KEY" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_mget_by_key \- Retrieving data from the server
.
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_fetch_execute(memcached_st\fI\ *ptr\fP, memcached_execute_fn\fI\ *callback\fP, void\fI\ *context\fP, uint32_t\fI\ number_of_callbacks\fP)
+.B memcached_return_t memcached_fetch_execute(memcached_st\fI\ *ptr\fP, \fI\%memcached_execute_fn\fP\fI\ *callback\fP, void\fI\ *context\fP, uint32_t\fI\ number_of_callbacks\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_mget_execute(memcached_st\fI\ *ptr\fP, const char * const\fI\ *keys\fP, const size_t\fI\ *key_length\fP, size_t\fI\ number_of_keys\fP, memcached_execute_fn\fI\ *callback\fP, void\fI\ *context\fP, uint32_t\fI\ number_of_callbacks\fP)
+.B memcached_return_t memcached_mget_execute(memcached_st\fI\ *ptr\fP, const char * const\fI\ *keys\fP, const size_t\fI\ *key_length\fP, size_t\fI\ number_of_keys\fP, \fI\%memcached_execute_fn\fP\fI\ *callback\fP, void\fI\ *context\fP, uint32_t\fI\ number_of_callbacks\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_mget_execute_by_key(memcached_st\fI\ *ptr\fP, const char\fI\ *group_key\fP, size_t\fI\ group_key_length\fP, const char * const\fI\ *keys\fP, const size_t\fI\ *key_length\fP, size_t\fI\ number_of_keys\fP, memcached_execute_fn\fI\ *callback\fP, void\fI\ *context\fP, uint32_t\fI\ number_of_callbacks\fP)
+.B memcached_return_t memcached_mget_execute_by_key(memcached_st\fI\ *ptr\fP, const char\fI\ *group_key\fP, size_t\fI\ group_key_length\fP, const char * const\fI\ *keys\fP, const size_t\fI\ *key_length\fP, size_t\fI\ number_of_keys\fP, \fI\%memcached_execute_fn\fP\fI\ *callback\fP, void\fI\ *context\fP, uint32_t\fI\ number_of_callbacks\fP)
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_return_t (*memcached_execute_fn)(const memcached_st\fI\ *ptr\fP, memcached_result_st\fI\ *result\fP, void\fI\ *context\fP)
.UNINDENT
.sp
Compile and link with \-lmemcached
three pointer variables which will give you the state of the returned
object. A \fBuint32_t\fP pointer to contain whatever flags you stored with the value, a \fBsize_t\fP pointer which will be filled with size of of the
object, and a \fBmemcached_return_t\fP pointer to hold any error. The
-object will be returned upon success and NULL will be returned on failure. \fBMEMCACHD_END\fP is returned by the *error value when all objects that have been found are returned. The final value upon \fBMEMCACHED_END\fP is null.
+object will be returned upon success and NULL will be returned on failure. \fBMEMCACHED_END\fP is returned by the *error value when all objects that have been found are returned. The final value upon \fBMEMCACHED_END\fP is null.
.sp
\fI\%memcached_fetch_result()\fP is used to return a \fBmemcached_result_st\fP structure from a memcached server. The result object is forward compatible
with changes to the server. For more information please refer to the
-.TH "MEMCACHED_MGET_EXECUTE" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_MGET_EXECUTE" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_mget_execute \- Retrieving data from the server
.
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_fetch_execute(memcached_st\fI\ *ptr\fP, memcached_execute_fn\fI\ *callback\fP, void\fI\ *context\fP, uint32_t\fI\ number_of_callbacks\fP)
+.B memcached_return_t memcached_fetch_execute(memcached_st\fI\ *ptr\fP, \fI\%memcached_execute_fn\fP\fI\ *callback\fP, void\fI\ *context\fP, uint32_t\fI\ number_of_callbacks\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_mget_execute(memcached_st\fI\ *ptr\fP, const char * const\fI\ *keys\fP, const size_t\fI\ *key_length\fP, size_t\fI\ number_of_keys\fP, memcached_execute_fn\fI\ *callback\fP, void\fI\ *context\fP, uint32_t\fI\ number_of_callbacks\fP)
+.B memcached_return_t memcached_mget_execute(memcached_st\fI\ *ptr\fP, const char * const\fI\ *keys\fP, const size_t\fI\ *key_length\fP, size_t\fI\ number_of_keys\fP, \fI\%memcached_execute_fn\fP\fI\ *callback\fP, void\fI\ *context\fP, uint32_t\fI\ number_of_callbacks\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_mget_execute_by_key(memcached_st\fI\ *ptr\fP, const char\fI\ *group_key\fP, size_t\fI\ group_key_length\fP, const char * const\fI\ *keys\fP, const size_t\fI\ *key_length\fP, size_t\fI\ number_of_keys\fP, memcached_execute_fn\fI\ *callback\fP, void\fI\ *context\fP, uint32_t\fI\ number_of_callbacks\fP)
+.B memcached_return_t memcached_mget_execute_by_key(memcached_st\fI\ *ptr\fP, const char\fI\ *group_key\fP, size_t\fI\ group_key_length\fP, const char * const\fI\ *keys\fP, const size_t\fI\ *key_length\fP, size_t\fI\ number_of_keys\fP, \fI\%memcached_execute_fn\fP\fI\ *callback\fP, void\fI\ *context\fP, uint32_t\fI\ number_of_callbacks\fP)
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_return_t (*memcached_execute_fn)(const memcached_st\fI\ *ptr\fP, memcached_result_st\fI\ *result\fP, void\fI\ *context\fP)
.UNINDENT
.sp
Compile and link with \-lmemcached
three pointer variables which will give you the state of the returned
object. A \fBuint32_t\fP pointer to contain whatever flags you stored with the value, a \fBsize_t\fP pointer which will be filled with size of of the
object, and a \fBmemcached_return_t\fP pointer to hold any error. The
-object will be returned upon success and NULL will be returned on failure. \fBMEMCACHD_END\fP is returned by the *error value when all objects that have been found are returned. The final value upon \fBMEMCACHED_END\fP is null.
+object will be returned upon success and NULL will be returned on failure. \fBMEMCACHED_END\fP is returned by the *error value when all objects that have been found are returned. The final value upon \fBMEMCACHED_END\fP is null.
.sp
\fI\%memcached_fetch_result()\fP is used to return a \fBmemcached_result_st\fP structure from a memcached server. The result object is forward compatible
with changes to the server. For more information please refer to the
-.TH "MEMCACHED_MGET_EXECUTE_BY_KEY" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_MGET_EXECUTE_BY_KEY" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_mget_execute_by_key \- Retrieving data from the server
.
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_fetch_execute(memcached_st\fI\ *ptr\fP, memcached_execute_fn\fI\ *callback\fP, void\fI\ *context\fP, uint32_t\fI\ number_of_callbacks\fP)
+.B memcached_return_t memcached_fetch_execute(memcached_st\fI\ *ptr\fP, \fI\%memcached_execute_fn\fP\fI\ *callback\fP, void\fI\ *context\fP, uint32_t\fI\ number_of_callbacks\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_mget_execute(memcached_st\fI\ *ptr\fP, const char * const\fI\ *keys\fP, const size_t\fI\ *key_length\fP, size_t\fI\ number_of_keys\fP, memcached_execute_fn\fI\ *callback\fP, void\fI\ *context\fP, uint32_t\fI\ number_of_callbacks\fP)
+.B memcached_return_t memcached_mget_execute(memcached_st\fI\ *ptr\fP, const char * const\fI\ *keys\fP, const size_t\fI\ *key_length\fP, size_t\fI\ number_of_keys\fP, \fI\%memcached_execute_fn\fP\fI\ *callback\fP, void\fI\ *context\fP, uint32_t\fI\ number_of_callbacks\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_mget_execute_by_key(memcached_st\fI\ *ptr\fP, const char\fI\ *group_key\fP, size_t\fI\ group_key_length\fP, const char * const\fI\ *keys\fP, const size_t\fI\ *key_length\fP, size_t\fI\ number_of_keys\fP, memcached_execute_fn\fI\ *callback\fP, void\fI\ *context\fP, uint32_t\fI\ number_of_callbacks\fP)
+.B memcached_return_t memcached_mget_execute_by_key(memcached_st\fI\ *ptr\fP, const char\fI\ *group_key\fP, size_t\fI\ group_key_length\fP, const char * const\fI\ *keys\fP, const size_t\fI\ *key_length\fP, size_t\fI\ number_of_keys\fP, \fI\%memcached_execute_fn\fP\fI\ *callback\fP, void\fI\ *context\fP, uint32_t\fI\ number_of_callbacks\fP)
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_return_t (*memcached_execute_fn)(const memcached_st\fI\ *ptr\fP, memcached_result_st\fI\ *result\fP, void\fI\ *context\fP)
.UNINDENT
.sp
Compile and link with \-lmemcached
three pointer variables which will give you the state of the returned
object. A \fBuint32_t\fP pointer to contain whatever flags you stored with the value, a \fBsize_t\fP pointer which will be filled with size of of the
object, and a \fBmemcached_return_t\fP pointer to hold any error. The
-object will be returned upon success and NULL will be returned on failure. \fBMEMCACHD_END\fP is returned by the *error value when all objects that have been found are returned. The final value upon \fBMEMCACHED_END\fP is null.
+object will be returned upon success and NULL will be returned on failure. \fBMEMCACHED_END\fP is returned by the *error value when all objects that have been found are returned. The final value upon \fBMEMCACHED_END\fP is null.
.sp
\fI\%memcached_fetch_result()\fP is used to return a \fBmemcached_result_st\fP structure from a memcached server. The result object is forward compatible
with changes to the server. For more information please refer to the
-.TH "MEMCACHED_POOL" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_POOL" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_pool \- libmemcached Documentation
.
.B memcached_st* memcached_pool_pop(\fI\%memcached_pool_st\fP*\fI\ pool\fP, bool\fI\ block\fP, memcached_return_t\fI\ *rc\fP)
.UNINDENT
.sp
-Deprecated since version 0.53: Use \fBmemcached_pool_fetch()\fP
+Deprecated since version 0.53: Use \fI\%memcached_pool_fetch()\fP
.INDENT 0.0
.TP
-.B memcached_st* memcached_pool_fetch(memcached_pool_st*, struct timespec* relative_time, memcached_return_t* rc);
+.B memcached_st* memcached_pool_fetch(\fI\%memcached_pool_st\fP*, struct timespec*\fI\ relative_time\fP, memcached_return_t*\fI\ rc\fP)
.UNINDENT
.sp
-New in version 0.53: Synonym for memcached_pool_pop()
+New in version 0.53: Synonym for memcached_pool_pop
.INDENT 0.0
.TP
.B memcached_return_t memcached_pool_push(\fI\%memcached_pool_st\fP*\fI\ pool\fP, memcached_st\fI\ *mmc\fP)
Deprecated since version 0.53: Use \fI\%memcached_pool_push()\fP
.INDENT 0.0
.TP
-.B memcached_return_t memcached_pool_release(memcached_pool_st* pool, memcached_st* mmc);
+.B memcached_return_t memcached_pool_release(\fI\%memcached_pool_st\fP*\fI\ pool\fP, memcached_st*\fI\ mmc\fP)
.UNINDENT
.sp
-New in version 0.53: Synonym for memcached_pool_push().
+New in version 0.53: Synonym for memcached_pool_push.
.INDENT 0.0
.TP
.B memcached_return_t memcached_pool_behavior_set(\fI\%memcached_pool_st\fP\fI\ *pool\fP, memcached_behavior_t\fI\ flag\fP, uint64_t\fI\ data\fP)
resources. It will return the pointer to the \fBmemcached_st\fP structure
passed as an argument to \fI\%memcached_pool_create()\fP, and returns the ownership of the pointer to the caller when created with \fI\%memcached_pool_create()\fP, otherwise NULL is returned..
.sp
-\fBmemcached_pool_fetch()\fP is used to fetch a connection structure from the
+\fI\%memcached_pool_fetch()\fP is used to fetch a connection structure from the
connection pool. The relative_time argument specifies if the function should
block and wait for a connection structure to be available if we try
to exceed the maximum size. You need to specify time in relative time.
.sp
-\fBmemcached_pool_release()\fP is used to return a connection structure back to the pool.
+\fI\%memcached_pool_release()\fP is used to return a connection structure back to the pool.
.sp
\fI\%memcached_pool_behavior_get()\fP and \fI\%memcached_pool_behavior_set()\fP is used to get/set behavior flags on all connections in the pool.
.sp
-Both \fBmemcached_pool_release()\fP and \fBmemcached_pool_fetch()\fP are thread safe.
+Both \fI\%memcached_pool_release()\fP and \fI\%memcached_pool_fetch()\fP are thread safe.
.SH RETURN
.sp
\fI\%memcached_pool_destroy()\fP returns the pointer (and ownership) to the \fBmemcached_st\fP structure used to create the pool. If connections are in use it returns NULL.
.sp
\fI\%memcached_pool_pop()\fP returns a pointer to a \fBmemcached_st\fP structure from the pool (or NULL if an allocation cannot be satisfied).
.sp
-\fBmemcached_pool_release()\fP returns \fBMEMCACHED_SUCCESS\fP upon success.
+\fI\%memcached_pool_release()\fP returns \fBMEMCACHED_SUCCESS\fP upon success.
.sp
\fI\%memcached_pool_behavior_get()\fP and \fI\%memcached_pool_behavior_get()\fP returns \fBMEMCACHED_SUCCESS\fP upon success.
.sp
If any methods returns MEMCACHED_IN_PROGRESS then a lock on the pool could not be obtained. If any of the parameters passed to any of these functions is invalid, MEMCACHED_INVALID_ARGUMENTS will be returned.
.sp
-memcached_pool_fetch() may return MEMCACHED_TIMEOUT if a timeout occurs while waiting for a free memcached_st. MEMCACHED_NOTFOUND if no memcached_st was available.
+memcached_pool_fetch may return MEMCACHED_TIMEOUT if a timeout occurs while waiting for a free memcached_st. MEMCACHED_NOTFOUND if no memcached_st was available.
.SH HOME
.sp
To find out more information please check:
-.TH "MEMCACHED_POOL_BEHAVIOR_GET" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_POOL_BEHAVIOR_GET" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_pool_behavior_get \- libmemcached Documentation
.
.B memcached_st* memcached_pool_pop(\fI\%memcached_pool_st\fP*\fI\ pool\fP, bool\fI\ block\fP, memcached_return_t\fI\ *rc\fP)
.UNINDENT
.sp
-Deprecated since version 0.53: Use \fBmemcached_pool_fetch()\fP
+Deprecated since version 0.53: Use \fI\%memcached_pool_fetch()\fP
.INDENT 0.0
.TP
-.B memcached_st* memcached_pool_fetch(memcached_pool_st*, struct timespec* relative_time, memcached_return_t* rc);
+.B memcached_st* memcached_pool_fetch(\fI\%memcached_pool_st\fP*, struct timespec*\fI\ relative_time\fP, memcached_return_t*\fI\ rc\fP)
.UNINDENT
.sp
-New in version 0.53: Synonym for memcached_pool_pop()
+New in version 0.53: Synonym for memcached_pool_pop
.INDENT 0.0
.TP
.B memcached_return_t memcached_pool_push(\fI\%memcached_pool_st\fP*\fI\ pool\fP, memcached_st\fI\ *mmc\fP)
Deprecated since version 0.53: Use \fI\%memcached_pool_push()\fP
.INDENT 0.0
.TP
-.B memcached_return_t memcached_pool_release(memcached_pool_st* pool, memcached_st* mmc);
+.B memcached_return_t memcached_pool_release(\fI\%memcached_pool_st\fP*\fI\ pool\fP, memcached_st*\fI\ mmc\fP)
.UNINDENT
.sp
-New in version 0.53: Synonym for memcached_pool_push().
+New in version 0.53: Synonym for memcached_pool_push.
.INDENT 0.0
.TP
.B memcached_return_t memcached_pool_behavior_set(\fI\%memcached_pool_st\fP\fI\ *pool\fP, memcached_behavior_t\fI\ flag\fP, uint64_t\fI\ data\fP)
resources. It will return the pointer to the \fBmemcached_st\fP structure
passed as an argument to \fI\%memcached_pool_create()\fP, and returns the ownership of the pointer to the caller when created with \fI\%memcached_pool_create()\fP, otherwise NULL is returned..
.sp
-\fBmemcached_pool_fetch()\fP is used to fetch a connection structure from the
+\fI\%memcached_pool_fetch()\fP is used to fetch a connection structure from the
connection pool. The relative_time argument specifies if the function should
block and wait for a connection structure to be available if we try
to exceed the maximum size. You need to specify time in relative time.
.sp
-\fBmemcached_pool_release()\fP is used to return a connection structure back to the pool.
+\fI\%memcached_pool_release()\fP is used to return a connection structure back to the pool.
.sp
\fI\%memcached_pool_behavior_get()\fP and \fI\%memcached_pool_behavior_set()\fP is used to get/set behavior flags on all connections in the pool.
.sp
-Both \fBmemcached_pool_release()\fP and \fBmemcached_pool_fetch()\fP are thread safe.
+Both \fI\%memcached_pool_release()\fP and \fI\%memcached_pool_fetch()\fP are thread safe.
.SH RETURN
.sp
\fI\%memcached_pool_destroy()\fP returns the pointer (and ownership) to the \fBmemcached_st\fP structure used to create the pool. If connections are in use it returns NULL.
.sp
\fI\%memcached_pool_pop()\fP returns a pointer to a \fBmemcached_st\fP structure from the pool (or NULL if an allocation cannot be satisfied).
.sp
-\fBmemcached_pool_release()\fP returns \fBMEMCACHED_SUCCESS\fP upon success.
+\fI\%memcached_pool_release()\fP returns \fBMEMCACHED_SUCCESS\fP upon success.
.sp
\fI\%memcached_pool_behavior_get()\fP and \fI\%memcached_pool_behavior_get()\fP returns \fBMEMCACHED_SUCCESS\fP upon success.
.sp
If any methods returns MEMCACHED_IN_PROGRESS then a lock on the pool could not be obtained. If any of the parameters passed to any of these functions is invalid, MEMCACHED_INVALID_ARGUMENTS will be returned.
.sp
-memcached_pool_fetch() may return MEMCACHED_TIMEOUT if a timeout occurs while waiting for a free memcached_st. MEMCACHED_NOTFOUND if no memcached_st was available.
+memcached_pool_fetch may return MEMCACHED_TIMEOUT if a timeout occurs while waiting for a free memcached_st. MEMCACHED_NOTFOUND if no memcached_st was available.
.SH HOME
.sp
To find out more information please check:
-.TH "MEMCACHED_POOL_BEHAVIOR_SET" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_POOL_BEHAVIOR_SET" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_pool_behavior_set \- libmemcached Documentation
.
.B memcached_st* memcached_pool_pop(\fI\%memcached_pool_st\fP*\fI\ pool\fP, bool\fI\ block\fP, memcached_return_t\fI\ *rc\fP)
.UNINDENT
.sp
-Deprecated since version 0.53: Use \fBmemcached_pool_fetch()\fP
+Deprecated since version 0.53: Use \fI\%memcached_pool_fetch()\fP
.INDENT 0.0
.TP
-.B memcached_st* memcached_pool_fetch(memcached_pool_st*, struct timespec* relative_time, memcached_return_t* rc);
+.B memcached_st* memcached_pool_fetch(\fI\%memcached_pool_st\fP*, struct timespec*\fI\ relative_time\fP, memcached_return_t*\fI\ rc\fP)
.UNINDENT
.sp
-New in version 0.53: Synonym for memcached_pool_pop()
+New in version 0.53: Synonym for memcached_pool_pop
.INDENT 0.0
.TP
.B memcached_return_t memcached_pool_push(\fI\%memcached_pool_st\fP*\fI\ pool\fP, memcached_st\fI\ *mmc\fP)
Deprecated since version 0.53: Use \fI\%memcached_pool_push()\fP
.INDENT 0.0
.TP
-.B memcached_return_t memcached_pool_release(memcached_pool_st* pool, memcached_st* mmc);
+.B memcached_return_t memcached_pool_release(\fI\%memcached_pool_st\fP*\fI\ pool\fP, memcached_st*\fI\ mmc\fP)
.UNINDENT
.sp
-New in version 0.53: Synonym for memcached_pool_push().
+New in version 0.53: Synonym for memcached_pool_push.
.INDENT 0.0
.TP
.B memcached_return_t memcached_pool_behavior_set(\fI\%memcached_pool_st\fP\fI\ *pool\fP, memcached_behavior_t\fI\ flag\fP, uint64_t\fI\ data\fP)
resources. It will return the pointer to the \fBmemcached_st\fP structure
passed as an argument to \fI\%memcached_pool_create()\fP, and returns the ownership of the pointer to the caller when created with \fI\%memcached_pool_create()\fP, otherwise NULL is returned..
.sp
-\fBmemcached_pool_fetch()\fP is used to fetch a connection structure from the
+\fI\%memcached_pool_fetch()\fP is used to fetch a connection structure from the
connection pool. The relative_time argument specifies if the function should
block and wait for a connection structure to be available if we try
to exceed the maximum size. You need to specify time in relative time.
.sp
-\fBmemcached_pool_release()\fP is used to return a connection structure back to the pool.
+\fI\%memcached_pool_release()\fP is used to return a connection structure back to the pool.
.sp
\fI\%memcached_pool_behavior_get()\fP and \fI\%memcached_pool_behavior_set()\fP is used to get/set behavior flags on all connections in the pool.
.sp
-Both \fBmemcached_pool_release()\fP and \fBmemcached_pool_fetch()\fP are thread safe.
+Both \fI\%memcached_pool_release()\fP and \fI\%memcached_pool_fetch()\fP are thread safe.
.SH RETURN
.sp
\fI\%memcached_pool_destroy()\fP returns the pointer (and ownership) to the \fBmemcached_st\fP structure used to create the pool. If connections are in use it returns NULL.
.sp
\fI\%memcached_pool_pop()\fP returns a pointer to a \fBmemcached_st\fP structure from the pool (or NULL if an allocation cannot be satisfied).
.sp
-\fBmemcached_pool_release()\fP returns \fBMEMCACHED_SUCCESS\fP upon success.
+\fI\%memcached_pool_release()\fP returns \fBMEMCACHED_SUCCESS\fP upon success.
.sp
\fI\%memcached_pool_behavior_get()\fP and \fI\%memcached_pool_behavior_get()\fP returns \fBMEMCACHED_SUCCESS\fP upon success.
.sp
If any methods returns MEMCACHED_IN_PROGRESS then a lock on the pool could not be obtained. If any of the parameters passed to any of these functions is invalid, MEMCACHED_INVALID_ARGUMENTS will be returned.
.sp
-memcached_pool_fetch() may return MEMCACHED_TIMEOUT if a timeout occurs while waiting for a free memcached_st. MEMCACHED_NOTFOUND if no memcached_st was available.
+memcached_pool_fetch may return MEMCACHED_TIMEOUT if a timeout occurs while waiting for a free memcached_st. MEMCACHED_NOTFOUND if no memcached_st was available.
.SH HOME
.sp
To find out more information please check:
-.TH "MEMCACHED_POOL_CREATE" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_POOL_CREATE" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_pool_create \- libmemcached Documentation
.
.B memcached_st* memcached_pool_pop(\fI\%memcached_pool_st\fP*\fI\ pool\fP, bool\fI\ block\fP, memcached_return_t\fI\ *rc\fP)
.UNINDENT
.sp
-Deprecated since version 0.53: Use \fBmemcached_pool_fetch()\fP
+Deprecated since version 0.53: Use \fI\%memcached_pool_fetch()\fP
.INDENT 0.0
.TP
-.B memcached_st* memcached_pool_fetch(memcached_pool_st*, struct timespec* relative_time, memcached_return_t* rc);
+.B memcached_st* memcached_pool_fetch(\fI\%memcached_pool_st\fP*, struct timespec*\fI\ relative_time\fP, memcached_return_t*\fI\ rc\fP)
.UNINDENT
.sp
-New in version 0.53: Synonym for memcached_pool_pop()
+New in version 0.53: Synonym for memcached_pool_pop
.INDENT 0.0
.TP
.B memcached_return_t memcached_pool_push(\fI\%memcached_pool_st\fP*\fI\ pool\fP, memcached_st\fI\ *mmc\fP)
Deprecated since version 0.53: Use \fI\%memcached_pool_push()\fP
.INDENT 0.0
.TP
-.B memcached_return_t memcached_pool_release(memcached_pool_st* pool, memcached_st* mmc);
+.B memcached_return_t memcached_pool_release(\fI\%memcached_pool_st\fP*\fI\ pool\fP, memcached_st*\fI\ mmc\fP)
.UNINDENT
.sp
-New in version 0.53: Synonym for memcached_pool_push().
+New in version 0.53: Synonym for memcached_pool_push.
.INDENT 0.0
.TP
.B memcached_return_t memcached_pool_behavior_set(\fI\%memcached_pool_st\fP\fI\ *pool\fP, memcached_behavior_t\fI\ flag\fP, uint64_t\fI\ data\fP)
resources. It will return the pointer to the \fBmemcached_st\fP structure
passed as an argument to \fI\%memcached_pool_create()\fP, and returns the ownership of the pointer to the caller when created with \fI\%memcached_pool_create()\fP, otherwise NULL is returned..
.sp
-\fBmemcached_pool_fetch()\fP is used to fetch a connection structure from the
+\fI\%memcached_pool_fetch()\fP is used to fetch a connection structure from the
connection pool. The relative_time argument specifies if the function should
block and wait for a connection structure to be available if we try
to exceed the maximum size. You need to specify time in relative time.
.sp
-\fBmemcached_pool_release()\fP is used to return a connection structure back to the pool.
+\fI\%memcached_pool_release()\fP is used to return a connection structure back to the pool.
.sp
\fI\%memcached_pool_behavior_get()\fP and \fI\%memcached_pool_behavior_set()\fP is used to get/set behavior flags on all connections in the pool.
.sp
-Both \fBmemcached_pool_release()\fP and \fBmemcached_pool_fetch()\fP are thread safe.
+Both \fI\%memcached_pool_release()\fP and \fI\%memcached_pool_fetch()\fP are thread safe.
.SH RETURN
.sp
\fI\%memcached_pool_destroy()\fP returns the pointer (and ownership) to the \fBmemcached_st\fP structure used to create the pool. If connections are in use it returns NULL.
.sp
\fI\%memcached_pool_pop()\fP returns a pointer to a \fBmemcached_st\fP structure from the pool (or NULL if an allocation cannot be satisfied).
.sp
-\fBmemcached_pool_release()\fP returns \fBMEMCACHED_SUCCESS\fP upon success.
+\fI\%memcached_pool_release()\fP returns \fBMEMCACHED_SUCCESS\fP upon success.
.sp
\fI\%memcached_pool_behavior_get()\fP and \fI\%memcached_pool_behavior_get()\fP returns \fBMEMCACHED_SUCCESS\fP upon success.
.sp
If any methods returns MEMCACHED_IN_PROGRESS then a lock on the pool could not be obtained. If any of the parameters passed to any of these functions is invalid, MEMCACHED_INVALID_ARGUMENTS will be returned.
.sp
-memcached_pool_fetch() may return MEMCACHED_TIMEOUT if a timeout occurs while waiting for a free memcached_st. MEMCACHED_NOTFOUND if no memcached_st was available.
+memcached_pool_fetch may return MEMCACHED_TIMEOUT if a timeout occurs while waiting for a free memcached_st. MEMCACHED_NOTFOUND if no memcached_st was available.
.SH HOME
.sp
To find out more information please check:
-.TH "MEMCACHED_POOL_DESTROY" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_POOL_DESTROY" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_pool_destroy \- libmemcached Documentation
.
.B memcached_st* memcached_pool_pop(\fI\%memcached_pool_st\fP*\fI\ pool\fP, bool\fI\ block\fP, memcached_return_t\fI\ *rc\fP)
.UNINDENT
.sp
-Deprecated since version 0.53: Use \fBmemcached_pool_fetch()\fP
+Deprecated since version 0.53: Use \fI\%memcached_pool_fetch()\fP
.INDENT 0.0
.TP
-.B memcached_st* memcached_pool_fetch(memcached_pool_st*, struct timespec* relative_time, memcached_return_t* rc);
+.B memcached_st* memcached_pool_fetch(\fI\%memcached_pool_st\fP*, struct timespec*\fI\ relative_time\fP, memcached_return_t*\fI\ rc\fP)
.UNINDENT
.sp
-New in version 0.53: Synonym for memcached_pool_pop()
+New in version 0.53: Synonym for memcached_pool_pop
.INDENT 0.0
.TP
.B memcached_return_t memcached_pool_push(\fI\%memcached_pool_st\fP*\fI\ pool\fP, memcached_st\fI\ *mmc\fP)
Deprecated since version 0.53: Use \fI\%memcached_pool_push()\fP
.INDENT 0.0
.TP
-.B memcached_return_t memcached_pool_release(memcached_pool_st* pool, memcached_st* mmc);
+.B memcached_return_t memcached_pool_release(\fI\%memcached_pool_st\fP*\fI\ pool\fP, memcached_st*\fI\ mmc\fP)
.UNINDENT
.sp
-New in version 0.53: Synonym for memcached_pool_push().
+New in version 0.53: Synonym for memcached_pool_push.
.INDENT 0.0
.TP
.B memcached_return_t memcached_pool_behavior_set(\fI\%memcached_pool_st\fP\fI\ *pool\fP, memcached_behavior_t\fI\ flag\fP, uint64_t\fI\ data\fP)
resources. It will return the pointer to the \fBmemcached_st\fP structure
passed as an argument to \fI\%memcached_pool_create()\fP, and returns the ownership of the pointer to the caller when created with \fI\%memcached_pool_create()\fP, otherwise NULL is returned..
.sp
-\fBmemcached_pool_fetch()\fP is used to fetch a connection structure from the
+\fI\%memcached_pool_fetch()\fP is used to fetch a connection structure from the
connection pool. The relative_time argument specifies if the function should
block and wait for a connection structure to be available if we try
to exceed the maximum size. You need to specify time in relative time.
.sp
-\fBmemcached_pool_release()\fP is used to return a connection structure back to the pool.
+\fI\%memcached_pool_release()\fP is used to return a connection structure back to the pool.
.sp
\fI\%memcached_pool_behavior_get()\fP and \fI\%memcached_pool_behavior_set()\fP is used to get/set behavior flags on all connections in the pool.
.sp
-Both \fBmemcached_pool_release()\fP and \fBmemcached_pool_fetch()\fP are thread safe.
+Both \fI\%memcached_pool_release()\fP and \fI\%memcached_pool_fetch()\fP are thread safe.
.SH RETURN
.sp
\fI\%memcached_pool_destroy()\fP returns the pointer (and ownership) to the \fBmemcached_st\fP structure used to create the pool. If connections are in use it returns NULL.
.sp
\fI\%memcached_pool_pop()\fP returns a pointer to a \fBmemcached_st\fP structure from the pool (or NULL if an allocation cannot be satisfied).
.sp
-\fBmemcached_pool_release()\fP returns \fBMEMCACHED_SUCCESS\fP upon success.
+\fI\%memcached_pool_release()\fP returns \fBMEMCACHED_SUCCESS\fP upon success.
.sp
\fI\%memcached_pool_behavior_get()\fP and \fI\%memcached_pool_behavior_get()\fP returns \fBMEMCACHED_SUCCESS\fP upon success.
.sp
If any methods returns MEMCACHED_IN_PROGRESS then a lock on the pool could not be obtained. If any of the parameters passed to any of these functions is invalid, MEMCACHED_INVALID_ARGUMENTS will be returned.
.sp
-memcached_pool_fetch() may return MEMCACHED_TIMEOUT if a timeout occurs while waiting for a free memcached_st. MEMCACHED_NOTFOUND if no memcached_st was available.
+memcached_pool_fetch may return MEMCACHED_TIMEOUT if a timeout occurs while waiting for a free memcached_st. MEMCACHED_NOTFOUND if no memcached_st was available.
.SH HOME
.sp
To find out more information please check:
-.TH "MEMCACHED_POOL_FETCH" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_POOL_FETCH" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_pool_fetch \- libmemcached Documentation
.
.B memcached_st* memcached_pool_pop(\fI\%memcached_pool_st\fP*\fI\ pool\fP, bool\fI\ block\fP, memcached_return_t\fI\ *rc\fP)
.UNINDENT
.sp
-Deprecated since version 0.53: Use \fBmemcached_pool_fetch()\fP
+Deprecated since version 0.53: Use \fI\%memcached_pool_fetch()\fP
.INDENT 0.0
.TP
-.B memcached_st* memcached_pool_fetch(memcached_pool_st*, struct timespec* relative_time, memcached_return_t* rc);
+.B memcached_st* memcached_pool_fetch(\fI\%memcached_pool_st\fP*, struct timespec*\fI\ relative_time\fP, memcached_return_t*\fI\ rc\fP)
.UNINDENT
.sp
-New in version 0.53: Synonym for memcached_pool_pop()
+New in version 0.53: Synonym for memcached_pool_pop
.INDENT 0.0
.TP
.B memcached_return_t memcached_pool_push(\fI\%memcached_pool_st\fP*\fI\ pool\fP, memcached_st\fI\ *mmc\fP)
Deprecated since version 0.53: Use \fI\%memcached_pool_push()\fP
.INDENT 0.0
.TP
-.B memcached_return_t memcached_pool_release(memcached_pool_st* pool, memcached_st* mmc);
+.B memcached_return_t memcached_pool_release(\fI\%memcached_pool_st\fP*\fI\ pool\fP, memcached_st*\fI\ mmc\fP)
.UNINDENT
.sp
-New in version 0.53: Synonym for memcached_pool_push().
+New in version 0.53: Synonym for memcached_pool_push.
.INDENT 0.0
.TP
.B memcached_return_t memcached_pool_behavior_set(\fI\%memcached_pool_st\fP\fI\ *pool\fP, memcached_behavior_t\fI\ flag\fP, uint64_t\fI\ data\fP)
resources. It will return the pointer to the \fBmemcached_st\fP structure
passed as an argument to \fI\%memcached_pool_create()\fP, and returns the ownership of the pointer to the caller when created with \fI\%memcached_pool_create()\fP, otherwise NULL is returned..
.sp
-\fBmemcached_pool_fetch()\fP is used to fetch a connection structure from the
+\fI\%memcached_pool_fetch()\fP is used to fetch a connection structure from the
connection pool. The relative_time argument specifies if the function should
block and wait for a connection structure to be available if we try
to exceed the maximum size. You need to specify time in relative time.
.sp
-\fBmemcached_pool_release()\fP is used to return a connection structure back to the pool.
+\fI\%memcached_pool_release()\fP is used to return a connection structure back to the pool.
.sp
\fI\%memcached_pool_behavior_get()\fP and \fI\%memcached_pool_behavior_set()\fP is used to get/set behavior flags on all connections in the pool.
.sp
-Both \fBmemcached_pool_release()\fP and \fBmemcached_pool_fetch()\fP are thread safe.
+Both \fI\%memcached_pool_release()\fP and \fI\%memcached_pool_fetch()\fP are thread safe.
.SH RETURN
.sp
\fI\%memcached_pool_destroy()\fP returns the pointer (and ownership) to the \fBmemcached_st\fP structure used to create the pool. If connections are in use it returns NULL.
.sp
\fI\%memcached_pool_pop()\fP returns a pointer to a \fBmemcached_st\fP structure from the pool (or NULL if an allocation cannot be satisfied).
.sp
-\fBmemcached_pool_release()\fP returns \fBMEMCACHED_SUCCESS\fP upon success.
+\fI\%memcached_pool_release()\fP returns \fBMEMCACHED_SUCCESS\fP upon success.
.sp
\fI\%memcached_pool_behavior_get()\fP and \fI\%memcached_pool_behavior_get()\fP returns \fBMEMCACHED_SUCCESS\fP upon success.
.sp
If any methods returns MEMCACHED_IN_PROGRESS then a lock on the pool could not be obtained. If any of the parameters passed to any of these functions is invalid, MEMCACHED_INVALID_ARGUMENTS will be returned.
.sp
-memcached_pool_fetch() may return MEMCACHED_TIMEOUT if a timeout occurs while waiting for a free memcached_st. MEMCACHED_NOTFOUND if no memcached_st was available.
+memcached_pool_fetch may return MEMCACHED_TIMEOUT if a timeout occurs while waiting for a free memcached_st. MEMCACHED_NOTFOUND if no memcached_st was available.
.SH HOME
.sp
To find out more information please check:
-.TH "MEMCACHED_POOL_POP" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_POOL_POP" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_pool_pop \- libmemcached Documentation
.
.B memcached_st* memcached_pool_pop(\fI\%memcached_pool_st\fP*\fI\ pool\fP, bool\fI\ block\fP, memcached_return_t\fI\ *rc\fP)
.UNINDENT
.sp
-Deprecated since version 0.53: Use \fBmemcached_pool_fetch()\fP
+Deprecated since version 0.53: Use \fI\%memcached_pool_fetch()\fP
.INDENT 0.0
.TP
-.B memcached_st* memcached_pool_fetch(memcached_pool_st*, struct timespec* relative_time, memcached_return_t* rc);
+.B memcached_st* memcached_pool_fetch(\fI\%memcached_pool_st\fP*, struct timespec*\fI\ relative_time\fP, memcached_return_t*\fI\ rc\fP)
.UNINDENT
.sp
-New in version 0.53: Synonym for memcached_pool_pop()
+New in version 0.53: Synonym for memcached_pool_pop
.INDENT 0.0
.TP
.B memcached_return_t memcached_pool_push(\fI\%memcached_pool_st\fP*\fI\ pool\fP, memcached_st\fI\ *mmc\fP)
Deprecated since version 0.53: Use \fI\%memcached_pool_push()\fP
.INDENT 0.0
.TP
-.B memcached_return_t memcached_pool_release(memcached_pool_st* pool, memcached_st* mmc);
+.B memcached_return_t memcached_pool_release(\fI\%memcached_pool_st\fP*\fI\ pool\fP, memcached_st*\fI\ mmc\fP)
.UNINDENT
.sp
-New in version 0.53: Synonym for memcached_pool_push().
+New in version 0.53: Synonym for memcached_pool_push.
.INDENT 0.0
.TP
.B memcached_return_t memcached_pool_behavior_set(\fI\%memcached_pool_st\fP\fI\ *pool\fP, memcached_behavior_t\fI\ flag\fP, uint64_t\fI\ data\fP)
resources. It will return the pointer to the \fBmemcached_st\fP structure
passed as an argument to \fI\%memcached_pool_create()\fP, and returns the ownership of the pointer to the caller when created with \fI\%memcached_pool_create()\fP, otherwise NULL is returned..
.sp
-\fBmemcached_pool_fetch()\fP is used to fetch a connection structure from the
+\fI\%memcached_pool_fetch()\fP is used to fetch a connection structure from the
connection pool. The relative_time argument specifies if the function should
block and wait for a connection structure to be available if we try
to exceed the maximum size. You need to specify time in relative time.
.sp
-\fBmemcached_pool_release()\fP is used to return a connection structure back to the pool.
+\fI\%memcached_pool_release()\fP is used to return a connection structure back to the pool.
.sp
\fI\%memcached_pool_behavior_get()\fP and \fI\%memcached_pool_behavior_set()\fP is used to get/set behavior flags on all connections in the pool.
.sp
-Both \fBmemcached_pool_release()\fP and \fBmemcached_pool_fetch()\fP are thread safe.
+Both \fI\%memcached_pool_release()\fP and \fI\%memcached_pool_fetch()\fP are thread safe.
.SH RETURN
.sp
\fI\%memcached_pool_destroy()\fP returns the pointer (and ownership) to the \fBmemcached_st\fP structure used to create the pool. If connections are in use it returns NULL.
.sp
\fI\%memcached_pool_pop()\fP returns a pointer to a \fBmemcached_st\fP structure from the pool (or NULL if an allocation cannot be satisfied).
.sp
-\fBmemcached_pool_release()\fP returns \fBMEMCACHED_SUCCESS\fP upon success.
+\fI\%memcached_pool_release()\fP returns \fBMEMCACHED_SUCCESS\fP upon success.
.sp
\fI\%memcached_pool_behavior_get()\fP and \fI\%memcached_pool_behavior_get()\fP returns \fBMEMCACHED_SUCCESS\fP upon success.
.sp
If any methods returns MEMCACHED_IN_PROGRESS then a lock on the pool could not be obtained. If any of the parameters passed to any of these functions is invalid, MEMCACHED_INVALID_ARGUMENTS will be returned.
.sp
-memcached_pool_fetch() may return MEMCACHED_TIMEOUT if a timeout occurs while waiting for a free memcached_st. MEMCACHED_NOTFOUND if no memcached_st was available.
+memcached_pool_fetch may return MEMCACHED_TIMEOUT if a timeout occurs while waiting for a free memcached_st. MEMCACHED_NOTFOUND if no memcached_st was available.
.SH HOME
.sp
To find out more information please check:
-.TH "MEMCACHED_POOL_PUSH" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_POOL_PUSH" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_pool_push \- libmemcached Documentation
.
.B memcached_st* memcached_pool_pop(\fI\%memcached_pool_st\fP*\fI\ pool\fP, bool\fI\ block\fP, memcached_return_t\fI\ *rc\fP)
.UNINDENT
.sp
-Deprecated since version 0.53: Use \fBmemcached_pool_fetch()\fP
+Deprecated since version 0.53: Use \fI\%memcached_pool_fetch()\fP
.INDENT 0.0
.TP
-.B memcached_st* memcached_pool_fetch(memcached_pool_st*, struct timespec* relative_time, memcached_return_t* rc);
+.B memcached_st* memcached_pool_fetch(\fI\%memcached_pool_st\fP*, struct timespec*\fI\ relative_time\fP, memcached_return_t*\fI\ rc\fP)
.UNINDENT
.sp
-New in version 0.53: Synonym for memcached_pool_pop()
+New in version 0.53: Synonym for memcached_pool_pop
.INDENT 0.0
.TP
.B memcached_return_t memcached_pool_push(\fI\%memcached_pool_st\fP*\fI\ pool\fP, memcached_st\fI\ *mmc\fP)
Deprecated since version 0.53: Use \fI\%memcached_pool_push()\fP
.INDENT 0.0
.TP
-.B memcached_return_t memcached_pool_release(memcached_pool_st* pool, memcached_st* mmc);
+.B memcached_return_t memcached_pool_release(\fI\%memcached_pool_st\fP*\fI\ pool\fP, memcached_st*\fI\ mmc\fP)
.UNINDENT
.sp
-New in version 0.53: Synonym for memcached_pool_push().
+New in version 0.53: Synonym for memcached_pool_push.
.INDENT 0.0
.TP
.B memcached_return_t memcached_pool_behavior_set(\fI\%memcached_pool_st\fP\fI\ *pool\fP, memcached_behavior_t\fI\ flag\fP, uint64_t\fI\ data\fP)
resources. It will return the pointer to the \fBmemcached_st\fP structure
passed as an argument to \fI\%memcached_pool_create()\fP, and returns the ownership of the pointer to the caller when created with \fI\%memcached_pool_create()\fP, otherwise NULL is returned..
.sp
-\fBmemcached_pool_fetch()\fP is used to fetch a connection structure from the
+\fI\%memcached_pool_fetch()\fP is used to fetch a connection structure from the
connection pool. The relative_time argument specifies if the function should
block and wait for a connection structure to be available if we try
to exceed the maximum size. You need to specify time in relative time.
.sp
-\fBmemcached_pool_release()\fP is used to return a connection structure back to the pool.
+\fI\%memcached_pool_release()\fP is used to return a connection structure back to the pool.
.sp
\fI\%memcached_pool_behavior_get()\fP and \fI\%memcached_pool_behavior_set()\fP is used to get/set behavior flags on all connections in the pool.
.sp
-Both \fBmemcached_pool_release()\fP and \fBmemcached_pool_fetch()\fP are thread safe.
+Both \fI\%memcached_pool_release()\fP and \fI\%memcached_pool_fetch()\fP are thread safe.
.SH RETURN
.sp
\fI\%memcached_pool_destroy()\fP returns the pointer (and ownership) to the \fBmemcached_st\fP structure used to create the pool. If connections are in use it returns NULL.
.sp
\fI\%memcached_pool_pop()\fP returns a pointer to a \fBmemcached_st\fP structure from the pool (or NULL if an allocation cannot be satisfied).
.sp
-\fBmemcached_pool_release()\fP returns \fBMEMCACHED_SUCCESS\fP upon success.
+\fI\%memcached_pool_release()\fP returns \fBMEMCACHED_SUCCESS\fP upon success.
.sp
\fI\%memcached_pool_behavior_get()\fP and \fI\%memcached_pool_behavior_get()\fP returns \fBMEMCACHED_SUCCESS\fP upon success.
.sp
If any methods returns MEMCACHED_IN_PROGRESS then a lock on the pool could not be obtained. If any of the parameters passed to any of these functions is invalid, MEMCACHED_INVALID_ARGUMENTS will be returned.
.sp
-memcached_pool_fetch() may return MEMCACHED_TIMEOUT if a timeout occurs while waiting for a free memcached_st. MEMCACHED_NOTFOUND if no memcached_st was available.
+memcached_pool_fetch may return MEMCACHED_TIMEOUT if a timeout occurs while waiting for a free memcached_st. MEMCACHED_NOTFOUND if no memcached_st was available.
.SH HOME
.sp
To find out more information please check:
-.TH "MEMCACHED_POOL_RELEASE" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_POOL_RELEASE" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_pool_release \- libmemcached Documentation
.
.B memcached_st* memcached_pool_pop(\fI\%memcached_pool_st\fP*\fI\ pool\fP, bool\fI\ block\fP, memcached_return_t\fI\ *rc\fP)
.UNINDENT
.sp
-Deprecated since version 0.53: Use \fBmemcached_pool_fetch()\fP
+Deprecated since version 0.53: Use \fI\%memcached_pool_fetch()\fP
.INDENT 0.0
.TP
-.B memcached_st* memcached_pool_fetch(memcached_pool_st*, struct timespec* relative_time, memcached_return_t* rc);
+.B memcached_st* memcached_pool_fetch(\fI\%memcached_pool_st\fP*, struct timespec*\fI\ relative_time\fP, memcached_return_t*\fI\ rc\fP)
.UNINDENT
.sp
-New in version 0.53: Synonym for memcached_pool_pop()
+New in version 0.53: Synonym for memcached_pool_pop
.INDENT 0.0
.TP
.B memcached_return_t memcached_pool_push(\fI\%memcached_pool_st\fP*\fI\ pool\fP, memcached_st\fI\ *mmc\fP)
Deprecated since version 0.53: Use \fI\%memcached_pool_push()\fP
.INDENT 0.0
.TP
-.B memcached_return_t memcached_pool_release(memcached_pool_st* pool, memcached_st* mmc);
+.B memcached_return_t memcached_pool_release(\fI\%memcached_pool_st\fP*\fI\ pool\fP, memcached_st*\fI\ mmc\fP)
.UNINDENT
.sp
-New in version 0.53: Synonym for memcached_pool_push().
+New in version 0.53: Synonym for memcached_pool_push.
.INDENT 0.0
.TP
.B memcached_return_t memcached_pool_behavior_set(\fI\%memcached_pool_st\fP\fI\ *pool\fP, memcached_behavior_t\fI\ flag\fP, uint64_t\fI\ data\fP)
resources. It will return the pointer to the \fBmemcached_st\fP structure
passed as an argument to \fI\%memcached_pool_create()\fP, and returns the ownership of the pointer to the caller when created with \fI\%memcached_pool_create()\fP, otherwise NULL is returned..
.sp
-\fBmemcached_pool_fetch()\fP is used to fetch a connection structure from the
+\fI\%memcached_pool_fetch()\fP is used to fetch a connection structure from the
connection pool. The relative_time argument specifies if the function should
block and wait for a connection structure to be available if we try
to exceed the maximum size. You need to specify time in relative time.
.sp
-\fBmemcached_pool_release()\fP is used to return a connection structure back to the pool.
+\fI\%memcached_pool_release()\fP is used to return a connection structure back to the pool.
.sp
\fI\%memcached_pool_behavior_get()\fP and \fI\%memcached_pool_behavior_set()\fP is used to get/set behavior flags on all connections in the pool.
.sp
-Both \fBmemcached_pool_release()\fP and \fBmemcached_pool_fetch()\fP are thread safe.
+Both \fI\%memcached_pool_release()\fP and \fI\%memcached_pool_fetch()\fP are thread safe.
.SH RETURN
.sp
\fI\%memcached_pool_destroy()\fP returns the pointer (and ownership) to the \fBmemcached_st\fP structure used to create the pool. If connections are in use it returns NULL.
.sp
\fI\%memcached_pool_pop()\fP returns a pointer to a \fBmemcached_st\fP structure from the pool (or NULL if an allocation cannot be satisfied).
.sp
-\fBmemcached_pool_release()\fP returns \fBMEMCACHED_SUCCESS\fP upon success.
+\fI\%memcached_pool_release()\fP returns \fBMEMCACHED_SUCCESS\fP upon success.
.sp
\fI\%memcached_pool_behavior_get()\fP and \fI\%memcached_pool_behavior_get()\fP returns \fBMEMCACHED_SUCCESS\fP upon success.
.sp
If any methods returns MEMCACHED_IN_PROGRESS then a lock on the pool could not be obtained. If any of the parameters passed to any of these functions is invalid, MEMCACHED_INVALID_ARGUMENTS will be returned.
.sp
-memcached_pool_fetch() may return MEMCACHED_TIMEOUT if a timeout occurs while waiting for a free memcached_st. MEMCACHED_NOTFOUND if no memcached_st was available.
+memcached_pool_fetch may return MEMCACHED_TIMEOUT if a timeout occurs while waiting for a free memcached_st. MEMCACHED_NOTFOUND if no memcached_st was available.
.SH HOME
.sp
To find out more information please check:
-.TH "MEMCACHED_POOL_ST" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_POOL_ST" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_pool_st \- libmemcached Documentation
.
.B memcached_st* memcached_pool_pop(\fI\%memcached_pool_st\fP*\fI\ pool\fP, bool\fI\ block\fP, memcached_return_t\fI\ *rc\fP)
.UNINDENT
.sp
-Deprecated since version 0.53: Use \fBmemcached_pool_fetch()\fP
+Deprecated since version 0.53: Use \fI\%memcached_pool_fetch()\fP
.INDENT 0.0
.TP
-.B memcached_st* memcached_pool_fetch(memcached_pool_st*, struct timespec* relative_time, memcached_return_t* rc);
+.B memcached_st* memcached_pool_fetch(\fI\%memcached_pool_st\fP*, struct timespec*\fI\ relative_time\fP, memcached_return_t*\fI\ rc\fP)
.UNINDENT
.sp
-New in version 0.53: Synonym for memcached_pool_pop()
+New in version 0.53: Synonym for memcached_pool_pop
.INDENT 0.0
.TP
.B memcached_return_t memcached_pool_push(\fI\%memcached_pool_st\fP*\fI\ pool\fP, memcached_st\fI\ *mmc\fP)
Deprecated since version 0.53: Use \fI\%memcached_pool_push()\fP
.INDENT 0.0
.TP
-.B memcached_return_t memcached_pool_release(memcached_pool_st* pool, memcached_st* mmc);
+.B memcached_return_t memcached_pool_release(\fI\%memcached_pool_st\fP*\fI\ pool\fP, memcached_st*\fI\ mmc\fP)
.UNINDENT
.sp
-New in version 0.53: Synonym for memcached_pool_push().
+New in version 0.53: Synonym for memcached_pool_push.
.INDENT 0.0
.TP
.B memcached_return_t memcached_pool_behavior_set(\fI\%memcached_pool_st\fP\fI\ *pool\fP, memcached_behavior_t\fI\ flag\fP, uint64_t\fI\ data\fP)
resources. It will return the pointer to the \fBmemcached_st\fP structure
passed as an argument to \fI\%memcached_pool_create()\fP, and returns the ownership of the pointer to the caller when created with \fI\%memcached_pool_create()\fP, otherwise NULL is returned..
.sp
-\fBmemcached_pool_fetch()\fP is used to fetch a connection structure from the
+\fI\%memcached_pool_fetch()\fP is used to fetch a connection structure from the
connection pool. The relative_time argument specifies if the function should
block and wait for a connection structure to be available if we try
to exceed the maximum size. You need to specify time in relative time.
.sp
-\fBmemcached_pool_release()\fP is used to return a connection structure back to the pool.
+\fI\%memcached_pool_release()\fP is used to return a connection structure back to the pool.
.sp
\fI\%memcached_pool_behavior_get()\fP and \fI\%memcached_pool_behavior_set()\fP is used to get/set behavior flags on all connections in the pool.
.sp
-Both \fBmemcached_pool_release()\fP and \fBmemcached_pool_fetch()\fP are thread safe.
+Both \fI\%memcached_pool_release()\fP and \fI\%memcached_pool_fetch()\fP are thread safe.
.SH RETURN
.sp
\fI\%memcached_pool_destroy()\fP returns the pointer (and ownership) to the \fBmemcached_st\fP structure used to create the pool. If connections are in use it returns NULL.
.sp
\fI\%memcached_pool_pop()\fP returns a pointer to a \fBmemcached_st\fP structure from the pool (or NULL if an allocation cannot be satisfied).
.sp
-\fBmemcached_pool_release()\fP returns \fBMEMCACHED_SUCCESS\fP upon success.
+\fI\%memcached_pool_release()\fP returns \fBMEMCACHED_SUCCESS\fP upon success.
.sp
\fI\%memcached_pool_behavior_get()\fP and \fI\%memcached_pool_behavior_get()\fP returns \fBMEMCACHED_SUCCESS\fP upon success.
.sp
If any methods returns MEMCACHED_IN_PROGRESS then a lock on the pool could not be obtained. If any of the parameters passed to any of these functions is invalid, MEMCACHED_INVALID_ARGUMENTS will be returned.
.sp
-memcached_pool_fetch() may return MEMCACHED_TIMEOUT if a timeout occurs while waiting for a free memcached_st. MEMCACHED_NOTFOUND if no memcached_st was available.
+memcached_pool_fetch may return MEMCACHED_TIMEOUT if a timeout occurs while waiting for a free memcached_st. MEMCACHED_NOTFOUND if no memcached_st was available.
.SH HOME
.sp
To find out more information please check:
-.TH "MEMCACHED_PREPEND" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_PREPEND" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_prepend \- Appending to or Prepending to data on the server
.
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_prepend_by_key(memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags);
+.B memcached_return_t memcached_prepend_by_key(memcached_st\fI\ *ptr\fP, const char\fI\ *group_key\fP, size_t\fI\ group_key_length\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, const char\fI\ *value\fP, size_t\fI\ value_length\fP, time_t\fI\ expiration\fP, uint32_t\fI\ flags\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_append_by_key(memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags);
+.B memcached_return_t memcached_append_by_key(memcached_st\fI\ *ptr\fP, const char\fI\ *group_key\fP, size_t\fI\ group_key_length\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, const char\fI\ *value\fP, size_t\fI\ value_length\fP, time_t\fI\ expiration\fP, uint32_t\fI\ flags\fP)
.UNINDENT
.sp
Compile and link with \-lmemcached
\fI\%memcached_append()\fP 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.
.sp
-\fBmemcached_prepend_by_key()\fP and
-\fBmemcached_append_by_key_by_key()\fP methods both behave in a similar
+\fI\%memcached_prepend_by_key()\fP and
+\fI\%memcached_append_by_key()\fP methods both behave in a similar
method as the non key methods. The difference is that they use their
group_key parameter to map objects to particular servers.
.sp
-.TH "MEMCACHED_PREPEND_BY_KEY" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_PREPEND_BY_KEY" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_prepend_by_key \- Appending to or Prepending to data on the server
.
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_prepend_by_key(memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags);
+.B memcached_return_t memcached_prepend_by_key(memcached_st\fI\ *ptr\fP, const char\fI\ *group_key\fP, size_t\fI\ group_key_length\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, const char\fI\ *value\fP, size_t\fI\ value_length\fP, time_t\fI\ expiration\fP, uint32_t\fI\ flags\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_append_by_key(memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags);
+.B memcached_return_t memcached_append_by_key(memcached_st\fI\ *ptr\fP, const char\fI\ *group_key\fP, size_t\fI\ group_key_length\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, const char\fI\ *value\fP, size_t\fI\ value_length\fP, time_t\fI\ expiration\fP, uint32_t\fI\ flags\fP)
.UNINDENT
.sp
Compile and link with \-lmemcached
\fI\%memcached_append()\fP 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.
.sp
-\fBmemcached_prepend_by_key()\fP and
-\fBmemcached_append_by_key_by_key()\fP methods both behave in a similar
+\fI\%memcached_prepend_by_key()\fP and
+\fI\%memcached_append_by_key()\fP methods both behave in a similar
method as the non key methods. The difference is that they use their
group_key parameter to map objects to particular servers.
.sp
-.TH "MEMCACHED_QUIT" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_QUIT" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_quit \- libmemcached Documentation
.
#include <libmemcached/memcached.h>
.INDENT 0.0
.TP
-.B void memcached_quit (memcached_st *ptr);
+.B void memcached_quit(memcached_st\fI\ *ptr\fP)
.UNINDENT
.sp
Compile and link with \-lmemcached
.SH DESCRIPTION
.sp
-\fBmemcached_quit()\fP will disconnect you from all currently connected
+\fI\%memcached_quit()\fP will disconnect you from all currently connected
servers. It will also reset the state of the connection (ie, any \fBmemcached_fetch()\fP you are in the middle of will be terminated). This function is
called automatically when you call \fBmemcached_free()\fP on the \fBmemcached_st\fP structure.
.sp
reset connections during the middle of a \fBmemcached_fetch()\fP.
.SH RETURN
.sp
-A value of type \fBmemcached_return\fP is returned
-On success that value will be \fBMEMCACHED_SUCCESS\fP.
-Use \fBmemcached_strerror()\fP to translate this value to a printable string.
+A value of type \fBmemcached_return_t\fP is returned On success that value
+will be \fBMEMCACHED_SUCCESS\fP. Use \fBmemcached_strerror()\fP to
+translate this value to a printable string.
.SH HOME
.sp
To find out more information please check:
-.TH "MEMCACHED_REPLACE" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_REPLACE" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_replace \- Storing and Replacing Data
.
#include <libmemcached/memcached.h>
.INDENT 0.0
.TP
-.B memcached_return_t memcached_set (memcached_st *ptr, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags);
+.B memcached_return_t memcached_set(memcached_st\fI\ *ptr\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, const char\fI\ *value\fP, size_t\fI\ value_length\fP, time_t\fI\ expiration\fP, uint32_t\fI\ flags\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_add (memcached_st *ptr, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags);
+.B memcached_return_t memcached_add(memcached_st\fI\ *ptr\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, const char\fI\ *value\fP, size_t\fI\ value_length\fP, time_t\fI\ expiration\fP, uint32_t\fI\ flags\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_replace (memcached_st *ptr, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags);
+.B memcached_return_t memcached_replace(memcached_st\fI\ *ptr\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, const char\fI\ *value\fP, size_t\fI\ value_length\fP, time_t\fI\ expiration\fP, uint32_t\fI\ flags\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_set_by_key(memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags);
+.B memcached_return_t memcached_set_by_key(memcached_st\fI\ *ptr\fP, const char\fI\ *group_key\fP, size_t\fI\ group_key_length\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, const char\fI\ *value\fP, size_t\fI\ value_length\fP, time_t\fI\ expiration\fP, uint32_t\fI\ flags\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_add_by_key(memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags);
+.B memcached_return_t memcached_add_by_key(memcached_st\fI\ *ptr\fP, const char\fI\ *group_key\fP, size_t\fI\ group_key_length\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, const char\fI\ *value\fP, size_t\fI\ value_length\fP, time_t\fI\ expiration\fP, uint32_t\fI\ flags\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_replace_by_key(memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags);
+.B memcached_return_t memcached_replace_by_key(memcached_st\fI\ *ptr\fP, const char\fI\ *group_key\fP, size_t\fI\ group_key_length\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, const char\fI\ *value\fP, size_t\fI\ value_length\fP, time_t\fI\ expiration\fP, uint32_t\fI\ flags\fP)
.UNINDENT
.sp
Compile and link with \-lmemcached
.SH DESCRIPTION
.sp
-\fBmemcached_set()\fP, \fBmemcached_add()\fP, and \fBmemcached_replace()\fP are all used to store information on the server. All methods take a key, and its length to store the object. Keys are currently limited to 250 characters when using either a version of memcached(1) which is 1.4 or below, or when using the text protocol. You must supply both a value and a length. Optionally you
+\fI\%memcached_set()\fP, \fI\%memcached_add()\fP, and \fI\%memcached_replace()\fP are all used to store information on the server. All methods take a key, and its length to store the object. Keys are currently limited to 250 characters when using either a version of memcached(1) which is 1.4 or below, or when using the text protocol. You must supply both a value and a length. Optionally you
store the object. Keys are currently limited to 250 characters by the
memcached(1) server. You must supply both a value and a length. Optionally you
may test an expiration time for the object and a 16 byte value (it is meant to be used as a bitmap). "flags" is a 4byte space that is stored alongside of the main value. Many sub libraries make use of this field, so in most cases users should avoid making use of it.
.sp
-\fBmemcached_set()\fP will write an object to the server. If an object
+\fI\%memcached_set()\fP will write an object to the server. If an object
already exists it will overwrite what is in the server. If the object does not
exist it will be written. If you are using the non\-blocking mode this function
will always return true unless a network error occurs.
.sp
-\fBmemcached_replace()\fP replaces an object on the server. If the object is not found on the server an error occurs.
+\fI\%memcached_replace()\fP replaces an object on the server. If the object is not found on the server an error occurs.
.sp
-\fBmemcached_add()\fP adds an object to the server. If the object is found on the server an error occurs, otherwise the value is stored.
+\fI\%memcached_add()\fP adds an object to the server. If the object is found on the server an error occurs, otherwise the value is stored.
.sp
\fBmemcached_cas()\fP 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 \fBmemcached_result_cas()\fP on a memcached_result_st(3) structure. At the point
that this note was written cas is still buggy in memached. Turning on tests
-for it in libmemcached(3) is optional. Please see memcached_set() for
+for it in libmemcached(3) is optional. Please see memcached_set for
information on how to do this.
.sp
-\fBmemcached_set_by_key()\fP, \fBmemcached_add_by_key()\fP, and \fBmemcached_replace_by_key()\fP methods all behave in a similar method as the non
+\fI\%memcached_set_by_key()\fP, \fI\%memcached_add_by_key()\fP, and \fI\%memcached_replace_by_key()\fP methods all behave in a similar method as the non
key methods. The difference is that they use their group_key parameter to map
objects to particular servers.
.sp
-If you are looking for performance, \fBmemcached_set()\fP with non\-blocking IO is the fastest way to store data on the server.
+If you are looking for performance, \fI\%memcached_set()\fP with non\-blocking IO is the fastest way to store data on the server.
.sp
All of the above functions are testsed with the \fBMEMCACHED_BEHAVIOR_USE_UDP\fP behavior enabled. However, when using these operations with this behavior
on, there are limits to the size of the payload being sent to the server.
On success the value will be \fBMEMCACHED_SUCCESS\fP.
Use \fBmemcached_strerror()\fP to translate this value to a printable string.
.sp
-For \fBmemcached_replace()\fP and \fBmemcached_add()\fP, \fBMEMCACHED_NOTSTORED\fP is a legitmate error in the case of a collision.
+For \fI\%memcached_replace()\fP and \fI\%memcached_add()\fP, \fBMEMCACHED_NOTSTORED\fP is a legitmate error in the case of a collision.
.SH HOME
.sp
To find out more information please check:
-.TH "MEMCACHED_REPLACE_BY_KEY" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_REPLACE_BY_KEY" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_replace_by_key \- Storing and Replacing Data
.
#include <libmemcached/memcached.h>
.INDENT 0.0
.TP
-.B memcached_return_t memcached_set (memcached_st *ptr, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags);
+.B memcached_return_t memcached_set(memcached_st\fI\ *ptr\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, const char\fI\ *value\fP, size_t\fI\ value_length\fP, time_t\fI\ expiration\fP, uint32_t\fI\ flags\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_add (memcached_st *ptr, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags);
+.B memcached_return_t memcached_add(memcached_st\fI\ *ptr\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, const char\fI\ *value\fP, size_t\fI\ value_length\fP, time_t\fI\ expiration\fP, uint32_t\fI\ flags\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_replace (memcached_st *ptr, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags);
+.B memcached_return_t memcached_replace(memcached_st\fI\ *ptr\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, const char\fI\ *value\fP, size_t\fI\ value_length\fP, time_t\fI\ expiration\fP, uint32_t\fI\ flags\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_set_by_key(memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags);
+.B memcached_return_t memcached_set_by_key(memcached_st\fI\ *ptr\fP, const char\fI\ *group_key\fP, size_t\fI\ group_key_length\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, const char\fI\ *value\fP, size_t\fI\ value_length\fP, time_t\fI\ expiration\fP, uint32_t\fI\ flags\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_add_by_key(memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags);
+.B memcached_return_t memcached_add_by_key(memcached_st\fI\ *ptr\fP, const char\fI\ *group_key\fP, size_t\fI\ group_key_length\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, const char\fI\ *value\fP, size_t\fI\ value_length\fP, time_t\fI\ expiration\fP, uint32_t\fI\ flags\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_replace_by_key(memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags);
+.B memcached_return_t memcached_replace_by_key(memcached_st\fI\ *ptr\fP, const char\fI\ *group_key\fP, size_t\fI\ group_key_length\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, const char\fI\ *value\fP, size_t\fI\ value_length\fP, time_t\fI\ expiration\fP, uint32_t\fI\ flags\fP)
.UNINDENT
.sp
Compile and link with \-lmemcached
.SH DESCRIPTION
.sp
-\fBmemcached_set()\fP, \fBmemcached_add()\fP, and \fBmemcached_replace()\fP are all used to store information on the server. All methods take a key, and its length to store the object. Keys are currently limited to 250 characters when using either a version of memcached(1) which is 1.4 or below, or when using the text protocol. You must supply both a value and a length. Optionally you
+\fI\%memcached_set()\fP, \fI\%memcached_add()\fP, and \fI\%memcached_replace()\fP are all used to store information on the server. All methods take a key, and its length to store the object. Keys are currently limited to 250 characters when using either a version of memcached(1) which is 1.4 or below, or when using the text protocol. You must supply both a value and a length. Optionally you
store the object. Keys are currently limited to 250 characters by the
memcached(1) server. You must supply both a value and a length. Optionally you
may test an expiration time for the object and a 16 byte value (it is meant to be used as a bitmap). "flags" is a 4byte space that is stored alongside of the main value. Many sub libraries make use of this field, so in most cases users should avoid making use of it.
.sp
-\fBmemcached_set()\fP will write an object to the server. If an object
+\fI\%memcached_set()\fP will write an object to the server. If an object
already exists it will overwrite what is in the server. If the object does not
exist it will be written. If you are using the non\-blocking mode this function
will always return true unless a network error occurs.
.sp
-\fBmemcached_replace()\fP replaces an object on the server. If the object is not found on the server an error occurs.
+\fI\%memcached_replace()\fP replaces an object on the server. If the object is not found on the server an error occurs.
.sp
-\fBmemcached_add()\fP adds an object to the server. If the object is found on the server an error occurs, otherwise the value is stored.
+\fI\%memcached_add()\fP adds an object to the server. If the object is found on the server an error occurs, otherwise the value is stored.
.sp
\fBmemcached_cas()\fP 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 \fBmemcached_result_cas()\fP on a memcached_result_st(3) structure. At the point
that this note was written cas is still buggy in memached. Turning on tests
-for it in libmemcached(3) is optional. Please see memcached_set() for
+for it in libmemcached(3) is optional. Please see memcached_set for
information on how to do this.
.sp
-\fBmemcached_set_by_key()\fP, \fBmemcached_add_by_key()\fP, and \fBmemcached_replace_by_key()\fP methods all behave in a similar method as the non
+\fI\%memcached_set_by_key()\fP, \fI\%memcached_add_by_key()\fP, and \fI\%memcached_replace_by_key()\fP methods all behave in a similar method as the non
key methods. The difference is that they use their group_key parameter to map
objects to particular servers.
.sp
-If you are looking for performance, \fBmemcached_set()\fP with non\-blocking IO is the fastest way to store data on the server.
+If you are looking for performance, \fI\%memcached_set()\fP with non\-blocking IO is the fastest way to store data on the server.
.sp
All of the above functions are testsed with the \fBMEMCACHED_BEHAVIOR_USE_UDP\fP behavior enabled. However, when using these operations with this behavior
on, there are limits to the size of the payload being sent to the server.
On success the value will be \fBMEMCACHED_SUCCESS\fP.
Use \fBmemcached_strerror()\fP to translate this value to a printable string.
.sp
-For \fBmemcached_replace()\fP and \fBmemcached_add()\fP, \fBMEMCACHED_NOTSTORED\fP is a legitmate error in the case of a collision.
+For \fI\%memcached_replace()\fP and \fI\%memcached_add()\fP, \fBMEMCACHED_NOTSTORED\fP is a legitmate error in the case of a collision.
.SH HOME
.sp
To find out more information please check:
-.TH "MEMCACHED_RESULT_CAS" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_RESULT_CAS" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_result_cas \- Working with result sets
.
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_result_st * memcached_result_create (memcached_st *ptr, memcached_result_st *result);
+.B \fI\%memcached_result_st\fP * memcached_result_create(memcached_st\fI\ *ptr\fP, \fI\%memcached_result_st\fP\fI\ *result\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B void memcached_result_free (memcached_result_st *result);
+.B void memcached_result_free(\fI\%memcached_result_st\fP\fI\ *result\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B const char * memcached_result_key_value (memcached_result_st *result);
+.B const char * memcached_result_key_value(\fI\%memcached_result_st\fP\fI\ *result\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B size_t memcached_result_key_length (const memcached_result_st *result);
+.B size_t memcached_result_key_length(const \fI\%memcached_result_st\fP\fI\ *result\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B const char *memcached_result_value (memcached_result_st *ptr);
+.B const char *memcached_result_value(\fI\%memcached_result_st\fP\fI\ *ptr\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B size_t memcached_result_length (const memcached_result_st *ptr);
+.B size_t memcached_result_length(const \fI\%memcached_result_st\fP\fI\ *ptr\fP)
.UNINDENT
.INDENT 0.0
.TP
.UNINDENT
.INDENT 0.0
.TP
-.B uint64_t memcached_result_cas (const memcached_result_st *result);
+.B uint64_t memcached_result_cas(const \fI\%memcached_result_st\fP\fI\ *result\fP)
.UNINDENT
.INDENT 0.0
.TP
The structure of \fI\%memcached_result_st\fP has been encapsulated, you should
not write code to directly access members of the structure.
.sp
-\fBmemcached_result_create()\fP will either allocate memory for a
+\fI\%memcached_result_create()\fP will either allocate memory for a
\fI\%memcached_result_st\fP or will initialize a structure passed to it.
.sp
-\fBmemcached_result_free()\fP will deallocate any memory attached to the
+\fI\%memcached_result_free()\fP will deallocate any memory attached to the
structure. If the structure was also allocated, it will deallocate it.
.sp
-\fBmemcached_result_key_value()\fP returns the key value associated with the
+\fI\%memcached_result_key_value()\fP returns the key value associated with the
current result object.
.sp
-\fBmemcached_result_key_length()\fP returns the key length associated with
+\fI\%memcached_result_key_length()\fP returns the key length associated with
the current result object.
.sp
-\fBmemcached_result_value()\fP returns the result value associated with the
+\fI\%memcached_result_value()\fP returns the result value associated with the
current result object.
.sp
-\fBmemcached_result_length()\fP returns the result length associated with
+\fI\%memcached_result_length()\fP returns the result length associated with
the current result object.
.sp
\fI\%memcached_result_flags()\fP returns the flags associated with the
current result object.
.sp
-\fBmemcached_result_cas()\fP returns the cas associated with the
+\fI\%memcached_result_cas()\fP returns the cas associated with the
current result object. This value will only be available if the server
tests it.
.sp
\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
-\fBvoid memcached_result_set_flags()\fP takes a result structure and stores
-a new value for the flags field.
+\fI\%memcached_result_set_flags()\fP takes a result structure and stores a new
+value for the flags field.
.sp
-\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).
+\fI\%memcached_result_set_expiration()\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
.SH RETURN
.sp
Varies, see particular functions. All structures must have
-\fBmemcached_result_free()\fP called on them for cleanup purposes. Failure
+\fI\%memcached_result_free()\fP called on them for cleanup purposes. Failure
to do this will result in leaked memory.
.SH HOME
.sp
-.TH "MEMCACHED_RESULT_CREATE" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_RESULT_CREATE" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_result_create \- Working with result sets
.
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_result_st * memcached_result_create (memcached_st *ptr, memcached_result_st *result);
+.B \fI\%memcached_result_st\fP * memcached_result_create(memcached_st\fI\ *ptr\fP, \fI\%memcached_result_st\fP\fI\ *result\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B void memcached_result_free (memcached_result_st *result);
+.B void memcached_result_free(\fI\%memcached_result_st\fP\fI\ *result\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B const char * memcached_result_key_value (memcached_result_st *result);
+.B const char * memcached_result_key_value(\fI\%memcached_result_st\fP\fI\ *result\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B size_t memcached_result_key_length (const memcached_result_st *result);
+.B size_t memcached_result_key_length(const \fI\%memcached_result_st\fP\fI\ *result\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B const char *memcached_result_value (memcached_result_st *ptr);
+.B const char *memcached_result_value(\fI\%memcached_result_st\fP\fI\ *ptr\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B size_t memcached_result_length (const memcached_result_st *ptr);
+.B size_t memcached_result_length(const \fI\%memcached_result_st\fP\fI\ *ptr\fP)
.UNINDENT
.INDENT 0.0
.TP
.UNINDENT
.INDENT 0.0
.TP
-.B uint64_t memcached_result_cas (const memcached_result_st *result);
+.B uint64_t memcached_result_cas(const \fI\%memcached_result_st\fP\fI\ *result\fP)
.UNINDENT
.INDENT 0.0
.TP
The structure of \fI\%memcached_result_st\fP has been encapsulated, you should
not write code to directly access members of the structure.
.sp
-\fBmemcached_result_create()\fP will either allocate memory for a
+\fI\%memcached_result_create()\fP will either allocate memory for a
\fI\%memcached_result_st\fP or will initialize a structure passed to it.
.sp
-\fBmemcached_result_free()\fP will deallocate any memory attached to the
+\fI\%memcached_result_free()\fP will deallocate any memory attached to the
structure. If the structure was also allocated, it will deallocate it.
.sp
-\fBmemcached_result_key_value()\fP returns the key value associated with the
+\fI\%memcached_result_key_value()\fP returns the key value associated with the
current result object.
.sp
-\fBmemcached_result_key_length()\fP returns the key length associated with
+\fI\%memcached_result_key_length()\fP returns the key length associated with
the current result object.
.sp
-\fBmemcached_result_value()\fP returns the result value associated with the
+\fI\%memcached_result_value()\fP returns the result value associated with the
current result object.
.sp
-\fBmemcached_result_length()\fP returns the result length associated with
+\fI\%memcached_result_length()\fP returns the result length associated with
the current result object.
.sp
\fI\%memcached_result_flags()\fP returns the flags associated with the
current result object.
.sp
-\fBmemcached_result_cas()\fP returns the cas associated with the
+\fI\%memcached_result_cas()\fP returns the cas associated with the
current result object. This value will only be available if the server
tests it.
.sp
\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
-\fBvoid memcached_result_set_flags()\fP takes a result structure and stores
-a new value for the flags field.
+\fI\%memcached_result_set_flags()\fP takes a result structure and stores a new
+value for the flags field.
.sp
-\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).
+\fI\%memcached_result_set_expiration()\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
.SH RETURN
.sp
Varies, see particular functions. All structures must have
-\fBmemcached_result_free()\fP called on them for cleanup purposes. Failure
+\fI\%memcached_result_free()\fP called on them for cleanup purposes. Failure
to do this will result in leaked memory.
.SH HOME
.sp
-.TH "MEMCACHED_RESULT_FLAGS" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_RESULT_FLAGS" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_result_flags \- Working with result sets
.
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_result_st * memcached_result_create (memcached_st *ptr, memcached_result_st *result);
+.B \fI\%memcached_result_st\fP * memcached_result_create(memcached_st\fI\ *ptr\fP, \fI\%memcached_result_st\fP\fI\ *result\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B void memcached_result_free (memcached_result_st *result);
+.B void memcached_result_free(\fI\%memcached_result_st\fP\fI\ *result\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B const char * memcached_result_key_value (memcached_result_st *result);
+.B const char * memcached_result_key_value(\fI\%memcached_result_st\fP\fI\ *result\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B size_t memcached_result_key_length (const memcached_result_st *result);
+.B size_t memcached_result_key_length(const \fI\%memcached_result_st\fP\fI\ *result\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B const char *memcached_result_value (memcached_result_st *ptr);
+.B const char *memcached_result_value(\fI\%memcached_result_st\fP\fI\ *ptr\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B size_t memcached_result_length (const memcached_result_st *ptr);
+.B size_t memcached_result_length(const \fI\%memcached_result_st\fP\fI\ *ptr\fP)
.UNINDENT
.INDENT 0.0
.TP
.UNINDENT
.INDENT 0.0
.TP
-.B uint64_t memcached_result_cas (const memcached_result_st *result);
+.B uint64_t memcached_result_cas(const \fI\%memcached_result_st\fP\fI\ *result\fP)
.UNINDENT
.INDENT 0.0
.TP
The structure of \fI\%memcached_result_st\fP has been encapsulated, you should
not write code to directly access members of the structure.
.sp
-\fBmemcached_result_create()\fP will either allocate memory for a
+\fI\%memcached_result_create()\fP will either allocate memory for a
\fI\%memcached_result_st\fP or will initialize a structure passed to it.
.sp
-\fBmemcached_result_free()\fP will deallocate any memory attached to the
+\fI\%memcached_result_free()\fP will deallocate any memory attached to the
structure. If the structure was also allocated, it will deallocate it.
.sp
-\fBmemcached_result_key_value()\fP returns the key value associated with the
+\fI\%memcached_result_key_value()\fP returns the key value associated with the
current result object.
.sp
-\fBmemcached_result_key_length()\fP returns the key length associated with
+\fI\%memcached_result_key_length()\fP returns the key length associated with
the current result object.
.sp
-\fBmemcached_result_value()\fP returns the result value associated with the
+\fI\%memcached_result_value()\fP returns the result value associated with the
current result object.
.sp
-\fBmemcached_result_length()\fP returns the result length associated with
+\fI\%memcached_result_length()\fP returns the result length associated with
the current result object.
.sp
\fI\%memcached_result_flags()\fP returns the flags associated with the
current result object.
.sp
-\fBmemcached_result_cas()\fP returns the cas associated with the
+\fI\%memcached_result_cas()\fP returns the cas associated with the
current result object. This value will only be available if the server
tests it.
.sp
\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
-\fBvoid memcached_result_set_flags()\fP takes a result structure and stores
-a new value for the flags field.
+\fI\%memcached_result_set_flags()\fP takes a result structure and stores a new
+value for the flags field.
.sp
-\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).
+\fI\%memcached_result_set_expiration()\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
.SH RETURN
.sp
Varies, see particular functions. All structures must have
-\fBmemcached_result_free()\fP called on them for cleanup purposes. Failure
+\fI\%memcached_result_free()\fP called on them for cleanup purposes. Failure
to do this will result in leaked memory.
.SH HOME
.sp
-.TH "MEMCACHED_RESULT_FREE" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_RESULT_FREE" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_result_free \- Working with result sets
.
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_result_st * memcached_result_create (memcached_st *ptr, memcached_result_st *result);
+.B \fI\%memcached_result_st\fP * memcached_result_create(memcached_st\fI\ *ptr\fP, \fI\%memcached_result_st\fP\fI\ *result\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B void memcached_result_free (memcached_result_st *result);
+.B void memcached_result_free(\fI\%memcached_result_st\fP\fI\ *result\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B const char * memcached_result_key_value (memcached_result_st *result);
+.B const char * memcached_result_key_value(\fI\%memcached_result_st\fP\fI\ *result\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B size_t memcached_result_key_length (const memcached_result_st *result);
+.B size_t memcached_result_key_length(const \fI\%memcached_result_st\fP\fI\ *result\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B const char *memcached_result_value (memcached_result_st *ptr);
+.B const char *memcached_result_value(\fI\%memcached_result_st\fP\fI\ *ptr\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B size_t memcached_result_length (const memcached_result_st *ptr);
+.B size_t memcached_result_length(const \fI\%memcached_result_st\fP\fI\ *ptr\fP)
.UNINDENT
.INDENT 0.0
.TP
.UNINDENT
.INDENT 0.0
.TP
-.B uint64_t memcached_result_cas (const memcached_result_st *result);
+.B uint64_t memcached_result_cas(const \fI\%memcached_result_st\fP\fI\ *result\fP)
.UNINDENT
.INDENT 0.0
.TP
The structure of \fI\%memcached_result_st\fP has been encapsulated, you should
not write code to directly access members of the structure.
.sp
-\fBmemcached_result_create()\fP will either allocate memory for a
+\fI\%memcached_result_create()\fP will either allocate memory for a
\fI\%memcached_result_st\fP or will initialize a structure passed to it.
.sp
-\fBmemcached_result_free()\fP will deallocate any memory attached to the
+\fI\%memcached_result_free()\fP will deallocate any memory attached to the
structure. If the structure was also allocated, it will deallocate it.
.sp
-\fBmemcached_result_key_value()\fP returns the key value associated with the
+\fI\%memcached_result_key_value()\fP returns the key value associated with the
current result object.
.sp
-\fBmemcached_result_key_length()\fP returns the key length associated with
+\fI\%memcached_result_key_length()\fP returns the key length associated with
the current result object.
.sp
-\fBmemcached_result_value()\fP returns the result value associated with the
+\fI\%memcached_result_value()\fP returns the result value associated with the
current result object.
.sp
-\fBmemcached_result_length()\fP returns the result length associated with
+\fI\%memcached_result_length()\fP returns the result length associated with
the current result object.
.sp
\fI\%memcached_result_flags()\fP returns the flags associated with the
current result object.
.sp
-\fBmemcached_result_cas()\fP returns the cas associated with the
+\fI\%memcached_result_cas()\fP returns the cas associated with the
current result object. This value will only be available if the server
tests it.
.sp
\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
-\fBvoid memcached_result_set_flags()\fP takes a result structure and stores
-a new value for the flags field.
+\fI\%memcached_result_set_flags()\fP takes a result structure and stores a new
+value for the flags field.
.sp
-\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).
+\fI\%memcached_result_set_expiration()\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
.SH RETURN
.sp
Varies, see particular functions. All structures must have
-\fBmemcached_result_free()\fP called on them for cleanup purposes. Failure
+\fI\%memcached_result_free()\fP called on them for cleanup purposes. Failure
to do this will result in leaked memory.
.SH HOME
.sp
-.TH "MEMCACHED_RESULT_KEY_LENGTH" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_RESULT_KEY_LENGTH" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_result_key_length \- Working with result sets
.
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_result_st * memcached_result_create (memcached_st *ptr, memcached_result_st *result);
+.B \fI\%memcached_result_st\fP * memcached_result_create(memcached_st\fI\ *ptr\fP, \fI\%memcached_result_st\fP\fI\ *result\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B void memcached_result_free (memcached_result_st *result);
+.B void memcached_result_free(\fI\%memcached_result_st\fP\fI\ *result\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B const char * memcached_result_key_value (memcached_result_st *result);
+.B const char * memcached_result_key_value(\fI\%memcached_result_st\fP\fI\ *result\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B size_t memcached_result_key_length (const memcached_result_st *result);
+.B size_t memcached_result_key_length(const \fI\%memcached_result_st\fP\fI\ *result\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B const char *memcached_result_value (memcached_result_st *ptr);
+.B const char *memcached_result_value(\fI\%memcached_result_st\fP\fI\ *ptr\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B size_t memcached_result_length (const memcached_result_st *ptr);
+.B size_t memcached_result_length(const \fI\%memcached_result_st\fP\fI\ *ptr\fP)
.UNINDENT
.INDENT 0.0
.TP
.UNINDENT
.INDENT 0.0
.TP
-.B uint64_t memcached_result_cas (const memcached_result_st *result);
+.B uint64_t memcached_result_cas(const \fI\%memcached_result_st\fP\fI\ *result\fP)
.UNINDENT
.INDENT 0.0
.TP
The structure of \fI\%memcached_result_st\fP has been encapsulated, you should
not write code to directly access members of the structure.
.sp
-\fBmemcached_result_create()\fP will either allocate memory for a
+\fI\%memcached_result_create()\fP will either allocate memory for a
\fI\%memcached_result_st\fP or will initialize a structure passed to it.
.sp
-\fBmemcached_result_free()\fP will deallocate any memory attached to the
+\fI\%memcached_result_free()\fP will deallocate any memory attached to the
structure. If the structure was also allocated, it will deallocate it.
.sp
-\fBmemcached_result_key_value()\fP returns the key value associated with the
+\fI\%memcached_result_key_value()\fP returns the key value associated with the
current result object.
.sp
-\fBmemcached_result_key_length()\fP returns the key length associated with
+\fI\%memcached_result_key_length()\fP returns the key length associated with
the current result object.
.sp
-\fBmemcached_result_value()\fP returns the result value associated with the
+\fI\%memcached_result_value()\fP returns the result value associated with the
current result object.
.sp
-\fBmemcached_result_length()\fP returns the result length associated with
+\fI\%memcached_result_length()\fP returns the result length associated with
the current result object.
.sp
\fI\%memcached_result_flags()\fP returns the flags associated with the
current result object.
.sp
-\fBmemcached_result_cas()\fP returns the cas associated with the
+\fI\%memcached_result_cas()\fP returns the cas associated with the
current result object. This value will only be available if the server
tests it.
.sp
\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
-\fBvoid memcached_result_set_flags()\fP takes a result structure and stores
-a new value for the flags field.
+\fI\%memcached_result_set_flags()\fP takes a result structure and stores a new
+value for the flags field.
.sp
-\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).
+\fI\%memcached_result_set_expiration()\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
.SH RETURN
.sp
Varies, see particular functions. All structures must have
-\fBmemcached_result_free()\fP called on them for cleanup purposes. Failure
+\fI\%memcached_result_free()\fP called on them for cleanup purposes. Failure
to do this will result in leaked memory.
.SH HOME
.sp
-.TH "MEMCACHED_RESULT_KEY_VALUE" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_RESULT_KEY_VALUE" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_result_key_value \- Working with result sets
.
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_result_st * memcached_result_create (memcached_st *ptr, memcached_result_st *result);
+.B \fI\%memcached_result_st\fP * memcached_result_create(memcached_st\fI\ *ptr\fP, \fI\%memcached_result_st\fP\fI\ *result\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B void memcached_result_free (memcached_result_st *result);
+.B void memcached_result_free(\fI\%memcached_result_st\fP\fI\ *result\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B const char * memcached_result_key_value (memcached_result_st *result);
+.B const char * memcached_result_key_value(\fI\%memcached_result_st\fP\fI\ *result\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B size_t memcached_result_key_length (const memcached_result_st *result);
+.B size_t memcached_result_key_length(const \fI\%memcached_result_st\fP\fI\ *result\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B const char *memcached_result_value (memcached_result_st *ptr);
+.B const char *memcached_result_value(\fI\%memcached_result_st\fP\fI\ *ptr\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B size_t memcached_result_length (const memcached_result_st *ptr);
+.B size_t memcached_result_length(const \fI\%memcached_result_st\fP\fI\ *ptr\fP)
.UNINDENT
.INDENT 0.0
.TP
.UNINDENT
.INDENT 0.0
.TP
-.B uint64_t memcached_result_cas (const memcached_result_st *result);
+.B uint64_t memcached_result_cas(const \fI\%memcached_result_st\fP\fI\ *result\fP)
.UNINDENT
.INDENT 0.0
.TP
The structure of \fI\%memcached_result_st\fP has been encapsulated, you should
not write code to directly access members of the structure.
.sp
-\fBmemcached_result_create()\fP will either allocate memory for a
+\fI\%memcached_result_create()\fP will either allocate memory for a
\fI\%memcached_result_st\fP or will initialize a structure passed to it.
.sp
-\fBmemcached_result_free()\fP will deallocate any memory attached to the
+\fI\%memcached_result_free()\fP will deallocate any memory attached to the
structure. If the structure was also allocated, it will deallocate it.
.sp
-\fBmemcached_result_key_value()\fP returns the key value associated with the
+\fI\%memcached_result_key_value()\fP returns the key value associated with the
current result object.
.sp
-\fBmemcached_result_key_length()\fP returns the key length associated with
+\fI\%memcached_result_key_length()\fP returns the key length associated with
the current result object.
.sp
-\fBmemcached_result_value()\fP returns the result value associated with the
+\fI\%memcached_result_value()\fP returns the result value associated with the
current result object.
.sp
-\fBmemcached_result_length()\fP returns the result length associated with
+\fI\%memcached_result_length()\fP returns the result length associated with
the current result object.
.sp
\fI\%memcached_result_flags()\fP returns the flags associated with the
current result object.
.sp
-\fBmemcached_result_cas()\fP returns the cas associated with the
+\fI\%memcached_result_cas()\fP returns the cas associated with the
current result object. This value will only be available if the server
tests it.
.sp
\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
-\fBvoid memcached_result_set_flags()\fP takes a result structure and stores
-a new value for the flags field.
+\fI\%memcached_result_set_flags()\fP takes a result structure and stores a new
+value for the flags field.
.sp
-\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).
+\fI\%memcached_result_set_expiration()\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
.SH RETURN
.sp
Varies, see particular functions. All structures must have
-\fBmemcached_result_free()\fP called on them for cleanup purposes. Failure
+\fI\%memcached_result_free()\fP called on them for cleanup purposes. Failure
to do this will result in leaked memory.
.SH HOME
.sp
-.TH "MEMCACHED_RESULT_LENGTH" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_RESULT_LENGTH" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_result_length \- Working with result sets
.
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_result_st * memcached_result_create (memcached_st *ptr, memcached_result_st *result);
+.B \fI\%memcached_result_st\fP * memcached_result_create(memcached_st\fI\ *ptr\fP, \fI\%memcached_result_st\fP\fI\ *result\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B void memcached_result_free (memcached_result_st *result);
+.B void memcached_result_free(\fI\%memcached_result_st\fP\fI\ *result\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B const char * memcached_result_key_value (memcached_result_st *result);
+.B const char * memcached_result_key_value(\fI\%memcached_result_st\fP\fI\ *result\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B size_t memcached_result_key_length (const memcached_result_st *result);
+.B size_t memcached_result_key_length(const \fI\%memcached_result_st\fP\fI\ *result\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B const char *memcached_result_value (memcached_result_st *ptr);
+.B const char *memcached_result_value(\fI\%memcached_result_st\fP\fI\ *ptr\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B size_t memcached_result_length (const memcached_result_st *ptr);
+.B size_t memcached_result_length(const \fI\%memcached_result_st\fP\fI\ *ptr\fP)
.UNINDENT
.INDENT 0.0
.TP
.UNINDENT
.INDENT 0.0
.TP
-.B uint64_t memcached_result_cas (const memcached_result_st *result);
+.B uint64_t memcached_result_cas(const \fI\%memcached_result_st\fP\fI\ *result\fP)
.UNINDENT
.INDENT 0.0
.TP
The structure of \fI\%memcached_result_st\fP has been encapsulated, you should
not write code to directly access members of the structure.
.sp
-\fBmemcached_result_create()\fP will either allocate memory for a
+\fI\%memcached_result_create()\fP will either allocate memory for a
\fI\%memcached_result_st\fP or will initialize a structure passed to it.
.sp
-\fBmemcached_result_free()\fP will deallocate any memory attached to the
+\fI\%memcached_result_free()\fP will deallocate any memory attached to the
structure. If the structure was also allocated, it will deallocate it.
.sp
-\fBmemcached_result_key_value()\fP returns the key value associated with the
+\fI\%memcached_result_key_value()\fP returns the key value associated with the
current result object.
.sp
-\fBmemcached_result_key_length()\fP returns the key length associated with
+\fI\%memcached_result_key_length()\fP returns the key length associated with
the current result object.
.sp
-\fBmemcached_result_value()\fP returns the result value associated with the
+\fI\%memcached_result_value()\fP returns the result value associated with the
current result object.
.sp
-\fBmemcached_result_length()\fP returns the result length associated with
+\fI\%memcached_result_length()\fP returns the result length associated with
the current result object.
.sp
\fI\%memcached_result_flags()\fP returns the flags associated with the
current result object.
.sp
-\fBmemcached_result_cas()\fP returns the cas associated with the
+\fI\%memcached_result_cas()\fP returns the cas associated with the
current result object. This value will only be available if the server
tests it.
.sp
\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
-\fBvoid memcached_result_set_flags()\fP takes a result structure and stores
-a new value for the flags field.
+\fI\%memcached_result_set_flags()\fP takes a result structure and stores a new
+value for the flags field.
.sp
-\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).
+\fI\%memcached_result_set_expiration()\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
.SH RETURN
.sp
Varies, see particular functions. All structures must have
-\fBmemcached_result_free()\fP called on them for cleanup purposes. Failure
+\fI\%memcached_result_free()\fP called on them for cleanup purposes. Failure
to do this will result in leaked memory.
.SH HOME
.sp
-.TH "MEMCACHED_RESULT_ST" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_RESULT_ST" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_result_st \- Working with result sets
.
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_result_st * memcached_result_create (memcached_st *ptr, memcached_result_st *result);
+.B \fI\%memcached_result_st\fP * memcached_result_create(memcached_st\fI\ *ptr\fP, \fI\%memcached_result_st\fP\fI\ *result\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B void memcached_result_free (memcached_result_st *result);
+.B void memcached_result_free(\fI\%memcached_result_st\fP\fI\ *result\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B const char * memcached_result_key_value (memcached_result_st *result);
+.B const char * memcached_result_key_value(\fI\%memcached_result_st\fP\fI\ *result\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B size_t memcached_result_key_length (const memcached_result_st *result);
+.B size_t memcached_result_key_length(const \fI\%memcached_result_st\fP\fI\ *result\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B const char *memcached_result_value (memcached_result_st *ptr);
+.B const char *memcached_result_value(\fI\%memcached_result_st\fP\fI\ *ptr\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B size_t memcached_result_length (const memcached_result_st *ptr);
+.B size_t memcached_result_length(const \fI\%memcached_result_st\fP\fI\ *ptr\fP)
.UNINDENT
.INDENT 0.0
.TP
.UNINDENT
.INDENT 0.0
.TP
-.B uint64_t memcached_result_cas (const memcached_result_st *result);
+.B uint64_t memcached_result_cas(const \fI\%memcached_result_st\fP\fI\ *result\fP)
.UNINDENT
.INDENT 0.0
.TP
The structure of \fI\%memcached_result_st\fP has been encapsulated, you should
not write code to directly access members of the structure.
.sp
-\fBmemcached_result_create()\fP will either allocate memory for a
+\fI\%memcached_result_create()\fP will either allocate memory for a
\fI\%memcached_result_st\fP or will initialize a structure passed to it.
.sp
-\fBmemcached_result_free()\fP will deallocate any memory attached to the
+\fI\%memcached_result_free()\fP will deallocate any memory attached to the
structure. If the structure was also allocated, it will deallocate it.
.sp
-\fBmemcached_result_key_value()\fP returns the key value associated with the
+\fI\%memcached_result_key_value()\fP returns the key value associated with the
current result object.
.sp
-\fBmemcached_result_key_length()\fP returns the key length associated with
+\fI\%memcached_result_key_length()\fP returns the key length associated with
the current result object.
.sp
-\fBmemcached_result_value()\fP returns the result value associated with the
+\fI\%memcached_result_value()\fP returns the result value associated with the
current result object.
.sp
-\fBmemcached_result_length()\fP returns the result length associated with
+\fI\%memcached_result_length()\fP returns the result length associated with
the current result object.
.sp
\fI\%memcached_result_flags()\fP returns the flags associated with the
current result object.
.sp
-\fBmemcached_result_cas()\fP returns the cas associated with the
+\fI\%memcached_result_cas()\fP returns the cas associated with the
current result object. This value will only be available if the server
tests it.
.sp
\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
-\fBvoid memcached_result_set_flags()\fP takes a result structure and stores
-a new value for the flags field.
+\fI\%memcached_result_set_flags()\fP takes a result structure and stores a new
+value for the flags field.
.sp
-\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).
+\fI\%memcached_result_set_expiration()\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
.SH RETURN
.sp
Varies, see particular functions. All structures must have
-\fBmemcached_result_free()\fP called on them for cleanup purposes. Failure
+\fI\%memcached_result_free()\fP called on them for cleanup purposes. Failure
to do this will result in leaked memory.
.SH HOME
.sp
-.TH "MEMCACHED_RESULT_VALUE" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_RESULT_VALUE" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_result_value \- Working with result sets
.
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_result_st * memcached_result_create (memcached_st *ptr, memcached_result_st *result);
+.B \fI\%memcached_result_st\fP * memcached_result_create(memcached_st\fI\ *ptr\fP, \fI\%memcached_result_st\fP\fI\ *result\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B void memcached_result_free (memcached_result_st *result);
+.B void memcached_result_free(\fI\%memcached_result_st\fP\fI\ *result\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B const char * memcached_result_key_value (memcached_result_st *result);
+.B const char * memcached_result_key_value(\fI\%memcached_result_st\fP\fI\ *result\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B size_t memcached_result_key_length (const memcached_result_st *result);
+.B size_t memcached_result_key_length(const \fI\%memcached_result_st\fP\fI\ *result\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B const char *memcached_result_value (memcached_result_st *ptr);
+.B const char *memcached_result_value(\fI\%memcached_result_st\fP\fI\ *ptr\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B size_t memcached_result_length (const memcached_result_st *ptr);
+.B size_t memcached_result_length(const \fI\%memcached_result_st\fP\fI\ *ptr\fP)
.UNINDENT
.INDENT 0.0
.TP
.UNINDENT
.INDENT 0.0
.TP
-.B uint64_t memcached_result_cas (const memcached_result_st *result);
+.B uint64_t memcached_result_cas(const \fI\%memcached_result_st\fP\fI\ *result\fP)
.UNINDENT
.INDENT 0.0
.TP
The structure of \fI\%memcached_result_st\fP has been encapsulated, you should
not write code to directly access members of the structure.
.sp
-\fBmemcached_result_create()\fP will either allocate memory for a
+\fI\%memcached_result_create()\fP will either allocate memory for a
\fI\%memcached_result_st\fP or will initialize a structure passed to it.
.sp
-\fBmemcached_result_free()\fP will deallocate any memory attached to the
+\fI\%memcached_result_free()\fP will deallocate any memory attached to the
structure. If the structure was also allocated, it will deallocate it.
.sp
-\fBmemcached_result_key_value()\fP returns the key value associated with the
+\fI\%memcached_result_key_value()\fP returns the key value associated with the
current result object.
.sp
-\fBmemcached_result_key_length()\fP returns the key length associated with
+\fI\%memcached_result_key_length()\fP returns the key length associated with
the current result object.
.sp
-\fBmemcached_result_value()\fP returns the result value associated with the
+\fI\%memcached_result_value()\fP returns the result value associated with the
current result object.
.sp
-\fBmemcached_result_length()\fP returns the result length associated with
+\fI\%memcached_result_length()\fP returns the result length associated with
the current result object.
.sp
\fI\%memcached_result_flags()\fP returns the flags associated with the
current result object.
.sp
-\fBmemcached_result_cas()\fP returns the cas associated with the
+\fI\%memcached_result_cas()\fP returns the cas associated with the
current result object. This value will only be available if the server
tests it.
.sp
\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
-\fBvoid memcached_result_set_flags()\fP takes a result structure and stores
-a new value for the flags field.
+\fI\%memcached_result_set_flags()\fP takes a result structure and stores a new
+value for the flags field.
.sp
-\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).
+\fI\%memcached_result_set_expiration()\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
.SH RETURN
.sp
Varies, see particular functions. All structures must have
-\fBmemcached_result_free()\fP called on them for cleanup purposes. Failure
+\fI\%memcached_result_free()\fP called on them for cleanup purposes. Failure
to do this will result in leaked memory.
.SH HOME
.sp
-.TH "MEMCACHED_RETURN_T" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_RETURN_T" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_return_t \- Return type values
.
.UNINDENT
.INDENT 0.0
.TP
-.B const char *libmemcached_strerror(libmemcached_return_t\fI\ rc\fP)
+.B const char *libmemcached_strerror(\fI\%memcached_return_t\fP\fI\ rc\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B bool libmemcached_success(libmemcached_return_t\fI\ rc\fP)
+.B bool libmemcached_success(\fI\%memcached_return_t\fP\fI\ rc\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B bool libmemcached_failure(libmemcached_return_t\fI\ rc\fP)
+.B bool libmemcached_failure(\fI\%memcached_return_t\fP\fI\ rc\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B bool libmemcache_continue(libmemcached_return_t\fI\ rc\fP)
-.UNINDENT
-.sp
-\fBmemcached_success()\fP return true if \fI\%MEMCACHED_SUCCESS\fP tested true.
-.sp
-\fBmemcached_failure()\fP return true if any value other then \fI\%MEMCACHED_SUCCESS\fP was provided.
-.SS Libmemcached return types:
-.INDENT 0.0
-.TP
-.B MEMCACHED_SUCCESS
-.UNINDENT
-.sp
-Success
-.INDENT 0.0
-.TP
-.B MEMCACHED_FAILURE
+.B bool libmemcache_continue(\fI\%memcached_return_t\fP\fI\ rc\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B MEMCACHED_HOST_LOOKUP_FAILURE
+.B bool memcached_success(\fI\%memcached_return_t\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B MEMCACHED_CONNECTION_FAILURE
-.UNINDENT
-.INDENT 0.0
-.TP
-.B MEMCACHED_CONNECTION_BIND_FAILURE
+.B bool memcached_failure(\fI\%memcached_return_t\fP)
.UNINDENT
.sp
-Deprecated since version <0.30.
-.INDENT 0.0
-.TP
-.B MEMCACHED_WRITE_FAILURE
-.UNINDENT
-.INDENT 0.0
-.TP
-.B MEMCACHED_READ_FAILURE
-.UNINDENT
-.INDENT 0.0
-.TP
-.B MEMCACHED_UNKNOWN_READ_FAILURE
-.UNINDENT
-.INDENT 0.0
-.TP
-.B MEMCACHED_PROTOCOL_ERROR
-.UNINDENT
-.INDENT 0.0
-.TP
-.B MEMCACHED_CLIENT_ERROR
-.UNINDENT
-.INDENT 0.0
-.TP
-.B MEMCACHED_SERVER_ERROR
-.UNINDENT
-.INDENT 0.0
-.TP
-.B MEMCACHED_CONNECTION_SOCKET_CREATE_FAILURE
-.UNINDENT
+\fI\%memcached_success()\fP return true if \fBMEMCACHED_SUCCESS\fP tested true.
.sp
-Deprecated since version <0.30.
-.INDENT 0.0
-.TP
-.B MEMCACHED_DATA_EXISTS
-.UNINDENT
-.INDENT 0.0
-.TP
-.B MEMCACHED_DATA_DOES_NOT_EXIST
-.UNINDENT
-.INDENT 0.0
-.TP
-.B MEMCACHED_NOTSTORED
-.UNINDENT
-.INDENT 0.0
-.TP
-.B MEMCACHED_STORED
-.UNINDENT
-.INDENT 0.0
-.TP
-.B MEMCACHED_NOTFOUND
-.UNINDENT
-.INDENT 0.0
-.TP
-.B MEMCACHED_MEMORY_ALLOCATION_FAILURE
-.UNINDENT
-.INDENT 0.0
-.TP
-.B MEMCACHED_PARTIAL_READ
-.UNINDENT
-.INDENT 0.0
-.TP
-.B MEMCACHED_SOME_ERRORS
-.UNINDENT
-.INDENT 0.0
-.TP
-.B MEMCACHED_NO_SERVERS
-.UNINDENT
-.INDENT 0.0
-.TP
-.B MEMCACHED_END
-.UNINDENT
-.INDENT 0.0
-.TP
-.B MEMCACHED_DELETED
-.UNINDENT
-.INDENT 0.0
-.TP
-.B MEMCACHED_VALUE
-.UNINDENT
-.INDENT 0.0
-.TP
-.B MEMCACHED_STAT
-.UNINDENT
-.INDENT 0.0
-.TP
-.B MEMCACHED_ITEM
-.UNINDENT
-.INDENT 0.0
-.TP
-.B MEMCACHED_ERRNO
-.UNINDENT
-.INDENT 0.0
-.TP
-.B MEMCACHED_FAIL_UNIX_SOCKET
-.UNINDENT
+\fI\%memcached_failure()\fP return true if any value other then \fBMEMCACHED_SUCCESS\fP was provided.
+.SS Libmemcached return types:
.sp
-Deprecated since version <0.30.
-.INDENT 0.0
-.TP
-.B MEMCACHED_NOT_SUPPORTED
-.UNINDENT
-.INDENT 0.0
-.TP
-.B MEMCACHED_NO_KEY_PROVIDED
-.UNINDENT
+\fBMEMCACHED_SUCCESS\fP
.sp
-Deprecated since version <0.30: Use \fI\%MEMCACHED_BAD_KEY_PROVIDED\fP instead.
-.INDENT 0.0
-.TP
-.B MEMCACHED_FETCH_NOTFINISHED
-.UNINDENT
-.INDENT 0.0
-.TP
-.B MEMCACHED_TIMEOUT
-Connection to server timed out.
-.UNINDENT
-.INDENT 0.0
-.TP
-.B MEMCACHED_BUFFERED
-.UNINDENT
-.INDENT 0.0
-.TP
-.B MEMCACHED_BAD_KEY_PROVIDED
-.UNINDENT
-.INDENT 0.0
-.TP
-.B MEMCACHED_INVALID_HOST_PROTOCOL
-.UNINDENT
-.INDENT 0.0
-.TP
-.B MEMCACHED_SERVER_MARKED_DEAD
-.UNINDENT
-.INDENT 0.0
-.TP
-.B MEMCACHED_UNKNOWN_STAT_KEY
-.UNINDENT
-.INDENT 0.0
-.TP
-.B MEMCACHED_E2BIG
-.UNINDENT
-.INDENT 0.0
-.TP
-.B MEMCACHED_INVALID_ARGUMENTS
-.UNINDENT
-.INDENT 0.0
-.TP
-.B MEMCACHED_KEY_TOO_BIG
-.UNINDENT
-.INDENT 0.0
-.TP
-.B MEMCACHED_AUTH_PROBLEM
-.UNINDENT
-.INDENT 0.0
-.TP
-.B MEMCACHED_AUTH_FAILURE
-.UNINDENT
-.INDENT 0.0
-.TP
-.B MEMCACHED_AUTH_CONTINUE
-.UNINDENT
-.INDENT 0.0
-.TP
-.B MEMCACHED_PARSE_ERROR
-.UNINDENT
-.INDENT 0.0
-.TP
-.B MEMCACHED_PARSE_USER_ERROR
-.UNINDENT
-.INDENT 0.0
-.TP
-.B MEMCACHED_DEPRECATED
-.UNINDENT
+\fBMEMCACHED_FAILURE\fP
+.sp
+\fBMEMCACHED_HOST_LOOKUP_FAILURE\fP
+.sp
+\fBMEMCACHED_CONNECTION_FAILURE\fP
+.sp
+\fBMEMCACHED_CONNECTION_BIND_FAILURE\fP
+.sp
+\fBMEMCACHED_WRITE_FAILURE\fP
+.sp
+\fBMEMCACHED_READ_FAILURE\fP
+.sp
+\fBMEMCACHED_UNKNOWN_READ_FAILURE\fP
+.sp
+\fBMEMCACHED_PROTOCOL_ERROR\fP
+.sp
+\fBMEMCACHED_CLIENT_ERROR\fP
+.sp
+\fBMEMCACHED_SERVER_ERROR\fP
+.sp
+\fBMEMCACHED_CONNECTION_SOCKET_CREATE_FAILURE\fP
+.sp
+\fBMEMCACHED_DATA_EXISTS\fP
+.sp
+\fBMEMCACHED_DATA_DOES_NOT_EXIST\fP
+.sp
+\fBMEMCACHED_NOTSTORED\fP
+.sp
+\fBMEMCACHED_STORED\fP
+.sp
+\fBMEMCACHED_NOTFOUND\fP
+.sp
+\fBMEMCACHED_MEMORY_ALLOCATION_FAILURE\fP
+.sp
+\fBMEMCACHED_PARTIAL_READ\fP
+.sp
+\fBMEMCACHED_SOME_ERRORS\fP
+.sp
+\fBMEMCACHED_NO_SERVERS\fP
+.sp
+\fBMEMCACHED_END\fP
+.sp
+\fBMEMCACHED_DELETED\fP
+.sp
+\fBMEMCACHED_VALUE\fP
+.sp
+\fBMEMCACHED_STAT\fP
+.sp
+\fBMEMCACHED_ITEM\fP
+.sp
+\fBMEMCACHED_ERRNO\fP
+.sp
+\fBMEMCACHED_FAIL_UNIX_SOCKET\fP
+.sp
+\fBMEMCACHED_NOT_SUPPORTED\fP
+.sp
+\fBMEMCACHED_NO_KEY_PROVIDED\fP
+.sp
+\fBMEMCACHED_FETCH_NOTFINISHED\fP
+.sp
+\fBMEMCACHED_TIMEOUT\fP
+.sp
+\fBMEMCACHED_BUFFERED\fP
+.sp
+\fBMEMCACHED_BAD_KEY_PROVIDED\fP
+.sp
+\fBMEMCACHED_INVALID_HOST_PROTOCOL\fP
+.sp
+\fBMEMCACHED_SERVER_MARKED_DEAD\fP
+.sp
+\fBMEMCACHED_UNKNOWN_STAT_KEY\fP
+.sp
+\fBMEMCACHED_E2BIG\fP
+.sp
+\fBMEMCACHED_INVALID_ARGUMENTS\fP
+.sp
+\fBMEMCACHED_KEY_TOO_BIG\fP
+.sp
+\fBMEMCACHED_AUTH_PROBLEM\fP
+.sp
+\fBMEMCACHED_AUTH_FAILURE\fP
+.sp
+\fBMEMCACHED_AUTH_CONTINUE\fP
+.sp
+\fBMEMCACHED_PARSE_ERROR\fP
+.sp
+\fBMEMCACHED_PARSE_USER_ERROR\fP
+.sp
+\fBMEMCACHED_DEPRECATED\fP
.SH SEE ALSO
.sp
-\fImemcached(8)\fP \fIlibmemcached(3)\fP \fImemcached_client_error()\fP or \fImemcached_worker_error()\fP
+\fImemcached\fP \fIlibmemcached\fP \fImemcached_client_error\fP or \fImemcached_worker_error\fP
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
-.TH "MEMCACHED_SASL" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_SASL" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_sasl \- libmemcached Documentation
.
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return memcached_set_sasl_auth_data(memcached_st\fI\ *ptr\fP, const char\fI\ *username\fP, const char\fI\ *password\fP)
+.B memcached_return_t memcached_set_sasl_auth_data(memcached_st\fI\ *ptr\fP, const char\fI\ *username\fP, const char\fI\ *password\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return memcached_destroy_sasl_auth_data(memcached_st\fI\ *ptr\fP)
+.B memcached_return_t memcached_destroy_sasl_auth_data(memcached_st\fI\ *ptr\fP)
.UNINDENT
.sp
Compile and link with \-lmemcached
\fBmemcached_free\fP to avoid a memory leak. You should NOT call
\fI\%memcached_destroy_sasl_auth_data\fP if you specify your own callback
function with \fI\%memcached_set_sasl_callbacks()\fP.
-.sp
-You as a client user have to initialize libsasl by using \fBsasl_client_init\fP before enabling it in libmemcached, and you have to shut down libsasl by
-calling \fBsasl_done()\fP when you are done using SASL from libmemcached.
.SH RETURN
.sp
-\fI\%memcached_get_sasl_callbacks()\fP returns the callbacks currently used
-by this memcached handle. \fBmemcached_get_sasl_set_auth_data()\fP returns \fBMEMCACHED_SUCCESS\fP upon success.
+\fI\%memcached_get_sasl_callbacks()\fP returns the callbacks currently used by
+this memcached handle. \fI\%memcached_set_sasl_auth_data()\fP returns
+\fBMEMCACHED_SUCCESS\fP upon success.
.SH HOME
.sp
To find out more information please check:
-.TH "MEMCACHED_SASL_SET_AUTH_DATA" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_SASL_SET_AUTH_DATA" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_sasl_set_auth_data \- libmemcached Documentation
.
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return memcached_set_sasl_auth_data(memcached_st\fI\ *ptr\fP, const char\fI\ *username\fP, const char\fI\ *password\fP)
+.B memcached_return_t memcached_set_sasl_auth_data(memcached_st\fI\ *ptr\fP, const char\fI\ *username\fP, const char\fI\ *password\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return memcached_destroy_sasl_auth_data(memcached_st\fI\ *ptr\fP)
+.B memcached_return_t memcached_destroy_sasl_auth_data(memcached_st\fI\ *ptr\fP)
.UNINDENT
.sp
Compile and link with \-lmemcached
\fBmemcached_free\fP to avoid a memory leak. You should NOT call
\fI\%memcached_destroy_sasl_auth_data\fP if you specify your own callback
function with \fI\%memcached_set_sasl_callbacks()\fP.
-.sp
-You as a client user have to initialize libsasl by using \fBsasl_client_init\fP before enabling it in libmemcached, and you have to shut down libsasl by
-calling \fBsasl_done()\fP when you are done using SASL from libmemcached.
.SH RETURN
.sp
-\fI\%memcached_get_sasl_callbacks()\fP returns the callbacks currently used
-by this memcached handle. \fBmemcached_get_sasl_set_auth_data()\fP returns \fBMEMCACHED_SUCCESS\fP upon success.
+\fI\%memcached_get_sasl_callbacks()\fP returns the callbacks currently used by
+this memcached handle. \fI\%memcached_set_sasl_auth_data()\fP returns
+\fBMEMCACHED_SUCCESS\fP upon success.
.SH HOME
.sp
To find out more information please check:
-.TH "MEMCACHED_SERVER_ADD" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_SERVER_ADD" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_server_add \- libmemcached Documentation
.
the list) are not saved.
.sp
\fI\%memcached_server_by_key()\fP allows you to provide a key and retrieve the
-server which would be used for assignment. This structure is cloned
-from its original structure and must be freed. If NULL is returned you
-should consult *error. The returning structure should be freed with
-\fBmemcached_server_free()\fP.
+server which would be used for assignment.
.sp
\fI\%memcached_server_get_last_disconnect()\fP returns a pointer to the last
server for which there was a connection problem. It does not mean this
-.TH "MEMCACHED_SERVER_ADD_UNIX_SOCKET" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_SERVER_ADD_UNIX_SOCKET" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_server_add_unix_socket \- libmemcached Documentation
.
the list) are not saved.
.sp
\fI\%memcached_server_by_key()\fP allows you to provide a key and retrieve the
-server which would be used for assignment. This structure is cloned
-from its original structure and must be freed. If NULL is returned you
-should consult *error. The returning structure should be freed with
-\fBmemcached_server_free()\fP.
+server which would be used for assignment.
.sp
\fI\%memcached_server_get_last_disconnect()\fP returns a pointer to the last
server for which there was a connection problem. It does not mean this
-.TH "MEMCACHED_SERVER_COUNT" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_SERVER_COUNT" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_server_count \- libmemcached Documentation
.
the list) are not saved.
.sp
\fI\%memcached_server_by_key()\fP allows you to provide a key and retrieve the
-server which would be used for assignment. This structure is cloned
-from its original structure and must be freed. If NULL is returned you
-should consult *error. The returning structure should be freed with
-\fBmemcached_server_free()\fP.
+server which would be used for assignment.
.sp
\fI\%memcached_server_get_last_disconnect()\fP returns a pointer to the last
server for which there was a connection problem. It does not mean this
-.TH "MEMCACHED_SERVER_CURSOR" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_SERVER_CURSOR" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_server_cursor \- libmemcached Documentation
.
the list) are not saved.
.sp
\fI\%memcached_server_by_key()\fP allows you to provide a key and retrieve the
-server which would be used for assignment. This structure is cloned
-from its original structure and must be freed. If NULL is returned you
-should consult *error. The returning structure should be freed with
-\fBmemcached_server_free()\fP.
+server which would be used for assignment.
.sp
\fI\%memcached_server_get_last_disconnect()\fP returns a pointer to the last
server for which there was a connection problem. It does not mean this
-.TH "MEMCACHED_SERVER_LIST" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_SERVER_LIST" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_server_list \- libmemcached Documentation
.
the list) are not saved.
.sp
\fI\%memcached_server_by_key()\fP allows you to provide a key and retrieve the
-server which would be used for assignment. This structure is cloned
-from its original structure and must be freed. If NULL is returned you
-should consult *error. The returning structure should be freed with
-\fBmemcached_server_free()\fP.
+server which would be used for assignment.
.sp
\fI\%memcached_server_get_last_disconnect()\fP returns a pointer to the last
server for which there was a connection problem. It does not mean this
-.TH "MEMCACHED_SERVER_LIST_APPEND" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_SERVER_LIST_APPEND" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_server_list_append \- libmemcached Documentation
.
.UNINDENT
.INDENT 0.0
.TP
+.B memcached_server_list_st
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_server_st
+.UNINDENT
+.INDENT 0.0
+.TP
.B const \fI\%memcached_server_instance_st\fP memcached_server_list(memcached_st\fI\ *ptr\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B void memcached_server_list_free(memcached_server_list_st\fI\ list\fP)
+.B void memcached_server_list_free(\fI\%memcached_server_list_st\fP\fI\ list\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_server_list_st memcached_server_list_append(memcached_server_list_st\fI\ list\fP, const char\fI\ *hostname\fP, unsigned int\fI\ port\fP, memcached_return_t\fI\ *error\fP)
+.B \fI\%memcached_server_list_st\fP memcached_server_list_append(\fI\%memcached_server_list_st\fP\fI\ list\fP, const char\fI\ *hostname\fP, in_port_t\fI\ port\fP, memcached_return_t\fI\ *error\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B uint32_t memcached_server_list_count(memcached_server_list_st\fI\ list\fP)
+.B uint32_t memcached_server_list_count(\fI\%memcached_server_list_st\fP\fI\ list\fP)
.UNINDENT
.INDENT 0.0
.TP
.UNINDENT
.sp
Deprecated since version 0.39.
+.INDENT 0.0
+.TP
+.B void memcached_servers_parse()
+.UNINDENT
+.sp
+Deprecated since version 0.39.
.sp
Compile and link with \-lmemcached
.SH DESCRIPTION
.sp
libmemcached(3) operates on a list of hosts which are stored in
-\fBmemcached_server_st\fP structures. You should not modify these structures
+\fI\%memcached_server_st\fP structures. You should not modify these structures
directly. Functions are provided to modify these structures (and more can be
added, just ask!).
.sp
-\fI\%memcached_server_list()\fP is used to provide an array of all defined hosts. This was incorrectly documented as "requiring free()" up till version 0.39.
+\fI\%memcached_server_list()\fP is used to provide an array of all defined hosts. This was incorrectly documented as "requiring free" up till version 0.39.
.sp
-\fI\%memcached_server_list_free()\fP deallocates all memory associated with the array of \fBmemcached_server_st\fP that you passed to it.
+\fI\%memcached_server_list_free()\fP deallocates all memory associated with the array of \fI\%memcached_server_st\fP that you passed to it.
.sp
\fI\%memcached_server_list_append()\fP adds a server to the end of a
-\fBmemcached_server_st\fP array. On error null will be returned and the
+\fI\%memcached_server_st\fP array. On error null will be returned and the
\fBmemcached_return_t\fP pointer you passed into the function will be set with the appropriate error. If the value of port is zero, it is set to the default
port of a memcached server.
.sp
-DEPRECATED \fBmemcached_servers_parse()\fP, please see \fBmemcached()\fP
+DEPRECATED \fI\%memcached_servers_parse()\fP, please see \fBmemcached()\fP
.sp
\fI\%memcached_server_error()\fP can be used to look at the text of the last error message sent by the server to to the client.
.sp
Before version 0.39 theses functions used a memcache_server_st *. In 0.39
-memcached_server_st * was aliased to \fBmemcached_server_list_st\fP. This was done for a style reason to help clean up some concepts in the code.
+memcached_server_st * was aliased to \fI\%memcached_server_list_st\fP. This was done for a style reason to help clean up some concepts in the code.
.SH RETURN
.sp
Varies, see particular functions.
-.TH "MEMCACHED_SERVER_LIST_COUNT" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_SERVER_LIST_COUNT" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_server_list_count \- libmemcached Documentation
.
.UNINDENT
.INDENT 0.0
.TP
+.B memcached_server_list_st
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_server_st
+.UNINDENT
+.INDENT 0.0
+.TP
.B const \fI\%memcached_server_instance_st\fP memcached_server_list(memcached_st\fI\ *ptr\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B void memcached_server_list_free(memcached_server_list_st\fI\ list\fP)
+.B void memcached_server_list_free(\fI\%memcached_server_list_st\fP\fI\ list\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_server_list_st memcached_server_list_append(memcached_server_list_st\fI\ list\fP, const char\fI\ *hostname\fP, unsigned int\fI\ port\fP, memcached_return_t\fI\ *error\fP)
+.B \fI\%memcached_server_list_st\fP memcached_server_list_append(\fI\%memcached_server_list_st\fP\fI\ list\fP, const char\fI\ *hostname\fP, in_port_t\fI\ port\fP, memcached_return_t\fI\ *error\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B uint32_t memcached_server_list_count(memcached_server_list_st\fI\ list\fP)
+.B uint32_t memcached_server_list_count(\fI\%memcached_server_list_st\fP\fI\ list\fP)
.UNINDENT
.INDENT 0.0
.TP
.UNINDENT
.sp
Deprecated since version 0.39.
+.INDENT 0.0
+.TP
+.B void memcached_servers_parse()
+.UNINDENT
+.sp
+Deprecated since version 0.39.
.sp
Compile and link with \-lmemcached
.SH DESCRIPTION
.sp
libmemcached(3) operates on a list of hosts which are stored in
-\fBmemcached_server_st\fP structures. You should not modify these structures
+\fI\%memcached_server_st\fP structures. You should not modify these structures
directly. Functions are provided to modify these structures (and more can be
added, just ask!).
.sp
-\fI\%memcached_server_list()\fP is used to provide an array of all defined hosts. This was incorrectly documented as "requiring free()" up till version 0.39.
+\fI\%memcached_server_list()\fP is used to provide an array of all defined hosts. This was incorrectly documented as "requiring free" up till version 0.39.
.sp
-\fI\%memcached_server_list_free()\fP deallocates all memory associated with the array of \fBmemcached_server_st\fP that you passed to it.
+\fI\%memcached_server_list_free()\fP deallocates all memory associated with the array of \fI\%memcached_server_st\fP that you passed to it.
.sp
\fI\%memcached_server_list_append()\fP adds a server to the end of a
-\fBmemcached_server_st\fP array. On error null will be returned and the
+\fI\%memcached_server_st\fP array. On error null will be returned and the
\fBmemcached_return_t\fP pointer you passed into the function will be set with the appropriate error. If the value of port is zero, it is set to the default
port of a memcached server.
.sp
-DEPRECATED \fBmemcached_servers_parse()\fP, please see \fBmemcached()\fP
+DEPRECATED \fI\%memcached_servers_parse()\fP, please see \fBmemcached()\fP
.sp
\fI\%memcached_server_error()\fP can be used to look at the text of the last error message sent by the server to to the client.
.sp
Before version 0.39 theses functions used a memcache_server_st *. In 0.39
-memcached_server_st * was aliased to \fBmemcached_server_list_st\fP. This was done for a style reason to help clean up some concepts in the code.
+memcached_server_st * was aliased to \fI\%memcached_server_list_st\fP. This was done for a style reason to help clean up some concepts in the code.
.SH RETURN
.sp
Varies, see particular functions.
-.TH "MEMCACHED_SERVER_LIST_FREE" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_SERVER_LIST_FREE" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_server_list_free \- libmemcached Documentation
.
.UNINDENT
.INDENT 0.0
.TP
+.B memcached_server_list_st
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_server_st
+.UNINDENT
+.INDENT 0.0
+.TP
.B const \fI\%memcached_server_instance_st\fP memcached_server_list(memcached_st\fI\ *ptr\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B void memcached_server_list_free(memcached_server_list_st\fI\ list\fP)
+.B void memcached_server_list_free(\fI\%memcached_server_list_st\fP\fI\ list\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_server_list_st memcached_server_list_append(memcached_server_list_st\fI\ list\fP, const char\fI\ *hostname\fP, unsigned int\fI\ port\fP, memcached_return_t\fI\ *error\fP)
+.B \fI\%memcached_server_list_st\fP memcached_server_list_append(\fI\%memcached_server_list_st\fP\fI\ list\fP, const char\fI\ *hostname\fP, in_port_t\fI\ port\fP, memcached_return_t\fI\ *error\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B uint32_t memcached_server_list_count(memcached_server_list_st\fI\ list\fP)
+.B uint32_t memcached_server_list_count(\fI\%memcached_server_list_st\fP\fI\ list\fP)
.UNINDENT
.INDENT 0.0
.TP
.UNINDENT
.sp
Deprecated since version 0.39.
+.INDENT 0.0
+.TP
+.B void memcached_servers_parse()
+.UNINDENT
+.sp
+Deprecated since version 0.39.
.sp
Compile and link with \-lmemcached
.SH DESCRIPTION
.sp
libmemcached(3) operates on a list of hosts which are stored in
-\fBmemcached_server_st\fP structures. You should not modify these structures
+\fI\%memcached_server_st\fP structures. You should not modify these structures
directly. Functions are provided to modify these structures (and more can be
added, just ask!).
.sp
-\fI\%memcached_server_list()\fP is used to provide an array of all defined hosts. This was incorrectly documented as "requiring free()" up till version 0.39.
+\fI\%memcached_server_list()\fP is used to provide an array of all defined hosts. This was incorrectly documented as "requiring free" up till version 0.39.
.sp
-\fI\%memcached_server_list_free()\fP deallocates all memory associated with the array of \fBmemcached_server_st\fP that you passed to it.
+\fI\%memcached_server_list_free()\fP deallocates all memory associated with the array of \fI\%memcached_server_st\fP that you passed to it.
.sp
\fI\%memcached_server_list_append()\fP adds a server to the end of a
-\fBmemcached_server_st\fP array. On error null will be returned and the
+\fI\%memcached_server_st\fP array. On error null will be returned and the
\fBmemcached_return_t\fP pointer you passed into the function will be set with the appropriate error. If the value of port is zero, it is set to the default
port of a memcached server.
.sp
-DEPRECATED \fBmemcached_servers_parse()\fP, please see \fBmemcached()\fP
+DEPRECATED \fI\%memcached_servers_parse()\fP, please see \fBmemcached()\fP
.sp
\fI\%memcached_server_error()\fP can be used to look at the text of the last error message sent by the server to to the client.
.sp
Before version 0.39 theses functions used a memcache_server_st *. In 0.39
-memcached_server_st * was aliased to \fBmemcached_server_list_st\fP. This was done for a style reason to help clean up some concepts in the code.
+memcached_server_st * was aliased to \fI\%memcached_server_list_st\fP. This was done for a style reason to help clean up some concepts in the code.
.SH RETURN
.sp
Varies, see particular functions.
-.TH "MEMCACHED_SERVER_PUSH" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_SERVER_PUSH" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_server_push \- libmemcached Documentation
.
the list) are not saved.
.sp
\fI\%memcached_server_by_key()\fP allows you to provide a key and retrieve the
-server which would be used for assignment. This structure is cloned
-from its original structure and must be freed. If NULL is returned you
-should consult *error. The returning structure should be freed with
-\fBmemcached_server_free()\fP.
+server which would be used for assignment.
.sp
\fI\%memcached_server_get_last_disconnect()\fP returns a pointer to the last
server for which there was a connection problem. It does not mean this
-.TH "MEMCACHED_SERVER_ST" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_SERVER_ST" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_server_st \- libmemcached Documentation
.
the list) are not saved.
.sp
\fI\%memcached_server_by_key()\fP allows you to provide a key and retrieve the
-server which would be used for assignment. This structure is cloned
-from its original structure and must be freed. If NULL is returned you
-should consult *error. The returning structure should be freed with
-\fBmemcached_server_free()\fP.
+server which would be used for assignment.
.sp
\fI\%memcached_server_get_last_disconnect()\fP returns a pointer to the last
server for which there was a connection problem. It does not mean this
-.TH "MEMCACHED_SERVERS" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_SERVERS" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_servers \- libmemcached Documentation
.
the list) are not saved.
.sp
\fI\%memcached_server_by_key()\fP allows you to provide a key and retrieve the
-server which would be used for assignment. This structure is cloned
-from its original structure and must be freed. If NULL is returned you
-should consult *error. The returning structure should be freed with
-\fBmemcached_server_free()\fP.
+server which would be used for assignment.
.sp
\fI\%memcached_server_get_last_disconnect()\fP returns a pointer to the last
server for which there was a connection problem. It does not mean this
-.TH "MEMCACHED_SERVERS_PARSE" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_SERVERS_PARSE" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_servers_parse \- libmemcached Documentation
.
.UNINDENT
.INDENT 0.0
.TP
+.B memcached_server_list_st
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_server_st
+.UNINDENT
+.INDENT 0.0
+.TP
.B const \fI\%memcached_server_instance_st\fP memcached_server_list(memcached_st\fI\ *ptr\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B void memcached_server_list_free(memcached_server_list_st\fI\ list\fP)
+.B void memcached_server_list_free(\fI\%memcached_server_list_st\fP\fI\ list\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_server_list_st memcached_server_list_append(memcached_server_list_st\fI\ list\fP, const char\fI\ *hostname\fP, unsigned int\fI\ port\fP, memcached_return_t\fI\ *error\fP)
+.B \fI\%memcached_server_list_st\fP memcached_server_list_append(\fI\%memcached_server_list_st\fP\fI\ list\fP, const char\fI\ *hostname\fP, in_port_t\fI\ port\fP, memcached_return_t\fI\ *error\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B uint32_t memcached_server_list_count(memcached_server_list_st\fI\ list\fP)
+.B uint32_t memcached_server_list_count(\fI\%memcached_server_list_st\fP\fI\ list\fP)
.UNINDENT
.INDENT 0.0
.TP
.UNINDENT
.sp
Deprecated since version 0.39.
+.INDENT 0.0
+.TP
+.B void memcached_servers_parse()
+.UNINDENT
+.sp
+Deprecated since version 0.39.
.sp
Compile and link with \-lmemcached
.SH DESCRIPTION
.sp
libmemcached(3) operates on a list of hosts which are stored in
-\fBmemcached_server_st\fP structures. You should not modify these structures
+\fI\%memcached_server_st\fP structures. You should not modify these structures
directly. Functions are provided to modify these structures (and more can be
added, just ask!).
.sp
-\fI\%memcached_server_list()\fP is used to provide an array of all defined hosts. This was incorrectly documented as "requiring free()" up till version 0.39.
+\fI\%memcached_server_list()\fP is used to provide an array of all defined hosts. This was incorrectly documented as "requiring free" up till version 0.39.
.sp
-\fI\%memcached_server_list_free()\fP deallocates all memory associated with the array of \fBmemcached_server_st\fP that you passed to it.
+\fI\%memcached_server_list_free()\fP deallocates all memory associated with the array of \fI\%memcached_server_st\fP that you passed to it.
.sp
\fI\%memcached_server_list_append()\fP adds a server to the end of a
-\fBmemcached_server_st\fP array. On error null will be returned and the
+\fI\%memcached_server_st\fP array. On error null will be returned and the
\fBmemcached_return_t\fP pointer you passed into the function will be set with the appropriate error. If the value of port is zero, it is set to the default
port of a memcached server.
.sp
-DEPRECATED \fBmemcached_servers_parse()\fP, please see \fBmemcached()\fP
+DEPRECATED \fI\%memcached_servers_parse()\fP, please see \fBmemcached()\fP
.sp
\fI\%memcached_server_error()\fP can be used to look at the text of the last error message sent by the server to to the client.
.sp
Before version 0.39 theses functions used a memcache_server_st *. In 0.39
-memcached_server_st * was aliased to \fBmemcached_server_list_st\fP. This was done for a style reason to help clean up some concepts in the code.
+memcached_server_st * was aliased to \fI\%memcached_server_list_st\fP. This was done for a style reason to help clean up some concepts in the code.
.SH RETURN
.sp
Varies, see particular functions.
-.TH "MEMCACHED_SERVERS_RESET" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_SERVERS_RESET" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_servers_reset \- libmemcached Documentation
.
#include <libmemcached/memcached.h>
.INDENT 0.0
.TP
-.B memcachd_st
+.B memcached_st
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_st* memcached_create(memcached_st\fI\ *ptr\fP)
+.B \fI\%memcached_st\fP* memcached_create(\fI\%memcached_st\fP\fI\ *ptr\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B void memcached_free(memcached_st\fI\ *ptr\fP)
+.B void memcached_free(\fI\%memcached_st\fP\fI\ *ptr\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_st* memcached_clone(memcached_st\fI\ *destination\fP, memcached_st\fI\ *source\fP)
+.B \fI\%memcached_st\fP* memcached_clone(\fI\%memcached_st\fP\fI\ *destination\fP, \fI\%memcached_st\fP\fI\ *source\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B void memcached_servers_reset(memcached_st)
+.B void memcached_servers_reset(\fI\%memcached_st\fP)
.UNINDENT
.sp
Compile and link with \-lmemcached
.SH DESCRIPTION
.sp
-\fI\%memcached_create()\fP is used to create a \fBmemcached_st\fP
+\fI\%memcached_create()\fP is used to create a \fI\%memcached_st\fP
structure that will then be used by other libmemcached(3) functions to
communicate with the server. You should either pass a statically declared
-\fBmemcached_st\fP to \fI\%memcached_create()\fP or
+\fI\%memcached_st\fP to \fI\%memcached_create()\fP or
a NULL. If a NULL passed in then a structure is allocated for you.
.sp
Please note, when you write new application use
-\fBmemcached_create_with_options()\fP over
+\fBmemcached()\fP over
\fI\%memcached_create()\fP.
.sp
\fI\%memcached_clone()\fP is similar to \fI\%memcached_create()\fP but
it copies the defaults and list of servers from the source
-\fBmemcached_st\fP. If you pass a null as the argument for the source
+\fI\%memcached_st\fP. If you pass a null as the argument for the source
to clone, it is the same as a call to \fI\%memcached_create()\fP.
-If the destination argument is NULL a \fBmemcached_st\fP will be allocated
+If the destination argument is NULL a \fI\%memcached_st\fP will be allocated
for you.
.sp
\fI\%memcached_servers_reset()\fP allows you to zero out the list of
-servers that the \fBmemcached_st\fP has.
+servers that the \fI\%memcached_st\fP has.
.sp
-To clean up memory associated with a \fBmemcached_st\fP structure you
+To clean up memory associated with a \fI\%memcached_st\fP structure you
should pass it to \fI\%memcached_free()\fP when you are finished using it.
\fI\%memcached_free()\fP is the only way to make sure all memory is
deallocated when you finish using the structure.
heap allocated structures.
.SH RETURN
.sp
-\fI\%memcached_create()\fP returns a pointer to the \fBmemcached_st\fP
+\fI\%memcached_create()\fP returns a pointer to the \fI\%memcached_st\fP
that was created (or initialized). On an allocation failure, it returns NULL.
.sp
-\fI\%memcached_clone()\fP returns a pointer to the \fBmemcached_st\fP
+\fI\%memcached_clone()\fP returns a pointer to the \fI\%memcached_st\fP
that was created (or initialized). On an allocation failure, it returns NULL.
.SH HOME
.sp
-.TH "MEMCACHED_SET" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_SET" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_set \- Storing and Replacing Data
.
#include <libmemcached/memcached.h>
.INDENT 0.0
.TP
-.B memcached_return_t memcached_set (memcached_st *ptr, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags);
+.B memcached_return_t memcached_set(memcached_st\fI\ *ptr\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, const char\fI\ *value\fP, size_t\fI\ value_length\fP, time_t\fI\ expiration\fP, uint32_t\fI\ flags\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_add (memcached_st *ptr, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags);
+.B memcached_return_t memcached_add(memcached_st\fI\ *ptr\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, const char\fI\ *value\fP, size_t\fI\ value_length\fP, time_t\fI\ expiration\fP, uint32_t\fI\ flags\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_replace (memcached_st *ptr, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags);
+.B memcached_return_t memcached_replace(memcached_st\fI\ *ptr\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, const char\fI\ *value\fP, size_t\fI\ value_length\fP, time_t\fI\ expiration\fP, uint32_t\fI\ flags\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_set_by_key(memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags);
+.B memcached_return_t memcached_set_by_key(memcached_st\fI\ *ptr\fP, const char\fI\ *group_key\fP, size_t\fI\ group_key_length\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, const char\fI\ *value\fP, size_t\fI\ value_length\fP, time_t\fI\ expiration\fP, uint32_t\fI\ flags\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_add_by_key(memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags);
+.B memcached_return_t memcached_add_by_key(memcached_st\fI\ *ptr\fP, const char\fI\ *group_key\fP, size_t\fI\ group_key_length\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, const char\fI\ *value\fP, size_t\fI\ value_length\fP, time_t\fI\ expiration\fP, uint32_t\fI\ flags\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_replace_by_key(memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags);
+.B memcached_return_t memcached_replace_by_key(memcached_st\fI\ *ptr\fP, const char\fI\ *group_key\fP, size_t\fI\ group_key_length\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, const char\fI\ *value\fP, size_t\fI\ value_length\fP, time_t\fI\ expiration\fP, uint32_t\fI\ flags\fP)
.UNINDENT
.sp
Compile and link with \-lmemcached
.SH DESCRIPTION
.sp
-\fBmemcached_set()\fP, \fBmemcached_add()\fP, and \fBmemcached_replace()\fP are all used to store information on the server. All methods take a key, and its length to store the object. Keys are currently limited to 250 characters when using either a version of memcached(1) which is 1.4 or below, or when using the text protocol. You must supply both a value and a length. Optionally you
+\fI\%memcached_set()\fP, \fI\%memcached_add()\fP, and \fI\%memcached_replace()\fP are all used to store information on the server. All methods take a key, and its length to store the object. Keys are currently limited to 250 characters when using either a version of memcached(1) which is 1.4 or below, or when using the text protocol. You must supply both a value and a length. Optionally you
store the object. Keys are currently limited to 250 characters by the
memcached(1) server. You must supply both a value and a length. Optionally you
may test an expiration time for the object and a 16 byte value (it is meant to be used as a bitmap). "flags" is a 4byte space that is stored alongside of the main value. Many sub libraries make use of this field, so in most cases users should avoid making use of it.
.sp
-\fBmemcached_set()\fP will write an object to the server. If an object
+\fI\%memcached_set()\fP will write an object to the server. If an object
already exists it will overwrite what is in the server. If the object does not
exist it will be written. If you are using the non\-blocking mode this function
will always return true unless a network error occurs.
.sp
-\fBmemcached_replace()\fP replaces an object on the server. If the object is not found on the server an error occurs.
+\fI\%memcached_replace()\fP replaces an object on the server. If the object is not found on the server an error occurs.
.sp
-\fBmemcached_add()\fP adds an object to the server. If the object is found on the server an error occurs, otherwise the value is stored.
+\fI\%memcached_add()\fP adds an object to the server. If the object is found on the server an error occurs, otherwise the value is stored.
.sp
\fBmemcached_cas()\fP 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 \fBmemcached_result_cas()\fP on a memcached_result_st(3) structure. At the point
that this note was written cas is still buggy in memached. Turning on tests
-for it in libmemcached(3) is optional. Please see memcached_set() for
+for it in libmemcached(3) is optional. Please see memcached_set for
information on how to do this.
.sp
-\fBmemcached_set_by_key()\fP, \fBmemcached_add_by_key()\fP, and \fBmemcached_replace_by_key()\fP methods all behave in a similar method as the non
+\fI\%memcached_set_by_key()\fP, \fI\%memcached_add_by_key()\fP, and \fI\%memcached_replace_by_key()\fP methods all behave in a similar method as the non
key methods. The difference is that they use their group_key parameter to map
objects to particular servers.
.sp
-If you are looking for performance, \fBmemcached_set()\fP with non\-blocking IO is the fastest way to store data on the server.
+If you are looking for performance, \fI\%memcached_set()\fP with non\-blocking IO is the fastest way to store data on the server.
.sp
All of the above functions are testsed with the \fBMEMCACHED_BEHAVIOR_USE_UDP\fP behavior enabled. However, when using these operations with this behavior
on, there are limits to the size of the payload being sent to the server.
On success the value will be \fBMEMCACHED_SUCCESS\fP.
Use \fBmemcached_strerror()\fP to translate this value to a printable string.
.sp
-For \fBmemcached_replace()\fP and \fBmemcached_add()\fP, \fBMEMCACHED_NOTSTORED\fP is a legitmate error in the case of a collision.
+For \fI\%memcached_replace()\fP and \fI\%memcached_add()\fP, \fBMEMCACHED_NOTSTORED\fP is a legitmate error in the case of a collision.
.SH HOME
.sp
To find out more information please check:
-.TH "MEMCACHED_SET_BY_KEY" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_SET_BY_KEY" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_set_by_key \- Storing and Replacing Data
.
#include <libmemcached/memcached.h>
.INDENT 0.0
.TP
-.B memcached_return_t memcached_set (memcached_st *ptr, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags);
+.B memcached_return_t memcached_set(memcached_st\fI\ *ptr\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, const char\fI\ *value\fP, size_t\fI\ value_length\fP, time_t\fI\ expiration\fP, uint32_t\fI\ flags\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_add (memcached_st *ptr, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags);
+.B memcached_return_t memcached_add(memcached_st\fI\ *ptr\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, const char\fI\ *value\fP, size_t\fI\ value_length\fP, time_t\fI\ expiration\fP, uint32_t\fI\ flags\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_replace (memcached_st *ptr, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags);
+.B memcached_return_t memcached_replace(memcached_st\fI\ *ptr\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, const char\fI\ *value\fP, size_t\fI\ value_length\fP, time_t\fI\ expiration\fP, uint32_t\fI\ flags\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_set_by_key(memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags);
+.B memcached_return_t memcached_set_by_key(memcached_st\fI\ *ptr\fP, const char\fI\ *group_key\fP, size_t\fI\ group_key_length\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, const char\fI\ *value\fP, size_t\fI\ value_length\fP, time_t\fI\ expiration\fP, uint32_t\fI\ flags\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_add_by_key(memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags);
+.B memcached_return_t memcached_add_by_key(memcached_st\fI\ *ptr\fP, const char\fI\ *group_key\fP, size_t\fI\ group_key_length\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, const char\fI\ *value\fP, size_t\fI\ value_length\fP, time_t\fI\ expiration\fP, uint32_t\fI\ flags\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_replace_by_key(memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, const char *value, size_t value_length, time_t expiration, uint32_t flags);
+.B memcached_return_t memcached_replace_by_key(memcached_st\fI\ *ptr\fP, const char\fI\ *group_key\fP, size_t\fI\ group_key_length\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, const char\fI\ *value\fP, size_t\fI\ value_length\fP, time_t\fI\ expiration\fP, uint32_t\fI\ flags\fP)
.UNINDENT
.sp
Compile and link with \-lmemcached
.SH DESCRIPTION
.sp
-\fBmemcached_set()\fP, \fBmemcached_add()\fP, and \fBmemcached_replace()\fP are all used to store information on the server. All methods take a key, and its length to store the object. Keys are currently limited to 250 characters when using either a version of memcached(1) which is 1.4 or below, or when using the text protocol. You must supply both a value and a length. Optionally you
+\fI\%memcached_set()\fP, \fI\%memcached_add()\fP, and \fI\%memcached_replace()\fP are all used to store information on the server. All methods take a key, and its length to store the object. Keys are currently limited to 250 characters when using either a version of memcached(1) which is 1.4 or below, or when using the text protocol. You must supply both a value and a length. Optionally you
store the object. Keys are currently limited to 250 characters by the
memcached(1) server. You must supply both a value and a length. Optionally you
may test an expiration time for the object and a 16 byte value (it is meant to be used as a bitmap). "flags" is a 4byte space that is stored alongside of the main value. Many sub libraries make use of this field, so in most cases users should avoid making use of it.
.sp
-\fBmemcached_set()\fP will write an object to the server. If an object
+\fI\%memcached_set()\fP will write an object to the server. If an object
already exists it will overwrite what is in the server. If the object does not
exist it will be written. If you are using the non\-blocking mode this function
will always return true unless a network error occurs.
.sp
-\fBmemcached_replace()\fP replaces an object on the server. If the object is not found on the server an error occurs.
+\fI\%memcached_replace()\fP replaces an object on the server. If the object is not found on the server an error occurs.
.sp
-\fBmemcached_add()\fP adds an object to the server. If the object is found on the server an error occurs, otherwise the value is stored.
+\fI\%memcached_add()\fP adds an object to the server. If the object is found on the server an error occurs, otherwise the value is stored.
.sp
\fBmemcached_cas()\fP 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 \fBmemcached_result_cas()\fP on a memcached_result_st(3) structure. At the point
that this note was written cas is still buggy in memached. Turning on tests
-for it in libmemcached(3) is optional. Please see memcached_set() for
+for it in libmemcached(3) is optional. Please see memcached_set for
information on how to do this.
.sp
-\fBmemcached_set_by_key()\fP, \fBmemcached_add_by_key()\fP, and \fBmemcached_replace_by_key()\fP methods all behave in a similar method as the non
+\fI\%memcached_set_by_key()\fP, \fI\%memcached_add_by_key()\fP, and \fI\%memcached_replace_by_key()\fP methods all behave in a similar method as the non
key methods. The difference is that they use their group_key parameter to map
objects to particular servers.
.sp
-If you are looking for performance, \fBmemcached_set()\fP with non\-blocking IO is the fastest way to store data on the server.
+If you are looking for performance, \fI\%memcached_set()\fP with non\-blocking IO is the fastest way to store data on the server.
.sp
All of the above functions are testsed with the \fBMEMCACHED_BEHAVIOR_USE_UDP\fP behavior enabled. However, when using these operations with this behavior
on, there are limits to the size of the payload being sent to the server.
On success the value will be \fBMEMCACHED_SUCCESS\fP.
Use \fBmemcached_strerror()\fP to translate this value to a printable string.
.sp
-For \fBmemcached_replace()\fP and \fBmemcached_add()\fP, \fBMEMCACHED_NOTSTORED\fP is a legitmate error in the case of a collision.
+For \fI\%memcached_replace()\fP and \fI\%memcached_add()\fP, \fBMEMCACHED_NOTSTORED\fP is a legitmate error in the case of a collision.
.SH HOME
.sp
To find out more information please check:
-.TH "MEMCACHED_SET_MEMORY_ALLOCATORS" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_SET_MEMORY_ALLOCATORS" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_set_memory_allocators \- libmemcached Documentation
.
#include <libmemcached/memcached.h>
.INDENT 0.0
.TP
-.B memcached_return_t memcached_set_memory_allocators (memcached_st *ptr, memcached_malloc_fn mem_malloc, memcached_free_fn mem_free, memcached_realloc_fn mem_realloc, memcached_calloc_fn mem_calloc, void *context);
+.B memcached_return_t memcached_set_memory_allocators(memcached_st\fI\ *ptr\fP, \fI\%memcached_malloc_fn\fP\fI\ mem_malloc\fP, \fI\%memcached_free_fn\fP\fI\ mem_free\fP, \fI\%memcached_realloc_fn\fP\fI\ mem_realloc\fP, \fI\%memcached_calloc_fn\fP\fI\ mem_calloc\fP, void\fI\ *context\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B void memcached_get_memory_allocators (memcached_st *ptr, memcached_malloc_fn *mem_malloc, memcached_free_fn *mem_free, memcached_realloc_fn *mem_realloc, memcached_calloc_fn *mem_calloc);
+.B void memcached_get_memory_allocators(memcached_st\fI\ *ptr\fP, \fI\%memcached_malloc_fn\fP\fI\ *mem_malloc\fP, \fI\%memcached_free_fn\fP\fI\ *mem_free\fP, \fI\%memcached_realloc_fn\fP\fI\ *mem_realloc\fP, \fI\%memcached_calloc_fn\fP\fI\ *mem_calloc\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B void * memcached_get_memory_allocators_context(const memcached_st *ptr);
+.B void * memcached_get_memory_allocators_context(const memcached_st\fI\ *ptr\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B void * (*memcached_malloc_fn) (memcached_st *ptr, const size_t size, void *context);
+.B void * (*memcached_malloc_fn)(memcached_st\fI\ *ptr\fP, const size_t\fI\ size\fP, void\fI\ *context\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B void * (*memcached_realloc_fn) (memcached_st *ptr, void *mem, const size_t size, void *context);
+.B void * (*memcached_realloc_fn)(memcached_st\fI\ *ptr\fP, void\fI\ *mem\fP, const size_t\fI\ size\fP, void\fI\ *context\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B void (*memcached_free_fn) (memcached_st *ptr, void *mem, void *context);
+.B void (*memcached_free_fn)(memcached_st\fI\ *ptr\fP, void\fI\ *mem\fP, void\fI\ *context\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B void * (*memcached_calloc_fn) (memcached_st *ptr, size_t nelem, const size_t elsize, void *context);
+.B void * (*memcached_calloc_fn)(memcached_st\fI\ *ptr\fP, size_t\fI\ nelem\fP, const size_t\fI\ elsize\fP, void\fI\ *context\fP)
.UNINDENT
.sp
Compile and link with \-lmemcached
libmemcached(3) allows you to specify your own memory allocators, optimized
for your application. This enables libmemcached to be used inside of applications that have their own malloc implementation.
.sp
-\fBmemcached_set_memory_allocators()\fP is used to set the memory
+\fI\%memcached_set_memory_allocators()\fP is used to set the memory
allocators used by the memcached instance specified by ptr. Please note that
you cannot override only one of the memory allocators, you have to specify a
complete new set if you want to override one of them. All of the memory
allocation functions should behave as specified in the C99 standard. Specify
NULL as all functions to reset them to the default values.
.sp
-\fBmemcached_get_memory_allocators()\fP is used to get the currently used
+\fI\%memcached_get_memory_allocators()\fP is used to get the currently used
memory allocators by a mamcached handle.
.sp
-\fBmemcached_get_memory_allocators_context()\fP returns the void * that
-was passed in during the call to \fBmemcached_set_memory_allocators()\fP.
+\fI\%memcached_get_memory_allocators_context()\fP returns the void * that
+was passed in during the call to \fI\%memcached_set_memory_allocators()\fP.
.sp
The first argument to the memory allocator functions is a pointer to a
memcached structure, the is passed as const and you will need to clone
own space for memory.
.SH RETURN
.sp
-\fBmemcached_set_memory_allocators()\fP return \fBMEMCACHED_SUCCESS\fP
+\fI\%memcached_set_memory_allocators()\fP return \fBMEMCACHED_SUCCESS\fP
upon success, and \fBMEMCACHED_FAILURE\fP if you don\(aqt pass a complete set
of function pointers.
.SH HOME
-.TH "MEMCACHED_SET_MEMORY_ALLOCATORS_CONTEXT" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_SET_MEMORY_ALLOCATORS_CONTEXT" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_set_memory_allocators_context \- libmemcached Documentation
.
#include <libmemcached/memcached.h>
.INDENT 0.0
.TP
-.B memcached_return_t memcached_set_memory_allocators (memcached_st *ptr, memcached_malloc_fn mem_malloc, memcached_free_fn mem_free, memcached_realloc_fn mem_realloc, memcached_calloc_fn mem_calloc, void *context);
+.B memcached_return_t memcached_set_memory_allocators(memcached_st\fI\ *ptr\fP, \fI\%memcached_malloc_fn\fP\fI\ mem_malloc\fP, \fI\%memcached_free_fn\fP\fI\ mem_free\fP, \fI\%memcached_realloc_fn\fP\fI\ mem_realloc\fP, \fI\%memcached_calloc_fn\fP\fI\ mem_calloc\fP, void\fI\ *context\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B void memcached_get_memory_allocators (memcached_st *ptr, memcached_malloc_fn *mem_malloc, memcached_free_fn *mem_free, memcached_realloc_fn *mem_realloc, memcached_calloc_fn *mem_calloc);
+.B void memcached_get_memory_allocators(memcached_st\fI\ *ptr\fP, \fI\%memcached_malloc_fn\fP\fI\ *mem_malloc\fP, \fI\%memcached_free_fn\fP\fI\ *mem_free\fP, \fI\%memcached_realloc_fn\fP\fI\ *mem_realloc\fP, \fI\%memcached_calloc_fn\fP\fI\ *mem_calloc\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B void * memcached_get_memory_allocators_context(const memcached_st *ptr);
+.B void * memcached_get_memory_allocators_context(const memcached_st\fI\ *ptr\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B void * (*memcached_malloc_fn) (memcached_st *ptr, const size_t size, void *context);
+.B void * (*memcached_malloc_fn)(memcached_st\fI\ *ptr\fP, const size_t\fI\ size\fP, void\fI\ *context\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B void * (*memcached_realloc_fn) (memcached_st *ptr, void *mem, const size_t size, void *context);
+.B void * (*memcached_realloc_fn)(memcached_st\fI\ *ptr\fP, void\fI\ *mem\fP, const size_t\fI\ size\fP, void\fI\ *context\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B void (*memcached_free_fn) (memcached_st *ptr, void *mem, void *context);
+.B void (*memcached_free_fn)(memcached_st\fI\ *ptr\fP, void\fI\ *mem\fP, void\fI\ *context\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B void * (*memcached_calloc_fn) (memcached_st *ptr, size_t nelem, const size_t elsize, void *context);
+.B void * (*memcached_calloc_fn)(memcached_st\fI\ *ptr\fP, size_t\fI\ nelem\fP, const size_t\fI\ elsize\fP, void\fI\ *context\fP)
.UNINDENT
.sp
Compile and link with \-lmemcached
libmemcached(3) allows you to specify your own memory allocators, optimized
for your application. This enables libmemcached to be used inside of applications that have their own malloc implementation.
.sp
-\fBmemcached_set_memory_allocators()\fP is used to set the memory
+\fI\%memcached_set_memory_allocators()\fP is used to set the memory
allocators used by the memcached instance specified by ptr. Please note that
you cannot override only one of the memory allocators, you have to specify a
complete new set if you want to override one of them. All of the memory
allocation functions should behave as specified in the C99 standard. Specify
NULL as all functions to reset them to the default values.
.sp
-\fBmemcached_get_memory_allocators()\fP is used to get the currently used
+\fI\%memcached_get_memory_allocators()\fP is used to get the currently used
memory allocators by a mamcached handle.
.sp
-\fBmemcached_get_memory_allocators_context()\fP returns the void * that
-was passed in during the call to \fBmemcached_set_memory_allocators()\fP.
+\fI\%memcached_get_memory_allocators_context()\fP returns the void * that
+was passed in during the call to \fI\%memcached_set_memory_allocators()\fP.
.sp
The first argument to the memory allocator functions is a pointer to a
memcached structure, the is passed as const and you will need to clone
own space for memory.
.SH RETURN
.sp
-\fBmemcached_set_memory_allocators()\fP return \fBMEMCACHED_SUCCESS\fP
+\fI\%memcached_set_memory_allocators()\fP return \fBMEMCACHED_SUCCESS\fP
upon success, and \fBMEMCACHED_FAILURE\fP if you don\(aqt pass a complete set
of function pointers.
.SH HOME
-.TH "MEMCACHED_SET_SASL_CALLBACKS" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_SET_SASL_CALLBACKS" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_set_sasl_callbacks \- libmemcached Documentation
.
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return memcached_set_sasl_auth_data(memcached_st\fI\ *ptr\fP, const char\fI\ *username\fP, const char\fI\ *password\fP)
+.B memcached_return_t memcached_set_sasl_auth_data(memcached_st\fI\ *ptr\fP, const char\fI\ *username\fP, const char\fI\ *password\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return memcached_destroy_sasl_auth_data(memcached_st\fI\ *ptr\fP)
+.B memcached_return_t memcached_destroy_sasl_auth_data(memcached_st\fI\ *ptr\fP)
.UNINDENT
.sp
Compile and link with \-lmemcached
\fBmemcached_free\fP to avoid a memory leak. You should NOT call
\fI\%memcached_destroy_sasl_auth_data\fP if you specify your own callback
function with \fI\%memcached_set_sasl_callbacks()\fP.
-.sp
-You as a client user have to initialize libsasl by using \fBsasl_client_init\fP before enabling it in libmemcached, and you have to shut down libsasl by
-calling \fBsasl_done()\fP when you are done using SASL from libmemcached.
.SH RETURN
.sp
-\fI\%memcached_get_sasl_callbacks()\fP returns the callbacks currently used
-by this memcached handle. \fBmemcached_get_sasl_set_auth_data()\fP returns \fBMEMCACHED_SUCCESS\fP upon success.
+\fI\%memcached_get_sasl_callbacks()\fP returns the callbacks currently used by
+this memcached handle. \fI\%memcached_set_sasl_auth_data()\fP returns
+\fBMEMCACHED_SUCCESS\fP upon success.
.SH HOME
.sp
To find out more information please check:
-.TH "MEMCACHED_SET_USER_DATA" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_SET_USER_DATA" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_set_user_data \- libmemcached Documentation
.
.sp
.nf
.ft C
-#include <libmemcached/memcached.h>
-
-void *memcached_get_user_data (memcached_st *ptr);
-void *memcached_set_user_data (memcached_st *ptr, void *data);
.ft P
.fi
+.sp
+#include <libmemcached/memcached.h>
+.INDENT 0.0
+.TP
+.B void *memcached_get_user_data(memcached_st\fI\ *ptr\fP)
+.UNINDENT
+.INDENT 0.0
+.TP
+.B void *memcached_set_user_data(memcached_st\fI\ *ptr\fP, void\fI\ *data\fP)
+.UNINDENT
+.sp
+Compile and link with \-lmemcached
.SH DESCRIPTION
.sp
libmemcached(3) allows you to store a pointer to a user specific data inside
the memcached_st structure.
.sp
-\fBmemcached_set_user_data()\fP is used to set the user specific data in the
+\fI\%memcached_set_user_data()\fP is used to set the user specific data in the
\fBmemcached_st\fP structure.
.sp
-\fBmemcached_get_user_data()\fP is used to retrieve the user specific data in the \fBmemcached_st\fP structure.
+\fI\%memcached_get_user_data()\fP is used to retrieve the user specific data in the \fBmemcached_st\fP structure.
.SH RETURN
.sp
-\fBmemcached_set_user_data()\fP returns the previous value of the user specific data.
+\fI\%memcached_set_user_data()\fP returns the previous value of the user specific data.
.sp
-\fBmemcached_get_user_data()\fP returns the current value uf the user specific data.
+\fI\%memcached_get_user_data()\fP returns the current value uf the user specific data.
.SH HOME
.sp
To find out more information please check:
-.TH "MEMCACHED_STAT" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_STAT" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_stat \- libmemcached Documentation
.
#include <libmemcached/memcached.h>
.INDENT 0.0
.TP
-.B memcached_stat_st *memcached_stat (memcached_st *ptr, char *args, memcached_return_t *error);
+.B memcached_stat_st
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_stat_servername (memcached_stat_st *stat, char *args, const char *hostname, unsigned int port);
+.B memcached_return_t (*memcached_stat_fn)(memcached_server_instance_st\fI\ server\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, const char\fI\ *value\fP, size_t\fI\ value_length\fP, void\fI\ *context\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B char * memcached_stat_get_value (memcached_st *ptr, memcached_stat_st *stat, const char *key, memcached_return_t *error);
+.B \fI\%memcached_stat_st\fP *memcached_stat(memcached_st\fI\ *ptr\fP, char\fI\ *args\fP, memcached_return_t\fI\ *error\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B char ** memcached_stat_get_keys (memcached_st *ptr, memcached_stat_st *stat, memcached_return_t *error);
+.B memcached_return_t memcached_stat_servername(\fI\%memcached_stat_st\fP\fI\ *stat\fP, char\fI\ *args\fP, const char\fI\ *hostname\fP, in_port_t\fI\ port\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_stat_execute (memcached_st *memc, const char *args, memcached_stat_fn func, void *context);
+.B char * memcached_stat_get_value(memcached_st\fI\ *ptr\fP, \fI\%memcached_stat_st\fP\fI\ *stat\fP, const char\fI\ *key\fP, memcached_return_t\fI\ *error\fP)
+.UNINDENT
+.INDENT 0.0
+.TP
+.B char ** memcached_stat_get_keys(memcached_st\fI\ *ptr\fP, \fI\%memcached_stat_st\fP\fI\ *stat\fP, memcached_return_t\fI\ *error\fP)
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_return_t memcached_stat_execute(memcached_st\fI\ *memc\fP, const char\fI\ *args\fP, \fI\%memcached_stat_fn\fP\fI\ func\fP, void\fI\ *context\fP)
.UNINDENT
.sp
Compile and link with \-lmemcached
.sp
libmemcached(3) has the ability to query a memcached server (or collection
of servers) for their current state. Queries to find state return a
-\fBmemcached_stat_st\fP structure. You are responsible for freeing this structure. While it is possible to access the structure directly it is not advisable. \fBmemcached_stat_get_value()\fP has been provided to query the structure.
+\fI\%memcached_stat_st\fP structure. You are responsible for freeing this structure. While it is possible to access the structure directly it is not advisable. \fI\%memcached_stat_get_value()\fP has been provided to query the structure.
.sp
-\fBmemcached_stat_execute()\fP uses the servers found in \fBmemcached_stat_st\fP and executes a "stat" command on each server. args is an optional argument that can be passed in to modify the behavior of "stats". You will need to supply a callback function that will be supplied each pair of values returned by
+\fI\%memcached_stat_execute()\fP uses the servers found in \fI\%memcached_stat_st\fP and executes a "stat" command on each server. args is an optional argument that can be passed in to modify the behavior of "stats". You will need to supply a callback function that will be supplied each pair of values returned by
the memcached server.
.sp
-\fBmemcached_stat()\fP fetches an array of \fBmemcached_stat_st\fP structures containing the state of all available memcached servers. The return value must be freed by the calling application. If called with the \fBMEMCACHED_BEHAVIOR_USE_UDP\fP behavior set, a NULL value is returned and the error parameter is set to \fBMEMCACHED_NOT_SUPPORTED\fP.
+\fI\%memcached_stat()\fP fetches an array of \fI\%memcached_stat_st\fP structures containing the state of all available memcached servers. The return value must be freed by the calling application. If called with the \fBMEMCACHED_BEHAVIOR_USE_UDP\fP behavior set, a NULL value is returned and the error parameter is set to \fBMEMCACHED_NOT_SUPPORTED\fP.
.sp
-\fBmemcached_stat_servername()\fP can be used standalone without a \fBmemcached_st\fP to obtain the state of a particular server. "args" is used to define a particular state object (a list of these are not provided for by either
-the \fBmemcached_stat_get_keys()\fP call nor are they defined in the memcached protocol). You must specify the hostname and port of the server you want to
+\fI\%memcached_stat_servername()\fP can be used standalone without a \fBmemcached_st\fP to obtain the state of a particular server. "args" is used to define a particular state object (a list of these are not provided for by either
+the \fI\%memcached_stat_get_keys()\fP call nor are they defined in the memcached protocol). You must specify the hostname and port of the server you want to
obtain information on.
.sp
-\fBmemcached_stat_get_value()\fP returns the value of a particular state key. You specify the key you wish to obtain. The key must be null terminated.
+\fI\%memcached_stat_get_value()\fP returns the value of a particular state key. You specify the key you wish to obtain. The key must be null terminated.
.sp
-\fBmemcached_stat_get_keys()\fP returns a list of keys that the server has state objects on. You are responsible for freeing this list.
+\fI\%memcached_stat_get_keys()\fP returns a list of keys that the server has state objects on. You are responsible for freeing this list.
.sp
A command line tool, memstat(1), is provided so that you do not have to write
an application to do this.
.sp
Varies, see particular functions.
.sp
-Any method returning a \fBmemcached_stat_st\fP expects you to free the
+Any method returning a \fI\%memcached_stat_st\fP expects you to free the
memory allocated for it.
.SH HOME
.sp
-.TH "MEMCACHED_STAT_EXECUTE" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_STAT_EXECUTE" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_stat_execute \- libmemcached Documentation
.
#include <libmemcached/memcached.h>
.INDENT 0.0
.TP
-.B memcached_stat_st *memcached_stat (memcached_st *ptr, char *args, memcached_return_t *error);
+.B memcached_stat_st
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_stat_servername (memcached_stat_st *stat, char *args, const char *hostname, unsigned int port);
+.B memcached_return_t (*memcached_stat_fn)(memcached_server_instance_st\fI\ server\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, const char\fI\ *value\fP, size_t\fI\ value_length\fP, void\fI\ *context\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B char * memcached_stat_get_value (memcached_st *ptr, memcached_stat_st *stat, const char *key, memcached_return_t *error);
+.B \fI\%memcached_stat_st\fP *memcached_stat(memcached_st\fI\ *ptr\fP, char\fI\ *args\fP, memcached_return_t\fI\ *error\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B char ** memcached_stat_get_keys (memcached_st *ptr, memcached_stat_st *stat, memcached_return_t *error);
+.B memcached_return_t memcached_stat_servername(\fI\%memcached_stat_st\fP\fI\ *stat\fP, char\fI\ *args\fP, const char\fI\ *hostname\fP, in_port_t\fI\ port\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_stat_execute (memcached_st *memc, const char *args, memcached_stat_fn func, void *context);
+.B char * memcached_stat_get_value(memcached_st\fI\ *ptr\fP, \fI\%memcached_stat_st\fP\fI\ *stat\fP, const char\fI\ *key\fP, memcached_return_t\fI\ *error\fP)
+.UNINDENT
+.INDENT 0.0
+.TP
+.B char ** memcached_stat_get_keys(memcached_st\fI\ *ptr\fP, \fI\%memcached_stat_st\fP\fI\ *stat\fP, memcached_return_t\fI\ *error\fP)
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_return_t memcached_stat_execute(memcached_st\fI\ *memc\fP, const char\fI\ *args\fP, \fI\%memcached_stat_fn\fP\fI\ func\fP, void\fI\ *context\fP)
.UNINDENT
.sp
Compile and link with \-lmemcached
.sp
libmemcached(3) has the ability to query a memcached server (or collection
of servers) for their current state. Queries to find state return a
-\fBmemcached_stat_st\fP structure. You are responsible for freeing this structure. While it is possible to access the structure directly it is not advisable. \fBmemcached_stat_get_value()\fP has been provided to query the structure.
+\fI\%memcached_stat_st\fP structure. You are responsible for freeing this structure. While it is possible to access the structure directly it is not advisable. \fI\%memcached_stat_get_value()\fP has been provided to query the structure.
.sp
-\fBmemcached_stat_execute()\fP uses the servers found in \fBmemcached_stat_st\fP and executes a "stat" command on each server. args is an optional argument that can be passed in to modify the behavior of "stats". You will need to supply a callback function that will be supplied each pair of values returned by
+\fI\%memcached_stat_execute()\fP uses the servers found in \fI\%memcached_stat_st\fP and executes a "stat" command on each server. args is an optional argument that can be passed in to modify the behavior of "stats". You will need to supply a callback function that will be supplied each pair of values returned by
the memcached server.
.sp
-\fBmemcached_stat()\fP fetches an array of \fBmemcached_stat_st\fP structures containing the state of all available memcached servers. The return value must be freed by the calling application. If called with the \fBMEMCACHED_BEHAVIOR_USE_UDP\fP behavior set, a NULL value is returned and the error parameter is set to \fBMEMCACHED_NOT_SUPPORTED\fP.
+\fI\%memcached_stat()\fP fetches an array of \fI\%memcached_stat_st\fP structures containing the state of all available memcached servers. The return value must be freed by the calling application. If called with the \fBMEMCACHED_BEHAVIOR_USE_UDP\fP behavior set, a NULL value is returned and the error parameter is set to \fBMEMCACHED_NOT_SUPPORTED\fP.
.sp
-\fBmemcached_stat_servername()\fP can be used standalone without a \fBmemcached_st\fP to obtain the state of a particular server. "args" is used to define a particular state object (a list of these are not provided for by either
-the \fBmemcached_stat_get_keys()\fP call nor are they defined in the memcached protocol). You must specify the hostname and port of the server you want to
+\fI\%memcached_stat_servername()\fP can be used standalone without a \fBmemcached_st\fP to obtain the state of a particular server. "args" is used to define a particular state object (a list of these are not provided for by either
+the \fI\%memcached_stat_get_keys()\fP call nor are they defined in the memcached protocol). You must specify the hostname and port of the server you want to
obtain information on.
.sp
-\fBmemcached_stat_get_value()\fP returns the value of a particular state key. You specify the key you wish to obtain. The key must be null terminated.
+\fI\%memcached_stat_get_value()\fP returns the value of a particular state key. You specify the key you wish to obtain. The key must be null terminated.
.sp
-\fBmemcached_stat_get_keys()\fP returns a list of keys that the server has state objects on. You are responsible for freeing this list.
+\fI\%memcached_stat_get_keys()\fP returns a list of keys that the server has state objects on. You are responsible for freeing this list.
.sp
A command line tool, memstat(1), is provided so that you do not have to write
an application to do this.
.sp
Varies, see particular functions.
.sp
-Any method returning a \fBmemcached_stat_st\fP expects you to free the
+Any method returning a \fI\%memcached_stat_st\fP expects you to free the
memory allocated for it.
.SH HOME
.sp
-.TH "MEMCACHED_STAT_GET_KEYS" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_STAT_GET_KEYS" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_stat_get_keys \- libmemcached Documentation
.
#include <libmemcached/memcached.h>
.INDENT 0.0
.TP
-.B memcached_stat_st *memcached_stat (memcached_st *ptr, char *args, memcached_return_t *error);
+.B memcached_stat_st
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_stat_servername (memcached_stat_st *stat, char *args, const char *hostname, unsigned int port);
+.B memcached_return_t (*memcached_stat_fn)(memcached_server_instance_st\fI\ server\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, const char\fI\ *value\fP, size_t\fI\ value_length\fP, void\fI\ *context\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B char * memcached_stat_get_value (memcached_st *ptr, memcached_stat_st *stat, const char *key, memcached_return_t *error);
+.B \fI\%memcached_stat_st\fP *memcached_stat(memcached_st\fI\ *ptr\fP, char\fI\ *args\fP, memcached_return_t\fI\ *error\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B char ** memcached_stat_get_keys (memcached_st *ptr, memcached_stat_st *stat, memcached_return_t *error);
+.B memcached_return_t memcached_stat_servername(\fI\%memcached_stat_st\fP\fI\ *stat\fP, char\fI\ *args\fP, const char\fI\ *hostname\fP, in_port_t\fI\ port\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_stat_execute (memcached_st *memc, const char *args, memcached_stat_fn func, void *context);
+.B char * memcached_stat_get_value(memcached_st\fI\ *ptr\fP, \fI\%memcached_stat_st\fP\fI\ *stat\fP, const char\fI\ *key\fP, memcached_return_t\fI\ *error\fP)
+.UNINDENT
+.INDENT 0.0
+.TP
+.B char ** memcached_stat_get_keys(memcached_st\fI\ *ptr\fP, \fI\%memcached_stat_st\fP\fI\ *stat\fP, memcached_return_t\fI\ *error\fP)
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_return_t memcached_stat_execute(memcached_st\fI\ *memc\fP, const char\fI\ *args\fP, \fI\%memcached_stat_fn\fP\fI\ func\fP, void\fI\ *context\fP)
.UNINDENT
.sp
Compile and link with \-lmemcached
.sp
libmemcached(3) has the ability to query a memcached server (or collection
of servers) for their current state. Queries to find state return a
-\fBmemcached_stat_st\fP structure. You are responsible for freeing this structure. While it is possible to access the structure directly it is not advisable. \fBmemcached_stat_get_value()\fP has been provided to query the structure.
+\fI\%memcached_stat_st\fP structure. You are responsible for freeing this structure. While it is possible to access the structure directly it is not advisable. \fI\%memcached_stat_get_value()\fP has been provided to query the structure.
.sp
-\fBmemcached_stat_execute()\fP uses the servers found in \fBmemcached_stat_st\fP and executes a "stat" command on each server. args is an optional argument that can be passed in to modify the behavior of "stats". You will need to supply a callback function that will be supplied each pair of values returned by
+\fI\%memcached_stat_execute()\fP uses the servers found in \fI\%memcached_stat_st\fP and executes a "stat" command on each server. args is an optional argument that can be passed in to modify the behavior of "stats". You will need to supply a callback function that will be supplied each pair of values returned by
the memcached server.
.sp
-\fBmemcached_stat()\fP fetches an array of \fBmemcached_stat_st\fP structures containing the state of all available memcached servers. The return value must be freed by the calling application. If called with the \fBMEMCACHED_BEHAVIOR_USE_UDP\fP behavior set, a NULL value is returned and the error parameter is set to \fBMEMCACHED_NOT_SUPPORTED\fP.
+\fI\%memcached_stat()\fP fetches an array of \fI\%memcached_stat_st\fP structures containing the state of all available memcached servers. The return value must be freed by the calling application. If called with the \fBMEMCACHED_BEHAVIOR_USE_UDP\fP behavior set, a NULL value is returned and the error parameter is set to \fBMEMCACHED_NOT_SUPPORTED\fP.
.sp
-\fBmemcached_stat_servername()\fP can be used standalone without a \fBmemcached_st\fP to obtain the state of a particular server. "args" is used to define a particular state object (a list of these are not provided for by either
-the \fBmemcached_stat_get_keys()\fP call nor are they defined in the memcached protocol). You must specify the hostname and port of the server you want to
+\fI\%memcached_stat_servername()\fP can be used standalone without a \fBmemcached_st\fP to obtain the state of a particular server. "args" is used to define a particular state object (a list of these are not provided for by either
+the \fI\%memcached_stat_get_keys()\fP call nor are they defined in the memcached protocol). You must specify the hostname and port of the server you want to
obtain information on.
.sp
-\fBmemcached_stat_get_value()\fP returns the value of a particular state key. You specify the key you wish to obtain. The key must be null terminated.
+\fI\%memcached_stat_get_value()\fP returns the value of a particular state key. You specify the key you wish to obtain. The key must be null terminated.
.sp
-\fBmemcached_stat_get_keys()\fP returns a list of keys that the server has state objects on. You are responsible for freeing this list.
+\fI\%memcached_stat_get_keys()\fP returns a list of keys that the server has state objects on. You are responsible for freeing this list.
.sp
A command line tool, memstat(1), is provided so that you do not have to write
an application to do this.
.sp
Varies, see particular functions.
.sp
-Any method returning a \fBmemcached_stat_st\fP expects you to free the
+Any method returning a \fI\%memcached_stat_st\fP expects you to free the
memory allocated for it.
.SH HOME
.sp
-.TH "MEMCACHED_STAT_GET_VALUE" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_STAT_GET_VALUE" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_stat_get_value \- libmemcached Documentation
.
#include <libmemcached/memcached.h>
.INDENT 0.0
.TP
-.B memcached_stat_st *memcached_stat (memcached_st *ptr, char *args, memcached_return_t *error);
+.B memcached_stat_st
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_stat_servername (memcached_stat_st *stat, char *args, const char *hostname, unsigned int port);
+.B memcached_return_t (*memcached_stat_fn)(memcached_server_instance_st\fI\ server\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, const char\fI\ *value\fP, size_t\fI\ value_length\fP, void\fI\ *context\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B char * memcached_stat_get_value (memcached_st *ptr, memcached_stat_st *stat, const char *key, memcached_return_t *error);
+.B \fI\%memcached_stat_st\fP *memcached_stat(memcached_st\fI\ *ptr\fP, char\fI\ *args\fP, memcached_return_t\fI\ *error\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B char ** memcached_stat_get_keys (memcached_st *ptr, memcached_stat_st *stat, memcached_return_t *error);
+.B memcached_return_t memcached_stat_servername(\fI\%memcached_stat_st\fP\fI\ *stat\fP, char\fI\ *args\fP, const char\fI\ *hostname\fP, in_port_t\fI\ port\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_stat_execute (memcached_st *memc, const char *args, memcached_stat_fn func, void *context);
+.B char * memcached_stat_get_value(memcached_st\fI\ *ptr\fP, \fI\%memcached_stat_st\fP\fI\ *stat\fP, const char\fI\ *key\fP, memcached_return_t\fI\ *error\fP)
+.UNINDENT
+.INDENT 0.0
+.TP
+.B char ** memcached_stat_get_keys(memcached_st\fI\ *ptr\fP, \fI\%memcached_stat_st\fP\fI\ *stat\fP, memcached_return_t\fI\ *error\fP)
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_return_t memcached_stat_execute(memcached_st\fI\ *memc\fP, const char\fI\ *args\fP, \fI\%memcached_stat_fn\fP\fI\ func\fP, void\fI\ *context\fP)
.UNINDENT
.sp
Compile and link with \-lmemcached
.sp
libmemcached(3) has the ability to query a memcached server (or collection
of servers) for their current state. Queries to find state return a
-\fBmemcached_stat_st\fP structure. You are responsible for freeing this structure. While it is possible to access the structure directly it is not advisable. \fBmemcached_stat_get_value()\fP has been provided to query the structure.
+\fI\%memcached_stat_st\fP structure. You are responsible for freeing this structure. While it is possible to access the structure directly it is not advisable. \fI\%memcached_stat_get_value()\fP has been provided to query the structure.
.sp
-\fBmemcached_stat_execute()\fP uses the servers found in \fBmemcached_stat_st\fP and executes a "stat" command on each server. args is an optional argument that can be passed in to modify the behavior of "stats". You will need to supply a callback function that will be supplied each pair of values returned by
+\fI\%memcached_stat_execute()\fP uses the servers found in \fI\%memcached_stat_st\fP and executes a "stat" command on each server. args is an optional argument that can be passed in to modify the behavior of "stats". You will need to supply a callback function that will be supplied each pair of values returned by
the memcached server.
.sp
-\fBmemcached_stat()\fP fetches an array of \fBmemcached_stat_st\fP structures containing the state of all available memcached servers. The return value must be freed by the calling application. If called with the \fBMEMCACHED_BEHAVIOR_USE_UDP\fP behavior set, a NULL value is returned and the error parameter is set to \fBMEMCACHED_NOT_SUPPORTED\fP.
+\fI\%memcached_stat()\fP fetches an array of \fI\%memcached_stat_st\fP structures containing the state of all available memcached servers. The return value must be freed by the calling application. If called with the \fBMEMCACHED_BEHAVIOR_USE_UDP\fP behavior set, a NULL value is returned and the error parameter is set to \fBMEMCACHED_NOT_SUPPORTED\fP.
.sp
-\fBmemcached_stat_servername()\fP can be used standalone without a \fBmemcached_st\fP to obtain the state of a particular server. "args" is used to define a particular state object (a list of these are not provided for by either
-the \fBmemcached_stat_get_keys()\fP call nor are they defined in the memcached protocol). You must specify the hostname and port of the server you want to
+\fI\%memcached_stat_servername()\fP can be used standalone without a \fBmemcached_st\fP to obtain the state of a particular server. "args" is used to define a particular state object (a list of these are not provided for by either
+the \fI\%memcached_stat_get_keys()\fP call nor are they defined in the memcached protocol). You must specify the hostname and port of the server you want to
obtain information on.
.sp
-\fBmemcached_stat_get_value()\fP returns the value of a particular state key. You specify the key you wish to obtain. The key must be null terminated.
+\fI\%memcached_stat_get_value()\fP returns the value of a particular state key. You specify the key you wish to obtain. The key must be null terminated.
.sp
-\fBmemcached_stat_get_keys()\fP returns a list of keys that the server has state objects on. You are responsible for freeing this list.
+\fI\%memcached_stat_get_keys()\fP returns a list of keys that the server has state objects on. You are responsible for freeing this list.
.sp
A command line tool, memstat(1), is provided so that you do not have to write
an application to do this.
.sp
Varies, see particular functions.
.sp
-Any method returning a \fBmemcached_stat_st\fP expects you to free the
+Any method returning a \fI\%memcached_stat_st\fP expects you to free the
memory allocated for it.
.SH HOME
.sp
-.TH "MEMCACHED_STAT_SERVERNAME" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_STAT_SERVERNAME" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_stat_servername \- libmemcached Documentation
.
#include <libmemcached/memcached.h>
.INDENT 0.0
.TP
-.B memcached_stat_st *memcached_stat (memcached_st *ptr, char *args, memcached_return_t *error);
+.B memcached_stat_st
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_stat_servername (memcached_stat_st *stat, char *args, const char *hostname, unsigned int port);
+.B memcached_return_t (*memcached_stat_fn)(memcached_server_instance_st\fI\ server\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, const char\fI\ *value\fP, size_t\fI\ value_length\fP, void\fI\ *context\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B char * memcached_stat_get_value (memcached_st *ptr, memcached_stat_st *stat, const char *key, memcached_return_t *error);
+.B \fI\%memcached_stat_st\fP *memcached_stat(memcached_st\fI\ *ptr\fP, char\fI\ *args\fP, memcached_return_t\fI\ *error\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B char ** memcached_stat_get_keys (memcached_st *ptr, memcached_stat_st *stat, memcached_return_t *error);
+.B memcached_return_t memcached_stat_servername(\fI\%memcached_stat_st\fP\fI\ *stat\fP, char\fI\ *args\fP, const char\fI\ *hostname\fP, in_port_t\fI\ port\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_stat_execute (memcached_st *memc, const char *args, memcached_stat_fn func, void *context);
+.B char * memcached_stat_get_value(memcached_st\fI\ *ptr\fP, \fI\%memcached_stat_st\fP\fI\ *stat\fP, const char\fI\ *key\fP, memcached_return_t\fI\ *error\fP)
+.UNINDENT
+.INDENT 0.0
+.TP
+.B char ** memcached_stat_get_keys(memcached_st\fI\ *ptr\fP, \fI\%memcached_stat_st\fP\fI\ *stat\fP, memcached_return_t\fI\ *error\fP)
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_return_t memcached_stat_execute(memcached_st\fI\ *memc\fP, const char\fI\ *args\fP, \fI\%memcached_stat_fn\fP\fI\ func\fP, void\fI\ *context\fP)
.UNINDENT
.sp
Compile and link with \-lmemcached
.sp
libmemcached(3) has the ability to query a memcached server (or collection
of servers) for their current state. Queries to find state return a
-\fBmemcached_stat_st\fP structure. You are responsible for freeing this structure. While it is possible to access the structure directly it is not advisable. \fBmemcached_stat_get_value()\fP has been provided to query the structure.
+\fI\%memcached_stat_st\fP structure. You are responsible for freeing this structure. While it is possible to access the structure directly it is not advisable. \fI\%memcached_stat_get_value()\fP has been provided to query the structure.
.sp
-\fBmemcached_stat_execute()\fP uses the servers found in \fBmemcached_stat_st\fP and executes a "stat" command on each server. args is an optional argument that can be passed in to modify the behavior of "stats". You will need to supply a callback function that will be supplied each pair of values returned by
+\fI\%memcached_stat_execute()\fP uses the servers found in \fI\%memcached_stat_st\fP and executes a "stat" command on each server. args is an optional argument that can be passed in to modify the behavior of "stats". You will need to supply a callback function that will be supplied each pair of values returned by
the memcached server.
.sp
-\fBmemcached_stat()\fP fetches an array of \fBmemcached_stat_st\fP structures containing the state of all available memcached servers. The return value must be freed by the calling application. If called with the \fBMEMCACHED_BEHAVIOR_USE_UDP\fP behavior set, a NULL value is returned and the error parameter is set to \fBMEMCACHED_NOT_SUPPORTED\fP.
+\fI\%memcached_stat()\fP fetches an array of \fI\%memcached_stat_st\fP structures containing the state of all available memcached servers. The return value must be freed by the calling application. If called with the \fBMEMCACHED_BEHAVIOR_USE_UDP\fP behavior set, a NULL value is returned and the error parameter is set to \fBMEMCACHED_NOT_SUPPORTED\fP.
.sp
-\fBmemcached_stat_servername()\fP can be used standalone without a \fBmemcached_st\fP to obtain the state of a particular server. "args" is used to define a particular state object (a list of these are not provided for by either
-the \fBmemcached_stat_get_keys()\fP call nor are they defined in the memcached protocol). You must specify the hostname and port of the server you want to
+\fI\%memcached_stat_servername()\fP can be used standalone without a \fBmemcached_st\fP to obtain the state of a particular server. "args" is used to define a particular state object (a list of these are not provided for by either
+the \fI\%memcached_stat_get_keys()\fP call nor are they defined in the memcached protocol). You must specify the hostname and port of the server you want to
obtain information on.
.sp
-\fBmemcached_stat_get_value()\fP returns the value of a particular state key. You specify the key you wish to obtain. The key must be null terminated.
+\fI\%memcached_stat_get_value()\fP returns the value of a particular state key. You specify the key you wish to obtain. The key must be null terminated.
.sp
-\fBmemcached_stat_get_keys()\fP returns a list of keys that the server has state objects on. You are responsible for freeing this list.
+\fI\%memcached_stat_get_keys()\fP returns a list of keys that the server has state objects on. You are responsible for freeing this list.
.sp
A command line tool, memstat(1), is provided so that you do not have to write
an application to do this.
.sp
Varies, see particular functions.
.sp
-Any method returning a \fBmemcached_stat_st\fP expects you to free the
+Any method returning a \fI\%memcached_stat_st\fP expects you to free the
memory allocated for it.
.SH HOME
.sp
-.TH "MEMCACHED_STATS" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_STATS" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_stats \- libmemcached Documentation
.
#include <libmemcached/memcached.h>
.INDENT 0.0
.TP
-.B memcached_stat_st *memcached_stat (memcached_st *ptr, char *args, memcached_return_t *error);
+.B memcached_stat_st
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_stat_servername (memcached_stat_st *stat, char *args, const char *hostname, unsigned int port);
+.B memcached_return_t (*memcached_stat_fn)(memcached_server_instance_st\fI\ server\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, const char\fI\ *value\fP, size_t\fI\ value_length\fP, void\fI\ *context\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B char * memcached_stat_get_value (memcached_st *ptr, memcached_stat_st *stat, const char *key, memcached_return_t *error);
+.B \fI\%memcached_stat_st\fP *memcached_stat(memcached_st\fI\ *ptr\fP, char\fI\ *args\fP, memcached_return_t\fI\ *error\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B char ** memcached_stat_get_keys (memcached_st *ptr, memcached_stat_st *stat, memcached_return_t *error);
+.B memcached_return_t memcached_stat_servername(\fI\%memcached_stat_st\fP\fI\ *stat\fP, char\fI\ *args\fP, const char\fI\ *hostname\fP, in_port_t\fI\ port\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_stat_execute (memcached_st *memc, const char *args, memcached_stat_fn func, void *context);
+.B char * memcached_stat_get_value(memcached_st\fI\ *ptr\fP, \fI\%memcached_stat_st\fP\fI\ *stat\fP, const char\fI\ *key\fP, memcached_return_t\fI\ *error\fP)
+.UNINDENT
+.INDENT 0.0
+.TP
+.B char ** memcached_stat_get_keys(memcached_st\fI\ *ptr\fP, \fI\%memcached_stat_st\fP\fI\ *stat\fP, memcached_return_t\fI\ *error\fP)
+.UNINDENT
+.INDENT 0.0
+.TP
+.B memcached_return_t memcached_stat_execute(memcached_st\fI\ *memc\fP, const char\fI\ *args\fP, \fI\%memcached_stat_fn\fP\fI\ func\fP, void\fI\ *context\fP)
.UNINDENT
.sp
Compile and link with \-lmemcached
.sp
libmemcached(3) has the ability to query a memcached server (or collection
of servers) for their current state. Queries to find state return a
-\fBmemcached_stat_st\fP structure. You are responsible for freeing this structure. While it is possible to access the structure directly it is not advisable. \fBmemcached_stat_get_value()\fP has been provided to query the structure.
+\fI\%memcached_stat_st\fP structure. You are responsible for freeing this structure. While it is possible to access the structure directly it is not advisable. \fI\%memcached_stat_get_value()\fP has been provided to query the structure.
.sp
-\fBmemcached_stat_execute()\fP uses the servers found in \fBmemcached_stat_st\fP and executes a "stat" command on each server. args is an optional argument that can be passed in to modify the behavior of "stats". You will need to supply a callback function that will be supplied each pair of values returned by
+\fI\%memcached_stat_execute()\fP uses the servers found in \fI\%memcached_stat_st\fP and executes a "stat" command on each server. args is an optional argument that can be passed in to modify the behavior of "stats". You will need to supply a callback function that will be supplied each pair of values returned by
the memcached server.
.sp
-\fBmemcached_stat()\fP fetches an array of \fBmemcached_stat_st\fP structures containing the state of all available memcached servers. The return value must be freed by the calling application. If called with the \fBMEMCACHED_BEHAVIOR_USE_UDP\fP behavior set, a NULL value is returned and the error parameter is set to \fBMEMCACHED_NOT_SUPPORTED\fP.
+\fI\%memcached_stat()\fP fetches an array of \fI\%memcached_stat_st\fP structures containing the state of all available memcached servers. The return value must be freed by the calling application. If called with the \fBMEMCACHED_BEHAVIOR_USE_UDP\fP behavior set, a NULL value is returned and the error parameter is set to \fBMEMCACHED_NOT_SUPPORTED\fP.
.sp
-\fBmemcached_stat_servername()\fP can be used standalone without a \fBmemcached_st\fP to obtain the state of a particular server. "args" is used to define a particular state object (a list of these are not provided for by either
-the \fBmemcached_stat_get_keys()\fP call nor are they defined in the memcached protocol). You must specify the hostname and port of the server you want to
+\fI\%memcached_stat_servername()\fP can be used standalone without a \fBmemcached_st\fP to obtain the state of a particular server. "args" is used to define a particular state object (a list of these are not provided for by either
+the \fI\%memcached_stat_get_keys()\fP call nor are they defined in the memcached protocol). You must specify the hostname and port of the server you want to
obtain information on.
.sp
-\fBmemcached_stat_get_value()\fP returns the value of a particular state key. You specify the key you wish to obtain. The key must be null terminated.
+\fI\%memcached_stat_get_value()\fP returns the value of a particular state key. You specify the key you wish to obtain. The key must be null terminated.
.sp
-\fBmemcached_stat_get_keys()\fP returns a list of keys that the server has state objects on. You are responsible for freeing this list.
+\fI\%memcached_stat_get_keys()\fP returns a list of keys that the server has state objects on. You are responsible for freeing this list.
.sp
A command line tool, memstat(1), is provided so that you do not have to write
an application to do this.
.sp
Varies, see particular functions.
.sp
-Any method returning a \fBmemcached_stat_st\fP expects you to free the
+Any method returning a \fI\%memcached_stat_st\fP expects you to free the
memory allocated for it.
.SH HOME
.sp
-.TH "MEMCACHED_STRERROR" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_STRERROR" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_strerror \- libmemcached Documentation
.
#include <libmemcached/memcached.h>
.INDENT 0.0
.TP
-.B const char * memcached_strerror (memcached_st *ptr, memcached_return_t rc);
+.B const char * memcached_strerror(memcached_st\fI\ *ptr\fP, memcached_return_t\fI\ rc\fP)
.UNINDENT
.sp
Compile and link with \-lmemcached
.SH DESCRIPTION
.sp
-\fBmemcached_strerror()\fP takes a \fBmemcached_return_t\fP value and returns a string describing the error.
+\fI\%memcached_strerror()\fP takes a \fBmemcached_return_t\fP value and returns a string describing the error.
.sp
This string must not be modified by the application.
.sp
\fBmemcached_return_t\fP values are of an enum type so that you can set up responses with switch/case and know that you are capturing all possible return values.
.SH RETURN
.sp
-\fBmemcached_strerror()\fP returns a string describing a \fBmemcached_return_t\fP value.
+\fI\%memcached_strerror()\fP returns a string describing a \fBmemcached_return_t\fP value.
.SH HOME
.sp
To find out more information please check:
-.TH "MEMCACHED_TOUCH" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_TOUCH" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_touch \- libmemcached Documentation
.
#include <libmemcached/memcached.h>
.INDENT 0.0
.TP
-.B memcached_return_t memcached_touch (memcached_st *ptr, const char *key, size_t key_length, time_t expiration);
+.B memcached_return_t memcached_touch(memcached_st\fI\ *ptr\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, time_t\fI\ expiration\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_touch_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, time_t expiration);
+.B memcached_return_t memcached_touch_by_key(memcached_st\fI\ *ptr\fP, const char\fI\ *group_key\fP, size_t\fI\ group_key_length\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, time_t\fI\ expiration\fP)
.UNINDENT
.sp
Compile and link with \-lmemcached
.SH DESCRIPTION
.sp
-\fBmemcached_touch()\fP is used to update the expiration time on an existing key.
-\fBmemcached_touch_by_key()\fP works the same, but it takes a master key
+\fI\%memcached_touch()\fP is used to update the expiration time on an existing key.
+\fI\%memcached_touch_by_key()\fP works the same, but it takes a master key
to find the given value.
.SH RETURN
.sp
-.TH "MEMCACHED_TOUCH_BY_KEY" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_TOUCH_BY_KEY" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_touch_by_key \- libmemcached Documentation
.
#include <libmemcached/memcached.h>
.INDENT 0.0
.TP
-.B memcached_return_t memcached_touch (memcached_st *ptr, const char *key, size_t key_length, time_t expiration);
+.B memcached_return_t memcached_touch(memcached_st\fI\ *ptr\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, time_t\fI\ expiration\fP)
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_return_t memcached_touch_by_key (memcached_st *ptr, const char *group_key, size_t group_key_length, const char *key, size_t key_length, time_t expiration);
+.B memcached_return_t memcached_touch_by_key(memcached_st\fI\ *ptr\fP, const char\fI\ *group_key\fP, size_t\fI\ group_key_length\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, time_t\fI\ expiration\fP)
.UNINDENT
.sp
Compile and link with \-lmemcached
.SH DESCRIPTION
.sp
-\fBmemcached_touch()\fP is used to update the expiration time on an existing key.
-\fBmemcached_touch_by_key()\fP works the same, but it takes a master key
+\fI\%memcached_touch()\fP is used to update the expiration time on an existing key.
+\fI\%memcached_touch_by_key()\fP works the same, but it takes a master key
to find the given value.
.SH RETURN
.sp
-.TH "MEMCACHED_USER_DATA" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_USER_DATA" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_user_data \- libmemcached Documentation
.
.sp
.nf
.ft C
-#include <libmemcached/memcached.h>
-
-void *memcached_get_user_data (memcached_st *ptr);
-void *memcached_set_user_data (memcached_st *ptr, void *data);
.ft P
.fi
+.sp
+#include <libmemcached/memcached.h>
+.INDENT 0.0
+.TP
+.B void *memcached_get_user_data(memcached_st\fI\ *ptr\fP)
+.UNINDENT
+.INDENT 0.0
+.TP
+.B void *memcached_set_user_data(memcached_st\fI\ *ptr\fP, void\fI\ *data\fP)
+.UNINDENT
+.sp
+Compile and link with \-lmemcached
.SH DESCRIPTION
.sp
libmemcached(3) allows you to store a pointer to a user specific data inside
the memcached_st structure.
.sp
-\fBmemcached_set_user_data()\fP is used to set the user specific data in the
+\fI\%memcached_set_user_data()\fP is used to set the user specific data in the
\fBmemcached_st\fP structure.
.sp
-\fBmemcached_get_user_data()\fP is used to retrieve the user specific data in the \fBmemcached_st\fP structure.
+\fI\%memcached_get_user_data()\fP is used to retrieve the user specific data in the \fBmemcached_st\fP structure.
.SH RETURN
.sp
-\fBmemcached_set_user_data()\fP returns the previous value of the user specific data.
+\fI\%memcached_set_user_data()\fP returns the previous value of the user specific data.
.sp
-\fBmemcached_get_user_data()\fP returns the current value uf the user specific data.
+\fI\%memcached_get_user_data()\fP returns the current value uf the user specific data.
.SH HOME
.sp
To find out more information please check:
-.TH "MEMCACHED_VERBOSITY" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_VERBOSITY" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_verbosity \- libmemcached Documentation
.
#include <libmemcached/memcached.h>
.INDENT 0.0
.TP
-.B memcached_return_t memcached_verbosity (memcached_st *ptr, unsigned int verbosity);
+.B memcached_return_t memcached_verbosity(memcached_st\fI\ *ptr\fP, uint32_t\fI\ verbosity\fP)
.UNINDENT
.sp
Compile and link with \-lmemcached
.SH DESCRIPTION
.sp
-\fBmemcached_verbosity()\fP modifies the "verbosity" of the
+\fI\%memcached_verbosity()\fP modifies the "verbosity" of the
memcached(1) servers referenced in the \fBmemcached_st\fP parameter.
.SH RETURN
.sp
-.TH "MEMCACHED_VERSION" "3" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCACHED_VERSION" "3" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcached_version \- libmemcached Documentation
.
.sp
\fI\%memcached_lib_version()\fP returns a string with the version of the libmemcached driver.
.sp
-A value of \fBmemcached_return_t\fP is returned from :c:func:\(aqmemcached_version()\(aq
+A value of \fBmemcached_return_t\fP is returned from :c:func:\(aqmemcached_version\(aq
.sp
On success that value will be \fBMEMCACHED_SUCCESS\fP.
.sp
-.TH "MEMCAPABLE" "1" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCAPABLE" "1" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcapable \- libmemcached Documentation
.
-.TH "MEMCAT" "1" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCAT" "1" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcat \- libmemcached Documentation
.
-.TH "MEMCP" "1" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMCP" "1" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memcp \- libmemcached Documentation
.
-.TH "MEMDUMP" "1" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMDUMP" "1" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memdump \- libmemcached Documentation
.
-.TH "MEMERROR" "1" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMERROR" "1" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memerror \- libmemcached Documentation
.
-.TH "MEMFLUSH" "1" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMFLUSH" "1" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memflush \- libmemcached Documentation
.
-.TH "MEMRM" "1" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMRM" "1" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memrm \- libmemcached Documentation
.
-.TH "MEMSLAP" "1" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMSLAP" "1" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memslap \- libmemcached Documentation
.
-.TH "MEMSTAT" "1" "January 26, 2012" "1.0.4" "libmemcached"
+.TH "MEMSTAT" "1" "March 14, 2012" "1.0.5" "libmemcached"
.SH NAME
memstat \- libmemcached Documentation
.
.TP
.B \-\-help
.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-analyze
+.UNINDENT
.SH HOME
.sp
To find out more information please check:
projects / awesomized / libmemcached / commitdiff
