… | |
… | |
68 | package EV; |
68 | package EV; |
69 | |
69 | |
70 | use strict; |
70 | use strict; |
71 | |
71 | |
72 | BEGIN { |
72 | BEGIN { |
73 | our $VERSION = '1.7'; |
73 | our $VERSION = '2.0'; |
74 | use XSLoader; |
74 | use XSLoader; |
75 | XSLoader::load "EV", $VERSION; |
75 | XSLoader::load "EV", $VERSION; |
76 | } |
76 | } |
77 | |
77 | |
78 | @EV::IO::ISA = |
78 | @EV::IO::ISA = |
… | |
… | |
86 | @EV::Check::ISA = |
86 | @EV::Check::ISA = |
87 | @EV::Embed::ISA = |
87 | @EV::Embed::ISA = |
88 | @EV::Fork::ISA = |
88 | @EV::Fork::ISA = |
89 | "EV::Watcher"; |
89 | "EV::Watcher"; |
90 | |
90 | |
|
|
91 | @EV::Loop::Default::ISA = "EV::Loop"; |
|
|
92 | |
|
|
93 | =head1 EVENT LOOPS |
|
|
94 | |
|
|
95 | EV supports multiple event loops: There is a single "default event loop" |
|
|
96 | that can handle everything including signals and child watchers, and any |
|
|
97 | number of "dynamic event loops" that can use different backends (with |
|
|
98 | various limitations), but no child and signal watchers. |
|
|
99 | |
|
|
100 | You do not have to do anything to create the default event loop: When |
|
|
101 | the module is loaded a suitable backend is selected on the premise of |
|
|
102 | selecting a working backend (which for example rules out kqueue on most |
|
|
103 | BSDs). Modules should, unless they have "special needs" always use the |
|
|
104 | default loop as this is fastest (perl-wise), best supported by other |
|
|
105 | modules (e.g. AnyEvent or Coro) and most portable event loop. |
|
|
106 | |
|
|
107 | For specific programs you cna create additional event loops dynamically. |
|
|
108 | |
|
|
109 | =over 4 |
|
|
110 | |
|
|
111 | =item $loop = new EV::loop [$flags] |
|
|
112 | |
|
|
113 | Create a new event loop as per the specified flags. Please refer to the |
|
|
114 | C<ev_loop_new ()> function description in the libev documentation |
|
|
115 | (L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#GLOBAL_FUNCTIONS>) |
|
|
116 | for more info. |
|
|
117 | |
|
|
118 | The loop will automatically be destroyed when it is no longer referenced |
|
|
119 | by any watcher and the loop object goes out of scope. |
|
|
120 | |
|
|
121 | Using C<EV::FLAG_FORKCHECK> is recommended, as only the default event loop |
|
|
122 | is protected by this module. |
|
|
123 | |
|
|
124 | =item $loop->loop_fork |
|
|
125 | |
|
|
126 | Must be called after a fork in the child, before entering or continuing |
|
|
127 | the event loop. An alternative is to use C<EV::FLAG_FORKCHECK> which calls |
|
|
128 | this fucntion automatically, at some performance loss (refer to the libev |
|
|
129 | documentation). |
|
|
130 | |
|
|
131 | =back |
|
|
132 | |
|
|
133 | |
91 | =head1 BASIC INTERFACE |
134 | =head1 BASIC INTERFACE |
92 | |
135 | |
93 | =over 4 |
136 | =over 4 |
94 | |
137 | |
95 | =item $EV::DIED |
138 | =item $EV::DIED |
96 | |
139 | |
97 | Must contain a reference to a function that is called when a callback |
140 | Must contain a reference to a function that is called when a callback |
98 | throws an exception (with $@ containing thr error). The default prints an |
141 | throws an exception (with $@ containing the error). The default prints an |
99 | informative message and continues. |
142 | informative message and continues. |
100 | |
143 | |
101 | If this callback throws an exception it will be silently ignored. |
144 | If this callback throws an exception it will be silently ignored. |
102 | |
145 | |
103 | =item $time = EV::time |
146 | =item $time = EV::time |
104 | |
147 | |
105 | Returns the current time in (fractional) seconds since the epoch. |
148 | Returns the current time in (fractional) seconds since the epoch. |
106 | |
149 | |
107 | =item $time = EV::now |
150 | =item $time = EV::now |
|
|
151 | |
|
|
152 | =item $time = $loop->now |
108 | |
153 | |
109 | Returns the time the last event loop iteration has been started. This |
154 | Returns the time the last event loop iteration has been started. This |
110 | is the time that (relative) timers are based on, and refering to it is |
155 | is the time that (relative) timers are based on, and refering to it is |
111 | usually faster then calling EV::time. |
156 | usually faster then calling EV::time. |
112 | |
157 | |
113 | =item $method = EV::method |
158 | =item $backend = EV::backend |
|
|
159 | |
|
|
160 | =item $backend = $loop->backend |
114 | |
161 | |
115 | Returns an integer describing the backend used by libev (EV::METHOD_SELECT |
162 | Returns an integer describing the backend used by libev (EV::METHOD_SELECT |
116 | or EV::METHOD_EPOLL). |
163 | or EV::METHOD_EPOLL). |
117 | |
164 | |
118 | =item EV::loop [$flags] |
165 | =item EV::loop [$flags] |
|
|
166 | |
|
|
167 | =item $loop->loop ([$flags]) |
119 | |
168 | |
120 | Begin checking for events and calling callbacks. It returns when a |
169 | Begin checking for events and calling callbacks. It returns when a |
121 | callback calls EV::unloop. |
170 | callback calls EV::unloop. |
122 | |
171 | |
123 | The $flags argument can be one of the following: |
172 | The $flags argument can be one of the following: |
… | |
… | |
126 | EV::LOOP_ONESHOT block at most once (wait, but do not loop) |
175 | EV::LOOP_ONESHOT block at most once (wait, but do not loop) |
127 | EV::LOOP_NONBLOCK do not block at all (fetch/handle events but do not wait) |
176 | EV::LOOP_NONBLOCK do not block at all (fetch/handle events but do not wait) |
128 | |
177 | |
129 | =item EV::unloop [$how] |
178 | =item EV::unloop [$how] |
130 | |
179 | |
|
|
180 | =item $loop->unloop ([$how]) |
|
|
181 | |
131 | When called with no arguments or an argument of EV::UNLOOP_ONE, makes the |
182 | When called with no arguments or an argument of EV::UNLOOP_ONE, makes the |
132 | innermost call to EV::loop return. |
183 | innermost call to EV::loop return. |
133 | |
184 | |
134 | When called with an argument of EV::UNLOOP_ALL, all calls to EV::loop will return as |
185 | When called with an argument of EV::UNLOOP_ALL, all calls to EV::loop will return as |
135 | fast as possible. |
186 | fast as possible. |
136 | |
187 | |
137 | =item $count = EV::loop_count |
188 | =item $count = EV::loop_count |
138 | |
189 | |
|
|
190 | =item $count = $loop->loop_count |
|
|
191 | |
139 | Return the number of times the event loop has polled for new |
192 | Return the number of times the event loop has polled for new |
140 | events. Sometiems useful as a generation counter. |
193 | events. Sometiems useful as a generation counter. |
141 | |
194 | |
142 | =item EV::once $fh_or_undef, $events, $timeout, $cb->($revents) |
195 | =item EV::once $fh_or_undef, $events, $timeout, $cb->($revents) |
|
|
196 | |
|
|
197 | =item $loop->once ($fh_or_undef, $events, $timeout, $cb->($revents)) |
143 | |
198 | |
144 | This function rolls together an I/O and a timer watcher for a single |
199 | This function rolls together an I/O and a timer watcher for a single |
145 | one-shot event without the need for managing a watcher object. |
200 | one-shot event without the need for managing a watcher object. |
146 | |
201 | |
147 | If C<$fh_or_undef> is a filehandle or file descriptor, then C<$events> |
202 | If C<$fh_or_undef> is a filehandle or file descriptor, then C<$events> |
… | |
… | |
160 | |
215 | |
161 | EV::once doesn't return anything: the watchers stay active till either |
216 | EV::once doesn't return anything: the watchers stay active till either |
162 | of them triggers, then they will be stopped and freed, and the callback |
217 | of them triggers, then they will be stopped and freed, and the callback |
163 | invoked. |
218 | invoked. |
164 | |
219 | |
165 | =back |
220 | =item EV::feed_fd_event ($fd, $revents) |
166 | |
221 | |
|
|
222 | =item $loop->feed_fd_event ($fd, $revents) |
|
|
223 | |
|
|
224 | Feed an event on a file descriptor into EV. EV will react to this call as |
|
|
225 | if the readyness notifications specified by C<$revents> (a combination of |
|
|
226 | C<EV::READ> and C<EV::WRITE>) happened on the file descriptor C<$fd>. |
|
|
227 | |
|
|
228 | =item EV::feed_signal_event ($signal) |
|
|
229 | |
|
|
230 | Feed a signal event into EV. EV will react to this call as if the signal |
|
|
231 | specified by C<$signal> had occured. |
|
|
232 | |
|
|
233 | =back |
|
|
234 | |
|
|
235 | |
167 | =head2 WATCHER OBJECTS |
236 | =head1 WATCHER OBJECTS |
168 | |
237 | |
169 | A watcher is an object that gets created to record your interest in some |
238 | A watcher is an object that gets created to record your interest in some |
170 | event. For instance, if you want to wait for STDIN to become readable, you |
239 | event. For instance, if you want to wait for STDIN to become readable, you |
171 | would create an EV::io watcher for that: |
240 | would create an EV::io watcher for that: |
172 | |
241 | |
… | |
… | |
253 | The default priority of any newly-created watcher is 0. |
322 | The default priority of any newly-created watcher is 0. |
254 | |
323 | |
255 | Note that the priority semantics have not yet been fleshed out and are |
324 | Note that the priority semantics have not yet been fleshed out and are |
256 | subject to almost certain change. |
325 | subject to almost certain change. |
257 | |
326 | |
258 | =item $w->trigger ($revents) |
327 | =item $w->invoke ($revents) |
259 | |
328 | |
260 | Call the callback *now* with the given event mask. |
329 | Call the callback *now* with the given event mask. |
|
|
330 | |
|
|
331 | =item $w->feed_event ($revents) |
|
|
332 | |
|
|
333 | Feed some events on this watcher into EV. EV will react to this call as if |
|
|
334 | the watcher had received the given C<$revents> mask. |
|
|
335 | |
|
|
336 | =item $revents = $w->clear_pending |
|
|
337 | |
|
|
338 | If the watcher is pending, this function returns clears its pending status |
|
|
339 | and returns its C<$revents> bitset (as if its callback was invoked). If the |
|
|
340 | watcher isn't pending it does nothing and returns C<0>. |
261 | |
341 | |
262 | =item $previous_state = $w->keepalive ($bool) |
342 | =item $previous_state = $w->keepalive ($bool) |
263 | |
343 | |
264 | Normally, C<EV::loop> will return when there are no active watchers |
344 | Normally, C<EV::loop> will return when there are no active watchers |
265 | (which is a "deadlock" because no progress can be made anymore). This is |
345 | (which is a "deadlock" because no progress can be made anymore). This is |
… | |
… | |
283 | Example: Register an I/O watcher for some UDP socket but do not keep the |
363 | Example: Register an I/O watcher for some UDP socket but do not keep the |
284 | event loop from running just because of that watcher. |
364 | event loop from running just because of that watcher. |
285 | |
365 | |
286 | my $udp_socket = ... |
366 | my $udp_socket = ... |
287 | my $udp_watcher = EV::io $udp_socket, EV::READ, sub { ... }; |
367 | my $udp_watcher = EV::io $udp_socket, EV::READ, sub { ... }; |
288 | $udp_watcher->keepalive (0); |
368 | $1000udp_watcher->keepalive (0); |
289 | |
369 | |
290 | =back |
370 | =item $loop = $w->loop |
291 | |
371 | |
|
|
372 | Return the loop that this watcher is attached to. |
292 | |
373 | |
|
|
374 | =back |
|
|
375 | |
|
|
376 | |
293 | =head2 WATCHER TYPES |
377 | =head1 WATCHER TYPES |
294 | |
378 | |
295 | Each of the following subsections describes a single watcher type. |
379 | Each of the following subsections describes a single watcher type. |
296 | |
380 | |
297 | =head3 I/O WATCHERS - is this file descriptor readable or writable? |
381 | =head3 I/O WATCHERS - is this file descriptor readable or writable? |
298 | |
382 | |
299 | =over 4 |
383 | =over 4 |
300 | |
384 | |
301 | =item $w = EV::io $fileno_or_fh, $eventmask, $callback |
385 | =item $w = EV::io $fileno_or_fh, $eventmask, $callback |
302 | |
386 | |
303 | =item $w = EV::io_ns $fileno_or_fh, $eventmask, $callback |
387 | =item $w = EV::io_ns $fileno_or_fh, $eventmask, $callback |
|
|
388 | |
|
|
389 | =item $w = $loop->io 8$fileno_or_fh, $eventmask, $callback) |
|
|
390 | |
|
|
391 | =item $w = $loop->io_ns ($fileno_or_fh, $eventmask, $callback) |
304 | |
392 | |
305 | As long as the returned watcher object is alive, call the C<$callback> |
393 | As long as the returned watcher object is alive, call the C<$callback> |
306 | when at least one of events specified in C<$eventmask> occurs. |
394 | when at least one of events specified in C<$eventmask> occurs. |
307 | |
395 | |
308 | The $eventmask can be one or more of these constants ORed together: |
396 | The $eventmask can be one or more of these constants ORed together: |
… | |
… | |
337 | =over 4 |
425 | =over 4 |
338 | |
426 | |
339 | =item $w = EV::timer $after, $repeat, $callback |
427 | =item $w = EV::timer $after, $repeat, $callback |
340 | |
428 | |
341 | =item $w = EV::timer_ns $after, $repeat, $callback |
429 | =item $w = EV::timer_ns $after, $repeat, $callback |
|
|
430 | |
|
|
431 | =item $w = $loop->timer ($after, $repeat, $callback) |
|
|
432 | |
|
|
433 | =item $w = $loop->timer_ns ($after, $repeat, $callback) |
342 | |
434 | |
343 | Calls the callback after C<$after> seconds (which may be fractional). If |
435 | Calls the callback after C<$after> seconds (which may be fractional). If |
344 | C<$repeat> is non-zero, the timer will be restarted (with the $repeat |
436 | C<$repeat> is non-zero, the timer will be restarted (with the $repeat |
345 | value as $after) after the callback returns. |
437 | value as $after) after the callback returns. |
346 | |
438 | |
… | |
… | |
387 | =over 4 |
479 | =over 4 |
388 | |
480 | |
389 | =item $w = EV::periodic $at, $interval, $reschedule_cb, $callback |
481 | =item $w = EV::periodic $at, $interval, $reschedule_cb, $callback |
390 | |
482 | |
391 | =item $w = EV::periodic_ns $at, $interval, $reschedule_cb, $callback |
483 | =item $w = EV::periodic_ns $at, $interval, $reschedule_cb, $callback |
|
|
484 | |
|
|
485 | =item $w = $loop->periodic ($at, $interval, $reschedule_cb, $callback) |
|
|
486 | |
|
|
487 | =item $w = $loop->periodic_ns ($at, $interval, $reschedule_cb, $callback) |
392 | |
488 | |
393 | Similar to EV::timer, but is not based on relative timeouts but on |
489 | Similar to EV::timer, but is not based on relative timeouts but on |
394 | absolute times. Apart from creating "simple" timers that trigger "at" the |
490 | absolute times. Apart from creating "simple" timers that trigger "at" the |
395 | specified time, it can also be used for non-drifting absolute timers and |
491 | specified time, it can also be used for non-drifting absolute timers and |
396 | more complex, cron-like, setups that are not adversely affected by time |
492 | more complex, cron-like, setups that are not adversely affected by time |
… | |
… | |
471 | |
567 | |
472 | =item $w->again |
568 | =item $w->again |
473 | |
569 | |
474 | Simply stops and starts the watcher again. |
570 | Simply stops and starts the watcher again. |
475 | |
571 | |
|
|
572 | =item $time = $w->at |
|
|
573 | |
|
|
574 | Return the time that the watcher is expected to trigger next. |
|
|
575 | |
476 | =back |
576 | =back |
477 | |
577 | |
478 | |
578 | |
479 | =head3 SIGNAL WATCHERS - signal me when a signal gets signalled! |
579 | =head3 SIGNAL WATCHERS - signal me when a signal gets signalled! |
480 | |
580 | |
… | |
… | |
517 | |
617 | |
518 | =item $w = EV::child $pid, $callback |
618 | =item $w = EV::child $pid, $callback |
519 | |
619 | |
520 | =item $w = EV::child_ns $pid, $callback |
620 | =item $w = EV::child_ns $pid, $callback |
521 | |
621 | |
|
|
622 | =item $w = $loop->child ($pid, $callback) |
|
|
623 | |
|
|
624 | =item $w = $loop->child_ns ($pid, $callback) |
|
|
625 | |
522 | Call the callback when a status change for pid C<$pid> (or any pid if |
626 | Call the callback when a status change for pid C<$pid> (or any pid if |
523 | C<$pid> is 0) has been received. More precisely: when the process receives |
627 | C<$pid> is 0) has been received. More precisely: when the process receives |
524 | a C<SIGCHLD>, EV will fetch the outstanding exit/wait status for all |
628 | a C<SIGCHLD>, EV will fetch the outstanding exit/wait status for all |
525 | changed/zombie children and call the callback. |
629 | changed/zombie children and call the callback. |
526 | |
630 | |
… | |
… | |
567 | |
671 | |
568 | =item $w = EV::stat $path, $interval, $callback |
672 | =item $w = EV::stat $path, $interval, $callback |
569 | |
673 | |
570 | =item $w = EV::stat_ns $path, $interval, $callback |
674 | =item $w = EV::stat_ns $path, $interval, $callback |
571 | |
675 | |
|
|
676 | =item $w = $loop->stat ($path, $interval, $callback) |
|
|
677 | |
|
|
678 | =item $w = $loop->stat_ns ($path, $interval, $callback) |
|
|
679 | |
572 | Call the callback when a file status change has been detected on |
680 | Call the callback when a file status change has been detected on |
573 | C<$path>. The C<$path> does not need to exist, changing from "path exists" |
681 | C<$path>. The C<$path> does not need to exist, changing from "path exists" |
574 | to "path does not exist" is a status change like any other. |
682 | to "path does not exist" is a status change like any other. |
575 | |
683 | |
576 | The C<$interval> is a recommended polling interval for systems where |
684 | The C<$interval> is a recommended polling interval for systems where |
… | |
… | |
645 | =over 4 |
753 | =over 4 |
646 | |
754 | |
647 | =item $w = EV::idle $callback |
755 | =item $w = EV::idle $callback |
648 | |
756 | |
649 | =item $w = EV::idle_ns $callback |
757 | =item $w = EV::idle_ns $callback |
|
|
758 | |
|
|
759 | =item $w = $loop->idle ($callback) |
|
|
760 | |
|
|
761 | =item $w = $loop->idle_ns ($callback) |
650 | |
762 | |
651 | Call the callback when there are no other pending watchers of the same or |
763 | Call the callback when there are no other pending watchers of the same or |
652 | higher priority (excluding check, prepare and other idle watchers of the |
764 | higher priority (excluding check, prepare and other idle watchers of the |
653 | same or lower priority, of course). They are called idle watchers because |
765 | same or lower priority, of course). They are called idle watchers because |
654 | when the watcher is the highest priority pending event in the process, the |
766 | when the watcher is the highest priority pending event in the process, the |
… | |
… | |
677 | |
789 | |
678 | =item $w = EV::prepare $callback |
790 | =item $w = EV::prepare $callback |
679 | |
791 | |
680 | =item $w = EV::prepare_ns $callback |
792 | =item $w = EV::prepare_ns $callback |
681 | |
793 | |
|
|
794 | =item $w = $loop->prepare ($callback) |
|
|
795 | |
|
|
796 | =item $w = $loop->prepare_ns 8$callback) |
|
|
797 | |
682 | Call the callback just before the process would block. You can still |
798 | Call the callback just before the process would block. You can still |
683 | create/modify any watchers at this point. |
799 | create/modify any watchers at this point. |
684 | |
800 | |
685 | See the EV::check watcher, below, for explanations and an example. |
801 | See the EV::check watcher, below, for explanations and an example. |
686 | |
802 | |
… | |
… | |
694 | =over 4 |
810 | =over 4 |
695 | |
811 | |
696 | =item $w = EV::check $callback |
812 | =item $w = EV::check $callback |
697 | |
813 | |
698 | =item $w = EV::check_ns $callback |
814 | =item $w = EV::check_ns $callback |
|
|
815 | |
|
|
816 | =item $w = $loop->check ($callback) |
|
|
817 | |
|
|
818 | =item $w = $loop->check_ns ($callback) |
699 | |
819 | |
700 | Call the callback just after the process wakes up again (after it has |
820 | Call the callback just after the process wakes up again (after it has |
701 | gathered events), but before any other callbacks have been invoked. |
821 | gathered events), but before any other callbacks have been invoked. |
702 | |
822 | |
703 | This is used to integrate other event-based software into the EV |
823 | This is used to integrate other event-based software into the EV |
… | |
… | |
758 | |
878 | |
759 | =item $w = EV::fork $callback |
879 | =item $w = EV::fork $callback |
760 | |
880 | |
761 | =item $w = EV::fork_ns $callback |
881 | =item $w = EV::fork_ns $callback |
762 | |
882 | |
|
|
883 | =item $w = $loop->fork ($callback) |
|
|
884 | |
|
|
885 | =item $w = $loop->fork_ns ($callback) |
|
|
886 | |
763 | Call the callback before the event loop is resumed in the child process |
887 | Call the callback before the event loop is resumed in the child process |
764 | after a fork. |
888 | after a fork. |
765 | |
889 | |
766 | The C<fork_ns> variant doesn't start (activate) the newly created watcher. |
890 | The C<fork_ns> variant doesn't start (activate) the newly created watcher. |
767 | |
891 | |
… | |
… | |
782 | to be called on every event loop iteration by installing a C<EV::check> |
906 | to be called on every event loop iteration by installing a C<EV::check> |
783 | watcher: |
907 | watcher: |
784 | |
908 | |
785 | my $async_check = EV::check sub { }; |
909 | my $async_check = EV::check sub { }; |
786 | |
910 | |
787 | This ensures that perl shortly gets into control for a short time, and |
911 | This ensures that perl gets into control for a short time to handle any |
788 | also ensures slower overall operation. |
912 | pending signals, and also ensures (slightly) slower overall operation. |
789 | |
913 | |
790 | =head1 THREADS |
914 | =head1 THREADS |
791 | |
915 | |
792 | Threads are not supported by this module in any way. Perl pseudo-threads |
916 | Threads are not supported by this module in any way. Perl pseudo-threads |
793 | is evil stuff and must die. As soon as Perl gains real threads I will work |
917 | is evil stuff and must die. As soon as Perl gains real threads I will work |
… | |
… | |
815 | our $DIED = sub { |
939 | our $DIED = sub { |
816 | warn "EV: error in callback (ignoring): $@"; |
940 | warn "EV: error in callback (ignoring): $@"; |
817 | }; |
941 | }; |
818 | |
942 | |
819 | default_loop |
943 | default_loop |
820 | or die 'EV: cannot initialise libev backend. bad $ENV{LIBEV_METHODS}?'; |
944 | or die 'EV: cannot initialise libev backend. bad $ENV{LIBEV_FLAGS}?'; |
821 | |
945 | |
822 | 1; |
946 | 1; |
823 | |
947 | |
824 | =head1 SEE ALSO |
948 | =head1 SEE ALSO |
825 | |
949 | |
826 | L<EV::ADNS> (asynchronous dns), L<Glib::EV> (makes Glib/Gtk2 use EV as |
950 | L<EV::ADNS> (asynchronous DNS), L<Glib::EV> (makes Glib/Gtk2 use EV as |
827 | event loop), L<Coro::EV> (efficient coroutines with EV). |
951 | event loop), L<EV::Glib> (embed Glib into EV), L<Coro::EV> (efficient |
|
|
952 | coroutines with EV), L<Net::SNMP::EV> (asynchronous SNMP). |
828 | |
953 | |
829 | =head1 AUTHOR |
954 | =head1 AUTHOR |
830 | |
955 | |
831 | Marc Lehmann <schmorp@schmorp.de> |
956 | Marc Lehmann <schmorp@schmorp.de> |
832 | http://home.schmorp.de/ |
957 | http://home.schmorp.de/ |