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

   1 .. highlight:: perl
   2
   3
   4 ****
   5 NAME
   6 ****
   7
   8
   9 memcached_server_list_free, memcached_server_list_append,
  10 memcached_server_list_count, memcached_servers_parse - Manage server list
  11
  12
  13 *******
  14 LIBRARY
  15 *******
  16
  17
  18 C Client Library for memcached (libmemcached, -lmemcached)
  19
  20
  21 ********
  22 SYNOPSIS
  23 ********
  24
  25
  26
  27 .. code-block:: perl
  28
  29    #include <memcached.h>
  30
  31    const memcached_server_instance_st
  32      memcached_server_list (memcached_st *ptr);
  33
  34    void memcached_server_list_free (memcached_server_list_st list);
  35
  36    memcached_server_list_st
  37      memcached_server_list_append (memcached_server_list_st list,
  38                                    const char *hostname,
  39                                    unsigned int port,
  40                                    memcached_return_t *error);
  41
  42    uint32_t memcached_server_list_count (memcached_server_list_st list);
  43
  44    memcached_server_list_st memcached_servers_parse (const char *server_strings);
  45
  46    const char *memcached_server_error (memcached_server_instance_st instance);
  47
  48    DEPRECATED
  49    void memcached_server_error_reset (memcached_server_instance_st list);
  50
  51
  52
  53 ***********
  54 DESCRIPTION
  55 ***********
  56
  57
  58 libmemcached(3) operates on a list of hosts which are stored in
  59 memcached_server_st structures. You should not modify these structures
  60 directly. Functions are provided to modify these structures (and more can be
  61 added, just ask!).
  62
  63 memcached_server_list() is used to provide an array of all defined hosts.
  64 This was incorrectly documented as "requiring free()" up till version 0.39.
  65
  66 memcached_server_list_free() deallocates all memory associated with the array
  67 of memcached_server_st that you passed to it.
  68
  69 memcached_server_list_append() adds a server to the end of a
  70 memcached_server_st array. On error null will be returned and the
  71 memcached_return_t pointer you passed into the function will be set with the
  72 appropriate error. If the value of port is zero, it is set to the default
  73 port of a memcached server.
  74
  75 memcached_servers_parse() takes a string, the type that is used for the
  76 command line applications, and parse it to an array of memcached_server_st.
  77 The example is "localhost, foo:555, foo, bar". All hosts except foo:555 will
  78 be set to the default port, while that host will have a port of 555.
  79
  80 memcached_server_error() can be used to look at the text of the last error
  81 message sent by the server to to the client.
  82
  83 Before version 0.39 theses functions used a memcache_server_st \*. In 0.39
  84 memcached_server_st \* was aliased to memcached_server_list_st. This was
  85 done for a style reason/to help clean up some concepts in the code.
  86
  87
  88 ******
  89 RETURN
  90 ******
  91
  92
  93 Varies, see particular functions.
  94
  95
  96 ****
  97 HOME
  98 ****
  99
 100
 101 To find out more information please check:
 102 `https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
 103
 104
 105 ******
 106 AUTHOR
 107 ******
 108
 109
 110 Brian Aker, <brian@tangent.org>
 111
 112
 113 ********
 114 SEE ALSO
 115 ********
 116
 117
 118 memcached(1) libmemcached(3) memcached_strerror(3)
 119