X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fman%2Fmemcached_server_add.3;h=59c698ea6e5939d8e121335885020ffe4efe5c87;hb=5aa178162af4134264e1c1e794e8b196bdd0d802;hp=5f6331176e1ebf9dbdfe35d8151e2ff59b0d98d9;hpb=67456d74f5bd4f354a360d70da503dc58cbe5971;p=m6w6%2Flibmemcached diff --git a/docs/man/memcached_server_add.3 b/docs/man/memcached_server_add.3 index 5f633117..06291d9f 100644 --- a/docs/man/memcached_server_add.3 +++ b/docs/man/memcached_server_add.3 @@ -1,4 +1,4 @@ -.TH "MEMCACHED_SERVER_ADD" "3" "April 14, 2011" "0.47" "libmemcached" +.TH "MEMCACHED_SERVER_ADD" "3" "April 28, 2012" "1.0.7" "libmemcached" .SH NAME memcached_server_add \- libmemcached Documentation . @@ -30,82 +30,88 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .. .\" Man page generated from reStructeredText. . +.SH SYNOPSIS .sp -Manage server list -.SH LIBRARY -.sp -C Client Library for memcached (libmemcached, \-lmemcached) -.SS SYNOPSIS -.sp -.nf -.ft C #include - -uint32_t memcached_server_count (memcached_st *ptr); - -memcached_return_t memcached_server_add (memcached_st *ptr, const char *hostname, in_port_t port); - -memcached_return_t memcached_server_add_udp (memcached_st *ptr, const char *hostname, in_port_t port); - -memcached_return_t memcached_server_add_unix_socket (memcached_st *ptr, const char *socket); - -memcached_return_t memcached_server_push (memcached_st *ptr, const memcached_server_st *list); - -memcached_server_instance_st memcached_server_by_key (const memcached_st *ptr, const char *key, size_t key_length, memcached_return_t *error); - -memcached_server_instance_st memcached_server_get_last_disconnect (const memcached_st *ptr) - -memcached_return_t memcached_server_cursor(const memcached_st *ptr, const memcached_server_fn *callback, void *context, uint32_t number_of_callbacks); -.ft P -.fi -.SS DESCRIPTION +.INDENT 0.0 +.TP +.B memcached_server_fn +.UNINDENT +.INDENT 0.0 +.TP +.B uint32_t memcached_server_count(memcached_st\fI\ *ptr\fP) +.UNINDENT +.INDENT 0.0 +.TP +.B memcached_return_t memcached_server_add(memcached_st\fI\ *ptr\fP, const char\fI\ *hostname\fP, in_port_t\fI\ port\fP) +.UNINDENT +.INDENT 0.0 +.TP +.B memcached_return_t memcached_server_add_udp(memcached_st\fI\ *ptr\fP, const char\fI\ *hostname\fP, in_port_t\fI\ port\fP) +.UNINDENT +.INDENT 0.0 +.TP +.B memcached_return_t memcached_server_add_unix_socket(memcached_st\fI\ *ptr\fP, const char\fI\ *socket\fP) +.UNINDENT +.INDENT 0.0 +.TP +.B memcached_return_t memcached_server_push(memcached_st\fI\ *ptr\fP, const memcached_server_st\fI\ *list\fP) +.UNINDENT +.INDENT 0.0 +.TP +.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 +.B memcached_server_instance_st memcached_server_get_last_disconnect(const memcached_st\fI\ *ptr\fP) +.UNINDENT +.INDENT 0.0 +.TP +.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) +.UNINDENT +.sp +compile and link with \-lmemcached +.SH DESCRIPTION .sp -libmemcached(3) performs operations on a list of hosts. The order of these -hosts determine routing to keys. Functions are provided to add keys to +\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 memcached_server_st(3). .sp -memcached_server_count() provides you a count of the current number of +\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 -memcached_server_add() pushes a single TCP server into the \fBmemcached_st\fPstructure. 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. -.sp -memcached_server_add_udp() pushes a single UDP server into the \fBmemcached_st\fPstructure. 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 +\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 -memcached_server_add_unix_socket() pushes a single UNIX socket into the -\fBmemcached_st\fP structure. This UNIX socket will be placed at the end. +\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 MEMCACHED_MAX_HOST_LENGTH. +of the filename must be one character less than \fBMEMCACHED_MAX_HOST_LENGTH\fP. .sp -memcached_server_push() 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 +\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 -memcached_server_by_key() 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 -memcached_server_free(). +\fI\%memcached_server_by_key()\fP allows you to provide a key and retrieve the +server which would be used for assignment. .sp -memcached_server_get_last_disconnect() 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. +\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 -memcached_server_cursor() takes a memcached_st and loops through the +\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. memcached_server_cursor() -is passed the original caller memcached_st in its current state. +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. @@ -113,7 +119,7 @@ Varies, see particular functions. .sp To find out more information please check: \fI\%http://libmemcached.org/\fP -.SS SEE ALSO +.SH SEE ALSO .sp \fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP .SH AUTHOR