Daisuke Maki > Memcached-libmemcached-0.3102 > memcached_server_add

Download:
Memcached-libmemcached-0.3102.tar.gz

Annotate this POD

CPAN RT

New  1
Open  0
Stalled  5
View/Report Bugs
Source   Latest Release: Memcached-libmemcached-0.4202

NAME ^

memcached_server_count, memcached_server_list, memcached_server_add, memcached_server_push - Manage server list

LIBRARY ^

C Client Library for memcached (libmemcached, -lmemcached)

SYNOPSIS ^

  #include <memcached.h>

  unsigned int memcached_server_count (memcached_st *ptr);

  memcached_server_st *
    memcached_server_list (memcached_st *ptr);

  memcached_return
    memcached_server_add (memcached_st *ptr,
                          const char *hostname,
                          unsigned int port);

  memcached_return
    memcached_server_add_udp (memcached_st *ptr,
                          const char *hostname,
                          unsigned int port);

  memcached_return
    memcached_server_add_unix_socket (memcached_st *ptr,
                                      const char *socket);

  memcached_return
    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 *error);

DESCRIPTION ^

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 memcached_st structures. To manipulate lists of servers see memcached_server_st(3).

memcached_server_count() provides you a count of the current number of servers being used by a memcached_st structure.

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 TCP server into the memcached_st structure. This server will be placed at the end. Duplicate servers are allowed, so duplication is not checked. Executing this function with the MEMCACHED_BEHAVIOR_USE_UDP behavior set will result in a MEMCACHED_INVALID_HOST_PROTOCOL.

memcached_server_add_udp() pushes a single UDP server into the memcached_st 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 MEMCACHED_BEHAVIOR_USE_UDP behavior will result in a MEMCACHED_INVALID_HOST_PROTOCOL.

memcached_server_add_unix_socket() pushes a single UNIX socket into the memcached_st 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.

memcached_server_push() pushes an array of memcached_server_st into the memcached_st 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.

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().

RETURN ^

Varies, see particular functions.

HOME ^

To find out more information please check: http://tangent.org/552/libmemcached.html

AUTHOR ^

Brian Aker, <brian@tangent.org>

SEE ALSO ^

memcached(1) libmemcached(3) memcached_strerror(3)

syntax highlighting: