1 .TH "MEMCACHED_SERVERS_PARSE" "3" "June 17, 2011" "0.49" "libmemcached"
3 memcached_servers_parse \- libmemcached Documentation
5 .nr rst2man-indent-level 0
9 level \\n[rst2man-indent-level]
10 level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
17 .\" .rstReportMargin pre:
19 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
20 . nr rst2man-indent-level +1
21 .\" .rstReportMargin post:
25 .\" indent \\n[an-margin]
26 .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
27 .nr rst2man-indent-level -1
28 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
29 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
31 .\" Man page generated from reStructeredText.
35 #include <libmemcached/memcached.h>
38 .B memcached_server_instance_st
42 .B const \fI\%memcached_server_instance_st\fP memcached_server_list(memcached_st\fI\ *ptr\fP)
46 .B void memcached_server_list_free(memcached_server_list_st\fI\ list\fP)
50 .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)
54 .B uint32_t memcached_server_list_count(memcached_server_list_st\fI\ list\fP)
58 .B const char *memcached_server_error(\fI\%memcached_server_instance_st\fP\fI\ instance\fP)
62 .B void memcached_server_error_reset(\fI\%memcached_server_instance_st\fP\fI\ list\fP)
65 Deprecated since version 0.39.
67 Compile and link with \-lmemcached
70 libmemcached(3) operates on a list of hosts which are stored in
71 memcached_server_st structures. You should not modify these structures
72 directly. Functions are provided to modify these structures (and more can be
75 \fI\%memcached_server_list()\fP is used to provide an array of all defined hosts.
76 This was incorrectly documented as "requiring free()" up till version 0.39.
78 \fI\%memcached_server_list_free()\fP deallocates all memory associated with the array
79 of memcached_server_st that you passed to it.
81 \fI\%memcached_server_list_append()\fP adds a server to the end of a
82 memcached_server_st array. On error null will be returned and the
83 memcached_return_t pointer you passed into the function will be set with the
84 appropriate error. If the value of port is zero, it is set to the default
85 port of a memcached server.
87 DEPRECATED \fBmemcached_servers_parse()\fP, please see \fBmemcached()\fP
89 \fI\%memcached_server_error()\fP can be used to look at the text of the last error
90 message sent by the server to to the client.
92 Before version 0.39 these functions used a memcache_server_st *. In 0.39
93 memcached_server_st * was aliased to \fBmemcached_server_list_st\fP. This was
94 done for a style reason/to help clean up some concepts in the code.
97 Varies, see particular functions.
100 To find out more information please check:
101 \fI\%http://libmemcached.org/\fP
104 \fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP
108 2011, Brian Aker DataDifferential, http://datadifferential.com/
109 .\" Generated by docutils manpage writer.