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

Comparing EV/EV.pm (file contents):
Revision 1.136 by root, Thu Jan 19 17:55:23 2012 UTC vs.
Revision 1.148 by root, Sun Dec 20 01:35:46 2015 UTC

… …
47 my ($w, $revents) = @_; 47 my ($w, $revents) = @_;
48 warn $w->path, " has changed somehow.\n"; 48 warn $w->path, " has changed somehow.\n";
49 }; 49 };
50 50
51 # MAINLOOP 51 # MAINLOOP
52 EV::run; # loop until EV::unloop is called or all watchers stop 52 EV::run; # loop until EV::break is called or all watchers stop
53 EV::run EV::RUN_ONCE; # block until at least one event could be handled 53 EV::run EV::RUN_ONCE; # block until at least one event could be handled
54 EV::run EV::RUN_NOWAIT; # try to handle same events, but do not block 54 EV::run EV::RUN_NOWAIT; # try to handle same events, but do not block
55 55
56=head1 BEFORE YOU START USING THIS MODULE 56=head1 BEFORE YOU START USING THIS MODULE
57 57
… …
119package EV; 119package EV;
120 120
121use common::sense; 121use common::sense;
122 122
123BEGIN { 123BEGIN {
124 our $VERSION = '4.10'; 124 our $VERSION = 4.22;
125 use XSLoader; 125 use XSLoader;
126 local $^W = 0; # avoid spurious warning
126 XSLoader::load "EV", $VERSION; 127 XSLoader::load "EV", $VERSION;
127} 128}
128 129
129@EV::IO::ISA = 130@EV::IO::ISA =
130@EV::Timer::ISA = 131@EV::Timer::ISA =
… …
290=item $backend = $loop->backend 291=item $backend = $loop->backend
291 292
292Returns an integer describing the backend used by libev (EV::BACKEND_SELECT 293Returns an integer describing the backend used by libev (EV::BACKEND_SELECT
293or EV::BACKEND_EPOLL). 294or EV::BACKEND_EPOLL).
294 295
295=item EV::run [$flags] 296=item $active = EV::run [$flags]
296 297
297=item $loop->run ([$flags]) 298=item $active = $loop->run ([$flags])
298 299
299Begin checking for events and calling callbacks. It returns when a 300Begin checking for events and calling callbacks. It returns when a
300callback calls EV::unloop. 301callback calls EV::break or the flasg are nonzero (in which case the
302return value is true) or when there are no active watchers which reference
303the loop (keepalive is true), in which case the return value will be
304false. The returnv alue can generally be interpreted as "if true, there is
305more work left to do".
301 306
302The $flags argument can be one of the following: 307The $flags argument can be one of the following:
303 308
304 0 as above 309 0 as above
305 EV::RUN_ONCE block at most once (wait, but do not loop) 310 EV::RUN_ONCE block at most once (wait, but do not loop)
… …
609in front of the machine while the timer is running and changes the system 614in front of the machine while the timer is running and changes the system
610clock, the timer will nevertheless run (roughly) the same time. 615clock, the timer will nevertheless run (roughly) the same time.
611 616
612The C<timer_ns> variant doesn't start (activate) the newly created watcher. 617The C<timer_ns> variant doesn't start (activate) the newly created watcher.
613 618
614=item $w->set ($after, $repeat) 619=item $w->set ($after, $repeat = 0)
615 620
616Reconfigures the watcher, see the constructor above for details. Can be called at 621Reconfigures the watcher, see the constructor above for details. Can be called at
617any time. 622any time.
618 623
619=item $w->again 624=item $w->again
625
626=item $w->again ($repeat)
620 627
621Similar to the C<start> method, but has special semantics for repeating timers: 628Similar to the C<start> method, but has special semantics for repeating timers:
622 629
623If the timer is active and non-repeating, it will be stopped. 630If the timer is active and non-repeating, it will be stopped.
624 631
… …
631 638
632This behaviour is useful when you have a timeout for some IO 639This behaviour is useful when you have a timeout for some IO
633operation. You create a timer object with the same value for C<$after> and 640operation. You create a timer object with the same value for C<$after> and
634C<$repeat>, and then, in the read/write watcher, run the C<again> method 641C<$repeat>, and then, in the read/write watcher, run the C<again> method
635on the timeout. 642on the timeout.
643
644If called with a C<$repeat> argument, then it uses this a timer repeat
645value.
646
647=item $after = $w->remaining
648
649Calculates and returns the remaining time till the timer will fire.
636 650
637=back 651=back
638 652
639 653
640=head3 PERIODIC WATCHERS - to cron or not to cron? 654=head3 PERIODIC WATCHERS - to cron or not to cron?
… …
677time: 691time:
678 692
679 my $hourly = EV::periodic 0, 3600, 0, sub { print "once/hour\n" }; 693 my $hourly = EV::periodic 0, 3600, 0, sub { print "once/hour\n" };
680 694
681That doesn't mean there will always be 3600 seconds in between triggers, 695That doesn't mean there will always be 3600 seconds in between triggers,
682but only that the the clalback will be called when the system time shows a 696but only that the the callback will be called when the system time shows a
683full hour (UTC). 697full hour (UTC).
684 698
685Another way to think about it (for the mathematically inclined) is that 699Another way to think about it (for the mathematically inclined) is that
686EV::periodic will try to run the callback in this mode at the next 700EV::periodic will try to run the callback in this mode at the next
687possible time where C<$time = $at (mod $interval)>, regardless of any time 701possible time where C<$time = $at (mod $interval)>, regardless of any time
… …
1135 1149
1136=item $w = EV::async $callback 1150=item $w = EV::async $callback
1137 1151
1138=item $w = EV::async_ns $callback 1152=item $w = EV::async_ns $callback
1139 1153
1154=item $w = $loop->async ($callback)
1155
1156=item $w = $loop->async_ns ($callback)
1157
1140=item $w->send 1158=item $w->send
1141 1159
1142=item $bool = $w->async_pending 1160=item $bool = $w->async_pending
1143 1161
1144=back 1162=back
1163
1164=head3 CLEANUP WATCHERS - how to clean up when the event loop goes away
1165
1166Cleanup watchers are not supported on the Perl level, they can only be
1167used via XS currently.
1145 1168
1146 1169
1147=head1 PERL SIGNALS 1170=head1 PERL SIGNALS
1148 1171
1149While Perl signal handling (C<%SIG>) is not affected by EV, the behaviour 1172While Perl signal handling (C<%SIG>) is not affected by EV, the behaviour

Diff Legend

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