reactor/reactor

class Reactor < Object

The Reactor is a base class for all other reactors. It is currently an abstract class, but this may change.

class AlreadyRegistered < RuntimeError

class NotRegistered < RuntimeError

Public Methods

initialize()

register_read(io_object, callback)

Register callback whenever data is ready to be read on io_object. The implementation should throw AlreadyRegistered if there is already a callback registered for this io_object.

io_object	the io object to register for.
callback	a proc or method that gets called when data is ready.

register_write(io_object, callback)

Register callback whenever data is ready to be written to io_object. The implementation should throw AlreadyRegistered if there is already a callback registered for this io_object.

io_object	the io object to register for.
callback	a proc or method that gets called when the io_object is ready to be written to.

register_error(io_object, callback)

Register callback whenever an exceptional conditions occurs for io_object. The implementation should throw AlreadyRegistered if there is already a callback registered for this io_object.

io_object	the io object to register for.
callback	a proc or method that gets called when the io_object has an exceptional condition.

unregister_read(io_object)

Unregister a read handler for an io_object. The implementation should raise NotRegistered if there is no callback registered for this io_object.

io_object	the io object to unregister.

unregister_write(io_object)

Unregister a write handler for an io_object. The implementation should raise NotRegistered if there is no callback registered for this io_object.

io_object	the io object to unregister.

unregister_error(io_object)

Unregister an error handler for an io_object. The implementation should raise NotRegistered if there is no callback registered for this io_object.

io_object	the io object to unregister.

run_event_loop(t = nil)

Run the reactor event loop for t seconds (or indefinitely if t is nil).

t	the length of time to run the event loop.

end_event_loop()

End the reactor event loop.

work_pending()

Determine if there the reactor has work to be done.

Returns: true if there is work pending, or false otherwise.

schedule_timer(callback, delta, interval=0)

Schedule a timer event.

callback	a proc or method to be called whenever the timer goes off.
delta	the amount of time to wait before the first timer goes off.
interval	the amount of time to wait between intervals.

Returns: the id of a timer event.

cancel_timer(timerid)

Unregister a timer event.

timerid	the id of the timer event to unregister.