aboutsummaryrefslogtreecommitdiffstats
path: root/actioncable
diff options
context:
space:
mode:
authorDavid Heinemeier Hansson <david@loudthinking.com>2015-12-21 14:32:44 +0100
committerDavid Heinemeier Hansson <david@loudthinking.com>2015-12-21 14:32:44 +0100
commit97eb5553f9b750963b4891171fb6e3fd3526a5a6 (patch)
treeb77d22f13697a00acd858a4c4008cce384d14517 /actioncable
parent26a8320c727cb516b116bf4e7d40bb134b2c42b5 (diff)
parent9f00021268ea5910bc6b4feb1c456ef16d85b22a (diff)
downloadrails-97eb5553f9b750963b4891171fb6e3fd3526a5a6.tar.gz
rails-97eb5553f9b750963b4891171fb6e3fd3526a5a6.tar.bz2
rails-97eb5553f9b750963b4891171fb6e3fd3526a5a6.zip
Merge pull request #22717 from nning/actioncable-readme-fixes
ActionCable README.md fixes
Diffstat (limited to 'actioncable')
-rw-r--r--actioncable/README.md10
1 files changed, 5 insertions, 5 deletions
diff --git a/actioncable/README.md b/actioncable/README.md
index 32f49c215f..6dbc1bfe03 100644
--- a/actioncable/README.md
+++ b/actioncable/README.md
@@ -1,4 +1,4 @@
-# Action Cable –- Integrated WebSockets for Rails
+# Action Cable – Integrated WebSockets for Rails
Action Cable seamlessly integrates WebSockets with the rest of your Rails application.
It allows for real-time features to be written in Ruby in the same style
@@ -364,7 +364,7 @@ Then add the following line to your layout before your JavaScript tag:
And finally, create your consumer like so:
```coffeescript
-App.cable = Cable.createConsumer()
+App.cable = ActionCable.createConsumer()
```
For a full list of all configuration options, see the `ActionCable::Server::Configuration` class.
@@ -399,16 +399,16 @@ The above will start a cable server on port 28080. Remember to point your client
### In app
-If you are using a threaded server like Puma or Thin, the current implementation of ActionCable can run side-along with your Rails application. For example, to listen for WebSocket requests on `/websocket`, match requests on that path:
+If you are using a threaded server like Puma or Thin, the current implementation of ActionCable can run side-along with your Rails application. For example, to listen for WebSocket requests on `/cable`, match requests on that path:
```ruby
# config/routes.rb
Example::Application.routes.draw do
- match "/websocket", :to => ActionCable.server, via: [:get, :post]
+ match "/cable", :to => ActionCable.server, via: [:get, :post]
end
```
-You can use `App.cable = Cable.createConsumer("/websocket")` to connect to the cable server.
+You can use `App.cable = ActionCable.createConsumer()` to connect to the cable server if `action_cable_meta_tag` is included in the layout. A custom path is specified as first argument to `createConsumer` (e.g. `App.cable = ActionCable.createConsumer("/websocket")`).
For every instance of your server you create and for every worker your server spawns, you will also have a new instance of ActionCable, but the use of Redis keeps messages synced across connections.