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

Comparing EV/EV.pm (file contents):
Revision 1.78 by root, Sat Dec 22 11:50:04 2007 UTC vs.
Revision 1.82 by root, Fri Jan 25 15:45:08 2008 UTC

… …
35 warn "sigquit received\n"; 35 warn "sigquit received\n";
36 }; 36 };
37 37
38 # CHILD/PID STATUS CHANGES 38 # CHILD/PID STATUS CHANGES
39 39
40 my $w = EV::child 666, sub { 40 my $w = EV::child 666, 0, sub {
41 my ($w, $revents) = @_; 41 my ($w, $revents) = @_;
42 my $status = $w->rstatus; 42 my $status = $w->rstatus;
43 }; 43 };
44 44
45 # STAT CHANGES 45 # STAT CHANGES
… …
68package EV; 68package EV;
69 69
70use strict; 70use strict;
71 71
72BEGIN { 72BEGIN {
73 our $VERSION = '2.0'; 73 our $VERSION = '2.01';
74 use XSLoader; 74 use XSLoader;
75 XSLoader::load "EV", $VERSION; 75 XSLoader::load "EV", $VERSION;
76} 76}
77 77
78@EV::IO::ISA = 78@EV::IO::ISA =
… …
102selecting a working backend (which for example rules out kqueue on most 102selecting a working backend (which for example rules out kqueue on most
103BSDs). Modules should, unless they have "special needs" always use the 103BSDs). Modules should, unless they have "special needs" always use the
104default loop as this is fastest (perl-wise), best supported by other 104default loop as this is fastest (perl-wise), best supported by other
105modules (e.g. AnyEvent or Coro) and most portable event loop. 105modules (e.g. AnyEvent or Coro) and most portable event loop.
106 106
107For specific programs you cna create additional event loops dynamically. 107For specific programs you can create additional event loops dynamically.
108 108
109=over 4 109=over 4
110 110
111=item $loop = new EV::loop [$flags] 111=item $loop = new EV::loop [$flags]
112 112
… …
126Must be called after a fork in the child, before entering or continuing 126Must 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 127the event loop. An alternative is to use C<EV::FLAG_FORKCHECK> which calls
128this fucntion automatically, at some performance loss (refer to the libev 128this fucntion automatically, at some performance loss (refer to the libev
129documentation). 129documentation).
130 130
131=item $loop = EV::default_loop [$flags]
132
133Return the default loop (which is a singleton object).
134
131=back 135=back
132 136
133 137
134=head1 BASIC INTERFACE 138=head1 BASIC INTERFACE
135 139
… …
140Must contain a reference to a function that is called when a callback 144Must contain a reference to a function that is called when a callback
141throws an exception (with $@ containing the error). The default prints an 145throws an exception (with $@ containing the error). The default prints an
142informative message and continues. 146informative message and continues.
143 147
144If this callback throws an exception it will be silently ignored. 148If this callback throws an exception it will be silently ignored.
149
150=item $flags = EV::supported_backends
151
152=item $flags = EV::recommended_backends
153
154=item $flags = EV::embeddable_backends
155
156Returns the set (see C<EV::BACKEND_*> flags) of backends supported by this
157instance of EV, the set of recommended backends (supposed to be good) for
158this platform and the set of embeddable backends (see EMBED WATCHERS).
159
160=item EV::sleep $seconds
161
162Block the process for the given number of (fractional) seconds.
145 163
146=item $time = EV::time 164=item $time = EV::time
147 165
148Returns the current time in (fractional) seconds since the epoch. 166Returns the current time in (fractional) seconds since the epoch.
149 167
… …
227 245
228=item EV::feed_signal_event ($signal) 246=item EV::feed_signal_event ($signal)
229 247
230Feed a signal event into EV. EV will react to this call as if the signal 248Feed a signal event into EV. EV will react to this call as if the signal
231specified by C<$signal> had occured. 249specified by C<$signal> had occured.
250
251=item EV::set_io_collect_interval $time
252
253=item $loop->set_io_collect_interval ($time)
254
255=item EV::set_timeout_collect_interval $time
256
257=item $loop->set_timeout_collect_interval ($time)
258
259These 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
261L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#FUNCTIONS_CONTROLLING_THE_EVENT_LOOP> for
262a more detailed discussion.
232 263
233=back 264=back
234 265
235 266
236=head1 WATCHER OBJECTS 267=head1 WATCHER OBJECTS
… …
613 644
614=head3 CHILD WATCHERS - watch out for process status changes 645=head3 CHILD WATCHERS - watch out for process status changes
615 646
616=over 4 647=over 4
617 648
618=item $w = EV::child $pid, $callback 649=item $w = EV::child $pid, $trace, $callback
619 650
620=item $w = EV::child_ns $pid, $callback 651=item $w = EV::child_ns $pid, $trace, $callback
621 652
622=item $w = $loop->child ($pid, $callback) 653=item $w = $loop->child ($pid, $trace, $callback)
623 654
624=item $w = $loop->child_ns ($pid, $callback) 655=item $w = $loop->child_ns ($pid, $trace, $callback)
625 656
626Call the callback when a status change for pid C<$pid> (or any pid if 657Call the callback when a status change for pid C<$pid> (or any pid
627C<$pid> is 0) has been received. More precisely: when the process receives 658if C<$pid> is 0) has been received (a status change happens when the
659process terminates or is killed, or, when trace is true, additionally when
660it is stopped or continued). More precisely: when the process receives
628a C<SIGCHLD>, EV will fetch the outstanding exit/wait status for all 661a C<SIGCHLD>, EV will fetch the outstanding exit/wait status for all
629changed/zombie children and call the callback. 662changed/zombie children and call the callback.
630 663
631It is valid (and fully supported) to install a child watcher after a child 664It is valid (and fully supported) to install a child watcher after a child
632has exited but before the event loop has started its next iteration (for 665has exited but before the event loop has started its next iteration (for
… …
639You can have as many pid watchers per pid as you want, they will all be 672You can have as many pid watchers per pid as you want, they will all be
640called. 673called.
641 674
642The C<child_ns> variant doesn't start (activate) the newly created watcher. 675The C<child_ns> variant doesn't start (activate) the newly created watcher.
643 676
644=item $w->set ($pid) 677=item $w->set ($pid, $trace)
645 678
646Reconfigures the watcher, see the constructor above for details. Can be called at 679Reconfigures the watcher, see the constructor above for details. Can be called at
647any time. 680any time.
648 681
649=item $current_pid = $w->pid 682=item $current_pid = $w->pid
650
651=item $old_pid = $w->pid ($new_pid)
652 683
653Returns the previously set process id and optionally set a new one. 684Returns the previously set process id and optionally set a new one.
654 685
655=item $exit_status = $w->rstatus 686=item $exit_status = $w->rstatus
656 687
… …
886 917
887Call the callback before the event loop is resumed in the child process 918Call the callback before the event loop is resumed in the child process
888after a fork. 919after a fork.
889 920
890The C<fork_ns> variant doesn't start (activate) the newly created watcher. 921The C<fork_ns> variant doesn't start (activate) the newly created watcher.
922
923=back
924
925
926=head3 EMBED WATCHERS - when one backend isn't enough...
927
928This is a rather advanced watcher type that lets you embed one event loop
929into another (currently only IO events are supported in the embedded
930loop, other types of watchers might be handled in a delayed or incorrect
931fashion and must not be used).
932
933See the libev documentation at
934L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#code_ev_embed_code_when_one_backend_>
935for more details.
936
937In short, this watcher is most useful on BSD systems without working
938kqueue to still be able to handle a large number of sockets:
939
940 my $socket_loop;
941
942 # check wether we use SELECT or POLL _and_ KQUEUE is supported
943 if (
944 (EV::backend & (EV::BACKEND_POLL | EV::BACKEND_SELECT))
945 && (EV::supported_backends & EV::embeddable_backends & EV::BACKEND_KQUEUE)
946 ) {
947 # use kqueue for sockets
948 $socket_loop = new EV::Loop EV::BACKEND_KQUEUE | EV::FLAG_NOENV;
949 }
950
951 # use the default loop otherwise
952 $socket_loop ||= EV::default_loop;
953
954=over 4
955
956=item $w = EV::embed $otherloop, $callback
957
958=item $w = EV::embed_ns $otherloop, $callback
959
960=item $w = $loop->embed ($otherloop, $callback)
961
962=item $w = $loop->embed_ns ($otherloop, $callback)
963
964Call 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
966this version of EV, which means the embedded event loop will be managed
967automatically.
968
969The C<embed_ns> variant doesn't start (activate) the newly created watcher.
891 970
892=back 971=back
893 972
894 973
895=head1 PERL SIGNALS 974=head1 PERL SIGNALS

Diff Legend

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