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

Comparing EV/EV.pm (file contents):
Revision 1.126 by root, Tue Mar 16 17:11:48 2010 UTC vs.
Revision 1.132 by root, Thu Dec 30 07:28:47 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
… …
68can use it through the L<AnyEvent> module, stay portable to other event 77can use it through the L<AnyEvent> module, stay portable to other event
69loops (if you don't rely on any watcher types not available through it) 78loops (if you don't rely on any watcher types not available through it)
70and still be faster than with any other event loop currently supported in 79and still be faster than with any other event loop currently supported in
71Perl. 80Perl.
72 81
82=head2 PORTING FROM EV 3.X to 4.X
83
84EV version 4 introduces a number of incompatible changes summarised
85here. According to the depreciation strategy used by libev, there is a
86compatibility 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
88updated).
89
90This compatibility layer will be switched off in some future release.
91
92All changes relevant to Perl are renames of symbols, functions and
93methods:
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
110The loop object methods corresponding to the functions above have been
111similarly renamed.
112
73=head2 MODULE EXPORTS 113=head2 MODULE EXPORTS
74 114
75This module does not export any symbols. 115This module does not export any symbols.
76 116
77=cut 117=cut
… …
79package EV; 119package EV;
80 120
81use common::sense; 121use common::sense;
82 122
83BEGIN { 123BEGIN {
84 our $VERSION = '4.00'; 124 our $VERSION = '4.02';
85 use XSLoader; 125 use XSLoader;
86 XSLoader::load "EV", $VERSION; 126 XSLoader::load "EV", $VERSION;
87} 127}
88 128
89@EV::IO::ISA = 129@EV::IO::ISA =
… …
941=item $w = $loop->check_ns ($callback) 981=item $w = $loop->check_ns ($callback)
942 982
943Call the callback just after the process wakes up again (after it has 983Call the callback just after the process wakes up again (after it has
944gathered events), but before any other callbacks have been invoked. 984gathered events), but before any other callbacks have been invoked.
945 985
946This is used to integrate other event-based software into the EV 986This can be used to integrate other event-based software into the EV
947mainloop: You register a prepare callback and in there, you create io and 987mainloop: You register a prepare callback and in there, you create io and
948timer watchers as required by the other software. Here is a real-world 988timer watchers as required by the other software. Here is a real-world
949example of integrating Net::SNMP (with some details left out): 989example of integrating Net::SNMP (with some details left out):
950 990
951 our @snmp_watcher; 991 our @snmp_watcher;
… …
985The callbacks of the created watchers will not be called as the watchers 1025The callbacks of the created watchers will not be called as the watchers
986are destroyed before this can happen (remember EV::check gets called 1026are destroyed before this can happen (remember EV::check gets called
987first). 1027first).
988 1028
989The C<check_ns> variant doesn't start (activate) the newly created watcher. 1029The C<check_ns> variant doesn't start (activate) the newly created watcher.
1030
1031=item EV::CHECK constant issues
1032
1033Like all other watcher types, there is a bitmask constant for use in
1034C<$revents> and other places. The C<EV::CHECK> is special as it has
1035the same name as the C<CHECK> sub called by Perl. This doesn't cause
1036big issues on newer perls (beginning with 5.8.9), but it means thatthe
1037constant must be I<inlined>, i.e. runtime calls will not work. That means
1038that as long as you always C<use EV> and then C<EV::CHECK> you are on the
1039safe 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
… …
1138 1188
11391; 11891;
1140 1190
1141=head1 SEE ALSO 1191=head1 SEE ALSO
1142 1192
1193L<EV::MakeMaker> - MakeMaker interface to XS API, L<EV::ADNS>
1143L<EV::ADNS> (asynchronous DNS), L<Glib::EV> (makes Glib/Gtk2 use EV as 1194(asynchronous DNS), L<Glib::EV> (makes Glib/Gtk2 use EV as event
1144event loop), L<EV::Glib> (embed Glib into EV), L<Coro::EV> (efficient 1195loop), L<EV::Glib> (embed Glib into EV), L<Coro::EV> (efficient thread
1145coroutines with EV), L<Net::SNMP::EV> (asynchronous SNMP), L<AnyEvent> for 1196integration), L<Net::SNMP::EV> (asynchronous SNMP), L<AnyEvent> for
1146event-loop agnostic and portable event driven programming. 1197event-loop agnostic and portable event driven programming.
1147 1198
1148=head1 AUTHOR 1199=head1 AUTHOR
1149 1200
1150 Marc Lehmann <schmorp@schmorp.de> 1201 Marc Lehmann <schmorp@schmorp.de>

Diff Legend

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