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

Comparing EV/EV.pm (file contents):
Revision 1.96 by root, Thu May 22 02:44:57 2008 UTC vs.
Revision 1.103 by root, Thu Oct 2 07:49:09 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
… …
71 71
72=cut 72=cut
73 73
74package EV; 74package EV;
75 75
76no warnings;
76use strict; 77use strict;
77 78
78BEGIN { 79BEGIN {
79 our $VERSION = '3.41'; 80 our $VERSION = '3.44';
80 use XSLoader; 81 use XSLoader;
81 XSLoader::load "EV", $VERSION; 82 XSLoader::load "EV", $VERSION;
82} 83}
83 84
84@EV::IO::ISA = 85@EV::IO::ISA =
… …
111default loop as this is fastest (perl-wise), best supported by other 112default loop as this is fastest (perl-wise), best supported by other
112modules (e.g. AnyEvent or Coro) and most portable event loop. 113modules (e.g. AnyEvent or Coro) and most portable event loop.
113 114
114For specific programs you can create additional event loops dynamically. 115For specific programs you can create additional event loops dynamically.
115 116
117If you want to take avdantage of kqueue (which often works properly for
118sockets only) even though the default loop doesn't enable it, you can
119I<embed> a kqueue loop into the default loop: running the default loop
120will then also service the kqueue loop to some extent. See the example in
121the section about embed watchers for an example on how to achieve that.
122
116=over 4 123=over 4
117 124
118=item $loop = new EV::loop [$flags] 125=item $loop = new EV::loop [$flags]
119 126
120Create a new event loop as per the specified flags. Please refer to the 127Create a new event loop as per the specified flags. Please refer to the
… …
123for more info. 130for more info.
124 131
125The loop will automatically be destroyed when it is no longer referenced 132The loop will automatically be destroyed when it is no longer referenced
126by any watcher and the loop object goes out of scope. 133by any watcher and the loop object goes out of scope.
127 134
128Using C<EV::FLAG_FORKCHECK> is recommended, as only the default event loop 135If you are not embedding the loop, then Using C<EV::FLAG_FORKCHECK>
129is protected by this module. 136is recommended, as only the default event loop is protected by this
137module. If you I<are> embedding this loop in the default loop, this is not
138necessary, as C<EV::embed> automatically does the right thing on fork.
130 139
131=item $loop->loop_fork 140=item $loop->loop_fork
132 141
133Must be called after a fork in the child, before entering or continuing 142Must be called after a fork in the child, before entering or continuing
134the event loop. An alternative is to use C<EV::FLAG_FORKCHECK> which calls 143the event loop. An alternative is to use C<EV::FLAG_FORKCHECK> which calls
… …
136documentation). 145documentation).
137 146
138=item $loop->loop_verify 147=item $loop->loop_verify
139 148
140Calls C<ev_verify> to make internal consistency checks (for debugging 149Calls C<ev_verify> to make internal consistency checks (for debugging
141libev) and abort the program if any data structures wree found to be 150libev) and abort the program if any data structures were found to be
142corrupted. 151corrupted.
143 152
144=item $loop = EV::default_loop [$flags] 153=item $loop = EV::default_loop [$flags]
145 154
146Return the default loop (which is a singleton object). Since this module 155Return the default loop (which is a singleton object). Since this module
147already creates the default loop with default flags, specifying flags here 156already creates the default loop with default flags, specifying flags here
148will not have any effect unless you destroy the default loop. 157will not have any effect unless you destroy the default loop first, which
158isn't supported. So in short: don't do it, and if you break it, you get to
159keep the pieces.
149 160
150=back 161=back
151 162
152 163
153=head1 BASIC INTERFACE 164=head1 BASIC INTERFACE
… …
283 294
284A watcher is an object that gets created to record your interest in some 295A 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 296event. For instance, if you want to wait for STDIN to become readable, you
286would create an EV::io watcher for that: 297would create an EV::io watcher for that:
287 298
288 my $watcher = EV::io *STDIN, EV::READ, sub { 299 my $watcher = EV::io *STDIN, EV::READ, sub {
289 my ($watcher, $revents) = @_; 300 my ($watcher, $revents) = @_;
290 warn "yeah, STDIN should now be readable without blocking!\n" 301 warn "yeah, STDIN should now be readable without blocking!\n"
291 }; 302 };
292 303
293All watchers can be active (waiting for events) or inactive (paused). Only 304All watchers can be active (waiting for events) or inactive (paused). Only
294active watchers will have their callbacks invoked. All callbacks will be 305active watchers will have their callbacks invoked. All callbacks will be
295called with at least two arguments: the watcher and a bitmask of received 306called with at least two arguments: the watcher and a bitmask of received
296events. 307events.
… …
409Example: Register an I/O watcher for some UDP socket but do not keep the 420Example: Register an I/O watcher for some UDP socket but do not keep the
410event loop from running just because of that watcher. 421event loop from running just because of that watcher.
411 422
412 my $udp_socket = ... 423 my $udp_socket = ...
413 my $udp_watcher = EV::io $udp_socket, EV::READ, sub { ... }; 424 my $udp_watcher = EV::io $udp_socket, EV::READ, sub { ... };
414 $1000udp_watcher->keepalive (0); 425 $udp_watcher->keepalive (0);
415 426
416=item $loop = $w->loop 427=item $loop = $w->loop
417 428
418Return the loop that this watcher is attached to. 429Return the loop that this watcher is attached to.
419 430
… …
951for more details. 962for more details.
952 963
953In short, this watcher is most useful on BSD systems without working 964In short, this watcher is most useful on BSD systems without working
954kqueue to still be able to handle a large number of sockets: 965kqueue to still be able to handle a large number of sockets:
955 966
956 my $socket_loop; 967 my $socket_loop;
957 968
958 # check wether we use SELECT or POLL _and_ KQUEUE is supported 969 # check wether we use SELECT or POLL _and_ KQUEUE is supported
959 if ( 970 if (
960 (EV::backend & (EV::BACKEND_POLL | EV::BACKEND_SELECT)) 971 (EV::backend & (EV::BACKEND_POLL | EV::BACKEND_SELECT))
961 && (EV::supported_backends & EV::embeddable_backends & EV::BACKEND_KQUEUE) 972 && (EV::supported_backends & EV::embeddable_backends & EV::BACKEND_KQUEUE)
962 ) { 973 ) {
963 # use kqueue for sockets 974 # use kqueue for sockets
964 $socket_loop = new EV::Loop EV::BACKEND_KQUEUE | EV::FLAG_NOENV; 975 $socket_loop = new EV::Loop EV::BACKEND_KQUEUE | EV::FLAG_NOENV;
965 } 976 }
966 977
967 # use the default loop otherwise 978 # use the default loop otherwise
968 $socket_loop ||= EV::default_loop; 979 $socket_loop ||= EV::default_loop;
969 980
970=over 4 981=over 4
971 982
972=item $w = EV::embed $otherloop, $callback 983=item $w = EV::embed $otherloop[, $callback]
973 984
974=item $w = EV::embed_ns $otherloop, $callback 985=item $w = EV::embed_ns $otherloop[, $callback]
975 986
976=item $w = $loop->embed ($otherloop, $callback) 987=item $w = $loop->embed ($otherloop[, $callback])
977 988
978=item $w = $loop->embed_ns ($otherloop, $callback) 989=item $w = $loop->embed_ns ($otherloop[, $callback])
979 990
980Call the callback when the embedded event loop (C<$otherloop>) has any 991Call the callback when the embedded event loop (C<$otherloop>) has any
981I/O activity. The C<$callback> should alwas be specified as C<undef> in 992I/O activity. The C<$callback> is optional: if it is missing, then the
982this version of EV, which means the embedded event loop will be managed 993embedded event loop will be managed automatically (which is recommended),
983automatically. 994otherwise you have to invoke C<sweep> yourself.
984 995
985The C<embed_ns> variant doesn't start (activate) the newly created watcher. 996The C<embed_ns> variant doesn't start (activate) the newly created watcher.
986 997
987=back 998=back
988 999
… …
1069coroutines with EV), L<Net::SNMP::EV> (asynchronous SNMP), L<AnyEvent> for 1080coroutines with EV), L<Net::SNMP::EV> (asynchronous SNMP), L<AnyEvent> for
1070event-loop agnostic and portable event driven programming. 1081event-loop agnostic and portable event driven programming.
1071 1082
1072=head1 AUTHOR 1083=head1 AUTHOR
1073 1084
1074 Marc Lehmann <schmorp@schmorp.de> 1085 Marc Lehmann <schmorp@schmorp.de>
1075 http://home.schmorp.de/ 1086 http://home.schmorp.de/
1076 1087
1077=cut 1088=cut
1078 1089

Diff Legend

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