1
.TH "MEMCACHED_POOL" "3" "April 09, 2011" "0.47" "libmemcached"
3
memcached_pool \- libmemcached Documentation
5
.nr rst2man-indent-level 0
9
level \\n[rst2man-indent-level]
10
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
17
.\" .rstReportMargin pre:
19
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
20
. nr rst2man-indent-level +1
21
.\" .rstReportMargin post:
25
.\" indent \\n[an-margin]
26
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
27
.nr rst2man-indent-level -1
28
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
29
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
31
.\" Man page generated from reStructeredText.
35
#include <libmemcached/memcached_pool.h>
38
.B memcached_pool_st * memcached_pool_create(memcached_st* mmc, int initial, int max);
42
.B memcached_st * memcached_pool_destroy(memcached_pool_st* pool);
46
.B memcached_st * memcached_pool_pop (memcached_pool_st* pool, bool block, memcached_return_t *rc);
50
.B memcached_return_t memcached_pool_push(memcached_pool_st* pool, memcached_st *mmc);
54
.B memcached_st *memcached_create (memcached_st *ptr);
58
.B memcached_return_t memcached_pool_behavior_set(memcached_pool_st\fI\ *pool\fP, memcached_behavior_t\fI\ flag\fP, uint64_t\fI\ data\fP)
62
.B memcached_return_t memcached_pool_behavior_get(memcached_pool_st\fI\ *pool\fP, memcached_behavior_t\fI\ flag\fP, uint64_t\fI\ *value\fP)
65
Compile and link with \-lmemcachedutil \-lmemcached
68
memcached_pool_create() is used to create a connection pool of objects you
69
may use to remove the overhead of using memcached_clone for short
70
lived \fBmemcached_st\fP objects. The mmc argument should be an
71
initialised \fBmemcached_st\fP structure, and a successfull invocation of
72
memcached_pool_create takes full ownership of the variable (until it
73
is released by memcached_pool_destroy). The \fBinitial\fP argument
74
specifies the initial size of the connection pool, and the \fBmax\fPargument specifies the maximum size the connection pool should grow
75
to. Please note that the library will allocate a fixed size buffer
76
scaled to the max size of the connection pool, so you should not pass
77
MAXINT or some other large number here.
79
memcached_pool_destroy() is used to destroy the connection pool
80
created with memcached_pool_create() and release all allocated
81
resources. It will return the pointer to the \fBmemcached_st\fP structure
82
passed as an argument to memcached_pool_create(), and returns the
83
ownership of the pointer to the caller.
85
memcached_pool_pop() is used to grab a connection structure from the
86
connection pool. The block argument specifies if the function should
87
block and wait for a connection structure to be available if we try
88
to exceed the maximum size.
90
memcached_pool_push() is used to return a connection structure back to the pool.
92
memcached_pool_behavior_set() and memcached_pool_behagior_get() is
93
used to get/set behavior flags on all connections in the pool.
96
memcached_pool_create() returns a pointer to the newly created
97
memcached_pool_st structure. On an allocation failure, it returns
100
memcached_pool_destroy() returns the pointer (and ownership) to the
101
memcached_st structure used to create the pool. If connections are in
104
memcached_pool_pop() returns a pointer to a memcached_st structure
105
from the pool (or NULL if an allocation cannot be satisfied).
107
memcached_pool_push() returns MEMCACHED_SUCCESS upon success.
109
memcached_pool_behavior_get() and memcached_pool_behavior_get()
110
returns MEMCACHED_SUCCESS upon success.
113
To find out more information please check:
114
\fI\%https://launchpad.net/libmemcached\fP
117
Brian Aker, <\fI\%brian@tangent.org\fP>
119
Trond Norbye, <\fI\%trond.norbye@gmail.com\fP>
122
\fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP
126
2011, Brian Aker DataDifferential, http://datadifferential.com/
127
.\" Generated by docutils manpage writer.
added
removed
docs/man/memcached_pool.3
