Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/francois2metz/em-eventsource

em-eventsource is an eventmachine library to consume Server-Sent Events streaming API.
https://github.com/francois2metz/em-eventsource

eventmachine eventsource eventsource-implementations ruby sse-client

Last synced: 3 days ago
JSON representation

em-eventsource is an eventmachine library to consume Server-Sent Events streaming API.

Host: GitHub
URL: https://github.com/francois2metz/em-eventsource
Owner: francois2metz
License: mit
Created: 2011-08-02T08:23:33.000Z (over 13 years ago)
Default Branch: master
Last Pushed: 2021-07-12T20:37:35.000Z (over 3 years ago)
Last Synced: 2024-12-30T19:14:46.443Z (10 days ago)
Topics: eventmachine, eventsource, eventsource-implementations, ruby, sse-client
Language: Ruby
Homepage:
Size: 70.3 KB
Stars: 85
Watchers: 36
Forks: 28
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

# 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:

```ruby
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:

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

Handle error:

```ruby
source.error do |error|
puts "error #{error}"
end
```

Handle open stream:

```ruby
source.open do
puts "opened"
end
```

Close the stream:

```ruby
source.close
```

Current status of the connection:

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

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

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

Get Last-Event-Id value:

```ruby
source.last_event_id
```

Attach middleware:

```ruby
source.use EM::Middleware::JSONResponse
```

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

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

## Licence

MIT License