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 memcached_server_st *memcached_server_list(memcached_st *ptr);
  15 memcached_return memcached_server_add(memcached_st *ptr, char *hostname, unsigned int port);
  16 memcached_return memcached_server_push(memcached_st *ptr, memcached_server_st *list);
  17
  18 =head1 DESCRIPTION
  19
  20
  21 libmemcached(3) performs operations on a list of hosts. The order of these
  22 hosts determine routing to keys. Functions are provided to add keys to
  23 memcached_st structures. To manipulate lists of servers see server_st(3).
  24
  25 memcached_server_count() provides you a count of the current number of
  26 servers being used by a memcached_st structure.
  27
  28 memcached_server_list() is used to provide an array of all connected hosts.
  29 You are responsible for freeing this list (aka it is not a pointer to the
  30 currently used structure).
  31
  32 memcached_server_add() pushes a single server into the memcached_st
  33 structure. This server will be placed at the end. Duplicate servers are
  34 allowed, so duplication is not checked.
  35
  36 memcached_server_push() pushes an array of memcached_server_st into the memcached_st
  37 structure. These servers will be placed at the end. Duplicate servers are
  38 allowed, so duplication is not checked. A copy is made of structure so the
  39 list provided (and any operations on the list) are not saved.
  40
  41 =head1 RETURN
  42
  43 Varies, see particular functions.
  44
  45 =head1 HOME
  46
  47 To find out more information please check: http://tangent.org/552/libmemcached.html
  48
  49 =head1 AUTHOR
  50
  51 Brian Aker, brian@tangent.org
  52
  53 =head1 SEE ALSO
  54
  55 memcached(1) libmemcached(3) memcached_strerror(3)
  56
  57 =cut
  58