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

   1 =========================
   2 Managing lists of servers
   3 =========================
   4
   5
   6 --------
   7 SYNOPSIS
   8 --------
   9
  10
  11
  12 #include <libmemcached/memcached.h>
  13
  14 .. c:type:: const memcached_instance_st *
  15
  16 .. c:type:: memcached_server_list_st
  17
  18 .. c:type:: memcached_server_st
  19
  20 .. c:function:: const const memcached_instance_st * memcached_server_list (memcached_st *ptr)
  21
  22 .. c:function:: void memcached_server_list_free (memcached_server_list_st list)
  23
  24 .. c:function:: memcached_server_list_st memcached_server_list_append (memcached_server_list_st list, const char *hostname, in_port_t port, memcached_return_t *error)
  25
  26 .. c:function:: uint32_t memcached_server_list_count (memcached_server_list_st list)
  27
  28 .. c:function:: const char *memcached_server_error (const memcached_instance_st * instance)
  29
  30 .. c:function:: void memcached_server_error_reset (const memcached_instance_st * list)
  31 .. deprecated:: 0.39
  32
  33 .. c:function:: void memcached_servers_parse ()
  34 .. deprecated:: 0.39
  35
  36 Compile and link with -lmemcached
  37
  38
  39 -----------
  40 DESCRIPTION
  41 -----------
  42
  43
  44 libmemcached(3) operates on a list of hosts which are stored in
  45 :c:type:`memcached_server_st` structures. You should not modify these structures
  46 directly. Functions are provided to modify these structures (and more can be
  47 added, just ask!).
  48
  49 :c:func:`memcached_server_list` is used to provide an array of all defined hosts. This was incorrectly documented as "requiring free" up till version 0.39.
  50
  51 :c:func:`memcached_server_list_free` deallocates all memory associated with the array of :c:type:`memcached_server_st` that you passed to it.
  52
  53 :c:func:`memcached_server_list_append` adds a server to the end of a
  54 :c:type:`memcached_server_st` array. On error null will be returned and the
  55 :c:type:`memcached_return_t` pointer you passed into the function will be set with the appropriate error. If the value of port is zero, it is set to the default
  56 port of a memcached server.
  57
  58 DEPRECATED :c:func:`memcached_servers_parse`, please see :c:func:`memcached`
  59
  60 :c:func:`memcached_server_error` can be used to look at the text of the last error message sent by the server to to the client.
  61
  62 Before version 0.39 theses functions used a memcache_server_st \*. In 0.39
  63 memcached_server_st \* was aliased to :c:type:`memcached_server_list_st`. This was done for a style reason to help clean up some concepts in the code.
  64
  65
  66 ------
  67 RETURN
  68 ------
  69
  70
  71 Varies, see particular functions.
  72
  73
  74 ----
  75 HOME
  76 ----
  77
  78
  79 To find out more information please check:
  80 `http://libmemcached.org/ <http://libmemcached.org/>`_
  81
  82
  83
  84 --------
  85 SEE ALSO
  86 --------
  87
  88
  89 :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`