… | |
… | |
79 | package EV; |
79 | package EV; |
80 | |
80 | |
81 | use common::sense; |
81 | use common::sense; |
82 | |
82 | |
83 | BEGIN { |
83 | BEGIN { |
84 | our $VERSION = '3.6'; |
84 | our $VERSION = '4.00'; |
85 | use XSLoader; |
85 | use XSLoader; |
86 | XSLoader::load "EV", $VERSION; |
86 | XSLoader::load "EV", $VERSION; |
87 | } |
87 | } |
88 | |
88 | |
89 | @EV::IO::ISA = |
89 | @EV::IO::ISA = |
… | |
… | |
299 | timeout. Otherwise a EV::timer with this value will be started. |
299 | timeout. Otherwise a EV::timer with this value will be started. |
300 | |
300 | |
301 | When an error occurs or either the timeout or I/O watcher triggers, then |
301 | 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 |
302 | 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>, |
303 | you can expect it to be a combination of C<EV::ERROR>, C<EV::READ>, |
304 | C<EV::WRITE> and C<EV::TIMEOUT>). |
304 | C<EV::WRITE> and C<EV::TIMER>). |
305 | |
305 | |
306 | EV::once doesn't return anything: the watchers stay active till either |
306 | 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 |
307 | of them triggers, then they will be stopped and freed, and the callback |
308 | invoked. |
308 | invoked. |
309 | |
309 | |
… | |
… | |
331 | These advanced functions set the minimum block interval when polling for I/O events and the minimum |
331 | These advanced functions set the minimum block interval when polling for I/O events and the minimum |
332 | wait interval for timer events. See the libev documentation at |
332 | wait interval for timer events. See the libev documentation at |
333 | L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#FUNCTIONS_CONTROLLING_THE_EVENT_LOOP> |
333 | L<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. |
334 | (locally installed as F<EV::libev>) for a more detailed discussion. |
335 | |
335 | |
|
|
336 | =item $count = EV::pending_count |
|
|
337 | |
|
|
338 | =item $count = $loop->pending_count |
|
|
339 | |
|
|
340 | Returns the number of currently pending watchers. |
|
|
341 | |
|
|
342 | =item EV::invoke_pending |
|
|
343 | |
|
|
344 | =item $loop->invoke_pending |
|
|
345 | |
|
|
346 | Invoke all currently pending watchers. |
|
|
347 | |
336 | =back |
348 | =back |
337 | |
349 | |
338 | |
350 | |
339 | =head1 WATCHER OBJECTS |
351 | =head1 WATCHER OBJECTS |
340 | |
352 | |
… | |
… | |
354 | |
366 | |
355 | Each watcher type has its associated bit in revents, so you can use the |
367 | Each watcher type has its associated bit in revents, so you can use the |
356 | same callback for multiple watchers. The event mask is named after the |
368 | same callback for multiple watchers. The event mask is named after the |
357 | type, i.e. EV::child sets EV::CHILD, EV::prepare sets EV::PREPARE, |
369 | type, i.e. EV::child sets EV::CHILD, EV::prepare sets EV::PREPARE, |
358 | EV::periodic sets EV::PERIODIC and so on, with the exception of I/O events |
370 | EV::periodic sets EV::PERIODIC and so on, with the exception of I/O events |
359 | (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). |
360 | uses EV::TIMEOUT). |
|
|
361 | |
372 | |
362 | In the rare case where one wants to create a watcher but not start it at |
373 | In the rare case where one wants to create a watcher but not start it at |
363 | the same time, each constructor has a variant with a trailing C<_ns> in |
374 | the same time, each constructor has a variant with a trailing C<_ns> in |
364 | its name, e.g. EV::io has a non-starting variant EV::io_ns and so on. |
375 | its name, e.g. EV::io has a non-starting variant EV::io_ns and so on. |
365 | |
376 | |
… | |
… | |
444 | |
455 | |
445 | =item $previous_state = $w->keepalive ($bool) |
456 | =item $previous_state = $w->keepalive ($bool) |
446 | |
457 | |
447 | Normally, C<EV::loop> will return when there are no active watchers |
458 | Normally, C<EV::loop> will return when there are no active watchers |
448 | (which is a "deadlock" because no progress can be made anymore). This is |
459 | (which is a "deadlock" because no progress can be made anymore). This is |
449 | convinient because it allows you to start your watchers (and your jobs), |
460 | convenient because it allows you to start your watchers (and your jobs), |
450 | call C<EV::loop> once and when it returns you know that all your jobs are |
461 | call C<EV::loop> once and when it returns you know that all your jobs are |
451 | finished (or they forgot to register some watchers for their task :). |
462 | finished (or they forgot to register some watchers for their task :). |
452 | |
463 | |
453 | Sometimes, however, this gets in your way, for example when the module |
464 | Sometimes, however, this gets in your way, for example when the module |
454 | that calls C<EV::loop> (usually the main program) is not the same module |
465 | that calls C<EV::loop> (usually the main program) is not the same module |
… | |
… | |
686 | |
697 | |
687 | =item $w = EV::signal $signal, $callback |
698 | =item $w = EV::signal $signal, $callback |
688 | |
699 | |
689 | =item $w = EV::signal_ns $signal, $callback |
700 | =item $w = EV::signal_ns $signal, $callback |
690 | |
701 | |
|
|
702 | =item $w = $loop->signal ($signal, $callback) |
|
|
703 | |
|
|
704 | =item $w = $loop->signal_ns ($signal, $callback) |
|
|
705 | |
691 | Call the callback when $signal is received (the signal can be specified by |
706 | Call the callback when $signal is received (the signal can be specified by |
692 | number or by name, just as with C<kill> or C<%SIG>). |
707 | number or by name, just as with C<kill> or C<%SIG>). |
|
|
708 | |
|
|
709 | Only one event loop can grab a given signal - attempting to grab the same |
|
|
710 | signal from two EV loops will crash the program immediately or cause data |
|
|
711 | corruption. |
693 | |
712 | |
694 | EV will grab the signal for the process (the kernel only allows one |
713 | EV will grab the signal for the process (the kernel only allows one |
695 | component to receive a signal at a time) when you start a signal watcher, |
714 | component to receive a signal at a time) when you start a signal watcher, |
696 | and removes it again when you stop it. Perl does the same when you |
715 | and removes it again when you stop it. Perl does the same when you |
697 | add/remove callbacks to C<%SIG>, so watch out. |
716 | add/remove callbacks to C<%SIG>, so watch out. |