X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fman%2Fmemcached_sasl_set_auth_data.3;h=6b36bee6eb149f8e14b2493d51f228ab1853159a;hb=9f3c2098e91293e4d69b1d691fbf352e440309ff;hp=024eb07a55fb5bd4d931823255f95dfc2534db19;hpb=a6c3e3a3d04f379b1480c8c88a8eae17e54b1449;p=m6w6%2Flibmemcached diff --git a/docs/man/memcached_sasl_set_auth_data.3 b/docs/man/memcached_sasl_set_auth_data.3 index 024eb07a..c5997fbd 100644 --- a/docs/man/memcached_sasl_set_auth_data.3 +++ b/docs/man/memcached_sasl_set_auth_data.3 @@ -1,4 +1,4 @@ -.TH "MEMCACHED_SASL_SET_AUTH_DATA" "3" "May 23, 2011" "0.47" "libmemcached" +.TH "MEMCACHED_SASL_SET_AUTH_DATA" "3" "April 08, 2012" "1.0.6" "libmemcached" .SH NAME memcached_sasl_set_auth_data \- libmemcached Documentation . @@ -43,11 +43,11 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .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) +.B memcached_return_t 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) +.B memcached_return_t memcached_destroy_sasl_auth_data(memcached_st\fI\ *ptr\fP) .UNINDENT .sp Compile and link with \-lmemcached @@ -59,21 +59,18 @@ 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 defining +\fI\%memcached_set_sasl_auth_data()\fP 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 -a memory leak. You should NOT call memcached_destroy_sasl_auth_data if you -specify your own callback function with memcached_set_sasl_callbacks(). -.sp -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. +\fI\%memcached_destroy_sasl_auth_data\fP before calling +\fBmemcached_free\fP to avoid a memory leak. You should NOT call +\fI\%memcached_destroy_sasl_auth_data\fP if you specify your own callback +function with \fI\%memcached_set_sasl_callbacks()\fP. .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. +\fI\%memcached_get_sasl_callbacks()\fP returns the callbacks currently used by +this memcached handle. \fI\%memcached_set_sasl_auth_data()\fP returns +\fBMEMCACHED_SUCCESS\fP upon success. .SH HOME .sp To find out more information please check: