git.m6w6.name Git - awesomized/libmemcached/blob - docs/memcached_servers.pod

   1 =head1 NAME
   2
   3 memcached_server_count, memcached_server_list, memcached_server_add, memcached_server_push
   4
   5 =head1 LIBRARY
   6
   7 C Client Library for memcached (libmemcached, -lmemcached)
   8
   9 =head1 SYNOPSIS
  10
  11   #include <memcached.h>
  12
  13   unsigned int memcached_server_count (memcached_st *ptr);
  14
  15   memcached_server_st *
  16     memcached_server_list (memcached_st *ptr);
  17
  18   memcached_return
  19     memcached_server_add (memcached_st *ptr,
  20                           const char *hostname,
  21                           unsigned int port);
  22
  23   memcached_return
  24     memcached_server_add_unix_socket (memcached_st *ptr,
  25                                       const char *socket);
  26
  27   memcached_return
  28     memcached_server_push (memcached_st *ptr,
  29                            memcached_server_st *list);
  30
  31   memcached_server_st *
  32     memcached_server_by_key (memcached_st *ptr,
  33                              const char *key, size_t key_length,
  34                              memcached_return *error);
  35
  36 =head1 DESCRIPTION
  37
  38 libmemcached(3) performs operations on a list of hosts. The order of these
  39 hosts determine routing to keys. Functions are provided to add keys to
  40 memcached_st structures. To manipulate lists of servers see
  41 memcached_server_st(3).
  42
  43 memcached_server_count() provides you a count of the current number of
  44 servers being used by a C<memcached_st> structure.
  45
  46 memcached_server_list() is used to provide an array of all defined hosts.
  47 You are responsible for freeing this list (aka it is not a pointer to the
  48 currently used structure).
  49
  50 memcached_server_add() pushes a single server into the C<memcached_st>
  51 structure. This server will be placed at the end. Duplicate servers are
  52 allowed, so duplication is not checked.
  53
  54 memcached_server_add_unix_socket() pushes a single UNIX socket into the
  55 C<memcached_st> structure. This UNIX socket will be placed at the end.
  56 Duplicate servers are allowed, so duplication is not checked. The length
  57 of the filename must be one character less then MEMCACHED_MAX_HOST_LENGTH.
  58
  59 memcached_server_push() pushes an array of C<memcached_server_st> into
  60 the C<memcached_st> structure. These servers will be placed at the
  61 end. Duplicate servers are allowed, so duplication is not checked. A
  62 copy is made of structure so the list provided (and any operations on
  63 the list) are not saved.
  64
  65 memcached_server_by_key() allows you to provide a key and retrieve the
  66 server which would be used for assignment. This structure is cloned
  67 from its original structure and must be freed. If NULL is returned you
  68 should consult *error. The returning structure should be freed with
  69 memcached_server_free().
  70
  71 =head1 RETURN
  72
  73 Varies, see particular functions.
  74
  75 =head1 HOME
  76
  77 To find out more information please check:
  78 L<http://tangent.org/552/libmemcached.html>
  79
  80 =head1 AUTHOR
  81
  82 Brian Aker, E<lt>brian@tangent.orgE<gt>
  83
  84 =head1 SEE ALSO
  85
  86 memcached(1) libmemcached(3) memcached_strerror(3)
  87
  88 =cut
  89