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

Comparing EV/EV.pm (file contents):
Revision 1.85 by root, Sat Mar 8 16:00:07 2008 UTC vs.
Revision 1.105 by root, Thu Oct 2 12:27:55 2008 UTC

… …
2 2
3EV - perl interface to libev, a high performance full-featured event loop 3EV - perl interface to libev, a high performance full-featured event loop
4 4
5=head1 SYNOPSIS 5=head1 SYNOPSIS
6 6
7 use EV; 7 use EV;
8
9 # TIMERS
10
11 my $w = EV::timer 2, 0, sub {
12 warn "is called after 2s";
13 };
14
15 my $w = EV::timer 2, 2, sub {
16 warn "is called roughly every 2s (repeat = 2)";
17 };
18
19 undef $w; # destroy event watcher again
20
21 my $w = EV::periodic 0, 60, 0, sub {
22 warn "is called every minute, on the minute, exactly";
23 };
24
25 # IO
26
27 my $w = EV::io *STDIN, EV::READ, sub {
28 my ($w, $revents) = @_; # all callbacks receive the watcher and event mask
29 warn "stdin is readable, you entered: ", <STDIN>;
30 };
31
32 # SIGNALS
33
34 my $w = EV::signal 'QUIT', sub {
35 warn "sigquit received\n";
36 };
37
38 # CHILD/PID STATUS CHANGES
8 39
9 # TIMERS 40 my $w = EV::child 666, 0, sub {
41 my ($w, $revents) = @_;
42 my $status = $w->rstatus;
43 };
10 44
11 my $w = EV::timer 2, 0, sub {
12 warn "is called after 2s";
13 };
14
15 my $w = EV::timer 2, 2, sub {
16 warn "is called roughly every 2s (repeat = 2)";
17 };
18
19 undef $w; # destroy event watcher again
20
21 my $w = EV::periodic 0, 60, 0, sub {
22 warn "is called every minute, on the minute, exactly";
23 };
24
25 # IO
26
27 my $w = EV::io *STDIN, EV::READ, sub {
28 my ($w, $revents) = @_; # all callbacks receive the watcher and event mask
29 warn "stdin is readable, you entered: ", <STDIN>;
30 };
31
32 # SIGNALS
33
34 my $w = EV::signal 'QUIT', sub {
35 warn "sigquit received\n";
36 };
37
38 # CHILD/PID STATUS CHANGES
39
40 my $w = EV::child 666, 0, sub {
41 my ($w, $revents) = @_;
42 my $status = $w->rstatus;
43 };
44
45 # STAT CHANGES 45 # STAT CHANGES
46 my $w = EV::stat "/etc/passwd", 10, sub { 46 my $w = EV::stat "/etc/passwd", 10, sub {
47 my ($w, $revents) = @_; 47 my ($w, $revents) = @_;
48 warn $w->path, " has changed somehow.\n"; 48 warn $w->path, " has changed somehow.\n";
49 }; 49 };
50 50
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 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://cvs.schmorp.de/libev/ev.html>) for more subtle details on 61libev itself (L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod> or
62watcher semantics or some discussion on the available backends, or how to 62F<perldoc EV::libev>) for more subtle details on watcher semantics or some
63force a specific backend with C<LIBEV_FLAGS>, or just about in any case 63discussion on the available backends, or how to force a specific backend
64because it has much more detailed information. 64with C<LIBEV_FLAGS>, or just about in any case because it has much more
65detailed information.
66
67This module is very fast and scalable. It is actually so fast that you
68can 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)
70and still be faster than with any other event loop currently supported in
71Perl.
65 72
66=cut 73=cut
67 74
68package EV; 75package EV;
69 76
77no warnings;
70use strict; 78use strict;
71 79
72BEGIN { 80BEGIN {
73 our $VERSION = '3.1'; 81 our $VERSION = '3.44';
74 use XSLoader; 82 use XSLoader;
75 XSLoader::load "EV", $VERSION; 83 XSLoader::load "EV", $VERSION;
76} 84}
77 85
78@EV::IO::ISA = 86@EV::IO::ISA =
… …
105default loop as this is fastest (perl-wise), best supported by other 113default loop as this is fastest (perl-wise), best supported by other
106modules (e.g. AnyEvent or Coro) and most portable event loop. 114modules (e.g. AnyEvent or Coro) and most portable event loop.
107 115
108For specific programs you can create additional event loops dynamically. 116For specific programs you can create additional event loops dynamically.
109 117
118If you want to take avdantage of kqueue (which often works properly for
119sockets only) even though the default loop doesn't enable it, you can
120I<embed> a kqueue loop into the default loop: running the default loop
121will then also service the kqueue loop to some extent. See the example in
122the section about embed watchers for an example on how to achieve that.
123
110=over 4 124=over 4
111 125
112=item $loop = new EV::loop [$flags] 126=item $loop = new EV::loop [$flags]
113 127
114Create 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
115C<ev_loop_new ()> function description in the libev documentation 129the C<ev_loop_new ()> function description in the libev documentation
116(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>,
117for more info. 131or locally-installed as F<EV::libev> manpage) for more info.
118 132
119The loop will automatically be destroyed when it is no longer referenced 133The loop will automatically be destroyed when it is no longer referenced
120by any watcher and the loop object goes out of scope. 134by any watcher and the loop object goes out of scope.
121 135
122Using 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>
123is 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.
124 140
125=item $loop->loop_fork 141=item $loop->loop_fork
126 142
127Must 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
128the 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
129this fucntion automatically, at some performance loss (refer to the libev 145this function automatically, at some performance loss (refer to the libev
130documentation). 146documentation).
131 147
148=item $loop->loop_verify
149
150Calls C<ev_verify> to make internal consistency checks (for debugging
151libev) and abort the program if any data structures were found to be
152corrupted.
153
132=item $loop = EV::default_loop [$flags] 154=item $loop = EV::default_loop [$flags]
133 155
134Return the default loop (which is a singleton object). 156Return the default loop (which is a singleton object). Since this module
157already creates the default loop with default flags, specifying flags here
158will not have any effect unless you destroy the default loop first, which
159isn't supported. So in short: don't do it, and if you break it, you get to
160keep the pieces.
135 161
136=back 162=back
137 163
138 164
139=head1 BASIC INTERFACE 165=head1 BASIC INTERFACE
… …
257 283
258=item $loop->set_timeout_collect_interval ($time) 284=item $loop->set_timeout_collect_interval ($time)
259 285
260These 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
261wait interval for timer events. See the libev documentation at 287wait interval for timer events. See the libev documentation at
262L<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>
263a more detailed discussion. 289(locally installed as F<EV::libev>) for a more detailed discussion.
264 290
265=back 291=back
266 292
267 293
268=head1 WATCHER OBJECTS 294=head1 WATCHER OBJECTS
269 295
270A watcher is an object that gets created to record your interest in some 296A watcher is an object that gets created to record your interest in some
271event. For instance, if you want to wait for STDIN to become readable, you 297event. For instance, if you want to wait for STDIN to become readable, you
272would create an EV::io watcher for that: 298would create an EV::io watcher for that:
273 299
274 my $watcher = EV::io *STDIN, EV::READ, sub { 300 my $watcher = EV::io *STDIN, EV::READ, sub {
275 my ($watcher, $revents) = @_; 301 my ($watcher, $revents) = @_;
276 warn "yeah, STDIN should now be readable without blocking!\n" 302 warn "yeah, STDIN should now be readable without blocking!\n"
277 }; 303 };
278 304
279All watchers can be active (waiting for events) or inactive (paused). Only 305All watchers can be active (waiting for events) or inactive (paused). Only
280active watchers will have their callbacks invoked. All callbacks will be 306active watchers will have their callbacks invoked. All callbacks will be
281called with at least two arguments: the watcher and a bitmask of received 307called with at least two arguments: the watcher and a bitmask of received
282events. 308events.
… …
395Example: Register an I/O watcher for some UDP socket but do not keep the 421Example: Register an I/O watcher for some UDP socket but do not keep the
396event loop from running just because of that watcher. 422event loop from running just because of that watcher.
397 423
398 my $udp_socket = ... 424 my $udp_socket = ...
399 my $udp_watcher = EV::io $udp_socket, EV::READ, sub { ... }; 425 my $udp_watcher = EV::io $udp_socket, EV::READ, sub { ... };
400 $1000udp_watcher->keepalive (0); 426 $udp_watcher->keepalive (0);
401 427
402=item $loop = $w->loop 428=item $loop = $w->loop
403 429
404Return the loop that this watcher is attached to. 430Return the loop that this watcher is attached to.
405 431
… …
562time the periodic watcher gets scheduled, the reschedule callback 588time the periodic watcher gets scheduled, the reschedule callback
563($reschedule_cb) will be called with the watcher as first, and the current 589($reschedule_cb) will be called with the watcher as first, and the current
564time as second argument. 590time as second argument.
565 591
566I<This callback MUST NOT stop or destroy this or any other periodic 592I<This callback MUST NOT stop or destroy this or any other periodic
567watcher, ever>. If you need to stop it, return 1e30 and stop it 593watcher, ever, and MUST NOT call any event loop functions or methods>. If
568afterwards. 594you need to stop it, return 1e30 and stop it afterwards. You may create
595and start a C<EV::prepare> watcher for this task.
569 596
570It must return the next time to trigger, based on the passed time value 597It must return the next time to trigger, based on the passed time value
571(that is, the lowest time value larger than to the second argument). It 598(that is, the lowest time value larger than or equal to to the second
572will usually be called just before the callback will be triggered, but 599argument). It will usually be called just before the callback will be
573might be called at other times, too. 600triggered, but might be called at other times, too.
574 601
575This can be used to create very complex timers, such as a timer that 602This can be used to create very complex timers, such as a timer that
576triggers on each midnight, local time (actually 24 hours after the last 603triggers on each midnight, local time (actually 24 hours after the last
577midnight, to keep the example simple. If you know a way to do it correctly 604midnight, to keep the example simple. If you know a way to do it correctly
578in about the same space (without requiring elaborate modules), drop me a 605in about the same space (without requiring elaborate modules), drop me a
… …
931loop, 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
932fashion and must not be used). 959fashion and must not be used).
933 960
934See the libev documentation at 961See the libev documentation at
935L<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_>
936for more details. 963(locally installed as F<EV::libev>) for more details.
937 964
938In short, this watcher is most useful on BSD systems without working 965In short, this watcher is most useful on BSD systems without working
939kqueue to still be able to handle a large number of sockets: 966kqueue to still be able to handle a large number of sockets:
940 967
941 my $socket_loop; 968 my $socket_loop;
942 969
943 # check wether we use SELECT or POLL _and_ KQUEUE is supported 970 # check wether we use SELECT or POLL _and_ KQUEUE is supported
944 if ( 971 if (
945 (EV::backend & (EV::BACKEND_POLL | EV::BACKEND_SELECT)) 972 (EV::backend & (EV::BACKEND_POLL | EV::BACKEND_SELECT))
946 && (EV::supported_backends & EV::embeddable_backends & EV::BACKEND_KQUEUE) 973 && (EV::supported_backends & EV::embeddable_backends & EV::BACKEND_KQUEUE)
947 ) { 974 ) {
948 # use kqueue for sockets 975 # use kqueue for sockets
949 $socket_loop = new EV::Loop EV::BACKEND_KQUEUE | EV::FLAG_NOENV; 976 $socket_loop = new EV::Loop EV::BACKEND_KQUEUE | EV::FLAG_NOENV;
950 } 977 }
951 978
952 # use the default loop otherwise 979 # use the default loop otherwise
953 $socket_loop ||= EV::default_loop; 980 $socket_loop ||= EV::default_loop;
954 981
955=over 4 982=over 4
956 983
957=item $w = EV::embed $otherloop, $callback 984=item $w = EV::embed $otherloop[, $callback]
958 985
959=item $w = EV::embed_ns $otherloop, $callback 986=item $w = EV::embed_ns $otherloop[, $callback]
960 987
961=item $w = $loop->embed ($otherloop, $callback) 988=item $w = $loop->embed ($otherloop[, $callback])
962 989
963=item $w = $loop->embed_ns ($otherloop, $callback) 990=item $w = $loop->embed_ns ($otherloop[, $callback])
964 991
965Call the callback when the embedded event loop (C<$otherloop>) has any 992Call the callback when the embedded event loop (C<$otherloop>) has any
966I/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
967this version of EV, which means the embedded event loop will be managed 994embedded event loop will be managed automatically (which is recommended),
968automatically. 995otherwise you have to invoke C<sweep> yourself.
969 996
970The 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.
971 998
972=back 999=back
973 1000
… …
978contexts where they could be of value. 1005contexts where they could be of value.
979 1006
980It is, however, possible to use them from the XS level. 1007It is, however, possible to use them from the XS level.
981 1008
982Please see the libev documentation for further details. 1009Please see the libev documentation for further details.
1010
1011=over 4
1012
1013=item $w = EV::async $callback
1014
1015=item $w = EV::async_ns $callback
1016
1017=item $w->send
1018
1019=item $bool = $w->async_pending
1020
1021=back
983 1022
984 1023
985=head1 PERL SIGNALS 1024=head1 PERL SIGNALS
986 1025
987While Perl signal handling (C<%SIG>) is not affected by EV, the behaviour 1026While Perl signal handling (C<%SIG>) is not affected by EV, the behaviour
… …
1037 1076
1038=head1 SEE ALSO 1077=head1 SEE ALSO
1039 1078
1040L<EV::ADNS> (asynchronous DNS), L<Glib::EV> (makes Glib/Gtk2 use EV as 1079L<EV::ADNS> (asynchronous DNS), L<Glib::EV> (makes Glib/Gtk2 use EV as
1041event loop), L<EV::Glib> (embed Glib into EV), L<Coro::EV> (efficient 1080event loop), L<EV::Glib> (embed Glib into EV), L<Coro::EV> (efficient
1042coroutines with EV), L<Net::SNMP::EV> (asynchronous SNMP). 1081coroutines with EV), L<Net::SNMP::EV> (asynchronous SNMP), L<AnyEvent> for
1082event-loop agnostic and portable event driven programming.
1043 1083
1044=head1 AUTHOR 1084=head1 AUTHOR
1045 1085
1046 Marc Lehmann <schmorp@schmorp.de> 1086 Marc Lehmann <schmorp@schmorp.de>
1047 http://home.schmorp.de/ 1087 http://home.schmorp.de/
1048 1088
1049=cut 1089=cut
1050 1090

Diff Legend

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