Action Cable – Integrated WebSockets for Rails (original) (raw)
Action Cable seamlessly integrates WebSockets with the rest of your Rails application. It allows for real-time features to be written in Ruby in the same style and form as the rest of your Rails application, while still being performant and scalable. It’s a full-stack offering that provides both a client-side JavaScript framework and a server-side Ruby framework. You have access to your full domain model written with Active Record or your ORM of choice.
You can read more about Action Cable in the Action Cable Overview guide.
Support
API documentation is at:
Bug reports for the Ruby on Rails project can be filed here:
Feature requests should be discussed on the rails-core mailing list here:
Namespace
- MODULE ActionCable::Channel
- MODULE ActionCable::Connection
- MODULE ActionCable::Helpers
- MODULE ActionCable::Server
- MODULE ActionCable::SubscriptionAdapter
- MODULE ActionCable::TestHelper
- MODULE ActionCable::VERSION
- CLASS ActionCable::RemoteConnections
- CLASS ActionCable::TestCase
Methods
G
S
V
Constants
| INTERNAL | = | { message_types: { welcome: "welcome", disconnect: "disconnect", ping: "ping", confirmation: "confirm_subscription", rejection: "reject_subscription" }, disconnect_reasons: { unauthorized: "unauthorized", invalid_request: "invalid_request", server_restart: "server_restart", remote: "remote" }, default_mount_path: "/cable", protocols: ["actioncable-v1-json", "actioncable-unsupported"].freeze } |
|---|---|---|
Class Public methods
gem_version()Link
Returns the currently loaded version of Action Cable as a Gem::Version.
def self.gem_version Gem::Version.new VERSION::STRING end
version()Link
Returns the currently loaded version of Action Cable as a Gem::Version.
Instance Public methods
server()Link
def server@server ||= ActionCable::Server::Base.new end