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

Comparing EV/EV.pm (file contents):
Revision 1.81 by root, Mon Dec 31 00:59:34 2007 UTC vs.
Revision 1.124 by root, Tue Dec 1 13:56:33 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, 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
70use strict; 81use common::sense;
71 82
72BEGIN { 83BEGIN {
73 our $VERSION = '2.01'; 84 our $VERSION = '3.8';
74 use XSLoader; 85 use XSLoader;
75 XSLoader::load "EV", $VERSION; 86 XSLoader::load "EV", $VERSION;
76} 87}
77 88
78@EV::IO::ISA = 89@EV::IO::ISA =
… …
84@EV::Idle::ISA = 95@EV::Idle::ISA =
85@EV::Prepare::ISA = 96@EV::Prepare::ISA =
86@EV::Check::ISA = 97@EV::Check::ISA =
87@EV::Embed::ISA = 98@EV::Embed::ISA =
88@EV::Fork::ISA = 99@EV::Fork::ISA =
100@EV::Async::ISA =
89 "EV::Watcher"; 101 "EV::Watcher";
90 102
91@EV::Loop::Default::ISA = "EV::Loop"; 103@EV::Loop::Default::ISA = "EV::Loop";
92 104
93=head1 EVENT LOOPS 105=head1 EVENT LOOPS
… …
104default loop as this is fastest (perl-wise), best supported by other 116default loop as this is fastest (perl-wise), best supported by other
105modules (e.g. AnyEvent or Coro) and most portable event loop. 117modules (e.g. AnyEvent or Coro) and most portable event loop.
106 118
107For specific programs you can create additional event loops dynamically. 119For specific programs you can create additional event loops dynamically.
108 120
109=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.
110 126
127=over 4
128
111=item $loop = new EV::loop [$flags] 129=item $loop = new EV::Loop [$flags]
112 130
113Create 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
114C<ev_loop_new ()> function description in the libev documentation 132the C<ev_loop_new ()> function description in the libev documentation
115(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>,
116for more info. 134or locally-installed as F<EV::libev> manpage) for more info.
117 135
118The loop will automatically be destroyed when it is no longer referenced 136The loop will automatically be destroyed when it is no longer referenced
119by any watcher and the loop object goes out of scope. 137by any watcher and the loop object goes out of scope.
120 138
121Using 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>
122is 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.
123 143
124=item $loop->loop_fork 144=item $loop->loop_fork
125 145
126Must 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
127the 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
128this fucntion automatically, at some performance loss (refer to the libev 148this function automatically, at some performance loss (refer to the libev
129documentation). 149documentation).
130 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
131=item $loop = EV::default_loop [$flags] 157=item $loop = EV::default_loop [$flags]
132 158
133Return 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.
134 164
135=back 165=back
136 166
137 167
138=head1 BASIC INTERFACE 168=head1 BASIC INTERFACE
… …
168=item $time = EV::now 198=item $time = EV::now
169 199
170=item $time = $loop->now 200=item $time = $loop->now
171 201
172Returns the time the last event loop iteration has been started. This 202Returns the time the last event loop iteration has been started. This
173is 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
174usually faster then calling EV::time. 204usually faster then calling EV::time.
175 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
176=item $backend = EV::backend 248=item $backend = EV::backend
177 249
178=item $backend = $loop->backend 250=item $backend = $loop->backend
179 251
180Returns an integer describing the backend used by libev (EV::METHOD_SELECT 252Returns an integer describing the backend used by libev (EV::BACKEND_SELECT
181or EV::METHOD_EPOLL). 253or EV::BACKEND_EPOLL).
182 254
183=item EV::loop [$flags] 255=item EV::loop [$flags]
184 256
185=item $loop->loop ([$flags]) 257=item $loop->loop ([$flags])
186 258
… …
206=item $count = EV::loop_count 278=item $count = EV::loop_count
207 279
208=item $count = $loop->loop_count 280=item $count = $loop->loop_count
209 281
210Return the number of times the event loop has polled for new 282Return the number of times the event loop has polled for new
211events. Sometiems useful as a generation counter. 283events. Sometimes useful as a generation counter.
212 284
213=item EV::once $fh_or_undef, $events, $timeout, $cb->($revents) 285=item EV::once $fh_or_undef, $events, $timeout, $cb->($revents)
214 286
215=item $loop->once ($fh_or_undef, $events, $timeout, $cb->($revents)) 287=item $loop->once ($fh_or_undef, $events, $timeout, $cb->($revents))
216 288
… …
256 328
257=item $loop->set_timeout_collect_interval ($time) 329=item $loop->set_timeout_collect_interval ($time)
258 330
259These 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
260wait interval for timer events. See the libev documentation at 332wait interval for timer events. See the libev documentation at
261L<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>
262a 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.
263 347
264=back 348=back
265 349
266 350
267=head1 WATCHER OBJECTS 351=head1 WATCHER OBJECTS
268 352
269A 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
270event. 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
271would create an EV::io watcher for that: 355would create an EV::io watcher for that:
272 356
273 my $watcher = EV::io *STDIN, EV::READ, sub { 357 my $watcher = EV::io *STDIN, EV::READ, sub {
274 my ($watcher, $revents) = @_; 358 my ($watcher, $revents) = @_;
275 warn "yeah, STDIN should now be readable without blocking!\n" 359 warn "yeah, STDIN should now be readable without blocking!\n"
276 }; 360 };
277 361
278All watchers can be active (waiting for events) or inactive (paused). Only 362All watchers can be active (waiting for events) or inactive (paused). Only
279active watchers will have their callbacks invoked. All callbacks will be 363active watchers will have their callbacks invoked. All callbacks will be
280called 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
281events. 365events.
282 366
283Each 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
284same callback for multiple watchers. The event mask is named after the 368same callback for multiple watchers. The event mask is named after the
285type, 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,
286EV::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
287(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
288uses EV::TIMEOUT). 372uses EV::TIMEOUT).
289 373
290In 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
… …
372 456
373=item $previous_state = $w->keepalive ($bool) 457=item $previous_state = $w->keepalive ($bool)
374 458
375Normally, C<EV::loop> will return when there are no active watchers 459Normally, C<EV::loop> will return when there are no active watchers
376(which is a "deadlock" because no progress can be made anymore). This is 460(which is a "deadlock" because no progress can be made anymore). This is
377convinient because it allows you to start your watchers (and your jobs), 461convenient because it allows you to start your watchers (and your jobs),
378call C<EV::loop> once and when it returns you know that all your jobs are 462call C<EV::loop> once and when it returns you know that all your jobs are
379finished (or they forgot to register some watchers for their task :). 463finished (or they forgot to register some watchers for their task :).
380 464
381Sometimes, however, this gets in your way, for example when the module 465Sometimes, however, this gets in your way, for example when the module
382that calls C<EV::loop> (usually the main program) is not the same module 466that calls C<EV::loop> (usually the main program) is not the same module
… …
386because you happen to have this long-running UDP port watcher. 470because you happen to have this long-running UDP port watcher.
387 471
388In 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
389though 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.
390 474
391The 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
392any time. 476any time.
393 477
394Example: 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
395event loop from running just because of that watcher. 479event loop from running just because of that watcher.
396 480
397 my $udp_socket = ... 481 my $udp_socket = ...
398 my $udp_watcher = EV::io $udp_socket, EV::READ, sub { ... }; 482 my $udp_watcher = EV::io $udp_socket, EV::READ, sub { ... };
399 $1000udp_watcher->keepalive (0); 483 $udp_watcher->keepalive (0);
400 484
401=item $loop = $w->loop 485=item $loop = $w->loop
402 486
403Return the loop that this watcher is attached to. 487Return the loop that this watcher is attached to.
404 488
… …
533This time simply fires at the wallclock time C<$at> and doesn't repeat. It 617This time simply fires at the wallclock time C<$at> and doesn't repeat. It
534will not adjust when a time jump occurs, that is, if it is to be run 618will not adjust when a time jump occurs, that is, if it is to be run
535at January 1st 2011 then it will run when the system time reaches or 619at January 1st 2011 then it will run when the system time reaches or
536surpasses this time. 620surpasses this time.
537 621
538=item * non-repeating interval timer ($interval > 0, $reschedule_cb = 0) 622=item * repeating interval timer ($interval > 0, $reschedule_cb = 0)
539 623
540In this mode the watcher will always be scheduled to time out at the 624In this mode the watcher will always be scheduled to time out at the
541next C<$at + N * $interval> time (for some integer N) and then repeat, 625next C<$at + N * $interval> time (for some integer N) and then repeat,
542regardless of any time jumps. 626regardless of any time jumps.
543 627
… …
561time the periodic watcher gets scheduled, the reschedule callback 645time the periodic watcher gets scheduled, the reschedule callback
562($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
563time as second argument. 647time as second argument.
564 648
565I<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
566watcher, 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
567afterwards. 651you need to stop it, return 1e30 and stop it afterwards. You may create
652and start a C<EV::prepare> watcher for this task.
568 653
569It 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
570(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
571will usually be called just before the callback will be triggered, but 656argument). It will usually be called just before the callback will be
572might be called at other times, too. 657triggered, but might be called at other times, too.
573 658
574This 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
575triggers on each midnight, local time (actually 24 hours after the last 660triggers on each midnight, local time (actually 24 hours after the last
576midnight, 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
577in about the same space (without requiring elaborate modules), drop me a 662in about the same space (without requiring elaborate modules), drop me a
… …
613 698
614=item $w = EV::signal $signal, $callback 699=item $w = EV::signal $signal, $callback
615 700
616=item $w = EV::signal_ns $signal, $callback 701=item $w = EV::signal_ns $signal, $callback
617 702
703=item $w = $loop->signal ($signal, $callback)
704
705=item $w = $loop->signal_ns ($signal, $callback)
706
618Call the callback when $signal is received (the signal can be specified by 707Call the callback when $signal is received (the signal can be specified by
619number or by name, just as with C<kill> or C<%SIG>). 708number or by name, just as with C<kill> or C<%SIG>).
709
710Only one event loop can grab a given signal - attempting to grab the same
711signal from two EV loops will crash the program immediately or cause data
712corruption.
620 713
621EV will grab the signal for the process (the kernel only allows one 714EV will grab the signal for the process (the kernel only allows one
622component to receive a signal at a time) when you start a signal watcher, 715component to receive a signal at a time) when you start a signal watcher,
623and removes it again when you stop it. Perl does the same when you 716and removes it again when you stop it. Perl does the same when you
624add/remove callbacks to C<%SIG>, so watch out. 717add/remove callbacks to C<%SIG>, so watch out.
… …
644 737
645=head3 CHILD WATCHERS - watch out for process status changes 738=head3 CHILD WATCHERS - watch out for process status changes
646 739
647=over 4 740=over 4
648 741
649=item $w = EV::child $pid, $callback 742=item $w = EV::child $pid, $trace, $callback
650 743
651=item $w = EV::child_ns $pid, $callback 744=item $w = EV::child_ns $pid, $trace, $callback
652 745
653=item $w = $loop->child ($pid, $callback) 746=item $w = $loop->child ($pid, $trace, $callback)
654 747
655=item $w = $loop->child_ns ($pid, $callback) 748=item $w = $loop->child_ns ($pid, $trace, $callback)
656 749
657Call the callback when a status change for pid C<$pid> (or any pid if 750Call the callback when a status change for pid C<$pid> (or any pid
658C<$pid> is 0) has been received. More precisely: when the process receives 751if C<$pid> is 0) has been received (a status change happens when the
752process terminates or is killed, or, when trace is true, additionally when
753it is stopped or continued). More precisely: when the process receives
659a C<SIGCHLD>, EV will fetch the outstanding exit/wait status for all 754a C<SIGCHLD>, EV will fetch the outstanding exit/wait status for all
660changed/zombie children and call the callback. 755changed/zombie children and call the callback.
661 756
662It is valid (and fully supported) to install a child watcher after a child 757It is valid (and fully supported) to install a child watcher after a child
663has exited but before the event loop has started its next iteration (for 758has exited but before the event loop has started its next iteration (for
… …
670You can have as many pid watchers per pid as you want, they will all be 765You can have as many pid watchers per pid as you want, they will all be
671called. 766called.
672 767
673The C<child_ns> variant doesn't start (activate) the newly created watcher. 768The C<child_ns> variant doesn't start (activate) the newly created watcher.
674 769
675=item $w->set ($pid) 770=item $w->set ($pid, $trace)
676 771
677Reconfigures the watcher, see the constructor above for details. Can be called at 772Reconfigures the watcher, see the constructor above for details. Can be called at
678any time. 773any time.
679 774
680=item $current_pid = $w->pid 775=item $current_pid = $w->pid
681
682=item $old_pid = $w->pid ($new_pid)
683 776
684Returns the previously set process id and optionally set a new one. 777Returns the previously set process id and optionally set a new one.
685 778
686=item $exit_status = $w->rstatus 779=item $exit_status = $w->rstatus
687 780
… …
889 # make the dispatcher handle any new stuff 982 # make the dispatcher handle any new stuff
890 ... not shown 983 ... not shown
891 }; 984 };
892 985
893The callbacks of the created watchers will not be called as the watchers 986The callbacks of the created watchers will not be called as the watchers
894are destroyed before this cna happen (remember EV::check gets called 987are destroyed before this can happen (remember EV::check gets called
895first). 988first).
896 989
897The C<check_ns> variant doesn't start (activate) the newly created watcher. 990The C<check_ns> variant doesn't start (activate) the newly created watcher.
898 991
899=back 992=back
… …
930loop, other types of watchers might be handled in a delayed or incorrect 1023loop, other types of watchers might be handled in a delayed or incorrect
931fashion and must not be used). 1024fashion and must not be used).
932 1025
933See the libev documentation at 1026See the libev documentation at
934L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#code_ev_embed_code_when_one_backend_> 1027L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#code_ev_embed_code_when_one_backend_>
935for more details. 1028(locally installed as F<EV::libev>) for more details.
936 1029
937In short, this watcher is most useful on BSD systems without working 1030In short, this watcher is most useful on BSD systems without working
938kqueue to still be able to handle a large number of sockets: 1031kqueue to still be able to handle a large number of sockets:
939 1032
940 my $socket_loop; 1033 my $socket_loop;
941 1034
942 # check wether we use SELECT or POLL _and_ KQUEUE is supported 1035 # check wether we use SELECT or POLL _and_ KQUEUE is supported
943 if ( 1036 if (
944 (EV::backend & (EV::BACKEND_POLL | EV::BACKEND_SELECT)) 1037 (EV::backend & (EV::BACKEND_POLL | EV::BACKEND_SELECT))
945 && (EV::supported_backends & EV::embeddable_backends & EV::BACKEND_KQUEUE) 1038 && (EV::supported_backends & EV::embeddable_backends & EV::BACKEND_KQUEUE)
946 ) { 1039 ) {
947 # use kqueue for sockets 1040 # use kqueue for sockets
948 $socket_loop = new EV::Loop EV::BACKEND_KQUEUE | EV::FLAG_NOENV; 1041 $socket_loop = new EV::Loop EV::BACKEND_KQUEUE | EV::FLAG_NOENV;
949 } 1042 }
950 1043
951 # use the default loop otherwise 1044 # use the default loop otherwise
952 $socket_loop ||= EV::default_loop; 1045 $socket_loop ||= EV::default_loop;
953 1046
954=over 4 1047=over 4
955 1048
956=item $w = EV::embed $otherloop, $callback 1049=item $w = EV::embed $otherloop[, $callback]
957 1050
958=item $w = EV::embed_ns $otherloop, $callback 1051=item $w = EV::embed_ns $otherloop[, $callback]
959 1052
960=item $w = $loop->embed ($otherloop, $callback) 1053=item $w = $loop->embed ($otherloop[, $callback])
961 1054
962=item $w = $loop->embed_ns ($otherloop, $callback) 1055=item $w = $loop->embed_ns ($otherloop[, $callback])
963 1056
964Call the callback when the embedded event loop (C<$otherloop>) has any 1057Call the callback when the embedded event loop (C<$otherloop>) has any
965I/O activity. The C<$callback> should alwas be specified as C<undef> in 1058I/O activity. The C<$callback> is optional: if it is missing, then the
966this version of EV, which means the embedded event loop will be managed 1059embedded event loop will be managed automatically (which is recommended),
967automatically. 1060otherwise you have to invoke C<sweep> yourself.
968 1061
969The C<embed_ns> variant doesn't start (activate) the newly created watcher. 1062The C<embed_ns> variant doesn't start (activate) the newly created watcher.
1063
1064=back
1065
1066=head3 ASYNC WATCHERS - how to wake up another event loop
1067
1068Async watchers are provided by EV, but have little use in perl directly,
1069as perl neither supports threads running in parallel nor direct access to
1070signal handlers or other contexts where they could be of value.
1071
1072It is, however, possible to use them from the XS level.
1073
1074Please see the libev documentation for further details.
1075
1076=over 4
1077
1078=item $w = EV::async $callback
1079
1080=item $w = EV::async_ns $callback
1081
1082=item $w->send
1083
1084=item $bool = $w->async_pending
970 1085
971=back 1086=back
972 1087
973 1088
974=head1 PERL SIGNALS 1089=head1 PERL SIGNALS
… …
988 my $async_check = EV::check sub { }; 1103 my $async_check = EV::check sub { };
989 1104
990This ensures that perl gets into control for a short time to handle any 1105This ensures that perl gets into control for a short time to handle any
991pending signals, and also ensures (slightly) slower overall operation. 1106pending signals, and also ensures (slightly) slower overall operation.
992 1107
993=head1 THREADS 1108=head1 ITHREADS
994 1109
995Threads are not supported by this module in any way. Perl pseudo-threads 1110Ithreads are not supported by this module in any way. Perl pseudo-threads
996is evil stuff and must die. As soon as Perl gains real threads I will work 1111is evil stuff and must die. Real threads as provided by Coro are fully
997on thread support for it. 1112supported (and enhanced support is available via L<Coro::EV>).
998 1113
999=head1 FORK 1114=head1 FORK
1000 1115
1001Most of the "improved" event delivering mechanisms of modern operating 1116Most of the "improved" event delivering mechanisms of modern operating
1002systems have quite a few problems with fork(2) (to put it bluntly: it is 1117systems have quite a few problems with fork(2) (to put it bluntly: it is
… …
1026 1141
1027=head1 SEE ALSO 1142=head1 SEE ALSO
1028 1143
1029L<EV::ADNS> (asynchronous DNS), L<Glib::EV> (makes Glib/Gtk2 use EV as 1144L<EV::ADNS> (asynchronous DNS), L<Glib::EV> (makes Glib/Gtk2 use EV as
1030event loop), L<EV::Glib> (embed Glib into EV), L<Coro::EV> (efficient 1145event loop), L<EV::Glib> (embed Glib into EV), L<Coro::EV> (efficient
1031coroutines with EV), L<Net::SNMP::EV> (asynchronous SNMP). 1146coroutines with EV), L<Net::SNMP::EV> (asynchronous SNMP), L<AnyEvent> for
1147event-loop agnostic and portable event driven programming.
1032 1148
1033=head1 AUTHOR 1149=head1 AUTHOR
1034 1150
1035 Marc Lehmann <schmorp@schmorp.de> 1151 Marc Lehmann <schmorp@schmorp.de>
1036 http://home.schmorp.de/ 1152 http://home.schmorp.de/
1037 1153
1038=cut 1154=cut
1039 1155

Diff Legend

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