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.175 by root, Sat Aug 8 22:20:43 2009 UTC vs.
Revision 1.201 by root, Wed Oct 13 01:15:57 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.91;
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} = AE::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.
… …
575=cut 644=cut
576 645
577sub no_delay { 646sub no_delay {
578 $_[0]{no_delay} = $_[1]; 647 $_[0]{no_delay} = $_[1];
579 648
649 setsockopt $_[0]{fh}, Socket::IPPROTO_TCP (), Socket::TCP_NODELAY (), int $_[1]
650 if $_[0]{fh};
651}
652
653=item $handle->keepalive ($boolean)
654
655Enables or disables the C<keepalive> setting (see constructor argument of
656the same name for details).
657
658=cut
659
660sub keepalive {
661 $_[0]{keepalive} = $_[1];
662
580 eval { 663 eval {
581 local $SIG{__DIE__}; 664 local $SIG{__DIE__};
582 setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1] 665 setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
583 if $_[0]{fh}; 666 if $_[0]{fh};
584 }; 667 };
585} 668}
586 669
670=item $handle->oobinline ($boolean)
671
672Enables or disables the C<oobinline> setting (see constructor argument of
673the same name for details).
674
675=cut
676
677sub oobinline {
678 $_[0]{oobinline} = $_[1];
679
680 eval {
681 local $SIG{__DIE__};
682 setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_OOBINLINE (), int $_[1]
683 if $_[0]{fh};
684 };
685}
686
687=item $handle->keepalive ($boolean)
688
689Enables or disables the C<keepalive> setting (see constructor argument of
690the same name for details).
691
692=cut
693
694sub keepalive {
695 $_[0]{keepalive} = $_[1];
696
697 eval {
698 local $SIG{__DIE__};
699 setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
700 if $_[0]{fh};
701 };
702}
703
587=item $handle->on_starttls ($cb) 704=item $handle->on_starttls ($cb)
588 705
589Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument). 706Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument).
590 707
591=cut 708=cut
… …
598 715
599Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument). 716Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).
600 717
601=cut 718=cut
602 719
603sub on_starttls { 720sub on_stoptls {
604 $_[0]{on_stoptls} = $_[1]; 721 $_[0]{on_stoptls} = $_[1];
605} 722}
606 723
607=item $handle->rbuf_max ($max_octets) 724=item $handle->rbuf_max ($max_octets)
608 725
… …
616 733
617############################################################################# 734#############################################################################
618 735
619=item $handle->timeout ($seconds) 736=item $handle->timeout ($seconds)
620 737
738=item $handle->rtimeout ($seconds)
739
740=item $handle->wtimeout ($seconds)
741
621Configures (or disables) the inactivity timeout. 742Configures (or disables) the inactivity timeout.
622 743
623=cut 744=item $handle->timeout_reset
624 745
625sub timeout { 746=item $handle->rtimeout_reset
747
748=item $handle->wtimeout_reset
749
750Reset the activity timeout, as if data was received or sent.
751
752These methods are cheap to call.
753
754=cut
755
756for my $dir ("", "r", "w") {
757 my $timeout = "${dir}timeout";
758 my $tw = "_${dir}tw";
759 my $on_timeout = "on_${dir}timeout";
760 my $activity = "_${dir}activity";
761 my $cb;
762
763 *$on_timeout = sub {
764 $_[0]{$on_timeout} = $_[1];
765 };
766
767 *$timeout = sub {
626 my ($self, $timeout) = @_; 768 my ($self, $new_value) = @_;
627 769
770 $new_value >= 0
771 or Carp::croak "AnyEvent::Handle->$timeout called with negative timeout ($new_value), caught";
772
628 $self->{timeout} = $timeout; 773 $self->{$timeout} = $new_value;
629 delete $self->{_tw}; 774 delete $self->{$tw}; &$cb;
630 $self->_timeout; 775 };
631}
632 776
777 *{"${dir}timeout_reset"} = sub {
778 $_[0]{$activity} = AE::now;
779 };
780
781 # main workhorse:
633# reset the timeout watcher, as neccessary 782 # reset the timeout watcher, as neccessary
634# also check for time-outs 783 # also check for time-outs
635sub _timeout { 784 $cb = sub {
636 my ($self) = @_; 785 my ($self) = @_;
637 786
638 if ($self->{timeout} && $self->{fh}) { 787 if ($self->{$timeout} && $self->{fh}) {
639 my $NOW = AE::now; 788 my $NOW = AE::now;
640 789
641 # when would the timeout trigger? 790 # when would the timeout trigger?
642 my $after = $self->{_activity} + $self->{timeout} - $NOW; 791 my $after = $self->{$activity} + $self->{$timeout} - $NOW;
643 792
644 # now or in the past already? 793 # now or in the past already?
645 if ($after <= 0) { 794 if ($after <= 0) {
646 $self->{_activity} = $NOW; 795 $self->{$activity} = $NOW;
647 796
648 if ($self->{on_timeout}) { 797 if ($self->{$on_timeout}) {
649 $self->{on_timeout}($self); 798 $self->{$on_timeout}($self);
650 } else { 799 } else {
651 $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};
652 } 808 }
653 809
654 # callback could have changed timeout value, optimise 810 Scalar::Util::weaken $self;
655 return unless $self->{timeout}; 811 return unless $self; # ->error could have destroyed $self
656 812
657 # calculate new after 813 $self->{$tw} ||= AE::timer $after, 0, sub {
658 $after = $self->{timeout}; 814 delete $self->{$tw};
815 $cb->($self);
816 };
817 } else {
818 delete $self->{$tw};
659 } 819 }
660
661 Scalar::Util::weaken $self;
662 return unless $self; # ->error could have destroyed $self
663
664 $self->{_tw} ||= AE::timer $after, 0, sub {
665 delete $self->{_tw};
666 $self->_timeout;
667 };
668 } else {
669 delete $self->{_tw};
670 } 820 }
671} 821}
672 822
673############################################################################# 823#############################################################################
674 824
… …
689 839
690=item $handle->on_drain ($cb) 840=item $handle->on_drain ($cb)
691 841
692Sets 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
693C<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).
694 847
695=cut 848=cut
696 849
697sub on_drain { 850sub on_drain {
698 my ($self, $cb) = @_; 851 my ($self, $cb) = @_;
… …
707 860
708Queues 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
709want (only limited by the available memory), as C<AnyEvent::Handle> 862want (only limited by the available memory), as C<AnyEvent::Handle>
710buffers it independently of the kernel. 863buffers it independently of the kernel.
711 864
865This method may invoke callbacks (and therefore the handle might be
866destroyed after it returns).
867
712=cut 868=cut
713 869
714sub _drain_wbuf { 870sub _drain_wbuf {
715 my ($self) = @_; 871 my ($self) = @_;
716 872
… …
722 my $len = syswrite $self->{fh}, $self->{wbuf}; 878 my $len = syswrite $self->{fh}, $self->{wbuf};
723 879
724 if (defined $len) { 880 if (defined $len) {
725 substr $self->{wbuf}, 0, $len, ""; 881 substr $self->{wbuf}, 0, $len, "";
726 882
727 $self->{_activity} = AE::now; 883 $self->{_activity} = $self->{_wactivity} = AE::now;
728 884
729 $self->{on_drain}($self) 885 $self->{on_drain}($self)
730 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})
731 && $self->{on_drain}; 887 && $self->{on_drain};
732 888
… …
745 }; 901 };
746} 902}
747 903
748our %WH; 904our %WH;
749 905
906# deprecated
750sub register_write_type($$) { 907sub register_write_type($$) {
751 $WH{$_[0]} = $_[1]; 908 $WH{$_[0]} = $_[1];
752} 909}
753 910
754sub push_write { 911sub push_write {
755 my $self = shift; 912 my $self = shift;
756 913
757 if (@_ > 1) { 914 if (@_ > 1) {
758 my $type = shift; 915 my $type = shift;
759 916
917 @_ = ($WH{$type} ||= _load_func "$type\::anyevent_write_type"
760 @_ = ($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")
761 ->($self, @_); 919 ->($self, @_);
762 } 920 }
763 921
922 # we downgrade here to avoid hard-to-track-down bugs,
923 # and diagnose the problem earlier and better.
924
764 if ($self->{tls}) { 925 if ($self->{tls}) {
765 $self->{_tls_wbuf} .= $_[0]; 926 utf8::downgrade $self->{_tls_wbuf} .= $_[0];
766 &_dotls ($self) if $self->{fh}; 927 &_dotls ($self) if $self->{fh};
767 } else { 928 } else {
768 $self->{wbuf} .= $_[0]; 929 utf8::downgrade $self->{wbuf} .= $_[0];
769 $self->_drain_wbuf if $self->{fh}; 930 $self->_drain_wbuf if $self->{fh};
770 } 931 }
771} 932}
772 933
773=item $handle->push_write (type => @args) 934=item $handle->push_write (type => @args)
774 935
775Instead of formatting your data yourself, you can also let this module do 936Instead of formatting your data yourself, you can also let this module
776the 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).
777 941
778Predefined 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
779drop by and tell us): 943drop by and tell us):
780 944
781=over 4 945=over 4
… …
838Other languages could read single lines terminated by a newline and pass 1002Other languages could read single lines terminated by a newline and pass
839this line into their JSON decoder of choice. 1003this line into their JSON decoder of choice.
840 1004
841=cut 1005=cut
842 1006
1007sub json_coder() {
1008 eval { require JSON::XS; JSON::XS->new->utf8 }
1009 || do { require JSON; JSON->new->utf8 }
1010}
1011
843register_write_type json => sub { 1012register_write_type json => sub {
844 my ($self, $ref) = @_; 1013 my ($self, $ref) = @_;
845 1014
846 require JSON; 1015 my $json = $self->{json} ||= json_coder;
847 1016
848 $self->{json} ? $self->{json}->encode ($ref) 1017 $json->encode ($ref)
849 : JSON::encode_json ($ref)
850}; 1018};
851 1019
852=item storable => $reference 1020=item storable => $reference
853 1021
854Freezes the given reference using L<Storable> and writes it to the 1022Freezes the given reference using L<Storable> and writes it to the
… …
880the peer. 1048the peer.
881 1049
882You 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
883afterwards. This is the cleanest way to close a connection. 1051afterwards. This is the cleanest way to close a connection.
884 1052
1053This method may invoke callbacks (and therefore the handle might be
1054destroyed after it returns).
1055
885=cut 1056=cut
886 1057
887sub push_shutdown { 1058sub push_shutdown {
888 my ($self) = @_; 1059 my ($self) = @_;
889 1060
890 delete $self->{low_water_mark}; 1061 delete $self->{low_water_mark};
891 $self->on_drain (sub { shutdown $_[0]{fh}, 1 }); 1062 $self->on_drain (sub { shutdown $_[0]{fh}, 1 });
892} 1063}
893 1064
894=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args) 1065=item custom write types - Package::anyevent_write_type $handle, @args
895 1066
896This 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
897Whenever 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
898reference with the handle object and the remaining arguments. 1074the handle object and the remaining arguments.
899 1075
900The 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
901be 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.
902 1079
903Note 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
904global, 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 }
905 1096
906=cut 1097=cut
907 1098
908############################################################################# 1099#############################################################################
909 1100
… …
918ways, 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
919a queue. 1110a queue.
920 1111
921In 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
922new 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
923enough 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
924leave 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
925partial message has been received so far). 1116partial message has been received so far), or change the read queue with
1117e.g. C<push_read>.
926 1118
927In 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
928case, AnyEvent::Handle will call the first queued callback each time new 1120case, AnyEvent::Handle will call the first queued callback each time new
929data 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
930done its job (see C<push_read>, below). 1122done its job (see C<push_read>, below).
931 1123
932This 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
933a chunk of data, and AnyEvent::Handle will execute them in order. 1125a chunk of data, and AnyEvent::Handle will execute them in order.
934 1126
… …
1065 1257
1066This 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
1067the 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
1068constructor. 1260constructor.
1069 1261
1262This method may invoke callbacks (and therefore the handle might be
1263destroyed after it returns).
1264
1070=cut 1265=cut
1071 1266
1072sub on_read { 1267sub on_read {
1073 my ($self, $cb) = @_; 1268 my ($self, $cb) = @_;
1074 1269
… …
1076 $self->_drain_rbuf if $cb; 1271 $self->_drain_rbuf if $cb;
1077} 1272}
1078 1273
1079=item $handle->rbuf 1274=item $handle->rbuf
1080 1275
1081Returns the read buffer (as a modifiable lvalue). 1276Returns the read buffer (as a modifiable lvalue). You can also access the
1277read buffer directly as the C<< ->{rbuf} >> member, if you want (this is
1278much faster, and no less clean).
1082 1279
1083You can access the read buffer directly as the C<< ->{rbuf} >> 1280The only operation allowed on the read buffer (apart from looking at it)
1084member, if you want. However, the only operation allowed on the 1281is removing data from its beginning. Otherwise modifying or appending to
1085read buffer (apart from looking at it) is removing data from its 1282it is not allowed and will lead to hard-to-track-down bugs.
1086beginning. Otherwise modifying or appending to it is not allowed and will
1087lead to hard-to-track-down bugs.
1088 1283
1089NOTE: The read buffer should only be used or modified if the C<on_read>, 1284NOTE: The read buffer should only be used or modified in the C<on_read>
1090C<push_read> or C<unshift_read> methods are used. The other read methods 1285callback or when C<push_read> or C<unshift_read> are used with a single
1091automatically manage the read buffer. 1286callback (i.e. untyped). Typed C<push_read> and C<unshift_read> methods
1287will manage the read buffer on their own.
1092 1288
1093=cut 1289=cut
1094 1290
1095sub rbuf : lvalue { 1291sub rbuf : lvalue {
1096 $_[0]{rbuf} 1292 $_[0]{rbuf}
… …
1113 1309
1114If enough data was available, then the callback must remove all data it is 1310If enough data was available, then the callback must remove all data it is
1115interested in (which can be none at all) and return a true value. After returning 1311interested in (which can be none at all) and return a true value. After returning
1116true, it will be removed from the queue. 1312true, it will be removed from the queue.
1117 1313
1314These methods may invoke callbacks (and therefore the handle might be
1315destroyed after it returns).
1316
1118=cut 1317=cut
1119 1318
1120our %RH; 1319our %RH;
1121 1320
1122sub register_read_type($$) { 1321sub register_read_type($$) {
… …
1128 my $cb = pop; 1327 my $cb = pop;
1129 1328
1130 if (@_) { 1329 if (@_) {
1131 my $type = shift; 1330 my $type = shift;
1132 1331
1332 $cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type"
1133 $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read") 1333 or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_read")
1134 ->($self, $cb, @_); 1334 ->($self, $cb, @_);
1135 } 1335 }
1136 1336
1137 push @{ $self->{_queue} }, $cb; 1337 push @{ $self->{_queue} }, $cb;
1138 $self->_drain_rbuf; 1338 $self->_drain_rbuf;
… …
1143 my $cb = pop; 1343 my $cb = pop;
1144 1344
1145 if (@_) { 1345 if (@_) {
1146 my $type = shift; 1346 my $type = shift;
1147 1347
1348 $cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type"
1148 $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read") 1349 or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::unshift_read")
1149 ->($self, $cb, @_); 1350 ->($self, $cb, @_);
1150 } 1351 }
1151
1152 1352
1153 unshift @{ $self->{_queue} }, $cb; 1353 unshift @{ $self->{_queue} }, $cb;
1154 $self->_drain_rbuf; 1354 $self->_drain_rbuf;
1155} 1355}
1156 1356
… …
1158 1358
1159=item $handle->unshift_read (type => @args, $cb) 1359=item $handle->unshift_read (type => @args, $cb)
1160 1360
1161Instead of providing a callback that parses the data itself you can chose 1361Instead of providing a callback that parses the data itself you can chose
1162between a number of predefined parsing formats, for chunks of data, lines 1362between a number of predefined parsing formats, for chunks of data, lines
1163etc. 1363etc. You can also specify the (fully qualified) name of a package, in
1364which case AnyEvent tries to load the package and then expects to find the
1365C<anyevent_read_type> function inside (see "custom read types", below).
1164 1366
1165Predefined types are (if you have ideas for additional types, feel free to 1367Predefined types are (if you have ideas for additional types, feel free to
1166drop by and tell us): 1368drop by and tell us):
1167 1369
1168=over 4 1370=over 4
… …
1260the receive buffer when neither C<$accept> nor C<$reject> match, 1462the receive buffer when neither C<$accept> nor C<$reject> match,
1261and everything preceding and including the match will be accepted 1463and everything preceding and including the match will be accepted
1262unconditionally. This is useful to skip large amounts of data that you 1464unconditionally. This is useful to skip large amounts of data that you
1263know cannot be matched, so that the C<$accept> or C<$reject> regex do not 1465know cannot be matched, so that the C<$accept> or C<$reject> regex do not
1264have to start matching from the beginning. This is purely an optimisation 1466have to start matching from the beginning. This is purely an optimisation
1265and is usually worth only when you expect more than a few kilobytes. 1467and is usually worth it only when you expect more than a few kilobytes.
1266 1468
1267Example: expect a http header, which ends at C<\015\012\015\012>. Since we 1469Example: expect a http header, which ends at C<\015\012\015\012>. Since we
1268expect the header to be very large (it isn't in practise, but...), we use 1470expect the header to be very large (it isn't in practice, but...), we use
1269a skip regex to skip initial portions. The skip regex is tricky in that 1471a skip regex to skip initial portions. The skip regex is tricky in that
1270it only accepts something not ending in either \015 or \012, as these are 1472it only accepts something not ending in either \015 or \012, as these are
1271required for the accept regex. 1473required for the accept regex.
1272 1474
1273 $handle->push_read (regex => 1475 $handle->push_read (regex =>
… …
1408=cut 1610=cut
1409 1611
1410register_read_type json => sub { 1612register_read_type json => sub {
1411 my ($self, $cb) = @_; 1613 my ($self, $cb) = @_;
1412 1614
1413 my $json = $self->{json} ||= 1615 my $json = $self->{json} ||= json_coder;
1414 eval { require JSON::XS; JSON::XS->new->utf8 }
1415 || do { require JSON; JSON->new->utf8 };
1416 1616
1417 my $data; 1617 my $data;
1418 my $rbuf = \$self->{rbuf}; 1618 my $rbuf = \$self->{rbuf};
1419 1619
1420 sub { 1620 sub {
… …
1489 } 1689 }
1490}; 1690};
1491 1691
1492=back 1692=back
1493 1693
1494=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args) 1694=item custom read types - Package::anyevent_read_type $handle, $cb, @args
1495 1695
1496This function (not method) lets you add your own types to C<push_read>. 1696Instead of one of the predefined types, you can also specify the name
1697of a package. AnyEvent will try to load the package and then expects to
1698find a function named C<anyevent_read_type> inside. If it isn't found, it
1699progressively tries to load the parent package until it either finds the
1700function (good) or runs out of packages (bad).
1497 1701
1498Whenever the given C<type> is used, C<push_read> will invoke the code 1702Whenever this type is used, C<push_read> will invoke the function with the
1499reference with the handle object, the callback and the remaining 1703handle object, the original callback and the remaining arguments.
1500arguments.
1501 1704
1502The code reference is supposed to return a callback (usually a closure) 1705The function is supposed to return a callback (usually a closure) that
1503that works as a plain read callback (see C<< ->push_read ($cb) >>). 1706works as a plain read callback (see C<< ->push_read ($cb) >>), so you can
1707mentally treat the function as a "configurable read type to read callback"
1708converter.
1504 1709
1505It should invoke the passed callback when it is done reading (remember to 1710It should invoke the original callback when it is done reading (remember
1506pass C<$handle> as first argument as all other callbacks do that). 1711to pass C<$handle> as first argument as all other callbacks do that,
1712although there is no strict requirement on this).
1507 1713
1508Note that this is a function, and all types registered this way will be
1509global, so try to use unique names.
1510
1511For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>, 1714For examples, see the source of this module (F<perldoc -m
1512search for C<register_read_type>)). 1715AnyEvent::Handle>, search for C<register_read_type>)).
1513 1716
1514=item $handle->stop_read 1717=item $handle->stop_read
1515 1718
1516=item $handle->start_read 1719=item $handle->start_read
1517 1720
… …
1537} 1740}
1538 1741
1539sub start_read { 1742sub start_read {
1540 my ($self) = @_; 1743 my ($self) = @_;
1541 1744
1542 unless ($self->{_rw} || $self->{_eof}) { 1745 unless ($self->{_rw} || $self->{_eof} || !$self->{fh}) {
1543 Scalar::Util::weaken $self; 1746 Scalar::Util::weaken $self;
1544 1747
1545 $self->{_rw} = AE::io $self->{fh}, 0, sub { 1748 $self->{_rw} = AE::io $self->{fh}, 0, sub {
1546 my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf}); 1749 my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1547 my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf; 1750 my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf;
1548 1751
1549 if ($len > 0) { 1752 if ($len > 0) {
1550 $self->{_activity} = AE::now; 1753 $self->{_activity} = $self->{_ractivity} = AE::now;
1551 1754
1552 if ($self->{tls}) { 1755 if ($self->{tls}) {
1553 Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf); 1756 Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1554 1757
1555 &_dotls ($self); 1758 &_dotls ($self);
… …
1640 && ($tmp != $ERROR_SYSCALL || $!); 1843 && ($tmp != $ERROR_SYSCALL || $!);
1641 1844
1642 while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) { 1845 while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1643 $self->{wbuf} .= $tmp; 1846 $self->{wbuf} .= $tmp;
1644 $self->_drain_wbuf; 1847 $self->_drain_wbuf;
1848 $self->{tls} or return; # tls session might have gone away in callback
1645 } 1849 }
1646 1850
1647 $self->{_on_starttls} 1851 $self->{_on_starttls}
1648 and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK () 1852 and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
1649 and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established"); 1853 and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");
… …
1671context in C<< $handle->{tls_ctx} >> after this call and can be used or 1875context in C<< $handle->{tls_ctx} >> after this call and can be used or
1672changed to your liking. Note that the handshake might have already started 1876changed to your liking. Note that the handshake might have already started
1673when this function returns. 1877when this function returns.
1674 1878
1675Due to bugs in OpenSSL, it might or might not be possible to do multiple 1879Due to bugs in OpenSSL, it might or might not be possible to do multiple
1676handshakes on the same stream. Best do not attempt to use the stream after 1880handshakes on the same stream. It is best to not attempt to use the
1677stopping TLS. 1881stream after stopping TLS.
1882
1883This method may invoke callbacks (and therefore the handle might be
1884destroyed after it returns).
1678 1885
1679=cut 1886=cut
1680 1887
1681our %TLS_CACHE; #TODO not yet documented, should we? 1888our %TLS_CACHE; #TODO not yet documented, should we?
1682 1889
… …
1694 require Net::SSLeay; 1901 require Net::SSLeay;
1695 1902
1696 $ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL (); 1903 $ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1697 $ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ (); 1904 $ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1698 1905
1699 $tls = $self->{tls}; 1906 $tls = delete $self->{tls};
1700 $ctx = $self->{tls_ctx}; 1907 $ctx = $self->{tls_ctx};
1701 1908
1702 local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session 1909 local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
1703 1910
1704 if ("HASH" eq ref $ctx) { 1911 if ("HASH" eq ref $ctx) {
… …
1748 1955
1749=item $handle->stoptls 1956=item $handle->stoptls
1750 1957
1751Shuts down the SSL connection - this makes a proper EOF handshake by 1958Shuts down the SSL connection - this makes a proper EOF handshake by
1752sending a close notify to the other side, but since OpenSSL doesn't 1959sending a close notify to the other side, but since OpenSSL doesn't
1753support non-blocking shut downs, it is not guarenteed that you can re-use 1960support non-blocking shut downs, it is not guaranteed that you can re-use
1754the stream afterwards. 1961the stream afterwards.
1962
1963This method may invoke callbacks (and therefore the handle might be
1964destroyed after it returns).
1755 1965
1756=cut 1966=cut
1757 1967
1758sub stoptls { 1968sub stoptls {
1759 my ($self) = @_; 1969 my ($self) = @_;
1760 1970
1761 if ($self->{tls}) { 1971 if ($self->{tls} && $self->{fh}) {
1762 Net::SSLeay::shutdown ($self->{tls}); 1972 Net::SSLeay::shutdown ($self->{tls});
1763 1973
1764 &_dotls; 1974 &_dotls;
1765 1975
1766# # we don't give a shit. no, we do, but we can't. no...#d# 1976# # we don't give a shit. no, we do, but we can't. no...#d#
… …
1843 2053
1844sub AnyEvent::Handle::destroyed::AUTOLOAD { 2054sub AnyEvent::Handle::destroyed::AUTOLOAD {
1845 #nop 2055 #nop
1846} 2056}
1847 2057
2058=item $handle->destroyed
2059
2060Returns false as long as the handle hasn't been destroyed by a call to C<<
2061->destroy >>, true otherwise.
2062
2063Can be useful to decide whether the handle is still valid after some
2064callback possibly destroyed the handle. For example, C<< ->push_write >>,
2065C<< ->starttls >> and other methods can call user callbacks, which in turn
2066can destroy the handle, so work can be avoided by checking sometimes:
2067
2068 $hdl->starttls ("accept");
2069 return if $hdl->destroyed;
2070 $hdl->push_write (...
2071
2072Note that the call to C<push_write> will silently be ignored if the handle
2073has been destroyed, so often you can just ignore the possibility of the
2074handle being destroyed.
2075
2076=cut
2077
2078sub destroyed { 0 }
2079sub AnyEvent::Handle::destroyed::destroyed { 1 }
2080
1848=item AnyEvent::Handle::TLS_CTX 2081=item AnyEvent::Handle::TLS_CTX
1849 2082
1850This function creates and returns the AnyEvent::TLS object used by default 2083This function creates and returns the AnyEvent::TLS object used by default
1851for TLS mode. 2084for TLS mode.
1852 2085
… …
1883 2116
1884=item I get different callback invocations in TLS mode/Why can't I pause 2117=item I get different callback invocations in TLS mode/Why can't I pause
1885reading? 2118reading?
1886 2119
1887Unlike, say, TCP, TLS connections do not consist of two independent 2120Unlike, say, TCP, TLS connections do not consist of two independent
1888communication channels, one for each direction. Or put differently. The 2121communication channels, one for each direction. Or put differently, the
1889read and write directions are not independent of each other: you cannot 2122read and write directions are not independent of each other: you cannot
1890write data unless you are also prepared to read, and vice versa. 2123write data unless you are also prepared to read, and vice versa.
1891 2124
1892This can mean than, in TLS mode, you might get C<on_error> or C<on_eof> 2125This means that, in TLS mode, you might get C<on_error> or C<on_eof>
1893callback invocations when you are not expecting any read data - the reason 2126callback invocations when you are not expecting any read data - the reason
1894is that AnyEvent::Handle always reads in TLS mode. 2127is that AnyEvent::Handle always reads in TLS mode.
1895 2128
1896During the connection, you have to make sure that you always have a 2129During the connection, you have to make sure that you always have a
1897non-empty read-queue, or an C<on_read> watcher. At the end of the 2130non-empty read-queue, or an C<on_read> watcher. At the end of the
… …
1911 my $data = delete $_[0]{rbuf}; 2144 my $data = delete $_[0]{rbuf};
1912 }); 2145 });
1913 2146
1914The reason to use C<on_error> is that TCP connections, due to latencies 2147The reason to use C<on_error> is that TCP connections, due to latencies
1915and packets loss, might get closed quite violently with an error, when in 2148and packets loss, might get closed quite violently with an error, when in
1916fact, all data has been received. 2149fact all data has been received.
1917 2150
1918It is usually better to use acknowledgements when transferring data, 2151It is usually better to use acknowledgements when transferring data,
1919to make sure the other side hasn't just died and you got the data 2152to make sure the other side hasn't just died and you got the data
1920intact. This is also one reason why so many internet protocols have an 2153intact. This is also one reason why so many internet protocols have an
1921explicit QUIT command. 2154explicit QUIT command.
… …
1938consider using C<< ->push_shutdown >> instead. 2171consider using C<< ->push_shutdown >> instead.
1939 2172
1940=item I want to contact a TLS/SSL server, I don't care about security. 2173=item I want to contact a TLS/SSL server, I don't care about security.
1941 2174
1942If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS, 2175If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS,
1943simply connect to it and then create the AnyEvent::Handle with the C<tls> 2176connect to it and then create the AnyEvent::Handle with the C<tls>
1944parameter: 2177parameter:
1945 2178
1946 tcp_connect $host, $port, sub { 2179 tcp_connect $host, $port, sub {
1947 my ($fh) = @_; 2180 my ($fh) = @_;
1948 2181
… …
2048 2281
2049=item * all members not documented here and not prefixed with an underscore 2282=item * all members not documented here and not prefixed with an underscore
2050are free to use in subclasses. 2283are free to use in subclasses.
2051 2284
2052Of course, new versions of AnyEvent::Handle may introduce more "public" 2285Of course, new versions of AnyEvent::Handle may introduce more "public"
2053member variables, but thats just life, at least it is documented. 2286member variables, but that's just life. At least it is documented.
2054 2287
2055=back 2288=back
2056 2289
2057=head1 AUTHOR 2290=head1 AUTHOR
2058 2291

Diff Legend

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