… | |
… | |
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::unloop 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 | no warnings; |
121 | use common::sense; |
77 | use strict; |
|
|
78 | |
122 | |
79 | BEGIN { |
123 | BEGIN { |
80 | our $VERSION = '3.431'; |
124 | our $VERSION = '4.03'; |
81 | use XSLoader; |
125 | use XSLoader; |
82 | XSLoader::load "EV", $VERSION; |
126 | XSLoader::load "EV", $VERSION; |
83 | } |
127 | } |
84 | |
128 | |
85 | @EV::IO::ISA = |
129 | @EV::IO::ISA = |
… | |
… | |
112 | default loop as this is fastest (perl-wise), best supported by other |
156 | default loop as this is fastest (perl-wise), best supported by other |
113 | modules (e.g. AnyEvent or Coro) and most portable event loop. |
157 | modules (e.g. AnyEvent or Coro) and most portable event loop. |
114 | |
158 | |
115 | For specific programs you can create additional event loops dynamically. |
159 | For specific programs you can create additional event loops dynamically. |
116 | |
160 | |
117 | If you want to take avdantage of kqueue (which often works properly for |
161 | If you want to take advantage of kqueue (which often works properly for |
118 | sockets only) even though the default loop doesn't enable it, you can |
162 | sockets only) even though the default loop doesn't enable it, you can |
119 | I<embed> a kqueue loop into the default loop: running the default loop |
163 | I<embed> a kqueue loop into the default loop: running the default loop |
120 | will then also service the kqueue loop to some extent. See the example in |
164 | will then also service the kqueue loop to some extent. See the example in |
121 | the section about embed watchers for an example on how to achieve that. |
165 | the section about embed watchers for an example on how to achieve that. |
122 | |
166 | |
123 | =over 4 |
167 | =over 4 |
124 | |
168 | |
125 | =item $loop = new EV::loop [$flags] |
169 | =item $loop = new EV::Loop [$flags] |
126 | |
170 | |
127 | Create a new event loop as per the specified flags. Please refer to the |
171 | Create a new event loop as per the specified flags. Please refer to |
128 | C<ev_loop_new ()> function description in the libev documentation |
172 | the C<ev_loop_new ()> function description in the libev documentation |
129 | (L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#GLOBAL_FUNCTIONS>) |
173 | (L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#GLOBAL_FUNCTIONS>, |
130 | for more info. |
174 | or locally-installed as F<EV::libev> manpage) for more info. |
131 | |
175 | |
132 | The loop will automatically be destroyed when it is no longer referenced |
176 | The loop will automatically be destroyed when it is no longer referenced |
133 | by any watcher and the loop object goes out of scope. |
177 | by any watcher and the loop object goes out of scope. |
134 | |
178 | |
135 | Using C<EV::FLAG_FORKCHECK> is recommended, as only the default event loop |
179 | If you are not embedding the loop, then Using C<EV::FLAG_FORKCHECK> |
136 | is protected by this module. |
180 | is recommended, as only the default event loop is protected by this |
|
|
181 | module. If you I<are> embedding this loop in the default loop, this is not |
|
|
182 | necessary, as C<EV::embed> automatically does the right thing on fork. |
137 | |
183 | |
138 | =item $loop->loop_fork |
184 | =item $loop->loop_fork |
139 | |
185 | |
140 | Must be called after a fork in the child, before entering or continuing |
186 | Must be called after a fork in the child, before entering or continuing |
141 | the event loop. An alternative is to use C<EV::FLAG_FORKCHECK> which calls |
187 | the event loop. An alternative is to use C<EV::FLAG_FORKCHECK> which calls |
142 | this function automatically, at some performance loss (refer to the libev |
188 | this function automatically, at some performance loss (refer to the libev |
143 | documentation). |
189 | documentation). |
144 | |
190 | |
145 | =item $loop->loop_verify |
191 | =item $loop->verify |
146 | |
192 | |
147 | Calls C<ev_verify> to make internal consistency checks (for debugging |
193 | Calls C<ev_verify> to make internal consistency checks (for debugging |
148 | libev) and abort the program if any data structures were found to be |
194 | libev) and abort the program if any data structures were found to be |
149 | corrupted. |
195 | corrupted. |
150 | |
196 | |
… | |
… | |
192 | =item $time = EV::now |
238 | =item $time = EV::now |
193 | |
239 | |
194 | =item $time = $loop->now |
240 | =item $time = $loop->now |
195 | |
241 | |
196 | Returns the time the last event loop iteration has been started. This |
242 | Returns the time the last event loop iteration has been started. This |
197 | is the time that (relative) timers are based on, and refering to it is |
243 | is the time that (relative) timers are based on, and referring to it is |
198 | usually faster then calling EV::time. |
244 | usually faster then calling EV::time. |
199 | |
245 | |
|
|
246 | =item EV::now_update |
|
|
247 | |
|
|
248 | =item $loop->now_update |
|
|
249 | |
|
|
250 | Establishes the current time by querying the kernel, updating the time |
|
|
251 | returned by C<EV::now> in the progress. This is a costly operation and |
|
|
252 | is usually done automatically within C<EV::loop>. |
|
|
253 | |
|
|
254 | This function is rarely useful, but when some event callback runs for a |
|
|
255 | very long time without entering the event loop, updating libev's idea of |
|
|
256 | the current time is a good idea. |
|
|
257 | |
|
|
258 | =item EV::suspend |
|
|
259 | |
|
|
260 | =item $loop->suspend |
|
|
261 | |
|
|
262 | =item EV::resume |
|
|
263 | |
|
|
264 | =item $loop->resume |
|
|
265 | |
|
|
266 | These two functions suspend and resume a loop, for use when the loop is |
|
|
267 | not used for a while and timeouts should not be processed. |
|
|
268 | |
|
|
269 | A typical use case would be an interactive program such as a game: When |
|
|
270 | the user presses C<^Z> to suspend the game and resumes it an hour later it |
|
|
271 | would be best to handle timeouts as if no time had actually passed while |
|
|
272 | the program was suspended. This can be achieved by calling C<suspend> |
|
|
273 | in your C<SIGTSTP> handler, sending yourself a C<SIGSTOP> and calling |
|
|
274 | C<resume> directly afterwards to resume timer processing. |
|
|
275 | |
|
|
276 | Effectively, all C<timer> watchers will be delayed by the time spend |
|
|
277 | between C<suspend> and C<resume>, and all C<periodic> watchers |
|
|
278 | will be rescheduled (that is, they will lose any events that would have |
|
|
279 | occured while suspended). |
|
|
280 | |
|
|
281 | After calling C<suspend> you B<must not> call I<any> function on the given |
|
|
282 | loop other than C<resume>, and you B<must not> call C<resume> |
|
|
283 | without a previous call to C<suspend>. |
|
|
284 | |
|
|
285 | Calling C<suspend>/C<resume> has the side effect of updating the event |
|
|
286 | loop time (see C<now_update>). |
|
|
287 | |
200 | =item $backend = EV::backend |
288 | =item $backend = EV::backend |
201 | |
289 | |
202 | =item $backend = $loop->backend |
290 | =item $backend = $loop->backend |
203 | |
291 | |
204 | Returns an integer describing the backend used by libev (EV::METHOD_SELECT |
292 | Returns an integer describing the backend used by libev (EV::BACKEND_SELECT |
205 | or EV::METHOD_EPOLL). |
293 | or EV::BACKEND_EPOLL). |
206 | |
294 | |
207 | =item EV::loop [$flags] |
295 | =item EV::run [$flags] |
208 | |
296 | |
209 | =item $loop->loop ([$flags]) |
297 | =item $loop->run ([$flags]) |
210 | |
298 | |
211 | Begin checking for events and calling callbacks. It returns when a |
299 | Begin checking for events and calling callbacks. It returns when a |
212 | callback calls EV::unloop. |
300 | callback calls EV::unloop. |
213 | |
301 | |
214 | The $flags argument can be one of the following: |
302 | The $flags argument can be one of the following: |
215 | |
303 | |
216 | 0 as above |
304 | 0 as above |
217 | EV::LOOP_ONESHOT block at most once (wait, but do not loop) |
305 | EV::RUN_ONCE block at most once (wait, but do not loop) |
218 | EV::LOOP_NONBLOCK do not block at all (fetch/handle events but do not wait) |
306 | EV::RUN_NOWAIT do not block at all (fetch/handle events but do not wait) |
219 | |
307 | |
220 | =item EV::unloop [$how] |
308 | =item EV::break [$how] |
221 | |
309 | |
222 | =item $loop->unloop ([$how]) |
310 | =item $loop->break ([$how]) |
223 | |
311 | |
224 | When called with no arguments or an argument of EV::UNLOOP_ONE, makes the |
312 | When called with no arguments or an argument of EV::BREAK_ONE, makes the |
225 | innermost call to EV::loop return. |
313 | innermost call to EV::loop return. |
226 | |
314 | |
227 | When called with an argument of EV::UNLOOP_ALL, all calls to EV::loop will return as |
315 | When called with an argument of EV::BREAK_ALL, all calls to EV::loop will |
228 | fast as possible. |
316 | return as fast as possible. |
229 | |
317 | |
230 | =item $count = EV::loop_count |
318 | When called with an argument of EV::BREAK_CANCEL, any pending break will |
|
|
319 | be cancelled. |
231 | |
320 | |
|
|
321 | =item $count = EV::iteration |
|
|
322 | |
232 | =item $count = $loop->loop_count |
323 | =item $count = $loop->iteration |
233 | |
324 | |
234 | Return the number of times the event loop has polled for new |
325 | Return the number of times the event loop has polled for new |
235 | events. Sometiems useful as a generation counter. |
326 | events. Sometimes useful as a generation counter. |
236 | |
327 | |
237 | =item EV::once $fh_or_undef, $events, $timeout, $cb->($revents) |
328 | =item EV::once $fh_or_undef, $events, $timeout, $cb->($revents) |
238 | |
329 | |
239 | =item $loop->once ($fh_or_undef, $events, $timeout, $cb->($revents)) |
330 | =item $loop->once ($fh_or_undef, $events, $timeout, $cb->($revents)) |
240 | |
331 | |
… | |
… | |
251 | timeout. Otherwise a EV::timer with this value will be started. |
342 | timeout. Otherwise a EV::timer with this value will be started. |
252 | |
343 | |
253 | When an error occurs or either the timeout or I/O watcher triggers, then |
344 | When an error occurs or either the timeout or I/O watcher triggers, then |
254 | the callback will be called with the received event set (in general |
345 | the callback will be called with the received event set (in general |
255 | you can expect it to be a combination of C<EV::ERROR>, C<EV::READ>, |
346 | you can expect it to be a combination of C<EV::ERROR>, C<EV::READ>, |
256 | C<EV::WRITE> and C<EV::TIMEOUT>). |
347 | C<EV::WRITE> and C<EV::TIMER>). |
257 | |
348 | |
258 | EV::once doesn't return anything: the watchers stay active till either |
349 | EV::once doesn't return anything: the watchers stay active till either |
259 | of them triggers, then they will be stopped and freed, and the callback |
350 | of them triggers, then they will be stopped and freed, and the callback |
260 | invoked. |
351 | invoked. |
261 | |
352 | |
262 | =item EV::feed_fd_event ($fd, $revents) |
353 | =item EV::feed_fd_event $fd, $revents |
263 | |
354 | |
264 | =item $loop->feed_fd_event ($fd, $revents) |
355 | =item $loop->feed_fd_event ($fd, $revents) |
265 | |
356 | |
266 | Feed an event on a file descriptor into EV. EV will react to this call as |
357 | Feed an event on a file descriptor into EV. EV will react to this call as |
267 | if the readyness notifications specified by C<$revents> (a combination of |
358 | if the readyness notifications specified by C<$revents> (a combination of |
268 | C<EV::READ> and C<EV::WRITE>) happened on the file descriptor C<$fd>. |
359 | C<EV::READ> and C<EV::WRITE>) happened on the file descriptor C<$fd>. |
269 | |
360 | |
270 | =item EV::feed_signal_event ($signal) |
361 | =item EV::feed_signal_event $signal |
271 | |
362 | |
272 | Feed a signal event into EV. EV will react to this call as if the signal |
363 | Feed a signal event into the default loop. EV will react to this call as |
273 | specified by C<$signal> had occured. |
364 | if the signal specified by C<$signal> had occured. |
|
|
365 | |
|
|
366 | =item EV::feed_signal $signal |
|
|
367 | |
|
|
368 | Feed a signal event into EV - unlike C<EV::feed_signal_event>, this works |
|
|
369 | regardless of which loop has registered the signal, and is mainly useful |
|
|
370 | fro custom signal implementations. |
274 | |
371 | |
275 | =item EV::set_io_collect_interval $time |
372 | =item EV::set_io_collect_interval $time |
276 | |
373 | |
277 | =item $loop->set_io_collect_interval ($time) |
374 | =item $loop->set_io_collect_interval ($time) |
278 | |
375 | |
… | |
… | |
280 | |
377 | |
281 | =item $loop->set_timeout_collect_interval ($time) |
378 | =item $loop->set_timeout_collect_interval ($time) |
282 | |
379 | |
283 | These advanced functions set the minimum block interval when polling for I/O events and the minimum |
380 | These advanced functions set the minimum block interval when polling for I/O events and the minimum |
284 | wait interval for timer events. See the libev documentation at |
381 | wait interval for timer events. See the libev documentation at |
285 | L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#FUNCTIONS_CONTROLLING_THE_EVENT_LOOP> for |
382 | L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#FUNCTIONS_CONTROLLING_THE_EVENT_LOOP> |
286 | a more detailed discussion. |
383 | (locally installed as F<EV::libev>) for a more detailed discussion. |
|
|
384 | |
|
|
385 | =item $count = EV::pending_count |
|
|
386 | |
|
|
387 | =item $count = $loop->pending_count |
|
|
388 | |
|
|
389 | Returns the number of currently pending watchers. |
|
|
390 | |
|
|
391 | =item EV::invoke_pending |
|
|
392 | |
|
|
393 | =item $loop->invoke_pending |
|
|
394 | |
|
|
395 | Invoke all currently pending watchers. |
287 | |
396 | |
288 | =back |
397 | =back |
289 | |
398 | |
290 | |
399 | |
291 | =head1 WATCHER OBJECTS |
400 | =head1 WATCHER OBJECTS |
… | |
… | |
304 | called with at least two arguments: the watcher and a bitmask of received |
413 | called with at least two arguments: the watcher and a bitmask of received |
305 | events. |
414 | events. |
306 | |
415 | |
307 | Each watcher type has its associated bit in revents, so you can use the |
416 | Each watcher type has its associated bit in revents, so you can use the |
308 | same callback for multiple watchers. The event mask is named after the |
417 | same callback for multiple watchers. The event mask is named after the |
309 | type, i..e. EV::child sets EV::CHILD, EV::prepare sets EV::PREPARE, |
418 | type, i.e. EV::child sets EV::CHILD, EV::prepare sets EV::PREPARE, |
310 | EV::periodic sets EV::PERIODIC and so on, with the exception of I/O events |
419 | EV::periodic sets EV::PERIODIC and so on, with the exception of I/O events |
311 | (which can set both EV::READ and EV::WRITE bits), and EV::timer (which |
420 | (which can set both EV::READ and EV::WRITE bits). |
312 | uses EV::TIMEOUT). |
|
|
313 | |
421 | |
314 | In the rare case where one wants to create a watcher but not start it at |
422 | In the rare case where one wants to create a watcher but not start it at |
315 | the same time, each constructor has a variant with a trailing C<_ns> in |
423 | the same time, each constructor has a variant with a trailing C<_ns> in |
316 | its name, e.g. EV::io has a non-starting variant EV::io_ns and so on. |
424 | its name, e.g. EV::io has a non-starting variant EV::io_ns and so on. |
317 | |
425 | |
… | |
… | |
396 | |
504 | |
397 | =item $previous_state = $w->keepalive ($bool) |
505 | =item $previous_state = $w->keepalive ($bool) |
398 | |
506 | |
399 | Normally, C<EV::loop> will return when there are no active watchers |
507 | Normally, C<EV::loop> will return when there are no active watchers |
400 | (which is a "deadlock" because no progress can be made anymore). This is |
508 | (which is a "deadlock" because no progress can be made anymore). This is |
401 | convinient because it allows you to start your watchers (and your jobs), |
509 | convenient because it allows you to start your watchers (and your jobs), |
402 | call C<EV::loop> once and when it returns you know that all your jobs are |
510 | call C<EV::loop> once and when it returns you know that all your jobs are |
403 | finished (or they forgot to register some watchers for their task :). |
511 | finished (or they forgot to register some watchers for their task :). |
404 | |
512 | |
405 | Sometimes, however, this gets in your way, for example when the module |
513 | Sometimes, however, this gets in your way, for example when the module |
406 | that calls C<EV::loop> (usually the main program) is not the same module |
514 | that calls C<EV::loop> (usually the main program) is not the same module |
… | |
… | |
410 | because you happen to have this long-running UDP port watcher. |
518 | because you happen to have this long-running UDP port watcher. |
411 | |
519 | |
412 | In this case you can clear the keepalive status, which means that even |
520 | In this case you can clear the keepalive status, which means that even |
413 | though your watcher is active, it won't keep C<EV::loop> from returning. |
521 | though your watcher is active, it won't keep C<EV::loop> from returning. |
414 | |
522 | |
415 | The initial value for keepalive is true (enabled), and you cna change it |
523 | The initial value for keepalive is true (enabled), and you can change it |
416 | any time. |
524 | any time. |
417 | |
525 | |
418 | Example: Register an I/O watcher for some UDP socket but do not keep the |
526 | Example: Register an I/O watcher for some UDP socket but do not keep the |
419 | event loop from running just because of that watcher. |
527 | event loop from running just because of that watcher. |
420 | |
528 | |
… | |
… | |
638 | |
746 | |
639 | =item $w = EV::signal $signal, $callback |
747 | =item $w = EV::signal $signal, $callback |
640 | |
748 | |
641 | =item $w = EV::signal_ns $signal, $callback |
749 | =item $w = EV::signal_ns $signal, $callback |
642 | |
750 | |
|
|
751 | =item $w = $loop->signal ($signal, $callback) |
|
|
752 | |
|
|
753 | =item $w = $loop->signal_ns ($signal, $callback) |
|
|
754 | |
643 | Call the callback when $signal is received (the signal can be specified by |
755 | Call the callback when $signal is received (the signal can be specified by |
644 | number or by name, just as with C<kill> or C<%SIG>). |
756 | number or by name, just as with C<kill> or C<%SIG>). |
|
|
757 | |
|
|
758 | Only one event loop can grab a given signal - attempting to grab the same |
|
|
759 | signal from two EV loops will crash the program immediately or cause data |
|
|
760 | corruption. |
645 | |
761 | |
646 | EV will grab the signal for the process (the kernel only allows one |
762 | EV will grab the signal for the process (the kernel only allows one |
647 | component to receive a signal at a time) when you start a signal watcher, |
763 | component to receive a signal at a time) when you start a signal watcher, |
648 | and removes it again when you stop it. Perl does the same when you |
764 | and removes it again when you stop it. Perl does the same when you |
649 | add/remove callbacks to C<%SIG>, so watch out. |
765 | add/remove callbacks to C<%SIG>, so watch out. |
… | |
… | |
874 | =item $w = $loop->check_ns ($callback) |
990 | =item $w = $loop->check_ns ($callback) |
875 | |
991 | |
876 | Call the callback just after the process wakes up again (after it has |
992 | Call the callback just after the process wakes up again (after it has |
877 | gathered events), but before any other callbacks have been invoked. |
993 | gathered events), but before any other callbacks have been invoked. |
878 | |
994 | |
879 | This is used to integrate other event-based software into the EV |
995 | This can be used to integrate other event-based software into the EV |
880 | mainloop: You register a prepare callback and in there, you create io and |
996 | mainloop: You register a prepare callback and in there, you create io and |
881 | timer watchers as required by the other software. Here is a real-world |
997 | timer watchers as required by the other software. Here is a real-world |
882 | example of integrating Net::SNMP (with some details left out): |
998 | example of integrating Net::SNMP (with some details left out): |
883 | |
999 | |
884 | our @snmp_watcher; |
1000 | our @snmp_watcher; |
… | |
… | |
914 | # make the dispatcher handle any new stuff |
1030 | # make the dispatcher handle any new stuff |
915 | ... not shown |
1031 | ... not shown |
916 | }; |
1032 | }; |
917 | |
1033 | |
918 | The callbacks of the created watchers will not be called as the watchers |
1034 | The callbacks of the created watchers will not be called as the watchers |
919 | are destroyed before this cna happen (remember EV::check gets called |
1035 | are destroyed before this can happen (remember EV::check gets called |
920 | first). |
1036 | first). |
921 | |
1037 | |
922 | The C<check_ns> variant doesn't start (activate) the newly created watcher. |
1038 | The C<check_ns> variant doesn't start (activate) the newly created watcher. |
|
|
1039 | |
|
|
1040 | =item EV::CHECK constant issues |
|
|
1041 | |
|
|
1042 | Like all other watcher types, there is a bitmask constant for use in |
|
|
1043 | C<$revents> and other places. The C<EV::CHECK> is special as it has |
|
|
1044 | the same name as the C<CHECK> sub called by Perl. This doesn't cause |
|
|
1045 | big issues on newer perls (beginning with 5.8.9), but it means thatthe |
|
|
1046 | constant must be I<inlined>, i.e. runtime calls will not work. That means |
|
|
1047 | that as long as you always C<use EV> and then C<EV::CHECK> you are on the |
|
|
1048 | safe side. |
923 | |
1049 | |
924 | =back |
1050 | =back |
925 | |
1051 | |
926 | |
1052 | |
927 | =head3 FORK WATCHERS - the audacity to resume the event loop after a fork |
1053 | =head3 FORK WATCHERS - the audacity to resume the event loop after a fork |
… | |
… | |
955 | loop, other types of watchers might be handled in a delayed or incorrect |
1081 | loop, other types of watchers might be handled in a delayed or incorrect |
956 | fashion and must not be used). |
1082 | fashion and must not be used). |
957 | |
1083 | |
958 | See the libev documentation at |
1084 | See the libev documentation at |
959 | L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#code_ev_embed_code_when_one_backend_> |
1085 | L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#code_ev_embed_code_when_one_backend_> |
960 | for more details. |
1086 | (locally installed as F<EV::libev>) for more details. |
961 | |
1087 | |
962 | In short, this watcher is most useful on BSD systems without working |
1088 | In short, this watcher is most useful on BSD systems without working |
963 | kqueue to still be able to handle a large number of sockets: |
1089 | kqueue to still be able to handle a large number of sockets: |
964 | |
1090 | |
965 | my $socket_loop; |
1091 | my $socket_loop; |
… | |
… | |
995 | |
1121 | |
996 | =back |
1122 | =back |
997 | |
1123 | |
998 | =head3 ASYNC WATCHERS - how to wake up another event loop |
1124 | =head3 ASYNC WATCHERS - how to wake up another event loop |
999 | |
1125 | |
1000 | Async watchers are provided by EV, but have little use in perl directly, as perl |
1126 | Async watchers are provided by EV, but have little use in perl directly, |
1001 | neither supports threads nor direct access to signal handlers or other |
1127 | as perl neither supports threads running in parallel nor direct access to |
1002 | contexts where they could be of value. |
1128 | signal handlers or other contexts where they could be of value. |
1003 | |
1129 | |
1004 | It is, however, possible to use them from the XS level. |
1130 | It is, however, possible to use them from the XS level. |
1005 | |
1131 | |
1006 | Please see the libev documentation for further details. |
1132 | Please see the libev documentation for further details. |
1007 | |
1133 | |
… | |
… | |
1035 | my $async_check = EV::check sub { }; |
1161 | my $async_check = EV::check sub { }; |
1036 | |
1162 | |
1037 | This ensures that perl gets into control for a short time to handle any |
1163 | This ensures that perl gets into control for a short time to handle any |
1038 | pending signals, and also ensures (slightly) slower overall operation. |
1164 | pending signals, and also ensures (slightly) slower overall operation. |
1039 | |
1165 | |
1040 | =head1 THREADS |
1166 | =head1 ITHREADS |
1041 | |
1167 | |
1042 | Threads are not supported by this module in any way. Perl pseudo-threads |
1168 | Ithreads are not supported by this module in any way. Perl pseudo-threads |
1043 | is evil stuff and must die. As soon as Perl gains real threads I will work |
1169 | is evil stuff and must die. Real threads as provided by Coro are fully |
1044 | on thread support for it. |
1170 | supported (and enhanced support is available via L<Coro::EV>). |
1045 | |
1171 | |
1046 | =head1 FORK |
1172 | =head1 FORK |
1047 | |
1173 | |
1048 | Most of the "improved" event delivering mechanisms of modern operating |
1174 | Most of the "improved" event delivering mechanisms of modern operating |
1049 | systems have quite a few problems with fork(2) (to put it bluntly: it is |
1175 | systems have quite a few problems with fork(2) (to put it bluntly: it is |
… | |
… | |
1071 | |
1197 | |
1072 | 1; |
1198 | 1; |
1073 | |
1199 | |
1074 | =head1 SEE ALSO |
1200 | =head1 SEE ALSO |
1075 | |
1201 | |
|
|
1202 | L<EV::MakeMaker> - MakeMaker interface to XS API, L<EV::ADNS> |
1076 | L<EV::ADNS> (asynchronous DNS), L<Glib::EV> (makes Glib/Gtk2 use EV as |
1203 | (asynchronous DNS), L<Glib::EV> (makes Glib/Gtk2 use EV as event |
1077 | event loop), L<EV::Glib> (embed Glib into EV), L<Coro::EV> (efficient |
1204 | loop), L<EV::Glib> (embed Glib into EV), L<Coro::EV> (efficient thread |
1078 | coroutines with EV), L<Net::SNMP::EV> (asynchronous SNMP), L<AnyEvent> for |
1205 | integration), L<Net::SNMP::EV> (asynchronous SNMP), L<AnyEvent> for |
1079 | event-loop agnostic and portable event driven programming. |
1206 | event-loop agnostic and portable event driven programming. |
1080 | |
1207 | |
1081 | =head1 AUTHOR |
1208 | =head1 AUTHOR |
1082 | |
1209 | |
1083 | Marc Lehmann <schmorp@schmorp.de> |
1210 | Marc Lehmann <schmorp@schmorp.de> |