0.02
The project is in a healthy, maintained state
An asynchronous adapter for ActionCable.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
 Dependencies
 Project Readme

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.

Development Status

Usage

Please see the project documentation for more details.

  • 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 see the project releases for all releases.

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.

  1. Fork it.
  2. Create your feature branch (git checkout -b my-new-feature).
  3. Commit your changes (git commit -am 'Add some feature').
  4. Push to the branch (git push origin my-new-feature).
  5. 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.