X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fsource%2Flibmemcachedutil.rst;h=f17cd86ba49c2f4019cfa4b189c99f0c14e5eb5b;hb=c07857b93826e18934ec530edf3191aaaac150dc;hp=29cc7dbfe078319eaf00f0aa2f0faa2df8e44035;hpb=ffaad0afbece28d246557bdff64b47103ea8f179;p=awesomized%2Flibmemcached diff --git a/docs/source/libmemcachedutil.rst b/docs/source/libmemcachedutil.rst index 29cc7dbf..f17cd86b 100644 --- a/docs/source/libmemcachedutil.rst +++ b/docs/source/libmemcachedutil.rst @@ -1,56 +1,41 @@ -============================ -Introducing libmemcachedutil -============================ +libmemcachedutil - C/C++ utilities extending libmemcached +========================================================= Utility library for libmemcached - --------- SYNOPSIS -------- -.. code-block:: c - - cc [ flag ... ] file ... -lmemcachedutil - - #include - +#include + Compile and link with -lmemcachedutil -lmemcached - ------------ DESCRIPTION ----------- +`libmemcachedutil` is a small and thread-safe client library that provides extra +functionality built on top of `libmemcached`. -:program:`libmemcachedutil` is a small and thread-safe client library that -provides extra functionality built on top of :program:`libmemcached`. - - -------- -THREADS -------- +THREADS AND PROCESSES +--------------------- +Do not try to access an instance of `memcached_st` from multiple threads at the +same time. If you want to access memcached from multiple threads you should +either clone the `memcached_st`, or use the memcached pool implementation. See +`memcached_pool`. -Do not try to access an instance of :c:type:`memcached_st` from multiple threads -at the same time. If you want to access memcached from multiple threads -you should either clone the :c:type:`memcached_st`, or use the memcached pool -implementation. see :c:func:`memcached_pool_create`. - - ----- -HOME ----- - - -To find out more information please check: -`http://libmemcached.org/ `_ - - --------- SEE ALSO -------- +.. only:: man + + :manpage:`libmemcached(3)` + :manpage:`memcached_pool(3)` + :manpage:`memcached_pool_destroy(3)` + :manpage:`memcached_pool_pop(3)` + :manpage:`memcached_pool_push(3)` -:manpage:`libmemcached(3)` :manpage:`memcached_pool_create(3)` :manpage:`memcached_pool_destroy(3)` :manpage:`memcached_pool_pop(3)` :manpage:`memcached_pool_push(3)` +.. only:: html + * :doc:`../libmemcached` + * :doc:`libmemcachedutil/memcached_pool`