Skip to content

Commit

Permalink
Merge pull request #31202 from fgo/patch-21
Browse files Browse the repository at this point in the history
Update Action Cable Overview Guide [ci skip]
  • Loading branch information
rafaelfranca committed Nov 22, 2017
2 parents d7b17df + d5eb8f2 commit 3650337
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions guides/source/action_cable_overview.md
@@ -1,12 +1,12 @@
Action Cable Overview
=====================

In this guide you will learn how Action Cable works and how to use WebSockets to
In this guide, you will learn how Action Cable works and how to use WebSockets to
incorporate real-time features into your Rails application.

After reading this guide, you will know:

* What Action Cable is and its integration on backend and frontend
* What Action Cable is and its integration backend and frontend
* How to setup Action Cable
* How to setup channels
* Deployment and Architecture setup for running Action Cable
Expand Down Expand Up @@ -129,7 +129,7 @@ subscriptions based on an identifier sent by the cable consumer.
# app/channels/chat_channel.rb
class ChatChannel < ApplicationCable::Channel
# Called when the consumer has successfully
# become a subscriber of this channel.
# become a subscriber to this channel.
def subscribed
end
end
Expand Down Expand Up @@ -225,7 +225,7 @@ A *broadcasting* is a pub/sub link where anything transmitted by a publisher
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
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.

Expand Down Expand Up @@ -515,8 +515,8 @@ user. For a user with an ID of 1, the broadcasting name would be
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 to `received`.
to the server-side broadcast call, JSON encoded for the trip across the wire
and unpacked for the data argument arriving as `received`.

### More Complete Examples

Expand Down Expand Up @@ -569,7 +569,7 @@ This may change in the future. [#27214](https://github.com/rails/rails/issues/27

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 match will be performed.
strings or regular expressions, against which a check for the match will be performed.

```ruby
config.action_cable.allowed_request_origins = ['http://rubyonrails.com', %r{http://ruby.*}]
Expand All @@ -592,7 +592,7 @@ environment configuration files.

### Other Configurations

The other common option to configure, is the log tags applied to the
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:

Expand All @@ -607,7 +607,7 @@ config.action_cable.log_tags = [
For a full list of all configuration options, see the
`ActionCable::Server::Configuration` class.

Also note that your server must provide at least the same number of database
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 that available. You can change that in
`config/database.yml` through the `pool` attribute.
Expand Down

0 comments on commit 3650337

Please sign in to comment.