… | |
… | |
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 |
… | |
… | |
67 | This module is very fast and scalable. It is actually so fast that you |
76 | This module is very fast and scalable. It is actually so fast that you |
68 | can use it through the L<AnyEvent> module, stay portable to other event |
77 | can use it through the L<AnyEvent> module, stay portable to other event |
69 | loops (if you don't rely on any watcher types not available through it) |
78 | loops (if you don't rely on any watcher types not available through it) |
70 | and still be faster than with any other event loop currently supported in |
79 | and still be faster than with any other event loop currently supported in |
71 | Perl. |
80 | Perl. |
|
|
81 | |
|
|
82 | =head2 PORTING FROM EV 3.X to 4.X |
|
|
83 | |
|
|
84 | EV version 4 introduces a number of incompatible changes summarised |
|
|
85 | here. According to the depreciation strategy used by libev, there is a |
|
|
86 | compatibility 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 |
|
|
88 | updated). |
|
|
89 | |
|
|
90 | This compatibility layer will be switched off in some future release. |
|
|
91 | |
|
|
92 | All changes relevant to Perl are renames of symbols, functions and |
|
|
93 | methods: |
|
|
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 | |
|
|
110 | The loop object methods corresponding to the functions above have been |
|
|
111 | similarly renamed. |
72 | |
112 | |
73 | =head2 MODULE EXPORTS |
113 | =head2 MODULE EXPORTS |
74 | |
114 | |
75 | This module does not export any symbols. |
115 | This module does not export any symbols. |
76 | |
116 | |
… | |
… | |
941 | =item $w = $loop->check_ns ($callback) |
981 | =item $w = $loop->check_ns ($callback) |
942 | |
982 | |
943 | Call the callback just after the process wakes up again (after it has |
983 | Call the callback just after the process wakes up again (after it has |
944 | gathered events), but before any other callbacks have been invoked. |
984 | gathered events), but before any other callbacks have been invoked. |
945 | |
985 | |
946 | This is used to integrate other event-based software into the EV |
986 | This can be used to integrate other event-based software into the EV |
947 | mainloop: You register a prepare callback and in there, you create io and |
987 | mainloop: You register a prepare callback and in there, you create io and |
948 | timer watchers as required by the other software. Here is a real-world |
988 | timer watchers as required by the other software. Here is a real-world |
949 | example of integrating Net::SNMP (with some details left out): |
989 | example of integrating Net::SNMP (with some details left out): |
950 | |
990 | |
951 | our @snmp_watcher; |
991 | our @snmp_watcher; |
… | |
… | |
985 | The callbacks of the created watchers will not be called as the watchers |
1025 | The callbacks of the created watchers will not be called as the watchers |
986 | are destroyed before this can happen (remember EV::check gets called |
1026 | are destroyed before this can happen (remember EV::check gets called |
987 | first). |
1027 | first). |
988 | |
1028 | |
989 | The C<check_ns> variant doesn't start (activate) the newly created watcher. |
1029 | The C<check_ns> variant doesn't start (activate) the newly created watcher. |
|
|
1030 | |
|
|
1031 | =item EV::CHECK constant issues |
|
|
1032 | |
|
|
1033 | Like all other watcher types, there is a bitmask constant for use in |
|
|
1034 | C<$revents> and other places. The C<EV::CHECK> is special as it has |
|
|
1035 | the same name as the C<CHECK> sub called by Perl. This doesn't cause |
|
|
1036 | big issues on newer perls (beginning with 5.8.9), but it means thatthe |
|
|
1037 | constant must be I<inlined>, i.e. runtime calls will not work. That means |
|
|
1038 | that as long as you always C<use EV> and then C<EV::CHECK> you are on the |
|
|
1039 | safe side. |
990 | |
1040 | |
991 | =back |
1041 | =back |
992 | |
1042 | |
993 | |
1043 | |
994 | =head3 FORK WATCHERS - the audacity to resume the event loop after a fork |
1044 | =head3 FORK WATCHERS - the audacity to resume the event loop after a fork |