Merge lp:~tangent-org/libmemcached/1.0-build/ Build: jenkins-Libmemcached-187
[m6w6/libmemcached] / libmemcached-1.0 / server.h
1 /* vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
2 *
3 * Libmemcached library
4 *
5 * Copyright (C) 2011 Data Differential, http://datadifferential.com/
6 * Copyright (C) 2006-2009 Brian Aker All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions are
10 * met:
11 *
12 * * Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 *
15 * * Redistributions in binary form must reproduce the above
16 * copyright notice, this list of conditions and the following disclaimer
17 * in the documentation and/or other materials provided with the
18 * distribution.
19 *
20 * * The names of its contributors may not be used to endorse or
21 * promote products derived from this software without specific prior
22 * written permission.
23 *
24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
25 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
26 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
27 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
28 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
29 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
30 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
31 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
32 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
33 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
34 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35 *
36 */
37
38
39 #pragma once
40
41 #include <libmemcached-1.0/struct/server.h>
42
43 #ifdef __cplusplus
44 extern "C" {
45 #endif
46
47 LIBMEMCACHED_API
48 memcached_return_t memcached_server_cursor(const memcached_st *ptr,
49 const memcached_server_fn *callback,
50 void *context,
51 uint32_t number_of_callbacks);
52
53 LIBMEMCACHED_API
54 memcached_server_instance_st memcached_server_by_key(memcached_st *ptr,
55 const char *key,
56 size_t key_length,
57 memcached_return_t *error);
58
59 LIBMEMCACHED_API
60 void memcached_server_error_reset(memcached_server_st *ptr);
61
62 LIBMEMCACHED_API
63 void memcached_server_free(memcached_server_st *ptr);
64
65 LIBMEMCACHED_API
66 memcached_server_instance_st memcached_server_get_last_disconnect(const memcached_st *ptr);
67
68
69 LIBMEMCACHED_API
70 memcached_return_t memcached_server_add_udp(memcached_st *ptr,
71 const char *hostname,
72 in_port_t port);
73 LIBMEMCACHED_API
74 memcached_return_t memcached_server_add_unix_socket(memcached_st *ptr,
75 const char *filename);
76 LIBMEMCACHED_API
77 memcached_return_t memcached_server_add(memcached_st *ptr,
78 const char *hostname, in_port_t port);
79
80 LIBMEMCACHED_API
81 memcached_return_t memcached_server_add_udp_with_weight(memcached_st *ptr,
82 const char *hostname,
83 in_port_t port,
84 uint32_t weight);
85 LIBMEMCACHED_API
86 memcached_return_t memcached_server_add_unix_socket_with_weight(memcached_st *ptr,
87 const char *filename,
88 uint32_t weight);
89 LIBMEMCACHED_API
90 memcached_return_t memcached_server_add_with_weight(memcached_st *ptr, const char *hostname,
91 in_port_t port,
92 uint32_t weight);
93
94 /**
95 Operations on Single Servers.
96 */
97 LIBMEMCACHED_API
98 uint32_t memcached_server_response_count(const memcached_server_instance_st self);
99
100 LIBMEMCACHED_API
101 const char *memcached_server_name(const memcached_server_instance_st self);
102
103 LIBMEMCACHED_API
104 in_port_t memcached_server_port(const memcached_server_instance_st self);
105
106 LIBMEMCACHED_API
107 void memcached_instance_next_retry(memcached_server_instance_st self, const time_t absolute_time);
108
109 LIBMEMCACHED_API
110 const char *memcached_server_type(const memcached_server_instance_st ptr);
111
112 LIBMEMCACHED_API
113 uint8_t memcached_server_major_version(const memcached_server_instance_st ptr);
114
115 LIBMEMCACHED_API
116 uint8_t memcached_server_minor_version(const memcached_server_instance_st ptr);
117
118 LIBMEMCACHED_API
119 uint8_t memcached_server_micro_version(const memcached_server_instance_st ptr);
120
121 #ifdef __cplusplus
122 } // extern "C"
123 #endif