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.106 by root, Thu Oct 23 04:56:49 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::libev>) 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
70Perl. 71Perl.
71 72
73=head2 MODULE EXPORTS
74
75This module does not export any symbols.
76
72=cut 77=cut
73 78
74package EV; 79package EV;
75 80
81no warnings;
76use strict; 82use strict;
77 83
78BEGIN { 84BEGIN {
79 our $VERSION = '3.42'; 85 our $VERSION = '3.45';
80 use XSLoader; 86 use XSLoader;
81 XSLoader::load "EV", $VERSION; 87 XSLoader::load "EV", $VERSION;
82} 88}
83 89
84@EV::IO::ISA = 90@EV::IO::ISA =
… …
121 127
122=over 4 128=over 4
123 129
124=item $loop = new EV::loop [$flags] 130=item $loop = new EV::loop [$flags]
125 131
126Create a new event loop as per the specified flags. Please refer to the 132Create a new event loop as per the specified flags. Please refer to
127C<ev_loop_new ()> function description in the libev documentation 133the 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>) 134(L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#GLOBAL_FUNCTIONS>,
129for more info. 135or locally-installed as F<EV::libev> manpage) for more info.
130 136
131The loop will automatically be destroyed when it is no longer referenced 137The loop will automatically be destroyed when it is no longer referenced
132by any watcher and the loop object goes out of scope. 138by any watcher and the loop object goes out of scope.
133 139
134Using C<EV::FLAG_FORKCHECK> is recommended, as only the default event loop 140If you are not embedding the loop, then Using C<EV::FLAG_FORKCHECK>
135is protected by this module. 141is recommended, as only the default event loop is protected by this
142module. If you I<are> embedding this loop in the default loop, this is not
143necessary, as C<EV::embed> automatically does the right thing on fork.
136 144
137=item $loop->loop_fork 145=item $loop->loop_fork
138 146
139Must be called after a fork in the child, before entering or continuing 147Must 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 148the event loop. An alternative is to use C<EV::FLAG_FORKCHECK> which calls
… …
279 287
280=item $loop->set_timeout_collect_interval ($time) 288=item $loop->set_timeout_collect_interval ($time)
281 289
282These advanced functions set the minimum block interval when polling for I/O events and the minimum 290These 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 291wait 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 292L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#FUNCTIONS_CONTROLLING_THE_EVENT_LOOP>
285a more detailed discussion. 293(locally installed as F<EV::libev>) for a more detailed discussion.
286 294
287=back 295=back
288 296
289 297
290=head1 WATCHER OBJECTS 298=head1 WATCHER OBJECTS
… …
954loop, other types of watchers might be handled in a delayed or incorrect 962loop, other types of watchers might be handled in a delayed or incorrect
955fashion and must not be used). 963fashion and must not be used).
956 964
957See the libev documentation at 965See the libev documentation at
958L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#code_ev_embed_code_when_one_backend_> 966L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#code_ev_embed_code_when_one_backend_>
959for more details. 967(locally installed as F<EV::libev>) for more details.
960 968
961In short, this watcher is most useful on BSD systems without working 969In short, this watcher is most useful on BSD systems without working
962kqueue to still be able to handle a large number of sockets: 970kqueue to still be able to handle a large number of sockets:
963 971
964 my $socket_loop; 972 my $socket_loop;
… …
975 # use the default loop otherwise 983 # use the default loop otherwise
976 $socket_loop ||= EV::default_loop; 984 $socket_loop ||= EV::default_loop;
977 985
978=over 4 986=over 4
979 987
980=item $w = EV::embed $otherloop, $callback 988=item $w = EV::embed $otherloop[, $callback]
981 989
982=item $w = EV::embed_ns $otherloop, $callback 990=item $w = EV::embed_ns $otherloop[, $callback]
983 991
984=item $w = $loop->embed ($otherloop, $callback) 992=item $w = $loop->embed ($otherloop[, $callback])
985 993
986=item $w = $loop->embed_ns ($otherloop, $callback) 994=item $w = $loop->embed_ns ($otherloop[, $callback])
987 995
988Call the callback when the embedded event loop (C<$otherloop>) has any 996Call 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 997I/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 998embedded event loop will be managed automatically (which is recommended),
991automatically. 999otherwise you have to invoke C<sweep> yourself.
992 1000
993The C<embed_ns> variant doesn't start (activate) the newly created watcher. 1001The C<embed_ns> variant doesn't start (activate) the newly created watcher.
994 1002
995=back 1003=back
996 1004

Diff Legend

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