module ServerSentEvents

Constants

VERSION

Public Class Methods

create_client(address, headers = {}) click to toggle source

Create new client that uses default parser to parse events.

@param address [String, URI] SSE endpoint @param headers [Hash] HTTP headers to use when connecting @return [Client] client

# File lib/server_sent_events.rb, line 30
def self.create_client(address, headers = {})
  Client.new(URI(address), Parser.new, headers)
end
listen(address, headers = {}, &callback) click to toggle source

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

@param address [String, URI] SSE endpoint @param headers [Hash] HTTP headers to use when connecting @param callback code block that should be executed on event arrival

# File lib/server_sent_events.rb, line 21
def self.listen(address, headers = {}, &callback)
  create_client(address, headers).listen(&callback)
end