Style cleanup
[m6w6/libmemcached] / docs / memcached_pool.rst
1 ============================
2 Working with memcached pools
3 ============================
4
5 --------
6 SYNOPSIS
7 --------
8
9 #include <libmemcached/memcached_pool.h>
10
11 .. c:type:: memcached_pool_st
12
13 .. c:function:: memcached_pool_st* memcached_pool(const char *option_string, size_t option_string_length)
14
15 .. c:function:: memcached_pool_st* memcached_pool_create(memcached_st* mmc, int initial, int max)
16 .. deprecated:: 0.46
17 Use :c:func:`memcached_pool()` instead.
18
19 .. c:function:: memcached_st* memcached_pool_destroy(memcached_pool_st* pool)
20
21 .. c:function:: memcached_st* memcached_pool_pop (memcached_pool_st* pool, bool block, memcached_return_t *rc)
22
23 .. c:function:: memcached_return_t memcached_pool_push(memcached_pool_st* pool, memcached_st *mmc)
24
25 .. c:function:: memcached_return_t memcached_pool_behavior_set(memcached_pool_st *pool, memcached_behavior_t flag, uint64_t data)
26
27 .. c:function:: memcached_return_t memcached_pool_behavior_get(memcached_pool_st *pool, memcached_behavior_t flag, uint64_t *value)
28
29 Compile and link with -lmemcachedutil -lmemcached
30
31
32 -----------
33 DESCRIPTION
34 -----------
35
36
37 :c:func:`memcached_pool()` is used to create a connection pool of objects you
38 may use to remove the overhead of using memcached_clone for short lived
39 :c:type:`memcached_st` objects. Please see :doc:`libmemcached_configuration` for details on the format of the configuration string.
40
41 :c:func:`memcached_pool_destroy()` is used to destroy the connection pool
42 created with :c:func:`memcached_pool_create()` and release all allocated
43 resources. It will return the pointer to the :c:type:`memcached_st` structure
44 passed as an argument to :c:func:`memcached_pool_create()`, and returns the ownership of the pointer to the caller when created with :c:func:`memcached_pool_create()`, otherwise NULL is returned..
45
46 :c:func:`memcached_pool_pop()` is used to grab a connection structure from the
47 connection pool. The block argument specifies if the function should
48 block and wait for a connection structure to be available if we try
49 to exceed the maximum size.
50
51 :c:func:`memcached_pool_push()` is used to return a connection structure back to the pool.
52
53 :c:func:`memcached_pool_behavior_get()` and :c:func:`memcached_pool_behavior_set()` is used to get/set behavior flags on all connections in the pool.
54
55
56 ------
57 RETURN
58 ------
59
60 :c:func:`memcached_pool_destroy()` returns the pointer (and ownership) to the :c:type:`memcached_st` structure used to create the pool. If connections are in use it returns NULL.
61
62 :c:func:`memcached_pool_pop()` returns a pointer to a :c:type:`memcached_st` structure from the pool (or NULL if an allocation cannot be satisfied).
63
64 :c:func:`memcached_pool_push()` returns :c:type:`MEMCACHED_SUCCESS` upon success.
65
66 :c:func:`memcached_pool_behavior_get()` and :c:func:`memcached_pool_behavior_get()` returns :c:type:`MEMCACHED_SUCCESS` upon success.
67
68
69 ----
70 HOME
71 ----
72
73
74 To find out more information please check:
75 `http://libmemcached.org/ <http://libmemcached.org/>`_
76
77
78 ------
79 AUTHOR
80 ------
81
82
83 Brian Aker, <brian@tangent.org>
84
85 Trond Norbye, <trond.norbye@gmail.com>
86
87
88 --------
89 SEE ALSO
90 --------
91
92 :manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` :manpage:`libmemcached_configuration(3)`