async_emitter 1.0.0 → 1.1.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    OGI1OGE0ZDUzZTIwN2JiMmFmMWY5N2VhNDVlYWRjM2NjOTIwNGVjOQ==
+    YTYyM2Y2ZWRhY2I3MTUyMzY0YTAxYzAxZTY2ZjhhNDQ5OTQwYzA3NQ==
   data.tar.gz: !binary |-
-    NzFlMzk0NzAxNjJiZWQxNWI1ZDI3Y2MxNDRjMDQ1MDUzNDA4YzNjZQ==
+    ZjNhMmM1ZjliZTM5ZWY3Y2FiNWNhMTRiMmNhYmUxNzY4MTdiNTdlOQ==
 SHA512:
   metadata.gz: !binary |-
-    ZTRmNTJkOTBjMTRmYmJlYjIyZmRkM2Y4NzBmYjRiMmE0OWMwMmMzZWQ2NTRj
-    YjI0OGMwM2MyODgyOTA5NGIyNjU5Yjk5MTY3OTllNTJiZjI4NWVhZTA5NDlm
-    MmI2ZjMzMTY1MmVjNTRhYmU5NzJkMzlkMWNlOGU1NmQ1YzA1OGI=
+    Njg5MDFjMjI0YTk0Y2NkOGI3YTk1ZjdiZmY4ZGZlMTkwNDhjMjZkYjViOTJh
+    ZDIyNjRkNjY3OThmMjc2ODJiZWYxMjU2OGVmMjQ0OTJhZWQyMjAzZDkzNmNm
+    M2YzYTdiMTIxZTUxNGQ5OGFlNjc3MmUwZDYyMzA5ZDdiNTk1ZmI=
   data.tar.gz: !binary |-
-    OGVjMTJmYjc0MjYxZDdhMzMzYjU3NzkxMjU3OTQ2YmUyMTU2YjkyYmVmZTgw
-    MDcyMmNkZTUwNjdhNTIyMGM0ZmM1MDk3YzQ2ZmViMjQwYjAzOGNjMDU1MjY1
-    N2YwZjkxM2EzMzJkMWUwOWI4OTAwY2M5MzkxMjllYWU0Y2Q2YTc=
+    YzA0MzQzYzkyZmIyODBiYjFkYzZjY2ExNTkwYjg5M2YyZmY2M2IyMDIyZjYz
+    YjRiNzBmMjg1MTAzYTZiOWNkNWJhYjYyNWFlMjdmN2UzZjk5OTgzOTkyYWE2
+    OGU5ZjI0ZmJkMTdkMDQzNzg2YmI4YWEyMWQxNjIzM2M1MDk1MTU=

data/lib/async_emitter.rb

@@ -1,40 +1,42 @@
 require 'thread'
 
-class AsyncEmitter
-=begin
-	The AsyncEmitter class provides a mechanism for asyncronous communication
-	in Ruby programs. Each instantiation provides notification of events
-	registered using any object that is valid as a Hash key. Multiple
-	events can be registered for each key and listeners can be registered 
-	for one or many events. Listeners for a key event can be released.
-
-	example:
-	emitter = AsyncEmitter.new
-	emitter.on :error, lambda { |e| puts "Error: #{e}" }
-	emitter.on :data, lambda { |data| puts "Data: #{data}" }
-
-	begin
-		data = get_data_from_somewhere
-		emitter.emit :data, data
-	rescue Exception => e
-		emitter.emit :error, e
-	end
-
-	Where more then one listener is registered for an event they are
-	notified in the order they are recieved.
-=end
+####################################################################################
+# The AsyncEmitter class provides a mechanism for asyncronous communication
+# in Ruby programs. Each instantiation provides notification of events
+# registered using any object that is valid as a Hash key. Multiple
+# events can be registered for each key and listeners can be registered 
+# for one or many events. Listeners for a key event can be released.
+#
+# @example
+#	emitter = AsyncEmitter.new
+#	emitter.on :error, lambda { |e| puts "Error: #{e}" }
+#	emitter.on :data, lambda { |data| puts "Data: #{data}" }
+#
+#	begin
+#		data = get_data_from_somewhere
+#		emitter.emit :data, data
+#	rescue Exception => e
+#		emitter.emit :error, e
+#	end
+#
+# Where more then one listener is registered for an event they are
+# notified in the order they are recieved.
+#
+# @author Greg Martin
+####################################################################################
 
+class AsyncEmitter
 	def initialize
 		@emissions = {}
 	end
 
-
 	########################################################################
 	# Register for notification
 	#
-	# token - any valid Hash key representing the event
-	# p - a procedure to be called on notification
-	# once_only - if true the notification is removed after being fired once
+	# @param token [Object] any valid Hash key representing the event
+	# @param p [Proc] a procedure to be called on notification
+	# @param once_only [Boolean] defualts to false,  if true the notification 
+	# 	is removed after being fired once
 	# ######################################################################
 	def on (token, p, once_only=false)
 		@emissions[token] ||= {}
@@ -67,13 +69,20 @@ class AsyncEmitter
 	# Register for single notification - convenience and self documenting
 	# method  for: on token, proc, true
 	#
-	# token - any valid Hash key representing the event
-	# p - a procedure to be called on notification
+	# @param token [Object] any valid Hash key representing the event
+	# @param p [Proc] a procedure to be called on notification
 	# ######################################################################
 	def once (token, p)
 		self.on token, p, true
 	end
 
+
+	#######################################################################
+	# Send notification of an event
+	#
+	# @param token [Object] the Hash key representing the event
+	# @param data [Object] argument to be passed to the events procedure
+	# #####################################################################
 	def emit (token, data)
 		@emissions[token][:semaphore] ||= Mutex.new
 		@emissions[token][:cv] ||= ConditionVariable.new 
@@ -90,13 +99,23 @@ class AsyncEmitter
 	########################################################################
 	# Remove notification for an event
 	#
-	# token - Hash key representing the event
+	# @param token [Object] Hash key representing the event
 	########################################################################
 	def release (token)
 		@emissions[token][:active] = false
 		Thread.kill @emissions[token][:thread]
 	end
 
+	########################################################################
+	# Remove all notifications
+	########################################################################
+	def release_all 
+		@emissions.each do |key, value|
+			value[:active] = false
+			Thread.kill value[:thread]
+		end
+	end
+
 	protected
 	def post_data_for (token)
 		@emissions[token][:p].each_index do |i|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: async_emitter
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Greg Martin