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

Comparing EV/EV.pm (file contents):
Revision 1.8 by root, Sat Oct 27 19:11:27 2007 UTC vs.
Revision 1.17 by root, Wed Oct 31 21:34:45 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, $revents) = @_; # all callbacks get the watcher object and event mask
29 if ($events & EV::TIMEOUT) { 29 if ($revents & 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
37 my $w = EV::timed_io \*STDIN, EV::READ, 30, sub {
38 my ($w, $revents) = @_;
39 if ($revents & 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 };
36 57
58 # CHILD/PID STATUS CHANGES
59
60 my $w = EV::child 666, sub {
61 my ($w, $revents, $status) = @_;
62 };
63
37 # MAINLOOP 64 # MAINLOOP
38 EV::dispatch; # loop as long as watchers are active 65 EV::dispatch; # loop as long as watchers are active
39 EV::loop; # the same thing 66 EV::loop; # the same thing
40 EV::loop EV::LOOP_ONCE; 67 EV::loop EV::LOOP_ONESHOT; # block until some events could be handles
41 EV::loop EV::LOOP_ONSHOT; 68 EV::loop EV::LOOP_NONBLOCK; # check and handle some events, but do not wait
42 69
43=head1 DESCRIPTION 70=head1 DESCRIPTION
44 71
45This module provides an interface to libevent 72This module provides an interface to libev
46(L<http://monkey.org/~provos/libevent/>). You probably should acquaint 73(L<http://software.schmorp.de/pkg/libev.html>). You probably should
47yourself with its documentation and source code to be able to use this 74acquaint yourself with its documentation and source code to be able to use
48module fully. 75this module fully.
49
50Please note thta this module disables the libevent EPOLL method by
51default, see BUGS, below, if you need to enable it.
52 76
53=cut 77=cut
54 78
55package EV; 79package EV;
56 80
57use strict; 81use strict;
58 82
59BEGIN { 83BEGIN {
60 our $VERSION = '0.01'; 84 our $VERSION = '0.03';
61 use XSLoader; 85 use XSLoader;
62 XSLoader::load "EV", $VERSION; 86 XSLoader::load "EV", $VERSION;
63} 87}
64 88
89@EV::Io::ISA = "EV::Watcher";
90@EV::Time::ISA = "EV::Watcher";
91@EV::Timer::ISA = "EV::Time";
92@EV::Periodic::ISA = "EV::Time";
93@EV::Signal::ISA = "EV::Watcher";
94@EV::Idle::ISA = "EV::Watcher";
95@EV::Prepare::ISA = "EV::Watcher";
96@EV::Check::ISA = "EV::Watcher";
97@EV::Child::ISA = "EV::Watcher";
98
65=head1 BASIC INTERFACE 99=head1 BASIC INTERFACE
66 100
67=over 4 101=over 4
68 102
69=item $EV::NPRI 103=item $EV::NPRI
… …
109 143
110As long as the returned watcher object is alive, call the C<$callback> 144As long as the returned watcher object is alive, call the C<$callback>
111when the events specified in C<$eventmask> happen. Initially, the timeout 145when the events specified in C<$eventmask> happen. Initially, the timeout
112is disabled. 146is disabled.
113 147
114Youc an additionall set a timeout to occur on the watcher, but note that 148You 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 149this 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 150case, and reaching a timeout will always stop the watcher even in the
117EV::PERSIST case. 151EV::PERSIST case.
118 152
119If you want a timeout to occur only after a specific time of inactivity, set 153If you want a timeout to occur only after a specific time of inactivity, set
… …
124 EV::READ wait until read() wouldn't block anymore 158 EV::READ wait until read() wouldn't block anymore
125 EV::WRITE wait until write() wouldn't block anymore 159 EV::WRITE wait until write() wouldn't block anymore
126 EV::PERSIST stay active after a (non-timeout) event occured 160 EV::PERSIST stay active after a (non-timeout) event occured
127 161
128The C<io_ns> variant doesn't add/start the newly created watcher. 162The C<io_ns> variant doesn't add/start the newly created watcher.
163
164=item my $w = EV::timed_io $fileno_or_fh, $eventmask, $timeout, $callback
165
166=item my $w = EV::timed_io_ns $fileno_or_fh, $eventmask, $timeout, $callback
167
168Same as C<io> and C<io_ns>, but also specifies a timeout (as if there was
169a call to C<< $w->timeout ($timout, 1) >>. The persist flag is not allowed
170and will automatically be cleared. The watcher will be restarted after each event.
171
172If the timeout is zero or undef, no timeout will be set, and a normal
173watcher (with the persist flag set!) will be created.
174
175This has the effect of timing out after the specified period of inactivity
176has happened.
177
178Due to the design of libevent, this is also relatively inefficient, having
179one or two io watchers and a separate timeout watcher that you reset on
180activity (by calling its C<start> method) is usually more efficient.
129 181
130=item my $w = EV::timer $after, $repeat, $callback 182=item my $w = EV::timer $after, $repeat, $callback
131 183
132=item my $w = EV::timer_ns $after, $repeat, $callback 184=item my $w = EV::timer_ns $after, $repeat, $callback
133 185
… …
160C<timer_abs> will try to tun the callback at the next possible time where 212C<timer_abs> will try to tun the callback at the next possible time where
161C<$time = $at (mod $interval)>, regardless of any time jumps. 213C<$time = $at (mod $interval)>, regardless of any time jumps.
162 214
163The C<timer_abs_ns> variant doesn't add/start the newly created watcher. 215The C<timer_abs_ns> variant doesn't add/start the newly created watcher.
164 216
165=item my $w = EV::signal $signum, $callback 217=item my $w = EV::signal $signal, $callback
166 218
167=item my $w = EV::signal_ns $signum, $callback 219=item my $w = EV::signal_ns $signal, $callback
168 220
169Call the callback when signal $signum is received. 221Call the callback when $signal is received (the signal can be specified
222by number or by name, just as with kill or %SIG). Signal watchers are
223persistent no natter what.
224
225EV will grab the signal for the process (the kernel only allows one
226component to receive signals) when you start a signal watcher, and
227removes it again when you stop it. Pelr does the same when you add/remove
228callbacks to %SIG, so watch out.
229
230Unfortunately, only one handler can be registered per signal. Screw
231libevent.
170 232
171The C<signal_ns> variant doesn't add/start the newly created watcher. 233The C<signal_ns> variant doesn't add/start the newly created watcher.
172 234
173=back 235=back
174 236
… …
202 264
203=item $current_fh = $w->fh 265=item $current_fh = $w->fh
204 266
205=item $old_fh = $w->fh ($new_fh) 267=item $old_fh = $w->fh ($new_fh)
206 268
207Returns the previously set filehandle and optionally set a new one. 269Returns the previously set filehandle and optionally set a new one (also
270clears the EV::SIGNAL flag when setting a filehandle).
271
272=item $current_signal = $w->signal
273
274=item $old_signal = $w->signal ($new_signal)
275
276Returns the previously set signal number and optionally set a new one (also sets
277the EV::SIGNAL flag when setting a signal).
208 278
209=item $current_eventmask = $w->events 279=item $current_eventmask = $w->events
210 280
211=item $old_eventmask = $w->events ($new_eventmask) 281=item $old_eventmask = $w->events ($new_eventmask)
212 282
… …
223=item $w->priority_set ($priority) 293=item $w->priority_set ($priority)
224 294
225Set the priority of the watcher to C<$priority> (0 <= $priority < $EV::NPRI). 295Set the priority of the watcher to C<$priority> (0 <= $priority < $EV::NPRI).
226 296
227=back 297=back
298
299=head1 THREADS
300
301Threads are not supported by this in any way. Perl pseudo-threads is evil
302and must die.
228 303
229=head1 BUGS 304=head1 BUGS
230 305
231Lots. Libevent itself isn't well tested and rather buggy, and this module 306Lots. Libevent itself isn't well tested and rather buggy, and this module
232is quite new at the moment. 307is quite new at the moment.
… …
243 318
244our $DIED = sub { 319our $DIED = sub {
245 warn "EV: error in callback (ignoring): $@"; 320 warn "EV: error in callback (ignoring): $@";
246}; 321};
247 322
248our $NPRI = 4; 323init;
249our $BASE = init;
250priority_init $NPRI;
251 324
252push @AnyEvent::REGISTRY, [EV => "EV::AnyEvent"]; 325push @AnyEvent::REGISTRY, [EV => "EV::AnyEvent"];
253 326
2541; 3271;
255 328

Diff Legend

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