docs/man/memcached_server_list_count.3


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120

.TH "MEMCACHED_SERVER_LIST_COUNT" "3" "September 16, 2012" "1.0.10" "libmemcached"
.SH NAME
memcached_server_list_count \- 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
..
.\" Man page generated from reStructeredText.
.
.SH SYNOPSIS
.sp
#include <libmemcached/memcached.h>
.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
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-2012, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\" 
.