-.. highlight:: perl
+============================
+Working with memcached pools
+============================
-
-****
-NAME
-****
-
-
-memcached_pool_create, memcached_pool_destroy, memcached_pool_push, memcached_pool_pop - Manage pools
-
-
-*******
-LIBRARY
-*******
-
-
-C Client Library for memcached (libmemcachedutil, -lmemcachedutil)
-
-
-********
+--------
SYNOPSIS
-********
-
+--------
+#include <libmemcached/memcached_pool.h>
-.. code-block:: perl
+.. c:function:: memcached_pool_st *memcached_pool(const char *option_string, size_t option_string_length);
- #include <libmemcached/memcached_pool.h>
+.. c:function:: memcached_pool_st * memcached_pool_create(memcached_st* mmc, int initial, int max); DEPRECATED
- memcached_pool_st *
- memcached_pool_create(memcached_st* mmc, int initial, int max);
+.. c:function:: memcached_st * memcached_pool_destroy(memcached_pool_st* pool);
- 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);
- memcached_st *
- memcached_pool_pop (memcached_pool_st* pool, bool block, memcached_return_t *rc);
+.. c:function:: memcached_return_t memcached_pool_push(memcached_pool_st* pool, memcached_st *mmc);
- memcached_return_t
- memcached_pool_push(memcached_pool_st* pool, memcached_st *mmc);
+.. c:function:: memcached_st *memcached_create (memcached_st *ptr);
- memcached_st *memcached_create (memcached_st *ptr);
+.. c:function:: memcached_return_t memcached_pool_behavior_set(memcached_pool_st *pool, memcached_behavior_t flag, uint64_t data)
- memcached_return_t
- memcached_pool_behavior_set(memcached_pool_st *pool,
- memcached_behavior_t flag,
- uint64_t data)
-
- memcached_return_t
- memcached_pool_behavior_get(memcached_pool_st *pool,
- memcached_behavior_t flag,
- uint64_t *value)
+.. 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
-***********
+-----------
+
+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
+\ ``memcached_st``\ objects. Please see :manpage:`libmemcached_configuration` for details on the format of the configuration string.
-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 \ ``memcached_st``\ objects. The mmc argument should be an
-initialised \ ``memcached_st``\ structure, and a successfull invocation of
-memcached_pool_create takes full ownership of the variable (until it
-is released by memcached_pool_destroy). The \ ``initial``\ argument
-specifies the initial size of the connection pool, and the \ ``max``\
-argument 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.
+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 \ ``memcached_st``\ objects. The mmc argument should be an
+initialised \ ``memcached_st``\ structure, and a successfull invocation of
+memcached_pool_create takes full ownership of the variable (until it is
+released by memcached_pool_destroy). The \ ``initial``\ argument specifies
+the initial size of the connection pool, and the \ ``max``\ argument
+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.
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 \ ``memcached_st``\ structure
-passed as an argument to memcached_pool_create(), and returns the
-ownership of the pointer to the caller.
+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..
memcached_pool_pop() is used to grab a connection structure from the
connection pool. The block argument specifies if the function should
used to get/set behavior flags on all connections in the pool.
-******
+------
RETURN
-******
+------
memcached_pool_create() returns a pointer to the newly created
returns MEMCACHED_SUCCESS upon success.
-****
+----
HOME
-****
+----
To find out more information please check:
`https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
-******
+------
AUTHOR
-******
+------
+Brian Aker, <brian@tangent.org>
+
Trond Norbye, <trond.norbye@gmail.com>
-********
+--------
SEE ALSO
-********
-
-
-memcached(1) libmemcached(3) memcached_create(3) memcached_free(3) libmemcachedutil(3) memcached_behavior_get(3) memcached_behavior_set(3)
+--------
+:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
projects / awesomized / libmemcached / blobdiff