… | |
… | |
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::c_doc>) 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 |
… | |
… | |
71 | |
72 | |
72 | =cut |
73 | =cut |
73 | |
74 | |
74 | package EV; |
75 | package EV; |
75 | |
76 | |
|
|
77 | no warnings; |
76 | use strict; |
78 | use strict; |
77 | |
79 | |
78 | BEGIN { |
80 | BEGIN { |
79 | our $VERSION = '3.42'; |
81 | our $VERSION = '3.44'; |
80 | use XSLoader; |
82 | use XSLoader; |
81 | XSLoader::load "EV", $VERSION; |
83 | XSLoader::load "EV", $VERSION; |
82 | } |
84 | } |
83 | |
85 | |
84 | @EV::IO::ISA = |
86 | @EV::IO::ISA = |
… | |
… | |
111 | default loop as this is fastest (perl-wise), best supported by other |
113 | default loop as this is fastest (perl-wise), best supported by other |
112 | modules (e.g. AnyEvent or Coro) and most portable event loop. |
114 | modules (e.g. AnyEvent or Coro) and most portable event loop. |
113 | |
115 | |
114 | For specific programs you can create additional event loops dynamically. |
116 | For specific programs you can create additional event loops dynamically. |
115 | |
117 | |
|
|
118 | If you want to take avdantage of kqueue (which often works properly for |
|
|
119 | sockets only) even though the default loop doesn't enable it, you can |
|
|
120 | I<embed> a kqueue loop into the default loop: running the default loop |
|
|
121 | will then also service the kqueue loop to some extent. See the example in |
|
|
122 | the section about embed watchers for an example on how to achieve that. |
|
|
123 | |
116 | =over 4 |
124 | =over 4 |
117 | |
125 | |
118 | =item $loop = new EV::loop [$flags] |
126 | =item $loop = new EV::loop [$flags] |
119 | |
127 | |
120 | Create a new event loop as per the specified flags. Please refer to the |
128 | Create a new event loop as per the specified flags. Please refer to |
121 | C<ev_loop_new ()> function description in the libev documentation |
129 | the C<ev_loop_new ()> function description in the libev documentation |
122 | (L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#GLOBAL_FUNCTIONS>) |
130 | (L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#GLOBAL_FUNCTIONS>, |
123 | for more info. |
131 | or locally-installed as F<EV::c_doc> manpage) for more info. |
124 | |
132 | |
125 | The loop will automatically be destroyed when it is no longer referenced |
133 | The loop will automatically be destroyed when it is no longer referenced |
126 | by any watcher and the loop object goes out of scope. |
134 | by any watcher and the loop object goes out of scope. |
127 | |
135 | |
128 | Using C<EV::FLAG_FORKCHECK> is recommended, as only the default event loop |
136 | If you are not embedding the loop, then Using C<EV::FLAG_FORKCHECK> |
129 | is protected by this module. |
137 | is recommended, as only the default event loop is protected by this |
|
|
138 | module. If you I<are> embedding this loop in the default loop, this is not |
|
|
139 | necessary, as C<EV::embed> automatically does the right thing on fork. |
130 | |
140 | |
131 | =item $loop->loop_fork |
141 | =item $loop->loop_fork |
132 | |
142 | |
133 | Must be called after a fork in the child, before entering or continuing |
143 | Must be called after a fork in the child, before entering or continuing |
134 | the event loop. An alternative is to use C<EV::FLAG_FORKCHECK> which calls |
144 | the event loop. An alternative is to use C<EV::FLAG_FORKCHECK> which calls |
… | |
… | |
136 | documentation). |
146 | documentation). |
137 | |
147 | |
138 | =item $loop->loop_verify |
148 | =item $loop->loop_verify |
139 | |
149 | |
140 | Calls C<ev_verify> to make internal consistency checks (for debugging |
150 | Calls C<ev_verify> to make internal consistency checks (for debugging |
141 | libev) and abort the program if any data structures wree found to be |
151 | libev) and abort the program if any data structures were found to be |
142 | corrupted. |
152 | corrupted. |
143 | |
153 | |
144 | =item $loop = EV::default_loop [$flags] |
154 | =item $loop = EV::default_loop [$flags] |
145 | |
155 | |
146 | Return the default loop (which is a singleton object). Since this module |
156 | Return the default loop (which is a singleton object). Since this module |
147 | already creates the default loop with default flags, specifying flags here |
157 | already creates the default loop with default flags, specifying flags here |
148 | will not have any effect unless you destroy the default loop. |
158 | will not have any effect unless you destroy the default loop first, which |
|
|
159 | isn't supported. So in short: don't do it, and if you break it, you get to |
|
|
160 | keep the pieces. |
149 | |
161 | |
150 | =back |
162 | =back |
151 | |
163 | |
152 | |
164 | |
153 | =head1 BASIC INTERFACE |
165 | =head1 BASIC INTERFACE |
… | |
… | |
271 | |
283 | |
272 | =item $loop->set_timeout_collect_interval ($time) |
284 | =item $loop->set_timeout_collect_interval ($time) |
273 | |
285 | |
274 | These advanced functions set the minimum block interval when polling for I/O events and the minimum |
286 | These advanced functions set the minimum block interval when polling for I/O events and the minimum |
275 | wait interval for timer events. See the libev documentation at |
287 | wait interval for timer events. See the libev documentation at |
276 | L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#FUNCTIONS_CONTROLLING_THE_EVENT_LOOP> for |
288 | L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#FUNCTIONS_CONTROLLING_THE_EVENT_LOOP> |
277 | a more detailed discussion. |
289 | (locally installed as F<EV::c_doc>) for a more detailed discussion. |
278 | |
290 | |
279 | =back |
291 | =back |
280 | |
292 | |
281 | |
293 | |
282 | =head1 WATCHER OBJECTS |
294 | =head1 WATCHER OBJECTS |
… | |
… | |
946 | loop, other types of watchers might be handled in a delayed or incorrect |
958 | loop, other types of watchers might be handled in a delayed or incorrect |
947 | fashion and must not be used). |
959 | fashion and must not be used). |
948 | |
960 | |
949 | See the libev documentation at |
961 | See the libev documentation at |
950 | L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#code_ev_embed_code_when_one_backend_> |
962 | L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#code_ev_embed_code_when_one_backend_> |
951 | for more details. |
963 | (locally installed as F<EV::c_doc>) for more details. |
952 | |
964 | |
953 | In short, this watcher is most useful on BSD systems without working |
965 | In short, this watcher is most useful on BSD systems without working |
954 | kqueue to still be able to handle a large number of sockets: |
966 | kqueue to still be able to handle a large number of sockets: |
955 | |
967 | |
956 | my $socket_loop; |
968 | my $socket_loop; |
… | |
… | |
967 | # use the default loop otherwise |
979 | # use the default loop otherwise |
968 | $socket_loop ||= EV::default_loop; |
980 | $socket_loop ||= EV::default_loop; |
969 | |
981 | |
970 | =over 4 |
982 | =over 4 |
971 | |
983 | |
972 | =item $w = EV::embed $otherloop, $callback |
984 | =item $w = EV::embed $otherloop[, $callback] |
973 | |
985 | |
974 | =item $w = EV::embed_ns $otherloop, $callback |
986 | =item $w = EV::embed_ns $otherloop[, $callback] |
975 | |
987 | |
976 | =item $w = $loop->embed ($otherloop, $callback) |
988 | =item $w = $loop->embed ($otherloop[, $callback]) |
977 | |
989 | |
978 | =item $w = $loop->embed_ns ($otherloop, $callback) |
990 | =item $w = $loop->embed_ns ($otherloop[, $callback]) |
979 | |
991 | |
980 | Call the callback when the embedded event loop (C<$otherloop>) has any |
992 | Call the callback when the embedded event loop (C<$otherloop>) has any |
981 | I/O activity. The C<$callback> should alwas be specified as C<undef> in |
993 | I/O activity. The C<$callback> is optional: if it is missing, then the |
982 | this version of EV, which means the embedded event loop will be managed |
994 | embedded event loop will be managed automatically (which is recommended), |
983 | automatically. |
995 | otherwise you have to invoke C<sweep> yourself. |
984 | |
996 | |
985 | The C<embed_ns> variant doesn't start (activate) the newly created watcher. |
997 | The C<embed_ns> variant doesn't start (activate) the newly created watcher. |
986 | |
998 | |
987 | =back |
999 | =back |
988 | |
1000 | |