NAME

Mojo::Reactor - Low level event reactor base class

SYNOPSIS

  package Mojo::Reactor::MyEventLoop;
  use Mojo::Base 'Mojo::Reactor';

  $ENV{MOJO_REACTOR} ||= 'Mojo::Reactor::MyEventLoop';

  sub io         {...}
  sub is_running {...}
  sub one_tick   {...}
  sub recurring  {...}
  sub remove     {...}
  sub start      {...}
  sub stop       {...}
  sub timer      {...}
  sub watch      {...}

  1;

DESCRIPTION

Mojo::Reactor is an abstract base class for low level event reactors.

EVENTS

Mojo::Reactor can emit the following events.

error

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

Emitted safely for exceptions caught in callbacks.

  $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, Mojo::Reactor::EV or Mojo::Reactor::Poll.

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 non-blocking check if a handle is readable, useful for identifying tainted sockets.

is_running

  my $success = $reactor->is_running;

Check if reactor is running.

one_tick

  $reactor->one_tick;

Run reactor for roughly one tick. Note that this method can recurse back into the reactor, so you need to be careful.

recurring

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

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

  # Invoke as soon as possible
  $reactor->recurring(0 => sub { say 'Reactor tick.' });

remove

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

Remove handle or timer.

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(0.5 => 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.

cpanm Mojolicious

perl -MCPAN -e shell
install Mojolicious