e-threadpool 1.0.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Dale Ma
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,36 @@
+# Threadpool
+Threadpool is the "threadpool pattern" implemented in ruby. It's a compact but robust component.
+
+## Features
+- Timeout jobs, it means the stuck threads will be recycled.
+- Job based tasks, job is an object not a block, could be more flexible.
+- MRI and JRuby are supported.
+
+## Install
+    gem install e-threadpool
+or edit Gemfile
+    ...
+    gem 'e-threadpool'
+    ...
+
+
+## Example
+    require 'threadpool'
+
+    class TestJob < Job
+      def run
+        puts "hello"
+      end
+    end
+
+    threadpool = Threadpool::Threadpool.new
+    100.times.each do
+      # threadpool auto-executes the job after loaded
+      threadpool.load(TestJob.new)
+    end
+
+    # shutdown will wait until all jobs are finished
+    threadpool.shutdown
+
+## LICENSE
+MIT LICENSE, please refer to the LICENSE file.

data/lib/threadpool.rb

@@ -0,0 +1,5 @@
+$: << File.dirname(__FILE__)
+
+require 'threadpool/worker'
+require 'threadpool/core'
+require 'threadpool/job'

data/lib/threadpool/core.rb

@@ -0,0 +1,94 @@
+require "monitor"
+
+module Threadpool
+
+  class Threadpool
+    INIT_WORKERS = 10
+    MAX_WORKERS = 20
+    TIMEOUT_SECS = 30
+
+    def initialize(*args)
+      extend MonitorMixin
+      @init_workers = args.shift || INIT_WORKERS
+      @max_workers = args.shift || MAX_WORKERS
+      @timeout_secs = args.shift || TIMEOUT_SECS
+      if @max_workers < @init_workers
+        raise "max_workers cannot smaller than init_workers"
+      end
+
+      @workers = (0...@init_workers).map { Threadpool::Worker.new }
+      Thread.new { process }
+    end
+
+    def load(job)
+      if @teminate
+        puts "job: #{job.jobid} cannot be loaded, the pool is terminating."
+        return
+      end
+
+      worker = nil
+      loop do
+        worker = idle_worker
+        worker.nil? ? create_worker : break
+        sleep(0.001)
+      end
+
+      worker.job = job
+    end
+
+    def shutdown
+      @teminate = true
+
+      loop do
+        return if busy_workers.count == 0
+        sleep(0.001)
+      end
+    end
+
+    private
+    def process
+      loop do
+        synchronize do
+          @workers.each do |w|
+
+            if w.loaded? 
+              w.process
+
+              if Time.now - w.start_time > @timeout_secs
+                puts "job is timeout."
+                w.cancel
+              end
+            end
+
+          end
+        end
+        sleep(0.001)
+
+        if @teminate && busy_workers.count == 0
+          return
+        end
+      end
+    end
+
+    def idle_worker
+      synchronize do
+        @workers.each do |worker|
+          return worker if !worker.loaded?
+        end
+      end
+
+      nil
+    end
+
+    def busy_workers
+      @workers.select { |w| w.loaded? }
+    end
+
+    def create_worker
+      synchronize do
+        @workers << Worker.new if @workers.count < @max_workers
+      end
+    end
+
+  end
+end

data/lib/threadpool/job.rb

@@ -0,0 +1,20 @@
+module Threadpool
+
+  class Job
+    attr_reader :jobid
+
+    def initialize(*args)
+      @args = args
+      @jobid = (0...16).map { ('0'..'9').to_a[rand(9)] }.join
+    end
+
+    def run
+      p "Running job: #{@jobid}"
+    end
+
+    def cancel
+      Thread.current.exit
+    end
+    
+  end
+end

data/lib/threadpool/worker.rb

@@ -0,0 +1,39 @@
+module Threadpool
+  
+  class Worker
+    attr_reader :start_time
+
+    def loaded?
+      !@job.nil?
+    end
+
+    def job=(job)
+      @job = job
+    end
+
+    def process
+      return if @start_time
+      @start_time = Time.now
+      @thread = Thread.new {
+        @job.run 
+        reset  
+      }
+    end
+
+    def cancel
+        @thread.exit
+        reset
+    end
+
+    def jobid
+      @job.jobid if @job
+    end
+
+    private
+    def reset
+      @job = nil
+      @start_time = nil
+    end
+    
+  end
+end

data/test/threadpool_test.rb

@@ -0,0 +1,35 @@
+require File.dirname(__FILE__) + '/../lib/threadpool'
+require 'test/unit'
+
+include Threadpool
+
+class TestJob < Job
+  # NOTE: Mutext synchronize is a must, or the result might be unpredictable.
+  @@m = Mutex.new
+  
+  def run
+    @@m.synchronize do
+      @args[0][0] += 1
+    end 
+  end
+end
+
+class TestThreadpool < Test::Unit::TestCase
+  
+  def test_sync
+    # arguments are init_workers, max_workers, timeout_secs. [OPTIONAL]
+    threadpool = Threadpool::Threadpool.new(8, 22, 5)
+
+    sum = [0]
+    5000.times.each do
+      threadpool.load(TestJob.new(sum))
+    end
+
+    threadpool.shutdown
+    assert_equal(5000, sum[0])
+
+    # after shutdown, threadpool should not accept any jobs
+    threadpool.load(TestJob.new(sum))
+    assert_equal(5000, sum[0])
+  end
+end

metadata

@@ -0,0 +1,52 @@
+--- !ruby/object:Gem::Specification
+name: e-threadpool
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Dale Ma
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-21 00:00:00.000000000 Z
+dependencies: []
+description: 
+email: dalema22@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/threadpool/core.rb
+- lib/threadpool/job.rb
+- lib/threadpool/worker.rb
+- lib/threadpool.rb
+- LICENSE
+- README.md
+- test/threadpool_test.rb
+homepage: http://github.com/eguitarz/threadpool
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.19
+signing_key: 
+specification_version: 3
+summary: Ruby based thread pool
+test_files:
+- test/threadpool_test.rb