X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fman%2Fmemcached_server_list_free.3;h=e6d14f3d52d6417d151fa88f9f200e4a980a375d;hb=9f3c2098e91293e4d69b1d691fbf352e440309ff;hp=0f2b62bbb56376181e56aa2eb8e4db791a80ce34;hpb=18ace40ddb7271f3f5e71965f74fe11d7754bd8f;p=m6w6%2Flibmemcached diff --git a/docs/man/memcached_server_list_free.3 b/docs/man/memcached_server_list_free.3 index 0f2b62bb..3bb2a492 100644 --- a/docs/man/memcached_server_list_free.3 +++ b/docs/man/memcached_server_list_free.3 @@ -1,4 +1,4 @@ -.TH "MEMCACHED_SERVER_LIST_FREE" "3" "April 11, 2011" "0.47" "libmemcached" +.TH "MEMCACHED_SERVER_LIST_FREE" "3" "April 08, 2012" "1.0.6" "libmemcached" .SH NAME memcached_server_list_free \- libmemcached Documentation . @@ -30,79 +30,85 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .. .\" Man page generated from reStructeredText. . +.SH SYNOPSIS .sp -Manage server list -.SH LIBRARY +#include +.INDENT 0.0 +.TP +.B memcached_server_instance_st +.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(\fI\%memcached_server_list_st\fP\fI\ list\fP) +.UNINDENT +.INDENT 0.0 +.TP +.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(\fI\%memcached_server_list_st\fP\fI\ list\fP) +.UNINDENT +.INDENT 0.0 +.TP +.B const char *memcached_server_error(\fI\%memcached_server_instance_st\fP\fI\ instance\fP) +.UNINDENT +.INDENT 0.0 +.TP +.B void memcached_server_error_reset(\fI\%memcached_server_instance_st\fP\fI\ list\fP) +.UNINDENT .sp -C Client Library for memcached (libmemcached, \-lmemcached) -.SS SYNOPSIS +Deprecated since version 0.39. +.INDENT 0.0 +.TP +.B void memcached_servers_parse() +.UNINDENT .sp -.nf -.ft C -#include - -const memcached_server_instance_st - memcached_server_list (memcached_st *ptr); - -void memcached_server_list_free (memcached_server_list_st list); - -memcached_server_list_st - memcached_server_list_append (memcached_server_list_st list, - const char *hostname, - unsigned int port, - memcached_return_t *error); - -uint32_t memcached_server_list_count (memcached_server_list_st list); - -memcached_server_list_st memcached_servers_parse (const char *server_strings); - -const char *memcached_server_error (memcached_server_instance_st instance); - -DEPRECATED -void memcached_server_error_reset (memcached_server_instance_st list); -.ft P -.fi -.SS DESCRIPTION +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 -memcached_server_st 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 -memcached_server_list() 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 -memcached_server_list_free() deallocates all memory associated with the array -of memcached_server_st 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 -memcached_server_list_append() adds a server to the end of a -memcached_server_st array. On error null will be returned and the -memcached_return_t 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 +\fI\%memcached_server_list_append()\fP adds a server to the end of a +\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 -memcached_servers_parse() takes a string, the type that is used for the -command line applications, and parse it to an array of memcached_server_st. -The example is "localhost, foo:555, foo, bar". All hosts except foo:555 will -be set to the default port, while that host will have a port of 555. +DEPRECATED \fI\%memcached_servers_parse()\fP, please see \fBmemcached()\fP .sp -memcached_server_error() can be used to look at the text of the last error -message sent by the server to to the client. +\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 memcached_server_list_st. 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. .SH HOME .sp To find out more information please check: -\fI\%https://launchpad.net/libmemcached\fP -.SH AUTHOR -.sp -Brian Aker, <\fI\%brian@tangent.org\fP> -.SS SEE ALSO +\fI\%http://libmemcached.org/\fP +.SH SEE ALSO .sp \fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP .SH AUTHOR