1
0
Fork 0
mirror of https://github.com/rails/rails.git synced 2022-11-09 12:12:34 -05:00
rails--rails/guides/source/action_cable_overview.md

875 lines
27 KiB
Markdown
Raw Normal View History

**DO NOT READ THIS FILE ON GITHUB, GUIDES ARE PUBLISHED ON https://guides.rubyonrails.org.**
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
Action Cable Overview
=====================
In this guide, you will learn how Action Cable works and how to use WebSockets to
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
incorporate real-time features into your Rails application.
After reading this guide, you will know:
* What Action Cable is and its integration backend and frontend
2019-08-09 17:30:15 -04:00
* How to set up Action Cable
* How to set up channels
* Deployment and Architecture setup for running Action Cable
--------------------------------------------------------------------------------
2016-02-23 22:36:37 -05:00
What is Action Cable?
---------------------
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
Action Cable seamlessly integrates
[WebSockets](https://en.wikipedia.org/wiki/WebSocket) 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.
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
Terminology
-----------
Action Cable uses WebSockets instead of the HTTP request-response protocol.
Both Action Cable and WebSockets introduce some less familiar terminology:
### Connections
*Connections* form the foundation of the client-server relationship.
A single Action Cable server can handle multiple connection instances. It has one
connection instance per WebSocket connection. A single user may have multiple
WebSockets open to your application if they use multiple browser tabs or devices.
### Consumers
The client of a WebSocket connection is called the *consumer*. In Action Cable
the consumer is created by the client-side JavaScript framework.
### Channels
Each consumer can in turn subscribe to multiple *channels*. Each channel
encapsulates a logical unit of work, similar to what a controller does in
a regular MVC setup. For example, you could have a `ChatChannel` and
an `AppearancesChannel`, and a consumer could be subscribed to either
or to both of these channels. At the very least, a consumer should be subscribed
to one channel.
### Subscribers
When the consumer is subscribed to a channel, they act as a *subscriber*.
The connection between the subscriber and the channel is, surprise-surprise,
called a subscription. A consumer can act as a subscriber to a given channel
any number of times. For example, a consumer could subscribe to multiple chat rooms
at the same time. (And remember that a physical user may have multiple consumers,
one per tab/device open to your connection).
### Pub/Sub
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
[Pub/Sub](https://en.wikipedia.org/wiki/Publish%E2%80%93subscribe_pattern), or
Publish-Subscribe, refers to a message queue paradigm whereby senders of
information (publishers), send data to an abstract class of recipients
(subscribers), without specifying individual recipients. Action Cable uses this
approach to communicate between the server and many clients.
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
### Broadcastings
A broadcasting is a pub/sub link where anything transmitted by the broadcaster is
sent directly to the channel subscribers who are streaming that named broadcasting.
Each channel can be streaming zero or more broadcastings.
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
## Server-Side Components
### Connections
2016-02-28 09:37:58 -05:00
For every WebSocket accepted by the server, a connection object is instantiated. This
object becomes the parent of all the *channel subscriptions* that are created
from there on. The connection itself does not deal with any specific application
logic beyond authentication and authorization. The client of a WebSocket
connection is called the connection *consumer*. An individual user will create
one consumer-connection pair per browser tab, window, or device they have open.
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
Connections are instances of `ApplicationCable::Connection`. In this class, you
authorize the incoming connection, and proceed to establish it if the user can
be identified.
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
#### Connection Setup
2016-02-28 09:37:58 -05:00
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
```ruby
# app/channels/application_cable/connection.rb
module ApplicationCable
class Connection < ActionCable::Connection::Base
identified_by :current_user
def connect
self.current_user = find_verified_user
end
2016-12-23 06:17:32 -05:00
private
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
def find_verified_user
if verified_user = User.find_by(id: cookies.encrypted[:user_id])
verified_user
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
else
reject_unauthorized_connection
end
end
end
end
```
2016-02-28 09:37:58 -05:00
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
Here `identified_by` is a connection identifier that can be used to find the
specific connection later. Note that anything marked as an identifier will automatically
2016-02-28 09:37:58 -05:00
create a delegate by the same name on any channel instances created off the connection.
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
2016-02-28 09:37:58 -05:00
This example relies on the fact that you will already have handled authentication of the user
somewhere else in your application, and that a successful authentication sets an encrypted
cookie with the user ID.
2016-02-28 09:37:58 -05:00
The cookie is then automatically sent to the connection instance when a new connection
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
is attempted, and you use that to set the `current_user`. By identifying the connection
by this same current user, you're also ensuring that you can later retrieve all open
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
connections by a given user (and potentially disconnect them all if the user is deleted
or unauthorized).
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
If your authentication approach includes using a session, you use cookie store for the
session, your session cookie is named `_session` and the user ID key is `user_id` you
can use this approach:
```ruby
verified_user = User.find_by(id: cookies.encrypted['_session']['user_id'])
```
#### Exception Handling
By default, unhandled exceptions are caught and logged to Rails' logger. If you would like to
globally intercept these exceptions and report them to an external bug tracking service, for
example, you can do so with
[`rescue_from`](https://api.rubyonrails.org/classes/ActiveSupport/Rescuable/ClassMethods.html#method-i-rescue_from).
```ruby
# app/channels/application_cable/connection.rb
module ApplicationCable
class Connection < ActionCable::Connection::Base
rescue_from StandardError, with: :report_error
private
def report_error(e)
SomeExternalBugtrackingService.notify(e)
end
end
end
```
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
### Channels
2016-02-28 09:37:58 -05:00
A *channel* encapsulates a logical unit of work, similar to what a controller does in a
regular MVC setup. By default, Rails creates a parent `ApplicationCable::Channel` class
for encapsulating shared logic between your channels.
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
#### Parent Channel Setup
2016-02-28 09:37:58 -05:00
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
```ruby
# app/channels/application_cable/channel.rb
module ApplicationCable
class Channel < ActionCable::Channel::Base
end
end
```
2016-02-28 09:37:58 -05:00
Then you would create your own channel classes. For example, you could have a
`ChatChannel` and an `AppearanceChannel`:
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
```ruby
2016-04-10 08:35:37 -04:00
# app/channels/chat_channel.rb
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
class ChatChannel < ApplicationCable::Channel
end
2016-04-10 08:35:37 -04:00
# app/channels/appearance_channel.rb
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
class AppearanceChannel < ApplicationCable::Channel
end
```
2016-02-28 09:37:58 -05:00
A consumer could then be subscribed to either or both of these channels.
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
#### Subscriptions
Consumers subscribe to channels, acting as *subscribers*. Their connection is
called a *subscription*. Produced messages are then routed to these channel
2020-07-14 15:17:57 -04:00
subscriptions based on an identifier sent by the channel consumer.
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
```ruby
2016-04-10 08:35:37 -04:00
# app/channels/chat_channel.rb
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
class ChatChannel < ApplicationCable::Channel
# Called when the consumer has successfully
# become a subscriber to this channel.
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
def subscribed
end
end
```
#### Exception Handling
As with `ActionCable::Connection::Base`, you can also use `rescue_from` on a
specific channel to handle raised exceptions:
```ruby
# app/channels/chat_channel.rb
class ChatChannel < ApplicationCable::Channel
rescue_from 'MyError', with: :deliver_error_message
private
def deliver_error_message(e)
broadcast_to(...)
end
end
```
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
## Client-Side Components
2016-02-28 09:37:58 -05:00
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
### Connections
2016-02-28 09:37:58 -05:00
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
Consumers require an instance of the connection on their side. This can be
established using the following JavaScript, which is generated by default by Rails:
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
#### Connect Consumer
2016-02-28 09:37:58 -05:00
```js
// app/javascript/channels/consumer.js
// Action Cable provides the framework to deal with WebSockets in Rails.
// You can generate new channels where WebSocket features live using the `bin/rails generate channel` command.
import { createConsumer } from "@rails/actioncable"
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
export default createConsumer()
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
```
2016-02-28 09:37:58 -05:00
This will ready a consumer that'll connect against `/cable` on your server by default.
2016-02-28 09:37:58 -05:00
The connection won't be established until you've also specified at least one subscription
you're interested in having.
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
The consumer can optionally take an argument that specifies the URL to connect to. This
can be a string, or a function that returns a string that will be called when the
WebSocket is opened.
```js
// Specify a different URL to connect to
createConsumer('https://ws.example.com/cable')
// Use a function to dynamically generate the URL
createConsumer(getWebSocketURL)
function getWebSocketURL {
const token = localStorage.get('auth-token')
return `https://ws.example.com/cable?token=${token}`
}
```
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
#### Subscriber
2016-02-28 09:37:58 -05:00
A consumer becomes a subscriber by creating a subscription to a given channel:
2016-02-28 09:37:58 -05:00
```js
// app/javascript/channels/chat_channel.js
import consumer from "./consumer"
consumer.subscriptions.create({ channel: "ChatChannel", room: "Best Room" })
// app/javascript/channels/appearance_channel.js
import consumer from "./consumer"
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
consumer.subscriptions.create({ channel: "AppearanceChannel" })
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
```
While this creates the subscription, the functionality needed to respond to
received data will be described later on.
A consumer can act as a subscriber to a given channel any number of times. For
example, a consumer could subscribe to multiple chat rooms at the same time:
```js
// app/javascript/channels/chat_channel.js
import consumer from "./consumer"
consumer.subscriptions.create({ channel: "ChatChannel", room: "1st Room" })
consumer.subscriptions.create({ channel: "ChatChannel", room: "2nd Room" })
```
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
## Client-Server Interactions
### Streams
2016-02-28 09:37:58 -05:00
*Streams* provide the mechanism by which channels route published content
(broadcasts) to their subscribers. The following example would
subscribe to the broadcasting `chat_Best Room` if the room parameter
is `Best Room`:
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
```ruby
2016-04-10 08:35:37 -04:00
# app/channels/chat_channel.rb
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
class ChatChannel < ApplicationCable::Channel
def subscribed
stream_from "chat_#{params[:room]}"
end
end
```
2016-02-23 22:05:46 -05:00
If you have a stream that is related to a model, then the broadcasting used
can be generated from the channel and model. The following example would
subscribe to a broadcasting like `comments:Z2lkOi8vVGVzdEFwcC9Qb3N0LzE`,
where `Z2lkOi8vVGVzdEFwcC9Qb3N0LzE` is the GlobalID of the Post model.
2016-02-23 22:05:46 -05:00
```ruby
class CommentsChannel < ApplicationCable::Channel
def subscribed
post = Post.find(params[:id])
stream_for post
end
end
```
2016-02-28 09:37:58 -05:00
You can then broadcast to this channel like this:
```ruby
CommentsChannel.broadcast_to(@post, @comment)
```
2016-02-23 22:05:46 -05:00
### Broadcasting
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
A *broadcasting* is a pub/sub link where anything transmitted by a publisher
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
is routed directly to the channel subscribers who are streaming that named
broadcasting. Each channel can be streaming zero or more broadcastings.
Broadcastings are purely an online queue and time-dependent. If a consumer is
not streaming (subscribed to a given channel), they'll not get the broadcast
should they connect later.
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
Broadcasts are called elsewhere in your Rails application:
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
```ruby
WebNotificationsChannel.broadcast_to(
current_user,
title: 'New things!',
body: 'All the news fit to print'
)
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
```
The `WebNotificationsChannel.broadcast_to` call places a message in the current
subscription adapter's pubsub queue under a separate broadcasting name for each user.
The default pubsub queue for Action Cable is `redis` in production and `async` in development and
test environments. For a user with an ID of 1, the broadcasting name would be `web_notifications:1`.
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
The channel has been instructed to stream everything that arrives at
`web_notifications:1` directly to the client by invoking the `received`
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
callback.
### Subscriptions
When a consumer is subscribed to a channel, they act as a subscriber. This
connection is called a subscription. Incoming messages are then routed to
these channel subscriptions based on an identifier sent by the cable consumer.
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
```js
// app/javascript/channels/chat_channel.js
// Assumes you've already requested the right to send web notifications
import consumer from "./consumer"
consumer.subscriptions.create({ channel: "ChatChannel", room: "Best Room" }, {
received(data) {
this.appendLine(data)
},
appendLine(data) {
const html = this.createLine(data)
const element = document.querySelector("[data-chat-room='Best Room']")
element.insertAdjacentHTML("beforeend", html)
},
createLine(data) {
return `
<article class="chat-line">
<span class="speaker">${data["sent_by"]}</span>
<span class="body">${data["body"]}</span>
</article>
`
}
})
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
```
### Passing Parameters to Channels
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
You can pass parameters from the client side to the server side when creating a
subscription. For example:
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
```ruby
# app/channels/chat_channel.rb
class ChatChannel < ApplicationCable::Channel
def subscribed
stream_from "chat_#{params[:room]}"
end
end
```
An object passed as the first argument to `subscriptions.create` becomes the
params hash in the cable channel. The keyword `channel` is required:
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
```js
// app/javascript/channels/chat_channel.js
import consumer from "./consumer"
consumer.subscriptions.create({ channel: "ChatChannel", room: "Best Room" }, {
received(data) {
this.appendLine(data)
},
appendLine(data) {
const html = this.createLine(data)
const element = document.querySelector("[data-chat-room='Best Room']")
element.insertAdjacentHTML("beforeend", html)
},
createLine(data) {
return `
<article class="chat-line">
<span class="speaker">${data["sent_by"]}</span>
<span class="body">${data["body"]}</span>
</article>
`
}
})
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
```
```ruby
# Somewhere in your app this is called, perhaps
# from a NewCommentJob.
ActionCable.server.broadcast(
"chat_#{room}",
sent_by: 'Paul',
body: 'This is a cool chat app.'
)
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
```
### Rebroadcasting a Message
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
A common use case is to *rebroadcast* a message sent by one client to any
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
other connected clients.
```ruby
# app/channels/chat_channel.rb
class ChatChannel < ApplicationCable::Channel
def subscribed
stream_from "chat_#{params[:room]}"
end
def receive(data)
ActionCable.server.broadcast("chat_#{params[:room]}", data)
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
end
end
```
```js
// app/javascript/channels/chat_channel.js
import consumer from "./consumer"
const chatChannel = consumer.subscriptions.create({ channel: "ChatChannel", room: "Best Room" }, {
received(data) {
// data => { sent_by: "Paul", body: "This is a cool chat app." }
}
}
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
chatChannel.send({ sent_by: "Paul", body: "This is a cool chat app." })
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
```
The rebroadcast will be received by all connected clients, _including_ the
client that sent the message. Note that params are the same as they were when
you subscribed to the channel.
## Full-Stack Examples
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
The following setup steps are common to both examples:
1. [Setup your connection](#connection-setup).
2. [Setup your parent channel](#parent-channel-setup).
3. [Connect your consumer](#connect-consumer).
### Example 1: User Appearances
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
Here's a simple example of a channel that tracks whether a user is online or not
and what page they're on. (This is useful for creating presence features like showing
a green dot next to a user name if they're online).
Create the server-side appearance channel:
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
```ruby
# app/channels/appearance_channel.rb
class AppearanceChannel < ApplicationCable::Channel
def subscribed
current_user.appear
end
def unsubscribed
current_user.disappear
end
def appear(data)
current_user.appear(on: data['appearing_on'])
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
end
def away
current_user.away
end
end
```
When a subscription is initiated the `subscribed` callback gets fired and we
take that opportunity to say "the current user has indeed appeared". That
appear/disappear API could be backed by Redis, a database, or whatever else.
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
Create the client-side appearance channel subscription:
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
```js
// app/javascript/channels/appearance_channel.js
import consumer from "./consumer"
consumer.subscriptions.create("AppearanceChannel", {
// Called once when the subscription is created.
initialized() {
this.update = this.update.bind(this)
},
// Called when the subscription is ready for use on the server.
connected() {
this.install()
this.update()
},
// Called when the WebSocket connection is closed.
disconnected() {
this.uninstall()
},
// Called when the subscription is rejected by the server.
rejected() {
this.uninstall()
},
update() {
this.documentIsActive ? this.appear() : this.away()
},
appear() {
// Calls `AppearanceChannel#appear(data)` on the server.
this.perform("appear", { appearing_on: this.appearingOn })
},
away() {
// Calls `AppearanceChannel#away` on the server.
this.perform("away")
},
install() {
window.addEventListener("focus", this.update)
window.addEventListener("blur", this.update)
document.addEventListener("turbolinks:load", this.update)
document.addEventListener("visibilitychange", this.update)
},
uninstall() {
window.removeEventListener("focus", this.update)
window.removeEventListener("blur", this.update)
document.removeEventListener("turbolinks:load", this.update)
document.removeEventListener("visibilitychange", this.update)
},
get documentIsActive() {
return document.visibilityState == "visible" && document.hasFocus()
},
get appearingOn() {
const element = document.querySelector("[data-appearing-on]")
return element ? element.getAttribute("data-appearing-on") : null
}
})
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
```
##### Client-Server Interaction
1. **Client** connects to the **Server** via `App.cable =
ActionCable.createConsumer("ws://cable.example.com")`. (`cable.js`). The
**Server** identifies this connection by `current_user`.
2. **Client** subscribes to the appearance channel via
`consumer.subscriptions.create({ channel: "AppearanceChannel" })`. (`appearance_channel.js`)
3. **Server** recognizes a new subscription has been initiated for the
appearance channel and runs its `subscribed` callback, calling the `appear`
method on `current_user`. (`appearance_channel.rb`)
4. **Client** recognizes that a subscription has been established and calls
`connected` (`appearance_channel.js`) which in turn calls `install` and `appear`.
`appear` calls `AppearanceChannel#appear(data)` on the server, and supplies a
data hash of `{ appearing_on: this.appearingOn }`. This is
possible because the server-side channel instance automatically exposes all
public methods declared on the class (minus the callbacks), so that these can be
reached as remote procedure calls via a subscription's `perform` method.
5. **Server** receives the request for the `appear` action on the appearance
channel for the connection identified by `current_user`
(`appearance_channel.rb`). **Server** retrieves the data with the
`:appearing_on` key from the data hash and sets it as the value for the `:on`
key being passed to `current_user.appear`.
### Example 2: Receiving New Web Notifications
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
The appearance example was all about exposing server functionality to
client-side invocation over the WebSocket connection. But the great thing
about WebSockets is that it's a two-way street. So now let's show an example
where the server invokes an action on the client.
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
This is a web notification channel that allows you to trigger client-side
web notifications when you broadcast to the right streams:
Create the server-side web notifications channel:
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
```ruby
# app/channels/web_notifications_channel.rb
class WebNotificationsChannel < ApplicationCable::Channel
def subscribed
2016-02-28 09:37:58 -05:00
stream_for current_user
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
end
end
```
Create the client-side web notifications channel subscription:
```js
// app/javascript/channels/web_notifications_channel.js
// Client-side which assumes you've already requested
// the right to send web notifications.
import consumer from "./consumer"
consumer.subscriptions.create("WebNotificationsChannel", {
received(data) {
new Notification(data["title"], body: data["body"])
}
})
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
```
Broadcast content to a web notification channel instance from elsewhere in your
application:
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
```ruby
# Somewhere in your app this is called, perhaps from a NewCommentJob
WebNotificationsChannel.broadcast_to(
current_user,
title: 'New things!',
body: 'All the news fit to print'
)
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
```
The `WebNotificationsChannel.broadcast_to` call places a message in the current
subscription adapter's pubsub queue under a separate broadcasting name for each
user. For a user with an ID of 1, the broadcasting name would be
`web_notifications:1`.
2016-02-28 09:37:58 -05:00
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
The channel has been instructed to stream everything that arrives at
`web_notifications:1` directly to the client by invoking the `received`
callback. The data passed as argument is the hash sent as the second parameter
to the server-side broadcast call, JSON encoded for the trip across the wire
and unpacked for the data argument arriving as `received`.
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
### More Complete Examples
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
2016-05-06 11:07:27 -04:00
See the [rails/actioncable-examples](https://github.com/rails/actioncable-examples)
2019-08-09 17:30:15 -04:00
repository for a full example of how to set up Action Cable in a Rails app and adding channels.
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
## Configuration
2016-02-28 09:37:58 -05:00
Action Cable has two required configurations: a subscription adapter and allowed request origins.
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
### Subscription Adapter
By default, Action Cable looks for a configuration file in `config/cable.yml`.
The file must specify an adapter for each Rails environment. See the
[Dependencies](#dependencies) section for additional information on adapters.
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
```yaml
development:
2016-02-28 09:37:58 -05:00
adapter: async
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
test:
adapter: async
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
production:
adapter: redis
url: redis://10.10.3.153:6381
channel_prefix: appname_production
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
```
#### Adapter Configuration
Below is a list of the subscription adapters available for end users.
##### Async Adapter
The async adapter is intended for development/testing and should not be used in production.
##### Redis Adapter
The Redis adapter requires users to provide a URL pointing to the Redis server.
2017-10-06 02:02:56 -04:00
Additionally, a `channel_prefix` may be provided to avoid channel name collisions
when using the same Redis server for multiple applications. See the [Redis PubSub documentation](https://redis.io/topics/pubsub#database-amp-scoping) for more details.
##### PostgreSQL Adapter
The PostgreSQL adapter uses Active Record's connection pool, and thus the
application's `config/database.yml` database configuration, for its connection.
This may change in the future. [#27214](https://github.com/rails/rails/issues/27214)
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
### Allowed Request Origins
Action Cable will only accept requests from specified origins, which are
passed to the server config as an array. The origins can be instances of
strings or regular expressions, against which a check for the match will be performed.
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
```ruby
config.action_cable.allowed_request_origins = ['https://rubyonrails.com', %r{http://ruby.*}]
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
```
To disable and allow requests from any origin:
```ruby
config.action_cable.disable_request_forgery_protection = true
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
```
By default, Action Cable allows all requests from localhost:3000 when running
in the development environment.
### Consumer Configuration
To configure the URL, add a call to `action_cable_meta_tag` in your HTML layout
HEAD. This uses a URL or path typically set via `config.action_cable.url` in the
environment configuration files.
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
### Worker Pool Configuration
The worker pool is used to run connection callbacks and channel actions in
isolation from the server's main thread. Action Cable allows the application
to configure the number of simultaneously processed threads in the worker pool.
```ruby
config.action_cable.worker_pool_size = 4
```
Also, note that your server must provide at least the same number of database
connections as you have workers. The default worker pool size is set to 4, so
that means you have to make at least 4 database connections available.
You can change that in `config/database.yml` through the `pool` attribute.
### Client side logging
Client side logging is disabled by default. You can enable this by setting the `ActionCable.logger.enabled` to true.
```ruby
import * as ActionCable from '@rails/actioncable'
ActionCable.logger.enabled = true
```
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
### Other Configurations
The other common option to configure is the log tags applied to the
per-connection logger. Here's an example that uses
the user account id if available, else "no-account" while tagging:
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
```ruby
config.action_cable.log_tags = [
-> request { request.env['user_account_id'] || "no-account" },
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
:action_cable,
-> request { request.uuid }
]
```
For a full list of all configuration options, see the
`ActionCable::Server::Configuration` class.
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
## Running Standalone Cable Servers
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
### In App
Action Cable can run alongside your Rails application. For example, to
listen for WebSocket requests on `/websocket`, specify that path to
`config.action_cable.mount_path`:
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
```ruby
# config/application.rb
class Application < Rails::Application
config.action_cable.mount_path = '/websocket'
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
end
```
You can use `ActionCable.createConsumer()` to connect to the cable
server if `action_cable_meta_tag` is invoked in the layout. Otherwise, A path is
specified as first argument to `createConsumer` (e.g. `ActionCable.createConsumer("/websocket")`).
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
For every instance of your server you create and for every worker your server
spawns, you will also have a new instance of Action Cable, but the use of Redis
keeps messages synced across connections.
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
### Standalone
The cable servers can be separated from your normal application server. It's
still a Rack application, but it is its own Rack application. The recommended
basic setup is as follows:
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
```ruby
# cable/config.ru
require_relative "../config/environment"
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
Rails.application.eager_load!
run ActionCable.server
```
Then you start the server using a binstub in `bin/cable` ala:
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
```
#!/bin/bash
bundle exec puma -p 28080 cable/config.ru
```
The above will start a cable server on port 28080.
### Notes
The WebSocket server doesn't have access to the session, but it has
access to the cookies. This can be used when you need to handle
authentication. You can see one way of doing that with Devise in this [article](https://greg.molnar.io/blog/actioncable-devise-authentication/).
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
## Dependencies
Action Cable provides a subscription adapter interface to process its
pubsub internals. By default, asynchronous, inline, PostgreSQL, and Redis
adapters are included. The default adapter
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
in new Rails applications is the asynchronous (`async`) adapter.
The Ruby side of things is built on top of [websocket-driver](https://github.com/faye/websocket-driver-ruby),
[nio4r](https://github.com/celluloid/nio4r), and [concurrent-ruby](https://github.com/ruby-concurrency/concurrent-ruby).
## Deployment
Action Cable is powered by a combination of WebSockets and threads. Both the
framework plumbing and user-specified channel work are handled internally by
utilizing Ruby's native thread support. This means you can use all your regular
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
Rails models with no problem, as long as you haven't committed any thread-safety sins.
The Action Cable server implements the Rack socket hijacking API,
Create action_cable_overview.md resolves #23176 [ci skip] Rails Guide for Action Cable Added content from README Pull additional information from Action Cable README and restructured Client/Server elements Update to list numbering Switched from list numbers to headings in the examples Change AppearancesChannel to AppearanceChannel Word missing fixed missing word. Removed Mistaken nesting of Channel class Removed nesting of ChatChannel and AppearanceChannel from within ApplicationChannel Module. (Copy&Paste error) Incorporated first round of comments 1. Capitalize "action cable" 2. Separated "Consumers require... via JavaScript" into two sentences 3. Minor typographical correction (remember...) 4. Extra backtick 5. Revised text which implied Redis was the exclusive storage adapter to reflect it's position as default. 6. Revised reference to denote correct config file location: config/cable.yml 7. Added adapter: redis to environment configuration blocks 8. Capitalized "R" for "Rack" 9. Revised syntax for routing to reflect the hash syntax. (to: NOT :to =>) 10. Removed reference to Action Cable being separate from Rails. 11. Began revision for adapter API [I believe this requires a reformatting of the 'Redis' portion of the configuration section to simply "Storage Adapters"] 12. Celluloid -> Concurrent-ruby Moved errant grave mark [ci skip] Reordered "In App" above "Standalone" [ci skip] Reordered to reflect "In App" as preferable to "Standalone" Action Cable Deployment [ci skip] Removed paragraph that alludes to Action Cable not being able to run in the same process as Rails. Removed EM reference and updated deployment [ci skip] Removed explicit multi-threaded server dependency reference [ci skip] Revised Configuration and fixed typos [ci skip] Switched Lifecycle Graphic for Detailed Description [ci skip] Switched from Lifecycle graphic to detailed description to facilitate revision and maintainability in the future. Capitalized Heading (typo) [ci skip] Implemented merged commits from README [ci skip] Pulled over all (or at least I believe all) merged commits from README. (Dec 14, 2015 - Feb 11, 2016) Editorial - Capitalize WebSockets [ci skip] Reformated lines to ~75 characters [ci skip]
2015-12-18 15:04:38 -05:00
thereby allowing the use of a multithreaded pattern for managing connections
internally, irrespective of whether the application server is multi-threaded or not.
Accordingly, Action Cable works with popular servers like Unicorn, Puma, and
Passenger.
2019-01-13 22:58:47 -05:00
## Testing
You can find detailed instructions on how to test your Action Cable functionality in the
[testing guide](testing.html#testing-action-cable).