… | |
… | |
68 | package EV; |
68 | package EV; |
69 | |
69 | |
70 | use strict; |
70 | use strict; |
71 | |
71 | |
72 | BEGIN { |
72 | BEGIN { |
73 | our $VERSION = '1.72'; |
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 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 | |
103 | =item $time = EV::time |
160 | =item $time = EV::time |
104 | |
161 | |
105 | Returns the current time in (fractional) seconds since the epoch. |
162 | Returns the current time in (fractional) seconds since the epoch. |
106 | |
163 | |
107 | =item $time = EV::now |
164 | =item $time = EV::now |
|
|
165 | |
|
|
166 | =item $time = $loop->now |
108 | |
167 | |
109 | Returns the time the last event loop iteration has been started. This |
168 | 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 |
169 | is the time that (relative) timers are based on, and refering to it is |
111 | usually faster then calling EV::time. |
170 | usually faster then calling EV::time. |
112 | |
171 | |
113 | =item $method = EV::method |
172 | =item $backend = EV::backend |
|
|
173 | |
|
|
174 | =item $backend = $loop->backend |
114 | |
175 | |
115 | Returns an integer describing the backend used by libev (EV::METHOD_SELECT |
176 | Returns an integer describing the backend used by libev (EV::METHOD_SELECT |
116 | or EV::METHOD_EPOLL). |
177 | or EV::METHOD_EPOLL). |
117 | |
178 | |
118 | =item EV::loop [$flags] |
179 | =item EV::loop [$flags] |
|
|
180 | |
|
|
181 | =item $loop->loop ([$flags]) |
119 | |
182 | |
120 | Begin checking for events and calling callbacks. It returns when a |
183 | Begin checking for events and calling callbacks. It returns when a |
121 | callback calls EV::unloop. |
184 | callback calls EV::unloop. |
122 | |
185 | |
123 | The $flags argument can be one of the following: |
186 | The $flags argument can be one of the following: |
… | |
… | |
126 | EV::LOOP_ONESHOT block at most once (wait, but do not loop) |
189 | 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) |
190 | EV::LOOP_NONBLOCK do not block at all (fetch/handle events but do not wait) |
128 | |
191 | |
129 | =item EV::unloop [$how] |
192 | =item EV::unloop [$how] |
130 | |
193 | |
|
|
194 | =item $loop->unloop ([$how]) |
|
|
195 | |
131 | When called with no arguments or an argument of EV::UNLOOP_ONE, makes the |
196 | When called with no arguments or an argument of EV::UNLOOP_ONE, makes the |
132 | innermost call to EV::loop return. |
197 | innermost call to EV::loop return. |
133 | |
198 | |
134 | When called with an argument of EV::UNLOOP_ALL, all calls to EV::loop will return as |
199 | When called with an argument of EV::UNLOOP_ALL, all calls to EV::loop will return as |
135 | fast as possible. |
200 | fast as possible. |
136 | |
201 | |
137 | =item $count = EV::loop_count |
202 | =item $count = EV::loop_count |
138 | |
203 | |
|
|
204 | =item $count = $loop->loop_count |
|
|
205 | |
139 | Return the number of times the event loop has polled for new |
206 | Return the number of times the event loop has polled for new |
140 | events. Sometiems useful as a generation counter. |
207 | events. Sometiems useful as a generation counter. |
141 | |
208 | |
142 | =item EV::once $fh_or_undef, $events, $timeout, $cb->($revents) |
209 | =item EV::once $fh_or_undef, $events, $timeout, $cb->($revents) |
|
|
210 | |
|
|
211 | =item $loop->once ($fh_or_undef, $events, $timeout, $cb->($revents)) |
143 | |
212 | |
144 | This function rolls together an I/O and a timer watcher for a single |
213 | 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. |
214 | one-shot event without the need for managing a watcher object. |
146 | |
215 | |
147 | If C<$fh_or_undef> is a filehandle or file descriptor, then C<$events> |
216 | 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 |
222 | If timeout is C<undef> or negative, then there will be no |
154 | timeout. Otherwise a EV::timer with this value will be started. |
223 | timeout. Otherwise a EV::timer with this value will be started. |
155 | |
224 | |
156 | When an error occurs or either the timeout or I/O watcher triggers, then |
225 | 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 |
226 | 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>, |
227 | you can expect it to be a combination of C<EV::ERROR>, C<EV::READ>, |
159 | C<EV::WRITE> and C<EV::TIMEOUT>). |
228 | C<EV::WRITE> and C<EV::TIMEOUT>). |
160 | |
229 | |
161 | EV::once doesn't return anything: the watchers stay active till either |
230 | 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 |
231 | of them triggers, then they will be stopped and freed, and the callback |
163 | invoked. |
232 | invoked. |
164 | |
233 | |
165 | =item EV::feed_fd_event ($fd, $revents) |
234 | =item EV::feed_fd_event ($fd, $revents) |
166 | |
235 | |
|
|
236 | =item $loop->feed_fd_event ($fd, $revents) |
|
|
237 | |
167 | Feed an event on a file descriptor into EV. EV will react to this call as |
238 | 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 |
239 | 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>. |
240 | C<EV::READ> and C<EV::WRITE>) happened on the file descriptor C<$fd>. |
170 | |
241 | |
171 | =item EV::feed_signal_event ($signal) |
242 | =item EV::feed_signal_event ($signal) |
172 | |
243 | |
173 | Feed a signal event into EV. EV will react to this call as if the signal |
244 | Feed a signal event into EV. EV will react to this call as if the signal |
174 | specified by C<$signal> had occured. |
245 | specified by C<$signal> had occured. |
175 | |
246 | |
176 | =back |
247 | =item EV::set_io_collect_interval $time |
177 | |
248 | |
|
|
249 | =item $loop->set_io_collect_interval ($time) |
178 | |
250 | |
|
|
251 | =item EV::set_timeout_collect_interval $time |
|
|
252 | |
|
|
253 | =item $loop->set_timeout_collect_interval ($time) |
|
|
254 | |
|
|
255 | These advanced functions set the minimum block interval when polling for I/O events and the minimum |
|
|
256 | wait interval for timer events. See the libev documentation at |
|
|
257 | L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#FUNCTIONS_CONTROLLING_THE_EVENT_LOOP> for |
|
|
258 | a more detailed discussion. |
|
|
259 | |
|
|
260 | =back |
|
|
261 | |
|
|
262 | |
179 | =head2 WATCHER OBJECTS |
263 | =head1 WATCHER OBJECTS |
180 | |
264 | |
181 | A watcher is an object that gets created to record your interest in some |
265 | A watcher is an object that gets created to record your interest in some |
182 | event. For instance, if you want to wait for STDIN to become readable, you |
266 | event. For instance, if you want to wait for STDIN to become readable, you |
183 | would create an EV::io watcher for that: |
267 | would create an EV::io watcher for that: |
184 | |
268 | |
185 | my $watcher = EV::io *STDIN, EV::READ, sub { |
269 | my $watcher = EV::io *STDIN, EV::READ, sub { |
186 | my ($watcher, $revents) = @_; |
270 | my ($watcher, $revents) = @_; |
187 | warn "yeah, STDIN should not be readable without blocking!\n" |
271 | warn "yeah, STDIN should now be readable without blocking!\n" |
188 | }; |
272 | }; |
189 | |
273 | |
190 | All watchers can be active (waiting for events) or inactive (paused). Only |
274 | All watchers can be active (waiting for events) or inactive (paused). Only |
191 | active watchers will have their callbacks invoked. All callbacks will be |
275 | active watchers will have their callbacks invoked. All callbacks will be |
192 | called with at least two arguments: the watcher and a bitmask of received |
276 | called with at least two arguments: the watcher and a bitmask of received |
… | |
… | |
276 | Feed some events on this watcher into EV. EV will react to this call as if |
360 | 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. |
361 | the watcher had received the given C<$revents> mask. |
278 | |
362 | |
279 | =item $revents = $w->clear_pending |
363 | =item $revents = $w->clear_pending |
280 | |
364 | |
281 | If the watcher is pending, this function returns clears its pending status |
365 | If the watcher is pending, this function clears its pending status and |
282 | and returns its C<$revents> bitset (as if its callback was invoked). If the |
366 | 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>. |
367 | watcher isn't pending it does nothing and returns C<0>. |
284 | |
368 | |
285 | =item $previous_state = $w->keepalive ($bool) |
369 | =item $previous_state = $w->keepalive ($bool) |
286 | |
370 | |
287 | Normally, C<EV::loop> will return when there are no active watchers |
371 | Normally, C<EV::loop> will return when there are no active watchers |
288 | (which is a "deadlock" because no progress can be made anymore). This is |
372 | (which is a "deadlock" because no progress can be made anymore). This is |
289 | convinient because it allows you to start your watchers (and your jobs), |
373 | convinient because it allows you to start your watchers (and your jobs), |
290 | call C<EV::loop> once and when it returns you know that all your jobs are |
374 | call C<EV::loop> once and when it returns you know that all your jobs are |
291 | finished (or they forgot to register some watchers for their task :). |
375 | finished (or they forgot to register some watchers for their task :). |
292 | |
376 | |
293 | Sometimes, however, this gets in your way, for example when you the module |
377 | Sometimes, however, this gets in your way, for example when the module |
294 | that calls C<EV::loop> (usually the main program) is not the same module |
378 | that calls C<EV::loop> (usually the main program) is not the same module |
295 | as a long-living watcher (for example a DNS client module written by |
379 | as a long-living watcher (for example a DNS client module written by |
296 | somebody else even). Then you might want any outstanding requests to be |
380 | somebody else even). Then you might want any outstanding requests to be |
297 | handled, but you would not want to keep C<EV::loop> from returning just |
381 | handled, but you would not want to keep C<EV::loop> from returning just |
298 | because you happen to have this long-running UDP port watcher. |
382 | because you happen to have this long-running UDP port watcher. |
… | |
… | |
306 | Example: Register an I/O watcher for some UDP socket but do not keep the |
390 | Example: Register an I/O watcher for some UDP socket but do not keep the |
307 | event loop from running just because of that watcher. |
391 | event loop from running just because of that watcher. |
308 | |
392 | |
309 | my $udp_socket = ... |
393 | my $udp_socket = ... |
310 | my $udp_watcher = EV::io $udp_socket, EV::READ, sub { ... }; |
394 | my $udp_watcher = EV::io $udp_socket, EV::READ, sub { ... }; |
311 | $udp_watcher->keepalive (0); |
395 | $1000udp_watcher->keepalive (0); |
312 | |
396 | |
313 | =back |
397 | =item $loop = $w->loop |
314 | |
398 | |
|
|
399 | Return the loop that this watcher is attached to. |
315 | |
400 | |
|
|
401 | =back |
|
|
402 | |
|
|
403 | |
316 | =head2 WATCHER TYPES |
404 | =head1 WATCHER TYPES |
317 | |
405 | |
318 | Each of the following subsections describes a single watcher type. |
406 | Each of the following subsections describes a single watcher type. |
319 | |
407 | |
320 | =head3 I/O WATCHERS - is this file descriptor readable or writable? |
408 | =head3 I/O WATCHERS - is this file descriptor readable or writable? |
321 | |
409 | |
322 | =over 4 |
410 | =over 4 |
323 | |
411 | |
324 | =item $w = EV::io $fileno_or_fh, $eventmask, $callback |
412 | =item $w = EV::io $fileno_or_fh, $eventmask, $callback |
325 | |
413 | |
326 | =item $w = EV::io_ns $fileno_or_fh, $eventmask, $callback |
414 | =item $w = EV::io_ns $fileno_or_fh, $eventmask, $callback |
|
|
415 | |
|
|
416 | =item $w = $loop->io ($fileno_or_fh, $eventmask, $callback) |
|
|
417 | |
|
|
418 | =item $w = $loop->io_ns ($fileno_or_fh, $eventmask, $callback) |
327 | |
419 | |
328 | As long as the returned watcher object is alive, call the C<$callback> |
420 | As long as the returned watcher object is alive, call the C<$callback> |
329 | when at least one of events specified in C<$eventmask> occurs. |
421 | when at least one of events specified in C<$eventmask> occurs. |
330 | |
422 | |
331 | The $eventmask can be one or more of these constants ORed together: |
423 | The $eventmask can be one or more of these constants ORed together: |
… | |
… | |
360 | =over 4 |
452 | =over 4 |
361 | |
453 | |
362 | =item $w = EV::timer $after, $repeat, $callback |
454 | =item $w = EV::timer $after, $repeat, $callback |
363 | |
455 | |
364 | =item $w = EV::timer_ns $after, $repeat, $callback |
456 | =item $w = EV::timer_ns $after, $repeat, $callback |
|
|
457 | |
|
|
458 | =item $w = $loop->timer ($after, $repeat, $callback) |
|
|
459 | |
|
|
460 | =item $w = $loop->timer_ns ($after, $repeat, $callback) |
365 | |
461 | |
366 | Calls the callback after C<$after> seconds (which may be fractional). If |
462 | Calls the callback after C<$after> seconds (which may be fractional). If |
367 | C<$repeat> is non-zero, the timer will be restarted (with the $repeat |
463 | C<$repeat> is non-zero, the timer will be restarted (with the $repeat |
368 | value as $after) after the callback returns. |
464 | value as $after) after the callback returns. |
369 | |
465 | |
… | |
… | |
410 | =over 4 |
506 | =over 4 |
411 | |
507 | |
412 | =item $w = EV::periodic $at, $interval, $reschedule_cb, $callback |
508 | =item $w = EV::periodic $at, $interval, $reschedule_cb, $callback |
413 | |
509 | |
414 | =item $w = EV::periodic_ns $at, $interval, $reschedule_cb, $callback |
510 | =item $w = EV::periodic_ns $at, $interval, $reschedule_cb, $callback |
|
|
511 | |
|
|
512 | =item $w = $loop->periodic ($at, $interval, $reschedule_cb, $callback) |
|
|
513 | |
|
|
514 | =item $w = $loop->periodic_ns ($at, $interval, $reschedule_cb, $callback) |
415 | |
515 | |
416 | Similar to EV::timer, but is not based on relative timeouts but on |
516 | Similar to EV::timer, but is not based on relative timeouts but on |
417 | absolute times. Apart from creating "simple" timers that trigger "at" the |
517 | absolute times. Apart from creating "simple" timers that trigger "at" the |
418 | specified time, it can also be used for non-drifting absolute timers and |
518 | specified time, it can also be used for non-drifting absolute timers and |
419 | more complex, cron-like, setups that are not adversely affected by time |
519 | more complex, cron-like, setups that are not adversely affected by time |
… | |
… | |
494 | |
594 | |
495 | =item $w->again |
595 | =item $w->again |
496 | |
596 | |
497 | Simply stops and starts the watcher again. |
597 | Simply stops and starts the watcher again. |
498 | |
598 | |
|
|
599 | =item $time = $w->at |
|
|
600 | |
|
|
601 | Return the time that the watcher is expected to trigger next. |
|
|
602 | |
499 | =back |
603 | =back |
500 | |
604 | |
501 | |
605 | |
502 | =head3 SIGNAL WATCHERS - signal me when a signal gets signalled! |
606 | =head3 SIGNAL WATCHERS - signal me when a signal gets signalled! |
503 | |
607 | |
… | |
… | |
540 | |
644 | |
541 | =item $w = EV::child $pid, $callback |
645 | =item $w = EV::child $pid, $callback |
542 | |
646 | |
543 | =item $w = EV::child_ns $pid, $callback |
647 | =item $w = EV::child_ns $pid, $callback |
544 | |
648 | |
|
|
649 | =item $w = $loop->child ($pid, $callback) |
|
|
650 | |
|
|
651 | =item $w = $loop->child_ns ($pid, $callback) |
|
|
652 | |
545 | Call the callback when a status change for pid C<$pid> (or any pid if |
653 | Call the callback when a status change for pid C<$pid> (or any pid if |
546 | C<$pid> is 0) has been received. More precisely: when the process receives |
654 | C<$pid> is 0) has been received. More precisely: when the process receives |
547 | a C<SIGCHLD>, EV will fetch the outstanding exit/wait status for all |
655 | a C<SIGCHLD>, EV will fetch the outstanding exit/wait status for all |
548 | changed/zombie children and call the callback. |
656 | changed/zombie children and call the callback. |
549 | |
657 | |
… | |
… | |
590 | |
698 | |
591 | =item $w = EV::stat $path, $interval, $callback |
699 | =item $w = EV::stat $path, $interval, $callback |
592 | |
700 | |
593 | =item $w = EV::stat_ns $path, $interval, $callback |
701 | =item $w = EV::stat_ns $path, $interval, $callback |
594 | |
702 | |
|
|
703 | =item $w = $loop->stat ($path, $interval, $callback) |
|
|
704 | |
|
|
705 | =item $w = $loop->stat_ns ($path, $interval, $callback) |
|
|
706 | |
595 | Call the callback when a file status change has been detected on |
707 | Call the callback when a file status change has been detected on |
596 | C<$path>. The C<$path> does not need to exist, changing from "path exists" |
708 | C<$path>. The C<$path> does not need to exist, changing from "path exists" |
597 | to "path does not exist" is a status change like any other. |
709 | to "path does not exist" is a status change like any other. |
598 | |
710 | |
599 | The C<$interval> is a recommended polling interval for systems where |
711 | The C<$interval> is a recommended polling interval for systems where |
… | |
… | |
668 | =over 4 |
780 | =over 4 |
669 | |
781 | |
670 | =item $w = EV::idle $callback |
782 | =item $w = EV::idle $callback |
671 | |
783 | |
672 | =item $w = EV::idle_ns $callback |
784 | =item $w = EV::idle_ns $callback |
|
|
785 | |
|
|
786 | =item $w = $loop->idle ($callback) |
|
|
787 | |
|
|
788 | =item $w = $loop->idle_ns ($callback) |
673 | |
789 | |
674 | Call the callback when there are no other pending watchers of the same or |
790 | Call the callback when there are no other pending watchers of the same or |
675 | higher priority (excluding check, prepare and other idle watchers of the |
791 | higher priority (excluding check, prepare and other idle watchers of the |
676 | same or lower priority, of course). They are called idle watchers because |
792 | same or lower priority, of course). They are called idle watchers because |
677 | when the watcher is the highest priority pending event in the process, the |
793 | when the watcher is the highest priority pending event in the process, the |
… | |
… | |
700 | |
816 | |
701 | =item $w = EV::prepare $callback |
817 | =item $w = EV::prepare $callback |
702 | |
818 | |
703 | =item $w = EV::prepare_ns $callback |
819 | =item $w = EV::prepare_ns $callback |
704 | |
820 | |
|
|
821 | =item $w = $loop->prepare ($callback) |
|
|
822 | |
|
|
823 | =item $w = $loop->prepare_ns ($callback) |
|
|
824 | |
705 | Call the callback just before the process would block. You can still |
825 | Call the callback just before the process would block. You can still |
706 | create/modify any watchers at this point. |
826 | create/modify any watchers at this point. |
707 | |
827 | |
708 | See the EV::check watcher, below, for explanations and an example. |
828 | See the EV::check watcher, below, for explanations and an example. |
709 | |
829 | |
… | |
… | |
717 | =over 4 |
837 | =over 4 |
718 | |
838 | |
719 | =item $w = EV::check $callback |
839 | =item $w = EV::check $callback |
720 | |
840 | |
721 | =item $w = EV::check_ns $callback |
841 | =item $w = EV::check_ns $callback |
|
|
842 | |
|
|
843 | =item $w = $loop->check ($callback) |
|
|
844 | |
|
|
845 | =item $w = $loop->check_ns ($callback) |
722 | |
846 | |
723 | Call the callback just after the process wakes up again (after it has |
847 | Call the callback just after the process wakes up again (after it has |
724 | gathered events), but before any other callbacks have been invoked. |
848 | gathered events), but before any other callbacks have been invoked. |
725 | |
849 | |
726 | This is used to integrate other event-based software into the EV |
850 | This is used to integrate other event-based software into the EV |
… | |
… | |
781 | |
905 | |
782 | =item $w = EV::fork $callback |
906 | =item $w = EV::fork $callback |
783 | |
907 | |
784 | =item $w = EV::fork_ns $callback |
908 | =item $w = EV::fork_ns $callback |
785 | |
909 | |
|
|
910 | =item $w = $loop->fork ($callback) |
|
|
911 | |
|
|
912 | =item $w = $loop->fork_ns ($callback) |
|
|
913 | |
786 | Call the callback before the event loop is resumed in the child process |
914 | Call the callback before the event loop is resumed in the child process |
787 | after a fork. |
915 | after a fork. |
788 | |
916 | |
789 | The C<fork_ns> variant doesn't start (activate) the newly created watcher. |
917 | The C<fork_ns> variant doesn't start (activate) the newly created watcher. |
|
|
918 | |
|
|
919 | =back |
|
|
920 | |
|
|
921 | |
|
|
922 | =head3 EMBED WATCHERS - when one backend isn't enough... |
|
|
923 | |
|
|
924 | This is a rather advanced watcher type that lets you embed one event loop |
|
|
925 | into another (currently only IO events are supported in the embedded |
|
|
926 | loop, other types of watchers might be handled in a delayed or incorrect |
|
|
927 | fashion and must not be used). |
|
|
928 | |
|
|
929 | See the libev documentation at |
|
|
930 | L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#code_ev_embed_code_when_one_backend_> |
|
|
931 | for more details. |
|
|
932 | |
|
|
933 | In short, this watcher is most useful on BSD systems without working |
|
|
934 | kqueue to still be able to handle a large number of sockets: |
|
|
935 | |
|
|
936 | my $socket_loop; |
|
|
937 | |
|
|
938 | # check wether we use SELECT or POLL _and_ KQUEUE is supported |
|
|
939 | if ( |
|
|
940 | (EV::backend & (EV::BACKEND_POLL | EV::BACKEND_SELECT)) |
|
|
941 | && (EV::supported_backends & EV::embeddable_backends & EV::BACKEND_KQUEUE) |
|
|
942 | ) { |
|
|
943 | # use kqueue for sockets |
|
|
944 | $socket_loop = new EV::Loop EV::BACKEND_KQUEUE | EV::FLAG_NOENV; |
|
|
945 | } |
|
|
946 | |
|
|
947 | # use the default loop otherwise |
|
|
948 | $socket_loop ||= EV::default_loop; |
|
|
949 | |
|
|
950 | =over 4 |
|
|
951 | |
|
|
952 | =item $w = EV::embed $otherloop, $callback |
|
|
953 | |
|
|
954 | =item $w = EV::embed_ns $otherloop, $callback |
|
|
955 | |
|
|
956 | =item $w = $loop->embed ($otherloop, $callback) |
|
|
957 | |
|
|
958 | =item $w = $loop->embed_ns ($otherloop, $callback) |
|
|
959 | |
|
|
960 | Call the callback when the embedded event loop (C<$otherloop>) has any |
|
|
961 | I/O activity. The C<$callback> should alwas be specified as C<undef> in |
|
|
962 | this version of EV, which means the embedded event loop will be managed |
|
|
963 | automatically. |
|
|
964 | |
|
|
965 | The C<embed_ns> variant doesn't start (activate) the newly created watcher. |
790 | |
966 | |
791 | =back |
967 | =back |
792 | |
968 | |
793 | |
969 | |
794 | =head1 PERL SIGNALS |
970 | =head1 PERL SIGNALS |
… | |
… | |
805 | to be called on every event loop iteration by installing a C<EV::check> |
981 | to be called on every event loop iteration by installing a C<EV::check> |
806 | watcher: |
982 | watcher: |
807 | |
983 | |
808 | my $async_check = EV::check sub { }; |
984 | my $async_check = EV::check sub { }; |
809 | |
985 | |
810 | This ensures that perl shortly gets into control for a short time, and |
986 | This ensures that perl gets into control for a short time to handle any |
811 | also ensures slower overall operation. |
987 | pending signals, and also ensures (slightly) slower overall operation. |
812 | |
988 | |
813 | =head1 THREADS |
989 | =head1 THREADS |
814 | |
990 | |
815 | Threads are not supported by this module in any way. Perl pseudo-threads |
991 | Threads are not supported by this module in any way. Perl pseudo-threads |
816 | is evil stuff and must die. As soon as Perl gains real threads I will work |
992 | is evil stuff and must die. As soon as Perl gains real threads I will work |
… | |
… | |
838 | our $DIED = sub { |
1014 | our $DIED = sub { |
839 | warn "EV: error in callback (ignoring): $@"; |
1015 | warn "EV: error in callback (ignoring): $@"; |
840 | }; |
1016 | }; |
841 | |
1017 | |
842 | default_loop |
1018 | default_loop |
843 | or die 'EV: cannot initialise libev backend. bad $ENV{LIBEV_METHODS}?'; |
1019 | or die 'EV: cannot initialise libev backend. bad $ENV{LIBEV_FLAGS}?'; |
844 | |
1020 | |
845 | 1; |
1021 | 1; |
846 | |
1022 | |
847 | =head1 SEE ALSO |
1023 | =head1 SEE ALSO |
848 | |
1024 | |
849 | L<EV::ADNS> (asynchronous dns), L<Glib::EV> (makes Glib/Gtk2 use EV as |
1025 | L<EV::ADNS> (asynchronous DNS), L<Glib::EV> (makes Glib/Gtk2 use EV as |
850 | event loop), L<Coro::EV> (efficient coroutines with EV). |
1026 | event loop), L<EV::Glib> (embed Glib into EV), L<Coro::EV> (efficient |
|
|
1027 | coroutines with EV), L<Net::SNMP::EV> (asynchronous SNMP). |
851 | |
1028 | |
852 | =head1 AUTHOR |
1029 | =head1 AUTHOR |
853 | |
1030 | |
854 | Marc Lehmann <schmorp@schmorp.de> |
1031 | Marc Lehmann <schmorp@schmorp.de> |
855 | http://home.schmorp.de/ |
1032 | http://home.schmorp.de/ |