The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.

NAME

Mojo::Reactor - Minimalistic low level event reactor

SYNOPSIS

  use Mojo::Reactor;

  # Watch if handle becomes readable or writabe
  my $reactor = Mojo::Reactor->new;
  $reactor->io($handle => sub {
    my ($reactor, $writable) = @_;
    say $writable ? 'Handle is writable' : 'Handle is readable';
  });

  # Add a timer
  $reactor->timer(15 => sub {
    my $reactor = shift;
    $reactor->drop($handle);
    say 'Timeout!';
  });

  # Start reactor if necessary
  $reactor->start unless $reactor->is_running;

DESCRIPTION

Mojo::Reactor is a minimalistic low level event reactor based on IO::Poll and the foundation of Mojo::IOLoop. Mojo::Reactor::EV is a good example for its extensibility. Note that this module is EXPERIMENTAL and might change without warning!

EVENTS

Mojo::Reactor can emit the following events.

error

  $reactor->on(error => sub {
    my ($reactor, $err) = @_;
    ...
  });

Emitted safely if an error happens.

  $reactor->on(error => sub {
    my ($reactor, $err) = @_;
    say "Something very bad happened: $err";
  });

METHODS

Mojo::Reactor inherits all methods from Mojo::EventEmitter and implements the following new ones.

detect

  my $class = Mojo::Reactor->detect;

Detect and load the best reactor implementation available, will try the value of the MOJO_REACTOR environment variable or Mojo::Reactor::EV.

drop

  my $success = $reactor->drop($handle);
  my $success = $reactor->drop($id);

Drop handle or timer.

io

  $reactor = $reactor->io($handle => sub {...});

Watch handle for I/O events, invoking the callback whenever handle becomes readable or writable.

  # Callback will be invoked twice if handle becomes readable and writable
  $reactor->io($handle => sub {
    my ($reactor, $writable) = @_;
    say $writable ? 'Handle is writable' : 'Handle is readable';
  });

is_readable

  my $success = $reactor->is_readable($handle);

Quick check if a handle is readable, useful for identifying tainted sockets.

is_running

  my $success = $reactor->is_running;

Check if reactor is running.

recurring

  my $id = $reactor->recurring(3 => sub {...});

Create a new recurring timer, invoking the callback repeatedly after a given amount of time in seconds.

start

  $reactor->start;

Start watching for I/O and timer events, this will block until stop is called or no events are being watched anymore.

stop

  $reactor->stop;

Stop watching for I/O and timer events.

timer

  my $id = $reactor->timer(3 => sub {...});

Create a new timer, invoking the callback after a given amount of time in seconds.

watch

  $reactor = $reactor->watch($handle, $readable, $writable);

Change I/O events to watch handle for with true and false values.

  # Watch only for readable events
  $reactor->watch($handle, 1, 0);

  # Watch only for writable events
  $reactor->watch($handle, 0, 1);

  # Watch for readable and writable events
  $reactor->watch($handle, 1, 1);

  # Pause watching for events
  $reactor->watch($handle, 0, 0);

SEE ALSO

Mojolicious, Mojolicious::Guides, http://mojolicio.us.