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

Comparing EV/EV.pm (file contents):
Revision 1.124 by root, Tue Dec 1 13:56:33 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.8'; 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
… …
366 375
367Each 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
368same callback for multiple watchers. The event mask is named after the 377same callback for multiple watchers. The event mask is named after the
369type, 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,
370EV::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
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).
372uses EV::TIMEOUT).
373 381
374In 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
375the 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
376its 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.
377 385

Diff Legend

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