SYNOPSIS
--------
-#include <libmemcached/memcached_pool.h>
+#include <libmemcachedutil-|libmemcached_version|/pool.h>
Compile and link with -lmemcachedutil -lmemcached
.. type:: struct memcached_pool_st memcached_pool_st
.. function:: memcached_st* memcached_pool_destroy(memcached_pool_st* pool)
.. 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
+
+ .. versionadded:: 0.53
+ Synonym for memcached_pool_pop
.. function:: memcached_return_t memcached_pool_release(memcached_pool_st* pool, memcached_st* mmc)
-.. versionadded:: 0.53
- Synonym for memcached_pool_push.
+
+ .. versionadded:: 0.53
+ Synonym for memcached_pool_push.
.. function:: memcached_return_t memcached_pool_behavior_set(memcached_pool_st *pool, memcached_behavior_t flag, uint64_t data)
.. function:: memcached_return_t memcached_pool_behavior_get(memcached_pool_st *pool, memcached_behavior_t flag, uint64_t *value)
.. function:: memcached_pool_st* memcached_pool_create(memcached_st* mmc, int initial, int max)
-.. deprecated:: 0.46
- Use :func:`memcached_pool`
+
+ .. deprecated:: 0.46
+ Use `memcached_pool`
.. function:: memcached_st* memcached_pool_pop(memcached_pool_st* pool, bool block, memcached_return_t *rc)
-.. deprecated:: 0.53
- Use :func:`memcached_pool_fetch`
+
+ .. deprecated:: 0.53
+ Use `memcached_pool_fetch`
.. function:: memcached_return_t memcached_pool_push(memcached_pool_st* pool, memcached_st *mmc)
-.. deprecated:: 0.53
- Use :func:`memcached_pool_release`
+
+ .. deprecated:: 0.53
+ Use `memcached_pool_release`
DESCRIPTION
-----------
-: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
-:type:`memcached_st` objects. Please see :doc:`../libmemcached/configuration`
-for details on the format of the configuration string.
+`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 :doc:`../libmemcached/configuration` for details on the
+format of the configuration string.
-:func:`memcached_pool_destroy` is used to destroy the connection pool
-created with :func:`memcached_pool_create` and release all allocated
-resources. It will return the pointer to the :type:`memcached_st` structure
-passed as an argument to :func:`memcached_pool_create`, and returns the
-ownership of the pointer to the caller when created with
-:func:`memcached_pool_create`, otherwise NULL is returned..
+`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
+when created with `memcached_pool_create`, otherwise NULL is returned..
-:func:`memcached_pool_fetch` is used to fetch a connection structure from the
+`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.
+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.
-:func:`memcached_pool_release` is used to return a connection structure back
-to the pool.
+`memcached_pool_release` is used to return a connection structure back to the
+pool.
-:func:`memcached_pool_behavior_get` and :func:`memcached_pool_behavior_set`
-is used to get/set behavior flags on all connections in the pool.
+`memcached_pool_behavior_get` and `memcached_pool_behavior_set` is used to
+get/set behavior flags on all connections in the pool.
-Both :func:`memcached_pool_release` and :func:`memcached_pool_fetch` are
-thread safe.
+Both `memcached_pool_release` and `memcached_pool_fetch` are thread safe.
-RETURN
-------
+RETURN VALUE
+------------
-:func:`memcached_pool_destroy` returns the pointer (and ownership) to the
-:type:`memcached_st` structure used to create the pool. If connections are in
-use it returns NULL.
+`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.
-:func:`memcached_pool_pop` returns a pointer to a :type:`memcached_st`
-structure from the pool (or NULL if an allocation cannot be satisfied).
+`memcached_pool_pop` returns a pointer to a `memcached_st` structure from the
+pool (or NULL if an allocation cannot be satisfied).
-:func:`memcached_pool_release` returns `MEMCACHED_SUCCESS` upon success.
+`memcached_pool_release` returns `MEMCACHED_SUCCESS` upon success.
-:func:`memcached_pool_behavior_get` and :func:`memcached_pool_behavior_get`
-returns `MEMCACHED_SUCCESS` upon success.
+`memcached_pool_behavior_get` and `memcached_pool_behavior_get` returns
+`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
projects / awesomized / libmemcached / blobdiff