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

   1 =========================
   2 Managing lists of servers
   3 =========================
   4
   5
   6 .. index:: object: memcached_server_instance_st
   7
   8 --------
   9 SYNOPSIS
  10 --------
  11
  12
  13
  14 #include <libmemcached/memcached.h>
  15
  16 .. c:function:: const memcached_server_instance_st memcached_server_list (memcached_st *ptr);
  17
  18 .. c:function:: void memcached_server_list_free (memcached_server_list_st list);
  19
  20 .. c:function:: memcached_server_list_st memcached_server_list_append (memcached_server_list_st list, const char *hostname, unsigned int port, memcached_return_t *error);
  21
  22 .. c:function:: uint32_t memcached_server_list_count (memcached_server_list_st list);
  23
  24 .. c:function:: const char *memcached_server_error (memcached_server_instance_st instance);
  25
  26 .. c:function:: void memcached_server_error_reset (memcached_server_instance_st list); DEPRECATED
  27
  28
  29 Compile and link with -lmemcached
  30
  31
  32 -----------
  33 DESCRIPTION
  34 -----------
  35
  36
  37 libmemcached(3) operates on a list of hosts which are stored in
  38 :c:type:`memcached_server_st` structures. You should not modify these structures
  39 directly. Functions are provided to modify these structures (and more can be
  40 added, just ask!).
  41
  42 :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.
  43
  44 :c:func:`memcached_server_list_free()` deallocates all memory associated with the array of :c:type:`memcached_server_st` that you passed to it.
  45
  46 :c:func:`memcached_server_list_append()` adds a server to the end of a
  47 :c:type:`memcached_server_st` array. On error null will be returned and the
  48 :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
  49 port of a memcached server.
  50
  51 DEPRECATED :c:func:`memcached_servers_parse()`, please see :manpage:`memcached(3)`
  52
  53 :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.
  54
  55 Before version 0.39 theses functions used a memcache_server_st \*. In 0.39
  56 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.
  57
  58
  59 ------
  60 RETURN
  61 ------
  62
  63
  64 Varies, see particular functions.
  65
  66
  67 ----
  68 HOME
  69 ----
  70
  71
  72 To find out more information please check:
  73 `http://libmemcached.org/ <http://libmemcached.org/>`_
  74
  75
  76
  77 --------
  78 SEE ALSO
  79 --------
  80
  81
  82 :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`