… | |
… | |
77 | 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 |
78 | 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) |
79 | 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 |
80 | Perl. |
80 | Perl. |
81 | |
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. |
|
|
112 | |
82 | =head2 MODULE EXPORTS |
113 | =head2 MODULE EXPORTS |
83 | |
114 | |
84 | This module does not export any symbols. |
115 | This module does not export any symbols. |
85 | |
116 | |
86 | =cut |
117 | =cut |
… | |
… | |
88 | package EV; |
119 | package EV; |
89 | |
120 | |
90 | use common::sense; |
121 | use common::sense; |
91 | |
122 | |
92 | BEGIN { |
123 | BEGIN { |
93 | our $VERSION = '4.00'; |
124 | our $VERSION = '4.03'; |
94 | use XSLoader; |
125 | use XSLoader; |
95 | XSLoader::load "EV", $VERSION; |
126 | XSLoader::load "EV", $VERSION; |
96 | } |
127 | } |
97 | |
128 | |
98 | @EV::IO::ISA = |
129 | @EV::IO::ISA = |
… | |
… | |
268 | Begin checking for events and calling callbacks. It returns when a |
299 | Begin checking for events and calling callbacks. It returns when a |
269 | callback calls EV::unloop. |
300 | callback calls EV::unloop. |
270 | |
301 | |
271 | The $flags argument can be one of the following: |
302 | The $flags argument can be one of the following: |
272 | |
303 | |
273 | 0 as above |
304 | 0 as above |
274 | 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) |
275 | 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) |
276 | |
307 | |
277 | =item EV::unloop [$how] |
308 | =item EV::break [$how] |
278 | |
309 | |
279 | =item $loop->unloop ([$how]) |
310 | =item $loop->break ([$how]) |
280 | |
311 | |
281 | When called with no arguments or an argument of EV::UNLOOP_ONE, makes the |
312 | When called with no arguments or an argument of EV::BREAK_ONE, makes the |
282 | innermost call to EV::loop return. |
313 | innermost call to EV::loop return. |
283 | |
314 | |
284 | When called with an argument of EV::UNLOOP_ALL, all calls to EV::loop will return as |
315 | When called with an argument of EV::BREAK_ALL, all calls to EV::loop will |
285 | fast as possible. |
316 | return as fast as possible. |
|
|
317 | |
|
|
318 | When called with an argument of EV::BREAK_CANCEL, any pending break will |
|
|
319 | be cancelled. |
286 | |
320 | |
287 | =item $count = EV::loop_count |
321 | =item $count = EV::loop_count |
288 | |
322 | |
289 | =item $count = $loop->loop_count |
323 | =item $count = $loop->loop_count |
290 | |
324 | |
… | |
… | |
314 | |
348 | |
315 | EV::once doesn't return anything: the watchers stay active till either |
349 | EV::once doesn't return anything: the watchers stay active till either |
316 | of them triggers, then they will be stopped and freed, and the callback |
350 | of them triggers, then they will be stopped and freed, and the callback |
317 | invoked. |
351 | invoked. |
318 | |
352 | |
319 | =item EV::feed_fd_event ($fd, $revents) |
353 | =item EV::feed_fd_event $fd, $revents |
320 | |
354 | |
321 | =item $loop->feed_fd_event ($fd, $revents) |
355 | =item $loop->feed_fd_event ($fd, $revents) |
322 | |
356 | |
323 | Feed an event on a file descriptor into EV. EV will react to this call as |
357 | Feed an event on a file descriptor into EV. EV will react to this call as |
324 | if the readyness notifications specified by C<$revents> (a combination of |
358 | if the readyness notifications specified by C<$revents> (a combination of |
325 | C<EV::READ> and C<EV::WRITE>) happened on the file descriptor C<$fd>. |
359 | C<EV::READ> and C<EV::WRITE>) happened on the file descriptor C<$fd>. |
326 | |
360 | |
327 | =item EV::feed_signal_event ($signal) |
361 | =item EV::feed_signal_event $signal |
328 | |
362 | |
329 | Feed a signal event into EV. EV will react to this call as if the signal |
363 | Feed a signal event into the default loop. EV will react to this call as |
330 | specified by C<$signal> had occured. |
364 | if the signal specified by C<$signal> had occured. |
|
|
365 | |
|
|
366 | =item EV::feed_signal $signal |
|
|
367 | |
|
|
368 | Feed a signal event into EV - unlike C<EV::feed_signal_event>, this works |
|
|
369 | regardless of which loop has registered the signal, and is mainly useful |
|
|
370 | fro custom signal implementations. |
331 | |
371 | |
332 | =item EV::set_io_collect_interval $time |
372 | =item EV::set_io_collect_interval $time |
333 | |
373 | |
334 | =item $loop->set_io_collect_interval ($time) |
374 | =item $loop->set_io_collect_interval ($time) |
335 | |
375 | |
… | |
… | |
950 | =item $w = $loop->check_ns ($callback) |
990 | =item $w = $loop->check_ns ($callback) |
951 | |
991 | |
952 | Call the callback just after the process wakes up again (after it has |
992 | Call the callback just after the process wakes up again (after it has |
953 | gathered events), but before any other callbacks have been invoked. |
993 | gathered events), but before any other callbacks have been invoked. |
954 | |
994 | |
955 | This is used to integrate other event-based software into the EV |
995 | This can be used to integrate other event-based software into the EV |
956 | mainloop: You register a prepare callback and in there, you create io and |
996 | mainloop: You register a prepare callback and in there, you create io and |
957 | timer watchers as required by the other software. Here is a real-world |
997 | timer watchers as required by the other software. Here is a real-world |
958 | example of integrating Net::SNMP (with some details left out): |
998 | example of integrating Net::SNMP (with some details left out): |
959 | |
999 | |
960 | our @snmp_watcher; |
1000 | our @snmp_watcher; |
… | |
… | |
994 | The callbacks of the created watchers will not be called as the watchers |
1034 | The callbacks of the created watchers will not be called as the watchers |
995 | are destroyed before this can happen (remember EV::check gets called |
1035 | are destroyed before this can happen (remember EV::check gets called |
996 | first). |
1036 | first). |
997 | |
1037 | |
998 | The C<check_ns> variant doesn't start (activate) the newly created watcher. |
1038 | The C<check_ns> variant doesn't start (activate) the newly created watcher. |
|
|
1039 | |
|
|
1040 | =item EV::CHECK constant issues |
|
|
1041 | |
|
|
1042 | Like all other watcher types, there is a bitmask constant for use in |
|
|
1043 | C<$revents> and other places. The C<EV::CHECK> is special as it has |
|
|
1044 | the same name as the C<CHECK> sub called by Perl. This doesn't cause |
|
|
1045 | big issues on newer perls (beginning with 5.8.9), but it means thatthe |
|
|
1046 | constant must be I<inlined>, i.e. runtime calls will not work. That means |
|
|
1047 | that as long as you always C<use EV> and then C<EV::CHECK> you are on the |
|
|
1048 | safe side. |
999 | |
1049 | |
1000 | =back |
1050 | =back |
1001 | |
1051 | |
1002 | |
1052 | |
1003 | =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 |
… | |
… | |
1147 | |
1197 | |
1148 | 1; |
1198 | 1; |
1149 | |
1199 | |
1150 | =head1 SEE ALSO |
1200 | =head1 SEE ALSO |
1151 | |
1201 | |
|
|
1202 | L<EV::MakeMaker> - MakeMaker interface to XS API, L<EV::ADNS> |
1152 | L<EV::ADNS> (asynchronous DNS), L<Glib::EV> (makes Glib/Gtk2 use EV as |
1203 | (asynchronous DNS), L<Glib::EV> (makes Glib/Gtk2 use EV as event |
1153 | event loop), L<EV::Glib> (embed Glib into EV), L<Coro::EV> (efficient |
1204 | loop), L<EV::Glib> (embed Glib into EV), L<Coro::EV> (efficient thread |
1154 | coroutines with EV), L<Net::SNMP::EV> (asynchronous SNMP), L<AnyEvent> for |
1205 | integration), L<Net::SNMP::EV> (asynchronous SNMP), L<AnyEvent> for |
1155 | event-loop agnostic and portable event driven programming. |
1206 | event-loop agnostic and portable event driven programming. |
1156 | |
1207 | |
1157 | =head1 AUTHOR |
1208 | =head1 AUTHOR |
1158 | |
1209 | |
1159 | Marc Lehmann <schmorp@schmorp.de> |
1210 | Marc Lehmann <schmorp@schmorp.de> |