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