… | |
… | |
55 | |
55 | |
56 | =head1 DESCRIPTION |
56 | =head1 DESCRIPTION |
57 | |
57 | |
58 | This module provides an interface to libev |
58 | This module provides an interface to libev |
59 | (L<http://software.schmorp.de/pkg/libev.html>). While the documentation |
59 | (L<http://software.schmorp.de/pkg/libev.html>). While the documentation |
60 | below is comprehensive, one might also consult the documentation of libev |
60 | 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 |
61 | 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 |
62 | 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 |
63 | discussion on the available backends, or how to force a specific backend |
64 | about in any case because it has much more detailed information. |
64 | with C<LIBEV_FLAGS>, or just about in any case because it has much more |
|
|
65 | detailed information. |
65 | |
66 | |
66 | This module is very fast and scalable. It is actually so fast that you |
67 | 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 |
68 | 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) |
69 | 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 |
70 | and still be faster than with any other event loop currently supported in |
70 | Perl. |
71 | Perl. |
71 | |
72 | |
|
|
73 | =head2 MODULE EXPORTS |
|
|
74 | |
|
|
75 | This module does not export any symbols. |
|
|
76 | |
72 | =cut |
77 | =cut |
73 | |
78 | |
74 | package EV; |
79 | package EV; |
75 | |
80 | |
76 | no warnings; |
81 | use common::sense; |
77 | use strict; |
|
|
78 | |
82 | |
79 | BEGIN { |
83 | BEGIN { |
80 | our $VERSION = '3.44'; |
84 | our $VERSION = '3.7001'; |
81 | use XSLoader; |
85 | use XSLoader; |
82 | XSLoader::load "EV", $VERSION; |
86 | XSLoader::load "EV", $VERSION; |
83 | } |
87 | } |
84 | |
88 | |
85 | @EV::IO::ISA = |
89 | @EV::IO::ISA = |
… | |
… | |
112 | default loop as this is fastest (perl-wise), best supported by other |
116 | default loop as this is fastest (perl-wise), best supported by other |
113 | modules (e.g. AnyEvent or Coro) and most portable event loop. |
117 | modules (e.g. AnyEvent or Coro) and most portable event loop. |
114 | |
118 | |
115 | For specific programs you can create additional event loops dynamically. |
119 | For specific programs you can create additional event loops dynamically. |
116 | |
120 | |
117 | If you want to take avdantage of kqueue (which often works properly for |
121 | 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 |
122 | 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 |
123 | 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 |
124 | 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. |
125 | the section about embed watchers for an example on how to achieve that. |
122 | |
126 | |
123 | =over 4 |
127 | =over 4 |
124 | |
128 | |
125 | =item $loop = new EV::loop [$flags] |
129 | =item $loop = new EV::Loop [$flags] |
126 | |
130 | |
127 | Create a new event loop as per the specified flags. Please refer to the |
131 | Create a new event loop as per the specified flags. Please refer to |
128 | C<ev_loop_new ()> function description in the libev documentation |
132 | 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>) |
133 | (L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#GLOBAL_FUNCTIONS>, |
130 | for more info. |
134 | or locally-installed as F<EV::libev> manpage) for more info. |
131 | |
135 | |
132 | The loop will automatically be destroyed when it is no longer referenced |
136 | The loop will automatically be destroyed when it is no longer referenced |
133 | by any watcher and the loop object goes out of scope. |
137 | by any watcher and the loop object goes out of scope. |
134 | |
138 | |
135 | Using C<EV::FLAG_FORKCHECK> is recommended, as only the default event loop |
139 | If you are not embedding the loop, then Using C<EV::FLAG_FORKCHECK> |
136 | is protected by this module. |
140 | is recommended, as only the default event loop is protected by this |
|
|
141 | module. If you I<are> embedding this loop in the default loop, this is not |
|
|
142 | necessary, as C<EV::embed> automatically does the right thing on fork. |
137 | |
143 | |
138 | =item $loop->loop_fork |
144 | =item $loop->loop_fork |
139 | |
145 | |
140 | Must be called after a fork in the child, before entering or continuing |
146 | 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 |
147 | the event loop. An alternative is to use C<EV::FLAG_FORKCHECK> which calls |
… | |
… | |
192 | =item $time = EV::now |
198 | =item $time = EV::now |
193 | |
199 | |
194 | =item $time = $loop->now |
200 | =item $time = $loop->now |
195 | |
201 | |
196 | Returns the time the last event loop iteration has been started. This |
202 | 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 |
203 | is the time that (relative) timers are based on, and referring to it is |
198 | usually faster then calling EV::time. |
204 | usually faster then calling EV::time. |
199 | |
205 | |
|
|
206 | =item EV::now_update |
|
|
207 | |
|
|
208 | =item $loop->now_update |
|
|
209 | |
|
|
210 | Establishes the current time by querying the kernel, updating the time |
|
|
211 | returned by C<EV::now> in the progress. This is a costly operation and |
|
|
212 | is usually done automatically within C<EV::loop>. |
|
|
213 | |
|
|
214 | This function is rarely useful, but when some event callback runs for a |
|
|
215 | very long time without entering the event loop, updating libev's idea of |
|
|
216 | the current time is a good idea. |
|
|
217 | |
|
|
218 | =item EV::suspend |
|
|
219 | |
|
|
220 | =item $loop->suspend |
|
|
221 | |
|
|
222 | =item EV::resume |
|
|
223 | |
|
|
224 | =item $loop->resume |
|
|
225 | |
|
|
226 | These two functions suspend and resume a loop, for use when the loop is |
|
|
227 | not used for a while and timeouts should not be processed. |
|
|
228 | |
|
|
229 | A typical use case would be an interactive program such as a game: When |
|
|
230 | the user presses C<^Z> to suspend the game and resumes it an hour later it |
|
|
231 | would be best to handle timeouts as if no time had actually passed while |
|
|
232 | the program was suspended. This can be achieved by calling C<suspend> |
|
|
233 | in your C<SIGTSTP> handler, sending yourself a C<SIGSTOP> and calling |
|
|
234 | C<resume> directly afterwards to resume timer processing. |
|
|
235 | |
|
|
236 | Effectively, all C<timer> watchers will be delayed by the time spend |
|
|
237 | between C<suspend> and C<resume>, and all C<periodic> watchers |
|
|
238 | will be rescheduled (that is, they will lose any events that would have |
|
|
239 | occured while suspended). |
|
|
240 | |
|
|
241 | After calling C<suspend> you B<must not> call I<any> function on the given |
|
|
242 | loop other than C<resume>, and you B<must not> call C<resume> |
|
|
243 | without a previous call to C<suspend>. |
|
|
244 | |
|
|
245 | Calling C<suspend>/C<resume> has the side effect of updating the event |
|
|
246 | loop time (see C<now_update>). |
|
|
247 | |
200 | =item $backend = EV::backend |
248 | =item $backend = EV::backend |
201 | |
249 | |
202 | =item $backend = $loop->backend |
250 | =item $backend = $loop->backend |
203 | |
251 | |
204 | Returns an integer describing the backend used by libev (EV::METHOD_SELECT |
252 | Returns an integer describing the backend used by libev (EV::BACKEND_SELECT |
205 | or EV::METHOD_EPOLL). |
253 | or EV::BACKEND_EPOLL). |
206 | |
254 | |
207 | =item EV::loop [$flags] |
255 | =item EV::loop [$flags] |
208 | |
256 | |
209 | =item $loop->loop ([$flags]) |
257 | =item $loop->loop ([$flags]) |
210 | |
258 | |
… | |
… | |
230 | =item $count = EV::loop_count |
278 | =item $count = EV::loop_count |
231 | |
279 | |
232 | =item $count = $loop->loop_count |
280 | =item $count = $loop->loop_count |
233 | |
281 | |
234 | Return the number of times the event loop has polled for new |
282 | Return the number of times the event loop has polled for new |
235 | events. Sometiems useful as a generation counter. |
283 | events. Sometimes useful as a generation counter. |
236 | |
284 | |
237 | =item EV::once $fh_or_undef, $events, $timeout, $cb->($revents) |
285 | =item EV::once $fh_or_undef, $events, $timeout, $cb->($revents) |
238 | |
286 | |
239 | =item $loop->once ($fh_or_undef, $events, $timeout, $cb->($revents)) |
287 | =item $loop->once ($fh_or_undef, $events, $timeout, $cb->($revents)) |
240 | |
288 | |
… | |
… | |
280 | |
328 | |
281 | =item $loop->set_timeout_collect_interval ($time) |
329 | =item $loop->set_timeout_collect_interval ($time) |
282 | |
330 | |
283 | These advanced functions set the minimum block interval when polling for I/O events and the minimum |
331 | 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 |
332 | 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 |
333 | L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#FUNCTIONS_CONTROLLING_THE_EVENT_LOOP> |
286 | a more detailed discussion. |
334 | (locally installed as F<EV::libev>) for a more detailed discussion. |
|
|
335 | |
|
|
336 | =item $count = EV::pending_count |
|
|
337 | |
|
|
338 | =item $count = $loop->pending_count |
|
|
339 | |
|
|
340 | Returns the number of currently pending watchers. |
|
|
341 | |
|
|
342 | =item EV::invoke_pending |
|
|
343 | |
|
|
344 | =item $loop->invoke_pending |
|
|
345 | |
|
|
346 | Invoke all currently pending watchers. |
287 | |
347 | |
288 | =back |
348 | =back |
289 | |
349 | |
290 | |
350 | |
291 | =head1 WATCHER OBJECTS |
351 | =head1 WATCHER OBJECTS |
… | |
… | |
304 | called with at least two arguments: the watcher and a bitmask of received |
364 | called with at least two arguments: the watcher and a bitmask of received |
305 | events. |
365 | events. |
306 | |
366 | |
307 | Each watcher type has its associated bit in revents, so you can use the |
367 | 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 |
368 | 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, |
369 | 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 |
370 | 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 |
371 | (which can set both EV::READ and EV::WRITE bits), and EV::timer (which |
312 | uses EV::TIMEOUT). |
372 | uses EV::TIMEOUT). |
313 | |
373 | |
314 | In the rare case where one wants to create a watcher but not start it at |
374 | In the rare case where one wants to create a watcher but not start it at |
… | |
… | |
410 | because you happen to have this long-running UDP port watcher. |
470 | because you happen to have this long-running UDP port watcher. |
411 | |
471 | |
412 | In this case you can clear the keepalive status, which means that even |
472 | 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. |
473 | though your watcher is active, it won't keep C<EV::loop> from returning. |
414 | |
474 | |
415 | The initial value for keepalive is true (enabled), and you cna change it |
475 | The initial value for keepalive is true (enabled), and you can change it |
416 | any time. |
476 | any time. |
417 | |
477 | |
418 | Example: Register an I/O watcher for some UDP socket but do not keep the |
478 | 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. |
479 | event loop from running just because of that watcher. |
420 | |
480 | |
… | |
… | |
914 | # make the dispatcher handle any new stuff |
974 | # make the dispatcher handle any new stuff |
915 | ... not shown |
975 | ... not shown |
916 | }; |
976 | }; |
917 | |
977 | |
918 | The callbacks of the created watchers will not be called as the watchers |
978 | 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 |
979 | are destroyed before this can happen (remember EV::check gets called |
920 | first). |
980 | first). |
921 | |
981 | |
922 | The C<check_ns> variant doesn't start (activate) the newly created watcher. |
982 | The C<check_ns> variant doesn't start (activate) the newly created watcher. |
923 | |
983 | |
924 | =back |
984 | =back |
… | |
… | |
955 | loop, other types of watchers might be handled in a delayed or incorrect |
1015 | loop, other types of watchers might be handled in a delayed or incorrect |
956 | fashion and must not be used). |
1016 | fashion and must not be used). |
957 | |
1017 | |
958 | See the libev documentation at |
1018 | 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_> |
1019 | L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#code_ev_embed_code_when_one_backend_> |
960 | for more details. |
1020 | (locally installed as F<EV::libev>) for more details. |
961 | |
1021 | |
962 | In short, this watcher is most useful on BSD systems without working |
1022 | 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: |
1023 | kqueue to still be able to handle a large number of sockets: |
964 | |
1024 | |
965 | my $socket_loop; |
1025 | my $socket_loop; |
… | |
… | |
995 | |
1055 | |
996 | =back |
1056 | =back |
997 | |
1057 | |
998 | =head3 ASYNC WATCHERS - how to wake up another event loop |
1058 | =head3 ASYNC WATCHERS - how to wake up another event loop |
999 | |
1059 | |
1000 | Async watchers are provided by EV, but have little use in perl directly, as perl |
1060 | 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 |
1061 | as perl neither supports threads running in parallel nor direct access to |
1002 | contexts where they could be of value. |
1062 | signal handlers or other contexts where they could be of value. |
1003 | |
1063 | |
1004 | It is, however, possible to use them from the XS level. |
1064 | It is, however, possible to use them from the XS level. |
1005 | |
1065 | |
1006 | Please see the libev documentation for further details. |
1066 | Please see the libev documentation for further details. |
1007 | |
1067 | |
… | |
… | |
1035 | my $async_check = EV::check sub { }; |
1095 | my $async_check = EV::check sub { }; |
1036 | |
1096 | |
1037 | This ensures that perl gets into control for a short time to handle any |
1097 | This ensures that perl gets into control for a short time to handle any |
1038 | pending signals, and also ensures (slightly) slower overall operation. |
1098 | pending signals, and also ensures (slightly) slower overall operation. |
1039 | |
1099 | |
1040 | =head1 THREADS |
1100 | =head1 ITHREADS |
1041 | |
1101 | |
1042 | Threads are not supported by this module in any way. Perl pseudo-threads |
1102 | 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 |
1103 | is evil stuff and must die. Real threads as provided by Coro are fully |
1044 | on thread support for it. |
1104 | supported (and enhanced support is available via L<Coro::EV>). |
1045 | |
1105 | |
1046 | =head1 FORK |
1106 | =head1 FORK |
1047 | |
1107 | |
1048 | Most of the "improved" event delivering mechanisms of modern operating |
1108 | 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 |
1109 | systems have quite a few problems with fork(2) (to put it bluntly: it is |