Merge in trond.

[m6w6/libmemcached] / docs / memcached_pool.pod

diff --git a/docs/memcached_pool.pod b/docs/memcached_pool.pod
old mode 100755 (executable)
new mode 100644 (file)
index c0a818e..b974be6
--- a/docs/memcached_pool.pod
+++ b/docs/memcached_pool.pod
@@ -1,6 +1,6 @@
 =head1 NAME
 
-memcached_pool_create, memcached_pool_destroy, memcached_pool_push, memcached_pool_pop
+memcached_pool_create, memcached_pool_destroy, memcached_pool_push, memcached_pool_pop - Manage pools
 
 =head1 LIBRARY
 
@@ -10,14 +10,29 @@ C Client Library for memcached (libmemcachedutil, -lmemcachedutil)
 
   #include <libmemcached/memcached_pool.h>
 
-  memcached_pool_st *memcached_pool_create(memcached_st* mmc, int initial, int max);
-  memcached_st* memcached_pool_destroy(memcached_pool_st* pool);
+  memcached_pool_st *
+    memcached_pool_create(memcached_st* mmc, int initial, int max);
 
-  memcached_st* memcached_pool_pop(memcached_pool_st* pool, bool block);
-  void memcached_pool_push(memcached_pool_st* pool, memcached_st *mmc);
+  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)
 
 =head1 DESCRIPTION
 
@@ -41,11 +56,15 @@ ownership of the pointer to the caller.
 
 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.
+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.
 
+memcached_pool_behavior_set() and memcached_pool_behagior_get() is
+used to get/set behavior flags on all connections in the pool.
+
+
 =head1 RETURN
 
 memcached_pool_create() returns a pointer to the newly created
@@ -59,17 +78,22 @@ 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).
 
+memcached_pool_push() returns MEMCACHED_SUCCESS upon success.
+
+memcached_pool_behavior_get() and memcached_pool_behavior_get()
+returns MEMCACHED_SUCCESS upon success.
+
 =head1 HOME
 
 To find out more information please check:
-L<http://tangent.org/552/libmemcached.html>
+L<https://launchpad.net/libmemcached>
 
 =head1 AUTHOR
 
-Trond Norbye, E<lt>trond.norbye@sun.comE<gt>
+Trond Norbye, E<lt>trond.norbye@gmail.comE<gt>
 
 =head1 SEE ALSO
 
-memcached(1) libmemcached(3) memcached_create(3) memcached_free(3) libmemcachedutil(3)
+memcached(1) libmemcached(3) memcached_create(3) memcached_free(3) libmemcachedutil(3) memcached_behavior_get(3) memcached_behavior_set(3)
 
 =cut