X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fmemcached_sasl.rst;h=4dc4039c4f0aec375e754116b7cab5b8a1a36d1f;hb=a6c3e3a3d04f379b1480c8c88a8eae17e54b1449;hp=30aa72ca7ed2f72e48d6f87fa90816dda5b5efb8;hpb=e668c212d13197abf5d8e2ddc7916057c94325b6;p=m6w6%2Flibmemcached diff --git a/docs/memcached_sasl.rst b/docs/memcached_sasl.rst index 30aa72ca..4dc4039c 100644 --- a/docs/memcached_sasl.rst +++ b/docs/memcached_sasl.rst @@ -2,34 +2,24 @@ SASL support ============ - -------- -LIBRARY -------- - - -C Client Library for memcached (libmemcached, -lmemcached) +.. index:: object: memcached_st -------- SYNOPSIS -------- +#include + +.. c:function:: void memcached_set_sasl_callbacks(memcached_st *ptr, const sasl_callback_t *callbacks) + +.. c:function:: const sasl_callback_t *memcached_get_sasl_callbacks(memcached_st *ptr) +.. c:function:: memcached_return memcached_set_sasl_auth_data(memcached_st *ptr, const char *username, const char *password) -.. code-block:: perl +.. c:function:: memcached_return memcached_destroy_sasl_auth_data(memcached_st *ptr) - #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) +Compile and link with -lmemcached @@ -44,7 +34,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. -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