… | |
… | |
68 | package EV; |
68 | package EV; |
69 | |
69 | |
70 | use strict; |
70 | use strict; |
71 | |
71 | |
72 | BEGIN { |
72 | BEGIN { |
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 = |
… | |
… | |
102 | selecting a working backend (which for example rules out kqueue on most |
102 | selecting a working backend (which for example rules out kqueue on most |
103 | BSDs). Modules should, unless they have "special needs" always use the |
103 | BSDs). Modules should, unless they have "special needs" always use the |
104 | default loop as this is fastest (perl-wise), best supported by other |
104 | default loop as this is fastest (perl-wise), best supported by other |
105 | modules (e.g. AnyEvent or Coro) and most portable event loop. |
105 | modules (e.g. AnyEvent or Coro) and most portable event loop. |
106 | |
106 | |
107 | For specific programs you cna create additional event loops dynamically. |
107 | For 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 | |
… | |
… | |
126 | Must be called after a fork in the child, before entering or continuing |
126 | Must be called after a fork in the child, before entering or continuing |
127 | the event loop. An alternative is to use C<EV::FLAG_FORKCHECK> which calls |
127 | the event loop. An alternative is to use C<EV::FLAG_FORKCHECK> which calls |
128 | this fucntion automatically, at some performance loss (refer to the libev |
128 | this fucntion automatically, at some performance loss (refer to the libev |
129 | documentation). |
129 | documentation). |
130 | |
130 | |
|
|
131 | =item $loop = EV::default_loop [$flags] |
|
|
132 | |
|
|
133 | Return 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 | |
… | |
… | |
140 | Must contain a reference to a function that is called when a callback |
144 | Must contain a reference to a function that is called when a callback |
141 | throws an exception (with $@ containing the error). The default prints an |
145 | throws an exception (with $@ containing the error). The default prints an |
142 | informative message and continues. |
146 | informative message and continues. |
143 | |
147 | |
144 | If this callback throws an exception it will be silently ignored. |
148 | If 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 | |
|
|
156 | Returns the set (see C<EV::BACKEND_*> flags) of backends supported by this |
|
|
157 | instance of EV, the set of recommended backends (supposed to be good) for |
|
|
158 | this platform and the set of embeddable backends (see EMBED WATCHERS). |
|
|
159 | |
|
|
160 | =item EV::sleep $seconds |
|
|
161 | |
|
|
162 | Block the process for the given number of (fractional) seconds. |
145 | |
163 | |
146 | =item $time = EV::time |
164 | =item $time = EV::time |
147 | |
165 | |
148 | Returns the current time in (fractional) seconds since the epoch. |
166 | Returns the current time in (fractional) seconds since the epoch. |
149 | |
167 | |
… | |
… | |
208 | If timeout is C<undef> or negative, then there will be no |
226 | If timeout is C<undef> or negative, then there will be no |
209 | timeout. Otherwise a EV::timer with this value will be started. |
227 | timeout. Otherwise a EV::timer with this value will be started. |
210 | |
228 | |
211 | When an error occurs or either the timeout or I/O watcher triggers, then |
229 | When an error occurs or either the timeout or I/O watcher triggers, then |
212 | the callback will be called with the received event set (in general |
230 | the callback will be called with the received event set (in general |
213 | you can expect it to be a combination of C<EV:ERROR>, C<EV::READ>, |
231 | you can expect it to be a combination of C<EV::ERROR>, C<EV::READ>, |
214 | C<EV::WRITE> and C<EV::TIMEOUT>). |
232 | C<EV::WRITE> and C<EV::TIMEOUT>). |
215 | |
233 | |
216 | EV::once doesn't return anything: the watchers stay active till either |
234 | EV::once doesn't return anything: the watchers stay active till either |
217 | of them triggers, then they will be stopped and freed, and the callback |
235 | of them triggers, then they will be stopped and freed, and the callback |
218 | invoked. |
236 | invoked. |
… | |
… | |
228 | =item EV::feed_signal_event ($signal) |
246 | =item EV::feed_signal_event ($signal) |
229 | |
247 | |
230 | Feed a signal event into EV. EV will react to this call as if the signal |
248 | Feed a signal event into EV. EV will react to this call as if the signal |
231 | specified by C<$signal> had occured. |
249 | specified by C<$signal> had occured. |
232 | |
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 | |
|
|
259 | These advanced functions set the minimum block interval when polling for I/O events and the minimum |
|
|
260 | wait interval for timer events. See the libev documentation at |
|
|
261 | L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#FUNCTIONS_CONTROLLING_THE_EVENT_LOOP> for |
|
|
262 | a more detailed discussion. |
|
|
263 | |
233 | =back |
264 | =back |
234 | |
265 | |
235 | |
266 | |
236 | =head1 WATCHER OBJECTS |
267 | =head1 WATCHER OBJECTS |
237 | |
268 | |
… | |
… | |
239 | event. For instance, if you want to wait for STDIN to become readable, you |
270 | event. For instance, if you want to wait for STDIN to become readable, you |
240 | would create an EV::io watcher for that: |
271 | would create an EV::io watcher for that: |
241 | |
272 | |
242 | my $watcher = EV::io *STDIN, EV::READ, sub { |
273 | my $watcher = EV::io *STDIN, EV::READ, sub { |
243 | my ($watcher, $revents) = @_; |
274 | my ($watcher, $revents) = @_; |
244 | warn "yeah, STDIN should not be readable without blocking!\n" |
275 | warn "yeah, STDIN should now be readable without blocking!\n" |
245 | }; |
276 | }; |
246 | |
277 | |
247 | All watchers can be active (waiting for events) or inactive (paused). Only |
278 | All watchers can be active (waiting for events) or inactive (paused). Only |
248 | active watchers will have their callbacks invoked. All callbacks will be |
279 | active watchers will have their callbacks invoked. All callbacks will be |
249 | called with at least two arguments: the watcher and a bitmask of received |
280 | called with at least two arguments: the watcher and a bitmask of received |
… | |
… | |
333 | Feed some events on this watcher into EV. EV will react to this call as if |
364 | Feed some events on this watcher into EV. EV will react to this call as if |
334 | the watcher had received the given C<$revents> mask. |
365 | the watcher had received the given C<$revents> mask. |
335 | |
366 | |
336 | =item $revents = $w->clear_pending |
367 | =item $revents = $w->clear_pending |
337 | |
368 | |
338 | If the watcher is pending, this function returns clears its pending status |
369 | If the watcher is pending, this function clears its pending status and |
339 | and returns its C<$revents> bitset (as if its callback was invoked). If the |
370 | returns its C<$revents> bitset (as if its callback was invoked). If the |
340 | watcher isn't pending it does nothing and returns C<0>. |
371 | watcher isn't pending it does nothing and returns C<0>. |
341 | |
372 | |
342 | =item $previous_state = $w->keepalive ($bool) |
373 | =item $previous_state = $w->keepalive ($bool) |
343 | |
374 | |
344 | Normally, C<EV::loop> will return when there are no active watchers |
375 | Normally, C<EV::loop> will return when there are no active watchers |
345 | (which is a "deadlock" because no progress can be made anymore). This is |
376 | (which is a "deadlock" because no progress can be made anymore). This is |
346 | convinient because it allows you to start your watchers (and your jobs), |
377 | convinient because it allows you to start your watchers (and your jobs), |
347 | call C<EV::loop> once and when it returns you know that all your jobs are |
378 | call C<EV::loop> once and when it returns you know that all your jobs are |
348 | finished (or they forgot to register some watchers for their task :). |
379 | finished (or they forgot to register some watchers for their task :). |
349 | |
380 | |
350 | Sometimes, however, this gets in your way, for example when you the module |
381 | Sometimes, however, this gets in your way, for example when the module |
351 | that calls C<EV::loop> (usually the main program) is not the same module |
382 | that calls C<EV::loop> (usually the main program) is not the same module |
352 | as a long-living watcher (for example a DNS client module written by |
383 | as a long-living watcher (for example a DNS client module written by |
353 | somebody else even). Then you might want any outstanding requests to be |
384 | somebody else even). Then you might want any outstanding requests to be |
354 | handled, but you would not want to keep C<EV::loop> from returning just |
385 | handled, but you would not want to keep C<EV::loop> from returning just |
355 | because you happen to have this long-running UDP port watcher. |
386 | because you happen to have this long-running UDP port watcher. |
… | |
… | |
890 | The C<fork_ns> variant doesn't start (activate) the newly created watcher. |
921 | The C<fork_ns> variant doesn't start (activate) the newly created watcher. |
891 | |
922 | |
892 | =back |
923 | =back |
893 | |
924 | |
894 | |
925 | |
|
|
926 | =head3 EMBED WATCHERS - when one backend isn't enough... |
|
|
927 | |
|
|
928 | This is a rather advanced watcher type that lets you embed one event loop |
|
|
929 | into another (currently only IO events are supported in the embedded |
|
|
930 | loop, other types of watchers might be handled in a delayed or incorrect |
|
|
931 | fashion and must not be used). |
|
|
932 | |
|
|
933 | See the libev documentation at |
|
|
934 | L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#code_ev_embed_code_when_one_backend_> |
|
|
935 | for more details. |
|
|
936 | |
|
|
937 | In short, this watcher is most useful on BSD systems without working |
|
|
938 | kqueue 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 | |
|
|
964 | Call the callback when the embedded event loop (C<$otherloop>) has any |
|
|
965 | I/O activity. The C<$callback> should alwas be specified as C<undef> in |
|
|
966 | this version of EV, which means the embedded event loop will be managed |
|
|
967 | automatically. |
|
|
968 | |
|
|
969 | The C<embed_ns> variant doesn't start (activate) the newly created watcher. |
|
|
970 | |
|
|
971 | =back |
|
|
972 | |
|
|
973 | |
895 | =head1 PERL SIGNALS |
974 | =head1 PERL SIGNALS |
896 | |
975 | |
897 | While Perl signal handling (C<%SIG>) is not affected by EV, the behaviour |
976 | While Perl signal handling (C<%SIG>) is not affected by EV, the behaviour |
898 | with EV is as the same as any other C library: Perl-signals will only be |
977 | with EV is as the same as any other C library: Perl-signals will only be |
899 | handled when Perl runs, which means your signal handler might be invoked |
978 | handled when Perl runs, which means your signal handler might be invoked |