X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fman%2Fmemcached_pool_st.3;h=7d20f263c207cdf6e95206202f060cf8f48e95d2;hb=20671681ff4e13ed84be72b699f71a90337245cd;hp=b3e4fd8ca3eb26a5f984c4539714b79b302a39e2;hpb=60c68bea5d034012f935eb849d92781c345c7214;p=m6w6%2Flibmemcached

diff --git a/docs/man/memcached_pool_st.3 b/docs/man/memcached_pool_st.3
index b3e4fd8c..5313cc85 100644
--- a/docs/man/memcached_pool_st.3
+++ b/docs/man/memcached_pool_st.3
@@ -1,4 +1,4 @@
-.TH "MEMCACHED_POOL_ST" "3" "July 21, 2011" "0.51" "libmemcached"
+.TH "MEMCACHED_POOL_ST" "3" "April 09, 2012" "1.0.6" "libmemcached"
 .SH NAME
 memcached_pool_st \- libmemcached Documentation
 .
@@ -46,7 +46,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .B \fI\%memcached_pool_st\fP* memcached_pool_create(memcached_st*\fI\ mmc\fP, int\fI\ initial\fP, int\fI\ max\fP)
 .UNINDENT
 .sp
-Deprecated since version 0.46: Use \fI\%memcached_pool()\fP instead.
+Deprecated since version 0.46: Use \fI\%memcached_pool()\fP
 .INDENT 0.0
 .TP
 .B memcached_st* memcached_pool_destroy(\fI\%memcached_pool_st\fP*\fI\ pool\fP)
@@ -55,10 +55,26 @@ Deprecated since version 0.46: Use \fI\%memcached_pool()\fP instead.
 .TP
 .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 \fI\%memcached_pool_fetch()\fP
+.INDENT 0.0
+.TP
+.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
 .INDENT 0.0
 .TP
 .B memcached_return_t memcached_pool_push(\fI\%memcached_pool_st\fP*\fI\ pool\fP, memcached_st\fI\ *mmc\fP)
 .UNINDENT
+.sp
+Deprecated since version 0.53: Use \fI\%memcached_pool_push()\fP
+.INDENT 0.0
+.TP
+.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.
 .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)
@@ -80,23 +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
-\fI\%memcached_pool_pop()\fP is used to grab a connection structure from the
-connection pool. The block argument specifies if the function should
+\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.
+to exceed the maximum size. You need to specify time in relative time.
 .sp
-\fI\%memcached_pool_push()\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 \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
-\fI\%memcached_pool_push()\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.
 .SH HOME
 .sp
 To find out more information please check: