← Back to branch summary

~kent/libmemcached/KBDocs4

« back to all changes in this revision

Viewing changes to docs/memcached_server_st.rst

  • Committer: Brian Aker
  • Date: 2011-04-14 04:51:43 UTC
  • mfrom: (929.1.80 libmemcached-build)
  • Revision ID: brian@tangent.org-20110414045143-2q2txh8q4ht5s8ve
Merge in updates (including removal of some depcrated bits from the examples).

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/memcached_server_st.rst
3
3
=========================
4
4
 
5
5
 
6
 
Manage server list
7
 
 
8
 
 
9
 
*******
10
 
LIBRARY
11
 
*******
12
 
 
13
 
 
14
 
C Client Library for memcached (libmemcached, -lmemcached)
15
 
 
16
6
 
17
7
--------
18
8
SYNOPSIS
20
10
 
21
11
 
22
12
 
23
 
.. code-block:: perl
24
 
 
25
 
   #include <libmemcached/memcached.h>
26
 
 
27
 
   const memcached_server_instance_st
28
 
     memcached_server_list (memcached_st *ptr);
29
 
 
30
 
   void memcached_server_list_free (memcached_server_list_st list);
31
 
 
32
 
   memcached_server_list_st
33
 
     memcached_server_list_append (memcached_server_list_st list, 
34
 
                                   const char *hostname,
35
 
                                   unsigned int port, 
36
 
                                   memcached_return_t *error);
37
 
 
38
 
   uint32_t memcached_server_list_count (memcached_server_list_st list);
39
 
 
40
 
   memcached_server_list_st memcached_servers_parse (const char *server_strings);
41
 
 
42
 
   const char *memcached_server_error (memcached_server_instance_st instance);
43
 
 
44
 
   DEPRECATED
45
 
   void memcached_server_error_reset (memcached_server_instance_st list);
46
 
 
 
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
47
29
 
48
30
 
49
31
-----------
68
50
appropriate error. If the value of port is zero, it is set to the default
69
51
port of a memcached server.
70
52
 
71
 
memcached_servers_parse() takes a string, the type that is used for the
72
 
command line applications, and parse it to an array of memcached_server_st.
73
 
The example is "localhost, foo:555, foo, bar". All hosts except foo:555 will
74
 
be set to the default port, while that host will have a port of 555.
 
53
DEPRECATED memcached_servers_parse(), please see :manpage:`memcached(3)`
75
54
 
76
55
memcached_server_error() can be used to look at the text of the last error 
77
56
message sent by the server to to the client.
81
60
done for a style reason/to help clean up some concepts in the code.
82
61
 
83
62
 
84
 
******
 
63
------
85
64
RETURN
86
 
******
 
65
------
87
66
 
88
67
 
89
68
Varies, see particular functions.
90
69
 
91
70
 
92
 
****
 
71
----
93
72
HOME
94
 
****
 
73
----
95
74
 
96
75
 
97
76
To find out more information please check:
98
 
`https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
99
 
 
100
 
 
101
 
******
102
 
AUTHOR
103
 
******
104
 
 
105
 
 
106
 
Brian Aker, <brian@tangent.org>
 
77
`http://libmemcached.org/ <http://libmemcached.org/>`_
 
78
 
107
79
 
108
80
 
109
81
--------