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.110 by root, Wed Dec 24 22:05:58 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.
72
73=head2 MODULE EXPORTS
74
75This module does not export any symbols.
65 76
66=cut 77=cut
67 78
68package EV; 79package EV;
69 80
81no warnings;
70use strict; 82use strict;
71 83
72BEGIN { 84BEGIN {
73 our $VERSION = '3.31'; 85 our $VERSION = '3.51';
74 use XSLoader; 86 use XSLoader;
75 XSLoader::load "EV", $VERSION; 87 XSLoader::load "EV", $VERSION;
76} 88}
77 89
78@EV::IO::ISA = 90@EV::IO::ISA =
… …
105default loop as this is fastest (perl-wise), best supported by other 117default loop as this is fastest (perl-wise), best supported by other
106modules (e.g. AnyEvent or Coro) and most portable event loop. 118modules (e.g. AnyEvent or Coro) and most portable event loop.
107 119
108For specific programs you can create additional event loops dynamically. 120For specific programs you can create additional event loops dynamically.
109 121
122If you want to take advantage 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
110=over 4 128=over 4
111 129
112=item $loop = new EV::loop [$flags] 130=item $loop = new EV::loop [$flags]
113 131
114Create 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
115C<ev_loop_new ()> function description in the libev documentation 133the 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>) 134(L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#GLOBAL_FUNCTIONS>,
117for more info. 135or locally-installed as F<EV::libev> manpage) for more info.
118 136
119The loop will automatically be destroyed when it is no longer referenced 137The loop will automatically be destroyed when it is no longer referenced
120by any watcher and the loop object goes out of scope. 138by any watcher and the loop object goes out of scope.
121 139
122Using 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>
123is 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.
124 144
125=item $loop->loop_fork 145=item $loop->loop_fork
126 146
127Must 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
128the 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
129this fucntion automatically, at some performance loss (refer to the libev 149this function automatically, at some performance loss (refer to the libev
130documentation). 150documentation).
131 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
132=item $loop = EV::default_loop [$flags] 158=item $loop = EV::default_loop [$flags]
133 159
134Return 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.
135 165
136=back 166=back
137 167
138 168
139=head1 BASIC INTERFACE 169=head1 BASIC INTERFACE
… …
169=item $time = EV::now 199=item $time = EV::now
170 200
171=item $time = $loop->now 201=item $time = $loop->now
172 202
173Returns the time the last event loop iteration has been started. This 203Returns the time the last event loop iteration has been started. This
174is the time that (relative) timers are based on, and refering to it is 204is the time that (relative) timers are based on, and referring to it is
175usually faster then calling EV::time. 205usually faster then calling EV::time.
176 206
177=item $backend = EV::backend 207=item $backend = EV::backend
178 208
179=item $backend = $loop->backend 209=item $backend = $loop->backend
180 210
181Returns an integer describing the backend used by libev (EV::METHOD_SELECT 211Returns an integer describing the backend used by libev (EV::BACKEND_SELECT
182or EV::METHOD_EPOLL). 212or EV::BACKEND_EPOLL).
183 213
184=item EV::loop [$flags] 214=item EV::loop [$flags]
185 215
186=item $loop->loop ([$flags]) 216=item $loop->loop ([$flags])
187 217
… …
207=item $count = EV::loop_count 237=item $count = EV::loop_count
208 238
209=item $count = $loop->loop_count 239=item $count = $loop->loop_count
210 240
211Return the number of times the event loop has polled for new 241Return the number of times the event loop has polled for new
212events. Sometiems useful as a generation counter. 242events. Sometimes useful as a generation counter.
213 243
214=item EV::once $fh_or_undef, $events, $timeout, $cb->($revents) 244=item EV::once $fh_or_undef, $events, $timeout, $cb->($revents)
215 245
216=item $loop->once ($fh_or_undef, $events, $timeout, $cb->($revents)) 246=item $loop->once ($fh_or_undef, $events, $timeout, $cb->($revents))
217 247
… …
257 287
258=item $loop->set_timeout_collect_interval ($time) 288=item $loop->set_timeout_collect_interval ($time)
259 289
260These 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
261wait interval for timer events. See the libev documentation at 291wait 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 292L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#FUNCTIONS_CONTROLLING_THE_EVENT_LOOP>
263a more detailed discussion. 293(locally installed as F<EV::libev>) for a more detailed discussion.
264 294
265=back 295=back
266 296
267 297
268=head1 WATCHER OBJECTS 298=head1 WATCHER OBJECTS
269 299
270A 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
271event. 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
272would create an EV::io watcher for that: 302would create an EV::io watcher for that:
273 303
274 my $watcher = EV::io *STDIN, EV::READ, sub { 304 my $watcher = EV::io *STDIN, EV::READ, sub {
275 my ($watcher, $revents) = @_; 305 my ($watcher, $revents) = @_;
276 warn "yeah, STDIN should now be readable without blocking!\n" 306 warn "yeah, STDIN should now be readable without blocking!\n"
277 }; 307 };
278 308
279All watchers can be active (waiting for events) or inactive (paused). Only 309All watchers can be active (waiting for events) or inactive (paused). Only
280active watchers will have their callbacks invoked. All callbacks will be 310active watchers will have their callbacks invoked. All callbacks will be
281called 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
282events. 312events.
283 313
284Each watcher type has its associated bit in revents, so you can use the 314Each watcher type has its associated bit in revents, so you can use the
285same callback for multiple watchers. The event mask is named after the 315same callback for multiple watchers. The event mask is named after the
286type, i..e. EV::child sets EV::CHILD, EV::prepare sets EV::PREPARE, 316type, i.e. EV::child sets EV::CHILD, EV::prepare sets EV::PREPARE,
287EV::periodic sets EV::PERIODIC and so on, with the exception of I/O events 317EV::periodic sets EV::PERIODIC and so on, with the exception of I/O events
288(which can set both EV::READ and EV::WRITE bits), and EV::timer (which 318(which can set both EV::READ and EV::WRITE bits), and EV::timer (which
289uses EV::TIMEOUT). 319uses EV::TIMEOUT).
290 320
291In the rare case where one wants to create a watcher but not start it at 321In the rare case where one wants to create a watcher but not start it at
… …
387because you happen to have this long-running UDP port watcher. 417because you happen to have this long-running UDP port watcher.
388 418
389In this case you can clear the keepalive status, which means that even 419In this case you can clear the keepalive status, which means that even
390though your watcher is active, it won't keep C<EV::loop> from returning. 420though your watcher is active, it won't keep C<EV::loop> from returning.
391 421
392The initial value for keepalive is true (enabled), and you cna change it 422The initial value for keepalive is true (enabled), and you can change it
393any time. 423any time.
394 424
395Example: 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
396event loop from running just because of that watcher. 426event loop from running just because of that watcher.
397 427
398 my $udp_socket = ... 428 my $udp_socket = ...
399 my $udp_watcher = EV::io $udp_socket, EV::READ, sub { ... }; 429 my $udp_watcher = EV::io $udp_socket, EV::READ, sub { ... };
400 $1000udp_watcher->keepalive (0); 430 $udp_watcher->keepalive (0);
401 431
402=item $loop = $w->loop 432=item $loop = $w->loop
403 433
404Return the loop that this watcher is attached to. 434Return the loop that this watcher is attached to.
405 435
… …
562time the periodic watcher gets scheduled, the reschedule callback 592time the periodic watcher gets scheduled, the reschedule callback
563($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
564time as second argument. 594time as second argument.
565 595
566I<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
567watcher, 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
568afterwards. 598you need to stop it, return 1e30 and stop it afterwards. You may create
599and start a C<EV::prepare> watcher for this task.
569 600
570It 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
571(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
572will usually be called just before the callback will be triggered, but 603argument). It will usually be called just before the callback will be
573might be called at other times, too. 604triggered, but might be called at other times, too.
574 605
575This 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
576triggers on each midnight, local time (actually 24 hours after the last 607triggers 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 608midnight, 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 609in about the same space (without requiring elaborate modules), drop me a
… …
890 # make the dispatcher handle any new stuff 921 # make the dispatcher handle any new stuff
891 ... not shown 922 ... not shown
892 }; 923 };
893 924
894The callbacks of the created watchers will not be called as the watchers 925The callbacks of the created watchers will not be called as the watchers
895are destroyed before this cna happen (remember EV::check gets called 926are destroyed before this can happen (remember EV::check gets called
896first). 927first).
897 928
898The C<check_ns> variant doesn't start (activate) the newly created watcher. 929The C<check_ns> variant doesn't start (activate) the newly created watcher.
899 930
900=back 931=back
… …
931loop, 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
932fashion and must not be used). 963fashion and must not be used).
933 964
934See the libev documentation at 965See the libev documentation at
935L<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_>
936for more details. 967(locally installed as F<EV::libev>) for more details.
937 968
938In short, this watcher is most useful on BSD systems without working 969In short, this watcher is most useful on BSD systems without working
939kqueue to still be able to handle a large number of sockets: 970kqueue to still be able to handle a large number of sockets:
940 971
941 my $socket_loop; 972 my $socket_loop;
942 973
943 # check wether we use SELECT or POLL _and_ KQUEUE is supported 974 # check wether we use SELECT or POLL _and_ KQUEUE is supported
944 if ( 975 if (
945 (EV::backend & (EV::BACKEND_POLL | EV::BACKEND_SELECT)) 976 (EV::backend & (EV::BACKEND_POLL | EV::BACKEND_SELECT))
946 && (EV::supported_backends & EV::embeddable_backends & EV::BACKEND_KQUEUE) 977 && (EV::supported_backends & EV::embeddable_backends & EV::BACKEND_KQUEUE)
947 ) { 978 ) {
948 # use kqueue for sockets 979 # use kqueue for sockets
949 $socket_loop = new EV::Loop EV::BACKEND_KQUEUE | EV::FLAG_NOENV; 980 $socket_loop = new EV::Loop EV::BACKEND_KQUEUE | EV::FLAG_NOENV;
950 } 981 }
951 982
952 # use the default loop otherwise 983 # use the default loop otherwise
953 $socket_loop ||= EV::default_loop; 984 $socket_loop ||= EV::default_loop;
954 985
955=over 4 986=over 4
956 987
957=item $w = EV::embed $otherloop, $callback 988=item $w = EV::embed $otherloop[, $callback]
958 989
959=item $w = EV::embed_ns $otherloop, $callback 990=item $w = EV::embed_ns $otherloop[, $callback]
960 991
961=item $w = $loop->embed ($otherloop, $callback) 992=item $w = $loop->embed ($otherloop[, $callback])
962 993
963=item $w = $loop->embed_ns ($otherloop, $callback) 994=item $w = $loop->embed_ns ($otherloop[, $callback])
964 995
965Call the callback when the embedded event loop (C<$otherloop>) has any 996Call 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 997I/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 998embedded event loop will be managed automatically (which is recommended),
968automatically. 999otherwise you have to invoke C<sweep> yourself.
969 1000
970The 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.
971 1002
972=back 1003=back
973 1004
… …
1049 1080
1050=head1 SEE ALSO 1081=head1 SEE ALSO
1051 1082
1052L<EV::ADNS> (asynchronous DNS), L<Glib::EV> (makes Glib/Gtk2 use EV as 1083L<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 1084event loop), L<EV::Glib> (embed Glib into EV), L<Coro::EV> (efficient
1054coroutines with EV), L<Net::SNMP::EV> (asynchronous SNMP). 1085coroutines with EV), L<Net::SNMP::EV> (asynchronous SNMP), L<AnyEvent> for
1086event-loop agnostic and portable event driven programming.
1055 1087
1056=head1 AUTHOR 1088=head1 AUTHOR
1057 1089
1058 Marc Lehmann <schmorp@schmorp.de> 1090 Marc Lehmann <schmorp@schmorp.de>
1059 http://home.schmorp.de/ 1091 http://home.schmorp.de/
1060 1092
1061=cut 1093=cut
1062 1094

Diff Legend

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