Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/socketry/nio4r

Cross-platform asynchronous I/O primitives for scalable network clients and servers.
https://github.com/socketry/nio4r

Last synced: 2 days ago
JSON representation

Cross-platform asynchronous I/O primitives for scalable network clients and servers.

Host: GitHub
URL: https://github.com/socketry/nio4r
Owner: socketry
License: other
Created: 2011-12-22T00:48:15.000Z (almost 13 years ago)
Default Branch: main
Last Pushed: 2024-10-28T20:54:03.000Z (6 days ago)
Last Synced: 2024-11-01T13:29:23.700Z (2 days ago)
Language: C
Homepage:
Size: 1.03 MB
Stars: 968
Watchers: 31
Forks: 86
Open Issues: 9
Metadata Files:
- Readme: readme.md
- Changelog: changes.md
- License: license.md

Awesome Lists containing this project

README

# ![nio4r](https://raw.github.com/socketry/nio4r/master/logo.png)

[![Development Status](https://github.com/socketry/nio4r/workflows/Test/badge.svg)](https://github.com/socketry/nio4r/actions?workflow=Test)

**New I/O for Ruby (nio4r)**: cross-platform asynchronous I/O primitives for
scalable network clients and servers. Modeled after the Java NIO API, but
simplified for ease-of-use.

**nio4r** provides an abstract, cross-platform stateful I/O selector API for Ruby.
I/O selectors are the heart of "reactor"-based event loops, and monitor
multiple I/O objects for various types of readiness, e.g. ready for reading or
writing.

## Projects using nio4r

- [ActionCable](https://rubygems.org/gems/actioncable): Rails 5 WebSocket protocol, uses nio4r for a WebSocket server
- [Celluloid](https://github.com/celluloid/celluloid-io): Actor-based concurrency framework, uses nio4r for async I/O
- [Async](https://github.com/socketry/async): Asynchronous I/O framework for Ruby
- [Puma](https://github.com/puma/puma): Ruby/Rack web server built for concurrency

## Goals

- Expose high-level interfaces for stateful IO selectors
- Keep the API small to maximize both portability and performance across many
different OSes and Ruby VMs
- Provide inherently thread-safe facilities for working with IO objects

## Supported platforms

- Ruby 2.5
- Ruby 2.6
- Ruby 2.7
- Ruby 3.0
- [JRuby](https://github.com/jruby/jruby)
- [TruffleRuby](https://github.com/oracle/truffleruby)

## Supported backends

- **libev**: MRI C extension targeting multiple native IO selector APIs (e.g epoll, kqueue)
- **Java NIO**: JRuby extension which wraps the Java NIO subsystem
- **Pure Ruby**: `Kernel.select`-based backend that should work on any Ruby interpreter

## Documentation

[Please see the nio4r wiki](https://github.com/socketry/nio4r/wiki)
for more detailed documentation and usage notes:

- [Getting Started](https://github.com/socketry/nio4r/wiki/Getting-Started): Introduction to nio4r's components
- [Selectors](https://github.com/socketry/nio4r/wiki/Selectors): monitor multiple `IO` objects for readiness events
- [Monitors](https://github.com/socketry/nio4r/wiki/Monitors): control interests and inspect readiness for specific `IO` objects
- [Byte Buffers](https://github.com/socketry/nio4r/wiki/Byte-Buffers): fixed-size native buffers for high-performance I/O