Updating for 1.0.2 release
[awesomized/libmemcached] / libmemcached-1.0 / sasl.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 #pragma once
39
40 #if defined(LIBMEMCACHED_WITH_SASL_SUPPORT) && LIBMEMCACHED_WITH_SASL_SUPPORT
41 #include <sasl/sasl.h>
42 #else
43 #define sasl_callback_t void
44 #endif
45
46 #ifdef __cplusplus
47 extern "C" {
48 #endif
49
50 LIBMEMCACHED_API
51 void memcached_set_sasl_callbacks(memcached_st *ptr,
52 const sasl_callback_t *callbacks);
53
54 LIBMEMCACHED_API
55 memcached_return_t memcached_set_sasl_auth_data(memcached_st *ptr,
56 const char *username,
57 const char *password);
58
59 LIBMEMCACHED_API
60 memcached_return_t memcached_destroy_sasl_auth_data(memcached_st *ptr);
61
62
63 LIBMEMCACHED_API
64 sasl_callback_t *memcached_get_sasl_callbacks(memcached_st *ptr);
65
66 LIBMEMCACHED_LOCAL
67 memcached_return_t memcached_clone_sasl(memcached_st *clone, const memcached_st *source);
68
69 LIBMEMCACHED_LOCAL
70 memcached_return_t memcached_sasl_authenticate_connection(memcached_server_st *server);
71
72 #ifdef __cplusplus
73 }
74 #endif
75
76 struct memcached_sasl_st {
77 sasl_callback_t *callbacks;
78 /*
79 ** Did we allocate data inside the callbacks, or did the user
80 ** supply that.
81 */
82 bool is_allocated;
83 };