support for custom exception classes

Author: runa

lib/system_timer.rb

@@ -40,10 +40,10 @@ class << self
     # Executes the method's block. If the block execution terminates before 
     # +seconds+ seconds has passed, it returns true. If not, it terminates 
     # the execution and raises a +Timeout::Error+.
-    def timeout_after(seconds)
+    def timeout_after(seconds, exception_class = nil)
       new_timer = nil                                      # just for scope
       @mutex.synchronize do
-        new_timer = timer_pool.add_timer seconds
+        new_timer = timer_pool.add_timer seconds, exception_class
         timer_interval = timer_pool.next_trigger_interval_in_seconds
         debug "==== Install Timer ==== at #{Time.now.to_i}, next interval: #{timer_interval}"
         if timer_pool.first_timer?
@@ -104,4 +104,4 @@ def debug(message)    #:nodoc
 
 end
 
-require 'system_timer_native'
+require 'system_timer_native'

lib/system_timer/concurrent_timer_pool.rb

@@ -8,14 +8,14 @@ def registered_timers
       @timers ||= []
     end
 
-    def register_timer(trigger_time, thread)
-      new_timer = ThreadTimer.new(trigger_time, thread)
+    def register_timer(trigger_time, thread, exception_class=nil)
+      new_timer = ThreadTimer.new(trigger_time, thread, exception_class)
       registered_timers << new_timer
       new_timer
     end
 
-    def add_timer(interval_in_seconds)
-      new_timer = register_timer(Time.now.to_i + interval_in_seconds, Thread.current)
+    def add_timer(interval_in_seconds, exception_class=nil)
+      new_timer = register_timer(Time.now.to_i + interval_in_seconds, Thread.current, exception_class)
       log_registered_timers if SystemTimer.debug_enabled?
       new_timer
     end
@@ -55,7 +55,7 @@ def trigger_next_expired_timer_at(now_in_seconds_since_epoch)
 
       cancel timer
       log_timeout_received(timer) if SystemTimer.debug_enabled?
-      timer.thread.raise Timeout::Error.new("time's up!")
+      timer.thread.raise timer.exception_class.new("time's up!")
     end
 
     def trigger_next_expired_timer
@@ -80,4 +80,4 @@ def log_registered_timers          #:nodoc:
 
   end
 
-end
+end

lib/system_timer/thread_timer.rb

@@ -6,15 +6,16 @@ module SystemTimer
   # from a Ruby signal handler and Ruby signals are always delivered to 
   # main thread.
   class ThreadTimer
-    attr_reader :trigger_time, :thread
+    attr_reader :trigger_time, :thread, :exception_class
 
-    def initialize(trigger_time, thread)
+    def initialize(trigger_time, thread, exception_class = nil)
       @trigger_time = trigger_time
       @thread = thread
+	  @exception_class = exception_class || Timeout::Error
     end
 
     def to_s
-      "<ThreadTimer :time => #{trigger_time}, :thread => #{thread}>"
+      "<ThreadTimer :time => #{trigger_time}, :thread => #{thread}, :exception_class => #{exception_class}>"
     end
 
   end

test/system_timer/concurrent_timer_pool_unit_test.rb

@@ -25,7 +25,7 @@
     now = Time.now
     Time.stubs(:now).returns(now)
 
-    pool.expects(:register_timer).with(now.to_i + 15, :the_current_thread)
+    pool.expects(:register_timer).with(now.to_i + 15, :the_current_thread, nil)
     pool.add_timer 15
   end
 

test/system_timer/thread_timer_test.rb

@@ -13,7 +13,7 @@
   end
 
   test "to_s retruns a human friendly description of the timer" do
-    assert_match /<ThreadTimer :time => 24, :thread => #<Thread(.*)>>/, 
+    assert_match /<ThreadTimer :time => 24, :thread => #<Thread(.*)>, :exception_class => Timeout::Error>/, 
                  SystemTimer::ThreadTimer.new(24, Thread.current).to_s                 
   end
 

test/system_timer_unit_test.rb

@@ -9,7 +9,7 @@
     SystemTimer.stubs(:install_next_timer)
     SystemTimer.stubs(:restore_original_configuration)
 
-    pool.expects(:add_timer).with(5).returns(stub_everything)
+    pool.expects(:add_timer).with(5,nil).returns(stub_everything)
     SystemTimer.timeout_after(5) {}    
   end
 
@@ -93,4 +93,4 @@
    end   
  end
 
-end
+end