Class: ActionController::Live::SSE
Relationships & Source Files | |
Inherits: | Object |
Defined in: | actionpack/lib/action_controller/metal/live.rb |
Overview
Action Controller Live Server Sent Events
This class provides the ability to write an SSE
(Server Sent Event) to an ::IO
stream. The class is initialized with a stream and can be used to either write a JSON string or an object which can be converted to JSON.
Writing an object will convert it into standard SSE
format with whatever options you have configured. You may choose to set the following options:
1) Event. If specified, an event with this name will be dispatched on
the browser.
2) Retry. The reconnection time in milliseconds used when attempting
to send the event.
3) Id. If the connection dies while sending an SSE to the browser, then
the server will receive a {Last-Event-ID} header with value equal to {id}.
After setting an option in the constructor of the SSE
object, all future SSEs sent across the stream will use those options unless overridden.
Example Usage:
class MyController < ActionController::Base
include ActionController::Live
def index
response.headers['Content-Type'] = 'text/event-stream'
sse = SSE.new(response.stream, retry: 300, event: "event-name")
sse.write({ name: 'John'})
sse.write({ name: 'John'}, id: 10)
sse.write({ name: 'John'}, id: 10, event: "other-event")
sse.write({ name: 'John'}, id: 10, event: "other-event", retry: 500)
ensure
sse.close
end
end
Note: SSEs are not currently supported by IE. However, they are supported by Chrome, Firefox, Opera, and Safari.
Constant Summary
-
PERMITTED_OPTIONS =
# File 'actionpack/lib/action_controller/metal/live.rb', line 108%w( retry event id )
Class Method Summary
- .new(stream, options = {}) ⇒ SSE constructor
Instance Method Summary
Constructor Details
.new(stream, options = {}) ⇒ SSE
# File 'actionpack/lib/action_controller/metal/live.rb', line 110
def initialize(stream, = {}) @stream = stream @options = end
Instance Method Details
#close
[ GitHub ]# File 'actionpack/lib/action_controller/metal/live.rb', line 115
def close @stream.close end
#write(object, options = {})
[ GitHub ]# File 'actionpack/lib/action_controller/metal/live.rb', line 119
def write(object, = {}) case object when String perform_write(object, ) else perform_write(ActiveSupport::JSON.encode(object), ) end end