async 0.13.0 → 0.14.0

data/examples/aio.rb

@@ -1,42 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'async'
-
-reactor = Async::Reactor.new
-
-puts "Creating server"
-server = TCPServer.new("localhost", 6777)
-
-REPEATS = 10
-
-timer = reactor.after(1) do
-	puts "Reactor timed out!"
-	reactor.stop
-end
-
-reactor.async(server) do |server, task|
-	REPEATS.times do |i|
-		puts "Accepting peer on server #{server}"
-		task.with(server.accept) do |peer|
-			puts "Sending data to peer"
-			peer << "data #{i}"
-			peer.shutdown
-		end
-	end
-	
-	puts "Server finished, canceling timer"
-	timer.cancel
-end
-
-REPEATS.times do |i|
-	# This aspect of the connection is synchronous.
-	puts "Creating client #{i}"
-	client = TCPSocket.new("localhost", 6777)
-	
-	reactor.async(client) do |client|
-		puts "Reading data on client #{i}"
-		puts client.read(1024)
-	end
-end
-
-reactor.run

data/examples/echo.rb

@@ -1,40 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'async'
-require 'async/tcp_socket'
-
-def echo_server
-	Async::Reactor.run do |task|
-		# This is a synchronous block within the current task:
-		task.with(TCPServer.new('localhost', 9000)) do |server|
-			
-			# This is an asynchronous block within the current reactor:
-			task.reactor.with(server.accept) do |client|
-				data = client.read(512)
-				
-				task.sleep(rand)
-				
-				client.write(data)
-			end while true
-		end
-	end
-end
-
-def echo_client(data)
-	Async::Reactor.run do |task|
-		Async::TCPServer.connect('localhost', 9000) do |socket|
-			socket.write(data)
-			puts "echo_client: #{socket.read(512)}"
-		end
-	end
-end
-
-Async::Reactor.run do
-	server = echo_server
-	
-	5.times.collect do |i|
-		echo_client("Hello World #{i}")
-	end.each(&:wait)
-	
-	server.stop
-end

data/lib/async/io.rb

@@ -1,109 +0,0 @@
-# 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 'wrapper'
-
-require 'forwardable'
-
-module Async
-	# Represents an asynchronous IO within a reactor.
-	class IO < Wrapper
-		extend Forwardable
-		
-		WRAPPERS = {}
-		
-		# Return the wrapper for a given native IO instance.
-		def self.[] instance
-			WRAPPERS[instance.class]
-		end
-		
-		class << self
-			# @!macro [attach] wrap_blocking_method
-			#   @method $1
-			#   Invokes `$2` on the underlying {io}. If the operation would block, the current task is paused until the operation can succeed, at which point it's resumed and the operation is completed.
-			def wrap_blocking_method(new_name, method_name, &block)
-				if block_given?
-					define_method(new_name, &block)
-				else
-					define_method(new_name) do |*args|
-						async_send(method_name, *args)
-					end
-				end
-			end
-			
-			def wraps(klass, *additional_methods)
-				WRAPPERS[klass] = self
-				
-				# klass.instance_methods(false).grep(/(.*)_nonblock/) do |method_name|
-				# 	wrap_blocking_method($1, method_name)
-				# end
-				
-				def_delegators :@io, *(additional_methods - instance_methods(false))
-			end
-		end
-		
-		wraps ::IO
-		
-		# @example
-		#   data = io.read(512)
-		wrap_blocking_method :read, :read_nonblock
-		
-		# @example
-		#   io.write("Hello World")
-		wrap_blocking_method :write, :write_nonblock
-		
-		protected
-		
-		if RUBY_VERSION >= "2.3"
-			def async_send(*args)
-				async do
-					@io.__send__(*args, exception: false)
-				end
-			end
-		else
-			def async_send(*args)
-				async do
-					@io.__send__(*args)
-				end
-			end
-		end
-		
-		def async
-			while true
-				begin
-					result = yield
-					
-					case result
-					when :wait_readable
-						wait_readable
-					when :wait_writable
-						wait_writable
-					else
-						return result
-					end
-				rescue ::IO::WaitReadable
-					wait_readable
-				rescue ::IO::WaitWritable
-					wait_writable
-				end
-			end
-		end
-	end
-end

data/lib/async/socket.rb

@@ -1,109 +0,0 @@
-# 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
-		
-		wrap_blocking_method :recv, :recv_nonblock
-		wrap_blocking_method :recvmsg, :recvmsg_nonblock
-		
-		wrap_blocking_method :recvfrom, :recvfrom_nonblock
-		
-		wrap_blocking_method :send, :sendmsg_nonblock
-		wrap_blocking_method :sendmsg, :sendmsg_nonblock
-	end
-	
-	class Socket < BasicSocket
-		wraps ::Socket
-		
-		wrap_blocking_method :accept, :accept_nonblock
-		
-		wrap_blocking_method :connect, :connect_nonblock do |*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::Socket.connect(Addrinfo.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)
-			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) if local_address
-			end
-			
-			if block_given?
-				task.with(socket) do |wrapper|
-					wrapper.connect(remote_address.to_sockaddr)
-					
-					yield wrapper
-				end
-			else
-				task.bind(socket).connect(remote_address.to_sockaddr)
-				
-				return socket
-			end
-		end
-		
-		# Bind to a local address.
-		# @example
-		#  socket = Async::Socket.bind(Addrinfo.tcp("0.0.0.0", 9090))
-		# @param local_address [Addrinfo] The local address to bind to.
-		# @option protcol [Integer] The socket protocol to use.
-		def self.bind(local_address, backlog: nil, protocol: 0, task: Task.current, &block)
-			socket = ::Socket.new(local_address.afamily, local_address.socktype, protocol)
-			
-			socket.setsockopt(::Socket::SOL_SOCKET, ::Socket::SO_REUSEADDR, true)
-			socket.bind(local_address)
-			
-			socket.listen(backlog) if backlog
-			
-			if block_given?
-				task.with(socket, &block)
-			else
-				return socket
-			end
-		end
-		
-		# Bind to a local address and accept connections in a loop.
-		def self.accept(*args, task: Task.current, &block)
-			bind(*args, task: task) do |wrapper|
-				task.with(*wrapper.accept, &block) while true
-			end
-		end
-	end
-	
-	class IPSocket < BasicSocket
-		wraps ::IPSocket
-	end
-end

data/lib/async/tcp_socket.rb

@@ -1,35 +0,0 @@
-# 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 wrapper.
-	class TCPSocket < IPSocket
-		wraps ::TCPSocket
-	end
-	
-	# Asynchronous TCP server wrappper.
-	class TCPServer < TCPSocket
-		wraps ::TCPServer
-		
-		wrap_blocking_method :accept, :accept_nonblock
-	end
-end

data/lib/async/unix_socket.rb

@@ -1,33 +0,0 @@
-# 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
-	class UNIXServer < BasicSocket
-		wraps ::UNIXServer
-		
-		wrap_blocking_method :accept, :accept_nonblock
-	end
-	
-	class UNIXSocket < BasicSocket
-		wraps ::UNIXSocket
-	end
-end

data/spec/async/tcp_socket_spec.rb

@@ -1,106 +0,0 @@
-# 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
-	include_context "closes all io"
-	
-	# Shared port for localhost network tests.
-	let(:server_address) {Addrinfo.tcp("localhost", 6779)}
-	let(:data) {"The quick brown fox jumped over the lazy dog."}
-	
-	around(:each) do |example|
-		# Accept a single incoming connection and then finish.
-		subject.async do |task|
-			Async::Socket.bind(server_address, backlog: 128) do |server|
-				task.with(*server.accept) do |peer, address|
-					data = peer.read(512)
-					peer.write(data)
-				end
-			end
-		end
-		
-		result = example.run
-		
-		return result if result.is_a? Exception
-		
-		subject.run
-	end
-	
-	describe 'basic tcp server' do
-		it "should start server and send data" do
-			subject.async do
-				Async::Socket.connect(server_address) do |client|
-					client.write(data)
-					expect(client.read(512)).to be == data
-				end
-			end
-		end
-	end
-	
-	describe 'non-blocking tcp connect' do
-		it "should start server and send data" do
-			subject.async do |task|
-				Async::Socket.connect(server_address) do |client|
-					client.write(data)
-					expect(client.read(512)).to be == data
-				end
-			end
-		end
-		
-		it "can connect socket and read/write in a different task" do
-			socket = nil
-			
-			subject.async do |task|
-				socket = Async::Socket.connect(server_address)
-				
-				# 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
-		
-		it "can't use a socket in nested tasks" do
-			subject.async do |task|
-				socket = Async::Socket.connect(server_address)
-				
-				# I'm not sure if this is the right behaviour or not. Without a significant amont of work, async sockets are tied to the task that creates them.
-				expect do
-					subject.async(socket) do |client|
-						client.write(data)
-						expect(client.read(512)).to be == data
-					end
-				end.to raise_error(ArgumentError, /already registered with selector/)
-				
-				# We need to explicitly close the socket, since we explicitly opened it.
-				socket.close
-			end
-		end
-	end
-end