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

Comparing EV/EV.pm (file contents):
Revision 1.86 by root, Wed Apr 2 11:00:58 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
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
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
70Perl.
65 71
66=cut 72=cut
67 73
68package EV; 74package EV;
69 75
70use strict; 76use strict;
71 77
72BEGIN { 78BEGIN {
73 our $VERSION = '3.2'; 79 our $VERSION = '3.42';
74 use XSLoader; 80 use XSLoader;
75 XSLoader::load "EV", $VERSION; 81 XSLoader::load "EV", $VERSION;
76} 82}
77 83
78@EV::IO::ISA = 84@EV::IO::ISA =
… …
124 130
125=item $loop->loop_fork 131=item $loop->loop_fork
126 132
127Must 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
128the 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
129this fucntion automatically, at some performance loss (refer to the libev 135this function automatically, at some performance loss (refer to the libev
130documentation). 136documentation).
131 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
132=item $loop = EV::default_loop [$flags] 144=item $loop = EV::default_loop [$flags]
133 145
134Return 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.
135 149
136=back 150=back
137 151
138 152
139=head1 BASIC INTERFACE 153=head1 BASIC INTERFACE
… …
562time the periodic watcher gets scheduled, the reschedule callback 576time the periodic watcher gets scheduled, the reschedule callback
563($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
564time as second argument. 578time as second argument.
565 579
566I<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
567watcher, 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
568afterwards. 582you need to stop it, return 1e30 and stop it afterwards. You may create
583and start a C<EV::prepare> watcher for this task.
569 584
570It 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
571(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
572will usually be called just before the callback will be triggered, but 587argument). It will usually be called just before the callback will be
573might be called at other times, too. 588triggered, but might be called at other times, too.
574 589
575This 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
576triggers on each midnight, local time (actually 24 hours after the last 591triggers on each midnight, local time (actually 24 hours after the last
577midnight, 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
578in about the same space (without requiring elaborate modules), drop me a 593in about the same space (without requiring elaborate modules), drop me a
… …
979 994
980It is, however, possible to use them from the XS level. 995It is, however, possible to use them from the XS level.
981 996
982Please see the libev documentation for further details. 997Please see the libev documentation for further details.
983 998
999=over 4
1000
1001=item $w = EV::async $callback
1002
1003=item $w = EV::async_ns $callback
1004
1005=item $w->send
1006
1007=item $bool = $w->async_pending
1008
1009=back
1010
984 1011
985=head1 PERL SIGNALS 1012=head1 PERL SIGNALS
986 1013
987While Perl signal handling (C<%SIG>) is not affected by EV, the behaviour 1014While Perl signal handling (C<%SIG>) is not affected by EV, the behaviour
988with EV is as the same as any other C library: Perl-signals will only be 1015with EV is as the same as any other C library: Perl-signals will only be
… …
1037 1064
1038=head1 SEE ALSO 1065=head1 SEE ALSO
1039 1066
1040L<EV::ADNS> (asynchronous DNS), L<Glib::EV> (makes Glib/Gtk2 use EV as 1067L<EV::ADNS> (asynchronous DNS), L<Glib::EV> (makes Glib/Gtk2 use EV as
1041event loop), L<EV::Glib> (embed Glib into EV), L<Coro::EV> (efficient 1068event loop), L<EV::Glib> (embed Glib into EV), L<Coro::EV> (efficient
1042coroutines with EV), L<Net::SNMP::EV> (asynchronous SNMP). 1069coroutines with EV), L<Net::SNMP::EV> (asynchronous SNMP), L<AnyEvent> for
1070event-loop agnostic and portable event driven programming.
1043 1071
1044=head1 AUTHOR 1072=head1 AUTHOR
1045 1073
1046 Marc Lehmann <schmorp@schmorp.de> 1074 Marc Lehmann <schmorp@schmorp.de>
1047 http://home.schmorp.de/ 1075 http://home.schmorp.de/

Diff Legend

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