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

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