1 .TH "MEMCACHED_SASL" "3" "April 07, 2011" "0.47" "libmemcached"
3 memcached_sasl \- libmemcached Documentation
5 .nr rst2man-indent-level 0
9 level \\n[rst2man-indent-level]
10 level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
17 .\" .rstReportMargin pre:
19 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
20 . nr rst2man-indent-level +1
21 .\" .rstReportMargin post:
25 .\" indent \\n[an-margin]
26 .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
27 .nr rst2man-indent-level -1
28 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
29 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
31 .\" Man page generated from reStructeredText.
37 C Client Library for memcached (libmemcached, \-lmemcached)
42 #include <libmemcached/memcached.h>
44 void memcached_set_sasl_callbacks(memcached_st *ptr,
45 const sasl_callback_t *callbacks)
47 const sasl_callback_t *memcached_get_sasl_callbacks(memcached_st *ptr)
49 memcached_return memcached_set_sasl_auth_data(memcached_st *ptr,
52 memcached_return memcached_destroy_sasl_auth_data(memcached_st *ptr)
57 libmemcached(3) allows you to plug in your own callbacks function used by
58 libsasl to perform SASL authentication.
60 Please note that SASL requires the memcached binary protocol, and you have
61 to specify the callbacks before you connect to the server.
63 memcached_set_sasl_auth_data() is a helper function for you defining
64 the basic functionality for you, but it will store the username and password
65 in memory. If you choose to use this method you have to call
66 memcached_destroy_sasl_auth_data before calling memcached_free to avoid
67 a memory leak. You should NOT call memcached_destroy_sasl_auth_data if you
68 specify your own callback function with memcached_set_sasl_callbacks().
70 You as a client user have to initialize libsasl by using sasl_client_init
71 before enabling it in libmemcached, and you have to shut down libsasl by
72 calling sasl_done() when you are done using SASL from libmemcached.
75 memcached_get_sasl_callbacks() returns the callbacks currently used
76 by this memcached handle.
77 memcached_get_sasl_set_auth_data() returns MEMCACHED_SUCCESS upon success.
80 To find out more information please check:
81 \fI\%http://libmemcached.org/\fP
84 Trond Norbye, <\fI\%trond.norbye@gmail.com\fP>
87 memcached(1) libmemcached(3)
92 .\" Generated by docutils manpage writer.