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.167 by root, Tue Jul 28 11:02:19 2009 UTC vs.
Revision 1.198 by root, Tue Aug 31 01:03:37 2010 UTC

1package AnyEvent::Handle;
2
3use Scalar::Util ();
4use Carp ();
5use Errno qw(EAGAIN EINTR);
6
7use AnyEvent (); BEGIN { AnyEvent::common_sense }
8use AnyEvent::Util qw(WSAEWOULDBLOCK);
9
10=head1 NAME 1=head1 NAME
11 2
12AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent 3AnyEvent::Handle - non-blocking I/O on streaming handles via AnyEvent
13
14=cut
15
16our $VERSION = 4.881;
17 4
18=head1 SYNOPSIS 5=head1 SYNOPSIS
19 6
20 use AnyEvent; 7 use AnyEvent;
21 use AnyEvent::Handle; 8 use AnyEvent::Handle;
… …
27 on_error => sub { 14 on_error => sub {
28 my ($hdl, $fatal, $msg) = @_; 15 my ($hdl, $fatal, $msg) = @_;
29 warn "got error $msg\n"; 16 warn "got error $msg\n";
30 $hdl->destroy; 17 $hdl->destroy;
31 $cv->send; 18 $cv->send;
32 ); 19 };
33 20
34 # send some request line 21 # send some request line
35 $hdl->push_write ("getinfo\015\012"); 22 $hdl->push_write ("getinfo\015\012");
36 23
37 # read the response line 24 # read the response line
… …
43 30
44 $cv->recv; 31 $cv->recv;
45 32
46=head1 DESCRIPTION 33=head1 DESCRIPTION
47 34
48This module is a helper module to make it easier to do event-based I/O on 35This is a helper module to make it easier to do event-based I/O on
49filehandles. 36stream-based filehandles (sockets, pipes, and other stream things).
50 37
51The L<AnyEvent::Intro> tutorial contains some well-documented 38The L<AnyEvent::Intro> tutorial contains some well-documented
52AnyEvent::Handle examples. 39AnyEvent::Handle examples.
53 40
54In the following, when the documentation refers to of "bytes" then this 41In the following, where the documentation refers to "bytes", it means
55means characters. As sysread and syswrite are used for all I/O, their 42characters. As sysread and syswrite are used for all I/O, their
56treatment of characters applies to this module as well. 43treatment of characters applies to this module as well.
57 44
58At the very minimum, you should specify C<fh> or C<connect>, and the 45At the very minimum, you should specify C<fh> or C<connect>, and the
59C<on_error> callback. 46C<on_error> callback.
60 47
61All callbacks will be invoked with the handle object as their first 48All callbacks will be invoked with the handle object as their first
62argument. 49argument.
63 50
51=cut
52
53package AnyEvent::Handle;
54
55use Scalar::Util ();
56use List::Util ();
57use Carp ();
58use Errno qw(EAGAIN EINTR);
59
60use AnyEvent (); BEGIN { AnyEvent::common_sense }
61use AnyEvent::Util qw(WSAEWOULDBLOCK);
62
63our $VERSION = $AnyEvent::VERSION;
64
65sub _load_func($) {
66 my $func = $_[0];
67
68 unless (defined &$func) {
69 my $pkg = $func;
70 do {
71 $pkg =~ s/::[^:]+$//
72 or return;
73 eval "require $pkg";
74 } until defined &$func;
75 }
76
77 \&$func
78}
79
64=head1 METHODS 80=head1 METHODS
65 81
66=over 4 82=over 4
67 83
68=item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value... 84=item $handle = B<new> AnyEvent::Handle fh => $filehandle, key => value...
69 85
70The constructor supports these arguments (all as C<< key => value >> pairs). 86The constructor supports these arguments (all as C<< key => value >> pairs).
71 87
72=over 4 88=over 4
73 89
… …
102prepare the file handle with parameters required for the actual connect 118prepare the file handle with parameters required for the actual connect
103(as opposed to settings that can be changed when the connection is already 119(as opposed to settings that can be changed when the connection is already
104established). 120established).
105 121
106The return value of this callback should be the connect timeout value in 122The return value of this callback should be the connect timeout value in
107seconds (or C<0>, or C<undef>, or the empty list, to indicate the default 123seconds (or C<0>, or C<undef>, or the empty list, to indicate that the
108timeout is to be used). 124default timeout is to be used).
109 125
110=item on_connect => $cb->($handle, $host, $port, $retry->()) 126=item on_connect => $cb->($handle, $host, $port, $retry->())
111 127
112This callback is called when a connection has been successfully established. 128This callback is called when a connection has been successfully established.
113 129
114The actual numeric host and port (the socket peername) are passed as 130The peer's numeric host and port (the socket peername) are passed as
115parameters, together with a retry callback. 131parameters, together with a retry callback.
116 132
117When, for some reason, the handle is not acceptable, then calling 133If, for some reason, the handle is not acceptable, calling C<$retry>
118C<$retry> will continue with the next conenction target (in case of 134will continue with the next connection target (in case of multi-homed
119multi-homed hosts or SRV records there can be multiple connection 135hosts or SRV records there can be multiple connection endpoints). At the
120endpoints). When it is called then the read and write queues, eof status, 136time it is called the read and write queues, eof status, tls status and
121tls status and similar properties of the handle are being reset. 137similar properties of the handle will have been reset.
122 138
123In most cases, ignoring the C<$retry> parameter is the way to go. 139In most cases, you should ignore the C<$retry> parameter.
124 140
125=item on_connect_error => $cb->($handle, $message) 141=item on_connect_error => $cb->($handle, $message)
126 142
127This callback is called when the conenction could not be 143This callback is called when the connection could not be
128established. C<$!> will contain the relevant error code, and C<$message> a 144established. C<$!> will contain the relevant error code, and C<$message> a
129message describing it (usually the same as C<"$!">). 145message describing it (usually the same as C<"$!">).
130 146
131If this callback isn't specified, then C<on_error> will be called with a 147If this callback isn't specified, then C<on_error> will be called with a
132fatal error instead. 148fatal error instead.
… …
135 151
136=item on_error => $cb->($handle, $fatal, $message) 152=item on_error => $cb->($handle, $fatal, $message)
137 153
138This is the error callback, which is called when, well, some error 154This is the error callback, which is called when, well, some error
139occured, such as not being able to resolve the hostname, failure to 155occured, such as not being able to resolve the hostname, failure to
140connect or a read error. 156connect, or a read error.
141 157
142Some errors are fatal (which is indicated by C<$fatal> being true). On 158Some errors are fatal (which is indicated by C<$fatal> being true). On
143fatal errors the handle object will be destroyed (by a call to C<< -> 159fatal errors the handle object will be destroyed (by a call to C<< ->
144destroy >>) after invoking the error callback (which means you are free to 160destroy >>) after invoking the error callback (which means you are free to
145examine the handle object). Examples of fatal errors are an EOF condition 161examine the handle object). Examples of fatal errors are an EOF condition
146with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors. In 162with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors. In
147cases where the other side can close the connection at their will it is 163cases where the other side can close the connection at will, it is
148often easiest to not report C<EPIPE> errors in this callback. 164often easiest to not report C<EPIPE> errors in this callback.
149 165
150AnyEvent::Handle tries to find an appropriate error code for you to check 166AnyEvent::Handle tries to find an appropriate error code for you to check
151against, but in some cases (TLS errors), this does not work well. It is 167against, but in some cases (TLS errors), this does not work well. It is
152recommended to always output the C<$message> argument in human-readable 168recommended to always output the C<$message> argument in human-readable
153error messages (it's usually the same as C<"$!">). 169error messages (it's usually the same as C<"$!">).
154 170
155Non-fatal errors can be retried by simply returning, but it is recommended 171Non-fatal errors can be retried by returning, but it is recommended
156to simply ignore this parameter and instead abondon the handle object 172to simply ignore this parameter and instead abondon the handle object
157when this callback is invoked. Examples of non-fatal errors are timeouts 173when this callback is invoked. Examples of non-fatal errors are timeouts
158C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>). 174C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
159 175
160On callback entrance, the value of C<$!> contains the operating system 176On entry to the callback, the value of C<$!> contains the operating
161error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or 177system error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
162C<EPROTO>). 178C<EPROTO>).
163 179
164While not mandatory, it is I<highly> recommended to set this callback, as 180While not mandatory, it is I<highly> recommended to set this callback, as
165you will not be notified of errors otherwise. The default simply calls 181you will not be notified of errors otherwise. The default just calls
166C<croak>. 182C<croak>.
167 183
168=item on_read => $cb->($handle) 184=item on_read => $cb->($handle)
169 185
170This sets the default read callback, which is called when data arrives 186This sets the default read callback, which is called when data arrives
… …
175To access (and remove data from) the read buffer, use the C<< ->rbuf >> 191To access (and remove data from) the read buffer, use the C<< ->rbuf >>
176method or access the C<< $handle->{rbuf} >> member directly. Note that you 192method or access the C<< $handle->{rbuf} >> member directly. Note that you
177must not enlarge or modify the read buffer, you can only remove data at 193must not enlarge or modify the read buffer, you can only remove data at
178the beginning from it. 194the beginning from it.
179 195
196You can also call C<< ->push_read (...) >> or any other function that
197modifies the read queue. Or do both. Or ...
198
180When an EOF condition is detected then AnyEvent::Handle will first try to 199When an EOF condition is detected, AnyEvent::Handle will first try to
181feed all the remaining data to the queued callbacks and C<on_read> before 200feed all the remaining data to the queued callbacks and C<on_read> before
182calling the C<on_eof> callback. If no progress can be made, then a fatal 201calling the C<on_eof> callback. If no progress can be made, then a fatal
183error will be raised (with C<$!> set to C<EPIPE>). 202error will be raised (with C<$!> set to C<EPIPE>).
184 203
185Note that, unlike requests in the read queue, an C<on_read> callback 204Note that, unlike requests in the read queue, an C<on_read> callback
… …
204set, then a fatal error will be raised with C<$!> set to <0>. 223set, then a fatal error will be raised with C<$!> set to <0>.
205 224
206=item on_drain => $cb->($handle) 225=item on_drain => $cb->($handle)
207 226
208This sets the callback that is called when the write buffer becomes empty 227This sets the callback that is called when the write buffer becomes empty
209(or when the callback is set and the buffer is empty already). 228(or immediately if the buffer is empty already).
210 229
211To append to the write buffer, use the C<< ->push_write >> method. 230To append to the write buffer, use the C<< ->push_write >> method.
212 231
213This callback is useful when you don't want to put all of your write data 232This callback is useful when you don't want to put all of your write data
214into the queue at once, for example, when you want to write the contents 233into the queue at once, for example, when you want to write the contents
… …
216memory and push it into the queue, but instead only read more data from 235memory and push it into the queue, but instead only read more data from
217the file when the write queue becomes empty. 236the file when the write queue becomes empty.
218 237
219=item timeout => $fractional_seconds 238=item timeout => $fractional_seconds
220 239
240=item rtimeout => $fractional_seconds
241
242=item wtimeout => $fractional_seconds
243
221If non-zero, then this enables an "inactivity" timeout: whenever this many 244If non-zero, then these enables an "inactivity" timeout: whenever this
222seconds pass without a successful read or write on the underlying file 245many seconds pass without a successful read or write on the underlying
223handle, the C<on_timeout> callback will be invoked (and if that one is 246file handle (or a call to C<timeout_reset>), the C<on_timeout> callback
224missing, a non-fatal C<ETIMEDOUT> error will be raised). 247will be invoked (and if that one is missing, a non-fatal C<ETIMEDOUT>
248error will be raised).
225 249
250There are three variants of the timeouts that work independently
251of each other, for both read and write, just read, and just write:
252C<timeout>, C<rtimeout> and C<wtimeout>, with corresponding callbacks
253C<on_timeout>, C<on_rtimeout> and C<on_wtimeout>, and reset functions
254C<timeout_reset>, C<rtimeout_reset>, and C<wtimeout_reset>.
255
226Note that timeout processing is also active when you currently do not have 256Note that timeout processing is active even when you do not have
227any outstanding read or write requests: If you plan to keep the connection 257any outstanding read or write requests: If you plan to keep the connection
228idle then you should disable the timout temporarily or ignore the timeout 258idle then you should disable the timeout temporarily or ignore the timeout
229in the C<on_timeout> callback, in which case AnyEvent::Handle will simply 259in the C<on_timeout> callback, in which case AnyEvent::Handle will simply
230restart the timeout. 260restart the timeout.
231 261
232Zero (the default) disables this timeout. 262Zero (the default) disables this timeout.
233 263
… …
249amount of data without a callback ever being called as long as the line 279amount of data without a callback ever being called as long as the line
250isn't finished). 280isn't finished).
251 281
252=item autocork => <boolean> 282=item autocork => <boolean>
253 283
254When disabled (the default), then C<push_write> will try to immediately 284When disabled (the default), C<push_write> will try to immediately
255write the data to the handle, if possible. This avoids having to register 285write the data to the handle if possible. This avoids having to register
256a write watcher and wait for the next event loop iteration, but can 286a write watcher and wait for the next event loop iteration, but can
257be inefficient if you write multiple small chunks (on the wire, this 287be inefficient if you write multiple small chunks (on the wire, this
258disadvantage is usually avoided by your kernel's nagle algorithm, see 288disadvantage is usually avoided by your kernel's nagle algorithm, see
259C<no_delay>, but this option can save costly syscalls). 289C<no_delay>, but this option can save costly syscalls).
260 290
261When enabled, then writes will always be queued till the next event loop 291When enabled, writes will always be queued till the next event loop
262iteration. This is efficient when you do many small writes per iteration, 292iteration. This is efficient when you do many small writes per iteration,
263but less efficient when you do a single write only per iteration (or when 293but less efficient when you do a single write only per iteration (or when
264the write buffer often is full). It also increases write latency. 294the write buffer often is full). It also increases write latency.
265 295
266=item no_delay => <boolean> 296=item no_delay => <boolean>
… …
270the Nagle algorithm, and usually it is beneficial. 300the Nagle algorithm, and usually it is beneficial.
271 301
272In some situations you want as low a delay as possible, which can be 302In some situations you want as low a delay as possible, which can be
273accomplishd by setting this option to a true value. 303accomplishd by setting this option to a true value.
274 304
275The default is your opertaing system's default behaviour (most likely 305The default is your operating system's default behaviour (most likely
276enabled), this option explicitly enables or disables it, if possible. 306enabled). This option explicitly enables or disables it, if possible.
307
308=item keepalive => <boolean>
309
310Enables (default disable) the SO_KEEPALIVE option on the stream socket:
311normally, TCP connections have no time-out once established, so TCP
312connections, once established, can stay alive forever even when the other
313side has long gone. TCP keepalives are a cheap way to take down long-lived
314TCP connections when the other side becomes unreachable. While the default
315is OS-dependent, TCP keepalives usually kick in after around two hours,
316and, if the other side doesn't reply, take down the TCP connection some 10
317to 15 minutes later.
318
319It is harmless to specify this option for file handles that do not support
320keepalives, and enabling it on connections that are potentially long-lived
321is usually a good idea.
322
323=item oobinline => <boolean>
324
325BSD majorly fucked up the implementation of TCP urgent data. The result
326is that almost no OS implements TCP according to the specs, and every OS
327implements it slightly differently.
328
329If you want to handle TCP urgent data, then setting this flag (the default
330is enabled) gives you the most portable way of getting urgent data, by
331putting it into the stream.
332
333Since BSD emulation of OOB data on top of TCP's urgent data can have
334security implications, AnyEvent::Handle sets this flag automatically
335unless explicitly specified. Note that setting this flag after
336establishing a connection I<may> be a bit too late (data loss could
337already have occured on BSD systems), but at least it will protect you
338from most attacks.
277 339
278=item read_size => <bytes> 340=item read_size => <bytes>
279 341
280The default read block size (the amount of bytes this module will 342The default read block size (the number of bytes this module will
281try to read during each loop iteration, which affects memory 343try to read during each loop iteration, which affects memory
282requirements). Default: C<8192>. 344requirements). Default: C<8192>.
283 345
284=item low_water_mark => <bytes> 346=item low_water_mark => <bytes>
285 347
286Sets the amount of bytes (default: C<0>) that make up an "empty" write 348Sets the number of bytes (default: C<0>) that make up an "empty" write
287buffer: If the write reaches this size or gets even samller it is 349buffer: If the buffer reaches this size or gets even samller it is
288considered empty. 350considered empty.
289 351
290Sometimes it can be beneficial (for performance reasons) to add data to 352Sometimes it can be beneficial (for performance reasons) to add data to
291the write buffer before it is fully drained, but this is a rare case, as 353the write buffer before it is fully drained, but this is a rare case, as
292the operating system kernel usually buffers data as well, so the default 354the operating system kernel usually buffers data as well, so the default
293is good in almost all cases. 355is good in almost all cases.
294 356
295=item linger => <seconds> 357=item linger => <seconds>
296 358
297If non-zero (default: C<3600>), then the destructor of the 359If this is non-zero (default: C<3600>), the destructor of the
298AnyEvent::Handle object will check whether there is still outstanding 360AnyEvent::Handle object will check whether there is still outstanding
299write data and will install a watcher that will write this data to the 361write data and will install a watcher that will write this data to the
300socket. No errors will be reported (this mostly matches how the operating 362socket. No errors will be reported (this mostly matches how the operating
301system treats outstanding data at socket close time). 363system treats outstanding data at socket close time).
302 364
… …
309A string used to identify the remote site - usually the DNS hostname 371A string used to identify the remote site - usually the DNS hostname
310(I<not> IDN!) used to create the connection, rarely the IP address. 372(I<not> IDN!) used to create the connection, rarely the IP address.
311 373
312Apart from being useful in error messages, this string is also used in TLS 374Apart from being useful in error messages, this string is also used in TLS
313peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This 375peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This
314verification will be skipped when C<peername> is not specified or 376verification will be skipped when C<peername> is not specified or is
315C<undef>. 377C<undef>.
316 378
317=item tls => "accept" | "connect" | Net::SSLeay::SSL object 379=item tls => "accept" | "connect" | Net::SSLeay::SSL object
318 380
319When this parameter is given, it enables TLS (SSL) mode, that means 381When this parameter is given, it enables TLS (SSL) mode, that means
320AnyEvent will start a TLS handshake as soon as the conenction has been 382AnyEvent will start a TLS handshake as soon as the connection has been
321established and will transparently encrypt/decrypt data afterwards. 383established and will transparently encrypt/decrypt data afterwards.
322 384
323All TLS protocol errors will be signalled as C<EPROTO>, with an 385All TLS protocol errors will be signalled as C<EPROTO>, with an
324appropriate error message. 386appropriate error message.
325 387
… …
345B<IMPORTANT:> since Net::SSLeay "objects" are really only integers, 407B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,
346passing in the wrong integer will lead to certain crash. This most often 408passing in the wrong integer will lead to certain crash. This most often
347happens when one uses a stylish C<< tls => 1 >> and is surprised about the 409happens when one uses a stylish C<< tls => 1 >> and is surprised about the
348segmentation fault. 410segmentation fault.
349 411
350See the C<< ->starttls >> method for when need to start TLS negotiation later. 412Use the C<< ->starttls >> method if you need to start TLS negotiation later.
351 413
352=item tls_ctx => $anyevent_tls 414=item tls_ctx => $anyevent_tls
353 415
354Use the given C<AnyEvent::TLS> object to create the new TLS connection 416Use the given C<AnyEvent::TLS> object to create the new TLS connection
355(unless a connection object was specified directly). If this parameter is 417(unless a connection object was specified directly). If this parameter is
… …
370 432
371TLS handshake failures will not cause C<on_error> to be invoked when this 433TLS handshake failures will not cause C<on_error> to be invoked when this
372callback is in effect, instead, the error message will be passed to C<on_starttls>. 434callback is in effect, instead, the error message will be passed to C<on_starttls>.
373 435
374Without this callback, handshake failures lead to C<on_error> being 436Without this callback, handshake failures lead to C<on_error> being
375called, as normal. 437called as usual.
376 438
377Note that you cannot call C<starttls> right again in this callback. If you 439Note that you cannot just call C<starttls> again in this callback. If you
378need to do that, start an zero-second timer instead whose callback can 440need to do that, start an zero-second timer instead whose callback can
379then call C<< ->starttls >> again. 441then call C<< ->starttls >> again.
380 442
381=item on_stoptls => $cb->($handle) 443=item on_stoptls => $cb->($handle)
382 444
… …
438 delete $self->{_skip_drain_rbuf}; 500 delete $self->{_skip_drain_rbuf};
439 $self->_start; 501 $self->_start;
440 502
441 $self->{on_connect} 503 $self->{on_connect}
442 and $self->{on_connect}($self, $host, $port, sub { 504 and $self->{on_connect}($self, $host, $port, sub {
443 delete @$self{qw(fh _tw _ww _rw _eof _queue rbuf _wbuf tls _tls_rbuf _tls_wbuf)}; 505 delete @$self{qw(fh _tw _rtw _wtw _ww _rw _eof _queue rbuf _wbuf tls _tls_rbuf _tls_wbuf)};
444 $self->{_skip_drain_rbuf} = 1; 506 $self->{_skip_drain_rbuf} = 1;
445 &$retry; 507 &$retry;
446 }); 508 });
447 509
448 } else { 510 } else {
… …
472} 534}
473 535
474sub _start { 536sub _start {
475 my ($self) = @_; 537 my ($self) = @_;
476 538
539 # too many clueless people try to use udp and similar sockets
540 # with AnyEvent::Handle, do them a favour.
541 my $type = getsockopt $self->{fh}, Socket::SOL_SOCKET (), Socket::SO_TYPE ();
542 Carp::croak "AnyEvent::Handle: only stream sockets supported, anything else will NOT work!"
543 if Socket::SOCK_STREAM () != (unpack "I", $type) && defined $type;
544
477 AnyEvent::Util::fh_nonblocking $self->{fh}, 1; 545 AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
478 546
547 $self->{_activity} =
548 $self->{_ractivity} =
479 $self->{_activity} = AnyEvent->now; 549 $self->{_wactivity} = AE::now;
480 $self->_timeout;
481 550
551 $self->timeout (delete $self->{timeout} ) if $self->{timeout};
552 $self->rtimeout (delete $self->{rtimeout} ) if $self->{rtimeout};
553 $self->wtimeout (delete $self->{wtimeout} ) if $self->{wtimeout};
554
482 $self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay}; 555 $self->no_delay (delete $self->{no_delay} ) if exists $self->{no_delay} && $self->{no_delay};
556 $self->keepalive (delete $self->{keepalive}) if exists $self->{keepalive} && $self->{keepalive};
483 557
558 $self->oobinline (exists $self->{oobinline} ? delete $self->{oobinline} : 1);
559
484 $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}) 560 $self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
485 if $self->{tls}; 561 if $self->{tls};
486 562
487 $self->on_drain (delete $self->{on_drain}) if $self->{on_drain}; 563 $self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
488 564
489 $self->start_read 565 $self->start_read
490 if $self->{on_read} || @{ $self->{_queue} }; 566 if $self->{on_read} || @{ $self->{_queue} };
491 567
492 $self->_drain_wbuf; 568 $self->_drain_wbuf;
493} 569}
494
495#sub _shutdown {
496# my ($self) = @_;
497#
498# delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)};
499# $self->{_eof} = 1; # tell starttls et. al to stop trying
500#
501# &_freetls;
502#}
503 570
504sub _error { 571sub _error {
505 my ($self, $errno, $fatal, $message) = @_; 572 my ($self, $errno, $fatal, $message) = @_;
506 573
507 $! = $errno; 574 $! = $errno;
508 $message ||= "$!"; 575 $message ||= "$!";
509 576
510 if ($self->{on_error}) { 577 if ($self->{on_error}) {
511 $self->{on_error}($self, $fatal, $message); 578 $self->{on_error}($self, $fatal, $message);
512 $self->destroy if $fatal; 579 $self->destroy if $fatal;
513 } elsif ($self->{fh}) { 580 } elsif ($self->{fh} || $self->{connect}) {
514 $self->destroy; 581 $self->destroy;
515 Carp::croak "AnyEvent::Handle uncaught error: $message"; 582 Carp::croak "AnyEvent::Handle uncaught error: $message";
516 } 583 }
517} 584}
518 585
… …
544 $_[0]{on_eof} = $_[1]; 611 $_[0]{on_eof} = $_[1];
545} 612}
546 613
547=item $handle->on_timeout ($cb) 614=item $handle->on_timeout ($cb)
548 615
549Replace the current C<on_timeout> callback, or disables the callback (but 616=item $handle->on_rtimeout ($cb)
550not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
551argument and method.
552 617
553=cut 618=item $handle->on_wtimeout ($cb)
554 619
555sub on_timeout { 620Replace the current C<on_timeout>, C<on_rtimeout> or C<on_wtimeout>
556 $_[0]{on_timeout} = $_[1]; 621callback, or disables the callback (but not the timeout) if C<$cb> =
557} 622C<undef>. See the C<timeout> constructor argument and method.
623
624=cut
625
626# see below
558 627
559=item $handle->autocork ($boolean) 628=item $handle->autocork ($boolean)
560 629
561Enables or disables the current autocork behaviour (see C<autocork> 630Enables or disables the current autocork behaviour (see C<autocork>
562constructor argument). Changes will only take effect on the next write. 631constructor argument). Changes will only take effect on the next write.
… …
577sub no_delay { 646sub no_delay {
578 $_[0]{no_delay} = $_[1]; 647 $_[0]{no_delay} = $_[1];
579 648
580 eval { 649 eval {
581 local $SIG{__DIE__}; 650 local $SIG{__DIE__};
582 setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1] 651 setsockopt $_[0]{fh}, Socket::IPPROTO_TCP (), Socket::TCP_NODELAY (), int $_[1]
583 if $_[0]{fh}; 652 if $_[0]{fh};
584 }; 653 };
585} 654}
586 655
656=item $handle->keepalive ($boolean)
657
658Enables or disables the C<keepalive> setting (see constructor argument of
659the same name for details).
660
661=cut
662
663sub keepalive {
664 $_[0]{keepalive} = $_[1];
665
666 eval {
667 local $SIG{__DIE__};
668 setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
669 if $_[0]{fh};
670 };
671}
672
673=item $handle->oobinline ($boolean)
674
675Enables or disables the C<oobinline> setting (see constructor argument of
676the same name for details).
677
678=cut
679
680sub oobinline {
681 $_[0]{oobinline} = $_[1];
682
683 eval {
684 local $SIG{__DIE__};
685 setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_OOBINLINE (), int $_[1]
686 if $_[0]{fh};
687 };
688}
689
690=item $handle->keepalive ($boolean)
691
692Enables or disables the C<keepalive> setting (see constructor argument of
693the same name for details).
694
695=cut
696
697sub keepalive {
698 $_[0]{keepalive} = $_[1];
699
700 eval {
701 local $SIG{__DIE__};
702 setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
703 if $_[0]{fh};
704 };
705}
706
587=item $handle->on_starttls ($cb) 707=item $handle->on_starttls ($cb)
588 708
589Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument). 709Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument).
590 710
591=cut 711=cut
… …
598 718
599Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument). 719Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).
600 720
601=cut 721=cut
602 722
603sub on_starttls { 723sub on_stoptls {
604 $_[0]{on_stoptls} = $_[1]; 724 $_[0]{on_stoptls} = $_[1];
605} 725}
606 726
727=item $handle->rbuf_max ($max_octets)
728
729Configures the C<rbuf_max> setting (C<undef> disables it).
730
731=cut
732
733sub rbuf_max {
734 $_[0]{rbuf_max} = $_[1];
735}
736
607############################################################################# 737#############################################################################
608 738
609=item $handle->timeout ($seconds) 739=item $handle->timeout ($seconds)
610 740
741=item $handle->rtimeout ($seconds)
742
743=item $handle->wtimeout ($seconds)
744
611Configures (or disables) the inactivity timeout. 745Configures (or disables) the inactivity timeout.
612 746
613=cut 747=item $handle->timeout_reset
614 748
615sub timeout { 749=item $handle->rtimeout_reset
750
751=item $handle->wtimeout_reset
752
753Reset the activity timeout, as if data was received or sent.
754
755These methods are cheap to call.
756
757=cut
758
759for my $dir ("", "r", "w") {
760 my $timeout = "${dir}timeout";
761 my $tw = "_${dir}tw";
762 my $on_timeout = "on_${dir}timeout";
763 my $activity = "_${dir}activity";
764 my $cb;
765
766 *$on_timeout = sub {
767 $_[0]{$on_timeout} = $_[1];
768 };
769
770 *$timeout = sub {
616 my ($self, $timeout) = @_; 771 my ($self, $new_value) = @_;
617 772
618 $self->{timeout} = $timeout; 773 $self->{$timeout} = $new_value;
619 $self->_timeout; 774 delete $self->{$tw}; &$cb;
620} 775 };
621 776
777 *{"${dir}timeout_reset"} = sub {
778 $_[0]{$activity} = AE::now;
779 };
780
781 # main workhorse:
622# reset the timeout watcher, as neccessary 782 # reset the timeout watcher, as neccessary
623# also check for time-outs 783 # also check for time-outs
624sub _timeout { 784 $cb = sub {
625 my ($self) = @_; 785 my ($self) = @_;
626 786
627 if ($self->{timeout} && $self->{fh}) { 787 if ($self->{$timeout} && $self->{fh}) {
628 my $NOW = AnyEvent->now; 788 my $NOW = AE::now;
629 789
630 # when would the timeout trigger? 790 # when would the timeout trigger?
631 my $after = $self->{_activity} + $self->{timeout} - $NOW; 791 my $after = $self->{$activity} + $self->{$timeout} - $NOW;
632 792
633 # now or in the past already? 793 # now or in the past already?
634 if ($after <= 0) { 794 if ($after <= 0) {
635 $self->{_activity} = $NOW; 795 $self->{$activity} = $NOW;
636 796
637 if ($self->{on_timeout}) { 797 if ($self->{$on_timeout}) {
638 $self->{on_timeout}($self); 798 $self->{$on_timeout}($self);
639 } else { 799 } else {
640 $self->_error (Errno::ETIMEDOUT); 800 $self->_error (Errno::ETIMEDOUT);
801 }
802
803 # callback could have changed timeout value, optimise
804 return unless $self->{$timeout};
805
806 # calculate new after
807 $after = $self->{$timeout};
641 } 808 }
642 809
643 # callback could have changed timeout value, optimise 810 Scalar::Util::weaken $self;
644 return unless $self->{timeout}; 811 return unless $self; # ->error could have destroyed $self
645 812
646 # calculate new after 813 $self->{$tw} ||= AE::timer $after, 0, sub {
647 $after = $self->{timeout}; 814 delete $self->{$tw};
815 $cb->($self);
816 };
817 } else {
818 delete $self->{$tw};
648 } 819 }
649
650 Scalar::Util::weaken $self;
651 return unless $self; # ->error could have destroyed $self
652
653 $self->{_tw} ||= AnyEvent->timer (after => $after, cb => sub {
654 delete $self->{_tw};
655 $self->_timeout;
656 });
657 } else {
658 delete $self->{_tw};
659 } 820 }
660} 821}
661 822
662############################################################################# 823#############################################################################
663 824
… …
678 839
679=item $handle->on_drain ($cb) 840=item $handle->on_drain ($cb)
680 841
681Sets the C<on_drain> callback or clears it (see the description of 842Sets the C<on_drain> callback or clears it (see the description of
682C<on_drain> in the constructor). 843C<on_drain> in the constructor).
844
845This method may invoke callbacks (and therefore the handle might be
846destroyed after it returns).
683 847
684=cut 848=cut
685 849
686sub on_drain { 850sub on_drain {
687 my ($self, $cb) = @_; 851 my ($self, $cb) = @_;
… …
696 860
697Queues the given scalar to be written. You can push as much data as you 861Queues the given scalar to be written. You can push as much data as you
698want (only limited by the available memory), as C<AnyEvent::Handle> 862want (only limited by the available memory), as C<AnyEvent::Handle>
699buffers it independently of the kernel. 863buffers it independently of the kernel.
700 864
865This method may invoke callbacks (and therefore the handle might be
866destroyed after it returns).
867
701=cut 868=cut
702 869
703sub _drain_wbuf { 870sub _drain_wbuf {
704 my ($self) = @_; 871 my ($self) = @_;
705 872
… …
711 my $len = syswrite $self->{fh}, $self->{wbuf}; 878 my $len = syswrite $self->{fh}, $self->{wbuf};
712 879
713 if (defined $len) { 880 if (defined $len) {
714 substr $self->{wbuf}, 0, $len, ""; 881 substr $self->{wbuf}, 0, $len, "";
715 882
716 $self->{_activity} = AnyEvent->now; 883 $self->{_activity} = $self->{_wactivity} = AE::now;
717 884
718 $self->{on_drain}($self) 885 $self->{on_drain}($self)
719 if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf}) 886 if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
720 && $self->{on_drain}; 887 && $self->{on_drain};
721 888
… …
727 894
728 # try to write data immediately 895 # try to write data immediately
729 $cb->() unless $self->{autocork}; 896 $cb->() unless $self->{autocork};
730 897
731 # if still data left in wbuf, we need to poll 898 # if still data left in wbuf, we need to poll
732 $self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb) 899 $self->{_ww} = AE::io $self->{fh}, 1, $cb
733 if length $self->{wbuf}; 900 if length $self->{wbuf};
734 }; 901 };
735} 902}
736 903
737our %WH; 904our %WH;
738 905
906# deprecated
739sub register_write_type($$) { 907sub register_write_type($$) {
740 $WH{$_[0]} = $_[1]; 908 $WH{$_[0]} = $_[1];
741} 909}
742 910
743sub push_write { 911sub push_write {
744 my $self = shift; 912 my $self = shift;
745 913
746 if (@_ > 1) { 914 if (@_ > 1) {
747 my $type = shift; 915 my $type = shift;
748 916
917 @_ = ($WH{$type} ||= _load_func "$type\::anyevent_write_type"
749 @_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write") 918 or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_write")
750 ->($self, @_); 919 ->($self, @_);
751 } 920 }
752 921
922 # we downgrade here to avoid hard-to-track-down bugs,
923 # and diagnose the problem earlier and better.
924
753 if ($self->{tls}) { 925 if ($self->{tls}) {
754 $self->{_tls_wbuf} .= $_[0]; 926 utf8::downgrade $self->{_tls_wbuf} .= $_[0];
755 &_dotls ($self) if $self->{fh}; 927 &_dotls ($self) if $self->{fh};
756 } else { 928 } else {
757 $self->{wbuf} .= $_[0]; 929 utf8::downgrade $self->{wbuf} .= $_[0];
758 $self->_drain_wbuf if $self->{fh}; 930 $self->_drain_wbuf if $self->{fh};
759 } 931 }
760} 932}
761 933
762=item $handle->push_write (type => @args) 934=item $handle->push_write (type => @args)
763 935
764Instead of formatting your data yourself, you can also let this module do 936Instead of formatting your data yourself, you can also let this module
765the job by specifying a type and type-specific arguments. 937do the job by specifying a type and type-specific arguments. You
938can also specify the (fully qualified) name of a package, in which
939case AnyEvent tries to load the package and then expects to find the
940C<anyevent_write_type> function inside (see "custom write types", below).
766 941
767Predefined types are (if you have ideas for additional types, feel free to 942Predefined types are (if you have ideas for additional types, feel free to
768drop by and tell us): 943drop by and tell us):
769 944
770=over 4 945=over 4
… …
827Other languages could read single lines terminated by a newline and pass 1002Other languages could read single lines terminated by a newline and pass
828this line into their JSON decoder of choice. 1003this line into their JSON decoder of choice.
829 1004
830=cut 1005=cut
831 1006
1007sub json_coder() {
1008 eval { require JSON::XS; JSON::XS->new->utf8 }
1009 || do { require JSON; JSON->new->utf8 }
1010}
1011
832register_write_type json => sub { 1012register_write_type json => sub {
833 my ($self, $ref) = @_; 1013 my ($self, $ref) = @_;
834 1014
835 require JSON; 1015 my $json = $self->{json} ||= json_coder;
836 1016
837 $self->{json} ? $self->{json}->encode ($ref) 1017 $json->encode ($ref)
838 : JSON::encode_json ($ref)
839}; 1018};
840 1019
841=item storable => $reference 1020=item storable => $reference
842 1021
843Freezes the given reference using L<Storable> and writes it to the 1022Freezes the given reference using L<Storable> and writes it to the
… …
869the peer. 1048the peer.
870 1049
871You can rely on the normal read queue and C<on_eof> handling 1050You can rely on the normal read queue and C<on_eof> handling
872afterwards. This is the cleanest way to close a connection. 1051afterwards. This is the cleanest way to close a connection.
873 1052
1053This method may invoke callbacks (and therefore the handle might be
1054destroyed after it returns).
1055
874=cut 1056=cut
875 1057
876sub push_shutdown { 1058sub push_shutdown {
877 my ($self) = @_; 1059 my ($self) = @_;
878 1060
879 delete $self->{low_water_mark}; 1061 delete $self->{low_water_mark};
880 $self->on_drain (sub { shutdown $_[0]{fh}, 1 }); 1062 $self->on_drain (sub { shutdown $_[0]{fh}, 1 });
881} 1063}
882 1064
883=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args) 1065=item custom write types - Package::anyevent_write_type $handle, @args
884 1066
885This function (not method) lets you add your own types to C<push_write>. 1067Instead of one of the predefined types, you can also specify the name of
1068a package. AnyEvent will try to load the package and then expects to find
1069a function named C<anyevent_write_type> inside. If it isn't found, it
1070progressively tries to load the parent package until it either finds the
1071function (good) or runs out of packages (bad).
1072
886Whenever the given C<type> is used, C<push_write> will invoke the code 1073Whenever the given C<type> is used, C<push_write> will the function with
887reference with the handle object and the remaining arguments. 1074the handle object and the remaining arguments.
888 1075
889The code reference is supposed to return a single octet string that will 1076The function is supposed to return a single octet string that will be
890be appended to the write buffer. 1077appended to the write buffer, so you cna mentally treat this function as a
1078"arguments to on-the-wire-format" converter.
891 1079
892Note that this is a function, and all types registered this way will be 1080Example: implement a custom write type C<join> that joins the remaining
893global, so try to use unique names. 1081arguments using the first one.
1082
1083 $handle->push_write (My::Type => " ", 1,2,3);
1084
1085 # uses the following package, which can be defined in the "My::Type" or in
1086 # the "My" modules to be auto-loaded, or just about anywhere when the
1087 # My::Type::anyevent_write_type is defined before invoking it.
1088
1089 package My::Type;
1090
1091 sub anyevent_write_type {
1092 my ($handle, $delim, @args) = @_;
1093
1094 join $delim, @args
1095 }
894 1096
895=cut 1097=cut
896 1098
897############################################################################# 1099#############################################################################
898 1100
… …
907ways, the "simple" way, using only C<on_read> and the "complex" way, using 1109ways, the "simple" way, using only C<on_read> and the "complex" way, using
908a queue. 1110a queue.
909 1111
910In the simple case, you just install an C<on_read> callback and whenever 1112In the simple case, you just install an C<on_read> callback and whenever
911new data arrives, it will be called. You can then remove some data (if 1113new data arrives, it will be called. You can then remove some data (if
912enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna 1114enough is there) from the read buffer (C<< $handle->rbuf >>). Or you can
913leave the data there if you want to accumulate more (e.g. when only a 1115leave the data there if you want to accumulate more (e.g. when only a
914partial message has been received so far). 1116partial message has been received so far), or change the read queue with
1117e.g. C<push_read>.
915 1118
916In the more complex case, you want to queue multiple callbacks. In this 1119In the more complex case, you want to queue multiple callbacks. In this
917case, AnyEvent::Handle will call the first queued callback each time new 1120case, AnyEvent::Handle will call the first queued callback each time new
918data arrives (also the first time it is queued) and removes it when it has 1121data arrives (also the first time it is queued) and remove it when it has
919done its job (see C<push_read>, below). 1122done its job (see C<push_read>, below).
920 1123
921This way you can, for example, push three line-reads, followed by reading 1124This way you can, for example, push three line-reads, followed by reading
922a chunk of data, and AnyEvent::Handle will execute them in order. 1125a chunk of data, and AnyEvent::Handle will execute them in order.
923 1126
… …
984 1187
985 # avoid recursion 1188 # avoid recursion
986 return if $self->{_skip_drain_rbuf}; 1189 return if $self->{_skip_drain_rbuf};
987 local $self->{_skip_drain_rbuf} = 1; 1190 local $self->{_skip_drain_rbuf} = 1;
988 1191
989 if (
990 defined $self->{rbuf_max}
991 && $self->{rbuf_max} < length $self->{rbuf}
992 ) {
993 $self->_error (Errno::ENOSPC, 1), return;
994 }
995
996 while () { 1192 while () {
997 # we need to use a separate tls read buffer, as we must not receive data while 1193 # we need to use a separate tls read buffer, as we must not receive data while
998 # we are draining the buffer, and this can only happen with TLS. 1194 # we are draining the buffer, and this can only happen with TLS.
999 $self->{rbuf} .= delete $self->{_tls_rbuf} 1195 $self->{rbuf} .= delete $self->{_tls_rbuf}
1000 if exists $self->{_tls_rbuf}; 1196 if exists $self->{_tls_rbuf};
… …
1041 : $self->_error (0, 1, "Unexpected end-of-file"); 1237 : $self->_error (0, 1, "Unexpected end-of-file");
1042 1238
1043 return; 1239 return;
1044 } 1240 }
1045 1241
1242 if (
1243 defined $self->{rbuf_max}
1244 && $self->{rbuf_max} < length $self->{rbuf}
1245 ) {
1246 $self->_error (Errno::ENOSPC, 1), return;
1247 }
1248
1046 # may need to restart read watcher 1249 # may need to restart read watcher
1047 unless ($self->{_rw}) { 1250 unless ($self->{_rw}) {
1048 $self->start_read 1251 $self->start_read
1049 if $self->{on_read} || @{ $self->{_queue} }; 1252 if $self->{on_read} || @{ $self->{_queue} };
1050 } 1253 }
… …
1053=item $handle->on_read ($cb) 1256=item $handle->on_read ($cb)
1054 1257
1055This replaces the currently set C<on_read> callback, or clears it (when 1258This replaces the currently set C<on_read> callback, or clears it (when
1056the new callback is C<undef>). See the description of C<on_read> in the 1259the new callback is C<undef>). See the description of C<on_read> in the
1057constructor. 1260constructor.
1261
1262This method may invoke callbacks (and therefore the handle might be
1263destroyed after it returns).
1058 1264
1059=cut 1265=cut
1060 1266
1061sub on_read { 1267sub on_read {
1062 my ($self, $cb) = @_; 1268 my ($self, $cb) = @_;
… …
1102 1308
1103If enough data was available, then the callback must remove all data it is 1309If enough data was available, then the callback must remove all data it is
1104interested in (which can be none at all) and return a true value. After returning 1310interested in (which can be none at all) and return a true value. After returning
1105true, it will be removed from the queue. 1311true, it will be removed from the queue.
1106 1312
1313These methods may invoke callbacks (and therefore the handle might be
1314destroyed after it returns).
1315
1107=cut 1316=cut
1108 1317
1109our %RH; 1318our %RH;
1110 1319
1111sub register_read_type($$) { 1320sub register_read_type($$) {
… …
1117 my $cb = pop; 1326 my $cb = pop;
1118 1327
1119 if (@_) { 1328 if (@_) {
1120 my $type = shift; 1329 my $type = shift;
1121 1330
1331 $cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type"
1122 $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read") 1332 or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_read")
1123 ->($self, $cb, @_); 1333 ->($self, $cb, @_);
1124 } 1334 }
1125 1335
1126 push @{ $self->{_queue} }, $cb; 1336 push @{ $self->{_queue} }, $cb;
1127 $self->_drain_rbuf; 1337 $self->_drain_rbuf;
… …
1136 1346
1137 $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read") 1347 $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")
1138 ->($self, $cb, @_); 1348 ->($self, $cb, @_);
1139 } 1349 }
1140 1350
1141
1142 unshift @{ $self->{_queue} }, $cb; 1351 unshift @{ $self->{_queue} }, $cb;
1143 $self->_drain_rbuf; 1352 $self->_drain_rbuf;
1144} 1353}
1145 1354
1146=item $handle->push_read (type => @args, $cb) 1355=item $handle->push_read (type => @args, $cb)
1147 1356
1148=item $handle->unshift_read (type => @args, $cb) 1357=item $handle->unshift_read (type => @args, $cb)
1149 1358
1150Instead of providing a callback that parses the data itself you can chose 1359Instead of providing a callback that parses the data itself you can chose
1151between a number of predefined parsing formats, for chunks of data, lines 1360between a number of predefined parsing formats, for chunks of data, lines
1152etc. 1361etc. You can also specify the (fully qualified) name of a package, in
1362which case AnyEvent tries to load the package and then expects to find the
1363C<anyevent_read_type> function inside (see "custom read types", below).
1153 1364
1154Predefined types are (if you have ideas for additional types, feel free to 1365Predefined types are (if you have ideas for additional types, feel free to
1155drop by and tell us): 1366drop by and tell us):
1156 1367
1157=over 4 1368=over 4
… …
1249the receive buffer when neither C<$accept> nor C<$reject> match, 1460the receive buffer when neither C<$accept> nor C<$reject> match,
1250and everything preceding and including the match will be accepted 1461and everything preceding and including the match will be accepted
1251unconditionally. This is useful to skip large amounts of data that you 1462unconditionally. This is useful to skip large amounts of data that you
1252know cannot be matched, so that the C<$accept> or C<$reject> regex do not 1463know cannot be matched, so that the C<$accept> or C<$reject> regex do not
1253have to start matching from the beginning. This is purely an optimisation 1464have to start matching from the beginning. This is purely an optimisation
1254and is usually worth only when you expect more than a few kilobytes. 1465and is usually worth it only when you expect more than a few kilobytes.
1255 1466
1256Example: expect a http header, which ends at C<\015\012\015\012>. Since we 1467Example: expect a http header, which ends at C<\015\012\015\012>. Since we
1257expect the header to be very large (it isn't in practise, but...), we use 1468expect the header to be very large (it isn't in practice, but...), we use
1258a skip regex to skip initial portions. The skip regex is tricky in that 1469a skip regex to skip initial portions. The skip regex is tricky in that
1259it only accepts something not ending in either \015 or \012, as these are 1470it only accepts something not ending in either \015 or \012, as these are
1260required for the accept regex. 1471required for the accept regex.
1261 1472
1262 $handle->push_read (regex => 1473 $handle->push_read (regex =>
… …
1397=cut 1608=cut
1398 1609
1399register_read_type json => sub { 1610register_read_type json => sub {
1400 my ($self, $cb) = @_; 1611 my ($self, $cb) = @_;
1401 1612
1402 my $json = $self->{json} ||= 1613 my $json = $self->{json} ||= json_coder;
1403 eval { require JSON::XS; JSON::XS->new->utf8 }
1404 || do { require JSON; JSON->new->utf8 };
1405 1614
1406 my $data; 1615 my $data;
1407 my $rbuf = \$self->{rbuf}; 1616 my $rbuf = \$self->{rbuf};
1408 1617
1409 sub { 1618 sub {
… …
1478 } 1687 }
1479}; 1688};
1480 1689
1481=back 1690=back
1482 1691
1483=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args) 1692=item custom read types - Package::anyevent_read_type $handle, $cb, @args
1484 1693
1485This function (not method) lets you add your own types to C<push_read>. 1694Instead of one of the predefined types, you can also specify the name
1695of a package. AnyEvent will try to load the package and then expects to
1696find a function named C<anyevent_read_type> inside. If it isn't found, it
1697progressively tries to load the parent package until it either finds the
1698function (good) or runs out of packages (bad).
1486 1699
1487Whenever the given C<type> is used, C<push_read> will invoke the code 1700Whenever this type is used, C<push_read> will invoke the function with the
1488reference with the handle object, the callback and the remaining 1701handle object, the original callback and the remaining arguments.
1489arguments.
1490 1702
1491The code reference is supposed to return a callback (usually a closure) 1703The function is supposed to return a callback (usually a closure) that
1492that works as a plain read callback (see C<< ->push_read ($cb) >>). 1704works as a plain read callback (see C<< ->push_read ($cb) >>), so you can
1705mentally treat the function as a "configurable read type to read callback"
1706converter.
1493 1707
1494It should invoke the passed callback when it is done reading (remember to 1708It should invoke the original callback when it is done reading (remember
1495pass C<$handle> as first argument as all other callbacks do that). 1709to pass C<$handle> as first argument as all other callbacks do that,
1710although there is no strict requirement on this).
1496 1711
1497Note that this is a function, and all types registered this way will be
1498global, so try to use unique names.
1499
1500For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>, 1712For examples, see the source of this module (F<perldoc -m
1501search for C<register_read_type>)). 1713AnyEvent::Handle>, search for C<register_read_type>)).
1502 1714
1503=item $handle->stop_read 1715=item $handle->stop_read
1504 1716
1505=item $handle->start_read 1717=item $handle->start_read
1506 1718
… …
1526} 1738}
1527 1739
1528sub start_read { 1740sub start_read {
1529 my ($self) = @_; 1741 my ($self) = @_;
1530 1742
1531 unless ($self->{_rw} || $self->{_eof}) { 1743 unless ($self->{_rw} || $self->{_eof} || !$self->{fh}) {
1532 Scalar::Util::weaken $self; 1744 Scalar::Util::weaken $self;
1533 1745
1534 $self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub { 1746 $self->{_rw} = AE::io $self->{fh}, 0, sub {
1535 my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf}); 1747 my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1536 my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf; 1748 my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf;
1537 1749
1538 if ($len > 0) { 1750 if ($len > 0) {
1539 $self->{_activity} = AnyEvent->now; 1751 $self->{_activity} = $self->{_ractivity} = AE::now;
1540 1752
1541 if ($self->{tls}) { 1753 if ($self->{tls}) {
1542 Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf); 1754 Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1543 1755
1544 &_dotls ($self); 1756 &_dotls ($self);
… …
1552 $self->_drain_rbuf; 1764 $self->_drain_rbuf;
1553 1765
1554 } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) { 1766 } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1555 return $self->_error ($!, 1); 1767 return $self->_error ($!, 1);
1556 } 1768 }
1557 }); 1769 };
1558 } 1770 }
1559} 1771}
1560 1772
1561our $ERROR_SYSCALL; 1773our $ERROR_SYSCALL;
1562our $ERROR_WANT_READ; 1774our $ERROR_WANT_READ;
… …
1629 && ($tmp != $ERROR_SYSCALL || $!); 1841 && ($tmp != $ERROR_SYSCALL || $!);
1630 1842
1631 while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) { 1843 while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1632 $self->{wbuf} .= $tmp; 1844 $self->{wbuf} .= $tmp;
1633 $self->_drain_wbuf; 1845 $self->_drain_wbuf;
1846 $self->{tls} or return; # tls session might have gone away in callback
1634 } 1847 }
1635 1848
1636 $self->{_on_starttls} 1849 $self->{_on_starttls}
1637 and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK () 1850 and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
1638 and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established"); 1851 and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");
… …
1660context in C<< $handle->{tls_ctx} >> after this call and can be used or 1873context in C<< $handle->{tls_ctx} >> after this call and can be used or
1661changed to your liking. Note that the handshake might have already started 1874changed to your liking. Note that the handshake might have already started
1662when this function returns. 1875when this function returns.
1663 1876
1664Due to bugs in OpenSSL, it might or might not be possible to do multiple 1877Due to bugs in OpenSSL, it might or might not be possible to do multiple
1665handshakes on the same stream. Best do not attempt to use the stream after 1878handshakes on the same stream. It is best to not attempt to use the
1666stopping TLS. 1879stream after stopping TLS.
1880
1881This method may invoke callbacks (and therefore the handle might be
1882destroyed after it returns).
1667 1883
1668=cut 1884=cut
1669 1885
1670our %TLS_CACHE; #TODO not yet documented, should we? 1886our %TLS_CACHE; #TODO not yet documented, should we?
1671 1887
… …
1683 require Net::SSLeay; 1899 require Net::SSLeay;
1684 1900
1685 $ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL (); 1901 $ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1686 $ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ (); 1902 $ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1687 1903
1688 $tls = $self->{tls}; 1904 $tls = delete $self->{tls};
1689 $ctx = $self->{tls_ctx}; 1905 $ctx = $self->{tls_ctx};
1690 1906
1691 local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session 1907 local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
1692 1908
1693 if ("HASH" eq ref $ctx) { 1909 if ("HASH" eq ref $ctx) {
… …
1722 Net::SSLeay::CTX_set_mode ($tls, 1|2); 1938 Net::SSLeay::CTX_set_mode ($tls, 1|2);
1723 1939
1724 $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); 1940 $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1725 $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); 1941 $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1726 1942
1943 Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf});
1944
1727 Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio}); 1945 Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
1728 1946
1729 $self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) } 1947 $self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1730 if $self->{on_starttls}; 1948 if $self->{on_starttls};
1731 1949
… …
1735 1953
1736=item $handle->stoptls 1954=item $handle->stoptls
1737 1955
1738Shuts down the SSL connection - this makes a proper EOF handshake by 1956Shuts down the SSL connection - this makes a proper EOF handshake by
1739sending a close notify to the other side, but since OpenSSL doesn't 1957sending a close notify to the other side, but since OpenSSL doesn't
1740support non-blocking shut downs, it is not guarenteed that you can re-use 1958support non-blocking shut downs, it is not guaranteed that you can re-use
1741the stream afterwards. 1959the stream afterwards.
1960
1961This method may invoke callbacks (and therefore the handle might be
1962destroyed after it returns).
1742 1963
1743=cut 1964=cut
1744 1965
1745sub stoptls { 1966sub stoptls {
1746 my ($self) = @_; 1967 my ($self) = @_;
1747 1968
1748 if ($self->{tls}) { 1969 if ($self->{tls} && $self->{fh}) {
1749 Net::SSLeay::shutdown ($self->{tls}); 1970 Net::SSLeay::shutdown ($self->{tls});
1750 1971
1751 &_dotls; 1972 &_dotls;
1752 1973
1753# # we don't give a shit. no, we do, but we can't. no...#d# 1974# # we don't give a shit. no, we do, but we can't. no...#d#
… …
1760 my ($self) = @_; 1981 my ($self) = @_;
1761 1982
1762 return unless $self->{tls}; 1983 return unless $self->{tls};
1763 1984
1764 $self->{tls_ctx}->_put_session (delete $self->{tls}) 1985 $self->{tls_ctx}->_put_session (delete $self->{tls})
1765 if ref $self->{tls}; 1986 if $self->{tls} > 0;
1766 1987
1767 delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)}; 1988 delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1768} 1989}
1769 1990
1770sub DESTROY { 1991sub DESTROY {
… …
1778 my $fh = delete $self->{fh}; 1999 my $fh = delete $self->{fh};
1779 my $wbuf = delete $self->{wbuf}; 2000 my $wbuf = delete $self->{wbuf};
1780 2001
1781 my @linger; 2002 my @linger;
1782 2003
1783 push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub { 2004 push @linger, AE::io $fh, 1, sub {
1784 my $len = syswrite $fh, $wbuf, length $wbuf; 2005 my $len = syswrite $fh, $wbuf, length $wbuf;
1785 2006
1786 if ($len > 0) { 2007 if ($len > 0) {
1787 substr $wbuf, 0, $len, ""; 2008 substr $wbuf, 0, $len, "";
1788 } else { 2009 } else {
1789 @linger = (); # end 2010 @linger = (); # end
1790 } 2011 }
1791 }); 2012 };
1792 push @linger, AnyEvent->timer (after => $linger, cb => sub { 2013 push @linger, AE::timer $linger, 0, sub {
1793 @linger = (); 2014 @linger = ();
1794 }); 2015 };
1795 } 2016 }
1796} 2017}
1797 2018
1798=item $handle->destroy 2019=item $handle->destroy
1799 2020
… …
1830 2051
1831sub AnyEvent::Handle::destroyed::AUTOLOAD { 2052sub AnyEvent::Handle::destroyed::AUTOLOAD {
1832 #nop 2053 #nop
1833} 2054}
1834 2055
2056=item $handle->destroyed
2057
2058Returns false as long as the handle hasn't been destroyed by a call to C<<
2059->destroy >>, true otherwise.
2060
2061Can be useful to decide whether the handle is still valid after some
2062callback possibly destroyed the handle. For example, C<< ->push_write >>,
2063C<< ->starttls >> and other methods can call user callbacks, which in turn
2064can destroy the handle, so work can be avoided by checking sometimes:
2065
2066 $hdl->starttls ("accept");
2067 return if $hdl->destroyed;
2068 $hdl->push_write (...
2069
2070Note that the call to C<push_write> will silently be ignored if the handle
2071has been destroyed, so often you can just ignore the possibility of the
2072handle being destroyed.
2073
2074=cut
2075
2076sub destroyed { 0 }
2077sub AnyEvent::Handle::destroyed::destroyed { 1 }
2078
1835=item AnyEvent::Handle::TLS_CTX 2079=item AnyEvent::Handle::TLS_CTX
1836 2080
1837This function creates and returns the AnyEvent::TLS object used by default 2081This function creates and returns the AnyEvent::TLS object used by default
1838for TLS mode. 2082for TLS mode.
1839 2083
… …
1870 2114
1871=item I get different callback invocations in TLS mode/Why can't I pause 2115=item I get different callback invocations in TLS mode/Why can't I pause
1872reading? 2116reading?
1873 2117
1874Unlike, say, TCP, TLS connections do not consist of two independent 2118Unlike, say, TCP, TLS connections do not consist of two independent
1875communication channels, one for each direction. Or put differently. The 2119communication channels, one for each direction. Or put differently, the
1876read and write directions are not independent of each other: you cannot 2120read and write directions are not independent of each other: you cannot
1877write data unless you are also prepared to read, and vice versa. 2121write data unless you are also prepared to read, and vice versa.
1878 2122
1879This can mean than, in TLS mode, you might get C<on_error> or C<on_eof> 2123This means that, in TLS mode, you might get C<on_error> or C<on_eof>
1880callback invocations when you are not expecting any read data - the reason 2124callback invocations when you are not expecting any read data - the reason
1881is that AnyEvent::Handle always reads in TLS mode. 2125is that AnyEvent::Handle always reads in TLS mode.
1882 2126
1883During the connection, you have to make sure that you always have a 2127During the connection, you have to make sure that you always have a
1884non-empty read-queue, or an C<on_read> watcher. At the end of the 2128non-empty read-queue, or an C<on_read> watcher. At the end of the
… …
1898 my $data = delete $_[0]{rbuf}; 2142 my $data = delete $_[0]{rbuf};
1899 }); 2143 });
1900 2144
1901The reason to use C<on_error> is that TCP connections, due to latencies 2145The reason to use C<on_error> is that TCP connections, due to latencies
1902and packets loss, might get closed quite violently with an error, when in 2146and packets loss, might get closed quite violently with an error, when in
1903fact, all data has been received. 2147fact all data has been received.
1904 2148
1905It is usually better to use acknowledgements when transferring data, 2149It is usually better to use acknowledgements when transferring data,
1906to make sure the other side hasn't just died and you got the data 2150to make sure the other side hasn't just died and you got the data
1907intact. This is also one reason why so many internet protocols have an 2151intact. This is also one reason why so many internet protocols have an
1908explicit QUIT command. 2152explicit QUIT command.
… …
1925consider using C<< ->push_shutdown >> instead. 2169consider using C<< ->push_shutdown >> instead.
1926 2170
1927=item I want to contact a TLS/SSL server, I don't care about security. 2171=item I want to contact a TLS/SSL server, I don't care about security.
1928 2172
1929If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS, 2173If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS,
1930simply connect to it and then create the AnyEvent::Handle with the C<tls> 2174connect to it and then create the AnyEvent::Handle with the C<tls>
1931parameter: 2175parameter:
1932 2176
1933 tcp_connect $host, $port, sub { 2177 tcp_connect $host, $port, sub {
1934 my ($fh) = @_; 2178 my ($fh) = @_;
1935 2179
… …
2035 2279
2036=item * all members not documented here and not prefixed with an underscore 2280=item * all members not documented here and not prefixed with an underscore
2037are free to use in subclasses. 2281are free to use in subclasses.
2038 2282
2039Of course, new versions of AnyEvent::Handle may introduce more "public" 2283Of course, new versions of AnyEvent::Handle may introduce more "public"
2040member variables, but thats just life, at least it is documented. 2284member variables, but that's just life. At least it is documented.
2041 2285
2042=back 2286=back
2043 2287
2044=head1 AUTHOR 2288=head1 AUTHOR
2045 2289

Diff Legend

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