~brianaker/libmemcached/gear-clean

« back to all changes in this revision

Viewing changes to docs/man/memcached_servers_parse.3

  • Committer: Brian Aker
  • Date: 2012-09-24 01:36:01 UTC
  • mto: This revision was merged to the branch mainline in revision 1072.
  • Revision ID: brian@tangent.org-20120924013601-4f0zeykol10ka6so
Updates from ddm4

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.TH "MEMCACHED_SERVERS_PARSE" "3" "September 16, 2012" "1.0.10" "libmemcached"
 
2
.SH NAME
 
3
memcached_servers_parse \- libmemcached Documentation
 
4
.
 
5
.nr rst2man-indent-level 0
 
6
.
 
7
.de1 rstReportMargin
 
8
\\$1 \\n[an-margin]
 
9
level \\n[rst2man-indent-level]
 
10
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 
11
-
 
12
\\n[rst2man-indent0]
 
13
\\n[rst2man-indent1]
 
14
\\n[rst2man-indent2]
 
15
..
 
16
.de1 INDENT
 
17
.\" .rstReportMargin pre:
 
18
. RS \\$1
 
19
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
 
20
. nr rst2man-indent-level +1
 
21
.\" .rstReportMargin post:
 
22
..
 
23
.de UNINDENT
 
24
. RE
 
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
 
30
..
 
31
.\" Man page generated from reStructeredText.
 
32
.
 
33
.SH SYNOPSIS
 
34
.sp
 
35
#include <libmemcached/memcached.h>
 
36
.INDENT 0.0
 
37
.TP
 
38
.B memcached_server_instance_st
 
39
.UNINDENT
 
40
.INDENT 0.0
 
41
.TP
 
42
.B memcached_server_list_st
 
43
.UNINDENT
 
44
.INDENT 0.0
 
45
.TP
 
46
.B memcached_server_st
 
47
.UNINDENT
 
48
.INDENT 0.0
 
49
.TP
 
50
.B const \fI\%memcached_server_instance_st\fP memcached_server_list(memcached_st\fI\ *ptr\fP)
 
51
.UNINDENT
 
52
.INDENT 0.0
 
53
.TP
 
54
.B void memcached_server_list_free(\fI\%memcached_server_list_st\fP\fI\ list\fP)
 
55
.UNINDENT
 
56
.INDENT 0.0
 
57
.TP
 
58
.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)
 
59
.UNINDENT
 
60
.INDENT 0.0
 
61
.TP
 
62
.B uint32_t memcached_server_list_count(\fI\%memcached_server_list_st\fP\fI\ list\fP)
 
63
.UNINDENT
 
64
.INDENT 0.0
 
65
.TP
 
66
.B const char *memcached_server_error(\fI\%memcached_server_instance_st\fP\fI\ instance\fP)
 
67
.UNINDENT
 
68
.INDENT 0.0
 
69
.TP
 
70
.B void memcached_server_error_reset(\fI\%memcached_server_instance_st\fP\fI\ list\fP)
 
71
.UNINDENT
 
72
.sp
 
73
Deprecated since version 0.39.
 
74
.INDENT 0.0
 
75
.TP
 
76
.B void memcached_servers_parse()
 
77
.UNINDENT
 
78
.sp
 
79
Deprecated since version 0.39.
 
80
.sp
 
81
Compile and link with \-lmemcached
 
82
.SH DESCRIPTION
 
83
.sp
 
84
libmemcached(3) operates on a list of hosts which are stored in
 
85
\fI\%memcached_server_st\fP structures. You should not modify these structures
 
86
directly. Functions are provided to modify these structures (and more can be
 
87
added, just ask!).
 
88
.sp
 
89
\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.
 
90
.sp
 
91
\fI\%memcached_server_list_free()\fP deallocates all memory associated with the array of \fI\%memcached_server_st\fP that you passed to it.
 
92
.sp
 
93
\fI\%memcached_server_list_append()\fP adds a server to the end of a
 
94
\fI\%memcached_server_st\fP array. On error null will be returned and the
 
95
\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
 
96
port of a memcached server.
 
97
.sp
 
98
DEPRECATED \fI\%memcached_servers_parse()\fP, please see \fBmemcached()\fP
 
99
.sp
 
100
\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.
 
101
.sp
 
102
Before version 0.39 theses functions used a memcache_server_st *. In 0.39
 
103
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.
 
104
.SH RETURN
 
105
.sp
 
106
Varies, see particular functions.
 
107
.SH HOME
 
108
.sp
 
109
To find out more information please check:
 
110
\fI\%http://libmemcached.org/\fP
 
111
.SH SEE ALSO
 
112
.sp
 
113
\fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP
 
114
.SH AUTHOR
 
115
Brian Aker
 
116
.SH COPYRIGHT
 
117
2011-2012, Brian Aker DataDifferential, http://datadifferential.com/
 
118
.\" Generated by docutils manpage writer.
 
119
.\" 
 
120
.