/ 
Mojo-Reactor-POE-0.006
River stage zero No dependents
/ Mojo::Reactor::POE

NAME

Mojo::Reactor::POE - POE backend for Mojo::Reactor

SYNOPSIS

use Mojo::Reactor::POE;

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

# Change to watching only if handle becomes writable
$reactor->watch($handle, 0, 1);

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

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

# Or in an application using Mojo::IOLoop
use POE qw(Loop::IO_Poll);
use Mojo::Reactor::POE;
use Mojo::IOLoop;

# Or in a Mojolicious application
$ MOJO_REACTOR=Mojo::Reactor::POE POE_EVENT_LOOP=POE::Loop::IO_Poll hypnotoad script/myapp

DESCRIPTION

Mojo::Reactor::POE is an event reactor for Mojo::IOLoop that uses POE. The usage is exactly the same as other Mojo::Reactor implementations such as Mojo::Reactor::Poll. Mojo::Reactor::POE will be used as the default backend for Mojo::IOLoop if it is loaded before Mojo::IOLoop or any module using the loop. However, when invoking a Mojolicious application through morbo or hypnotoad, the reactor must be set as the default by setting the MOJO_REACTOR environment variable to Mojo::Reactor::POE.

Note that if POE detects multiple potential event loops it will fail. This includes IO::Poll and Mojo::IOLoop (loaded by Mojolicious) if the appropriate POE::Loop modules are installed. To avoid this, load POE before any Mojolicious module, or specify the POE event loop explicitly. This means that for Mojolicious applications invoked through morbo or hypnotoad, the POE event loop may also need to be set in the environment. See "Using POE with Other Event Loops" in POE::Kernel.

EVENTS

Mojo::Reactor::POE inherits all events from Mojo::Reactor.

METHODS

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

again

$reactor->again($id);

Restart active timer.

io

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

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

is_running

my $bool = $reactor->is_running;

Check if reactor is running.

new

my $reactor = Mojo::Reactor::POE->new;

Construct a new Mojo::Reactor::POE object.

one_tick

$reactor->one_tick;

Run reactor until an event occurs or no events are being watched anymore. 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.

remove

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

Remove handle or timer.

reset

$reactor->reset;

Remove all handles and timers.

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. See "CAVEATS".

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. Note that this method requires an active I/O watcher.

CAVEATS

If you set a timer or I/O watcher, and don't call "start" or "one_tick" (or start POE::Kernel separately), POE will output a warning that POE::Kernel->run() was not called. This is consistent with creating your own POE::Session and not starting POE::Kernel. See "run" in POE::Kernel for more information.

To stop the POE::Kernel reactor, all sessions must be stopped and are thus destroyed. Be aware of this if you create your own POE sessions then stop the reactor. I/O and timer events managed by Mojo::Reactor::POE will persist.

BUGS

POE has a complex session system which may lead to bugs when used in this manner. Report any issues on the public bugtracker.

AUTHOR

Dan Book, dbook@cpan.org

COPYRIGHT AND LICENSE

Copyright 2015, Dan Book.

This library is free software; you may redistribute it and/or modify it under the terms of the Artistic License version 2.0.

SEE ALSO

Mojolicious, Mojo::IOLoop, POE