Getting Started

This guide shows how to add async to your project and run code asynchronously.

Scheduler

This guide gives an overview of how the scheduler is implemented.

Tasks

This guide explains how asynchronous tasks work and how to use them.

Best Practices

This guide gives an overview of best practices for using Async.

Debugging

This guide explains how to debug issues with programs that use Async.

Thread safety

This guide explains thread safety in Ruby, focusing on fibers and threads, common pitfalls, and best practices to avoid problems like data corruption, race conditions, and deadlocks.

Unreleased

• Thread-safe Async::Condition and Async::Notification, implemented using Thread::Queue.
• Thread-safe Async::Queue and Async::LimitedQueue, implemented using Thread::Queue and Thread::LimitedQueue respectively.

• Introduce Async::PriorityQueue.

v2.28.1

• Fix race condition between Async::Barrier#stop and finish signalling.

v2.28.0

• Use Traces.current_context and Traces.with_context for better integration with OpenTelemetry.

v2.27.4

• Suppress excessive warning in Async::Scheduler#async.

v2.27.3

• Ensure trace attributes are strings, fixes integration with OpenTelemetry.

v2.27.2

• Fix context/index.yaml schema.

v2.27.1

• Updated documentation and agent context.

v2.27.0

• Async::Task#stop supports an optional cause: argument (that defaults to $!), which allows you to specify the cause (exception) for stopping the task.
• Add thread-safety agent context.

v2.26.0

• Async::Notification#signal now returns true if a task was signaled, false otherwise, providing better feedback for notification operations.
• require "async/limited_queue" is required to use Async::LimitedQueue without a deprecation warning. Async::LimitedQueue is not deprecated, but it's usage via async/queue is deprecated.
• Async::Task#sleep is deprecated with no replacement.
• Async::Task.yield is deprecated with no replacement.
• Async::Scheduler#async is deprecated, use Async{}, Sync{} or Async::Task#async instead.
• Agent context is now available, via the agent-context gem.

• Async::Barrier Improvements
• 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
• Better handling of IO#close using fiber_interrupt