docs: semver
[m6w6/libmemcached] / docs / source / libmemcachedutil / index.rst
1 libmemcachedutil - C/C++ utilities extending libmemcached
2 =========================================================
3
4 Utility library for libmemcached
5
6 SYNOPSIS
7 --------
8
9 #include <libmemcachedutil-|libmemcachedutil_version|/util.h>
10 Compile and link with -lmemcachedutil -lmemcached
11
12 DESCRIPTION
13 -----------
14
15 `libmemcachedutil` is a small and thread-safe client library that provides extra
16 functionality built on top of `libmemcached`.
17
18 THREADS AND PROCESSES
19 ---------------------
20
21 Do not try to access an instance of `memcached_st` from multiple threads at the
22 same time. If you want to access memcached from multiple threads you should
23 either clone the `memcached_st`, or use the memcached pool implementation. See
24 `memcached_pool`.
25
26 .. toctree::
27 :titlesonly:
28 :caption: Additional Utilities
29
30 memcached_pool
31
32 SEE ALSO
33 --------
34
35 .. only:: man
36
37 :manpage:`libmemcached(3)`
38 :manpage:`memcached_pool(3)`
39 :manpage:`memcached_pool_destroy(3)`
40 :manpage:`memcached_pool_pop(3)`
41 :manpage:`memcached_pool_push(3)`
42
43 .. only:: html
44
45 * :doc:`../libmemcached`
46