X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fmemcached_sasl.rst;h=2a2e5699088047cc160a55d103600a363033c83b;hb=fc72bfb155d6938e6d4b7b0e24a6256d88c2a7c3;hp=155d64df3edbb6b2a6ca452931c33b30a3318a85;hpb=bf12e933c3c73aa04d8de2221144cc73cc9ef3b8;p=m6w6%2Flibmemcached diff --git a/docs/memcached_sasl.rst b/docs/memcached_sasl.rst index 155d64df..2a2e5699 100644 --- a/docs/memcached_sasl.rst +++ b/docs/memcached_sasl.rst @@ -1,46 +1,31 @@ -.. highlight:: perl - - -memcached_set_sasl_callbacks, memcached_get_sasl_callbacks, memcached_sasl_set_auth_data, memcached_destroy_sasl_auth_data -************************************************************************************************************************** - - +============ SASL support +============ - -******* -LIBRARY -******* +.. index:: object: memcached_st -C Client Library for memcached (libmemcached, -lmemcached) +-------- +SYNOPSIS +-------- +#include -******** -SYNOPSIS -******** +.. 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_t memcached_set_sasl_auth_data(memcached_st *ptr, const char *username, const char *password) -.. code-block:: perl +.. c:function:: memcached_return_t 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 -*********** +----------- DESCRIPTION -*********** +----------- libmemcached(3) allows you to plug in your own callbacks function used by @@ -49,48 +34,47 @@ 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 +: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(). +: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`. -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. - -****** +------ 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. -**** +---- HOME -**** +---- To find out more information please check: `http://libmemcached.org/ `_ -****** +------ AUTHOR -****** +------ + +Brian Aker, Trond Norbye, -******** +-------- SEE ALSO -******** +-------- :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`