common-pool 0.3.0 → 0.3.1

data/CHANGELOG

@@ -1,3 +1,7 @@
-*0.5.0* (14th May 2007)
+*0.3.1* (16th May 2007)
+
+* Return validation_timeout and idle_check_status as part of status_info returned
+
+*0.3.0* (14th May 2007)
 
 * First release

data/README

@@ -1,51 +1,70 @@
 == common-pool
 
-Object pooling with idle objects eviction check similar with Apache Common Pool.
+First in first out (FIFO) object pooling mechanism with idle objects eviction check, similar with {Apache Common Pool}[link:http://jakarta.apache.org/commons/pool/].
 
-Links:
-* http://common-pool.rubyforge.org
-* http://www.pluitsolutions.com/common-pool
+It supports the following configuration parameters:
+* min_idle
+* max_idle
+* max_idle_time
+* max_active
+* timeout
+* validation_timeout
+* idle_check_no_per_run
+* idle_check_interval
+
+Overwrite <code>CommonPool::PoolDataSource</code> to create object to be returned to the pool.
 
-== INSTALLATION
+== Installation
 
   $ gem install common-pool
 
-== EXAMPLE
+== Example
 
   require 'common_pool'    
-    
+  
   # Extend data source object
   class RandomNumberDataSource < CommonPool::PoolDataSource
     # Overwrite to return object to be stored in the pool.
     def create_object
       rand(1000)
     end
-      
+    
     # Overwrite to check if idle object in the pool is still valid.
     def valid?(object)
       true
     end
   end
-    
+  
   # Create a new object pool
   object_pool = ObjectPool.new(RandomNumberDataSource.new)
-    
-  # Borrow and return an object from the pool
+  
+  # Borrow object from the pool
   object = object_pool.borrow_object
+
+  # Return object to the pool
   object_pool.return_object(object)
-    
-  # Borrow and invalidate object
-  object = object_pool.borrow_object
-  object_pool.return_object(object)    
-    
+  
+  # Or invalidate object and remove it from the pool
+  object_pool.invalidate_object(object)
+  
   # Create object pool with idle objects eviction thread
   object_pool = ObjectPool.new(RandomNumberDataSource.new) do |config|
     config.min_idle = 5
     config.max_idle = 10
-    config.idle_check_no_per_run = 10 		# check max 10 idle objects per run
-    config.idle_check_interval = 10 * 60 	# check every 10 minutes
+  
+    # max 10 idle objects checked per run
+    config.idle_check_no_per_run = 10
+
+    # check idle objects every 10 minutes
+    config.idle_check_interval = 10 * 60
   end
- 
-  # Return a hash of pool instance status variables, including active and idle objects list and 
-  # configuration options
-  object_pool.status_info
+
+  # Return a hash of pool instance status variables, i.e.
+  # active and idle lists size, and configuration options
+  object_pool.status_info
+  
+== Links
+* http://www.rubyforge.org/projects/common-pool
+* http://www.pluitsolutions.com/common-pool
+  
+  

data/lib/common_pool.rb

@@ -42,7 +42,7 @@ module CommonPool
     # Maximum number of active objects in the pool. Default: 8.
     attr_accessor :max_active
     
-    # Request timeout when creating object for the pool, timeout in seconds. Default: 30.
+    # Request timeout when creating object for the pool, timeout in seconds. Default: 60.
     # If set to 0 or less, there will be no timeout.
     attr_accessor :timeout
     
@@ -73,13 +73,14 @@ module CommonPool
       self.max_active         = 8
       self.idle_check_no_per_run = 3
       self.idle_check_interval= 0
-      self.timeout            = 30
+      self.timeout            = 60
       self.validation_timeout = 30
     end
     
     # Convert configuration properties to hash object.
     def to_hash
       { :timeout => self.timeout,
+        :validation_tmeout => self.validation_timeout,
         :min_idle => self.min_idle,
         :max_idle => self.max_idle,
         :max_idle_time => self.max_idle_time,
@@ -253,7 +254,8 @@ module CommonPool
     # Return a hash of active and idle objects size with pool instance configuration options.
     def status_info
       {:active_objects => @active_list.size,
-       :idle_objects => @idle_list.size}.merge(self.config.to_hash)
+       :idle_objects => @idle_list.size,
+       :idle_check_status => @idle_check_status}.merge(self.config.to_hash)
     end
     
     # Check if an idle object is valid, return false if <code>validation_timeout</code> period reached.

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.2
 specification_version: 1
 name: common-pool
 version: !ruby/object:Gem::Version 
-  version: 0.3.0
-date: 2007-05-14 00:00:00 +08:00
+  version: 0.3.1
+date: 2007-05-16 00:00:00 +08:00
 summary: Common Pool - Object Pooling
 require_paths: 
 - lib