X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fmemcached_sasl.rst;h=bd51348bff8d3df3e0f6a612e07f37c4af50bb68;hb=ca4acb0672e11e89af59ce588ea9c441c20b4e7a;hp=74a4e919e6da65395e2987de9420490af35c7ca6;hpb=281c398ba3a10af677494c4453cd09d85ca921e0;p=m6w6%2Flibmemcached diff --git a/docs/memcached_sasl.rst b/docs/memcached_sasl.rst index 74a4e919..bd51348b 100644 --- a/docs/memcached_sasl.rst +++ b/docs/memcached_sasl.rst @@ -1,40 +1,25 @@ -.. highlight:: perl +============ +SASL support +============ - -memcached_set_sasl_callbacks, memcached_get_sasl_callbacks, memcached_sasl_set_auth_data, memcached_destroy_sasl_auth_data -------------------------------------------------------------------------------------------------------------------------** - - -SASL tests - - -******* -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) -.. code-block:: perl +.. c:function:: memcached_return memcached_set_sasl_auth_data(memcached_st *ptr, const char *username, const char *password) - #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) +.. c:function:: memcached_return memcached_destroy_sasl_auth_data(memcached_st *ptr) + +Compile and link with -lmemcached @@ -49,41 +34,42 @@ 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. +You as a client user have to initialize libsasl by using :c:type:`sasl_client_init` before enabling it in libmemcached, and you have to shut down libsasl by +calling :c:func:`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_get_sasl_set_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,