… | |
… | |
68 | package EV; |
68 | package EV; |
69 | |
69 | |
70 | use strict; |
70 | use strict; |
71 | |
71 | |
72 | BEGIN { |
72 | BEGIN { |
73 | our $VERSION = '1.8'; |
73 | our $VERSION = '2.01'; |
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 can 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 | =item $loop = EV::default_loop [$flags] |
|
|
132 | |
|
|
133 | Return the default loop (which is a singleton object). |
|
|
134 | |
|
|
135 | =back |
|
|
136 | |
|
|
137 | |
91 | =head1 BASIC INTERFACE |
138 | =head1 BASIC INTERFACE |
92 | |
139 | |
93 | =over 4 |
140 | =over 4 |
94 | |
141 | |
95 | =item $EV::DIED |
142 | =item $EV::DIED |
96 | |
143 | |
97 | Must contain a reference to a function that is called when a callback |
144 | 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 |
145 | throws an exception (with $@ containing the error). The default prints an |
99 | informative message and continues. |
146 | informative message and continues. |
100 | |
147 | |
101 | If this callback throws an exception it will be silently ignored. |
148 | If this callback throws an exception it will be silently ignored. |
102 | |
149 | |
|
|
150 | =item $flags = EV::supported_backends |
|
|
151 | |
|
|
152 | =item $flags = EV::recommended_backends |
|
|
153 | |
|
|
154 | =item $flags = EV::embeddable_backends |
|
|
155 | |
|
|
156 | Returns the set (see C<EV::BACKEND_*> flags) of backends supported by this |
|
|
157 | instance of EV, the set of recommended backends (supposed to be good) for |
|
|
158 | this platform and the set of embeddable backends (see EMBED WATCHERS). |
|
|
159 | |
|
|
160 | =item EV::sleep $seconds |
|
|
161 | |
|
|
162 | Block the process for the given number of (fractional) seconds. |
|
|
163 | |
103 | =item $time = EV::time |
164 | =item $time = EV::time |
104 | |
165 | |
105 | Returns the current time in (fractional) seconds since the epoch. |
166 | Returns the current time in (fractional) seconds since the epoch. |
106 | |
167 | |
107 | =item $time = EV::now |
168 | =item $time = EV::now |
|
|
169 | |
|
|
170 | =item $time = $loop->now |
108 | |
171 | |
109 | Returns the time the last event loop iteration has been started. This |
172 | 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 |
173 | is the time that (relative) timers are based on, and refering to it is |
111 | usually faster then calling EV::time. |
174 | usually faster then calling EV::time. |
112 | |
175 | |
113 | =item $method = EV::method |
176 | =item $backend = EV::backend |
|
|
177 | |
|
|
178 | =item $backend = $loop->backend |
114 | |
179 | |
115 | Returns an integer describing the backend used by libev (EV::METHOD_SELECT |
180 | Returns an integer describing the backend used by libev (EV::METHOD_SELECT |
116 | or EV::METHOD_EPOLL). |
181 | or EV::METHOD_EPOLL). |
117 | |
182 | |
118 | =item EV::loop [$flags] |
183 | =item EV::loop [$flags] |
|
|
184 | |
|
|
185 | =item $loop->loop ([$flags]) |
119 | |
186 | |
120 | Begin checking for events and calling callbacks. It returns when a |
187 | Begin checking for events and calling callbacks. It returns when a |
121 | callback calls EV::unloop. |
188 | callback calls EV::unloop. |
122 | |
189 | |
123 | The $flags argument can be one of the following: |
190 | The $flags argument can be one of the following: |
… | |
… | |
126 | EV::LOOP_ONESHOT block at most once (wait, but do not loop) |
193 | 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) |
194 | EV::LOOP_NONBLOCK do not block at all (fetch/handle events but do not wait) |
128 | |
195 | |
129 | =item EV::unloop [$how] |
196 | =item EV::unloop [$how] |
130 | |
197 | |
|
|
198 | =item $loop->unloop ([$how]) |
|
|
199 | |
131 | When called with no arguments or an argument of EV::UNLOOP_ONE, makes the |
200 | When called with no arguments or an argument of EV::UNLOOP_ONE, makes the |
132 | innermost call to EV::loop return. |
201 | innermost call to EV::loop return. |
133 | |
202 | |
134 | When called with an argument of EV::UNLOOP_ALL, all calls to EV::loop will return as |
203 | When called with an argument of EV::UNLOOP_ALL, all calls to EV::loop will return as |
135 | fast as possible. |
204 | fast as possible. |
136 | |
205 | |
137 | =item $count = EV::loop_count |
206 | =item $count = EV::loop_count |
138 | |
207 | |
|
|
208 | =item $count = $loop->loop_count |
|
|
209 | |
139 | Return the number of times the event loop has polled for new |
210 | Return the number of times the event loop has polled for new |
140 | events. Sometiems useful as a generation counter. |
211 | events. Sometiems useful as a generation counter. |
141 | |
212 | |
142 | =item EV::once $fh_or_undef, $events, $timeout, $cb->($revents) |
213 | =item EV::once $fh_or_undef, $events, $timeout, $cb->($revents) |
|
|
214 | |
|
|
215 | =item $loop->once ($fh_or_undef, $events, $timeout, $cb->($revents)) |
143 | |
216 | |
144 | This function rolls together an I/O and a timer watcher for a single |
217 | 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. |
218 | one-shot event without the need for managing a watcher object. |
146 | |
219 | |
147 | If C<$fh_or_undef> is a filehandle or file descriptor, then C<$events> |
220 | If C<$fh_or_undef> is a filehandle or file descriptor, then C<$events> |
… | |
… | |
153 | If timeout is C<undef> or negative, then there will be no |
226 | If timeout is C<undef> or negative, then there will be no |
154 | timeout. Otherwise a EV::timer with this value will be started. |
227 | timeout. Otherwise a EV::timer with this value will be started. |
155 | |
228 | |
156 | When an error occurs or either the timeout or I/O watcher triggers, then |
229 | When an error occurs or either the timeout or I/O watcher triggers, then |
157 | the callback will be called with the received event set (in general |
230 | the callback will be called with the received event set (in general |
158 | you can expect it to be a combination of C<EV:ERROR>, C<EV::READ>, |
231 | you can expect it to be a combination of C<EV::ERROR>, C<EV::READ>, |
159 | C<EV::WRITE> and C<EV::TIMEOUT>). |
232 | C<EV::WRITE> and C<EV::TIMEOUT>). |
160 | |
233 | |
161 | EV::once doesn't return anything: the watchers stay active till either |
234 | 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 |
235 | of them triggers, then they will be stopped and freed, and the callback |
163 | invoked. |
236 | invoked. |
164 | |
237 | |
165 | =back |
238 | =item EV::feed_fd_event ($fd, $revents) |
166 | |
239 | |
|
|
240 | =item $loop->feed_fd_event ($fd, $revents) |
|
|
241 | |
|
|
242 | Feed an event on a file descriptor into EV. EV will react to this call as |
|
|
243 | if the readyness notifications specified by C<$revents> (a combination of |
|
|
244 | C<EV::READ> and C<EV::WRITE>) happened on the file descriptor C<$fd>. |
|
|
245 | |
|
|
246 | =item EV::feed_signal_event ($signal) |
|
|
247 | |
|
|
248 | Feed a signal event into EV. EV will react to this call as if the signal |
|
|
249 | specified by C<$signal> had occured. |
|
|
250 | |
|
|
251 | =item EV::set_io_collect_interval $time |
|
|
252 | |
|
|
253 | =item $loop->set_io_collect_interval ($time) |
|
|
254 | |
|
|
255 | =item EV::set_timeout_collect_interval $time |
|
|
256 | |
|
|
257 | =item $loop->set_timeout_collect_interval ($time) |
|
|
258 | |
|
|
259 | These advanced functions set the minimum block interval when polling for I/O events and the minimum |
|
|
260 | wait interval for timer events. See the libev documentation at |
|
|
261 | L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#FUNCTIONS_CONTROLLING_THE_EVENT_LOOP> for |
|
|
262 | a more detailed discussion. |
|
|
263 | |
|
|
264 | =back |
|
|
265 | |
|
|
266 | |
167 | =head2 WATCHER OBJECTS |
267 | =head1 WATCHER OBJECTS |
168 | |
268 | |
169 | A watcher is an object that gets created to record your interest in some |
269 | 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 |
270 | event. For instance, if you want to wait for STDIN to become readable, you |
171 | would create an EV::io watcher for that: |
271 | would create an EV::io watcher for that: |
172 | |
272 | |
173 | my $watcher = EV::io *STDIN, EV::READ, sub { |
273 | my $watcher = EV::io *STDIN, EV::READ, sub { |
174 | my ($watcher, $revents) = @_; |
274 | my ($watcher, $revents) = @_; |
175 | warn "yeah, STDIN should not be readable without blocking!\n" |
275 | warn "yeah, STDIN should now be readable without blocking!\n" |
176 | }; |
276 | }; |
177 | |
277 | |
178 | All watchers can be active (waiting for events) or inactive (paused). Only |
278 | All watchers can be active (waiting for events) or inactive (paused). Only |
179 | active watchers will have their callbacks invoked. All callbacks will be |
279 | active watchers will have their callbacks invoked. All callbacks will be |
180 | called with at least two arguments: the watcher and a bitmask of received |
280 | called with at least two arguments: the watcher and a bitmask of received |
… | |
… | |
253 | The default priority of any newly-created watcher is 0. |
353 | The default priority of any newly-created watcher is 0. |
254 | |
354 | |
255 | Note that the priority semantics have not yet been fleshed out and are |
355 | Note that the priority semantics have not yet been fleshed out and are |
256 | subject to almost certain change. |
356 | subject to almost certain change. |
257 | |
357 | |
258 | =item $w->trigger ($revents) |
358 | =item $w->invoke ($revents) |
259 | |
359 | |
260 | Call the callback *now* with the given event mask. |
360 | Call the callback *now* with the given event mask. |
|
|
361 | |
|
|
362 | =item $w->feed_event ($revents) |
|
|
363 | |
|
|
364 | Feed some events on this watcher into EV. EV will react to this call as if |
|
|
365 | the watcher had received the given C<$revents> mask. |
|
|
366 | |
|
|
367 | =item $revents = $w->clear_pending |
|
|
368 | |
|
|
369 | If the watcher is pending, this function clears its pending status and |
|
|
370 | returns its C<$revents> bitset (as if its callback was invoked). If the |
|
|
371 | watcher isn't pending it does nothing and returns C<0>. |
261 | |
372 | |
262 | =item $previous_state = $w->keepalive ($bool) |
373 | =item $previous_state = $w->keepalive ($bool) |
263 | |
374 | |
264 | Normally, C<EV::loop> will return when there are no active watchers |
375 | 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 |
376 | (which is a "deadlock" because no progress can be made anymore). This is |
266 | convinient because it allows you to start your watchers (and your jobs), |
377 | convinient because it allows you to start your watchers (and your jobs), |
267 | call C<EV::loop> once and when it returns you know that all your jobs are |
378 | call C<EV::loop> once and when it returns you know that all your jobs are |
268 | finished (or they forgot to register some watchers for their task :). |
379 | finished (or they forgot to register some watchers for their task :). |
269 | |
380 | |
270 | Sometimes, however, this gets in your way, for example when you the module |
381 | Sometimes, however, this gets in your way, for example when the module |
271 | that calls C<EV::loop> (usually the main program) is not the same module |
382 | that calls C<EV::loop> (usually the main program) is not the same module |
272 | as a long-living watcher (for example a DNS client module written by |
383 | as a long-living watcher (for example a DNS client module written by |
273 | somebody else even). Then you might want any outstanding requests to be |
384 | somebody else even). Then you might want any outstanding requests to be |
274 | handled, but you would not want to keep C<EV::loop> from returning just |
385 | handled, but you would not want to keep C<EV::loop> from returning just |
275 | because you happen to have this long-running UDP port watcher. |
386 | because you happen to have this long-running UDP port watcher. |
… | |
… | |
283 | Example: Register an I/O watcher for some UDP socket but do not keep the |
394 | 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. |
395 | event loop from running just because of that watcher. |
285 | |
396 | |
286 | my $udp_socket = ... |
397 | my $udp_socket = ... |
287 | my $udp_watcher = EV::io $udp_socket, EV::READ, sub { ... }; |
398 | my $udp_watcher = EV::io $udp_socket, EV::READ, sub { ... }; |
288 | $udp_watcher->keepalive (0); |
399 | $1000udp_watcher->keepalive (0); |
289 | |
400 | |
290 | =back |
401 | =item $loop = $w->loop |
291 | |
402 | |
|
|
403 | Return the loop that this watcher is attached to. |
292 | |
404 | |
|
|
405 | =back |
|
|
406 | |
|
|
407 | |
293 | =head2 WATCHER TYPES |
408 | =head1 WATCHER TYPES |
294 | |
409 | |
295 | Each of the following subsections describes a single watcher type. |
410 | Each of the following subsections describes a single watcher type. |
296 | |
411 | |
297 | =head3 I/O WATCHERS - is this file descriptor readable or writable? |
412 | =head3 I/O WATCHERS - is this file descriptor readable or writable? |
298 | |
413 | |
299 | =over 4 |
414 | =over 4 |
300 | |
415 | |
301 | =item $w = EV::io $fileno_or_fh, $eventmask, $callback |
416 | =item $w = EV::io $fileno_or_fh, $eventmask, $callback |
302 | |
417 | |
303 | =item $w = EV::io_ns $fileno_or_fh, $eventmask, $callback |
418 | =item $w = EV::io_ns $fileno_or_fh, $eventmask, $callback |
|
|
419 | |
|
|
420 | =item $w = $loop->io ($fileno_or_fh, $eventmask, $callback) |
|
|
421 | |
|
|
422 | =item $w = $loop->io_ns ($fileno_or_fh, $eventmask, $callback) |
304 | |
423 | |
305 | As long as the returned watcher object is alive, call the C<$callback> |
424 | 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. |
425 | when at least one of events specified in C<$eventmask> occurs. |
307 | |
426 | |
308 | The $eventmask can be one or more of these constants ORed together: |
427 | The $eventmask can be one or more of these constants ORed together: |
… | |
… | |
337 | =over 4 |
456 | =over 4 |
338 | |
457 | |
339 | =item $w = EV::timer $after, $repeat, $callback |
458 | =item $w = EV::timer $after, $repeat, $callback |
340 | |
459 | |
341 | =item $w = EV::timer_ns $after, $repeat, $callback |
460 | =item $w = EV::timer_ns $after, $repeat, $callback |
|
|
461 | |
|
|
462 | =item $w = $loop->timer ($after, $repeat, $callback) |
|
|
463 | |
|
|
464 | =item $w = $loop->timer_ns ($after, $repeat, $callback) |
342 | |
465 | |
343 | Calls the callback after C<$after> seconds (which may be fractional). If |
466 | 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 |
467 | C<$repeat> is non-zero, the timer will be restarted (with the $repeat |
345 | value as $after) after the callback returns. |
468 | value as $after) after the callback returns. |
346 | |
469 | |
… | |
… | |
387 | =over 4 |
510 | =over 4 |
388 | |
511 | |
389 | =item $w = EV::periodic $at, $interval, $reschedule_cb, $callback |
512 | =item $w = EV::periodic $at, $interval, $reschedule_cb, $callback |
390 | |
513 | |
391 | =item $w = EV::periodic_ns $at, $interval, $reschedule_cb, $callback |
514 | =item $w = EV::periodic_ns $at, $interval, $reschedule_cb, $callback |
|
|
515 | |
|
|
516 | =item $w = $loop->periodic ($at, $interval, $reschedule_cb, $callback) |
|
|
517 | |
|
|
518 | =item $w = $loop->periodic_ns ($at, $interval, $reschedule_cb, $callback) |
392 | |
519 | |
393 | Similar to EV::timer, but is not based on relative timeouts but on |
520 | 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 |
521 | 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 |
522 | 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 |
523 | more complex, cron-like, setups that are not adversely affected by time |
… | |
… | |
471 | |
598 | |
472 | =item $w->again |
599 | =item $w->again |
473 | |
600 | |
474 | Simply stops and starts the watcher again. |
601 | Simply stops and starts the watcher again. |
475 | |
602 | |
|
|
603 | =item $time = $w->at |
|
|
604 | |
|
|
605 | Return the time that the watcher is expected to trigger next. |
|
|
606 | |
476 | =back |
607 | =back |
477 | |
608 | |
478 | |
609 | |
479 | =head3 SIGNAL WATCHERS - signal me when a signal gets signalled! |
610 | =head3 SIGNAL WATCHERS - signal me when a signal gets signalled! |
480 | |
611 | |
… | |
… | |
517 | |
648 | |
518 | =item $w = EV::child $pid, $callback |
649 | =item $w = EV::child $pid, $callback |
519 | |
650 | |
520 | =item $w = EV::child_ns $pid, $callback |
651 | =item $w = EV::child_ns $pid, $callback |
521 | |
652 | |
|
|
653 | =item $w = $loop->child ($pid, $callback) |
|
|
654 | |
|
|
655 | =item $w = $loop->child_ns ($pid, $callback) |
|
|
656 | |
522 | Call the callback when a status change for pid C<$pid> (or any pid if |
657 | 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 |
658 | 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 |
659 | a C<SIGCHLD>, EV will fetch the outstanding exit/wait status for all |
525 | changed/zombie children and call the callback. |
660 | changed/zombie children and call the callback. |
526 | |
661 | |
… | |
… | |
567 | |
702 | |
568 | =item $w = EV::stat $path, $interval, $callback |
703 | =item $w = EV::stat $path, $interval, $callback |
569 | |
704 | |
570 | =item $w = EV::stat_ns $path, $interval, $callback |
705 | =item $w = EV::stat_ns $path, $interval, $callback |
571 | |
706 | |
|
|
707 | =item $w = $loop->stat ($path, $interval, $callback) |
|
|
708 | |
|
|
709 | =item $w = $loop->stat_ns ($path, $interval, $callback) |
|
|
710 | |
572 | Call the callback when a file status change has been detected on |
711 | 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" |
712 | 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. |
713 | to "path does not exist" is a status change like any other. |
575 | |
714 | |
576 | The C<$interval> is a recommended polling interval for systems where |
715 | The C<$interval> is a recommended polling interval for systems where |
… | |
… | |
645 | =over 4 |
784 | =over 4 |
646 | |
785 | |
647 | =item $w = EV::idle $callback |
786 | =item $w = EV::idle $callback |
648 | |
787 | |
649 | =item $w = EV::idle_ns $callback |
788 | =item $w = EV::idle_ns $callback |
|
|
789 | |
|
|
790 | =item $w = $loop->idle ($callback) |
|
|
791 | |
|
|
792 | =item $w = $loop->idle_ns ($callback) |
650 | |
793 | |
651 | Call the callback when there are no other pending watchers of the same or |
794 | 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 |
795 | higher priority (excluding check, prepare and other idle watchers of the |
653 | same or lower priority, of course). They are called idle watchers because |
796 | 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 |
797 | when the watcher is the highest priority pending event in the process, the |
… | |
… | |
677 | |
820 | |
678 | =item $w = EV::prepare $callback |
821 | =item $w = EV::prepare $callback |
679 | |
822 | |
680 | =item $w = EV::prepare_ns $callback |
823 | =item $w = EV::prepare_ns $callback |
681 | |
824 | |
|
|
825 | =item $w = $loop->prepare ($callback) |
|
|
826 | |
|
|
827 | =item $w = $loop->prepare_ns ($callback) |
|
|
828 | |
682 | Call the callback just before the process would block. You can still |
829 | Call the callback just before the process would block. You can still |
683 | create/modify any watchers at this point. |
830 | create/modify any watchers at this point. |
684 | |
831 | |
685 | See the EV::check watcher, below, for explanations and an example. |
832 | See the EV::check watcher, below, for explanations and an example. |
686 | |
833 | |
… | |
… | |
694 | =over 4 |
841 | =over 4 |
695 | |
842 | |
696 | =item $w = EV::check $callback |
843 | =item $w = EV::check $callback |
697 | |
844 | |
698 | =item $w = EV::check_ns $callback |
845 | =item $w = EV::check_ns $callback |
|
|
846 | |
|
|
847 | =item $w = $loop->check ($callback) |
|
|
848 | |
|
|
849 | =item $w = $loop->check_ns ($callback) |
699 | |
850 | |
700 | Call the callback just after the process wakes up again (after it has |
851 | Call the callback just after the process wakes up again (after it has |
701 | gathered events), but before any other callbacks have been invoked. |
852 | gathered events), but before any other callbacks have been invoked. |
702 | |
853 | |
703 | This is used to integrate other event-based software into the EV |
854 | This is used to integrate other event-based software into the EV |
… | |
… | |
758 | |
909 | |
759 | =item $w = EV::fork $callback |
910 | =item $w = EV::fork $callback |
760 | |
911 | |
761 | =item $w = EV::fork_ns $callback |
912 | =item $w = EV::fork_ns $callback |
762 | |
913 | |
|
|
914 | =item $w = $loop->fork ($callback) |
|
|
915 | |
|
|
916 | =item $w = $loop->fork_ns ($callback) |
|
|
917 | |
763 | Call the callback before the event loop is resumed in the child process |
918 | Call the callback before the event loop is resumed in the child process |
764 | after a fork. |
919 | after a fork. |
765 | |
920 | |
766 | The C<fork_ns> variant doesn't start (activate) the newly created watcher. |
921 | The C<fork_ns> variant doesn't start (activate) the newly created watcher. |
|
|
922 | |
|
|
923 | =back |
|
|
924 | |
|
|
925 | |
|
|
926 | =head3 EMBED WATCHERS - when one backend isn't enough... |
|
|
927 | |
|
|
928 | This is a rather advanced watcher type that lets you embed one event loop |
|
|
929 | into another (currently only IO events are supported in the embedded |
|
|
930 | loop, other types of watchers might be handled in a delayed or incorrect |
|
|
931 | fashion and must not be used). |
|
|
932 | |
|
|
933 | See the libev documentation at |
|
|
934 | L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#code_ev_embed_code_when_one_backend_> |
|
|
935 | for more details. |
|
|
936 | |
|
|
937 | In short, this watcher is most useful on BSD systems without working |
|
|
938 | kqueue to still be able to handle a large number of sockets: |
|
|
939 | |
|
|
940 | my $socket_loop; |
|
|
941 | |
|
|
942 | # check wether we use SELECT or POLL _and_ KQUEUE is supported |
|
|
943 | if ( |
|
|
944 | (EV::backend & (EV::BACKEND_POLL | EV::BACKEND_SELECT)) |
|
|
945 | && (EV::supported_backends & EV::embeddable_backends & EV::BACKEND_KQUEUE) |
|
|
946 | ) { |
|
|
947 | # use kqueue for sockets |
|
|
948 | $socket_loop = new EV::Loop EV::BACKEND_KQUEUE | EV::FLAG_NOENV; |
|
|
949 | } |
|
|
950 | |
|
|
951 | # use the default loop otherwise |
|
|
952 | $socket_loop ||= EV::default_loop; |
|
|
953 | |
|
|
954 | =over 4 |
|
|
955 | |
|
|
956 | =item $w = EV::embed $otherloop, $callback |
|
|
957 | |
|
|
958 | =item $w = EV::embed_ns $otherloop, $callback |
|
|
959 | |
|
|
960 | =item $w = $loop->embed ($otherloop, $callback) |
|
|
961 | |
|
|
962 | =item $w = $loop->embed_ns ($otherloop, $callback) |
|
|
963 | |
|
|
964 | Call the callback when the embedded event loop (C<$otherloop>) has any |
|
|
965 | I/O activity. The C<$callback> should alwas be specified as C<undef> in |
|
|
966 | this version of EV, which means the embedded event loop will be managed |
|
|
967 | automatically. |
|
|
968 | |
|
|
969 | The C<embed_ns> variant doesn't start (activate) the newly created watcher. |
767 | |
970 | |
768 | =back |
971 | =back |
769 | |
972 | |
770 | |
973 | |
771 | =head1 PERL SIGNALS |
974 | =head1 PERL SIGNALS |
… | |
… | |
782 | to be called on every event loop iteration by installing a C<EV::check> |
985 | to be called on every event loop iteration by installing a C<EV::check> |
783 | watcher: |
986 | watcher: |
784 | |
987 | |
785 | my $async_check = EV::check sub { }; |
988 | my $async_check = EV::check sub { }; |
786 | |
989 | |
787 | This ensures that perl shortly gets into control for a short time, and |
990 | This ensures that perl gets into control for a short time to handle any |
788 | also ensures slower overall operation. |
991 | pending signals, and also ensures (slightly) slower overall operation. |
789 | |
992 | |
790 | =head1 THREADS |
993 | =head1 THREADS |
791 | |
994 | |
792 | Threads are not supported by this module in any way. Perl pseudo-threads |
995 | 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 |
996 | is evil stuff and must die. As soon as Perl gains real threads I will work |
… | |
… | |
815 | our $DIED = sub { |
1018 | our $DIED = sub { |
816 | warn "EV: error in callback (ignoring): $@"; |
1019 | warn "EV: error in callback (ignoring): $@"; |
817 | }; |
1020 | }; |
818 | |
1021 | |
819 | default_loop |
1022 | default_loop |
820 | or die 'EV: cannot initialise libev backend. bad $ENV{LIBEV_METHODS}?'; |
1023 | or die 'EV: cannot initialise libev backend. bad $ENV{LIBEV_FLAGS}?'; |
821 | |
1024 | |
822 | 1; |
1025 | 1; |
823 | |
1026 | |
824 | =head1 SEE ALSO |
1027 | =head1 SEE ALSO |
825 | |
1028 | |
826 | L<EV::ADNS> (asynchronous dns), L<Glib::EV> (makes Glib/Gtk2 use EV as |
1029 | L<EV::ADNS> (asynchronous DNS), L<Glib::EV> (makes Glib/Gtk2 use EV as |
827 | event loop), L<Coro::EV> (efficient coroutines with EV). |
1030 | event loop), L<EV::Glib> (embed Glib into EV), L<Coro::EV> (efficient |
|
|
1031 | coroutines with EV), L<Net::SNMP::EV> (asynchronous SNMP). |
828 | |
1032 | |
829 | =head1 AUTHOR |
1033 | =head1 AUTHOR |
830 | |
1034 | |
831 | Marc Lehmann <schmorp@schmorp.de> |
1035 | Marc Lehmann <schmorp@schmorp.de> |
832 | http://home.schmorp.de/ |
1036 | http://home.schmorp.de/ |