Read Me

[documentation](doc)

Overview
--------

This is a completely minimal implementation of a select-based reactor framework
for event-based asynchronous IO programming.  The reactor core supports
scheduling of tasks (a la Twisted, asio, etc.).  This was written for the
constrained-resource environment that is PlanetLab, mostly out of performance
paranoia.  It also helped us remove the need for a separate thread for the
scheduled executor tasks - these are run in-line (using timeouts to select).

Aside from its simplicity, efficiency, and support for scheduled tasks, it also
has no dependencies except for Java 6.  Both TCP and UDP are supported.

Setup
-----

Requirements:

- [Java] 6

[Java]: http://java.sun.com/

Suggested:

- [SimpleBuild]

[SimpleBuild]: http://assorted.sf.net/simple-build/

Usage
-----

For an example of how to use the reactor, please refer to `ReactorTest.java`.

Related Work
------------

- [Apache Mina]: we originally used this for [SRON], but it is not as
  lightweight, lacked select-based time-scheduling, and also requires at least
  [slf4j].

- [SRON]: The project from which Java Reactor was born.

[Apache Mina]: http://mina.apache.org/
[SRON]: https://moo.cmcl.cs.cmu.edu/trac/scaleron
[slf4j]: http://www.slf4j.org/

Changes
-------

version 0.2, 2008-10-08

- added TCP support

version 0.1, 2008-03-03

- initial release; UDP only

Links
-----

- [Web site](http://assorted.sf.net/java-reactor/)
- [ROX NIO tutorial](http://rox-xmlrpc.sourceforge.net/niotut/)