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

Comparing EV/EV.pm (file contents):
Revision 1.99 by root, Tue Jul 8 09:37:37 2008 UTC vs.
Revision 1.104 by root, Thu Oct 2 12:26:25 2008 UTC

… …
55 55
56=head1 DESCRIPTION 56=head1 DESCRIPTION
57 57
58This module provides an interface to libev 58This module provides an interface to libev
59(L<http://software.schmorp.de/pkg/libev.html>). While the documentation 59(L<http://software.schmorp.de/pkg/libev.html>). While the documentation
60below is comprehensive, one might also consult the documentation of libev 60below is comprehensive, one might also consult the documentation of
61itself (L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod>) for more 61libev itself (L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod> or
62subtle details on watcher semantics or some discussion on the available 62F<perldoc EV::c_doc>) for more subtle details on watcher semantics or some
63backends, or how to force a specific backend with C<LIBEV_FLAGS>, or just 63discussion on the available backends, or how to force a specific backend
64about in any case because it has much more detailed information. 64with C<LIBEV_FLAGS>, or just about in any case because it has much more
65detailed information.
65 66
66This module is very fast and scalable. It is actually so fast that you 67This module is very fast and scalable. It is actually so fast that you
67can use it through the L<AnyEvent> module, stay portable to other event 68can use it through the L<AnyEvent> module, stay portable to other event
68loops (if you don't rely on any watcher types not available through it) 69loops (if you don't rely on any watcher types not available through it)
69and still be faster than with any other event loop currently supported in 70and still be faster than with any other event loop currently supported in
… …
71 72
72=cut 73=cut
73 74
74package EV; 75package EV;
75 76
77no warnings;
76use strict; 78use strict;
77 79
78BEGIN { 80BEGIN {
79 our $VERSION = '3.42'; 81 our $VERSION = '3.44';
80 use XSLoader; 82 use XSLoader;
81 XSLoader::load "EV", $VERSION; 83 XSLoader::load "EV", $VERSION;
82} 84}
83 85
84@EV::IO::ISA = 86@EV::IO::ISA =
… …
121 123
122=over 4 124=over 4
123 125
124=item $loop = new EV::loop [$flags] 126=item $loop = new EV::loop [$flags]
125 127
126Create a new event loop as per the specified flags. Please refer to the 128Create a new event loop as per the specified flags. Please refer to
127C<ev_loop_new ()> function description in the libev documentation 129the C<ev_loop_new ()> function description in the libev documentation
128(L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#GLOBAL_FUNCTIONS>) 130(L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#GLOBAL_FUNCTIONS>,
129for more info. 131or locally-installed as F<EV::c_doc> manpage) for more info.
130 132
131The loop will automatically be destroyed when it is no longer referenced 133The loop will automatically be destroyed when it is no longer referenced
132by any watcher and the loop object goes out of scope. 134by any watcher and the loop object goes out of scope.
133 135
134Using C<EV::FLAG_FORKCHECK> is recommended, as only the default event loop 136If you are not embedding the loop, then Using C<EV::FLAG_FORKCHECK>
135is protected by this module. 137is recommended, as only the default event loop is protected by this
138module. If you I<are> embedding this loop in the default loop, this is not
139necessary, as C<EV::embed> automatically does the right thing on fork.
136 140
137=item $loop->loop_fork 141=item $loop->loop_fork
138 142
139Must be called after a fork in the child, before entering or continuing 143Must be called after a fork in the child, before entering or continuing
140the event loop. An alternative is to use C<EV::FLAG_FORKCHECK> which calls 144the event loop. An alternative is to use C<EV::FLAG_FORKCHECK> which calls
… …
279 283
280=item $loop->set_timeout_collect_interval ($time) 284=item $loop->set_timeout_collect_interval ($time)
281 285
282These advanced functions set the minimum block interval when polling for I/O events and the minimum 286These advanced functions set the minimum block interval when polling for I/O events and the minimum
283wait interval for timer events. See the libev documentation at 287wait interval for timer events. See the libev documentation at
284L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#FUNCTIONS_CONTROLLING_THE_EVENT_LOOP> for 288L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#FUNCTIONS_CONTROLLING_THE_EVENT_LOOP>
285a more detailed discussion. 289(locally installed as F<EV::c_doc>) for a more detailed discussion.
286 290
287=back 291=back
288 292
289 293
290=head1 WATCHER OBJECTS 294=head1 WATCHER OBJECTS
… …
954loop, other types of watchers might be handled in a delayed or incorrect 958loop, other types of watchers might be handled in a delayed or incorrect
955fashion and must not be used). 959fashion and must not be used).
956 960
957See the libev documentation at 961See the libev documentation at
958L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#code_ev_embed_code_when_one_backend_> 962L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#code_ev_embed_code_when_one_backend_>
959for more details. 963(locally installed as F<EV::c_doc>) for more details.
960 964
961In short, this watcher is most useful on BSD systems without working 965In short, this watcher is most useful on BSD systems without working
962kqueue to still be able to handle a large number of sockets: 966kqueue to still be able to handle a large number of sockets:
963 967
964 my $socket_loop; 968 my $socket_loop;
… …
975 # use the default loop otherwise 979 # use the default loop otherwise
976 $socket_loop ||= EV::default_loop; 980 $socket_loop ||= EV::default_loop;
977 981
978=over 4 982=over 4
979 983
980=item $w = EV::embed $otherloop, $callback 984=item $w = EV::embed $otherloop[, $callback]
981 985
982=item $w = EV::embed_ns $otherloop, $callback 986=item $w = EV::embed_ns $otherloop[, $callback]
983 987
984=item $w = $loop->embed ($otherloop, $callback) 988=item $w = $loop->embed ($otherloop[, $callback])
985 989
986=item $w = $loop->embed_ns ($otherloop, $callback) 990=item $w = $loop->embed_ns ($otherloop[, $callback])
987 991
988Call the callback when the embedded event loop (C<$otherloop>) has any 992Call the callback when the embedded event loop (C<$otherloop>) has any
989I/O activity. The C<$callback> should alwas be specified as C<undef> in 993I/O activity. The C<$callback> is optional: if it is missing, then the
990this version of EV, which means the embedded event loop will be managed 994embedded event loop will be managed automatically (which is recommended),
991automatically. 995otherwise you have to invoke C<sweep> yourself.
992 996
993The C<embed_ns> variant doesn't start (activate) the newly created watcher. 997The C<embed_ns> variant doesn't start (activate) the newly created watcher.
994 998
995=back 999=back
996 1000

Diff Legend

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