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                           char *hostname,
  21                           unsigned int port);
  22
  23   memcached_return
  24     memcached_server_add_unix_socket (memcached_st *ptr,
  25                                       char *socket);
  26
  27   memcached_return
  28     memcached_server_push (memcached_st *ptr,
  29                            memcached_server_st *list);
  30
  31 =head1 DESCRIPTION
  32
  33 libmemcached(3) performs operations on a list of hosts. The order of these
  34 hosts determine routing to keys. Functions are provided to add keys to
  35 memcached_st structures. To manipulate lists of servers see
  36 memcached_server_st(3).
  37
  38 memcached_server_count() provides you a count of the current number of
  39 servers being used by a C<memcached_st> structure.
  40
  41 memcached_server_list() is used to provide an array of all defined hosts.
  42 You are responsible for freeing this list (aka it is not a pointer to the
  43 currently used structure).
  44
  45 memcached_server_add() pushes a single server into the C<memcached_st>
  46 structure. This server will be placed at the end. Duplicate servers are
  47 allowed, so duplication is not checked.
  48
  49 memcached_server_add_unix_socket() pushes a single UNIX socket into the
  50 C<memcached_st> structure. This UNIX socket will be placed at the end.
  51 Duplicate servers are allowed, so duplication is not checked. The length
  52 of the filename must be one character less then MEMCACHED_MAX_HOST_LENGTH.
  53
  54 memcached_server_push() pushes an array of C<memcached_server_st> into
  55 the C<memcached_st> structure. These servers will be placed at the
  56 end. Duplicate servers are allowed, so duplication is not checked. A
  57 copy is made of structure so the list provided (and any operations on
  58 the list) are not saved.
  59
  60 =head1 RETURN
  61
  62 Varies, see particular functions.
  63
  64 =head1 HOME
  65
  66 To find out more information please check:
  67 L<http://tangent.org/552/libmemcached.html>
  68
  69 =head1 AUTHOR
  70
  71 Brian Aker, E<lt>brian@tangent.orgE<gt>
  72
  73 =head1 SEE ALSO
  74
  75 memcached(1) libmemcached(3) memcached_strerror(3)
  76
  77 =cut
  78