Updates for documentation style/etc.
[m6w6/libmemcached] / docs / libmemcachedutil.rst
1 ================
2 libmemcachedutil
3 ================
4
5
6 Utility library for libmemcached
7
8
9 =======
10 LIBRARY
11 =======
12
13
14 C Client Library containing utility functions for libmemcached (libmemcachedutil, -lmemcachedutil)
15
16
17 ========
18 SYNOPSIS
19 ========
20
21
22 .. code-block:: perl
23
24 cc [ flag ... ] file ... -lmemcachedutil
25
26 #include <libmemcached/memcached_util.h>
27
28
29
30 ===========
31 DESCRIPTION
32 ===========
33
34
35 \ **libmemcachedutil**\ is a small and thread-safe client library that provides
36 extra functionality built on top of \ **libmemcached**\ .
37
38
39 =======
40 THREADS
41 =======
42
43
44 Do not try to access an instance of \ ``memcached_st``\ from multiple threads
45 at the same time. If you want to access memcached from multiple threads
46 you should either clone the \ ``memcached_st``\ , or use the memcached pool
47 implementation. see memcached_pool_create(3).
48
49
50 ====
51 HOME
52 ====
53
54
55 To find out more information please check:
56 `https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
57
58
59 ========
60 SEE ALSO
61 ========
62
63
64 :manpage:`libmemcached(3)`
65 :manpage:`memcached_pool_create(3)` :manpage:`memcached_pool_destroy(3)` :manpage:`memcached_pool_pop(3)` :manpage:`memcached_pool_push(3)`
66