ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/EV/EV.pm
(Generate patch)

Comparing EV/EV.pm (file contents):
Revision 1.55 by root, Tue Nov 27 08:11:52 2007 UTC vs.
Revision 1.139 by root, Fri Mar 1 11:20:07 2013 UTC

2 2
3EV - perl interface to libev, a high performance full-featured event loop 3EV - perl interface to libev, a high performance full-featured event loop
4 4
5=head1 SYNOPSIS 5=head1 SYNOPSIS
6 6
7 use EV; 7 use EV;
8
9 # TIMERS
10
11 my $w = EV::timer 2, 0, sub {
12 warn "is called after 2s";
13 };
14
15 my $w = EV::timer 2, 2, sub {
16 warn "is called roughly every 2s (repeat = 2)";
17 };
18
19 undef $w; # destroy event watcher again
20
21 my $w = EV::periodic 0, 60, 0, sub {
22 warn "is called every minute, on the minute, exactly";
23 };
24
25 # IO
26
27 my $w = EV::io *STDIN, EV::READ, sub {
28 my ($w, $revents) = @_; # all callbacks receive the watcher and event mask
29 warn "stdin is readable, you entered: ", <STDIN>;
30 };
31
32 # SIGNALS
33
34 my $w = EV::signal 'QUIT', sub {
35 warn "sigquit received\n";
36 };
37
38 # CHILD/PID STATUS CHANGES
8 39
9 # TIMERS 40 my $w = EV::child 666, 0, sub {
41 my ($w, $revents) = @_;
42 my $status = $w->rstatus;
43 };
10 44
11 my $w = EV::timer 2, 0, sub {
12 warn "is called after 2s";
13 };
14
15 my $w = EV::timer 2, 2, sub {
16 warn "is called roughly every 2s (repeat = 2)";
17 };
18
19 undef $w; # destroy event watcher again
20
21 my $w = EV::periodic 0, 60, 0, sub {
22 warn "is called every minute, on the minute, exactly";
23 };
24
25 # IO
26
27 my $w = EV::io *STDIN, EV::READ, sub {
28 my ($w, $revents) = @_; # all callbacks receive the watcher and event mask
29 warn "stdin is readable, you entered: ", <STDIN>;
30 };
31
32 # SIGNALS
33
34 my $w = EV::signal 'QUIT', sub {
35 warn "sigquit received\n";
36 };
37
38 # CHILD/PID STATUS CHANGES
39
40 my $w = EV::child 666, sub {
41 my ($w, $revents) = @_;
42 my $status = $w->rstatus;
43 };
44
45 # STAT CHANGES 45 # STAT CHANGES
46 my $w = EV::stat "/etc/passwd", 10, sub { 46 my $w = EV::stat "/etc/passwd", 10, sub {
47 my ($w, $revents) = @_; 47 my ($w, $revents) = @_;
48 warn $w->path, " has changed somehow.\n"; 48 warn $w->path, " has changed somehow.\n";
49 }; 49 };
50 50
51 # MAINLOOP 51 # MAINLOOP
52 EV::loop; # loop until EV::unloop is called or all watchers stop 52 EV::run; # loop until EV::unloop is called or all watchers stop
53 EV::loop EV::LOOP_ONESHOT; # block until at least one event could be handled 53 EV::run EV::RUN_ONCE; # block until at least one event could be handled
54 EV::loop EV::LOOP_NONBLOCK; # try to handle same events, but do not block 54 EV::run EV::RUN_NOWAIT; # try to handle same events, but do not block
55
56=head1 BEFORE YOU START USING THIS MODULE
57
58If you only need timer, I/O, signal, child and idle watchers and not the
59advanced functionality of this module, consider using L<AnyEvent> instead,
60specifically the simplified API described in L<AE>.
61
62When used with EV as backend, the L<AE> API is as fast as the native L<EV>
63API, but your programs/modules will still run with many other event loops.
55 64
56=head1 DESCRIPTION 65=head1 DESCRIPTION
57 66
58This module provides an interface to libev 67This module provides an interface to libev
59(L<http://software.schmorp.de/pkg/libev.html>). While the documentation 68(L<http://software.schmorp.de/pkg/libev.html>). While the documentation
60below is comprehensive, one might also consult the documentation of libev 69below is comprehensive, one might also consult the documentation of
61itself (L<http://cvs.schmorp.de/libev/ev.html>) for more subtle details on 70libev itself (L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod> or
62watcher semantics or some discussion on the available backends, or how to 71F<perldoc EV::libev>) for more subtle details on watcher semantics or some
63force a specific backend with C<LIBEV_FLAGS>. 72discussion on the available backends, or how to force a specific backend
73with C<LIBEV_FLAGS>, or just about in any case because it has much more
74detailed information.
75
76This module is very fast and scalable. It is actually so fast that you
77can use it through the L<AnyEvent> module, stay portable to other event
78loops (if you don't rely on any watcher types not available through it)
79and still be faster than with any other event loop currently supported in
80Perl.
81
82=head2 PORTING FROM EV 3.X to 4.X
83
84EV version 4 introduces a number of incompatible changes summarised
85here. According to the depreciation strategy used by libev, there is a
86compatibility layer in place so programs should continue to run unchanged
87(the XS interface lacks this layer, so programs using that one need to be
88updated).
89
90This compatibility layer will be switched off in some future release.
91
92All changes relevant to Perl are renames of symbols, functions and
93methods:
94
95 EV::loop => EV::run
96 EV::LOOP_NONBLOCK => EV::RUN_NOWAIT
97 EV::LOOP_ONESHOT => EV::RUN_ONCE
98
99 EV::unloop => EV::break
100 EV::UNLOOP_CANCEL => EV::BREAK_CANCEL
101 EV::UNLOOP_ONE => EV::BREAK_ONE
102 EV::UNLOOP_ALL => EV::BREAK_ALL
103
104 EV::TIMEOUT => EV::TIMER
105
106 EV::loop_count => EV::iteration
107 EV::loop_depth => EV::depth
108 EV::loop_verify => EV::verify
109
110The loop object methods corresponding to the functions above have been
111similarly renamed.
112
113=head2 MODULE EXPORTS
114
115This module does not export any symbols.
64 116
65=cut 117=cut
66 118
67package EV; 119package EV;
68 120
69use strict; 121use common::sense;
70 122
71BEGIN { 123BEGIN {
72 our $VERSION = '1.4'; 124 our $VERSION = '4.15';
73 use XSLoader; 125 use XSLoader;
74 XSLoader::load "EV", $VERSION; 126 XSLoader::load "EV", $VERSION;
75} 127}
76 128
77@EV::IO::ISA = 129@EV::IO::ISA =
78@EV::Timer::ISA = 130@EV::Timer::ISA =
79@EV::Periodic::ISA = 131@EV::Periodic::ISA =
80@EV::Signal::ISA = 132@EV::Signal::ISA =
133@EV::Child::ISA =
134@EV::Stat::ISA =
81@EV::Idle::ISA = 135@EV::Idle::ISA =
82@EV::Prepare::ISA = 136@EV::Prepare::ISA =
83@EV::Check::ISA = 137@EV::Check::ISA =
84@EV::Child::ISA =
85@EV::Embed::ISA = 138@EV::Embed::ISA =
86@EV::Stat::ISA = "EV::Watcher"; 139@EV::Fork::ISA =
140@EV::Async::ISA =
141 "EV::Watcher";
142
143@EV::Loop::Default::ISA = "EV::Loop";
144
145=head1 EVENT LOOPS
146
147EV supports multiple event loops: There is a single "default event loop"
148that can handle everything including signals and child watchers, and any
149number of "dynamic event loops" that can use different backends (with
150various limitations), but no child and signal watchers.
151
152You do not have to do anything to create the default event loop: When
153the module is loaded a suitable backend is selected on the premise of
154selecting a working backend (which for example rules out kqueue on most
155BSDs). Modules should, unless they have "special needs" always use the
156default loop as this is fastest (perl-wise), best supported by other
157modules (e.g. AnyEvent or Coro) and most portable event loop.
158
159For specific programs you can create additional event loops dynamically.
160
161If you want to take advantage of kqueue (which often works properly for
162sockets only) even though the default loop doesn't enable it, you can
163I<embed> a kqueue loop into the default loop: running the default loop
164will then also service the kqueue loop to some extent. See the example in
165the section about embed watchers for an example on how to achieve that.
166
167=over 4
168
169=item $loop = new EV::Loop [$flags]
170
171Create a new event loop as per the specified flags. Please refer to
172the C<ev_loop_new ()> function description in the libev documentation
173(L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#GLOBAL_FUNCTIONS>,
174or locally-installed as F<EV::libev> manpage) for more info.
175
176The loop will automatically be destroyed when it is no longer referenced
177by any watcher and the loop object goes out of scope.
178
179If you are not embedding the loop, then Using C<EV::FLAG_FORKCHECK>
180is recommended, as only the default event loop is protected by this
181module. If you I<are> embedding this loop in the default loop, this is not
182necessary, as C<EV::embed> automatically does the right thing on fork.
183
184=item $loop->loop_fork
185
186Must be called after a fork in the child, before entering or continuing
187the event loop. An alternative is to use C<EV::FLAG_FORKCHECK> which calls
188this function automatically, at some performance loss (refer to the libev
189documentation).
190
191=item $loop->verify
192
193Calls C<ev_verify> to make internal consistency checks (for debugging
194libev) and abort the program if any data structures were found to be
195corrupted.
196
197=item $loop = EV::default_loop [$flags]
198
199Return the default loop (which is a singleton object). Since this module
200already creates the default loop with default flags, specifying flags here
201will not have any effect unless you destroy the default loop first, which
202isn't supported. So in short: don't do it, and if you break it, you get to
203keep the pieces.
204
205=back
206
87 207
88=head1 BASIC INTERFACE 208=head1 BASIC INTERFACE
89 209
90=over 4 210=over 4
91 211
92=item $EV::DIED 212=item $EV::DIED
93 213
94Must contain a reference to a function that is called when a callback 214Must contain a reference to a function that is called when a callback
95throws an exception (with $@ containing thr error). The default prints an 215throws an exception (with $@ containing the error). The default prints an
96informative message and continues. 216informative message and continues.
97 217
98If this callback throws an exception it will be silently ignored. 218If this callback throws an exception it will be silently ignored.
99 219
220=item $flags = EV::supported_backends
221
222=item $flags = EV::recommended_backends
223
224=item $flags = EV::embeddable_backends
225
226Returns the set (see C<EV::BACKEND_*> flags) of backends supported by this
227instance of EV, the set of recommended backends (supposed to be good) for
228this platform and the set of embeddable backends (see EMBED WATCHERS).
229
230=item EV::sleep $seconds
231
232Block the process for the given number of (fractional) seconds.
233
100=item $time = EV::time 234=item $time = EV::time
101 235
102Returns the current time in (fractional) seconds since the epoch. 236Returns the current time in (fractional) seconds since the epoch.
103 237
104=item $time = EV::now 238=item $time = EV::now
105 239
240=item $time = $loop->now
241
106Returns the time the last event loop iteration has been started. This 242Returns the time the last event loop iteration has been started. This
107is the time that (relative) timers are based on, and refering to it is 243is the time that (relative) timers are based on, and referring to it is
108usually faster then calling EV::time. 244usually faster then calling EV::time.
109 245
110=item $method = EV::method 246=item EV::now_update
111 247
248=item $loop->now_update
249
250Establishes the current time by querying the kernel, updating the time
251returned by C<EV::now> in the progress. This is a costly operation and
252is usually done automatically within C<EV::loop>.
253
254This function is rarely useful, but when some event callback runs for a
255very long time without entering the event loop, updating libev's idea of
256the current time is a good idea.
257
258=item EV::suspend
259
260=item $loop->suspend
261
262=item EV::resume
263
264=item $loop->resume
265
266These two functions suspend and resume a loop, for use when the loop is
267not used for a while and timeouts should not be processed.
268
269A typical use case would be an interactive program such as a game: When
270the user presses C<^Z> to suspend the game and resumes it an hour later it
271would be best to handle timeouts as if no time had actually passed while
272the program was suspended. This can be achieved by calling C<suspend>
273in your C<SIGTSTP> handler, sending yourself a C<SIGSTOP> and calling
274C<resume> directly afterwards to resume timer processing.
275
276Effectively, all C<timer> watchers will be delayed by the time spend
277between C<suspend> and C<resume>, and all C<periodic> watchers
278will be rescheduled (that is, they will lose any events that would have
279occured while suspended).
280
281After calling C<suspend> you B<must not> call I<any> function on the given
282loop other than C<resume>, and you B<must not> call C<resume>
283without a previous call to C<suspend>.
284
285Calling C<suspend>/C<resume> has the side effect of updating the event
286loop time (see C<now_update>).
287
288=item $backend = EV::backend
289
290=item $backend = $loop->backend
291
112Returns an integer describing the backend used by libev (EV::METHOD_SELECT 292Returns an integer describing the backend used by libev (EV::BACKEND_SELECT
113or EV::METHOD_EPOLL). 293or EV::BACKEND_EPOLL).
114 294
115=item EV::loop [$flags] 295=item $active = EV::run [$flags]
296
297=item $active = $loop->run ([$flags])
116 298
117Begin checking for events and calling callbacks. It returns when a 299Begin checking for events and calling callbacks. It returns when a
118callback calls EV::unloop. 300callback calls EV::unloop or the flasg are nonzero (in which case the
301return value is true) or when there are no active watchers which reference
302the loop (keepalive is true), in which case the return value will be
303false. The returnv alue can generally be interpreted as "if true, there is
304more work left to do".
119 305
120The $flags argument can be one of the following: 306The $flags argument can be one of the following:
121 307
122 0 as above 308 0 as above
123 EV::LOOP_ONESHOT block at most once (wait, but do not loop) 309 EV::RUN_ONCE block at most once (wait, but do not loop)
124 EV::LOOP_NONBLOCK do not block at all (fetch/handle events but do not wait) 310 EV::RUN_NOWAIT do not block at all (fetch/handle events but do not wait)
125 311
126=item EV::unloop [$how] 312=item EV::break [$how]
127 313
314=item $loop->break ([$how])
315
128When called with no arguments or an argument of EV::UNLOOP_ONE, makes the 316When called with no arguments or an argument of EV::BREAK_ONE, makes the
129innermost call to EV::loop return. 317innermost call to EV::loop return.
130 318
131When called with an argument of EV::UNLOOP_ALL, all calls to EV::loop will return as 319When called with an argument of EV::BREAK_ALL, all calls to EV::loop will
132fast as possible. 320return as fast as possible.
321
322When called with an argument of EV::BREAK_CANCEL, any pending break will
323be cancelled.
324
325=item $count = EV::iteration
326
327=item $count = $loop->iteration
328
329Return the number of times the event loop has polled for new
330events. Sometimes useful as a generation counter.
133 331
134=item EV::once $fh_or_undef, $events, $timeout, $cb->($revents) 332=item EV::once $fh_or_undef, $events, $timeout, $cb->($revents)
333
334=item $loop->once ($fh_or_undef, $events, $timeout, $cb->($revents))
135 335
136This function rolls together an I/O and a timer watcher for a single 336This function rolls together an I/O and a timer watcher for a single
137one-shot event without the need for managing a watcher object. 337one-shot event without the need for managing a watcher object.
138 338
139If C<$fh_or_undef> is a filehandle or file descriptor, then C<$events> 339If C<$fh_or_undef> is a filehandle or file descriptor, then C<$events>
145If timeout is C<undef> or negative, then there will be no 345If timeout is C<undef> or negative, then there will be no
146timeout. Otherwise a EV::timer with this value will be started. 346timeout. Otherwise a EV::timer with this value will be started.
147 347
148When an error occurs or either the timeout or I/O watcher triggers, then 348When an error occurs or either the timeout or I/O watcher triggers, then
149the callback will be called with the received event set (in general 349the callback will be called with the received event set (in general
150you can expect it to be a combination of C<EV:ERROR>, C<EV::READ>, 350you can expect it to be a combination of C<EV::ERROR>, C<EV::READ>,
151C<EV::WRITE> and C<EV::TIMEOUT>). 351C<EV::WRITE> and C<EV::TIMER>).
152 352
153EV::once doesn't return anything: the watchers stay active till either 353EV::once doesn't return anything: the watchers stay active till either
154of them triggers, then they will be stopped and freed, and the callback 354of them triggers, then they will be stopped and freed, and the callback
155invoked. 355invoked.
156 356
157=back 357=item EV::feed_fd_event $fd, $revents
158 358
359=item $loop->feed_fd_event ($fd, $revents)
360
361Feed an event on a file descriptor into EV. EV will react to this call as
362if the readyness notifications specified by C<$revents> (a combination of
363C<EV::READ> and C<EV::WRITE>) happened on the file descriptor C<$fd>.
364
365=item EV::feed_signal_event $signal
366
367Feed a signal event into the default loop. EV will react to this call as
368if the signal specified by C<$signal> had occured.
369
370=item EV::feed_signal $signal
371
372Feed a signal event into EV - unlike C<EV::feed_signal_event>, this works
373regardless of which loop has registered the signal, and is mainly useful
374fro custom signal implementations.
375
376=item EV::set_io_collect_interval $time
377
378=item $loop->set_io_collect_interval ($time)
379
380=item EV::set_timeout_collect_interval $time
381
382=item $loop->set_timeout_collect_interval ($time)
383
384These advanced functions set the minimum block interval when polling for I/O events and the minimum
385wait interval for timer events. See the libev documentation at
386L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#FUNCTIONS_CONTROLLING_THE_EVENT_LOOP>
387(locally installed as F<EV::libev>) for a more detailed discussion.
388
389=item $count = EV::pending_count
390
391=item $count = $loop->pending_count
392
393Returns the number of currently pending watchers.
394
395=item EV::invoke_pending
396
397=item $loop->invoke_pending
398
399Invoke all currently pending watchers.
400
401=back
402
403
159=head2 WATCHER OBJECTS 404=head1 WATCHER OBJECTS
160 405
161A watcher is an object that gets created to record your interest in some 406A watcher is an object that gets created to record your interest in some
162event. For instance, if you want to wait for STDIN to become readable, you 407event. For instance, if you want to wait for STDIN to become readable, you
163would create an EV::io watcher for that: 408would create an EV::io watcher for that:
164 409
165 my $watcher = EV::io *STDIN, EV::READ, sub { 410 my $watcher = EV::io *STDIN, EV::READ, sub {
166 my ($watcher, $revents) = @_; 411 my ($watcher, $revents) = @_;
167 warn "yeah, STDIN should not be readable without blocking!\n" 412 warn "yeah, STDIN should now be readable without blocking!\n"
168 }; 413 };
169 414
170All watchers can be active (waiting for events) or inactive (paused). Only 415All watchers can be active (waiting for events) or inactive (paused). Only
171active watchers will have their callbacks invoked. All callbacks will be 416active watchers will have their callbacks invoked. All callbacks will be
172called with at least two arguments: the watcher and a bitmask of received 417called with at least two arguments: the watcher and a bitmask of received
173events. 418events.
174 419
175Each watcher type has its associated bit in revents, so you can use the 420Each watcher type has its associated bit in revents, so you can use the
176same callback for multiple watchers. The event mask is named after the 421same callback for multiple watchers. The event mask is named after the
177type, i..e. EV::child sets EV::CHILD, EV::prepare sets EV::PREPARE, 422type, i.e. EV::child sets EV::CHILD, EV::prepare sets EV::PREPARE,
178EV::periodic sets EV::PERIODIC and so on, with the exception of IO events 423EV::periodic sets EV::PERIODIC and so on, with the exception of I/O events
179(which can set both EV::READ and EV::WRITE bits), and EV::timer (which 424(which can set both EV::READ and EV::WRITE bits).
180uses EV::TIMEOUT).
181 425
182In the rare case where one wants to create a watcher but not start it at 426In the rare case where one wants to create a watcher but not start it at
183the same time, each constructor has a variant with a trailing C<_ns> in 427the same time, each constructor has a variant with a trailing C<_ns> in
184its name, e.g. EV::io has a non-starting variant EV::io_ns and so on. 428its name, e.g. EV::io has a non-starting variant EV::io_ns and so on.
185 429
205 449
206=item $w->stop 450=item $w->stop
207 451
208Stop a watcher if it is active. Also clear any pending events (events that 452Stop a watcher if it is active. Also clear any pending events (events that
209have been received but that didn't yet result in a callback invocation), 453have been received but that didn't yet result in a callback invocation),
210regardless of wether the watcher was active or not. 454regardless of whether the watcher was active or not.
211 455
212=item $bool = $w->is_active 456=item $bool = $w->is_active
213 457
214Returns true if the watcher is active, false otherwise. 458Returns true if the watcher is active, false otherwise.
215 459
245The default priority of any newly-created watcher is 0. 489The default priority of any newly-created watcher is 0.
246 490
247Note that the priority semantics have not yet been fleshed out and are 491Note that the priority semantics have not yet been fleshed out and are
248subject to almost certain change. 492subject to almost certain change.
249 493
250=item $w->trigger ($revents) 494=item $w->invoke ($revents)
251 495
252Call the callback *now* with the given event mask. 496Call the callback *now* with the given event mask.
497
498=item $w->feed_event ($revents)
499
500Feed some events on this watcher into EV. EV will react to this call as if
501the watcher had received the given C<$revents> mask.
502
503=item $revents = $w->clear_pending
504
505If the watcher is pending, this function clears its pending status and
506returns its C<$revents> bitset (as if its callback was invoked). If the
507watcher isn't pending it does nothing and returns C<0>.
253 508
254=item $previous_state = $w->keepalive ($bool) 509=item $previous_state = $w->keepalive ($bool)
255 510
256Normally, C<EV::loop> will return when there are no active watchers 511Normally, C<EV::loop> will return when there are no active watchers
257(which is a "deadlock" because no progress can be made anymore). This is 512(which is a "deadlock" because no progress can be made anymore). This is
258convinient because it allows you to start your watchers (and your jobs), 513convenient because it allows you to start your watchers (and your jobs),
259call C<EV::loop> once and when it returns you know that all your jobs are 514call C<EV::loop> once and when it returns you know that all your jobs are
260finished (or they forgot to register some watchers for their task :). 515finished (or they forgot to register some watchers for their task :).
261 516
262Sometimes, however, this gets in your way, for example when you the module 517Sometimes, however, this gets in your way, for example when the module
263that calls C<EV::loop> (usually the main program) is not the same module 518that calls C<EV::loop> (usually the main program) is not the same module
264as a long-living watcher (for example a DNS client module written by 519as a long-living watcher (for example a DNS client module written by
265somebody else even). Then you might want any outstanding requests to be 520somebody else even). Then you might want any outstanding requests to be
266handled, but you would not want to keep C<EV::loop> from returning just 521handled, but you would not want to keep C<EV::loop> from returning just
267because you happen to have this long-running UDP port watcher. 522because you happen to have this long-running UDP port watcher.
268 523
269In this case you can clear the keepalive status, which means that even 524In this case you can clear the keepalive status, which means that even
270though your watcher is active, it won't keep C<EV::loop> from returning. 525though your watcher is active, it won't keep C<EV::loop> from returning.
271 526
272The initial value for keepalive is true (enabled), and you cna change it 527The initial value for keepalive is true (enabled), and you can change it
273any time. 528any time.
274 529
275Example: Register an IO watcher for some UDP socket but do not keep the 530Example: Register an I/O watcher for some UDP socket but do not keep the
276event loop from running just because of that watcher. 531event loop from running just because of that watcher.
277 532
278 my $udp_socket = ... 533 my $udp_socket = ...
279 my $udp_watcher = EV::io $udp_socket, EV::READ, sub { ... }; 534 my $udp_watcher = EV::io $udp_socket, EV::READ, sub { ... };
280 $udp_watcher->keepalive (0); 535 $udp_watcher->keepalive (0);
281 536
282=back 537=item $loop = $w->loop
283 538
539Return the loop that this watcher is attached to.
284 540
541=back
542
543
285=head2 WATCHER TYPES 544=head1 WATCHER TYPES
286 545
287Each of the following subsections describes a single watcher type. 546Each of the following subsections describes a single watcher type.
288 547
289=head3 IO WATCHERS - is this file descriptor readable or writable? 548=head3 I/O WATCHERS - is this file descriptor readable or writable?
290 549
291=over 4 550=over 4
292 551
293=item $w = EV::io $fileno_or_fh, $eventmask, $callback 552=item $w = EV::io $fileno_or_fh, $eventmask, $callback
294 553
295=item $w = EV::io_ns $fileno_or_fh, $eventmask, $callback 554=item $w = EV::io_ns $fileno_or_fh, $eventmask, $callback
555
556=item $w = $loop->io ($fileno_or_fh, $eventmask, $callback)
557
558=item $w = $loop->io_ns ($fileno_or_fh, $eventmask, $callback)
296 559
297As long as the returned watcher object is alive, call the C<$callback> 560As long as the returned watcher object is alive, call the C<$callback>
298when at least one of events specified in C<$eventmask> occurs. 561when at least one of events specified in C<$eventmask> occurs.
299 562
300The $eventmask can be one or more of these constants ORed together: 563The $eventmask can be one or more of these constants ORed together:
329=over 4 592=over 4
330 593
331=item $w = EV::timer $after, $repeat, $callback 594=item $w = EV::timer $after, $repeat, $callback
332 595
333=item $w = EV::timer_ns $after, $repeat, $callback 596=item $w = EV::timer_ns $after, $repeat, $callback
597
598=item $w = $loop->timer ($after, $repeat, $callback)
599
600=item $w = $loop->timer_ns ($after, $repeat, $callback)
334 601
335Calls the callback after C<$after> seconds (which may be fractional). If 602Calls the callback after C<$after> seconds (which may be fractional). If
336C<$repeat> is non-zero, the timer will be restarted (with the $repeat 603C<$repeat> is non-zero, the timer will be restarted (with the $repeat
337value as $after) after the callback returns. 604value as $after) after the callback returns.
338 605
379=over 4 646=over 4
380 647
381=item $w = EV::periodic $at, $interval, $reschedule_cb, $callback 648=item $w = EV::periodic $at, $interval, $reschedule_cb, $callback
382 649
383=item $w = EV::periodic_ns $at, $interval, $reschedule_cb, $callback 650=item $w = EV::periodic_ns $at, $interval, $reschedule_cb, $callback
651
652=item $w = $loop->periodic ($at, $interval, $reschedule_cb, $callback)
653
654=item $w = $loop->periodic_ns ($at, $interval, $reschedule_cb, $callback)
384 655
385Similar to EV::timer, but is not based on relative timeouts but on 656Similar to EV::timer, but is not based on relative timeouts but on
386absolute times. Apart from creating "simple" timers that trigger "at" the 657absolute times. Apart from creating "simple" timers that trigger "at" the
387specified time, it can also be used for non-drifting absolute timers and 658specified time, it can also be used for non-drifting absolute timers and
388more complex, cron-like, setups that are not adversely affected by time 659more complex, cron-like, setups that are not adversely affected by time
398This time simply fires at the wallclock time C<$at> and doesn't repeat. It 669This time simply fires at the wallclock time C<$at> and doesn't repeat. It
399will not adjust when a time jump occurs, that is, if it is to be run 670will not adjust when a time jump occurs, that is, if it is to be run
400at January 1st 2011 then it will run when the system time reaches or 671at January 1st 2011 then it will run when the system time reaches or
401surpasses this time. 672surpasses this time.
402 673
403=item * non-repeating interval timer ($interval > 0, $reschedule_cb = 0) 674=item * repeating interval timer ($interval > 0, $reschedule_cb = 0)
404 675
405In this mode the watcher will always be scheduled to time out at the 676In this mode the watcher will always be scheduled to time out at the
406next C<$at + N * $interval> time (for some integer N) and then repeat, 677next C<$at + N * $interval> time (for some integer N) and then repeat,
407regardless of any time jumps. 678regardless of any time jumps.
408 679
426time the periodic watcher gets scheduled, the reschedule callback 697time the periodic watcher gets scheduled, the reschedule callback
427($reschedule_cb) will be called with the watcher as first, and the current 698($reschedule_cb) will be called with the watcher as first, and the current
428time as second argument. 699time as second argument.
429 700
430I<This callback MUST NOT stop or destroy this or any other periodic 701I<This callback MUST NOT stop or destroy this or any other periodic
431watcher, ever>. If you need to stop it, return 1e30 and stop it 702watcher, ever, and MUST NOT call any event loop functions or methods>. If
432afterwards. 703you need to stop it, return 1e30 and stop it afterwards. You may create
704and start a C<EV::prepare> watcher for this task.
433 705
434It must return the next time to trigger, based on the passed time value 706It must return the next time to trigger, based on the passed time value
435(that is, the lowest time value larger than to the second argument). It 707(that is, the lowest time value larger than or equal to to the second
436will usually be called just before the callback will be triggered, but 708argument). It will usually be called just before the callback will be
437might be called at other times, too. 709triggered, but might be called at other times, too.
438 710
439This can be used to create very complex timers, such as a timer that 711This can be used to create very complex timers, such as a timer that
440triggers on each midnight, local time (actually 24 hours after the last 712triggers on each midnight, local time (actually 24 hours after the last
441midnight, to keep the example simple. If you know a way to do it correctly 713midnight, to keep the example simple. If you know a way to do it correctly
442in about the same space (without requiring elaborate modules), drop me a 714in about the same space (without requiring elaborate modules), drop me a
463 735
464=item $w->again 736=item $w->again
465 737
466Simply stops and starts the watcher again. 738Simply stops and starts the watcher again.
467 739
740=item $time = $w->at
741
742Return the time that the watcher is expected to trigger next.
743
468=back 744=back
469 745
470 746
471=head3 SIGNAL WATCHERS - signal me when a signal gets signalled! 747=head3 SIGNAL WATCHERS - signal me when a signal gets signalled!
472 748
473=over 4 749=over 4
474 750
475=item $w = EV::signal $signal, $callback 751=item $w = EV::signal $signal, $callback
476 752
477=item $w = EV::signal_ns $signal, $callback 753=item $w = EV::signal_ns $signal, $callback
754
755=item $w = $loop->signal ($signal, $callback)
756
757=item $w = $loop->signal_ns ($signal, $callback)
478 758
479Call the callback when $signal is received (the signal can be specified by 759Call the callback when $signal is received (the signal can be specified by
480number or by name, just as with C<kill> or C<%SIG>). 760number or by name, just as with C<kill> or C<%SIG>).
761
762Only one event loop can grab a given signal - attempting to grab the same
763signal from two EV loops will crash the program immediately or cause data
764corruption.
481 765
482EV will grab the signal for the process (the kernel only allows one 766EV will grab the signal for the process (the kernel only allows one
483component to receive a signal at a time) when you start a signal watcher, 767component to receive a signal at a time) when you start a signal watcher,
484and removes it again when you stop it. Perl does the same when you 768and removes it again when you stop it. Perl does the same when you
485add/remove callbacks to C<%SIG>, so watch out. 769add/remove callbacks to C<%SIG>, so watch out.
505 789
506=head3 CHILD WATCHERS - watch out for process status changes 790=head3 CHILD WATCHERS - watch out for process status changes
507 791
508=over 4 792=over 4
509 793
510=item $w = EV::child $pid, $callback 794=item $w = EV::child $pid, $trace, $callback
511 795
512=item $w = EV::child_ns $pid, $callback 796=item $w = EV::child_ns $pid, $trace, $callback
513 797
798=item $w = $loop->child ($pid, $trace, $callback)
799
800=item $w = $loop->child_ns ($pid, $trace, $callback)
801
514Call the callback when a status change for pid C<$pid> (or any pid if 802Call the callback when a status change for pid C<$pid> (or any pid
515C<$pid> is 0) has been received. More precisely: when the process receives 803if C<$pid> is 0) has been received (a status change happens when the
804process terminates or is killed, or, when trace is true, additionally when
805it is stopped or continued). More precisely: when the process receives
516a C<SIGCHLD>, EV will fetch the outstanding exit/wait status for all 806a C<SIGCHLD>, EV will fetch the outstanding exit/wait status for all
517changed/zombie children and call the callback. 807changed/zombie children and call the callback.
518 808
519It is valid (and fully supported) to install a child watcher after a child 809It is valid (and fully supported) to install a child watcher after a child
520has exited but before the event loop has started its next iteration (for 810has exited but before the event loop has started its next iteration (for
527You can have as many pid watchers per pid as you want, they will all be 817You can have as many pid watchers per pid as you want, they will all be
528called. 818called.
529 819
530The C<child_ns> variant doesn't start (activate) the newly created watcher. 820The C<child_ns> variant doesn't start (activate) the newly created watcher.
531 821
532=item $w->set ($pid) 822=item $w->set ($pid, $trace)
533 823
534Reconfigures the watcher, see the constructor above for details. Can be called at 824Reconfigures the watcher, see the constructor above for details. Can be called at
535any time. 825any time.
536 826
537=item $current_pid = $w->pid 827=item $current_pid = $w->pid
538 828
539=item $old_pid = $w->pid ($new_pid)
540
541Returns the previously set process id and optionally set a new one. 829Returns the previously set process id and optionally set a new one.
542 830
543=item $exit_status = $w->rstatus 831=item $exit_status = $w->rstatus
544 832
545Return the exit/wait status (as returned by waitpid, see the waitpid entry 833Return the exit/wait status (as returned by waitpid, see the waitpid entry
551watcher for all pids). 839watcher for all pids).
552 840
553=back 841=back
554 842
555 843
844=head3 STAT WATCHERS - did the file attributes just change?
845
846=over 4
847
848=item $w = EV::stat $path, $interval, $callback
849
850=item $w = EV::stat_ns $path, $interval, $callback
851
852=item $w = $loop->stat ($path, $interval, $callback)
853
854=item $w = $loop->stat_ns ($path, $interval, $callback)
855
856Call the callback when a file status change has been detected on
857C<$path>. The C<$path> does not need to exist, changing from "path exists"
858to "path does not exist" is a status change like any other.
859
860The C<$interval> is a recommended polling interval for systems where
861OS-supported change notifications don't exist or are not supported. If
862you use C<0> then an unspecified default is used (which is highly
863recommended!), which is to be expected to be around five seconds usually.
864
865This watcher type is not meant for massive numbers of stat watchers,
866as even with OS-supported change notifications, this can be
867resource-intensive.
868
869The C<stat_ns> variant doesn't start (activate) the newly created watcher.
870
871=item ... = $w->stat
872
873This call is very similar to the perl C<stat> built-in: It stats (using
874C<lstat>) the path specified in the watcher and sets perls stat cache (as
875well as EV's idea of the current stat values) to the values found.
876
877In scalar context, a boolean is return indicating success or failure of
878the stat. In list context, the same 13-value list as with stat is returned
879(except that the blksize and blocks fields are not reliable).
880
881In the case of an error, errno is set to C<ENOENT> (regardless of the
882actual error value) and the C<nlink> value is forced to zero (if the stat
883was successful then nlink is guaranteed to be non-zero).
884
885See also the next two entries for more info.
886
887=item ... = $w->attr
888
889Just like C<< $w->stat >>, but without the initial stat'ing: this returns
890the values most recently detected by EV. See the next entry for more info.
891
892=item ... = $w->prev
893
894Just like C<< $w->stat >>, but without the initial stat'ing: this returns
895the previous set of values, before the change.
896
897That is, when the watcher callback is invoked, C<< $w->prev >> will be set
898to the values found I<before> a change was detected, while C<< $w->attr >>
899returns the values found leading to the change detection. The difference (if any)
900between C<prev> and C<attr> is what triggered the callback.
901
902If you did something to the filesystem object and do not want to trigger
903yet another change, you can call C<stat> to update EV's idea of what the
904current attributes are.
905
906=item $w->set ($path, $interval)
907
908Reconfigures the watcher, see the constructor above for details. Can be
909called at any time.
910
911=item $current_path = $w->path
912
913=item $old_path = $w->path ($new_path)
914
915Returns the previously set path and optionally set a new one.
916
917=item $current_interval = $w->interval
918
919=item $old_interval = $w->interval ($new_interval)
920
921Returns the previously set interval and optionally set a new one. Can be
922used to query the actual interval used.
923
924=back
925
926
556=head3 IDLE WATCHERS - when you've got nothing better to do... 927=head3 IDLE WATCHERS - when you've got nothing better to do...
557 928
558=over 4 929=over 4
559 930
560=item $w = EV::idle $callback 931=item $w = EV::idle $callback
561 932
562=item $w = EV::idle_ns $callback 933=item $w = EV::idle_ns $callback
563 934
564Call the callback when there are no pending io, timer/periodic, signal or 935=item $w = $loop->idle ($callback)
565child events, i.e. when the process is idle. 936
937=item $w = $loop->idle_ns ($callback)
938
939Call the callback when there are no other pending watchers of the same or
940higher priority (excluding check, prepare and other idle watchers of the
941same or lower priority, of course). They are called idle watchers because
942when the watcher is the highest priority pending event in the process, the
943process is considered to be idle at that priority.
944
945If you want a watcher that is only ever called when I<no> other events are
946outstanding you have to set the priority to C<EV::MINPRI>.
566 947
567The process will not block as long as any idle watchers are active, and 948The process will not block as long as any idle watchers are active, and
568they will be called repeatedly until stopped. 949they will be called repeatedly until stopped.
569 950
951For example, if you have idle watchers at priority C<0> and C<1>, and
952an I/O watcher at priority C<0>, then the idle watcher at priority C<1>
953and the I/O watcher will always run when ready. Only when the idle watcher
954at priority C<1> is stopped and the I/O watcher at priority C<0> is not
955pending with the C<0>-priority idle watcher be invoked.
956
570The C<idle_ns> variant doesn't start (activate) the newly created watcher. 957The C<idle_ns> variant doesn't start (activate) the newly created watcher.
571 958
572=back 959=back
573 960
574 961
577=over 4 964=over 4
578 965
579=item $w = EV::prepare $callback 966=item $w = EV::prepare $callback
580 967
581=item $w = EV::prepare_ns $callback 968=item $w = EV::prepare_ns $callback
969
970=item $w = $loop->prepare ($callback)
971
972=item $w = $loop->prepare_ns ($callback)
582 973
583Call the callback just before the process would block. You can still 974Call the callback just before the process would block. You can still
584create/modify any watchers at this point. 975create/modify any watchers at this point.
585 976
586See the EV::check watcher, below, for explanations and an example. 977See the EV::check watcher, below, for explanations and an example.
596 987
597=item $w = EV::check $callback 988=item $w = EV::check $callback
598 989
599=item $w = EV::check_ns $callback 990=item $w = EV::check_ns $callback
600 991
992=item $w = $loop->check ($callback)
993
994=item $w = $loop->check_ns ($callback)
995
601Call the callback just after the process wakes up again (after it has 996Call the callback just after the process wakes up again (after it has
602gathered events), but before any other callbacks have been invoked. 997gathered events), but before any other callbacks have been invoked.
603 998
604This is used to integrate other event-based software into the EV 999This can be used to integrate other event-based software into the EV
605mainloop: You register a prepare callback and in there, you create io and 1000mainloop: You register a prepare callback and in there, you create io and
606timer watchers as required by the other software. Here is a real-world 1001timer watchers as required by the other software. Here is a real-world
607example of integrating Net::SNMP (with some details left out): 1002example of integrating Net::SNMP (with some details left out):
608 1003
609 our @snmp_watcher; 1004 our @snmp_watcher;
614 or return; 1009 or return;
615 1010
616 # make the dispatcher handle any outstanding stuff 1011 # make the dispatcher handle any outstanding stuff
617 ... not shown 1012 ... not shown
618 1013
619 # create an IO watcher for each and every socket 1014 # create an I/O watcher for each and every socket
620 @snmp_watcher = ( 1015 @snmp_watcher = (
621 (map { EV::io $_, EV::READ, sub { } } 1016 (map { EV::io $_, EV::READ, sub { } }
622 keys %{ $dispatcher->{_descriptors} }), 1017 keys %{ $dispatcher->{_descriptors} }),
623 1018
624 EV::timer +($event->[Net::SNMP::Dispatcher::_ACTIVE] 1019 EV::timer +($event->[Net::SNMP::Dispatcher::_ACTIVE]
639 # make the dispatcher handle any new stuff 1034 # make the dispatcher handle any new stuff
640 ... not shown 1035 ... not shown
641 }; 1036 };
642 1037
643The callbacks of the created watchers will not be called as the watchers 1038The callbacks of the created watchers will not be called as the watchers
644are destroyed before this cna happen (remember EV::check gets called 1039are destroyed before this can happen (remember EV::check gets called
645first). 1040first).
646 1041
647The C<check_ns> variant doesn't start (activate) the newly created watcher. 1042The C<check_ns> variant doesn't start (activate) the newly created watcher.
648 1043
649=back 1044=item EV::CHECK constant issues
650 1045
651=head3 STAT WATCHERS - did the file attributes just change? 1046Like all other watcher types, there is a bitmask constant for use in
1047C<$revents> and other places. The C<EV::CHECK> is special as it has
1048the same name as the C<CHECK> sub called by Perl. This doesn't cause
1049big issues on newer perls (beginning with 5.8.9), but it means thatthe
1050constant must be I<inlined>, i.e. runtime calls will not work. That means
1051that as long as you always C<use EV> and then C<EV::CHECK> you are on the
1052safe side.
652 1053
653=over 4 1054=back
654 1055
655=item $w = EV::stat $path, $interval, $callback
656 1056
657=item $w = EV::stat_ns $path, $interval, $callback 1057=head3 FORK WATCHERS - the audacity to resume the event loop after a fork
658 1058
659Call the callback when a file status change has been detected on 1059Fork watchers are called when a C<fork ()> was detected. The invocation
660C<$path>. The C<$path> does not need to exist, changing from "path exists" 1060is done before the event loop blocks next and before C<check> watchers
661to "path does not exist" is a status change like any other. 1061are being called, and only in the child after the fork.
662 1062
663The C<$interval> is a recommended polling interval for systems where 1063=over 4
664OS-supported change notifications don't exist or are not supported. If
665you use C<0> then an unspecified default is used (which is highly
666recommended!), which is to be expected to be around five seconds usually.
667 1064
668This watcher type is not meant for massive numbers of stat watchers, 1065=item $w = EV::fork $callback
669as even with OS-supported change notifications, this can be
670resource-intensive.
671 1066
1067=item $w = EV::fork_ns $callback
1068
1069=item $w = $loop->fork ($callback)
1070
1071=item $w = $loop->fork_ns ($callback)
1072
1073Call the callback before the event loop is resumed in the child process
1074after a fork.
1075
672The C<stat_ns> variant doesn't start (activate) the newly created watcher. 1076The C<fork_ns> variant doesn't start (activate) the newly created watcher.
673 1077
674=item $w->set ($path, $interval)
675
676Reconfigures the watcher, see the constructor above for details. Can be
677called at any time.
678
679=item $current_path = $w->path
680
681=item $old_path = $w->path ($new_path)
682
683Returns the previously set path and optionally set a new one.
684
685=item $current_interval = $w->interval
686
687=item $old_interval = $w->interval ($new_interval)
688
689Returns the previously set interval and optionally set a new one. Can be
690used to query the actual interval used.
691
692=back 1078=back
693 1079
694 1080
1081=head3 EMBED WATCHERS - when one backend isn't enough...
1082
1083This is a rather advanced watcher type that lets you embed one event loop
1084into another (currently only IO events are supported in the embedded
1085loop, other types of watchers might be handled in a delayed or incorrect
1086fashion and must not be used).
1087
1088See the libev documentation at
1089L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#code_ev_embed_code_when_one_backend_>
1090(locally installed as F<EV::libev>) for more details.
1091
1092In short, this watcher is most useful on BSD systems without working
1093kqueue to still be able to handle a large number of sockets:
1094
1095 my $socket_loop;
1096
1097 # check wether we use SELECT or POLL _and_ KQUEUE is supported
1098 if (
1099 (EV::backend & (EV::BACKEND_POLL | EV::BACKEND_SELECT))
1100 && (EV::supported_backends & EV::embeddable_backends & EV::BACKEND_KQUEUE)
1101 ) {
1102 # use kqueue for sockets
1103 $socket_loop = new EV::Loop EV::BACKEND_KQUEUE | EV::FLAG_NOENV;
1104 }
1105
1106 # use the default loop otherwise
1107 $socket_loop ||= EV::default_loop;
1108
1109=over 4
1110
1111=item $w = EV::embed $otherloop[, $callback]
1112
1113=item $w = EV::embed_ns $otherloop[, $callback]
1114
1115=item $w = $loop->embed ($otherloop[, $callback])
1116
1117=item $w = $loop->embed_ns ($otherloop[, $callback])
1118
1119Call the callback when the embedded event loop (C<$otherloop>) has any
1120I/O activity. The C<$callback> is optional: if it is missing, then the
1121embedded event loop will be managed automatically (which is recommended),
1122otherwise you have to invoke C<sweep> yourself.
1123
1124The C<embed_ns> variant doesn't start (activate) the newly created watcher.
1125
1126=back
1127
1128=head3 ASYNC WATCHERS - how to wake up another event loop
1129
1130Async watchers are provided by EV, but have little use in perl directly,
1131as perl neither supports threads running in parallel nor direct access to
1132signal handlers or other contexts where they could be of value.
1133
1134It is, however, possible to use them from the XS level.
1135
1136Please see the libev documentation for further details.
1137
1138=over 4
1139
1140=item $w = EV::async $callback
1141
1142=item $w = EV::async_ns $callback
1143
1144=item $w = $loop->async ($callback)
1145
1146=item $w = $loop->async_ns ($callback)
1147
1148=item $w->send
1149
1150=item $bool = $w->async_pending
1151
1152=back
1153
1154=head3 CLEANUP WATCHERS - how to clean up when the event loop goes away
1155
1156Cleanup watchers are not supported on the Perl level, they can only be
1157used via XS currently.
1158
1159
1160=head1 PERL SIGNALS
1161
1162While Perl signal handling (C<%SIG>) is not affected by EV, the behaviour
1163with EV is as the same as any other C library: Perl-signals will only be
1164handled when Perl runs, which means your signal handler might be invoked
1165only the next time an event callback is invoked.
1166
1167The solution is to use EV signal watchers (see C<EV::signal>), which will
1168ensure proper operations with regards to other event watchers.
1169
1170If you cannot do this for whatever reason, you can also force a watcher
1171to be called on every event loop iteration by installing a C<EV::check>
1172watcher:
1173
1174 my $async_check = EV::check sub { };
1175
1176This ensures that perl gets into control for a short time to handle any
1177pending signals, and also ensures (slightly) slower overall operation.
1178
695=head1 THREADS 1179=head1 ITHREADS
696 1180
697Threads are not supported by this module in any way. Perl pseudo-threads 1181Ithreads are not supported by this module in any way. Perl pseudo-threads
698is evil stuff and must die. As soon as Perl gains real threads I will work 1182is evil stuff and must die. Real threads as provided by Coro are fully
699on thread support for it. 1183supported (and enhanced support is available via L<Coro::EV>).
700 1184
701=head1 FORK 1185=head1 FORK
702 1186
703Most of the "improved" event delivering mechanisms of modern operating 1187Most of the "improved" event delivering mechanisms of modern operating
704systems have quite a few problems with fork(2) (to put it bluntly: it is 1188systems have quite a few problems with fork(2) (to put it bluntly: it is
720our $DIED = sub { 1204our $DIED = sub {
721 warn "EV: error in callback (ignoring): $@"; 1205 warn "EV: error in callback (ignoring): $@";
722}; 1206};
723 1207
724default_loop 1208default_loop
725 or die 'EV: cannot initialise libev backend. bad $ENV{LIBEV_METHODS}?'; 1209 or die 'EV: cannot initialise libev backend. bad $ENV{LIBEV_FLAGS}?';
726 1210
7271; 12111;
728 1212
729=head1 SEE ALSO 1213=head1 SEE ALSO
730 1214
731L<EV::DNS>. 1215L<EV::MakeMaker> - MakeMaker interface to XS API, L<EV::ADNS>
1216(asynchronous DNS), L<Glib::EV> (makes Glib/Gtk2 use EV as event
1217loop), L<EV::Glib> (embed Glib into EV), L<Coro::EV> (efficient thread
1218integration), L<Net::SNMP::EV> (asynchronous SNMP), L<AnyEvent> for
1219event-loop agnostic and portable event driven programming.
732 1220
733=head1 AUTHOR 1221=head1 AUTHOR
734 1222
735 Marc Lehmann <schmorp@schmorp.de> 1223 Marc Lehmann <schmorp@schmorp.de>
736 http://home.schmorp.de/ 1224 http://home.schmorp.de/
737 1225
738=cut 1226=cut
739 1227

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines