thread-pool 0.0.1

data/History.rdoc

@@ -0,0 +1,4 @@
+
+=== 0.0.1 / YYYY-MM-DD
+
+* Initial release

data/Manifest

@@ -0,0 +1,15 @@
+History.rdoc
+Manifest
+README.rdoc
+Rakefile
+examples/basic.rb
+examples/timeout.rb
+lib/thread-pool.rb
+lib/thread-pool/pool.rb
+lib/thread-pool/version.rb
+spec/GEM_spec.rb
+spec/spec_helper.rb
+tasks/docs.rake
+tasks/gemspec.rake
+tasks/spec.rake
+thread-pool.gemspec

data/README.rdoc

@@ -0,0 +1,29 @@
+
+= Thread Pool
+
+Multi-threaded Array subclass.
+
+== License:
+
+(The MIT License)
+
+Copyright (c) 2009 TJ Holowaychuk <tj@vision-media.ca>
+
+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, an d/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/Rakefile

@@ -0,0 +1,15 @@
+
+$:.unshift 'lib'
+require 'thread-pool'
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new "thread-pool", ThreadPool::VERSION do |p|
+  p.author = "TJ Holowaychuk"
+  p.email = "tj@vision-media.ca"
+  p.summary = "Multi-threaded Array subclass"
+  p.runtime_dependencies = []
+end
+
+Dir['tasks/**/*.rake'].sort.each { |f| load f }

data/examples/basic.rb

@@ -0,0 +1,71 @@
+
+$:.unshift File.dirname(__FILE__) + '/../lib'
+require 'thread-pool'
+
+# TODO: thread-safe ThreadPool ? ensure all methods are thread safe
+# TODO: fix issue with joining threads as they are added ...
+#       sleep 0.002 while busy?
+# TODO: get stop to work
+# TODO: hard stop! ? resume?
+# TODO: stop
+# TODO: stop! kill terminate
+
+# Any object responding to #call may be passed to #<<
+
+pool = ThreadPool.new 2
+pool << lambda { sleep 0.5; puts 'one' }
+pool << lambda { sleep 0.5; puts 'two' }
+pool << lambda { sleep 0.5; puts 'three' }
+pool << lambda { sleep 0.5; puts 'four' }
+pool << lambda { sleep 0.5; puts 'five' }
+pool.join
+p pool
+
+# Calling #process on a pool will push the given
+# block onto the queue. Arguments may be passed as parameters into
+# the thread.
+
+pool = ThreadPool.new
+1.upto(10) do |n|
+  pool.process(n * 2) { |n|
+    sleep 0.5
+    p n
+  }
+end
+pool.join
+p pool
+
+# You may specify the :reap_interval which reaps old threads.
+
+ThreadPool.new 5, :reap_interval => 0.0002 do |pool|
+  1.upto(10) do |n|
+    pool.process(n) { |n|
+      sleep 0.5
+      p n
+    }
+  end
+end
+p pool
+
+# A block may be passed to #new which then calls #join at the end.
+
+ThreadPool.new do
+  1.upto(10) do |n|
+    process(n) { |n|
+      sleep 0.5
+      p n
+    }
+  end
+end
+p pool
+
+# Another example
+
+ThreadPool.new do |pool|
+  1.upto(50) do |n|
+    pool << lambda { p n }
+    pool.stop if n > 30
+  end
+end
+p pool
+

data/lib/thread-pool.rb

@@ -0,0 +1,25 @@
+#--
+# Copyright (c) 2009 TJ Holowaychuk <tj@vision-media.ca>
+#
+# 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.
+#++
+
+require 'thread-pool/version'
+require 'thread-pool/pool'

data/lib/thread-pool/pool.rb

@@ -0,0 +1,156 @@
+
+class ThreadPool
+  
+  #--
+  # Constants
+  #++
+  
+  ##
+  # Max number of worker threads available to this pool.
+  
+  THREAD_LIMIT = 10
+  
+  ##
+  # Interval at which to poll the workers, at which time
+  # any inactive threads are destroyed.
+  
+  REAP_INTERVAL = 0.002
+  
+  ##
+  # Interval at which to poll workers, preventing the 
+  # parent thread from exiting.
+  
+  JOIN_INTERVAL = 0.002
+  
+  ##
+  # Live threads.
+  
+  attr_reader :threads
+  
+  ##
+  # Maximum threads.
+  
+  attr_reader :max_threads
+  
+  ##
+  # Reap interval.
+  
+  attr_reader :reap_interval
+  
+  ##
+  # Initialize with _max_threads_ and _options_.
+  # When a _block_ is passed it will be evaluated in context
+  # to the thread pool, or the thread pool will be yielded, and
+  # the pool will call #join before exiting the block.
+  #
+  # === Options
+  #
+  #   :reap_interval  reap interval or REAP_INTERVAL
+  #
+  
+  def initialize max_threads = nil, options = {}, &block
+    @threads, @data = [], []
+    @max_threads = max_threads || THREAD_LIMIT
+    @reap_interval = options.fetch :reap_interval, REAP_INTERVAL
+    if block
+      if block.arity > 0
+        yield self
+      else
+        self.instance_eval &block   
+      end
+      join
+    end
+  end
+  
+  ##
+  # Process any _object_ which must respond to #call in a worker thread.
+  
+  def << object
+    process &lambda { |*args|
+      object.call *args
+    }
+  end
+  
+  ##
+  # Fetch a worker and execute _block_ passing _args_.
+  
+  def process *args, &block
+    @data << [args, block]
+  end
+  
+  ##
+  # Return inspection string.
+  
+  def inspect
+    "#<ThreadPool:#{__id__} max_threads:#{max_threads} threads:#{threads.length}>"
+  end
+  
+  ##
+  # Run worker thread with _args_ and _block_.
+  
+  def worker *args, &block
+    unless threads.length > max_threads
+      threads << Thread.new(*args, &block)
+    else
+      sleep REAP_INTERVAL
+      reap; retry
+    end
+  end
+  
+  ##
+  # Run workers.
+  
+  def start
+    @running = true
+    @data.each do |args, proc|
+      worker *args, &proc
+    end
+  end
+  
+  ##
+  # Stop the thread pool, killing its workers.
+  
+  def stop
+    threads.each do |thread|
+      thread.kill
+    end
+    @running = false
+  end
+  
+  ##
+  # Check if the thread pool is running.
+  
+  def running?
+    @running
+  end
+  
+  ##
+  # Check if any thread pool workers are busy.
+  
+  def busy?
+    running? && threads.any? { |thread| thread.alive? }
+  end
+  
+  ##
+  # Join threads and start workers.
+  
+  def join
+    start unless running?
+    sleep JOIN_INTERVAL while busy?
+  end
+  
+  private
+  
+  ##
+  # Reap dead threads.
+  
+  def reap
+    threads.delete_if do |thread|
+      not thread.alive?
+    end.each do |thread|
+      thread.kill
+    end
+  end
+  
+end
+

data/lib/thread-pool/version.rb

@@ -0,0 +1,4 @@
+
+class ThreadPool < Array
+  VERSION = '0.0.1'
+end

data/tasks/docs.rake

@@ -0,0 +1,13 @@
+
+namespace :docs do
+  
+  desc 'Remove rdoc products'
+  task :remove => [:clobber_docs]
+  
+  desc 'Build docs, and open in browser for viewing (specify BROWSER)'
+  task :open do
+    browser = ENV["BROWSER"] || "safari"
+    sh "open -a #{browser} doc/index.html"
+  end
+  
+end

data/tasks/gemspec.rake

@@ -0,0 +1,3 @@
+
+desc 'Build gemspec file'
+task :gemspec => [:build_gemspec]

data/tasks/spec.rake

@@ -0,0 +1,25 @@
+
+require 'spec/rake/spectask'
+  
+desc "Run all specifications"
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.libs << "lib"
+  t.spec_opts = ["--color", "--require", "spec/spec_helper.rb"]
+end
+  
+namespace :spec do
+
+  desc "Run all specifications verbosely"
+  Spec::Rake::SpecTask.new(:verbose) do |t|
+    t.libs << "lib"
+    t.spec_opts = ["--color", "--format", "specdoc", "--require", "spec/spec_helper.rb"]
+  end
+  
+  desc "Run specific specification verbosely (specify SPEC)"
+  Spec::Rake::SpecTask.new(:select) do |t|
+    t.libs << "lib"
+    t.spec_files = [ENV["SPEC"]]
+    t.spec_opts = ["--color", "--format", "specdoc", "--require", "spec/spec_helper.rb"]
+  end
+  
+end

data/thread-pool.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{thread-pool}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["TJ Holowaychuk"]
+  s.date = %q{2009-10-12}
+  s.description = %q{Multi-threaded Array subclass}
+  s.email = %q{tj@vision-media.ca}
+  s.extra_rdoc_files = ["README.rdoc", "lib/thread-pool.rb", "lib/thread-pool/pool.rb", "lib/thread-pool/version.rb", "tasks/docs.rake", "tasks/gemspec.rake", "tasks/spec.rake"]
+  s.files = ["History.rdoc", "Manifest", "README.rdoc", "Rakefile", "examples/basic.rb", "examples/timeout.rb", "lib/thread-pool.rb", "lib/thread-pool/pool.rb", "lib/thread-pool/version.rb", "spec/GEM_spec.rb", "spec/spec_helper.rb", "tasks/docs.rake", "tasks/gemspec.rake", "tasks/spec.rake", "thread-pool.gemspec"]
+  s.homepage = %q{}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Thread-pool", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{thread-pool}
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Multi-threaded Array subclass}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification 
+name: thread-pool
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- TJ Holowaychuk
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-12 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Multi-threaded Array subclass
+email: tj@vision-media.ca
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- lib/thread-pool.rb
+- lib/thread-pool/pool.rb
+- lib/thread-pool/version.rb
+- tasks/docs.rake
+- tasks/gemspec.rake
+- tasks/spec.rake
+files: 
+- History.rdoc
+- Manifest
+- README.rdoc
+- Rakefile
+- examples/basic.rb
+- examples/timeout.rb
+- lib/thread-pool.rb
+- lib/thread-pool/pool.rb
+- lib/thread-pool/version.rb
+- spec/GEM_spec.rb
+- spec/spec_helper.rb
+- tasks/docs.rake
+- tasks/gemspec.rake
+- tasks/spec.rake
+- thread-pool.gemspec
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Thread-pool
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: thread-pool
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Multi-threaded Array subclass
+test_files: []
+