X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fmemcached_pool.rst;h=38d2b3a73137757d594bec0876205ce968b23176;hb=16ba6539e831e2abcef9dcf56fa26e3a0d5c7f91;hp=603419f53039a62da361c4e802cad1fd7eb04661;hpb=dc421179c0d159f1ca8a6b2b64b89163a7e0c639;p=awesomized%2Flibmemcached diff --git a/docs/memcached_pool.rst b/docs/memcached_pool.rst index 603419f5..38d2b3a7 100644 --- a/docs/memcached_pool.rst +++ b/docs/memcached_pool.rst @@ -2,6 +2,8 @@ Working with memcached pools ============================ +.. index:: object: memcached_pool_st + -------- SYNOPSIS -------- @@ -32,38 +34,35 @@ 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. +: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 :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 +DEPRECATED :c:func:`memcached_pool_create()` is used to create a connection pool of objects you may use to remove the overhead of using +:c:type:`memcached_clone` for short lived :c:type:`memcached_st` objects. +The mmc argument should be an initialised :c:type:`memcached_st` structure, +and a successfull invocation of :c:type:`memcached_pool_create` takes full +ownership of the variable (until it is released by +:c:type:`memcached_pool_destroy`). The :c:type:`initial` argument specifies +the initial size of the connection pool, and the :c:type:`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 when created with memcached_pool_create, -otherwise NULL is returned.. +: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.. -memcached_pool_pop() is used to grab a connection structure from the +: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_set()` and :c:func:`memcached_pool_behagior_get()` is used to get/set behavior flags on all connections in the pool. ------ @@ -71,21 +70,19 @@ RETURN ------ -memcached_pool_create() returns a pointer to the newly created -memcached_pool_st structure. On an allocation failure, it returns +:c:func:`memcached_pool_create()` returns a pointer to the newly created +:c:type:`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 +: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_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. ---- @@ -94,7 +91,7 @@ HOME To find out more information please check: -`https://launchpad.net/libmemcached `_ +`http://libmemcached.org/ `_ ------