… | |
… | |
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.6'; |
73 | our $VERSION = '2.0'; |
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 = |
… | |
… | |
85 | @EV::Check::ISA = |
86 | @EV::Check::ISA = |
86 | @EV::Embed::ISA = |
87 | @EV::Embed::ISA = |
87 | @EV::Fork::ISA = |
88 | @EV::Fork::ISA = |
88 | "EV::Watcher"; |
89 | "EV::Watcher"; |
89 | |
90 | |
|
|
91 | @EV::Loop::Default::ISA = "EV::Loop"; |
|
|
92 | |
90 | =head1 BASIC INTERFACE |
93 | =head1 BASIC INTERFACE |
91 | |
94 | |
92 | =over 4 |
95 | =over 4 |
93 | |
96 | |
94 | =item $EV::DIED |
97 | =item $EV::DIED |
95 | |
98 | |
96 | Must contain a reference to a function that is called when a callback |
99 | 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 |
100 | throws an exception (with $@ containing the error). The default prints an |
98 | informative message and continues. |
101 | informative message and continues. |
99 | |
102 | |
100 | If this callback throws an exception it will be silently ignored. |
103 | If this callback throws an exception it will be silently ignored. |
101 | |
104 | |
102 | =item $time = EV::time |
105 | =item $time = EV::time |
… | |
… | |
159 | |
162 | |
160 | EV::once doesn't return anything: the watchers stay active till either |
163 | EV::once doesn't return anything: the watchers stay active till either |
161 | of them triggers, then they will be stopped and freed, and the callback |
164 | of them triggers, then they will be stopped and freed, and the callback |
162 | invoked. |
165 | invoked. |
163 | |
166 | |
|
|
167 | =item EV::feed_fd_event ($fd, $revents) |
|
|
168 | |
|
|
169 | Feed an event on a file descriptor into EV. EV will react to this call as |
|
|
170 | if the readyness notifications specified by C<$revents> (a combination of |
|
|
171 | C<EV::READ> and C<EV::WRITE>) happened on the file descriptor C<$fd>. |
|
|
172 | |
|
|
173 | =item EV::feed_signal_event ($signal) |
|
|
174 | |
|
|
175 | Feed a signal event into EV. EV will react to this call as if the signal |
|
|
176 | specified by C<$signal> had occured. |
|
|
177 | |
164 | =back |
178 | =back |
|
|
179 | |
165 | |
180 | |
166 | =head2 WATCHER OBJECTS |
181 | =head2 WATCHER OBJECTS |
167 | |
182 | |
168 | A watcher is an object that gets created to record your interest in some |
183 | A watcher is an object that gets created to record your interest in some |
169 | event. For instance, if you want to wait for STDIN to become readable, you |
184 | event. For instance, if you want to wait for STDIN to become readable, you |
… | |
… | |
180 | events. |
195 | events. |
181 | |
196 | |
182 | Each watcher type has its associated bit in revents, so you can use the |
197 | Each watcher type has its associated bit in revents, so you can use the |
183 | same callback for multiple watchers. The event mask is named after the |
198 | same callback for multiple watchers. The event mask is named after the |
184 | type, i..e. EV::child sets EV::CHILD, EV::prepare sets EV::PREPARE, |
199 | type, i..e. EV::child sets EV::CHILD, EV::prepare sets EV::PREPARE, |
185 | EV::periodic sets EV::PERIODIC and so on, with the exception of IO events |
200 | EV::periodic sets EV::PERIODIC and so on, with the exception of I/O events |
186 | (which can set both EV::READ and EV::WRITE bits), and EV::timer (which |
201 | (which can set both EV::READ and EV::WRITE bits), and EV::timer (which |
187 | uses EV::TIMEOUT). |
202 | uses EV::TIMEOUT). |
188 | |
203 | |
189 | In the rare case where one wants to create a watcher but not start it at |
204 | In the rare case where one wants to create a watcher but not start it at |
190 | the same time, each constructor has a variant with a trailing C<_ns> in |
205 | the same time, each constructor has a variant with a trailing C<_ns> in |
… | |
… | |
212 | |
227 | |
213 | =item $w->stop |
228 | =item $w->stop |
214 | |
229 | |
215 | Stop a watcher if it is active. Also clear any pending events (events that |
230 | Stop a watcher if it is active. Also clear any pending events (events that |
216 | have been received but that didn't yet result in a callback invocation), |
231 | have been received but that didn't yet result in a callback invocation), |
217 | regardless of wether the watcher was active or not. |
232 | regardless of whether the watcher was active or not. |
218 | |
233 | |
219 | =item $bool = $w->is_active |
234 | =item $bool = $w->is_active |
220 | |
235 | |
221 | Returns true if the watcher is active, false otherwise. |
236 | Returns true if the watcher is active, false otherwise. |
222 | |
237 | |
… | |
… | |
252 | The default priority of any newly-created watcher is 0. |
267 | The default priority of any newly-created watcher is 0. |
253 | |
268 | |
254 | Note that the priority semantics have not yet been fleshed out and are |
269 | Note that the priority semantics have not yet been fleshed out and are |
255 | subject to almost certain change. |
270 | subject to almost certain change. |
256 | |
271 | |
257 | =item $w->trigger ($revents) |
272 | =item $w->invoke ($revents) |
258 | |
273 | |
259 | Call the callback *now* with the given event mask. |
274 | Call the callback *now* with the given event mask. |
|
|
275 | |
|
|
276 | =item $w->feed_event ($revents) |
|
|
277 | |
|
|
278 | Feed some events on this watcher into EV. EV will react to this call as if |
|
|
279 | the watcher had received the given C<$revents> mask. |
|
|
280 | |
|
|
281 | =item $revents = $w->clear_pending |
|
|
282 | |
|
|
283 | If the watcher is pending, this function returns clears its pending status |
|
|
284 | and returns its C<$revents> bitset (as if its callback was invoked). If the |
|
|
285 | watcher isn't pending it does nothing and returns C<0>. |
260 | |
286 | |
261 | =item $previous_state = $w->keepalive ($bool) |
287 | =item $previous_state = $w->keepalive ($bool) |
262 | |
288 | |
263 | Normally, C<EV::loop> will return when there are no active watchers |
289 | Normally, C<EV::loop> will return when there are no active watchers |
264 | (which is a "deadlock" because no progress can be made anymore). This is |
290 | (which is a "deadlock" because no progress can be made anymore). This is |
… | |
… | |
277 | though your watcher is active, it won't keep C<EV::loop> from returning. |
303 | though your watcher is active, it won't keep C<EV::loop> from returning. |
278 | |
304 | |
279 | The initial value for keepalive is true (enabled), and you cna change it |
305 | The initial value for keepalive is true (enabled), and you cna change it |
280 | any time. |
306 | any time. |
281 | |
307 | |
282 | Example: Register an IO watcher for some UDP socket but do not keep the |
308 | Example: Register an I/O watcher for some UDP socket but do not keep the |
283 | event loop from running just because of that watcher. |
309 | event loop from running just because of that watcher. |
284 | |
310 | |
285 | my $udp_socket = ... |
311 | my $udp_socket = ... |
286 | my $udp_watcher = EV::io $udp_socket, EV::READ, sub { ... }; |
312 | my $udp_watcher = EV::io $udp_socket, EV::READ, sub { ... }; |
287 | $udp_watcher->keepalive (0); |
313 | $udp_watcher->keepalive (0); |
… | |
… | |
291 | |
317 | |
292 | =head2 WATCHER TYPES |
318 | =head2 WATCHER TYPES |
293 | |
319 | |
294 | Each of the following subsections describes a single watcher type. |
320 | Each of the following subsections describes a single watcher type. |
295 | |
321 | |
296 | =head3 IO WATCHERS - is this file descriptor readable or writable? |
322 | =head3 I/O WATCHERS - is this file descriptor readable or writable? |
297 | |
323 | |
298 | =over 4 |
324 | =over 4 |
299 | |
325 | |
300 | =item $w = EV::io $fileno_or_fh, $eventmask, $callback |
326 | =item $w = EV::io $fileno_or_fh, $eventmask, $callback |
301 | |
327 | |
… | |
… | |
470 | |
496 | |
471 | =item $w->again |
497 | =item $w->again |
472 | |
498 | |
473 | Simply stops and starts the watcher again. |
499 | Simply stops and starts the watcher again. |
474 | |
500 | |
|
|
501 | =item $time = $w->at |
|
|
502 | |
|
|
503 | Return the time that the watcher is expected to trigger next. |
|
|
504 | |
475 | =back |
505 | =back |
476 | |
506 | |
477 | |
507 | |
478 | =head3 SIGNAL WATCHERS - signal me when a signal gets signalled! |
508 | =head3 SIGNAL WATCHERS - signal me when a signal gets signalled! |
479 | |
509 | |
… | |
… | |
645 | |
675 | |
646 | =item $w = EV::idle $callback |
676 | =item $w = EV::idle $callback |
647 | |
677 | |
648 | =item $w = EV::idle_ns $callback |
678 | =item $w = EV::idle_ns $callback |
649 | |
679 | |
650 | Call the callback when there are no pending io, timer/periodic, signal or |
680 | Call the callback when there are no other pending watchers of the same or |
651 | child events, i.e. when the process is idle. |
681 | higher priority (excluding check, prepare and other idle watchers of the |
|
|
682 | same or lower priority, of course). They are called idle watchers because |
|
|
683 | when the watcher is the highest priority pending event in the process, the |
|
|
684 | process is considered to be idle at that priority. |
|
|
685 | |
|
|
686 | If you want a watcher that is only ever called when I<no> other events are |
|
|
687 | outstanding you have to set the priority to C<EV::MINPRI>. |
652 | |
688 | |
653 | The process will not block as long as any idle watchers are active, and |
689 | The process will not block as long as any idle watchers are active, and |
654 | they will be called repeatedly until stopped. |
690 | they will be called repeatedly until stopped. |
|
|
691 | |
|
|
692 | For example, if you have idle watchers at priority C<0> and C<1>, and |
|
|
693 | an I/O watcher at priority C<0>, then the idle watcher at priority C<1> |
|
|
694 | and the I/O watcher will always run when ready. Only when the idle watcher |
|
|
695 | at priority C<1> is stopped and the I/O watcher at priority C<0> is not |
|
|
696 | pending with the C<0>-priority idle watcher be invoked. |
655 | |
697 | |
656 | The C<idle_ns> variant doesn't start (activate) the newly created watcher. |
698 | The C<idle_ns> variant doesn't start (activate) the newly created watcher. |
657 | |
699 | |
658 | =back |
700 | =back |
659 | |
701 | |
… | |
… | |
700 | or return; |
742 | or return; |
701 | |
743 | |
702 | # make the dispatcher handle any outstanding stuff |
744 | # make the dispatcher handle any outstanding stuff |
703 | ... not shown |
745 | ... not shown |
704 | |
746 | |
705 | # create an IO watcher for each and every socket |
747 | # create an I/O watcher for each and every socket |
706 | @snmp_watcher = ( |
748 | @snmp_watcher = ( |
707 | (map { EV::io $_, EV::READ, sub { } } |
749 | (map { EV::io $_, EV::READ, sub { } } |
708 | keys %{ $dispatcher->{_descriptors} }), |
750 | keys %{ $dispatcher->{_descriptors} }), |
709 | |
751 | |
710 | EV::timer +($event->[Net::SNMP::Dispatcher::_ACTIVE] |
752 | EV::timer +($event->[Net::SNMP::Dispatcher::_ACTIVE] |
… | |
… | |
802 | our $DIED = sub { |
844 | our $DIED = sub { |
803 | warn "EV: error in callback (ignoring): $@"; |
845 | warn "EV: error in callback (ignoring): $@"; |
804 | }; |
846 | }; |
805 | |
847 | |
806 | default_loop |
848 | default_loop |
807 | or die 'EV: cannot initialise libev backend. bad $ENV{LIBEV_METHODS}?'; |
849 | or die 'EV: cannot initialise libev backend. bad $ENV{LIBEV_FLAGS}?'; |
808 | |
850 | |
809 | 1; |
851 | 1; |
810 | |
852 | |
811 | =head1 SEE ALSO |
853 | =head1 SEE ALSO |
812 | |
854 | |