diff options
author | Rafael França <rafaelmfranca@gmail.com> | 2016-02-22 22:55:39 -0300 |
---|---|---|
committer | Rafael França <rafaelmfranca@gmail.com> | 2016-02-22 22:55:39 -0300 |
commit | d3f0aa36c388310fbbbcab6295548dc18e385d0f (patch) | |
tree | b2a343ab2e99b11c279a6f47d355f381bd191689 /actioncable/lib/action_cable/server/broadcasting.rb | |
parent | b86bf3929c0cbbee2bd9b4bd0f6460bd7ba99e7b (diff) | |
parent | 05088b6299a39f4eb9b1da95b05d2e14e3c90c8e (diff) | |
download | rails-d3f0aa36c388310fbbbcab6295548dc18e385d0f.tar.gz rails-d3f0aa36c388310fbbbcab6295548dc18e385d0f.tar.bz2 rails-d3f0aa36c388310fbbbcab6295548dc18e385d0f.zip |
Merge pull request #23668 from maclover7/cable-docs
Full Action Cable documentation read through
Diffstat (limited to 'actioncable/lib/action_cable/server/broadcasting.rb')
-rw-r--r-- | actioncable/lib/action_cable/server/broadcasting.rb | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/actioncable/lib/action_cable/server/broadcasting.rb b/actioncable/lib/action_cable/server/broadcasting.rb index b87232671b..f90fe7b9e2 100644 --- a/actioncable/lib/action_cable/server/broadcasting.rb +++ b/actioncable/lib/action_cable/server/broadcasting.rb @@ -1,6 +1,6 @@ module ActionCable module Server - # Broadcasting is how other parts of your application can send messages to the channel subscribers. As explained in Channel, most of the time, these + # Broadcasting is how other parts of your application can send messages to a channel's subscribers. As explained in Channel, most of the time, these # broadcastings are streamed directly to the clients subscribed to the named broadcasting. Let's explain with a full-stack example: # # class WebNotificationsChannel < ApplicationCable::Channel @@ -9,16 +9,16 @@ module ActionCable # end # end # - # # Somewhere in your app this is called, perhaps from a NewCommentJob + # # Somewhere in your app this is called, perhaps from a NewCommentJob: # ActionCable.server.broadcast \ # "web_notifications_1", { title: "New things!", body: "All that's fit for print" } # - # # Client-side CoffeeScript, which assumes you've already requested the right to send web notifications + # # Client-side CoffeeScript, which assumes you've already requested the right to send web notifications: # App.cable.subscriptions.create "WebNotificationsChannel", # received: (data) -> # new Notification data['title'], body: data['body'] module Broadcasting - # Broadcast a hash directly to a named <tt>broadcasting</tt>. It'll automatically be JSON encoded. + # Broadcast a hash directly to a named <tt>broadcasting</tt>. This will later be JSON encoded. def broadcast(broadcasting, message) broadcaster_for(broadcasting).broadcast(message) end |