Skip to content
A SSE wrapper for easy streaming.
Ruby
Find file
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
lib/rails
spec
.gitignore
.travis.yml
Gemfile
LICENSE.txt
README.md
Rakefile
sse-rails.gemspec

README.md

sse-rails Gem Version Build Status Code Climate

sse-rails is a simple wrapper around ActionController::Live to hide all the complexity of streaming.

Installation

Add this line to your application's Gemfile:

gem 'sse-rails'

And then execute:

$ bundle

Or install it yourself as:

$ gem install sse-rails

Usage

Add these lines to a controller:

require 'rails/sse'

include ActionController::Live
include Rails::SSE

And then use it in one of your actions:

def listen
  stream do |channel|
    channel.post({ username: 'jim' }, event: 'refresh')
  end
end

You can also use Rails::SSE::Channel#ping! to see if connection is still open. This is useful when you are in a loop like this:

def listen
  stream do |channel|
    loop do
      channel.post('anything') if condition

      channel.ping!
      sleep 1
    end
  end
end

Without pinging you would know that the connection was lost only when the condition becomes true.

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request
Something went wrong with that request. Please try again.