async-io 0.1.0

data/lib/async/io/socket.rb

@@ -0,0 +1,159 @@
+# 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 'socket'
+require_relative 'generic'
+
+module Async
+	module IO
+		class BasicSocket < Generic
+			wraps ::BasicSocket, :setsockopt, :connect_address, :local_address, :remote_address, :do_not_reverse_lookup, :do_not_reverse_lookup=, :shutdown, :getsockopt, :getsockname, :getpeername, :getpeereid
+			
+			wrap_blocking_method :recv, :recv_nonblock
+			wrap_blocking_method :recvmsg, :recvmsg_nonblock
+			
+			wrap_blocking_method :recvfrom, :recvfrom_nonblock
+			
+			wrap_blocking_method :sendmsg, :sendmsg_nonblock
+			wrap_blocking_method :send, :sendmsg_nonblock, invert: false
+		end
+		
+		module ServerSocket
+			def accept
+				peer, address = async_send(:accept_nonblock)
+				
+				if block_given?
+					wrapper = Socket.new(peer, self.reactor)
+					
+					begin
+						yield wrapper, address
+					ensure
+						wrapper.close
+					end
+				else
+					return Socket.new(peer, self.reactor), address
+				end
+			end
+			
+			def accept_each(task: Task.current)
+				task.annotate "accepting connections #{self.local_address.inspect}"
+				
+				while true
+					task.async(*self.accept) do |task, io, address|
+						task.annotate "incoming connection #{address}"
+						
+						begin
+							yield io, address
+						ensure
+							io.close
+						end
+					end
+				end
+			end
+		end
+		
+		class Socket < BasicSocket
+			wraps ::Socket, :bind, :ipv6only!, :listen
+			
+			include ::Socket::Constants
+			
+			include ServerSocket
+			
+			def connect(*args)
+				begin
+					async_send(:connect_nonblock, *args)
+				rescue Errno::EISCONN
+					# We are now connected.
+				end
+			end
+			
+			# Establish a connection to a given `remote_address`.
+			# @example
+			#  socket = Async::IO::Socket.connect(Async::IO::Address.tcp("8.8.8.8", 53))
+			# @param remote_address [Addrinfo] The remote address to connect to.
+			# @param local_address [Addrinfo] The local address to bind to before connecting.
+			# @option protcol [Integer] The socket protocol to use.
+			def self.connect(remote_address, local_address = nil, protocol: 0, task: Task.current)
+				task.annotate "connecting to #{remote_address.inspect}"
+				
+				socket = ::Socket.new(remote_address.afamily, remote_address.socktype, protocol)
+				
+				if local_address
+					socket.setsockopt(::Socket::SOL_SOCKET, ::Socket::SO_REUSEADDR, true)
+					socket.bind(local_address.to_sockaddr) if local_address
+				end
+				
+				wrapper = self.new(socket, task.reactor)
+				wrapper.connect(remote_address.to_sockaddr)
+				
+				task.annotate "connected to #{remote_address.inspect}"
+				
+				if block_given?
+					begin
+						return yield(wrapper)
+					ensure
+						wrapper.close
+					end
+				else
+					return wrapper
+				end
+			end
+			
+			# Bind to a local address.
+			# @example
+			#  socket = Async::IO::Socket.bind(Async::IO::Address.tcp("0.0.0.0", 9090))
+			# @param local_address [Address] The local address to bind to.
+			# @option protcol [Integer] The socket protocol to use.
+			def self.bind(local_address, protocol: 0, task: Task.current, &block)
+				task.annotate "binding to #{local_address.inspect}"
+				
+				socket = ::Socket.new(local_address.afamily, local_address.socktype, protocol)
+				
+				socket.setsockopt(::Socket::SOL_SOCKET, ::Socket::SO_REUSEADDR, true)
+				socket.bind(local_address.to_sockaddr)
+				
+				wrapper = self.new(socket, task.reactor)
+				
+				if block_given?
+					begin
+						return yield(wrapper, task)
+					ensure
+						wrapper.close
+					end
+				else
+					return wrapper
+				end
+			end
+			
+			# Bind to a local address and accept connections in a loop.
+			def self.accept(*args, backlog: SOMAXCONN, &block)
+				bind(*args) do |server, task|
+					server.listen(backlog) if backlog
+					
+					server.accept_each(task: task, &block)
+				end
+			end
+		end
+		
+		class IPSocket < BasicSocket
+			wraps ::IPSocket, :addr, :peeraddr
+		end
+	end
+end

data/lib/async/io/tcp_socket.rb

@@ -0,0 +1,37 @@
+# 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 IO
+		# Asynchronous TCP socket wrapper.
+		class TCPSocket < IPSocket
+			wraps ::TCPSocket
+		end
+		
+		# Asynchronous TCP server wrappper.
+		class TCPServer < TCPSocket
+			wraps ::TCPServer, :listen
+			
+			include ServerSocket
+		end
+	end
+end

data/lib/async/io/udp_socket.rb

@@ -0,0 +1,36 @@
+# 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 IO
+		# Asynchronous UDP socket wrapper.
+		class UDPSocket < IPSocket
+			wraps ::UDPSocket, :bind
+			
+			# We pass `send` through directly, but in theory it might block. Internally, it uses sendto.
+			def_delegators :@io, :send
+			
+			# This function is so fucked. Why does `UDPSocket#recvfrom` return the remote address as an array, but `Socket#recfrom` return it as an `Addrinfo`? You should prefer `recvmsg`.
+			wrap_blocking_method :recvfrom, :recvfrom_nonblock
+		end
+	end
+end

data/lib/async/io/unix_socket.rb

@@ -0,0 +1,52 @@
+# 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 IO
+		class UNIXSocket < BasicSocket
+			wraps ::UNIXSocket, :path, :addr, :peeraddr
+			
+			# TODO Currently unimplemented.
+			# , :send_io, :recv_io
+		end
+		
+		class UNIXServer < UNIXSocket
+			wraps ::UNIXServer
+			
+			def accept
+				peer = async_send(:accept_nonblock)
+				
+				if block_given?
+					wrapper = UNIXSocket.new(peer, self.reactor)
+					
+					begin
+						yield wrapper
+					ensure
+						wrapper.close
+					end
+				else
+					return UNIXSocket.new(peer, self.reactor)
+				end
+			end
+		end
+	end
+end

data/lib/async/io/version.rb

@@ -0,0 +1,25 @@
+# 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
+	module IO
+		VERSION = "0.1.0"
+	end
+end

data/lib/async/io/wrap/tcp.rb

@@ -0,0 +1,62 @@
+# 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 IO
+		module Wrap
+			module TCPServer
+				def self.new(*args)
+					return ::TCPServer.new(*args) unless Task.current?
+					
+					case args.size
+					when 2
+						local_address = Async::IO::Address.tcp(*args)
+					when 1
+						local_address = Async::IO::Address.tcp("0.0.0.0", *args)
+					else
+						raise ArgumentError, "TCPServer.new([hostname], port)"
+					end
+					
+					return Async::IO::Socket.bind(local_address)
+				end
+			end
+			
+			module TCPSocket
+				def self.new(remote_host, remote_port, local_host=nil, local_port=nil)
+					return ::TCPSocket.new(remote_host, remote_port, local_host, local_port) unless Task.current?
+					
+					remote_address = Async::IO::Address.tcp(remote_host, remote_port)
+					
+					if local_host && local_port
+						local_address = Async::IO::Address.tcp(local_host, local_port)
+					end
+					
+					return Async::IO::Socket.connect(remote_address, local_address)
+				end
+				
+				def self.open(*args)
+					self.new(*args)
+				end
+			end
+		end
+	end
+end

data/spec/async/io/address_spec.rb

@@ -0,0 +1,45 @@
+# 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 'async/io/address'
+
+RSpec.describe Async::IO::Address do
+	include_context Async::RSpec::Reactor
+	
+	describe Async::IO::Address.new([:tcp, '0.0.0.0', 1234]) do
+		it "should be a tcp binding" do
+			expect(subject.socktype).to be == ::Socket::SOCK_STREAM
+		end
+		
+		it "should generate valid address" do
+			expect(subject).to be == Addrinfo.tcp('0.0.0.0', 1234)
+		end
+	end
+	
+	describe Async::IO::Address.new(TCPServer.new('0.0.0.0', 1234)) do
+		it "should be a tcp binding" do
+			expect(subject.socktype).to be == ::Socket::SOCK_STREAM
+		end
+		
+		it "should generate valid address" do
+			expect(subject).to be == Addrinfo.tcp('0.0.0.0', 1234)
+		end
+	end
+end

data/spec/async/io/echo_spec.rb

@@ -0,0 +1,72 @@
+# 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 'async/io'
+
+RSpec.describe "echo client/server" do
+	include_context Async::RSpec::Reactor
+	
+	let(:server_address) {Async::IO::Address.new([:tcp, '0.0.0.0', 9000])}
+	
+	def echo_server(server_address)
+		Async::Reactor.run do |task|
+			# This is a synchronous block within the current task:
+			Async::IO::Socket.accept(server_address) do |client|
+				# This is an asynchronous block within the current reactor:
+				data = client.read(512)
+				
+				# This produces out-of-order responses.
+				task.sleep(rand * 0.01)
+				
+				client.write(data)
+			end
+		end
+	end
+	
+	def echo_client(server_address, data, responses)
+		Async::Reactor.run do |task|
+			Async::IO::Socket.connect(server_address) do |peer|
+				result = peer.write(data)
+				
+				message = peer.read(512)
+				
+				responses << message
+			end
+		end
+	end
+	
+	let(:repeats) {10}
+
+	it "should echo several messages" do
+		server = echo_server(server_address)
+		responses = []
+		
+		tasks = repeats.times.collect do |i|
+			echo_client(server_address, "Hello World #{i}", responses)
+		end
+		
+		# task.reactor.print_hierarchy
+		
+		tasks.each(&:wait)
+		server.stop
+		
+		expect(responses.count).to be repeats
+	end
+end