io-endpoint 0.13.1 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 80426a4ee162f18eb945d9ce2fd75bde3cf23e9d5bb8333faa2ff627f6b87a23
-  data.tar.gz: 37d79a722c7371c993476fc3061d5c63e7c10f6051dcdc5215d079bac88d5965
+  metadata.gz: 85f53ad778e7ab62a17def218d84235d361df69805fa9f0edbf08b4ec0dfebc1
+  data.tar.gz: db08fed38c6ff791c0d4b98af3a661af718c5c44595f135cb0bf77147a36155b
 SHA512:
-  metadata.gz: b89867de53a90531d5b9f1484d529e3f556b6ac75b30b6174c2bfc7f3c0199b80208b7699f6998d8c61b8e0eef666b72f66e10377090b566ae4058b4d229859d
-  data.tar.gz: a7c98d22e20fd3cdd558b8266b92bfb88fc110c6f0a144769daf58b505447cc0e0fff04a4b07d0bbe490327a3a46d5f7b353f436cb72651040cae8e350523f54
+  metadata.gz: 7c00c73e293110af0cb9caed8e7a8477b1c18eabe896b523297e42f3daf689586e916c989e103c33b9d4be37ce75e67a3433d2bfed92cdd5e366177076454bfe
+  data.tar.gz: a1bb99c8199618a8984deca2678c9884f382542b38c83c3fe6a08b1896a13fd5f9a57efb125b487a259f9b0a0e6fc4425446aea083ce8423b27acc1420178331

data/lib/io/endpoint/address_endpoint.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2023, by Samuel Williams.
+# Copyright, 2023-2025, by Samuel Williams.
 
-require 'socket'
+require "socket"
 
-require_relative 'generic'
-require_relative 'wrapper'
+require_relative "generic"
+require_relative "wrapper"
 
 module IO::Endpoint
 	class AddressEndpoint < Generic
@@ -17,6 +17,17 @@ module IO::Endpoint
 		end
 		
 		def to_s
+			case @address.afamily
+			when Socket::AF_INET
+				"inet:#{@address.inspect_sockaddr}"
+			when Socket::AF_INET6
+				"inet6:#{@address.inspect_sockaddr}"
+			else
+				"address:#{@address.inspect_sockaddr}"
+			end
+		end
+		
+		def inspect
 			"\#<#{self.class} address=#{@address.inspect}>"
 		end
 		
@@ -26,13 +37,13 @@ module IO::Endpoint
 		# @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)
+		def bind(wrapper = self.wrapper, &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.
 		# @return [Socket] the connected socket
-		def connect(wrapper = Wrapper.default, &block)
+		def connect(wrapper = self.wrapper, &block)
 			wrapper.connect(@address, **@options, &block)
 		end
 	end

data/lib/io/endpoint/bound_endpoint.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2024, by Samuel Williams.
+# Copyright, 2024-2025, by Samuel Williams.
 
-require_relative 'generic'
-require_relative 'composite_endpoint'
-require_relative 'address_endpoint'
+require_relative "generic"
+require_relative "composite_endpoint"
+require_relative "address_endpoint"
 
 module IO::Endpoint
 	class BoundEndpoint < Generic
@@ -55,13 +55,17 @@ module IO::Endpoint
 		end
 		
 		def to_s
+			"bound:#{@endpoint}"
+		end
+		
+		def inspect
 			"\#<#{self.class} #{@sockets.size} bound sockets for #{@endpoint}>"
 		end
 		
-		def bind(wrapper = Wrapper.default, &block)
+		def bind(wrapper = self.wrapper, &block)
 			@sockets.map do |server|
 				if block_given?
-					wrapper.async do
+					wrapper.schedule do
 						yield server
 					end
 				else

data/lib/io/endpoint/composite_endpoint.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2023-2024, by Samuel Williams.
+# Copyright, 2023-2025, by Samuel Williams.
 
-require_relative 'generic'
+require_relative "generic"
 
 module IO::Endpoint
 	# A composite endpoint is a collection of endpoints that are used in order.
@@ -19,6 +19,14 @@ module IO::Endpoint
 			@endpoints = endpoints
 		end
 		
+		def to_s
+			"composite:#{@endpoints.join(",")}"
+		end
+		
+		def inspect
+			"\#<#{self.class} endpoints=#{@endpoints}>"
+		end
+		
 		def with(**options)
 			self.class.new(endpoints.map{|endpoint| endpoint.with(**options)}, **@options.merge(options))
 		end
@@ -36,7 +44,7 @@ module IO::Endpoint
 			end
 		end
 		
-		def connect(wrapper = Wrapper.default, &block)
+		def connect(wrapper = self.wrapper, &block)
 			last_error = nil
 			
 			@endpoints.each do |endpoint|
@@ -49,7 +57,7 @@ module IO::Endpoint
 			raise last_error
 		end
 		
-		def bind(wrapper = Wrapper.default, &block)
+		def bind(wrapper = self.wrapper, &block)
 			if block_given?
 				@endpoints.each do |endpoint|
 					endpoint.bind(&block)

data/lib/io/endpoint/connected_endpoint.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2024, by Samuel Williams.
+# Copyright, 2024-2025, by Samuel Williams.
 
-require_relative 'generic'
-require_relative 'composite_endpoint'
-require_relative 'socket_endpoint'
+require_relative "generic"
+require_relative "composite_endpoint"
+require_relative "socket_endpoint"
 
-require 'openssl'
+require "openssl"
 
 module IO::Endpoint
 	class ConnectedEndpoint < Generic
@@ -41,7 +41,7 @@ module IO::Endpoint
 			AddressEndpoint.new(socket.to_io.remote_address, **options)
 		end
 		
-		def connect(wrapper = Wrapper.default, &block)
+		def connect(wrapper = self.wrapper, &block)
 			if block_given?
 				yield @socket
 			else
@@ -57,6 +57,10 @@ module IO::Endpoint
 		end
 		
 		def to_s
+			"connected:#{@endpoint}"
+		end
+		
+		def inspect
 			"\#<#{self.class} #{@socket} connected for #{@endpoint}>"
 		end
 	end

data/lib/io/endpoint/generic.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2023-2024, by Samuel Williams.
+# Copyright, 2023-2025, by Samuel Williams.
 
 # require_relative 'address'
-require 'uri'
-require 'socket'
+require "uri"
+require "socket"
 
 module IO::Endpoint
 	Address = Addrinfo
@@ -64,21 +64,21 @@ module IO::Endpoint
 		# @yields {|socket| ...}	An optional block which will be passed the socket.
 		#   @parameter socket [Socket] The socket which has been bound.
 		# @returns [Array(Socket)] the bound socket
-		def bind(wrapper = Wrapper.default, &block)
+		def bind(wrapper = self.wrapper, &block)
 			raise NotImplementedError
 		end
 		
 		# Connects a socket to the given address. If a block is given, the socket will be automatically closed when the block exits.
 		# @parameter wrapper [Wrapper] The wrapper to use for connecting.
 		# @return [Socket] the connected socket
-		def connect(wrapper = Wrapper.default, &block)
+		def connect(wrapper = self.wrapper, &block)
 			raise NotImplementedError
 		end
 		
 		# Bind and accept connections on the given address.
 		# @parameter wrapper [Wrapper] The wrapper to use for accepting connections.
 		# @yields [Socket] The accepted socket.
-		def accept(wrapper = Wrapper.default, &block)
+		def accept(wrapper = self.wrapper, &block)
 			bind(wrapper) do |server|
 				wrapper.accept(server, **@options, &block)
 			end
@@ -109,5 +109,10 @@ module IO::Endpoint
 			
 			IO::Endpoint.public_send(uri.scheme, uri.host, uri.port, **options)
 		end
+		
+		# The default wrapper to use for binding, connecting, and accepting connections.
+		def wrapper
+			@options[:wrapper] || Wrapper.default
+		end
 	end
 end

data/lib/io/endpoint/host_endpoint.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2023, by Samuel Williams.
+# Copyright, 2023-2025, by Samuel Williams.
 
-require_relative 'address_endpoint'
+require_relative "address_endpoint"
 
 module IO::Endpoint
 	class HostEndpoint < Generic
@@ -14,6 +14,10 @@ module IO::Endpoint
 		end
 		
 		def to_s
+			"host:#{@specification[0]}:#{@specification[1]}"
+		end
+		
+		def inspect
 			nodename, service, family, socktype, protocol, flags = @specification
 			
 			"\#<#{self.class} name=#{nodename.inspect} service=#{service.inspect} family=#{family.inspect} type=#{socktype.inspect} protocol=#{protocol.inspect} flags=#{flags.inspect}>"
@@ -34,7 +38,7 @@ module IO::Endpoint
 		# @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(wrapper = Wrapper.default, &block)
+		def connect(wrapper = self.wrapper, &block)
 			last_error = nil
 			
 			Addrinfo.foreach(*@specification) do |address|
@@ -59,7 +63,7 @@ module IO::Endpoint
 		# 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(wrapper = Wrapper.default, &block)
+		def bind(wrapper = self.wrapper, &block)
 			Addrinfo.foreach(*@specification).map do |address|
 				wrapper.bind(address, **@options, &block)
 			end

data/lib/io/endpoint/shared_endpoint.rb

@@ -3,5 +3,5 @@
 # Released under the MIT License.
 # Copyright, 2023-2024, by Samuel Williams.
 
-require_relative 'bound_endpoint'
-require_relative 'connected_endpoint'
+require_relative "bound_endpoint"
+require_relative "connected_endpoint"

data/lib/io/endpoint/socket_endpoint.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2023, by Samuel Williams.
+# Copyright, 2023-2024, by Samuel Williams.
 
-require_relative 'generic'
+require_relative "generic"
 
 module IO::Endpoint
 	# This class doesn't exert ownership over the specified socket, wraps a native ::IO.
@@ -15,6 +15,10 @@ module IO::Endpoint
 		end
 		
 		def to_s
+			"socket:#{@socket}"
+		end
+		
+		def inspect
 			"\#<#{self.class} #{@socket.inspect}>"
 		end
 		

data/lib/io/endpoint/ssl_endpoint.rb

@@ -3,10 +3,10 @@
 # Released under the MIT License.
 # Copyright, 2023-2024, by Samuel Williams.
 
-require_relative 'host_endpoint'
-require_relative 'generic'
+require_relative "host_endpoint"
+require_relative "generic"
 
-require 'openssl'
+require "openssl"
 
 module OpenSSL
 	module SSL
@@ -87,7 +87,11 @@ module IO::Endpoint
 		end
 		
 		def to_s
-			"\#<#{self.class} #{@endpoint}>"
+			"ssl:#{@endpoint}"
+		end
+		
+		def inspect
+			"\#<#{self.class} endpoint=#{@endpoint.inspect}>"
 		end
 		
 		def address

data/lib/io/endpoint/unix_endpoint.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2023, by Samuel Williams.
+# Copyright, 2023-2024, by Samuel Williams.
 
-require_relative 'address_endpoint'
+require_relative "address_endpoint"
 
 module IO::Endpoint
 	# This class doesn't exert ownership over the specified unix socket and ensures exclusive access by using `flock` where possible.
@@ -16,7 +16,11 @@ module IO::Endpoint
 		end
 		
 		def to_s
-			"\#<#{self.class} #{@path.inspect}>"
+			"unix:#{@path}"
+		end
+		
+		def inspect
+			"\#<#{self.class} path=#{@path.inspect}>"
 		end
 		
 		attr :path

data/lib/io/endpoint/version.rb

@@ -5,6 +5,6 @@
 
 class IO
 	module Endpoint
-		VERSION = "0.13.1"
+		VERSION = "0.15.0"
 	end
 end

data/lib/io/endpoint/wrapper.rb

@@ -1,14 +1,28 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2023-2024, by Samuel Williams.
+# Copyright, 2023-2025, by Samuel Williams.
 
-require 'socket'
+require "socket"
 
 module IO::Endpoint
 	class Wrapper
 		include ::Socket::Constants
 		
+		if Fiber.respond_to?(:scheduler)
+			def schedule(&block)
+				if Fiber.scheduler
+					Fiber.schedule(&block)
+				else
+					Thread.new(&block)
+				end
+			end
+		else
+			def schedule(&block)
+				Thread.new(&block)
+			end
+		end
+		
 		def set_timeout(io, timeout)
 			if io.respond_to?(:timeout=)
 				io.timeout = timeout
@@ -30,8 +44,13 @@ module IO::Endpoint
 			# It may not be supported by the protocol (e.g. UDP). ¯\_(ツ)_/¯
 		end
 		
-		def async
-			raise NotImplementedError
+		# Connect a socket to a remote address.
+		# This is an extension point for subclasses to provide additional functionality.
+		#
+		# @parameter socket [Socket] The socket to connect.
+		# @parameter remote_address [Address] The remote address to connect to.
+		def socket_connect(socket, remote_address)
+			socket.connect(remote_address.to_sockaddr)
 		end
 		
 		# Establish a connection to a given `remote_address`.
@@ -72,7 +91,7 @@ module IO::Endpoint
 			end
 			
 			begin
-				socket.connect(remote_address.to_sockaddr)
+				socket_connect(socket, remote_address)
 			rescue Exception
 				socket.close
 				raise
@@ -142,7 +161,7 @@ module IO::Endpoint
 			
 			return socket unless block_given?
 			
-			async do
+			schedule do
 				begin
 					yield socket
 				ensure
@@ -151,11 +170,21 @@ module IO::Endpoint
 			end
 		end
 		
+		# Accept a connection from a bound socket.
+		# This is an extension point for subclasses to provide additional functionality.
+		#
+		# @parameter server [Socket] The bound server socket.
+		# @returns [Tuple(Socket, Address)] The connected socket and the remote address.
+		def socket_accept(server)
+			server.accept
+		end
+		
 		# Bind to a local address and accept connections in a loop.
 		def accept(server, timeout: nil, linger: nil, **options, &block)
 			# Ensure we use a `loop do ... end` so that state is not leaked between iterations:
+			
 			loop do
-				socket, address = server.accept
+				socket, address = socket_accept(server)
 				
 				if linger
 					socket.setsockopt(SOL_SOCKET, SO_LINGER, 1)
@@ -165,7 +194,7 @@ module IO::Endpoint
 					set_timeout(socket, timeout)
 				end
 				
-				async do
+				schedule do
 					# Some sockets, notably SSL sockets, need application level negotiation before they are ready:
 					if socket.respond_to?(:start)
 						begin
@@ -183,31 +212,11 @@ module IO::Endpoint
 				end
 			end
 		end
-	end
-	
-	class ThreadWrapper < Wrapper
-		def async(&block)
-			::Thread.new(&block)
-		end
-	end
-	
-	class FiberWrapper < Wrapper
-		def async(&block)
-			::Fiber.schedule(&block)
-		end
-	end
-	
-	if Fiber.respond_to?(:scheduler)
-		def Wrapper.default
-			if Fiber.scheduler
-				FiberWrapper.new
-			else
-				ThreadWrapper.new
-			end
-		end
-	else
-		def Wrapper.default
-			ThreadWrapper.new
+		
+		DEFAULT = new
+		
+		def self.default
+			DEFAULT
 		end
 	end
 end

data/license.md

@@ -1,6 +1,6 @@
 # MIT License
 
-Copyright, 2023-2024, by Samuel Williams.  
+Copyright, 2023-2025, by Samuel Williams.  
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

metadata

@@ -1,11 +1,10 @@
 --- !ruby/object:Gem::Specification
 name: io-endpoint
 version: !ruby/object:Gem::Version
-  version: 0.13.1
+  version: 0.15.0
 platform: ruby
 authors:
 - Samuel Williams
-autorequire:
 bindir: bin
 cert_chain:
 - |
@@ -37,10 +36,8 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2024-08-27 00:00:00.000000000 Z
+date: 2025-02-11 00:00:00.000000000 Z
 dependencies: []
-description:
-email:
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -66,7 +63,6 @@ licenses:
 metadata:
   documentation_uri: https://socketry.github.io/io-endpoint
   source_code_uri: https://github.com/socketry/io-endpoint.git
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -81,8 +77,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Provides a separation of concerns interface for IO endpoints.
 test_files: []

metadata.gz.sig

@@ -1,6 +1,5 @@
-^-a�pы}x�7�!ipn�K��h��EWl}�Ă��ソ]�)	�?�
�n)3�[��x�,ό��|�1�K���9�S-F��g	BZ�<�Oթ Rj{�
:���\��ZC>6S��K_�}6_��$G�`���~bp,*���$
-��ix��`}r����]M���S i�7<����
-�
-��%�^��47��{��
ptl$��t���-=&YU&��ҁ��av���I�i4�s
->)����cC�٣Ŧ���{:-N.K#
-������2Dz^
+��UP���8�fp&	��f�޻����Y'mH���"wN1é�GL��Ǻ��
nUoe>�
+�
+m\oXk�Al&�,x���2��x��7�qx��À�� 
+��ݯ"�d�B�3O�=.
+���;b�-���z\%VK8��6�y}~od$g�S���y0If%G�Ȭ�i1Jd�!J/S��ڲg��3�x5�uڔQ0E���J`�k�����ҥ���0���#�ʃ3�N?$�Y�3Ml���[UG�6��@1��жT`�t��3{I���ZAUz?1j3�Mh/�\O.�@��.�q�3���Qf�|Iޔ6E�uӸ������}��_R��o�H�f\b�\p��7ʰ�%�n�uN���Y�J]I�h�b�!���9�|�