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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.84 by root, Thu Aug 21 19:13:05 2008 UTC vs.
Revision 1.110 by root, Wed Jan 21 05:36:45 2009 UTC

14 14
15AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent 15AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent
16 16
17=cut 17=cut
18 18
19our $VERSION = 4.232; 19our $VERSION = 4.331;
20 20
21=head1 SYNOPSIS 21=head1 SYNOPSIS
22 22
23 use AnyEvent; 23 use AnyEvent;
24 use AnyEvent::Handle; 24 use AnyEvent::Handle;
27 27
28 my $handle = 28 my $handle =
29 AnyEvent::Handle->new ( 29 AnyEvent::Handle->new (
30 fh => \*STDIN, 30 fh => \*STDIN,
31 on_eof => sub { 31 on_eof => sub {
32 $cv->broadcast; 32 $cv->send;
33 }, 33 },
34 ); 34 );
35 35
36 # send some request line 36 # send some request line
37 $handle->push_write ("getinfo\015\012"); 37 $handle->push_write ("getinfo\015\012");
84Set the callback to be called when an end-of-file condition is detected, 84Set the callback to be called when an end-of-file condition is detected,
85i.e. in the case of a socket, when the other side has closed the 85i.e. in the case of a socket, when the other side has closed the
86connection cleanly. 86connection cleanly.
87 87
88For sockets, this just means that the other side has stopped sending data, 88For sockets, this just means that the other side has stopped sending data,
89you can still try to write data, and, in fact, one can return from the eof 89you can still try to write data, and, in fact, one can return from the EOF
90callback and continue writing data, as only the read part has been shut 90callback and continue writing data, as only the read part has been shut
91down. 91down.
92 92
93While not mandatory, it is I<highly> recommended to set an eof callback, 93While not mandatory, it is I<highly> recommended to set an EOF callback,
94otherwise you might end up with a closed socket while you are still 94otherwise you might end up with a closed socket while you are still
95waiting for data. 95waiting for data.
96 96
97If an EOF condition has been detected but no C<on_eof> callback has been 97If an EOF condition has been detected but no C<on_eof> callback has been
98set, then a fatal error will be raised with C<$!> set to <0>. 98set, then a fatal error will be raised with C<$!> set to <0>.
103occured, such as not being able to resolve the hostname, failure to 103occured, such as not being able to resolve the hostname, failure to
104connect or a read error. 104connect or a read error.
105 105
106Some errors are fatal (which is indicated by C<$fatal> being true). On 106Some errors are fatal (which is indicated by C<$fatal> being true). On
107fatal errors the handle object will be shut down and will not be usable 107fatal errors the handle object will be shut down and will not be usable
108(but you are free to look at the current C< ->rbuf >). Examples of fatal 108(but you are free to look at the current C<< ->rbuf >>). Examples of fatal
109errors are an EOF condition with active (but unsatisifable) read watchers 109errors are an EOF condition with active (but unsatisifable) read watchers
110(C<EPIPE>) or I/O errors. 110(C<EPIPE>) or I/O errors.
111 111
112Non-fatal errors can be retried by simply returning, but it is recommended 112Non-fatal errors can be retried by simply returning, but it is recommended
113to simply ignore this parameter and instead abondon the handle object 113to simply ignore this parameter and instead abondon the handle object
152=item timeout => $fractional_seconds 152=item timeout => $fractional_seconds
153 153
154If non-zero, then this enables an "inactivity" timeout: whenever this many 154If non-zero, then this enables an "inactivity" timeout: whenever this many
155seconds pass without a successful read or write on the underlying file 155seconds pass without a successful read or write on the underlying file
156handle, the C<on_timeout> callback will be invoked (and if that one is 156handle, the C<on_timeout> callback will be invoked (and if that one is
157missing, an C<ETIMEDOUT> error will be raised). 157missing, a non-fatal C<ETIMEDOUT> error will be raised).
158 158
159Note that timeout processing is also active when you currently do not have 159Note that timeout processing is also active when you currently do not have
160any outstanding read or write requests: If you plan to keep the connection 160any outstanding read or write requests: If you plan to keep the connection
161idle then you should disable the timout temporarily or ignore the timeout 161idle then you should disable the timout temporarily or ignore the timeout
162in the C<on_timeout> callback. 162in the C<on_timeout> callback, in which case AnyEvent::Handle will simply
163restart the timeout.
163 164
164Zero (the default) disables this timeout. 165Zero (the default) disables this timeout.
165 166
166=item on_timeout => $cb->($handle) 167=item on_timeout => $cb->($handle)
167 168
171 172
172=item rbuf_max => <bytes> 173=item rbuf_max => <bytes>
173 174
174If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>) 175If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)
175when the read buffer ever (strictly) exceeds this size. This is useful to 176when the read buffer ever (strictly) exceeds this size. This is useful to
176avoid denial-of-service attacks. 177avoid some forms of denial-of-service attacks.
177 178
178For example, a server accepting connections from untrusted sources should 179For example, a server accepting connections from untrusted sources should
179be configured to accept only so-and-so much data that it cannot act on 180be configured to accept only so-and-so much data that it cannot act on
180(for example, when expecting a line, an attacker could send an unlimited 181(for example, when expecting a line, an attacker could send an unlimited
181amount of data without a callback ever being called as long as the line 182amount of data without a callback ever being called as long as the line
182isn't finished). 183isn't finished).
183 184
184=item autocork => <boolean> 185=item autocork => <boolean>
185 186
186When disabled (the default), then C<push_write> will try to immediately 187When disabled (the default), then C<push_write> will try to immediately
187write the data to the handle if possible. This avoids having to register 188write the data to the handle, if possible. This avoids having to register
188a write watcher and wait for the next event loop iteration, but can be 189a write watcher and wait for the next event loop iteration, but can
189inefficient if you write multiple small chunks (this disadvantage is 190be inefficient if you write multiple small chunks (on the wire, this
190usually avoided by your kernel's nagle algorithm, see C<low_delay>). 191disadvantage is usually avoided by your kernel's nagle algorithm, see
192C<no_delay>, but this option can save costly syscalls).
191 193
192When enabled, then writes will always be queued till the next event loop 194When enabled, then writes will always be queued till the next event loop
193iteration. This is efficient when you do many small writes per iteration, 195iteration. This is efficient when you do many small writes per iteration,
194but less efficient when you do a single write only. 196but less efficient when you do a single write only per iteration (or when
197the write buffer often is full). It also increases write latency.
195 198
196=item no_delay => <boolean> 199=item no_delay => <boolean>
197 200
198When doing small writes on sockets, your operating system kernel might 201When doing small writes on sockets, your operating system kernel might
199wait a bit for more data before actually sending it out. This is called 202wait a bit for more data before actually sending it out. This is called
200the Nagle algorithm, and usually it is beneficial. 203the Nagle algorithm, and usually it is beneficial.
201 204
202In some situations you want as low a delay as possible, which cna be 205In some situations you want as low a delay as possible, which can be
203accomplishd by setting this option to true. 206accomplishd by setting this option to a true value.
204 207
205The default is your opertaing system's default behaviour, this option 208The default is your opertaing system's default behaviour (most likely
206explicitly enables or disables it, if possible. 209enabled), this option explicitly enables or disables it, if possible.
207 210
208=item read_size => <bytes> 211=item read_size => <bytes>
209 212
210The default read block size (the amount of bytes this module will try to read 213The default read block size (the amount of bytes this module will
211during each (loop iteration). Default: C<8192>. 214try to read during each loop iteration, which affects memory
215requirements). Default: C<8192>.
212 216
213=item low_water_mark => <bytes> 217=item low_water_mark => <bytes>
214 218
215Sets the amount of bytes (default: C<0>) that make up an "empty" write 219Sets the amount of bytes (default: C<0>) that make up an "empty" write
216buffer: If the write reaches this size or gets even samller it is 220buffer: If the write reaches this size or gets even samller it is
217considered empty. 221considered empty.
218 222
223Sometimes it can be beneficial (for performance reasons) to add data to
224the write buffer before it is fully drained, but this is a rare case, as
225the operating system kernel usually buffers data as well, so the default
226is good in almost all cases.
227
219=item linger => <seconds> 228=item linger => <seconds>
220 229
221If non-zero (default: C<3600>), then the destructor of the 230If non-zero (default: C<3600>), then the destructor of the
222AnyEvent::Handle object will check wether there is still outstanding write 231AnyEvent::Handle object will check whether there is still outstanding
223data and will install a watcher that will write out this data. No errors 232write data and will install a watcher that will write this data to the
224will be reported (this mostly matches how the operating system treats 233socket. No errors will be reported (this mostly matches how the operating
225outstanding data at socket close time). 234system treats outstanding data at socket close time).
226 235
227This will not work for partial TLS data that could not yet been 236This will not work for partial TLS data that could not be encoded
228encoded. This data will be lost. 237yet. This data will be lost. Calling the C<stoptls> method in time might
238help.
229 239
230=item tls => "accept" | "connect" | Net::SSLeay::SSL object 240=item tls => "accept" | "connect" | Net::SSLeay::SSL object
231 241
232When this parameter is given, it enables TLS (SSL) mode, that means it 242When this parameter is given, it enables TLS (SSL) mode, that means
233will start making tls handshake and will transparently encrypt/decrypt 243AnyEvent will start a TLS handshake as soon as the conenction has been
234data. 244established and will transparently encrypt/decrypt data afterwards.
235 245
236TLS mode requires Net::SSLeay to be installed (it will be loaded 246TLS mode requires Net::SSLeay to be installed (it will be loaded
237automatically when you try to create a TLS handle). 247automatically when you try to create a TLS handle): this module doesn't
248have a dependency on that module, so if your module requires it, you have
249to add the dependency yourself.
238 250
239For the TLS server side, use C<accept>, and for the TLS client side of a 251Unlike TCP, TLS has a server and client side: for the TLS server side, use
240connection, use C<connect> mode. 252C<accept>, and for the TLS client side of a connection, use C<connect>
253mode.
241 254
242You can also provide your own TLS connection object, but you have 255You can also provide your own TLS connection object, but you have
243to make sure that you call either C<Net::SSLeay::set_connect_state> 256to make sure that you call either C<Net::SSLeay::set_connect_state>
244or C<Net::SSLeay::set_accept_state> on it before you pass it to 257or C<Net::SSLeay::set_accept_state> on it before you pass it to
245AnyEvent::Handle. 258AnyEvent::Handle.
246 259
260B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,
261passing in the wrong integer will lead to certain crash. This most often
262happens when one uses a stylish C<< tls => 1 >> and is surprised about the
263segmentation fault.
264
247See the C<starttls> method if you need to start TLS negotiation later. 265See the C<< ->starttls >> method for when need to start TLS negotiation later.
248 266
249=item tls_ctx => $ssl_ctx 267=item tls_ctx => $ssl_ctx
250 268
251Use the given Net::SSLeay::CTX object to create the new TLS connection 269Use the given C<Net::SSLeay::CTX> object to create the new TLS connection
252(unless a connection object was specified directly). If this parameter is 270(unless a connection object was specified directly). If this parameter is
253missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>. 271missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
254 272
255=item json => JSON or JSON::XS object 273=item json => JSON or JSON::XS object
256 274
257This is the json coder object used by the C<json> read and write types. 275This is the json coder object used by the C<json> read and write types.
258 276
259If you don't supply it, then AnyEvent::Handle will create and use a 277If you don't supply it, then AnyEvent::Handle will create and use a
260suitable one, which will write and expect UTF-8 encoded JSON texts. 278suitable one (on demand), which will write and expect UTF-8 encoded JSON
279texts.
261 280
262Note that you are responsible to depend on the JSON module if you want to 281Note that you are responsible to depend on the JSON module if you want to
263use this functionality, as AnyEvent does not have a dependency itself. 282use this functionality, as AnyEvent does not have a dependency itself.
264 283
265=item filter_r => $cb
266
267=item filter_w => $cb
268
269These exist, but are undocumented at this time.
270
271=back 284=back
272 285
273=cut 286=cut
274 287
275sub new { 288sub new {
279 292
280 $self->{fh} or Carp::croak "mandatory argument fh is missing"; 293 $self->{fh} or Carp::croak "mandatory argument fh is missing";
281 294
282 AnyEvent::Util::fh_nonblocking $self->{fh}, 1; 295 AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
283 296
284 if ($self->{tls}) {
285 require Net::SSLeay;
286 $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}); 297 $self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
287 } 298 if $self->{tls};
288 299
289 $self->{_activity} = AnyEvent->now; 300 $self->{_activity} = AnyEvent->now;
290 $self->_timeout; 301 $self->_timeout;
291 302
292 $self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain}; 303 $self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};
304 delete $self->{_tw}; 315 delete $self->{_tw};
305 delete $self->{_rw}; 316 delete $self->{_rw};
306 delete $self->{_ww}; 317 delete $self->{_ww};
307 delete $self->{fh}; 318 delete $self->{fh};
308 319
309 $self->stoptls; 320 &_freetls;
310 321
311 delete $self->{on_read}; 322 delete $self->{on_read};
312 delete $self->{_queue}; 323 delete $self->{_queue};
313} 324}
314 325
320 331
321 $! = $errno; 332 $! = $errno;
322 333
323 if ($self->{on_error}) { 334 if ($self->{on_error}) {
324 $self->{on_error}($self, $fatal); 335 $self->{on_error}($self, $fatal);
325 } else { 336 } elsif ($self->{fh}) {
326 Carp::croak "AnyEvent::Handle uncaught error: $!"; 337 Carp::croak "AnyEvent::Handle uncaught error: $!";
327 } 338 }
328} 339}
329 340
330=item $fh = $handle->fh 341=item $fh = $handle->fh
331 342
332This method returns the file handle of the L<AnyEvent::Handle> object. 343This method returns the file handle used to create the L<AnyEvent::Handle> object.
333 344
334=cut 345=cut
335 346
336sub fh { $_[0]{fh} } 347sub fh { $_[0]{fh} }
337 348
355 $_[0]{on_eof} = $_[1]; 366 $_[0]{on_eof} = $_[1];
356} 367}
357 368
358=item $handle->on_timeout ($cb) 369=item $handle->on_timeout ($cb)
359 370
360Replace the current C<on_timeout> callback, or disables the callback 371Replace the current C<on_timeout> callback, or disables the callback (but
361(but not the timeout) if C<$cb> = C<undef>. See C<timeout> constructor 372not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
362argument. 373argument and method.
363 374
364=cut 375=cut
365 376
366sub on_timeout { 377sub on_timeout {
367 $_[0]{on_timeout} = $_[1]; 378 $_[0]{on_timeout} = $_[1];
368} 379}
369 380
370=item $handle->autocork ($boolean) 381=item $handle->autocork ($boolean)
371 382
372Enables or disables the current autocork behaviour (see C<autocork> 383Enables or disables the current autocork behaviour (see C<autocork>
373constructor argument). 384constructor argument). Changes will only take effect on the next write.
374 385
375=cut 386=cut
387
388sub autocork {
389 $_[0]{autocork} = $_[1];
390}
376 391
377=item $handle->no_delay ($boolean) 392=item $handle->no_delay ($boolean)
378 393
379Enables or disables the C<no_delay> setting (see constructor argument of 394Enables or disables the C<no_delay> setting (see constructor argument of
380the same name for details). 395the same name for details).
473 my ($self, $cb) = @_; 488 my ($self, $cb) = @_;
474 489
475 $self->{on_drain} = $cb; 490 $self->{on_drain} = $cb;
476 491
477 $cb->($self) 492 $cb->($self)
478 if $cb && $self->{low_water_mark} >= length $self->{wbuf}; 493 if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});
479} 494}
480 495
481=item $handle->push_write ($data) 496=item $handle->push_write ($data)
482 497
483Queues the given scalar to be written. You can push as much data as you 498Queues the given scalar to be written. You can push as much data as you
500 substr $self->{wbuf}, 0, $len, ""; 515 substr $self->{wbuf}, 0, $len, "";
501 516
502 $self->{_activity} = AnyEvent->now; 517 $self->{_activity} = AnyEvent->now;
503 518
504 $self->{on_drain}($self) 519 $self->{on_drain}($self)
505 if $self->{low_water_mark} >= length $self->{wbuf} 520 if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
506 && $self->{on_drain}; 521 && $self->{on_drain};
507 522
508 delete $self->{_ww} unless length $self->{wbuf}; 523 delete $self->{_ww} unless length $self->{wbuf};
509 } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) { 524 } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
510 $self->_error ($!, 1); 525 $self->_error ($!, 1);
534 549
535 @_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write") 550 @_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")
536 ->($self, @_); 551 ->($self, @_);
537 } 552 }
538 553
539 if ($self->{filter_w}) { 554 if ($self->{tls}) {
540 $self->{filter_w}($self, \$_[0]); 555 $self->{_tls_wbuf} .= $_[0];
556
557 &_dotls ($self);
541 } else { 558 } else {
542 $self->{wbuf} .= $_[0]; 559 $self->{wbuf} .= $_[0];
543 $self->_drain_wbuf; 560 $self->_drain_wbuf;
544 } 561 }
545} 562}
562=cut 579=cut
563 580
564register_write_type netstring => sub { 581register_write_type netstring => sub {
565 my ($self, $string) = @_; 582 my ($self, $string) = @_;
566 583
567 sprintf "%d:%s,", (length $string), $string 584 (length $string) . ":$string,"
568}; 585};
569 586
570=item packstring => $format, $data 587=item packstring => $format, $data
571 588
572An octet string prefixed with an encoded length. The encoding C<$format> 589An octet string prefixed with an encoded length. The encoding C<$format>
781 798
782 last; # more data might arrive 799 last; # more data might arrive
783 } 800 }
784 } else { 801 } else {
785 # read side becomes idle 802 # read side becomes idle
786 delete $self->{_rw}; 803 delete $self->{_rw} unless $self->{tls};
787 last; 804 last;
788 } 805 }
789 } 806 }
790 807
791 if ($self->{_eof}) { 808 if ($self->{_eof}) {
1086An octet string prefixed with an encoded length. The encoding C<$format> 1103An octet string prefixed with an encoded length. The encoding C<$format>
1087uses the same format as a Perl C<pack> format, but must specify a single 1104uses the same format as a Perl C<pack> format, but must specify a single
1088integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an 1105integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
1089optional C<!>, C<< < >> or C<< > >> modifier). 1106optional C<!>, C<< < >> or C<< > >> modifier).
1090 1107
1091DNS over TCP uses a prefix of C<n>, EPP uses a prefix of C<N>. 1108For example, DNS over TCP uses a prefix of C<n> (2 octet network order),
1109EPP uses a prefix of C<N> (4 octtes).
1092 1110
1093Example: read a block of data prefixed by its length in BER-encoded 1111Example: read a block of data prefixed by its length in BER-encoded
1094format (very efficient). 1112format (very efficient).
1095 1113
1096 $handle->push_read (packstring => "w", sub { 1114 $handle->push_read (packstring => "w", sub {
1126 } 1144 }
1127}; 1145};
1128 1146
1129=item json => $cb->($handle, $hash_or_arrayref) 1147=item json => $cb->($handle, $hash_or_arrayref)
1130 1148
1131Reads a JSON object or array, decodes it and passes it to the callback. 1149Reads a JSON object or array, decodes it and passes it to the
1150callback. When a parse error occurs, an C<EBADMSG> error will be raised.
1132 1151
1133If a C<json> object was passed to the constructor, then that will be used 1152If a C<json> object was passed to the constructor, then that will be used
1134for the final decode, otherwise it will create a JSON coder expecting UTF-8. 1153for the final decode, otherwise it will create a JSON coder expecting UTF-8.
1135 1154
1136This read type uses the incremental parser available with JSON version 1155This read type uses the incremental parser available with JSON version
1153 my $rbuf = \$self->{rbuf}; 1172 my $rbuf = \$self->{rbuf};
1154 1173
1155 my $json = $self->{json} ||= JSON->new->utf8; 1174 my $json = $self->{json} ||= JSON->new->utf8;
1156 1175
1157 sub { 1176 sub {
1177 eval {
1158 my $ref = $json->incr_parse ($self->{rbuf}); 1178 my $ref = $json->incr_parse ($self->{rbuf});
1159 1179
1160 if ($ref) { 1180 if ($ref) {
1181 $self->{rbuf} = $json->incr_text;
1182 $json->incr_text = "";
1183 $cb->($self, $ref);
1184
1185 1
1186 } else {
1187 $self->{rbuf} = "";
1188 ()
1189 }
1190
1191 1
1192 } or do {
1193 $json->incr_skip;
1194
1161 $self->{rbuf} = $json->incr_text; 1195 $self->{rbuf} = $json->incr_text;
1162 $json->incr_text = ""; 1196 $json->incr_text = "";
1163 $cb->($self, $ref);
1164 1197
1165 1 1198 $self->_error (&Errno::EBADMSG);
1166 } else {
1167 $self->{rbuf} = "";
1168 ()
1169 } 1199 };
1200
1170 } 1201 }
1171}; 1202};
1172 1203
1173=item storable => $cb->($handle, $ref) 1204=item storable => $cb->($handle, $ref)
1174 1205
1249Note that AnyEvent::Handle will automatically C<start_read> for you when 1280Note that AnyEvent::Handle will automatically C<start_read> for you when
1250you change the C<on_read> callback or push/unshift a read callback, and it 1281you change the C<on_read> callback or push/unshift a read callback, and it
1251will automatically C<stop_read> for you when neither C<on_read> is set nor 1282will automatically C<stop_read> for you when neither C<on_read> is set nor
1252there are any read requests in the queue. 1283there are any read requests in the queue.
1253 1284
1285These methods will have no effect when in TLS mode (as TLS doesn't support
1286half-duplex connections).
1287
1254=cut 1288=cut
1255 1289
1256sub stop_read { 1290sub stop_read {
1257 my ($self) = @_; 1291 my ($self) = @_;
1258 1292
1259 delete $self->{_rw}; 1293 delete $self->{_rw} unless $self->{tls};
1260} 1294}
1261 1295
1262sub start_read { 1296sub start_read {
1263 my ($self) = @_; 1297 my ($self) = @_;
1264 1298
1265 unless ($self->{_rw} || $self->{_eof}) { 1299 unless ($self->{_rw} || $self->{_eof}) {
1266 Scalar::Util::weaken $self; 1300 Scalar::Util::weaken $self;
1267 1301
1268 $self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub { 1302 $self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
1269 my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf}; 1303 my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1270 my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf; 1304 my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf;
1271 1305
1272 if ($len > 0) { 1306 if ($len > 0) {
1273 $self->{_activity} = AnyEvent->now; 1307 $self->{_activity} = AnyEvent->now;
1274 1308
1275 $self->{filter_r} 1309 if ($self->{tls}) {
1276 ? $self->{filter_r}($self, $rbuf) 1310 Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1277 : $self->{_in_drain} || $self->_drain_rbuf; 1311
1312 &_dotls ($self);
1313 } else {
1314 $self->_drain_rbuf unless $self->{_in_drain};
1315 }
1278 1316
1279 } elsif (defined $len) { 1317 } elsif (defined $len) {
1280 delete $self->{_rw}; 1318 delete $self->{_rw};
1281 $self->{_eof} = 1; 1319 $self->{_eof} = 1;
1282 $self->_drain_rbuf unless $self->{_in_drain}; 1320 $self->_drain_rbuf unless $self->{_in_drain};
1286 } 1324 }
1287 }); 1325 });
1288 } 1326 }
1289} 1327}
1290 1328
1329# poll the write BIO and send the data if applicable
1291sub _dotls { 1330sub _dotls {
1292 my ($self) = @_; 1331 my ($self) = @_;
1293 1332
1294 my $buf; 1333 my $tmp;
1295 1334
1296 if (length $self->{_tls_wbuf}) { 1335 if (length $self->{_tls_wbuf}) {
1297 while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) { 1336 while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1298 substr $self->{_tls_wbuf}, 0, $len, ""; 1337 substr $self->{_tls_wbuf}, 0, $tmp, "";
1299 } 1338 }
1300 } 1339 }
1301 1340
1302 if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1303 $self->{wbuf} .= $buf;
1304 $self->_drain_wbuf;
1305 }
1306
1307 while (defined ($buf = Net::SSLeay::read ($self->{tls}))) { 1341 while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
1308 if (length $buf) { 1342 unless (length $tmp) {
1309 $self->{rbuf} .= $buf;
1310 $self->_drain_rbuf unless $self->{_in_drain};
1311 } else {
1312 # let's treat SSL-eof as we treat normal EOF 1343 # let's treat SSL-eof as we treat normal EOF
1344 delete $self->{_rw};
1313 $self->{_eof} = 1; 1345 $self->{_eof} = 1;
1314 $self->_shutdown; 1346 &_freetls;
1315 return;
1316 } 1347 }
1317 }
1318 1348
1349 $self->{rbuf} .= $tmp;
1350 $self->_drain_rbuf unless $self->{_in_drain};
1351 $self->{tls} or return; # tls session might have gone away in callback
1352 }
1353
1319 my $err = Net::SSLeay::get_error ($self->{tls}, -1); 1354 $tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1320 1355
1321 if ($err!= Net::SSLeay::ERROR_WANT_READ ()) { 1356 if ($tmp != Net::SSLeay::ERROR_WANT_READ ()) {
1322 if ($err == Net::SSLeay::ERROR_SYSCALL ()) { 1357 if ($tmp == Net::SSLeay::ERROR_SYSCALL ()) {
1323 return $self->_error ($!, 1); 1358 return $self->_error ($!, 1);
1324 } elsif ($err == Net::SSLeay::ERROR_SSL ()) { 1359 } elsif ($tmp == Net::SSLeay::ERROR_SSL ()) {
1325 return $self->_error (&Errno::EIO, 1); 1360 return $self->_error (&Errno::EIO, 1);
1326 } 1361 }
1327 1362
1328 # all others are fine for our purposes 1363 # all other errors are fine for our purposes
1364 }
1365
1366 while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1367 $self->{wbuf} .= $tmp;
1368 $self->_drain_wbuf;
1329 } 1369 }
1330} 1370}
1331 1371
1332=item $handle->starttls ($tls[, $tls_ctx]) 1372=item $handle->starttls ($tls[, $tls_ctx])
1333 1373
1343 1383
1344The TLS connection object will end up in C<< $handle->{tls} >> after this 1384The TLS connection object will end up in C<< $handle->{tls} >> after this
1345call and can be used or changed to your liking. Note that the handshake 1385call and can be used or changed to your liking. Note that the handshake
1346might have already started when this function returns. 1386might have already started when this function returns.
1347 1387
1388If it an error to start a TLS handshake more than once per
1389AnyEvent::Handle object (this is due to bugs in OpenSSL).
1390
1348=cut 1391=cut
1349 1392
1350sub starttls { 1393sub starttls {
1351 my ($self, $ssl, $ctx) = @_; 1394 my ($self, $ssl, $ctx) = @_;
1352 1395
1353 $self->stoptls; 1396 require Net::SSLeay;
1354 1397
1398 Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"
1399 if $self->{tls};
1400
1355 if ($ssl eq "accept") { 1401 if ($ssl eq "accept") {
1356 $ssl = Net::SSLeay::new ($ctx || TLS_CTX ()); 1402 $ssl = Net::SSLeay::new ($ctx || TLS_CTX ());
1357 Net::SSLeay::set_accept_state ($ssl); 1403 Net::SSLeay::set_accept_state ($ssl);
1358 } elsif ($ssl eq "connect") { 1404 } elsif ($ssl eq "connect") {
1359 $ssl = Net::SSLeay::new ($ctx || TLS_CTX ()); 1405 $ssl = Net::SSLeay::new ($ctx || TLS_CTX ());
1365 # basically, this is deep magic (because SSL_read should have the same issues) 1411 # basically, this is deep magic (because SSL_read should have the same issues)
1366 # but the openssl maintainers basically said: "trust us, it just works". 1412 # but the openssl maintainers basically said: "trust us, it just works".
1367 # (unfortunately, we have to hardcode constants because the abysmally misdesigned 1413 # (unfortunately, we have to hardcode constants because the abysmally misdesigned
1368 # and mismaintained ssleay-module doesn't even offer them). 1414 # and mismaintained ssleay-module doesn't even offer them).
1369 # http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html 1415 # http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
1416 #
1417 # in short: this is a mess.
1418 #
1419 # note that we do not try to keep the length constant between writes as we are required to do.
1420 # we assume that most (but not all) of this insanity only applies to non-blocking cases,
1421 # and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
1422 # have identity issues in that area.
1370 Net::SSLeay::CTX_set_mode ($self->{tls}, 1423 Net::SSLeay::CTX_set_mode ($self->{tls},
1371 (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1) 1424 (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)
1372 | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2)); 1425 | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));
1373 1426
1374 $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); 1427 $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1375 $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); 1428 $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1376 1429
1377 Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio}); 1430 Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
1378 1431
1379 $self->{filter_w} = sub { 1432 &_dotls; # need to trigger the initial handshake
1380 $_[0]{_tls_wbuf} .= ${$_[1]}; 1433 $self->start_read; # make sure we actually do read
1381 &_dotls;
1382 };
1383 $self->{filter_r} = sub {
1384 Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});
1385 &_dotls;
1386 };
1387} 1434}
1388 1435
1389=item $handle->stoptls 1436=item $handle->stoptls
1390 1437
1391Destroys the SSL connection, if any. Partial read or write data will be 1438Shuts down the SSL connection - this makes a proper EOF handshake by
1392lost. 1439sending a close notify to the other side, but since OpenSSL doesn't
1440support non-blocking shut downs, it is not possible to re-use the stream
1441afterwards.
1393 1442
1394=cut 1443=cut
1395 1444
1396sub stoptls { 1445sub stoptls {
1397 my ($self) = @_; 1446 my ($self) = @_;
1398 1447
1448 if ($self->{tls}) {
1449 Net::SSLeay::shutdown ($self->{tls});
1450
1451 &_dotls;
1452
1453 # we don't give a shit. no, we do, but we can't. no...
1454 # we, we... have to use openssl :/
1455 &_freetls;
1456 }
1457}
1458
1459sub _freetls {
1460 my ($self) = @_;
1461
1462 return unless $self->{tls};
1463
1399 Net::SSLeay::free (delete $self->{tls}) if $self->{tls}; 1464 Net::SSLeay::free (delete $self->{tls});
1400 1465
1401 delete $self->{_rbio}; 1466 delete @$self{qw(_rbio _wbio _tls_wbuf)};
1402 delete $self->{_wbio};
1403 delete $self->{_tls_wbuf};
1404 delete $self->{filter_r};
1405 delete $self->{filter_w};
1406} 1467}
1407 1468
1408sub DESTROY { 1469sub DESTROY {
1409 my $self = shift; 1470 my $self = shift;
1410 1471
1411 $self->stoptls; 1472 &_freetls;
1412 1473
1413 my $linger = exists $self->{linger} ? $self->{linger} : 3600; 1474 my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1414 1475
1415 if ($linger && length $self->{wbuf}) { 1476 if ($linger && length $self->{wbuf}) {
1416 my $fh = delete $self->{fh}; 1477 my $fh = delete $self->{fh};
1431 @linger = (); 1492 @linger = ();
1432 }); 1493 });
1433 } 1494 }
1434} 1495}
1435 1496
1497=item $handle->destroy
1498
1499Shuts down the handle object as much as possible - this call ensures that
1500no further callbacks will be invoked and resources will be freed as much
1501as possible. You must not call any methods on the object afterwards.
1502
1503Normally, you can just "forget" any references to an AnyEvent::Handle
1504object and it will simply shut down. This works in fatal error and EOF
1505callbacks, as well as code outside. It does I<NOT> work in a read or write
1506callback, so when you want to destroy the AnyEvent::Handle object from
1507within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
1508that case.
1509
1510The handle might still linger in the background and write out remaining
1511data, as specified by the C<linger> option, however.
1512
1513=cut
1514
1515sub destroy {
1516 my ($self) = @_;
1517
1518 $self->DESTROY;
1519 %$self = ();
1520}
1521
1436=item AnyEvent::Handle::TLS_CTX 1522=item AnyEvent::Handle::TLS_CTX
1437 1523
1438This function creates and returns the Net::SSLeay::CTX object used by 1524This function creates and returns the Net::SSLeay::CTX object used by
1439default for TLS mode. 1525default for TLS mode.
1440 1526
1468 } 1554 }
1469} 1555}
1470 1556
1471=back 1557=back
1472 1558
1559
1560=head1 NONFREQUENTLY ASKED QUESTIONS
1561
1562=over 4
1563
1564=item I C<undef> the AnyEvent::Handle reference inside my callback and
1565still get further invocations!
1566
1567That's because AnyEvent::Handle keeps a reference to itself when handling
1568read or write callbacks.
1569
1570It is only safe to "forget" the reference inside EOF or error callbacks,
1571from within all other callbacks, you need to explicitly call the C<<
1572->destroy >> method.
1573
1574=item I get different callback invocations in TLS mode/Why can't I pause
1575reading?
1576
1577Unlike, say, TCP, TLS connections do not consist of two independent
1578communication channels, one for each direction. Or put differently. The
1579read and write directions are not independent of each other: you cannot
1580write data unless you are also prepared to read, and vice versa.
1581
1582This can mean than, in TLS mode, you might get C<on_error> or C<on_eof>
1583callback invocations when you are not expecting any read data - the reason
1584is that AnyEvent::Handle always reads in TLS mode.
1585
1586During the connection, you have to make sure that you always have a
1587non-empty read-queue, or an C<on_read> watcher. At the end of the
1588connection (or when you no longer want to use it) you can call the
1589C<destroy> method.
1590
1591=item How do I read data until the other side closes the connection?
1592
1593If you just want to read your data into a perl scalar, the easiest way
1594to achieve this is by setting an C<on_read> callback that does nothing,
1595clearing the C<on_eof> callback and in the C<on_error> callback, the data
1596will be in C<$_[0]{rbuf}>:
1597
1598 $handle->on_read (sub { });
1599 $handle->on_eof (undef);
1600 $handle->on_error (sub {
1601 my $data = delete $_[0]{rbuf};
1602 undef $handle;
1603 });
1604
1605The reason to use C<on_error> is that TCP connections, due to latencies
1606and packets loss, might get closed quite violently with an error, when in
1607fact, all data has been received.
1608
1609It is usually better to use acknowledgements when transferring data,
1610to make sure the other side hasn't just died and you got the data
1611intact. This is also one reason why so many internet protocols have an
1612explicit QUIT command.
1613
1614=item I don't want to destroy the handle too early - how do I wait until
1615all data has been written?
1616
1617After writing your last bits of data, set the C<on_drain> callback
1618and destroy the handle in there - with the default setting of
1619C<low_water_mark> this will be called precisely when all data has been
1620written to the socket:
1621
1622 $handle->push_write (...);
1623 $handle->on_drain (sub {
1624 warn "all data submitted to the kernel\n";
1625 undef $handle;
1626 });
1627
1628=back
1629
1630
1473=head1 SUBCLASSING AnyEvent::Handle 1631=head1 SUBCLASSING AnyEvent::Handle
1474 1632
1475In many cases, you might want to subclass AnyEvent::Handle. 1633In many cases, you might want to subclass AnyEvent::Handle.
1476 1634
1477To make this easier, a given version of AnyEvent::Handle uses these 1635To make this easier, a given version of AnyEvent::Handle uses these

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines