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

   1 Managing lists of servers
   2 =========================
   3
   4 SYNOPSIS
   5 --------
   6
   7 #include <libmemcached/memcached.h>
   8   Compile and link with -lmemcached
   9
  10 .. c:type:: struct memcached_instance_st memcached_instance_st
  11
  12 .. c:type:: struct memcached_server_st memcached_server_st
  13
  14 .. c:type:: struct memcached_server_st *memcached_server_list_st
  15
  16 .. function:: const memcached_instance_st * memcached_server_list (memcached_st *ptr)
  17
  18     :param ptr: pointer to initialized `memcached_st` struct
  19     :returns: list of `memcached_instance_st` objects
  20
  21 .. function:: void memcached_server_list_free (memcached_server_list_st list)
  22
  23     :param list:
  24
  25 .. 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)
  26
  27 .. function:: uint32_t memcached_server_list_count (memcached_server_list_st list)
  28
  29 .. function:: const char *memcached_server_error (const memcached_instance_st * instance)
  30
  31 .. function:: void memcached_server_error_reset (const memcached_instance_st * list)
  32
  33     .. deprecated:: 0.39
  34
  35 .. function:: void memcached_servers_parse ()
  36
  37     .. deprecated:: 0.39
  38
  39 DESCRIPTION
  40 -----------
  41
  42 libmemcached(3) operates on a list of hosts which are stored in
  43 :type:`memcached_server_st` structures. You should not modify these structures
  44 directly. Functions are provided to modify these structures.
  45
  46 :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.
  47
  48 :func:`memcached_server_list_free` deallocates all memory associated with the array of :type:`memcached_server_st` that you passed to it.
  49
  50 :func:`memcached_server_list_append` adds a server to the end of a
  51 :type:`memcached_server_st` array. On error null will be returned and the
  52 :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
  53 port of a memcached server.
  54
  55 DEPRECATED :func:`memcached_servers_parse`, please see :func:`memcached`
  56
  57 :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.
  58
  59 Before version 0.39 theses functions used a memcached_server_st \*. In 0.39
  60 memcached_server_st \* was aliased to :type:`memcached_server_list_st`. This was done for a style reason to help clean up some concepts in the code.
  61
  62 RETURN VALUE
  63 ------------
  64
  65 Varies, see particular functions.
  66
  67 SEE ALSO
  68 --------
  69
  70 .. only:: man
  71
  72   :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`