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 - Manage server list
   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                                   const char *hostname,
  19                                   unsigned int port,
  20                                   memcached_return_t *error);
  21
  22   unsigned int memcached_server_list_count (memcached_server_st *ptr);
  23
  24   memcached_server_st *memcached_servers_parse (const char *server_strings);
  25
  26   const char *memcached_server_error (memcached_server_st *ptr);
  27
  28   void memcached_server_error_reset (memcached_server_st *ptr);
  29
  30 =head1 DESCRIPTION
  31
  32 libmemcached(3) operates on a list of hosts which are stored in
  33 memcached_server_st structures. You should not modify these structures
  34 directly. Functions are provided to modify these structures (and more can be
  35 added, just ask!).
  36
  37 memcached_server_list_free() deallocates all memory associated with the array
  38 of memcached_server_st that you passed to it.
  39
  40 memcached_server_list_append() adds a server to the end of a
  41 memcached_server_st array. On error null will be returned and the
  42 memcached_return_t pointer you passed into the function will be set with the
  43 appropriate error. If the value of port is zero, it is set to the default
  44 port of a memcached server.
  45
  46 memcached_servers_parse() takes a string, the type that is used for the
  47 command line applications, and parse it to an array of memcached_server_st.
  48 The example is "localhost, foo:555, foo, bar". All hosts except foo:555 will
  49 be set to the default port, while that host will have a port of 555.
  50
  51 memcached_server_error() can be used to look at the text of the last error
  52 message sent by the server to to the client. Use memcached_server_error_reset()
  53 to reset the message (this does not currently free up the memory associated
  54 with the message).
  55
  56
  57 =head1 RETURN
  58
  59 Varies, see particular functions.
  60
  61 =head1 HOME
  62
  63 To find out more information please check:
  64 L<https://launchpad.net/libmemcached>
  65
  66 =head1 AUTHOR
  67
  68 Brian Aker, E<lt>brian@tangent.orgE<gt>
  69
  70 =head1 SEE ALSO
  71
  72 memcached(1) libmemcached(3) memcached_strerror(3)
  73
  74 =cut
  75