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

Comparing EV/EV.pm (file contents):
Revision 1.97 by root, Mon May 26 05:37:18 2008 UTC vs.
Revision 1.98 by root, Sat May 31 23:17:50 2008 UTC

2 2
3EV - perl interface to libev, a high performance full-featured event loop 3EV - perl interface to libev, a high performance full-featured event loop
4 4
5=head1 SYNOPSIS 5=head1 SYNOPSIS
6 6
7 use EV; 7 use EV;
8
9 # TIMERS
10
11 my $w = EV::timer 2, 0, sub {
12 warn "is called after 2s";
13 };
14
15 my $w = EV::timer 2, 2, sub {
16 warn "is called roughly every 2s (repeat = 2)";
17 };
18
19 undef $w; # destroy event watcher again
20
21 my $w = EV::periodic 0, 60, 0, sub {
22 warn "is called every minute, on the minute, exactly";
23 };
24
25 # IO
26
27 my $w = EV::io *STDIN, EV::READ, sub {
28 my ($w, $revents) = @_; # all callbacks receive the watcher and event mask
29 warn "stdin is readable, you entered: ", <STDIN>;
30 };
31
32 # SIGNALS
33
34 my $w = EV::signal 'QUIT', sub {
35 warn "sigquit received\n";
36 };
37
38 # CHILD/PID STATUS CHANGES
8 39
9 # TIMERS 40 my $w = EV::child 666, 0, sub {
41 my ($w, $revents) = @_;
42 my $status = $w->rstatus;
43 };
10 44
11 my $w = EV::timer 2, 0, sub {
12 warn "is called after 2s";
13 };
14
15 my $w = EV::timer 2, 2, sub {
16 warn "is called roughly every 2s (repeat = 2)";
17 };
18
19 undef $w; # destroy event watcher again
20
21 my $w = EV::periodic 0, 60, 0, sub {
22 warn "is called every minute, on the minute, exactly";
23 };
24
25 # IO
26
27 my $w = EV::io *STDIN, EV::READ, sub {
28 my ($w, $revents) = @_; # all callbacks receive the watcher and event mask
29 warn "stdin is readable, you entered: ", <STDIN>;
30 };
31
32 # SIGNALS
33
34 my $w = EV::signal 'QUIT', sub {
35 warn "sigquit received\n";
36 };
37
38 # CHILD/PID STATUS CHANGES
39
40 my $w = EV::child 666, 0, sub {
41 my ($w, $revents) = @_;
42 my $status = $w->rstatus;
43 };
44
45 # STAT CHANGES 45 # STAT CHANGES
46 my $w = EV::stat "/etc/passwd", 10, sub { 46 my $w = EV::stat "/etc/passwd", 10, sub {
47 my ($w, $revents) = @_; 47 my ($w, $revents) = @_;
48 warn $w->path, " has changed somehow.\n"; 48 warn $w->path, " has changed somehow.\n";
49 }; 49 };
50 50
51 # MAINLOOP 51 # MAINLOOP
52 EV::loop; # loop until EV::unloop is called or all watchers stop 52 EV::loop; # loop until EV::unloop is called or all watchers stop
53 EV::loop EV::LOOP_ONESHOT; # block until at least one event could be handled 53 EV::loop EV::LOOP_ONESHOT; # block until at least one event could be handled
54 EV::loop EV::LOOP_NONBLOCK; # try to handle same events, but do not block 54 EV::loop EV::LOOP_NONBLOCK; # try to handle same events, but do not block
55 55
56=head1 DESCRIPTION 56=head1 DESCRIPTION
57 57
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
283 283
284A watcher is an object that gets created to record your interest in some 284A watcher is an object that gets created to record your interest in some
285event. For instance, if you want to wait for STDIN to become readable, you 285event. For instance, if you want to wait for STDIN to become readable, you
286would create an EV::io watcher for that: 286would create an EV::io watcher for that:
287 287
288 my $watcher = EV::io *STDIN, EV::READ, sub { 288 my $watcher = EV::io *STDIN, EV::READ, sub {
289 my ($watcher, $revents) = @_; 289 my ($watcher, $revents) = @_;
290 warn "yeah, STDIN should now be readable without blocking!\n" 290 warn "yeah, STDIN should now be readable without blocking!\n"
291 }; 291 };
292 292
293All watchers can be active (waiting for events) or inactive (paused). Only 293All watchers can be active (waiting for events) or inactive (paused). Only
294active watchers will have their callbacks invoked. All callbacks will be 294active watchers will have their callbacks invoked. All callbacks will be
295called with at least two arguments: the watcher and a bitmask of received 295called with at least two arguments: the watcher and a bitmask of received
296events. 296events.
409Example: Register an I/O watcher for some UDP socket but do not keep the 409Example: Register an I/O watcher for some UDP socket but do not keep the
410event loop from running just because of that watcher. 410event loop from running just because of that watcher.
411 411
412 my $udp_socket = ... 412 my $udp_socket = ...
413 my $udp_watcher = EV::io $udp_socket, EV::READ, sub { ... }; 413 my $udp_watcher = EV::io $udp_socket, EV::READ, sub { ... };
414 $1000udp_watcher->keepalive (0); 414 $udp_watcher->keepalive (0);
415 415
416=item $loop = $w->loop 416=item $loop = $w->loop
417 417
418Return the loop that this watcher is attached to. 418Return the loop that this watcher is attached to.
419 419
951for more details. 951for more details.
952 952
953In short, this watcher is most useful on BSD systems without working 953In short, this watcher is most useful on BSD systems without working
954kqueue to still be able to handle a large number of sockets: 954kqueue to still be able to handle a large number of sockets:
955 955
956 my $socket_loop; 956 my $socket_loop;
957 957
958 # check wether we use SELECT or POLL _and_ KQUEUE is supported 958 # check wether we use SELECT or POLL _and_ KQUEUE is supported
959 if ( 959 if (
960 (EV::backend & (EV::BACKEND_POLL | EV::BACKEND_SELECT)) 960 (EV::backend & (EV::BACKEND_POLL | EV::BACKEND_SELECT))
961 && (EV::supported_backends & EV::embeddable_backends & EV::BACKEND_KQUEUE) 961 && (EV::supported_backends & EV::embeddable_backends & EV::BACKEND_KQUEUE)
962 ) { 962 ) {
963 # use kqueue for sockets 963 # use kqueue for sockets
964 $socket_loop = new EV::Loop EV::BACKEND_KQUEUE | EV::FLAG_NOENV; 964 $socket_loop = new EV::Loop EV::BACKEND_KQUEUE | EV::FLAG_NOENV;
965 } 965 }
966 966
967 # use the default loop otherwise 967 # use the default loop otherwise
968 $socket_loop ||= EV::default_loop; 968 $socket_loop ||= EV::default_loop;
969 969
970=over 4 970=over 4
971 971
972=item $w = EV::embed $otherloop, $callback 972=item $w = EV::embed $otherloop, $callback
973 973
1069coroutines with EV), L<Net::SNMP::EV> (asynchronous SNMP), L<AnyEvent> for 1069coroutines with EV), L<Net::SNMP::EV> (asynchronous SNMP), L<AnyEvent> for
1070event-loop agnostic and portable event driven programming. 1070event-loop agnostic and portable event driven programming.
1071 1071
1072=head1 AUTHOR 1072=head1 AUTHOR
1073 1073
1074 Marc Lehmann <schmorp@schmorp.de> 1074 Marc Lehmann <schmorp@schmorp.de>
1075 http://home.schmorp.de/ 1075 http://home.schmorp.de/
1076 1076
1077=cut 1077=cut
1078 1078

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines