X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fmemcached_pool.rst;h=a3080788f4bb919a385dd14123f30b717cee842b;hb=4e38a2eadb390c100cbc8e73bf257c49f6eeb7d8;hp=9f842738b82b794b8ca3c336dd6c136a3faaab93;hpb=281c398ba3a10af677494c4453cd09d85ca921e0;p=m6w6%2Flibmemcached diff --git a/docs/memcached_pool.rst b/docs/memcached_pool.rst index 9f842738..a3080788 100644 --- a/docs/memcached_pool.rst +++ b/docs/memcached_pool.rst @@ -2,113 +2,102 @@ Working with memcached pools ============================ - -Manage pools - - -******* -LIBRARY -******* - - -C Client Library for memcached (libmemcachedutil, -lmemcachedutil) - - -------- SYNOPSIS -------- +#include +.. c:type:: memcached_pool_st -.. code-block:: perl +.. c:function:: memcached_pool_st* memcached_pool(const char *option_string, size_t option_string_length) - #include - - memcached_pool_st * memcached_pool_create(memcached_st* mmc, int initial, int max); - - memcached_st * memcached_pool_destroy(memcached_pool_st* pool); +.. c:function:: memcached_pool_st* memcached_pool_create(memcached_st* mmc, int initial, int max) +.. deprecated:: 0.46 + Use :c:func:`memcached_pool` - memcached_st * memcached_pool_pop (memcached_pool_st* pool, bool block, memcached_return_t *rc); +.. c:function:: memcached_st* memcached_pool_destroy(memcached_pool_st* pool) - memcached_return_t memcached_pool_push(memcached_pool_st* pool, memcached_st *mmc); - - memcached_st *memcached_create (memcached_st *ptr); +.. 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. - 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_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_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. - -memcached_pool_pop() is used to grab a connection structure from the -connection pool. The block argument specifies if the function should +: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. +to exceed the maximum size. You need to specify time in relative time. -memcached_pool_push() is used to return a connection structure back to the pool. +:c:func:`memcached_pool_release` is used to return a connection structure back to the pool. -memcached_pool_behavior_set() and memcached_pool_behagior_get() is -used to get/set behavior flags on all connections in 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. -memcached_pool_create() returns a pointer to the newly created -memcached_pool_st structure. On an allocation failure, 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). -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. +:c:func:`memcached_pool_release` returns :c:type:`MEMCACHED_SUCCESS` upon success. -memcached_pool_pop() returns a pointer to a memcached_st structure -from the pool (or NULL if an allocation cannot be satisfied). +:c:func:`memcached_pool_behavior_get` and :c:func:`memcached_pool_behavior_get` returns :c:type:`MEMCACHED_SUCCESS` upon success. -memcached_pool_push() 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 invalid, MEMCACHED_INVALID_ARGUMENTS will be returned. -memcached_pool_behavior_get() and memcached_pool_behavior_get() -returns MEMCACHED_SUCCESS upon success. +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: -`https://launchpad.net/libmemcached `_ +`http://libmemcached.org/ `_ -****** +------ AUTHOR -****** +------ + +Brian Aker, Trond Norbye, @@ -117,4 +106,4 @@ Trond Norbye, SEE ALSO -------- -:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` +:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)` :manpage:`libmemcached_configuration(3)`