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.79 by root, Sat Dec 22 16:37:07 2007 UTC

… …
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).
145 159
146=item $time = EV::time 160=item $time = EV::time
147 161
148Returns the current time in (fractional) seconds since the epoch. 162Returns the current time in (fractional) seconds since the epoch.
149 163
… …
227 241
228=item EV::feed_signal_event ($signal) 242=item EV::feed_signal_event ($signal)
229 243
230Feed a signal event into EV. EV will react to this call as if the signal 244Feed a signal event into EV. EV will react to this call as if the signal
231specified by C<$signal> had occured. 245specified by C<$signal> had occured.
246
247=item EV::set_io_collect_interval $time
248
249=item $loop->set_io_collect_interval ($time)
250
251=item EV::set_timeout_collect_interval $time
252
253=item $loop->set_timeout_collect_interval ($time)
254
255These advanced functions set the minimum block interval when polling for I/O events and the minimum
256wait interval for timer events. See the libev documentation at
257L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#FUNCTIONS_CONTROLLING_THE_EVENT_LOOP> for
258a more detailed discussion.
232 259
233=back 260=back
234 261
235 262
236=head1 WATCHER OBJECTS 263=head1 WATCHER OBJECTS
… …
890The C<fork_ns> variant doesn't start (activate) the newly created watcher. 917The C<fork_ns> variant doesn't start (activate) the newly created watcher.
891 918
892=back 919=back
893 920
894 921
922=head3 EMBED WATCHERS - when one backend isn't enough...
923
924This is a rather advanced watcher type that lets you embed one event loop
925into another (currently only IO events are supported in the embedded
926loop, other types of watchers might be handled in a delayed or incorrect
927fashion and must not be used).
928
929See the libev documentation at
930L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#code_ev_embed_code_when_one_backend_>
931for more details.
932
933In short, this watcher is most useful on BSD systems without working
934kqueue to still be able to handle a large number of sockets:
935
936 my $socket_loop;
937
938 # check wether we use SELECT or POLL _and_ KQUEUE is supported
939 if (
940 (EV::backend & (EV::BACKEND_POLL | EV::BACKEND_SELECT))
941 && (EV::supported_backends & EV::embeddable_backends & EV::BACKEND_KQUEUE)
942 ) {
943 # use kqueue for sockets
944 $socket_loop = new EV::Loop EV::BACKEND_KQUEUE | EV::FLAG_NOENV;
945 }
946
947 # use the default loop otherwise
948 $socket_loop ||= EV::default_loop;
949
950=over 4
951
952=item $w = EV::embed $otherloop, $callback
953
954=item $w = EV::embed_ns $otherloop, $callback
955
956=item $w = $loop->embed ($otherloop, $callback)
957
958=item $w = $loop->embed_ns ($otherloop, $callback)
959
960Call the callback when the embedded event loop (C<$otherloop>) has any
961I/O activity. The C<$callback> should alwas be specified as C<undef> in
962this version of EV, which means the embedded event loop will be managed
963automatically.
964
965The C<embed_ns> variant doesn't start (activate) the newly created watcher.
966
967=back
968
969
895=head1 PERL SIGNALS 970=head1 PERL SIGNALS
896 971
897While Perl signal handling (C<%SIG>) is not affected by EV, the behaviour 972While Perl signal handling (C<%SIG>) is not affected by EV, the behaviour
898with EV is as the same as any other C library: Perl-signals will only be 973with EV is as the same as any other C library: Perl-signals will only be
899handled when Perl runs, which means your signal handler might be invoked 974handled when Perl runs, which means your signal handler might be invoked

Diff Legend

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