EventSource client for EventMachine

See the specification: https://html.spec.whatwg.org/multipage/server-sent-events.html

Install

Install with Rubygems:

gem install em-eventsource

If you use bundler, add it to your Gemfile:

gem "em-eventsource", "~> 0.3.0"

Usage

Basic usage:

rubyCopy
require "em-eventsource"
EM.run do
  source = EventMachine::EventSource.new("http://example.com/streaming")
  source.message do |message|
    puts "new message #{message}"
  end
  source.start # Start listening
end

Listening specific event name:

rubyCopy
source.on "eventname" do |message|
  puts "eventname #{message}"
end

Handle error:

rubyCopy
source.error do |error|
  puts "error #{error}"
end

Handle open stream:

rubyCopy
source.open do
  puts "opened"
end

Close the stream:

rubyCopy
source.close

Current status of the connection:

rubyCopy
# Can be:
# - EM::EventSource::CLOSED
# - EM::EventSource::CONNECTING
# - EM::EventSource::OPEN
source.ready_state

Override the default retry value (if the connection is lost):

rubyCopy
source.retry = 5 # in seconds (default 3)

Get Last-Event-Id value:

rubyCopy
source.last_event_id

Attach middleware:

rubyCopy
source.use EM::Middleware::JSONResponse

Set the inactivity timeout. Set to 0 to disable the timeout.

rubyCopy
source.inactivity_timeout = 120 # in seconds (default: 60).

Licence

MIT License

Copyright (C) 2020 François de Metz

Copyright (C) 2011 af83