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

Comparing EV/EV.pm (file contents):
Revision 1.89 by root, Wed Apr 16 18:49:49 2008 UTC vs.
Revision 1.102 by root, Mon Sep 8 17:27:42 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 libev
61itself (L<http://cvs.schmorp.de/libev/ev.html>) for more subtle details on 61itself (L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod>) for more
62watcher semantics or some discussion on the available backends, or how to 62subtle details on watcher semantics or some discussion on the available
63force a specific backend with C<LIBEV_FLAGS>, or just about in any case 63backends, or how to force a specific backend with C<LIBEV_FLAGS>, or just
64because it has much more detailed information. 64about in any case because it has much more detailed information.
65
66This 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
68loops (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
70Perl.
65 71
66=cut 72=cut
67 73
68package EV; 74package EV;
69 75
76no warnings;
70use strict; 77use strict;
71 78
72BEGIN { 79BEGIN {
73 our $VERSION = '3.31'; 80 our $VERSION = '3.44';
74 use XSLoader; 81 use XSLoader;
75 XSLoader::load "EV", $VERSION; 82 XSLoader::load "EV", $VERSION;
76} 83}
77 84
78@EV::IO::ISA = 85@EV::IO::ISA =
… …
105default loop as this is fastest (perl-wise), best supported by other 112default loop as this is fastest (perl-wise), best supported by other
106modules (e.g. AnyEvent or Coro) and most portable event loop. 113modules (e.g. AnyEvent or Coro) and most portable event loop.
107 114
108For specific programs you can create additional event loops dynamically. 115For specific programs you can create additional event loops dynamically.
109 116
117If you want to take avdantage of kqueue (which often works properly for
118sockets only) even though the default loop doesn't enable it, you can
119I<embed> a kqueue loop into the default loop: running the default loop
120will then also service the kqueue loop to some extent. See the example in
121the section about embed watchers for an example on how to achieve that.
122
110=over 4 123=over 4
111 124
112=item $loop = new EV::loop [$flags] 125=item $loop = new EV::loop [$flags]
113 126
114Create a new event loop as per the specified flags. Please refer to the 127Create a new event loop as per the specified flags. Please refer to the
… …
124 137
125=item $loop->loop_fork 138=item $loop->loop_fork
126 139
127Must be called after a fork in the child, before entering or continuing 140Must 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 141the event loop. An alternative is to use C<EV::FLAG_FORKCHECK> which calls
129this fucntion automatically, at some performance loss (refer to the libev 142this function automatically, at some performance loss (refer to the libev
130documentation). 143documentation).
131 144
145=item $loop->loop_verify
146
147Calls C<ev_verify> to make internal consistency checks (for debugging
148libev) and abort the program if any data structures were found to be
149corrupted.
150
132=item $loop = EV::default_loop [$flags] 151=item $loop = EV::default_loop [$flags]
133 152
134Return the default loop (which is a singleton object). 153Return the default loop (which is a singleton object). Since this module
154already creates the default loop with default flags, specifying flags here
155will not have any effect unless you destroy the default loop first, which
156isn't supported. So in short: don't do it, and if you break it, you get to
157keep the pieces.
135 158
136=back 159=back
137 160
138 161
139=head1 BASIC INTERFACE 162=head1 BASIC INTERFACE
… …
269 292
270A watcher is an object that gets created to record your interest in some 293A 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 294event. For instance, if you want to wait for STDIN to become readable, you
272would create an EV::io watcher for that: 295would create an EV::io watcher for that:
273 296
274 my $watcher = EV::io *STDIN, EV::READ, sub { 297 my $watcher = EV::io *STDIN, EV::READ, sub {
275 my ($watcher, $revents) = @_; 298 my ($watcher, $revents) = @_;
276 warn "yeah, STDIN should now be readable without blocking!\n" 299 warn "yeah, STDIN should now be readable without blocking!\n"
277 }; 300 };
278 301
279All watchers can be active (waiting for events) or inactive (paused). Only 302All watchers can be active (waiting for events) or inactive (paused). Only
280active watchers will have their callbacks invoked. All callbacks will be 303active watchers will have their callbacks invoked. All callbacks will be
281called with at least two arguments: the watcher and a bitmask of received 304called with at least two arguments: the watcher and a bitmask of received
282events. 305events.
… …
395Example: Register an I/O watcher for some UDP socket but do not keep the 418Example: Register an I/O watcher for some UDP socket but do not keep the
396event loop from running just because of that watcher. 419event loop from running just because of that watcher.
397 420
398 my $udp_socket = ... 421 my $udp_socket = ...
399 my $udp_watcher = EV::io $udp_socket, EV::READ, sub { ... }; 422 my $udp_watcher = EV::io $udp_socket, EV::READ, sub { ... };
400 $1000udp_watcher->keepalive (0); 423 $udp_watcher->keepalive (0);
401 424
402=item $loop = $w->loop 425=item $loop = $w->loop
403 426
404Return the loop that this watcher is attached to. 427Return the loop that this watcher is attached to.
405 428
… …
562time the periodic watcher gets scheduled, the reschedule callback 585time the periodic watcher gets scheduled, the reschedule callback
563($reschedule_cb) will be called with the watcher as first, and the current 586($reschedule_cb) will be called with the watcher as first, and the current
564time as second argument. 587time as second argument.
565 588
566I<This callback MUST NOT stop or destroy this or any other periodic 589I<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 590watcher, ever, and MUST NOT call any event loop functions or methods>. If
568afterwards. 591you need to stop it, return 1e30 and stop it afterwards. You may create
592and start a C<EV::prepare> watcher for this task.
569 593
570It must return the next time to trigger, based on the passed time value 594It 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 595(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 596argument). It will usually be called just before the callback will be
573might be called at other times, too. 597triggered, but might be called at other times, too.
574 598
575This can be used to create very complex timers, such as a timer that 599This 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 600triggers 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 601midnight, 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 602in about the same space (without requiring elaborate modules), drop me a
… …
936for more details. 960for more details.
937 961
938In short, this watcher is most useful on BSD systems without working 962In short, this watcher is most useful on BSD systems without working
939kqueue to still be able to handle a large number of sockets: 963kqueue to still be able to handle a large number of sockets:
940 964
941 my $socket_loop; 965 my $socket_loop;
942 966
943 # check wether we use SELECT or POLL _and_ KQUEUE is supported 967 # check wether we use SELECT or POLL _and_ KQUEUE is supported
944 if ( 968 if (
945 (EV::backend & (EV::BACKEND_POLL | EV::BACKEND_SELECT)) 969 (EV::backend & (EV::BACKEND_POLL | EV::BACKEND_SELECT))
946 && (EV::supported_backends & EV::embeddable_backends & EV::BACKEND_KQUEUE) 970 && (EV::supported_backends & EV::embeddable_backends & EV::BACKEND_KQUEUE)
947 ) { 971 ) {
948 # use kqueue for sockets 972 # use kqueue for sockets
949 $socket_loop = new EV::Loop EV::BACKEND_KQUEUE | EV::FLAG_NOENV; 973 $socket_loop = new EV::Loop EV::BACKEND_KQUEUE | EV::FLAG_NOENV;
950 } 974 }
951 975
952 # use the default loop otherwise 976 # use the default loop otherwise
953 $socket_loop ||= EV::default_loop; 977 $socket_loop ||= EV::default_loop;
954 978
955=over 4 979=over 4
956 980
957=item $w = EV::embed $otherloop, $callback 981=item $w = EV::embed $otherloop[, $callback]
958 982
959=item $w = EV::embed_ns $otherloop, $callback 983=item $w = EV::embed_ns $otherloop[, $callback]
960 984
961=item $w = $loop->embed ($otherloop, $callback) 985=item $w = $loop->embed ($otherloop[, $callback])
962 986
963=item $w = $loop->embed_ns ($otherloop, $callback) 987=item $w = $loop->embed_ns ($otherloop[, $callback])
964 988
965Call the callback when the embedded event loop (C<$otherloop>) has any 989Call 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 990I/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 991embedded event loop will be managed automatically (which is recommended),
968automatically. 992otherwise you have to invoke C<sweep> yourself.
969 993
970The C<embed_ns> variant doesn't start (activate) the newly created watcher. 994The C<embed_ns> variant doesn't start (activate) the newly created watcher.
971 995
972=back 996=back
973 997
… …
1049 1073
1050=head1 SEE ALSO 1074=head1 SEE ALSO
1051 1075
1052L<EV::ADNS> (asynchronous DNS), L<Glib::EV> (makes Glib/Gtk2 use EV as 1076L<EV::ADNS> (asynchronous DNS), L<Glib::EV> (makes Glib/Gtk2 use EV as
1053event loop), L<EV::Glib> (embed Glib into EV), L<Coro::EV> (efficient 1077event loop), L<EV::Glib> (embed Glib into EV), L<Coro::EV> (efficient
1054coroutines with EV), L<Net::SNMP::EV> (asynchronous SNMP). 1078coroutines with EV), L<Net::SNMP::EV> (asynchronous SNMP), L<AnyEvent> for
1079event-loop agnostic and portable event driven programming.
1055 1080
1056=head1 AUTHOR 1081=head1 AUTHOR
1057 1082
1058 Marc Lehmann <schmorp@schmorp.de> 1083 Marc Lehmann <schmorp@schmorp.de>
1059 http://home.schmorp.de/ 1084 http://home.schmorp.de/
1060 1085
1061=cut 1086=cut
1062 1087

Diff Legend

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