1 |
=head1 NAME |
2 |
|
3 |
EV - perl interface to libevent, monkey.org/~provos/libevent/ |
4 |
|
5 |
=head1 SYNOPSIS |
6 |
|
7 |
use EV; |
8 |
|
9 |
# TIMER |
10 |
|
11 |
my $w = EV::timer 2, 0, sub { |
12 |
warn "is called after 2s"; |
13 |
}; |
14 |
|
15 |
my $w = EV::timer 2, 1, sub { |
16 |
warn "is called roughly every 2s (repeat = 1)"; |
17 |
}; |
18 |
|
19 |
undef $w; # destroy event watcher again |
20 |
|
21 |
my $w = EV::timer_abs 0, 60, sub { |
22 |
warn "is called every minute, on the minute, exactly"; |
23 |
}; |
24 |
|
25 |
# IO |
26 |
|
27 |
my $w = EV::io \*STDIN, EV::READ | EV::PERSIST, sub { |
28 |
my ($w, $revents) = @_; # all callbacks get the watcher object and event mask |
29 |
if ($revents & EV::TIMEOUT) { |
30 |
warn "nothing received on stdin for 10 seconds, retrying"; |
31 |
} else { |
32 |
warn "stdin is readable, you entered: ", <STDIN>; |
33 |
} |
34 |
}; |
35 |
$w->timeout (10); |
36 |
|
37 |
my $w = EV::timed_io \*STDIN, EV::READ, 30, sub { |
38 |
my ($w, $revents) = @_; |
39 |
if ($revents & EV::TIMEOUT) { |
40 |
warn "nothing entered within 30 seconds, bye bye.\n"; |
41 |
$w->stop; |
42 |
} else { |
43 |
my $line = <STDIN>; |
44 |
warn "you entered something, you again have 30 seconds.\n"; |
45 |
} |
46 |
}; |
47 |
|
48 |
# SIGNALS |
49 |
|
50 |
my $w = EV::signal 'QUIT', sub { |
51 |
warn "sigquit received\n"; |
52 |
}; |
53 |
|
54 |
my $w = EV::signal 3, sub { |
55 |
warn "sigquit received (this is GNU/Linux, right?)\n"; |
56 |
}; |
57 |
|
58 |
# CHILD/PID STATUS CHANGES |
59 |
|
60 |
my $w = EV::child 666, sub { |
61 |
my ($w, $revents, $status) = @_; |
62 |
}; |
63 |
|
64 |
# MAINLOOP |
65 |
EV::dispatch; # loop as long as watchers are active |
66 |
EV::loop; # the same thing |
67 |
EV::loop EV::LOOP_ONESHOT; # block until some events could be handles |
68 |
EV::loop EV::LOOP_NONBLOCK; # check and handle some events, but do not wait |
69 |
|
70 |
=head1 DESCRIPTION |
71 |
|
72 |
This module provides an interface to libev |
73 |
(L<http://software.schmorp.de/pkg/libev.html>). You probably should |
74 |
acquaint yourself with its documentation and source code to be able to use |
75 |
this module fully. |
76 |
|
77 |
=cut |
78 |
|
79 |
package EV; |
80 |
|
81 |
use strict; |
82 |
|
83 |
BEGIN { |
84 |
our $VERSION = '0.03'; |
85 |
use XSLoader; |
86 |
XSLoader::load "EV", $VERSION; |
87 |
} |
88 |
|
89 |
@EV::Io::ISA = "EV::Watcher"; |
90 |
@EV::Time::ISA = "EV::Watcher"; |
91 |
@EV::Timer::ISA = "EV::Time"; |
92 |
@EV::Periodic::ISA = "EV::Time"; |
93 |
@EV::Signal::ISA = "EV::Watcher"; |
94 |
@EV::Idle::ISA = "EV::Watcher"; |
95 |
@EV::Prepare::ISA = "EV::Watcher"; |
96 |
@EV::Check::ISA = "EV::Watcher"; |
97 |
|
98 |
=head1 BASIC INTERFACE |
99 |
|
100 |
=over 4 |
101 |
|
102 |
=item $EV::NPRI |
103 |
|
104 |
How many priority levels are available. |
105 |
|
106 |
=item $EV::DIED |
107 |
|
108 |
Must contain a reference to a function that is called when a callback |
109 |
throws an exception (with $@ containing thr error). The default prints an |
110 |
informative message and continues. |
111 |
|
112 |
If this callback throws an exception it will be silently ignored. |
113 |
|
114 |
=item $time = EV::now |
115 |
|
116 |
Returns the time in (fractional) seconds since the epoch. |
117 |
|
118 |
=item $version = EV::version |
119 |
|
120 |
=item $method = EV::method |
121 |
|
122 |
Return version string and event polling method used. |
123 |
|
124 |
=item EV::loop $flags # EV::LOOP_ONCE, EV::LOOP_ONESHOT |
125 |
|
126 |
=item EV::loopexit $after |
127 |
|
128 |
Exit any active loop or dispatch after C<$after> seconds or immediately if |
129 |
C<$after> is missing or zero. |
130 |
|
131 |
=item EV::dispatch |
132 |
|
133 |
Same as C<EV::loop 0>. |
134 |
|
135 |
=item EV::event $callback |
136 |
|
137 |
Creates a new event watcher waiting for nothing, calling the given callback. |
138 |
|
139 |
=item my $w = EV::io $fileno_or_fh, $eventmask, $callback |
140 |
|
141 |
=item my $w = EV::io_ns $fileno_or_fh, $eventmask, $callback |
142 |
|
143 |
As long as the returned watcher object is alive, call the C<$callback> |
144 |
when the events specified in C<$eventmask> happen. Initially, the timeout |
145 |
is disabled. |
146 |
|
147 |
You can additionall set a timeout to occur on the watcher, but note that |
148 |
this timeout will not be reset when you get an I/O event in the EV::PERSIST |
149 |
case, and reaching a timeout will always stop the watcher even in the |
150 |
EV::PERSIST case. |
151 |
|
152 |
If you want a timeout to occur only after a specific time of inactivity, set |
153 |
a repeating timeout and do NOT use EV::PERSIST. |
154 |
|
155 |
Eventmask can be one or more of these constants ORed together: |
156 |
|
157 |
EV::READ wait until read() wouldn't block anymore |
158 |
EV::WRITE wait until write() wouldn't block anymore |
159 |
EV::PERSIST stay active after a (non-timeout) event occured |
160 |
|
161 |
The C<io_ns> variant doesn't add/start the newly created watcher. |
162 |
|
163 |
=item my $w = EV::timed_io $fileno_or_fh, $eventmask, $timeout, $callback |
164 |
|
165 |
=item my $w = EV::timed_io_ns $fileno_or_fh, $eventmask, $timeout, $callback |
166 |
|
167 |
Same as C<io> and C<io_ns>, but also specifies a timeout (as if there was |
168 |
a call to C<< $w->timeout ($timout, 1) >>. The persist flag is not allowed |
169 |
and will automatically be cleared. The watcher will be restarted after each event. |
170 |
|
171 |
If the timeout is zero or undef, no timeout will be set, and a normal |
172 |
watcher (with the persist flag set!) will be created. |
173 |
|
174 |
This has the effect of timing out after the specified period of inactivity |
175 |
has happened. |
176 |
|
177 |
Due to the design of libevent, this is also relatively inefficient, having |
178 |
one or two io watchers and a separate timeout watcher that you reset on |
179 |
activity (by calling its C<start> method) is usually more efficient. |
180 |
|
181 |
=item my $w = EV::timer $after, $repeat, $callback |
182 |
|
183 |
=item my $w = EV::timer_ns $after, $repeat, $callback |
184 |
|
185 |
Calls the callback after C<$after> seconds. If C<$repeat> is true, the |
186 |
timer will be restarted after the callback returns. This means that the |
187 |
callback would be called roughly every C<$after> seconds, prolonged by the |
188 |
time the callback takes. |
189 |
|
190 |
The C<timer_ns> variant doesn't add/start the newly created watcher. |
191 |
|
192 |
=item my $w = EV::timer_abs $at, $interval, $callback |
193 |
|
194 |
=item my $w = EV::timer_abs_ns $at, $interval, $callback |
195 |
|
196 |
Similar to EV::timer, but the time is given as an absolute point in time |
197 |
(C<$at>), plus an optional C<$interval>. |
198 |
|
199 |
If the C<$interval> is zero, then the callback will be called at the time |
200 |
C<$at> if that is in the future, or as soon as possible if its in the |
201 |
past. It will not automatically repeat. |
202 |
|
203 |
If the C<$interval> is nonzero, then the watcher will always be scheduled |
204 |
to time out at the next C<$at + integer * $interval> time. |
205 |
|
206 |
This can be used to schedule a callback to run at very regular intervals, |
207 |
as long as the processing time is less then the interval (otherwise |
208 |
obviously events will be skipped). |
209 |
|
210 |
Another way to think about it (for the mathematically inclined) is that |
211 |
C<timer_abs> will try to tun the callback at the next possible time where |
212 |
C<$time = $at (mod $interval)>, regardless of any time jumps. |
213 |
|
214 |
The C<timer_abs_ns> variant doesn't add/start the newly created watcher. |
215 |
|
216 |
=item my $w = EV::signal $signal, $callback |
217 |
|
218 |
=item my $w = EV::signal_ns $signal, $callback |
219 |
|
220 |
Call the callback when $signal is received (the signal can be specified |
221 |
by number or by name, just as with kill or %SIG). Signal watchers are |
222 |
persistent no natter what. |
223 |
|
224 |
EV will grab the signal for the process (the kernel only allows one |
225 |
component to receive signals) when you start a signal watcher, and |
226 |
removes it again when you stop it. Pelr does the same when you add/remove |
227 |
callbacks to %SIG, so watch out. |
228 |
|
229 |
Unfortunately, only one handler can be registered per signal. Screw |
230 |
libevent. |
231 |
|
232 |
The C<signal_ns> variant doesn't add/start the newly created watcher. |
233 |
|
234 |
=back |
235 |
|
236 |
=head1 THE EV::Event CLASS |
237 |
|
238 |
All EV functions creating an event watcher (designated by C<my $w => |
239 |
above) support the following methods on the returned watcher object: |
240 |
|
241 |
=over 4 |
242 |
|
243 |
=item $w->add ($timeout) |
244 |
|
245 |
Stops and (re-)starts the event watcher, setting the optional timeout to |
246 |
the given value, or clearing the timeout if none is given. |
247 |
|
248 |
=item $w->start |
249 |
|
250 |
Stops and (re-)starts the event watcher without touching the timeout. |
251 |
|
252 |
=item $w->del |
253 |
|
254 |
=item $w->stop |
255 |
|
256 |
Stop the event watcher if it was started. |
257 |
|
258 |
=item $current_callback = $w->cb |
259 |
|
260 |
=item $old_callback = $w->cb ($new_callback) |
261 |
|
262 |
Return the previously set callback and optionally set a new one. |
263 |
|
264 |
=item $current_fh = $w->fh |
265 |
|
266 |
=item $old_fh = $w->fh ($new_fh) |
267 |
|
268 |
Returns the previously set filehandle and optionally set a new one (also |
269 |
clears the EV::SIGNAL flag when setting a filehandle). |
270 |
|
271 |
=item $current_signal = $w->signal |
272 |
|
273 |
=item $old_signal = $w->signal ($new_signal) |
274 |
|
275 |
Returns the previously set signal number and optionally set a new one (also sets |
276 |
the EV::SIGNAL flag when setting a signal). |
277 |
|
278 |
=item $current_eventmask = $w->events |
279 |
|
280 |
=item $old_eventmask = $w->events ($new_eventmask) |
281 |
|
282 |
Returns the previously set event mask and optionally set a new one. |
283 |
|
284 |
=item $w->timeout ($after, $repeat) |
285 |
|
286 |
Resets the timeout (see C<EV::timer> for details). |
287 |
|
288 |
=item $w->timeout_abs ($at, $interval) |
289 |
|
290 |
Resets the timeout (see C<EV::timer_abs> for details). |
291 |
|
292 |
=item $w->priority_set ($priority) |
293 |
|
294 |
Set the priority of the watcher to C<$priority> (0 <= $priority < $EV::NPRI). |
295 |
|
296 |
=back |
297 |
|
298 |
=head1 THREADS |
299 |
|
300 |
Threads are not supported by this in any way. Perl pseudo-threads is evil |
301 |
and must die. |
302 |
|
303 |
=head1 BUGS |
304 |
|
305 |
Lots. Libevent itself isn't well tested and rather buggy, and this module |
306 |
is quite new at the moment. |
307 |
|
308 |
Please note that the epoll method is not, in general, reliable in programs |
309 |
that use fork (even if no libveent calls are being made in the forked |
310 |
process). If your program behaves erratically, try setting the environment |
311 |
variable C<EVENT_NOEPOLL> first when running the program. |
312 |
|
313 |
In general, if you fork, then you can only use the EV module in one of the |
314 |
children. |
315 |
|
316 |
=cut |
317 |
|
318 |
our $DIED = sub { |
319 |
warn "EV: error in callback (ignoring): $@"; |
320 |
}; |
321 |
|
322 |
init; |
323 |
|
324 |
push @AnyEvent::REGISTRY, [EV => "EV::AnyEvent"]; |
325 |
|
326 |
1; |
327 |
|
328 |
=head1 SEE ALSO |
329 |
|
330 |
L<EV::DNS>, L<event(3)>, L<event.h>, L<evdns.h>. |
331 |
L<EV::AnyEvent>. |
332 |
|
333 |
=head1 AUTHOR |
334 |
|
335 |
Marc Lehmann <schmorp@schmorp.de> |
336 |
http://home.schmorp.de/ |
337 |
|
338 |
=cut |
339 |
|