| … | |
… | |
| 2 | |
2 | |
| 3 | AE - simpler/faster/newer/cooler AnyEvent API |
3 | AE - simpler/faster/newer/cooler AnyEvent API |
| 4 | |
4 | |
| 5 | =head1 SYNOPSIS |
5 | =head1 SYNOPSIS |
| 6 | |
6 | |
| 7 | See the L<AnyEvent> manpage for everything there is to say about AE. |
7 | use AnyEvent; # not AE |
|
|
8 | |
|
|
9 | # file handle or descriptor readable |
|
|
10 | my $w = AE::io $fh, 0, sub { ... }; |
|
|
11 | |
|
|
12 | # one-shot or repeating timers |
|
|
13 | my $w = AE::timer $seconds, 0, sub { ... }; # once |
|
|
14 | my $w = AE::timer $seconds, $interval, sub { ... }; # repeated |
|
|
15 | |
|
|
16 | print AE::now; # prints current event loop time |
|
|
17 | print AE::time; # think Time::HiRes::time or simply CORE::time. |
|
|
18 | |
|
|
19 | # POSIX signal |
|
|
20 | my $w = AE::signal TERM => sub { ... }; |
|
|
21 | |
|
|
22 | # child process exit |
|
|
23 | my $w = AE::child $pid, sub { |
|
|
24 | my ($pid, $status) = @_; |
|
|
25 | ... |
|
|
26 | }; |
|
|
27 | |
|
|
28 | # called when event loop idle (if applicable) |
|
|
29 | my $w = AE::idle sub { ... }; |
|
|
30 | |
|
|
31 | my $cv = AE::cv; # stores whether a condition was flagged |
|
|
32 | $cv->send; # wake up current and all future recv's |
|
|
33 | $cv->recv; # enters "main loop" till $condvar gets ->send |
|
|
34 | # use a condvar in callback mode: |
|
|
35 | $cv->cb (sub { $_[0]->recv }); |
|
|
36 | |
| 8 | |
37 | |
| 9 | =head1 DESCRIPTION |
38 | =head1 DESCRIPTION |
| 10 | |
39 | |
| 11 | This module implements the new simpler AnyEvent API. There is no |
40 | This module documents the new simpler AnyEvent API. |
| 12 | description of this API here, refer to the L<AnyEvent> module for this. |
|
|
| 13 | |
41 | |
| 14 | The rationale for the new API is that experience with L<EV> shows that |
42 | The rationale for the new API is that experience with L<EV> shows that |
| 15 | this API actually "works", despite it's simplicity. This API is (will be) |
43 | this API actually "works", despite its lack of extensibility, leading to |
| 16 | much faster and also requires less typing. |
44 | a shorter, easier and faster API. |
| 17 | |
45 | |
| 18 | The "old" API is still supported, and there are no plans to "switch". |
46 | The main differences from AnyEvent is that function calls are used |
|
|
47 | instead of method calls, and that no named arguments are used. |
|
|
48 | |
|
|
49 | This makes calls to watcher creation functions really short, which can |
|
|
50 | make a program more readable despite the lack of named parameters. |
|
|
51 | Function calls also allow more static type checking than method calls, so |
|
|
52 | many mistakes are caught at compile-time with this API. |
|
|
53 | |
|
|
54 | Also, some backends (Perl and EV) are so fast that the method call |
|
|
55 | overhead is very noticeable (with EV it increases the execution time five- |
|
|
56 | to six-fold, with Perl the method call overhead is about a factor of two). |
|
|
57 | |
|
|
58 | Note that the C<AE> API is an alternative to, not the future version of, |
|
|
59 | the AnyEvent API. Both APIs can be used interchangeably and there are |
|
|
60 | no plans to "switch", so if in doubt, feel free to use the L<AnyEvent> |
|
|
61 | API in new code. |
|
|
62 | |
|
|
63 | As the AE API is complementary, not everything in the AnyEvent API is |
|
|
64 | available, and you still need to use AnyEvent for the finer stuff. Also, |
|
|
65 | you should not C<use AE> directly, C<use AnyEvent> will provide the AE |
|
|
66 | namespace. |
|
|
67 | |
|
|
68 | At the moment, these functions will become slower then their method-call |
|
|
69 | counterparts when using L<AnyEvent::Strict> or L<AnyEvent::Debug>::wrap. |
|
|
70 | |
|
|
71 | =head2 FUNCTIONS |
|
|
72 | |
|
|
73 | This section briefly describes the alternative watcher constructors and |
|
|
74 | other functions available inside the C<AE> namespace. Semantics are not |
|
|
75 | described here; please refer to the description of the function or method |
|
|
76 | with the same name in the L<AnyEvent> manpage for the details. |
|
|
77 | |
|
|
78 | =over 4 |
| 19 | |
79 | |
| 20 | =cut |
80 | =cut |
| 21 | |
81 | |
| 22 | package AE; |
82 | package AE; |
| 23 | |
83 | |
| 24 | use AnyEvent (); # BEGIN { AnyEvent::common_sense } |
84 | use AnyEvent (); # BEGIN { AnyEvent::common_sense } |
| 25 | |
85 | |
| 26 | 1; |
86 | our $VERSION = $AnyEvent::VERSION; |
|
|
87 | |
|
|
88 | =item $w = AE::io $fh_or_fd, $watch_write, $cb |
|
|
89 | |
|
|
90 | Creates an I/O watcher that listens for read events (C<$watch_write> |
|
|
91 | false) or write events (C<$watch_write> is true) on the file handle or |
|
|
92 | file descriptor C<$fh_or_fd>. |
|
|
93 | |
|
|
94 | The callback C<$cb> is invoked as soon and as long as I/O of the type |
|
|
95 | specified by C<$watch_write>) can be done on the file handle/descriptor. |
|
|
96 | |
|
|
97 | Example: wait until STDIN becomes readable. |
|
|
98 | |
|
|
99 | $stdin_ready = AE::io *STDIN, 0, sub { scalar <STDIN> }; |
|
|
100 | |
|
|
101 | Example: wait until STDOUT becomes writable and print something. |
|
|
102 | |
|
|
103 | $stdout_ready = AE::io *STDOUT, 1, sub { print STDOUT "woaw\n" }; |
|
|
104 | |
|
|
105 | =item $w = AE::timer $after, $interval, $cb |
|
|
106 | |
|
|
107 | Creates a timer watcher that invokes the callback C<$cb> after at least |
|
|
108 | C<$after> second have passed (C<$after> can be negative or C<0>). |
|
|
109 | |
|
|
110 | If C<$interval> is C<0>, then the callback will only be invoked once, |
|
|
111 | otherwise it must be a positive number of seconds that specifies the |
|
|
112 | interval between successive invocations of the callback. |
|
|
113 | |
|
|
114 | Example: print "too late" after at least one second has passed. |
|
|
115 | |
|
|
116 | $timer_once = AE::timer 1, 0, sub { print "too late\n" }; |
|
|
117 | |
|
|
118 | Example: print "blubb" once a second, starting as soon as possible. |
|
|
119 | |
|
|
120 | $timer_repeated = AE::timer 0, 1, sub { print "blubb\n" }; |
|
|
121 | |
|
|
122 | =item $w = AE::signal $signame, $cb |
|
|
123 | |
|
|
124 | Invoke the callback C<$cb> each time one or more occurrences of the |
|
|
125 | named signal C<$signame> are detected. |
|
|
126 | |
|
|
127 | =item $w = AE::child $pid, $cb |
|
|
128 | |
|
|
129 | Invokes the callback C<$cb> when the child with the given C<$pid> exits |
|
|
130 | (or all children, when C<$pid> is zero). |
|
|
131 | |
|
|
132 | The callback will get the actual pid and exit status as arguments. |
|
|
133 | |
|
|
134 | =item $w = AE::idle $cb |
|
|
135 | |
|
|
136 | Invoke the callback C<$cb> each time the event loop is "idle" (has no |
|
|
137 | events outstanding), but do not prevent the event loop from polling for |
|
|
138 | more events. |
|
|
139 | |
|
|
140 | =item $cv = AE::cv |
|
|
141 | |
|
|
142 | =item $cv = AE::cv { BLOCK } |
|
|
143 | |
|
|
144 | Create a new condition variable. The first form is identical to C<< |
|
|
145 | AnyEvent->condvar >>, the second form additionally sets the callback (as |
|
|
146 | if the C<cb> method is called on the condition variable). |
|
|
147 | |
|
|
148 | =item AE::now |
|
|
149 | |
|
|
150 | Returns the current event loop time (may be cached by the event loop). |
|
|
151 | |
|
|
152 | =item AE::now_update |
|
|
153 | |
|
|
154 | Ensures that the current event loop time is up to date. |
|
|
155 | |
|
|
156 | =item AE::time |
|
|
157 | |
|
|
158 | Return the current time (not cached, always consults a hardware clock). |
|
|
159 | |
|
|
160 | =item AE::postpone { BLOCK } |
|
|
161 | |
|
|
162 | Exactly the same as C<AnyEvent:::postpone>. |
|
|
163 | |
|
|
164 | =item AE::log $level, $msg[, @args] |
|
|
165 | |
|
|
166 | Exactly the same as C<AnyEvent::log> (or C<AnyEvent::Log::log>). |
|
|
167 | |
|
|
168 | =back |
| 27 | |
169 | |
| 28 | =head1 AUTHOR |
170 | =head1 AUTHOR |
| 29 | |
171 | |
| 30 | Marc Lehmann <schmorp@schmorp.de> |
172 | Marc Lehmann <schmorp@schmorp.de> |
| 31 | http://home.schmorp.de/ |
173 | http://anyevent.schmorp.de |
| 32 | |
174 | |
| 33 | =cut |
175 | =cut |
| 34 | |
176 | |
|
|
177 | 1 |
|
|
178 | |
