Async is a composable asynchronous I/O framework for Ruby based on io-event.
"Lately I've been looking into
async, as one of my projects – tus-ruby-server – would really benefit from non-blocking I/O. It's really beautifully designed." – janko
Features
- Scalable event-driven I/O for Ruby. Thousands of clients per process!
- Light weight fiber-based concurrency. No need for callbacks!
- Multi-thread/process containers for parallelism.
- Growing eco-system of event-driven components.
Usage
Please browse the source code index or refer to the guides below.
Getting Started
This guide shows how to add async to your project and run code asynchronously.
Asynchronous Tasks
This guide explains how asynchronous tasks work and how to use them.
Scheduler
This guide gives an overview of how the scheduler is implemented.
Compatibility
This guide gives an overview of the compatibility of Async with Ruby and other frameworks.
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.
Releases
Please browse the releases for more details.
v2.23.0
- Rename
ASYNC_SCHEDULER_DEFAULT_WORKER_POOLtoASYNC_SCHEDULER_WORKER_POOL.
v2.21.1
v2.20.0
v2.19.0
v2.18.0
- Add support for
Sync(annotation:), so that you can annotate the block with a description of what it does, even if it doesn't create a new task.
v2.17.0
- Introduce
Async::Queue#pushandAsync::Queue#popfor compatibility with::Queue.
v2.16.0
See Also
- async-http — Asynchronous HTTP client/server.
- async-websocket — Asynchronous client and server websockets.
- async-dns — Asynchronous DNS resolver and server.
- falcon — A rack compatible server built on top of
async-http. - rubydns — An easy to use Ruby DNS server.
- slack-ruby-bot — A client for making slack bots.
Contributing
We welcome contributions to this project.
- Fork it.
- Create your feature branch (
git checkout -b my-new-feature). - Commit your changes (
git commit -am 'Add some feature'). - Push to the branch (
git push origin my-new-feature). - Create new Pull Request.
Developer Certificate of Origin
In order to protect users of this project, we require all contributors to comply with the Developer Certificate of Origin. This ensures that all contributions are properly licensed and attributed.
Community Guidelines
This project is best served by a collaborative and respectful environment. Treat each other professionally, respect differing viewpoints, and engage constructively. Harassment, discrimination, or harmful behavior is not tolerated. Communicate clearly, listen actively, and support one another. If any issues arise, please inform the project maintainers.