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.99 by root, Tue Jul 8 09:37:37 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
… …
74package EV; 74package EV;
75 75
76use strict; 76use strict;
77 77
78BEGIN { 78BEGIN {
79 our $VERSION = '3.33'; 79 our $VERSION = '3.42';
80 use XSLoader; 80 use XSLoader;
81 XSLoader::load "EV", $VERSION; 81 XSLoader::load "EV", $VERSION;
82} 82}
83 83
84@EV::IO::ISA = 84@EV::IO::ISA =
… …
111default loop as this is fastest (perl-wise), best supported by other 111default loop as this is fastest (perl-wise), best supported by other
112modules (e.g. AnyEvent or Coro) and most portable event loop. 112modules (e.g. AnyEvent or Coro) and most portable event loop.
113 113
114For specific programs you can create additional event loops dynamically. 114For specific programs you can create additional event loops dynamically.
115 115
116If you want to take avdantage of kqueue (which often works properly for
117sockets only) even though the default loop doesn't enable it, you can
118I<embed> a kqueue loop into the default loop: running the default loop
119will then also service the kqueue loop to some extent. See the example in
120the section about embed watchers for an example on how to achieve that.
121
116=over 4 122=over 4
117 123
118=item $loop = new EV::loop [$flags] 124=item $loop = new EV::loop [$flags]
119 125
120Create a new event loop as per the specified flags. Please refer to the 126Create a new event loop as per the specified flags. Please refer to the
… …
130 136
131=item $loop->loop_fork 137=item $loop->loop_fork
132 138
133Must be called after a fork in the child, before entering or continuing 139Must 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 140the event loop. An alternative is to use C<EV::FLAG_FORKCHECK> which calls
135this fucntion automatically, at some performance loss (refer to the libev 141this function automatically, at some performance loss (refer to the libev
136documentation). 142documentation).
137 143
144=item $loop->loop_verify
145
146Calls C<ev_verify> to make internal consistency checks (for debugging
147libev) and abort the program if any data structures were found to be
148corrupted.
149
138=item $loop = EV::default_loop [$flags] 150=item $loop = EV::default_loop [$flags]
139 151
140Return the default loop (which is a singleton object). 152Return the default loop (which is a singleton object). Since this module
153already creates the default loop with default flags, specifying flags here
154will not have any effect unless you destroy the default loop first, which
155isn't supported. So in short: don't do it, and if you break it, you get to
156keep the pieces.
141 157
142=back 158=back
143 159
144 160
145=head1 BASIC INTERFACE 161=head1 BASIC INTERFACE
… …
275 291
276A watcher is an object that gets created to record your interest in some 292A 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 293event. For instance, if you want to wait for STDIN to become readable, you
278would create an EV::io watcher for that: 294would create an EV::io watcher for that:
279 295
280 my $watcher = EV::io *STDIN, EV::READ, sub { 296 my $watcher = EV::io *STDIN, EV::READ, sub {
281 my ($watcher, $revents) = @_; 297 my ($watcher, $revents) = @_;
282 warn "yeah, STDIN should now be readable without blocking!\n" 298 warn "yeah, STDIN should now be readable without blocking!\n"
283 }; 299 };
284 300
285All watchers can be active (waiting for events) or inactive (paused). Only 301All watchers can be active (waiting for events) or inactive (paused). Only
286active watchers will have their callbacks invoked. All callbacks will be 302active watchers will have their callbacks invoked. All callbacks will be
287called with at least two arguments: the watcher and a bitmask of received 303called with at least two arguments: the watcher and a bitmask of received
288events. 304events.
… …
401Example: Register an I/O watcher for some UDP socket but do not keep the 417Example: Register an I/O watcher for some UDP socket but do not keep the
402event loop from running just because of that watcher. 418event loop from running just because of that watcher.
403 419
404 my $udp_socket = ... 420 my $udp_socket = ...
405 my $udp_watcher = EV::io $udp_socket, EV::READ, sub { ... }; 421 my $udp_watcher = EV::io $udp_socket, EV::READ, sub { ... };
406 $1000udp_watcher->keepalive (0); 422 $udp_watcher->keepalive (0);
407 423
408=item $loop = $w->loop 424=item $loop = $w->loop
409 425
410Return the loop that this watcher is attached to. 426Return the loop that this watcher is attached to.
411 427
… …
568time the periodic watcher gets scheduled, the reschedule callback 584time the periodic watcher gets scheduled, the reschedule callback
569($reschedule_cb) will be called with the watcher as first, and the current 585($reschedule_cb) will be called with the watcher as first, and the current
570time as second argument. 586time as second argument.
571 587
572I<This callback MUST NOT stop or destroy this or any other periodic 588I<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 589watcher, ever, and MUST NOT call any event loop functions or methods>. If
574afterwards. 590you need to stop it, return 1e30 and stop it afterwards. You may create
591and start a C<EV::prepare> watcher for this task.
575 592
576It must return the next time to trigger, based on the passed time value 593It 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 594(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 595argument). It will usually be called just before the callback will be
579might be called at other times, too. 596triggered, but might be called at other times, too.
580 597
581This can be used to create very complex timers, such as a timer that 598This 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 599triggers 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 600midnight, 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 601in about the same space (without requiring elaborate modules), drop me a
… …
942for more details. 959for more details.
943 960
944In short, this watcher is most useful on BSD systems without working 961In short, this watcher is most useful on BSD systems without working
945kqueue to still be able to handle a large number of sockets: 962kqueue to still be able to handle a large number of sockets:
946 963
947 my $socket_loop; 964 my $socket_loop;
948 965
949 # check wether we use SELECT or POLL _and_ KQUEUE is supported 966 # check wether we use SELECT or POLL _and_ KQUEUE is supported
950 if ( 967 if (
951 (EV::backend & (EV::BACKEND_POLL | EV::BACKEND_SELECT)) 968 (EV::backend & (EV::BACKEND_POLL | EV::BACKEND_SELECT))
952 && (EV::supported_backends & EV::embeddable_backends & EV::BACKEND_KQUEUE) 969 && (EV::supported_backends & EV::embeddable_backends & EV::BACKEND_KQUEUE)
953 ) { 970 ) {
954 # use kqueue for sockets 971 # use kqueue for sockets
955 $socket_loop = new EV::Loop EV::BACKEND_KQUEUE | EV::FLAG_NOENV; 972 $socket_loop = new EV::Loop EV::BACKEND_KQUEUE | EV::FLAG_NOENV;
956 } 973 }
957 974
958 # use the default loop otherwise 975 # use the default loop otherwise
959 $socket_loop ||= EV::default_loop; 976 $socket_loop ||= EV::default_loop;
960 977
961=over 4 978=over 4
962 979
963=item $w = EV::embed $otherloop, $callback 980=item $w = EV::embed $otherloop, $callback
964 981
… …
1060coroutines with EV), L<Net::SNMP::EV> (asynchronous SNMP), L<AnyEvent> for 1077coroutines with EV), L<Net::SNMP::EV> (asynchronous SNMP), L<AnyEvent> for
1061event-loop agnostic and portable event driven programming. 1078event-loop agnostic and portable event driven programming.
1062 1079
1063=head1 AUTHOR 1080=head1 AUTHOR
1064 1081
1065 Marc Lehmann <schmorp@schmorp.de> 1082 Marc Lehmann <schmorp@schmorp.de>
1066 http://home.schmorp.de/ 1083 http://home.schmorp.de/
1067 1084
1068=cut 1085=cut
1069 1086

Diff Legend

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