Update docs.
[awesomized/libmemcached] / docs / man / memcached_server_add.3
1 .TH "MEMCACHED_SERVER_ADD" "3" "January 26, 2012" "1.0.4" "libmemcached"
2 .SH NAME
3 memcached_server_add \- 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_fn
39 .UNINDENT
40 .INDENT 0.0
41 .TP
42 .B uint32_t memcached_server_count(memcached_st\fI\ *ptr\fP)
43 .UNINDENT
44 .INDENT 0.0
45 .TP
46 .B memcached_return_t memcached_server_add(memcached_st\fI\ *ptr\fP, const char\fI\ *hostname\fP, in_port_t\fI\ port\fP)
47 .UNINDENT
48 .INDENT 0.0
49 .TP
50 .B memcached_return_t memcached_server_add_udp(memcached_st\fI\ *ptr\fP, const char\fI\ *hostname\fP, in_port_t\fI\ port\fP)
51 .UNINDENT
52 .INDENT 0.0
53 .TP
54 .B memcached_return_t memcached_server_add_unix_socket(memcached_st\fI\ *ptr\fP, const char\fI\ *socket\fP)
55 .UNINDENT
56 .INDENT 0.0
57 .TP
58 .B memcached_return_t memcached_server_push(memcached_st\fI\ *ptr\fP, const memcached_server_st\fI\ *list\fP)
59 .UNINDENT
60 .INDENT 0.0
61 .TP
62 .B memcached_server_instance_st memcached_server_by_key(memcached_st\fI\ *ptr\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, memcached_return_t\fI\ *error\fP)
63 .UNINDENT
64 .INDENT 0.0
65 .TP
66 .B memcached_server_instance_st memcached_server_get_last_disconnect(const memcached_st\fI\ *ptr\fP)
67 .UNINDENT
68 .INDENT 0.0
69 .TP
70 .B memcached_return_t memcached_server_cursor(const memcached_st\fI\ *ptr\fP, const \fI\%memcached_server_fn\fP\fI\ *callback\fP, void\fI\ *context\fP, uint32_t\fI\ number_of_callbacks\fP)
71 .UNINDENT
72 .sp
73 compile and link with \-lmemcached
74 .SH DESCRIPTION
75 .sp
76 \fBlibmemcached\fP performs operations on a list of hosts. The order of
77 these hosts determine routing to keys. Functions are provided to add keys to
78 memcached_st structures. To manipulate lists of servers see
79 memcached_server_st(3).
80 .sp
81 \fI\%memcached_server_count()\fP provides you a count of the current number of
82 servers being used by a \fBmemcached_st\fP structure.
83 .INDENT 0.0
84 .TP
85 .B \fI\%memcached_server_add()\fP pushes a single TCP server into the \fBmemcached_st\fP structure. This server will be placed at the end. Duplicate servers
86 are allowed, so duplication is not checked. Executing this function with the \fBMEMCACHED_BEHAVIOR_USE_UDP\fP behavior set will result in a \fBMEMCACHED_INVALID_HOST_PROTOCOL\fP.
87 .UNINDENT
88 .sp
89 \fI\%memcached_server_add_udp()\fP pushes a single UDP server into the \fBmemcached_st\fP structure. This server will be placed at the end. Duplicate
90 servers are allowed, so duplication is not checked. Executing this function with out setting the \fBMEMCACHED_BEHAVIOR_USE_UDP\fP behavior will result in a
91 \fBMEMCACHED_INVALID_HOST_PROTOCOL\fP.
92 .sp
93 \fI\%memcached_server_add_unix_socket()\fP pushes a single UNIX socket into the \fBmemcached_st\fP structure. This UNIX socket will be placed at the end.
94 Duplicate servers are allowed, so duplication is not checked. The length
95 of the filename must be one character less than \fBMEMCACHED_MAX_HOST_LENGTH\fP.
96 .sp
97 \fI\%memcached_server_push()\fP pushes an array of \fBmemcached_server_st\fP into the \fBmemcached_st\fP structure. These servers will be placed at
98 the end. Duplicate servers are allowed, so duplication is not checked. A
99 copy is made of structure so the list provided (and any operations on
100 the list) are not saved.
101 .sp
102 \fI\%memcached_server_by_key()\fP allows you to provide a key and retrieve the
103 server which would be used for assignment. This structure is cloned
104 from its original structure and must be freed. If NULL is returned you
105 should consult *error. The returning structure should be freed with
106 \fBmemcached_server_free()\fP.
107 .sp
108 \fI\%memcached_server_get_last_disconnect()\fP returns a pointer to the last
109 server for which there was a connection problem. It does not mean this
110 particular server is currently dead but if the library is reporting a server
111 is, the returned server is a very good candidate.
112 .sp
113 \fI\%memcached_server_cursor()\fP takes a memcached_st and loops through the
114 list of hosts currently in the cursor calling the list of callback
115 functions provided. You can optionally pass in a value via
116 context which will be provided to each callback function. An error
117 return from any callback will terminate the loop. \fI\%memcached_server_cursor()\fP is passed the original caller \fBmemcached_st\fP in its current state.
118 .SH RETURN
119 .sp
120 Varies, see particular functions.
121 .SH HOME
122 .sp
123 To find out more information please check:
124 \fI\%http://libmemcached.org/\fP
125 .SH SEE ALSO
126 .sp
127 \fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP
128 .SH AUTHOR
129 Brian Aker
130 .SH COPYRIGHT
131 2011, Brian Aker DataDifferential, http://datadifferential.com/
132 .\" Generated by docutils manpage writer.
133 .\"
134 .