… | |
… | |
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 | no warnings; |
77 | use strict; |
82 | use strict; |
78 | |
83 | |
79 | BEGIN { |
84 | BEGIN { |
80 | our $VERSION = '3.431'; |
85 | our $VERSION = '3.53'; |
81 | use XSLoader; |
86 | use XSLoader; |
82 | XSLoader::load "EV", $VERSION; |
87 | XSLoader::load "EV", $VERSION; |
83 | } |
88 | } |
84 | |
89 | |
85 | @EV::IO::ISA = |
90 | @EV::IO::ISA = |
… | |
… | |
112 | default loop as this is fastest (perl-wise), best supported by other |
117 | default loop as this is fastest (perl-wise), best supported by other |
113 | modules (e.g. AnyEvent or Coro) and most portable event loop. |
118 | modules (e.g. AnyEvent or Coro) and most portable event loop. |
114 | |
119 | |
115 | For specific programs you can create additional event loops dynamically. |
120 | For specific programs you can create additional event loops dynamically. |
116 | |
121 | |
117 | If you want to take avdantage of kqueue (which often works properly for |
122 | 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 |
123 | 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 |
124 | 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 |
125 | 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. |
126 | the section about embed watchers for an example on how to achieve that. |
122 | |
127 | |
123 | =over 4 |
128 | =over 4 |
124 | |
129 | |
125 | =item $loop = new EV::loop [$flags] |
130 | =item $loop = new EV::loop [$flags] |
126 | |
131 | |
127 | Create a new event loop as per the specified flags. Please refer to the |
132 | Create a new event loop as per the specified flags. Please refer to |
128 | C<ev_loop_new ()> function description in the libev documentation |
133 | 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>) |
134 | (L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#GLOBAL_FUNCTIONS>, |
130 | for more info. |
135 | or locally-installed as F<EV::libev> manpage) for more info. |
131 | |
136 | |
132 | The loop will automatically be destroyed when it is no longer referenced |
137 | The loop will automatically be destroyed when it is no longer referenced |
133 | by any watcher and the loop object goes out of scope. |
138 | by any watcher and the loop object goes out of scope. |
134 | |
139 | |
135 | Using C<EV::FLAG_FORKCHECK> is recommended, as only the default event loop |
140 | If you are not embedding the loop, then Using C<EV::FLAG_FORKCHECK> |
136 | is protected by this module. |
141 | is recommended, as only the default event loop is protected by this |
|
|
142 | module. If you I<are> embedding this loop in the default loop, this is not |
|
|
143 | necessary, as C<EV::embed> automatically does the right thing on fork. |
137 | |
144 | |
138 | =item $loop->loop_fork |
145 | =item $loop->loop_fork |
139 | |
146 | |
140 | Must be called after a fork in the child, before entering or continuing |
147 | 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 |
148 | the event loop. An alternative is to use C<EV::FLAG_FORKCHECK> which calls |
… | |
… | |
192 | =item $time = EV::now |
199 | =item $time = EV::now |
193 | |
200 | |
194 | =item $time = $loop->now |
201 | =item $time = $loop->now |
195 | |
202 | |
196 | Returns the time the last event loop iteration has been started. This |
203 | 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 |
204 | is the time that (relative) timers are based on, and referring to it is |
198 | usually faster then calling EV::time. |
205 | usually faster then calling EV::time. |
199 | |
206 | |
200 | =item $backend = EV::backend |
207 | =item $backend = EV::backend |
201 | |
208 | |
202 | =item $backend = $loop->backend |
209 | =item $backend = $loop->backend |
203 | |
210 | |
204 | Returns an integer describing the backend used by libev (EV::METHOD_SELECT |
211 | Returns an integer describing the backend used by libev (EV::BACKEND_SELECT |
205 | or EV::METHOD_EPOLL). |
212 | or EV::BACKEND_EPOLL). |
206 | |
213 | |
207 | =item EV::loop [$flags] |
214 | =item EV::loop [$flags] |
208 | |
215 | |
209 | =item $loop->loop ([$flags]) |
216 | =item $loop->loop ([$flags]) |
210 | |
217 | |
… | |
… | |
230 | =item $count = EV::loop_count |
237 | =item $count = EV::loop_count |
231 | |
238 | |
232 | =item $count = $loop->loop_count |
239 | =item $count = $loop->loop_count |
233 | |
240 | |
234 | Return the number of times the event loop has polled for new |
241 | Return the number of times the event loop has polled for new |
235 | events. Sometiems useful as a generation counter. |
242 | events. Sometimes useful as a generation counter. |
236 | |
243 | |
237 | =item EV::once $fh_or_undef, $events, $timeout, $cb->($revents) |
244 | =item EV::once $fh_or_undef, $events, $timeout, $cb->($revents) |
238 | |
245 | |
239 | =item $loop->once ($fh_or_undef, $events, $timeout, $cb->($revents)) |
246 | =item $loop->once ($fh_or_undef, $events, $timeout, $cb->($revents)) |
240 | |
247 | |
… | |
… | |
280 | |
287 | |
281 | =item $loop->set_timeout_collect_interval ($time) |
288 | =item $loop->set_timeout_collect_interval ($time) |
282 | |
289 | |
283 | These advanced functions set the minimum block interval when polling for I/O events and the minimum |
290 | 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 |
291 | 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 |
292 | L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#FUNCTIONS_CONTROLLING_THE_EVENT_LOOP> |
286 | a more detailed discussion. |
293 | (locally installed as F<EV::libev>) for a more detailed discussion. |
287 | |
294 | |
288 | =back |
295 | =back |
289 | |
296 | |
290 | |
297 | |
291 | =head1 WATCHER OBJECTS |
298 | =head1 WATCHER OBJECTS |
… | |
… | |
304 | called with at least two arguments: the watcher and a bitmask of received |
311 | called with at least two arguments: the watcher and a bitmask of received |
305 | events. |
312 | events. |
306 | |
313 | |
307 | Each watcher type has its associated bit in revents, so you can use the |
314 | 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 |
315 | 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, |
316 | 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 |
317 | 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 |
318 | (which can set both EV::READ and EV::WRITE bits), and EV::timer (which |
312 | uses EV::TIMEOUT). |
319 | uses EV::TIMEOUT). |
313 | |
320 | |
314 | In the rare case where one wants to create a watcher but not start it at |
321 | 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. |
417 | because you happen to have this long-running UDP port watcher. |
411 | |
418 | |
412 | In this case you can clear the keepalive status, which means that even |
419 | 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. |
420 | though your watcher is active, it won't keep C<EV::loop> from returning. |
414 | |
421 | |
415 | The initial value for keepalive is true (enabled), and you cna change it |
422 | The initial value for keepalive is true (enabled), and you can change it |
416 | any time. |
423 | any time. |
417 | |
424 | |
418 | Example: Register an I/O watcher for some UDP socket but do not keep the |
425 | 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. |
426 | event loop from running just because of that watcher. |
420 | |
427 | |
… | |
… | |
914 | # make the dispatcher handle any new stuff |
921 | # make the dispatcher handle any new stuff |
915 | ... not shown |
922 | ... not shown |
916 | }; |
923 | }; |
917 | |
924 | |
918 | The callbacks of the created watchers will not be called as the watchers |
925 | 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 |
926 | are destroyed before this can happen (remember EV::check gets called |
920 | first). |
927 | first). |
921 | |
928 | |
922 | The C<check_ns> variant doesn't start (activate) the newly created watcher. |
929 | The C<check_ns> variant doesn't start (activate) the newly created watcher. |
923 | |
930 | |
924 | =back |
931 | =back |
… | |
… | |
955 | loop, other types of watchers might be handled in a delayed or incorrect |
962 | loop, other types of watchers might be handled in a delayed or incorrect |
956 | fashion and must not be used). |
963 | fashion and must not be used). |
957 | |
964 | |
958 | See the libev documentation at |
965 | 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_> |
966 | L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#code_ev_embed_code_when_one_backend_> |
960 | for more details. |
967 | (locally installed as F<EV::libev>) for more details. |
961 | |
968 | |
962 | In short, this watcher is most useful on BSD systems without working |
969 | 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: |
970 | kqueue to still be able to handle a large number of sockets: |
964 | |
971 | |
965 | my $socket_loop; |
972 | my $socket_loop; |