memcached_servers_parse(3)

1memcached_servers_parse.pop(3m)emcached_servers_parmseemcached_servers_parse.pop(3)
2
3
4

NAME

6       memcached_server_list_free, memcached_server_list_append,
7       memcached_server_list_count, memcached_servers_parse - Manage server
8       list
9

LIBRARY

11       C Client Library for memcached (libmemcached, -lmemcached)
12

SYNOPSIS

14         #include <memcached.h>
15
16         const memcached_server_instance_st
17           memcached_server_list (memcached_st *ptr);
18
19         void memcached_server_list_free (memcached_server_list_st list);
20
21         memcached_server_list_st
22           memcached_server_list_append (memcached_server_list_st list,
23                                         const char *hostname,
24                                         unsigned int port,
25                                         memcached_return_t *error);
26
27         uint32_t memcached_server_list_count (memcached_server_list_st list);
28
29         memcached_server_list_st memcached_servers_parse (const char *server_strings);
30
31         const char *memcached_server_error (memcached_server_instance_st instance);
32
33         DEPRECATED
34         void memcached_server_error_reset (memcached_server_instance_st list);
35

DESCRIPTION

37       libmemcached(3) operates on a list of hosts which are stored in
38       memcached_server_st structures. You should not modify these structures
39       directly. Functions are provided to modify these structures (and more
40       can be added, just ask!).
41
42       memcached_server_list() is used to provide an array of all defined
43       hosts.  This was incorrectly documented as "requiring free()" up till
44       version 0.39.
45
46       memcached_server_list_free() deallocates all memory associated with the
47       array of memcached_server_st that you passed to it.
48
49       memcached_server_list_append() adds a server to the end of a
50       memcached_server_st array. On error null will be returned and the
51       memcached_return_t pointer you passed into the function will be set
52       with the appropriate error. If the value of port is zero, it is set to
53       the default port of a memcached server.
54
55       memcached_servers_parse() takes a string, the type that is used for the
56       command line applications, and parse it to an array of
57       memcached_server_st.  The example is "localhost, foo:555, foo, bar".
58       All hosts except foo:555 will be set to the default port, while that
59       host will have a port of 555.
60
61       memcached_server_error() can be used to look at the text of the last
62       error message sent by the server to to the client.
63
64       Before version 0.39 theses functions used a memcache_server_st *. In
65       0.39 memcached_server_st * was aliased to memcached_server_list_st.
66       This was done for a style reason/to help clean up some concepts in the
67       code.
68

RETURN

70       Varies, see particular functions.
71

HOME

73       To find out more information please check:
74       <https://launchpad.net/libmemcached>
75

AUTHOR

77       Brian Aker, <brian@tangent.org>
78