.TH "MEMCACHED_POOL_ST" "3" "June 17, 2011" "0.49" "libmemcached"
.SH NAME
memcached_pool_st \- libmemcached Documentation
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.\" Man page generated from reStructeredText.
.
.SH SYNOPSIS
.sp
#include <libmemcached/memcached_pool.h>
.INDENT 0.0
.TP
.B memcached_pool_st *memcached_pool(const char *option_string, size_t option_string_length);
.UNINDENT
.INDENT 0.0
.TP
.B memcached_pool_st * memcached_pool_create(memcached_st* mmc, int initial, int max); DEPRECATED
.UNINDENT
.INDENT 0.0
.TP
.B memcached_st * memcached_pool_destroy(memcached_pool_st* pool);
.UNINDENT
.INDENT 0.0
.TP
.B memcached_st * memcached_pool_pop (memcached_pool_st* pool, bool block, memcached_return_t *rc);
.UNINDENT
.INDENT 0.0
.TP
.B memcached_return_t memcached_pool_push(memcached_pool_st* pool, memcached_st *mmc);
.UNINDENT
.INDENT 0.0
.TP
.B memcached_st *memcached_create (memcached_st *ptr);
.UNINDENT
.INDENT 0.0
.TP
.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)
.UNINDENT
.INDENT 0.0
.TP
.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)
.UNINDENT
.sp
Compile and link with \-lmemcachedutil \-lmemcached
.SH DESCRIPTION
.sp
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
\fBmemcached_st\fPobjects. Please see \fIlibmemcached_configuration\fP for details on the format of the configuration string.
.sp
DEPRECATED memcached_pool_create() is used to create a connection pool of
objects you may use to remove the overhead of using memcached_clone for
short lived \fBmemcached_st\fPobjects. The mmc argument should be an
initialised \fBmemcached_st\fPstructure, and a successfull invocation of
memcached_pool_create takes full ownership of the variable (until it is
released by memcached_pool_destroy).  The \fBinitial\fP argument specifies
the initial size of the connection pool, and the \fBmax\fPargument
specifies the maximum size the connection pool should grow to. Please note
that the library will allocate a fixed size buffer scaled to the max size of
the connection pool, so you should not pass MAXINT or some other large
number here.
.sp
memcached_pool_destroy() is used to destroy the connection pool
created with memcached_pool_create() and release all allocated
resources. It will return the pointer to the \fBmemcached_st\fP structure
passed as an argument to memcached_pool_create(), and returns the ownership
of the pointer to the caller when created with memcached_pool_create,
otherwise NULL is returned..
.sp
memcached_pool_pop() is used to grab a connection structure from the
connection pool. The block argument specifies if the function should
block and wait for a connection structure to be available if we try
to exceed the maximum size.
.sp
memcached_pool_push() is used to return a connection structure back to the pool.
.sp
memcached_pool_behavior_set() and memcached_pool_behagior_get() is
used to get/set behavior flags on all connections in the pool.
.SH RETURN
.sp
memcached_pool_create() returns a pointer to the newly created
memcached_pool_st structure. On an allocation failure, it returns
NULL.
.sp
memcached_pool_destroy() returns the pointer (and ownership) to the
memcached_st structure used to create the pool. If connections are in
use it returns NULL.
.sp
memcached_pool_pop() returns a pointer to a memcached_st structure
from the pool (or NULL if an allocation cannot be satisfied).
.sp
memcached_pool_push() returns MEMCACHED_SUCCESS upon success.
.sp
memcached_pool_behavior_get() and memcached_pool_behavior_get()
returns MEMCACHED_SUCCESS upon success.
.SH HOME
.sp
To find out more information please check:
\fI\%http://libmemcached.org/\fP
.SH AUTHOR
.sp
Brian Aker, <\fI\%brian@tangent.org\fP>
.sp
Trond Norbye, <\fI\%trond.norbye@gmail.com\fP>
.SH SEE ALSO
.sp
\fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP
.SH AUTHOR
Brian Aker
.SH COPYRIGHT
2011, Brian Aker DataDifferential, http://datadifferential.com/
.\" Generated by docutils manpage writer.
.\" 
.