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

Comparing EV/EV.pm (file contents):
Revision 1.103 by root, Thu Oct 2 07:49:09 2008 UTC vs.
Revision 1.108 by root, Mon Nov 3 12:13:15 2008 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
76no warnings; 81no warnings;
77use strict; 82use strict;
78 83
79BEGIN { 84BEGIN {
80 our $VERSION = '3.44'; 85 our $VERSION = '3.48';
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 =
… …
112default loop as this is fastest (perl-wise), best supported by other 117default loop as this is fastest (perl-wise), best supported by other
113modules (e.g. AnyEvent or Coro) and most portable event loop. 118modules (e.g. AnyEvent or Coro) and most portable event loop.
114 119
115For specific programs you can create additional event loops dynamically. 120For specific programs you can create additional event loops dynamically.
116 121
117If you want to take avdantage of kqueue (which often works properly for 122If you want to take advantage of kqueue (which often works properly for
118sockets only) even though the default loop doesn't enable it, you can 123sockets only) even though the default loop doesn't enable it, you can
119I<embed> a kqueue loop into the default loop: running the default loop 124I<embed> a kqueue loop into the default loop: running the default loop
120will then also service the kqueue loop to some extent. See the example in 125will then also service the kqueue loop to some extent. See the example in
121the section about embed watchers for an example on how to achieve that. 126the 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
127Create 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
128C<ev_loop_new ()> function description in the libev documentation 133the 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>,
130for more info. 135or locally-installed as F<EV::libev> manpage) for more info.
131 136
132The loop will automatically be destroyed when it is no longer referenced 137The loop will automatically be destroyed when it is no longer referenced
133by any watcher and the loop object goes out of scope. 138by any watcher and the loop object goes out of scope.
134 139
135If you are not embedding the loop, then Using C<EV::FLAG_FORKCHECK> 140If you are not embedding the loop, then Using C<EV::FLAG_FORKCHECK>
… …
194=item $time = EV::now 199=item $time = EV::now
195 200
196=item $time = $loop->now 201=item $time = $loop->now
197 202
198Returns the time the last event loop iteration has been started. This 203Returns the time the last event loop iteration has been started. This
199is 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
200usually faster then calling EV::time. 205usually faster then calling EV::time.
201 206
202=item $backend = EV::backend 207=item $backend = EV::backend
203 208
204=item $backend = $loop->backend 209=item $backend = $loop->backend
205 210
206Returns an integer describing the backend used by libev (EV::METHOD_SELECT 211Returns an integer describing the backend used by libev (EV::BACKEND_SELECT
207or EV::METHOD_EPOLL). 212or EV::BACKEND_EPOLL).
208 213
209=item EV::loop [$flags] 214=item EV::loop [$flags]
210 215
211=item $loop->loop ([$flags]) 216=item $loop->loop ([$flags])
212 217
… …
232=item $count = EV::loop_count 237=item $count = EV::loop_count
233 238
234=item $count = $loop->loop_count 239=item $count = $loop->loop_count
235 240
236Return the number of times the event loop has polled for new 241Return the number of times the event loop has polled for new
237events. Sometiems useful as a generation counter. 242events. Sometimes useful as a generation counter.
238 243
239=item EV::once $fh_or_undef, $events, $timeout, $cb->($revents) 244=item EV::once $fh_or_undef, $events, $timeout, $cb->($revents)
240 245
241=item $loop->once ($fh_or_undef, $events, $timeout, $cb->($revents)) 246=item $loop->once ($fh_or_undef, $events, $timeout, $cb->($revents))
242 247
… …
282 287
283=item $loop->set_timeout_collect_interval ($time) 288=item $loop->set_timeout_collect_interval ($time)
284 289
285These 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
286wait interval for timer events. See the libev documentation at 291wait interval for timer events. See the libev documentation at
287L<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>
288a more detailed discussion. 293(locally installed as F<EV::libev>) for a more detailed discussion.
289 294
290=back 295=back
291 296
292 297
293=head1 WATCHER OBJECTS 298=head1 WATCHER OBJECTS
… …
306called 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
307events. 312events.
308 313
309Each 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
310same callback for multiple watchers. The event mask is named after the 315same callback for multiple watchers. The event mask is named after the
311type, 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,
312EV::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
313(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
314uses EV::TIMEOUT). 319uses EV::TIMEOUT).
315 320
316In 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
… …
412because you happen to have this long-running UDP port watcher. 417because you happen to have this long-running UDP port watcher.
413 418
414In 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
415though 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.
416 421
417The 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
418any time. 423any time.
419 424
420Example: 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
421event loop from running just because of that watcher. 426event loop from running just because of that watcher.
422 427
… …
916 # make the dispatcher handle any new stuff 921 # make the dispatcher handle any new stuff
917 ... not shown 922 ... not shown
918 }; 923 };
919 924
920The 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
921are destroyed before this cna happen (remember EV::check gets called 926are destroyed before this can happen (remember EV::check gets called
922first). 927first).
923 928
924The 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.
925 930
926=back 931=back
… …
957loop, 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
958fashion and must not be used). 963fashion and must not be used).
959 964
960See the libev documentation at 965See the libev documentation at
961L<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_>
962for more details. 967(locally installed as F<EV::libev>) for more details.
963 968
964In short, this watcher is most useful on BSD systems without working 969In short, this watcher is most useful on BSD systems without working
965kqueue to still be able to handle a large number of sockets: 970kqueue to still be able to handle a large number of sockets:
966 971
967 my $socket_loop; 972 my $socket_loop;

Diff Legend

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