X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fmemcached_sasl.rst;h=2a2e5699088047cc160a55d103600a363033c83b;hb=a7df49566dd006c5725eabcd11aab958cf8e5600;hp=4dc4039c4f0aec375e754116b7cab5b8a1a36d1f;hpb=da3714e6dc31ab2f9d115707ab79a838420c7b5a;p=m6w6%2Flibmemcached diff --git a/docs/memcached_sasl.rst b/docs/memcached_sasl.rst index 4dc4039c..2a2e5699 100644 --- a/docs/memcached_sasl.rst +++ b/docs/memcached_sasl.rst @@ -15,9 +15,9 @@ SYNOPSIS .. 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) +.. c:function:: memcached_return_t memcached_set_sasl_auth_data(memcached_st *ptr, const char *username, const char *password) -.. c:function:: memcached_return memcached_destroy_sasl_auth_data(memcached_st *ptr) +.. c:function:: memcached_return_t memcached_destroy_sasl_auth_data(memcached_st *ptr) Compile and link with -lmemcached @@ -34,16 +34,13 @@ 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 defining +:c:func:`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 -a memory leak. You should NOT call memcached_destroy_sasl_auth_data if you -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. +:c:type:`memcached_destroy_sasl_auth_data` before calling +:c:type:`memcached_free` to avoid a memory leak. You should NOT call +:c:type:`memcached_destroy_sasl_auth_data` if you specify your own callback +function with :c:func:`memcached_set_sasl_callbacks`. ------ @@ -51,9 +48,9 @@ RETURN ------ -memcached_get_sasl_callbacks() returns the callbacks currently used -by this memcached handle. -memcached_get_sasl_set_auth_data() returns MEMCACHED_SUCCESS upon success. +:c:func:`memcached_get_sasl_callbacks` returns the callbacks currently used by +this memcached handle. :c:func:`memcached_set_sasl_auth_data` returns +:c:type:`MEMCACHED_SUCCESS` upon success. ----