Git Product home page Git Product logo

celluloid-eventsource's Introduction

Celluloid::Eventsource

Gem Version CircleCI

An EventSource client based off Celluloid::IO.

Specification based on EventSource

Installation

Add this line to your application's Gemfile:

gem 'ld-celluloid-eventsource'

And then execute:

$ bundle

Or install it yourself as:

$ gem install celluloid-eventsource

then somewhere in your project:

require 'celluloid/eventsource'

Usage

Initializing a new Celluloid::EventSource object will create the connection:

es = Celluloid::EventSource.new("http://example.com/")

Messages can be received on events such as on_open, on_message and on_error.

These can be assigned at initialize time

es = Celluloid::EventSource.new("http://example.com/") do |conn|
  conn.on_open do
    puts "Connection was made"
  end

  conn.on_message do |event|
    puts "Message: #{event.data}"
  end

  conn.on_error do |message|
    puts "Response status #{message[:status_code]}, Response body #{message[:body]}"
  end

  conn.on(:time) do |event|
    puts "The time is #{event.data}"
  end
end

To close the connection #close will shut the socket connection but keep the actor alive.

Event Handlers

Event handlers should be added when initializing the eventsource.

Warning To change event handlers after initializing there is a Gotcha. Celluloid sends messages to actors through thread-safe proxies.

To get around this, use wrapped_object to set the handler on the actor but be aware of the concequences.

es.wrapped_object.on_messsage { |message| puts "Different #{message}" }

This same concept applies for changing the url of the eventsource.

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

celluloid-eventsource's People

Contributors

tonkpils avatar jkodumal avatar eli-darkly avatar dlau avatar nandosola avatar drichelson avatar ashanbrown avatar jonturner avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.