1 Managing lists of servers
2 =========================
7 #include <libmemcached/memcached.h>
8 Compile and link with -lmemcached
10 .. c:type:: struct memcached_instance_st memcached_instance_st
12 .. c:type:: struct memcached_server_list_st memcached_server_list_st
14 .. c:type:: struct memcached_server_st memcached_server_st
16 .. function:: const memcached_instance_st * memcached_server_list (memcached_st *ptr)
18 .. function:: void memcached_server_list_free (memcached_server_list_st list)
20 .. 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)
22 .. function:: uint32_t memcached_server_list_count (memcached_server_list_st list)
24 .. function:: const char *memcached_server_error (const memcached_instance_st * instance)
26 .. function:: void memcached_server_error_reset (const memcached_instance_st * list)
30 .. function:: void memcached_servers_parse ()
37 libmemcached(3) operates on a list of hosts which are stored in
38 :type:`memcached_server_st` structures. You should not modify these structures
39 directly. Functions are provided to modify these structures (and more can be
42 :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.
44 :func:`memcached_server_list_free` deallocates all memory associated with the array of :type:`memcached_server_st` that you passed to it.
46 :func:`memcached_server_list_append` adds a server to the end of a
47 :type:`memcached_server_st` array. On error null will be returned and the
48 :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.
51 DEPRECATED :func:`memcached_servers_parse`, please see :func:`memcached`
53 :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.
55 Before version 0.39 theses functions used a memcached_server_st \*. In 0.39
56 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 Varies, see particular functions.
68 :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`