X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fmemcached_servers.pod;h=3cd5da9e5478d1ac960156b4e59fbd09ec0e48b0;hb=94885bf32b9393247186c0e82271f2bd5a5f6c91;hp=2fbd1a6632ce7a2e119d623056a9cdd449fb4be7;hpb=128e13163e0f26383f888fe0bb284d569562ca6c;p=awesomized%2Flibmemcached diff --git a/docs/memcached_servers.pod b/docs/memcached_servers.pod old mode 100755 new mode 100644 index 2fbd1a66..3cd5da9e --- a/docs/memcached_servers.pod +++ b/docs/memcached_servers.pod @@ -1,6 +1,6 @@ =head1 NAME -memcached_server_count, memcached_server_list, memcached_server_add, memcached_server_push +memcached_server_count, memcached_server_list, memcached_server_add, memcached_server_push, memcached_server_get_last_disconnect - Manage server list =head1 LIBRARY @@ -15,20 +15,33 @@ C Client Library for memcached (libmemcached, -lmemcached) memcached_server_st * memcached_server_list (memcached_st *ptr); - memcached_return + memcached_return_t memcached_server_add (memcached_st *ptr, - char *hostname, - unsigned int port); + const char *hostname, + in_port_t port); - memcached_return + 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, - char *hostname, - unsigned int port); + const char *socket); - memcached_return + memcached_return_t memcached_server_push (memcached_st *ptr, memcached_server_st *list); + memcached_server_st * + memcached_server_by_key (memcached_st *ptr, + const char *key, size_t key_length, + memcached_return_t *error); + + memcached_server_st * + memcached_server_get_last_disconnect (memcached_st *ptr) + + =head1 DESCRIPTION libmemcached(3) performs operations on a list of hosts. The order of these @@ -39,16 +52,24 @@ memcached_server_st(3). memcached_server_count() provides you a count of the current number of servers being used by a C structure. -memcached_server_list() is used to provide an array of all connected hosts. +memcached_server_list() is used to provide an array of all defined hosts. You are responsible for freeing this list (aka it is not a pointer to the currently used structure). -memcached_server_add() pushes a single server into the C +memcached_server_add() pushes a single TCP server into the C +structure. This server will be placed at the end. Duplicate servers are +allowed, so duplication is not checked. Executing this function with the +C behavior set will result in a +C. + +memcached_server_add_udp() pushes a single UDP server into the C structure. This server will be placed at the end. Duplicate servers are -allowed, so duplication is not checked. +allowed, so duplication is not checked. Executing this function with out +setting the C behavior will result in a +C. -memcached_server_add_unix_socket() pushes a single UNIX socket into the -C structure. This UNIX socket will be placed at the end. +memcached_server_add_unix_socket() pushes a single UNIX socket into the +C 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. @@ -58,14 +79,25 @@ 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. +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(). + +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. + =head1 RETURN Varies, see particular functions. =head1 HOME -To find out more information please check: -L +To find out more information please check: +L =head1 AUTHOR