… | |
… | |
47 | my ($w, $revents) = @_; |
47 | my ($w, $revents) = @_; |
48 | warn $w->path, " has changed somehow.\n"; |
48 | warn $w->path, " has changed somehow.\n"; |
49 | }; |
49 | }; |
50 | |
50 | |
51 | # MAINLOOP |
51 | # MAINLOOP |
52 | EV::loop; # loop until EV::unloop is called or all watchers stop |
52 | EV::run; # loop until EV::break is called or all watchers stop |
53 | EV::loop EV::LOOP_ONESHOT; # block until at least one event could be handled |
53 | EV::run EV::RUN_ONCE; # block until at least one event could be handled |
54 | EV::loop EV::LOOP_NONBLOCK; # try to handle same events, but do not block |
54 | EV::run EV::RUN_NOWAIT; # try to handle same events, but do not block |
|
|
55 | |
|
|
56 | =head1 BEFORE YOU START USING THIS MODULE |
|
|
57 | |
|
|
58 | If you only need timer, I/O, signal, child and idle watchers and not the |
|
|
59 | advanced functionality of this module, consider using L<AnyEvent> instead, |
|
|
60 | specifically the simplified API described in L<AE>. |
|
|
61 | |
|
|
62 | When used with EV as backend, the L<AE> API is as fast as the native L<EV> |
|
|
63 | API, but your programs/modules will still run with many other event loops. |
55 | |
64 | |
56 | =head1 DESCRIPTION |
65 | =head1 DESCRIPTION |
57 | |
66 | |
58 | This module provides an interface to libev |
67 | This module provides an interface to libev |
59 | (L<http://software.schmorp.de/pkg/libev.html>). While the documentation |
68 | (L<http://software.schmorp.de/pkg/libev.html>). While the documentation |
60 | below is comprehensive, one might also consult the documentation of libev |
69 | below is comprehensive, one might also consult the documentation of |
61 | itself (L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod>) for more |
70 | libev itself (L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod> or |
62 | subtle details on watcher semantics or some discussion on the available |
71 | F<perldoc EV::libev>) for more subtle details on watcher semantics or some |
63 | backends, or how to force a specific backend with C<LIBEV_FLAGS>, or just |
72 | discussion on the available backends, or how to force a specific backend |
64 | about in any case because it has much more detailed information. |
73 | with C<LIBEV_FLAGS>, or just about in any case because it has much more |
|
|
74 | detailed information. |
65 | |
75 | |
66 | This module is very fast and scalable. It is actually so fast that you |
76 | This module is very fast and scalable. It is actually so fast that you |
67 | can use it through the L<AnyEvent> module, stay portable to other event |
77 | can use it through the L<AnyEvent> module, stay portable to other event |
68 | loops (if you don't rely on any watcher types not available through it) |
78 | loops (if you don't rely on any watcher types not available through it) |
69 | and still be faster than with any other event loop currently supported in |
79 | and still be faster than with any other event loop currently supported in |
70 | Perl. |
80 | Perl. |
71 | |
81 | |
|
|
82 | =head2 PORTING FROM EV 3.X to 4.X |
|
|
83 | |
|
|
84 | EV version 4 introduces a number of incompatible changes summarised |
|
|
85 | here. According to the depreciation strategy used by libev, there is a |
|
|
86 | compatibility layer in place so programs should continue to run unchanged |
|
|
87 | (the XS interface lacks this layer, so programs using that one need to be |
|
|
88 | updated). |
|
|
89 | |
|
|
90 | This compatibility layer will be switched off in some future release. |
|
|
91 | |
|
|
92 | All changes relevant to Perl are renames of symbols, functions and |
|
|
93 | methods: |
|
|
94 | |
|
|
95 | EV::loop => EV::run |
|
|
96 | EV::LOOP_NONBLOCK => EV::RUN_NOWAIT |
|
|
97 | EV::LOOP_ONESHOT => EV::RUN_ONCE |
|
|
98 | |
|
|
99 | EV::unloop => EV::break |
|
|
100 | EV::UNLOOP_CANCEL => EV::BREAK_CANCEL |
|
|
101 | EV::UNLOOP_ONE => EV::BREAK_ONE |
|
|
102 | EV::UNLOOP_ALL => EV::BREAK_ALL |
|
|
103 | |
|
|
104 | EV::TIMEOUT => EV::TIMER |
|
|
105 | |
|
|
106 | EV::loop_count => EV::iteration |
|
|
107 | EV::loop_depth => EV::depth |
|
|
108 | EV::loop_verify => EV::verify |
|
|
109 | |
|
|
110 | The loop object methods corresponding to the functions above have been |
|
|
111 | similarly renamed. |
|
|
112 | |
|
|
113 | =head2 MODULE EXPORTS |
|
|
114 | |
|
|
115 | This module does not export any symbols. |
|
|
116 | |
72 | =cut |
117 | =cut |
73 | |
118 | |
74 | package EV; |
119 | package EV; |
75 | |
120 | |
76 | use strict; |
121 | use common::sense; |
77 | |
122 | |
78 | BEGIN { |
123 | BEGIN { |
79 | our $VERSION = '3.42'; |
124 | our $VERSION = 4.27; |
80 | use XSLoader; |
125 | use XSLoader; |
|
|
126 | local $^W = 0; # avoid spurious warning |
81 | XSLoader::load "EV", $VERSION; |
127 | XSLoader::load "EV", $VERSION; |
82 | } |
128 | } |
83 | |
129 | |
84 | @EV::IO::ISA = |
130 | @EV::IO::ISA = |
85 | @EV::Timer::ISA = |
131 | @EV::Timer::ISA = |
… | |
… | |
111 | default loop as this is fastest (perl-wise), best supported by other |
157 | default loop as this is fastest (perl-wise), best supported by other |
112 | modules (e.g. AnyEvent or Coro) and most portable event loop. |
158 | modules (e.g. AnyEvent or Coro) and most portable event loop. |
113 | |
159 | |
114 | For specific programs you can create additional event loops dynamically. |
160 | For specific programs you can create additional event loops dynamically. |
115 | |
161 | |
116 | If you want to take avdantage of kqueue (which often works properly for |
162 | If you want to take advantage of kqueue (which often works properly for |
117 | sockets only) even though the default loop doesn't enable it, you can |
163 | sockets only) even though the default loop doesn't enable it, you can |
118 | I<embed> a kqueue loop into the default loop: running the default loop |
164 | I<embed> a kqueue loop into the default loop: running the default loop |
119 | will then also service the kqueue loop to some extent. See the example in |
165 | will then also service the kqueue loop to some extent. See the example in |
120 | the section about embed watchers for an example on how to achieve that. |
166 | the section about embed watchers for an example on how to achieve that. |
121 | |
167 | |
122 | =over 4 |
168 | =over 4 |
123 | |
169 | |
124 | =item $loop = new EV::loop [$flags] |
170 | =item $loop = new EV::Loop [$flags] |
125 | |
171 | |
126 | Create a new event loop as per the specified flags. Please refer to the |
172 | Create a new event loop as per the specified flags. Please refer to |
127 | C<ev_loop_new ()> function description in the libev documentation |
173 | the C<ev_loop_new ()> function description in the libev documentation |
128 | (L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#GLOBAL_FUNCTIONS>) |
174 | (L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#GLOBAL_FUNCTIONS>, |
129 | for more info. |
175 | or locally-installed as F<EV::libev> manpage) for more info. |
130 | |
176 | |
131 | The loop will automatically be destroyed when it is no longer referenced |
177 | The loop will automatically be destroyed when it is no longer referenced |
132 | by any watcher and the loop object goes out of scope. |
178 | by any watcher and the loop object goes out of scope. |
133 | |
179 | |
134 | Using C<EV::FLAG_FORKCHECK> is recommended, as only the default event loop |
180 | If you are not embedding the loop, then Using C<EV::FLAG_FORKCHECK> |
135 | is protected by this module. |
181 | is recommended, as only the default event loop is protected by this |
|
|
182 | module. If you I<are> embedding this loop in the default loop, this is not |
|
|
183 | necessary, as C<EV::embed> automatically does the right thing on fork. |
136 | |
184 | |
137 | =item $loop->loop_fork |
185 | =item $loop->loop_fork |
138 | |
186 | |
139 | Must be called after a fork in the child, before entering or continuing |
187 | Must be called after a fork in the child, before entering or continuing |
140 | the event loop. An alternative is to use C<EV::FLAG_FORKCHECK> which calls |
188 | the event loop. An alternative is to use C<EV::FLAG_FORKCHECK> which calls |
141 | this function automatically, at some performance loss (refer to the libev |
189 | this function automatically, at some performance loss (refer to the libev |
142 | documentation). |
190 | documentation). |
143 | |
191 | |
144 | =item $loop->loop_verify |
192 | =item $loop->verify |
145 | |
193 | |
146 | Calls C<ev_verify> to make internal consistency checks (for debugging |
194 | Calls C<ev_verify> to make internal consistency checks (for debugging |
147 | libev) and abort the program if any data structures were found to be |
195 | libev) and abort the program if any data structures were found to be |
148 | corrupted. |
196 | corrupted. |
149 | |
197 | |
… | |
… | |
191 | =item $time = EV::now |
239 | =item $time = EV::now |
192 | |
240 | |
193 | =item $time = $loop->now |
241 | =item $time = $loop->now |
194 | |
242 | |
195 | Returns the time the last event loop iteration has been started. This |
243 | Returns the time the last event loop iteration has been started. This |
196 | is the time that (relative) timers are based on, and refering to it is |
244 | is the time that (relative) timers are based on, and referring to it is |
197 | usually faster then calling EV::time. |
245 | usually faster then calling EV::time. |
198 | |
246 | |
|
|
247 | =item EV::now_update |
|
|
248 | |
|
|
249 | =item $loop->now_update |
|
|
250 | |
|
|
251 | Establishes the current time by querying the kernel, updating the time |
|
|
252 | returned by C<EV::now> in the progress. This is a costly operation and |
|
|
253 | is usually done automatically within C<EV::run>. |
|
|
254 | |
|
|
255 | This function is rarely useful, but when some event callback runs for a |
|
|
256 | very long time without entering the event loop, updating libev's idea of |
|
|
257 | the current time is a good idea. |
|
|
258 | |
|
|
259 | =item EV::suspend |
|
|
260 | |
|
|
261 | =item $loop->suspend |
|
|
262 | |
|
|
263 | =item EV::resume |
|
|
264 | |
|
|
265 | =item $loop->resume |
|
|
266 | |
|
|
267 | These two functions suspend and resume a loop, for use when the loop is |
|
|
268 | not used for a while and timeouts should not be processed. |
|
|
269 | |
|
|
270 | A typical use case would be an interactive program such as a game: When |
|
|
271 | the user presses C<^Z> to suspend the game and resumes it an hour later it |
|
|
272 | would be best to handle timeouts as if no time had actually passed while |
|
|
273 | the program was suspended. This can be achieved by calling C<suspend> |
|
|
274 | in your C<SIGTSTP> handler, sending yourself a C<SIGSTOP> and calling |
|
|
275 | C<resume> directly afterwards to resume timer processing. |
|
|
276 | |
|
|
277 | Effectively, all C<timer> watchers will be delayed by the time spend |
|
|
278 | between C<suspend> and C<resume>, and all C<periodic> watchers |
|
|
279 | will be rescheduled (that is, they will lose any events that would have |
|
|
280 | occured while suspended). |
|
|
281 | |
|
|
282 | After calling C<suspend> you B<must not> call I<any> function on the given |
|
|
283 | loop other than C<resume>, and you B<must not> call C<resume> |
|
|
284 | without a previous call to C<suspend>. |
|
|
285 | |
|
|
286 | Calling C<suspend>/C<resume> has the side effect of updating the event |
|
|
287 | loop time (see C<now_update>). |
|
|
288 | |
199 | =item $backend = EV::backend |
289 | =item $backend = EV::backend |
200 | |
290 | |
201 | =item $backend = $loop->backend |
291 | =item $backend = $loop->backend |
202 | |
292 | |
203 | Returns an integer describing the backend used by libev (EV::METHOD_SELECT |
293 | Returns an integer describing the backend used by libev (EV::BACKEND_SELECT |
204 | or EV::METHOD_EPOLL). |
294 | or EV::BACKEND_EPOLL). |
205 | |
295 | |
206 | =item EV::loop [$flags] |
296 | =item $active = EV::run [$flags] |
207 | |
297 | |
208 | =item $loop->loop ([$flags]) |
298 | =item $active = $loop->run ([$flags]) |
209 | |
299 | |
210 | Begin checking for events and calling callbacks. It returns when a |
300 | Begin checking for events and calling callbacks. It returns when a |
211 | callback calls EV::unloop. |
301 | callback calls EV::break or the flags are nonzero (in which case the |
|
|
302 | return value is true) or when there are no active watchers which reference |
|
|
303 | the loop (keepalive is true), in which case the return value will be |
|
|
304 | false. The return value can generally be interpreted as "if true, there is |
|
|
305 | more work left to do". |
212 | |
306 | |
213 | The $flags argument can be one of the following: |
307 | The $flags argument can be one of the following: |
214 | |
308 | |
215 | 0 as above |
309 | 0 as above |
216 | EV::LOOP_ONESHOT block at most once (wait, but do not loop) |
310 | EV::RUN_ONCE block at most once (wait, but do not loop) |
217 | EV::LOOP_NONBLOCK do not block at all (fetch/handle events but do not wait) |
311 | EV::RUN_NOWAIT do not block at all (fetch/handle events but do not wait) |
218 | |
312 | |
219 | =item EV::unloop [$how] |
313 | =item EV::break [$how] |
220 | |
314 | |
221 | =item $loop->unloop ([$how]) |
315 | =item $loop->break ([$how]) |
222 | |
316 | |
223 | When called with no arguments or an argument of EV::UNLOOP_ONE, makes the |
317 | When called with no arguments or an argument of EV::BREAK_ONE, makes the |
224 | innermost call to EV::loop return. |
318 | innermost call to EV::run return. |
225 | |
319 | |
226 | When called with an argument of EV::UNLOOP_ALL, all calls to EV::loop will return as |
320 | When called with an argument of EV::BREAK_ALL, all calls to EV::run will |
227 | fast as possible. |
321 | return as fast as possible. |
228 | |
322 | |
229 | =item $count = EV::loop_count |
323 | When called with an argument of EV::BREAK_CANCEL, any pending break will |
|
|
324 | be cancelled. |
230 | |
325 | |
|
|
326 | =item $count = EV::iteration |
|
|
327 | |
231 | =item $count = $loop->loop_count |
328 | =item $count = $loop->iteration |
232 | |
329 | |
233 | Return the number of times the event loop has polled for new |
330 | Return the number of times the event loop has polled for new |
234 | events. Sometiems useful as a generation counter. |
331 | events. Sometimes useful as a generation counter. |
235 | |
332 | |
236 | =item EV::once $fh_or_undef, $events, $timeout, $cb->($revents) |
333 | =item EV::once $fh_or_undef, $events, $timeout, $cb->($revents) |
237 | |
334 | |
238 | =item $loop->once ($fh_or_undef, $events, $timeout, $cb->($revents)) |
335 | =item $loop->once ($fh_or_undef, $events, $timeout, $cb->($revents)) |
239 | |
336 | |
… | |
… | |
245 | | EV::WRITE>, indicating the type of I/O event you want to wait for. If |
342 | | EV::WRITE>, indicating the type of I/O event you want to wait for. If |
246 | you do not want to wait for some I/O event, specify C<undef> for |
343 | you do not want to wait for some I/O event, specify C<undef> for |
247 | C<$fh_or_undef> and C<0> for C<$events>). |
344 | C<$fh_or_undef> and C<0> for C<$events>). |
248 | |
345 | |
249 | If timeout is C<undef> or negative, then there will be no |
346 | If timeout is C<undef> or negative, then there will be no |
250 | timeout. Otherwise a EV::timer with this value will be started. |
347 | timeout. Otherwise an C<EV::timer> with this value will be started. |
251 | |
348 | |
252 | When an error occurs or either the timeout or I/O watcher triggers, then |
349 | When an error occurs or either the timeout or I/O watcher triggers, then |
253 | the callback will be called with the received event set (in general |
350 | the callback will be called with the received event set (in general |
254 | you can expect it to be a combination of C<EV::ERROR>, C<EV::READ>, |
351 | you can expect it to be a combination of C<EV::ERROR>, C<EV::READ>, |
255 | C<EV::WRITE> and C<EV::TIMEOUT>). |
352 | C<EV::WRITE> and C<EV::TIMER>). |
256 | |
353 | |
257 | EV::once doesn't return anything: the watchers stay active till either |
354 | EV::once doesn't return anything: the watchers stay active till either |
258 | of them triggers, then they will be stopped and freed, and the callback |
355 | of them triggers, then they will be stopped and freed, and the callback |
259 | invoked. |
356 | invoked. |
260 | |
357 | |
261 | =item EV::feed_fd_event ($fd, $revents) |
358 | =item EV::feed_fd_event $fd, $revents |
262 | |
359 | |
263 | =item $loop->feed_fd_event ($fd, $revents) |
360 | =item $loop->feed_fd_event ($fd, $revents) |
264 | |
361 | |
265 | Feed an event on a file descriptor into EV. EV will react to this call as |
362 | Feed an event on a file descriptor into EV. EV will react to this call as |
266 | if the readyness notifications specified by C<$revents> (a combination of |
363 | if the readyness notifications specified by C<$revents> (a combination of |
267 | C<EV::READ> and C<EV::WRITE>) happened on the file descriptor C<$fd>. |
364 | C<EV::READ> and C<EV::WRITE>) happened on the file descriptor C<$fd>. |
268 | |
365 | |
269 | =item EV::feed_signal_event ($signal) |
366 | =item EV::feed_signal_event $signal |
270 | |
367 | |
271 | Feed a signal event into EV. EV will react to this call as if the signal |
368 | Feed a signal event into the default loop. EV will react to this call as |
272 | specified by C<$signal> had occured. |
369 | if the signal specified by C<$signal> had occured. |
|
|
370 | |
|
|
371 | =item EV::feed_signal $signal |
|
|
372 | |
|
|
373 | Feed a signal event into EV - unlike C<EV::feed_signal_event>, this works |
|
|
374 | regardless of which loop has registered the signal, and is mainly useful |
|
|
375 | for custom signal implementations. |
273 | |
376 | |
274 | =item EV::set_io_collect_interval $time |
377 | =item EV::set_io_collect_interval $time |
275 | |
378 | |
276 | =item $loop->set_io_collect_interval ($time) |
379 | =item $loop->set_io_collect_interval ($time) |
277 | |
380 | |
… | |
… | |
279 | |
382 | |
280 | =item $loop->set_timeout_collect_interval ($time) |
383 | =item $loop->set_timeout_collect_interval ($time) |
281 | |
384 | |
282 | These advanced functions set the minimum block interval when polling for I/O events and the minimum |
385 | These advanced functions set the minimum block interval when polling for I/O events and the minimum |
283 | wait interval for timer events. See the libev documentation at |
386 | wait interval for timer events. See the libev documentation at |
284 | L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#FUNCTIONS_CONTROLLING_THE_EVENT_LOOP> for |
387 | L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#FUNCTIONS_CONTROLLING_THE_EVENT_LOOP> |
285 | a more detailed discussion. |
388 | (locally installed as F<EV::libev>) for a more detailed discussion. |
|
|
389 | |
|
|
390 | =item $count = EV::pending_count |
|
|
391 | |
|
|
392 | =item $count = $loop->pending_count |
|
|
393 | |
|
|
394 | Returns the number of currently pending watchers. |
|
|
395 | |
|
|
396 | =item EV::invoke_pending |
|
|
397 | |
|
|
398 | =item $loop->invoke_pending |
|
|
399 | |
|
|
400 | Invoke all currently pending watchers. |
286 | |
401 | |
287 | =back |
402 | =back |
288 | |
403 | |
289 | |
404 | |
290 | =head1 WATCHER OBJECTS |
405 | =head1 WATCHER OBJECTS |
… | |
… | |
303 | called with at least two arguments: the watcher and a bitmask of received |
418 | called with at least two arguments: the watcher and a bitmask of received |
304 | events. |
419 | events. |
305 | |
420 | |
306 | Each watcher type has its associated bit in revents, so you can use the |
421 | Each watcher type has its associated bit in revents, so you can use the |
307 | same callback for multiple watchers. The event mask is named after the |
422 | same callback for multiple watchers. The event mask is named after the |
308 | type, i..e. EV::child sets EV::CHILD, EV::prepare sets EV::PREPARE, |
423 | type, i.e. EV::child sets EV::CHILD, EV::prepare sets EV::PREPARE, |
309 | EV::periodic sets EV::PERIODIC and so on, with the exception of I/O events |
424 | EV::periodic sets EV::PERIODIC and so on, with the exception of I/O events |
310 | (which can set both EV::READ and EV::WRITE bits), and EV::timer (which |
425 | (which can set both EV::READ and EV::WRITE bits). |
311 | uses EV::TIMEOUT). |
|
|
312 | |
426 | |
313 | In the rare case where one wants to create a watcher but not start it at |
427 | In the rare case where one wants to create a watcher but not start it at |
314 | the same time, each constructor has a variant with a trailing C<_ns> in |
428 | the same time, each constructor has a variant with a trailing C<_ns> in |
315 | its name, e.g. EV::io has a non-starting variant EV::io_ns and so on. |
429 | its name, e.g. EV::io has a non-starting variant EV::io_ns and so on. |
316 | |
430 | |
… | |
… | |
393 | returns its C<$revents> bitset (as if its callback was invoked). If the |
507 | returns its C<$revents> bitset (as if its callback was invoked). If the |
394 | watcher isn't pending it does nothing and returns C<0>. |
508 | watcher isn't pending it does nothing and returns C<0>. |
395 | |
509 | |
396 | =item $previous_state = $w->keepalive ($bool) |
510 | =item $previous_state = $w->keepalive ($bool) |
397 | |
511 | |
398 | Normally, C<EV::loop> will return when there are no active watchers |
512 | Normally, C<EV::run> will return when there are no active watchers |
399 | (which is a "deadlock" because no progress can be made anymore). This is |
513 | (which is a "deadlock" because no progress can be made anymore). This is |
400 | convinient because it allows you to start your watchers (and your jobs), |
514 | convenient because it allows you to start your watchers (and your jobs), |
401 | call C<EV::loop> once and when it returns you know that all your jobs are |
515 | call C<EV::run> once and when it returns you know that all your jobs are |
402 | finished (or they forgot to register some watchers for their task :). |
516 | finished (or they forgot to register some watchers for their task :). |
403 | |
517 | |
404 | Sometimes, however, this gets in your way, for example when the module |
518 | Sometimes, however, this gets in your way, for example when the module |
405 | that calls C<EV::loop> (usually the main program) is not the same module |
519 | that calls C<EV::run> (usually the main program) is not the same module |
406 | as a long-living watcher (for example a DNS client module written by |
520 | as a long-living watcher (for example a DNS client module written by |
407 | somebody else even). Then you might want any outstanding requests to be |
521 | somebody else even). Then you might want any outstanding requests to be |
408 | handled, but you would not want to keep C<EV::loop> from returning just |
522 | handled, but you would not want to keep C<EV::run> from returning just |
409 | because you happen to have this long-running UDP port watcher. |
523 | because you happen to have this long-running UDP port watcher. |
410 | |
524 | |
411 | In this case you can clear the keepalive status, which means that even |
525 | In this case you can clear the keepalive status, which means that even |
412 | though your watcher is active, it won't keep C<EV::loop> from returning. |
526 | though your watcher is active, it won't keep C<EV::run> from returning. |
413 | |
527 | |
414 | The initial value for keepalive is true (enabled), and you cna change it |
528 | The initial value for keepalive is true (enabled), and you can change it |
415 | any time. |
529 | any time. |
416 | |
530 | |
417 | Example: Register an I/O watcher for some UDP socket but do not keep the |
531 | Example: Register an I/O watcher for some UDP socket but do not keep the |
418 | event loop from running just because of that watcher. |
532 | event loop from running just because of that watcher. |
419 | |
533 | |
… | |
… | |
484 | |
598 | |
485 | =item $w = $loop->timer ($after, $repeat, $callback) |
599 | =item $w = $loop->timer ($after, $repeat, $callback) |
486 | |
600 | |
487 | =item $w = $loop->timer_ns ($after, $repeat, $callback) |
601 | =item $w = $loop->timer_ns ($after, $repeat, $callback) |
488 | |
602 | |
489 | Calls the callback after C<$after> seconds (which may be fractional). If |
603 | Calls the callback after C<$after> seconds (which may be fractional or |
490 | C<$repeat> is non-zero, the timer will be restarted (with the $repeat |
604 | negative). If C<$repeat> is non-zero, the timer will be restarted (with |
491 | value as $after) after the callback returns. |
605 | the $repeat value as $after) after the callback returns. |
492 | |
606 | |
493 | This means that the callback would be called roughly after C<$after> |
607 | This means that the callback would be called roughly after C<$after> |
494 | seconds, and then every C<$repeat> seconds. The timer does his best not |
608 | seconds, and then every C<$repeat> seconds. The timer does his best not |
495 | to drift, but it will not invoke the timer more often then once per event |
609 | to drift, but it will not invoke the timer more often then once per event |
496 | loop iteration, and might drift in other cases. If that isn't acceptable, |
610 | loop iteration, and might drift in other cases. If that isn't acceptable, |
… | |
… | |
500 | in front of the machine while the timer is running and changes the system |
614 | in front of the machine while the timer is running and changes the system |
501 | clock, the timer will nevertheless run (roughly) the same time. |
615 | clock, the timer will nevertheless run (roughly) the same time. |
502 | |
616 | |
503 | The C<timer_ns> variant doesn't start (activate) the newly created watcher. |
617 | The C<timer_ns> variant doesn't start (activate) the newly created watcher. |
504 | |
618 | |
505 | =item $w->set ($after, $repeat) |
619 | =item $w->set ($after, $repeat = 0) |
506 | |
620 | |
507 | Reconfigures the watcher, see the constructor above for details. Can be called at |
621 | Reconfigures the watcher, see the constructor above for details. Can be called at |
508 | any time. |
622 | any time. |
509 | |
623 | |
510 | =item $w->again |
624 | =item $w->again |
|
|
625 | |
|
|
626 | =item $w->again ($repeat) |
511 | |
627 | |
512 | Similar to the C<start> method, but has special semantics for repeating timers: |
628 | Similar to the C<start> method, but has special semantics for repeating timers: |
513 | |
629 | |
514 | If the timer is active and non-repeating, it will be stopped. |
630 | If the timer is active and non-repeating, it will be stopped. |
515 | |
631 | |
… | |
… | |
522 | |
638 | |
523 | This behaviour is useful when you have a timeout for some IO |
639 | This behaviour is useful when you have a timeout for some IO |
524 | operation. You create a timer object with the same value for C<$after> and |
640 | operation. You create a timer object with the same value for C<$after> and |
525 | C<$repeat>, and then, in the read/write watcher, run the C<again> method |
641 | C<$repeat>, and then, in the read/write watcher, run the C<again> method |
526 | on the timeout. |
642 | on the timeout. |
|
|
643 | |
|
|
644 | If called with a C<$repeat> argument, then it uses this a timer repeat |
|
|
645 | value. |
|
|
646 | |
|
|
647 | =item $after = $w->remaining |
|
|
648 | |
|
|
649 | Calculates and returns the remaining time till the timer will fire. |
527 | |
650 | |
528 | =back |
651 | =back |
529 | |
652 | |
530 | |
653 | |
531 | =head3 PERIODIC WATCHERS - to cron or not to cron? |
654 | =head3 PERIODIC WATCHERS - to cron or not to cron? |
… | |
… | |
559 | surpasses this time. |
682 | surpasses this time. |
560 | |
683 | |
561 | =item * repeating interval timer ($interval > 0, $reschedule_cb = 0) |
684 | =item * repeating interval timer ($interval > 0, $reschedule_cb = 0) |
562 | |
685 | |
563 | In this mode the watcher will always be scheduled to time out at the |
686 | In this mode the watcher will always be scheduled to time out at the |
564 | next C<$at + N * $interval> time (for some integer N) and then repeat, |
687 | next C<$at + N * $interval> time (for the lowest integer N) and then repeat, |
565 | regardless of any time jumps. |
688 | regardless of any time jumps. Note that, since C<N> can be negative, the |
|
|
689 | first trigger can happen before C<$at>. |
566 | |
690 | |
567 | This can be used to create timers that do not drift with respect to system |
691 | This can be used to create timers that do not drift with respect to system |
568 | time: |
692 | time: |
569 | |
693 | |
570 | my $hourly = EV::periodic 0, 3600, 0, sub { print "once/hour\n" }; |
694 | my $hourly = EV::periodic 0, 3600, 0, sub { print "once/hour\n" }; |
571 | |
695 | |
572 | That doesn't mean there will always be 3600 seconds in between triggers, |
696 | That doesn't mean there will always be 3600 seconds in between triggers, |
573 | but only that the the clalback will be called when the system time shows a |
697 | but only that the the callback will be called when the system time shows a |
574 | full hour (UTC). |
698 | full hour (UTC). |
575 | |
699 | |
576 | Another way to think about it (for the mathematically inclined) is that |
700 | Another way to think about it (for the mathematically inclined) is that |
577 | EV::periodic will try to run the callback in this mode at the next |
701 | EV::periodic will try to run the callback in this mode at the next |
578 | possible time where C<$time = $at (mod $interval)>, regardless of any time |
702 | possible time where C<$time = $at (mod $interval)>, regardless of any time |
… | |
… | |
586 | time as second argument. |
710 | time as second argument. |
587 | |
711 | |
588 | I<This callback MUST NOT stop or destroy this or any other periodic |
712 | I<This callback MUST NOT stop or destroy this or any other periodic |
589 | watcher, ever, and MUST NOT call any event loop functions or methods>. If |
713 | watcher, ever, and MUST NOT call any event loop functions or methods>. If |
590 | you need to stop it, return 1e30 and stop it afterwards. You may create |
714 | you need to stop it, return 1e30 and stop it afterwards. You may create |
591 | and start a C<EV::prepare> watcher for this task. |
715 | and start an C<EV::prepare> watcher for this task. |
592 | |
716 | |
593 | It must return the next time to trigger, based on the passed time value |
717 | It must return the next time to trigger, based on the passed time value |
594 | (that is, the lowest time value larger than or equal to to the second |
718 | (that is, the lowest time value larger than or equal to to the second |
595 | argument). It will usually be called just before the callback will be |
719 | argument). It will usually be called just before the callback will be |
596 | triggered, but might be called at other times, too. |
720 | triggered, but might be called at other times, too. |
597 | |
721 | |
598 | This can be used to create very complex timers, such as a timer that |
722 | This can be used to create very complex timers, such as a timer that |
599 | triggers on each midnight, local time (actually 24 hours after the last |
723 | triggers on each midnight, local time (actually one day after the last |
600 | midnight, to keep the example simple. If you know a way to do it correctly |
724 | midnight, to keep the example simple): |
601 | in about the same space (without requiring elaborate modules), drop me a |
|
|
602 | note :): |
|
|
603 | |
725 | |
604 | my $daily = EV::periodic 0, 0, sub { |
726 | my $daily = EV::periodic 0, 0, sub { |
605 | my ($w, $now) = @_; |
727 | my ($w, $now) = @_; |
606 | |
728 | |
607 | use Time::Local (); |
729 | use Time::Local (); |
608 | my (undef, undef, undef, $d, $m, $y) = localtime $now; |
730 | my (undef, undef, undef, $d, $m, $y) = localtime $now; |
609 | 86400 + Time::Local::timelocal 0, 0, 0, $d, $m, $y |
731 | Time::Local::timelocal_nocheck 0, 0, 0, $d + 1, $m, $y |
610 | }, sub { |
732 | }, sub { |
611 | print "it's midnight or likely shortly after, now\n"; |
733 | print "it's midnight or likely shortly after, now\n"; |
612 | }; |
734 | }; |
613 | |
735 | |
614 | =back |
736 | =back |
… | |
… | |
637 | |
759 | |
638 | =item $w = EV::signal $signal, $callback |
760 | =item $w = EV::signal $signal, $callback |
639 | |
761 | |
640 | =item $w = EV::signal_ns $signal, $callback |
762 | =item $w = EV::signal_ns $signal, $callback |
641 | |
763 | |
|
|
764 | =item $w = $loop->signal ($signal, $callback) |
|
|
765 | |
|
|
766 | =item $w = $loop->signal_ns ($signal, $callback) |
|
|
767 | |
642 | Call the callback when $signal is received (the signal can be specified by |
768 | Call the callback when $signal is received (the signal can be specified by |
643 | number or by name, just as with C<kill> or C<%SIG>). |
769 | number or by name, just as with C<kill> or C<%SIG>). |
|
|
770 | |
|
|
771 | Only one event loop can grab a given signal - attempting to grab the same |
|
|
772 | signal from two EV loops will crash the program immediately or cause data |
|
|
773 | corruption. |
644 | |
774 | |
645 | EV will grab the signal for the process (the kernel only allows one |
775 | EV will grab the signal for the process (the kernel only allows one |
646 | component to receive a signal at a time) when you start a signal watcher, |
776 | component to receive a signal at a time) when you start a signal watcher, |
647 | and removes it again when you stop it. Perl does the same when you |
777 | and removes it again when you stop it. Perl does the same when you |
648 | add/remove callbacks to C<%SIG>, so watch out. |
778 | add/remove callbacks to C<%SIG>, so watch out. |
… | |
… | |
873 | =item $w = $loop->check_ns ($callback) |
1003 | =item $w = $loop->check_ns ($callback) |
874 | |
1004 | |
875 | Call the callback just after the process wakes up again (after it has |
1005 | Call the callback just after the process wakes up again (after it has |
876 | gathered events), but before any other callbacks have been invoked. |
1006 | gathered events), but before any other callbacks have been invoked. |
877 | |
1007 | |
878 | This is used to integrate other event-based software into the EV |
1008 | This can be used to integrate other event-based software into the EV |
879 | mainloop: You register a prepare callback and in there, you create io and |
1009 | mainloop: You register a prepare callback and in there, you create io and |
880 | timer watchers as required by the other software. Here is a real-world |
1010 | timer watchers as required by the other software. Here is a real-world |
881 | example of integrating Net::SNMP (with some details left out): |
1011 | example of integrating Net::SNMP (with some details left out): |
882 | |
1012 | |
883 | our @snmp_watcher; |
1013 | our @snmp_watcher; |
… | |
… | |
913 | # make the dispatcher handle any new stuff |
1043 | # make the dispatcher handle any new stuff |
914 | ... not shown |
1044 | ... not shown |
915 | }; |
1045 | }; |
916 | |
1046 | |
917 | The callbacks of the created watchers will not be called as the watchers |
1047 | The callbacks of the created watchers will not be called as the watchers |
918 | are destroyed before this cna happen (remember EV::check gets called |
1048 | are destroyed before this can happen (remember EV::check gets called |
919 | first). |
1049 | first). |
920 | |
1050 | |
921 | The C<check_ns> variant doesn't start (activate) the newly created watcher. |
1051 | The C<check_ns> variant doesn't start (activate) the newly created watcher. |
|
|
1052 | |
|
|
1053 | =item EV::CHECK constant issues |
|
|
1054 | |
|
|
1055 | Like all other watcher types, there is a bitmask constant for use in |
|
|
1056 | C<$revents> and other places. The C<EV::CHECK> is special as it has |
|
|
1057 | the same name as the C<CHECK> sub called by Perl. This doesn't cause |
|
|
1058 | big issues on newer perls (beginning with 5.8.9), but it means thatthe |
|
|
1059 | constant must be I<inlined>, i.e. runtime calls will not work. That means |
|
|
1060 | that as long as you always C<use EV> and then C<EV::CHECK> you are on the |
|
|
1061 | safe side. |
922 | |
1062 | |
923 | =back |
1063 | =back |
924 | |
1064 | |
925 | |
1065 | |
926 | =head3 FORK WATCHERS - the audacity to resume the event loop after a fork |
1066 | =head3 FORK WATCHERS - the audacity to resume the event loop after a fork |
… | |
… | |
954 | loop, other types of watchers might be handled in a delayed or incorrect |
1094 | loop, other types of watchers might be handled in a delayed or incorrect |
955 | fashion and must not be used). |
1095 | fashion and must not be used). |
956 | |
1096 | |
957 | See the libev documentation at |
1097 | See the libev documentation at |
958 | L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#code_ev_embed_code_when_one_backend_> |
1098 | L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#code_ev_embed_code_when_one_backend_> |
959 | for more details. |
1099 | (locally installed as F<EV::libev>) for more details. |
960 | |
1100 | |
961 | In short, this watcher is most useful on BSD systems without working |
1101 | In short, this watcher is most useful on BSD systems without working |
962 | kqueue to still be able to handle a large number of sockets: |
1102 | kqueue to still be able to handle a large number of sockets: |
963 | |
1103 | |
964 | my $socket_loop; |
1104 | my $socket_loop; |
… | |
… | |
975 | # use the default loop otherwise |
1115 | # use the default loop otherwise |
976 | $socket_loop ||= EV::default_loop; |
1116 | $socket_loop ||= EV::default_loop; |
977 | |
1117 | |
978 | =over 4 |
1118 | =over 4 |
979 | |
1119 | |
980 | =item $w = EV::embed $otherloop, $callback |
1120 | =item $w = EV::embed $otherloop[, $callback] |
981 | |
1121 | |
982 | =item $w = EV::embed_ns $otherloop, $callback |
1122 | =item $w = EV::embed_ns $otherloop[, $callback] |
983 | |
1123 | |
984 | =item $w = $loop->embed ($otherloop, $callback) |
1124 | =item $w = $loop->embed ($otherloop[, $callback]) |
985 | |
1125 | |
986 | =item $w = $loop->embed_ns ($otherloop, $callback) |
1126 | =item $w = $loop->embed_ns ($otherloop[, $callback]) |
987 | |
1127 | |
988 | Call the callback when the embedded event loop (C<$otherloop>) has any |
1128 | Call the callback when the embedded event loop (C<$otherloop>) has any |
989 | I/O activity. The C<$callback> should alwas be specified as C<undef> in |
1129 | I/O activity. The C<$callback> is optional: if it is missing, then the |
990 | this version of EV, which means the embedded event loop will be managed |
1130 | embedded event loop will be managed automatically (which is recommended), |
991 | automatically. |
1131 | otherwise you have to invoke C<sweep> yourself. |
992 | |
1132 | |
993 | The C<embed_ns> variant doesn't start (activate) the newly created watcher. |
1133 | The C<embed_ns> variant doesn't start (activate) the newly created watcher. |
994 | |
1134 | |
995 | =back |
1135 | =back |
996 | |
1136 | |
997 | =head3 ASYNC WATCHERS - how to wake up another event loop |
1137 | =head3 ASYNC WATCHERS - how to wake up another event loop |
998 | |
1138 | |
999 | Async watchers are provided by EV, but have little use in perl directly, as perl |
1139 | Async watchers are provided by EV, but have little use in perl directly, |
1000 | neither supports threads nor direct access to signal handlers or other |
1140 | as perl neither supports threads running in parallel nor direct access to |
1001 | contexts where they could be of value. |
1141 | signal handlers or other contexts where they could be of value. |
1002 | |
1142 | |
1003 | It is, however, possible to use them from the XS level. |
1143 | It is, however, possible to use them from the XS level. |
1004 | |
1144 | |
1005 | Please see the libev documentation for further details. |
1145 | Please see the libev documentation for further details. |
1006 | |
1146 | |
… | |
… | |
1008 | |
1148 | |
1009 | =item $w = EV::async $callback |
1149 | =item $w = EV::async $callback |
1010 | |
1150 | |
1011 | =item $w = EV::async_ns $callback |
1151 | =item $w = EV::async_ns $callback |
1012 | |
1152 | |
|
|
1153 | =item $w = $loop->async ($callback) |
|
|
1154 | |
|
|
1155 | =item $w = $loop->async_ns ($callback) |
|
|
1156 | |
1013 | =item $w->send |
1157 | =item $w->send |
1014 | |
1158 | |
1015 | =item $bool = $w->async_pending |
1159 | =item $bool = $w->async_pending |
1016 | |
1160 | |
1017 | =back |
1161 | =back |
|
|
1162 | |
|
|
1163 | =head3 CLEANUP WATCHERS - how to clean up when the event loop goes away |
|
|
1164 | |
|
|
1165 | Cleanup watchers are not supported on the Perl level, they can only be |
|
|
1166 | used via XS currently. |
1018 | |
1167 | |
1019 | |
1168 | |
1020 | =head1 PERL SIGNALS |
1169 | =head1 PERL SIGNALS |
1021 | |
1170 | |
1022 | While Perl signal handling (C<%SIG>) is not affected by EV, the behaviour |
1171 | While Perl signal handling (C<%SIG>) is not affected by EV, the behaviour |
… | |
… | |
1034 | my $async_check = EV::check sub { }; |
1183 | my $async_check = EV::check sub { }; |
1035 | |
1184 | |
1036 | This ensures that perl gets into control for a short time to handle any |
1185 | This ensures that perl gets into control for a short time to handle any |
1037 | pending signals, and also ensures (slightly) slower overall operation. |
1186 | pending signals, and also ensures (slightly) slower overall operation. |
1038 | |
1187 | |
1039 | =head1 THREADS |
1188 | =head1 ITHREADS |
1040 | |
1189 | |
1041 | Threads are not supported by this module in any way. Perl pseudo-threads |
1190 | Ithreads are not supported by this module in any way. Perl pseudo-threads |
1042 | is evil stuff and must die. As soon as Perl gains real threads I will work |
1191 | is evil stuff and must die. Real threads as provided by Coro are fully |
1043 | on thread support for it. |
1192 | supported (and enhanced support is available via L<Coro::EV>). |
1044 | |
1193 | |
1045 | =head1 FORK |
1194 | =head1 FORK |
1046 | |
1195 | |
1047 | Most of the "improved" event delivering mechanisms of modern operating |
1196 | Most of the "improved" event delivering mechanisms of modern operating |
1048 | systems have quite a few problems with fork(2) (to put it bluntly: it is |
1197 | systems have quite a few problems with fork(2) (to put it bluntly: it is |
… | |
… | |
1070 | |
1219 | |
1071 | 1; |
1220 | 1; |
1072 | |
1221 | |
1073 | =head1 SEE ALSO |
1222 | =head1 SEE ALSO |
1074 | |
1223 | |
|
|
1224 | L<EV::MakeMaker> - MakeMaker interface to XS API, L<EV::ADNS> |
1075 | L<EV::ADNS> (asynchronous DNS), L<Glib::EV> (makes Glib/Gtk2 use EV as |
1225 | (asynchronous DNS), L<Glib::EV> (makes Glib/Gtk2 use EV as event |
1076 | event loop), L<EV::Glib> (embed Glib into EV), L<Coro::EV> (efficient |
1226 | loop), L<EV::Glib> (embed Glib into EV), L<Coro::EV> (efficient thread |
1077 | coroutines with EV), L<Net::SNMP::EV> (asynchronous SNMP), L<AnyEvent> for |
1227 | integration), L<Net::SNMP::EV> (asynchronous SNMP), L<AnyEvent> for |
1078 | event-loop agnostic and portable event driven programming. |
1228 | event-loop agnostic and portable event driven programming. |
1079 | |
1229 | |
1080 | =head1 AUTHOR |
1230 | =head1 AUTHOR |
1081 | |
1231 | |
1082 | Marc Lehmann <schmorp@schmorp.de> |
1232 | Marc Lehmann <schmorp@schmorp.de> |