X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fmemcached_pool.rst;h=aa914e50ecd06b8f58a0cba4a733a2f42f3f9406;hb=a6c3e3a3d04f379b1480c8c88a8eae17e54b1449;hp=9f842738b82b794b8ca3c336dd6c136a3faaab93;hpb=281c398ba3a10af677494c4453cd09d85ca921e0;p=m6w6%2Flibmemcached diff --git a/docs/memcached_pool.rst b/docs/memcached_pool.rst index 9f842738..aa914e50 100644 --- a/docs/memcached_pool.rst +++ b/docs/memcached_pool.rst @@ -2,42 +2,31 @@ Working with memcached pools ============================ - -Manage pools - - -******* -LIBRARY -******* - - -C Client Library for memcached (libmemcachedutil, -lmemcachedutil) - +.. index:: object: memcached_pool_st -------- SYNOPSIS -------- +#include +.. c:function:: memcached_pool_st *memcached_pool(const char *option_string, size_t option_string_length); -.. code-block:: perl - - #include - - memcached_pool_st * memcached_pool_create(memcached_st* mmc, int initial, int max); +.. c:function:: memcached_pool_st * memcached_pool_create(memcached_st* mmc, int initial, int max); DEPRECATED - memcached_st * memcached_pool_destroy(memcached_pool_st* pool); +.. c:function:: memcached_st * memcached_pool_destroy(memcached_pool_st* pool); - memcached_st * memcached_pool_pop (memcached_pool_st* pool, bool block, memcached_return_t *rc); +.. c:function:: memcached_st * memcached_pool_pop (memcached_pool_st* pool, bool block, memcached_return_t *rc); - memcached_return_t memcached_pool_push(memcached_pool_st* pool, memcached_st *mmc); +.. c:function:: 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_create (memcached_st *ptr); - 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 ----------- @@ -45,23 +34,28 @@ 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() 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. + +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 @@ -74,9 +68,9 @@ memcached_pool_behavior_set() and memcached_pool_behagior_get() is used to get/set behavior flags on all connections in the pool. -****** +------ RETURN -****** +------ memcached_pool_create() returns a pointer to the newly created @@ -96,19 +90,21 @@ memcached_pool_behavior_get() and memcached_pool_behavior_get() returns MEMCACHED_SUCCESS upon success. -**** +---- HOME -**** +---- To find out more information please check: -`https://launchpad.net/libmemcached `_ +`http://libmemcached.org/ `_ -****** +------ AUTHOR -****** +------ + +Brian Aker, Trond Norbye,