1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
|
============================
Working with memcached pools
============================
--------
SYNOPSIS
--------
#include <libmemcached/memcached_pool.h>
.. c:type:: memcached_pool_st
.. c:function:: memcached_pool_st* memcached_pool(const char *option_string, size_t option_string_length)
.. c:function:: memcached_pool_st* memcached_pool_create(memcached_st* mmc, int initial, int max)
.. deprecated:: 0.46
Use :c:func:`memcached_pool`
.. c:function:: memcached_st* memcached_pool_destroy(memcached_pool_st* pool)
.. c:function:: memcached_st* memcached_pool_pop(memcached_pool_st* pool, bool block, memcached_return_t *rc)
.. deprecated:: 0.53
Use :c:func:`memcached_pool_fetch`
.. c:function:: memcached_st* memcached_pool_fetch(memcached_pool_st*, struct timespec* relative_time, memcached_return_t* rc)
.. versionadded:: 0.53
Synonym for memcached_pool_pop
.. c:function:: memcached_return_t memcached_pool_push(memcached_pool_st* pool, memcached_st *mmc)
.. deprecated:: 0.53
Use :c:func:`memcached_pool_push`
.. c:function:: memcached_return_t memcached_pool_release(memcached_pool_st* pool, memcached_st* mmc)
.. versionadded:: 0.53
Synonym for memcached_pool_push.
.. c:function:: memcached_return_t memcached_pool_behavior_set(memcached_pool_st *pool, memcached_behavior_t flag, uint64_t data)
.. c:function:: memcached_return_t memcached_pool_behavior_get(memcached_pool_st *pool, memcached_behavior_t flag, uint64_t *value)
Compile and link with -lmemcachedutil -lmemcached
-----------
DESCRIPTION
-----------
:c:func:`memcached_pool` is used to create a connection pool of objects you
may use to remove the overhead of using memcached_clone for short lived
:c:type:`memcached_st` objects. Please see :doc:`libmemcached_configuration` for details on the format of the configuration string.
:c:func:`memcached_pool_destroy` is used to destroy the connection pool
created with :c:func:`memcached_pool_create` and release all allocated
resources. It will return the pointer to the :c:type:`memcached_st` structure
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..
:c:func:`memcached_pool_fetch` is used to fetch a connection structure from the
connection pool. The relative_time argument specifies if the function should
block and wait for a connection structure to be available if we try
to exceed the maximum size. You need to specify time in relative time.
:c:func:`memcached_pool_release` is used to return a connection structure back to the pool.
: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.
Both :c:func:`memcached_pool_release` and :c:func:`memcached_pool_fetch` are thread safe.
------
RETURN
------
: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.
: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).
:c:func:`memcached_pool_release` returns :c:type:`MEMCACHED_SUCCESS` upon success.
:c:func:`memcached_pool_behavior_get` and :c:func:`memcached_pool_behavior_get` returns :c:type:`MEMCACHED_SUCCESS` upon success.
If any methods returns MEMCACHED_IN_PROGRESS then a lock on the pool could not be obtained. If any of the parameters passed to any of these functions is invalid, MEMCACHED_INVALID_ARGUMENTS will be returned.
memcached_pool_fetch may return MEMCACHED_TIMEOUT if a timeout occurs while waiting for a free memcached_st. MEMCACHED_NOTFOUND if no memcached_st was available.
----
HOME
----
To find out more information please check:
`http://libmemcached.org/ <http://libmemcached.org/>`_
------
AUTHOR
------
Brian Aker, <brian@tangent.org>
Trond Norbye, <trond.norbye@gmail.com>
--------
SEE ALSO
--------
:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` :manpage:`libmemcached_configuration(3)`
|
