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

   1 =head1 NAME
   2
   3 memcached_server_list_free, memcached_server_list_append,
   4 memcached_server_list_count, memcached_servers_parse
   5
   6 =head1 LIBRARY
   7
   8 C Client Library for memcached (libmemcached, -lmemcached)
   9
  10 =head1 SYNOPSIS
  11
  12   #include <memcached.h>
  13
  14   void memcached_server_list_free (memcached_server_st *ptr);
  15
  16   memcached_server_st *
  17     memcached_server_list_append (memcached_server_st *ptr,
  18                                   char *hostname,
  19                                   unsigned int port,
  20                                   memcached_return *error);
  21
  22   unsigned int memcached_server_list_count (memcached_server_st *ptr);
  23
  24   memcached_server_st *memcached_servers_parse (char *server_strings);
  25
  26 =head1 DESCRIPTION
  27
  28 libmemcached(3) operates on a list of hosts which are stored in
  29 memcached_server_st structures. You should not modify these structures
  30 directly. Functions are provided to modify these structures (and more can be
  31 added, just ask!).
  32
  33 memcached_server_list_free() deallocates all memory associated with the array
  34 of memcached_server_st that you passed to it.
  35
  36 memcached_server_list_append() adds a server to the end of a
  37 memcached_server_st array. On error null will be returned and the
  38 memcached_return pointer you passed into the function will be set with the
  39 appropriate error. If the value of port is zero, it is set to the default
  40 port of a memcached server.
  41
  42 memcached_servers_parse() takes a string, the type that is used for the
  43 command line applications, and parse it to an array of memcached_server_st.
  44 The example is "localhost, foo:555, foo, bar". All hosts except foo:555 will
  45 be set to the default port, while that host will have a port of 555.
  46
  47 =head1 RETURN
  48
  49 Varies, see particular functions.
  50
  51 =head1 HOME
  52
  53 To find out more information please check:
  54 L<http://tangent.org/552/libmemcached.html>
  55
  56 =head1 AUTHOR
  57
  58 Brian Aker, E<lt>brian@tangent.orgE<gt>
  59
  60 =head1 SEE ALSO
  61
  62 memcached(1) libmemcached(3) memcached_strerror(3)
  63
  64 =cut
  65