/usr/share/perl5/Mojo/Reactor.pm is in libmojolicious-perl 5.54+dfsg-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 | package Mojo::Reactor;
use Mojo::Base 'Mojo::EventEmitter';
use Carp 'croak';
use IO::Poll qw(POLLIN POLLPRI);
use Mojo::Loader;
sub again { croak 'Method "again" not implemented by subclass' }
sub detect {
my $try = $ENV{MOJO_REACTOR} || 'Mojo::Reactor::EV';
return Mojo::Loader->new->load($try) ? 'Mojo::Reactor::Poll' : $try;
}
sub io { croak 'Method "io" not implemented by subclass' }
# This may break at some point in the future, but is worth it for performance
sub is_readable {
!(IO::Poll::_poll(0, fileno(pop), my $dummy = POLLIN | POLLPRI) == 0);
}
sub is_running { croak 'Method "is_running" not implemented by subclass' }
sub next_tick { shift->timer(0 => @_) and return undef }
sub one_tick { croak 'Method "one_tick" not implemented by subclass' }
sub recurring { croak 'Method "recurring" not implemented by subclass' }
sub remove { croak 'Method "remove" not implemented by subclass' }
sub reset { croak 'Method "reset" not implemented by subclass' }
sub start { croak 'Method "start" not implemented by subclass' }
sub stop { croak 'Method "stop" not implemented by subclass' }
sub timer { croak 'Method "timer" not implemented by subclass' }
sub watch { croak 'Method "watch" not implemented by subclass' }
1;
=encoding utf8
=head1 NAME
Mojo::Reactor - Low-level event reactor base class
=head1 SYNOPSIS
package Mojo::Reactor::MyEventLoop;
use Mojo::Base 'Mojo::Reactor';
$ENV{MOJO_REACTOR} ||= 'Mojo::Reactor::MyEventLoop';
sub again {...}
sub io {...}
sub is_running {...}
sub one_tick {...}
sub recurring {...}
sub remove {...}
sub reset {...}
sub start {...}
sub stop {...}
sub timer {...}
sub watch {...}
=head1 DESCRIPTION
L<Mojo::Reactor> is an abstract base class for low-level event reactors.
=head1 EVENTS
L<Mojo::Reactor> inherits all events from L<Mojo::EventEmitter> and can emit
the following new ones.
=head2 error
$reactor->on(error => sub {
my ($reactor, $err) = @_;
...
});
Emitted for exceptions caught in callbacks, fatal if unhandled. Note that if
this event is unhandled or fails it might kill your program, so you need to be
careful.
$reactor->on(error => sub {
my ($reactor, $err) = @_;
say "Something very bad happened: $err";
});
=head1 METHODS
L<Mojo::Reactor> inherits all methods from L<Mojo::EventEmitter> and
implements the following new ones.
=head2 again
$reactor->again($id);
Restart active timer. Meant to be overloaded in a subclass.
=head2 detect
my $class = Mojo::Reactor->detect;
Detect and load the best reactor implementation available, will try the value
of the C<MOJO_REACTOR> environment variable, L<Mojo::Reactor::EV> or
L<Mojo::Reactor::Poll>.
# Instantiate best reactor implementation available
my $reactor = Mojo::Reactor->detect->new;
=head2 io
$reactor = $reactor->io($handle => sub {...});
Watch handle for I/O events, invoking the callback whenever handle becomes
readable or writable. Meant to be overloaded in a subclass.
# 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 is_readable
my $bool = $reactor->is_readable($handle);
Quick non-blocking check if a handle is readable, useful for identifying
tainted sockets.
=head2 is_running
my $bool = $reactor->is_running;
Check if reactor is running. Meant to be overloaded in a subclass.
=head2 next_tick
my $undef = $reactor->next_tick(sub {...});
Invoke callback as soon as possible, but not before returning, always returns
C<undef>.
=head2 one_tick
$reactor->one_tick;
Run reactor until an event occurs. Note that this method can recurse back into
the reactor, so you need to be careful. Meant to be overloaded in a subclass.
# 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. Meant to be overloaded in a subclass.
=head2 remove
my $bool = $reactor->remove($handle);
my $bool = $reactor->remove($id);
Remove handle or timer. Meant to be overloaded in a subclass.
=head2 reset
$reactor->reset;
Remove all handles and timers. Meant to be overloaded in a subclass.
=head2 start
$reactor->start;
Start watching for I/O and timer events, this will block until L</"stop"> is
called. Note that some reactors stop automatically if there are no events
being watched anymore. Meant to be overloaded in a subclass.
=head2 stop
$reactor->stop;
Stop watching for I/O and timer events. Meant to be overloaded in a subclass.
=head2 timer
my $id = $reactor->timer(0.5 => sub {...});
Create a new timer, invoking the callback after a given amount of time in
seconds. Meant to be overloaded in a subclass.
=head2 watch
$reactor = $reactor->watch($handle, $readable, $writable);
Change I/O events to watch handle for with true and false values. Meant to be
overloaded in a subclass. 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 SEE ALSO
L<Mojolicious>, L<Mojolicious::Guides>, L<http://mojolicio.us>.
=cut
|