event_timer 1.0.0 → 1.0.1

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MDhhZDAyNjZiNjEwOWEzZTg1YjEwOGEzYjQ1MTNhMmQ2NTM5YjBlYQ==
+    MmFjMmE3ZGRiZTY1MTFjZjUzNjI0MzkxNDcwYTNkNzRmZDUyYjIwMQ==
   data.tar.gz: !binary |-
-    OGY2NDRiMmZkZWViMTlhZmE0ZGEwN2E1NjY3YmQyYTU5Mzk0YTVkZg==
+    ZWZkNTQyODQyM2RhMTgwOWVjNmQwNjhhMjMwOTY3NDYzY2E1MjEyMA==
 SHA512:
   metadata.gz: !binary |-
-    ZTRlMmVjN2ZkNTcwMzcyMmMxNDdkYzY1ZDE1OGU5NWMxMTk2MThiMTA5YzE3
-    NzUxNmUyZGJkMzFmZjc5NDQ5ZmYxNGEwZWExZjUzMmU3ZjgzOWVlYWFmZmI5
-    MmQ0ODFhOTE2NjIyOGQ2NDU5NGRjOTEyYTI3MGZjODVlNzc4Y2I=
+    ZGM2YWRhMWU4NTc2ZDU0Y2U2OTU0NjA0MjYxZDJiZDE1MTk3MDc3ZDc2MDM1
+    MmMxNTYwMjRmZGQ2Zjk1NmE0M2M2OTU2MDM2N2JjNzVmMDIzNDJjZjBmYTc2
+    YzIwOGQ0NTJiN2ViN2VjNDJiOWM1OTY1YTY1NWUyMWRjMWJjODM=
   data.tar.gz: !binary |-
-    ODhlYzYyMTQ3YmZhM2VjZjM2MzA3ZDE1ZTJjNzkyYTJlNTVmOTE2Nzc2Mzc2
-    NDYyMzNmYTg4ZDRhNDU4Yzg1NGY2ZjFkZjk3Y2UwYzE0Zjg4YzkwYTBiN2Yz
-    MjNkZTU4MzU2YmJlMTA3MjY2NzY1NzJiNThjM2IyYTg0MjRhNzQ=
+    Y2YyYTdhYTYzOGEwMGYyYjUxOWRiNjQ5MmQxN2U1YjdiYmNkMjUwZjg1NTc0
+    YTQyMGIwNmZjYTE3NzU1ZDhlZjZjZDE5M2IzNDIyODFiYmIwZWU5MTJhMTc2
+    YTFkYjE2MWNjNTAxOTE2NDZjODRhNjA2MDNiOTVmNzUzZDg1NmM=

data/lib/event_timer.rb

@@ -1,30 +1,74 @@
 require 'ready_pool'
 require 'async_emitter'
-
+####################################################################################
+# An event timer with second granularity. It inherits from AsyncEmitter and events are 
+# captured using the AsyncEmitter methods on and once.
+# ==Example
+# 
+#    require 'event_timer'
+#    
+#    timer = EventTimer.new 4
+#    
+#    timer.on :one, lambda { |data| puts "#{data}" }
+#    timer.on :two, lambda { |data| puts "#{data}" }
+#    timer.on :three, lambda { |data| puts "#{data}" }
+#    timer.on :four, lambda { |data| puts "#{data}" }
+#    
+#    timer.start :one, 1, 1
+#    timer.start :two, 2, 2
+#    timer.start :three, 3, 3
+#    timer.start :four, 4, 4
+#    timer.cancel :four
+#    
+#    gets
+#    
+# @author Greg Martin
+###################################################################################
 class EventTimer < AsyncEmitter
+
+	###########################################################################
+	# constructor - prepares a ReadyPool for the timers. Timers can be added as 
+	# needed bu it is more efficient to add them in the constructor
+	#
+	# @param num_timers [FixedNum] the number of timers expected
+	##########################################################################
 	def initialize (num_timers)
 		super()
 		@pool = ReadyPool.new num_timers, lambda { |args| timer_proc args }
 		@th_args = {}
 	end
 
+	##########################################################################
+	# Start a timer running
+	#
+	# @param event [Object] the emitter event - and valid hash key
+	# @param time [FixedNum] the number pf seconds until the event
+	# @param data [Object] data passed to the timer function
+	##########################################################################
 	def start (event, time, data)
 		args = {
 			:event => event,
 			:time => time,
 			:data => data,
 			:cancel => false,
-			:mutex => Mutex.new
+			:mutex => Mutex.new,
+			:thread => nil
 		}
 	
 		@th_args[args[:event]] = args
 			
-		@pool.start args
+		@th_args[args[:event]][:thread] = @pool.start args
 	end
 
+	##########################################################################
+	# Cancel an event
+	#
+	# @param event [Object] the emitter event - and valid hash key
+	##########################################################################
 	def cancel (event)
 		@th_args[event][:mutex].synchronize do
 			@th_args[event][:cancel] = true
+			@th_args[event][:thread].run
 		end
 	end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: event_timer
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Greg Martin
@@ -39,7 +39,7 @@ dependencies:
         version: '1.1'
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 1.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -49,7 +49,7 @@ dependencies:
         version: '1.1'
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 1.1.1
 description: An event timer for Ruby
 email: greg@softsprocket.com
 executables: []