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

Comparing EV/EV.pm (file contents):
Revision 1.70 by root, Fri Dec 14 19:33:32 2007 UTC vs.
Revision 1.125 by root, Thu Dec 31 06:59:47 2009 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 55
56=head1 DESCRIPTION 56=head1 DESCRIPTION
57 57
58This module provides an interface to libev 58This module provides an interface to libev
59(L<http://software.schmorp.de/pkg/libev.html>). While the documentation 59(L<http://software.schmorp.de/pkg/libev.html>). While the documentation
60below is comprehensive, one might also consult the documentation of libev 60below is comprehensive, one might also consult the documentation of
61itself (L<http://cvs.schmorp.de/libev/ev.html>) for more subtle details on 61libev 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 62F<perldoc EV::libev>) for more subtle details on watcher semantics or some
63force a specific backend with C<LIBEV_FLAGS>, or just about in any case 63discussion on the available backends, or how to force a specific backend
64because it has much more detailed information. 64with C<LIBEV_FLAGS>, or just about in any case because it has much more
65detailed information.
66
67This module is very fast and scalable. It is actually so fast that you
68can use it through the L<AnyEvent> module, stay portable to other event
69loops (if you don't rely on any watcher types not available through it)
70and still be faster than with any other event loop currently supported in
71Perl.
72
73=head2 MODULE EXPORTS
74
75This module does not export any symbols.
65 76
66=cut 77=cut
67 78
68package EV; 79package EV;
69 80
70use strict; 81use common::sense;
71 82
72BEGIN { 83BEGIN {
73 our $VERSION = '1.85'; 84 our $VERSION = '3.9';
74 use XSLoader; 85 use XSLoader;
75 XSLoader::load "EV", $VERSION; 86 XSLoader::load "EV", $VERSION;
76} 87}
77 88
78@EV::IO::ISA = 89@EV::IO::ISA =
… …
84@EV::Idle::ISA = 95@EV::Idle::ISA =
85@EV::Prepare::ISA = 96@EV::Prepare::ISA =
86@EV::Check::ISA = 97@EV::Check::ISA =
87@EV::Embed::ISA = 98@EV::Embed::ISA =
88@EV::Fork::ISA = 99@EV::Fork::ISA =
100@EV::Async::ISA =
89 "EV::Watcher"; 101 "EV::Watcher";
102
103@EV::Loop::Default::ISA = "EV::Loop";
104
105=head1 EVENT LOOPS
106
107EV supports multiple event loops: There is a single "default event loop"
108that can handle everything including signals and child watchers, and any
109number of "dynamic event loops" that can use different backends (with
110various limitations), but no child and signal watchers.
111
112You do not have to do anything to create the default event loop: When
113the module is loaded a suitable backend is selected on the premise of
114selecting a working backend (which for example rules out kqueue on most
115BSDs). Modules should, unless they have "special needs" always use the
116default loop as this is fastest (perl-wise), best supported by other
117modules (e.g. AnyEvent or Coro) and most portable event loop.
118
119For specific programs you can create additional event loops dynamically.
120
121If you want to take advantage of kqueue (which often works properly for
122sockets only) even though the default loop doesn't enable it, you can
123I<embed> a kqueue loop into the default loop: running the default loop
124will then also service the kqueue loop to some extent. See the example in
125the section about embed watchers for an example on how to achieve that.
126
127=over 4
128
129=item $loop = new EV::Loop [$flags]
130
131Create a new event loop as per the specified flags. Please refer to
132the C<ev_loop_new ()> function description in the libev documentation
133(L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#GLOBAL_FUNCTIONS>,
134or locally-installed as F<EV::libev> manpage) for more info.
135
136The loop will automatically be destroyed when it is no longer referenced
137by any watcher and the loop object goes out of scope.
138
139If you are not embedding the loop, then Using C<EV::FLAG_FORKCHECK>
140is recommended, as only the default event loop is protected by this
141module. If you I<are> embedding this loop in the default loop, this is not
142necessary, as C<EV::embed> automatically does the right thing on fork.
143
144=item $loop->loop_fork
145
146Must be called after a fork in the child, before entering or continuing
147the event loop. An alternative is to use C<EV::FLAG_FORKCHECK> which calls
148this function automatically, at some performance loss (refer to the libev
149documentation).
150
151=item $loop->loop_verify
152
153Calls C<ev_verify> to make internal consistency checks (for debugging
154libev) and abort the program if any data structures were found to be
155corrupted.
156
157=item $loop = EV::default_loop [$flags]
158
159Return the default loop (which is a singleton object). Since this module
160already creates the default loop with default flags, specifying flags here
161will not have any effect unless you destroy the default loop first, which
162isn't supported. So in short: don't do it, and if you break it, you get to
163keep the pieces.
164
165=back
166
90 167
91=head1 BASIC INTERFACE 168=head1 BASIC INTERFACE
92 169
93=over 4 170=over 4
94 171
… …
98throws an exception (with $@ containing the error). The default prints an 175throws an exception (with $@ containing the error). The default prints an
99informative message and continues. 176informative message and continues.
100 177
101If this callback throws an exception it will be silently ignored. 178If this callback throws an exception it will be silently ignored.
102 179
180=item $flags = EV::supported_backends
181
182=item $flags = EV::recommended_backends
183
184=item $flags = EV::embeddable_backends
185
186Returns the set (see C<EV::BACKEND_*> flags) of backends supported by this
187instance of EV, the set of recommended backends (supposed to be good) for
188this platform and the set of embeddable backends (see EMBED WATCHERS).
189
190=item EV::sleep $seconds
191
192Block the process for the given number of (fractional) seconds.
193
103=item $time = EV::time 194=item $time = EV::time
104 195
105Returns the current time in (fractional) seconds since the epoch. 196Returns the current time in (fractional) seconds since the epoch.
106 197
107=item $time = EV::now 198=item $time = EV::now
108 199
200=item $time = $loop->now
201
109Returns the time the last event loop iteration has been started. This 202Returns the time the last event loop iteration has been started. This
110is the time that (relative) timers are based on, and refering to it is 203is the time that (relative) timers are based on, and referring to it is
111usually faster then calling EV::time. 204usually faster then calling EV::time.
112 205
113=item $method = EV::method 206=item EV::now_update
114 207
208=item $loop->now_update
209
210Establishes the current time by querying the kernel, updating the time
211returned by C<EV::now> in the progress. This is a costly operation and
212is usually done automatically within C<EV::loop>.
213
214This function is rarely useful, but when some event callback runs for a
215very long time without entering the event loop, updating libev's idea of
216the current time is a good idea.
217
218=item EV::suspend
219
220=item $loop->suspend
221
222=item EV::resume
223
224=item $loop->resume
225
226These two functions suspend and resume a loop, for use when the loop is
227not used for a while and timeouts should not be processed.
228
229A typical use case would be an interactive program such as a game: When
230the user presses C<^Z> to suspend the game and resumes it an hour later it
231would be best to handle timeouts as if no time had actually passed while
232the program was suspended. This can be achieved by calling C<suspend>
233in your C<SIGTSTP> handler, sending yourself a C<SIGSTOP> and calling
234C<resume> directly afterwards to resume timer processing.
235
236Effectively, all C<timer> watchers will be delayed by the time spend
237between C<suspend> and C<resume>, and all C<periodic> watchers
238will be rescheduled (that is, they will lose any events that would have
239occured while suspended).
240
241After calling C<suspend> you B<must not> call I<any> function on the given
242loop other than C<resume>, and you B<must not> call C<resume>
243without a previous call to C<suspend>.
244
245Calling C<suspend>/C<resume> has the side effect of updating the event
246loop time (see C<now_update>).
247
248=item $backend = EV::backend
249
250=item $backend = $loop->backend
251
115Returns an integer describing the backend used by libev (EV::METHOD_SELECT 252Returns an integer describing the backend used by libev (EV::BACKEND_SELECT
116or EV::METHOD_EPOLL). 253or EV::BACKEND_EPOLL).
117 254
118=item EV::loop [$flags] 255=item EV::loop [$flags]
256
257=item $loop->loop ([$flags])
119 258
120Begin checking for events and calling callbacks. It returns when a 259Begin checking for events and calling callbacks. It returns when a
121callback calls EV::unloop. 260callback calls EV::unloop.
122 261
123The $flags argument can be one of the following: 262The $flags argument can be one of the following:
… …
126 EV::LOOP_ONESHOT block at most once (wait, but do not loop) 265 EV::LOOP_ONESHOT block at most once (wait, but do not loop)
127 EV::LOOP_NONBLOCK do not block at all (fetch/handle events but do not wait) 266 EV::LOOP_NONBLOCK do not block at all (fetch/handle events but do not wait)
128 267
129=item EV::unloop [$how] 268=item EV::unloop [$how]
130 269
270=item $loop->unloop ([$how])
271
131When called with no arguments or an argument of EV::UNLOOP_ONE, makes the 272When called with no arguments or an argument of EV::UNLOOP_ONE, makes the
132innermost call to EV::loop return. 273innermost call to EV::loop return.
133 274
134When called with an argument of EV::UNLOOP_ALL, all calls to EV::loop will return as 275When called with an argument of EV::UNLOOP_ALL, all calls to EV::loop will return as
135fast as possible. 276fast as possible.
136 277
137=item $count = EV::loop_count 278=item $count = EV::loop_count
138 279
280=item $count = $loop->loop_count
281
139Return the number of times the event loop has polled for new 282Return the number of times the event loop has polled for new
140events. Sometiems useful as a generation counter. 283events. Sometimes useful as a generation counter.
141 284
142=item EV::once $fh_or_undef, $events, $timeout, $cb->($revents) 285=item EV::once $fh_or_undef, $events, $timeout, $cb->($revents)
286
287=item $loop->once ($fh_or_undef, $events, $timeout, $cb->($revents))
143 288
144This function rolls together an I/O and a timer watcher for a single 289This function rolls together an I/O and a timer watcher for a single
145one-shot event without the need for managing a watcher object. 290one-shot event without the need for managing a watcher object.
146 291
147If C<$fh_or_undef> is a filehandle or file descriptor, then C<$events> 292If C<$fh_or_undef> is a filehandle or file descriptor, then C<$events>
… …
153If timeout is C<undef> or negative, then there will be no 298If timeout is C<undef> or negative, then there will be no
154timeout. Otherwise a EV::timer with this value will be started. 299timeout. Otherwise a EV::timer with this value will be started.
155 300
156When an error occurs or either the timeout or I/O watcher triggers, then 301When an error occurs or either the timeout or I/O watcher triggers, then
157the callback will be called with the received event set (in general 302the callback will be called with the received event set (in general
158you can expect it to be a combination of C<EV:ERROR>, C<EV::READ>, 303you can expect it to be a combination of C<EV::ERROR>, C<EV::READ>,
159C<EV::WRITE> and C<EV::TIMEOUT>). 304C<EV::WRITE> and C<EV::TIMEOUT>).
160 305
161EV::once doesn't return anything: the watchers stay active till either 306EV::once doesn't return anything: the watchers stay active till either
162of them triggers, then they will be stopped and freed, and the callback 307of them triggers, then they will be stopped and freed, and the callback
163invoked. 308invoked.
164 309
165=item EV::feed_fd_event ($fd, $revents) 310=item EV::feed_fd_event ($fd, $revents)
166 311
312=item $loop->feed_fd_event ($fd, $revents)
313
167Feed an event on a file descriptor into EV. EV will react to this call as 314Feed an event on a file descriptor into EV. EV will react to this call as
168if the readyness notifications specified by C<$revents> (a combination of 315if the readyness notifications specified by C<$revents> (a combination of
169C<EV::READ> and C<EV::WRITE>) happened on the file descriptor C<$fd>. 316C<EV::READ> and C<EV::WRITE>) happened on the file descriptor C<$fd>.
170 317
171=item EV::feed_signal_event ($signal) 318=item EV::feed_signal_event ($signal)
172 319
173Feed a signal event into EV. EV will react to this call as if the signal 320Feed a signal event into EV. EV will react to this call as if the signal
174specified by C<$signal> had occured. 321specified by C<$signal> had occured.
175 322
176=back 323=item EV::set_io_collect_interval $time
177 324
325=item $loop->set_io_collect_interval ($time)
178 326
327=item EV::set_timeout_collect_interval $time
328
329=item $loop->set_timeout_collect_interval ($time)
330
331These advanced functions set the minimum block interval when polling for I/O events and the minimum
332wait interval for timer events. See the libev documentation at
333L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#FUNCTIONS_CONTROLLING_THE_EVENT_LOOP>
334(locally installed as F<EV::libev>) for a more detailed discussion.
335
336=item $count = EV::pending_count
337
338=item $count = $loop->pending_count
339
340Returns the number of currently pending watchers.
341
342=item EV::invoke_pending
343
344=item $loop->invoke_pending
345
346Invoke all currently pending watchers.
347
348=back
349
350
179=head2 WATCHER OBJECTS 351=head1 WATCHER OBJECTS
180 352
181A watcher is an object that gets created to record your interest in some 353A watcher is an object that gets created to record your interest in some
182event. For instance, if you want to wait for STDIN to become readable, you 354event. For instance, if you want to wait for STDIN to become readable, you
183would create an EV::io watcher for that: 355would create an EV::io watcher for that:
184 356
185 my $watcher = EV::io *STDIN, EV::READ, sub { 357 my $watcher = EV::io *STDIN, EV::READ, sub {
186 my ($watcher, $revents) = @_; 358 my ($watcher, $revents) = @_;
187 warn "yeah, STDIN should not be readable without blocking!\n" 359 warn "yeah, STDIN should now be readable without blocking!\n"
188 }; 360 };
189 361
190All watchers can be active (waiting for events) or inactive (paused). Only 362All watchers can be active (waiting for events) or inactive (paused). Only
191active watchers will have their callbacks invoked. All callbacks will be 363active watchers will have their callbacks invoked. All callbacks will be
192called with at least two arguments: the watcher and a bitmask of received 364called with at least two arguments: the watcher and a bitmask of received
193events. 365events.
194 366
195Each watcher type has its associated bit in revents, so you can use the 367Each watcher type has its associated bit in revents, so you can use the
196same callback for multiple watchers. The event mask is named after the 368same callback for multiple watchers. The event mask is named after the
197type, i..e. EV::child sets EV::CHILD, EV::prepare sets EV::PREPARE, 369type, i.e. EV::child sets EV::CHILD, EV::prepare sets EV::PREPARE,
198EV::periodic sets EV::PERIODIC and so on, with the exception of I/O events 370EV::periodic sets EV::PERIODIC and so on, with the exception of I/O events
199(which can set both EV::READ and EV::WRITE bits), and EV::timer (which 371(which can set both EV::READ and EV::WRITE bits), and EV::timer (which
200uses EV::TIMEOUT). 372uses EV::TIMEOUT).
201 373
202In the rare case where one wants to create a watcher but not start it at 374In the rare case where one wants to create a watcher but not start it at
… …
276Feed some events on this watcher into EV. EV will react to this call as if 448Feed some events on this watcher into EV. EV will react to this call as if
277the watcher had received the given C<$revents> mask. 449the watcher had received the given C<$revents> mask.
278 450
279=item $revents = $w->clear_pending 451=item $revents = $w->clear_pending
280 452
281If the watcher is pending, this function returns clears its pending status 453If the watcher is pending, this function clears its pending status and
282and returns its C<$revents> bitset (as if its callback was invoked). If the 454returns its C<$revents> bitset (as if its callback was invoked). If the
283watcher isn't pending it does nothing and returns C<0>. 455watcher isn't pending it does nothing and returns C<0>.
284 456
285=item $previous_state = $w->keepalive ($bool) 457=item $previous_state = $w->keepalive ($bool)
286 458
287Normally, C<EV::loop> will return when there are no active watchers 459Normally, C<EV::loop> will return when there are no active watchers
288(which is a "deadlock" because no progress can be made anymore). This is 460(which is a "deadlock" because no progress can be made anymore). This is
289convinient because it allows you to start your watchers (and your jobs), 461convenient because it allows you to start your watchers (and your jobs),
290call C<EV::loop> once and when it returns you know that all your jobs are 462call C<EV::loop> once and when it returns you know that all your jobs are
291finished (or they forgot to register some watchers for their task :). 463finished (or they forgot to register some watchers for their task :).
292 464
293Sometimes, however, this gets in your way, for example when you the module 465Sometimes, however, this gets in your way, for example when the module
294that calls C<EV::loop> (usually the main program) is not the same module 466that calls C<EV::loop> (usually the main program) is not the same module
295as a long-living watcher (for example a DNS client module written by 467as a long-living watcher (for example a DNS client module written by
296somebody else even). Then you might want any outstanding requests to be 468somebody else even). Then you might want any outstanding requests to be
297handled, but you would not want to keep C<EV::loop> from returning just 469handled, but you would not want to keep C<EV::loop> from returning just
298because you happen to have this long-running UDP port watcher. 470because you happen to have this long-running UDP port watcher.
299 471
300In this case you can clear the keepalive status, which means that even 472In this case you can clear the keepalive status, which means that even
301though your watcher is active, it won't keep C<EV::loop> from returning. 473though your watcher is active, it won't keep C<EV::loop> from returning.
302 474
303The initial value for keepalive is true (enabled), and you cna change it 475The initial value for keepalive is true (enabled), and you can change it
304any time. 476any time.
305 477
306Example: Register an I/O watcher for some UDP socket but do not keep the 478Example: Register an I/O watcher for some UDP socket but do not keep the
307event loop from running just because of that watcher. 479event loop from running just because of that watcher.
308 480
309 my $udp_socket = ... 481 my $udp_socket = ...
310 my $udp_watcher = EV::io $udp_socket, EV::READ, sub { ... }; 482 my $udp_watcher = EV::io $udp_socket, EV::READ, sub { ... };
311 $udp_watcher->keepalive (0); 483 $udp_watcher->keepalive (0);
312 484
313=back 485=item $loop = $w->loop
314 486
487Return the loop that this watcher is attached to.
315 488
489=back
490
491
316=head2 WATCHER TYPES 492=head1 WATCHER TYPES
317 493
318Each of the following subsections describes a single watcher type. 494Each of the following subsections describes a single watcher type.
319 495
320=head3 I/O WATCHERS - is this file descriptor readable or writable? 496=head3 I/O WATCHERS - is this file descriptor readable or writable?
321 497
322=over 4 498=over 4
323 499
324=item $w = EV::io $fileno_or_fh, $eventmask, $callback 500=item $w = EV::io $fileno_or_fh, $eventmask, $callback
325 501
326=item $w = EV::io_ns $fileno_or_fh, $eventmask, $callback 502=item $w = EV::io_ns $fileno_or_fh, $eventmask, $callback
503
504=item $w = $loop->io ($fileno_or_fh, $eventmask, $callback)
505
506=item $w = $loop->io_ns ($fileno_or_fh, $eventmask, $callback)
327 507
328As long as the returned watcher object is alive, call the C<$callback> 508As long as the returned watcher object is alive, call the C<$callback>
329when at least one of events specified in C<$eventmask> occurs. 509when at least one of events specified in C<$eventmask> occurs.
330 510
331The $eventmask can be one or more of these constants ORed together: 511The $eventmask can be one or more of these constants ORed together:
… …
360=over 4 540=over 4
361 541
362=item $w = EV::timer $after, $repeat, $callback 542=item $w = EV::timer $after, $repeat, $callback
363 543
364=item $w = EV::timer_ns $after, $repeat, $callback 544=item $w = EV::timer_ns $after, $repeat, $callback
545
546=item $w = $loop->timer ($after, $repeat, $callback)
547
548=item $w = $loop->timer_ns ($after, $repeat, $callback)
365 549
366Calls the callback after C<$after> seconds (which may be fractional). If 550Calls the callback after C<$after> seconds (which may be fractional). If
367C<$repeat> is non-zero, the timer will be restarted (with the $repeat 551C<$repeat> is non-zero, the timer will be restarted (with the $repeat
368value as $after) after the callback returns. 552value as $after) after the callback returns.
369 553
… …
410=over 4 594=over 4
411 595
412=item $w = EV::periodic $at, $interval, $reschedule_cb, $callback 596=item $w = EV::periodic $at, $interval, $reschedule_cb, $callback
413 597
414=item $w = EV::periodic_ns $at, $interval, $reschedule_cb, $callback 598=item $w = EV::periodic_ns $at, $interval, $reschedule_cb, $callback
599
600=item $w = $loop->periodic ($at, $interval, $reschedule_cb, $callback)
601
602=item $w = $loop->periodic_ns ($at, $interval, $reschedule_cb, $callback)
415 603
416Similar to EV::timer, but is not based on relative timeouts but on 604Similar to EV::timer, but is not based on relative timeouts but on
417absolute times. Apart from creating "simple" timers that trigger "at" the 605absolute times. Apart from creating "simple" timers that trigger "at" the
418specified time, it can also be used for non-drifting absolute timers and 606specified time, it can also be used for non-drifting absolute timers and
419more complex, cron-like, setups that are not adversely affected by time 607more complex, cron-like, setups that are not adversely affected by time
… …
429This time simply fires at the wallclock time C<$at> and doesn't repeat. It 617This time simply fires at the wallclock time C<$at> and doesn't repeat. It
430will not adjust when a time jump occurs, that is, if it is to be run 618will not adjust when a time jump occurs, that is, if it is to be run
431at January 1st 2011 then it will run when the system time reaches or 619at January 1st 2011 then it will run when the system time reaches or
432surpasses this time. 620surpasses this time.
433 621
434=item * non-repeating interval timer ($interval > 0, $reschedule_cb = 0) 622=item * repeating interval timer ($interval > 0, $reschedule_cb = 0)
435 623
436In this mode the watcher will always be scheduled to time out at the 624In this mode the watcher will always be scheduled to time out at the
437next C<$at + N * $interval> time (for some integer N) and then repeat, 625next C<$at + N * $interval> time (for some integer N) and then repeat,
438regardless of any time jumps. 626regardless of any time jumps.
439 627
… …
457time the periodic watcher gets scheduled, the reschedule callback 645time the periodic watcher gets scheduled, the reschedule callback
458($reschedule_cb) will be called with the watcher as first, and the current 646($reschedule_cb) will be called with the watcher as first, and the current
459time as second argument. 647time as second argument.
460 648
461I<This callback MUST NOT stop or destroy this or any other periodic 649I<This callback MUST NOT stop or destroy this or any other periodic
462watcher, ever>. If you need to stop it, return 1e30 and stop it 650watcher, ever, and MUST NOT call any event loop functions or methods>. If
463afterwards. 651you need to stop it, return 1e30 and stop it afterwards. You may create
652and start a C<EV::prepare> watcher for this task.
464 653
465It must return the next time to trigger, based on the passed time value 654It must return the next time to trigger, based on the passed time value
466(that is, the lowest time value larger than to the second argument). It 655(that is, the lowest time value larger than or equal to to the second
467will usually be called just before the callback will be triggered, but 656argument). It will usually be called just before the callback will be
468might be called at other times, too. 657triggered, but might be called at other times, too.
469 658
470This can be used to create very complex timers, such as a timer that 659This can be used to create very complex timers, such as a timer that
471triggers on each midnight, local time (actually 24 hours after the last 660triggers on each midnight, local time (actually 24 hours after the last
472midnight, to keep the example simple. If you know a way to do it correctly 661midnight, to keep the example simple. If you know a way to do it correctly
473in about the same space (without requiring elaborate modules), drop me a 662in about the same space (without requiring elaborate modules), drop me a
… …
494 683
495=item $w->again 684=item $w->again
496 685
497Simply stops and starts the watcher again. 686Simply stops and starts the watcher again.
498 687
688=item $time = $w->at
689
690Return the time that the watcher is expected to trigger next.
691
499=back 692=back
500 693
501 694
502=head3 SIGNAL WATCHERS - signal me when a signal gets signalled! 695=head3 SIGNAL WATCHERS - signal me when a signal gets signalled!
503 696
504=over 4 697=over 4
505 698
506=item $w = EV::signal $signal, $callback 699=item $w = EV::signal $signal, $callback
507 700
508=item $w = EV::signal_ns $signal, $callback 701=item $w = EV::signal_ns $signal, $callback
702
703=item $w = $loop->signal ($signal, $callback)
704
705=item $w = $loop->signal_ns ($signal, $callback)
509 706
510Call the callback when $signal is received (the signal can be specified by 707Call the callback when $signal is received (the signal can be specified by
511number or by name, just as with C<kill> or C<%SIG>). 708number or by name, just as with C<kill> or C<%SIG>).
709
710Only one event loop can grab a given signal - attempting to grab the same
711signal from two EV loops will crash the program immediately or cause data
712corruption.
512 713
513EV will grab the signal for the process (the kernel only allows one 714EV will grab the signal for the process (the kernel only allows one
514component to receive a signal at a time) when you start a signal watcher, 715component to receive a signal at a time) when you start a signal watcher,
515and removes it again when you stop it. Perl does the same when you 716and removes it again when you stop it. Perl does the same when you
516add/remove callbacks to C<%SIG>, so watch out. 717add/remove callbacks to C<%SIG>, so watch out.
… …
536 737
537=head3 CHILD WATCHERS - watch out for process status changes 738=head3 CHILD WATCHERS - watch out for process status changes
538 739
539=over 4 740=over 4
540 741
541=item $w = EV::child $pid, $callback 742=item $w = EV::child $pid, $trace, $callback
542 743
543=item $w = EV::child_ns $pid, $callback 744=item $w = EV::child_ns $pid, $trace, $callback
544 745
746=item $w = $loop->child ($pid, $trace, $callback)
747
748=item $w = $loop->child_ns ($pid, $trace, $callback)
749
545Call the callback when a status change for pid C<$pid> (or any pid if 750Call the callback when a status change for pid C<$pid> (or any pid
546C<$pid> is 0) has been received. More precisely: when the process receives 751if C<$pid> is 0) has been received (a status change happens when the
752process terminates or is killed, or, when trace is true, additionally when
753it is stopped or continued). More precisely: when the process receives
547a C<SIGCHLD>, EV will fetch the outstanding exit/wait status for all 754a C<SIGCHLD>, EV will fetch the outstanding exit/wait status for all
548changed/zombie children and call the callback. 755changed/zombie children and call the callback.
549 756
550It is valid (and fully supported) to install a child watcher after a child 757It is valid (and fully supported) to install a child watcher after a child
551has exited but before the event loop has started its next iteration (for 758has exited but before the event loop has started its next iteration (for
… …
558You can have as many pid watchers per pid as you want, they will all be 765You can have as many pid watchers per pid as you want, they will all be
559called. 766called.
560 767
561The C<child_ns> variant doesn't start (activate) the newly created watcher. 768The C<child_ns> variant doesn't start (activate) the newly created watcher.
562 769
563=item $w->set ($pid) 770=item $w->set ($pid, $trace)
564 771
565Reconfigures the watcher, see the constructor above for details. Can be called at 772Reconfigures the watcher, see the constructor above for details. Can be called at
566any time. 773any time.
567 774
568=item $current_pid = $w->pid 775=item $current_pid = $w->pid
569 776
570=item $old_pid = $w->pid ($new_pid)
571
572Returns the previously set process id and optionally set a new one. 777Returns the previously set process id and optionally set a new one.
573 778
574=item $exit_status = $w->rstatus 779=item $exit_status = $w->rstatus
575 780
576Return the exit/wait status (as returned by waitpid, see the waitpid entry 781Return the exit/wait status (as returned by waitpid, see the waitpid entry
… …
589=over 4 794=over 4
590 795
591=item $w = EV::stat $path, $interval, $callback 796=item $w = EV::stat $path, $interval, $callback
592 797
593=item $w = EV::stat_ns $path, $interval, $callback 798=item $w = EV::stat_ns $path, $interval, $callback
799
800=item $w = $loop->stat ($path, $interval, $callback)
801
802=item $w = $loop->stat_ns ($path, $interval, $callback)
594 803
595Call the callback when a file status change has been detected on 804Call the callback when a file status change has been detected on
596C<$path>. The C<$path> does not need to exist, changing from "path exists" 805C<$path>. The C<$path> does not need to exist, changing from "path exists"
597to "path does not exist" is a status change like any other. 806to "path does not exist" is a status change like any other.
598 807
… …
668=over 4 877=over 4
669 878
670=item $w = EV::idle $callback 879=item $w = EV::idle $callback
671 880
672=item $w = EV::idle_ns $callback 881=item $w = EV::idle_ns $callback
882
883=item $w = $loop->idle ($callback)
884
885=item $w = $loop->idle_ns ($callback)
673 886
674Call the callback when there are no other pending watchers of the same or 887Call the callback when there are no other pending watchers of the same or
675higher priority (excluding check, prepare and other idle watchers of the 888higher priority (excluding check, prepare and other idle watchers of the
676same or lower priority, of course). They are called idle watchers because 889same or lower priority, of course). They are called idle watchers because
677when the watcher is the highest priority pending event in the process, the 890when the watcher is the highest priority pending event in the process, the
… …
700 913
701=item $w = EV::prepare $callback 914=item $w = EV::prepare $callback
702 915
703=item $w = EV::prepare_ns $callback 916=item $w = EV::prepare_ns $callback
704 917
918=item $w = $loop->prepare ($callback)
919
920=item $w = $loop->prepare_ns ($callback)
921
705Call the callback just before the process would block. You can still 922Call the callback just before the process would block. You can still
706create/modify any watchers at this point. 923create/modify any watchers at this point.
707 924
708See the EV::check watcher, below, for explanations and an example. 925See the EV::check watcher, below, for explanations and an example.
709 926
… …
717=over 4 934=over 4
718 935
719=item $w = EV::check $callback 936=item $w = EV::check $callback
720 937
721=item $w = EV::check_ns $callback 938=item $w = EV::check_ns $callback
939
940=item $w = $loop->check ($callback)
941
942=item $w = $loop->check_ns ($callback)
722 943
723Call the callback just after the process wakes up again (after it has 944Call the callback just after the process wakes up again (after it has
724gathered events), but before any other callbacks have been invoked. 945gathered events), but before any other callbacks have been invoked.
725 946
726This is used to integrate other event-based software into the EV 947This is used to integrate other event-based software into the EV
… …
761 # make the dispatcher handle any new stuff 982 # make the dispatcher handle any new stuff
762 ... not shown 983 ... not shown
763 }; 984 };
764 985
765The callbacks of the created watchers will not be called as the watchers 986The callbacks of the created watchers will not be called as the watchers
766are destroyed before this cna happen (remember EV::check gets called 987are destroyed before this can happen (remember EV::check gets called
767first). 988first).
768 989
769The C<check_ns> variant doesn't start (activate) the newly created watcher. 990The C<check_ns> variant doesn't start (activate) the newly created watcher.
770 991
771=back 992=back
… …
781 1002
782=item $w = EV::fork $callback 1003=item $w = EV::fork $callback
783 1004
784=item $w = EV::fork_ns $callback 1005=item $w = EV::fork_ns $callback
785 1006
1007=item $w = $loop->fork ($callback)
1008
1009=item $w = $loop->fork_ns ($callback)
1010
786Call the callback before the event loop is resumed in the child process 1011Call the callback before the event loop is resumed in the child process
787after a fork. 1012after a fork.
788 1013
789The C<fork_ns> variant doesn't start (activate) the newly created watcher. 1014The C<fork_ns> variant doesn't start (activate) the newly created watcher.
1015
1016=back
1017
1018
1019=head3 EMBED WATCHERS - when one backend isn't enough...
1020
1021This is a rather advanced watcher type that lets you embed one event loop
1022into another (currently only IO events are supported in the embedded
1023loop, other types of watchers might be handled in a delayed or incorrect
1024fashion and must not be used).
1025
1026See the libev documentation at
1027L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#code_ev_embed_code_when_one_backend_>
1028(locally installed as F<EV::libev>) for more details.
1029
1030In short, this watcher is most useful on BSD systems without working
1031kqueue to still be able to handle a large number of sockets:
1032
1033 my $socket_loop;
1034
1035 # check wether we use SELECT or POLL _and_ KQUEUE is supported
1036 if (
1037 (EV::backend & (EV::BACKEND_POLL | EV::BACKEND_SELECT))
1038 && (EV::supported_backends & EV::embeddable_backends & EV::BACKEND_KQUEUE)
1039 ) {
1040 # use kqueue for sockets
1041 $socket_loop = new EV::Loop EV::BACKEND_KQUEUE | EV::FLAG_NOENV;
1042 }
1043
1044 # use the default loop otherwise
1045 $socket_loop ||= EV::default_loop;
1046
1047=over 4
1048
1049=item $w = EV::embed $otherloop[, $callback]
1050
1051=item $w = EV::embed_ns $otherloop[, $callback]
1052
1053=item $w = $loop->embed ($otherloop[, $callback])
1054
1055=item $w = $loop->embed_ns ($otherloop[, $callback])
1056
1057Call the callback when the embedded event loop (C<$otherloop>) has any
1058I/O activity. The C<$callback> is optional: if it is missing, then the
1059embedded event loop will be managed automatically (which is recommended),
1060otherwise you have to invoke C<sweep> yourself.
1061
1062The C<embed_ns> variant doesn't start (activate) the newly created watcher.
1063
1064=back
1065
1066=head3 ASYNC WATCHERS - how to wake up another event loop
1067
1068Async watchers are provided by EV, but have little use in perl directly,
1069as perl neither supports threads running in parallel nor direct access to
1070signal handlers or other contexts where they could be of value.
1071
1072It is, however, possible to use them from the XS level.
1073
1074Please see the libev documentation for further details.
1075
1076=over 4
1077
1078=item $w = EV::async $callback
1079
1080=item $w = EV::async_ns $callback
1081
1082=item $w->send
1083
1084=item $bool = $w->async_pending
790 1085
791=back 1086=back
792 1087
793 1088
794=head1 PERL SIGNALS 1089=head1 PERL SIGNALS
… …
805to be called on every event loop iteration by installing a C<EV::check> 1100to be called on every event loop iteration by installing a C<EV::check>
806watcher: 1101watcher:
807 1102
808 my $async_check = EV::check sub { }; 1103 my $async_check = EV::check sub { };
809 1104
810This ensures that perl shortly gets into control for a short time, and 1105This ensures that perl gets into control for a short time to handle any
811also ensures slower overall operation. 1106pending signals, and also ensures (slightly) slower overall operation.
812 1107
813=head1 THREADS 1108=head1 ITHREADS
814 1109
815Threads are not supported by this module in any way. Perl pseudo-threads 1110Ithreads are not supported by this module in any way. Perl pseudo-threads
816is evil stuff and must die. As soon as Perl gains real threads I will work 1111is evil stuff and must die. Real threads as provided by Coro are fully
817on thread support for it. 1112supported (and enhanced support is available via L<Coro::EV>).
818 1113
819=head1 FORK 1114=head1 FORK
820 1115
821Most of the "improved" event delivering mechanisms of modern operating 1116Most of the "improved" event delivering mechanisms of modern operating
822systems have quite a few problems with fork(2) (to put it bluntly: it is 1117systems have quite a few problems with fork(2) (to put it bluntly: it is
… …
844 1139
8451; 11401;
846 1141
847=head1 SEE ALSO 1142=head1 SEE ALSO
848 1143
849L<EV::ADNS> (asynchronous dns), L<Glib::EV> (makes Glib/Gtk2 use EV as 1144L<EV::ADNS> (asynchronous DNS), L<Glib::EV> (makes Glib/Gtk2 use EV as
850event loop), L<Coro::EV> (efficient coroutines with EV). 1145event loop), L<EV::Glib> (embed Glib into EV), L<Coro::EV> (efficient
1146coroutines with EV), L<Net::SNMP::EV> (asynchronous SNMP), L<AnyEvent> for
1147event-loop agnostic and portable event driven programming.
851 1148
852=head1 AUTHOR 1149=head1 AUTHOR
853 1150
854 Marc Lehmann <schmorp@schmorp.de> 1151 Marc Lehmann <schmorp@schmorp.de>
855 http://home.schmorp.de/ 1152 http://home.schmorp.de/
856 1153
857=cut 1154=cut
858 1155

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines