… | |
… | |
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 BEFORE YOU START USING THIS MODULE |
|
|
57 | |
|
|
58 | If you only need timer, I/O, signal, child and idle watchers and not the |
|
|
59 | advanced functionality of this module, consider using L<AnyEvent> instead, |
|
|
60 | specifically the simplified API described in L<AE>. |
|
|
61 | |
|
|
62 | When used with EV as backend, the L<AE> API is as fast as the native L<EV> |
|
|
63 | API, but your programs/modules will still run with many other event loops. |
|
|
64 | |
56 | =head1 DESCRIPTION |
65 | =head1 DESCRIPTION |
57 | |
66 | |
58 | This module provides an interface to libev |
67 | This 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 |
60 | below is comprehensive, one might also consult the documentation of |
69 | below is comprehensive, one might also consult the documentation of |
… | |
… | |
79 | package EV; |
88 | package EV; |
80 | |
89 | |
81 | use common::sense; |
90 | use common::sense; |
82 | |
91 | |
83 | BEGIN { |
92 | BEGIN { |
84 | our $VERSION = '3.9'; |
93 | our $VERSION = '4.00'; |
85 | use XSLoader; |
94 | use XSLoader; |
86 | XSLoader::load "EV", $VERSION; |
95 | XSLoader::load "EV", $VERSION; |
87 | } |
96 | } |
88 | |
97 | |
89 | @EV::IO::ISA = |
98 | @EV::IO::ISA = |
… | |
… | |
299 | timeout. Otherwise a EV::timer with this value will be started. |
308 | timeout. Otherwise a EV::timer with this value will be started. |
300 | |
309 | |
301 | When an error occurs or either the timeout or I/O watcher triggers, then |
310 | When an error occurs or either the timeout or I/O watcher triggers, then |
302 | the callback will be called with the received event set (in general |
311 | the callback will be called with the received event set (in general |
303 | you can expect it to be a combination of C<EV::ERROR>, C<EV::READ>, |
312 | you can expect it to be a combination of C<EV::ERROR>, C<EV::READ>, |
304 | C<EV::WRITE> and C<EV::TIMEOUT>). |
313 | C<EV::WRITE> and C<EV::TIMER>). |
305 | |
314 | |
306 | EV::once doesn't return anything: the watchers stay active till either |
315 | EV::once doesn't return anything: the watchers stay active till either |
307 | of them triggers, then they will be stopped and freed, and the callback |
316 | of them triggers, then they will be stopped and freed, and the callback |
308 | invoked. |
317 | invoked. |
309 | |
318 | |
… | |
… | |
366 | |
375 | |
367 | Each watcher type has its associated bit in revents, so you can use the |
376 | Each watcher type has its associated bit in revents, so you can use the |
368 | same callback for multiple watchers. The event mask is named after the |
377 | same callback for multiple watchers. The event mask is named after the |
369 | type, i.e. EV::child sets EV::CHILD, EV::prepare sets EV::PREPARE, |
378 | type, i.e. EV::child sets EV::CHILD, EV::prepare sets EV::PREPARE, |
370 | EV::periodic sets EV::PERIODIC and so on, with the exception of I/O events |
379 | EV::periodic sets EV::PERIODIC and so on, with the exception of I/O events |
371 | (which can set both EV::READ and EV::WRITE bits), and EV::timer (which |
380 | (which can set both EV::READ and EV::WRITE bits). |
372 | uses EV::TIMEOUT). |
|
|
373 | |
381 | |
374 | In the rare case where one wants to create a watcher but not start it at |
382 | In the rare case where one wants to create a watcher but not start it at |
375 | the same time, each constructor has a variant with a trailing C<_ns> in |
383 | the same time, each constructor has a variant with a trailing C<_ns> in |
376 | its name, e.g. EV::io has a non-starting variant EV::io_ns and so on. |
384 | its name, e.g. EV::io has a non-starting variant EV::io_ns and so on. |
377 | |
385 | |
… | |
… | |
942 | =item $w = $loop->check_ns ($callback) |
950 | =item $w = $loop->check_ns ($callback) |
943 | |
951 | |
944 | Call the callback just after the process wakes up again (after it has |
952 | Call the callback just after the process wakes up again (after it has |
945 | gathered events), but before any other callbacks have been invoked. |
953 | gathered events), but before any other callbacks have been invoked. |
946 | |
954 | |
947 | This is used to integrate other event-based software into the EV |
955 | This can be used to integrate other event-based software into the EV |
948 | mainloop: You register a prepare callback and in there, you create io and |
956 | mainloop: You register a prepare callback and in there, you create io and |
949 | timer watchers as required by the other software. Here is a real-world |
957 | timer watchers as required by the other software. Here is a real-world |
950 | example of integrating Net::SNMP (with some details left out): |
958 | example of integrating Net::SNMP (with some details left out): |
951 | |
959 | |
952 | our @snmp_watcher; |
960 | our @snmp_watcher; |
… | |
… | |
986 | The callbacks of the created watchers will not be called as the watchers |
994 | The callbacks of the created watchers will not be called as the watchers |
987 | are destroyed before this can happen (remember EV::check gets called |
995 | are destroyed before this can happen (remember EV::check gets called |
988 | first). |
996 | first). |
989 | |
997 | |
990 | The C<check_ns> variant doesn't start (activate) the newly created watcher. |
998 | The C<check_ns> variant doesn't start (activate) the newly created watcher. |
|
|
999 | |
|
|
1000 | =item EV::CHECK constant issues |
|
|
1001 | |
|
|
1002 | Like all other watcher types, there is a bitmask constant for use in |
|
|
1003 | C<$revents> and other places. The C<EV::CHECK> is special as it has |
|
|
1004 | the same name as the C<CHECK> sub called by Perl. This doesn't cause |
|
|
1005 | big issues on newer perls (beginning with 5.8.9), but it means thatthe |
|
|
1006 | constant must be I<inlined>, i.e. runtime calls will not work. That means |
|
|
1007 | that as long as you always C<use EV> and then C<EV::CHECK> you are on the |
|
|
1008 | safe side. |
991 | |
1009 | |
992 | =back |
1010 | =back |
993 | |
1011 | |
994 | |
1012 | |
995 | =head3 FORK WATCHERS - the audacity to resume the event loop after a fork |
1013 | =head3 FORK WATCHERS - the audacity to resume the event loop after a fork |