X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fsource%2Flibmemcachedutil%2Findex.rst;h=0d8f65c81271360fb073655103d8a3edf240f815;hb=4f6e4eaafdeb09115d7c8ff15dc897a7b8a05ae6;hp=e16691ecd97cff43fdc82a25ec7ab49602db3d49;hpb=28c4d79e109e11d7d2a9f3189de57da28302ec68;p=awesomized%2Flibmemcached diff --git a/docs/source/libmemcachedutil/index.rst b/docs/source/libmemcachedutil/index.rst index e16691ec..0d8f65c8 100644 --- a/docs/source/libmemcachedutil/index.rst +++ b/docs/source/libmemcachedutil/index.rst @@ -1,8 +1,46 @@ -libmemcachedutil API -==================== +libmemcachedutil - C/C++ utilities extending libmemcached +========================================================= + +Utility library for libmemcached + +SYNOPSIS +-------- + +#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`. + +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`. .. toctree:: :titlesonly: :caption: Additional Utilities memcached_pool + +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)` + +.. only:: html + + * :doc:`../libmemcached` +