Class: ActionController::Live::Buffer

Inherits:
ActionDispatch::Response::Buffer show all
Includes:
MonitorMixin
Defined in:
actionpack/lib/action_controller/metal/live.rb

Overview

:nodoc:

Class Attribute Summary collapse

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from ActionDispatch::Response::Buffer

#body, #closed?, #each, #to_ary

Constructor Details

#initialize(response) ⇒ Buffer

Returns a new instance of Buffer.



166
167
168
169
170
171
172
 
# File 'actionpack/lib/action_controller/metal/live.rb', line 166

def initialize(response)
  super(response, build_queue(self.class.queue_size))
  @error_callback = lambda { true }
  @cv = new_cond
  @aborted = false
  @ignore_disconnect = false
end

Class Attribute Details

.queue_size ⇒ Object

Returns the value of attribute queue_size.



155
156
157
 
# File 'actionpack/lib/action_controller/metal/live.rb', line 155

def queue_size
  @queue_size
end

Instance Attribute Details

#ignore_disconnect ⇒ Object

Ignore that the client has disconnected.

If this value is true, calling write after the client disconnects will result in the written content being silently discarded. If this value is false (the default), a ClientDisconnected exception will be raised.



164
165
166
 
# File 'actionpack/lib/action_controller/metal/live.rb', line 164

def ignore_disconnect
  @ignore_disconnect
end

Instance Method Details

#abort ⇒ Object

Inform the producer/writing thread that the client has disconnected; the reading thread is no longer interested in anything that’s being written.

See also #close.



220
221
222
223
224
225
 
# File 'actionpack/lib/action_controller/metal/live.rb', line 220

def abort
  synchronize do
    @aborted = true
    @buf.clear
  end
end

#call_on_error ⇒ Object 



239
240
241
 
# File 'actionpack/lib/action_controller/metal/live.rb', line 239

def call_on_error
  @error_callback.call
end

#close ⇒ Object

Write a ‘close’ event to the buffer; the producer/writing thread uses this to notify us that it’s finished supplying content.

See also #abort.



208
209
210
211
212
213
214
 
# File 'actionpack/lib/action_controller/metal/live.rb', line 208

def close
  synchronize do
    super
    @buf.push nil
    @cv.broadcast
  end
end

#connected? ⇒ Boolean

Is the client still connected and waiting for content?

The result of calling write when this is false is determined by ignore_disconnect.

Returns:

  • (Boolean) 


231
232
233
 
# File 'actionpack/lib/action_controller/metal/live.rb', line 231

def connected?
  !@aborted
end

#on_error(&block) ⇒ Object 



235
236
237
 
# File 'actionpack/lib/action_controller/metal/live.rb', line 235

def on_error(&block)
  @error_callback = block
end

#write(string) ⇒ Object 



180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'actionpack/lib/action_controller/metal/live.rb', line 180

def write(string)
  unless @response.committed?
    @response.headers["Cache-Control"] ||= "no-cache"
    @response.delete_header "Content-Length"
  end

  super

  unless connected?
    @buf.clear

    unless @ignore_disconnect
      # Raise ClientDisconnected, which is a RuntimeError (not an IOError), because
      # that's more appropriate for something beyond the developer's control.
      raise ClientDisconnected, "client disconnected"
    end
  end
end

#writeln(string) ⇒ Object

Same as write but automatically include a newline at the end of the string.



200
201
202
 
# File 'actionpack/lib/action_controller/metal/live.rb', line 200

def writeln(string)
  write string.end_with?("\n") ? string : "#{string}\n"
end