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.120 by root, Sun Jul 19 01:36:34 2009 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
76use strict; 81use common::sense;
77 82
78BEGIN { 83BEGIN {
79 our $VERSION = '3.33'; 84 our $VERSION = '3.8';
80 use XSLoader; 85 use XSLoader;
81 XSLoader::load "EV", $VERSION; 86 XSLoader::load "EV", $VERSION;
82} 87}
83 88
84@EV::IO::ISA = 89@EV::IO::ISA =
… …
111default loop as this is fastest (perl-wise), best supported by other 116default loop as this is fastest (perl-wise), best supported by other
112modules (e.g. AnyEvent or Coro) and most portable event loop. 117modules (e.g. AnyEvent or Coro) and most portable event loop.
113 118
114For specific programs you can create additional event loops dynamically. 119For specific programs you can create additional event loops dynamically.
115 120
116=over 4 121If you want to take advantage of kqueue (which often works properly for
122sockets only) even though the default loop doesn't enable it, you can
123I<embed> a kqueue loop into the default loop: running the default loop
124will then also service the kqueue loop to some extent. See the example in
125the section about embed watchers for an example on how to achieve that.
117 126
127=over 4
128
118=item $loop = new EV::loop [$flags] 129=item $loop = new EV::Loop [$flags]
119 130
120Create a new event loop as per the specified flags. Please refer to the 131Create a new event loop as per the specified flags. Please refer to
121C<ev_loop_new ()> function description in the libev documentation 132the 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>) 133(L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#GLOBAL_FUNCTIONS>,
123for more info. 134or locally-installed as F<EV::libev> manpage) for more info.
124 135
125The loop will automatically be destroyed when it is no longer referenced 136The loop will automatically be destroyed when it is no longer referenced
126by any watcher and the loop object goes out of scope. 137by any watcher and the loop object goes out of scope.
127 138
128Using C<EV::FLAG_FORKCHECK> is recommended, as only the default event loop 139If you are not embedding the loop, then Using C<EV::FLAG_FORKCHECK>
129is protected by this module. 140is recommended, as only the default event loop is protected by this
141module. If you I<are> embedding this loop in the default loop, this is not
142necessary, as C<EV::embed> automatically does the right thing on fork.
130 143
131=item $loop->loop_fork 144=item $loop->loop_fork
132 145
133Must be called after a fork in the child, before entering or continuing 146Must 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 147the event loop. An alternative is to use C<EV::FLAG_FORKCHECK> which calls
135this fucntion automatically, at some performance loss (refer to the libev 148this function automatically, at some performance loss (refer to the libev
136documentation). 149documentation).
137 150
151=item $loop->loop_verify
152
153Calls C<ev_verify> to make internal consistency checks (for debugging
154libev) and abort the program if any data structures were found to be
155corrupted.
156
138=item $loop = EV::default_loop [$flags] 157=item $loop = EV::default_loop [$flags]
139 158
140Return the default loop (which is a singleton object). 159Return the default loop (which is a singleton object). Since this module
160already creates the default loop with default flags, specifying flags here
161will not have any effect unless you destroy the default loop first, which
162isn't supported. So in short: don't do it, and if you break it, you get to
163keep the pieces.
141 164
142=back 165=back
143 166
144 167
145=head1 BASIC INTERFACE 168=head1 BASIC INTERFACE
… …
175=item $time = EV::now 198=item $time = EV::now
176 199
177=item $time = $loop->now 200=item $time = $loop->now
178 201
179Returns the time the last event loop iteration has been started. This 202Returns the time the last event loop iteration has been started. This
180is the time that (relative) timers are based on, and refering to it is 203is the time that (relative) timers are based on, and referring to it is
181usually faster then calling EV::time. 204usually faster then calling EV::time.
182 205
206=item EV::now_update
207
208=item $loop->now_update
209
210Establishes the current time by querying the kernel, updating the time
211returned by C<EV::now> in the progress. This is a costly operation and
212is usually done automatically within C<EV::loop>.
213
214This function is rarely useful, but when some event callback runs for a
215very long time without entering the event loop, updating libev's idea of
216the current time is a good idea.
217
218=item EV::suspend
219
220=item $loop->suspend
221
222=item EV::resume
223
224=item $loop->resume
225
226These two functions suspend and resume a loop, for use when the loop is
227not used for a while and timeouts should not be processed.
228
229A typical use case would be an interactive program such as a game: When
230the user presses C<^Z> to suspend the game and resumes it an hour later it
231would be best to handle timeouts as if no time had actually passed while
232the program was suspended. This can be achieved by calling C<suspend>
233in your C<SIGTSTP> handler, sending yourself a C<SIGSTOP> and calling
234C<resume> directly afterwards to resume timer processing.
235
236Effectively, all C<timer> watchers will be delayed by the time spend
237between C<suspend> and C<resume>, and all C<periodic> watchers
238will be rescheduled (that is, they will lose any events that would have
239occured while suspended).
240
241After calling C<suspend> you B<must not> call I<any> function on the given
242loop other than C<resume>, and you B<must not> call C<resume>
243without a previous call to C<suspend>.
244
245Calling C<suspend>/C<resume> has the side effect of updating the event
246loop time (see C<now_update>).
247
183=item $backend = EV::backend 248=item $backend = EV::backend
184 249
185=item $backend = $loop->backend 250=item $backend = $loop->backend
186 251
187Returns an integer describing the backend used by libev (EV::METHOD_SELECT 252Returns an integer describing the backend used by libev (EV::BACKEND_SELECT
188or EV::METHOD_EPOLL). 253or EV::BACKEND_EPOLL).
189 254
190=item EV::loop [$flags] 255=item EV::loop [$flags]
191 256
192=item $loop->loop ([$flags]) 257=item $loop->loop ([$flags])
193 258
… …
213=item $count = EV::loop_count 278=item $count = EV::loop_count
214 279
215=item $count = $loop->loop_count 280=item $count = $loop->loop_count
216 281
217Return the number of times the event loop has polled for new 282Return the number of times the event loop has polled for new
218events. Sometiems useful as a generation counter. 283events. Sometimes useful as a generation counter.
219 284
220=item EV::once $fh_or_undef, $events, $timeout, $cb->($revents) 285=item EV::once $fh_or_undef, $events, $timeout, $cb->($revents)
221 286
222=item $loop->once ($fh_or_undef, $events, $timeout, $cb->($revents)) 287=item $loop->once ($fh_or_undef, $events, $timeout, $cb->($revents))
223 288
… …
263 328
264=item $loop->set_timeout_collect_interval ($time) 329=item $loop->set_timeout_collect_interval ($time)
265 330
266These advanced functions set the minimum block interval when polling for I/O events and the minimum 331These 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 332wait 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 333L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#FUNCTIONS_CONTROLLING_THE_EVENT_LOOP>
269a more detailed discussion. 334(locally installed as F<EV::libev>) for a more detailed discussion.
335
336=item $count = EV::pending_count
337
338=item $count = $loop->pending_count
339
340Returns the number of currently pending watchers.
341
342=item EV::invoke_pending
343
344=item $loop->invoke_pending
345
346Invoke all currently pending watchers.
270 347
271=back 348=back
272 349
273 350
274=head1 WATCHER OBJECTS 351=head1 WATCHER OBJECTS
275 352
276A watcher is an object that gets created to record your interest in some 353A 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 354event. For instance, if you want to wait for STDIN to become readable, you
278would create an EV::io watcher for that: 355would create an EV::io watcher for that:
279 356
280 my $watcher = EV::io *STDIN, EV::READ, sub { 357 my $watcher = EV::io *STDIN, EV::READ, sub {
281 my ($watcher, $revents) = @_; 358 my ($watcher, $revents) = @_;
282 warn "yeah, STDIN should now be readable without blocking!\n" 359 warn "yeah, STDIN should now be readable without blocking!\n"
283 }; 360 };
284 361
285All watchers can be active (waiting for events) or inactive (paused). Only 362All watchers can be active (waiting for events) or inactive (paused). Only
286active watchers will have their callbacks invoked. All callbacks will be 363active watchers will have their callbacks invoked. All callbacks will be
287called with at least two arguments: the watcher and a bitmask of received 364called with at least two arguments: the watcher and a bitmask of received
288events. 365events.
289 366
290Each watcher type has its associated bit in revents, so you can use the 367Each watcher type has its associated bit in revents, so you can use the
291same callback for multiple watchers. The event mask is named after the 368same callback for multiple watchers. The event mask is named after the
292type, i..e. EV::child sets EV::CHILD, EV::prepare sets EV::PREPARE, 369type, i.e. EV::child sets EV::CHILD, EV::prepare sets EV::PREPARE,
293EV::periodic sets EV::PERIODIC and so on, with the exception of I/O events 370EV::periodic sets EV::PERIODIC and so on, with the exception of I/O events
294(which can set both EV::READ and EV::WRITE bits), and EV::timer (which 371(which can set both EV::READ and EV::WRITE bits), and EV::timer (which
295uses EV::TIMEOUT). 372uses EV::TIMEOUT).
296 373
297In the rare case where one wants to create a watcher but not start it at 374In the rare case where one wants to create a watcher but not start it at
… …
393because you happen to have this long-running UDP port watcher. 470because you happen to have this long-running UDP port watcher.
394 471
395In this case you can clear the keepalive status, which means that even 472In this case you can clear the keepalive status, which means that even
396though your watcher is active, it won't keep C<EV::loop> from returning. 473though your watcher is active, it won't keep C<EV::loop> from returning.
397 474
398The initial value for keepalive is true (enabled), and you cna change it 475The initial value for keepalive is true (enabled), and you can change it
399any time. 476any time.
400 477
401Example: Register an I/O watcher for some UDP socket but do not keep the 478Example: Register an I/O watcher for some UDP socket but do not keep the
402event loop from running just because of that watcher. 479event loop from running just because of that watcher.
403 480
404 my $udp_socket = ... 481 my $udp_socket = ...
405 my $udp_watcher = EV::io $udp_socket, EV::READ, sub { ... }; 482 my $udp_watcher = EV::io $udp_socket, EV::READ, sub { ... };
406 $1000udp_watcher->keepalive (0); 483 $udp_watcher->keepalive (0);
407 484
408=item $loop = $w->loop 485=item $loop = $w->loop
409 486
410Return the loop that this watcher is attached to. 487Return the loop that this watcher is attached to.
411 488
… …
568time the periodic watcher gets scheduled, the reschedule callback 645time the periodic watcher gets scheduled, the reschedule callback
569($reschedule_cb) will be called with the watcher as first, and the current 646($reschedule_cb) will be called with the watcher as first, and the current
570time as second argument. 647time as second argument.
571 648
572I<This callback MUST NOT stop or destroy this or any other periodic 649I<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 650watcher, ever, and MUST NOT call any event loop functions or methods>. If
574afterwards. 651you need to stop it, return 1e30 and stop it afterwards. You may create
652and start a C<EV::prepare> watcher for this task.
575 653
576It must return the next time to trigger, based on the passed time value 654It 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 655(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 656argument). It will usually be called just before the callback will be
579might be called at other times, too. 657triggered, but might be called at other times, too.
580 658
581This can be used to create very complex timers, such as a timer that 659This 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 660triggers 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 661midnight, 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 662in about the same space (without requiring elaborate modules), drop me a
… …
896 # make the dispatcher handle any new stuff 974 # make the dispatcher handle any new stuff
897 ... not shown 975 ... not shown
898 }; 976 };
899 977
900The callbacks of the created watchers will not be called as the watchers 978The callbacks of the created watchers will not be called as the watchers
901are destroyed before this cna happen (remember EV::check gets called 979are destroyed before this can happen (remember EV::check gets called
902first). 980first).
903 981
904The C<check_ns> variant doesn't start (activate) the newly created watcher. 982The C<check_ns> variant doesn't start (activate) the newly created watcher.
905 983
906=back 984=back
… …
937loop, other types of watchers might be handled in a delayed or incorrect 1015loop, other types of watchers might be handled in a delayed or incorrect
938fashion and must not be used). 1016fashion and must not be used).
939 1017
940See the libev documentation at 1018See the libev documentation at
941L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#code_ev_embed_code_when_one_backend_> 1019L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#code_ev_embed_code_when_one_backend_>
942for more details. 1020(locally installed as F<EV::libev>) for more details.
943 1021
944In short, this watcher is most useful on BSD systems without working 1022In short, this watcher is most useful on BSD systems without working
945kqueue to still be able to handle a large number of sockets: 1023kqueue to still be able to handle a large number of sockets:
946 1024
947 my $socket_loop; 1025 my $socket_loop;
948 1026
949 # check wether we use SELECT or POLL _and_ KQUEUE is supported 1027 # check wether we use SELECT or POLL _and_ KQUEUE is supported
950 if ( 1028 if (
951 (EV::backend & (EV::BACKEND_POLL | EV::BACKEND_SELECT)) 1029 (EV::backend & (EV::BACKEND_POLL | EV::BACKEND_SELECT))
952 && (EV::supported_backends & EV::embeddable_backends & EV::BACKEND_KQUEUE) 1030 && (EV::supported_backends & EV::embeddable_backends & EV::BACKEND_KQUEUE)
953 ) { 1031 ) {
954 # use kqueue for sockets 1032 # use kqueue for sockets
955 $socket_loop = new EV::Loop EV::BACKEND_KQUEUE | EV::FLAG_NOENV; 1033 $socket_loop = new EV::Loop EV::BACKEND_KQUEUE | EV::FLAG_NOENV;
956 } 1034 }
957 1035
958 # use the default loop otherwise 1036 # use the default loop otherwise
959 $socket_loop ||= EV::default_loop; 1037 $socket_loop ||= EV::default_loop;
960 1038
961=over 4 1039=over 4
962 1040
963=item $w = EV::embed $otherloop, $callback 1041=item $w = EV::embed $otherloop[, $callback]
964 1042
965=item $w = EV::embed_ns $otherloop, $callback 1043=item $w = EV::embed_ns $otherloop[, $callback]
966 1044
967=item $w = $loop->embed ($otherloop, $callback) 1045=item $w = $loop->embed ($otherloop[, $callback])
968 1046
969=item $w = $loop->embed_ns ($otherloop, $callback) 1047=item $w = $loop->embed_ns ($otherloop[, $callback])
970 1048
971Call the callback when the embedded event loop (C<$otherloop>) has any 1049Call 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 1050I/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 1051embedded event loop will be managed automatically (which is recommended),
974automatically. 1052otherwise you have to invoke C<sweep> yourself.
975 1053
976The C<embed_ns> variant doesn't start (activate) the newly created watcher. 1054The C<embed_ns> variant doesn't start (activate) the newly created watcher.
977 1055
978=back 1056=back
979 1057
980=head3 ASYNC WATCHERS - how to wake up another event loop 1058=head3 ASYNC WATCHERS - how to wake up another event loop
981 1059
982Async watchers are provided by EV, but have little use in perl directly, as perl 1060Async watchers are provided by EV, but have little use in perl directly,
983neither supports threads nor direct access to signal handlers or other 1061as perl neither supports threads running in parallel nor direct access to
984contexts where they could be of value. 1062signal handlers or other contexts where they could be of value.
985 1063
986It is, however, possible to use them from the XS level. 1064It is, however, possible to use them from the XS level.
987 1065
988Please see the libev documentation for further details. 1066Please see the libev documentation for further details.
989 1067
… …
1017 my $async_check = EV::check sub { }; 1095 my $async_check = EV::check sub { };
1018 1096
1019This ensures that perl gets into control for a short time to handle any 1097This ensures that perl gets into control for a short time to handle any
1020pending signals, and also ensures (slightly) slower overall operation. 1098pending signals, and also ensures (slightly) slower overall operation.
1021 1099
1022=head1 THREADS 1100=head1 ITHREADS
1023 1101
1024Threads are not supported by this module in any way. Perl pseudo-threads 1102Ithreads are not supported by this module in any way. Perl pseudo-threads
1025is evil stuff and must die. As soon as Perl gains real threads I will work 1103is evil stuff and must die. Real threads as provided by Coro are fully
1026on thread support for it. 1104supported (and enhanced support is available via L<Coro::EV>).
1027 1105
1028=head1 FORK 1106=head1 FORK
1029 1107
1030Most of the "improved" event delivering mechanisms of modern operating 1108Most of the "improved" event delivering mechanisms of modern operating
1031systems have quite a few problems with fork(2) (to put it bluntly: it is 1109systems have quite a few problems with fork(2) (to put it bluntly: it is
… …
1060coroutines with EV), L<Net::SNMP::EV> (asynchronous SNMP), L<AnyEvent> for 1138coroutines with EV), L<Net::SNMP::EV> (asynchronous SNMP), L<AnyEvent> for
1061event-loop agnostic and portable event driven programming. 1139event-loop agnostic and portable event driven programming.
1062 1140
1063=head1 AUTHOR 1141=head1 AUTHOR
1064 1142
1065 Marc Lehmann <schmorp@schmorp.de> 1143 Marc Lehmann <schmorp@schmorp.de>
1066 http://home.schmorp.de/ 1144 http://home.schmorp.de/
1067 1145
1068=cut 1146=cut
1069 1147

Diff Legend

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