… | |
… | |
119 | package EV; |
119 | package EV; |
120 | |
120 | |
121 | use common::sense; |
121 | use common::sense; |
122 | |
122 | |
123 | BEGIN { |
123 | BEGIN { |
124 | our $VERSION = 4.25; |
124 | our $VERSION = 4.27; |
125 | use XSLoader; |
125 | use XSLoader; |
126 | local $^W = 0; # avoid spurious warning |
126 | local $^W = 0; # avoid spurious warning |
127 | XSLoader::load "EV", $VERSION; |
127 | XSLoader::load "EV", $VERSION; |
128 | } |
128 | } |
129 | |
129 | |
… | |
… | |
248 | |
248 | |
249 | =item $loop->now_update |
249 | =item $loop->now_update |
250 | |
250 | |
251 | Establishes the current time by querying the kernel, updating the time |
251 | Establishes the current time by querying the kernel, updating the time |
252 | returned by C<EV::now> in the progress. This is a costly operation and |
252 | returned by C<EV::now> in the progress. This is a costly operation and |
253 | is usually done automatically within C<EV::loop>. |
253 | is usually done automatically within C<EV::run>. |
254 | |
254 | |
255 | This function is rarely useful, but when some event callback runs for a |
255 | This function is rarely useful, but when some event callback runs for a |
256 | very long time without entering the event loop, updating libev's idea of |
256 | very long time without entering the event loop, updating libev's idea of |
257 | the current time is a good idea. |
257 | the current time is a good idea. |
258 | |
258 | |
… | |
… | |
313 | =item EV::break [$how] |
313 | =item EV::break [$how] |
314 | |
314 | |
315 | =item $loop->break ([$how]) |
315 | =item $loop->break ([$how]) |
316 | |
316 | |
317 | When called with no arguments or an argument of EV::BREAK_ONE, makes the |
317 | When called with no arguments or an argument of EV::BREAK_ONE, makes the |
318 | innermost call to EV::loop return. |
318 | innermost call to EV::run return. |
319 | |
319 | |
320 | When called with an argument of EV::BREAK_ALL, all calls to EV::loop will |
320 | When called with an argument of EV::BREAK_ALL, all calls to EV::run will |
321 | return as fast as possible. |
321 | return as fast as possible. |
322 | |
322 | |
323 | When called with an argument of EV::BREAK_CANCEL, any pending break will |
323 | When called with an argument of EV::BREAK_CANCEL, any pending break will |
324 | be cancelled. |
324 | be cancelled. |
325 | |
325 | |
… | |
… | |
370 | |
370 | |
371 | =item EV::feed_signal $signal |
371 | =item EV::feed_signal $signal |
372 | |
372 | |
373 | Feed a signal event into EV - unlike C<EV::feed_signal_event>, this works |
373 | Feed a signal event into EV - unlike C<EV::feed_signal_event>, this works |
374 | regardless of which loop has registered the signal, and is mainly useful |
374 | regardless of which loop has registered the signal, and is mainly useful |
375 | fro custom signal implementations. |
375 | for custom signal implementations. |
376 | |
376 | |
377 | =item EV::set_io_collect_interval $time |
377 | =item EV::set_io_collect_interval $time |
378 | |
378 | |
379 | =item $loop->set_io_collect_interval ($time) |
379 | =item $loop->set_io_collect_interval ($time) |
380 | |
380 | |
… | |
… | |
507 | returns its C<$revents> bitset (as if its callback was invoked). If the |
507 | returns its C<$revents> bitset (as if its callback was invoked). If the |
508 | watcher isn't pending it does nothing and returns C<0>. |
508 | watcher isn't pending it does nothing and returns C<0>. |
509 | |
509 | |
510 | =item $previous_state = $w->keepalive ($bool) |
510 | =item $previous_state = $w->keepalive ($bool) |
511 | |
511 | |
512 | Normally, C<EV::loop> will return when there are no active watchers |
512 | Normally, C<EV::run> will return when there are no active watchers |
513 | (which is a "deadlock" because no progress can be made anymore). This is |
513 | (which is a "deadlock" because no progress can be made anymore). This is |
514 | convenient because it allows you to start your watchers (and your jobs), |
514 | convenient because it allows you to start your watchers (and your jobs), |
515 | call C<EV::loop> once and when it returns you know that all your jobs are |
515 | call C<EV::run> once and when it returns you know that all your jobs are |
516 | finished (or they forgot to register some watchers for their task :). |
516 | finished (or they forgot to register some watchers for their task :). |
517 | |
517 | |
518 | Sometimes, however, this gets in your way, for example when the module |
518 | Sometimes, however, this gets in your way, for example when the module |
519 | that calls C<EV::loop> (usually the main program) is not the same module |
519 | that calls C<EV::run> (usually the main program) is not the same module |
520 | as a long-living watcher (for example a DNS client module written by |
520 | as a long-living watcher (for example a DNS client module written by |
521 | somebody else even). Then you might want any outstanding requests to be |
521 | somebody else even). Then you might want any outstanding requests to be |
522 | handled, but you would not want to keep C<EV::loop> from returning just |
522 | handled, but you would not want to keep C<EV::run> from returning just |
523 | because you happen to have this long-running UDP port watcher. |
523 | because you happen to have this long-running UDP port watcher. |
524 | |
524 | |
525 | In this case you can clear the keepalive status, which means that even |
525 | In this case you can clear the keepalive status, which means that even |
526 | though your watcher is active, it won't keep C<EV::loop> from returning. |
526 | though your watcher is active, it won't keep C<EV::run> from returning. |
527 | |
527 | |
528 | The initial value for keepalive is true (enabled), and you can change it |
528 | The initial value for keepalive is true (enabled), and you can change it |
529 | any time. |
529 | any time. |
530 | |
530 | |
531 | Example: Register an I/O watcher for some UDP socket but do not keep the |
531 | Example: Register an I/O watcher for some UDP socket but do not keep the |