… | |
… | |
58 | This module provides an interface to libev |
58 | This module provides an interface to libev |
59 | (L<http://software.schmorp.de/pkg/libev.html>). While the documentation |
59 | (L<http://software.schmorp.de/pkg/libev.html>). While the documentation |
60 | below is comprehensive, one might also consult the documentation of libev |
60 | below is comprehensive, one might also consult the documentation of libev |
61 | itself (L<http://cvs.schmorp.de/libev/ev.html>) for more subtle details on |
61 | itself (L<http://cvs.schmorp.de/libev/ev.html>) for more subtle details on |
62 | watcher semantics or some discussion on the available backends, or how to |
62 | watcher semantics or some discussion on the available backends, or how to |
63 | force a specific backend with C<LIBEV_FLAGS>. |
63 | force a specific backend with C<LIBEV_FLAGS>, or just about in any case |
|
|
64 | because it has much more detailed information. |
64 | |
65 | |
65 | =cut |
66 | =cut |
66 | |
67 | |
67 | package EV; |
68 | package EV; |
68 | |
69 | |
69 | use strict; |
70 | use strict; |
70 | |
71 | |
71 | BEGIN { |
72 | BEGIN { |
72 | our $VERSION = '1.4'; |
73 | our $VERSION = '1.86'; |
73 | use XSLoader; |
74 | use XSLoader; |
74 | XSLoader::load "EV", $VERSION; |
75 | XSLoader::load "EV", $VERSION; |
75 | } |
76 | } |
76 | |
77 | |
77 | @EV::IO::ISA = |
78 | @EV::IO::ISA = |
… | |
… | |
92 | =over 4 |
93 | =over 4 |
93 | |
94 | |
94 | =item $EV::DIED |
95 | =item $EV::DIED |
95 | |
96 | |
96 | Must contain a reference to a function that is called when a callback |
97 | Must contain a reference to a function that is called when a callback |
97 | throws an exception (with $@ containing thr error). The default prints an |
98 | throws an exception (with $@ containing the error). The default prints an |
98 | informative message and continues. |
99 | informative message and continues. |
99 | |
100 | |
100 | If this callback throws an exception it will be silently ignored. |
101 | If this callback throws an exception it will be silently ignored. |
101 | |
102 | |
102 | =item $time = EV::time |
103 | =item $time = EV::time |
… | |
… | |
130 | When called with no arguments or an argument of EV::UNLOOP_ONE, makes the |
131 | When called with no arguments or an argument of EV::UNLOOP_ONE, makes the |
131 | innermost call to EV::loop return. |
132 | innermost call to EV::loop return. |
132 | |
133 | |
133 | When called with an argument of EV::UNLOOP_ALL, all calls to EV::loop will return as |
134 | When called with an argument of EV::UNLOOP_ALL, all calls to EV::loop will return as |
134 | fast as possible. |
135 | fast as possible. |
|
|
136 | |
|
|
137 | =item $count = EV::loop_count |
|
|
138 | |
|
|
139 | Return the number of times the event loop has polled for new |
|
|
140 | events. Sometiems useful as a generation counter. |
135 | |
141 | |
136 | =item EV::once $fh_or_undef, $events, $timeout, $cb->($revents) |
142 | =item EV::once $fh_or_undef, $events, $timeout, $cb->($revents) |
137 | |
143 | |
138 | This function rolls together an I/O and a timer watcher for a single |
144 | This function rolls together an I/O and a timer watcher for a single |
139 | one-shot event without the need for managing a watcher object. |
145 | one-shot event without the need for managing a watcher object. |
… | |
… | |
154 | |
160 | |
155 | EV::once doesn't return anything: the watchers stay active till either |
161 | EV::once doesn't return anything: the watchers stay active till either |
156 | of them triggers, then they will be stopped and freed, and the callback |
162 | of them triggers, then they will be stopped and freed, and the callback |
157 | invoked. |
163 | invoked. |
158 | |
164 | |
|
|
165 | =item EV::feed_fd_event ($fd, $revents) |
|
|
166 | |
|
|
167 | Feed an event on a file descriptor into EV. EV will react to this call as |
|
|
168 | if the readyness notifications specified by C<$revents> (a combination of |
|
|
169 | C<EV::READ> and C<EV::WRITE>) happened on the file descriptor C<$fd>. |
|
|
170 | |
|
|
171 | =item EV::feed_signal_event ($signal) |
|
|
172 | |
|
|
173 | Feed a signal event into EV. EV will react to this call as if the signal |
|
|
174 | specified by C<$signal> had occured. |
|
|
175 | |
159 | =back |
176 | =back |
|
|
177 | |
160 | |
178 | |
161 | =head2 WATCHER OBJECTS |
179 | =head2 WATCHER OBJECTS |
162 | |
180 | |
163 | A watcher is an object that gets created to record your interest in some |
181 | A watcher is an object that gets created to record your interest in some |
164 | event. For instance, if you want to wait for STDIN to become readable, you |
182 | event. For instance, if you want to wait for STDIN to become readable, you |
… | |
… | |
175 | events. |
193 | events. |
176 | |
194 | |
177 | Each watcher type has its associated bit in revents, so you can use the |
195 | Each watcher type has its associated bit in revents, so you can use the |
178 | same callback for multiple watchers. The event mask is named after the |
196 | same callback for multiple watchers. The event mask is named after the |
179 | type, i..e. EV::child sets EV::CHILD, EV::prepare sets EV::PREPARE, |
197 | type, i..e. EV::child sets EV::CHILD, EV::prepare sets EV::PREPARE, |
180 | EV::periodic sets EV::PERIODIC and so on, with the exception of IO events |
198 | EV::periodic sets EV::PERIODIC and so on, with the exception of I/O events |
181 | (which can set both EV::READ and EV::WRITE bits), and EV::timer (which |
199 | (which can set both EV::READ and EV::WRITE bits), and EV::timer (which |
182 | uses EV::TIMEOUT). |
200 | uses EV::TIMEOUT). |
183 | |
201 | |
184 | In the rare case where one wants to create a watcher but not start it at |
202 | In the rare case where one wants to create a watcher but not start it at |
185 | the same time, each constructor has a variant with a trailing C<_ns> in |
203 | the same time, each constructor has a variant with a trailing C<_ns> in |
… | |
… | |
207 | |
225 | |
208 | =item $w->stop |
226 | =item $w->stop |
209 | |
227 | |
210 | Stop a watcher if it is active. Also clear any pending events (events that |
228 | Stop a watcher if it is active. Also clear any pending events (events that |
211 | have been received but that didn't yet result in a callback invocation), |
229 | have been received but that didn't yet result in a callback invocation), |
212 | regardless of wether the watcher was active or not. |
230 | regardless of whether the watcher was active or not. |
213 | |
231 | |
214 | =item $bool = $w->is_active |
232 | =item $bool = $w->is_active |
215 | |
233 | |
216 | Returns true if the watcher is active, false otherwise. |
234 | Returns true if the watcher is active, false otherwise. |
217 | |
235 | |
… | |
… | |
247 | The default priority of any newly-created watcher is 0. |
265 | The default priority of any newly-created watcher is 0. |
248 | |
266 | |
249 | Note that the priority semantics have not yet been fleshed out and are |
267 | Note that the priority semantics have not yet been fleshed out and are |
250 | subject to almost certain change. |
268 | subject to almost certain change. |
251 | |
269 | |
252 | =item $w->trigger ($revents) |
270 | =item $w->invoke ($revents) |
253 | |
271 | |
254 | Call the callback *now* with the given event mask. |
272 | Call the callback *now* with the given event mask. |
|
|
273 | |
|
|
274 | =item $w->feed_event ($revents) |
|
|
275 | |
|
|
276 | Feed some events on this watcher into EV. EV will react to this call as if |
|
|
277 | the watcher had received the given C<$revents> mask. |
|
|
278 | |
|
|
279 | =item $revents = $w->clear_pending |
|
|
280 | |
|
|
281 | If the watcher is pending, this function returns clears its pending status |
|
|
282 | and returns its C<$revents> bitset (as if its callback was invoked). If the |
|
|
283 | watcher isn't pending it does nothing and returns C<0>. |
255 | |
284 | |
256 | =item $previous_state = $w->keepalive ($bool) |
285 | =item $previous_state = $w->keepalive ($bool) |
257 | |
286 | |
258 | Normally, C<EV::loop> will return when there are no active watchers |
287 | Normally, C<EV::loop> will return when there are no active watchers |
259 | (which is a "deadlock" because no progress can be made anymore). This is |
288 | (which is a "deadlock" because no progress can be made anymore). This is |
… | |
… | |
272 | though your watcher is active, it won't keep C<EV::loop> from returning. |
301 | though your watcher is active, it won't keep C<EV::loop> from returning. |
273 | |
302 | |
274 | The initial value for keepalive is true (enabled), and you cna change it |
303 | The initial value for keepalive is true (enabled), and you cna change it |
275 | any time. |
304 | any time. |
276 | |
305 | |
277 | Example: Register an IO watcher for some UDP socket but do not keep the |
306 | Example: Register an I/O watcher for some UDP socket but do not keep the |
278 | event loop from running just because of that watcher. |
307 | event loop from running just because of that watcher. |
279 | |
308 | |
280 | my $udp_socket = ... |
309 | my $udp_socket = ... |
281 | my $udp_watcher = EV::io $udp_socket, EV::READ, sub { ... }; |
310 | my $udp_watcher = EV::io $udp_socket, EV::READ, sub { ... }; |
282 | $udp_watcher->keepalive (0); |
311 | $udp_watcher->keepalive (0); |
… | |
… | |
286 | |
315 | |
287 | =head2 WATCHER TYPES |
316 | =head2 WATCHER TYPES |
288 | |
317 | |
289 | Each of the following subsections describes a single watcher type. |
318 | Each of the following subsections describes a single watcher type. |
290 | |
319 | |
291 | =head3 IO WATCHERS - is this file descriptor readable or writable? |
320 | =head3 I/O WATCHERS - is this file descriptor readable or writable? |
292 | |
321 | |
293 | =over 4 |
322 | =over 4 |
294 | |
323 | |
295 | =item $w = EV::io $fileno_or_fh, $eventmask, $callback |
324 | =item $w = EV::io $fileno_or_fh, $eventmask, $callback |
296 | |
325 | |
… | |
… | |
465 | |
494 | |
466 | =item $w->again |
495 | =item $w->again |
467 | |
496 | |
468 | Simply stops and starts the watcher again. |
497 | Simply stops and starts the watcher again. |
469 | |
498 | |
|
|
499 | =item $time = $w->at |
|
|
500 | |
|
|
501 | Return the time that the watcher is expected to trigger next. |
|
|
502 | |
470 | =back |
503 | =back |
471 | |
504 | |
472 | |
505 | |
473 | =head3 SIGNAL WATCHERS - signal me when a signal gets signalled! |
506 | =head3 SIGNAL WATCHERS - signal me when a signal gets signalled! |
474 | |
507 | |
… | |
… | |
576 | as even with OS-supported change notifications, this can be |
609 | as even with OS-supported change notifications, this can be |
577 | resource-intensive. |
610 | resource-intensive. |
578 | |
611 | |
579 | The C<stat_ns> variant doesn't start (activate) the newly created watcher. |
612 | The C<stat_ns> variant doesn't start (activate) the newly created watcher. |
580 | |
613 | |
|
|
614 | =item ... = $w->stat |
|
|
615 | |
|
|
616 | This call is very similar to the perl C<stat> built-in: It stats (using |
|
|
617 | C<lstat>) the path specified in the watcher and sets perls stat cache (as |
|
|
618 | well as EV's idea of the current stat values) to the values found. |
|
|
619 | |
|
|
620 | In scalar context, a boolean is return indicating success or failure of |
|
|
621 | the stat. In list context, the same 13-value list as with stat is returned |
|
|
622 | (except that the blksize and blocks fields are not reliable). |
|
|
623 | |
|
|
624 | In the case of an error, errno is set to C<ENOENT> (regardless of the |
|
|
625 | actual error value) and the C<nlink> value is forced to zero (if the stat |
|
|
626 | was successful then nlink is guaranteed to be non-zero). |
|
|
627 | |
|
|
628 | See also the next two entries for more info. |
|
|
629 | |
|
|
630 | =item ... = $w->attr |
|
|
631 | |
|
|
632 | Just like C<< $w->stat >>, but without the initial stat'ing: this returns |
|
|
633 | the values most recently detected by EV. See the next entry for more info. |
|
|
634 | |
|
|
635 | =item ... = $w->prev |
|
|
636 | |
|
|
637 | Just like C<< $w->stat >>, but without the initial stat'ing: this returns |
|
|
638 | the previous set of values, before the change. |
|
|
639 | |
|
|
640 | That is, when the watcher callback is invoked, C<< $w->prev >> will be set |
|
|
641 | to the values found I<before> a change was detected, while C<< $w->attr >> |
|
|
642 | returns the values found leading to the change detection. The difference (if any) |
|
|
643 | between C<prev> and C<attr> is what triggered the callback. |
|
|
644 | |
|
|
645 | If you did something to the filesystem object and do not want to trigger |
|
|
646 | yet another change, you can call C<stat> to update EV's idea of what the |
|
|
647 | current attributes are. |
|
|
648 | |
581 | =item $w->set ($path, $interval) |
649 | =item $w->set ($path, $interval) |
582 | |
650 | |
583 | Reconfigures the watcher, see the constructor above for details. Can be |
651 | Reconfigures the watcher, see the constructor above for details. Can be |
584 | called at any time. |
652 | called at any time. |
585 | |
653 | |
… | |
… | |
605 | |
673 | |
606 | =item $w = EV::idle $callback |
674 | =item $w = EV::idle $callback |
607 | |
675 | |
608 | =item $w = EV::idle_ns $callback |
676 | =item $w = EV::idle_ns $callback |
609 | |
677 | |
610 | Call the callback when there are no pending io, timer/periodic, signal or |
678 | Call the callback when there are no other pending watchers of the same or |
611 | child events, i.e. when the process is idle. |
679 | higher priority (excluding check, prepare and other idle watchers of the |
|
|
680 | same or lower priority, of course). They are called idle watchers because |
|
|
681 | when the watcher is the highest priority pending event in the process, the |
|
|
682 | process is considered to be idle at that priority. |
|
|
683 | |
|
|
684 | If you want a watcher that is only ever called when I<no> other events are |
|
|
685 | outstanding you have to set the priority to C<EV::MINPRI>. |
612 | |
686 | |
613 | The process will not block as long as any idle watchers are active, and |
687 | The process will not block as long as any idle watchers are active, and |
614 | they will be called repeatedly until stopped. |
688 | they will be called repeatedly until stopped. |
|
|
689 | |
|
|
690 | For example, if you have idle watchers at priority C<0> and C<1>, and |
|
|
691 | an I/O watcher at priority C<0>, then the idle watcher at priority C<1> |
|
|
692 | and the I/O watcher will always run when ready. Only when the idle watcher |
|
|
693 | at priority C<1> is stopped and the I/O watcher at priority C<0> is not |
|
|
694 | pending with the C<0>-priority idle watcher be invoked. |
615 | |
695 | |
616 | The C<idle_ns> variant doesn't start (activate) the newly created watcher. |
696 | The C<idle_ns> variant doesn't start (activate) the newly created watcher. |
617 | |
697 | |
618 | =back |
698 | =back |
619 | |
699 | |
… | |
… | |
660 | or return; |
740 | or return; |
661 | |
741 | |
662 | # make the dispatcher handle any outstanding stuff |
742 | # make the dispatcher handle any outstanding stuff |
663 | ... not shown |
743 | ... not shown |
664 | |
744 | |
665 | # create an IO watcher for each and every socket |
745 | # create an I/O watcher for each and every socket |
666 | @snmp_watcher = ( |
746 | @snmp_watcher = ( |
667 | (map { EV::io $_, EV::READ, sub { } } |
747 | (map { EV::io $_, EV::READ, sub { } } |
668 | keys %{ $dispatcher->{_descriptors} }), |
748 | keys %{ $dispatcher->{_descriptors} }), |
669 | |
749 | |
670 | EV::timer +($event->[Net::SNMP::Dispatcher::_ACTIVE] |
750 | EV::timer +($event->[Net::SNMP::Dispatcher::_ACTIVE] |
… | |
… | |
712 | |
792 | |
713 | The C<fork_ns> variant doesn't start (activate) the newly created watcher. |
793 | The C<fork_ns> variant doesn't start (activate) the newly created watcher. |
714 | |
794 | |
715 | =back |
795 | =back |
716 | |
796 | |
|
|
797 | |
|
|
798 | =head1 PERL SIGNALS |
|
|
799 | |
|
|
800 | While Perl signal handling (C<%SIG>) is not affected by EV, the behaviour |
|
|
801 | with EV is as the same as any other C library: Perl-signals will only be |
|
|
802 | handled when Perl runs, which means your signal handler might be invoked |
|
|
803 | only the next time an event callback is invoked. |
|
|
804 | |
|
|
805 | The solution is to use EV signal watchers (see C<EV::signal>), which will |
|
|
806 | ensure proper operations with regards to other event watchers. |
|
|
807 | |
|
|
808 | If you cannot do this for whatever reason, you can also force a watcher |
|
|
809 | to be called on every event loop iteration by installing a C<EV::check> |
|
|
810 | watcher: |
|
|
811 | |
|
|
812 | my $async_check = EV::check sub { }; |
|
|
813 | |
|
|
814 | This ensures that perl shortly gets into control for a short time, and |
|
|
815 | also ensures slower overall operation. |
717 | |
816 | |
718 | =head1 THREADS |
817 | =head1 THREADS |
719 | |
818 | |
720 | Threads are not supported by this module in any way. Perl pseudo-threads |
819 | Threads are not supported by this module in any way. Perl pseudo-threads |
721 | is evil stuff and must die. As soon as Perl gains real threads I will work |
820 | is evil stuff and must die. As soon as Perl gains real threads I will work |
… | |
… | |
743 | our $DIED = sub { |
842 | our $DIED = sub { |
744 | warn "EV: error in callback (ignoring): $@"; |
843 | warn "EV: error in callback (ignoring): $@"; |
745 | }; |
844 | }; |
746 | |
845 | |
747 | default_loop |
846 | default_loop |
748 | or die 'EV: cannot initialise libev backend. bad $ENV{LIBEV_METHODS}?'; |
847 | or die 'EV: cannot initialise libev backend. bad $ENV{LIBEV_FLAGS}?'; |
749 | |
848 | |
750 | 1; |
849 | 1; |
751 | |
850 | |
752 | =head1 SEE ALSO |
851 | =head1 SEE ALSO |
753 | |
852 | |
754 | L<EV::DNS>. |
853 | L<EV::ADNS> (asynchronous dns), L<Glib::EV> (makes Glib/Gtk2 use EV as |
|
|
854 | event loop), L<Coro::EV> (efficient coroutines with EV). |
755 | |
855 | |
756 | =head1 AUTHOR |
856 | =head1 AUTHOR |
757 | |
857 | |
758 | Marc Lehmann <schmorp@schmorp.de> |
858 | Marc Lehmann <schmorp@schmorp.de> |
759 | http://home.schmorp.de/ |
859 | http://home.schmorp.de/ |