async 0.16.0 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b09ff3d20b66fd1a908bbf44ba04e10fb6b633cf
-  data.tar.gz: 287bc69ce12fb51c1b1412749ed3fe62473a6673
+  metadata.gz: a53fcaec5de211edad59be553e0a79428a6033f6
+  data.tar.gz: a3f0c6e234ba5b7e0d31d83e3c4e2d866a9118ed
 SHA512:
-  metadata.gz: e3eee05641978320874385017b666d4e7daf02ebc2bfa22ce8eeab6ece962322a645b1e8d6896dc744ef1a428ba48f6f633ad27335dc7573c570ba97ee89bdbb
-  data.tar.gz: 50f17f1f2213b2afeeb5c0bfe63ed6aae31e98b81d45f9f6bacb1f752808278456ed9e7f19d928d9c7ab459f8ec3f78e638c5bf97a222dee078e6b3fddc0a196
+  metadata.gz: 5d3e0bbe7877ef2db58d51d078cfe1c66c93fffa1bcc41d3208766b3b28c48488274e5a3df7d393d982e214a08cfd1d7cf749ad4f939caf217c50c5418782ff8
+  data.tar.gz: f3781101e3f0fd51de46d2a4fa9e97369ac88afb4eb0c115d7aaa48f10f7e032309067e0267f55210c07f3ff28d4cd71e368ac556bf886882012ecdfd7bb87fe

data/README.md

@@ -81,7 +81,7 @@ This method effectively creates a child task. It's the most efficient way to sch
 
 `Async::Reactor` and `Async::Task` form nodes in a tree. Reactors and tasks can spawn children tasks. When you invoke `Async::Reactor#async`, the parent task is determined by calling `Async::Task.current?` which uses fiber local storage. A slightly more efficient method is to use `Async::Task#async`, which uses `self` as the parent task.
 
-When invoking `Async::Reactor#stop`, you will stop *all* children tasks of that reactor. Tasks will raise `Async::Interrupt` if they are in a blocking operation. In addition, it's possible to only stop a sub-tree by issuing `Async::Task#stop`, which will stop that task and all it's children (recursively). When you design a server, you should return the task back to the caller. They can use this task to stop the server if needed, independently of any other unrelated tasks within the reactor, and it will correctly clean up all related tasks.
+When invoking `Async::Reactor#stop`, you will stop *all* children tasks of that reactor. Tasks will raise `Async::Stop` if they are in a blocking operation. In addition, it's possible to only stop a sub-tree by issuing `Async::Task#stop`, which will stop that task and all it's children (recursively). When you design a server, you should return the task back to the caller. They can use this task to stop the server if needed, independently of any other unrelated tasks within the reactor, and it will correctly clean up all related tasks.
 
 ### Resource Management
 
@@ -90,10 +90,10 @@ In order to ensure your resources are cleaned up correctly, make sure you wrap r
 ```ruby
 Async::Reactor.run do
 	begin
-		socket = connect(remote_address) # May raise Async::Interrupt so socket could be nil
+		socket = connect(remote_address) # May raise Async::Stop so socket could be nil
 		
-		socket.write(...) # May raise Async::Interrupt
-		socket.read(...) # May raise Async::Interrupt
+		socket.write(...) # May raise Async::Stop
+		socket.read(...) # May raise Async::Stop
 	ensure
 		socket.close if socket
 	end

data/lib/async/task.rb

@@ -26,7 +26,7 @@ require_relative 'condition'
 
 module Async
 	# Raised when a task is explicitly stopped.
-	class Interrupt < Exception
+	class Stop < Exception
 	end
 
 	# A task represents the state associated with the execution of an asynchronous
@@ -74,9 +74,9 @@ module Async
 					@result = yield(self, *args)
 					@status = :complete
 					# Async.logger.debug("Task #{self} completed normally.")
-				rescue Interrupt
-					@status = :interrupted
-					# Async.logger.debug("Task #{self} interrupted: #{$!}")
+				rescue Stop
+					@status = :stop
+					# Async.logger.debug("Task #{self} stopped: #{$!}")
 				rescue Exception => error
 					@result = error
 					@status = :failed
@@ -101,7 +101,7 @@ module Async
 		attr :fiber
 		def_delegators :@fiber, :alive?
 		
-		# @attr status [Symbol] The status of the execution of the fiber, one of `:running`, `:complete`, `:interrupted`, or `:failed`.
+		# @attr status [Symbol] The status of the execution of the fiber, one of `:running`, `:complete`, `:stopped`, or `:failed`.
 		attr :status
 		
 		# Resume the execution of the task.
@@ -144,8 +144,7 @@ module Async
 			@children.each(&:stop)
 			
 			if @fiber.alive?
-				exception = Interrupt.new("Stop right now!")
-				@fiber.resume(exception)
+				@fiber.resume(Stop.new)
 			end
 		end
 	

data/lib/async/version.rb

@@ -19,5 +19,5 @@
 # THE SOFTWARE.
 
 module Async
-	VERSION = "0.16.0"
+	VERSION = "0.17.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: async
 version: !ruby/object:Gem::Version
-  version: 0.16.0
+  version: 0.17.0
 platform: ruby
 authors:
 - Samuel Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-15 00:00:00.000000000 Z
+date: 2017-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nio4r