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

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