async 0.9.1

data/lib/async/socket.rb

@@ -0,0 +1,51 @@
+# Copyright, 2017, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require_relative 'io'
+
+require 'socket'
+
+module Async
+	class BasicSocket < IO
+		wraps ::BasicSocket
+		
+		# We provide non-blocking send:
+		alias send sendmsg
+	end
+	
+	class Socket < BasicSocket
+		wraps ::Socket
+		
+		module Connect
+			def connect(*args)
+				begin
+					super
+				rescue Errno::EISCONN
+				end
+			end
+		end
+		
+		prepend Connect
+	end
+	
+	class IPSocket < BasicSocket
+		wraps ::IPSocket
+	end
+end

data/lib/async/ssl_socket.rb

@@ -0,0 +1,30 @@
+# Copyright, 2017, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require_relative 'io'
+
+require 'openssl'
+
+module Async
+	# This might be better in a nested module?
+	class SSLSocket < IO
+		wraps OpenSSL::SSL::SSLSocket
+	end
+end

data/lib/async/task.rb

@@ -0,0 +1,102 @@
+# Copyright, 2017, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require 'fiber'
+require 'forwardable'
+
+module Async
+	class Interrupt < Exception
+	end
+	
+	class Task
+		extend Forwardable
+		
+		def initialize(ios, reactor, &block)
+			@ios = Hash[
+				ios.collect{|io| [io.fileno, reactor.wrap(io, self)]}
+			]
+			
+			@reactor = reactor
+			
+			@fiber = Fiber.new do
+				set!
+				
+				begin
+					yield(*@ios.values, self)
+					# Async.logger.debug("Task #{self} completed normally.")
+				rescue Interrupt
+					# Async.logger.debug("Task #{self} interrupted: #{$!}")
+				ensure
+					close
+				end
+			end
+		end
+		
+		def_delegators :@reactor, :timeout, :sleep
+		
+		def run
+			@fiber.resume
+				
+			return @fiber
+		end
+		
+		def stop!
+			if @fiber.alive?
+				exception = Interrupt.new("Stop right now!")
+				@fiber.resume(exception)
+			end
+		end
+		
+		attr :ios
+		attr :reactor
+		
+		def with(io)
+			wrapper = @reactor.wrap(io, self)
+			
+			yield wrapper
+		ensure
+			wrapper.close
+			io.close
+		end
+		
+		def bind(io)
+			@ios[io.fileno] ||= reactor.wrap(io, self)
+		end
+		
+		def register(io, interests)
+			@reactor.register(io, interests)
+		end
+		
+		def self.current
+			Thread.current[:async_task] or raise RuntimeError, "No async task available!"
+		end
+		
+		private
+		
+		def close
+			@ios.each_value(&:close)
+		end
+		
+		def set!
+			# This is actually fiber-local:
+			Thread.current[:async_task] = self
+		end
+	end
+end

data/lib/async/tcp_socket.rb

@@ -0,0 +1,54 @@
+# Copyright, 2017, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require_relative 'socket'
+
+module Async
+	# Asynchronous TCP socket/client.
+	class TCPSocket < IPSocket
+		wraps ::TCPSocket
+		
+		def self.connect(remote_address, remote_port, local_address = nil, local_port = nil, task: Task.current, &block)
+			# This may block if remote_address is a hostname
+			remote = Addrinfo.tcp(remote_address, remote_port)
+			
+			socket = ::Socket.new(remote.afamily, ::Socket::SOCK_STREAM, 0)
+			socket.bind Addrinfo.tcp(local_address, local_port) if local_address
+			
+			if block_given?
+				task.with(socket) do |wrapper|
+					wrapper.connect(remote.to_sockaddr)
+					
+					yield wrapper
+				end
+			else
+				task.bind(socket).connect(remote.to_sockaddr)
+				
+				return socket
+			end
+		end
+	end
+	
+	# Asynchronous TCP server
+	class TCPServer < TCPSocket
+		wraps ::TCPServer
+	end
+end
+

data/lib/async/udp_socket.rb

@@ -0,0 +1,30 @@
+# Copyright, 2017, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require_relative 'socket'
+
+module Async
+	# Asynchronous UDP socket.
+	class UDPSocket < IPSocket
+		# We pass `send` through directly, but in theory it might block. Internally, it uses sendto.
+		wraps ::UDPSocket, :send
+	end
+end
+

data/lib/async/unix_socket.rb

@@ -0,0 +1,27 @@
+# Copyright, 2017, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require_relative 'socket'
+
+module Async
+	module UNIXSocket < BasicSocket
+		wraps ::UNIXSocket
+	end
+end

data/lib/async/version.rb

@@ -0,0 +1,23 @@
+# Copyright, 2017, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+module Async
+	VERSION = "0.9.1"
+end

data/lib/async/wrapper.rb

@@ -0,0 +1,71 @@
+# Copyright, 2017, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+module Async
+	# Represents an asynchronous IO within a reactor.
+	class Wrapper
+		def initialize(io, task)
+			@io = io
+			@task = task
+			@monitor = nil
+		end
+		
+		attr :io
+		attr :task
+		
+		def monitor(interests)
+			unless @monitor
+				@monitor = @task.register(@io, interests)
+			else
+				@monitor.interests = interests
+			end
+			
+			@monitor.value = Fiber.current
+			
+			yield
+			
+		ensure
+			@monitor.value = nil if @monitor
+		end
+		
+		def wait_readable
+			wait_any(:r)
+		end
+		
+		def wait_writable
+			wait_any(:w)
+		end
+		
+		def wait_any(interests = :rw)
+			monitor(interests) do
+				# Async.logger.debug "Fiber #{Fiber.current} yielding..."
+				result = Fiber.yield
+				
+				# Async.logger.debug "Fiber #{Fiber.current} resuming with result #{result}..."
+				raise result if result.is_a? Exception
+			end
+		end
+		
+		def close
+			@monitor.close if @monitor
+			@monitor = nil
+		end
+	end
+end

data/spec/async/reactor_spec.rb

@@ -0,0 +1,173 @@
+# Copyright, 2017, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+RSpec.describe Async::Reactor do
+	# Shared port for localhost network tests.
+	let(:port) {6778}
+	
+	it "can run asynchronously" do
+		outer_fiber = Fiber.current
+		inner_fiber = nil
+		
+		described_class.run do
+			inner_fiber = Fiber.current
+		end
+		
+		expect(outer_fiber).not_to be == inner_fiber
+	end
+	
+	it "can be stopped" do
+		state = nil
+		
+		subject.async do |task|
+			state = :started
+			task.sleep(10)
+			state = :stopped
+		end
+		
+		subject.stop
+		
+		expect(state).to be == :started
+	end
+	
+	describe 'basic tcp server' do
+		include_context "reactor"
+		
+		# These may block:
+		let(:server) {TCPServer.new("localhost", port)}
+		let(:client) {TCPSocket.new("localhost", port)}
+		
+		let(:data) {"The quick brown fox jumped over the lazy dog."}
+		
+		after(:each) do
+			server.close
+		end
+		
+		it "should start server and send data" do
+			subject.async(server) do |server, task|
+				task.with(server.accept) do |peer|
+					peer.write(peer.read(512))
+				end
+			end
+			
+			subject.with(client) do |client|
+				client.write(data)
+				
+				expect(client.read(512)).to be == data
+			end
+			
+			subject.run
+			
+			expect(client).to be_closed
+		end
+	end
+	
+	describe 'non-blocking tcp connect' do
+		include_context "reactor"
+		
+		# These may block:
+		let(:server) {TCPServer.new("localhost", port)}
+		
+		let(:data) {"The quick brown fox jumped over the lazy dog."}
+		
+		after(:each) do
+			server.close
+		end
+		
+		it "should start server and send data" do
+			subject.async(server) do |server, task|
+				task.with(server.accept) do |peer|
+					peer.write(peer.read(512))
+				end
+			end
+			
+			subject.async do |task|
+				Async::TCPSocket.connect("localhost", port) do |client|
+					client.write(data)
+					expect(client.read(512)).to be == data
+				end
+			end
+			
+			subject.run
+		end
+		
+		it "can connect socket and read/write in a different task" do
+			subject.async(server) do |server, task|
+				task.with(server.accept) do |peer|
+					peer.write(peer.read(512))
+				end
+			end
+			
+			socket = nil
+			
+			subject.async do |task|
+				socket = Async::TCPSocket.connect("localhost", port)
+				
+				# Stop the reactor once the connection was made.
+				subject.stop
+			end
+			
+			subject.run
+			
+			expect(socket).to_not be_nil
+			
+			subject.async(socket) do |client|
+				client.write(data)
+				expect(client.read(512)).to be == data
+			end
+			
+			subject.run
+		end
+	end
+	
+	describe 'basic udp server' do
+		include_context "reactor"
+		
+		# These may block:
+		let(:server) {UDPSocket.new.tap{|socket| socket.bind("localhost", port)}}
+		let(:client) {UDPSocket.new}
+		
+		let(:data) {"The quick brown fox jumped over the lazy dog."}
+		
+		after(:each) do
+			server.close
+		end
+		
+		it "should echo data back to peer" do
+			subject.async(server) do |server, task|
+				packet, (_, remote_port, remote_host) = server.recvfrom(512)
+				
+				reactor.async do
+					server.send(packet, 0, remote_host, remote_port)
+				end
+			end
+			
+			subject.async(client) do |client|
+				client.send(data, 0, "localhost", port)
+				
+				response, _ = client.recvfrom(512)
+				
+				expect(response).to be == data
+			end
+			
+			subject.run
+		end
+	end
+end