X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fman%2Fmemcached_get_sasl_callbacks.3;h=047908f318697aad1f3572f6aaf998e636267e20;hb=5a9c49c1e9f1950045eb845277c370324ac9ef16;hp=d82176d8cadafa893439d42535f10e52e82e5c99;hpb=281c398ba3a10af677494c4453cd09d85ca921e0;p=awesomized%2Flibmemcached diff --git a/docs/man/memcached_get_sasl_callbacks.3 b/docs/man/memcached_get_sasl_callbacks.3 index d82176d8..047908f3 100644 --- a/docs/man/memcached_get_sasl_callbacks.3 +++ b/docs/man/memcached_get_sasl_callbacks.3 @@ -1,4 +1,4 @@ -.TH "MEMCACHED_GET_SASL_CALLBACKS" "3" "April 08, 2011" "0.47" "libmemcached" +.TH "MEMCACHED_GET_SASL_CALLBACKS" "3" "June 17, 2011" "0.49" "libmemcached" .SH NAME memcached_get_sasl_callbacks \- libmemcached Documentation . @@ -30,30 +30,27 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .. .\" Man page generated from reStructeredText. . -.sp -memcached_set_sasl_callbacks, memcached_get_sasl_callbacks, memcached_sasl_set_auth_data, memcached_destroy_sasl_auth_data -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-** -.sp -SASL tests -.sp -C Client Library for memcached (libmemcached, \-lmemcached) .SH SYNOPSIS .sp -.nf -.ft C -#include - -void memcached_set_sasl_callbacks(memcached_st *ptr, - const sasl_callback_t *callbacks) - -const sasl_callback_t *memcached_get_sasl_callbacks(memcached_st *ptr) - -memcached_return memcached_set_sasl_auth_data(memcached_st *ptr, - const char *username, - const char *password) -memcached_return memcached_destroy_sasl_auth_data(memcached_st *ptr) -.ft P -.fi +#include +.INDENT 0.0 +.TP +.B void memcached_set_sasl_callbacks(memcached_st\fI\ *ptr\fP, const sasl_callback_t\fI\ *callbacks\fP) +.UNINDENT +.INDENT 0.0 +.TP +.B const sasl_callback_t *memcached_get_sasl_callbacks(memcached_st\fI\ *ptr\fP) +.UNINDENT +.INDENT 0.0 +.TP +.B memcached_return memcached_set_sasl_auth_data(memcached_st\fI\ *ptr\fP, const char\fI\ *username\fP, const char\fI\ *password\fP) +.UNINDENT +.INDENT 0.0 +.TP +.B memcached_return memcached_destroy_sasl_auth_data(memcached_st\fI\ *ptr\fP) +.UNINDENT +.sp +Compile and link with \-lmemcached .SH DESCRIPTION .sp libmemcached(3) allows you to plug in your own callbacks function used by @@ -62,7 +59,7 @@ libsasl to perform SASL authentication. Please note that SASL requires the memcached binary protocol, and you have to specify the callbacks before you connect to the server. .sp -memcached_set_sasl_auth_data() is a helper function for you defining +memcached_set_sasl_auth_data() is a helper function defining the basic functionality for you, but it will store the username and password in memory. If you choose to use this method you have to call memcached_destroy_sasl_auth_data before calling memcached_free to avoid @@ -72,13 +69,18 @@ specify your own callback function with memcached_set_sasl_callbacks(). You as a client user have to initialize libsasl by using sasl_client_init before enabling it in libmemcached, and you have to shut down libsasl by calling sasl_done() when you are done using SASL from libmemcached. +.SH RETURN .sp memcached_get_sasl_callbacks() returns the callbacks currently used by this memcached handle. memcached_get_sasl_set_auth_data() returns MEMCACHED_SUCCESS upon success. +.SH HOME .sp To find out more information please check: \fI\%http://libmemcached.org/\fP +.SH AUTHOR +.sp +Brian Aker, <\fI\%brian@tangent.org\fP> .sp Trond Norbye, <\fI\%trond.norbye@gmail.com\fP> .SH SEE ALSO @@ -87,7 +89,7 @@ Trond Norbye, <\fI\%trond.norbye@gmail.com\fP> .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" .