Home

Awesome

EventMachine-LE

EventMachine-LE (Live Edition) is a branch of EventMachine with fixes and more features.

Build Status

What do you mean by "branch"?

Well, outside the narrower git circles, "fork" has all these negative connotations, as in bad feelings after an argument, marriages divorcing, nation states splitting after a civil war, people hating each other. This is not at all the point here, so let's call this fork a "branch".

Purpose of this branch

This branch incorporates interesting pull requests that are not yet included in the mainline EventMachine repository. The maintainers of that version prefer to minimize change in order to keep the stability with already existing EventMachine deployments, which provides an impressive multi-platform base for IPv4 TCP servers (e.g., Web servers) that don't need good UDP or IPv6 support.

This dedication to stability is helpful for production use, but can also lead to ossification. The present "Live Edition" or "Leading Edge" branch has its focus on supporting a somewhat wider use, including new Web servers or protocols beyond the HTTP Web.

To provide even more focus, this branch is currently applying its energy towards Linux and Unix/BSD/OSX environments. Java reactor and pure Ruby reactor are for now removed in this branch, and Windows/Cygwin support is untested. This may very well change later, once interesting pull requests come in.

EventMachine-LE draws from a number of dormant pull requests on the mainline version of EventMachine. New proposals will also directly come to EventMachine-LE and will be included once they are tested.

This is not a "development branch" — we do use EventMachine-LE in production, just beyond the focus of mainline EventMachine.

The intention is that EventMachine-LE is always a drop-in replacement for EventMachine, just with additional (and fixed) functionality.

Features and changes

The list of additions and improvements will grow over time. Currently the following features/fixes have been applied in EventMachine-LE:

Version 1.1.6

Version 1.1.5

Version 1.1.4 and below

Installation

Install the current stable version of EventMachine-LE:

<pre> gem install eventmachine-le </pre>

If you want the last beta version (not fully tested) install it by using --pre option:

<pre> gem install eventmachine-le --pre </pre>

Usage

Using EventMachine-LE within your project just requires loading it as follows:

<pre> # First load EventMachine-LE. require "eventmachine-le" # NOTE: It does not hurt to call "require 'eventmachine'" later # (it has no effect at all). # Then load any other Ruby Gem depending on EventMachine so it # will use EventMachine-LE. require "em-udns" </pre>

By doing this, you will avoid conflicts with the main EventMachine Gem (if it's also installed).

Authors

This branch is mantained by Carsten Bormann and Iñaki Baz Castillo.