4 memcached_server_list_free, memcached_server_list_append, memcached_server_list_count, memcached_servers_parse
5 **************************************************************************************************************
16 C Client Library for memcached (libmemcached, -lmemcached)
27 #include <memcached.h>
29 const memcached_server_instance_st
30 memcached_server_list (memcached_st *ptr);
32 void memcached_server_list_free (memcached_server_list_st list);
34 memcached_server_list_st
35 memcached_server_list_append (memcached_server_list_st list,
38 memcached_return_t *error);
40 uint32_t memcached_server_list_count (memcached_server_list_st list);
42 memcached_server_list_st memcached_servers_parse (const char *server_strings);
44 const char *memcached_server_error (memcached_server_instance_st instance);
47 void memcached_server_error_reset (memcached_server_instance_st list);
56 libmemcached(3) operates on a list of hosts which are stored in
57 memcached_server_st structures. You should not modify these structures
58 directly. Functions are provided to modify these structures (and more can be
61 memcached_server_list() is used to provide an array of all defined hosts.
62 This was incorrectly documented as "requiring free()" up till version 0.39.
64 memcached_server_list_free() deallocates all memory associated with the array
65 of memcached_server_st that you passed to it.
67 memcached_server_list_append() adds a server to the end of a
68 memcached_server_st array. On error null will be returned and the
69 memcached_return_t pointer you passed into the function will be set with the
70 appropriate error. If the value of port is zero, it is set to the default
71 port of a memcached server.
73 memcached_servers_parse() takes a string, the type that is used for the
74 command line applications, and parse it to an array of memcached_server_st.
75 The example is "localhost, foo:555, foo, bar". All hosts except foo:555 will
76 be set to the default port, while that host will have a port of 555.
78 memcached_server_error() can be used to look at the text of the last error
79 message sent by the server to to the client.
81 Before version 0.39 theses functions used a memcache_server_st \*. In 0.39
82 memcached_server_st \* was aliased to memcached_server_list_st. This was
83 done for a style reason/to help clean up some concepts in the code.
91 Varies, see particular functions.
99 To find out more information please check:
100 `https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
108 Brian Aker, <brian@tangent.org>
116 memcached(1) libmemcached(3) memcached_strerror(3)