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.168 by root, Fri Jul 31 07:34:00 2009 UTC vs.
Revision 1.203 by root, Sat Oct 16 03:22:10 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
80sub MAX_READ_SIZE() { 131072 }
81
64=head1 METHODS 82=head1 METHODS
65 83
66=over 4 84=over 4
67 85
68=item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value... 86=item $handle = B<new> AnyEvent::Handle fh => $filehandle, key => value...
69 87
70The constructor supports these arguments (all as C<< key => value >> pairs). 88The constructor supports these arguments (all as C<< key => value >> pairs).
71 89
72=over 4 90=over 4
73 91
… …
102prepare the file handle with parameters required for the actual connect 120prepare the file handle with parameters required for the actual connect
103(as opposed to settings that can be changed when the connection is already 121(as opposed to settings that can be changed when the connection is already
104established). 122established).
105 123
106The return value of this callback should be the connect timeout value in 124The 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 125seconds (or C<0>, or C<undef>, or the empty list, to indicate that the
108timeout is to be used). 126default timeout is to be used).
109 127
110=item on_connect => $cb->($handle, $host, $port, $retry->()) 128=item on_connect => $cb->($handle, $host, $port, $retry->())
111 129
112This callback is called when a connection has been successfully established. 130This callback is called when a connection has been successfully established.
113 131
114The actual numeric host and port (the socket peername) are passed as 132The peer's numeric host and port (the socket peername) are passed as
115parameters, together with a retry callback. 133parameters, together with a retry callback.
116 134
117When, for some reason, the handle is not acceptable, then calling 135If, for some reason, the handle is not acceptable, calling C<$retry>
118C<$retry> will continue with the next conenction target (in case of 136will continue with the next connection target (in case of multi-homed
119multi-homed hosts or SRV records there can be multiple connection 137hosts or SRV records there can be multiple connection endpoints). At the
120endpoints). When it is called then the read and write queues, eof status, 138time it is called the read and write queues, eof status, tls status and
121tls status and similar properties of the handle are being reset. 139similar properties of the handle will have been reset.
122 140
123In most cases, ignoring the C<$retry> parameter is the way to go. 141In most cases, you should ignore the C<$retry> parameter.
124 142
125=item on_connect_error => $cb->($handle, $message) 143=item on_connect_error => $cb->($handle, $message)
126 144
127This callback is called when the conenction could not be 145This callback is called when the connection could not be
128established. C<$!> will contain the relevant error code, and C<$message> a 146established. C<$!> will contain the relevant error code, and C<$message> a
129message describing it (usually the same as C<"$!">). 147message describing it (usually the same as C<"$!">).
130 148
131If this callback isn't specified, then C<on_error> will be called with a 149If this callback isn't specified, then C<on_error> will be called with a
132fatal error instead. 150fatal error instead.
… …
135 153
136=item on_error => $cb->($handle, $fatal, $message) 154=item on_error => $cb->($handle, $fatal, $message)
137 155
138This is the error callback, which is called when, well, some error 156This is the error callback, which is called when, well, some error
139occured, such as not being able to resolve the hostname, failure to 157occured, such as not being able to resolve the hostname, failure to
140connect or a read error. 158connect, or a read error.
141 159
142Some errors are fatal (which is indicated by C<$fatal> being true). On 160Some 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<< -> 161fatal errors the handle object will be destroyed (by a call to C<< ->
144destroy >>) after invoking the error callback (which means you are free to 162destroy >>) after invoking the error callback (which means you are free to
145examine the handle object). Examples of fatal errors are an EOF condition 163examine the handle object). Examples of fatal errors are an EOF condition
146with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors. In 164with 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 165cases where the other side can close the connection at will, it is
148often easiest to not report C<EPIPE> errors in this callback. 166often easiest to not report C<EPIPE> errors in this callback.
149 167
150AnyEvent::Handle tries to find an appropriate error code for you to check 168AnyEvent::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 169against, but in some cases (TLS errors), this does not work well. It is
152recommended to always output the C<$message> argument in human-readable 170recommended to always output the C<$message> argument in human-readable
153error messages (it's usually the same as C<"$!">). 171error messages (it's usually the same as C<"$!">).
154 172
155Non-fatal errors can be retried by simply returning, but it is recommended 173Non-fatal errors can be retried by returning, but it is recommended
156to simply ignore this parameter and instead abondon the handle object 174to simply ignore this parameter and instead abondon the handle object
157when this callback is invoked. Examples of non-fatal errors are timeouts 175when this callback is invoked. Examples of non-fatal errors are timeouts
158C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>). 176C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
159 177
160On callback entrance, the value of C<$!> contains the operating system 178On entry to the callback, the value of C<$!> contains the operating
161error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or 179system error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
162C<EPROTO>). 180C<EPROTO>).
163 181
164While not mandatory, it is I<highly> recommended to set this callback, as 182While not mandatory, it is I<highly> recommended to set this callback, as
165you will not be notified of errors otherwise. The default simply calls 183you will not be notified of errors otherwise. The default just calls
166C<croak>. 184C<croak>.
167 185
168=item on_read => $cb->($handle) 186=item on_read => $cb->($handle)
169 187
170This sets the default read callback, which is called when data arrives 188This sets the default read callback, which is called when data arrives
… …
175To access (and remove data from) the read buffer, use the C<< ->rbuf >> 193To access (and remove data from) the read buffer, use the C<< ->rbuf >>
176method or access the C<< $handle->{rbuf} >> member directly. Note that you 194method 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 195must not enlarge or modify the read buffer, you can only remove data at
178the beginning from it. 196the beginning from it.
179 197
198You can also call C<< ->push_read (...) >> or any other function that
199modifies the read queue. Or do both. Or ...
200
180When an EOF condition is detected then AnyEvent::Handle will first try to 201When 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 202feed 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 203calling the C<on_eof> callback. If no progress can be made, then a fatal
183error will be raised (with C<$!> set to C<EPIPE>). 204error will be raised (with C<$!> set to C<EPIPE>).
184 205
185Note that, unlike requests in the read queue, an C<on_read> callback 206Note 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>. 225set, then a fatal error will be raised with C<$!> set to <0>.
205 226
206=item on_drain => $cb->($handle) 227=item on_drain => $cb->($handle)
207 228
208This sets the callback that is called when the write buffer becomes empty 229This 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). 230(or immediately if the buffer is empty already).
210 231
211To append to the write buffer, use the C<< ->push_write >> method. 232To append to the write buffer, use the C<< ->push_write >> method.
212 233
213This callback is useful when you don't want to put all of your write data 234This 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 235into 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 237memory and push it into the queue, but instead only read more data from
217the file when the write queue becomes empty. 238the file when the write queue becomes empty.
218 239
219=item timeout => $fractional_seconds 240=item timeout => $fractional_seconds
220 241
242=item rtimeout => $fractional_seconds
243
244=item wtimeout => $fractional_seconds
245
221If non-zero, then this enables an "inactivity" timeout: whenever this many 246If non-zero, then these enables an "inactivity" timeout: whenever this
222seconds pass without a successful read or write on the underlying file 247many 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 248file handle (or a call to C<timeout_reset>), the C<on_timeout> callback
224missing, a non-fatal C<ETIMEDOUT> error will be raised). 249will be invoked (and if that one is missing, a non-fatal C<ETIMEDOUT>
250error will be raised).
225 251
252There are three variants of the timeouts that work independently
253of each other, for both read and write, just read, and just write:
254C<timeout>, C<rtimeout> and C<wtimeout>, with corresponding callbacks
255C<on_timeout>, C<on_rtimeout> and C<on_wtimeout>, and reset functions
256C<timeout_reset>, C<rtimeout_reset>, and C<wtimeout_reset>.
257
226Note that timeout processing is also active when you currently do not have 258Note that timeout processing is active even when you do not have
227any outstanding read or write requests: If you plan to keep the connection 259any outstanding read or write requests: If you plan to keep the connection
228idle then you should disable the timout temporarily or ignore the timeout 260idle then you should disable the timeout temporarily or ignore the timeout
229in the C<on_timeout> callback, in which case AnyEvent::Handle will simply 261in the C<on_timeout> callback, in which case AnyEvent::Handle will simply
230restart the timeout. 262restart the timeout.
231 263
232Zero (the default) disables this timeout. 264Zero (the default) disables this timeout.
233 265
… …
249amount of data without a callback ever being called as long as the line 281amount of data without a callback ever being called as long as the line
250isn't finished). 282isn't finished).
251 283
252=item autocork => <boolean> 284=item autocork => <boolean>
253 285
254When disabled (the default), then C<push_write> will try to immediately 286When disabled (the default), C<push_write> will try to immediately
255write the data to the handle, if possible. This avoids having to register 287write 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 288a write watcher and wait for the next event loop iteration, but can
257be inefficient if you write multiple small chunks (on the wire, this 289be inefficient if you write multiple small chunks (on the wire, this
258disadvantage is usually avoided by your kernel's nagle algorithm, see 290disadvantage is usually avoided by your kernel's nagle algorithm, see
259C<no_delay>, but this option can save costly syscalls). 291C<no_delay>, but this option can save costly syscalls).
260 292
261When enabled, then writes will always be queued till the next event loop 293When enabled, writes will always be queued till the next event loop
262iteration. This is efficient when you do many small writes per iteration, 294iteration. 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 295but less efficient when you do a single write only per iteration (or when
264the write buffer often is full). It also increases write latency. 296the write buffer often is full). It also increases write latency.
265 297
266=item no_delay => <boolean> 298=item no_delay => <boolean>
… …
270the Nagle algorithm, and usually it is beneficial. 302the Nagle algorithm, and usually it is beneficial.
271 303
272In some situations you want as low a delay as possible, which can be 304In some situations you want as low a delay as possible, which can be
273accomplishd by setting this option to a true value. 305accomplishd by setting this option to a true value.
274 306
275The default is your opertaing system's default behaviour (most likely 307The default is your operating system's default behaviour (most likely
276enabled), this option explicitly enables or disables it, if possible. 308enabled). This option explicitly enables or disables it, if possible.
309
310=item keepalive => <boolean>
311
312Enables (default disable) the SO_KEEPALIVE option on the stream socket:
313normally, TCP connections have no time-out once established, so TCP
314connections, once established, can stay alive forever even when the other
315side has long gone. TCP keepalives are a cheap way to take down long-lived
316TCP connections when the other side becomes unreachable. While the default
317is OS-dependent, TCP keepalives usually kick in after around two hours,
318and, if the other side doesn't reply, take down the TCP connection some 10
319to 15 minutes later.
320
321It is harmless to specify this option for file handles that do not support
322keepalives, and enabling it on connections that are potentially long-lived
323is usually a good idea.
324
325=item oobinline => <boolean>
326
327BSD majorly fucked up the implementation of TCP urgent data. The result
328is that almost no OS implements TCP according to the specs, and every OS
329implements it slightly differently.
330
331If you want to handle TCP urgent data, then setting this flag (the default
332is enabled) gives you the most portable way of getting urgent data, by
333putting it into the stream.
334
335Since BSD emulation of OOB data on top of TCP's urgent data can have
336security implications, AnyEvent::Handle sets this flag automatically
337unless explicitly specified. Note that setting this flag after
338establishing a connection I<may> be a bit too late (data loss could
339already have occured on BSD systems), but at least it will protect you
340from most attacks.
277 341
278=item read_size => <bytes> 342=item read_size => <bytes>
279 343
280The default read block size (the amount of bytes this module will 344The initial read block size, the number of bytes this module will try to
281try to read during each loop iteration, which affects memory 345read during each loop iteration. Each handle object will consume at least
282requirements). Default: C<8192>. 346this amount of memory for the read buffer as well, so when handling many
347connections requirements). See also C<max_read_size>. Default: C<2048>.
348
349=item max_read_size => <bytes>
350
351The maximum read buffer size used by the dynamic adjustment
352algorithm: Each time AnyEvent::Handle can read C<read_size> bytes in
353one go it will double C<read_size> up to the maximum given by this
354option. Default: C<131072> or C<read_size>, whichever is higher.
283 355
284=item low_water_mark => <bytes> 356=item low_water_mark => <bytes>
285 357
286Sets the amount of bytes (default: C<0>) that make up an "empty" write 358Sets 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 359buffer: If the buffer reaches this size or gets even samller it is
288considered empty. 360considered empty.
289 361
290Sometimes it can be beneficial (for performance reasons) to add data to 362Sometimes 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 363the 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 364the operating system kernel usually buffers data as well, so the default
293is good in almost all cases. 365is good in almost all cases.
294 366
295=item linger => <seconds> 367=item linger => <seconds>
296 368
297If non-zero (default: C<3600>), then the destructor of the 369If this is non-zero (default: C<3600>), the destructor of the
298AnyEvent::Handle object will check whether there is still outstanding 370AnyEvent::Handle object will check whether there is still outstanding
299write data and will install a watcher that will write this data to the 371write 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 372socket. No errors will be reported (this mostly matches how the operating
301system treats outstanding data at socket close time). 373system treats outstanding data at socket close time).
302 374
… …
309A string used to identify the remote site - usually the DNS hostname 381A string used to identify the remote site - usually the DNS hostname
310(I<not> IDN!) used to create the connection, rarely the IP address. 382(I<not> IDN!) used to create the connection, rarely the IP address.
311 383
312Apart from being useful in error messages, this string is also used in TLS 384Apart from being useful in error messages, this string is also used in TLS
313peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This 385peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This
314verification will be skipped when C<peername> is not specified or 386verification will be skipped when C<peername> is not specified or is
315C<undef>. 387C<undef>.
316 388
317=item tls => "accept" | "connect" | Net::SSLeay::SSL object 389=item tls => "accept" | "connect" | Net::SSLeay::SSL object
318 390
319When this parameter is given, it enables TLS (SSL) mode, that means 391When this parameter is given, it enables TLS (SSL) mode, that means
320AnyEvent will start a TLS handshake as soon as the conenction has been 392AnyEvent will start a TLS handshake as soon as the connection has been
321established and will transparently encrypt/decrypt data afterwards. 393established and will transparently encrypt/decrypt data afterwards.
322 394
323All TLS protocol errors will be signalled as C<EPROTO>, with an 395All TLS protocol errors will be signalled as C<EPROTO>, with an
324appropriate error message. 396appropriate error message.
325 397
… …
345B<IMPORTANT:> since Net::SSLeay "objects" are really only integers, 417B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,
346passing in the wrong integer will lead to certain crash. This most often 418passing 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 419happens when one uses a stylish C<< tls => 1 >> and is surprised about the
348segmentation fault. 420segmentation fault.
349 421
350See the C<< ->starttls >> method for when need to start TLS negotiation later. 422Use the C<< ->starttls >> method if you need to start TLS negotiation later.
351 423
352=item tls_ctx => $anyevent_tls 424=item tls_ctx => $anyevent_tls
353 425
354Use the given C<AnyEvent::TLS> object to create the new TLS connection 426Use the given C<AnyEvent::TLS> object to create the new TLS connection
355(unless a connection object was specified directly). If this parameter is 427(unless a connection object was specified directly). If this parameter is
… …
370 442
371TLS handshake failures will not cause C<on_error> to be invoked when this 443TLS 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>. 444callback is in effect, instead, the error message will be passed to C<on_starttls>.
373 445
374Without this callback, handshake failures lead to C<on_error> being 446Without this callback, handshake failures lead to C<on_error> being
375called, as normal. 447called as usual.
376 448
377Note that you cannot call C<starttls> right again in this callback. If you 449Note 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 450need to do that, start an zero-second timer instead whose callback can
379then call C<< ->starttls >> again. 451then call C<< ->starttls >> again.
380 452
381=item on_stoptls => $cb->($handle) 453=item on_stoptls => $cb->($handle)
382 454
… …
438 delete $self->{_skip_drain_rbuf}; 510 delete $self->{_skip_drain_rbuf};
439 $self->_start; 511 $self->_start;
440 512
441 $self->{on_connect} 513 $self->{on_connect}
442 and $self->{on_connect}($self, $host, $port, sub { 514 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)}; 515 delete @$self{qw(fh _tw _rtw _wtw _ww _rw _eof _queue rbuf _wbuf tls _tls_rbuf _tls_wbuf)};
444 $self->{_skip_drain_rbuf} = 1; 516 $self->{_skip_drain_rbuf} = 1;
445 &$retry; 517 &$retry;
446 }); 518 });
447 519
448 } else { 520 } else {
… …
472} 544}
473 545
474sub _start { 546sub _start {
475 my ($self) = @_; 547 my ($self) = @_;
476 548
549 # too many clueless people try to use udp and similar sockets
550 # with AnyEvent::Handle, do them a favour.
551 my $type = getsockopt $self->{fh}, Socket::SOL_SOCKET (), Socket::SO_TYPE ();
552 Carp::croak "AnyEvent::Handle: only stream sockets supported, anything else will NOT work!"
553 if Socket::SOCK_STREAM () != (unpack "I", $type) && defined $type;
554
477 AnyEvent::Util::fh_nonblocking $self->{fh}, 1; 555 AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
478 556
557 $self->{_activity} =
558 $self->{_ractivity} =
479 $self->{_activity} = AnyEvent->now; 559 $self->{_wactivity} = AE::now;
480 $self->_timeout;
481 560
561 $self->{read_size} ||= 2048;
562 $self->{max_read_size} = $self->{read_size}
563 if $self->{read_size} > ($self->{max_read_size} || MAX_READ_SIZE);
564
565 $self->timeout (delete $self->{timeout} ) if $self->{timeout};
566 $self->rtimeout (delete $self->{rtimeout} ) if $self->{rtimeout};
567 $self->wtimeout (delete $self->{wtimeout} ) if $self->{wtimeout};
568
482 $self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay}; 569 $self->no_delay (delete $self->{no_delay} ) if exists $self->{no_delay} && $self->{no_delay};
570 $self->keepalive (delete $self->{keepalive}) if exists $self->{keepalive} && $self->{keepalive};
483 571
572 $self->oobinline (exists $self->{oobinline} ? delete $self->{oobinline} : 1);
573
484 $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}) 574 $self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
485 if $self->{tls}; 575 if $self->{tls};
486 576
487 $self->on_drain (delete $self->{on_drain}) if $self->{on_drain}; 577 $self->on_drain (delete $self->{on_drain} ) if $self->{on_drain};
488 578
489 $self->start_read 579 $self->start_read
490 if $self->{on_read} || @{ $self->{_queue} }; 580 if $self->{on_read} || @{ $self->{_queue} };
491 581
492 $self->_drain_wbuf; 582 $self->_drain_wbuf;
493} 583}
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 584
504sub _error { 585sub _error {
505 my ($self, $errno, $fatal, $message) = @_; 586 my ($self, $errno, $fatal, $message) = @_;
506 587
507 $! = $errno; 588 $! = $errno;
508 $message ||= "$!"; 589 $message ||= "$!";
509 590
510 if ($self->{on_error}) { 591 if ($self->{on_error}) {
511 $self->{on_error}($self, $fatal, $message); 592 $self->{on_error}($self, $fatal, $message);
512 $self->destroy if $fatal; 593 $self->destroy if $fatal;
513 } elsif ($self->{fh}) { 594 } elsif ($self->{fh} || $self->{connect}) {
514 $self->destroy; 595 $self->destroy;
515 Carp::croak "AnyEvent::Handle uncaught error: $message"; 596 Carp::croak "AnyEvent::Handle uncaught error: $message";
516 } 597 }
517} 598}
518 599
… …
544 $_[0]{on_eof} = $_[1]; 625 $_[0]{on_eof} = $_[1];
545} 626}
546 627
547=item $handle->on_timeout ($cb) 628=item $handle->on_timeout ($cb)
548 629
549Replace the current C<on_timeout> callback, or disables the callback (but 630=item $handle->on_rtimeout ($cb)
550not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
551argument and method.
552 631
553=cut 632=item $handle->on_wtimeout ($cb)
554 633
555sub on_timeout { 634Replace the current C<on_timeout>, C<on_rtimeout> or C<on_wtimeout>
556 $_[0]{on_timeout} = $_[1]; 635callback, or disables the callback (but not the timeout) if C<$cb> =
557} 636C<undef>. See the C<timeout> constructor argument and method.
637
638=cut
639
640# see below
558 641
559=item $handle->autocork ($boolean) 642=item $handle->autocork ($boolean)
560 643
561Enables or disables the current autocork behaviour (see C<autocork> 644Enables or disables the current autocork behaviour (see C<autocork>
562constructor argument). Changes will only take effect on the next write. 645constructor argument). Changes will only take effect on the next write.
… …
575=cut 658=cut
576 659
577sub no_delay { 660sub no_delay {
578 $_[0]{no_delay} = $_[1]; 661 $_[0]{no_delay} = $_[1];
579 662
663 setsockopt $_[0]{fh}, Socket::IPPROTO_TCP (), Socket::TCP_NODELAY (), int $_[1]
664 if $_[0]{fh};
665}
666
667=item $handle->keepalive ($boolean)
668
669Enables or disables the C<keepalive> setting (see constructor argument of
670the same name for details).
671
672=cut
673
674sub keepalive {
675 $_[0]{keepalive} = $_[1];
676
580 eval { 677 eval {
581 local $SIG{__DIE__}; 678 local $SIG{__DIE__};
582 setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1] 679 setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
583 if $_[0]{fh}; 680 if $_[0]{fh};
584 }; 681 };
585} 682}
586 683
684=item $handle->oobinline ($boolean)
685
686Enables or disables the C<oobinline> setting (see constructor argument of
687the same name for details).
688
689=cut
690
691sub oobinline {
692 $_[0]{oobinline} = $_[1];
693
694 eval {
695 local $SIG{__DIE__};
696 setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_OOBINLINE (), int $_[1]
697 if $_[0]{fh};
698 };
699}
700
701=item $handle->keepalive ($boolean)
702
703Enables or disables the C<keepalive> setting (see constructor argument of
704the same name for details).
705
706=cut
707
708sub keepalive {
709 $_[0]{keepalive} = $_[1];
710
711 eval {
712 local $SIG{__DIE__};
713 setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
714 if $_[0]{fh};
715 };
716}
717
587=item $handle->on_starttls ($cb) 718=item $handle->on_starttls ($cb)
588 719
589Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument). 720Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument).
590 721
591=cut 722=cut
… …
598 729
599Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument). 730Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).
600 731
601=cut 732=cut
602 733
603sub on_starttls { 734sub on_stoptls {
604 $_[0]{on_stoptls} = $_[1]; 735 $_[0]{on_stoptls} = $_[1];
605} 736}
606 737
607=item $handle->rbuf_max ($max_octets) 738=item $handle->rbuf_max ($max_octets)
608 739
… …
616 747
617############################################################################# 748#############################################################################
618 749
619=item $handle->timeout ($seconds) 750=item $handle->timeout ($seconds)
620 751
752=item $handle->rtimeout ($seconds)
753
754=item $handle->wtimeout ($seconds)
755
621Configures (or disables) the inactivity timeout. 756Configures (or disables) the inactivity timeout.
622 757
623=cut 758=item $handle->timeout_reset
624 759
625sub timeout { 760=item $handle->rtimeout_reset
761
762=item $handle->wtimeout_reset
763
764Reset the activity timeout, as if data was received or sent.
765
766These methods are cheap to call.
767
768=cut
769
770for my $dir ("", "r", "w") {
771 my $timeout = "${dir}timeout";
772 my $tw = "_${dir}tw";
773 my $on_timeout = "on_${dir}timeout";
774 my $activity = "_${dir}activity";
775 my $cb;
776
777 *$on_timeout = sub {
778 $_[0]{$on_timeout} = $_[1];
779 };
780
781 *$timeout = sub {
626 my ($self, $timeout) = @_; 782 my ($self, $new_value) = @_;
627 783
784 $new_value >= 0
785 or Carp::croak "AnyEvent::Handle->$timeout called with negative timeout ($new_value), caught";
786
628 $self->{timeout} = $timeout; 787 $self->{$timeout} = $new_value;
629 $self->_timeout; 788 delete $self->{$tw}; &$cb;
630} 789 };
631 790
791 *{"${dir}timeout_reset"} = sub {
792 $_[0]{$activity} = AE::now;
793 };
794
795 # main workhorse:
632# reset the timeout watcher, as neccessary 796 # reset the timeout watcher, as neccessary
633# also check for time-outs 797 # also check for time-outs
634sub _timeout { 798 $cb = sub {
635 my ($self) = @_; 799 my ($self) = @_;
636 800
637 if ($self->{timeout} && $self->{fh}) { 801 if ($self->{$timeout} && $self->{fh}) {
638 my $NOW = AnyEvent->now; 802 my $NOW = AE::now;
639 803
640 # when would the timeout trigger? 804 # when would the timeout trigger?
641 my $after = $self->{_activity} + $self->{timeout} - $NOW; 805 my $after = $self->{$activity} + $self->{$timeout} - $NOW;
642 806
643 # now or in the past already? 807 # now or in the past already?
644 if ($after <= 0) { 808 if ($after <= 0) {
645 $self->{_activity} = $NOW; 809 $self->{$activity} = $NOW;
646 810
647 if ($self->{on_timeout}) { 811 if ($self->{$on_timeout}) {
648 $self->{on_timeout}($self); 812 $self->{$on_timeout}($self);
649 } else { 813 } else {
650 $self->_error (Errno::ETIMEDOUT); 814 $self->_error (Errno::ETIMEDOUT);
815 }
816
817 # callback could have changed timeout value, optimise
818 return unless $self->{$timeout};
819
820 # calculate new after
821 $after = $self->{$timeout};
651 } 822 }
652 823
653 # callback could have changed timeout value, optimise 824 Scalar::Util::weaken $self;
654 return unless $self->{timeout}; 825 return unless $self; # ->error could have destroyed $self
655 826
656 # calculate new after 827 $self->{$tw} ||= AE::timer $after, 0, sub {
657 $after = $self->{timeout}; 828 delete $self->{$tw};
829 $cb->($self);
830 };
831 } else {
832 delete $self->{$tw};
658 } 833 }
659
660 Scalar::Util::weaken $self;
661 return unless $self; # ->error could have destroyed $self
662
663 $self->{_tw} ||= AnyEvent->timer (after => $after, cb => sub {
664 delete $self->{_tw};
665 $self->_timeout;
666 });
667 } else {
668 delete $self->{_tw};
669 } 834 }
670} 835}
671 836
672############################################################################# 837#############################################################################
673 838
… …
688 853
689=item $handle->on_drain ($cb) 854=item $handle->on_drain ($cb)
690 855
691Sets the C<on_drain> callback or clears it (see the description of 856Sets the C<on_drain> callback or clears it (see the description of
692C<on_drain> in the constructor). 857C<on_drain> in the constructor).
858
859This method may invoke callbacks (and therefore the handle might be
860destroyed after it returns).
693 861
694=cut 862=cut
695 863
696sub on_drain { 864sub on_drain {
697 my ($self, $cb) = @_; 865 my ($self, $cb) = @_;
… …
706 874
707Queues the given scalar to be written. You can push as much data as you 875Queues the given scalar to be written. You can push as much data as you
708want (only limited by the available memory), as C<AnyEvent::Handle> 876want (only limited by the available memory), as C<AnyEvent::Handle>
709buffers it independently of the kernel. 877buffers it independently of the kernel.
710 878
879This method may invoke callbacks (and therefore the handle might be
880destroyed after it returns).
881
711=cut 882=cut
712 883
713sub _drain_wbuf { 884sub _drain_wbuf {
714 my ($self) = @_; 885 my ($self) = @_;
715 886
… …
721 my $len = syswrite $self->{fh}, $self->{wbuf}; 892 my $len = syswrite $self->{fh}, $self->{wbuf};
722 893
723 if (defined $len) { 894 if (defined $len) {
724 substr $self->{wbuf}, 0, $len, ""; 895 substr $self->{wbuf}, 0, $len, "";
725 896
726 $self->{_activity} = AnyEvent->now; 897 $self->{_activity} = $self->{_wactivity} = AE::now;
727 898
728 $self->{on_drain}($self) 899 $self->{on_drain}($self)
729 if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf}) 900 if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
730 && $self->{on_drain}; 901 && $self->{on_drain};
731 902
… …
737 908
738 # try to write data immediately 909 # try to write data immediately
739 $cb->() unless $self->{autocork}; 910 $cb->() unless $self->{autocork};
740 911
741 # if still data left in wbuf, we need to poll 912 # if still data left in wbuf, we need to poll
742 $self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb) 913 $self->{_ww} = AE::io $self->{fh}, 1, $cb
743 if length $self->{wbuf}; 914 if length $self->{wbuf};
744 }; 915 };
745} 916}
746 917
747our %WH; 918our %WH;
748 919
920# deprecated
749sub register_write_type($$) { 921sub register_write_type($$) {
750 $WH{$_[0]} = $_[1]; 922 $WH{$_[0]} = $_[1];
751} 923}
752 924
753sub push_write { 925sub push_write {
754 my $self = shift; 926 my $self = shift;
755 927
756 if (@_ > 1) { 928 if (@_ > 1) {
757 my $type = shift; 929 my $type = shift;
758 930
931 @_ = ($WH{$type} ||= _load_func "$type\::anyevent_write_type"
759 @_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write") 932 or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_write")
760 ->($self, @_); 933 ->($self, @_);
761 } 934 }
762 935
936 # we downgrade here to avoid hard-to-track-down bugs,
937 # and diagnose the problem earlier and better.
938
763 if ($self->{tls}) { 939 if ($self->{tls}) {
764 $self->{_tls_wbuf} .= $_[0]; 940 utf8::downgrade $self->{_tls_wbuf} .= $_[0];
765 &_dotls ($self) if $self->{fh}; 941 &_dotls ($self) if $self->{fh};
766 } else { 942 } else {
767 $self->{wbuf} .= $_[0]; 943 utf8::downgrade $self->{wbuf} .= $_[0];
768 $self->_drain_wbuf if $self->{fh}; 944 $self->_drain_wbuf if $self->{fh};
769 } 945 }
770} 946}
771 947
772=item $handle->push_write (type => @args) 948=item $handle->push_write (type => @args)
773 949
774Instead of formatting your data yourself, you can also let this module do 950Instead of formatting your data yourself, you can also let this module
775the job by specifying a type and type-specific arguments. 951do the job by specifying a type and type-specific arguments. You
952can also specify the (fully qualified) name of a package, in which
953case AnyEvent tries to load the package and then expects to find the
954C<anyevent_write_type> function inside (see "custom write types", below).
776 955
777Predefined types are (if you have ideas for additional types, feel free to 956Predefined types are (if you have ideas for additional types, feel free to
778drop by and tell us): 957drop by and tell us):
779 958
780=over 4 959=over 4
… …
837Other languages could read single lines terminated by a newline and pass 1016Other languages could read single lines terminated by a newline and pass
838this line into their JSON decoder of choice. 1017this line into their JSON decoder of choice.
839 1018
840=cut 1019=cut
841 1020
1021sub json_coder() {
1022 eval { require JSON::XS; JSON::XS->new->utf8 }
1023 || do { require JSON; JSON->new->utf8 }
1024}
1025
842register_write_type json => sub { 1026register_write_type json => sub {
843 my ($self, $ref) = @_; 1027 my ($self, $ref) = @_;
844 1028
845 require JSON; 1029 my $json = $self->{json} ||= json_coder;
846 1030
847 $self->{json} ? $self->{json}->encode ($ref) 1031 $json->encode ($ref)
848 : JSON::encode_json ($ref)
849}; 1032};
850 1033
851=item storable => $reference 1034=item storable => $reference
852 1035
853Freezes the given reference using L<Storable> and writes it to the 1036Freezes the given reference using L<Storable> and writes it to the
… …
879the peer. 1062the peer.
880 1063
881You can rely on the normal read queue and C<on_eof> handling 1064You can rely on the normal read queue and C<on_eof> handling
882afterwards. This is the cleanest way to close a connection. 1065afterwards. This is the cleanest way to close a connection.
883 1066
1067This method may invoke callbacks (and therefore the handle might be
1068destroyed after it returns).
1069
884=cut 1070=cut
885 1071
886sub push_shutdown { 1072sub push_shutdown {
887 my ($self) = @_; 1073 my ($self) = @_;
888 1074
889 delete $self->{low_water_mark}; 1075 delete $self->{low_water_mark};
890 $self->on_drain (sub { shutdown $_[0]{fh}, 1 }); 1076 $self->on_drain (sub { shutdown $_[0]{fh}, 1 });
891} 1077}
892 1078
893=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args) 1079=item custom write types - Package::anyevent_write_type $handle, @args
894 1080
895This function (not method) lets you add your own types to C<push_write>. 1081Instead of one of the predefined types, you can also specify the name of
1082a package. AnyEvent will try to load the package and then expects to find
1083a function named C<anyevent_write_type> inside. If it isn't found, it
1084progressively tries to load the parent package until it either finds the
1085function (good) or runs out of packages (bad).
1086
896Whenever the given C<type> is used, C<push_write> will invoke the code 1087Whenever the given C<type> is used, C<push_write> will the function with
897reference with the handle object and the remaining arguments. 1088the handle object and the remaining arguments.
898 1089
899The code reference is supposed to return a single octet string that will 1090The function is supposed to return a single octet string that will be
900be appended to the write buffer. 1091appended to the write buffer, so you cna mentally treat this function as a
1092"arguments to on-the-wire-format" converter.
901 1093
902Note that this is a function, and all types registered this way will be 1094Example: implement a custom write type C<join> that joins the remaining
903global, so try to use unique names. 1095arguments using the first one.
1096
1097 $handle->push_write (My::Type => " ", 1,2,3);
1098
1099 # uses the following package, which can be defined in the "My::Type" or in
1100 # the "My" modules to be auto-loaded, or just about anywhere when the
1101 # My::Type::anyevent_write_type is defined before invoking it.
1102
1103 package My::Type;
1104
1105 sub anyevent_write_type {
1106 my ($handle, $delim, @args) = @_;
1107
1108 join $delim, @args
1109 }
904 1110
905=cut 1111=cut
906 1112
907############################################################################# 1113#############################################################################
908 1114
… …
917ways, the "simple" way, using only C<on_read> and the "complex" way, using 1123ways, the "simple" way, using only C<on_read> and the "complex" way, using
918a queue. 1124a queue.
919 1125
920In the simple case, you just install an C<on_read> callback and whenever 1126In the simple case, you just install an C<on_read> callback and whenever
921new data arrives, it will be called. You can then remove some data (if 1127new data arrives, it will be called. You can then remove some data (if
922enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna 1128enough is there) from the read buffer (C<< $handle->rbuf >>). Or you can
923leave the data there if you want to accumulate more (e.g. when only a 1129leave the data there if you want to accumulate more (e.g. when only a
924partial message has been received so far). 1130partial message has been received so far), or change the read queue with
1131e.g. C<push_read>.
925 1132
926In the more complex case, you want to queue multiple callbacks. In this 1133In the more complex case, you want to queue multiple callbacks. In this
927case, AnyEvent::Handle will call the first queued callback each time new 1134case, AnyEvent::Handle will call the first queued callback each time new
928data arrives (also the first time it is queued) and removes it when it has 1135data arrives (also the first time it is queued) and remove it when it has
929done its job (see C<push_read>, below). 1136done its job (see C<push_read>, below).
930 1137
931This way you can, for example, push three line-reads, followed by reading 1138This way you can, for example, push three line-reads, followed by reading
932a chunk of data, and AnyEvent::Handle will execute them in order. 1139a chunk of data, and AnyEvent::Handle will execute them in order.
933 1140
… …
994 1201
995 # avoid recursion 1202 # avoid recursion
996 return if $self->{_skip_drain_rbuf}; 1203 return if $self->{_skip_drain_rbuf};
997 local $self->{_skip_drain_rbuf} = 1; 1204 local $self->{_skip_drain_rbuf} = 1;
998 1205
999 if (
1000 defined $self->{rbuf_max}
1001 && $self->{rbuf_max} < length $self->{rbuf}
1002 ) {
1003 $self->_error (Errno::ENOSPC, 1), return;
1004 }
1005
1006 while () { 1206 while () {
1007 # we need to use a separate tls read buffer, as we must not receive data while 1207 # we need to use a separate tls read buffer, as we must not receive data while
1008 # we are draining the buffer, and this can only happen with TLS. 1208 # we are draining the buffer, and this can only happen with TLS.
1009 $self->{rbuf} .= delete $self->{_tls_rbuf} 1209 $self->{rbuf} .= delete $self->{_tls_rbuf}
1010 if exists $self->{_tls_rbuf}; 1210 if exists $self->{_tls_rbuf};
… …
1051 : $self->_error (0, 1, "Unexpected end-of-file"); 1251 : $self->_error (0, 1, "Unexpected end-of-file");
1052 1252
1053 return; 1253 return;
1054 } 1254 }
1055 1255
1256 if (
1257 defined $self->{rbuf_max}
1258 && $self->{rbuf_max} < length $self->{rbuf}
1259 ) {
1260 $self->_error (Errno::ENOSPC, 1), return;
1261 }
1262
1056 # may need to restart read watcher 1263 # may need to restart read watcher
1057 unless ($self->{_rw}) { 1264 unless ($self->{_rw}) {
1058 $self->start_read 1265 $self->start_read
1059 if $self->{on_read} || @{ $self->{_queue} }; 1266 if $self->{on_read} || @{ $self->{_queue} };
1060 } 1267 }
… …
1064 1271
1065This replaces the currently set C<on_read> callback, or clears it (when 1272This replaces the currently set C<on_read> callback, or clears it (when
1066the new callback is C<undef>). See the description of C<on_read> in the 1273the new callback is C<undef>). See the description of C<on_read> in the
1067constructor. 1274constructor.
1068 1275
1276This method may invoke callbacks (and therefore the handle might be
1277destroyed after it returns).
1278
1069=cut 1279=cut
1070 1280
1071sub on_read { 1281sub on_read {
1072 my ($self, $cb) = @_; 1282 my ($self, $cb) = @_;
1073 1283
… …
1075 $self->_drain_rbuf if $cb; 1285 $self->_drain_rbuf if $cb;
1076} 1286}
1077 1287
1078=item $handle->rbuf 1288=item $handle->rbuf
1079 1289
1080Returns the read buffer (as a modifiable lvalue). 1290Returns the read buffer (as a modifiable lvalue). You can also access the
1291read buffer directly as the C<< ->{rbuf} >> member, if you want (this is
1292much faster, and no less clean).
1081 1293
1082You can access the read buffer directly as the C<< ->{rbuf} >> 1294The only operation allowed on the read buffer (apart from looking at it)
1083member, if you want. However, the only operation allowed on the 1295is removing data from its beginning. Otherwise modifying or appending to
1084read buffer (apart from looking at it) is removing data from its 1296it is not allowed and will lead to hard-to-track-down bugs.
1085beginning. Otherwise modifying or appending to it is not allowed and will
1086lead to hard-to-track-down bugs.
1087 1297
1088NOTE: The read buffer should only be used or modified if the C<on_read>, 1298NOTE: The read buffer should only be used or modified in the C<on_read>
1089C<push_read> or C<unshift_read> methods are used. The other read methods 1299callback or when C<push_read> or C<unshift_read> are used with a single
1090automatically manage the read buffer. 1300callback (i.e. untyped). Typed C<push_read> and C<unshift_read> methods
1301will manage the read buffer on their own.
1091 1302
1092=cut 1303=cut
1093 1304
1094sub rbuf : lvalue { 1305sub rbuf : lvalue {
1095 $_[0]{rbuf} 1306 $_[0]{rbuf}
… …
1112 1323
1113If enough data was available, then the callback must remove all data it is 1324If enough data was available, then the callback must remove all data it is
1114interested in (which can be none at all) and return a true value. After returning 1325interested in (which can be none at all) and return a true value. After returning
1115true, it will be removed from the queue. 1326true, it will be removed from the queue.
1116 1327
1328These methods may invoke callbacks (and therefore the handle might be
1329destroyed after it returns).
1330
1117=cut 1331=cut
1118 1332
1119our %RH; 1333our %RH;
1120 1334
1121sub register_read_type($$) { 1335sub register_read_type($$) {
… …
1127 my $cb = pop; 1341 my $cb = pop;
1128 1342
1129 if (@_) { 1343 if (@_) {
1130 my $type = shift; 1344 my $type = shift;
1131 1345
1346 $cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type"
1132 $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read") 1347 or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_read")
1133 ->($self, $cb, @_); 1348 ->($self, $cb, @_);
1134 } 1349 }
1135 1350
1136 push @{ $self->{_queue} }, $cb; 1351 push @{ $self->{_queue} }, $cb;
1137 $self->_drain_rbuf; 1352 $self->_drain_rbuf;
… …
1142 my $cb = pop; 1357 my $cb = pop;
1143 1358
1144 if (@_) { 1359 if (@_) {
1145 my $type = shift; 1360 my $type = shift;
1146 1361
1362 $cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type"
1147 $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read") 1363 or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::unshift_read")
1148 ->($self, $cb, @_); 1364 ->($self, $cb, @_);
1149 } 1365 }
1150
1151 1366
1152 unshift @{ $self->{_queue} }, $cb; 1367 unshift @{ $self->{_queue} }, $cb;
1153 $self->_drain_rbuf; 1368 $self->_drain_rbuf;
1154} 1369}
1155 1370
… …
1157 1372
1158=item $handle->unshift_read (type => @args, $cb) 1373=item $handle->unshift_read (type => @args, $cb)
1159 1374
1160Instead of providing a callback that parses the data itself you can chose 1375Instead of providing a callback that parses the data itself you can chose
1161between a number of predefined parsing formats, for chunks of data, lines 1376between a number of predefined parsing formats, for chunks of data, lines
1162etc. 1377etc. You can also specify the (fully qualified) name of a package, in
1378which case AnyEvent tries to load the package and then expects to find the
1379C<anyevent_read_type> function inside (see "custom read types", below).
1163 1380
1164Predefined types are (if you have ideas for additional types, feel free to 1381Predefined types are (if you have ideas for additional types, feel free to
1165drop by and tell us): 1382drop by and tell us):
1166 1383
1167=over 4 1384=over 4
… …
1259the receive buffer when neither C<$accept> nor C<$reject> match, 1476the receive buffer when neither C<$accept> nor C<$reject> match,
1260and everything preceding and including the match will be accepted 1477and everything preceding and including the match will be accepted
1261unconditionally. This is useful to skip large amounts of data that you 1478unconditionally. This is useful to skip large amounts of data that you
1262know cannot be matched, so that the C<$accept> or C<$reject> regex do not 1479know cannot be matched, so that the C<$accept> or C<$reject> regex do not
1263have to start matching from the beginning. This is purely an optimisation 1480have to start matching from the beginning. This is purely an optimisation
1264and is usually worth only when you expect more than a few kilobytes. 1481and is usually worth it only when you expect more than a few kilobytes.
1265 1482
1266Example: expect a http header, which ends at C<\015\012\015\012>. Since we 1483Example: expect a http header, which ends at C<\015\012\015\012>. Since we
1267expect the header to be very large (it isn't in practise, but...), we use 1484expect the header to be very large (it isn't in practice, but...), we use
1268a skip regex to skip initial portions. The skip regex is tricky in that 1485a skip regex to skip initial portions. The skip regex is tricky in that
1269it only accepts something not ending in either \015 or \012, as these are 1486it only accepts something not ending in either \015 or \012, as these are
1270required for the accept regex. 1487required for the accept regex.
1271 1488
1272 $handle->push_read (regex => 1489 $handle->push_read (regex =>
… …
1407=cut 1624=cut
1408 1625
1409register_read_type json => sub { 1626register_read_type json => sub {
1410 my ($self, $cb) = @_; 1627 my ($self, $cb) = @_;
1411 1628
1412 my $json = $self->{json} ||= 1629 my $json = $self->{json} ||= json_coder;
1413 eval { require JSON::XS; JSON::XS->new->utf8 }
1414 || do { require JSON; JSON->new->utf8 };
1415 1630
1416 my $data; 1631 my $data;
1417 my $rbuf = \$self->{rbuf}; 1632 my $rbuf = \$self->{rbuf};
1418 1633
1419 sub { 1634 sub {
… …
1488 } 1703 }
1489}; 1704};
1490 1705
1491=back 1706=back
1492 1707
1493=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args) 1708=item custom read types - Package::anyevent_read_type $handle, $cb, @args
1494 1709
1495This function (not method) lets you add your own types to C<push_read>. 1710Instead of one of the predefined types, you can also specify the name
1711of a package. AnyEvent will try to load the package and then expects to
1712find a function named C<anyevent_read_type> inside. If it isn't found, it
1713progressively tries to load the parent package until it either finds the
1714function (good) or runs out of packages (bad).
1496 1715
1497Whenever the given C<type> is used, C<push_read> will invoke the code 1716Whenever this type is used, C<push_read> will invoke the function with the
1498reference with the handle object, the callback and the remaining 1717handle object, the original callback and the remaining arguments.
1499arguments.
1500 1718
1501The code reference is supposed to return a callback (usually a closure) 1719The function is supposed to return a callback (usually a closure) that
1502that works as a plain read callback (see C<< ->push_read ($cb) >>). 1720works as a plain read callback (see C<< ->push_read ($cb) >>), so you can
1721mentally treat the function as a "configurable read type to read callback"
1722converter.
1503 1723
1504It should invoke the passed callback when it is done reading (remember to 1724It should invoke the original callback when it is done reading (remember
1505pass C<$handle> as first argument as all other callbacks do that). 1725to pass C<$handle> as first argument as all other callbacks do that,
1726although there is no strict requirement on this).
1506 1727
1507Note that this is a function, and all types registered this way will be
1508global, so try to use unique names.
1509
1510For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>, 1728For examples, see the source of this module (F<perldoc -m
1511search for C<register_read_type>)). 1729AnyEvent::Handle>, search for C<register_read_type>)).
1512 1730
1513=item $handle->stop_read 1731=item $handle->stop_read
1514 1732
1515=item $handle->start_read 1733=item $handle->start_read
1516 1734
… …
1536} 1754}
1537 1755
1538sub start_read { 1756sub start_read {
1539 my ($self) = @_; 1757 my ($self) = @_;
1540 1758
1541 unless ($self->{_rw} || $self->{_eof}) { 1759 unless ($self->{_rw} || $self->{_eof} || !$self->{fh}) {
1542 Scalar::Util::weaken $self; 1760 Scalar::Util::weaken $self;
1543 1761
1544 $self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub { 1762 $self->{_rw} = AE::io $self->{fh}, 0, sub {
1545 my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf}); 1763 my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1546 my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf; 1764 my $len = sysread $self->{fh}, $$rbuf, $self->{read_size}, length $$rbuf;
1547 1765
1548 if ($len > 0) { 1766 if ($len > 0) {
1549 $self->{_activity} = AnyEvent->now; 1767 $self->{_activity} = $self->{_ractivity} = AE::now;
1550 1768
1551 if ($self->{tls}) { 1769 if ($self->{tls}) {
1552 Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf); 1770 Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1553 1771
1554 &_dotls ($self); 1772 &_dotls ($self);
1555 } else { 1773 } else {
1556 $self->_drain_rbuf; 1774 $self->_drain_rbuf;
1557 } 1775 }
1558 1776
1777 if ($len == $self->{read_size}) {
1778 $self->{read_size} *= 2;
1779 $self->{read_size} = $self->{max_read_size} || MAX_READ_SIZE
1780 if $self->{read_size} > ($self->{max_read_size} || MAX_READ_SIZE);
1781 }
1782
1559 } elsif (defined $len) { 1783 } elsif (defined $len) {
1560 delete $self->{_rw}; 1784 delete $self->{_rw};
1561 $self->{_eof} = 1; 1785 $self->{_eof} = 1;
1562 $self->_drain_rbuf; 1786 $self->_drain_rbuf;
1563 1787
1564 } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) { 1788 } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1565 return $self->_error ($!, 1); 1789 return $self->_error ($!, 1);
1566 } 1790 }
1567 }); 1791 };
1568 } 1792 }
1569} 1793}
1570 1794
1571our $ERROR_SYSCALL; 1795our $ERROR_SYSCALL;
1572our $ERROR_WANT_READ; 1796our $ERROR_WANT_READ;
… …
1639 && ($tmp != $ERROR_SYSCALL || $!); 1863 && ($tmp != $ERROR_SYSCALL || $!);
1640 1864
1641 while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) { 1865 while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1642 $self->{wbuf} .= $tmp; 1866 $self->{wbuf} .= $tmp;
1643 $self->_drain_wbuf; 1867 $self->_drain_wbuf;
1868 $self->{tls} or return; # tls session might have gone away in callback
1644 } 1869 }
1645 1870
1646 $self->{_on_starttls} 1871 $self->{_on_starttls}
1647 and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK () 1872 and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
1648 and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established"); 1873 and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");
… …
1670context in C<< $handle->{tls_ctx} >> after this call and can be used or 1895context in C<< $handle->{tls_ctx} >> after this call and can be used or
1671changed to your liking. Note that the handshake might have already started 1896changed to your liking. Note that the handshake might have already started
1672when this function returns. 1897when this function returns.
1673 1898
1674Due to bugs in OpenSSL, it might or might not be possible to do multiple 1899Due to bugs in OpenSSL, it might or might not be possible to do multiple
1675handshakes on the same stream. Best do not attempt to use the stream after 1900handshakes on the same stream. It is best to not attempt to use the
1676stopping TLS. 1901stream after stopping TLS.
1902
1903This method may invoke callbacks (and therefore the handle might be
1904destroyed after it returns).
1677 1905
1678=cut 1906=cut
1679 1907
1680our %TLS_CACHE; #TODO not yet documented, should we? 1908our %TLS_CACHE; #TODO not yet documented, should we?
1681 1909
… …
1693 require Net::SSLeay; 1921 require Net::SSLeay;
1694 1922
1695 $ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL (); 1923 $ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1696 $ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ (); 1924 $ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1697 1925
1698 $tls = $self->{tls}; 1926 $tls = delete $self->{tls};
1699 $ctx = $self->{tls_ctx}; 1927 $ctx = $self->{tls_ctx};
1700 1928
1701 local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session 1929 local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
1702 1930
1703 if ("HASH" eq ref $ctx) { 1931 if ("HASH" eq ref $ctx) {
… …
1732 Net::SSLeay::CTX_set_mode ($tls, 1|2); 1960 Net::SSLeay::CTX_set_mode ($tls, 1|2);
1733 1961
1734 $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); 1962 $self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1735 $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ()); 1963 $self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1736 1964
1965 Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf});
1966
1737 Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio}); 1967 Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
1738 1968
1739 $self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) } 1969 $self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1740 if $self->{on_starttls}; 1970 if $self->{on_starttls};
1741 1971
… …
1745 1975
1746=item $handle->stoptls 1976=item $handle->stoptls
1747 1977
1748Shuts down the SSL connection - this makes a proper EOF handshake by 1978Shuts down the SSL connection - this makes a proper EOF handshake by
1749sending a close notify to the other side, but since OpenSSL doesn't 1979sending a close notify to the other side, but since OpenSSL doesn't
1750support non-blocking shut downs, it is not guarenteed that you can re-use 1980support non-blocking shut downs, it is not guaranteed that you can re-use
1751the stream afterwards. 1981the stream afterwards.
1982
1983This method may invoke callbacks (and therefore the handle might be
1984destroyed after it returns).
1752 1985
1753=cut 1986=cut
1754 1987
1755sub stoptls { 1988sub stoptls {
1756 my ($self) = @_; 1989 my ($self) = @_;
1757 1990
1758 if ($self->{tls}) { 1991 if ($self->{tls} && $self->{fh}) {
1759 Net::SSLeay::shutdown ($self->{tls}); 1992 Net::SSLeay::shutdown ($self->{tls});
1760 1993
1761 &_dotls; 1994 &_dotls;
1762 1995
1763# # we don't give a shit. no, we do, but we can't. no...#d# 1996# # we don't give a shit. no, we do, but we can't. no...#d#
… …
1770 my ($self) = @_; 2003 my ($self) = @_;
1771 2004
1772 return unless $self->{tls}; 2005 return unless $self->{tls};
1773 2006
1774 $self->{tls_ctx}->_put_session (delete $self->{tls}) 2007 $self->{tls_ctx}->_put_session (delete $self->{tls})
1775 if ref $self->{tls}; 2008 if $self->{tls} > 0;
1776 2009
1777 delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)}; 2010 delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1778} 2011}
1779 2012
1780sub DESTROY { 2013sub DESTROY {
… …
1788 my $fh = delete $self->{fh}; 2021 my $fh = delete $self->{fh};
1789 my $wbuf = delete $self->{wbuf}; 2022 my $wbuf = delete $self->{wbuf};
1790 2023
1791 my @linger; 2024 my @linger;
1792 2025
1793 push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub { 2026 push @linger, AE::io $fh, 1, sub {
1794 my $len = syswrite $fh, $wbuf, length $wbuf; 2027 my $len = syswrite $fh, $wbuf, length $wbuf;
1795 2028
1796 if ($len > 0) { 2029 if ($len > 0) {
1797 substr $wbuf, 0, $len, ""; 2030 substr $wbuf, 0, $len, "";
1798 } else { 2031 } elsif (defined $len || ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK)) {
1799 @linger = (); # end 2032 @linger = (); # end
1800 } 2033 }
1801 }); 2034 };
1802 push @linger, AnyEvent->timer (after => $linger, cb => sub { 2035 push @linger, AE::timer $linger, 0, sub {
1803 @linger = (); 2036 @linger = ();
1804 }); 2037 };
1805 } 2038 }
1806} 2039}
1807 2040
1808=item $handle->destroy 2041=item $handle->destroy
1809 2042
… …
1840 2073
1841sub AnyEvent::Handle::destroyed::AUTOLOAD { 2074sub AnyEvent::Handle::destroyed::AUTOLOAD {
1842 #nop 2075 #nop
1843} 2076}
1844 2077
2078=item $handle->destroyed
2079
2080Returns false as long as the handle hasn't been destroyed by a call to C<<
2081->destroy >>, true otherwise.
2082
2083Can be useful to decide whether the handle is still valid after some
2084callback possibly destroyed the handle. For example, C<< ->push_write >>,
2085C<< ->starttls >> and other methods can call user callbacks, which in turn
2086can destroy the handle, so work can be avoided by checking sometimes:
2087
2088 $hdl->starttls ("accept");
2089 return if $hdl->destroyed;
2090 $hdl->push_write (...
2091
2092Note that the call to C<push_write> will silently be ignored if the handle
2093has been destroyed, so often you can just ignore the possibility of the
2094handle being destroyed.
2095
2096=cut
2097
2098sub destroyed { 0 }
2099sub AnyEvent::Handle::destroyed::destroyed { 1 }
2100
1845=item AnyEvent::Handle::TLS_CTX 2101=item AnyEvent::Handle::TLS_CTX
1846 2102
1847This function creates and returns the AnyEvent::TLS object used by default 2103This function creates and returns the AnyEvent::TLS object used by default
1848for TLS mode. 2104for TLS mode.
1849 2105
… …
1880 2136
1881=item I get different callback invocations in TLS mode/Why can't I pause 2137=item I get different callback invocations in TLS mode/Why can't I pause
1882reading? 2138reading?
1883 2139
1884Unlike, say, TCP, TLS connections do not consist of two independent 2140Unlike, say, TCP, TLS connections do not consist of two independent
1885communication channels, one for each direction. Or put differently. The 2141communication channels, one for each direction. Or put differently, the
1886read and write directions are not independent of each other: you cannot 2142read and write directions are not independent of each other: you cannot
1887write data unless you are also prepared to read, and vice versa. 2143write data unless you are also prepared to read, and vice versa.
1888 2144
1889This can mean than, in TLS mode, you might get C<on_error> or C<on_eof> 2145This means that, in TLS mode, you might get C<on_error> or C<on_eof>
1890callback invocations when you are not expecting any read data - the reason 2146callback invocations when you are not expecting any read data - the reason
1891is that AnyEvent::Handle always reads in TLS mode. 2147is that AnyEvent::Handle always reads in TLS mode.
1892 2148
1893During the connection, you have to make sure that you always have a 2149During the connection, you have to make sure that you always have a
1894non-empty read-queue, or an C<on_read> watcher. At the end of the 2150non-empty read-queue, or an C<on_read> watcher. At the end of the
… …
1908 my $data = delete $_[0]{rbuf}; 2164 my $data = delete $_[0]{rbuf};
1909 }); 2165 });
1910 2166
1911The reason to use C<on_error> is that TCP connections, due to latencies 2167The reason to use C<on_error> is that TCP connections, due to latencies
1912and packets loss, might get closed quite violently with an error, when in 2168and packets loss, might get closed quite violently with an error, when in
1913fact, all data has been received. 2169fact all data has been received.
1914 2170
1915It is usually better to use acknowledgements when transferring data, 2171It is usually better to use acknowledgements when transferring data,
1916to make sure the other side hasn't just died and you got the data 2172to make sure the other side hasn't just died and you got the data
1917intact. This is also one reason why so many internet protocols have an 2173intact. This is also one reason why so many internet protocols have an
1918explicit QUIT command. 2174explicit QUIT command.
… …
1935consider using C<< ->push_shutdown >> instead. 2191consider using C<< ->push_shutdown >> instead.
1936 2192
1937=item I want to contact a TLS/SSL server, I don't care about security. 2193=item I want to contact a TLS/SSL server, I don't care about security.
1938 2194
1939If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS, 2195If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS,
1940simply connect to it and then create the AnyEvent::Handle with the C<tls> 2196connect to it and then create the AnyEvent::Handle with the C<tls>
1941parameter: 2197parameter:
1942 2198
1943 tcp_connect $host, $port, sub { 2199 tcp_connect $host, $port, sub {
1944 my ($fh) = @_; 2200 my ($fh) = @_;
1945 2201
… …
2045 2301
2046=item * all members not documented here and not prefixed with an underscore 2302=item * all members not documented here and not prefixed with an underscore
2047are free to use in subclasses. 2303are free to use in subclasses.
2048 2304
2049Of course, new versions of AnyEvent::Handle may introduce more "public" 2305Of course, new versions of AnyEvent::Handle may introduce more "public"
2050member variables, but thats just life, at least it is documented. 2306member variables, but that's just life. At least it is documented.
2051 2307
2052=back 2308=back
2053 2309
2054=head1 AUTHOR 2310=head1 AUTHOR
2055 2311

Diff Legend

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