async-io 1.14.0 → 1.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '08ed02b9fabc43bcd20e61f50473ee0606a821b7e655710805da340164cb7c2d'
-  data.tar.gz: 2275335c17c84fb21fdd70275c6108a184c513e4eeb92d0fbd1140b683112f10
+  metadata.gz: 6d4d9a66fb4be7f89c7dda8e08e7e10fdc2145d52eb5310b7b0d5bf0aa657fd7
+  data.tar.gz: ba85706fcee621d8f23b01a67389c084c8772f759c301e6c22a165b94a2f5686
 SHA512:
-  metadata.gz: 944f73030f9c9134b8a209eda2fdd8afb9b438c2c8a52085c250a8a695c9e546cbe65447b96c09caa8b7699a0c0a742b24fdabb574d1b56b37fee323a59a3017
-  data.tar.gz: c7b5d911865071df5a711269547388d13e2dcdd0ad5fd685b1545ff334d7d0d18d6a93efec111eac7203eca0fb58a5349f44a5aa1bd3123bc27f3b947dcdefe4
+  metadata.gz: f2f682fdde7cd37a7836233bd194c7a1fca1a5f25e4f1f1bb424e95075b40a3b6d46c83ca2a92c57557e038515bb425989a11397067bf7afb2c8128ce532b514
+  data.tar.gz: c7fa044f6140fc47e040188d0fa66848812ea1b187935fb9fbbdc46efdff7f553037af77089e955481779c1c605396851b6aa9b1fc280a2497fd64f995304a61

data/lib/async/io/address_endpoint.rb

@@ -38,10 +38,15 @@ module Async
 			attr :address
 			attr :options
 			
+			# Bind a socket to the given address. If a block is given, the socket will be automatically closed when the block exits.
+			# @yield [Socket] the bound socket
+			# @return [Socket] the bound socket
 			def bind(&block)
 				Socket.bind(@address, **@options, &block)
 			end
 			
+			# Connects a socket to the given address. If a block is given, the socket will be automatically closed when the block exits.
+			# @return [Socket] the connected socket
 			def connect(&block)
 				Socket.connect(@address, **@options, &block)
 			end

data/lib/async/io/endpoint.rb

@@ -25,6 +25,7 @@ require 'uri'
 
 module Async
 	module IO
+		# Endpoints represent a way of connecting or binding to an address.
 		class Endpoint
 			def initialize(**options)
 				@options = options

data/lib/async/io/host_endpoint.rb

@@ -37,10 +37,14 @@ module Async
 				@specification.first
 			end
 			
+			# Try to connect to the given host by connecting to each address in sequence until a connection is made.
+			# @yield [Socket] the socket which is being connected, may be invoked more than once
+			# @return [Socket] the connected socket
+			# @raise if no connection could complete successfully
 			def connect(&block)
 				last_error = nil
 				
-				Addrinfo.foreach(*@specification).each do |address|
+				Addrinfo.foreach(*@specification) do |address|
 					begin
 						return Socket.connect(address, **@options, &block)
 					rescue
@@ -51,16 +55,20 @@ module Async
 				raise last_error
 			end
 			
+			# Invokes the given block for every address which can be bound to.
+			# @yield [Socket] the bound socket
+			# @return [Array<Socket>] an array of bound sockets
 			def bind(&block)
-				Addrinfo.foreach(*@specification) do |address|
+				Addrinfo.foreach(*@specification).collect do |address|
 					Socket.bind(address, **@options, &block)
 				end
 			end
 			
+			# @yield [AddressEndpoint] address endpoints by resolving the given host specification
 			def each
 				return to_enum unless block_given?
 				
-				Addrinfo.foreach(*@specification).each do |address|
+				Addrinfo.foreach(*@specification) do |address|
 					yield AddressEndpoint.new(address, **@options)
 				end
 			end

data/lib/async/io/shared_endpoint.rb

@@ -50,10 +50,13 @@ module Async
 			end
 			
 			def initialize(endpoint, wrappers)
-				@wrappers = wrappers
 				@endpoint = endpoint
+				@wrappers = wrappers
 			end
 			
+			attr :endpoint
+			attr :wrappers
+			
 			def close
 				@wrappers.each(&:close)
 			end

data/lib/async/io/ssl_endpoint.rb

@@ -62,12 +62,22 @@ module Async
 				return context
 			end
 			
+			# Connect to the underlying endpoint and establish a SSL connection.
+			# @yield [Socket] the socket which is being connected
+			# @return [Socket] the connected socket
 			def bind
-				@endpoint.bind do |server|
-					yield SSLServer.new(server, context)
+				if block_given?
+					@endpoint.bind do |server|
+						yield SSLServer.new(server, context)
+					end
+				else
+					return SSLServer.new(@endpoint.bind, context)
 				end
 			end
 			
+			# Connect to the underlying endpoint and establish a SSL connection.
+			# @yield [Socket] the socket which is being connected
+			# @return [Socket] the connected socket
 			def connect(&block)
 				SSLSocket.connect(@endpoint.connect, context, hostname, &block)
 			end

data/lib/async/io/ssl_socket.rb

@@ -94,7 +94,7 @@ module Async
 				@context = context
 			end
 			
-			def_delegators :@server, :local_address, :setsockopt, :getsockopt, :close
+			def_delegators :@server, :local_address, :setsockopt, :getsockopt, :close, :close_on_exec=, :reactor=
 			
 			attr :server
 			attr :context

data/lib/async/io/version.rb

@@ -20,6 +20,6 @@
 
 module Async
 	module IO
-		VERSION = "1.14.0"
+		VERSION = "1.15.0"
 	end
 end

data/spec/async/io/shared_endpoint_spec.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 'async/io/host_endpoint'
+require 'async/io/shared_endpoint'
+
+RSpec.describe Async::IO::SharedEndpoint do
+	include_context Async::RSpec::Reactor
+	
+	describe '#bound' do
+		let(:endpoint) {Async::IO::Endpoint.tcp("localhost", 5123)}
+		
+		it "can bind to shared endpoint" do
+			bound_endpoint = described_class.bound(endpoint)
+			
+			expect(bound_endpoint.wrappers).to_not be_empty
+			expect(bound_endpoint.wrappers.first).to be_a Async::IO::Socket
+			
+			bound_endpoint.close
+		end
+	end
+	
+	describe '#connected' do
+		let(:endpoint) {Async::IO::Endpoint.tcp("www.google.com", 80)}
+		
+		it "can connect to shared endpoint" do
+			connected_endpoint = described_class.connected(endpoint)
+			
+			expect(connected_endpoint.wrappers).to_not be_empty
+			expect(connected_endpoint.wrappers.first).to be_a Async::IO::Socket
+			
+			connected_endpoint.close
+		end
+	end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: async-io
 version: !ruby/object:Gem::Version
-  version: 1.14.0
+  version: 1.15.0
 platform: ruby
 authors:
 - Samuel Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-31 00:00:00.000000000 Z
+date: 2018-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async
@@ -133,6 +133,7 @@ files:
 - spec/async/io/generic_spec.rb
 - spec/async/io/notification_spec.rb
 - spec/async/io/protocol/line_spec.rb
+- spec/async/io/shared_endpoint_spec.rb
 - spec/async/io/socket/tcp_spec.rb
 - spec/async/io/socket/udp_spec.rb
 - spec/async/io/socket_spec.rb
@@ -178,6 +179,7 @@ test_files:
 - spec/async/io/generic_spec.rb
 - spec/async/io/notification_spec.rb
 - spec/async/io/protocol/line_spec.rb
+- spec/async/io/shared_endpoint_spec.rb
 - spec/async/io/socket/tcp_spec.rb
 - spec/async/io/socket/udp_spec.rb
 - spec/async/io/socket_spec.rb