Spec-Zone.ru › Ruby on Rails 6.0

модуль ActionController::Live

Смешайте этот модуль в свой контроллер, и все действия в этом контроллере смогут транслировать данные клиенту по мере их записи.

class MyController < ActionController::Base
  include ActionController::Live

  def stream
    response.headers['Content-Type'] = 'text/event-stream'
    100.times {
      response.stream.write "hello world\n"
      sleep 1
    }
  ensure
    response.stream.close
  end
end

Существуют некоторые особенности этого модуля. Вы не можете писать заголовки после того, как ответ был подтвержден (Response#committed? вернёт истину). Вызывая write или close на потоке ответа, вы заставите объект ответа быть подтверждённым. Убедитесь, что все заголовки установлены перед вызовом write или close для вашего потока.

Вы обязательно должны вызвать close для вашего потока, когда вы закончите, в противном случае сокет может остаться открытым навсегда.

Окончательное ограничение заключается в том, что ваши действия выполняются в отдельном потоке, отличном от основного. Убедитесь, что ваши действия потокобезопасны, и это не должно быть проблемой (не делитесь состоянием между потоками и т. д.).

Публичные методы экземпляров

process(name) Показать исходный код
# File actionpack/lib/action_controller/metal/live.rb, line 238
def process(name)
  t1 = Thread.current
  locals = t1.keys.map { |key| [key, t1[key]] }

  error = nil
  # This processes the action in a child thread. It lets us return the
  # response code and headers back up the Rack stack, and still process
  # the body in parallel with sending data to the client.
  new_controller_thread {
    ActiveSupport::Dependencies.interlock.running do
      t2 = Thread.current

      # Since we're processing the view in a different thread, copy the
      # thread locals from the main thread to the child thread. :'(
      locals.each { |k, v| t2[k] = v }

      begin
        super(name)
      rescue => e
        if @_response.committed?
          begin
            @_response.stream.write(ActionView::Base.streaming_completion_on_exception) if request.format == :html
            @_response.stream.call_on_error
          rescue => exception
            log_error(exception)
          ensure
            log_error(e)
            @_response.stream.close
          end
        else
          error = e
        end
      ensure
        @_response.commit!
      end
    end
  }

  ActiveSupport::Dependencies.interlock.permit_concurrent_loads do
    @_response.await_commit
  end

  raise error if error
end
Вызывается метод суперкласса
response_body=(body) Показать исходный код
# File actionpack/lib/action_controller/metal/live.rb, line 283
def response_body=(body)
  super
  response.close if response
end
Вызывается метод суперкласса

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

Spec-Zone.ru

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