-.TH "MEMCACHED_SERVER_PUSH" "3" "June 17, 2011" "0.49" "libmemcached"
+.TH "MEMCACHED_SERVER_PUSH" "3" "April 28, 2012" "1.0.7" "libmemcached"
.SH NAME
memcached_server_push \- libmemcached Documentation
.
.UNINDENT
.INDENT 0.0
.TP
-.B memcached_server_instance_st memcached_server_by_key(const memcached_st\fI\ *ptr\fP, const char\fI\ *key\fP, size_t\fI\ key_length\fP, memcached_return_t\fI\ *error\fP)
+.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)
.UNINDENT
.INDENT 0.0
.TP
\fBlibmemcached\fP performs operations on a list of hosts. The order of
these hosts determine routing to keys. Functions are provided to add keys to
memcached_st structures. To manipulate lists of servers see
-\fBmemcached_server_st()\fP.
+memcached_server_st(3).
.sp
-\fI\%memcached_server_count()\fP provides you a count of the current
-number of servers being used by a \fBmemcached_st\fP structure.
-.sp
-\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 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.
+\fI\%memcached_server_count()\fP provides you a count of the current number of
+servers being used by a \fBmemcached_st\fP structure.
+.INDENT 0.0
+.TP
+.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
+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.
+.UNINDENT
.sp
-\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 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 \fBMEMCACHED_INVALID_HOST_PROTOCOL\fP.
+\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
+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
+\fBMEMCACHED_INVALID_HOST_PROTOCOL\fP.
.sp
-\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. Duplicate servers are allowed, so duplication is not checked.
-The length of the filename must be one character less then
-\fBMEMCACHED_MAX_HOST_LENGTH\fP.
+\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.
+Duplicate servers are allowed, so duplication is not checked. The length
+of the filename must be one character less than \fBMEMCACHED_MAX_HOST_LENGTH\fP.
.sp
-\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 the end. Duplicate servers are allowed, so
-duplication is not checked. A copy is made of structure so the list provided
-(and any operations on the list) are not saved.
+\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
+the end. Duplicate servers are allowed, so duplication is not checked. A
+copy is made of structure so the list provided (and any operations on
+the list) are not saved.
.sp
-\fI\%memcached_server_by_key()\fP allows you to provide a key and retrieve
-the server which would be used for assignment. This structure is cloned from
-its original structure and must be freed. If NULL is returned you should
-consult *error. The returning structure should be freed with
-\fBmemcached_server_free()\fP.
+\fI\%memcached_server_by_key()\fP allows you to provide a key and retrieve the
+server which would be used for assignment.
.sp
-\fI\%memcached_server_get_last_disconnect()\fP returns a pointer to the
-last server for which there was a connection problem. It does not mean this
+\fI\%memcached_server_get_last_disconnect()\fP returns a pointer to the last
+server for which there was a connection problem. It does not mean this
particular server is currently dead but if the library is reporting a server
is, the returned server is a very good candidate.
.sp
-\fI\%memcached_server_cursor()\fP takes a memcached_st and loops through
-the list of hosts currently in the cursor calling the list of callback
-functions provided. You can optionally pass in a value via context which
-will be provided to each callback function. An error return from any
-callback will terminate the loop. \fI\%memcached_server_cursor()\fP is
-passed the original caller memcached_st in its current state.
+\fI\%memcached_server_cursor()\fP takes a memcached_st and loops through the
+list of hosts currently in the cursor calling the list of callback
+functions provided. You can optionally pass in a value via
+context which will be provided to each callback function. An error
+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.
.SH RETURN
.sp
Varies, see particular functions.
projects / m6w6 / libmemcached / blobdiff