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

Comparing AnyEvent/lib/AE.pm (file contents):
Revision 1.7 by root, Wed Mar 24 23:28:06 2010 UTC vs.
Revision 1.16 by root, Mon Apr 9 02:25:48 2012 UTC

… …
8 8
9 # file handle or descriptor readable 9 # file handle or descriptor readable
10 my $w = AE::io $fh, 0, sub { ... }; 10 my $w = AE::io $fh, 0, sub { ... };
11 11
12 # one-shot or repeating timers 12 # one-shot or repeating timers
13 my $w = AE::timer $seconds, 0, sub { ... }; # once 13 my $w = AE::timer $seconds, 0, sub { ... }; # once
14 my $w = AE::timer $seconds, interval, sub { ... }; # repeated 14 my $w = AE::timer $seconds, $interval, sub { ... }; # repeated
15 15
16 print AE::now; # prints current event loop time 16 print AE::now; # prints current event loop time
17 print AE::time; # think Time::HiRes::time or simply CORE::time. 17 print AE::time; # think Time::HiRes::time or simply CORE::time.
18 18
19 # POSIX signal 19 # POSIX signal
… …
24 my ($pid, $status) = @_; 24 my ($pid, $status) = @_;
25 ... 25 ...
26 }; 26 };
27 27
28 # called when event loop idle (if applicable) 28 # called when event loop idle (if applicable)
29 my $w = AE::idle { ... }; 29 my $w = AE::idle sub { ... };
30 30
31 my $w = AE::cv; # stores whether a condition was flagged 31 my $cv = AE::cv; # stores whether a condition was flagged
32 $w->send; # wake up current and all future recv's 32 $cv->send; # wake up current and all future recv's
33 $w->recv; # enters "main loop" till $condvar gets ->send 33 $cv->recv; # enters "main loop" till $condvar gets ->send
34 # use a condvar in callback mode: 34 # use a condvar in callback mode:
35 $w->cb (sub { $_[0]->recv }); 35 $cv->cb (sub { $_[0]->recv });
36 36
37 37
38=head1 DESCRIPTION 38=head1 DESCRIPTION
39 39
40This module documents the new simpler AnyEvent API. 40This module documents the new simpler AnyEvent API.
41 41
42The rationale for the new API is that experience with L<EV> shows that 42The rationale for the new API is that experience with L<EV> shows that
43this API actually "works", despite it's lack of extensibility, leading to 43this API actually "works", despite its lack of extensibility, leading to
44a shorter, easier and faster API. 44a shorter, easier and faster API.
45 45
46The main difference to AnyEvent is that instead of method calls, function 46The main differences from AnyEvent is that function calls are used
47calls are used, and that no named arguments are used. 47instead of method calls, and that no named arguments are used.
48 48
49This makes calls to watcher creation functions really short, which can 49This makes calls to watcher creation functions really short, which can
50make a program more readable, despite the lack of named parameters. 50make a program more readable despite the lack of named parameters.
51Function calls also allow more static type checking than method calls, so 51Function calls also allow more static type checking than method calls, so
52many mistakes are caught at compiletime with this API. 52many mistakes are caught at compile-time with this API.
53 53
54Also, some backends (Perl and EV) are so fast that the method call 54Also, some backends (Perl and EV) are so fast that the method call
55overhead is very noticeable (with EV it increases the execution time five- 55overhead is very noticeable (with EV it increases the execution time five-
56to six-fold, with Perl the method call overhead is about a factor of two). 56to six-fold, with Perl the method call overhead is about a factor of two).
57 57
58At the moment, there will be no checking (L<AnyEvent::Strict> does not
59affect his API), so the L<AnyEvent> API has a definite advantage here
60still.
61
62Note that the C<AE> API is an alternative to, not the future version of, 58Note that the C<AE> API is an alternative to, not the future version of,
63the AnyEvent API. Both APIs can be used interchangably and and there are 59the AnyEvent API. Both APIs can be used interchangeably and there are
64no plans to "switch", so if in doubt, feel free to use the L<AnyEvent> 60no plans to "switch", so if in doubt, feel free to use the L<AnyEvent>
65API in new code. 61API in new code.
66 62
67As the AE API is complementary, not everything in the AnyEvent API is 63As the AE API is complementary, not everything in the AnyEvent API is
68available, so you still need to use AnyEvent for the finer stuff. Also, 64available, and you still need to use AnyEvent for the finer stuff. Also,
69you should not C<use AE> directly, C<use AnyEvent> will provide the AE 65you should not C<use AE> directly, C<use AnyEvent> will provide the AE
70namespace. 66namespace.
71 67
68At the moment, these functions will become slower then their method-call
69counterparts when using L<AnyEvent::Strict> or L<AnyEvent::Debug>::wrap.
70
72=head2 FUNCTIONS 71=head2 FUNCTIONS
73 72
74This section briefly describes the alternative watcher 73This section briefly describes the alternative watcher constructors and
75constructors. Semantics and any methods are not described here, please 74other functions available inside the C<AE> namespace. Semantics are not
75described here; please refer to the description of the function or method
76refer to the L<AnyEvent> manpage for the details. 76with the same name in the L<AnyEvent> manpage for the details.
77 77
78=over 4 78=over 4
79 79
80=cut 80=cut
81 81
… …
96 96
97Example: wait until STDIN becomes readable. 97Example: wait until STDIN becomes readable.
98 98
99 $stdin_ready = AE::io *STDIN, 0, sub { scalar <STDIN> }; 99 $stdin_ready = AE::io *STDIN, 0, sub { scalar <STDIN> };
100 100
101Example. wait until STDOUT becomes writable and print something. 101Example: wait until STDOUT becomes writable and print something.
102 102
103 $stdout_ready = AE::io *STDOUT, 1, sub { print STDOUT "woaw\n" }; 103 $stdout_ready = AE::io *STDOUT, 1, sub { print STDOUT "woaw\n" };
104 104
105=item $w = AE::timer $after, $interval, $cb 105=item $w = AE::timer $after, $interval, $cb
106 106
107Creates a timer watcher that invokes the callback C<$cb> after at least 107Creates a timer watcher that invokes the callback C<$cb> after at least
108C<$after> second have passed (C<$after> can be negative or C<0>). 108C<$after> second have passed (C<$after> can be negative or C<0>).
109 109
110If C<$interval> is C<0>, then the clalback will only be invoked once, 110If C<$interval> is C<0>, then the callback will only be invoked once,
111otherwise it must be a positive number of seconds that specified the 111otherwise it must be a positive number of seconds that specifies the
112interval between successive invocations of the callback. 112interval between successive invocations of the callback.
113 113
114Example: print "too late" after at least one second has passed. 114Example: print "too late" after at least one second has passed.
115 115
116 $timer_once = AE::timer 1, 0, sub { print "too late\n" }; 116 $timer_once = AE::timer 1, 0, sub { print "too late\n" };
… …
119 119
120 $timer_repeated = AE::timer 0, 1, sub { print "blubb\n" }; 120 $timer_repeated = AE::timer 0, 1, sub { print "blubb\n" };
121 121
122=item $w = AE::signal $signame, $cb 122=item $w = AE::signal $signame, $cb
123 123
124Invoke the callback c<$cb> each time one or more occurences of the named 124Invoke the callback C<$cb> each time one or more occurrences of the
125signal C<$signame> are detected. 125named signal C<$signame> are detected.
126 126
127=item $w = AE::child $pid, $cb 127=item $w = AE::child $pid, $cb
128 128
129Invokes the callbakc C<$cb> when the child with the given C<$pid> exits 129Invokes the callback C<$cb> when the child with the given C<$pid> exits
130(or all children, when C<$pid> is zero). 130(or all children, when C<$pid> is zero).
131 131
132The callback will get the actual pid and exit status as arguments. 132The callback will get the actual pid and exit status as arguments.
133 133
134=item $w = AE::idle $cb 134=item $w = AE::idle $cb
… …
155 155
156=item AE::time 156=item AE::time
157 157
158Return the current time (not cached, always consults a hardware clock). 158Return the current time (not cached, always consults a hardware clock).
159 159
160=item AE::postpone { BLOCK }
161
162Exactly the same as C<AnyEvent:::postpone>.
163
164=item AE::log $level, $msg[, @args]
165
166Exactly the same as C<AnyEvent::log> (or C<AnyEvent::Log::log>).
167
160=back 168=back
161 169
162=head1 AUTHOR 170=head1 AUTHOR
163 171
164 Marc Lehmann <schmorp@schmorp.de> 172 Marc Lehmann <schmorp@schmorp.de>
165 http://home.schmorp.de/ 173 http://anyevent.schmorp.de
166 174
167=cut 175=cut
168 176
1691 1771
170 178

Diff Legend

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