Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/grinnz/mojo-reactor-epoll

Mojo::Reactor::Epoll - epoll backend for Mojo::Reactor
https://github.com/grinnz/mojo-reactor-epoll

Last synced: 5 days ago
JSON representation

Mojo::Reactor::Epoll - epoll backend for Mojo::Reactor

Awesome Lists containing this project

README 

        
=pod



=head1 NAME



Mojo::Reactor::Epoll - epoll backend for Mojo::Reactor



=head1 SYNOPSIS



  use Mojo::Reactor::Epoll;



  # Watch if handle becomes readable or writable

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

  $reactor->io($first => sub {

    my ($reactor, $writable) = @_;

    say $writable ? 'First handle is writable' : 'First handle is readable';

  });



  # Change to watching only if handle becomes writable

  $reactor->watch($first, 0, 1);



  # Turn file descriptor into handle and watch if it becomes readable

  my $second = IO::Handle->new_from_fd($fd, 'r');

  $reactor->io($second => sub {

    my ($reactor, $writable) = @_;

    say $writable ? 'Second handle is writable' : 'Second handle is readable';

  })->watch($second, 1, 0);



  # Add a timer

  $reactor->timer(15 => sub {

    my $reactor = shift;

    $reactor->remove($first);

    $reactor->remove($second);

    say 'Timeout!';

  });



  # Start reactor if necessary

  $reactor->start unless $reactor->is_running;



  # Or in an application using Mojo::IOLoop

  use Mojo::Reactor::Epoll;

  use Mojo::IOLoop;

  

  # Or in a Mojolicious application

  $ MOJO_REACTOR=Mojo::Reactor::Epoll hypnotoad script/myapp



=head1 DESCRIPTION



L is an event reactor for L that uses the

L Linux subsystem. The usage is exactly the same as other

L implementations such as L.

L will be used as the default backend for L

if it is loaded before L or any module using the loop. However,

when invoking a L application through L or L,

the reactor must be set as the default by setting the C

environment variable to C.



=head1 EVENTS



L inherits all events from L.



=head1 METHODS



L inherits all methods from L and

implements the following new ones.



=head2 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';

  });



=head2 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.



  # Don't block longer than 0.5 seconds

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

  $reactor->one_tick;

  $reactor->remove($id);



=head2 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.



=head2 remove



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

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



Remove handle or timer.



=head2 reset



  $reactor->reset;



Remove all handles and timers.



=head2 timer



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



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

seconds.



=head2 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.



  # 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);



=head1 CAVEATS



The epoll notification facility is exclusive to Linux systems.



The epoll handle is not usable across forks, and this is not currently managed

for you, though it is not created until the loop is started to allow for

preforking deployments such as L.



=head1 BUGS



Report any issues on the public bugtracker.



=head1 AUTHOR



Dan Book, C



=head1 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.



=head1 SEE ALSO



L, L, L



=cut