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

Comparing EV/EV.pm (file contents):
Revision 1.57 by root, Wed Nov 28 17:32:24 2007 UTC vs.
Revision 1.75 by root, Fri Dec 21 10:36:22 2007 UTC

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://cvs.schmorp.de/libev/ev.html>) for more subtle details on
62watcher semantics or some discussion on the available backends, or how to 62watcher semantics or some discussion on the available backends, or how to
63force a specific backend with C<LIBEV_FLAGS>. 63force a specific backend with C<LIBEV_FLAGS>, or just about in any case
64because it has much more detailed information.
64 65
65=cut 66=cut
66 67
67package EV; 68package EV;
68 69
69use strict; 70use strict;
70 71
71BEGIN { 72BEGIN {
72 our $VERSION = '1.4'; 73 our $VERSION = '2.0';
73 use XSLoader; 74 use XSLoader;
74 XSLoader::load "EV", $VERSION; 75 XSLoader::load "EV", $VERSION;
75} 76}
76 77
77@EV::IO::ISA = 78@EV::IO::ISA =
85@EV::Check::ISA = 86@EV::Check::ISA =
86@EV::Embed::ISA = 87@EV::Embed::ISA =
87@EV::Fork::ISA = 88@EV::Fork::ISA =
88 "EV::Watcher"; 89 "EV::Watcher";
89 90
91@EV::Loop::Default::ISA = "EV::Loop";
92
93=head1 EVENT LOOPS
94
95EV supports multiple event loops: There is a single "default event loop"
96that can handle everything including signals and child watchers, and any
97number of "dynamic event loops" that can use different backends (with
98various limitations), but no child and signal watchers.
99
100You do not have to do anything to create the default event loop: When
101the module is loaded a suitable backend is selected on the premise of
102selecting a working backend (which for example rules out kqueue on most
103BSDs). Modules should, unless they have "special needs" always use the
104default loop as this is fastest (perl-wise), best supported by other
105modules (e.g. AnyEvent or Coro) and most portable event loop.
106
107For specific programs you cna create additional event loops dynamically.
108
109=over 4
110
111=item $loop = new EV::loop [$flags]
112
113Create a new event loop as per the specified flags. Please refer to the
114C<ev_loop_new ()> function description in the libev documentation
115(L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#GLOBAL_FUNCTIONS>)
116for more info.
117
118The loop will automatically be destroyed when it is no longer referenced
119by any watcher and the loop object goes out of scope.
120
121Using C<EV::FLAG_FORKCHECK> is recommended, as only the default event loop
122is protected by this module.
123
124=item $loop->loop_fork
125
126Must be called after a fork in the child, before entering or continuing
127the event loop. An alternative is to use C<EV::FLAG_FORKCHECK> which calls
128this fucntion automatically, at some performance loss (refer to the libev
129documentation).
130
131=back
132
133
90=head1 BASIC INTERFACE 134=head1 BASIC INTERFACE
91 135
92=over 4 136=over 4
93 137
94=item $EV::DIED 138=item $EV::DIED
95 139
96Must contain a reference to a function that is called when a callback 140Must contain a reference to a function that is called when a callback
97throws an exception (with $@ containing thr error). The default prints an 141throws an exception (with $@ containing the error). The default prints an
98informative message and continues. 142informative message and continues.
99 143
100If this callback throws an exception it will be silently ignored. 144If this callback throws an exception it will be silently ignored.
101 145
102=item $time = EV::time 146=item $time = EV::time
103 147
104Returns the current time in (fractional) seconds since the epoch. 148Returns the current time in (fractional) seconds since the epoch.
105 149
106=item $time = EV::now 150=item $time = EV::now
151
152=item $time = $loop->now
107 153
108Returns the time the last event loop iteration has been started. This 154Returns the time the last event loop iteration has been started. This
109is the time that (relative) timers are based on, and refering to it is 155is the time that (relative) timers are based on, and refering to it is
110usually faster then calling EV::time. 156usually faster then calling EV::time.
111 157
112=item $method = EV::method 158=item $backend = EV::backend
159
160=item $backend = $loop->backend
113 161
114Returns an integer describing the backend used by libev (EV::METHOD_SELECT 162Returns an integer describing the backend used by libev (EV::METHOD_SELECT
115or EV::METHOD_EPOLL). 163or EV::METHOD_EPOLL).
116 164
117=item EV::loop [$flags] 165=item EV::loop [$flags]
166
167=item $loop->loop ([$flags])
118 168
119Begin checking for events and calling callbacks. It returns when a 169Begin checking for events and calling callbacks. It returns when a
120callback calls EV::unloop. 170callback calls EV::unloop.
121 171
122The $flags argument can be one of the following: 172The $flags argument can be one of the following:
125 EV::LOOP_ONESHOT block at most once (wait, but do not loop) 175 EV::LOOP_ONESHOT block at most once (wait, but do not loop)
126 EV::LOOP_NONBLOCK do not block at all (fetch/handle events but do not wait) 176 EV::LOOP_NONBLOCK do not block at all (fetch/handle events but do not wait)
127 177
128=item EV::unloop [$how] 178=item EV::unloop [$how]
129 179
180=item $loop->unloop ([$how])
181
130When called with no arguments or an argument of EV::UNLOOP_ONE, makes the 182When called with no arguments or an argument of EV::UNLOOP_ONE, makes the
131innermost call to EV::loop return. 183innermost call to EV::loop return.
132 184
133When called with an argument of EV::UNLOOP_ALL, all calls to EV::loop will return as 185When called with an argument of EV::UNLOOP_ALL, all calls to EV::loop will return as
134fast as possible. 186fast as possible.
135 187
188=item $count = EV::loop_count
189
190=item $count = $loop->loop_count
191
192Return the number of times the event loop has polled for new
193events. Sometiems useful as a generation counter.
194
136=item EV::once $fh_or_undef, $events, $timeout, $cb->($revents) 195=item EV::once $fh_or_undef, $events, $timeout, $cb->($revents)
196
197=item $loop->once ($fh_or_undef, $events, $timeout, $cb->($revents))
137 198
138This function rolls together an I/O and a timer watcher for a single 199This function rolls together an I/O and a timer watcher for a single
139one-shot event without the need for managing a watcher object. 200one-shot event without the need for managing a watcher object.
140 201
141If C<$fh_or_undef> is a filehandle or file descriptor, then C<$events> 202If C<$fh_or_undef> is a filehandle or file descriptor, then C<$events>
154 215
155EV::once doesn't return anything: the watchers stay active till either 216EV::once doesn't return anything: the watchers stay active till either
156of them triggers, then they will be stopped and freed, and the callback 217of them triggers, then they will be stopped and freed, and the callback
157invoked. 218invoked.
158 219
159=back 220=item EV::feed_fd_event ($fd, $revents)
160 221
222=item $loop->feed_fd_event ($fd, $revents)
223
224Feed an event on a file descriptor into EV. EV will react to this call as
225if the readyness notifications specified by C<$revents> (a combination of
226C<EV::READ> and C<EV::WRITE>) happened on the file descriptor C<$fd>.
227
228=item EV::feed_signal_event ($signal)
229
230Feed a signal event into EV. EV will react to this call as if the signal
231specified by C<$signal> had occured.
232
233=back
234
235
161=head2 WATCHER OBJECTS 236=head1 WATCHER OBJECTS
162 237
163A watcher is an object that gets created to record your interest in some 238A watcher is an object that gets created to record your interest in some
164event. For instance, if you want to wait for STDIN to become readable, you 239event. For instance, if you want to wait for STDIN to become readable, you
165would create an EV::io watcher for that: 240would create an EV::io watcher for that:
166 241
175events. 250events.
176 251
177Each watcher type has its associated bit in revents, so you can use the 252Each watcher type has its associated bit in revents, so you can use the
178same callback for multiple watchers. The event mask is named after the 253same callback for multiple watchers. The event mask is named after the
179type, i..e. EV::child sets EV::CHILD, EV::prepare sets EV::PREPARE, 254type, i..e. EV::child sets EV::CHILD, EV::prepare sets EV::PREPARE,
180EV::periodic sets EV::PERIODIC and so on, with the exception of IO events 255EV::periodic sets EV::PERIODIC and so on, with the exception of I/O events
181(which can set both EV::READ and EV::WRITE bits), and EV::timer (which 256(which can set both EV::READ and EV::WRITE bits), and EV::timer (which
182uses EV::TIMEOUT). 257uses EV::TIMEOUT).
183 258
184In the rare case where one wants to create a watcher but not start it at 259In the rare case where one wants to create a watcher but not start it at
185the same time, each constructor has a variant with a trailing C<_ns> in 260the same time, each constructor has a variant with a trailing C<_ns> in
207 282
208=item $w->stop 283=item $w->stop
209 284
210Stop a watcher if it is active. Also clear any pending events (events that 285Stop a watcher if it is active. Also clear any pending events (events that
211have been received but that didn't yet result in a callback invocation), 286have been received but that didn't yet result in a callback invocation),
212regardless of wether the watcher was active or not. 287regardless of whether the watcher was active or not.
213 288
214=item $bool = $w->is_active 289=item $bool = $w->is_active
215 290
216Returns true if the watcher is active, false otherwise. 291Returns true if the watcher is active, false otherwise.
217 292
247The default priority of any newly-created watcher is 0. 322The default priority of any newly-created watcher is 0.
248 323
249Note that the priority semantics have not yet been fleshed out and are 324Note that the priority semantics have not yet been fleshed out and are
250subject to almost certain change. 325subject to almost certain change.
251 326
252=item $w->trigger ($revents) 327=item $w->invoke ($revents)
253 328
254Call the callback *now* with the given event mask. 329Call the callback *now* with the given event mask.
330
331=item $w->feed_event ($revents)
332
333Feed some events on this watcher into EV. EV will react to this call as if
334the watcher had received the given C<$revents> mask.
335
336=item $revents = $w->clear_pending
337
338If the watcher is pending, this function returns clears its pending status
339and returns its C<$revents> bitset (as if its callback was invoked). If the
340watcher isn't pending it does nothing and returns C<0>.
255 341
256=item $previous_state = $w->keepalive ($bool) 342=item $previous_state = $w->keepalive ($bool)
257 343
258Normally, C<EV::loop> will return when there are no active watchers 344Normally, C<EV::loop> will return when there are no active watchers
259(which is a "deadlock" because no progress can be made anymore). This is 345(which is a "deadlock" because no progress can be made anymore). This is
272though your watcher is active, it won't keep C<EV::loop> from returning. 358though your watcher is active, it won't keep C<EV::loop> from returning.
273 359
274The initial value for keepalive is true (enabled), and you cna change it 360The initial value for keepalive is true (enabled), and you cna change it
275any time. 361any time.
276 362
277Example: Register an IO watcher for some UDP socket but do not keep the 363Example: Register an I/O watcher for some UDP socket but do not keep the
278event loop from running just because of that watcher. 364event loop from running just because of that watcher.
279 365
280 my $udp_socket = ... 366 my $udp_socket = ...
281 my $udp_watcher = EV::io $udp_socket, EV::READ, sub { ... }; 367 my $udp_watcher = EV::io $udp_socket, EV::READ, sub { ... };
282 $udp_watcher->keepalive (0); 368 $1000udp_watcher->keepalive (0);
283 369
284=back 370=item $loop = $w->loop
285 371
372Return the loop that this watcher is attached to.
286 373
374=back
375
376
287=head2 WATCHER TYPES 377=head1 WATCHER TYPES
288 378
289Each of the following subsections describes a single watcher type. 379Each of the following subsections describes a single watcher type.
290 380
291=head3 IO WATCHERS - is this file descriptor readable or writable? 381=head3 I/O WATCHERS - is this file descriptor readable or writable?
292 382
293=over 4 383=over 4
294 384
295=item $w = EV::io $fileno_or_fh, $eventmask, $callback 385=item $w = EV::io $fileno_or_fh, $eventmask, $callback
296 386
297=item $w = EV::io_ns $fileno_or_fh, $eventmask, $callback 387=item $w = EV::io_ns $fileno_or_fh, $eventmask, $callback
388
389=item $w = $loop->io 8$fileno_or_fh, $eventmask, $callback)
390
391=item $w = $loop->io_ns ($fileno_or_fh, $eventmask, $callback)
298 392
299As long as the returned watcher object is alive, call the C<$callback> 393As long as the returned watcher object is alive, call the C<$callback>
300when at least one of events specified in C<$eventmask> occurs. 394when at least one of events specified in C<$eventmask> occurs.
301 395
302The $eventmask can be one or more of these constants ORed together: 396The $eventmask can be one or more of these constants ORed together:
331=over 4 425=over 4
332 426
333=item $w = EV::timer $after, $repeat, $callback 427=item $w = EV::timer $after, $repeat, $callback
334 428
335=item $w = EV::timer_ns $after, $repeat, $callback 429=item $w = EV::timer_ns $after, $repeat, $callback
430
431=item $w = $loop->timer ($after, $repeat, $callback)
432
433=item $w = $loop->timer_ns ($after, $repeat, $callback)
336 434
337Calls the callback after C<$after> seconds (which may be fractional). If 435Calls the callback after C<$after> seconds (which may be fractional). If
338C<$repeat> is non-zero, the timer will be restarted (with the $repeat 436C<$repeat> is non-zero, the timer will be restarted (with the $repeat
339value as $after) after the callback returns. 437value as $after) after the callback returns.
340 438
381=over 4 479=over 4
382 480
383=item $w = EV::periodic $at, $interval, $reschedule_cb, $callback 481=item $w = EV::periodic $at, $interval, $reschedule_cb, $callback
384 482
385=item $w = EV::periodic_ns $at, $interval, $reschedule_cb, $callback 483=item $w = EV::periodic_ns $at, $interval, $reschedule_cb, $callback
484
485=item $w = $loop->periodic ($at, $interval, $reschedule_cb, $callback)
486
487=item $w = $loop->periodic_ns ($at, $interval, $reschedule_cb, $callback)
386 488
387Similar to EV::timer, but is not based on relative timeouts but on 489Similar to EV::timer, but is not based on relative timeouts but on
388absolute times. Apart from creating "simple" timers that trigger "at" the 490absolute times. Apart from creating "simple" timers that trigger "at" the
389specified time, it can also be used for non-drifting absolute timers and 491specified time, it can also be used for non-drifting absolute timers and
390more complex, cron-like, setups that are not adversely affected by time 492more complex, cron-like, setups that are not adversely affected by time
465 567
466=item $w->again 568=item $w->again
467 569
468Simply stops and starts the watcher again. 570Simply stops and starts the watcher again.
469 571
572=item $time = $w->at
573
574Return the time that the watcher is expected to trigger next.
575
470=back 576=back
471 577
472 578
473=head3 SIGNAL WATCHERS - signal me when a signal gets signalled! 579=head3 SIGNAL WATCHERS - signal me when a signal gets signalled!
474 580
511 617
512=item $w = EV::child $pid, $callback 618=item $w = EV::child $pid, $callback
513 619
514=item $w = EV::child_ns $pid, $callback 620=item $w = EV::child_ns $pid, $callback
515 621
622=item $w = $loop->child ($pid, $callback)
623
624=item $w = $loop->child_ns ($pid, $callback)
625
516Call the callback when a status change for pid C<$pid> (or any pid if 626Call the callback when a status change for pid C<$pid> (or any pid if
517C<$pid> is 0) has been received. More precisely: when the process receives 627C<$pid> is 0) has been received. More precisely: when the process receives
518a C<SIGCHLD>, EV will fetch the outstanding exit/wait status for all 628a C<SIGCHLD>, EV will fetch the outstanding exit/wait status for all
519changed/zombie children and call the callback. 629changed/zombie children and call the callback.
520 630
561 671
562=item $w = EV::stat $path, $interval, $callback 672=item $w = EV::stat $path, $interval, $callback
563 673
564=item $w = EV::stat_ns $path, $interval, $callback 674=item $w = EV::stat_ns $path, $interval, $callback
565 675
676=item $w = $loop->stat ($path, $interval, $callback)
677
678=item $w = $loop->stat_ns ($path, $interval, $callback)
679
566Call the callback when a file status change has been detected on 680Call the callback when a file status change has been detected on
567C<$path>. The C<$path> does not need to exist, changing from "path exists" 681C<$path>. The C<$path> does not need to exist, changing from "path exists"
568to "path does not exist" is a status change like any other. 682to "path does not exist" is a status change like any other.
569 683
570The C<$interval> is a recommended polling interval for systems where 684The C<$interval> is a recommended polling interval for systems where
640 754
641=item $w = EV::idle $callback 755=item $w = EV::idle $callback
642 756
643=item $w = EV::idle_ns $callback 757=item $w = EV::idle_ns $callback
644 758
645Call the callback when there are no pending io, timer/periodic, signal or 759=item $w = $loop->idle ($callback)
646child events, i.e. when the process is idle. 760
761=item $w = $loop->idle_ns ($callback)
762
763Call the callback when there are no other pending watchers of the same or
764higher priority (excluding check, prepare and other idle watchers of the
765same or lower priority, of course). They are called idle watchers because
766when the watcher is the highest priority pending event in the process, the
767process is considered to be idle at that priority.
768
769If you want a watcher that is only ever called when I<no> other events are
770outstanding you have to set the priority to C<EV::MINPRI>.
647 771
648The process will not block as long as any idle watchers are active, and 772The process will not block as long as any idle watchers are active, and
649they will be called repeatedly until stopped. 773they will be called repeatedly until stopped.
650 774
775For example, if you have idle watchers at priority C<0> and C<1>, and
776an I/O watcher at priority C<0>, then the idle watcher at priority C<1>
777and the I/O watcher will always run when ready. Only when the idle watcher
778at priority C<1> is stopped and the I/O watcher at priority C<0> is not
779pending with the C<0>-priority idle watcher be invoked.
780
651The C<idle_ns> variant doesn't start (activate) the newly created watcher. 781The C<idle_ns> variant doesn't start (activate) the newly created watcher.
652 782
653=back 783=back
654 784
655 785
658=over 4 788=over 4
659 789
660=item $w = EV::prepare $callback 790=item $w = EV::prepare $callback
661 791
662=item $w = EV::prepare_ns $callback 792=item $w = EV::prepare_ns $callback
793
794=item $w = $loop->prepare ($callback)
795
796=item $w = $loop->prepare_ns 8$callback)
663 797
664Call the callback just before the process would block. You can still 798Call the callback just before the process would block. You can still
665create/modify any watchers at this point. 799create/modify any watchers at this point.
666 800
667See the EV::check watcher, below, for explanations and an example. 801See the EV::check watcher, below, for explanations and an example.
676=over 4 810=over 4
677 811
678=item $w = EV::check $callback 812=item $w = EV::check $callback
679 813
680=item $w = EV::check_ns $callback 814=item $w = EV::check_ns $callback
815
816=item $w = $loop->check ($callback)
817
818=item $w = $loop->check_ns ($callback)
681 819
682Call the callback just after the process wakes up again (after it has 820Call the callback just after the process wakes up again (after it has
683gathered events), but before any other callbacks have been invoked. 821gathered events), but before any other callbacks have been invoked.
684 822
685This is used to integrate other event-based software into the EV 823This is used to integrate other event-based software into the EV
695 or return; 833 or return;
696 834
697 # make the dispatcher handle any outstanding stuff 835 # make the dispatcher handle any outstanding stuff
698 ... not shown 836 ... not shown
699 837
700 # create an IO watcher for each and every socket 838 # create an I/O watcher for each and every socket
701 @snmp_watcher = ( 839 @snmp_watcher = (
702 (map { EV::io $_, EV::READ, sub { } } 840 (map { EV::io $_, EV::READ, sub { } }
703 keys %{ $dispatcher->{_descriptors} }), 841 keys %{ $dispatcher->{_descriptors} }),
704 842
705 EV::timer +($event->[Net::SNMP::Dispatcher::_ACTIVE] 843 EV::timer +($event->[Net::SNMP::Dispatcher::_ACTIVE]
740 878
741=item $w = EV::fork $callback 879=item $w = EV::fork $callback
742 880
743=item $w = EV::fork_ns $callback 881=item $w = EV::fork_ns $callback
744 882
883=item $w = $loop->fork ($callback)
884
885=item $w = $loop->fork_ns ($callback)
886
745Call the callback before the event loop is resumed in the child process 887Call the callback before the event loop is resumed in the child process
746after a fork. 888after a fork.
747 889
748The C<fork_ns> variant doesn't start (activate) the newly created watcher. 890The C<fork_ns> variant doesn't start (activate) the newly created watcher.
749 891
750=back 892=back
751 893
894
895=head1 PERL SIGNALS
896
897While Perl signal handling (C<%SIG>) is not affected by EV, the behaviour
898with EV is as the same as any other C library: Perl-signals will only be
899handled when Perl runs, which means your signal handler might be invoked
900only the next time an event callback is invoked.
901
902The solution is to use EV signal watchers (see C<EV::signal>), which will
903ensure proper operations with regards to other event watchers.
904
905If you cannot do this for whatever reason, you can also force a watcher
906to be called on every event loop iteration by installing a C<EV::check>
907watcher:
908
909 my $async_check = EV::check sub { };
910
911This ensures that perl gets into control for a short time to handle any
912pending signals, and also ensures (slightly) slower overall operation.
752 913
753=head1 THREADS 914=head1 THREADS
754 915
755Threads are not supported by this module in any way. Perl pseudo-threads 916Threads are not supported by this module in any way. Perl pseudo-threads
756is evil stuff and must die. As soon as Perl gains real threads I will work 917is evil stuff and must die. As soon as Perl gains real threads I will work
778our $DIED = sub { 939our $DIED = sub {
779 warn "EV: error in callback (ignoring): $@"; 940 warn "EV: error in callback (ignoring): $@";
780}; 941};
781 942
782default_loop 943default_loop
783 or die 'EV: cannot initialise libev backend. bad $ENV{LIBEV_METHODS}?'; 944 or die 'EV: cannot initialise libev backend. bad $ENV{LIBEV_FLAGS}?';
784 945
7851; 9461;
786 947
787=head1 SEE ALSO 948=head1 SEE ALSO
788 949
789L<EV::DNS>. 950L<EV::ADNS> (asynchronous DNS), L<Glib::EV> (makes Glib/Gtk2 use EV as
951event loop), L<EV::Glib> (embed Glib into EV), L<Coro::EV> (efficient
952coroutines with EV), L<Net::SNMP::EV> (asynchronous SNMP).
790 953
791=head1 AUTHOR 954=head1 AUTHOR
792 955
793 Marc Lehmann <schmorp@schmorp.de> 956 Marc Lehmann <schmorp@schmorp.de>
794 http://home.schmorp.de/ 957 http://home.schmorp.de/

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines