opee 1.0.1 → 1.0.2

data/README.md

@@ -24,9 +24,9 @@ Give it a try. Any comments, thoughts, or suggestions are welcome.
 
 ## <a name="release">Release Notes</a>
 
-### Release 1.0.1
+### Release 1.0.2
 
- - Fixed bug in Exception handling
+ - Added AskQueue which serves up method invocations instead of jobs.
 
 # Plans and Notes
 

data/lib/opee.rb

@@ -6,6 +6,8 @@ require 'opee/errors'
 require 'opee/env'
 require 'opee/actor'
 require 'opee/log'
+require 'opee/queue'
 require 'opee/workqueue'
+require 'opee/askqueue'
 require 'opee/job'
 require 'opee/collector'

data/lib/opee/actor.rb

@@ -158,7 +158,7 @@ module Opee
     # @param [Array] args arguments to the op method
     # @param [Proc] blk ignored
     def method_missing(m, *args, &blk)
-      raise NoMethodError.new("undefine method '#{m}' for #{self.class}", m, args) unless respond_to?(m, true)
+      raise NoMethodError.new("undefined method '#{m}' for #{self.class}", m, args) unless respond_to?(m, true)
       ask(m, *args)
     end
 

data/lib/opee/askqueue.rb

@@ -0,0 +1,29 @@
+
+module Opee
+  # Implements a work queue Actor that will distribute method calls to Actors
+  # that volunteer to execute those methods. The primary use is to distribute
+  # work across multiple workers.
+  class AskQueue < Queue
+
+    def initialize(options={})
+      super(options)
+    end
+
+    # Queues an operation and arguments to be handed off to a worker when the worker is ready.
+    # @param [Symbol] op method to queue for the Actor
+    # @param [Array] args arguments to the op method
+    # @raise [BusyError] if the request queue does not become available in the {#ask_timeout} seconds
+    def add_method(op, *args)
+      ask(:add, Act.new(op, args))
+    end
+
+    private
+
+    # Asks the worker to invoke the method of an Act Object.
+    def ask_worker(worker, job)
+      raise NoMethodError.new("undefined method for #{job.class}. Expected a method invocation") unless job.is_a?(Actor::Act)
+      worker.ask(job.op, *job.args)
+    end
+
+  end # AskQueue
+end # Opee

data/lib/opee/env.rb

@@ -120,7 +120,6 @@ module Opee
     # rescue() method is called.
     # @param [Exception] ex Exception to handle
     def self.rescue(ex)
-      puts "*** rescue"
       begin
         log_rescue(ex)
         @@rescuer.rescue(ex) unless @@rescuer.nil?

data/lib/opee/queue.rb

@@ -0,0 +1,94 @@
+
+module Opee
+  # Implements a queue Actor that will distribute jobs to Actors that
+  # volunteer to complete those jobs. The primary use is to distribute work or
+  # jobs across multiple workers.
+  class Queue < Actor
+
+    def initialize(options={})
+      @workers = []
+      @work_queue = []
+      @max_job_count = 0
+      @job_timeout = 3.0
+      @add_thread = nil
+      super(options)
+    end
+
+    # Returns the number of jobs currently on the work queue.
+    # @return [Fixnum] number of waiting jobs
+    def work_queue_size()
+      @work_queue.size
+    end
+
+    # Returns the number of worker Actors waiting to process jobs.
+    # @return [Fixnum] number of waiting workers
+    def worker_count()
+      @workers.size
+    end
+
+    # Returns the true if any requests are queued, a request is being
+    # processed, or if there are jobs waiting on the work request queue.
+    # @return [true|false] true if busy, false otherwise
+    def busy?
+      !@work_queue.empty? || super
+    end
+
+    # Verifies that additional jobs can be added to the work queue before
+    # allowing an {#add}() to be called.
+    # @see Actor#ask
+    def ask(op, *args)
+      if :add == op && 0 < @max_job_count && (@work_queue.size() + @queue.size()) >= @max_job_count
+        unless 0.0 >= @job_timeout
+          @add_thread = Thread.current
+          give_up_at = Time.now + @job_timeout
+          until Time.now > give_up_at || (@work_queue.size() + @queue.size()) < @max_job_count
+            sleep(@job_timeout)
+          end
+          @add_thread = nil
+        end
+        raise BusyError.new() unless @work_queue.size() < @max_job_count
+      end
+      super
+    end
+
+    private
+
+    # Processes the initialize() options. Subclasses should call super.
+    # @param [Hash] options options to be used for initialization
+    # @option options [Symbol] :method method to call on workers
+    # @option options [Fixnum] :max_job_count maximum number of jobs
+    #         that can be queued before backpressure is applied to the caller.
+    # @option options [Float] :job_timeout timeout in seconds to wait
+    #         before raising a BusyError if the work queue is too long.
+    def set_options(options)
+      super(options)
+      @max_job_count = options.fetch(:max_job_count, @max_job_count)
+      @job_timeout = options.fetch(:job_timeout, @job_timeout)
+    end
+
+    # Places a job on the work queue. This method is executed asynchronously.
+    # @param [Object] job work to be processed
+    def add(job)
+      if @workers.empty?
+        @work_queue.insert(0, job)
+      else
+        worker = @workers.pop()
+        ask_worker(worker, job)
+      end
+    end
+
+    # Identifies a worker as available to process jobs when they become
+    # available. This method is executed asynchronously.
+    # @param [Actor] worker Actor that responds to the {#method}
+    def ready(worker)
+      if @work_queue.empty?
+        @workers.insert(0, worker) unless @workers.include?(worker)
+      else
+        job = @work_queue.pop()
+        @add_thread.wakeup() unless @add_thread.nil?
+        ask_worker(worker, job)
+      end
+    end
+
+  end # Queue
+end # Opee

data/lib/opee/version.rb

@@ -1,5 +1,5 @@
 
 module Opee
   # Current version of the module. 
-  VERSION = '1.0.1'
+  VERSION = '1.0.2'
 end

data/lib/opee/workqueue.rb

@@ -1,26 +1,15 @@
 
 module Opee
-  # Implements a work queue Actor that ill distribute jobs to Actors that
+  # Implements a work queue Actor that will distribute jobs to Actors that
   # volunteer to complete those jobs. The primary use is to distribute work or
   # jobs across multiple workers.
-  class WorkQueue < Actor
+  class WorkQueue < Queue
 
     def initialize(options={})
-      @workers = []
-      @work_queue = []
       @method = nil
-      @max_job_count = 0
-      @job_timeout = 3.0
-      @add_thread = nil
       super(options)
     end
 
-    # Returns the number of jobs currently on the work queue.
-    # @return [Fixnum] number of waiting jobs
-    def work_queue_size()
-      @work_queue.size
-    end
-
     # Returns the number of worker Actors waiting to process jobs.
     # @return [Fixnum] number of waiting workers
     def worker_count()
@@ -33,69 +22,19 @@ module Opee
       @workers.size
     end
 
-    # Returns the true if any requests are queued, a request is being
-    # processed, or if there are jobs waiting on the work request queue.
-    # @return [true|false] true if busy, false otherwise
-    def busy?
-      !@work_queue.empty? || super
-    end
-
-    # Verifies that additional jobs can be added to the work queue before
-    # allowing an {#add}() to be called.
-    # @see Actor#ask
-    def ask(op, *args)
-      if :add == op && 0 < @max_job_count && (@work_queue.size() + @queue.size()) >= @max_job_count
-        unless 0.0 >= @job_timeout
-          @add_thread = Thread.current
-          give_up_at = Time.now + @job_timeout
-          until Time.now > give_up_at || (@work_queue.size() + @queue.size()) < @max_job_count
-            sleep(@job_timeout)
-          end
-          @add_thread = nil
-        end
-        raise BusyError.new() unless @work_queue.size() < @max_job_count
-      end
-      super
-    end
-
     private
 
     # Processes the initialize() options. Subclasses should call super.
     # @param [Hash] options options to be used for initialization
     # @option options [Symbol] :method method to call on workers
-    # @option options [Fixnum] :max_job_count maximum number of jobs
-    #         that can be queued before backpressure is applied to the caller.
-    # @option options [Float] :job_timeout timeout in seconds to wait
-    #         before raising a BusyError if the work queue is too long.
     def set_options(options)
       super(options)
       raise MissingOptionError.new(:method, "for processing jobs") if (@method = options[:method]).nil?
-      @max_job_count = options.fetch(:max_job_count, @max_job_count)
-      @job_timeout = options.fetch(:job_timeout, @job_timeout)
-    end
-
-    # Places a job on the work queue. This method is executed asynchronously.
-    # @param [Object] job work to be processed
-    def add(job)
-      if @workers.empty?
-        @work_queue.insert(0, job)
-      else
-        worker = @workers.pop()
-        worker.ask(@method, job)
-      end
     end
 
-    # Identifies a worker as available to process jobs when they become
-    # available. This method is executed asynchronously.
-    # @param [Actor] worker Actor that responds to the {#method}
-    def ready(worker)
-      if @work_queue.empty?
-        @workers.insert(0, worker) unless @workers.include?(worker)
-      else
-        job = @work_queue.pop()
-        @add_thread.wakeup() unless @add_thread.nil?
-        worker.ask(@method, job)
-      end
+    # Asks the worker to invoke the default method on a job.
+    def ask_worker(worker, job)
+      worker.ask(@method, job)
     end
 
   end # WorkQueue

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: opee
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-18 00:00:00.000000000 Z
+date: 2012-05-29 00:00:00.000000000 Z
 dependencies: []
 description: ! 'An experimental Object-base Parallel Evaluation Environment. '
 email: peter@ohler.com
@@ -19,11 +19,13 @@ extra_rdoc_files:
 - README.md
 files:
 - lib/opee/actor.rb
+- lib/opee/askqueue.rb
 - lib/opee/collector.rb
 - lib/opee/env.rb
 - lib/opee/errors.rb
 - lib/opee/job.rb
 - lib/opee/log.rb
+- lib/opee/queue.rb
 - lib/opee/version.rb
 - lib/opee/workqueue.rb
 - lib/opee.rb
@@ -33,7 +35,6 @@ files:
 - test/tc_opee_env.rb
 - test/tc_opee_log.rb
 - test/tc_opee_workqueue.rb
-- test/tests.rb
 - test/ts_opee.rb
 - LICENSE
 - README.md

data/test/tests.rb

@@ -1,40 +0,0 @@
-#!/usr/bin/env ruby -wW1
-# encoding: UTF-8
-
-$: << File.join(File.dirname(__FILE__), "../lib")
-
-require 'test/unit'
-require 'opee'
-require 'relay'
-
-class Opeet < ::Test::Unit::TestCase
-
-  def test_ask_queue
-    a = ::Relay.new(nil)
-    assert_equal(0, a.queue_count())
-    a.stop()
-    a.ask(:relay, 7)
-    assert_equal(1, a.queue_count())
-    a.start()
-    sleep(0.5)
-    assert_equal(7, a.last_data)
-    a.close()
-  end
-
-  def test_log
-    #::Opee::Env.logger.ask(:severity=, Logger::INFO)
-    ::Opee::Env.logger.severity= Logger::INFO
-    ::Opee::Env.log(Logger::INFO, "hello")
-    ::Opee::Env.each_actor { |a| puts a.to_s }
-    sleep(0.2)
-  end
-
-  def test_wait_close
-    a = ::Relay.new(nil)
-    a.ask(:relay, 7)
-    ::Opee::Env.wait_close()
-    assert_equal(7, a.last_data)
-    a.close()
-  end
-
-end # Opeet