… | |
… | |
46 | my ($w, $revents) = @_; |
46 | my ($w, $revents) = @_; |
47 | warn $w->path, " has changed somehow.\n"; |
47 | warn $w->path, " has changed somehow.\n"; |
48 | }; |
48 | }; |
49 | |
49 | |
50 | # MAINLOOP |
50 | # MAINLOOP |
51 | EV::loop; # loop until EV::unloop is called or all watchers stop |
51 | EV::run; # loop until EV::unloop is called or all watchers stop |
52 | EV::loop EV::LOOP_ONESHOT; # block until at least one event could be handled |
52 | EV::run EV::RUN_ONCE; # block until at least one event could be handled |
53 | EV::loop EV::LOOP_NONBLOCK; # try to handle same events, but do not block |
53 | EV::run EV::RUN_NOWAIT; # try to handle same events, but do not block |
|
|
54 | |
|
|
55 | BEFORE YOU START USING THIS MODULE |
|
|
56 | If you only need timer, I/O, signal, child and idle watchers and not the |
|
|
57 | advanced functionality of this module, consider using AnyEvent instead, |
|
|
58 | specifically the simplified API described in AE. |
|
|
59 | |
|
|
60 | When used with EV as backend, the AE API is as fast as the native EV |
|
|
61 | API, but your programs/modules will still run with many other event |
|
|
62 | loops. |
54 | |
63 | |
55 | DESCRIPTION |
64 | DESCRIPTION |
56 | This module provides an interface to libev |
65 | This module provides an interface to libev |
57 | (<http://software.schmorp.de/pkg/libev.html>). While the documentation |
66 | (<http://software.schmorp.de/pkg/libev.html>). While the documentation |
58 | below is comprehensive, one might also consult the documentation of |
67 | below is comprehensive, one might also consult the documentation of |
… | |
… | |
66 | can use it through the AnyEvent module, stay portable to other event |
75 | can use it through the AnyEvent module, stay portable to other event |
67 | loops (if you don't rely on any watcher types not available through it) |
76 | loops (if you don't rely on any watcher types not available through it) |
68 | and still be faster than with any other event loop currently supported |
77 | and still be faster than with any other event loop currently supported |
69 | in Perl. |
78 | in Perl. |
70 | |
79 | |
|
|
80 | PORTING FROM EV 3.X to 4.X |
|
|
81 | EV version 4 introduces a number of incompatible changes summarised |
|
|
82 | here. According to the depreciation strategy used by libev, there is a |
|
|
83 | compatibility layer in place so programs should continue to run |
|
|
84 | unchanged (the XS interface lacks this layer, so programs using that one |
|
|
85 | need to be updated). |
|
|
86 | |
|
|
87 | This compatibility layer will be switched off in some future release. |
|
|
88 | |
|
|
89 | All changes relevant to Perl are renames of symbols, functions and |
|
|
90 | methods: |
|
|
91 | |
|
|
92 | EV::loop => EV::run |
|
|
93 | EV::LOOP_NONBLOCK => EV::RUN_NOWAIT |
|
|
94 | EV::LOOP_ONESHOT => EV::RUN_ONCE |
|
|
95 | |
|
|
96 | EV::unloop => EV::break |
|
|
97 | EV::UNLOOP_CANCEL => EV::BREAK_CANCEL |
|
|
98 | EV::UNLOOP_ONE => EV::BREAK_ONE |
|
|
99 | EV::UNLOOP_ALL => EV::BREAK_ALL |
|
|
100 | |
|
|
101 | EV::TIMEOUT => EV::TIMER |
|
|
102 | |
|
|
103 | EV::loop_count => EV::iteration |
|
|
104 | EV::loop_depth => EV::depth |
|
|
105 | EV::loop_verify => EV::verify |
|
|
106 | |
|
|
107 | The loop object methods corresponding to the functions above have been |
|
|
108 | similarly renamed. |
|
|
109 | |
71 | MODULE EXPORTS |
110 | MODULE EXPORTS |
72 | This module does not export any symbols. |
111 | This module does not export any symbols. |
73 | |
112 | |
74 | EVENT LOOPS |
113 | EVENT LOOPS |
75 | EV supports multiple event loops: There is a single "default event loop" |
114 | EV supports multiple event loops: There is a single "default event loop" |
… | |
… | |
112 | Must be called after a fork in the child, before entering or |
151 | Must be called after a fork in the child, before entering or |
113 | continuing the event loop. An alternative is to use |
152 | continuing the event loop. An alternative is to use |
114 | "EV::FLAG_FORKCHECK" which calls this function automatically, at |
153 | "EV::FLAG_FORKCHECK" which calls this function automatically, at |
115 | some performance loss (refer to the libev documentation). |
154 | some performance loss (refer to the libev documentation). |
116 | |
155 | |
117 | $loop->loop_verify |
156 | $loop->verify |
118 | Calls "ev_verify" to make internal consistency checks (for debugging |
157 | Calls "ev_verify" to make internal consistency checks (for debugging |
119 | libev) and abort the program if any data structures were found to be |
158 | libev) and abort the program if any data structures were found to be |
120 | corrupted. |
159 | corrupted. |
121 | |
160 | |
122 | $loop = EV::default_loop [$flags] |
161 | $loop = EV::default_loop [$flags] |
… | |
… | |
194 | $backend = EV::backend |
233 | $backend = EV::backend |
195 | $backend = $loop->backend |
234 | $backend = $loop->backend |
196 | Returns an integer describing the backend used by libev |
235 | Returns an integer describing the backend used by libev |
197 | (EV::BACKEND_SELECT or EV::BACKEND_EPOLL). |
236 | (EV::BACKEND_SELECT or EV::BACKEND_EPOLL). |
198 | |
237 | |
199 | EV::loop [$flags] |
238 | EV::run [$flags] |
200 | $loop->loop ([$flags]) |
239 | $loop->run ([$flags]) |
201 | Begin checking for events and calling callbacks. It returns when a |
240 | Begin checking for events and calling callbacks. It returns when a |
202 | callback calls EV::unloop. |
241 | callback calls EV::unloop. |
203 | |
242 | |
204 | The $flags argument can be one of the following: |
243 | The $flags argument can be one of the following: |
205 | |
244 | |
206 | 0 as above |
245 | 0 as above |
207 | EV::LOOP_ONESHOT block at most once (wait, but do not loop) |
246 | EV::RUN_ONCE block at most once (wait, but do not loop) |
208 | EV::LOOP_NONBLOCK do not block at all (fetch/handle events but do not wait) |
247 | EV::RUN_NOWAIT do not block at all (fetch/handle events but do not wait) |
209 | |
248 | |
210 | EV::unloop [$how] |
249 | EV::break [$how] |
211 | $loop->unloop ([$how]) |
250 | $loop->break ([$how]) |
212 | When called with no arguments or an argument of EV::UNLOOP_ONE, |
251 | When called with no arguments or an argument of EV::BREAK_ONE, makes |
213 | makes the innermost call to EV::loop return. |
252 | the innermost call to EV::loop return. |
214 | |
253 | |
215 | When called with an argument of EV::UNLOOP_ALL, all calls to |
254 | When called with an argument of EV::BREAK_ALL, all calls to EV::loop |
216 | EV::loop will return as fast as possible. |
255 | will return as fast as possible. |
217 | |
256 | |
218 | $count = EV::loop_count |
257 | When called with an argument of EV::BREAK_CANCEL, any pending break |
219 | $count = $loop->loop_count |
258 | will be cancelled. |
|
|
259 | |
|
|
260 | $count = EV::iteration |
|
|
261 | $count = $loop->iteration |
220 | Return the number of times the event loop has polled for new events. |
262 | Return the number of times the event loop has polled for new events. |
221 | Sometimes useful as a generation counter. |
263 | Sometimes useful as a generation counter. |
222 | |
264 | |
223 | EV::once $fh_or_undef, $events, $timeout, $cb->($revents) |
265 | EV::once $fh_or_undef, $events, $timeout, $cb->($revents) |
224 | $loop->once ($fh_or_undef, $events, $timeout, $cb->($revents)) |
266 | $loop->once ($fh_or_undef, $events, $timeout, $cb->($revents)) |
… | |
… | |
235 | Otherwise a EV::timer with this value will be started. |
277 | Otherwise a EV::timer with this value will be started. |
236 | |
278 | |
237 | When an error occurs or either the timeout or I/O watcher triggers, |
279 | When an error occurs or either the timeout or I/O watcher triggers, |
238 | then the callback will be called with the received event set (in |
280 | then the callback will be called with the received event set (in |
239 | general you can expect it to be a combination of "EV::ERROR", |
281 | general you can expect it to be a combination of "EV::ERROR", |
240 | "EV::READ", "EV::WRITE" and "EV::TIMEOUT"). |
282 | "EV::READ", "EV::WRITE" and "EV::TIMER"). |
241 | |
283 | |
242 | EV::once doesn't return anything: the watchers stay active till |
284 | EV::once doesn't return anything: the watchers stay active till |
243 | either of them triggers, then they will be stopped and freed, and |
285 | either of them triggers, then they will be stopped and freed, and |
244 | the callback invoked. |
286 | the callback invoked. |
245 | |
287 | |
246 | EV::feed_fd_event ($fd, $revents) |
288 | EV::feed_fd_event $fd, $revents |
247 | $loop->feed_fd_event ($fd, $revents) |
289 | $loop->feed_fd_event ($fd, $revents) |
248 | Feed an event on a file descriptor into EV. EV will react to this |
290 | Feed an event on a file descriptor into EV. EV will react to this |
249 | call as if the readyness notifications specified by $revents (a |
291 | call as if the readyness notifications specified by $revents (a |
250 | combination of "EV::READ" and "EV::WRITE") happened on the file |
292 | combination of "EV::READ" and "EV::WRITE") happened on the file |
251 | descriptor $fd. |
293 | descriptor $fd. |
252 | |
294 | |
253 | EV::feed_signal_event ($signal) |
295 | EV::feed_signal_event $signal |
254 | Feed a signal event into EV. EV will react to this call as if the |
296 | Feed a signal event into the default loop. EV will react to this |
255 | signal specified by $signal had occured. |
297 | call as if the signal specified by $signal had occured. |
|
|
298 | |
|
|
299 | EV::feed_signal $signal |
|
|
300 | Feed a signal event into EV - unlike "EV::feed_signal_event", this |
|
|
301 | works regardless of which loop has registered the signal, and is |
|
|
302 | mainly useful fro custom signal implementations. |
256 | |
303 | |
257 | EV::set_io_collect_interval $time |
304 | EV::set_io_collect_interval $time |
258 | $loop->set_io_collect_interval ($time) |
305 | $loop->set_io_collect_interval ($time) |
259 | EV::set_timeout_collect_interval $time |
306 | EV::set_timeout_collect_interval $time |
260 | $loop->set_timeout_collect_interval ($time) |
307 | $loop->set_timeout_collect_interval ($time) |
… | |
… | |
290 | |
337 | |
291 | Each watcher type has its associated bit in revents, so you can use the |
338 | Each watcher type has its associated bit in revents, so you can use the |
292 | same callback for multiple watchers. The event mask is named after the |
339 | same callback for multiple watchers. The event mask is named after the |
293 | type, i.e. EV::child sets EV::CHILD, EV::prepare sets EV::PREPARE, |
340 | type, i.e. EV::child sets EV::CHILD, EV::prepare sets EV::PREPARE, |
294 | EV::periodic sets EV::PERIODIC and so on, with the exception of I/O |
341 | EV::periodic sets EV::PERIODIC and so on, with the exception of I/O |
295 | events (which can set both EV::READ and EV::WRITE bits), and EV::timer |
342 | events (which can set both EV::READ and EV::WRITE bits). |
296 | (which uses EV::TIMEOUT). |
|
|
297 | |
343 | |
298 | In the rare case where one wants to create a watcher but not start it at |
344 | In the rare case where one wants to create a watcher but not start it at |
299 | the same time, each constructor has a variant with a trailing "_ns" in |
345 | the same time, each constructor has a variant with a trailing "_ns" in |
300 | its name, e.g. EV::io has a non-starting variant EV::io_ns and so on. |
346 | its name, e.g. EV::io has a non-starting variant EV::io_ns and so on. |
301 | |
347 | |
… | |
… | |
758 | $w = $loop->check_ns ($callback) |
804 | $w = $loop->check_ns ($callback) |
759 | Call the callback just after the process wakes up again (after it |
805 | Call the callback just after the process wakes up again (after it |
760 | has gathered events), but before any other callbacks have been |
806 | has gathered events), but before any other callbacks have been |
761 | invoked. |
807 | invoked. |
762 | |
808 | |
763 | This is used to integrate other event-based software into the EV |
809 | This can be used to integrate other event-based software into the EV |
764 | mainloop: You register a prepare callback and in there, you create |
810 | mainloop: You register a prepare callback and in there, you create |
765 | io and timer watchers as required by the other software. Here is a |
811 | io and timer watchers as required by the other software. Here is a |
766 | real-world example of integrating Net::SNMP (with some details left |
812 | real-world example of integrating Net::SNMP (with some details left |
767 | out): |
813 | out): |
768 | |
814 | |
… | |
… | |
804 | watchers are destroyed before this can happen (remember EV::check |
850 | watchers are destroyed before this can happen (remember EV::check |
805 | gets called first). |
851 | gets called first). |
806 | |
852 | |
807 | The "check_ns" variant doesn't start (activate) the newly created |
853 | The "check_ns" variant doesn't start (activate) the newly created |
808 | watcher. |
854 | watcher. |
|
|
855 | |
|
|
856 | EV::CHECK constant issues |
|
|
857 | Like all other watcher types, there is a bitmask constant for use in |
|
|
858 | $revents and other places. The "EV::CHECK" is special as it has the |
|
|
859 | same name as the "CHECK" sub called by Perl. This doesn't cause big |
|
|
860 | issues on newer perls (beginning with 5.8.9), but it means thatthe |
|
|
861 | constant must be *inlined*, i.e. runtime calls will not work. That |
|
|
862 | means that as long as you always "use EV" and then "EV::CHECK" you |
|
|
863 | are on the safe side. |
809 | |
864 | |
810 | FORK WATCHERS - the audacity to resume the event loop after a fork |
865 | FORK WATCHERS - the audacity to resume the event loop after a fork |
811 | Fork watchers are called when a "fork ()" was detected. The invocation |
866 | Fork watchers are called when a "fork ()" was detected. The invocation |
812 | is done before the event loop blocks next and before "check" watchers |
867 | is done before the event loop blocks next and before "check" watchers |
813 | are being called, and only in the child after the fork. |
868 | are being called, and only in the child after the fork. |
… | |
… | |
915 | |
970 | |
916 | On win32, there is no notion of fork so all this doesn't apply, of |
971 | On win32, there is no notion of fork so all this doesn't apply, of |
917 | course. |
972 | course. |
918 | |
973 | |
919 | SEE ALSO |
974 | SEE ALSO |
920 | EV::ADNS (asynchronous DNS), Glib::EV (makes Glib/Gtk2 use EV as event |
975 | EV::MakeMaker - MakeMaker interface to XS API, EV::ADNS (asynchronous |
921 | loop), EV::Glib (embed Glib into EV), Coro::EV (efficient coroutines |
976 | DNS), Glib::EV (makes Glib/Gtk2 use EV as event loop), EV::Glib (embed |
922 | with EV), Net::SNMP::EV (asynchronous SNMP), AnyEvent for event-loop |
977 | Glib into EV), Coro::EV (efficient thread integration), Net::SNMP::EV |
923 | agnostic and portable event driven programming. |
978 | (asynchronous SNMP), AnyEvent for event-loop agnostic and portable event |
|
|
979 | driven programming. |
924 | |
980 | |
925 | AUTHOR |
981 | AUTHOR |
926 | Marc Lehmann <schmorp@schmorp.de> |
982 | Marc Lehmann <schmorp@schmorp.de> |
927 | http://home.schmorp.de/ |
983 | http://home.schmorp.de/ |
928 | |
984 | |