модуль 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 для вашего потока, когда закончите, иначе сокет может остаться открытым навсегда.

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

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

log_error(exception) Показать исходный код

# File actionpack/lib/action_controller/metal/live.rb, line 294
def log_error(exception)
  logger = ActionController::Base.logger
  return unless logger

  logger.fatal do
    message = "\n#{exception.class} (#{exception.message}):\n"
    message << exception.annoted_source_code.to_s if exception.respond_to?(:annoted_source_code)
    message << "  " << exception.backtrace.join("\n  ")
    "#{message}\n\n"
  end
end

process(name) Показать исходный код

# File actionpack/lib/action_controller/metal/live.rb, line 237
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 306
def response_body=(body)
  super
  response.close if response
end

Вызывает метод суперкласса