Spec-Zone.ru › Ruby on Rails 8.1

module ActionCable::Server::Broadcasting

Action Cable Broadcasting

Broadcasting — это способ, с помощью которого другие части вашего приложения могут отправлять сообщения подписчикам канала. Как объясняется в Channel, обычно эти трансляции передаются напрямую клиентам, подписанным на трансляцию с указанным именем. Рассмотрим пример приложения с полным стеком:

class WebNotificationsChannel < ApplicationCable::Channel
  def subscribed
    stream_from "web_notifications_#{current_user.id}"
  end
end

# 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 JavaScript, which assumes you've already requested the right to send web notifications:
App.cable.subscriptions.create("WebNotificationsChannel", {
  received: function(data) {
    new Notification(data['title'], { body: data['body'] })
  }
})

Открытые методы экземпляра

broadcast (broadcasting, message, coder: ActiveSupport::JSON) Показать исходный код
# File actioncable/lib/action_cable/server/broadcasting.rb, line 33
def broadcast(broadcasting, message, coder: ActiveSupport::JSON)
  broadcaster_for(broadcasting, coder: coder).broadcast(message)
end

Отправляет хеш напрямую в трансляцию с указанным именем broadcasting. Позже он будет закодирован в JSON.

broadcaster_for (broadcasting, coder: ActiveSupport::JSON) Показать исходный код
# File actioncable/lib/action_cable/server/broadcasting.rb, line 40
def broadcaster_for(broadcasting, coder: ActiveSupport::JSON)
  Broadcaster.new(self, String(broadcasting), coder: coder)
end

Возвращает широковещатель для трансляции с указанным именем broadcasting, который можно использовать повторно. Полезно, если у вас есть объект, которому может понадобиться многократно передавать данные в определённую трансляцию из разных мест.

© 2004–2021 David Heinemeier Hansson
Licensed under the MIT License.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API