ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/EV/EV.pm
(Generate patch)

Comparing EV/EV.pm (file contents):
Revision 1.98 by root, Sat May 31 23:17:50 2008 UTC vs.
Revision 1.112 by root, Sun Feb 15 01:44:40 2009 UTC

… …
55 55
56=head1 DESCRIPTION 56=head1 DESCRIPTION
57 57
58This module provides an interface to libev 58This 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
60below is comprehensive, one might also consult the documentation of libev 60below is comprehensive, one might also consult the documentation of
61itself (L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod>) for more 61libev itself (L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod> or
62subtle details on watcher semantics or some discussion on the available 62F<perldoc EV::libev>) for more subtle details on watcher semantics or some
63backends, or how to force a specific backend with C<LIBEV_FLAGS>, or just 63discussion on the available backends, or how to force a specific backend
64about in any case because it has much more detailed information. 64with C<LIBEV_FLAGS>, or just about in any case because it has much more
65detailed information.
65 66
66This module is very fast and scalable. It is actually so fast that you 67This module is very fast and scalable. It is actually so fast that you
67can use it through the L<AnyEvent> module, stay portable to other event 68can use it through the L<AnyEvent> module, stay portable to other event
68loops (if you don't rely on any watcher types not available through it) 69loops (if you don't rely on any watcher types not available through it)
69and still be faster than with any other event loop currently supported in 70and still be faster than with any other event loop currently supported in
70Perl. 71Perl.
71 72
73=head2 MODULE EXPORTS
74
75This module does not export any symbols.
76
72=cut 77=cut
73 78
74package EV; 79package EV;
75 80
81no warnings;
76use strict; 82use strict;
77 83
78BEGIN { 84BEGIN {
79 our $VERSION = '3.42'; 85 our $VERSION = '3.53';
80 use XSLoader; 86 use XSLoader;
81 XSLoader::load "EV", $VERSION; 87 XSLoader::load "EV", $VERSION;
82} 88}
83 89
84@EV::IO::ISA = 90@EV::IO::ISA =
… …
111default loop as this is fastest (perl-wise), best supported by other 117default loop as this is fastest (perl-wise), best supported by other
112modules (e.g. AnyEvent or Coro) and most portable event loop. 118modules (e.g. AnyEvent or Coro) and most portable event loop.
113 119
114For specific programs you can create additional event loops dynamically. 120For specific programs you can create additional event loops dynamically.
115 121
122If you want to take advantage of kqueue (which often works properly for
123sockets only) even though the default loop doesn't enable it, you can
124I<embed> a kqueue loop into the default loop: running the default loop
125will then also service the kqueue loop to some extent. See the example in
126the section about embed watchers for an example on how to achieve that.
127
116=over 4 128=over 4
117 129
118=item $loop = new EV::loop [$flags] 130=item $loop = new EV::loop [$flags]
119 131
120Create a new event loop as per the specified flags. Please refer to the 132Create a new event loop as per the specified flags. Please refer to
121C<ev_loop_new ()> function description in the libev documentation 133the 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>) 134(L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#GLOBAL_FUNCTIONS>,
123for more info. 135or locally-installed as F<EV::libev> manpage) for more info.
124 136
125The loop will automatically be destroyed when it is no longer referenced 137The loop will automatically be destroyed when it is no longer referenced
126by any watcher and the loop object goes out of scope. 138by any watcher and the loop object goes out of scope.
127 139
128Using C<EV::FLAG_FORKCHECK> is recommended, as only the default event loop 140If you are not embedding the loop, then Using C<EV::FLAG_FORKCHECK>
129is protected by this module. 141is recommended, as only the default event loop is protected by this
142module. If you I<are> embedding this loop in the default loop, this is not
143necessary, as C<EV::embed> automatically does the right thing on fork.
130 144
131=item $loop->loop_fork 145=item $loop->loop_fork
132 146
133Must be called after a fork in the child, before entering or continuing 147Must be called after a fork in the child, before entering or continuing
134the event loop. An alternative is to use C<EV::FLAG_FORKCHECK> which calls 148the event loop. An alternative is to use C<EV::FLAG_FORKCHECK> which calls
… …
136documentation). 150documentation).
137 151
138=item $loop->loop_verify 152=item $loop->loop_verify
139 153
140Calls C<ev_verify> to make internal consistency checks (for debugging 154Calls C<ev_verify> to make internal consistency checks (for debugging
141libev) and abort the program if any data structures wree found to be 155libev) and abort the program if any data structures were found to be
142corrupted. 156corrupted.
143 157
144=item $loop = EV::default_loop [$flags] 158=item $loop = EV::default_loop [$flags]
145 159
146Return the default loop (which is a singleton object). Since this module 160Return the default loop (which is a singleton object). Since this module
147already creates the default loop with default flags, specifying flags here 161already creates the default loop with default flags, specifying flags here
148will not have any effect unless you destroy the default loop. 162will not have any effect unless you destroy the default loop first, which
163isn't supported. So in short: don't do it, and if you break it, you get to
164keep the pieces.
149 165
150=back 166=back
151 167
152 168
153=head1 BASIC INTERFACE 169=head1 BASIC INTERFACE
… …
183=item $time = EV::now 199=item $time = EV::now
184 200
185=item $time = $loop->now 201=item $time = $loop->now
186 202
187Returns the time the last event loop iteration has been started. This 203Returns the time the last event loop iteration has been started. This
188is the time that (relative) timers are based on, and refering to it is 204is the time that (relative) timers are based on, and referring to it is
189usually faster then calling EV::time. 205usually faster then calling EV::time.
190 206
191=item $backend = EV::backend 207=item $backend = EV::backend
192 208
193=item $backend = $loop->backend 209=item $backend = $loop->backend
194 210
195Returns an integer describing the backend used by libev (EV::METHOD_SELECT 211Returns an integer describing the backend used by libev (EV::BACKEND_SELECT
196or EV::METHOD_EPOLL). 212or EV::BACKEND_EPOLL).
197 213
198=item EV::loop [$flags] 214=item EV::loop [$flags]
199 215
200=item $loop->loop ([$flags]) 216=item $loop->loop ([$flags])
201 217
… …
221=item $count = EV::loop_count 237=item $count = EV::loop_count
222 238
223=item $count = $loop->loop_count 239=item $count = $loop->loop_count
224 240
225Return the number of times the event loop has polled for new 241Return the number of times the event loop has polled for new
226events. Sometiems useful as a generation counter. 242events. Sometimes useful as a generation counter.
227 243
228=item EV::once $fh_or_undef, $events, $timeout, $cb->($revents) 244=item EV::once $fh_or_undef, $events, $timeout, $cb->($revents)
229 245
230=item $loop->once ($fh_or_undef, $events, $timeout, $cb->($revents)) 246=item $loop->once ($fh_or_undef, $events, $timeout, $cb->($revents))
231 247
… …
271 287
272=item $loop->set_timeout_collect_interval ($time) 288=item $loop->set_timeout_collect_interval ($time)
273 289
274These advanced functions set the minimum block interval when polling for I/O events and the minimum 290These advanced functions set the minimum block interval when polling for I/O events and the minimum
275wait interval for timer events. See the libev documentation at 291wait interval for timer events. See the libev documentation at
276L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#FUNCTIONS_CONTROLLING_THE_EVENT_LOOP> for 292L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#FUNCTIONS_CONTROLLING_THE_EVENT_LOOP>
277a more detailed discussion. 293(locally installed as F<EV::libev>) for a more detailed discussion.
278 294
279=back 295=back
280 296
281 297
282=head1 WATCHER OBJECTS 298=head1 WATCHER OBJECTS
… …
295called with at least two arguments: the watcher and a bitmask of received 311called with at least two arguments: the watcher and a bitmask of received
296events. 312events.
297 313
298Each watcher type has its associated bit in revents, so you can use the 314Each watcher type has its associated bit in revents, so you can use the
299same callback for multiple watchers. The event mask is named after the 315same callback for multiple watchers. The event mask is named after the
300type, i..e. EV::child sets EV::CHILD, EV::prepare sets EV::PREPARE, 316type, i.e. EV::child sets EV::CHILD, EV::prepare sets EV::PREPARE,
301EV::periodic sets EV::PERIODIC and so on, with the exception of I/O events 317EV::periodic sets EV::PERIODIC and so on, with the exception of I/O events
302(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
303uses EV::TIMEOUT). 319uses EV::TIMEOUT).
304 320
305In the rare case where one wants to create a watcher but not start it at 321In the rare case where one wants to create a watcher but not start it at
… …
401because you happen to have this long-running UDP port watcher. 417because you happen to have this long-running UDP port watcher.
402 418
403In this case you can clear the keepalive status, which means that even 419In this case you can clear the keepalive status, which means that even
404though your watcher is active, it won't keep C<EV::loop> from returning. 420though your watcher is active, it won't keep C<EV::loop> from returning.
405 421
406The initial value for keepalive is true (enabled), and you cna change it 422The initial value for keepalive is true (enabled), and you can change it
407any time. 423any time.
408 424
409Example: Register an I/O watcher for some UDP socket but do not keep the 425Example: Register an I/O watcher for some UDP socket but do not keep the
410event loop from running just because of that watcher. 426event loop from running just because of that watcher.
411 427
… …
905 # make the dispatcher handle any new stuff 921 # make the dispatcher handle any new stuff
906 ... not shown 922 ... not shown
907 }; 923 };
908 924
909The callbacks of the created watchers will not be called as the watchers 925The callbacks of the created watchers will not be called as the watchers
910are destroyed before this cna happen (remember EV::check gets called 926are destroyed before this can happen (remember EV::check gets called
911first). 927first).
912 928
913The C<check_ns> variant doesn't start (activate) the newly created watcher. 929The C<check_ns> variant doesn't start (activate) the newly created watcher.
914 930
915=back 931=back
… …
946loop, other types of watchers might be handled in a delayed or incorrect 962loop, other types of watchers might be handled in a delayed or incorrect
947fashion and must not be used). 963fashion and must not be used).
948 964
949See the libev documentation at 965See the libev documentation at
950L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#code_ev_embed_code_when_one_backend_> 966L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#code_ev_embed_code_when_one_backend_>
951for more details. 967(locally installed as F<EV::libev>) for more details.
952 968
953In short, this watcher is most useful on BSD systems without working 969In short, this watcher is most useful on BSD systems without working
954kqueue to still be able to handle a large number of sockets: 970kqueue to still be able to handle a large number of sockets:
955 971
956 my $socket_loop; 972 my $socket_loop;
… …
967 # use the default loop otherwise 983 # use the default loop otherwise
968 $socket_loop ||= EV::default_loop; 984 $socket_loop ||= EV::default_loop;
969 985
970=over 4 986=over 4
971 987
972=item $w = EV::embed $otherloop, $callback 988=item $w = EV::embed $otherloop[, $callback]
973 989
974=item $w = EV::embed_ns $otherloop, $callback 990=item $w = EV::embed_ns $otherloop[, $callback]
975 991
976=item $w = $loop->embed ($otherloop, $callback) 992=item $w = $loop->embed ($otherloop[, $callback])
977 993
978=item $w = $loop->embed_ns ($otherloop, $callback) 994=item $w = $loop->embed_ns ($otherloop[, $callback])
979 995
980Call the callback when the embedded event loop (C<$otherloop>) has any 996Call the callback when the embedded event loop (C<$otherloop>) has any
981I/O activity. The C<$callback> should alwas be specified as C<undef> in 997I/O activity. The C<$callback> is optional: if it is missing, then the
982this version of EV, which means the embedded event loop will be managed 998embedded event loop will be managed automatically (which is recommended),
983automatically. 999otherwise you have to invoke C<sweep> yourself.
984 1000
985The C<embed_ns> variant doesn't start (activate) the newly created watcher. 1001The C<embed_ns> variant doesn't start (activate) the newly created watcher.
986 1002
987=back 1003=back
988 1004

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines