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

Comparing EV/EV.pm (file contents):
Revision 1.118 by root, Tue Jul 14 20:31:21 2009 UTC vs.
Revision 1.127 by root, Sun Mar 28 15:48:21 2010 UTC

… …
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
58If you only need timer, I/O, signal, child and idle watchers and not the
59advanced functionality of this module, consider using L<AnyEvent> instead,
60specifically the simplified API described in L<AE>.
61
62When used with EV as backend, the L<AE> API is as fast as the native L<EV>
63API, but your programs/modules will still run with many other event loops.
64
56=head1 DESCRIPTION 65=head1 DESCRIPTION
57 66
58This module provides an interface to libev 67This 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
60below is comprehensive, one might also consult the documentation of 69below is comprehensive, one might also consult the documentation of
… …
79package EV; 88package EV;
80 89
81use common::sense; 90use common::sense;
82 91
83BEGIN { 92BEGIN {
84 our $VERSION = '3.7'; 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 =
… …
299timeout. Otherwise a EV::timer with this value will be started. 308timeout. Otherwise a EV::timer with this value will be started.
300 309
301When an error occurs or either the timeout or I/O watcher triggers, then 310When an error occurs or either the timeout or I/O watcher triggers, then
302the callback will be called with the received event set (in general 311the callback will be called with the received event set (in general
303you can expect it to be a combination of C<EV::ERROR>, C<EV::READ>, 312you can expect it to be a combination of C<EV::ERROR>, C<EV::READ>,
304C<EV::WRITE> and C<EV::TIMEOUT>). 313C<EV::WRITE> and C<EV::TIMER>).
305 314
306EV::once doesn't return anything: the watchers stay active till either 315EV::once doesn't return anything: the watchers stay active till either
307of them triggers, then they will be stopped and freed, and the callback 316of them triggers, then they will be stopped and freed, and the callback
308invoked. 317invoked.
309 318
… …
331These advanced functions set the minimum block interval when polling for I/O events and the minimum 340These 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 341wait 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> 342L<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. 343(locally installed as F<EV::libev>) for a more detailed discussion.
335 344
345=item $count = EV::pending_count
346
347=item $count = $loop->pending_count
348
349Returns the number of currently pending watchers.
350
351=item EV::invoke_pending
352
353=item $loop->invoke_pending
354
355Invoke all currently pending watchers.
356
336=back 357=back
337 358
338 359
339=head1 WATCHER OBJECTS 360=head1 WATCHER OBJECTS
340 361
… …
354 375
355Each watcher type has its associated bit in revents, so you can use the 376Each watcher type has its associated bit in revents, so you can use the
356same callback for multiple watchers. The event mask is named after the 377same callback for multiple watchers. The event mask is named after the
357type, i.e. EV::child sets EV::CHILD, EV::prepare sets EV::PREPARE, 378type, i.e. EV::child sets EV::CHILD, EV::prepare sets EV::PREPARE,
358EV::periodic sets EV::PERIODIC and so on, with the exception of I/O events 379EV::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 380(which can set both EV::READ and EV::WRITE bits).
360uses EV::TIMEOUT).
361 381
362In the rare case where one wants to create a watcher but not start it at 382In the rare case where one wants to create a watcher but not start it at
363the same time, each constructor has a variant with a trailing C<_ns> in 383the same time, each constructor has a variant with a trailing C<_ns> in
364its name, e.g. EV::io has a non-starting variant EV::io_ns and so on. 384its name, e.g. EV::io has a non-starting variant EV::io_ns and so on.
365 385
… …
444 464
445=item $previous_state = $w->keepalive ($bool) 465=item $previous_state = $w->keepalive ($bool)
446 466
447Normally, C<EV::loop> will return when there are no active watchers 467Normally, 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 468(which is a "deadlock" because no progress can be made anymore). This is
449convinient because it allows you to start your watchers (and your jobs), 469convenient because it allows you to start your watchers (and your jobs),
450call C<EV::loop> once and when it returns you know that all your jobs are 470call C<EV::loop> once and when it returns you know that all your jobs are
451finished (or they forgot to register some watchers for their task :). 471finished (or they forgot to register some watchers for their task :).
452 472
453Sometimes, however, this gets in your way, for example when the module 473Sometimes, however, this gets in your way, for example when the module
454that calls C<EV::loop> (usually the main program) is not the same module 474that calls C<EV::loop> (usually the main program) is not the same module
… …
686 706
687=item $w = EV::signal $signal, $callback 707=item $w = EV::signal $signal, $callback
688 708
689=item $w = EV::signal_ns $signal, $callback 709=item $w = EV::signal_ns $signal, $callback
690 710
711=item $w = $loop->signal ($signal, $callback)
712
713=item $w = $loop->signal_ns ($signal, $callback)
714
691Call the callback when $signal is received (the signal can be specified by 715Call the callback when $signal is received (the signal can be specified by
692number or by name, just as with C<kill> or C<%SIG>). 716number or by name, just as with C<kill> or C<%SIG>).
717
718Only one event loop can grab a given signal - attempting to grab the same
719signal from two EV loops will crash the program immediately or cause data
720corruption.
693 721
694EV will grab the signal for the process (the kernel only allows one 722EV will grab the signal for the process (the kernel only allows one
695component to receive a signal at a time) when you start a signal watcher, 723component to receive a signal at a time) when you start a signal watcher,
696and removes it again when you stop it. Perl does the same when you 724and removes it again when you stop it. Perl does the same when you
697add/remove callbacks to C<%SIG>, so watch out. 725add/remove callbacks to C<%SIG>, so watch out.

Diff Legend

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