trAvis - MANAGER

Edit File: memcached_server_list_append.3

.\" Man page generated from reStructuredText. . .TH "MEMCACHED_SERVER_LIST_APPEND" "3" "February 09, 2014" "1.0.18" "libmemcached" .SH NAME memcached_server_list_append \- libmemcached Documentation . .nr rst2man-indent-level 0 . .de1 rstReportMargin \\$1 \\n[an-margin] level \\n[rst2man-indent-level] level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] - \\n[rst2man-indent0] \\n[rst2man-indent1] \\n[rst2man-indent2] .. .de1 INDENT .\" .rstReportMargin pre: . RS \\$1 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] . nr rst2man-indent-level +1 .\" .rstReportMargin post: .. .de UNINDENT . RE .\" indent \\n[an-margin] .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] .nr rst2man-indent-level -1 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. . .nr rst2man-indent-level 0 . .de1 rstReportMargin \\$1 \\n[an-margin] level \\n[rst2man-indent-level] level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] - \\n[rst2man-indent0] \\n[rst2man-indent1] \\n[rst2man-indent2] .. .de1 INDENT .\" .rstReportMargin pre: . RS \\$1 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] . nr rst2man-indent-level +1 .\" .rstReportMargin post: .. .de UNINDENT . RE .\" indent \\n[an-margin] .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] .nr rst2man-indent-level -1 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. .SH SYNOPSIS .sp #include <libmemcached/memcached.h> .INDENT 0.0 .TP .B const memcached_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 const memcached_instance_st * 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(const memcached_instance_st *\fI\ instance\fP) .UNINDENT .INDENT 0.0 .TP .B void memcached_server_error_reset(const memcached_instance_st *\fI\ list\fP) .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 \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. .sp \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 \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 \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 \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\%http://libmemcached.org/\fP .SH SEE ALSO .sp \fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP .SH AUTHOR Brian Aker .SH COPYRIGHT 2011-2013, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .