io-endpoint 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cbc52bab1fde2330c0b971cf987db15dc5865f9f3ce72a130121db97d00671ba
-  data.tar.gz: a7503b553781fd02e86a082015e82f1c5af24b5fa3a735dbdeb7415498901da8
+  metadata.gz: 10203d535af830bf9ff71034262b5851ec323024a9de4db527f061cb1cd76102
+  data.tar.gz: b150061a0414c379afb7fb5f2c142767afc5ed1822e5b106b78ece023d1cf459
 SHA512:
-  metadata.gz: 40343e43190bd695c0152fb5ec45946efe281245eb033eacae1eeda9291c37b4bc975dffac6db9d007b060bf9d375cdf3beed31f70a81f344c65f17b6772bff4
-  data.tar.gz: 40a34915f55409d96fddfaea9925c71c5bcddee36c0f6a6cc001982ec1e884a7694a3f4d89aad534353df3c182eb9b94f618619fdec9a77fc36d723620b5af09
+  metadata.gz: 82930d72359dee91627b19c771f79c9f2c6cc43dc93b9514a372a4568d1fb92c653ff2da1403c8519eddc4470dc14ef2356abe41cd202fba80bc35ba10e2d053
+  data.tar.gz: 556e87a95eb514e643a3e6bb40468ac851cceea5da6fb6f72db37767dca18882bb9b63e61e05d2e69629a1e4eef1859c3a2b3e0797b36e0e4eb1202684f8d44c

data/lib/io/connected.rb

@@ -0,0 +1,27 @@
+require 'socket'
+
+class IO
+	def connected?
+		!closed?
+	end
+end
+
+class Socket
+	def connected?
+		# Is it likely that the socket is still connected?
+		# May return false positive, but won't return false negative.
+		return false unless super
+		
+		# If we can wait for the socket to become readable, we know that the socket may still be open.
+		result = to_io.recv_nonblock(1, MSG_PEEK, exception: false)
+		
+		# No data was available - newer Ruby can return nil instead of empty string:
+		return false if result.nil?
+		
+		# Either there was some data available, or we can wait to see if there is data avaialble.
+		return !result.empty? || result == :wait_readable
+	rescue Errno::ECONNRESET
+		# This might be thrown by recv_nonblock.
+		return false
+	end
+end

data/lib/io/endpoint/address_endpoint.rb

@@ -23,10 +23,11 @@ module IO::Endpoint
 		attr :address
 		
 		# 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
+		# @yield {|socket| ...}	An optional block which will be passed the socket.
+		#   @parameter socket [Socket] The socket which has been bound.
+		# @return [Array(Socket)] the bound socket
 		def bind(wrapper = Wrapper.default, &block)
-			wrapper.bind(@address, **@options, &block)
+			[wrapper.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.

data/lib/io/endpoint/composite_endpoint.rb

@@ -13,15 +13,17 @@ module IO::Endpoint
 		end
 		
 		def each(&block)
-			@endpoints.each(&block)
+			@endpoints.each do |endpoint|
+				endpoint.each(&block)
+			end
 		end
 		
-		def connect(&block)
+		def connect(wrapper = Wrapper.default, &block)
 			last_error = nil
 			
 			@endpoints.each do |endpoint|
 				begin
-					return endpoint.connect(&block)
+					return endpoint.connect(wrapper, &block)
 				rescue => last_error
 				end
 			end
@@ -29,8 +31,14 @@ module IO::Endpoint
 			raise last_error
 		end
 		
-		def bind(&block)
-			@endpoints.map(&:bind)
+		def bind(wrapper = Wrapper.default, &block)
+			if block_given?
+				@endpoints.each do |endpoint|
+					endpoint.bind(&block)
+				end
+			else
+				@endpoints.map(&:bind).flatten.compact
+			end
 		end
 	end
 	

data/lib/io/endpoint/generic.rb

@@ -69,22 +69,16 @@ module IO::Endpoint
 		
 		# Accept connections from the specified endpoint.
 		# @param backlog [Integer] the number of connections to listen for.
-		def accept(backlog: Socket::SOMAXCONN, &block)
-			bind do |server|
-				server.listen(backlog) if backlog
-				
-				while true
-					socket, address = server.accept
-					
-					Fiber.schedule do
-						yield accepted(socket), address
-					end
-				end
+		def accept(wrapper = Wrapper.default, *arguments, **options, &block)
+			bind(wrapper, *arguments, **options) do |server|
+				wrapper.accept(server, &block)
 			end
 		end
 		
 		# Create an Endpoint instance by URI scheme. The host and port of the URI will be passed to the Endpoint factory method, along with any options.
 		#
+		# You should not use untrusted input as it may execute arbitrary code.
+		#
 		# @param string [String] URI as string. Scheme will decide implementation used.
 		# @param options keyword arguments passed through to {#initialize}
 		#
@@ -95,13 +89,7 @@ module IO::Endpoint
 		def self.parse(string, **options)
 			uri = URI.parse(string)
 			
-			self.public_send(uri.scheme, uri.host, uri.port, **options)
-		end
-		
-		protected
-		
-		def accepted(socket)
-			socket
+			IO::Endpoint.public_send(uri.scheme, uri.host, uri.port, **options)
 		end
 	end
 end

data/lib/io/endpoint/host_endpoint.rb

@@ -23,7 +23,11 @@ module IO::Endpoint
 		attr :specification
 		
 		def hostname
-			@specification.first
+			@specification[0]
+		end
+		
+		def service
+			@specification[1]
 		end
 		
 		# Try to connect to the given host by connecting to each address in sequence until a connection is made.
@@ -35,7 +39,7 @@ module IO::Endpoint
 			
 			Addrinfo.foreach(*@specification) do |address|
 				begin
-					socket = wrapper.connect(@address, **@options)
+					socket = wrapper.connect(address, **@options)
 				rescue Errno::ECONNREFUSED, Errno::ENETUNREACH, Errno::EAGAIN => last_error
 					# Try again unless if possible, otherwise raise...
 				else

data/lib/io/endpoint/shared_endpoint.rb

@@ -7,16 +7,16 @@ require_relative 'generic'
 require_relative 'composite_endpoint'
 require_relative 'socket_endpoint'
 
+require 'openssl'
+
 module IO::Endpoint
 	# Pre-connect and pre-bind sockets so that it can be used between processes.
 	class SharedEndpoint < Generic
 		# Create a new `SharedEndpoint` by binding to the given endpoint.
 		def self.bound(endpoint, backlog: Socket::SOMAXCONN, close_on_exec: false, **options)
-			sockets = []
+			sockets = endpoint.bind(**options)
 			
-			endpoint.each do |server_endpoint|
-				server = server_endpoint.bind(**options)
-				
+			sockets.each do |server|
 				# This is somewhat optional. We want to have a generic interface as much as possible so that users of this interface can just call it without knowing a lot of internal details. Therefore, we ignore errors here if it's because the underlying socket does not support the operation.
 				begin
 					server.listen(backlog)
@@ -25,8 +25,6 @@ module IO::Endpoint
 				end
 				
 				server.close_on_exec = close_on_exec
-				
-				sockets << server
 			end
 			
 			return self.new(endpoint, sockets)
@@ -34,11 +32,11 @@ module IO::Endpoint
 		
 		# Create a new `SharedEndpoint` by connecting to the given endpoint.
 		def self.connected(endpoint, close_on_exec: false)
-			wrapper = endpoint.connect
+			socket = endpoint.connect
 			
-			wrapper.close_on_exec = close_on_exec
+			socket.close_on_exec = close_on_exec
 			
-			return self.new(endpoint, [wrapper])
+			return self.new(endpoint, [socket])
 		end
 		
 		def initialize(endpoint, sockets, **options)
@@ -55,18 +53,18 @@ module IO::Endpoint
 		
 		def local_address_endpoint(**options)
 			endpoints = @sockets.map do |wrapper|
-				AddressEndpoint.new(wrapper.to_io.local_address)
+				AddressEndpoint.new(wrapper.to_io.local_address, **options)
 			end
 			
-			return CompositeEndpoint.new(endpoints, **options)
+			return CompositeEndpoint.new(endpoints)
 		end
 		
 		def remote_address_endpoint(**options)
 			endpoints = @sockets.map do |wrapper|
-				AddressEndpoint.new(wrapper.to_io.remote_address)
+				AddressEndpoint.new(wrapper.to_io.remote_address, **options)
 			end
 			
-			return CompositeEndpoint.new(endpoints, **options)
+			return CompositeEndpoint.new(endpoints)
 		end
 		
 		# Close all the internal sockets.
@@ -115,9 +113,9 @@ module IO::Endpoint
 			end
 		end
 		
-		def accept(**options, &block)
-			bind do |server|
-				server.accept(&block)
+		def accept(wrapper = Wrapper.default, &block)
+			bind(wrapper) do |server|
+				wrapper.accept(server, &block)
 			end
 		end
 		

data/lib/io/endpoint/ssl_endpoint.rb

@@ -8,6 +8,38 @@ require_relative 'generic'
 
 require 'openssl'
 
+module OpenSSL::SSL::SocketForwarder
+	unless method_defined?(:close_on_exec=)
+		def close_on_exec=(value)
+			to_io.close_on_exec = value
+		end
+	end
+	
+	unless method_defined?(:close_on_exec)
+		def local_address
+			to_io.local_address
+		end
+	end
+	
+	unless method_defined?(:wait)
+		def wait(*arguments)
+			to_io.wait(*arguments)
+		end
+	end
+	
+	unless method_defined?(:wait_readable)
+		def wait_readable(*arguments)
+			to_io.wait_readable(*arguments)
+		end
+	end
+	
+	unless method_defined?(:wait_writable)
+		def wait_writable(*arguments)
+			to_io.wait_writable(*arguments)
+		end
+	end
+end
+
 module IO::Endpoint
 	class SSLEndpoint < Generic
 		def initialize(endpoint, **options)
@@ -41,13 +73,13 @@ module IO::Endpoint
 			@options[:ssl_params]
 		end
 		
-		def build_context(context = OpenSSL::SSL::SSLContext.new)
+		def build_context(context = ::OpenSSL::SSL::SSLContext.new)
 			if params = self.params
 				context.set_params(params)
 			end
 			
-			context.setup
-			context.freeze
+			# context.setup
+			# context.freeze
 			
 			return context
 		end
@@ -59,13 +91,15 @@ module IO::Endpoint
 		# 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
+		def bind(*arguments, **options, &block)
 			if block_given?
-				@endpoint.bind do |server|
-					yield OpenSSL::SSL::SSLServer.new(server, context)
+				@endpoint.bind(*arguments, **options) do |server|
+					yield ::OpenSSL::SSL::SSLServer.new(server, self.context)
 				end
 			else
-				return OpenSSL::SSL::SSLServer.new(@endpoint.bind, context)
+				@endpoint.bind(*arguments, **options).map do |server|
+					::OpenSSL::SSL::SSLServer.new(server, self.context)
+				end
 			end
 		end
 		
@@ -73,7 +107,7 @@ module IO::Endpoint
 		# @yield [Socket] the socket which is being connected
 		# @return [Socket] the connected socket
 		def connect(&block)
-			socket = OpenSSL::SSL::SSLSocket.new(@endpoint.connect, context)
+			socket = ::OpenSSL::SSL::SSLSocket.new(@endpoint.connect, self.context)
 			
 			if hostname = self.hostname
 				socket.hostname = hostname
@@ -102,13 +136,6 @@ module IO::Endpoint
 				yield self.class.new(endpoint, **@options)
 			end
 		end
-		
-		protected
-		
-		def accepted(socket)
-			socket.accept
-			socket
-		end
 	end
 
 	# @param arguments

data/lib/io/endpoint/version.rb

@@ -5,6 +5,6 @@
 
 class IO
 	module Endpoint
-		VERSION = "0.2.0"
+		VERSION = "0.4.0"
 	end
 end

data/lib/io/endpoint/wrapper.rb

@@ -30,7 +30,6 @@ module IO::Endpoint
 			# On Darwin, sometimes occurs when the connection is not yet fully formed. Empirically, TCP_NODELAY is enabled despite this result.
 		rescue Errno::EOPNOTSUPP
 			# Some platforms may simply not support the operation.
-			# Console.logger.warn(self) {"Unable to set sync=#{value}!"}
 		rescue Errno::ENOPROTOOPT
 			# It may not be supported by the protocol (e.g. UDP). ¯\_(ツ)_/¯
 		end
@@ -131,14 +130,14 @@ module IO::Endpoint
 		end
 		
 		# Bind to a local address and accept connections in a loop.
-		def accept(*arguments, backlog: SOMAXCONN, **options, &block)
-			bind(*arguments, **options) do |server|
-				server.listen(backlog) if backlog
+		def accept(server, timeout: server.timeout, &block)
+			while true
+				socket, address = server.accept
+				
+				socket.timeout = timeout if timeout != false
 				
 				async do
-					while true
-						server.accept(&block)
-					end
+					yield socket, address
 				end
 			end
 		end

data/readme.md

@@ -18,6 +18,14 @@ We welcome contributions to this project.
 4.  Push to the branch (`git push origin my-new-feature`).
 5.  Create new Pull Request.
 
+### Developer Certificate of Origin
+
+This project uses the [Developer Certificate of Origin](https://developercertificate.org/). All contributors to this project must agree to this document to have their contributions accepted.
+
+### Contributor Covenant
+
+This project is governed by the [Contributor Covenant](https://www.contributor-covenant.org/). All contributors and participants agree to abide by its terms.
+
 ## See Also
 
   - [async-io](https://github.com/socketry/async-io) — Asynchronous IO primitives.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: io-endpoint
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -37,56 +37,15 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2023-12-16 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: bake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: covered
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: sus
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+date: 2024-01-01 00:00:00.000000000 Z
+dependencies: []
 description:
 email:
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/io/connected.rb
 - lib/io/endpoint.rb
 - lib/io/endpoint/address_endpoint.rb
 - lib/io/endpoint/composite_endpoint.rb
@@ -120,7 +79,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.22
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Provides a separation of concerns interface for IO endpoints.