1 |
elmex |
1.1 |
package AnyEvent::Handle; |
2 |
|
|
|
3 |
elmex |
1.6 |
no warnings; |
4 |
elmex |
1.1 |
use strict; |
5 |
|
|
|
6 |
root |
1.8 |
use AnyEvent (); |
7 |
|
|
use AnyEvent::Util (); |
8 |
|
|
use Scalar::Util (); |
9 |
|
|
use Carp (); |
10 |
|
|
use Fcntl (); |
11 |
elmex |
1.1 |
use Errno qw/EAGAIN EINTR/; |
12 |
|
|
|
13 |
|
|
=head1 NAME |
14 |
|
|
|
15 |
root |
1.22 |
AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent |
16 |
elmex |
1.1 |
|
17 |
root |
1.15 |
This module is experimental. |
18 |
|
|
|
19 |
elmex |
1.1 |
=cut |
20 |
|
|
|
21 |
root |
1.15 |
our $VERSION = '0.04'; |
22 |
elmex |
1.1 |
|
23 |
|
|
=head1 SYNOPSIS |
24 |
|
|
|
25 |
|
|
use AnyEvent; |
26 |
|
|
use AnyEvent::Handle; |
27 |
|
|
|
28 |
|
|
my $cv = AnyEvent->condvar; |
29 |
|
|
|
30 |
|
|
my $ae_fh = AnyEvent::Handle->new (fh => \*STDIN); |
31 |
|
|
|
32 |
root |
1.8 |
#TODO |
33 |
elmex |
1.1 |
|
34 |
elmex |
1.2 |
# or use the constructor to pass the callback: |
35 |
|
|
|
36 |
|
|
my $ae_fh2 = |
37 |
|
|
AnyEvent::Handle->new ( |
38 |
|
|
fh => \*STDIN, |
39 |
|
|
on_eof => sub { |
40 |
|
|
$cv->broadcast; |
41 |
|
|
}, |
42 |
root |
1.8 |
#TODO |
43 |
elmex |
1.2 |
); |
44 |
|
|
|
45 |
elmex |
1.1 |
$cv->wait; |
46 |
|
|
|
47 |
|
|
=head1 DESCRIPTION |
48 |
|
|
|
49 |
root |
1.8 |
This module is a helper module to make it easier to do event-based I/O on |
50 |
elmex |
1.13 |
filehandles. For utility functions for doing non-blocking connects and accepts |
51 |
|
|
on sockets see L<AnyEvent::Util>. |
52 |
root |
1.8 |
|
53 |
|
|
In the following, when the documentation refers to of "bytes" then this |
54 |
|
|
means characters. As sysread and syswrite are used for all I/O, their |
55 |
|
|
treatment of characters applies to this module as well. |
56 |
elmex |
1.1 |
|
57 |
root |
1.8 |
All callbacks will be invoked with the handle object as their first |
58 |
|
|
argument. |
59 |
elmex |
1.1 |
|
60 |
|
|
=head1 METHODS |
61 |
|
|
|
62 |
|
|
=over 4 |
63 |
|
|
|
64 |
|
|
=item B<new (%args)> |
65 |
|
|
|
66 |
root |
1.8 |
The constructor supports these arguments (all as key => value pairs). |
67 |
elmex |
1.1 |
|
68 |
|
|
=over 4 |
69 |
|
|
|
70 |
root |
1.8 |
=item fh => $filehandle [MANDATORY] |
71 |
elmex |
1.1 |
|
72 |
|
|
The filehandle this L<AnyEvent::Handle> object will operate on. |
73 |
|
|
|
74 |
root |
1.8 |
NOTE: The filehandle will be set to non-blocking (using |
75 |
|
|
AnyEvent::Util::fh_nonblocking). |
76 |
|
|
|
77 |
root |
1.16 |
=item on_eof => $cb->($self) |
78 |
root |
1.10 |
|
79 |
|
|
Set the callback to be called on EOF. |
80 |
root |
1.8 |
|
81 |
root |
1.16 |
While not mandatory, it is highly recommended to set an eof callback, |
82 |
|
|
otherwise you might end up with a closed socket while you are still |
83 |
|
|
waiting for data. |
84 |
|
|
|
85 |
root |
1.10 |
=item on_error => $cb->($self) |
86 |
|
|
|
87 |
|
|
This is the fatal error callback, that is called when, well, a fatal error |
88 |
elmex |
1.20 |
occurs, such as not being able to resolve the hostname, failure to connect |
89 |
root |
1.10 |
or a read error. |
90 |
root |
1.8 |
|
91 |
|
|
The object will not be in a usable state when this callback has been |
92 |
|
|
called. |
93 |
|
|
|
94 |
root |
1.10 |
On callback entrance, the value of C<$!> contains the operating system |
95 |
root |
1.8 |
error (or C<ENOSPC> or C<EPIPE>). |
96 |
|
|
|
97 |
root |
1.10 |
While not mandatory, it is I<highly> recommended to set this callback, as |
98 |
|
|
you will not be notified of errors otherwise. The default simply calls |
99 |
|
|
die. |
100 |
root |
1.8 |
|
101 |
|
|
=item on_read => $cb->($self) |
102 |
|
|
|
103 |
|
|
This sets the default read callback, which is called when data arrives |
104 |
root |
1.10 |
and no read request is in the queue. |
105 |
root |
1.8 |
|
106 |
|
|
To access (and remove data from) the read buffer, use the C<< ->rbuf >> |
107 |
elmex |
1.20 |
method or access the C<$self->{rbuf}> member directly. |
108 |
root |
1.8 |
|
109 |
|
|
When an EOF condition is detected then AnyEvent::Handle will first try to |
110 |
|
|
feed all the remaining data to the queued callbacks and C<on_read> before |
111 |
|
|
calling the C<on_eof> callback. If no progress can be made, then a fatal |
112 |
|
|
error will be raised (with C<$!> set to C<EPIPE>). |
113 |
elmex |
1.1 |
|
114 |
root |
1.8 |
=item on_drain => $cb->() |
115 |
elmex |
1.1 |
|
116 |
root |
1.8 |
This sets the callback that is called when the write buffer becomes empty |
117 |
|
|
(or when the callback is set and the buffer is empty already). |
118 |
elmex |
1.1 |
|
119 |
root |
1.8 |
To append to the write buffer, use the C<< ->push_write >> method. |
120 |
elmex |
1.2 |
|
121 |
root |
1.8 |
=item rbuf_max => <bytes> |
122 |
elmex |
1.2 |
|
123 |
root |
1.8 |
If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>) |
124 |
|
|
when the read buffer ever (strictly) exceeds this size. This is useful to |
125 |
|
|
avoid denial-of-service attacks. |
126 |
elmex |
1.2 |
|
127 |
root |
1.8 |
For example, a server accepting connections from untrusted sources should |
128 |
|
|
be configured to accept only so-and-so much data that it cannot act on |
129 |
|
|
(for example, when expecting a line, an attacker could send an unlimited |
130 |
|
|
amount of data without a callback ever being called as long as the line |
131 |
|
|
isn't finished). |
132 |
elmex |
1.2 |
|
133 |
root |
1.8 |
=item read_size => <bytes> |
134 |
elmex |
1.2 |
|
135 |
root |
1.8 |
The default read block size (the amount of bytes this module will try to read |
136 |
|
|
on each [loop iteration). Default: C<4096>. |
137 |
|
|
|
138 |
|
|
=item low_water_mark => <bytes> |
139 |
|
|
|
140 |
|
|
Sets the amount of bytes (default: C<0>) that make up an "empty" write |
141 |
|
|
buffer: If the write reaches this size or gets even samller it is |
142 |
|
|
considered empty. |
143 |
elmex |
1.2 |
|
144 |
root |
1.19 |
=item tls => "accept" | "connect" | Net::SSLeay::SSL object |
145 |
|
|
|
146 |
|
|
When this parameter is given, it enables TLS (SSL) mode, that means it |
147 |
|
|
will start making tls handshake and will transparently encrypt/decrypt |
148 |
|
|
data. |
149 |
|
|
|
150 |
|
|
For the TLS server side, use C<accept>, and for the TLS client side of a |
151 |
|
|
connection, use C<connect> mode. |
152 |
|
|
|
153 |
|
|
You can also provide your own TLS connection object, but you have |
154 |
|
|
to make sure that you call either C<Net::SSLeay::set_connect_state> |
155 |
|
|
or C<Net::SSLeay::set_accept_state> on it before you pass it to |
156 |
|
|
AnyEvent::Handle. |
157 |
|
|
|
158 |
|
|
=item tls_ctx => $ssl_ctx |
159 |
|
|
|
160 |
|
|
Use the given Net::SSLeay::CTX object to create the new TLS connection |
161 |
|
|
(unless a connection object was specified directly). If this parameter is |
162 |
|
|
missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>. |
163 |
|
|
|
164 |
elmex |
1.1 |
=back |
165 |
|
|
|
166 |
|
|
=cut |
167 |
|
|
|
168 |
|
|
sub new { |
169 |
root |
1.8 |
my $class = shift; |
170 |
|
|
|
171 |
|
|
my $self = bless { @_ }, $class; |
172 |
|
|
|
173 |
|
|
$self->{fh} or Carp::croak "mandatory argument fh is missing"; |
174 |
|
|
|
175 |
|
|
AnyEvent::Util::fh_nonblocking $self->{fh}, 1; |
176 |
elmex |
1.1 |
|
177 |
root |
1.19 |
if ($self->{tls}) { |
178 |
|
|
require Net::SSLeay; |
179 |
|
|
$self->starttls (delete $self->{tls}, delete $self->{tls_ctx}); |
180 |
|
|
} |
181 |
|
|
|
182 |
root |
1.16 |
$self->on_eof (delete $self->{on_eof} ) if $self->{on_eof}; |
183 |
root |
1.10 |
$self->on_error (delete $self->{on_error}) if $self->{on_error}; |
184 |
root |
1.8 |
$self->on_drain (delete $self->{on_drain}) if $self->{on_drain}; |
185 |
|
|
$self->on_read (delete $self->{on_read} ) if $self->{on_read}; |
186 |
elmex |
1.1 |
|
187 |
root |
1.10 |
$self->start_read; |
188 |
|
|
|
189 |
root |
1.8 |
$self |
190 |
|
|
} |
191 |
elmex |
1.2 |
|
192 |
root |
1.8 |
sub _shutdown { |
193 |
|
|
my ($self) = @_; |
194 |
elmex |
1.2 |
|
195 |
root |
1.8 |
delete $self->{rw}; |
196 |
|
|
delete $self->{ww}; |
197 |
|
|
delete $self->{fh}; |
198 |
|
|
} |
199 |
|
|
|
200 |
|
|
sub error { |
201 |
|
|
my ($self) = @_; |
202 |
|
|
|
203 |
|
|
{ |
204 |
|
|
local $!; |
205 |
|
|
$self->_shutdown; |
206 |
elmex |
1.1 |
} |
207 |
|
|
|
208 |
root |
1.10 |
if ($self->{on_error}) { |
209 |
|
|
$self->{on_error}($self); |
210 |
|
|
} else { |
211 |
|
|
die "AnyEvent::Handle uncaught fatal error: $!"; |
212 |
|
|
} |
213 |
elmex |
1.1 |
} |
214 |
|
|
|
215 |
root |
1.8 |
=item $fh = $handle->fh |
216 |
elmex |
1.1 |
|
217 |
root |
1.22 |
This method returns the file handle of the L<AnyEvent::Handle> object. |
218 |
elmex |
1.1 |
|
219 |
|
|
=cut |
220 |
|
|
|
221 |
|
|
sub fh { $_[0]->{fh} } |
222 |
|
|
|
223 |
root |
1.8 |
=item $handle->on_error ($cb) |
224 |
elmex |
1.1 |
|
225 |
root |
1.8 |
Replace the current C<on_error> callback (see the C<on_error> constructor argument). |
226 |
elmex |
1.1 |
|
227 |
root |
1.8 |
=cut |
228 |
|
|
|
229 |
|
|
sub on_error { |
230 |
|
|
$_[0]{on_error} = $_[1]; |
231 |
|
|
} |
232 |
|
|
|
233 |
|
|
=item $handle->on_eof ($cb) |
234 |
|
|
|
235 |
|
|
Replace the current C<on_eof> callback (see the C<on_eof> constructor argument). |
236 |
elmex |
1.1 |
|
237 |
|
|
=cut |
238 |
|
|
|
239 |
root |
1.8 |
sub on_eof { |
240 |
|
|
$_[0]{on_eof} = $_[1]; |
241 |
|
|
} |
242 |
|
|
|
243 |
root |
1.9 |
############################################################################# |
244 |
|
|
|
245 |
|
|
=back |
246 |
|
|
|
247 |
|
|
=head2 WRITE QUEUE |
248 |
|
|
|
249 |
|
|
AnyEvent::Handle manages two queues per handle, one for writing and one |
250 |
|
|
for reading. |
251 |
|
|
|
252 |
|
|
The write queue is very simple: you can add data to its end, and |
253 |
|
|
AnyEvent::Handle will automatically try to get rid of it for you. |
254 |
|
|
|
255 |
elmex |
1.20 |
When data could be written and the write buffer is shorter then the low |
256 |
root |
1.9 |
water mark, the C<on_drain> callback will be invoked. |
257 |
|
|
|
258 |
|
|
=over 4 |
259 |
|
|
|
260 |
root |
1.8 |
=item $handle->on_drain ($cb) |
261 |
|
|
|
262 |
|
|
Sets the C<on_drain> callback or clears it (see the description of |
263 |
|
|
C<on_drain> in the constructor). |
264 |
|
|
|
265 |
|
|
=cut |
266 |
|
|
|
267 |
|
|
sub on_drain { |
268 |
elmex |
1.1 |
my ($self, $cb) = @_; |
269 |
|
|
|
270 |
root |
1.8 |
$self->{on_drain} = $cb; |
271 |
|
|
|
272 |
|
|
$cb->($self) |
273 |
|
|
if $cb && $self->{low_water_mark} >= length $self->{wbuf}; |
274 |
|
|
} |
275 |
|
|
|
276 |
|
|
=item $handle->push_write ($data) |
277 |
|
|
|
278 |
|
|
Queues the given scalar to be written. You can push as much data as you |
279 |
|
|
want (only limited by the available memory), as C<AnyEvent::Handle> |
280 |
|
|
buffers it independently of the kernel. |
281 |
|
|
|
282 |
|
|
=cut |
283 |
|
|
|
284 |
root |
1.17 |
sub _drain_wbuf { |
285 |
|
|
my ($self) = @_; |
286 |
root |
1.8 |
|
287 |
|
|
unless ($self->{ww}) { |
288 |
|
|
Scalar::Util::weaken $self; |
289 |
|
|
my $cb = sub { |
290 |
|
|
my $len = syswrite $self->{fh}, $self->{wbuf}; |
291 |
|
|
|
292 |
|
|
if ($len > 0) { |
293 |
|
|
substr $self->{wbuf}, 0, $len, ""; |
294 |
|
|
|
295 |
|
|
$self->{on_drain}($self) |
296 |
|
|
if $self->{low_water_mark} >= length $self->{wbuf} |
297 |
|
|
&& $self->{on_drain}; |
298 |
|
|
|
299 |
|
|
delete $self->{ww} unless length $self->{wbuf}; |
300 |
|
|
} elsif ($! != EAGAIN && $! != EINTR) { |
301 |
|
|
$self->error; |
302 |
elmex |
1.1 |
} |
303 |
root |
1.8 |
}; |
304 |
|
|
|
305 |
|
|
$self->{ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb); |
306 |
|
|
|
307 |
|
|
$cb->($self); |
308 |
|
|
}; |
309 |
|
|
} |
310 |
|
|
|
311 |
root |
1.17 |
sub push_write { |
312 |
|
|
my $self = shift; |
313 |
|
|
|
314 |
|
|
if ($self->{filter_w}) { |
315 |
root |
1.18 |
$self->{filter_w}->($self, \$_[0]); |
316 |
root |
1.17 |
} else { |
317 |
|
|
$self->{wbuf} .= $_[0]; |
318 |
|
|
$self->_drain_wbuf; |
319 |
|
|
} |
320 |
|
|
} |
321 |
|
|
|
322 |
root |
1.8 |
############################################################################# |
323 |
|
|
|
324 |
root |
1.9 |
=back |
325 |
|
|
|
326 |
|
|
=head2 READ QUEUE |
327 |
|
|
|
328 |
|
|
AnyEvent::Handle manages two queues per handle, one for writing and one |
329 |
|
|
for reading. |
330 |
|
|
|
331 |
|
|
The read queue is more complex than the write queue. It can be used in two |
332 |
|
|
ways, the "simple" way, using only C<on_read> and the "complex" way, using |
333 |
|
|
a queue. |
334 |
|
|
|
335 |
|
|
In the simple case, you just install an C<on_read> callback and whenever |
336 |
|
|
new data arrives, it will be called. You can then remove some data (if |
337 |
|
|
enough is there) from the read buffer (C<< $handle->rbuf >>) if you want |
338 |
|
|
or not. |
339 |
|
|
|
340 |
|
|
In the more complex case, you want to queue multiple callbacks. In this |
341 |
|
|
case, AnyEvent::Handle will call the first queued callback each time new |
342 |
|
|
data arrives and removes it when it has done its job (see C<push_read>, |
343 |
|
|
below). |
344 |
|
|
|
345 |
|
|
This way you can, for example, push three line-reads, followed by reading |
346 |
|
|
a chunk of data, and AnyEvent::Handle will execute them in order. |
347 |
|
|
|
348 |
|
|
Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by |
349 |
|
|
the specified number of bytes which give an XML datagram. |
350 |
|
|
|
351 |
|
|
# in the default state, expect some header bytes |
352 |
|
|
$handle->on_read (sub { |
353 |
|
|
# some data is here, now queue the length-header-read (4 octets) |
354 |
|
|
shift->unshift_read_chunk (4, sub { |
355 |
|
|
# header arrived, decode |
356 |
|
|
my $len = unpack "N", $_[1]; |
357 |
|
|
|
358 |
|
|
# now read the payload |
359 |
|
|
shift->unshift_read_chunk ($len, sub { |
360 |
|
|
my $xml = $_[1]; |
361 |
|
|
# handle xml |
362 |
|
|
}); |
363 |
|
|
}); |
364 |
|
|
}); |
365 |
|
|
|
366 |
|
|
Example 2: Implement a client for a protocol that replies either with |
367 |
|
|
"OK" and another line or "ERROR" for one request, and 64 bytes for the |
368 |
|
|
second request. Due tot he availability of a full queue, we can just |
369 |
|
|
pipeline sending both requests and manipulate the queue as necessary in |
370 |
|
|
the callbacks: |
371 |
|
|
|
372 |
|
|
# request one |
373 |
|
|
$handle->push_write ("request 1\015\012"); |
374 |
|
|
|
375 |
|
|
# we expect "ERROR" or "OK" as response, so push a line read |
376 |
|
|
$handle->push_read_line (sub { |
377 |
|
|
# if we got an "OK", we have to _prepend_ another line, |
378 |
|
|
# so it will be read before the second request reads its 64 bytes |
379 |
|
|
# which are already in the queue when this callback is called |
380 |
|
|
# we don't do this in case we got an error |
381 |
|
|
if ($_[1] eq "OK") { |
382 |
|
|
$_[0]->unshift_read_line (sub { |
383 |
|
|
my $response = $_[1]; |
384 |
|
|
... |
385 |
|
|
}); |
386 |
|
|
} |
387 |
|
|
}); |
388 |
|
|
|
389 |
|
|
# request two |
390 |
|
|
$handle->push_write ("request 2\015\012"); |
391 |
|
|
|
392 |
|
|
# simply read 64 bytes, always |
393 |
|
|
$handle->push_read_chunk (64, sub { |
394 |
|
|
my $response = $_[1]; |
395 |
|
|
... |
396 |
|
|
}); |
397 |
|
|
|
398 |
|
|
=over 4 |
399 |
|
|
|
400 |
root |
1.10 |
=cut |
401 |
|
|
|
402 |
root |
1.8 |
sub _drain_rbuf { |
403 |
|
|
my ($self) = @_; |
404 |
elmex |
1.1 |
|
405 |
root |
1.17 |
if ( |
406 |
|
|
defined $self->{rbuf_max} |
407 |
|
|
&& $self->{rbuf_max} < length $self->{rbuf} |
408 |
|
|
) { |
409 |
|
|
$! = &Errno::ENOSPC; return $self->error; |
410 |
|
|
} |
411 |
|
|
|
412 |
root |
1.11 |
return if $self->{in_drain}; |
413 |
root |
1.8 |
local $self->{in_drain} = 1; |
414 |
elmex |
1.1 |
|
415 |
root |
1.8 |
while (my $len = length $self->{rbuf}) { |
416 |
|
|
no strict 'refs'; |
417 |
root |
1.10 |
if (my $cb = shift @{ $self->{queue} }) { |
418 |
|
|
if (!$cb->($self)) { |
419 |
|
|
if ($self->{eof}) { |
420 |
|
|
# no progress can be made (not enough data and no data forthcoming) |
421 |
|
|
$! = &Errno::EPIPE; return $self->error; |
422 |
|
|
} |
423 |
|
|
|
424 |
|
|
unshift @{ $self->{queue} }, $cb; |
425 |
root |
1.8 |
return; |
426 |
|
|
} |
427 |
|
|
} elsif ($self->{on_read}) { |
428 |
|
|
$self->{on_read}($self); |
429 |
|
|
|
430 |
|
|
if ( |
431 |
|
|
$self->{eof} # if no further data will arrive |
432 |
|
|
&& $len == length $self->{rbuf} # and no data has been consumed |
433 |
|
|
&& !@{ $self->{queue} } # and the queue is still empty |
434 |
|
|
&& $self->{on_read} # and we still want to read data |
435 |
|
|
) { |
436 |
|
|
# then no progress can be made |
437 |
|
|
$! = &Errno::EPIPE; return $self->error; |
438 |
elmex |
1.1 |
} |
439 |
root |
1.8 |
} else { |
440 |
|
|
# read side becomes idle |
441 |
|
|
delete $self->{rw}; |
442 |
|
|
return; |
443 |
|
|
} |
444 |
|
|
} |
445 |
|
|
|
446 |
|
|
if ($self->{eof}) { |
447 |
|
|
$self->_shutdown; |
448 |
root |
1.16 |
$self->{on_eof}($self) |
449 |
|
|
if $self->{on_eof}; |
450 |
root |
1.8 |
} |
451 |
elmex |
1.1 |
} |
452 |
|
|
|
453 |
root |
1.8 |
=item $handle->on_read ($cb) |
454 |
elmex |
1.1 |
|
455 |
root |
1.8 |
This replaces the currently set C<on_read> callback, or clears it (when |
456 |
|
|
the new callback is C<undef>). See the description of C<on_read> in the |
457 |
|
|
constructor. |
458 |
elmex |
1.1 |
|
459 |
root |
1.8 |
=cut |
460 |
|
|
|
461 |
|
|
sub on_read { |
462 |
|
|
my ($self, $cb) = @_; |
463 |
elmex |
1.1 |
|
464 |
root |
1.8 |
$self->{on_read} = $cb; |
465 |
elmex |
1.1 |
} |
466 |
|
|
|
467 |
root |
1.8 |
=item $handle->rbuf |
468 |
|
|
|
469 |
|
|
Returns the read buffer (as a modifiable lvalue). |
470 |
elmex |
1.1 |
|
471 |
root |
1.8 |
You can access the read buffer directly as the C<< ->{rbuf} >> member, if |
472 |
|
|
you want. |
473 |
elmex |
1.1 |
|
474 |
root |
1.8 |
NOTE: The read buffer should only be used or modified if the C<on_read>, |
475 |
|
|
C<push_read> or C<unshift_read> methods are used. The other read methods |
476 |
|
|
automatically manage the read buffer. |
477 |
elmex |
1.1 |
|
478 |
|
|
=cut |
479 |
|
|
|
480 |
elmex |
1.2 |
sub rbuf : lvalue { |
481 |
root |
1.8 |
$_[0]{rbuf} |
482 |
elmex |
1.2 |
} |
483 |
elmex |
1.1 |
|
484 |
root |
1.8 |
=item $handle->push_read ($cb) |
485 |
|
|
|
486 |
|
|
=item $handle->unshift_read ($cb) |
487 |
|
|
|
488 |
|
|
Append the given callback to the end of the queue (C<push_read>) or |
489 |
|
|
prepend it (C<unshift_read>). |
490 |
|
|
|
491 |
|
|
The callback is called each time some additional read data arrives. |
492 |
elmex |
1.1 |
|
493 |
elmex |
1.20 |
It must check whether enough data is in the read buffer already. |
494 |
elmex |
1.1 |
|
495 |
root |
1.8 |
If not enough data is available, it must return the empty list or a false |
496 |
|
|
value, in which case it will be called repeatedly until enough data is |
497 |
|
|
available (or an error condition is detected). |
498 |
|
|
|
499 |
|
|
If enough data was available, then the callback must remove all data it is |
500 |
|
|
interested in (which can be none at all) and return a true value. After returning |
501 |
|
|
true, it will be removed from the queue. |
502 |
elmex |
1.1 |
|
503 |
|
|
=cut |
504 |
|
|
|
505 |
root |
1.8 |
sub push_read { |
506 |
|
|
my ($self, $cb) = @_; |
507 |
elmex |
1.1 |
|
508 |
root |
1.8 |
push @{ $self->{queue} }, $cb; |
509 |
|
|
$self->_drain_rbuf; |
510 |
elmex |
1.1 |
} |
511 |
|
|
|
512 |
root |
1.8 |
sub unshift_read { |
513 |
|
|
my ($self, $cb) = @_; |
514 |
|
|
|
515 |
|
|
push @{ $self->{queue} }, $cb; |
516 |
|
|
$self->_drain_rbuf; |
517 |
|
|
} |
518 |
elmex |
1.1 |
|
519 |
root |
1.8 |
=item $handle->push_read_chunk ($len, $cb->($self, $data)) |
520 |
elmex |
1.1 |
|
521 |
root |
1.8 |
=item $handle->unshift_read_chunk ($len, $cb->($self, $data)) |
522 |
elmex |
1.1 |
|
523 |
root |
1.8 |
Append the given callback to the end of the queue (C<push_read_chunk>) or |
524 |
|
|
prepend it (C<unshift_read_chunk>). |
525 |
elmex |
1.1 |
|
526 |
root |
1.8 |
The callback will be called only once C<$len> bytes have been read, and |
527 |
|
|
these C<$len> bytes will be passed to the callback. |
528 |
elmex |
1.1 |
|
529 |
|
|
=cut |
530 |
|
|
|
531 |
root |
1.8 |
sub _read_chunk($$) { |
532 |
root |
1.10 |
my ($self, $len, $cb) = @_; |
533 |
elmex |
1.1 |
|
534 |
root |
1.8 |
sub { |
535 |
|
|
$len <= length $_[0]{rbuf} or return; |
536 |
elmex |
1.12 |
$cb->($_[0], substr $_[0]{rbuf}, 0, $len, ""); |
537 |
root |
1.8 |
1 |
538 |
|
|
} |
539 |
|
|
} |
540 |
|
|
|
541 |
|
|
sub push_read_chunk { |
542 |
root |
1.10 |
$_[0]->push_read (&_read_chunk); |
543 |
root |
1.8 |
} |
544 |
elmex |
1.1 |
|
545 |
elmex |
1.5 |
|
546 |
root |
1.8 |
sub unshift_read_chunk { |
547 |
root |
1.10 |
$_[0]->unshift_read (&_read_chunk); |
548 |
elmex |
1.1 |
} |
549 |
|
|
|
550 |
root |
1.8 |
=item $handle->push_read_line ([$eol, ]$cb->($self, $line, $eol)) |
551 |
elmex |
1.1 |
|
552 |
root |
1.8 |
=item $handle->unshift_read_line ([$eol, ]$cb->($self, $line, $eol)) |
553 |
elmex |
1.1 |
|
554 |
root |
1.8 |
Append the given callback to the end of the queue (C<push_read_line>) or |
555 |
|
|
prepend it (C<unshift_read_line>). |
556 |
elmex |
1.1 |
|
557 |
root |
1.8 |
The callback will be called only once a full line (including the end of |
558 |
|
|
line marker, C<$eol>) has been read. This line (excluding the end of line |
559 |
|
|
marker) will be passed to the callback as second argument (C<$line>), and |
560 |
|
|
the end of line marker as the third argument (C<$eol>). |
561 |
elmex |
1.1 |
|
562 |
root |
1.8 |
The end of line marker, C<$eol>, can be either a string, in which case it |
563 |
|
|
will be interpreted as a fixed record end marker, or it can be a regex |
564 |
|
|
object (e.g. created by C<qr>), in which case it is interpreted as a |
565 |
|
|
regular expression. |
566 |
elmex |
1.1 |
|
567 |
root |
1.8 |
The end of line marker argument C<$eol> is optional, if it is missing (NOT |
568 |
|
|
undef), then C<qr|\015?\012|> is used (which is good for most internet |
569 |
|
|
protocols). |
570 |
elmex |
1.1 |
|
571 |
root |
1.8 |
Partial lines at the end of the stream will never be returned, as they are |
572 |
|
|
not marked by the end of line marker. |
573 |
elmex |
1.1 |
|
574 |
root |
1.8 |
=cut |
575 |
elmex |
1.1 |
|
576 |
root |
1.8 |
sub _read_line($$) { |
577 |
root |
1.10 |
my $self = shift; |
578 |
root |
1.8 |
my $cb = pop; |
579 |
|
|
my $eol = @_ ? shift : qr|(\015?\012)|; |
580 |
|
|
my $pos; |
581 |
elmex |
1.1 |
|
582 |
root |
1.14 |
$eol = quotemeta $eol unless ref $eol; |
583 |
|
|
$eol = qr|^(.*?)($eol)|s; |
584 |
elmex |
1.1 |
|
585 |
root |
1.8 |
sub { |
586 |
|
|
$_[0]{rbuf} =~ s/$eol// or return; |
587 |
elmex |
1.1 |
|
588 |
elmex |
1.12 |
$cb->($_[0], $1, $2); |
589 |
root |
1.8 |
1 |
590 |
|
|
} |
591 |
|
|
} |
592 |
elmex |
1.1 |
|
593 |
root |
1.8 |
sub push_read_line { |
594 |
root |
1.10 |
$_[0]->push_read (&_read_line); |
595 |
|
|
} |
596 |
|
|
|
597 |
|
|
sub unshift_read_line { |
598 |
|
|
$_[0]->unshift_read (&_read_line); |
599 |
|
|
} |
600 |
|
|
|
601 |
|
|
=item $handle->stop_read |
602 |
|
|
|
603 |
|
|
=item $handle->start_read |
604 |
|
|
|
605 |
root |
1.18 |
In rare cases you actually do not want to read anything from the |
606 |
root |
1.10 |
socket. In this case you can call C<stop_read>. Neither C<on_read> no |
607 |
root |
1.22 |
any queued callbacks will be executed then. To start reading again, call |
608 |
root |
1.10 |
C<start_read>. |
609 |
|
|
|
610 |
|
|
=cut |
611 |
|
|
|
612 |
|
|
sub stop_read { |
613 |
|
|
my ($self) = @_; |
614 |
elmex |
1.1 |
|
615 |
root |
1.10 |
delete $self->{rw}; |
616 |
root |
1.8 |
} |
617 |
elmex |
1.1 |
|
618 |
root |
1.10 |
sub start_read { |
619 |
|
|
my ($self) = @_; |
620 |
|
|
|
621 |
|
|
unless ($self->{rw} || $self->{eof}) { |
622 |
|
|
Scalar::Util::weaken $self; |
623 |
|
|
|
624 |
|
|
$self->{rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub { |
625 |
root |
1.17 |
my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf}; |
626 |
|
|
my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf; |
627 |
root |
1.10 |
|
628 |
|
|
if ($len > 0) { |
629 |
root |
1.17 |
$self->{filter_r} |
630 |
root |
1.18 |
? $self->{filter_r}->($self, $rbuf) |
631 |
root |
1.17 |
: $self->_drain_rbuf; |
632 |
root |
1.10 |
|
633 |
|
|
} elsif (defined $len) { |
634 |
root |
1.17 |
delete $self->{rw}; |
635 |
root |
1.10 |
$self->{eof} = 1; |
636 |
root |
1.17 |
$self->_drain_rbuf; |
637 |
root |
1.10 |
|
638 |
|
|
} elsif ($! != EAGAIN && $! != EINTR) { |
639 |
|
|
return $self->error; |
640 |
|
|
} |
641 |
|
|
}); |
642 |
|
|
} |
643 |
elmex |
1.1 |
} |
644 |
|
|
|
645 |
root |
1.19 |
sub _dotls { |
646 |
|
|
my ($self) = @_; |
647 |
|
|
|
648 |
|
|
if (length $self->{tls_wbuf}) { |
649 |
root |
1.22 |
while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{tls_wbuf})) > 0) { |
650 |
|
|
substr $self->{tls_wbuf}, 0, $len, ""; |
651 |
|
|
} |
652 |
root |
1.19 |
} |
653 |
|
|
|
654 |
|
|
if (defined (my $buf = Net::SSLeay::BIO_read ($self->{tls_wbio}))) { |
655 |
|
|
$self->{wbuf} .= $buf; |
656 |
|
|
$self->_drain_wbuf; |
657 |
|
|
} |
658 |
|
|
|
659 |
root |
1.23 |
while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) { |
660 |
|
|
$self->{rbuf} .= $buf; |
661 |
|
|
$self->_drain_rbuf; |
662 |
|
|
} |
663 |
|
|
|
664 |
root |
1.24 |
my $err = Net::SSLeay::get_error ($self->{tls}, -1); |
665 |
|
|
|
666 |
|
|
if ($err!= Net::SSLeay::ERROR_WANT_READ ()) { |
667 |
root |
1.23 |
if ($err == Net::SSLeay::ERROR_SYSCALL ()) { |
668 |
|
|
$self->error; |
669 |
|
|
} elsif ($err == Net::SSLeay::ERROR_SSL ()) { |
670 |
|
|
$! = &Errno::EIO; |
671 |
|
|
$self->error; |
672 |
root |
1.19 |
} |
673 |
root |
1.23 |
|
674 |
|
|
# all others are fine for our purposes |
675 |
root |
1.19 |
} |
676 |
|
|
} |
677 |
|
|
|
678 |
|
|
# TODO: maybe document... |
679 |
|
|
sub starttls { |
680 |
|
|
my ($self, $ssl, $ctx) = @_; |
681 |
|
|
|
682 |
|
|
if ($ssl eq "accept") { |
683 |
|
|
$ssl = Net::SSLeay::new ($ctx || TLS_CTX ()); |
684 |
|
|
Net::SSLeay::set_accept_state ($ssl); |
685 |
|
|
} elsif ($ssl eq "connect") { |
686 |
|
|
$ssl = Net::SSLeay::new ($ctx || TLS_CTX ()); |
687 |
|
|
Net::SSLeay::set_connect_state ($ssl); |
688 |
|
|
} |
689 |
|
|
|
690 |
|
|
$self->{tls} = $ssl; |
691 |
|
|
|
692 |
root |
1.21 |
# basically, this is deep magic (because SSL_read should have the same issues) |
693 |
|
|
# but the openssl maintainers basically said: "trust us, it just works". |
694 |
|
|
# (unfortunately, we have to hardcode constants because the abysmally misdesigned |
695 |
|
|
# and mismaintained ssleay-module doesn't even offer them). |
696 |
|
|
Net::SSLeay::CTX_set_mode ($self->{tls}, |
697 |
|
|
(eval { Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1) |
698 |
|
|
| (eval { Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2)); |
699 |
|
|
|
700 |
root |
1.19 |
$self->{tls_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
701 |
|
|
$self->{tls_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); |
702 |
|
|
|
703 |
|
|
Net::SSLeay::set_bio ($ssl, $self->{tls_rbio}, $self->{tls_wbio}); |
704 |
|
|
|
705 |
|
|
$self->{filter_w} = sub { |
706 |
|
|
$_[0]{tls_wbuf} .= ${$_[1]}; |
707 |
|
|
&_dotls; |
708 |
|
|
}; |
709 |
|
|
$self->{filter_r} = sub { |
710 |
|
|
Net::SSLeay::BIO_write ($_[0]{tls_rbio}, ${$_[1]}); |
711 |
|
|
&_dotls; |
712 |
|
|
}; |
713 |
|
|
} |
714 |
|
|
|
715 |
|
|
sub DESTROY { |
716 |
|
|
my $self = shift; |
717 |
|
|
|
718 |
|
|
Net::SSLeay::free (delete $self->{tls}) if $self->{tls}; |
719 |
|
|
} |
720 |
|
|
|
721 |
|
|
=item AnyEvent::Handle::TLS_CTX |
722 |
|
|
|
723 |
|
|
This function creates and returns the Net::SSLeay::CTX object used by |
724 |
|
|
default for TLS mode. |
725 |
|
|
|
726 |
|
|
The context is created like this: |
727 |
|
|
|
728 |
|
|
Net::SSLeay::load_error_strings; |
729 |
|
|
Net::SSLeay::SSLeay_add_ssl_algorithms; |
730 |
|
|
Net::SSLeay::randomize; |
731 |
|
|
|
732 |
|
|
my $CTX = Net::SSLeay::CTX_new; |
733 |
|
|
|
734 |
|
|
Net::SSLeay::CTX_set_options $CTX, Net::SSLeay::OP_ALL |
735 |
|
|
|
736 |
|
|
=cut |
737 |
|
|
|
738 |
|
|
our $TLS_CTX; |
739 |
|
|
|
740 |
|
|
sub TLS_CTX() { |
741 |
|
|
$TLS_CTX || do { |
742 |
|
|
require Net::SSLeay; |
743 |
|
|
|
744 |
|
|
Net::SSLeay::load_error_strings (); |
745 |
|
|
Net::SSLeay::SSLeay_add_ssl_algorithms (); |
746 |
|
|
Net::SSLeay::randomize (); |
747 |
|
|
|
748 |
|
|
$TLS_CTX = Net::SSLeay::CTX_new (); |
749 |
|
|
|
750 |
|
|
Net::SSLeay::CTX_set_options ($TLS_CTX, Net::SSLeay::OP_ALL ()); |
751 |
|
|
|
752 |
|
|
$TLS_CTX |
753 |
|
|
} |
754 |
|
|
} |
755 |
|
|
|
756 |
elmex |
1.1 |
=back |
757 |
|
|
|
758 |
|
|
=head1 AUTHOR |
759 |
|
|
|
760 |
root |
1.8 |
Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>. |
761 |
elmex |
1.1 |
|
762 |
|
|
=cut |
763 |
|
|
|
764 |
|
|
1; # End of AnyEvent::Handle |