Tribe EM is a Ruby gem that adds event-driven network IO to Tribe.
Ruby
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib
.gitignore
Gemfile
LICENSE.txt
README.md
Rakefile
tribe_em.gemspec

README.md

Tribe EM

Tribe EM is a Ruby gem that adds event-driven network IO to [Tribe] (https://github.com/chadrem/tribe "Tribe"). It is based on [EventMachine] (http://rubyeventmachine.com/ "EventMachine").

Installation

Add this line to your application's Gemfile:

gem 'tribe_em'

And then execute:

$ bundle

Or install it yourself as:

$ gem install tribe_em

Usage

You can test the below code using a utility such as telnet (telnet localhost 9000), entering some text, and then killing telnet.

# Create a custom connection actor class.
class EchoConn < Tribe::EM::Connection
  private
  def exception_handler(e)
    super
    puts concat_e("EchoConn (#{identifier}) died.", e)
  end

  def post_init_handler
    puts "Actor (#{identifier}) connected to client using thread (#{Thread.current.object_id})."
  end

  def receive_data_handler(data)
    puts "Actor (#{identifier}) received data (#{data}) using thread (#{Thread.current.object_id})."
    write(data)
    shutdown!
  end

  def unbind_handler
    puts "Actor (#{identifier}) disconnected from client using thread (#{Thread.current.object_id})."
  end
end

# Create your server actor.
server = Tribe::EM::TcpServer.new('localhost', 9000, EchoConn)

Customization

Tribe EM is designed to be easily customized through inheritence of Tribe::EM::Connection. Communication between EventMachine and the Tribe actor system is provided by Tribe::EM::ActorProxy.

Protocols

Tribe EM has native TCP server and connection classes built in. Other protocol implementations can be found below. Note that some impmementations are marked as native while others are marked as wrappers. Native implementations are specifically designed to for Tribe EM and thus push most work to the actor threads. Wrapper implementations wrap existing EM libraries and usually do more work in the EM thread. This means that native implmentations (when used with real threads via JRuby) will scale better on multi-core systems. None of this really matters much with MRI Ruby since it has a global interpretter lock.

TODO - missing features

  • Commonly used server protocols such as HTTP.
  • Client side sockets.

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