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

Comparing EV/EV.pm (file contents):
Revision 1.152 by root, Sun Oct 28 23:40:32 2018 UTC vs.
Revision 1.162 by root, Wed Jan 22 23:17:31 2020 UTC

… …
119package EV; 119package EV;
120 120
121use common::sense; 121use common::sense;
122 122
123BEGIN { 123BEGIN {
124 our $VERSION = 4.22; 124 our $VERSION = '4.31';
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
251Establishes the current time by querying the kernel, updating the time 251Establishes the current time by querying the kernel, updating the time
252returned by C<EV::now> in the progress. This is a costly operation and 252returned by C<EV::now> in the progress. This is a costly operation and
253is usually done automatically within C<EV::loop>. 253is usually done automatically within C<EV::run>.
254 254
255This function is rarely useful, but when some event callback runs for a 255This function is rarely useful, but when some event callback runs for a
256very long time without entering the event loop, updating libev's idea of 256very long time without entering the event loop, updating libev's idea of
257the current time is a good idea. 257the 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
317When called with no arguments or an argument of EV::BREAK_ONE, makes the 317When called with no arguments or an argument of EV::BREAK_ONE, makes the
318innermost call to EV::loop return. 318innermost call to EV::run return.
319 319
320When called with an argument of EV::BREAK_ALL, all calls to EV::loop will 320When called with an argument of EV::BREAK_ALL, all calls to EV::run will
321return as fast as possible. 321return as fast as possible.
322 322
323When called with an argument of EV::BREAK_CANCEL, any pending break will 323When called with an argument of EV::BREAK_CANCEL, any pending break will
324be cancelled. 324be cancelled.
325 325
… …
342| EV::WRITE>, indicating the type of I/O event you want to wait for. If 342| EV::WRITE>, indicating the type of I/O event you want to wait for. If
343you do not want to wait for some I/O event, specify C<undef> for 343you do not want to wait for some I/O event, specify C<undef> for
344C<$fh_or_undef> and C<0> for C<$events>). 344C<$fh_or_undef> and C<0> for C<$events>).
345 345
346If timeout is C<undef> or negative, then there will be no 346If timeout is C<undef> or negative, then there will be no
347timeout. Otherwise a EV::timer with this value will be started. 347timeout. Otherwise an C<EV::timer> with this value will be started.
348 348
349When an error occurs or either the timeout or I/O watcher triggers, then 349When an error occurs or either the timeout or I/O watcher triggers, then
350the callback will be called with the received event set (in general 350the callback will be called with the received event set (in general
351you can expect it to be a combination of C<EV::ERROR>, C<EV::READ>, 351you can expect it to be a combination of C<EV::ERROR>, C<EV::READ>,
352C<EV::WRITE> and C<EV::TIMER>). 352C<EV::WRITE> and C<EV::TIMER>).
… …
370 370
371=item EV::feed_signal $signal 371=item EV::feed_signal $signal
372 372
373Feed a signal event into EV - unlike C<EV::feed_signal_event>, this works 373Feed a signal event into EV - unlike C<EV::feed_signal_event>, this works
374regardless of which loop has registered the signal, and is mainly useful 374regardless of which loop has registered the signal, and is mainly useful
375fro custom signal implementations. 375for 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
… …
507returns its C<$revents> bitset (as if its callback was invoked). If the 507returns its C<$revents> bitset (as if its callback was invoked). If the
508watcher isn't pending it does nothing and returns C<0>. 508watcher 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
512Normally, C<EV::loop> will return when there are no active watchers 512Normally, 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
514convenient because it allows you to start your watchers (and your jobs), 514convenient because it allows you to start your watchers (and your jobs),
515call C<EV::loop> once and when it returns you know that all your jobs are 515call C<EV::run> once and when it returns you know that all your jobs are
516finished (or they forgot to register some watchers for their task :). 516finished (or they forgot to register some watchers for their task :).
517 517
518Sometimes, however, this gets in your way, for example when the module 518Sometimes, however, this gets in your way, for example when the module
519that calls C<EV::loop> (usually the main program) is not the same module 519that calls C<EV::run> (usually the main program) is not the same module
520as a long-living watcher (for example a DNS client module written by 520as a long-living watcher (for example a DNS client module written by
521somebody else even). Then you might want any outstanding requests to be 521somebody else even). Then you might want any outstanding requests to be
522handled, but you would not want to keep C<EV::loop> from returning just 522handled, but you would not want to keep C<EV::run> from returning just
523because you happen to have this long-running UDP port watcher. 523because you happen to have this long-running UDP port watcher.
524 524
525In this case you can clear the keepalive status, which means that even 525In this case you can clear the keepalive status, which means that even
526though your watcher is active, it won't keep C<EV::loop> from returning. 526though your watcher is active, it won't keep C<EV::run> from returning.
527 527
528The initial value for keepalive is true (enabled), and you can change it 528The initial value for keepalive is true (enabled), and you can change it
529any time. 529any time.
530 530
531Example: Register an I/O watcher for some UDP socket but do not keep the 531Example: Register an I/O watcher for some UDP socket but do not keep the
… …
645value. 645value.
646 646
647=item $after = $w->remaining 647=item $after = $w->remaining
648 648
649Calculates and returns the remaining time till the timer will fire. 649Calculates and returns the remaining time till the timer will fire.
650
651=item $old_repeat = $w->reapat ([$new_repeat])
652
653Returns the current value of the repeat attribute and optionally sets a
654new one. Setting the new one will not restart the watcher - if the watcher
655is active, the new repeat value is used whenever it expires next.
650 656
651=back 657=back
652 658
653 659
654=head3 PERIODIC WATCHERS - to cron or not to cron? 660=head3 PERIODIC WATCHERS - to cron or not to cron?
… …
710time as second argument. 716time as second argument.
711 717
712I<This callback MUST NOT stop or destroy this or any other periodic 718I<This callback MUST NOT stop or destroy this or any other periodic
713watcher, ever, and MUST NOT call any event loop functions or methods>. If 719watcher, ever, and MUST NOT call any event loop functions or methods>. If
714you need to stop it, return 1e30 and stop it afterwards. You may create 720you need to stop it, return 1e30 and stop it afterwards. You may create
715and start a C<EV::prepare> watcher for this task. 721and start an C<EV::prepare> watcher for this task.
716 722
717It must return the next time to trigger, based on the passed time value 723It must return the next time to trigger, based on the passed time value
718(that is, the lowest time value larger than or equal to to the second 724(that is, the lowest time value larger than or equal to to the second
719argument). It will usually be called just before the callback will be 725argument). It will usually be called just before the callback will be
720triggered, but might be called at other times, too. 726triggered, but might be called at other times, too.
… …
747Simply stops and starts the watcher again. 753Simply stops and starts the watcher again.
748 754
749=item $time = $w->at 755=item $time = $w->at
750 756
751Return the time that the watcher is expected to trigger next. 757Return the time that the watcher is expected to trigger next.
758
759=item $old_offset = $w->offset ([$new_offset])
760
761Returns the current value of the offset attribute and optionally sets a
762new one. Setting the new one will not restart the watcher - if the watcher
763is active, the new offset value is used whenever it expires next.
764
765=item $old_interval = $w->interval ([$new_interval])
766
767See above, for the interval attribute.
768
769=item $old_reschedule_cb = $w->reschedule_cb ([$new_reschedule_xcb])
770
771See above, for the reschedule callback.
752 772
753=back 773=back
754 774
755 775
756=head3 SIGNAL WATCHERS - signal me when a signal gets signalled! 776=head3 SIGNAL WATCHERS - signal me when a signal gets signalled!

Diff Legend

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