X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fman%2Fmemcached_pool.3;h=db25d6a182b8a88dc82955f2d710b842b1d80248;hb=381c98f0967635bf58f70f6666c7f56dbf1b8e76;hp=bf8dc33eec9cbc5d9cfd9f363f2cfe914ddcc49f;hpb=e268471e4642c16281dc65b2f0ad9b897786c0b4;p=m6w6%2Flibmemcached diff --git a/docs/man/memcached_pool.3 b/docs/man/memcached_pool.3 index bf8dc33e..db25d6a1 100644 --- a/docs/man/memcached_pool.3 +++ b/docs/man/memcached_pool.3 @@ -1,4 +1,4 @@ -.TH "MEMCACHED_POOL" "3" "January 26, 2012" "1.0.4" "libmemcached" +.TH "MEMCACHED_POOL" "3" "September 16, 2012" "1.0.10" "libmemcached" .SH NAME memcached_pool \- libmemcached Documentation . @@ -56,13 +56,13 @@ Deprecated since version 0.46: Use \fI\%memcached_pool()\fP .B memcached_st* memcached_pool_pop(\fI\%memcached_pool_st\fP*\fI\ pool\fP, bool\fI\ block\fP, memcached_return_t\fI\ *rc\fP) .UNINDENT .sp -Deprecated since version 0.53: Use \fBmemcached_pool_fetch()\fP +Deprecated since version 0.53: Use \fI\%memcached_pool_fetch()\fP .INDENT 0.0 .TP -.B memcached_st* memcached_pool_fetch(memcached_pool_st*, struct timespec* relative_time, memcached_return_t* rc); +.B memcached_st* memcached_pool_fetch(\fI\%memcached_pool_st\fP*, struct timespec*\fI\ relative_time\fP, memcached_return_t*\fI\ rc\fP) .UNINDENT .sp -New in version 0.53: Synonym for memcached_pool_pop() +New in version 0.53: Synonym for memcached_pool_pop .INDENT 0.0 .TP .B memcached_return_t memcached_pool_push(\fI\%memcached_pool_st\fP*\fI\ pool\fP, memcached_st\fI\ *mmc\fP) @@ -71,10 +71,10 @@ New in version 0.53: Synonym for memcached_pool_pop() Deprecated since version 0.53: Use \fI\%memcached_pool_push()\fP .INDENT 0.0 .TP -.B memcached_return_t memcached_pool_release(memcached_pool_st* pool, memcached_st* mmc); +.B memcached_return_t memcached_pool_release(\fI\%memcached_pool_st\fP*\fI\ pool\fP, memcached_st*\fI\ mmc\fP) .UNINDENT .sp -New in version 0.53: Synonym for memcached_pool_push(). +New in version 0.53: Synonym for memcached_pool_push. .INDENT 0.0 .TP .B memcached_return_t memcached_pool_behavior_set(\fI\%memcached_pool_st\fP\fI\ *pool\fP, memcached_behavior_t\fI\ flag\fP, uint64_t\fI\ data\fP) @@ -96,29 +96,29 @@ created with \fI\%memcached_pool_create()\fP and release all allocated resources. It will return the pointer to the \fBmemcached_st\fP structure passed as an argument to \fI\%memcached_pool_create()\fP, and returns the ownership of the pointer to the caller when created with \fI\%memcached_pool_create()\fP, otherwise NULL is returned.. .sp -\fBmemcached_pool_fetch()\fP is used to fetch a connection structure from the +\fI\%memcached_pool_fetch()\fP 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. .sp -\fBmemcached_pool_release()\fP is used to return a connection structure back to the pool. +\fI\%memcached_pool_release()\fP is used to return a connection structure back to the pool. .sp \fI\%memcached_pool_behavior_get()\fP and \fI\%memcached_pool_behavior_set()\fP is used to get/set behavior flags on all connections in the pool. .sp -Both \fBmemcached_pool_release()\fP and \fBmemcached_pool_fetch()\fP are thread safe. +Both \fI\%memcached_pool_release()\fP and \fI\%memcached_pool_fetch()\fP are thread safe. .SH RETURN .sp \fI\%memcached_pool_destroy()\fP returns the pointer (and ownership) to the \fBmemcached_st\fP structure used to create the pool. If connections are in use it returns NULL. .sp \fI\%memcached_pool_pop()\fP returns a pointer to a \fBmemcached_st\fP structure from the pool (or NULL if an allocation cannot be satisfied). .sp -\fBmemcached_pool_release()\fP returns \fBMEMCACHED_SUCCESS\fP upon success. +\fI\%memcached_pool_release()\fP returns \fBMEMCACHED_SUCCESS\fP upon success. .sp \fI\%memcached_pool_behavior_get()\fP and \fI\%memcached_pool_behavior_get()\fP returns \fBMEMCACHED_SUCCESS\fP upon success. .sp 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. .sp -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. +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. .SH HOME .sp To find out more information please check: @@ -134,7 +134,7 @@ Trond Norbye, <\fI\%trond.norbye@gmail.com\fP> .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker DataDifferential, http://datadifferential.com/ +2011-2012, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" .