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

Comparing EV/EV.pm (file contents):
Revision 1.9 by root, Sun Oct 28 06:40:46 2007 UTC vs.
Revision 1.12 by root, Mon Oct 29 08:52:28 2007 UTC

… …
2 2
3EV - perl interface to libevent, monkey.org/~provos/libevent/ 3EV - perl interface to libevent, monkey.org/~provos/libevent/
4 4
5=head1 SYNOPSIS 5=head1 SYNOPSIS
6 6
7 use EV; 7 use EV;
8 8
9 # TIMER 9 # TIMER
10 10
11 my $w = EV::timer 2, 0, sub { 11 my $w = EV::timer 2, 0, sub {
12 warn "is called after 2s"; 12 warn "is called after 2s";
13 }; 13 };
14 14
15 my $w = EV::timer 2, 1, sub { 15 my $w = EV::timer 2, 1, sub {
16 warn "is called roughly every 2s (repeat = 1)"; 16 warn "is called roughly every 2s (repeat = 1)";
17 }; 17 };
18 18
19 undef $w; # destroy event watcher again 19 undef $w; # destroy event watcher again
20 20
21 # IO
22
23 my $w = EV::timer_abs 0, 60, sub { 21 my $w = EV::timer_abs 0, 60, sub {
24 warn "is called every minute, on the minute, exactly"; 22 warn "is called every minute, on the minute, exactly";
25 }; 23 };
26 24
25 # IO
26
27 my $w = EV::io \*STDIN, EV::READ | EV::PERSIST, sub { 27 my $w = EV::io \*STDIN, EV::READ | EV::PERSIST, sub {
28 my ($w, $events) = @_; # all callbacks get the watcher object and event mask 28 my ($w, $events) = @_; # all callbacks get the watcher object and event mask
29 if ($events & EV::TIMEOUT) { 29 if ($events & EV::TIMEOUT) {
30 warn "nothign received on stdin for 10 seconds, retrying"; 30 warn "nothing received on stdin for 10 seconds, retrying";
31 } else { 31 } else {
32 warn "stdin is readable, you entered: ", <STDIN>; 32 warn "stdin is readable, you entered: ", <STDIN>;
33 } 33 }
34 }; 34 };
35 $w->timeout (10); 35 $w->timeout (10);
36 36
37 my $w = EV::timed_io \*STDIN, EV::READ, 30, sub {
38 my ($w, $events) = @_;
39 if ($_[1] & EV::TIMEOUT) {
40 warn "nothing entered within 30 seconds, bye bye.\n";
41 $w->stop;
42 } else {
43 my $line = <STDIN>;
44 warn "you entered something, you again have 30 seconds.\n";
45 }
46 };
47
48 # SIGNALS
49
50 my $w = EV::signal 'QUIT', sub {
51 warn "sigquit received\n";
52 };
53
54 my $w = EV::signal 3, sub {
55 warn "sigquit received (this is GNU/Linux, right?)\n";
56 };
57
37 # MAINLOOP 58 # MAINLOOP
38 EV::dispatch; # loop as long as watchers are active 59 EV::dispatch; # loop as long as watchers are active
39 EV::loop; # the same thing 60 EV::loop; # the same thing
40 EV::loop EV::LOOP_ONCE; 61 EV::loop EV::LOOP_ONCE; # block until some events could be handles
41 EV::loop EV::LOOP_ONSHOT; 62 EV::loop EV::LOOP_NONBLOCK; # check and handle some events, but do not wait
42 63
43=head1 DESCRIPTION 64=head1 DESCRIPTION
44 65
45This module provides an interface to libevent 66This module provides an interface to libevent
46(L<http://monkey.org/~provos/libevent/>). You probably should acquaint 67(L<http://monkey.org/~provos/libevent/>). You probably should acquaint
… …
55package EV; 76package EV;
56 77
57use strict; 78use strict;
58 79
59BEGIN { 80BEGIN {
60 our $VERSION = '0.02'; 81 our $VERSION = '0.03';
61 use XSLoader; 82 use XSLoader;
62 XSLoader::load "EV", $VERSION; 83 XSLoader::load "EV", $VERSION;
63} 84}
64 85
65=head1 BASIC INTERFACE 86=head1 BASIC INTERFACE
… …
109 130
110As long as the returned watcher object is alive, call the C<$callback> 131As long as the returned watcher object is alive, call the C<$callback>
111when the events specified in C<$eventmask> happen. Initially, the timeout 132when the events specified in C<$eventmask> happen. Initially, the timeout
112is disabled. 133is disabled.
113 134
114Youc an additionall set a timeout to occur on the watcher, but note that 135You can additionall set a timeout to occur on the watcher, but note that
115this timeout will not be reset when you get an I/O event in the EV::PERSIST 136this timeout will not be reset when you get an I/O event in the EV::PERSIST
116case, and reaching a timeout will always stop the watcher even in the 137case, and reaching a timeout will always stop the watcher even in the
117EV::PERSIST case. 138EV::PERSIST case.
118 139
119If you want a timeout to occur only after a specific time of inactivity, set 140If you want a timeout to occur only after a specific time of inactivity, set
… …
124 EV::READ wait until read() wouldn't block anymore 145 EV::READ wait until read() wouldn't block anymore
125 EV::WRITE wait until write() wouldn't block anymore 146 EV::WRITE wait until write() wouldn't block anymore
126 EV::PERSIST stay active after a (non-timeout) event occured 147 EV::PERSIST stay active after a (non-timeout) event occured
127 148
128The C<io_ns> variant doesn't add/start the newly created watcher. 149The C<io_ns> variant doesn't add/start the newly created watcher.
150
151=item my $w = EV::timed_io $fileno_or_fh, $eventmask, $timeout, $callback
152
153=item my $w = EV::timed_io_ns $fileno_or_fh, $eventmask, $timeout, $callback
154
155Same as C<io> and C<io_ns>, but also specifies a timeout (as if there was
156a call to C<< $w->timeout ($timout, 1) >>. The persist flag is not allowed
157and will automatically be cleared. The watcher will be restarted after each event.
158
159If the timeout is zero or undef, no timeout will be set, and a normal
160watcher (with the persist flag set!) will be created.
161
162This has the effect of timing out after the specified period of inactivity
163has happened.
164
165Due to the design of libevent, this is also relatively inefficient, having
166one or two io watchers and a separate timeout watcher that you reset on
167activity (by calling its C<start> method) is usually more efficient.
129 168
130=item my $w = EV::timer $after, $repeat, $callback 169=item my $w = EV::timer $after, $repeat, $callback
131 170
132=item my $w = EV::timer_ns $after, $repeat, $callback 171=item my $w = EV::timer_ns $after, $repeat, $callback
133 172
… …
160C<timer_abs> will try to tun the callback at the next possible time where 199C<timer_abs> will try to tun the callback at the next possible time where
161C<$time = $at (mod $interval)>, regardless of any time jumps. 200C<$time = $at (mod $interval)>, regardless of any time jumps.
162 201
163The C<timer_abs_ns> variant doesn't add/start the newly created watcher. 202The C<timer_abs_ns> variant doesn't add/start the newly created watcher.
164 203
165=item my $w = EV::signal $signum, $callback 204=item my $w = EV::signal $signal, $callback
166 205
167=item my $w = EV::signal_ns $signum, $callback 206=item my $w = EV::signal_ns $signal, $callback
168 207
169Call the callback when signal $signum is received. 208Call the callback when $signal is received (the signal can be specified
209by number or by name, just as with kill or %SIG). Signal watchers are
210persistent no natter what.
211
212EV will grab the signal for the process (the kernel only allows one
213component to receive signals) when you start a signal watcher, and
214removes it again when you stop it. Pelr does the same when you add/remove
215callbacks to %SIG, so watch out.
216
217Unfortunately, only one handler can be registered per signal. Screw
218libevent.
170 219
171The C<signal_ns> variant doesn't add/start the newly created watcher. 220The C<signal_ns> variant doesn't add/start the newly created watcher.
172 221
173=back 222=back
174 223
… …
202 251
203=item $current_fh = $w->fh 252=item $current_fh = $w->fh
204 253
205=item $old_fh = $w->fh ($new_fh) 254=item $old_fh = $w->fh ($new_fh)
206 255
207Returns the previously set filehandle and optionally set a new one. 256Returns the previously set filehandle and optionally set a new one (also
257clears the EV::SIGNAL flag when setting a filehandle).
258
259=item $current_signal = $w->signal
260
261=item $old_signal = $w->signal ($new_signal)
262
263Returns the previously set signal number and optionally set a new one (also sets
264the EV::SIGNAL flag when setting a signal).
208 265
209=item $current_eventmask = $w->events 266=item $current_eventmask = $w->events
210 267
211=item $old_eventmask = $w->events ($new_eventmask) 268=item $old_eventmask = $w->events ($new_eventmask)
212 269

Diff Legend

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