tribe 0.0.11 → 0.1.0

data/Gemfile.lock

@@ -2,12 +2,12 @@ PATH
   remote: .
   specs:
     tribe (0.0.11)
-      workers (= 0.0.8)
+      workers (= 0.1.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    workers (0.0.8)
+    workers (0.1.1)
 
 PLATFORMS
   java

data/README.md

@@ -90,6 +90,43 @@ In general you shouldn't have to create your own since there is a global one (Tr
       :name => nil                      # The name of the actor (must be unique in the registry).
     )
 
+## Timers
+
+Actors can create timers to perform some work in the future.
+Both one-shot and periodic timers are provides.
+
+    class MyActor < Tribe::Actor
+      private
+      def initialize(options = {})
+        super
+
+        timer(1, :timer, Time.now)
+        periodic_timer(1, :periodic_timer, Time.now)
+      end
+
+      def on_timer(event)
+        puts "MyActor (#{identifier}) ONE-SHOT: #{event.data}"
+      end
+
+      def on_periodic_timer(event)
+        puts "MyActor (#{identifier}) PERIODIC: #{event.data}"
+      end
+    end
+
+    # Create some named actors.
+    10.times do |i|
+      MyActor.new(:name => "my_actor_#{i}")
+    end
+
+    # Sleep in order to observe the timers.
+    sleep 10
+
+    # Shutdown the actors.
+    10.times do |i|
+      actor = Tribe.registry["my_actor_#{i}"]
+      actor.enqueue(:shutdown)
+    end
+
 ## TODO - missing features
 
 - Futures.

data/lib/tribe/actable.rb

@@ -7,6 +7,8 @@ module Tribe
       @dedicated = options[:dedicated] || false
       @mailbox = options[:mailbox] || Tribe::Mailbox.new
       @registry = options[:registry] || Tribe.registry
+      @scheduler = options[:scheduler] || Workers.scheduler
+      @timers = Tribe::SafeSet.new
       @name = options[:name]
       @pool = @dedicated ? Workers::Pool.new(:size => 1) : (options[:pool] || Workers.pool)
       @alive = true
@@ -71,14 +73,53 @@ module Tribe
     # Override and call super as necessary.
     def process_event(event)
       send("on_#{event.command}", event)
+
+      return nil
     end
 
     # Override and call super as necessary.
     def exception_handler(e)
+      return nil
     end
 
     # Override and call super as necessary.
     def shutdown_handler(event)
+      shutdown_timers
+
+      return nil
+    end
+
+    def shutdown_timers
+      @timers.each do |timer|
+        timer.cancel
+      end
+
+      return nil
+    end
+
+    def timer(delay, command, data = nil)
+      timer = Workers::Timer.new(delay, :scheduler => @scheduler) do
+        @timers.delete(timer)
+        enqueue(command, data)
+      end
+
+      @timers.add(timer)
+
+      return timer
+    end
+
+    def periodic_timer(delay, command, data = nil)
+      timer = Workers::PeriodicTimer.new(delay, :scheduler => @scheduler) do
+        enqueue(command, data)
+        unless alive?
+          @timers.delete(timer)
+          timer.cancel
+        end
+      end
+
+      @timers.add(timer)
+
+      return timer
     end
   end
 end

data/lib/tribe/safe_set.rb

@@ -0,0 +1,40 @@
+# Ruby's built in Set class may not be thread safe.
+# This class wraps each method to make it so.
+# More methods will be wrapped as needed.
+
+module Tribe
+  class SafeSet
+    def initialize
+      @mutex = Mutex.new
+      @set = Set.new
+
+      return nil
+    end
+
+    def add(item)
+      @mutex.synchronize do
+        @set.add(item)
+      end
+
+      return self
+    end
+
+    def delete(item)
+      @mutex.synchronize do
+        @set.delete(item)
+      end
+
+      return self
+    end
+
+    def each(&block)
+      @mutex.synchronize do
+        @set.each do |item|
+          yield(item)
+        end
+      end
+
+      return self
+    end
+  end
+end

data/lib/tribe/version.rb

@@ -1,3 +1,3 @@
 module Tribe
-  VERSION = '0.0.11'
+  VERSION = '0.1.0'
 end

data/lib/tribe.rb

@@ -1,5 +1,8 @@
+require 'set'
+
 require 'workers'
 
+require 'tribe/safe_set'
 require 'tribe/mailbox'
 require 'tribe/actable'
 require 'tribe/actor'

data/tribe.gemspec

@@ -15,5 +15,5 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = Tribe::VERSION
 
-  gem.add_dependency('workers', '0.0.8')
+  gem.add_dependency('workers', '0.1.1')
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tribe
 version: !ruby/object:Gem::Version
-  version: 0.0.11
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-16 00:00:00.000000000 Z
+date: 2013-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: workers
@@ -18,7 +18,7 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.0.8
+        version: 0.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.0.8
+        version: 0.1.1
 description: Tribe is a Ruby gem that implements event-driven actors.
 email:
 - chad@remesch.com
@@ -46,6 +46,7 @@ files:
 - lib/tribe/dedicated_actor.rb
 - lib/tribe/mailbox.rb
 - lib/tribe/registry.rb
+- lib/tribe/safe_set.rb
 - lib/tribe/version.rb
 - tribe.gemspec
 homepage: https://github.com/chadrem/tribe