Async::Cable

This is a proof-of-concept adapter for Action Cable.

The next branch tracks Rails main and relies on the ActionCable::Server::Socket abstraction introduced by rails/rails#50979 (Rails 8.1+). For stable Rails (≤ 8.0), use the main branch, which depends on actioncable-next.

Usage

Please browse the source code index or refer to the guides below.

Getting Started

This guide shows you how to add async-cable to your project to enable real-time communication between clients and servers using Falcon and Action Cable.

Releases

Please browse the releases for more details.

Unreleased

Add Async::Cable::Socket#raw_transmit for pushing pre-encoded payloads to the client without re-encoding. Enables "fastlane" broadcasts that encode the message once and share it across many connections.

v0.3.0

Filter requests based on path - don't eat all inbound WebSocket connections.

v0.2.0

Don't close the WebSocket if it is already closed.

v0.1.0

Initial implementation.

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.

Running Tests

To run the test suite:

bundle exec sus

Making Releases

To make a new release:

bundle exec bake gem:release:patch # or minor or major

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.