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

Comparing EV/README (file contents):
Revision 1.32 by root, Tue Apr 28 00:50:57 2009 UTC vs.
Revision 1.41 by root, Fri Mar 1 11:20:07 2013 UTC

2 EV - perl interface to libev, a high performance full-featured event 2 EV - perl interface to libev, a high performance full-featured event
3 loop 3 loop
4 4
5SYNOPSIS 5SYNOPSIS
6 use EV; 6 use EV;
7 7
8 # TIMERS 8 # TIMERS
9 9
10 my $w = EV::timer 2, 0, sub { 10 my $w = EV::timer 2, 0, sub {
11 warn "is called after 2s"; 11 warn "is called after 2s";
12 }; 12 };
13 13
14 my $w = EV::timer 2, 2, sub { 14 my $w = EV::timer 2, 2, sub {
15 warn "is called roughly every 2s (repeat = 2)"; 15 warn "is called roughly every 2s (repeat = 2)";
16 }; 16 };
17 17
18 undef $w; # destroy event watcher again 18 undef $w; # destroy event watcher again
19 19
20 my $w = EV::periodic 0, 60, 0, sub { 20 my $w = EV::periodic 0, 60, 0, sub {
21 warn "is called every minute, on the minute, exactly"; 21 warn "is called every minute, on the minute, exactly";
22 }; 22 };
23
23 24 # IO
24 # IO 25
25
26 my $w = EV::io *STDIN, EV::READ, sub { 26 my $w = EV::io *STDIN, EV::READ, sub {
27 my ($w, $revents) = @_; # all callbacks receive the watcher and event mask 27 my ($w, $revents) = @_; # all callbacks receive the watcher and event mask
28 warn "stdin is readable, you entered: ", <STDIN>; 28 warn "stdin is readable, you entered: ", <STDIN>;
29 }; 29 };
30 30
31 # SIGNALS 31 # SIGNALS
32 32
33 my $w = EV::signal 'QUIT', sub { 33 my $w = EV::signal 'QUIT', sub {
34 warn "sigquit received\n"; 34 warn "sigquit received\n";
35 }; 35 };
36 36
37 # CHILD/PID STATUS CHANGES 37 # CHILD/PID STATUS CHANGES
38 38
39 my $w = EV::child 666, 0, sub { 39 my $w = EV::child 666, 0, sub {
40 my ($w, $revents) = @_; 40 my ($w, $revents) = @_;
41 my $status = $w->rstatus; 41 my $status = $w->rstatus;
42 }; 42 };
43 43
44 # STAT CHANGES 44 # STAT CHANGES
45 my $w = EV::stat "/etc/passwd", 10, sub { 45 my $w = EV::stat "/etc/passwd", 10, sub {
46 my ($w, $revents) = @_; 46 my ($w, $revents) = @_;
47 warn $w->path, " has changed somehow.\n"; 47 warn $w->path, " has changed somehow.\n";
48 }; 48 };
49 49
50 # MAINLOOP 50 # MAINLOOP
51 EV::loop; # loop until EV::unloop is called or all watchers stop 51 EV::run; # loop until EV::unloop is called or all watchers stop
52 EV::loop EV::LOOP_ONESHOT; # block until at least one event could be handled 52 EV::run EV::RUN_ONCE; # block until at least one event could be handled
53 EV::loop EV::LOOP_NONBLOCK; # try to handle same events, but do not block 53 EV::run EV::RUN_NOWAIT; # try to handle same events, but do not block
54
55BEFORE YOU START USING THIS MODULE
56 If you only need timer, I/O, signal, child and idle watchers and not the
57 advanced functionality of this module, consider using AnyEvent instead,
58 specifically the simplified API described in AE.
59
60 When used with EV as backend, the AE API is as fast as the native EV
61 API, but your programs/modules will still run with many other event
62 loops.
54 63
55DESCRIPTION 64DESCRIPTION
56 This module provides an interface to libev 65 This module provides an interface to libev
57 (<http://software.schmorp.de/pkg/libev.html>). While the documentation 66 (<http://software.schmorp.de/pkg/libev.html>). While the documentation
58 below is comprehensive, one might also consult the documentation of 67 below is comprehensive, one might also consult the documentation of
66 can use it through the AnyEvent module, stay portable to other event 75 can use it through the AnyEvent module, stay portable to other event
67 loops (if you don't rely on any watcher types not available through it) 76 loops (if you don't rely on any watcher types not available through it)
68 and still be faster than with any other event loop currently supported 77 and still be faster than with any other event loop currently supported
69 in Perl. 78 in Perl.
70 79
80 PORTING FROM EV 3.X to 4.X
81 EV version 4 introduces a number of incompatible changes summarised
82 here. According to the depreciation strategy used by libev, there is a
83 compatibility layer in place so programs should continue to run
84 unchanged (the XS interface lacks this layer, so programs using that one
85 need to be updated).
86
87 This compatibility layer will be switched off in some future release.
88
89 All changes relevant to Perl are renames of symbols, functions and
90 methods:
91
92 EV::loop => EV::run
93 EV::LOOP_NONBLOCK => EV::RUN_NOWAIT
94 EV::LOOP_ONESHOT => EV::RUN_ONCE
95
96 EV::unloop => EV::break
97 EV::UNLOOP_CANCEL => EV::BREAK_CANCEL
98 EV::UNLOOP_ONE => EV::BREAK_ONE
99 EV::UNLOOP_ALL => EV::BREAK_ALL
100
101 EV::TIMEOUT => EV::TIMER
102
103 EV::loop_count => EV::iteration
104 EV::loop_depth => EV::depth
105 EV::loop_verify => EV::verify
106
107 The loop object methods corresponding to the functions above have been
108 similarly renamed.
109
71 MODULE EXPORTS 110 MODULE EXPORTS
72 This module does not export any symbols. 111 This module does not export any symbols.
73 112
74EVENT LOOPS 113EVENT LOOPS
75 EV supports multiple event loops: There is a single "default event loop" 114 EV supports multiple event loops: There is a single "default event loop"
112 Must be called after a fork in the child, before entering or 151 Must be called after a fork in the child, before entering or
113 continuing the event loop. An alternative is to use 152 continuing the event loop. An alternative is to use
114 "EV::FLAG_FORKCHECK" which calls this function automatically, at 153 "EV::FLAG_FORKCHECK" which calls this function automatically, at
115 some performance loss (refer to the libev documentation). 154 some performance loss (refer to the libev documentation).
116 155
117 $loop->loop_verify 156 $loop->verify
118 Calls "ev_verify" to make internal consistency checks (for debugging 157 Calls "ev_verify" to make internal consistency checks (for debugging
119 libev) and abort the program if any data structures were found to be 158 libev) and abort the program if any data structures were found to be
120 corrupted. 159 corrupted.
121 160
122 $loop = EV::default_loop [$flags] 161 $loop = EV::default_loop [$flags]
194 $backend = EV::backend 233 $backend = EV::backend
195 $backend = $loop->backend 234 $backend = $loop->backend
196 Returns an integer describing the backend used by libev 235 Returns an integer describing the backend used by libev
197 (EV::BACKEND_SELECT or EV::BACKEND_EPOLL). 236 (EV::BACKEND_SELECT or EV::BACKEND_EPOLL).
198 237
199 EV::loop [$flags] 238 $active = EV::run [$flags]
200 $loop->loop ([$flags]) 239 $active = $loop->run ([$flags])
201 Begin checking for events and calling callbacks. It returns when a 240 Begin checking for events and calling callbacks. It returns when a
202 callback calls EV::unloop. 241 callback calls EV::unloop or the flasg are nonzero (in which case
242 the return value is true) or when there are no active watchers which
243 reference the loop (keepalive is true), in which case the return
244 value will be false. The returnv alue can generally be interpreted
245 as "if true, there is more work left to do".
203 246
204 The $flags argument can be one of the following: 247 The $flags argument can be one of the following:
205 248
206 0 as above 249 0 as above
207 EV::LOOP_ONESHOT block at most once (wait, but do not loop) 250 EV::RUN_ONCE block at most once (wait, but do not loop)
208 EV::LOOP_NONBLOCK do not block at all (fetch/handle events but do not wait) 251 EV::RUN_NOWAIT do not block at all (fetch/handle events but do not wait)
209 252
210 EV::unloop [$how] 253 EV::break [$how]
211 $loop->unloop ([$how]) 254 $loop->break ([$how])
212 When called with no arguments or an argument of EV::UNLOOP_ONE, 255 When called with no arguments or an argument of EV::BREAK_ONE, makes
213 makes the innermost call to EV::loop return. 256 the innermost call to EV::loop return.
214 257
215 When called with an argument of EV::UNLOOP_ALL, all calls to 258 When called with an argument of EV::BREAK_ALL, all calls to EV::loop
216 EV::loop will return as fast as possible. 259 will return as fast as possible.
217 260
218 $count = EV::loop_count 261 When called with an argument of EV::BREAK_CANCEL, any pending break
219 $count = $loop->loop_count 262 will be cancelled.
263
264 $count = EV::iteration
265 $count = $loop->iteration
220 Return the number of times the event loop has polled for new events. 266 Return the number of times the event loop has polled for new events.
221 Sometimes useful as a generation counter. 267 Sometimes useful as a generation counter.
222 268
223 EV::once $fh_or_undef, $events, $timeout, $cb->($revents) 269 EV::once $fh_or_undef, $events, $timeout, $cb->($revents)
224 $loop->once ($fh_or_undef, $events, $timeout, $cb->($revents)) 270 $loop->once ($fh_or_undef, $events, $timeout, $cb->($revents))
235 Otherwise a EV::timer with this value will be started. 281 Otherwise a EV::timer with this value will be started.
236 282
237 When an error occurs or either the timeout or I/O watcher triggers, 283 When an error occurs or either the timeout or I/O watcher triggers,
238 then the callback will be called with the received event set (in 284 then the callback will be called with the received event set (in
239 general you can expect it to be a combination of "EV::ERROR", 285 general you can expect it to be a combination of "EV::ERROR",
240 "EV::READ", "EV::WRITE" and "EV::TIMEOUT"). 286 "EV::READ", "EV::WRITE" and "EV::TIMER").
241 287
242 EV::once doesn't return anything: the watchers stay active till 288 EV::once doesn't return anything: the watchers stay active till
243 either of them triggers, then they will be stopped and freed, and 289 either of them triggers, then they will be stopped and freed, and
244 the callback invoked. 290 the callback invoked.
245 291
246 EV::feed_fd_event ($fd, $revents) 292 EV::feed_fd_event $fd, $revents
247 $loop->feed_fd_event ($fd, $revents) 293 $loop->feed_fd_event ($fd, $revents)
248 Feed an event on a file descriptor into EV. EV will react to this 294 Feed an event on a file descriptor into EV. EV will react to this
249 call as if the readyness notifications specified by $revents (a 295 call as if the readyness notifications specified by $revents (a
250 combination of "EV::READ" and "EV::WRITE") happened on the file 296 combination of "EV::READ" and "EV::WRITE") happened on the file
251 descriptor $fd. 297 descriptor $fd.
252 298
253 EV::feed_signal_event ($signal) 299 EV::feed_signal_event $signal
254 Feed a signal event into EV. EV will react to this call as if the 300 Feed a signal event into the default loop. EV will react to this
255 signal specified by $signal had occured. 301 call as if the signal specified by $signal had occured.
302
303 EV::feed_signal $signal
304 Feed a signal event into EV - unlike "EV::feed_signal_event", this
305 works regardless of which loop has registered the signal, and is
306 mainly useful fro custom signal implementations.
256 307
257 EV::set_io_collect_interval $time 308 EV::set_io_collect_interval $time
258 $loop->set_io_collect_interval ($time) 309 $loop->set_io_collect_interval ($time)
259 EV::set_timeout_collect_interval $time 310 EV::set_timeout_collect_interval $time
260 $loop->set_timeout_collect_interval ($time) 311 $loop->set_timeout_collect_interval ($time)
263 the libev documentation at 314 the libev documentation at
264 <http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#FUNCTIONS_CONT 315 <http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#FUNCTIONS_CONT
265 ROLLING_THE_EVENT_LOOP> (locally installed as EV::libev) for a more 316 ROLLING_THE_EVENT_LOOP> (locally installed as EV::libev) for a more
266 detailed discussion. 317 detailed discussion.
267 318
319 $count = EV::pending_count
320 $count = $loop->pending_count
321 Returns the number of currently pending watchers.
322
323 EV::invoke_pending
324 $loop->invoke_pending
325 Invoke all currently pending watchers.
326
268WATCHER OBJECTS 327WATCHER OBJECTS
269 A watcher is an object that gets created to record your interest in some 328 A watcher is an object that gets created to record your interest in some
270 event. For instance, if you want to wait for STDIN to become readable, 329 event. For instance, if you want to wait for STDIN to become readable,
271 you would create an EV::io watcher for that: 330 you would create an EV::io watcher for that:
272 331
282 341
283 Each watcher type has its associated bit in revents, so you can use the 342 Each watcher type has its associated bit in revents, so you can use the
284 same callback for multiple watchers. The event mask is named after the 343 same callback for multiple watchers. The event mask is named after the
285 type, i.e. EV::child sets EV::CHILD, EV::prepare sets EV::PREPARE, 344 type, i.e. EV::child sets EV::CHILD, EV::prepare sets EV::PREPARE,
286 EV::periodic sets EV::PERIODIC and so on, with the exception of I/O 345 EV::periodic sets EV::PERIODIC and so on, with the exception of I/O
287 events (which can set both EV::READ and EV::WRITE bits), and EV::timer 346 events (which can set both EV::READ and EV::WRITE bits).
288 (which uses EV::TIMEOUT).
289 347
290 In the rare case where one wants to create a watcher but not start it at 348 In the rare case where one wants to create a watcher but not start it at
291 the same time, each constructor has a variant with a trailing "_ns" in 349 the same time, each constructor has a variant with a trailing "_ns" in
292 its name, e.g. EV::io has a non-starting variant EV::io_ns and so on. 350 its name, e.g. EV::io has a non-starting variant EV::io_ns and so on.
293 351
358 the watcher isn't pending it does nothing and returns 0. 416 the watcher isn't pending it does nothing and returns 0.
359 417
360 $previous_state = $w->keepalive ($bool) 418 $previous_state = $w->keepalive ($bool)
361 Normally, "EV::loop" will return when there are no active watchers 419 Normally, "EV::loop" will return when there are no active watchers
362 (which is a "deadlock" because no progress can be made anymore). 420 (which is a "deadlock" because no progress can be made anymore).
363 This is convinient because it allows you to start your watchers (and 421 This is convenient because it allows you to start your watchers (and
364 your jobs), call "EV::loop" once and when it returns you know that 422 your jobs), call "EV::loop" once and when it returns you know that
365 all your jobs are finished (or they forgot to register some watchers 423 all your jobs are finished (or they forgot to register some watchers
366 for their task :). 424 for their task :).
367 425
368 Sometimes, however, this gets in your way, for example when the 426 Sometimes, however, this gets in your way, for example when the
559 Return the time that the watcher is expected to trigger next. 617 Return the time that the watcher is expected to trigger next.
560 618
561 SIGNAL WATCHERS - signal me when a signal gets signalled! 619 SIGNAL WATCHERS - signal me when a signal gets signalled!
562 $w = EV::signal $signal, $callback 620 $w = EV::signal $signal, $callback
563 $w = EV::signal_ns $signal, $callback 621 $w = EV::signal_ns $signal, $callback
622 $w = $loop->signal ($signal, $callback)
623 $w = $loop->signal_ns ($signal, $callback)
564 Call the callback when $signal is received (the signal can be 624 Call the callback when $signal is received (the signal can be
565 specified by number or by name, just as with "kill" or %SIG). 625 specified by number or by name, just as with "kill" or %SIG).
626
627 Only one event loop can grab a given signal - attempting to grab the
628 same signal from two EV loops will crash the program immediately or
629 cause data corruption.
566 630
567 EV will grab the signal for the process (the kernel only allows one 631 EV will grab the signal for the process (the kernel only allows one
568 component to receive a signal at a time) when you start a signal 632 component to receive a signal at a time) when you start a signal
569 watcher, and removes it again when you stop it. Perl does the same 633 watcher, and removes it again when you stop it. Perl does the same
570 when you add/remove callbacks to %SIG, so watch out. 634 when you add/remove callbacks to %SIG, so watch out.
744 $w = $loop->check_ns ($callback) 808 $w = $loop->check_ns ($callback)
745 Call the callback just after the process wakes up again (after it 809 Call the callback just after the process wakes up again (after it
746 has gathered events), but before any other callbacks have been 810 has gathered events), but before any other callbacks have been
747 invoked. 811 invoked.
748 812
749 This is used to integrate other event-based software into the EV 813 This can be used to integrate other event-based software into the EV
750 mainloop: You register a prepare callback and in there, you create 814 mainloop: You register a prepare callback and in there, you create
751 io and timer watchers as required by the other software. Here is a 815 io and timer watchers as required by the other software. Here is a
752 real-world example of integrating Net::SNMP (with some details left 816 real-world example of integrating Net::SNMP (with some details left
753 out): 817 out):
754 818
790 watchers are destroyed before this can happen (remember EV::check 854 watchers are destroyed before this can happen (remember EV::check
791 gets called first). 855 gets called first).
792 856
793 The "check_ns" variant doesn't start (activate) the newly created 857 The "check_ns" variant doesn't start (activate) the newly created
794 watcher. 858 watcher.
859
860 EV::CHECK constant issues
861 Like all other watcher types, there is a bitmask constant for use in
862 $revents and other places. The "EV::CHECK" is special as it has the
863 same name as the "CHECK" sub called by Perl. This doesn't cause big
864 issues on newer perls (beginning with 5.8.9), but it means thatthe
865 constant must be *inlined*, i.e. runtime calls will not work. That
866 means that as long as you always "use EV" and then "EV::CHECK" you
867 are on the safe side.
795 868
796 FORK WATCHERS - the audacity to resume the event loop after a fork 869 FORK WATCHERS - the audacity to resume the event loop after a fork
797 Fork watchers are called when a "fork ()" was detected. The invocation 870 Fork watchers are called when a "fork ()" was detected. The invocation
798 is done before the event loop blocks next and before "check" watchers 871 is done before the event loop blocks next and before "check" watchers
799 are being called, and only in the child after the fork. 872 are being called, and only in the child after the fork.
820 893
821 In short, this watcher is most useful on BSD systems without working 894 In short, this watcher is most useful on BSD systems without working
822 kqueue to still be able to handle a large number of sockets: 895 kqueue to still be able to handle a large number of sockets:
823 896
824 my $socket_loop; 897 my $socket_loop;
825 898
826 # check wether we use SELECT or POLL _and_ KQUEUE is supported 899 # check wether we use SELECT or POLL _and_ KQUEUE is supported
827 if ( 900 if (
828 (EV::backend & (EV::BACKEND_POLL | EV::BACKEND_SELECT)) 901 (EV::backend & (EV::BACKEND_POLL | EV::BACKEND_SELECT))
829 && (EV::supported_backends & EV::embeddable_backends & EV::BACKEND_KQUEUE) 902 && (EV::supported_backends & EV::embeddable_backends & EV::BACKEND_KQUEUE)
830 ) { 903 ) {
831 # use kqueue for sockets 904 # use kqueue for sockets
832 $socket_loop = new EV::Loop EV::BACKEND_KQUEUE | EV::FLAG_NOENV; 905 $socket_loop = new EV::Loop EV::BACKEND_KQUEUE | EV::FLAG_NOENV;
833 } 906 }
834 907
835 # use the default loop otherwise 908 # use the default loop otherwise
836 $socket_loop ||= EV::default_loop; 909 $socket_loop ||= EV::default_loop;
837 910
838 $w = EV::embed $otherloop[, $callback] 911 $w = EV::embed $otherloop[, $callback]
839 $w = EV::embed_ns $otherloop[, $callback] 912 $w = EV::embed_ns $otherloop[, $callback]
840 $w = $loop->embed ($otherloop[, $callback]) 913 $w = $loop->embed ($otherloop[, $callback])
847 The "embed_ns" variant doesn't start (activate) the newly created 920 The "embed_ns" variant doesn't start (activate) the newly created
848 watcher. 921 watcher.
849 922
850 ASYNC WATCHERS - how to wake up another event loop 923 ASYNC WATCHERS - how to wake up another event loop
851 Async watchers are provided by EV, but have little use in perl directly, 924 Async watchers are provided by EV, but have little use in perl directly,
852 as perl neither supports threads nor direct access to signal handlers or 925 as perl neither supports threads running in parallel nor direct access
853 other contexts where they could be of value. 926 to signal handlers or other contexts where they could be of value.
854 927
855 It is, however, possible to use them from the XS level. 928 It is, however, possible to use them from the XS level.
856 929
857 Please see the libev documentation for further details. 930 Please see the libev documentation for further details.
858 931
859 $w = EV::async $callback 932 $w = EV::async $callback
860 $w = EV::async_ns $callback 933 $w = EV::async_ns $callback
934 $w = $loop->async ($callback)
935 $w = $loop->async_ns ($callback)
861 $w->send 936 $w->send
862 $bool = $w->async_pending 937 $bool = $w->async_pending
938
939 CLEANUP WATCHERS - how to clean up when the event loop goes away
940 Cleanup watchers are not supported on the Perl level, they can only be
941 used via XS currently.
863 942
864PERL SIGNALS 943PERL SIGNALS
865 While Perl signal handling (%SIG) is not affected by EV, the behaviour 944 While Perl signal handling (%SIG) is not affected by EV, the behaviour
866 with EV is as the same as any other C library: Perl-signals will only be 945 with EV is as the same as any other C library: Perl-signals will only be
867 handled when Perl runs, which means your signal handler might be invoked 946 handled when Perl runs, which means your signal handler might be invoked
877 my $async_check = EV::check sub { }; 956 my $async_check = EV::check sub { };
878 957
879 This ensures that perl gets into control for a short time to handle any 958 This ensures that perl gets into control for a short time to handle any
880 pending signals, and also ensures (slightly) slower overall operation. 959 pending signals, and also ensures (slightly) slower overall operation.
881 960
882THREADS 961ITHREADS
883 Threads are not supported by this module in any way. Perl pseudo-threads 962 Ithreads are not supported by this module in any way. Perl
884 is evil stuff and must die. As soon as Perl gains real threads I will 963 pseudo-threads is evil stuff and must die. Real threads as provided by
885 work on thread support for it. 964 Coro are fully supported (and enhanced support is available via
965 Coro::EV).
886 966
887FORK 967FORK
888 Most of the "improved" event delivering mechanisms of modern operating 968 Most of the "improved" event delivering mechanisms of modern operating
889 systems have quite a few problems with fork(2) (to put it bluntly: it is 969 systems have quite a few problems with fork(2) (to put it bluntly: it is
890 not supported and usually destructive). Libev makes it possible to work 970 not supported and usually destructive). Libev makes it possible to work
900 980
901 On win32, there is no notion of fork so all this doesn't apply, of 981 On win32, there is no notion of fork so all this doesn't apply, of
902 course. 982 course.
903 983
904SEE ALSO 984SEE ALSO
905 EV::ADNS (asynchronous DNS), Glib::EV (makes Glib/Gtk2 use EV as event 985 EV::MakeMaker - MakeMaker interface to XS API, EV::ADNS (asynchronous
906 loop), EV::Glib (embed Glib into EV), Coro::EV (efficient coroutines 986 DNS), Glib::EV (makes Glib/Gtk2 use EV as event loop), EV::Glib (embed
907 with EV), Net::SNMP::EV (asynchronous SNMP), AnyEvent for event-loop 987 Glib into EV), Coro::EV (efficient thread integration), Net::SNMP::EV
908 agnostic and portable event driven programming. 988 (asynchronous SNMP), AnyEvent for event-loop agnostic and portable event
989 driven programming.
909 990
910AUTHOR 991AUTHOR
911 Marc Lehmann <schmorp@schmorp.de> 992 Marc Lehmann <schmorp@schmorp.de>
912 http://home.schmorp.de/ 993 http://home.schmorp.de/
913 994

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines