Module: ServerSentEvents

Defined in:
lib/server_sent_events.rb,
lib/server_sent_events/event.rb,
lib/server_sent_events/client.rb,
lib/server_sent_events/parser.rb,
lib/server_sent_events/version.rb

Defined Under Namespace

Classes: Client, Event, Parser

Constant Summary collapse

VERSION = 
"0.1.3"

Class Method Summary collapse

Class Method Details

.create_client(address, headers = {}) ⇒ Client

Create new client that uses default parser to parse events.

Parameters:

  • address (String, URI) —

    SSE endpoint

  • headers (Hash) (defaults to: {}) —

    HTTP headers to use when connecting

Returns:



31
32
33
 
# File 'lib/server_sent_events.rb', line 31

def self.create_client(address, headers = {})
  Client.new(URI(address), Parser.new, headers)
end

.listen(address, headers = {}, &callback) ⇒ Object

Convenience method to get up-and-running fast.

In order to start listening to server events, this is all the code that we need:

ServerSentEvents.listen("http://example.com") do |event|
  puts event
end

Parameters:

  • address (String, URI) —

    SSE endpoint

  • headers (Hash) (defaults to: {}) —

    HTTP headers to use when connecting

  • callback —

    code block that should be executed on event arrival



22
23
24
 
# File 'lib/server_sent_events.rb', line 22

def self.listen(address, headers = {}, &callback)
  create_client(address, headers).listen(&callback)
end