X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fmemcached_pool.rst;h=7dcc707a9c081152d9f0868fd4400524abb71df4;hb=026339d350e4cbec41951eea4d64bda5caf9febc;hp=b7a0f04081754cb88636e5e4a072d37b6a47d266;hpb=e668c212d13197abf5d8e2ddc7916057c94325b6;p=awesomized%2Flibmemcached diff --git a/docs/memcached_pool.rst b/docs/memcached_pool.rst index b7a0f040..7dcc707a 100644 --- a/docs/memcached_pool.rst +++ b/docs/memcached_pool.rst @@ -8,15 +8,19 @@ SYNOPSIS #include -.. c:function:: memcached_pool_st * memcached_pool_create(memcached_st* mmc, int initial, int max); - -.. c:function:: memcached_st * memcached_pool_destroy(memcached_pool_st* pool); +.. c:type:: memcached_pool_st + +.. c:function:: memcached_pool_st* memcached_pool(const char *option_string, size_t option_string_length) + +.. c:function:: memcached_pool_st* memcached_pool_create(memcached_st* mmc, int initial, int max) +.. deprecated:: 0.46 + Use :c:func:`memcached_pool()` instead. -.. c:function:: 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) -.. c:function:: memcached_return_t memcached_pool_push(memcached_pool_st* pool, memcached_st *mmc); +.. c:function:: memcached_st* memcached_pool_pop (memcached_pool_st* pool, bool block, memcached_return_t *rc) -.. c:function:: memcached_st *memcached_create (memcached_st *ptr); +.. c:function:: memcached_return_t memcached_pool_push(memcached_pool_st* pool, memcached_st *mmc) .. c:function:: memcached_return_t memcached_pool_behavior_set(memcached_pool_st *pool, memcached_behavior_t flag, uint64_t data) @@ -30,55 +34,36 @@ 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 +: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_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. -memcached_pool_push() is used to return a connection structure back to the pool. +:c:func:`memcached_pool_push()` 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. ------ 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. - -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. - -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_pop()` returns a pointer to a :c:type:`memcached_st` structure from the pool (or NULL if an allocation cannot be satisfied). -memcached_pool_push() returns MEMCACHED_SUCCESS upon success. +:c:func:`memcached_pool_push()` returns :c:type:`MEMCACHED_SUCCESS` upon success. -memcached_pool_behavior_get() and memcached_pool_behavior_get() -returns MEMCACHED_SUCCESS upon success. +:c:func:`memcached_pool_behavior_get()` and :c:func:`memcached_pool_behavior_get()` returns :c:type:`MEMCACHED_SUCCESS` upon success. ---- @@ -87,7 +72,7 @@ HOME To find out more information please check: -`https://launchpad.net/libmemcached `_ +`http://libmemcached.org/ `_ ------ @@ -104,4 +89,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)`