X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fman%2Fmemcached_pool_behavior_set.3;h=0151cfdde8c1962f91c1bbb0f320d0da05bee065;hb=ca4acb0672e11e89af59ce588ea9c441c20b4e7a;hp=0729736c3a9d504e49f3eb555062100edc497e56;hpb=281c398ba3a10af677494c4453cd09d85ca921e0;p=m6w6%2Flibmemcached diff --git a/docs/man/memcached_pool_behavior_set.3 b/docs/man/memcached_pool_behavior_set.3 index 0729736c..0151cfdd 100644 --- a/docs/man/memcached_pool_behavior_set.3 +++ b/docs/man/memcached_pool_behavior_set.3 @@ -1,4 +1,4 @@ -.TH "MEMCACHED_POOL_BEHAVIOR_SET" "3" "April 08, 2011" "0.47" "libmemcached" +.TH "MEMCACHED_POOL_BEHAVIOR_SET" "3" "June 17, 2011" "0.49" "libmemcached" .SH NAME memcached_pool_behavior_set \- libmemcached Documentation . @@ -30,50 +30,67 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .. .\" Man page generated from reStructeredText. . +.SH SYNOPSIS .sp -Manage pools -.SH LIBRARY -.sp -C Client Library for memcached (libmemcachedutil, \-lmemcachedutil) -.SS SYNOPSIS -.sp -.nf -.ft C #include - -memcached_pool_st * memcached_pool_create(memcached_st* mmc, int initial, int max); - -memcached_st * memcached_pool_destroy(memcached_pool_st* pool); - -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); - -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) - -memcached_return_t memcached_pool_behavior_get(memcached_pool_st *pool, memcached_behavior_t flag, uint64_t *value) -.ft P -.fi -.SS DESCRIPTION -.sp -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 \fBmemcached_st\fP objects. The mmc argument should be an -initialised \fBmemcached_st\fP structure, and a successfull invocation of -memcached_pool_create takes full ownership of the variable (until it -is released by memcached_pool_destroy). The \fBinitial\fP argument -specifies the initial size of the connection pool, and the \fBmax\fPargument 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. +.INDENT 0.0 +.TP +.B memcached_pool_st *memcached_pool(const char *option_string, size_t option_string_length); +.UNINDENT +.INDENT 0.0 +.TP +.B memcached_pool_st * memcached_pool_create(memcached_st* mmc, int initial, int max); DEPRECATED +.UNINDENT +.INDENT 0.0 +.TP +.B memcached_st * memcached_pool_destroy(memcached_pool_st* pool); +.UNINDENT +.INDENT 0.0 +.TP +.B memcached_st * memcached_pool_pop (memcached_pool_st* pool, bool block, memcached_return_t *rc); +.UNINDENT +.INDENT 0.0 +.TP +.B memcached_return_t memcached_pool_push(memcached_pool_st* pool, memcached_st *mmc); +.UNINDENT +.INDENT 0.0 +.TP +.B memcached_st *memcached_create (memcached_st *ptr); +.UNINDENT +.INDENT 0.0 +.TP +.B memcached_return_t memcached_pool_behavior_set(memcached_pool_st\fI\ *pool\fP, memcached_behavior_t\fI\ flag\fP, uint64_t\fI\ data\fP) +.UNINDENT +.INDENT 0.0 +.TP +.B memcached_return_t memcached_pool_behavior_get(memcached_pool_st\fI\ *pool\fP, memcached_behavior_t\fI\ flag\fP, uint64_t\fI\ *value\fP) +.UNINDENT +.sp +Compile and link with \-lmemcachedutil \-lmemcached +.SH DESCRIPTION +.sp +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 +\fBmemcached_st\fPobjects. Please see \fIlibmemcached_configuration\fP for details on the format of the configuration string. +.sp +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 \fBmemcached_st\fPobjects. The mmc argument should be an +initialised \fBmemcached_st\fPstructure, and a successfull invocation of +memcached_pool_create takes full ownership of the variable (until it is +released by memcached_pool_destroy). The \fBinitial\fP argument specifies +the initial size of the connection pool, and the \fBmax\fPargument +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. .sp 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 \fBmemcached_st\fP 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.. .sp memcached_pool_pop() is used to grab a connection structure from the connection pool. The block argument specifies if the function should @@ -104,17 +121,19 @@ returns MEMCACHED_SUCCESS upon success. .SH HOME .sp To find out more information please check: -\fI\%https://launchpad.net/libmemcached\fP +\fI\%http://libmemcached.org/\fP .SH AUTHOR .sp +Brian Aker, <\fI\%brian@tangent.org\fP> +.sp Trond Norbye, <\fI\%trond.norbye@gmail.com\fP> -.SS SEE ALSO +.SH SEE ALSO .sp \fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP .SH AUTHOR Brian Aker .SH COPYRIGHT -2011, Brian Aker +2011, Brian Aker DataDifferential, http://datadifferential.com/ .\" Generated by docutils manpage writer. .\" .