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

Comparing EV/EV.pm (file contents):
Revision 1.7 by root, Sat Oct 27 14:54:20 2007 UTC vs.
Revision 1.16 by root, Wed Oct 31 20:10:17 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
65=head1 FUNCTIONAL INTERFACE 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
98=head1 BASIC INTERFACE
66 99
67=over 4 100=over 4
68 101
69=item $EV::NPRI 102=item $EV::NPRI
70 103
71How many priority levels are available. 104How many priority levels are available.
105
106=item $EV::DIED
107
108Must contain a reference to a function that is called when a callback
109throws an exception (with $@ containing thr error). The default prints an
110informative message and continues.
111
112If this callback throws an exception it will be silently ignored.
72 113
73=item $time = EV::now 114=item $time = EV::now
74 115
75Returns the time in (fractional) seconds since the epoch. 116Returns the time in (fractional) seconds since the epoch.
76 117
… …
101 142
102As long as the returned watcher object is alive, call the C<$callback> 143As long as the returned watcher object is alive, call the C<$callback>
103when the events specified in C<$eventmask> happen. Initially, the timeout 144when the events specified in C<$eventmask> happen. Initially, the timeout
104is disabled. 145is disabled.
105 146
106Youc an additionall set a timeout to occur on the watcher, but note that 147You can additionall set a timeout to occur on the watcher, but note that
107this timeout will not be reset when you get an I/O event in the EV::PERSIST 148this timeout will not be reset when you get an I/O event in the EV::PERSIST
108case, and reaching a timeout will always stop the watcher even in the 149case, and reaching a timeout will always stop the watcher even in the
109EV::PERSIST case. 150EV::PERSIST case.
110 151
111If you want a timeout to occur only after a specific time of inactivity, set 152If you want a timeout to occur only after a specific time of inactivity, set
… …
116 EV::READ wait until read() wouldn't block anymore 157 EV::READ wait until read() wouldn't block anymore
117 EV::WRITE wait until write() wouldn't block anymore 158 EV::WRITE wait until write() wouldn't block anymore
118 EV::PERSIST stay active after a (non-timeout) event occured 159 EV::PERSIST stay active after a (non-timeout) event occured
119 160
120The C<io_ns> variant doesn't add/start the newly created watcher. 161The C<io_ns> variant doesn't add/start the newly created watcher.
162
163=item my $w = EV::timed_io $fileno_or_fh, $eventmask, $timeout, $callback
164
165=item my $w = EV::timed_io_ns $fileno_or_fh, $eventmask, $timeout, $callback
166
167Same as C<io> and C<io_ns>, but also specifies a timeout (as if there was
168a call to C<< $w->timeout ($timout, 1) >>. The persist flag is not allowed
169and will automatically be cleared. The watcher will be restarted after each event.
170
171If the timeout is zero or undef, no timeout will be set, and a normal
172watcher (with the persist flag set!) will be created.
173
174This has the effect of timing out after the specified period of inactivity
175has happened.
176
177Due to the design of libevent, this is also relatively inefficient, having
178one or two io watchers and a separate timeout watcher that you reset on
179activity (by calling its C<start> method) is usually more efficient.
121 180
122=item my $w = EV::timer $after, $repeat, $callback 181=item my $w = EV::timer $after, $repeat, $callback
123 182
124=item my $w = EV::timer_ns $after, $repeat, $callback 183=item my $w = EV::timer_ns $after, $repeat, $callback
125 184
… …
152C<timer_abs> will try to tun the callback at the next possible time where 211C<timer_abs> will try to tun the callback at the next possible time where
153C<$time = $at (mod $interval)>, regardless of any time jumps. 212C<$time = $at (mod $interval)>, regardless of any time jumps.
154 213
155The C<timer_abs_ns> variant doesn't add/start the newly created watcher. 214The C<timer_abs_ns> variant doesn't add/start the newly created watcher.
156 215
157=item my $w = EV::signal $signum, $callback 216=item my $w = EV::signal $signal, $callback
158 217
159=item my $w = EV::signal_ns $signum, $callback 218=item my $w = EV::signal_ns $signal, $callback
160 219
161Call the callback when signal $signum is received. 220Call the callback when $signal is received (the signal can be specified
221by number or by name, just as with kill or %SIG). Signal watchers are
222persistent no natter what.
223
224EV will grab the signal for the process (the kernel only allows one
225component to receive signals) when you start a signal watcher, and
226removes it again when you stop it. Pelr does the same when you add/remove
227callbacks to %SIG, so watch out.
228
229Unfortunately, only one handler can be registered per signal. Screw
230libevent.
162 231
163The C<signal_ns> variant doesn't add/start the newly created watcher. 232The C<signal_ns> variant doesn't add/start the newly created watcher.
164 233
165=back 234=back
166 235
… …
194 263
195=item $current_fh = $w->fh 264=item $current_fh = $w->fh
196 265
197=item $old_fh = $w->fh ($new_fh) 266=item $old_fh = $w->fh ($new_fh)
198 267
199Returns the previously set filehandle and optionally set a new one. 268Returns the previously set filehandle and optionally set a new one (also
269clears the EV::SIGNAL flag when setting a filehandle).
270
271=item $current_signal = $w->signal
272
273=item $old_signal = $w->signal ($new_signal)
274
275Returns the previously set signal number and optionally set a new one (also sets
276the EV::SIGNAL flag when setting a signal).
200 277
201=item $current_eventmask = $w->events 278=item $current_eventmask = $w->events
202 279
203=item $old_eventmask = $w->events ($new_eventmask) 280=item $old_eventmask = $w->events ($new_eventmask)
204 281
… …
215=item $w->priority_set ($priority) 292=item $w->priority_set ($priority)
216 293
217Set the priority of the watcher to C<$priority> (0 <= $priority < $EV::NPRI). 294Set the priority of the watcher to C<$priority> (0 <= $priority < $EV::NPRI).
218 295
219=back 296=back
297
298=head1 THREADS
299
300Threads are not supported by this in any way. Perl pseudo-threads is evil
301and must die.
220 302
221=head1 BUGS 303=head1 BUGS
222 304
223Lots. Libevent itself isn't well tested and rather buggy, and this module 305Lots. Libevent itself isn't well tested and rather buggy, and this module
224is quite new at the moment. 306is quite new at the moment.
… …
231In general, if you fork, then you can only use the EV module in one of the 313In general, if you fork, then you can only use the EV module in one of the
232children. 314children.
233 315
234=cut 316=cut
235 317
236our $NPRI = 4; 318our $DIED = sub {
237our $BASE = init; 319 warn "EV: error in callback (ignoring): $@";
238priority_init $NPRI; 320};
321
322init;
239 323
240push @AnyEvent::REGISTRY, [EV => "EV::AnyEvent"]; 324push @AnyEvent::REGISTRY, [EV => "EV::AnyEvent"];
241 325
2421; 3261;
243 327

Diff Legend

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