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

Comparing EV/EV.pm (file contents):
Revision 1.90 by root, Sat Apr 26 03:34:24 2008 UTC vs.
Revision 1.97 by root, Mon May 26 05:37:18 2008 UTC

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 libev
61itself (L<http://cvs.schmorp.de/libev/ev.html>) for more subtle details on 61itself (L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod>) for more
62watcher semantics or some discussion on the available backends, or how to 62subtle details on watcher semantics or some discussion on the available
63force a specific backend with C<LIBEV_FLAGS>, or just about in any case 63backends, or how to force a specific backend with C<LIBEV_FLAGS>, or just
64because it has much more detailed information. 64about in any case because it has much more detailed information.
65 65
66This module is very fast and scalable. It is actually so fast that you 66This 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 67can 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) 68loops (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 69and still be faster than with any other event loop currently supported in
74package EV; 74package EV;
75 75
76use strict; 76use strict;
77 77
78BEGIN { 78BEGIN {
79 our $VERSION = '3.31'; 79 our $VERSION = '3.42';
80 use XSLoader; 80 use XSLoader;
81 XSLoader::load "EV", $VERSION; 81 XSLoader::load "EV", $VERSION;
82} 82}
83 83
84@EV::IO::ISA = 84@EV::IO::ISA =
130 130
131=item $loop->loop_fork 131=item $loop->loop_fork
132 132
133Must be called after a fork in the child, before entering or continuing 133Must 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 134the event loop. An alternative is to use C<EV::FLAG_FORKCHECK> which calls
135this fucntion automatically, at some performance loss (refer to the libev 135this function automatically, at some performance loss (refer to the libev
136documentation). 136documentation).
137 137
138=item $loop->loop_verify
139
140Calls C<ev_verify> to make internal consistency checks (for debugging
141libev) and abort the program if any data structures wree found to be
142corrupted.
143
138=item $loop = EV::default_loop [$flags] 144=item $loop = EV::default_loop [$flags]
139 145
140Return the default loop (which is a singleton object). 146Return the default loop (which is a singleton object). Since this module
147already creates the default loop with default flags, specifying flags here
148will not have any effect unless you destroy the default loop.
141 149
142=back 150=back
143 151
144 152
145=head1 BASIC INTERFACE 153=head1 BASIC INTERFACE
568time the periodic watcher gets scheduled, the reschedule callback 576time the periodic watcher gets scheduled, the reschedule callback
569($reschedule_cb) will be called with the watcher as first, and the current 577($reschedule_cb) will be called with the watcher as first, and the current
570time as second argument. 578time as second argument.
571 579
572I<This callback MUST NOT stop or destroy this or any other periodic 580I<This callback MUST NOT stop or destroy this or any other periodic
573watcher, ever>. If you need to stop it, return 1e30 and stop it 581watcher, ever, and MUST NOT call any event loop functions or methods>. If
574afterwards. 582you need to stop it, return 1e30 and stop it afterwards. You may create
583and start a C<EV::prepare> watcher for this task.
575 584
576It must return the next time to trigger, based on the passed time value 585It must return the next time to trigger, based on the passed time value
577(that is, the lowest time value larger than to the second argument). It 586(that is, the lowest time value larger than or equal to to the second
578will usually be called just before the callback will be triggered, but 587argument). It will usually be called just before the callback will be
579might be called at other times, too. 588triggered, but might be called at other times, too.
580 589
581This can be used to create very complex timers, such as a timer that 590This can be used to create very complex timers, such as a timer that
582triggers on each midnight, local time (actually 24 hours after the last 591triggers on each midnight, local time (actually 24 hours after the last
583midnight, to keep the example simple. If you know a way to do it correctly 592midnight, to keep the example simple. If you know a way to do it correctly
584in about the same space (without requiring elaborate modules), drop me a 593in about the same space (without requiring elaborate modules), drop me a

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines