async 2.29.0 → 2.30.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 643f4000360902d473fec7d3c35dfa4d810499a7ee2d419bb6a44e185e4ce9a6
-  data.tar.gz: fd8150c4df0e9834259c612811856764dde221f3e21a58cb33ae7a9903822f8a
+  metadata.gz: 1423e2d1cc2a1e1aec71d5e70640a0b8c8069d6a2b2af9da63f7bed3d0c9d548
+  data.tar.gz: 2529e362cd8141d9fa0d8a6ea29fd0d74298630cdd8d4034633c20365a2c5491
 SHA512:
-  metadata.gz: 39886cbaf6b6d9a10522956c67d2c5228e22aeefe27104456f3e767441b43b13887ddb41c71e7bc2cffab7956e17117a9e0a8df64d585ecbfe532a87c2f2d592
-  data.tar.gz: b282710c3ce0fc5db35b7de431fa7d8121c9ca3d2ef4ccb1b0c5cafc26a84162eff01aae53b1b267683d8a0c635a991afae54e4d73d3cf7c2a8b23e2e8d32cdf
+  metadata.gz: 3455b22a4ea6a6e438e1da05ab9c4f5e7cf4d7f8f465138814c71743b2a6d7c1b1525cc3bb13b065b0aa67d0a57d5409d23cc101c61bd026c6ace345919f0005
+  data.tar.gz: fb21c61222c5067d272f8e5b845fcdef9ce2f99ab831cebf6575e94068b5e22f365569a2b2af1c5ec704b7e1bf53de93ef4c6143c014e5d77f9995908761b975

data/lib/async/priority_queue.rb

@@ -39,12 +39,24 @@ module Async
 				condition.signal
 			end
 			
-			def wait_for_value(mutex)
-				condition.wait(mutex)
+			def wait_for_value(mutex, timeout = nil)
+				condition.wait(mutex, timeout)
 				return self.value
 			end
+			
+			# Invalidate this waiter, making it unusable and detectable as abandoned.
+			def invalidate!
+				self.fiber = nil
+			end
+			
+			# Check if this waiter has been invalidated.
+			def valid?
+				self.fiber&.alive?
+			end
 		end
 		
+		private_constant :Waiter
+		
 		# Create a new priority queue.
 		#
 		# @parameter parent [Interface(:async) | Nil] The parent task to use for async operations.
@@ -64,16 +76,18 @@ module Async
 			@mutex.synchronize do
 				@closed = true
 				
-				# Signal all waiting fibers with nil, skipping dead ones:
+				# Signal all waiting fibers with nil, skipping dead/invalid ones:
 				while waiter = @waiting.pop
-					if waiter.fiber.alive?
-						waiter.signal(nil)
-					end
-					# Dead waiter discarded, continue to next one.
+					waiter.signal(nil)
 				end
 			end
 		end
 		
+		# @returns [Boolean] Whether the queue is closed.
+		def closed?
+			@closed
+		end
+		
 		# @attribute [Array] The items in the queue.
 		attr :items
 		
@@ -105,14 +119,14 @@ module Async
 				
 				@items << item
 				
-				# Wake up the highest priority waiter if any, skipping dead waiters:
+				# Wake up the highest priority waiter if any, skipping dead/invalid waiters:
 				while waiter = @waiting.pop
-					if waiter.fiber.alive?
+					if waiter.valid?
 						value = @items.shift
 						waiter.signal(value)
 						break
 					end
-					# Dead waiter discarded, try next one.
+					# Dead/invalid waiter discarded, try next one.
 				end
 			end
 		end
@@ -133,26 +147,27 @@ module Async
 				
 				@items.concat(items)
 				
-				# Wake up waiting fibers in priority order, skipping dead waiters:
+				# Wake up waiting fibers in priority order, skipping dead/invalid waiters:
 				while !@items.empty? && (waiter = @waiting.pop)
-					if waiter.fiber.alive?
+					if waiter.valid?
 						value = @items.shift
 						waiter.signal(value)
 					end
-					# Dead waiter discarded, continue to next one.
+					# Dead/invalid waiter discarded, continue to next one.
 				end
 			end
 		end
 		
 		# Remove and return the next item from the queue.
 		#
-		# If the queue is empty, this method will block until an item is available.
+		# If the queue is empty, this method will block until an item is available or timeout expires.
 		# Fibers are served in priority order, with higher priority fibers receiving
 		# items first.
 		#
 		# @parameter priority [Numeric] The priority of this consumer (higher = served first).
-		# @returns [Object] The next item in the queue.
-		def dequeue(priority: 0)
+		# @parameter timeout [Numeric, nil] Maximum time to wait for an item. If nil, waits indefinitely. If 0, returns immediately.
+		# @returns [Object, nil] The next item in the queue, or nil if timeout expires.
+		def dequeue(priority: 0, timeout: nil)
 			@mutex.synchronize do
 				# If queue is closed and empty, return nil immediately:
 				if @closed && @items.empty?
@@ -167,25 +182,34 @@ module Async
 					end
 				end
 				
+				# Handle immediate timeout (non-blocking)
+				return nil if timeout == 0
+				
 				# Need to wait - create our own condition variable and add to waiting queue:
 				sequence = @sequence
 				@sequence += 1
 				
 				condition = ConditionVariable.new
-				waiter = Waiter.new(Fiber.current, priority, sequence, condition, nil)
-				@waiting.push(waiter)
 				
-				# Wait for our specific condition variable to be signaled:
-				# The mutex is released during wait, reacquired after:
-				return waiter.wait_for_value(@mutex)
+				begin
+					waiter = Waiter.new(Fiber.current, priority, sequence, condition, nil)
+					@waiting.push(waiter)
+					
+					# Wait for our specific condition variable to be signaled:
+					return waiter.wait_for_value(@mutex, timeout)
+				ensure
+					waiter&.invalidate!
+				end
 			end
 		end
 		
 		# Compatibility with {::Queue#pop}.
 		#
 		# @parameter priority [Numeric] The priority of this consumer.
-		def pop(priority: 0)
-			self.dequeue(priority: priority)
+		# @parameter timeout [Numeric, nil] Maximum time to wait for an item. If nil, waits indefinitely. If 0, returns immediately.
+		# @returns [Object, nil] The dequeued item, or nil if timeout expires.
+		def pop(priority: 0, timeout: nil)
+			self.dequeue(priority: priority, timeout: timeout)
 		end
 		
 		# Process each item in the queue.

data/lib/async/queue.rb

@@ -73,13 +73,17 @@ module Async
 		end
 		
 		# Remove and return the next item from the queue.
-		def dequeue
-			@delegate.pop
+		# @parameter timeout [Numeric, nil] Maximum time to wait for an item. If nil, waits indefinitely. If 0, returns immediately.
+		# @returns [Object, nil] The dequeued item, or nil if timeout expires.
+		def dequeue(timeout: nil)
+			@delegate.pop(timeout: timeout)
 		end
 		
 		# Compatibility with {::Queue#pop}.
-		def pop(...)
-			@delegate.pop(...)
+		# @parameter timeout [Numeric, nil] Maximum time to wait for an item. If nil, waits indefinitely. If 0, returns immediately.
+		# @returns [Object, nil] The dequeued item, or nil if timeout expires.
+		def pop(timeout: nil)
+			@delegate.pop(timeout: timeout)
 		end
 		
 		# Process each item in the queue.

data/lib/async/version.rb

@@ -4,5 +4,5 @@
 # Copyright, 2017-2025, by Samuel Williams.
 
 module Async
-	VERSION = "2.29.0"
+	VERSION = "2.30.0"
 end

data/readme.md

@@ -35,6 +35,13 @@ 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.30.0
+
+  - Add timeout support to `Async::Queue#dequeue` and `Async::Queue#pop` methods.
+  - Add timeout support to `Async::PriorityQueue#dequeue` and `Async::PriorityQueue#pop` methods.
+  - Add `closed?` method to `Async::PriorityQueue` for full queue interface compatibility.
+  - Support non-blocking operations using `timeout: 0` parameter.
+
 ### v2.29.0
 
 This release introduces thread-safety as a core concept of Async. Many core classes now have thread-safe guarantees, allowing them to be used safely across multiple threads.
@@ -85,12 +92,6 @@ This release introduces thread-safety as a core concept of Async. Many core clas
   - [`Async::Barrier` Improvements](https://socketry.github.io/async/releases/index#async::barrier-improvements)
   - [Introduce `Async::Queue#close`](https://socketry.github.io/async/releases/index#introduce-async::queue#close)
 
-### v2.25.0
-
-  - Added support for `io_select` hook in the fiber scheduler, allowing non-blocking `IO.select` operations. This enables better integration with code that uses `IO.select` for multiplexing IO operations.
-  - [Use `IO::Event::WorkerPool` for Blocking Operations](https://socketry.github.io/async/releases/index#use-io::event::workerpool-for-blocking-operations)
-  - [Better handling of `IO#close` using `fiber_interrupt`](https://socketry.github.io/async/releases/index#better-handling-of-io#close-using-fiber_interrupt)
-
 ## See Also
 
   - [async-http](https://github.com/socketry/async-http) — Asynchronous HTTP client/server.

data/releases.md

@@ -1,5 +1,12 @@
 # Releases
 
+## v2.30.0
+
+  - Add timeout support to `Async::Queue#dequeue` and `Async::Queue#pop` methods.
+  - Add timeout support to `Async::PriorityQueue#dequeue` and `Async::PriorityQueue#pop` methods.
+  - Add `closed?` method to `Async::PriorityQueue` for full queue interface compatibility.
+  - Support non-blocking operations using `timeout: 0` parameter.
+
 ## v2.29.0
 
 This release introduces thread-safety as a core concept of Async. Many core classes now have thread-safe guarantees, allowing them to be used safely across multiple threads.

metadata

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