async 2.45.0 → 2.45.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3d9408068579f9a742c20019cf9024bbc4c545c239c4c5178e929c377ac06b6c
-  data.tar.gz: 699c17d5dbff6502e1611252982c3595b7b84d57284010222462b838e683d1ac
+  metadata.gz: f51489757a93062c6aa4ccf5ad1f3c7367c4a374166dc704d42168f13f539c86
+  data.tar.gz: 056c11094c9ea4bffc8c5b808a50a3af4bc699b24497cd3f9c8ea3afe3745cfb
 SHA512:
-  metadata.gz: a40ca6a441ad341267c5782d089d512b45b36765afbdd1c6382ebb7f931e273cdf29d08ae3a446a0b624618981730c2ee69e15d39adb0956dc44fc1d2ccd2ab9
-  data.tar.gz: 325d951d894d7c2fb9cc042534e5e8d76c3edbeb81c061993204ef345af499cfd0fd71ebaae0a6fbbdfd62afdf99a859564554c9cb97dcd730111385948aebf1
+  metadata.gz: 62c77f5b6dbb84291d2435e0098965d6d78b6dd906f8fd538adb5139240f18dc50484c89b0b7f0772aa0ad85139d3c31a38cbe36425d38f21dec7a310d22cae2
+  data.tar.gz: 5e356c8c7754bccece84388bb95ed6f9860924279d5f084673b62c6d0a1b549bdabb19e47b0b05748444b2f43e37d21addf70ed01b39aa5f994531b7676b4648

data/lib/async/scheduler.rb

@@ -307,6 +307,7 @@ module Async
 		# @parameter io [IO] The IO object to wait on.
 		# @parameter events [Integer] The events to wait for, e.g. `IO::READABLE`, `IO::WRITABLE`, etc.
 		# @parameter timeout [Float | Nil] The maximum time to wait, or if nil, indefinitely.
+		# @returns [Integer | false] The subset of events that are ready, or `false` if the timeout expires.
 		def io_wait(io, events, timeout = nil)
 			fiber = Fiber.current
 			expired = false
@@ -326,8 +327,8 @@ module Async
 			
 			# A selector wait may return a falsy result when the fiber is resumed without the requested IO becoming ready. For example, a deferred unblock from a previous blocking operation may arrive after the fiber has moved on to this wait. Retry these stale or spurious wake-ups without resetting the original timer.
 			until result = @selector.io_wait(fiber, io, events)
-				# If the original timer resumed the fiber, the falsy result represents the timeout rather than a spurious wake-up:
-				return nil if expired
+				# If the original timer resumed the fiber, the false result represents the timeout rather than a spurious wake-up:
+				return false if expired
 			end
 			
 			return result
@@ -336,16 +337,16 @@ module Async
 		end
 		
 		if ::IO::Event::Support.buffer?
-			# Read from the specified IO into the buffer.
+			# Read at most the specified number of bytes from the IO into the buffer.
 			#
 			# @public Since *Async v2* and Ruby with `IO::Buffer` support.
 			# @asynchronous May be non-blocking.
 			#
 			# @parameter io [IO] The IO object to read from.
 			# @parameter buffer [IO::Buffer] The buffer to read into.
-			# @parameter length [Integer] The minimum number of bytes to read.
 			# @parameter offset [Integer] The offset within the buffer to read into.
-			def io_read(io, buffer, length, offset = 0)
+			# @parameter length [Integer] The maximum number of bytes to read.
+			def io_read(io, buffer, offset, length)
 				fiber = Fiber.current
 				
 				if timeout = io.timeout
@@ -354,22 +355,22 @@ module Async
 					end
 				end
 				
-				@selector.io_read(fiber, io, buffer, length, offset)
+				@selector.io_read(fiber, io, buffer, offset, length)
 			ensure
 				timer&.cancel!
 			end
 			
 			if RUBY_ENGINE != "ruby" || RUBY_VERSION >= "3.3.1"
-				# Write the specified buffer to the IO.
+				# Write at most the specified number of bytes from the buffer to the IO.
 				#
 				# @public Since *Async v2* and *Ruby v3.3.1* with `IO::Buffer` support.
 				# @asynchronous May be non-blocking.
 				#
 				# @parameter io [IO] The IO object to write to.
 				# @parameter buffer [IO::Buffer] The buffer to write from.
-				# @parameter length [Integer] The minimum number of bytes to write.
 				# @parameter offset [Integer] The offset within the buffer to write from.
-				def io_write(io, buffer, length, offset = 0)
+				# @parameter length [Integer] The maximum number of bytes to write.
+				def io_write(io, buffer, offset, length)
 					fiber = Fiber.current
 					
 					if timeout = io.timeout
@@ -378,7 +379,7 @@ module Async
 						end
 					end
 					
-					@selector.io_write(fiber, io, buffer, length, offset)
+					@selector.io_write(fiber, io, buffer, offset, length)
 				ensure
 					timer&.cancel!
 				end

data/lib/async/version.rb

@@ -5,5 +5,5 @@
 
 # @namespace
 module Async
-	VERSION = "2.45.0"
+	VERSION = "2.45.1"
 end

data/readme.md

@@ -35,6 +35,10 @@ Please see the [project documentation](https://socketry.github.io/async/) for mo
 
 Please see the [project releases](https://socketry.github.io/async/releases/index) for all releases.
 
+### v2.45.1
+
+  - Fixed `Scheduler#io_wait` returning `nil` instead of `false` when an explicit timeout expired. Native callers such as `Socket#connect` with `connect_timeout:` distinguish a timeout by checking for `false`, so the `nil` caused `TypeError: no implicit conversion from nil to integer` instead of the intended `IO::TimeoutError`.
+
 ### v2.45.0
 
   - Fixed scheduler I/O and process waits returning prematurely after stale or interrupted wake-ups. I/O waits now preserve their original timeout, while blocking process waits retry and non-blocking `Process::WNOHANG` waits still return `nil`.
@@ -72,11 +76,6 @@ Please see the [project releases](https://socketry.github.io/async/releases/inde
   - Rename `Task#stop` to `Task#cancel` for better clarity and consistency with common concurrency terminology. The old `stop` method is still available as an alias for backward compatibility, but it is recommended to use `cancel` going forward.
   - Forward arguments from `Task#wait` -\> `Promise#wait`, so `task.wait(timeout: N)` is supported.
 
-### v2.37.0
-
-  - Introduce `Async::Loop` for robust, time-aligned loops.
-  - Add support for `Async::Promise#wait(timeout: N)`.
-
 ## See Also
 
   - [async-http](https://github.com/socketry/async-http) — Asynchronous HTTP client/server.

data/releases.md

@@ -1,5 +1,9 @@
 # Releases
 
+## v2.45.1
+
+  - Fixed `Scheduler#io_wait` returning `nil` instead of `false` when an explicit timeout expired. Native callers such as `Socket#connect` with `connect_timeout:` distinguish a timeout by checking for `false`, so the `nil` caused `TypeError: no implicit conversion from nil to integer` instead of the intended `IO::TimeoutError`.
+
 ## v2.45.0
 
   - Fixed scheduler I/O and process waits returning prematurely after stale or interrupted wake-ups. I/O waits now preserve their original timeout, while blocking process waits retry and non-blocking `Process::WNOHANG` waits still return `nil`.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: async
 version: !ruby/object:Gem::Version
-  version: 2.45.0
+  version: 2.45.1
 platform: ruby
 authors:
 - Samuel Williams