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.174 by root, Sat Aug 8 20:52:06 2009 UTC vs.
Revision 1.208 by root, Sun Dec 5 11:41:45 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
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 unsatisfiable) 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
356missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>. 428parameter is missing (or C<undef>), then AnyEvent::Handle will use
429C<AnyEvent::Handle::TLS_CTX>.
357 430
358Instead of an object, you can also specify a hash reference with C<< key 431Instead of an object, you can also specify a hash reference with C<< key
359=> value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a 432=> value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a
360new TLS context object. 433new TLS context object.
361 434
… …
370 443
371TLS handshake failures will not cause C<on_error> to be invoked when this 444TLS 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>. 445callback is in effect, instead, the error message will be passed to C<on_starttls>.
373 446
374Without this callback, handshake failures lead to C<on_error> being 447Without this callback, handshake failures lead to C<on_error> being
375called, as normal. 448called as usual.
376 449
377Note that you cannot call C<starttls> right again in this callback. If you 450Note 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 451need to do that, start an zero-second timer instead whose callback can
379then call C<< ->starttls >> again. 452then call C<< ->starttls >> again.
380 453
381=item on_stoptls => $cb->($handle) 454=item on_stoptls => $cb->($handle)
382 455
… …
430 $self->{connect}[0], 503 $self->{connect}[0],
431 $self->{connect}[1], 504 $self->{connect}[1],
432 sub { 505 sub {
433 my ($fh, $host, $port, $retry) = @_; 506 my ($fh, $host, $port, $retry) = @_;
434 507
508 delete $self->{_connect}; # no longer needed
509
435 if ($fh) { 510 if ($fh) {
436 $self->{fh} = $fh; 511 $self->{fh} = $fh;
437 512
438 delete $self->{_skip_drain_rbuf}; 513 delete $self->{_skip_drain_rbuf};
439 $self->_start; 514 $self->_start;
440 515
441 $self->{on_connect} 516 $self->{on_connect}
442 and $self->{on_connect}($self, $host, $port, sub { 517 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)}; 518 delete @$self{qw(fh _tw _rtw _wtw _ww _rw _eof _queue rbuf _wbuf tls _tls_rbuf _tls_wbuf)};
444 $self->{_skip_drain_rbuf} = 1; 519 $self->{_skip_drain_rbuf} = 1;
445 &$retry; 520 &$retry;
446 }); 521 });
447 522
448 } else { 523 } else {
… …
472} 547}
473 548
474sub _start { 549sub _start {
475 my ($self) = @_; 550 my ($self) = @_;
476 551
552 # too many clueless people try to use udp and similar sockets
553 # with AnyEvent::Handle, do them a favour.
554 my $type = getsockopt $self->{fh}, Socket::SOL_SOCKET (), Socket::SO_TYPE ();
555 Carp::croak "AnyEvent::Handle: only stream sockets supported, anything else will NOT work!"
556 if Socket::SOCK_STREAM () != (unpack "I", $type) && defined $type;
557
477 AnyEvent::Util::fh_nonblocking $self->{fh}, 1; 558 AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
478 559
560 $self->{_activity} =
561 $self->{_ractivity} =
479 $self->{_activity} = AnyEvent->now; 562 $self->{_wactivity} = AE::now;
480 $self->_timeout;
481 563
564 $self->{read_size} ||= 2048;
565 $self->{max_read_size} = $self->{read_size}
566 if $self->{read_size} > ($self->{max_read_size} || MAX_READ_SIZE);
567
568 $self->timeout (delete $self->{timeout} ) if $self->{timeout};
569 $self->rtimeout (delete $self->{rtimeout} ) if $self->{rtimeout};
570 $self->wtimeout (delete $self->{wtimeout} ) if $self->{wtimeout};
571
482 $self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay}; 572 $self->no_delay (delete $self->{no_delay} ) if exists $self->{no_delay} && $self->{no_delay};
573 $self->keepalive (delete $self->{keepalive}) if exists $self->{keepalive} && $self->{keepalive};
483 574
575 $self->oobinline (exists $self->{oobinline} ? delete $self->{oobinline} : 1);
576
484 $self->starttls (delete $self->{tls}, delete $self->{tls_ctx}) 577 $self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
485 if $self->{tls}; 578 if $self->{tls};
486 579
487 $self->on_drain (delete $self->{on_drain}) if $self->{on_drain}; 580 $self->on_drain (delete $self->{on_drain} ) if $self->{on_drain};
488 581
489 $self->start_read 582 $self->start_read
490 if $self->{on_read} || @{ $self->{_queue} }; 583 if $self->{on_read} || @{ $self->{_queue} };
491 584
492 $self->_drain_wbuf; 585 $self->_drain_wbuf;
493} 586}
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 587
504sub _error { 588sub _error {
505 my ($self, $errno, $fatal, $message) = @_; 589 my ($self, $errno, $fatal, $message) = @_;
506 590
507 $! = $errno; 591 $! = $errno;
508 $message ||= "$!"; 592 $message ||= "$!";
509 593
510 if ($self->{on_error}) { 594 if ($self->{on_error}) {
511 $self->{on_error}($self, $fatal, $message); 595 $self->{on_error}($self, $fatal, $message);
512 $self->destroy if $fatal; 596 $self->destroy if $fatal;
513 } elsif ($self->{fh}) { 597 } elsif ($self->{fh} || $self->{connect}) {
514 $self->destroy; 598 $self->destroy;
515 Carp::croak "AnyEvent::Handle uncaught error: $message"; 599 Carp::croak "AnyEvent::Handle uncaught error: $message";
516 } 600 }
517} 601}
518 602
… …
544 $_[0]{on_eof} = $_[1]; 628 $_[0]{on_eof} = $_[1];
545} 629}
546 630
547=item $handle->on_timeout ($cb) 631=item $handle->on_timeout ($cb)
548 632
549Replace the current C<on_timeout> callback, or disables the callback (but 633=item $handle->on_rtimeout ($cb)
550not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
551argument and method.
552 634
553=cut 635=item $handle->on_wtimeout ($cb)
554 636
555sub on_timeout { 637Replace the current C<on_timeout>, C<on_rtimeout> or C<on_wtimeout>
556 $_[0]{on_timeout} = $_[1]; 638callback, or disables the callback (but not the timeout) if C<$cb> =
557} 639C<undef>. See the C<timeout> constructor argument and method.
640
641=cut
642
643# see below
558 644
559=item $handle->autocork ($boolean) 645=item $handle->autocork ($boolean)
560 646
561Enables or disables the current autocork behaviour (see C<autocork> 647Enables or disables the current autocork behaviour (see C<autocork>
562constructor argument). Changes will only take effect on the next write. 648constructor argument). Changes will only take effect on the next write.
… …
575=cut 661=cut
576 662
577sub no_delay { 663sub no_delay {
578 $_[0]{no_delay} = $_[1]; 664 $_[0]{no_delay} = $_[1];
579 665
666 setsockopt $_[0]{fh}, Socket::IPPROTO_TCP (), Socket::TCP_NODELAY (), int $_[1]
667 if $_[0]{fh};
668}
669
670=item $handle->keepalive ($boolean)
671
672Enables or disables the C<keepalive> setting (see constructor argument of
673the same name for details).
674
675=cut
676
677sub keepalive {
678 $_[0]{keepalive} = $_[1];
679
580 eval { 680 eval {
581 local $SIG{__DIE__}; 681 local $SIG{__DIE__};
582 setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1] 682 setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
583 if $_[0]{fh}; 683 if $_[0]{fh};
584 }; 684 };
585} 685}
586 686
687=item $handle->oobinline ($boolean)
688
689Enables or disables the C<oobinline> setting (see constructor argument of
690the same name for details).
691
692=cut
693
694sub oobinline {
695 $_[0]{oobinline} = $_[1];
696
697 eval {
698 local $SIG{__DIE__};
699 setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_OOBINLINE (), int $_[1]
700 if $_[0]{fh};
701 };
702}
703
704=item $handle->keepalive ($boolean)
705
706Enables or disables the C<keepalive> setting (see constructor argument of
707the same name for details).
708
709=cut
710
711sub keepalive {
712 $_[0]{keepalive} = $_[1];
713
714 eval {
715 local $SIG{__DIE__};
716 setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
717 if $_[0]{fh};
718 };
719}
720
587=item $handle->on_starttls ($cb) 721=item $handle->on_starttls ($cb)
588 722
589Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument). 723Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument).
590 724
591=cut 725=cut
… …
598 732
599Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument). 733Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).
600 734
601=cut 735=cut
602 736
603sub on_starttls { 737sub on_stoptls {
604 $_[0]{on_stoptls} = $_[1]; 738 $_[0]{on_stoptls} = $_[1];
605} 739}
606 740
607=item $handle->rbuf_max ($max_octets) 741=item $handle->rbuf_max ($max_octets)
608 742
… …
616 750
617############################################################################# 751#############################################################################
618 752
619=item $handle->timeout ($seconds) 753=item $handle->timeout ($seconds)
620 754
755=item $handle->rtimeout ($seconds)
756
757=item $handle->wtimeout ($seconds)
758
621Configures (or disables) the inactivity timeout. 759Configures (or disables) the inactivity timeout.
622 760
623=cut 761=item $handle->timeout_reset
624 762
625sub timeout { 763=item $handle->rtimeout_reset
764
765=item $handle->wtimeout_reset
766
767Reset the activity timeout, as if data was received or sent.
768
769These methods are cheap to call.
770
771=cut
772
773for my $dir ("", "r", "w") {
774 my $timeout = "${dir}timeout";
775 my $tw = "_${dir}tw";
776 my $on_timeout = "on_${dir}timeout";
777 my $activity = "_${dir}activity";
778 my $cb;
779
780 *$on_timeout = sub {
781 $_[0]{$on_timeout} = $_[1];
782 };
783
784 *$timeout = sub {
626 my ($self, $timeout) = @_; 785 my ($self, $new_value) = @_;
627 786
787 $new_value >= 0
788 or Carp::croak "AnyEvent::Handle->$timeout called with negative timeout ($new_value), caught";
789
628 $self->{timeout} = $timeout; 790 $self->{$timeout} = $new_value;
629 delete $self->{_tw}; 791 delete $self->{$tw}; &$cb;
630 $self->_timeout; 792 };
631}
632 793
794 *{"${dir}timeout_reset"} = sub {
795 $_[0]{$activity} = AE::now;
796 };
797
798 # main workhorse:
633# reset the timeout watcher, as neccessary 799 # reset the timeout watcher, as neccessary
634# also check for time-outs 800 # also check for time-outs
635sub _timeout { 801 $cb = sub {
636 my ($self) = @_; 802 my ($self) = @_;
637 803
638 if ($self->{timeout} && $self->{fh}) { 804 if ($self->{$timeout} && $self->{fh}) {
639 my $NOW = AnyEvent->now; 805 my $NOW = AE::now;
640 806
641 # when would the timeout trigger? 807 # when would the timeout trigger?
642 my $after = $self->{_activity} + $self->{timeout} - $NOW; 808 my $after = $self->{$activity} + $self->{$timeout} - $NOW;
643 809
644 # now or in the past already? 810 # now or in the past already?
645 if ($after <= 0) { 811 if ($after <= 0) {
646 $self->{_activity} = $NOW; 812 $self->{$activity} = $NOW;
647 813
648 if ($self->{on_timeout}) { 814 if ($self->{$on_timeout}) {
649 $self->{on_timeout}($self); 815 $self->{$on_timeout}($self);
650 } else { 816 } else {
651 $self->_error (Errno::ETIMEDOUT); 817 $self->_error (Errno::ETIMEDOUT);
818 }
819
820 # callback could have changed timeout value, optimise
821 return unless $self->{$timeout};
822
823 # calculate new after
824 $after = $self->{$timeout};
652 } 825 }
653 826
654 # callback could have changed timeout value, optimise 827 Scalar::Util::weaken $self;
655 return unless $self->{timeout}; 828 return unless $self; # ->error could have destroyed $self
656 829
657 # calculate new after 830 $self->{$tw} ||= AE::timer $after, 0, sub {
658 $after = $self->{timeout}; 831 delete $self->{$tw};
832 $cb->($self);
833 };
834 } else {
835 delete $self->{$tw};
659 } 836 }
660
661 Scalar::Util::weaken $self;
662 return unless $self; # ->error could have destroyed $self
663
664 $self->{_tw} ||= AnyEvent->timer (after => $after, cb => sub {
665 delete $self->{_tw};
666 $self->_timeout;
667 });
668 } else {
669 delete $self->{_tw};
670 } 837 }
671} 838}
672 839
673############################################################################# 840#############################################################################
674 841
… …
689 856
690=item $handle->on_drain ($cb) 857=item $handle->on_drain ($cb)
691 858
692Sets the C<on_drain> callback or clears it (see the description of 859Sets the C<on_drain> callback or clears it (see the description of
693C<on_drain> in the constructor). 860C<on_drain> in the constructor).
861
862This method may invoke callbacks (and therefore the handle might be
863destroyed after it returns).
694 864
695=cut 865=cut
696 866
697sub on_drain { 867sub on_drain {
698 my ($self, $cb) = @_; 868 my ($self, $cb) = @_;
… …
707 877
708Queues the given scalar to be written. You can push as much data as you 878Queues 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> 879want (only limited by the available memory), as C<AnyEvent::Handle>
710buffers it independently of the kernel. 880buffers it independently of the kernel.
711 881
882This method may invoke callbacks (and therefore the handle might be
883destroyed after it returns).
884
712=cut 885=cut
713 886
714sub _drain_wbuf { 887sub _drain_wbuf {
715 my ($self) = @_; 888 my ($self) = @_;
716 889
… …
722 my $len = syswrite $self->{fh}, $self->{wbuf}; 895 my $len = syswrite $self->{fh}, $self->{wbuf};
723 896
724 if (defined $len) { 897 if (defined $len) {
725 substr $self->{wbuf}, 0, $len, ""; 898 substr $self->{wbuf}, 0, $len, "";
726 899
727 $self->{_activity} = AnyEvent->now; 900 $self->{_activity} = $self->{_wactivity} = AE::now;
728 901
729 $self->{on_drain}($self) 902 $self->{on_drain}($self)
730 if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf}) 903 if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
731 && $self->{on_drain}; 904 && $self->{on_drain};
732 905
… …
738 911
739 # try to write data immediately 912 # try to write data immediately
740 $cb->() unless $self->{autocork}; 913 $cb->() unless $self->{autocork};
741 914
742 # if still data left in wbuf, we need to poll 915 # if still data left in wbuf, we need to poll
743 $self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb) 916 $self->{_ww} = AE::io $self->{fh}, 1, $cb
744 if length $self->{wbuf}; 917 if length $self->{wbuf};
745 }; 918 };
746} 919}
747 920
748our %WH; 921our %WH;
749 922
923# deprecated
750sub register_write_type($$) { 924sub register_write_type($$) {
751 $WH{$_[0]} = $_[1]; 925 $WH{$_[0]} = $_[1];
752} 926}
753 927
754sub push_write { 928sub push_write {
755 my $self = shift; 929 my $self = shift;
756 930
757 if (@_ > 1) { 931 if (@_ > 1) {
758 my $type = shift; 932 my $type = shift;
759 933
934 @_ = ($WH{$type} ||= _load_func "$type\::anyevent_write_type"
760 @_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write") 935 or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_write")
761 ->($self, @_); 936 ->($self, @_);
762 } 937 }
763 938
939 # we downgrade here to avoid hard-to-track-down bugs,
940 # and diagnose the problem earlier and better.
941
764 if ($self->{tls}) { 942 if ($self->{tls}) {
765 $self->{_tls_wbuf} .= $_[0]; 943 utf8::downgrade $self->{_tls_wbuf} .= $_[0];
766 &_dotls ($self) if $self->{fh}; 944 &_dotls ($self) if $self->{fh};
767 } else { 945 } else {
768 $self->{wbuf} .= $_[0]; 946 utf8::downgrade $self->{wbuf} .= $_[0];
769 $self->_drain_wbuf if $self->{fh}; 947 $self->_drain_wbuf if $self->{fh};
770 } 948 }
771} 949}
772 950
773=item $handle->push_write (type => @args) 951=item $handle->push_write (type => @args)
774 952
775Instead of formatting your data yourself, you can also let this module do 953Instead of formatting your data yourself, you can also let this module
776the job by specifying a type and type-specific arguments. 954do the job by specifying a type and type-specific arguments. You
955can also specify the (fully qualified) name of a package, in which
956case AnyEvent tries to load the package and then expects to find the
957C<anyevent_write_type> function inside (see "custom write types", below).
777 958
778Predefined types are (if you have ideas for additional types, feel free to 959Predefined types are (if you have ideas for additional types, feel free to
779drop by and tell us): 960drop by and tell us):
780 961
781=over 4 962=over 4
… …
838Other languages could read single lines terminated by a newline and pass 1019Other languages could read single lines terminated by a newline and pass
839this line into their JSON decoder of choice. 1020this line into their JSON decoder of choice.
840 1021
841=cut 1022=cut
842 1023
1024sub json_coder() {
1025 eval { require JSON::XS; JSON::XS->new->utf8 }
1026 || do { require JSON; JSON->new->utf8 }
1027}
1028
843register_write_type json => sub { 1029register_write_type json => sub {
844 my ($self, $ref) = @_; 1030 my ($self, $ref) = @_;
845 1031
846 require JSON; 1032 my $json = $self->{json} ||= json_coder;
847 1033
848 $self->{json} ? $self->{json}->encode ($ref) 1034 $json->encode ($ref)
849 : JSON::encode_json ($ref)
850}; 1035};
851 1036
852=item storable => $reference 1037=item storable => $reference
853 1038
854Freezes the given reference using L<Storable> and writes it to the 1039Freezes the given reference using L<Storable> and writes it to the
… …
880the peer. 1065the peer.
881 1066
882You can rely on the normal read queue and C<on_eof> handling 1067You can rely on the normal read queue and C<on_eof> handling
883afterwards. This is the cleanest way to close a connection. 1068afterwards. This is the cleanest way to close a connection.
884 1069
1070This method may invoke callbacks (and therefore the handle might be
1071destroyed after it returns).
1072
885=cut 1073=cut
886 1074
887sub push_shutdown { 1075sub push_shutdown {
888 my ($self) = @_; 1076 my ($self) = @_;
889 1077
890 delete $self->{low_water_mark}; 1078 delete $self->{low_water_mark};
891 $self->on_drain (sub { shutdown $_[0]{fh}, 1 }); 1079 $self->on_drain (sub { shutdown $_[0]{fh}, 1 });
892} 1080}
893 1081
894=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args) 1082=item custom write types - Package::anyevent_write_type $handle, @args
895 1083
896This function (not method) lets you add your own types to C<push_write>. 1084Instead of one of the predefined types, you can also specify the name of
1085a package. AnyEvent will try to load the package and then expects to find
1086a function named C<anyevent_write_type> inside. If it isn't found, it
1087progressively tries to load the parent package until it either finds the
1088function (good) or runs out of packages (bad).
1089
897Whenever the given C<type> is used, C<push_write> will invoke the code 1090Whenever the given C<type> is used, C<push_write> will the function with
898reference with the handle object and the remaining arguments. 1091the handle object and the remaining arguments.
899 1092
900The code reference is supposed to return a single octet string that will 1093The function is supposed to return a single octet string that will be
901be appended to the write buffer. 1094appended to the write buffer, so you cna mentally treat this function as a
1095"arguments to on-the-wire-format" converter.
902 1096
903Note that this is a function, and all types registered this way will be 1097Example: implement a custom write type C<join> that joins the remaining
904global, so try to use unique names. 1098arguments using the first one.
1099
1100 $handle->push_write (My::Type => " ", 1,2,3);
1101
1102 # uses the following package, which can be defined in the "My::Type" or in
1103 # the "My" modules to be auto-loaded, or just about anywhere when the
1104 # My::Type::anyevent_write_type is defined before invoking it.
1105
1106 package My::Type;
1107
1108 sub anyevent_write_type {
1109 my ($handle, $delim, @args) = @_;
1110
1111 join $delim, @args
1112 }
905 1113
906=cut 1114=cut
907 1115
908############################################################################# 1116#############################################################################
909 1117
… …
918ways, the "simple" way, using only C<on_read> and the "complex" way, using 1126ways, the "simple" way, using only C<on_read> and the "complex" way, using
919a queue. 1127a queue.
920 1128
921In the simple case, you just install an C<on_read> callback and whenever 1129In 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 1130new 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 1131enough 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 1132leave the data there if you want to accumulate more (e.g. when only a
925partial message has been received so far). 1133partial message has been received so far), or change the read queue with
1134e.g. C<push_read>.
926 1135
927In the more complex case, you want to queue multiple callbacks. In this 1136In the more complex case, you want to queue multiple callbacks. In this
928case, AnyEvent::Handle will call the first queued callback each time new 1137case, 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 1138data arrives (also the first time it is queued) and remove it when it has
930done its job (see C<push_read>, below). 1139done its job (see C<push_read>, below).
931 1140
932This way you can, for example, push three line-reads, followed by reading 1141This way you can, for example, push three line-reads, followed by reading
933a chunk of data, and AnyEvent::Handle will execute them in order. 1142a chunk of data, and AnyEvent::Handle will execute them in order.
934 1143
… …
1065 1274
1066This replaces the currently set C<on_read> callback, or clears it (when 1275This 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 1276the new callback is C<undef>). See the description of C<on_read> in the
1068constructor. 1277constructor.
1069 1278
1279This method may invoke callbacks (and therefore the handle might be
1280destroyed after it returns).
1281
1070=cut 1282=cut
1071 1283
1072sub on_read { 1284sub on_read {
1073 my ($self, $cb) = @_; 1285 my ($self, $cb) = @_;
1074 1286
… …
1076 $self->_drain_rbuf if $cb; 1288 $self->_drain_rbuf if $cb;
1077} 1289}
1078 1290
1079=item $handle->rbuf 1291=item $handle->rbuf
1080 1292
1081Returns the read buffer (as a modifiable lvalue). 1293Returns the read buffer (as a modifiable lvalue). You can also access the
1294read buffer directly as the C<< ->{rbuf} >> member, if you want (this is
1295much faster, and no less clean).
1082 1296
1083You can access the read buffer directly as the C<< ->{rbuf} >> 1297The only operation allowed on the read buffer (apart from looking at it)
1084member, if you want. However, the only operation allowed on the 1298is removing data from its beginning. Otherwise modifying or appending to
1085read buffer (apart from looking at it) is removing data from its 1299it 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 1300
1089NOTE: The read buffer should only be used or modified if the C<on_read>, 1301NOTE: 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 1302callback or when C<push_read> or C<unshift_read> are used with a single
1091automatically manage the read buffer. 1303callback (i.e. untyped). Typed C<push_read> and C<unshift_read> methods
1304will manage the read buffer on their own.
1092 1305
1093=cut 1306=cut
1094 1307
1095sub rbuf : lvalue { 1308sub rbuf : lvalue {
1096 $_[0]{rbuf} 1309 $_[0]{rbuf}
… …
1113 1326
1114If enough data was available, then the callback must remove all data it is 1327If 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 1328interested in (which can be none at all) and return a true value. After returning
1116true, it will be removed from the queue. 1329true, it will be removed from the queue.
1117 1330
1331These methods may invoke callbacks (and therefore the handle might be
1332destroyed after it returns).
1333
1118=cut 1334=cut
1119 1335
1120our %RH; 1336our %RH;
1121 1337
1122sub register_read_type($$) { 1338sub register_read_type($$) {
… …
1128 my $cb = pop; 1344 my $cb = pop;
1129 1345
1130 if (@_) { 1346 if (@_) {
1131 my $type = shift; 1347 my $type = shift;
1132 1348
1349 $cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type"
1133 $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read") 1350 or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_read")
1134 ->($self, $cb, @_); 1351 ->($self, $cb, @_);
1135 } 1352 }
1136 1353
1137 push @{ $self->{_queue} }, $cb; 1354 push @{ $self->{_queue} }, $cb;
1138 $self->_drain_rbuf; 1355 $self->_drain_rbuf;
… …
1143 my $cb = pop; 1360 my $cb = pop;
1144 1361
1145 if (@_) { 1362 if (@_) {
1146 my $type = shift; 1363 my $type = shift;
1147 1364
1365 $cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type"
1148 $cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read") 1366 or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::unshift_read")
1149 ->($self, $cb, @_); 1367 ->($self, $cb, @_);
1150 } 1368 }
1151
1152 1369
1153 unshift @{ $self->{_queue} }, $cb; 1370 unshift @{ $self->{_queue} }, $cb;
1154 $self->_drain_rbuf; 1371 $self->_drain_rbuf;
1155} 1372}
1156 1373
… …
1158 1375
1159=item $handle->unshift_read (type => @args, $cb) 1376=item $handle->unshift_read (type => @args, $cb)
1160 1377
1161Instead of providing a callback that parses the data itself you can chose 1378Instead of providing a callback that parses the data itself you can chose
1162between a number of predefined parsing formats, for chunks of data, lines 1379between a number of predefined parsing formats, for chunks of data, lines
1163etc. 1380etc. You can also specify the (fully qualified) name of a package, in
1381which case AnyEvent tries to load the package and then expects to find the
1382C<anyevent_read_type> function inside (see "custom read types", below).
1164 1383
1165Predefined types are (if you have ideas for additional types, feel free to 1384Predefined types are (if you have ideas for additional types, feel free to
1166drop by and tell us): 1385drop by and tell us):
1167 1386
1168=over 4 1387=over 4
… …
1260the receive buffer when neither C<$accept> nor C<$reject> match, 1479the receive buffer when neither C<$accept> nor C<$reject> match,
1261and everything preceding and including the match will be accepted 1480and everything preceding and including the match will be accepted
1262unconditionally. This is useful to skip large amounts of data that you 1481unconditionally. 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 1482know 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 1483have to start matching from the beginning. This is purely an optimisation
1265and is usually worth only when you expect more than a few kilobytes. 1484and is usually worth it only when you expect more than a few kilobytes.
1266 1485
1267Example: expect a http header, which ends at C<\015\012\015\012>. Since we 1486Example: 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 1487expect 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 1488a 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 1489it only accepts something not ending in either \015 or \012, as these are
1271required for the accept regex. 1490required for the accept regex.
1272 1491
1273 $handle->push_read (regex => 1492 $handle->push_read (regex =>
… …
1408=cut 1627=cut
1409 1628
1410register_read_type json => sub { 1629register_read_type json => sub {
1411 my ($self, $cb) = @_; 1630 my ($self, $cb) = @_;
1412 1631
1413 my $json = $self->{json} ||= 1632 my $json = $self->{json} ||= json_coder;
1414 eval { require JSON::XS; JSON::XS->new->utf8 }
1415 || do { require JSON; JSON->new->utf8 };
1416 1633
1417 my $data; 1634 my $data;
1418 my $rbuf = \$self->{rbuf}; 1635 my $rbuf = \$self->{rbuf};
1419 1636
1420 sub { 1637 sub {
… …
1489 } 1706 }
1490}; 1707};
1491 1708
1492=back 1709=back
1493 1710
1494=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args) 1711=item custom read types - Package::anyevent_read_type $handle, $cb, @args
1495 1712
1496This function (not method) lets you add your own types to C<push_read>. 1713Instead of one of the predefined types, you can also specify the name
1714of a package. AnyEvent will try to load the package and then expects to
1715find a function named C<anyevent_read_type> inside. If it isn't found, it
1716progressively tries to load the parent package until it either finds the
1717function (good) or runs out of packages (bad).
1497 1718
1498Whenever the given C<type> is used, C<push_read> will invoke the code 1719Whenever this type is used, C<push_read> will invoke the function with the
1499reference with the handle object, the callback and the remaining 1720handle object, the original callback and the remaining arguments.
1500arguments.
1501 1721
1502The code reference is supposed to return a callback (usually a closure) 1722The function is supposed to return a callback (usually a closure) that
1503that works as a plain read callback (see C<< ->push_read ($cb) >>). 1723works as a plain read callback (see C<< ->push_read ($cb) >>), so you can
1724mentally treat the function as a "configurable read type to read callback"
1725converter.
1504 1726
1505It should invoke the passed callback when it is done reading (remember to 1727It should invoke the original callback when it is done reading (remember
1506pass C<$handle> as first argument as all other callbacks do that). 1728to pass C<$handle> as first argument as all other callbacks do that,
1729although there is no strict requirement on this).
1507 1730
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>, 1731For examples, see the source of this module (F<perldoc -m
1512search for C<register_read_type>)). 1732AnyEvent::Handle>, search for C<register_read_type>)).
1513 1733
1514=item $handle->stop_read 1734=item $handle->stop_read
1515 1735
1516=item $handle->start_read 1736=item $handle->start_read
1517 1737
… …
1537} 1757}
1538 1758
1539sub start_read { 1759sub start_read {
1540 my ($self) = @_; 1760 my ($self) = @_;
1541 1761
1542 unless ($self->{_rw} || $self->{_eof}) { 1762 unless ($self->{_rw} || $self->{_eof} || !$self->{fh}) {
1543 Scalar::Util::weaken $self; 1763 Scalar::Util::weaken $self;
1544 1764
1545 $self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub { 1765 $self->{_rw} = AE::io $self->{fh}, 0, sub {
1546 my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf}); 1766 my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1547 my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf; 1767 my $len = sysread $self->{fh}, $$rbuf, $self->{read_size}, length $$rbuf;
1548 1768
1549 if ($len > 0) { 1769 if ($len > 0) {
1550 $self->{_activity} = AnyEvent->now; 1770 $self->{_activity} = $self->{_ractivity} = AE::now;
1551 1771
1552 if ($self->{tls}) { 1772 if ($self->{tls}) {
1553 Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf); 1773 Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1554 1774
1555 &_dotls ($self); 1775 &_dotls ($self);
1556 } else { 1776 } else {
1557 $self->_drain_rbuf; 1777 $self->_drain_rbuf;
1558 } 1778 }
1559 1779
1780 if ($len == $self->{read_size}) {
1781 $self->{read_size} *= 2;
1782 $self->{read_size} = $self->{max_read_size} || MAX_READ_SIZE
1783 if $self->{read_size} > ($self->{max_read_size} || MAX_READ_SIZE);
1784 }
1785
1560 } elsif (defined $len) { 1786 } elsif (defined $len) {
1561 delete $self->{_rw}; 1787 delete $self->{_rw};
1562 $self->{_eof} = 1; 1788 $self->{_eof} = 1;
1563 $self->_drain_rbuf; 1789 $self->_drain_rbuf;
1564 1790
1565 } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) { 1791 } elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1566 return $self->_error ($!, 1); 1792 return $self->_error ($!, 1);
1567 } 1793 }
1568 }); 1794 };
1569 } 1795 }
1570} 1796}
1571 1797
1572our $ERROR_SYSCALL; 1798our $ERROR_SYSCALL;
1573our $ERROR_WANT_READ; 1799our $ERROR_WANT_READ;
… …
1640 && ($tmp != $ERROR_SYSCALL || $!); 1866 && ($tmp != $ERROR_SYSCALL || $!);
1641 1867
1642 while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) { 1868 while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1643 $self->{wbuf} .= $tmp; 1869 $self->{wbuf} .= $tmp;
1644 $self->_drain_wbuf; 1870 $self->_drain_wbuf;
1871 $self->{tls} or return; # tls session might have gone away in callback
1645 } 1872 }
1646 1873
1647 $self->{_on_starttls} 1874 $self->{_on_starttls}
1648 and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK () 1875 and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
1649 and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established"); 1876 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 1898context 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 1899changed to your liking. Note that the handshake might have already started
1673when this function returns. 1900when this function returns.
1674 1901
1675Due to bugs in OpenSSL, it might or might not be possible to do multiple 1902Due 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 1903handshakes on the same stream. It is best to not attempt to use the
1677stopping TLS. 1904stream after stopping TLS.
1905
1906This method may invoke callbacks (and therefore the handle might be
1907destroyed after it returns).
1678 1908
1679=cut 1909=cut
1680 1910
1681our %TLS_CACHE; #TODO not yet documented, should we? 1911our %TLS_CACHE; #TODO not yet documented, should we?
1682 1912
… …
1694 require Net::SSLeay; 1924 require Net::SSLeay;
1695 1925
1696 $ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL (); 1926 $ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1697 $ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ (); 1927 $ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1698 1928
1699 $tls = $self->{tls}; 1929 $tls = delete $self->{tls};
1700 $ctx = $self->{tls_ctx}; 1930 $ctx = $self->{tls_ctx};
1701 1931
1702 local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session 1932 local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
1703 1933
1704 if ("HASH" eq ref $ctx) { 1934 if ("HASH" eq ref $ctx) {
… …
1748 1978
1749=item $handle->stoptls 1979=item $handle->stoptls
1750 1980
1751Shuts down the SSL connection - this makes a proper EOF handshake by 1981Shuts down the SSL connection - this makes a proper EOF handshake by
1752sending a close notify to the other side, but since OpenSSL doesn't 1982sending 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 1983support non-blocking shut downs, it is not guaranteed that you can re-use
1754the stream afterwards. 1984the stream afterwards.
1985
1986This method may invoke callbacks (and therefore the handle might be
1987destroyed after it returns).
1755 1988
1756=cut 1989=cut
1757 1990
1758sub stoptls { 1991sub stoptls {
1759 my ($self) = @_; 1992 my ($self) = @_;
1760 1993
1761 if ($self->{tls}) { 1994 if ($self->{tls} && $self->{fh}) {
1762 Net::SSLeay::shutdown ($self->{tls}); 1995 Net::SSLeay::shutdown ($self->{tls});
1763 1996
1764 &_dotls; 1997 &_dotls;
1765 1998
1766# # we don't give a shit. no, we do, but we can't. no...#d# 1999# # we don't give a shit. no, we do, but we can't. no...#d#
… …
1791 my $fh = delete $self->{fh}; 2024 my $fh = delete $self->{fh};
1792 my $wbuf = delete $self->{wbuf}; 2025 my $wbuf = delete $self->{wbuf};
1793 2026
1794 my @linger; 2027 my @linger;
1795 2028
1796 push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub { 2029 push @linger, AE::io $fh, 1, sub {
1797 my $len = syswrite $fh, $wbuf, length $wbuf; 2030 my $len = syswrite $fh, $wbuf, length $wbuf;
1798 2031
1799 if ($len > 0) { 2032 if ($len > 0) {
1800 substr $wbuf, 0, $len, ""; 2033 substr $wbuf, 0, $len, "";
1801 } else { 2034 } elsif (defined $len || ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK)) {
1802 @linger = (); # end 2035 @linger = (); # end
1803 } 2036 }
1804 }); 2037 };
1805 push @linger, AnyEvent->timer (after => $linger, cb => sub { 2038 push @linger, AE::timer $linger, 0, sub {
1806 @linger = (); 2039 @linger = ();
1807 }); 2040 };
1808 } 2041 }
1809} 2042}
1810 2043
1811=item $handle->destroy 2044=item $handle->destroy
1812 2045
… …
1843 2076
1844sub AnyEvent::Handle::destroyed::AUTOLOAD { 2077sub AnyEvent::Handle::destroyed::AUTOLOAD {
1845 #nop 2078 #nop
1846} 2079}
1847 2080
2081=item $handle->destroyed
2082
2083Returns false as long as the handle hasn't been destroyed by a call to C<<
2084->destroy >>, true otherwise.
2085
2086Can be useful to decide whether the handle is still valid after some
2087callback possibly destroyed the handle. For example, C<< ->push_write >>,
2088C<< ->starttls >> and other methods can call user callbacks, which in turn
2089can destroy the handle, so work can be avoided by checking sometimes:
2090
2091 $hdl->starttls ("accept");
2092 return if $hdl->destroyed;
2093 $hdl->push_write (...
2094
2095Note that the call to C<push_write> will silently be ignored if the handle
2096has been destroyed, so often you can just ignore the possibility of the
2097handle being destroyed.
2098
2099=cut
2100
2101sub destroyed { 0 }
2102sub AnyEvent::Handle::destroyed::destroyed { 1 }
2103
1848=item AnyEvent::Handle::TLS_CTX 2104=item AnyEvent::Handle::TLS_CTX
1849 2105
1850This function creates and returns the AnyEvent::TLS object used by default 2106This function creates and returns the AnyEvent::TLS object used by default
1851for TLS mode. 2107for TLS mode.
1852 2108
… …
1879 2135
1880It is only safe to "forget" the reference inside EOF or error callbacks, 2136It is only safe to "forget" the reference inside EOF or error callbacks,
1881from within all other callbacks, you need to explicitly call the C<< 2137from within all other callbacks, you need to explicitly call the C<<
1882->destroy >> method. 2138->destroy >> method.
1883 2139
2140=item Why is my C<on_eof> callback never called?
2141
2142Probably because your C<on_error> callback is being called instead: When
2143you have outstanding requests in your read queue, then an EOF is
2144considered an error as you clearly expected some data.
2145
2146To avoid this, make sure you have an empty read queue whenever your handle
2147is supposed to be "idle" (i.e. connection closes are O.K.). You cna set
2148an C<on_read> handler that simply pushes the first read requests in the
2149queue.
2150
2151See also the next question, which explains this in a bit more detail.
2152
2153=item How can I serve requests in a loop?
2154
2155Most protocols consist of some setup phase (authentication for example)
2156followed by a request handling phase, where the server waits for requests
2157and handles them, in a loop.
2158
2159There are two important variants: The first (traditional, better) variant
2160handles requests until the server gets some QUIT command, causing it to
2161close the connection first (highly desirable for a busy TCP server). A
2162client dropping the connection is an error, which means this variant can
2163detect an unexpected detection close.
2164
2165To handle this case, always make sure you have a on-empty read queue, by
2166pushing the "read request start" handler on it:
2167
2168 # we assume a request starts with a single line
2169 my @start_request; @start_request = (line => sub {
2170 my ($hdl, $line) = @_;
2171
2172 ... handle request
2173
2174 # push next request read, possibly from a nested callback
2175 $hdl->push_read (@start_request);
2176 });
2177
2178 # auth done, now go into request handling loop
2179 # now push the first @start_request
2180 $hdl->push_read (@start_request);
2181
2182By always having an outstanding C<push_read>, the handle always expects
2183some data and raises the C<EPIPE> error when the connction is dropped
2184unexpectedly.
2185
2186The second variant is a protocol where the client can drop the connection
2187at any time. For TCP, this means that the server machine may run out of
2188sockets easier, and in general, it means you cnanot distinguish a protocl
2189failure/client crash from a normal connection close. Nevertheless, these
2190kinds of protocols are common (and sometimes even the best solution to the
2191problem).
2192
2193Having an outstanding read request at all times is possible if you ignore
2194C<EPIPE> errors, but this doesn't help with when the client drops the
2195connection during a request, which would still be an error.
2196
2197A better solution is to push the initial request read in an C<on_read>
2198callback. This avoids an error, as when the server doesn't expect data
2199(i.e. is idly waiting for the next request, an EOF will not raise an
2200error, but simply result in an C<on_eof> callback. It is also a bit slower
2201and simpler:
2202
2203 # auth done, now go into request handling loop
2204 $hdl->on_read (sub {
2205 my ($hdl) = @_;
2206
2207 # called each time we receive data but the read queue is empty
2208 # simply start read the request
2209
2210 $hdl->push_read (line => sub {
2211 my ($hdl, $line) = @_;
2212
2213 ... handle request
2214
2215 # do nothing special when the request has been handled, just
2216 # let the request queue go empty.
2217 });
2218 });
2219
1884=item I get different callback invocations in TLS mode/Why can't I pause 2220=item I get different callback invocations in TLS mode/Why can't I pause
1885reading? 2221reading?
1886 2222
1887Unlike, say, TCP, TLS connections do not consist of two independent 2223Unlike, say, TCP, TLS connections do not consist of two independent
1888communication channels, one for each direction. Or put differently. The 2224communication channels, one for each direction. Or put differently, the
1889read and write directions are not independent of each other: you cannot 2225read and write directions are not independent of each other: you cannot
1890write data unless you are also prepared to read, and vice versa. 2226write data unless you are also prepared to read, and vice versa.
1891 2227
1892This can mean than, in TLS mode, you might get C<on_error> or C<on_eof> 2228This 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 2229callback invocations when you are not expecting any read data - the reason
1894is that AnyEvent::Handle always reads in TLS mode. 2230is that AnyEvent::Handle always reads in TLS mode.
1895 2231
1896During the connection, you have to make sure that you always have a 2232During 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 2233non-empty read-queue, or an C<on_read> watcher. At the end of the
… …
1911 my $data = delete $_[0]{rbuf}; 2247 my $data = delete $_[0]{rbuf};
1912 }); 2248 });
1913 2249
1914The reason to use C<on_error> is that TCP connections, due to latencies 2250The 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 2251and packets loss, might get closed quite violently with an error, when in
1916fact, all data has been received. 2252fact all data has been received.
1917 2253
1918It is usually better to use acknowledgements when transferring data, 2254It is usually better to use acknowledgements when transferring data,
1919to make sure the other side hasn't just died and you got the data 2255to 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 2256intact. This is also one reason why so many internet protocols have an
1921explicit QUIT command. 2257explicit QUIT command.
… …
1938consider using C<< ->push_shutdown >> instead. 2274consider using C<< ->push_shutdown >> instead.
1939 2275
1940=item I want to contact a TLS/SSL server, I don't care about security. 2276=item I want to contact a TLS/SSL server, I don't care about security.
1941 2277
1942If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS, 2278If 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> 2279connect to it and then create the AnyEvent::Handle with the C<tls>
1944parameter: 2280parameter:
1945 2281
1946 tcp_connect $host, $port, sub { 2282 tcp_connect $host, $port, sub {
1947 my ($fh) = @_; 2283 my ($fh) = @_;
1948 2284
… …
2048 2384
2049=item * all members not documented here and not prefixed with an underscore 2385=item * all members not documented here and not prefixed with an underscore
2050are free to use in subclasses. 2386are free to use in subclasses.
2051 2387
2052Of course, new versions of AnyEvent::Handle may introduce more "public" 2388Of course, new versions of AnyEvent::Handle may introduce more "public"
2053member variables, but thats just life, at least it is documented. 2389member variables, but that's just life. At least it is documented.
2054 2390
2055=back 2391=back
2056 2392
2057=head1 AUTHOR 2393=head1 AUTHOR
2058 2394

Diff Legend

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