--- cvsroot/EV/EV.pm 2007/10/27 14:54:20 1.7 +++ cvsroot/EV/EV.pm 2007/10/29 07:56:03 1.11 @@ -4,41 +4,62 @@ =head1 SYNOPSIS - use EV; - - # TIMER - - my $w = EV::timer 2, 0, sub { - warn "is called after 2s"; - }; - - my $w = EV::timer 2, 1, sub { - warn "is called roughly every 2s (repeat = 1)"; - }; - - undef $w; # destroy event watcher again - - # IO - - my $w = EV::timer_abs 0, 60, sub { - warn "is called every minute, on the minute, exactly"; - }; - - my $w = EV::io \*STDIN, EV::READ | EV::PERSIST, sub { - my ($w, $events) = @_; # all callbacks get the watcher object and event mask - if ($events & EV::TIMEOUT) { - warn "nothign received on stdin for 10 seconds, retrying"; - } else { - warn "stdin is readable, you entered: ", ; - } - }; - $w->timeout (10); - - # MAINLOOP - EV::dispatch; # loop as long as watchers are active - EV::loop; # the same thing - EV::loop EV::LOOP_ONCE; - EV::loop EV::LOOP_ONSHOT; + use EV; + + # TIMER + + my $w = EV::timer 2, 0, sub { + warn "is called after 2s"; + }; + + my $w = EV::timer 2, 1, sub { + warn "is called roughly every 2s (repeat = 1)"; + }; + + undef $w; # destroy event watcher again + + my $w = EV::timer_abs 0, 60, sub { + warn "is called every minute, on the minute, exactly"; + }; + + # IO + + my $w = EV::io \*STDIN, EV::READ | EV::PERSIST, sub { + my ($w, $events) = @_; # all callbacks get the watcher object and event mask + if ($events & EV::TIMEOUT) { + warn "nothing received on stdin for 10 seconds, retrying"; + } else { + warn "stdin is readable, you entered: ", ; + } + }; + $w->timeout (10); + + my $w = EV::timed_io \*STDIN, EV::READ, 30, sub { + my ($w, $events) = @_; + if ($_[1] & EV::TIMEOUT) { + warn "nothing entered within 30 seconds, bye bye.\n"; + $w->stop; + } else { + my $line = ; + warn "you entered something, you again have 30 seconds.\n"; + } + }; + + # SIGNALS + + my $w = EV::signal 'QUIT', sub { + warn "sigquit received\n"; + }; + + my $w = EV::signal 3, sub { + warn "sigquit received (this is GNU/Linux, right?)\n"; + }; + + # MAINLOOP + EV::dispatch; # loop as long as watchers are active + EV::loop; # the same thing + EV::loop EV::LOOP_ONCE; # block until some events could be handles + EV::loop EV::LOOP_NONBLOCK; # check and handle some events, but do not wait =head1 DESCRIPTION @@ -57,12 +78,12 @@ use strict; BEGIN { - our $VERSION = '0.01'; + our $VERSION = '0.02'; use XSLoader; XSLoader::load "EV", $VERSION; } -=head1 FUNCTIONAL INTERFACE +=head1 BASIC INTERFACE =over 4 @@ -70,6 +91,14 @@ How many priority levels are available. +=item $EV::DIED + +Must contain a reference to a function that is called when a callback +throws an exception (with $@ containing thr error). The default prints an +informative message and continues. + +If this callback throws an exception it will be silently ignored. + =item $time = EV::now Returns the time in (fractional) seconds since the epoch. @@ -103,7 +132,7 @@ when the events specified in C<$eventmask> happen. Initially, the timeout is disabled. -Youc an additionall set a timeout to occur on the watcher, but note that +You can additionall set a timeout to occur on the watcher, but note that this timeout will not be reset when you get an I/O event in the EV::PERSIST case, and reaching a timeout will always stop the watcher even in the EV::PERSIST case. @@ -119,6 +148,24 @@ The C variant doesn't add/start the newly created watcher. +=item my $w = EV::timed_io $fileno_or_fh, $eventmask, $timeout, $callback + +=item my $w = EV::timed_io_ns $fileno_or_fh, $eventmask, $timeout, $callback + +Same as C and C, but also specifies a timeout (as if there was +a call to C<< $w->timeout ($timout, 1) >>. The persist flag is not allowed +and will automatically be cleared. The watcher will be restarted after each event. + +If the timeout is zero or undef, no timeout will be set, and a normal +watcher (with the persist flag set!) will be created. + +This has the effect of timing out after the specified period of inactivity +has happened. + +Due to the design of libevent, this is also relatively inefficient, having +one or two io watchers and a separate timeout watcher that you reset on +activity (by calling its C method) is usually more efficient. + =item my $w = EV::timer $after, $repeat, $callback =item my $w = EV::timer_ns $after, $repeat, $callback @@ -154,11 +201,21 @@ The C variant doesn't add/start the newly created watcher. -=item my $w = EV::signal $signum, $callback +=item my $w = EV::signal $signal, $callback + +=item my $w = EV::signal_ns $signal, $callback + +Call the callback when $signal is received (the signal can be specified +by number or by name, just as with kill or %SIG). Signal watchers are +persistent no natter what. -=item my $w = EV::signal_ns $signum, $callback +EV will grab the signal for the process (the kernel only allows one +component to receive signals) when you start a signal watcher, and +removes it again when you stop it. Pelr does the same when you add/remove +callbacks to %SIG, so watch out. -Call the callback when signal $signum is received. +Unfortunately, only one handler can be registered per signal. Screw +libevent. The C variant doesn't add/start the newly created watcher. @@ -196,7 +253,15 @@ =item $old_fh = $w->fh ($new_fh) -Returns the previously set filehandle and optionally set a new one. +Returns the previously set filehandle and optionally set a new one (also +clears the EV::SIGNAL flag when setting a filehandle). + +=item $current_signal = $w->signal + +=item $old_signal = $w->signal ($new_signal) + +Returns the previously set signal number and optionally set a new one (also sets +the EV::SIGNAL flag when setting a signal). =item $current_eventmask = $w->events @@ -233,6 +298,10 @@ =cut +our $DIED = sub { + warn "EV: error in callback (ignoring): $@"; +}; + our $NPRI = 4; our $BASE = init; priority_init $NPRI;