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

Comparing EV/EV.pm (file contents):
Revision 1.56 by root, Tue Nov 27 10:59:10 2007 UTC vs.
Revision 1.134 by root, Tue Jan 11 13:45:28 2011 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::loop; # 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::loop EV::LOOP_ONESHOT; # 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::loop EV::LOOP_NONBLOCK; # 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.03';
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 =
83@EV::Idle::ISA = 135@EV::Idle::ISA =
84@EV::Prepare::ISA = 136@EV::Prepare::ISA =
85@EV::Check::ISA = 137@EV::Check::ISA =
86@EV::Embed::ISA = 138@EV::Embed::ISA =
87@EV::Fork::ISA = 139@EV::Fork::ISA =
140@EV::Async::ISA =
88 "EV::Watcher"; 141 "EV::Watcher";
89 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->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
207
90=head1 BASIC INTERFACE 208=head1 BASIC INTERFACE
91 209
92=over 4 210=over 4
93 211
94=item $EV::DIED 212=item $EV::DIED
95 213
96Must 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
97throws an exception (with $@ containing thr error). The default prints an 215throws an exception (with $@ containing the error). The default prints an
98informative message and continues. 216informative message and continues.
99 217
100If this callback throws an exception it will be silently ignored. 218If this callback throws an exception it will be silently ignored.
101 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
102=item $time = EV::time 234=item $time = EV::time
103 235
104Returns the current time in (fractional) seconds since the epoch. 236Returns the current time in (fractional) seconds since the epoch.
105 237
106=item $time = EV::now 238=item $time = EV::now
107 239
240=item $time = $loop->now
241
108Returns the time the last event loop iteration has been started. This 242Returns the time the last event loop iteration has been started. This
109is 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
110usually faster then calling EV::time. 244usually faster then calling EV::time.
111 245
112=item $method = EV::method 246=item EV::now_update
113 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
114Returns an integer describing the backend used by libev (EV::METHOD_SELECT 292Returns an integer describing the backend used by libev (EV::BACKEND_SELECT
115or EV::METHOD_EPOLL). 293or EV::BACKEND_EPOLL).
116 294
117=item EV::loop [$flags] 295=item EV::loop [$flags]
296
297=item $loop->loop ([$flags])
118 298
119Begin checking for events and calling callbacks. It returns when a 299Begin checking for events and calling callbacks. It returns when a
120callback calls EV::unloop. 300callback calls EV::unloop.
121 301
122The $flags argument can be one of the following: 302The $flags argument can be one of the following:
123 303
124 0 as above 304 0 as above
125 EV::LOOP_ONESHOT block at most once (wait, but do not loop) 305 EV::LOOP_ONCE block at most once (wait, but do not loop)
126 EV::LOOP_NONBLOCK do not block at all (fetch/handle events but do not wait) 306 EV::LOOP_NOWAIT do not block at all (fetch/handle events but do not wait)
127 307
128=item EV::unloop [$how] 308=item EV::break [$how]
129 309
310=item $loop->break ([$how])
311
130When called with no arguments or an argument of EV::UNLOOP_ONE, makes the 312When called with no arguments or an argument of EV::BREAK_ONE, makes the
131innermost call to EV::loop return. 313innermost call to EV::loop return.
132 314
133When called with an argument of EV::UNLOOP_ALL, all calls to EV::loop will return as 315When called with an argument of EV::BREAK_ALL, all calls to EV::loop will
134fast as possible. 316return as fast as possible.
317
318When called with an argument of EV::BREAK_CANCEL, any pending break will
319be cancelled.
320
321=item $count = EV::loop_count
322
323=item $count = $loop->loop_count
324
325Return the number of times the event loop has polled for new
326events. Sometimes useful as a generation counter.
135 327
136=item EV::once $fh_or_undef, $events, $timeout, $cb->($revents) 328=item EV::once $fh_or_undef, $events, $timeout, $cb->($revents)
329
330=item $loop->once ($fh_or_undef, $events, $timeout, $cb->($revents))
137 331
138This function rolls together an I/O and a timer watcher for a single 332This function rolls together an I/O and a timer watcher for a single
139one-shot event without the need for managing a watcher object. 333one-shot event without the need for managing a watcher object.
140 334
141If C<$fh_or_undef> is a filehandle or file descriptor, then C<$events> 335If C<$fh_or_undef> is a filehandle or file descriptor, then C<$events>
147If timeout is C<undef> or negative, then there will be no 341If timeout is C<undef> or negative, then there will be no
148timeout. Otherwise a EV::timer with this value will be started. 342timeout. Otherwise a EV::timer with this value will be started.
149 343
150When an error occurs or either the timeout or I/O watcher triggers, then 344When an error occurs or either the timeout or I/O watcher triggers, then
151the callback will be called with the received event set (in general 345the callback will be called with the received event set (in general
152you can expect it to be a combination of C<EV:ERROR>, C<EV::READ>, 346you can expect it to be a combination of C<EV::ERROR>, C<EV::READ>,
153C<EV::WRITE> and C<EV::TIMEOUT>). 347C<EV::WRITE> and C<EV::TIMER>).
154 348
155EV::once doesn't return anything: the watchers stay active till either 349EV::once doesn't return anything: the watchers stay active till either
156of them triggers, then they will be stopped and freed, and the callback 350of them triggers, then they will be stopped and freed, and the callback
157invoked. 351invoked.
158 352
159=back 353=item EV::feed_fd_event $fd, $revents
160 354
355=item $loop->feed_fd_event ($fd, $revents)
356
357Feed an event on a file descriptor into EV. EV will react to this call as
358if the readyness notifications specified by C<$revents> (a combination of
359C<EV::READ> and C<EV::WRITE>) happened on the file descriptor C<$fd>.
360
361=item EV::feed_signal_event $signal
362
363Feed a signal event into the default loop. EV will react to this call as
364if the signal specified by C<$signal> had occured.
365
366=item EV::feed_signal $signal
367
368Feed a signal event into EV - unlike C<EV::feed_signal_event>, this works
369regardless of which loop has registered the signal, and is mainly useful
370fro custom signal implementations.
371
372=item EV::set_io_collect_interval $time
373
374=item $loop->set_io_collect_interval ($time)
375
376=item EV::set_timeout_collect_interval $time
377
378=item $loop->set_timeout_collect_interval ($time)
379
380These advanced functions set the minimum block interval when polling for I/O events and the minimum
381wait interval for timer events. See the libev documentation at
382L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#FUNCTIONS_CONTROLLING_THE_EVENT_LOOP>
383(locally installed as F<EV::libev>) for a more detailed discussion.
384
385=item $count = EV::pending_count
386
387=item $count = $loop->pending_count
388
389Returns the number of currently pending watchers.
390
391=item EV::invoke_pending
392
393=item $loop->invoke_pending
394
395Invoke all currently pending watchers.
396
397=back
398
399
161=head2 WATCHER OBJECTS 400=head1 WATCHER OBJECTS
162 401
163A watcher is an object that gets created to record your interest in some 402A watcher is an object that gets created to record your interest in some
164event. For instance, if you want to wait for STDIN to become readable, you 403event. For instance, if you want to wait for STDIN to become readable, you
165would create an EV::io watcher for that: 404would create an EV::io watcher for that:
166 405
167 my $watcher = EV::io *STDIN, EV::READ, sub { 406 my $watcher = EV::io *STDIN, EV::READ, sub {
168 my ($watcher, $revents) = @_; 407 my ($watcher, $revents) = @_;
169 warn "yeah, STDIN should not be readable without blocking!\n" 408 warn "yeah, STDIN should now be readable without blocking!\n"
170 }; 409 };
171 410
172All watchers can be active (waiting for events) or inactive (paused). Only 411All watchers can be active (waiting for events) or inactive (paused). Only
173active watchers will have their callbacks invoked. All callbacks will be 412active watchers will have their callbacks invoked. All callbacks will be
174called with at least two arguments: the watcher and a bitmask of received 413called with at least two arguments: the watcher and a bitmask of received
175events. 414events.
176 415
177Each watcher type has its associated bit in revents, so you can use the 416Each watcher type has its associated bit in revents, so you can use the
178same callback for multiple watchers. The event mask is named after the 417same callback for multiple watchers. The event mask is named after the
179type, i..e. EV::child sets EV::CHILD, EV::prepare sets EV::PREPARE, 418type, i.e. EV::child sets EV::CHILD, EV::prepare sets EV::PREPARE,
180EV::periodic sets EV::PERIODIC and so on, with the exception of IO events 419EV::periodic sets EV::PERIODIC and so on, with the exception of I/O events
181(which can set both EV::READ and EV::WRITE bits), and EV::timer (which 420(which can set both EV::READ and EV::WRITE bits).
182uses EV::TIMEOUT).
183 421
184In the rare case where one wants to create a watcher but not start it at 422In the rare case where one wants to create a watcher but not start it at
185the same time, each constructor has a variant with a trailing C<_ns> in 423the same time, each constructor has a variant with a trailing C<_ns> in
186its name, e.g. EV::io has a non-starting variant EV::io_ns and so on. 424its name, e.g. EV::io has a non-starting variant EV::io_ns and so on.
187 425
207 445
208=item $w->stop 446=item $w->stop
209 447
210Stop a watcher if it is active. Also clear any pending events (events that 448Stop a watcher if it is active. Also clear any pending events (events that
211have been received but that didn't yet result in a callback invocation), 449have been received but that didn't yet result in a callback invocation),
212regardless of wether the watcher was active or not. 450regardless of whether the watcher was active or not.
213 451
214=item $bool = $w->is_active 452=item $bool = $w->is_active
215 453
216Returns true if the watcher is active, false otherwise. 454Returns true if the watcher is active, false otherwise.
217 455
247The default priority of any newly-created watcher is 0. 485The default priority of any newly-created watcher is 0.
248 486
249Note that the priority semantics have not yet been fleshed out and are 487Note that the priority semantics have not yet been fleshed out and are
250subject to almost certain change. 488subject to almost certain change.
251 489
252=item $w->trigger ($revents) 490=item $w->invoke ($revents)
253 491
254Call the callback *now* with the given event mask. 492Call the callback *now* with the given event mask.
493
494=item $w->feed_event ($revents)
495
496Feed some events on this watcher into EV. EV will react to this call as if
497the watcher had received the given C<$revents> mask.
498
499=item $revents = $w->clear_pending
500
501If the watcher is pending, this function clears its pending status and
502returns its C<$revents> bitset (as if its callback was invoked). If the
503watcher isn't pending it does nothing and returns C<0>.
255 504
256=item $previous_state = $w->keepalive ($bool) 505=item $previous_state = $w->keepalive ($bool)
257 506
258Normally, C<EV::loop> will return when there are no active watchers 507Normally, C<EV::loop> will return when there are no active watchers
259(which is a "deadlock" because no progress can be made anymore). This is 508(which is a "deadlock" because no progress can be made anymore). This is
260convinient because it allows you to start your watchers (and your jobs), 509convenient because it allows you to start your watchers (and your jobs),
261call C<EV::loop> once and when it returns you know that all your jobs are 510call C<EV::loop> once and when it returns you know that all your jobs are
262finished (or they forgot to register some watchers for their task :). 511finished (or they forgot to register some watchers for their task :).
263 512
264Sometimes, however, this gets in your way, for example when you the module 513Sometimes, however, this gets in your way, for example when the module
265that calls C<EV::loop> (usually the main program) is not the same module 514that calls C<EV::loop> (usually the main program) is not the same module
266as a long-living watcher (for example a DNS client module written by 515as a long-living watcher (for example a DNS client module written by
267somebody else even). Then you might want any outstanding requests to be 516somebody else even). Then you might want any outstanding requests to be
268handled, but you would not want to keep C<EV::loop> from returning just 517handled, but you would not want to keep C<EV::loop> from returning just
269because you happen to have this long-running UDP port watcher. 518because you happen to have this long-running UDP port watcher.
270 519
271In this case you can clear the keepalive status, which means that even 520In this case you can clear the keepalive status, which means that even
272though your watcher is active, it won't keep C<EV::loop> from returning. 521though your watcher is active, it won't keep C<EV::loop> from returning.
273 522
274The initial value for keepalive is true (enabled), and you cna change it 523The initial value for keepalive is true (enabled), and you can change it
275any time. 524any time.
276 525
277Example: Register an IO watcher for some UDP socket but do not keep the 526Example: Register an I/O watcher for some UDP socket but do not keep the
278event loop from running just because of that watcher. 527event loop from running just because of that watcher.
279 528
280 my $udp_socket = ... 529 my $udp_socket = ...
281 my $udp_watcher = EV::io $udp_socket, EV::READ, sub { ... }; 530 my $udp_watcher = EV::io $udp_socket, EV::READ, sub { ... };
282 $udp_watcher->keepalive (0); 531 $udp_watcher->keepalive (0);
283 532
284=back 533=item $loop = $w->loop
285 534
535Return the loop that this watcher is attached to.
286 536
537=back
538
539
287=head2 WATCHER TYPES 540=head1 WATCHER TYPES
288 541
289Each of the following subsections describes a single watcher type. 542Each of the following subsections describes a single watcher type.
290 543
291=head3 IO WATCHERS - is this file descriptor readable or writable? 544=head3 I/O WATCHERS - is this file descriptor readable or writable?
292 545
293=over 4 546=over 4
294 547
295=item $w = EV::io $fileno_or_fh, $eventmask, $callback 548=item $w = EV::io $fileno_or_fh, $eventmask, $callback
296 549
297=item $w = EV::io_ns $fileno_or_fh, $eventmask, $callback 550=item $w = EV::io_ns $fileno_or_fh, $eventmask, $callback
551
552=item $w = $loop->io ($fileno_or_fh, $eventmask, $callback)
553
554=item $w = $loop->io_ns ($fileno_or_fh, $eventmask, $callback)
298 555
299As long as the returned watcher object is alive, call the C<$callback> 556As long as the returned watcher object is alive, call the C<$callback>
300when at least one of events specified in C<$eventmask> occurs. 557when at least one of events specified in C<$eventmask> occurs.
301 558
302The $eventmask can be one or more of these constants ORed together: 559The $eventmask can be one or more of these constants ORed together:
331=over 4 588=over 4
332 589
333=item $w = EV::timer $after, $repeat, $callback 590=item $w = EV::timer $after, $repeat, $callback
334 591
335=item $w = EV::timer_ns $after, $repeat, $callback 592=item $w = EV::timer_ns $after, $repeat, $callback
593
594=item $w = $loop->timer ($after, $repeat, $callback)
595
596=item $w = $loop->timer_ns ($after, $repeat, $callback)
336 597
337Calls the callback after C<$after> seconds (which may be fractional). If 598Calls the callback after C<$after> seconds (which may be fractional). If
338C<$repeat> is non-zero, the timer will be restarted (with the $repeat 599C<$repeat> is non-zero, the timer will be restarted (with the $repeat
339value as $after) after the callback returns. 600value as $after) after the callback returns.
340 601
381=over 4 642=over 4
382 643
383=item $w = EV::periodic $at, $interval, $reschedule_cb, $callback 644=item $w = EV::periodic $at, $interval, $reschedule_cb, $callback
384 645
385=item $w = EV::periodic_ns $at, $interval, $reschedule_cb, $callback 646=item $w = EV::periodic_ns $at, $interval, $reschedule_cb, $callback
647
648=item $w = $loop->periodic ($at, $interval, $reschedule_cb, $callback)
649
650=item $w = $loop->periodic_ns ($at, $interval, $reschedule_cb, $callback)
386 651
387Similar to EV::timer, but is not based on relative timeouts but on 652Similar to EV::timer, but is not based on relative timeouts but on
388absolute times. Apart from creating "simple" timers that trigger "at" the 653absolute times. Apart from creating "simple" timers that trigger "at" the
389specified time, it can also be used for non-drifting absolute timers and 654specified time, it can also be used for non-drifting absolute timers and
390more complex, cron-like, setups that are not adversely affected by time 655more complex, cron-like, setups that are not adversely affected by time
400This time simply fires at the wallclock time C<$at> and doesn't repeat. It 665This time simply fires at the wallclock time C<$at> and doesn't repeat. It
401will not adjust when a time jump occurs, that is, if it is to be run 666will not adjust when a time jump occurs, that is, if it is to be run
402at January 1st 2011 then it will run when the system time reaches or 667at January 1st 2011 then it will run when the system time reaches or
403surpasses this time. 668surpasses this time.
404 669
405=item * non-repeating interval timer ($interval > 0, $reschedule_cb = 0) 670=item * repeating interval timer ($interval > 0, $reschedule_cb = 0)
406 671
407In this mode the watcher will always be scheduled to time out at the 672In this mode the watcher will always be scheduled to time out at the
408next C<$at + N * $interval> time (for some integer N) and then repeat, 673next C<$at + N * $interval> time (for some integer N) and then repeat,
409regardless of any time jumps. 674regardless of any time jumps.
410 675
428time the periodic watcher gets scheduled, the reschedule callback 693time the periodic watcher gets scheduled, the reschedule callback
429($reschedule_cb) will be called with the watcher as first, and the current 694($reschedule_cb) will be called with the watcher as first, and the current
430time as second argument. 695time as second argument.
431 696
432I<This callback MUST NOT stop or destroy this or any other periodic 697I<This callback MUST NOT stop or destroy this or any other periodic
433watcher, ever>. If you need to stop it, return 1e30 and stop it 698watcher, ever, and MUST NOT call any event loop functions or methods>. If
434afterwards. 699you need to stop it, return 1e30 and stop it afterwards. You may create
700and start a C<EV::prepare> watcher for this task.
435 701
436It must return the next time to trigger, based on the passed time value 702It must return the next time to trigger, based on the passed time value
437(that is, the lowest time value larger than to the second argument). It 703(that is, the lowest time value larger than or equal to to the second
438will usually be called just before the callback will be triggered, but 704argument). It will usually be called just before the callback will be
439might be called at other times, too. 705triggered, but might be called at other times, too.
440 706
441This can be used to create very complex timers, such as a timer that 707This can be used to create very complex timers, such as a timer that
442triggers on each midnight, local time (actually 24 hours after the last 708triggers on each midnight, local time (actually 24 hours after the last
443midnight, to keep the example simple. If you know a way to do it correctly 709midnight, to keep the example simple. If you know a way to do it correctly
444in about the same space (without requiring elaborate modules), drop me a 710in about the same space (without requiring elaborate modules), drop me a
465 731
466=item $w->again 732=item $w->again
467 733
468Simply stops and starts the watcher again. 734Simply stops and starts the watcher again.
469 735
736=item $time = $w->at
737
738Return the time that the watcher is expected to trigger next.
739
470=back 740=back
471 741
472 742
473=head3 SIGNAL WATCHERS - signal me when a signal gets signalled! 743=head3 SIGNAL WATCHERS - signal me when a signal gets signalled!
474 744
475=over 4 745=over 4
476 746
477=item $w = EV::signal $signal, $callback 747=item $w = EV::signal $signal, $callback
478 748
479=item $w = EV::signal_ns $signal, $callback 749=item $w = EV::signal_ns $signal, $callback
750
751=item $w = $loop->signal ($signal, $callback)
752
753=item $w = $loop->signal_ns ($signal, $callback)
480 754
481Call the callback when $signal is received (the signal can be specified by 755Call the callback when $signal is received (the signal can be specified by
482number or by name, just as with C<kill> or C<%SIG>). 756number or by name, just as with C<kill> or C<%SIG>).
757
758Only one event loop can grab a given signal - attempting to grab the same
759signal from two EV loops will crash the program immediately or cause data
760corruption.
483 761
484EV will grab the signal for the process (the kernel only allows one 762EV will grab the signal for the process (the kernel only allows one
485component to receive a signal at a time) when you start a signal watcher, 763component to receive a signal at a time) when you start a signal watcher,
486and removes it again when you stop it. Perl does the same when you 764and removes it again when you stop it. Perl does the same when you
487add/remove callbacks to C<%SIG>, so watch out. 765add/remove callbacks to C<%SIG>, so watch out.
507 785
508=head3 CHILD WATCHERS - watch out for process status changes 786=head3 CHILD WATCHERS - watch out for process status changes
509 787
510=over 4 788=over 4
511 789
512=item $w = EV::child $pid, $callback 790=item $w = EV::child $pid, $trace, $callback
513 791
514=item $w = EV::child_ns $pid, $callback 792=item $w = EV::child_ns $pid, $trace, $callback
515 793
794=item $w = $loop->child ($pid, $trace, $callback)
795
796=item $w = $loop->child_ns ($pid, $trace, $callback)
797
516Call the callback when a status change for pid C<$pid> (or any pid if 798Call the callback when a status change for pid C<$pid> (or any pid
517C<$pid> is 0) has been received. More precisely: when the process receives 799if C<$pid> is 0) has been received (a status change happens when the
800process terminates or is killed, or, when trace is true, additionally when
801it is stopped or continued). More precisely: when the process receives
518a C<SIGCHLD>, EV will fetch the outstanding exit/wait status for all 802a C<SIGCHLD>, EV will fetch the outstanding exit/wait status for all
519changed/zombie children and call the callback. 803changed/zombie children and call the callback.
520 804
521It is valid (and fully supported) to install a child watcher after a child 805It is valid (and fully supported) to install a child watcher after a child
522has exited but before the event loop has started its next iteration (for 806has exited but before the event loop has started its next iteration (for
529You can have as many pid watchers per pid as you want, they will all be 813You can have as many pid watchers per pid as you want, they will all be
530called. 814called.
531 815
532The C<child_ns> variant doesn't start (activate) the newly created watcher. 816The C<child_ns> variant doesn't start (activate) the newly created watcher.
533 817
534=item $w->set ($pid) 818=item $w->set ($pid, $trace)
535 819
536Reconfigures the watcher, see the constructor above for details. Can be called at 820Reconfigures the watcher, see the constructor above for details. Can be called at
537any time. 821any time.
538 822
539=item $current_pid = $w->pid 823=item $current_pid = $w->pid
540 824
541=item $old_pid = $w->pid ($new_pid)
542
543Returns the previously set process id and optionally set a new one. 825Returns the previously set process id and optionally set a new one.
544 826
545=item $exit_status = $w->rstatus 827=item $exit_status = $w->rstatus
546 828
547Return the exit/wait status (as returned by waitpid, see the waitpid entry 829Return the exit/wait status (as returned by waitpid, see the waitpid entry
560=over 4 842=over 4
561 843
562=item $w = EV::stat $path, $interval, $callback 844=item $w = EV::stat $path, $interval, $callback
563 845
564=item $w = EV::stat_ns $path, $interval, $callback 846=item $w = EV::stat_ns $path, $interval, $callback
847
848=item $w = $loop->stat ($path, $interval, $callback)
849
850=item $w = $loop->stat_ns ($path, $interval, $callback)
565 851
566Call the callback when a file status change has been detected on 852Call the callback when a file status change has been detected on
567C<$path>. The C<$path> does not need to exist, changing from "path exists" 853C<$path>. The C<$path> does not need to exist, changing from "path exists"
568to "path does not exist" is a status change like any other. 854to "path does not exist" is a status change like any other.
569 855
576as even with OS-supported change notifications, this can be 862as even with OS-supported change notifications, this can be
577resource-intensive. 863resource-intensive.
578 864
579The C<stat_ns> variant doesn't start (activate) the newly created watcher. 865The C<stat_ns> variant doesn't start (activate) the newly created watcher.
580 866
867=item ... = $w->stat
868
869This call is very similar to the perl C<stat> built-in: It stats (using
870C<lstat>) the path specified in the watcher and sets perls stat cache (as
871well as EV's idea of the current stat values) to the values found.
872
873In scalar context, a boolean is return indicating success or failure of
874the stat. In list context, the same 13-value list as with stat is returned
875(except that the blksize and blocks fields are not reliable).
876
877In the case of an error, errno is set to C<ENOENT> (regardless of the
878actual error value) and the C<nlink> value is forced to zero (if the stat
879was successful then nlink is guaranteed to be non-zero).
880
881See also the next two entries for more info.
882
883=item ... = $w->attr
884
885Just like C<< $w->stat >>, but without the initial stat'ing: this returns
886the values most recently detected by EV. See the next entry for more info.
887
888=item ... = $w->prev
889
890Just like C<< $w->stat >>, but without the initial stat'ing: this returns
891the previous set of values, before the change.
892
893That is, when the watcher callback is invoked, C<< $w->prev >> will be set
894to the values found I<before> a change was detected, while C<< $w->attr >>
895returns the values found leading to the change detection. The difference (if any)
896between C<prev> and C<attr> is what triggered the callback.
897
898If you did something to the filesystem object and do not want to trigger
899yet another change, you can call C<stat> to update EV's idea of what the
900current attributes are.
901
581=item $w->set ($path, $interval) 902=item $w->set ($path, $interval)
582 903
583Reconfigures the watcher, see the constructor above for details. Can be 904Reconfigures the watcher, see the constructor above for details. Can be
584called at any time. 905called at any time.
585 906
605 926
606=item $w = EV::idle $callback 927=item $w = EV::idle $callback
607 928
608=item $w = EV::idle_ns $callback 929=item $w = EV::idle_ns $callback
609 930
610Call the callback when there are no pending io, timer/periodic, signal or 931=item $w = $loop->idle ($callback)
611child events, i.e. when the process is idle. 932
933=item $w = $loop->idle_ns ($callback)
934
935Call the callback when there are no other pending watchers of the same or
936higher priority (excluding check, prepare and other idle watchers of the
937same or lower priority, of course). They are called idle watchers because
938when the watcher is the highest priority pending event in the process, the
939process is considered to be idle at that priority.
940
941If you want a watcher that is only ever called when I<no> other events are
942outstanding you have to set the priority to C<EV::MINPRI>.
612 943
613The process will not block as long as any idle watchers are active, and 944The process will not block as long as any idle watchers are active, and
614they will be called repeatedly until stopped. 945they will be called repeatedly until stopped.
615 946
947For example, if you have idle watchers at priority C<0> and C<1>, and
948an I/O watcher at priority C<0>, then the idle watcher at priority C<1>
949and the I/O watcher will always run when ready. Only when the idle watcher
950at priority C<1> is stopped and the I/O watcher at priority C<0> is not
951pending with the C<0>-priority idle watcher be invoked.
952
616The C<idle_ns> variant doesn't start (activate) the newly created watcher. 953The C<idle_ns> variant doesn't start (activate) the newly created watcher.
617 954
618=back 955=back
619 956
620 957
623=over 4 960=over 4
624 961
625=item $w = EV::prepare $callback 962=item $w = EV::prepare $callback
626 963
627=item $w = EV::prepare_ns $callback 964=item $w = EV::prepare_ns $callback
965
966=item $w = $loop->prepare ($callback)
967
968=item $w = $loop->prepare_ns ($callback)
628 969
629Call the callback just before the process would block. You can still 970Call the callback just before the process would block. You can still
630create/modify any watchers at this point. 971create/modify any watchers at this point.
631 972
632See the EV::check watcher, below, for explanations and an example. 973See the EV::check watcher, below, for explanations and an example.
642 983
643=item $w = EV::check $callback 984=item $w = EV::check $callback
644 985
645=item $w = EV::check_ns $callback 986=item $w = EV::check_ns $callback
646 987
988=item $w = $loop->check ($callback)
989
990=item $w = $loop->check_ns ($callback)
991
647Call the callback just after the process wakes up again (after it has 992Call the callback just after the process wakes up again (after it has
648gathered events), but before any other callbacks have been invoked. 993gathered events), but before any other callbacks have been invoked.
649 994
650This is used to integrate other event-based software into the EV 995This can be used to integrate other event-based software into the EV
651mainloop: You register a prepare callback and in there, you create io and 996mainloop: You register a prepare callback and in there, you create io and
652timer watchers as required by the other software. Here is a real-world 997timer watchers as required by the other software. Here is a real-world
653example of integrating Net::SNMP (with some details left out): 998example of integrating Net::SNMP (with some details left out):
654 999
655 our @snmp_watcher; 1000 our @snmp_watcher;
660 or return; 1005 or return;
661 1006
662 # make the dispatcher handle any outstanding stuff 1007 # make the dispatcher handle any outstanding stuff
663 ... not shown 1008 ... not shown
664 1009
665 # create an IO watcher for each and every socket 1010 # create an I/O watcher for each and every socket
666 @snmp_watcher = ( 1011 @snmp_watcher = (
667 (map { EV::io $_, EV::READ, sub { } } 1012 (map { EV::io $_, EV::READ, sub { } }
668 keys %{ $dispatcher->{_descriptors} }), 1013 keys %{ $dispatcher->{_descriptors} }),
669 1014
670 EV::timer +($event->[Net::SNMP::Dispatcher::_ACTIVE] 1015 EV::timer +($event->[Net::SNMP::Dispatcher::_ACTIVE]
685 # make the dispatcher handle any new stuff 1030 # make the dispatcher handle any new stuff
686 ... not shown 1031 ... not shown
687 }; 1032 };
688 1033
689The callbacks of the created watchers will not be called as the watchers 1034The callbacks of the created watchers will not be called as the watchers
690are destroyed before this cna happen (remember EV::check gets called 1035are destroyed before this can happen (remember EV::check gets called
691first). 1036first).
692 1037
693The C<check_ns> variant doesn't start (activate) the newly created watcher. 1038The C<check_ns> variant doesn't start (activate) the newly created watcher.
1039
1040=item EV::CHECK constant issues
1041
1042Like all other watcher types, there is a bitmask constant for use in
1043C<$revents> and other places. The C<EV::CHECK> is special as it has
1044the same name as the C<CHECK> sub called by Perl. This doesn't cause
1045big issues on newer perls (beginning with 5.8.9), but it means thatthe
1046constant must be I<inlined>, i.e. runtime calls will not work. That means
1047that as long as you always C<use EV> and then C<EV::CHECK> you are on the
1048safe side.
694 1049
695=back 1050=back
696 1051
697 1052
698=head3 FORK WATCHERS - the audacity to resume the event loop after a fork 1053=head3 FORK WATCHERS - the audacity to resume the event loop after a fork
705 1060
706=item $w = EV::fork $callback 1061=item $w = EV::fork $callback
707 1062
708=item $w = EV::fork_ns $callback 1063=item $w = EV::fork_ns $callback
709 1064
1065=item $w = $loop->fork ($callback)
1066
1067=item $w = $loop->fork_ns ($callback)
1068
710Call the callback before the event loop is resumed in the child process 1069Call the callback before the event loop is resumed in the child process
711after a fork. 1070after a fork.
712 1071
713The C<fork_ns> variant doesn't start (activate) the newly created watcher. 1072The C<fork_ns> variant doesn't start (activate) the newly created watcher.
714 1073
715=back 1074=back
716 1075
717 1076
1077=head3 EMBED WATCHERS - when one backend isn't enough...
1078
1079This is a rather advanced watcher type that lets you embed one event loop
1080into another (currently only IO events are supported in the embedded
1081loop, other types of watchers might be handled in a delayed or incorrect
1082fashion and must not be used).
1083
1084See the libev documentation at
1085L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#code_ev_embed_code_when_one_backend_>
1086(locally installed as F<EV::libev>) for more details.
1087
1088In short, this watcher is most useful on BSD systems without working
1089kqueue to still be able to handle a large number of sockets:
1090
1091 my $socket_loop;
1092
1093 # check wether we use SELECT or POLL _and_ KQUEUE is supported
1094 if (
1095 (EV::backend & (EV::BACKEND_POLL | EV::BACKEND_SELECT))
1096 && (EV::supported_backends & EV::embeddable_backends & EV::BACKEND_KQUEUE)
1097 ) {
1098 # use kqueue for sockets
1099 $socket_loop = new EV::Loop EV::BACKEND_KQUEUE | EV::FLAG_NOENV;
1100 }
1101
1102 # use the default loop otherwise
1103 $socket_loop ||= EV::default_loop;
1104
1105=over 4
1106
1107=item $w = EV::embed $otherloop[, $callback]
1108
1109=item $w = EV::embed_ns $otherloop[, $callback]
1110
1111=item $w = $loop->embed ($otherloop[, $callback])
1112
1113=item $w = $loop->embed_ns ($otherloop[, $callback])
1114
1115Call the callback when the embedded event loop (C<$otherloop>) has any
1116I/O activity. The C<$callback> is optional: if it is missing, then the
1117embedded event loop will be managed automatically (which is recommended),
1118otherwise you have to invoke C<sweep> yourself.
1119
1120The C<embed_ns> variant doesn't start (activate) the newly created watcher.
1121
1122=back
1123
1124=head3 ASYNC WATCHERS - how to wake up another event loop
1125
1126Async watchers are provided by EV, but have little use in perl directly,
1127as perl neither supports threads running in parallel nor direct access to
1128signal handlers or other contexts where they could be of value.
1129
1130It is, however, possible to use them from the XS level.
1131
1132Please see the libev documentation for further details.
1133
1134=over 4
1135
1136=item $w = EV::async $callback
1137
1138=item $w = EV::async_ns $callback
1139
1140=item $w->send
1141
1142=item $bool = $w->async_pending
1143
1144=back
1145
1146
1147=head1 PERL SIGNALS
1148
1149While Perl signal handling (C<%SIG>) is not affected by EV, the behaviour
1150with EV is as the same as any other C library: Perl-signals will only be
1151handled when Perl runs, which means your signal handler might be invoked
1152only the next time an event callback is invoked.
1153
1154The solution is to use EV signal watchers (see C<EV::signal>), which will
1155ensure proper operations with regards to other event watchers.
1156
1157If you cannot do this for whatever reason, you can also force a watcher
1158to be called on every event loop iteration by installing a C<EV::check>
1159watcher:
1160
1161 my $async_check = EV::check sub { };
1162
1163This ensures that perl gets into control for a short time to handle any
1164pending signals, and also ensures (slightly) slower overall operation.
1165
718=head1 THREADS 1166=head1 ITHREADS
719 1167
720Threads are not supported by this module in any way. Perl pseudo-threads 1168Ithreads are not supported by this module in any way. Perl pseudo-threads
721is evil stuff and must die. As soon as Perl gains real threads I will work 1169is evil stuff and must die. Real threads as provided by Coro are fully
722on thread support for it. 1170supported (and enhanced support is available via L<Coro::EV>).
723 1171
724=head1 FORK 1172=head1 FORK
725 1173
726Most of the "improved" event delivering mechanisms of modern operating 1174Most of the "improved" event delivering mechanisms of modern operating
727systems have quite a few problems with fork(2) (to put it bluntly: it is 1175systems have quite a few problems with fork(2) (to put it bluntly: it is
743our $DIED = sub { 1191our $DIED = sub {
744 warn "EV: error in callback (ignoring): $@"; 1192 warn "EV: error in callback (ignoring): $@";
745}; 1193};
746 1194
747default_loop 1195default_loop
748 or die 'EV: cannot initialise libev backend. bad $ENV{LIBEV_METHODS}?'; 1196 or die 'EV: cannot initialise libev backend. bad $ENV{LIBEV_FLAGS}?';
749 1197
7501; 11981;
751 1199
752=head1 SEE ALSO 1200=head1 SEE ALSO
753 1201
754L<EV::DNS>. 1202L<EV::MakeMaker> - MakeMaker interface to XS API, L<EV::ADNS>
1203(asynchronous DNS), L<Glib::EV> (makes Glib/Gtk2 use EV as event
1204loop), L<EV::Glib> (embed Glib into EV), L<Coro::EV> (efficient thread
1205integration), L<Net::SNMP::EV> (asynchronous SNMP), L<AnyEvent> for
1206event-loop agnostic and portable event driven programming.
755 1207
756=head1 AUTHOR 1208=head1 AUTHOR
757 1209
758 Marc Lehmann <schmorp@schmorp.de> 1210 Marc Lehmann <schmorp@schmorp.de>
759 http://home.schmorp.de/ 1211 http://home.schmorp.de/
760 1212
761=cut 1213=cut
762 1214

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines