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

Comparing EV/EV.pm (file contents):
Revision 1.92 by root, Sun May 18 10:45:36 2008 UTC vs.
Revision 1.106 by root, Thu Oct 23 04:56:49 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://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.33'; 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 =
… …
111default loop as this is fastest (perl-wise), best supported by other 117default loop as this is fastest (perl-wise), best supported by other
112modules (e.g. AnyEvent or Coro) and most portable event loop. 118modules (e.g. AnyEvent or Coro) and most portable event loop.
113 119
114For specific programs you can create additional event loops dynamically. 120For specific programs you can create additional event loops dynamically.
115 121
122If you want to take avdantage of kqueue (which often works properly for
123sockets only) even though the default loop doesn't enable it, you can
124I<embed> a kqueue loop into the default loop: running the default loop
125will then also service the kqueue loop to some extent. See the example in
126the section about embed watchers for an example on how to achieve that.
127
116=over 4 128=over 4
117 129
118=item $loop = new EV::loop [$flags] 130=item $loop = new EV::loop [$flags]
119 131
120Create 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
121C<ev_loop_new ()> function description in the libev documentation 133the C<ev_loop_new ()> function description in the libev documentation
122(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>,
123for more info. 135or locally-installed as F<EV::libev> manpage) for more info.
124 136
125The loop will automatically be destroyed when it is no longer referenced 137The loop will automatically be destroyed when it is no longer referenced
126by any watcher and the loop object goes out of scope. 138by any watcher and the loop object goes out of scope.
127 139
128Using 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>
129is 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.
130 144
131=item $loop->loop_fork 145=item $loop->loop_fork
132 146
133Must 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
134the 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
135this fucntion automatically, at some performance loss (refer to the libev 149this function automatically, at some performance loss (refer to the libev
136documentation). 150documentation).
137 151
152=item $loop->loop_verify
153
154Calls C<ev_verify> to make internal consistency checks (for debugging
155libev) and abort the program if any data structures were found to be
156corrupted.
157
138=item $loop = EV::default_loop [$flags] 158=item $loop = EV::default_loop [$flags]
139 159
140Return the default loop (which is a singleton object). 160Return the default loop (which is a singleton object). Since this module
161already creates the default loop with default flags, specifying flags here
162will not have any effect unless you destroy the default loop first, which
163isn't supported. So in short: don't do it, and if you break it, you get to
164keep the pieces.
141 165
142=back 166=back
143 167
144 168
145=head1 BASIC INTERFACE 169=head1 BASIC INTERFACE
… …
263 287
264=item $loop->set_timeout_collect_interval ($time) 288=item $loop->set_timeout_collect_interval ($time)
265 289
266These 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
267wait interval for timer events. See the libev documentation at 291wait interval for timer events. See the libev documentation at
268L<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>
269a more detailed discussion. 293(locally installed as F<EV::libev>) for a more detailed discussion.
270 294
271=back 295=back
272 296
273 297
274=head1 WATCHER OBJECTS 298=head1 WATCHER OBJECTS
275 299
276A watcher is an object that gets created to record your interest in some 300A watcher is an object that gets created to record your interest in some
277event. For instance, if you want to wait for STDIN to become readable, you 301event. For instance, if you want to wait for STDIN to become readable, you
278would create an EV::io watcher for that: 302would create an EV::io watcher for that:
279 303
280 my $watcher = EV::io *STDIN, EV::READ, sub { 304 my $watcher = EV::io *STDIN, EV::READ, sub {
281 my ($watcher, $revents) = @_; 305 my ($watcher, $revents) = @_;
282 warn "yeah, STDIN should now be readable without blocking!\n" 306 warn "yeah, STDIN should now be readable without blocking!\n"
283 }; 307 };
284 308
285All watchers can be active (waiting for events) or inactive (paused). Only 309All watchers can be active (waiting for events) or inactive (paused). Only
286active watchers will have their callbacks invoked. All callbacks will be 310active watchers will have their callbacks invoked. All callbacks will be
287called with at least two arguments: the watcher and a bitmask of received 311called with at least two arguments: the watcher and a bitmask of received
288events. 312events.
… …
401Example: Register an I/O watcher for some UDP socket but do not keep the 425Example: Register an I/O watcher for some UDP socket but do not keep the
402event loop from running just because of that watcher. 426event loop from running just because of that watcher.
403 427
404 my $udp_socket = ... 428 my $udp_socket = ...
405 my $udp_watcher = EV::io $udp_socket, EV::READ, sub { ... }; 429 my $udp_watcher = EV::io $udp_socket, EV::READ, sub { ... };
406 $1000udp_watcher->keepalive (0); 430 $udp_watcher->keepalive (0);
407 431
408=item $loop = $w->loop 432=item $loop = $w->loop
409 433
410Return the loop that this watcher is attached to. 434Return the loop that this watcher is attached to.
411 435
… …
568time the periodic watcher gets scheduled, the reschedule callback 592time the periodic watcher gets scheduled, the reschedule callback
569($reschedule_cb) will be called with the watcher as first, and the current 593($reschedule_cb) will be called with the watcher as first, and the current
570time as second argument. 594time as second argument.
571 595
572I<This callback MUST NOT stop or destroy this or any other periodic 596I<This callback MUST NOT stop or destroy this or any other periodic
573watcher, ever>. If you need to stop it, return 1e30 and stop it 597watcher, ever, and MUST NOT call any event loop functions or methods>. If
574afterwards. 598you need to stop it, return 1e30 and stop it afterwards. You may create
599and start a C<EV::prepare> watcher for this task.
575 600
576It must return the next time to trigger, based on the passed time value 601It must return the next time to trigger, based on the passed time value
577(that is, the lowest time value larger than to the second argument). It 602(that is, the lowest time value larger than or equal to to the second
578will usually be called just before the callback will be triggered, but 603argument). It will usually be called just before the callback will be
579might be called at other times, too. 604triggered, but might be called at other times, too.
580 605
581This can be used to create very complex timers, such as a timer that 606This can be used to create very complex timers, such as a timer that
582triggers on each midnight, local time (actually 24 hours after the last 607triggers on each midnight, local time (actually 24 hours after the last
583midnight, to keep the example simple. If you know a way to do it correctly 608midnight, to keep the example simple. If you know a way to do it correctly
584in about the same space (without requiring elaborate modules), drop me a 609in about the same space (without requiring elaborate modules), drop me a
… …
937loop, 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
938fashion and must not be used). 963fashion and must not be used).
939 964
940See the libev documentation at 965See the libev documentation at
941L<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_>
942for more details. 967(locally installed as F<EV::libev>) for more details.
943 968
944In short, this watcher is most useful on BSD systems without working 969In short, this watcher is most useful on BSD systems without working
945kqueue to still be able to handle a large number of sockets: 970kqueue to still be able to handle a large number of sockets:
946 971
947 my $socket_loop; 972 my $socket_loop;
948 973
949 # check wether we use SELECT or POLL _and_ KQUEUE is supported 974 # check wether we use SELECT or POLL _and_ KQUEUE is supported
950 if ( 975 if (
951 (EV::backend & (EV::BACKEND_POLL | EV::BACKEND_SELECT)) 976 (EV::backend & (EV::BACKEND_POLL | EV::BACKEND_SELECT))
952 && (EV::supported_backends & EV::embeddable_backends & EV::BACKEND_KQUEUE) 977 && (EV::supported_backends & EV::embeddable_backends & EV::BACKEND_KQUEUE)
953 ) { 978 ) {
954 # use kqueue for sockets 979 # use kqueue for sockets
955 $socket_loop = new EV::Loop EV::BACKEND_KQUEUE | EV::FLAG_NOENV; 980 $socket_loop = new EV::Loop EV::BACKEND_KQUEUE | EV::FLAG_NOENV;
956 } 981 }
957 982
958 # use the default loop otherwise 983 # use the default loop otherwise
959 $socket_loop ||= EV::default_loop; 984 $socket_loop ||= EV::default_loop;
960 985
961=over 4 986=over 4
962 987
963=item $w = EV::embed $otherloop, $callback 988=item $w = EV::embed $otherloop[, $callback]
964 989
965=item $w = EV::embed_ns $otherloop, $callback 990=item $w = EV::embed_ns $otherloop[, $callback]
966 991
967=item $w = $loop->embed ($otherloop, $callback) 992=item $w = $loop->embed ($otherloop[, $callback])
968 993
969=item $w = $loop->embed_ns ($otherloop, $callback) 994=item $w = $loop->embed_ns ($otherloop[, $callback])
970 995
971Call the callback when the embedded event loop (C<$otherloop>) has any 996Call the callback when the embedded event loop (C<$otherloop>) has any
972I/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
973this version of EV, which means the embedded event loop will be managed 998embedded event loop will be managed automatically (which is recommended),
974automatically. 999otherwise you have to invoke C<sweep> yourself.
975 1000
976The 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.
977 1002
978=back 1003=back
979 1004
… …
1060coroutines with EV), L<Net::SNMP::EV> (asynchronous SNMP), L<AnyEvent> for 1085coroutines with EV), L<Net::SNMP::EV> (asynchronous SNMP), L<AnyEvent> for
1061event-loop agnostic and portable event driven programming. 1086event-loop agnostic and portable event driven programming.
1062 1087
1063=head1 AUTHOR 1088=head1 AUTHOR
1064 1089
1065 Marc Lehmann <schmorp@schmorp.de> 1090 Marc Lehmann <schmorp@schmorp.de>
1066 http://home.schmorp.de/ 1091 http://home.schmorp.de/
1067 1092
1068=cut 1093=cut
1069 1094

Diff Legend

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