X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fman%2Fmemcached_stat_execute.3;h=2af3170b991786db0103c428396bcd5b3f4bd79e;hb=5a6dd35a036e60a1e51d2bffbde6b5fb0064e65d;hp=7f9e70229219659be3cdc796010ab8e76b17c55b;hpb=984cae2b407dbe0547aff01b20802aaa94dc97af;p=awesomized%2Flibmemcached diff --git a/docs/man/memcached_stat_execute.3 b/docs/man/memcached_stat_execute.3 index 7f9e7022..2af3170b 100644 --- a/docs/man/memcached_stat_execute.3 +++ b/docs/man/memcached_stat_execute.3 @@ -1,4 +1,4 @@ -.TH "MEMCACHED_STAT_EXECUTE" "3" "October 18, 2011" "1.01" "libmemcached" +.TH "MEMCACHED_STAT_EXECUTE" "3" "September 16, 2012" "1.0.10" "libmemcached" .SH NAME memcached_stat_execute \- libmemcached Documentation . @@ -37,23 +37,31 @@ Get memcached statistics #include .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 @@ -61,20 +69,20 @@ 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. @@ -82,7 +90,7 @@ 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 @@ -97,7 +105,7 @@ Brian Aker, <\fI\%brian@tangent.org\fP> .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker DataDifferential, http://datadifferential.com/ +2011-2012, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" .