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