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.69 by root, Sun Jun 15 21:44:56 2008 UTC vs.
Revision 1.94 by root, Wed Oct 1 15:50:33 2008 UTC

1package AnyEvent::Handle; 1package AnyEvent::Handle;
2 2
3no warnings; 3no warnings;
4use strict; 4use strict qw(subs vars);
5 5
6use AnyEvent (); 6use AnyEvent ();
7use AnyEvent::Util qw(WSAEWOULDBLOCK); 7use AnyEvent::Util qw(WSAEWOULDBLOCK);
8use Scalar::Util (); 8use Scalar::Util ();
9use Carp (); 9use Carp ();
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.151; 19our $VERSION = 4.3;
20 20
21=head1 SYNOPSIS 21=head1 SYNOPSIS
22 22
23 use AnyEvent; 23 use AnyEvent;
24 use AnyEvent::Handle; 24 use AnyEvent::Handle;
49 49
50This module is a helper module to make it easier to do event-based I/O on 50This module is a helper module to make it easier to do event-based I/O on
51filehandles. For utility functions for doing non-blocking connects and accepts 51filehandles. For utility functions for doing non-blocking connects and accepts
52on sockets see L<AnyEvent::Util>. 52on sockets see L<AnyEvent::Util>.
53 53
54The L<AnyEvent::Intro> tutorial contains some well-documented
55AnyEvent::Handle examples.
56
54In the following, when the documentation refers to of "bytes" then this 57In the following, when the documentation refers to of "bytes" then this
55means characters. As sysread and syswrite are used for all I/O, their 58means characters. As sysread and syswrite are used for all I/O, their
56treatment of characters applies to this module as well. 59treatment of characters applies to this module as well.
57 60
58All callbacks will be invoked with the handle object as their first 61All callbacks will be invoked with the handle object as their first
59argument. 62argument.
60 63
64=head2 SIGPIPE is not handled by this module
65
66SIGPIPE is not handled by this module, so one of the practical
67requirements of using it is to ignore SIGPIPE (C<$SIG{PIPE} =
68'IGNORE'>). At least, this is highly recommend in a networked program: If
69you use AnyEvent::Handle in a filter program (like sort), exiting on
70SIGPIPE is probably the right thing to do.
71
61=head1 METHODS 72=head1 METHODS
62 73
63=over 4 74=over 4
64 75
65=item B<new (%args)> 76=item B<new (%args)>
70 81
71=item fh => $filehandle [MANDATORY] 82=item fh => $filehandle [MANDATORY]
72 83
73The filehandle this L<AnyEvent::Handle> object will operate on. 84The filehandle this L<AnyEvent::Handle> object will operate on.
74 85
75NOTE: The filehandle will be set to non-blocking (using 86NOTE: The filehandle will be set to non-blocking mode (using
76AnyEvent::Util::fh_nonblocking). 87C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in
88that mode.
77 89
78=item on_eof => $cb->($handle) 90=item on_eof => $cb->($handle)
79 91
80Set the callback to be called when an end-of-file condition is detcted, 92Set the callback to be called when an end-of-file condition is detected,
81i.e. in the case of a socket, when the other side has closed the 93i.e. in the case of a socket, when the other side has closed the
82connection cleanly. 94connection cleanly.
83 95
96For sockets, this just means that the other side has stopped sending data,
97you can still try to write data, and, in fact, one can return from the eof
98callback and continue writing data, as only the read part has been shut
99down.
100
84While not mandatory, it is highly recommended to set an eof callback, 101While not mandatory, it is I<highly> recommended to set an eof callback,
85otherwise you might end up with a closed socket while you are still 102otherwise you might end up with a closed socket while you are still
86waiting for data. 103waiting for data.
104
105If an EOF condition has been detected but no C<on_eof> callback has been
106set, then a fatal error will be raised with C<$!> set to <0>.
87 107
88=item on_error => $cb->($handle, $fatal) 108=item on_error => $cb->($handle, $fatal)
89 109
90This is the error callback, which is called when, well, some error 110This is the error callback, which is called when, well, some error
91occured, such as not being able to resolve the hostname, failure to 111occured, such as not being able to resolve the hostname, failure to
92connect or a read error. 112connect or a read error.
93 113
94Some errors are fatal (which is indicated by C<$fatal> being true). On 114Some errors are fatal (which is indicated by C<$fatal> being true). On
95fatal errors the handle object will be shut down and will not be 115fatal errors the handle object will be shut down and will not be usable
116(but you are free to look at the current C<< ->rbuf >>). Examples of fatal
117errors are an EOF condition with active (but unsatisifable) read watchers
118(C<EPIPE>) or I/O errors.
119
96usable. Non-fatal errors can be retried by simply returning, but it is 120Non-fatal errors can be retried by simply returning, but it is recommended
97recommended to simply ignore this parameter and instead abondon the handle 121to simply ignore this parameter and instead abondon the handle object
98object when this callback is invoked. 122when this callback is invoked. Examples of non-fatal errors are timeouts
123C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
99 124
100On callback entrance, the value of C<$!> contains the operating system 125On callback entrance, the value of C<$!> contains the operating system
101error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>). 126error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).
102 127
103While not mandatory, it is I<highly> recommended to set this callback, as 128While not mandatory, it is I<highly> recommended to set this callback, as
135=item timeout => $fractional_seconds 160=item timeout => $fractional_seconds
136 161
137If non-zero, then this enables an "inactivity" timeout: whenever this many 162If non-zero, then this enables an "inactivity" timeout: whenever this many
138seconds pass without a successful read or write on the underlying file 163seconds pass without a successful read or write on the underlying file
139handle, the C<on_timeout> callback will be invoked (and if that one is 164handle, the C<on_timeout> callback will be invoked (and if that one is
140missing, an C<ETIMEDOUT> error will be raised). 165missing, a non-fatal C<ETIMEDOUT> error will be raised).
141 166
142Note that timeout processing is also active when you currently do not have 167Note that timeout processing is also active when you currently do not have
143any outstanding read or write requests: If you plan to keep the connection 168any outstanding read or write requests: If you plan to keep the connection
144idle then you should disable the timout temporarily or ignore the timeout 169idle then you should disable the timout temporarily or ignore the timeout
145in the C<on_timeout> callback. 170in the C<on_timeout> callback, in which case AnyEvent::Handle will simply
171restart the timeout.
146 172
147Zero (the default) disables this timeout. 173Zero (the default) disables this timeout.
148 174
149=item on_timeout => $cb->($handle) 175=item on_timeout => $cb->($handle)
150 176
154 180
155=item rbuf_max => <bytes> 181=item rbuf_max => <bytes>
156 182
157If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>) 183If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)
158when the read buffer ever (strictly) exceeds this size. This is useful to 184when the read buffer ever (strictly) exceeds this size. This is useful to
159avoid denial-of-service attacks. 185avoid some forms of denial-of-service attacks.
160 186
161For example, a server accepting connections from untrusted sources should 187For example, a server accepting connections from untrusted sources should
162be configured to accept only so-and-so much data that it cannot act on 188be configured to accept only so-and-so much data that it cannot act on
163(for example, when expecting a line, an attacker could send an unlimited 189(for example, when expecting a line, an attacker could send an unlimited
164amount of data without a callback ever being called as long as the line 190amount of data without a callback ever being called as long as the line
165isn't finished). 191isn't finished).
166 192
193=item autocork => <boolean>
194
195When disabled (the default), then C<push_write> will try to immediately
196write the data to the handle, if possible. This avoids having to register
197a write watcher and wait for the next event loop iteration, but can
198be inefficient if you write multiple small chunks (on the wire, this
199disadvantage is usually avoided by your kernel's nagle algorithm, see
200C<no_delay>, but this option can save costly syscalls).
201
202When enabled, then writes will always be queued till the next event loop
203iteration. This is efficient when you do many small writes per iteration,
204but less efficient when you do a single write only per iteration (or when
205the write buffer often is full). It also increases write latency.
206
207=item no_delay => <boolean>
208
209When doing small writes on sockets, your operating system kernel might
210wait a bit for more data before actually sending it out. This is called
211the Nagle algorithm, and usually it is beneficial.
212
213In some situations you want as low a delay as possible, which can be
214accomplishd by setting this option to a true value.
215
216The default is your opertaing system's default behaviour (most likely
217enabled), this option explicitly enables or disables it, if possible.
218
167=item read_size => <bytes> 219=item read_size => <bytes>
168 220
169The default read block size (the amount of bytes this module will try to read 221The default read block size (the amount of bytes this module will
170during each (loop iteration). Default: C<8192>. 222try to read during each loop iteration, which affects memory
223requirements). Default: C<8192>.
171 224
172=item low_water_mark => <bytes> 225=item low_water_mark => <bytes>
173 226
174Sets the amount of bytes (default: C<0>) that make up an "empty" write 227Sets the amount of bytes (default: C<0>) that make up an "empty" write
175buffer: If the write reaches this size or gets even samller it is 228buffer: If the write reaches this size or gets even samller it is
176considered empty. 229considered empty.
177 230
231Sometimes it can be beneficial (for performance reasons) to add data to
232the write buffer before it is fully drained, but this is a rare case, as
233the operating system kernel usually buffers data as well, so the default
234is good in almost all cases.
235
178=item linger => <seconds> 236=item linger => <seconds>
179 237
180If non-zero (default: C<3600>), then the destructor of the 238If non-zero (default: C<3600>), then the destructor of the
181AnyEvent::Handle object will check wether there is still outstanding write 239AnyEvent::Handle object will check whether there is still outstanding
182data and will install a watcher that will write out this data. No errors 240write data and will install a watcher that will write this data to the
183will be reported (this mostly matches how the operating system treats 241socket. No errors will be reported (this mostly matches how the operating
184outstanding data at socket close time). 242system treats outstanding data at socket close time).
185 243
186This will not work for partial TLS data that could not yet been 244This will not work for partial TLS data that could not be encoded
187encoded. This data will be lost. 245yet. This data will be lost. Calling the C<stoptls> method in time might
246help.
188 247
189=item tls => "accept" | "connect" | Net::SSLeay::SSL object 248=item tls => "accept" | "connect" | Net::SSLeay::SSL object
190 249
191When this parameter is given, it enables TLS (SSL) mode, that means it 250When this parameter is given, it enables TLS (SSL) mode, that means
192will start making tls handshake and will transparently encrypt/decrypt 251AnyEvent will start a TLS handshake as soon as the conenction has been
193data. 252established and will transparently encrypt/decrypt data afterwards.
194 253
195TLS mode requires Net::SSLeay to be installed (it will be loaded 254TLS mode requires Net::SSLeay to be installed (it will be loaded
196automatically when you try to create a TLS handle). 255automatically when you try to create a TLS handle): this module doesn't
256have a dependency on that module, so if your module requires it, you have
257to add the dependency yourself.
197 258
198For the TLS server side, use C<accept>, and for the TLS client side of a 259Unlike TCP, TLS has a server and client side: for the TLS server side, use
199connection, use C<connect> mode. 260C<accept>, and for the TLS client side of a connection, use C<connect>
261mode.
200 262
201You can also provide your own TLS connection object, but you have 263You can also provide your own TLS connection object, but you have
202to make sure that you call either C<Net::SSLeay::set_connect_state> 264to make sure that you call either C<Net::SSLeay::set_connect_state>
203or C<Net::SSLeay::set_accept_state> on it before you pass it to 265or C<Net::SSLeay::set_accept_state> on it before you pass it to
204AnyEvent::Handle. 266AnyEvent::Handle.
205 267
206See the C<starttls> method if you need to start TLs negotiation later. 268See the C<< ->starttls >> method for when need to start TLS negotiation later.
207 269
208=item tls_ctx => $ssl_ctx 270=item tls_ctx => $ssl_ctx
209 271
210Use the given Net::SSLeay::CTX object to create the new TLS connection 272Use the given C<Net::SSLeay::CTX> object to create the new TLS connection
211(unless a connection object was specified directly). If this parameter is 273(unless a connection object was specified directly). If this parameter is
212missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>. 274missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
213 275
214=item json => JSON or JSON::XS object 276=item json => JSON or JSON::XS object
215 277
216This is the json coder object used by the C<json> read and write types. 278This is the json coder object used by the C<json> read and write types.
217 279
218If you don't supply it, then AnyEvent::Handle will create and use a 280If you don't supply it, then AnyEvent::Handle will create and use a
219suitable one, which will write and expect UTF-8 encoded JSON texts. 281suitable one (on demand), which will write and expect UTF-8 encoded JSON
282texts.
220 283
221Note that you are responsible to depend on the JSON module if you want to 284Note that you are responsible to depend on the JSON module if you want to
222use this functionality, as AnyEvent does not have a dependency itself. 285use this functionality, as AnyEvent does not have a dependency itself.
223 286
224=item filter_r => $cb
225
226=item filter_w => $cb
227
228These exist, but are undocumented at this time.
229
230=back 287=back
231 288
232=cut 289=cut
233 290
234sub new { 291sub new {
238 295
239 $self->{fh} or Carp::croak "mandatory argument fh is missing"; 296 $self->{fh} or Carp::croak "mandatory argument fh is missing";
240 297
241 AnyEvent::Util::fh_nonblocking $self->{fh}, 1; 298 AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
242 299
243 if ($self->{tls}) {
244 require Net::SSLeay;
245 $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}); 300 $self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
246 } 301 if $self->{tls};
247 302
248 $self->{_activity} = AnyEvent->now; 303 $self->{_activity} = AnyEvent->now;
249 $self->_timeout; 304 $self->_timeout;
250 305
251 $self->on_drain (delete $self->{on_drain}) if $self->{on_drain}; 306 $self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};
307 $self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
252 308
253 $self->start_read 309 $self->start_read
254 if $self->{on_read}; 310 if $self->{on_read};
255 311
256 $self 312 $self
262 delete $self->{_tw}; 318 delete $self->{_tw};
263 delete $self->{_rw}; 319 delete $self->{_rw};
264 delete $self->{_ww}; 320 delete $self->{_ww};
265 delete $self->{fh}; 321 delete $self->{fh};
266 322
267 $self->stoptls; 323 &_freetls;
324
325 delete $self->{on_read};
326 delete $self->{_queue};
268} 327}
269 328
270sub _error { 329sub _error {
271 my ($self, $errno, $fatal) = @_; 330 my ($self, $errno, $fatal) = @_;
272 331
282 } 341 }
283} 342}
284 343
285=item $fh = $handle->fh 344=item $fh = $handle->fh
286 345
287This method returns the file handle of the L<AnyEvent::Handle> object. 346This method returns the file handle used to create the L<AnyEvent::Handle> object.
288 347
289=cut 348=cut
290 349
291sub fh { $_[0]{fh} } 350sub fh { $_[0]{fh} }
292 351
310 $_[0]{on_eof} = $_[1]; 369 $_[0]{on_eof} = $_[1];
311} 370}
312 371
313=item $handle->on_timeout ($cb) 372=item $handle->on_timeout ($cb)
314 373
315Replace the current C<on_timeout> callback, or disables the callback 374Replace the current C<on_timeout> callback, or disables the callback (but
316(but not the timeout) if C<$cb> = C<undef>. See C<timeout> constructor 375not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
317argument. 376argument and method.
318 377
319=cut 378=cut
320 379
321sub on_timeout { 380sub on_timeout {
322 $_[0]{on_timeout} = $_[1]; 381 $_[0]{on_timeout} = $_[1];
382}
383
384=item $handle->autocork ($boolean)
385
386Enables or disables the current autocork behaviour (see C<autocork>
387constructor argument).
388
389=cut
390
391=item $handle->no_delay ($boolean)
392
393Enables or disables the C<no_delay> setting (see constructor argument of
394the same name for details).
395
396=cut
397
398sub no_delay {
399 $_[0]{no_delay} = $_[1];
400
401 eval {
402 local $SIG{__DIE__};
403 setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];
404 };
323} 405}
324 406
325############################################################################# 407#############################################################################
326 408
327=item $handle->timeout ($seconds) 409=item $handle->timeout ($seconds)
405 my ($self, $cb) = @_; 487 my ($self, $cb) = @_;
406 488
407 $self->{on_drain} = $cb; 489 $self->{on_drain} = $cb;
408 490
409 $cb->($self) 491 $cb->($self)
410 if $cb && $self->{low_water_mark} >= length $self->{wbuf}; 492 if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});
411} 493}
412 494
413=item $handle->push_write ($data) 495=item $handle->push_write ($data)
414 496
415Queues the given scalar to be written. You can push as much data as you 497Queues the given scalar to be written. You can push as much data as you
432 substr $self->{wbuf}, 0, $len, ""; 514 substr $self->{wbuf}, 0, $len, "";
433 515
434 $self->{_activity} = AnyEvent->now; 516 $self->{_activity} = AnyEvent->now;
435 517
436 $self->{on_drain}($self) 518 $self->{on_drain}($self)
437 if $self->{low_water_mark} >= length $self->{wbuf} 519 if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
438 && $self->{on_drain}; 520 && $self->{on_drain};
439 521
440 delete $self->{_ww} unless length $self->{wbuf}; 522 delete $self->{_ww} unless length $self->{wbuf};
441 } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) { 523 } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
442 $self->_error ($!, 1); 524 $self->_error ($!, 1);
443 } 525 }
444 }; 526 };
445 527
446 # try to write data immediately 528 # try to write data immediately
447 $cb->(); 529 $cb->() unless $self->{autocork};
448 530
449 # if still data left in wbuf, we need to poll 531 # if still data left in wbuf, we need to poll
450 $self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb) 532 $self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)
451 if length $self->{wbuf}; 533 if length $self->{wbuf};
452 }; 534 };
466 548
467 @_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write") 549 @_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")
468 ->($self, @_); 550 ->($self, @_);
469 } 551 }
470 552
471 if ($self->{filter_w}) { 553 if ($self->{tls}) {
472 $self->{filter_w}($self, \$_[0]); 554 $self->{_tls_wbuf} .= $_[0];
555 &_dotls ($self);
473 } else { 556 } else {
474 $self->{wbuf} .= $_[0]; 557 $self->{wbuf} .= $_[0];
475 $self->_drain_wbuf; 558 $self->_drain_wbuf;
476 } 559 }
477} 560}
678 761
679 if ( 762 if (
680 defined $self->{rbuf_max} 763 defined $self->{rbuf_max}
681 && $self->{rbuf_max} < length $self->{rbuf} 764 && $self->{rbuf_max} < length $self->{rbuf}
682 ) { 765 ) {
683 return $self->_error (&Errno::ENOSPC, 1); 766 $self->_error (&Errno::ENOSPC, 1), return;
684 } 767 }
685 768
686 while () { 769 while () {
687 no strict 'refs';
688
689 my $len = length $self->{rbuf}; 770 my $len = length $self->{rbuf};
690 771
691 if (my $cb = shift @{ $self->{_queue} }) { 772 if (my $cb = shift @{ $self->{_queue} }) {
692 unless ($cb->($self)) { 773 unless ($cb->($self)) {
693 if ($self->{_eof}) { 774 if ($self->{_eof}) {
694 # no progress can be made (not enough data and no data forthcoming) 775 # no progress can be made (not enough data and no data forthcoming)
695 $self->_error (&Errno::EPIPE, 1), last; 776 $self->_error (&Errno::EPIPE, 1), return;
696 } 777 }
697 778
698 unshift @{ $self->{_queue} }, $cb; 779 unshift @{ $self->{_queue} }, $cb;
699 last; 780 last;
700 } 781 }
708 && !@{ $self->{_queue} } # and the queue is still empty 789 && !@{ $self->{_queue} } # and the queue is still empty
709 && $self->{on_read} # but we still have on_read 790 && $self->{on_read} # but we still have on_read
710 ) { 791 ) {
711 # no further data will arrive 792 # no further data will arrive
712 # so no progress can be made 793 # so no progress can be made
713 $self->_error (&Errno::EPIPE, 1), last 794 $self->_error (&Errno::EPIPE, 1), return
714 if $self->{_eof}; 795 if $self->{_eof};
715 796
716 last; # more data might arrive 797 last; # more data might arrive
717 } 798 }
718 } else { 799 } else {
719 # read side becomes idle 800 # read side becomes idle
720 delete $self->{_rw}; 801 delete $self->{_rw} unless $self->{tls};
721 last; 802 last;
722 } 803 }
723 } 804 }
724 805
806 if ($self->{_eof}) {
807 if ($self->{on_eof}) {
725 $self->{on_eof}($self) 808 $self->{on_eof}($self)
726 if $self->{_eof} && $self->{on_eof}; 809 } else {
810 $self->_error (0, 1);
811 }
812 }
727 813
728 # may need to restart read watcher 814 # may need to restart read watcher
729 unless ($self->{_rw}) { 815 unless ($self->{_rw}) {
730 $self->start_read 816 $self->start_read
731 if $self->{on_read} || @{ $self->{_queue} }; 817 if $self->{on_read} || @{ $self->{_queue} };
857 $cb->($_[0], substr $_[0]{rbuf}, 0, $len, ""); 943 $cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");
858 1 944 1
859 } 945 }
860}; 946};
861 947
862# compatibility with older API
863sub push_read_chunk {
864 $_[0]->push_read (chunk => $_[1], $_[2]);
865}
866
867sub unshift_read_chunk {
868 $_[0]->unshift_read (chunk => $_[1], $_[2]);
869}
870
871=item line => [$eol, ]$cb->($handle, $line, $eol) 948=item line => [$eol, ]$cb->($handle, $line, $eol)
872 949
873The callback will be called only once a full line (including the end of 950The callback will be called only once a full line (including the end of
874line marker, C<$eol>) has been read. This line (excluding the end of line 951line marker, C<$eol>) has been read. This line (excluding the end of line
875marker) will be passed to the callback as second argument (C<$line>), and 952marker) will be passed to the callback as second argument (C<$line>), and
890=cut 967=cut
891 968
892register_read_type line => sub { 969register_read_type line => sub {
893 my ($self, $cb, $eol) = @_; 970 my ($self, $cb, $eol) = @_;
894 971
895 $eol = qr|(\015?\012)| if @_ < 3; 972 if (@_ < 3) {
973 # this is more than twice as fast as the generic code below
974 sub {
975 $_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return;
976
977 $cb->($_[0], $1, $2);
978 1
979 }
980 } else {
896 $eol = quotemeta $eol unless ref $eol; 981 $eol = quotemeta $eol unless ref $eol;
897 $eol = qr|^(.*?)($eol)|s; 982 $eol = qr|^(.*?)($eol)|s;
898 983
899 sub { 984 sub {
900 $_[0]{rbuf} =~ s/$eol// or return; 985 $_[0]{rbuf} =~ s/$eol// or return;
901 986
902 $cb->($_[0], $1, $2); 987 $cb->($_[0], $1, $2);
988 1
903 1 989 }
904 } 990 }
905}; 991};
906
907# compatibility with older API
908sub push_read_line {
909 my $self = shift;
910 $self->push_read (line => @_);
911}
912
913sub unshift_read_line {
914 my $self = shift;
915 $self->unshift_read (line => @_);
916}
917 992
918=item regex => $accept[, $reject[, $skip], $cb->($handle, $data) 993=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
919 994
920Makes a regex match against the regex object C<$accept> and returns 995Makes a regex match against the regex object C<$accept> and returns
921everything up to and including the match. 996everything up to and including the match.
1042register_read_type packstring => sub { 1117register_read_type packstring => sub {
1043 my ($self, $cb, $format) = @_; 1118 my ($self, $cb, $format) = @_;
1044 1119
1045 sub { 1120 sub {
1046 # when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method 1121 # when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
1047 defined (my $len = eval { unpack $format, $_[0]->{rbuf} }) 1122 defined (my $len = eval { unpack $format, $_[0]{rbuf} })
1048 or return; 1123 or return;
1049 1124
1125 $format = length pack $format, $len;
1126
1127 # bypass unshift if we already have the remaining chunk
1128 if ($format + $len <= length $_[0]{rbuf}) {
1129 my $data = substr $_[0]{rbuf}, $format, $len;
1130 substr $_[0]{rbuf}, 0, $format + $len, "";
1131 $cb->($_[0], $data);
1132 } else {
1050 # remove prefix 1133 # remove prefix
1051 substr $_[0]->{rbuf}, 0, (length pack $format, $len), ""; 1134 substr $_[0]{rbuf}, 0, $format, "";
1052 1135
1053 # read rest 1136 # read remaining chunk
1054 $_[0]->unshift_read (chunk => $len, $cb); 1137 $_[0]->unshift_read (chunk => $len, $cb);
1138 }
1055 1139
1056 1 1140 1
1057 } 1141 }
1058}; 1142};
1059 1143
1116 1200
1117 require Storable; 1201 require Storable;
1118 1202
1119 sub { 1203 sub {
1120 # when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method 1204 # when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
1121 defined (my $len = eval { unpack "w", $_[0]->{rbuf} }) 1205 defined (my $len = eval { unpack "w", $_[0]{rbuf} })
1122 or return; 1206 or return;
1123 1207
1208 my $format = length pack "w", $len;
1209
1210 # bypass unshift if we already have the remaining chunk
1211 if ($format + $len <= length $_[0]{rbuf}) {
1212 my $data = substr $_[0]{rbuf}, $format, $len;
1213 substr $_[0]{rbuf}, 0, $format + $len, "";
1214 $cb->($_[0], Storable::thaw ($data));
1215 } else {
1124 # remove prefix 1216 # remove prefix
1125 substr $_[0]->{rbuf}, 0, (length pack "w", $len), ""; 1217 substr $_[0]{rbuf}, 0, $format, "";
1126 1218
1127 # read rest 1219 # read remaining chunk
1128 $_[0]->unshift_read (chunk => $len, sub { 1220 $_[0]->unshift_read (chunk => $len, sub {
1129 if (my $ref = eval { Storable::thaw ($_[1]) }) { 1221 if (my $ref = eval { Storable::thaw ($_[1]) }) {
1130 $cb->($_[0], $ref); 1222 $cb->($_[0], $ref);
1131 } else { 1223 } else {
1132 $self->_error (&Errno::EBADMSG); 1224 $self->_error (&Errno::EBADMSG);
1225 }
1133 } 1226 });
1134 }); 1227 }
1228
1229 1
1135 } 1230 }
1136}; 1231};
1137 1232
1138=back 1233=back
1139 1234
1169Note that AnyEvent::Handle will automatically C<start_read> for you when 1264Note that AnyEvent::Handle will automatically C<start_read> for you when
1170you change the C<on_read> callback or push/unshift a read callback, and it 1265you change the C<on_read> callback or push/unshift a read callback, and it
1171will automatically C<stop_read> for you when neither C<on_read> is set nor 1266will automatically C<stop_read> for you when neither C<on_read> is set nor
1172there are any read requests in the queue. 1267there are any read requests in the queue.
1173 1268
1269These methods will have no effect when in TLS mode (as TLS doesn't support
1270half-duplex connections).
1271
1174=cut 1272=cut
1175 1273
1176sub stop_read { 1274sub stop_read {
1177 my ($self) = @_; 1275 my ($self) = @_;
1178 1276
1179 delete $self->{_rw}; 1277 delete $self->{_rw} unless $self->{tls};
1180} 1278}
1181 1279
1182sub start_read { 1280sub start_read {
1183 my ($self) = @_; 1281 my ($self) = @_;
1184 1282
1185 unless ($self->{_rw} || $self->{_eof}) { 1283 unless ($self->{_rw} || $self->{_eof}) {
1186 Scalar::Util::weaken $self; 1284 Scalar::Util::weaken $self;
1187 1285
1188 $self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub { 1286 $self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
1189 my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf}; 1287 my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1190 my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf; 1288 my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf;
1191 1289
1192 if ($len > 0) { 1290 if ($len > 0) {
1193 $self->{_activity} = AnyEvent->now; 1291 $self->{_activity} = AnyEvent->now;
1194 1292
1195 $self->{filter_r} 1293 if ($self->{tls}) {
1196 ? $self->{filter_r}($self, $rbuf) 1294 Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1197 : $self->{_in_drain} || $self->_drain_rbuf; 1295 &_dotls ($self);
1296 } else {
1297 $self->_drain_rbuf unless $self->{_in_drain};
1298 }
1198 1299
1199 } elsif (defined $len) { 1300 } elsif (defined $len) {
1200 delete $self->{_rw}; 1301 delete $self->{_rw};
1201 $self->{_eof} = 1; 1302 $self->{_eof} = 1;
1202 $self->_drain_rbuf unless $self->{_in_drain}; 1303 $self->_drain_rbuf unless $self->{_in_drain};
1217 while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) { 1318 while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1218 substr $self->{_tls_wbuf}, 0, $len, ""; 1319 substr $self->{_tls_wbuf}, 0, $len, "";
1219 } 1320 }
1220 } 1321 }
1221 1322
1222 if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1223 $self->{wbuf} .= $buf;
1224 $self->_drain_wbuf;
1225 }
1226
1227 while (defined ($buf = Net::SSLeay::read ($self->{tls}))) { 1323 while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {
1228 if (length $buf) { 1324 unless (length $buf) {
1229 $self->{rbuf} .= $buf;
1230 $self->_drain_rbuf unless $self->{_in_drain};
1231 } else {
1232 # let's treat SSL-eof as we treat normal EOF 1325 # let's treat SSL-eof as we treat normal EOF
1326 delete $self->{_rw};
1233 $self->{_eof} = 1; 1327 $self->{_eof} = 1;
1234 $self->_shutdown; 1328 &_freetls;
1235 return;
1236 } 1329 }
1330
1331 $self->{rbuf} .= $buf;
1332 $self->_drain_rbuf unless $self->{_in_drain};
1333 $self->{tls} or return; # tls session might have gone away in callback
1237 } 1334 }
1238 1335
1239 my $err = Net::SSLeay::get_error ($self->{tls}, -1); 1336 my $err = Net::SSLeay::get_error ($self->{tls}, -1);
1240 1337
1241 if ($err!= Net::SSLeay::ERROR_WANT_READ ()) { 1338 if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
1245 return $self->_error (&Errno::EIO, 1); 1342 return $self->_error (&Errno::EIO, 1);
1246 } 1343 }
1247 1344
1248 # all others are fine for our purposes 1345 # all others are fine for our purposes
1249 } 1346 }
1347
1348 if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1349 $self->{wbuf} .= $buf;
1350 $self->_drain_wbuf;
1351 }
1250} 1352}
1251 1353
1252=item $handle->starttls ($tls[, $tls_ctx]) 1354=item $handle->starttls ($tls[, $tls_ctx])
1253 1355
1254Instead of starting TLS negotiation immediately when the AnyEvent::Handle 1356Instead of starting TLS negotiation immediately when the AnyEvent::Handle
1263 1365
1264The TLS connection object will end up in C<< $handle->{tls} >> after this 1366The TLS connection object will end up in C<< $handle->{tls} >> after this
1265call and can be used or changed to your liking. Note that the handshake 1367call and can be used or changed to your liking. Note that the handshake
1266might have already started when this function returns. 1368might have already started when this function returns.
1267 1369
1370If it an error to start a TLS handshake more than once per
1371AnyEvent::Handle object (this is due to bugs in OpenSSL).
1372
1268=cut 1373=cut
1269 1374
1270sub starttls { 1375sub starttls {
1271 my ($self, $ssl, $ctx) = @_; 1376 my ($self, $ssl, $ctx) = @_;
1272 1377
1273 $self->stoptls; 1378 require Net::SSLeay;
1274 1379
1380 Carp::croak "it is an error to call starttls more than once on an Anyevent::Handle object"
1381 if $self->{tls};
1382
1275 if ($ssl eq "accept") { 1383 if ($ssl eq "accept") {
1276 $ssl = Net::SSLeay::new ($ctx || TLS_CTX ()); 1384 $ssl = Net::SSLeay::new ($ctx || TLS_CTX ());
1277 Net::SSLeay::set_accept_state ($ssl); 1385 Net::SSLeay::set_accept_state ($ssl);
1278 } elsif ($ssl eq "connect") { 1386 } elsif ($ssl eq "connect") {
1279 $ssl = Net::SSLeay::new ($ctx || TLS_CTX ()); 1387 $ssl = Net::SSLeay::new ($ctx || TLS_CTX ());
1285 # basically, this is deep magic (because SSL_read should have the same issues) 1393 # basically, this is deep magic (because SSL_read should have the same issues)
1286 # but the openssl maintainers basically said: "trust us, it just works". 1394 # but the openssl maintainers basically said: "trust us, it just works".
1287 # (unfortunately, we have to hardcode constants because the abysmally misdesigned 1395 # (unfortunately, we have to hardcode constants because the abysmally misdesigned
1288 # and mismaintained ssleay-module doesn't even offer them). 1396 # and mismaintained ssleay-module doesn't even offer them).
1289 # http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html 1397 # http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
1398 #
1399 # in short: this is a mess.
1400 #
1401 # note that we do not try to keep the length constant between writes as we are required to do.
1402 # we assume that most (but not all) of this insanity only applies to non-blocking cases,
1403 # and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
1404 # have identity issues in that area.
1290 Net::SSLeay::CTX_set_mode ($self->{tls}, 1405 Net::SSLeay::CTX_set_mode ($self->{tls},
1291 (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1) 1406 (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)
1292 | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2)); 1407 | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));
1293 1408
1294 $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); 1409 $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1295 $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); 1410 $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1296 1411
1297 Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio}); 1412 Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
1298 1413
1299 $self->{filter_w} = sub { 1414 &_dotls; # need to trigger the initial handshake
1300 $_[0]{_tls_wbuf} .= ${$_[1]}; 1415 $self->start_read; # make sure we actually do read
1301 &_dotls;
1302 };
1303 $self->{filter_r} = sub {
1304 Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});
1305 &_dotls;
1306 };
1307} 1416}
1308 1417
1309=item $handle->stoptls 1418=item $handle->stoptls
1310 1419
1311Destroys the SSL connection, if any. Partial read or write data will be 1420Shuts down the SSL connection - this makes a proper EOF handshake by
1312lost. 1421sending a close notify to the other side, but since OpenSSL doesn't
1422support non-blocking shut downs, it is not possible to re-use the stream
1423afterwards.
1313 1424
1314=cut 1425=cut
1315 1426
1316sub stoptls { 1427sub stoptls {
1317 my ($self) = @_; 1428 my ($self) = @_;
1318 1429
1430 if ($self->{tls}) {
1431 Net::SSLeay::shutdown ($self->{tls});
1432
1433 &_dotls;
1434
1435 # we don't give a shit. no, we do, but we can't. no...
1436 # we, we... have to use openssl :/
1437 &_freetls;
1438 }
1439}
1440
1441sub _freetls {
1442 my ($self) = @_;
1443
1444 return unless $self->{tls};
1445
1319 Net::SSLeay::free (delete $self->{tls}) if $self->{tls}; 1446 Net::SSLeay::free (delete $self->{tls});
1320 1447
1321 delete $self->{_rbio}; 1448 delete @$self{qw(_rbio _wbio _tls_wbuf)};
1322 delete $self->{_wbio};
1323 delete $self->{_tls_wbuf};
1324 delete $self->{filter_r};
1325 delete $self->{filter_w};
1326} 1449}
1327 1450
1328sub DESTROY { 1451sub DESTROY {
1329 my $self = shift; 1452 my $self = shift;
1330 1453
1331 $self->stoptls; 1454 &_freetls;
1332 1455
1333 my $linger = exists $self->{linger} ? $self->{linger} : 3600; 1456 my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1334 1457
1335 if ($linger && length $self->{wbuf}) { 1458 if ($linger && length $self->{wbuf}) {
1336 my $fh = delete $self->{fh}; 1459 my $fh = delete $self->{fh};
1400=over 4 1523=over 4
1401 1524
1402=item * all constructor arguments become object members. 1525=item * all constructor arguments become object members.
1403 1526
1404At least initially, when you pass a C<tls>-argument to the constructor it 1527At least initially, when you pass a C<tls>-argument to the constructor it
1405will end up in C<< $handle->{tls} >>. Those members might be changes or 1528will end up in C<< $handle->{tls} >>. Those members might be changed or
1406mutated later on (for example C<tls> will hold the TLS connection object). 1529mutated later on (for example C<tls> will hold the TLS connection object).
1407 1530
1408=item * other object member names are prefixed with an C<_>. 1531=item * other object member names are prefixed with an C<_>.
1409 1532
1410All object members not explicitly documented (internal use) are prefixed 1533All object members not explicitly documented (internal use) are prefixed

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines