ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/AnyEvent/lib/AnyEvent/Handle.pm

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.148 by root, Fri Jul 10 22:35:28 2009 UTC vs.
Revision 1.196 by root, Tue Jun 8 10:04:17 2010 UTC

1	package AnyEvent::Handle;
2
3	no warnings;
4	use strict qw(subs vars);
5
6	use AnyEvent ();
7	use AnyEvent::Util qw(WSAEWOULDBLOCK);
8	use Scalar::Util ();
9	use Carp ();
10	use Fcntl ();
11	use Errno qw(EAGAIN EINTR);
12
13	=head1 NAME	1	=head1 NAME
14		2
15	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent	3	AnyEvent::Handle - non-blocking I/O on streaming handles via AnyEvent
16
17	=cut
18
19	our $VERSION = 4.82;
20		4
21	=head1 SYNOPSIS	5	=head1 SYNOPSIS
22		6
23	use AnyEvent;	7	use AnyEvent;
24	use AnyEvent::Handle;	8	use AnyEvent::Handle;
25		9
26	my $cv = AnyEvent->condvar;	10	my $cv = AnyEvent->condvar;
27		11
28	my $handle =	12	my $hdl; $hdl = new AnyEvent::Handle
29	AnyEvent::Handle->new (
30	fh => \*STDIN,	13	fh => \*STDIN,
31	on_eof => sub {	14	on_error => sub {
		15	my ($hdl, $fatal, $msg) = @_;
		16	warn "got error $msg\n";
		17	$hdl->destroy;
32	$cv->send;	18	$cv->send;
33	},
34	);	19	};
35		20
36	# send some request line	21	# send some request line
37	$handle->push_write ("getinfo\015\012");	22	$hdl->push_write ("getinfo\015\012");
38		23
39	# read the response line	24	# read the response line
40	$handle->push_read (line => sub {	25	$hdl->push_read (line => sub {
41	my ($handle, $line) = @_;	26	my ($hdl, $line) = @_;
42	warn "read line <$line>\n";	27	warn "got line <$line>\n";
43	$cv->send;	28	$cv->send;
44	});	29	});
45		30
46	$cv->recv;	31	$cv->recv;
47		32
48	=head1 DESCRIPTION	33	=head1 DESCRIPTION
49		34
50	This module is a helper module to make it easier to do event-based I/O on	35	This module is a helper module to make it easier to do event-based I/O on
51	filehandles. For utility functions for doing non-blocking connects and accepts	36	stream-based filehandles (sockets, pipes or other stream things).
52	on sockets see L<AnyEvent::Util>.
53		37
54	The L<AnyEvent::Intro> tutorial contains some well-documented	38	The L<AnyEvent::Intro> tutorial contains some well-documented
55	AnyEvent::Handle examples.	39	AnyEvent::Handle examples.
56		40
57	In the following, when the documentation refers to of "bytes" then this	41	In the following, when the documentation refers to of "bytes" then this
58	means characters. As sysread and syswrite are used for all I/O, their	42	means characters. As sysread and syswrite are used for all I/O, their
59	treatment of characters applies to this module as well.	43	treatment of characters applies to this module as well.
60		44
		45	At the very minimum, you should specify C<fh> or C<connect>, and the
		46	C<on_error> callback.
		47
61	All callbacks will be invoked with the handle object as their first	48	All callbacks will be invoked with the handle object as their first
62	argument.	49	argument.
63		50
		51	=cut
		52
		53	package AnyEvent::Handle;
		54
		55	use Scalar::Util ();
		56	use List::Util ();
		57	use Carp ();
		58	use Errno qw(EAGAIN EINTR);
		59
		60	use AnyEvent (); BEGIN { AnyEvent::common_sense }
		61	use AnyEvent::Util qw(WSAEWOULDBLOCK);
		62
		63	our $VERSION = $AnyEvent::VERSION;
		64
		65	sub _load_func($) {
		66	my $func = $_[0];
		67
		68	unless (defined &$func) {
		69	my $pkg = $func;
		70	do {
		71	$pkg =~ s/::[^:]+$//
		72	or return;
		73	eval "require $pkg";
		74	} until defined &$func;
		75	}
		76
		77	\&$func
		78	}
		79
64	=head1 METHODS	80	=head1 METHODS
65		81
66	=over 4	82	=over 4
67		83
68	=item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value...	84	=item $handle = B<new> AnyEvent::Handle fh => $filehandle, key => value...
69		85
70	The constructor supports these arguments (all as C<< key => value >> pairs).	86	The constructor supports these arguments (all as C<< key => value >> pairs).
71		87
72	=over 4	88	=over 4
73		89
74	=item fh => $filehandle [MANDATORY]	90	=item fh => $filehandle [C<fh> or C<connect> MANDATORY]
75		91
76	The filehandle this L<AnyEvent::Handle> object will operate on.	92	The filehandle this L<AnyEvent::Handle> object will operate on.
77
78	NOTE: The filehandle will be set to non-blocking mode (using	93	NOTE: The filehandle will be set to non-blocking mode (using
79	C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in	94	C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in
80	that mode.	95	that mode.
81		96
		97	=item connect => [$host, $service] [C<fh> or C<connect> MANDATORY]
		98
		99	Try to connect to the specified host and service (port), using
		100	C<AnyEvent::Socket::tcp_connect>. The C<$host> additionally becomes the
		101	default C<peername>.
		102
		103	You have to specify either this parameter, or C<fh>, above.
		104
		105	It is possible to push requests on the read and write queues, and modify
		106	properties of the stream, even while AnyEvent::Handle is connecting.
		107
		108	When this parameter is specified, then the C<on_prepare>,
		109	C<on_connect_error> and C<on_connect> callbacks will be called under the
		110	appropriate circumstances:
		111
		112	=over 4
		113
		114	=item on_prepare => $cb->($handle)
		115
		116	This (rarely used) callback is called before a new connection is
		117	attempted, but after the file handle has been created. It could be used to
		118	prepare the file handle with parameters required for the actual connect
		119	(as opposed to settings that can be changed when the connection is already
		120	established).
		121
		122	The return value of this callback should be the connect timeout value in
		123	seconds (or C<0>, or C<undef>, or the empty list, to indicate the default
		124	timeout is to be used).
		125
		126	=item on_connect => $cb->($handle, $host, $port, $retry->())
		127
		128	This callback is called when a connection has been successfully established.
		129
		130	The actual numeric host and port (the socket peername) are passed as
		131	parameters, together with a retry callback.
		132
		133	When, for some reason, the handle is not acceptable, then calling
		134	C<$retry> will continue with the next connection target (in case of
		135	multi-homed hosts or SRV records there can be multiple connection
		136	endpoints). At the time it is called the read and write queues, eof
		137	status, tls status and similar properties of the handle will have been
		138	reset.
		139
		140	In most cases, ignoring the C<$retry> parameter is the way to go.
		141
		142	=item on_connect_error => $cb->($handle, $message)
		143
		144	This callback is called when the connection could not be
		145	established. C<$!> will contain the relevant error code, and C<$message> a
		146	message describing it (usually the same as C<"$!">).
		147
		148	If this callback isn't specified, then C<on_error> will be called with a
		149	fatal error instead.
		150
		151	=back
		152
		153	=item on_error => $cb->($handle, $fatal, $message)
		154
		155	This is the error callback, which is called when, well, some error
		156	occured, such as not being able to resolve the hostname, failure to
		157	connect or a read error.
		158
		159	Some errors are fatal (which is indicated by C<$fatal> being true). On
		160	fatal errors the handle object will be destroyed (by a call to C<< ->
		161	destroy >>) after invoking the error callback (which means you are free to
		162	examine the handle object). Examples of fatal errors are an EOF condition
		163	with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors. In
		164	cases where the other side can close the connection at their will it is
		165	often easiest to not report C<EPIPE> errors in this callback.
		166
		167	AnyEvent::Handle tries to find an appropriate error code for you to check
		168	against, but in some cases (TLS errors), this does not work well. It is
		169	recommended to always output the C<$message> argument in human-readable
		170	error messages (it's usually the same as C<"$!">).
		171
		172	Non-fatal errors can be retried by simply returning, but it is recommended
		173	to simply ignore this parameter and instead abondon the handle object
		174	when this callback is invoked. Examples of non-fatal errors are timeouts
		175	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
		176
		177	On callback entrance, the value of C<$!> contains the operating system
		178	error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
		179	C<EPROTO>).
		180
		181	While not mandatory, it is I<highly> recommended to set this callback, as
		182	you will not be notified of errors otherwise. The default simply calls
		183	C<croak>.
		184
		185	=item on_read => $cb->($handle)
		186
		187	This sets the default read callback, which is called when data arrives
		188	and no read request is in the queue (unlike read queue callbacks, this
		189	callback will only be called when at least one octet of data is in the
		190	read buffer).
		191
		192	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
		193	method or access the C<< $handle->{rbuf} >> member directly. Note that you
		194	must not enlarge or modify the read buffer, you can only remove data at
		195	the beginning from it.
		196
		197	When an EOF condition is detected then AnyEvent::Handle will first try to
		198	feed all the remaining data to the queued callbacks and C<on_read> before
		199	calling the C<on_eof> callback. If no progress can be made, then a fatal
		200	error will be raised (with C<$!> set to C<EPIPE>).
		201
		202	Note that, unlike requests in the read queue, an C<on_read> callback
		203	doesn't mean you I<require> some data: if there is an EOF and there
		204	are outstanding read requests then an error will be flagged. With an
		205	C<on_read> callback, the C<on_eof> callback will be invoked.
		206
82	=item on_eof => $cb->($handle)	207	=item on_eof => $cb->($handle)
83		208
84	Set the callback to be called when an end-of-file condition is detected,	209	Set the callback to be called when an end-of-file condition is detected,
85	i.e. in the case of a socket, when the other side has closed the	210	i.e. in the case of a socket, when the other side has closed the
86	connection cleanly.	211	connection cleanly, and there are no outstanding read requests in the
		212	queue (if there are read requests, then an EOF counts as an unexpected
		213	connection close and will be flagged as an error).
87		214
88	For sockets, this just means that the other side has stopped sending data,	215	For sockets, this just means that the other side has stopped sending data,
89	you can still try to write data, and, in fact, one can return from the EOF	216	you can still try to write data, and, in fact, one can return from the EOF
90	callback and continue writing data, as only the read part has been shut	217	callback and continue writing data, as only the read part has been shut
91	down.	218	down.
92		219
93	While not mandatory, it is I<highly> recommended to set an EOF callback,
94	otherwise you might end up with a closed socket while you are still
95	waiting for data.
96
97	If an EOF condition has been detected but no C<on_eof> callback has been	220	If an EOF condition has been detected but no C<on_eof> callback has been
98	set, then a fatal error will be raised with C<$!> set to <0>.	221	set, then a fatal error will be raised with C<$!> set to <0>.
99
100	=item on_error => $cb->($handle, $fatal, $message)
101
102	This is the error callback, which is called when, well, some error
103	occured, such as not being able to resolve the hostname, failure to
104	connect or a read error.
105
106	Some errors are fatal (which is indicated by C<$fatal> being true). On
107	fatal errors the handle object will be shut down and will not be usable
108	(but you are free to look at the current C<< ->rbuf >>). Examples of fatal
109	errors are an EOF condition with active (but unsatisifable) read watchers
110	(C<EPIPE>) or I/O errors.
111
112	AnyEvent::Handle tries to find an appropriate error code for you to check
113	against, but in some cases (TLS errors), this does not work well. It is
114	recommended to always output the C<$message> argument in human-readable
115	error messages (it's usually the same as C<"$!">).
116
117	Non-fatal errors can be retried by simply returning, but it is recommended
118	to simply ignore this parameter and instead abondon the handle object
119	when this callback is invoked. Examples of non-fatal errors are timeouts
120	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
121
122	On callback entrance, the value of C<$!> contains the operating system
123	error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
124	C<EPROTO>).
125
126	While not mandatory, it is I<highly> recommended to set this callback, as
127	you will not be notified of errors otherwise. The default simply calls
128	C<croak>.
129
130	=item on_read => $cb->($handle)
131
132	This sets the default read callback, which is called when data arrives
133	and no read request is in the queue (unlike read queue callbacks, this
134	callback will only be called when at least one octet of data is in the
135	read buffer).
136
137	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
138	method or access the C<< $handle->{rbuf} >> member directly. Note that you
139	must not enlarge or modify the read buffer, you can only remove data at
140	the beginning from it.
141
142	When an EOF condition is detected then AnyEvent::Handle will first try to
143	feed all the remaining data to the queued callbacks and C<on_read> before
144	calling the C<on_eof> callback. If no progress can be made, then a fatal
145	error will be raised (with C<$!> set to C<EPIPE>).
146		222
147	=item on_drain => $cb->($handle)	223	=item on_drain => $cb->($handle)
148		224
149	This sets the callback that is called when the write buffer becomes empty	225	This sets the callback that is called when the write buffer becomes empty
150	(or when the callback is set and the buffer is empty already).	226	(or when the callback is set and the buffer is empty already).
…		…
157	memory and push it into the queue, but instead only read more data from	233	memory and push it into the queue, but instead only read more data from
158	the file when the write queue becomes empty.	234	the file when the write queue becomes empty.
159		235
160	=item timeout => $fractional_seconds	236	=item timeout => $fractional_seconds
161		237
		238	=item rtimeout => $fractional_seconds
		239
		240	=item wtimeout => $fractional_seconds
		241
162	If non-zero, then this enables an "inactivity" timeout: whenever this many	242	If non-zero, then these enables an "inactivity" timeout: whenever this
163	seconds pass without a successful read or write on the underlying file	243	many seconds pass without a successful read or write on the underlying
164	handle, the C<on_timeout> callback will be invoked (and if that one is	244	file handle (or a call to C<timeout_reset>), the C<on_timeout> callback
165	missing, a non-fatal C<ETIMEDOUT> error will be raised).	245	will be invoked (and if that one is missing, a non-fatal C<ETIMEDOUT>
		246	error will be raised).
		247
		248	There are three variants of the timeouts that work fully independent
		249	of each other, for both read and write, just read, and just write:
		250	C<timeout>, C<rtimeout> and C<wtimeout>, with corresponding callbacks
		251	C<on_timeout>, C<on_rtimeout> and C<on_wtimeout>, and reset functions
		252	C<timeout_reset>, C<rtimeout_reset>, and C<wtimeout_reset>.
166		253
167	Note that timeout processing is also active when you currently do not have	254	Note that timeout processing is also active when you currently do not have
168	any outstanding read or write requests: If you plan to keep the connection	255	any outstanding read or write requests: If you plan to keep the connection
169	idle then you should disable the timout temporarily or ignore the timeout	256	idle then you should disable the timout temporarily or ignore the timeout
170	in the C<on_timeout> callback, in which case AnyEvent::Handle will simply	257	in the C<on_timeout> callback, in which case AnyEvent::Handle will simply
…		…
214	accomplishd by setting this option to a true value.	301	accomplishd by setting this option to a true value.
215		302
216	The default is your opertaing system's default behaviour (most likely	303	The default is your opertaing system's default behaviour (most likely
217	enabled), this option explicitly enables or disables it, if possible.	304	enabled), this option explicitly enables or disables it, if possible.
218		305
		306	=item keepalive => <boolean>
		307
		308	Enables (default disable) the SO_KEEPALIVE option on the stream socket:
		309	normally, TCP connections have no time-out once established, so TCP
		310	connections, once established, can stay alive forever even when the other
		311	side has long gone. TCP keepalives are a cheap way to take down long-lived
		312	TCP connections whent he other side becomes unreachable. While the default
		313	is OS-dependent, TCP keepalives usually kick in after around two hours,
		314	and, if the other side doesn't reply, take down the TCP connection some 10
		315	to 15 minutes later.
		316
		317	It is harmless to specify this option for file handles that do not support
		318	keepalives, and enabling it on connections that are potentially long-lived
		319	is usually a good idea.
		320
		321	=item oobinline => <boolean>
		322
		323	BSD majorly fucked up the implementation of TCP urgent data. The result
		324	is that almost no OS implements TCP according to the specs, and every OS
		325	implements it slightly differently.
		326
		327	If you want to handle TCP urgent data, then setting this flag (the default
		328	is enabled) gives you the most portable way of getting urgent data, by
		329	putting it into the stream.
		330
		331	Since BSD emulation of OOB data on top of TCP's urgent data can have
		332	security implications, AnyEvent::Handle sets this flag automatically
		333	unless explicitly specified. Note that setting this flag after
		334	establishing a connection I<may> be a bit too late (data loss could
		335	already have occured on BSD systems), but at least it will protect you
		336	from most attacks.
		337
219	=item read_size => <bytes>	338	=item read_size => <bytes>
220		339
221	The default read block size (the amount of bytes this module will	340	The default read block size (the amount of bytes this module will
222	try to read during each loop iteration, which affects memory	341	try to read during each loop iteration, which affects memory
223	requirements). Default: C<8192>.	342	requirements). Default: C<8192>.
…		…
256	C<undef>.	375	C<undef>.
257		376
258	=item tls => "accept" | "connect" | Net::SSLeay::SSL object	377	=item tls => "accept" | "connect" | Net::SSLeay::SSL object
259		378
260	When this parameter is given, it enables TLS (SSL) mode, that means	379	When this parameter is given, it enables TLS (SSL) mode, that means
261	AnyEvent will start a TLS handshake as soon as the conenction has been	380	AnyEvent will start a TLS handshake as soon as the connection has been
262	established and will transparently encrypt/decrypt data afterwards.	381	established and will transparently encrypt/decrypt data afterwards.
263		382
264	All TLS protocol errors will be signalled as C<EPROTO>, with an	383	All TLS protocol errors will be signalled as C<EPROTO>, with an
265	appropriate error message.	384	appropriate error message.
266		385
…		…
349		468
350	sub new {	469	sub new {
351	my $class = shift;	470	my $class = shift;
352	my $self = bless { @_ }, $class;	471	my $self = bless { @_ }, $class;
353		472
354	$self->{fh} or Carp::croak "mandatory argument fh is missing";	473	if ($self->{fh}) {
		474	$self->_start;
		475	return unless $self->{fh}; # could be gone by now
		476
		477	} elsif ($self->{connect}) {
		478	require AnyEvent::Socket;
		479
		480	$self->{peername} = $self->{connect}[0]
		481	unless exists $self->{peername};
		482
		483	$self->{_skip_drain_rbuf} = 1;
		484
		485	{
		486	Scalar::Util::weaken (my $self = $self);
		487
		488	$self->{_connect} =
		489	AnyEvent::Socket::tcp_connect (
		490	$self->{connect}[0],
		491	$self->{connect}[1],
		492	sub {
		493	my ($fh, $host, $port, $retry) = @_;
		494
		495	if ($fh) {
		496	$self->{fh} = $fh;
		497
		498	delete $self->{_skip_drain_rbuf};
		499	$self->_start;
		500
		501	$self->{on_connect}
		502	and $self->{on_connect}($self, $host, $port, sub {
		503	delete @$self{qw(fh _tw _rtw _wtw _ww _rw _eof _queue rbuf _wbuf tls _tls_rbuf _tls_wbuf)};
		504	$self->{_skip_drain_rbuf} = 1;
		505	&$retry;
		506	});
		507
		508	} else {
		509	if ($self->{on_connect_error}) {
		510	$self->{on_connect_error}($self, "$!");
		511	$self->destroy;
		512	} else {
		513	$self->_error ($!, 1);
		514	}
		515	}
		516	},
		517	sub {
		518	local $self->{fh} = $_[0];
		519
		520	$self->{on_prepare}
		521	? $self->{on_prepare}->($self)
		522	: ()
		523	}
		524	);
		525	}
		526
		527	} else {
		528	Carp::croak "AnyEvent::Handle: either an existing fh or the connect parameter must be specified";
		529	}
		530
		531	$self
		532	}
		533
		534	sub _start {
		535	my ($self) = @_;
		536
		537	# too many clueless people try to use udp and similar sockets
		538	# with AnyEvent::Handle, do them a favour.
		539	my $type = getsockopt $self->{fh}, Socket::SOL_SOCKET (), Socket::SO_TYPE ();
		540	Carp::croak "AnyEvent::Handle: only stream sockets supported, anything else will NOT work!"
		541	if Socket::SOCK_STREAM () != (unpack "I", $type) && defined $type;
355		542
356	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	543	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
357		544
		545	$self->{_activity} =
		546	$self->{_ractivity} =
358	$self->{_activity} = AnyEvent->now;	547	$self->{_wactivity} = AE::now;
359	$self->_timeout;
360		548
		549	$self->timeout (delete $self->{timeout} ) if $self->{timeout};
		550	$self->rtimeout (delete $self->{rtimeout} ) if $self->{rtimeout};
		551	$self->wtimeout (delete $self->{wtimeout} ) if $self->{wtimeout};
		552
361	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};	553	$self->no_delay (delete $self->{no_delay} ) if exists $self->{no_delay} && $self->{no_delay};
		554	$self->keepalive (delete $self->{keepalive}) if exists $self->{keepalive} && $self->{keepalive};
362		555
		556	$self->oobinline (exists $self->{oobinline} ? delete $self->{oobinline} : 1);
		557
363	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})	558	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
364	if $self->{tls};	559	if $self->{tls};
365		560
366	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	561	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
367		562
368	$self->start_read	563	$self->start_read
369	if $self->{on_read};	564	if $self->{on_read} || @{ $self->{_queue} };
370		565
371	$self->{fh} && $self	566	$self->_drain_wbuf;
372	}
373
374	sub _shutdown {
375	my ($self) = @_;
376
377	delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)};
378	$self->{_eof} = 1; # tell starttls et. al to stop trying
379
380	&_freetls;
381	}	567	}
382		568
383	sub _error {	569	sub _error {
384	my ($self, $errno, $fatal, $message) = @_;	570	my ($self, $errno, $fatal, $message) = @_;
385		571
386	$self->_shutdown
387	if $fatal;
388
389	$! = $errno;	572	$! = $errno;
390	$message ||= "$!";	573	$message ||= "$!";
391		574
392	if ($self->{on_error}) {	575	if ($self->{on_error}) {
393	$self->{on_error}($self, $fatal, $message);	576	$self->{on_error}($self, $fatal, $message);
394	} elsif ($self->{fh}) {	577	$self->destroy if $fatal;
		578	} elsif ($self->{fh} || $self->{connect}) {
		579	$self->destroy;
395	Carp::croak "AnyEvent::Handle uncaught error: $message";	580	Carp::croak "AnyEvent::Handle uncaught error: $message";
396	}	581	}
397	}	582	}
398		583
399	=item $fh = $handle->fh	584	=item $fh = $handle->fh
…		…
424	$_[0]{on_eof} = $_[1];	609	$_[0]{on_eof} = $_[1];
425	}	610	}
426		611
427	=item $handle->on_timeout ($cb)	612	=item $handle->on_timeout ($cb)
428		613
429	Replace the current C<on_timeout> callback, or disables the callback (but	614	=item $handle->on_rtimeout ($cb)
430	not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
431	argument and method.
432		615
433	=cut	616	=item $handle->on_wtimeout ($cb)
434		617
435	sub on_timeout {	618	Replace the current C<on_timeout>, C<on_rtimeout> or C<on_wtimeout>
436	$_[0]{on_timeout} = $_[1];	619	callback, or disables the callback (but not the timeout) if C<$cb> =
437	}	620	C<undef>. See the C<timeout> constructor argument and method.
		621
		622	=cut
		623
		624	# see below
438		625
439	=item $handle->autocork ($boolean)	626	=item $handle->autocork ($boolean)
440		627
441	Enables or disables the current autocork behaviour (see C<autocork>	628	Enables or disables the current autocork behaviour (see C<autocork>
442	constructor argument). Changes will only take effect on the next write.	629	constructor argument). Changes will only take effect on the next write.
…		…
457	sub no_delay {	644	sub no_delay {
458	$_[0]{no_delay} = $_[1];	645	$_[0]{no_delay} = $_[1];
459		646
460	eval {	647	eval {
461	local $SIG{__DIE__};	648	local $SIG{__DIE__};
462	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];	649	setsockopt $_[0]{fh}, Socket::IPPROTO_TCP (), Socket::TCP_NODELAY (), int $_[1]
		650	if $_[0]{fh};
		651	};
		652	}
		653
		654	=item $handle->keepalive ($boolean)
		655
		656	Enables or disables the C<keepalive> setting (see constructor argument of
		657	the same name for details).
		658
		659	=cut
		660
		661	sub keepalive {
		662	$_[0]{keepalive} = $_[1];
		663
		664	eval {
		665	local $SIG{__DIE__};
		666	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
		667	if $_[0]{fh};
		668	};
		669	}
		670
		671	=item $handle->oobinline ($boolean)
		672
		673	Enables or disables the C<oobinline> setting (see constructor argument of
		674	the same name for details).
		675
		676	=cut
		677
		678	sub oobinline {
		679	$_[0]{oobinline} = $_[1];
		680
		681	eval {
		682	local $SIG{__DIE__};
		683	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_OOBINLINE (), int $_[1]
		684	if $_[0]{fh};
		685	};
		686	}
		687
		688	=item $handle->keepalive ($boolean)
		689
		690	Enables or disables the C<keepalive> setting (see constructor argument of
		691	the same name for details).
		692
		693	=cut
		694
		695	sub keepalive {
		696	$_[0]{keepalive} = $_[1];
		697
		698	eval {
		699	local $SIG{__DIE__};
		700	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
		701	if $_[0]{fh};
463	};	702	};
464	}	703	}
465		704
466	=item $handle->on_starttls ($cb)	705	=item $handle->on_starttls ($cb)
467		706
…		…
477		716
478	Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).	717	Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).
479		718
480	=cut	719	=cut
481		720
482	sub on_starttls {	721	sub on_stoptls {
483	$_[0]{on_stoptls} = $_[1];	722	$_[0]{on_stoptls} = $_[1];
484	}	723	}
485		724
		725	=item $handle->rbuf_max ($max_octets)
		726
		727	Configures the C<rbuf_max> setting (C<undef> disables it).
		728
		729	=cut
		730
		731	sub rbuf_max {
		732	$_[0]{rbuf_max} = $_[1];
		733	}
		734
486	#############################################################################	735	#############################################################################
487		736
488	=item $handle->timeout ($seconds)	737	=item $handle->timeout ($seconds)
489		738
		739	=item $handle->rtimeout ($seconds)
		740
		741	=item $handle->wtimeout ($seconds)
		742
490	Configures (or disables) the inactivity timeout.	743	Configures (or disables) the inactivity timeout.
491		744
492	=cut	745	=item $handle->timeout_reset
493		746
494	sub timeout {	747	=item $handle->rtimeout_reset
		748
		749	=item $handle->wtimeout_reset
		750
		751	Reset the activity timeout, as if data was received or sent.
		752
		753	These methods are cheap to call.
		754
		755	=cut
		756
		757	for my $dir ("", "r", "w") {
		758	my $timeout = "${dir}timeout";
		759	my $tw = "_${dir}tw";
		760	my $on_timeout = "on_${dir}timeout";
		761	my $activity = "_${dir}activity";
		762	my $cb;
		763
		764	*$on_timeout = sub {
		765	$_[0]{$on_timeout} = $_[1];
		766	};
		767
		768	*$timeout = sub {
495	my ($self, $timeout) = @_;	769	my ($self, $new_value) = @_;
496		770
497	$self->{timeout} = $timeout;	771	$self->{$timeout} = $new_value;
498	$self->_timeout;	772	delete $self->{$tw}; &$cb;
499	}	773	};
500		774
		775	*{"${dir}timeout_reset"} = sub {
		776	$_[0]{$activity} = AE::now;
		777	};
		778
		779	# main workhorse:
501	# reset the timeout watcher, as neccessary	780	# reset the timeout watcher, as neccessary
502	# also check for time-outs	781	# also check for time-outs
503	sub _timeout {	782	$cb = sub {
504	my ($self) = @_;	783	my ($self) = @_;
505		784
506	if ($self->{timeout}) {	785	if ($self->{$timeout} && $self->{fh}) {
507	my $NOW = AnyEvent->now;	786	my $NOW = AE::now;
508		787
509	# when would the timeout trigger?	788	# when would the timeout trigger?
510	my $after = $self->{_activity} + $self->{timeout} - $NOW;	789	my $after = $self->{$activity} + $self->{$timeout} - $NOW;
511		790
512	# now or in the past already?	791	# now or in the past already?
513	if ($after <= 0) {	792	if ($after <= 0) {
514	$self->{_activity} = $NOW;	793	$self->{$activity} = $NOW;
515		794
516	if ($self->{on_timeout}) {	795	if ($self->{$on_timeout}) {
517	$self->{on_timeout}($self);	796	$self->{$on_timeout}($self);
518	} else {	797	} else {
519	$self->_error (&Errno::ETIMEDOUT);	798	$self->_error (Errno::ETIMEDOUT);
		799	}
		800
		801	# callback could have changed timeout value, optimise
		802	return unless $self->{$timeout};
		803
		804	# calculate new after
		805	$after = $self->{$timeout};
520	}	806	}
521		807
522	# callback could have changed timeout value, optimise	808	Scalar::Util::weaken $self;
523	return unless $self->{timeout};	809	return unless $self; # ->error could have destroyed $self
524		810
525	# calculate new after	811	$self->{$tw} ||= AE::timer $after, 0, sub {
526	$after = $self->{timeout};	812	delete $self->{$tw};
		813	$cb->($self);
		814	};
		815	} else {
		816	delete $self->{$tw};
527	}	817	}
528
529	Scalar::Util::weaken $self;
530	return unless $self; # ->error could have destroyed $self
531
532	$self->{_tw} ||= AnyEvent->timer (after => $after, cb => sub {
533	delete $self->{_tw};
534	$self->_timeout;
535	});
536	} else {
537	delete $self->{_tw};
538	}	818	}
539	}	819	}
540		820
541	#############################################################################	821	#############################################################################
542		822
…		…
557		837
558	=item $handle->on_drain ($cb)	838	=item $handle->on_drain ($cb)
559		839
560	Sets the C<on_drain> callback or clears it (see the description of	840	Sets the C<on_drain> callback or clears it (see the description of
561	C<on_drain> in the constructor).	841	C<on_drain> in the constructor).
		842
		843	This method may invoke callbacks (and therefore the handle might be
		844	destroyed after it returns).
562		845
563	=cut	846	=cut
564		847
565	sub on_drain {	848	sub on_drain {
566	my ($self, $cb) = @_;	849	my ($self, $cb) = @_;
…		…
575		858
576	Queues the given scalar to be written. You can push as much data as you	859	Queues the given scalar to be written. You can push as much data as you
577	want (only limited by the available memory), as C<AnyEvent::Handle>	860	want (only limited by the available memory), as C<AnyEvent::Handle>
578	buffers it independently of the kernel.	861	buffers it independently of the kernel.
579		862
		863	This method may invoke callbacks (and therefore the handle might be
		864	destroyed after it returns).
		865
580	=cut	866	=cut
581		867
582	sub _drain_wbuf {	868	sub _drain_wbuf {
583	my ($self) = @_;	869	my ($self) = @_;
584		870
…		…
590	my $len = syswrite $self->{fh}, $self->{wbuf};	876	my $len = syswrite $self->{fh}, $self->{wbuf};
591		877
592	if (defined $len) {	878	if (defined $len) {
593	substr $self->{wbuf}, 0, $len, "";	879	substr $self->{wbuf}, 0, $len, "";
594		880
595	$self->{_activity} = AnyEvent->now;	881	$self->{_activity} = $self->{_wactivity} = AE::now;
596		882
597	$self->{on_drain}($self)	883	$self->{on_drain}($self)
598	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})	884	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
599	&& $self->{on_drain};	885	&& $self->{on_drain};
600		886
…		…
606		892
607	# try to write data immediately	893	# try to write data immediately
608	$cb->() unless $self->{autocork};	894	$cb->() unless $self->{autocork};
609		895
610	# if still data left in wbuf, we need to poll	896	# if still data left in wbuf, we need to poll
611	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	897	$self->{_ww} = AE::io $self->{fh}, 1, $cb
612	if length $self->{wbuf};	898	if length $self->{wbuf};
613	};	899	};
614	}	900	}
615		901
616	our %WH;	902	our %WH;
617		903
		904	# deprecated
618	sub register_write_type($$) {	905	sub register_write_type($$) {
619	$WH{$_[0]} = $_[1];	906	$WH{$_[0]} = $_[1];
620	}	907	}
621		908
622	sub push_write {	909	sub push_write {
623	my $self = shift;	910	my $self = shift;
624		911
625	if (@_ > 1) {	912	if (@_ > 1) {
626	my $type = shift;	913	my $type = shift;
627		914
		915	@_ = ($WH{$type} ||= _load_func "$type\::anyevent_write_type"
628	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	916	or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_write")
629	->($self, @_);	917	->($self, @_);
630	}	918	}
631		919
		920	# we downgrade here to avoid hard-to-track-down bugs,
		921	# and diagnose the problem earlier and better.
		922
632	if ($self->{tls}) {	923	if ($self->{tls}) {
633	$self->{_tls_wbuf} .= $_[0];	924	utf8::downgrade $self->{_tls_wbuf} .= $_[0];
634		925	&_dotls ($self) if $self->{fh};
635	&_dotls ($self);
636	} else {	926	} else {
637	$self->{wbuf} .= $_[0];	927	utf8::downgrade $self->{wbuf} .= $_[0];
638	$self->_drain_wbuf;	928	$self->_drain_wbuf if $self->{fh};
639	}	929	}
640	}	930	}
641		931
642	=item $handle->push_write (type => @args)	932	=item $handle->push_write (type => @args)
643		933
644	Instead of formatting your data yourself, you can also let this module do	934	Instead of formatting your data yourself, you can also let this module
645	the job by specifying a type and type-specific arguments.	935	do the job by specifying a type and type-specific arguments. You
		936	can also specify the (fully qualified) name of a package, in which
		937	case AnyEvent tries to load the package and then expects to find the
		938	C<anyevent_read_type> function inside (see "custom write types", below).
646		939
647	Predefined types are (if you have ideas for additional types, feel free to	940	Predefined types are (if you have ideas for additional types, feel free to
648	drop by and tell us):	941	drop by and tell us):
649		942
650	=over 4	943	=over 4
…		…
707	Other languages could read single lines terminated by a newline and pass	1000	Other languages could read single lines terminated by a newline and pass
708	this line into their JSON decoder of choice.	1001	this line into their JSON decoder of choice.
709		1002
710	=cut	1003	=cut
711		1004
		1005	sub json_coder() {
		1006	eval { require JSON::XS; JSON::XS->new->utf8 }
		1007	|| do { require JSON; JSON->new->utf8 }
		1008	}
		1009
712	register_write_type json => sub {	1010	register_write_type json => sub {
713	my ($self, $ref) = @_;	1011	my ($self, $ref) = @_;
714		1012
715	require JSON;	1013	my $json = $self->{json} ||= json_coder;
716		1014
717	$self->{json} ? $self->{json}->encode ($ref)	1015	$json->encode ($ref)
718	: JSON::encode_json ($ref)
719	};	1016	};
720		1017
721	=item storable => $reference	1018	=item storable => $reference
722		1019
723	Freezes the given reference using L<Storable> and writes it to the	1020	Freezes the given reference using L<Storable> and writes it to the
…		…
749	the peer.	1046	the peer.
750		1047
751	You can rely on the normal read queue and C<on_eof> handling	1048	You can rely on the normal read queue and C<on_eof> handling
752	afterwards. This is the cleanest way to close a connection.	1049	afterwards. This is the cleanest way to close a connection.
753		1050
		1051	This method may invoke callbacks (and therefore the handle might be
		1052	destroyed after it returns).
		1053
754	=cut	1054	=cut
755		1055
756	sub push_shutdown {	1056	sub push_shutdown {
757	my ($self) = @_;	1057	my ($self) = @_;
758		1058
759	delete $self->{low_water_mark};	1059	delete $self->{low_water_mark};
760	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });	1060	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });
761	}	1061	}
762		1062
763	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	1063	=item custom write types - Package::anyevent_write_type $handle, @args
764		1064
765	This function (not method) lets you add your own types to C<push_write>.	1065	Instead of one of the predefined types, you can also specify the name of
		1066	a package. AnyEvent will try to load the package and then expects to find
		1067	a function named C<anyevent_write_type> inside. If it isn't found, it
		1068	progressively tries to load the parent package until it either finds the
		1069	function (good) or runs out of packages (bad).
		1070
766	Whenever the given C<type> is used, C<push_write> will invoke the code	1071	Whenever the given C<type> is used, C<push_write> will the function with
767	reference with the handle object and the remaining arguments.	1072	the handle object and the remaining arguments.
768		1073
769	The code reference is supposed to return a single octet string that will	1074	The function is supposed to return a single octet string that will be
770	be appended to the write buffer.	1075	appended to the write buffer, so you cna mentally treat this function as a
		1076	"arguments to on-the-wire-format" converter.
771		1077
772	Note that this is a function, and all types registered this way will be	1078	Example: implement a custom write type C<join> that joins the remaining
773	global, so try to use unique names.	1079	arguments using the first one.
		1080
		1081	$handle->push_write (My::Type => " ", 1,2,3);
		1082
		1083	# uses the following package, which can be defined in the "My::Type" or in
		1084	# the "My" modules to be auto-loaded, or just about anywhere when the
		1085	# My::Type::anyevent_write_type is defined before invoking it.
		1086
		1087	package My::Type;
		1088
		1089	sub anyevent_write_type {
		1090	my ($handle, $delim, @args) = @_;
		1091
		1092	join $delim, @args
		1093	}
774		1094
775	=cut	1095	=cut
776		1096
777	#############################################################################	1097	#############################################################################
778		1098
…		…
860	=cut	1180	=cut
861		1181
862	sub _drain_rbuf {	1182	sub _drain_rbuf {
863	my ($self) = @_;	1183	my ($self) = @_;
864		1184
		1185	# avoid recursion
		1186	return if $self->{_skip_drain_rbuf};
865	local $self->{_in_drain} = 1;	1187	local $self->{_skip_drain_rbuf} = 1;
866
867	if (
868	defined $self->{rbuf_max}
869	&& $self->{rbuf_max} < length $self->{rbuf}
870	) {
871	$self->_error (&Errno::ENOSPC, 1), return;
872	}
873		1188
874	while () {	1189	while () {
875	# we need to use a separate tls read buffer, as we must not receive data while	1190	# we need to use a separate tls read buffer, as we must not receive data while
876	# we are draining the buffer, and this can only happen with TLS.	1191	# we are draining the buffer, and this can only happen with TLS.
877	$self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf};	1192	$self->{rbuf} .= delete $self->{_tls_rbuf}
		1193	if exists $self->{_tls_rbuf};
878		1194
879	my $len = length $self->{rbuf};	1195	my $len = length $self->{rbuf};
880		1196
881	if (my $cb = shift @{ $self->{_queue} }) {	1197	if (my $cb = shift @{ $self->{_queue} }) {
882	unless ($cb->($self)) {	1198	unless ($cb->($self)) {
883	if ($self->{_eof}) {	1199	# no progress can be made
884	# no progress can be made (not enough data and no data forthcoming)	1200	# (not enough data and no data forthcoming)
885	$self->_error (&Errno::EPIPE, 1), return;	1201	$self->_error (Errno::EPIPE, 1), return
886	}	1202	if $self->{_eof};
887		1203
888	unshift @{ $self->{_queue} }, $cb;	1204	unshift @{ $self->{_queue} }, $cb;
889	last;	1205	last;
890	}	1206	}
891	} elsif ($self->{on_read}) {	1207	} elsif ($self->{on_read}) {
…		…
898	&& !@{ $self->{_queue} } # and the queue is still empty	1214	&& !@{ $self->{_queue} } # and the queue is still empty
899	&& $self->{on_read} # but we still have on_read	1215	&& $self->{on_read} # but we still have on_read
900	) {	1216	) {
901	# no further data will arrive	1217	# no further data will arrive
902	# so no progress can be made	1218	# so no progress can be made
903	$self->_error (&Errno::EPIPE, 1), return	1219	$self->_error (Errno::EPIPE, 1), return
904	if $self->{_eof};	1220	if $self->{_eof};
905		1221
906	last; # more data might arrive	1222	last; # more data might arrive
907	}	1223	}
908	} else {	1224	} else {
…		…
911	last;	1227	last;
912	}	1228	}
913	}	1229	}
914		1230
915	if ($self->{_eof}) {	1231	if ($self->{_eof}) {
916	if ($self->{on_eof}) {	1232	$self->{on_eof}
917	$self->{on_eof}($self)	1233	? $self->{on_eof}($self)
918	} else {
919	$self->_error (0, 1, "Unexpected end-of-file");	1234	: $self->_error (0, 1, "Unexpected end-of-file");
920	}	1235
		1236	return;
		1237	}
		1238
		1239	if (
		1240	defined $self->{rbuf_max}
		1241	&& $self->{rbuf_max} < length $self->{rbuf}
		1242	) {
		1243	$self->_error (Errno::ENOSPC, 1), return;
921	}	1244	}
922		1245
923	# may need to restart read watcher	1246	# may need to restart read watcher
924	unless ($self->{_rw}) {	1247	unless ($self->{_rw}) {
925	$self->start_read	1248	$self->start_read
…		…
931		1254
932	This replaces the currently set C<on_read> callback, or clears it (when	1255	This replaces the currently set C<on_read> callback, or clears it (when
933	the new callback is C<undef>). See the description of C<on_read> in the	1256	the new callback is C<undef>). See the description of C<on_read> in the
934	constructor.	1257	constructor.
935		1258
		1259	This method may invoke callbacks (and therefore the handle might be
		1260	destroyed after it returns).
		1261
936	=cut	1262	=cut
937		1263
938	sub on_read {	1264	sub on_read {
939	my ($self, $cb) = @_;	1265	my ($self, $cb) = @_;
940		1266
941	$self->{on_read} = $cb;	1267	$self->{on_read} = $cb;
942	$self->_drain_rbuf if $cb && !$self->{_in_drain};	1268	$self->_drain_rbuf if $cb;
943	}	1269	}
944		1270
945	=item $handle->rbuf	1271	=item $handle->rbuf
946		1272
947	Returns the read buffer (as a modifiable lvalue).	1273	Returns the read buffer (as a modifiable lvalue).
…		…
979		1305
980	If enough data was available, then the callback must remove all data it is	1306	If enough data was available, then the callback must remove all data it is
981	interested in (which can be none at all) and return a true value. After returning	1307	interested in (which can be none at all) and return a true value. After returning
982	true, it will be removed from the queue.	1308	true, it will be removed from the queue.
983		1309
		1310	These methods may invoke callbacks (and therefore the handle might be
		1311	destroyed after it returns).
		1312
984	=cut	1313	=cut
985		1314
986	our %RH;	1315	our %RH;
987		1316
988	sub register_read_type($$) {	1317	sub register_read_type($$) {
…		…
994	my $cb = pop;	1323	my $cb = pop;
995		1324
996	if (@_) {	1325	if (@_) {
997	my $type = shift;	1326	my $type = shift;
998		1327
		1328	$cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type"
999	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	1329	or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_read")
1000	->($self, $cb, @_);	1330	->($self, $cb, @_);
1001	}	1331	}
1002		1332
1003	push @{ $self->{_queue} }, $cb;	1333	push @{ $self->{_queue} }, $cb;
1004	$self->_drain_rbuf unless $self->{_in_drain};	1334	$self->_drain_rbuf;
1005	}	1335	}
1006		1336
1007	sub unshift_read {	1337	sub unshift_read {
1008	my $self = shift;	1338	my $self = shift;
1009	my $cb = pop;	1339	my $cb = pop;
…		…
1013		1343
1014	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")	1344	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")
1015	->($self, $cb, @_);	1345	->($self, $cb, @_);
1016	}	1346	}
1017		1347
1018
1019	unshift @{ $self->{_queue} }, $cb;	1348	unshift @{ $self->{_queue} }, $cb;
1020	$self->_drain_rbuf unless $self->{_in_drain};	1349	$self->_drain_rbuf;
1021	}	1350	}
1022		1351
1023	=item $handle->push_read (type => @args, $cb)	1352	=item $handle->push_read (type => @args, $cb)
1024		1353
1025	=item $handle->unshift_read (type => @args, $cb)	1354	=item $handle->unshift_read (type => @args, $cb)
1026		1355
1027	Instead of providing a callback that parses the data itself you can chose	1356	Instead of providing a callback that parses the data itself you can chose
1028	between a number of predefined parsing formats, for chunks of data, lines	1357	between a number of predefined parsing formats, for chunks of data, lines
1029	etc.	1358	etc. You can also specify the (fully qualified) name of a package, in
		1359	which case AnyEvent tries to load the package and then expects to find the
		1360	C<anyevent_read_type> function inside (see "custom read types", below).
1030		1361
1031	Predefined types are (if you have ideas for additional types, feel free to	1362	Predefined types are (if you have ideas for additional types, feel free to
1032	drop by and tell us):	1363	drop by and tell us):
1033		1364
1034	=over 4	1365	=over 4
…		…
1158	return 1;	1489	return 1;
1159	}	1490	}
1160		1491
1161	# reject	1492	# reject
1162	if ($reject && $$rbuf =~ $reject) {	1493	if ($reject && $$rbuf =~ $reject) {
1163	$self->_error (&Errno::EBADMSG);	1494	$self->_error (Errno::EBADMSG);
1164	}	1495	}
1165		1496
1166	# skip	1497	# skip
1167	if ($skip && $$rbuf =~ $skip) {	1498	if ($skip && $$rbuf =~ $skip) {
1168	$data .= substr $$rbuf, 0, $+[0], "";	1499	$data .= substr $$rbuf, 0, $+[0], "";
…		…
1184	my ($self, $cb) = @_;	1515	my ($self, $cb) = @_;
1185		1516
1186	sub {	1517	sub {
1187	unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {	1518	unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {
1188	if ($_[0]{rbuf} =~ /[^0-9]/) {	1519	if ($_[0]{rbuf} =~ /[^0-9]/) {
1189	$self->_error (&Errno::EBADMSG);	1520	$self->_error (Errno::EBADMSG);
1190	}	1521	}
1191	return;	1522	return;
1192	}	1523	}
1193		1524
1194	my $len = $1;	1525	my $len = $1;
…		…
1197	my $string = $_[1];	1528	my $string = $_[1];
1198	$_[0]->unshift_read (chunk => 1, sub {	1529	$_[0]->unshift_read (chunk => 1, sub {
1199	if ($_[1] eq ",") {	1530	if ($_[1] eq ",") {
1200	$cb->($_[0], $string);	1531	$cb->($_[0], $string);
1201	} else {	1532	} else {
1202	$self->_error (&Errno::EBADMSG);	1533	$self->_error (Errno::EBADMSG);
1203	}	1534	}
1204	});	1535	});
1205	});	1536	});
1206		1537
1207	1	1538	1
…		…
1274	=cut	1605	=cut
1275		1606
1276	register_read_type json => sub {	1607	register_read_type json => sub {
1277	my ($self, $cb) = @_;	1608	my ($self, $cb) = @_;
1278		1609
1279	my $json = $self->{json} ||=	1610	my $json = $self->{json} ||= json_coder;
1280	eval { require JSON::XS; JSON::XS->new->utf8 }
1281	|| do { require JSON; JSON->new->utf8 };
1282		1611
1283	my $data;	1612	my $data;
1284	my $rbuf = \$self->{rbuf};	1613	my $rbuf = \$self->{rbuf};
1285		1614
1286	sub {	1615	sub {
…		…
1297	$json->incr_skip;	1626	$json->incr_skip;
1298		1627
1299	$self->{rbuf} = $json->incr_text;	1628	$self->{rbuf} = $json->incr_text;
1300	$json->incr_text = "";	1629	$json->incr_text = "";
1301		1630
1302	$self->_error (&Errno::EBADMSG);	1631	$self->_error (Errno::EBADMSG);
1303		1632
1304	()	1633	()
1305	} else {	1634	} else {
1306	$self->{rbuf} = "";	1635	$self->{rbuf} = "";
1307		1636
…		…
1344	# read remaining chunk	1673	# read remaining chunk
1345	$_[0]->unshift_read (chunk => $len, sub {	1674	$_[0]->unshift_read (chunk => $len, sub {
1346	if (my $ref = eval { Storable::thaw ($_[1]) }) {	1675	if (my $ref = eval { Storable::thaw ($_[1]) }) {
1347	$cb->($_[0], $ref);	1676	$cb->($_[0], $ref);
1348	} else {	1677	} else {
1349	$self->_error (&Errno::EBADMSG);	1678	$self->_error (Errno::EBADMSG);
1350	}	1679	}
1351	});	1680	});
1352	}	1681	}
1353		1682
1354	1	1683	1
1355	}	1684	}
1356	};	1685	};
1357		1686
1358	=back	1687	=back
1359		1688
1360	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)	1689	=item custom read types - Package::anyevent_read_type $handle, $cb, @args
1361		1690
1362	This function (not method) lets you add your own types to C<push_read>.	1691	Instead of one of the predefined types, you can also specify the name
		1692	of a package. AnyEvent will try to load the package and then expects to
		1693	find a function named C<anyevent_read_type> inside. If it isn't found, it
		1694	progressively tries to load the parent package until it either finds the
		1695	function (good) or runs out of packages (bad).
1363		1696
1364	Whenever the given C<type> is used, C<push_read> will invoke the code	1697	Whenever this type is used, C<push_read> will invoke the function with the
1365	reference with the handle object, the callback and the remaining	1698	handle object, the original callback and the remaining arguments.
1366	arguments.
1367		1699
1368	The code reference is supposed to return a callback (usually a closure)	1700	The function is supposed to return a callback (usually a closure) that
1369	that works as a plain read callback (see C<< ->push_read ($cb) >>).	1701	works as a plain read callback (see C<< ->push_read ($cb) >>), so you can
		1702	mentally treat the function as a "configurable read type to read callback"
		1703	converter.
1370		1704
1371	It should invoke the passed callback when it is done reading (remember to	1705	It should invoke the original callback when it is done reading (remember
1372	pass C<$handle> as first argument as all other callbacks do that).	1706	to pass C<$handle> as first argument as all other callbacks do that,
		1707	although there is no strict requirement on this).
1373		1708
1374	Note that this is a function, and all types registered this way will be
1375	global, so try to use unique names.
1376
1377	For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>,	1709	For examples, see the source of this module (F<perldoc -m
1378	search for C<register_read_type>)).	1710	AnyEvent::Handle>, search for C<register_read_type>)).
1379		1711
1380	=item $handle->stop_read	1712	=item $handle->stop_read
1381		1713
1382	=item $handle->start_read	1714	=item $handle->start_read
1383		1715
…		…
1403	}	1735	}
1404		1736
1405	sub start_read {	1737	sub start_read {
1406	my ($self) = @_;	1738	my ($self) = @_;
1407		1739
1408	unless ($self->{_rw} || $self->{_eof}) {	1740	unless ($self->{_rw} || $self->{_eof} || !$self->{fh}) {
1409	Scalar::Util::weaken $self;	1741	Scalar::Util::weaken $self;
1410		1742
1411	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1743	$self->{_rw} = AE::io $self->{fh}, 0, sub {
1412	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});	1744	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1413	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf;	1745	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf;
1414		1746
1415	if ($len > 0) {	1747	if ($len > 0) {
1416	$self->{_activity} = AnyEvent->now;	1748	$self->{_activity} = $self->{_ractivity} = AE::now;
1417		1749
1418	if ($self->{tls}) {	1750	if ($self->{tls}) {
1419	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);	1751	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1420		1752
1421	&_dotls ($self);	1753	&_dotls ($self);
1422	} else {	1754	} else {
1423	$self->_drain_rbuf unless $self->{_in_drain};	1755	$self->_drain_rbuf;
1424	}	1756	}
1425		1757
1426	} elsif (defined $len) {	1758	} elsif (defined $len) {
1427	delete $self->{_rw};	1759	delete $self->{_rw};
1428	$self->{_eof} = 1;	1760	$self->{_eof} = 1;
1429	$self->_drain_rbuf unless $self->{_in_drain};	1761	$self->_drain_rbuf;
1430		1762
1431	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1763	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1432	return $self->_error ($!, 1);	1764	return $self->_error ($!, 1);
1433	}	1765	}
1434	});	1766	};
1435	}	1767	}
1436	}	1768	}
1437		1769
1438	our $ERROR_SYSCALL;	1770	our $ERROR_SYSCALL;
1439	our $ERROR_WANT_READ;	1771	our $ERROR_WANT_READ;
…		…
1452	if ($self->{_on_starttls}) {	1784	if ($self->{_on_starttls}) {
1453	(delete $self->{_on_starttls})->($self, undef, $err);	1785	(delete $self->{_on_starttls})->($self, undef, $err);
1454	&_freetls;	1786	&_freetls;
1455	} else {	1787	} else {
1456	&_freetls;	1788	&_freetls;
1457	$self->_error (&Errno::EPROTO, 1, $err);	1789	$self->_error (Errno::EPROTO, 1, $err);
1458	}	1790	}
1459	}	1791	}
1460		1792
1461	# poll the write BIO and send the data if applicable	1793	# poll the write BIO and send the data if applicable
1462	# also decode read data if possible	1794	# also decode read data if possible
…		…
1494	$self->{_eof} = 1;	1826	$self->{_eof} = 1;
1495	}	1827	}
1496	}	1828	}
1497		1829
1498	$self->{_tls_rbuf} .= $tmp;	1830	$self->{_tls_rbuf} .= $tmp;
1499	$self->_drain_rbuf unless $self->{_in_drain};	1831	$self->_drain_rbuf;
1500	$self->{tls} or return; # tls session might have gone away in callback	1832	$self->{tls} or return; # tls session might have gone away in callback
1501	}	1833	}
1502		1834
1503	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);	1835	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1504	return $self->_tls_error ($tmp)	1836	return $self->_tls_error ($tmp)
…		…
1506	&& ($tmp != $ERROR_SYSCALL || $!);	1838	&& ($tmp != $ERROR_SYSCALL || $!);
1507		1839
1508	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1840	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1509	$self->{wbuf} .= $tmp;	1841	$self->{wbuf} .= $tmp;
1510	$self->_drain_wbuf;	1842	$self->_drain_wbuf;
		1843	$self->{tls} or return; # tls session might have gone away in callback
1511	}	1844	}
1512		1845
1513	$self->{_on_starttls}	1846	$self->{_on_starttls}
1514	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()	1847	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
1515	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");	1848	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");
…		…
1518	=item $handle->starttls ($tls[, $tls_ctx])	1851	=item $handle->starttls ($tls[, $tls_ctx])
1519		1852
1520	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	1853	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
1521	object is created, you can also do that at a later time by calling	1854	object is created, you can also do that at a later time by calling
1522	C<starttls>.	1855	C<starttls>.
		1856
		1857	Starting TLS is currently an asynchronous operation - when you push some
		1858	write data and then call C<< ->starttls >> then TLS negotiation will start
		1859	immediately, after which the queued write data is then sent.
1523		1860
1524	The first argument is the same as the C<tls> constructor argument (either	1861	The first argument is the same as the C<tls> constructor argument (either
1525	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1862	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1526		1863
1527	The second argument is the optional C<AnyEvent::TLS> object that is used	1864	The second argument is the optional C<AnyEvent::TLS> object that is used
…		…
1532	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS	1869	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS
1533	context in C<< $handle->{tls_ctx} >> after this call and can be used or	1870	context in C<< $handle->{tls_ctx} >> after this call and can be used or
1534	changed to your liking. Note that the handshake might have already started	1871	changed to your liking. Note that the handshake might have already started
1535	when this function returns.	1872	when this function returns.
1536		1873
1537	If it an error to start a TLS handshake more than once per	1874	Due to bugs in OpenSSL, it might or might not be possible to do multiple
1538	AnyEvent::Handle object (this is due to bugs in OpenSSL).	1875	handshakes on the same stream. Best do not attempt to use the stream after
		1876	stopping TLS.
		1877
		1878	This method may invoke callbacks (and therefore the handle might be
		1879	destroyed after it returns).
1539		1880
1540	=cut	1881	=cut
1541		1882
1542	our %TLS_CACHE; #TODO not yet documented, should we?	1883	our %TLS_CACHE; #TODO not yet documented, should we?
1543		1884
1544	sub starttls {	1885	sub starttls {
1545	my ($self, $ssl, $ctx) = @_;	1886	my ($self, $tls, $ctx) = @_;
		1887
		1888	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"
		1889	if $self->{tls};
		1890
		1891	$self->{tls} = $tls;
		1892	$self->{tls_ctx} = $ctx if @_ > 2;
		1893
		1894	return unless $self->{fh};
1546		1895
1547	require Net::SSLeay;	1896	require Net::SSLeay;
1548
1549	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"
1550	if $self->{tls};
1551		1897
1552	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();	1898	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1553	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();	1899	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1554		1900
		1901	$tls = delete $self->{tls};
1555	$ctx ||= $self->{tls_ctx};	1902	$ctx = $self->{tls_ctx};
		1903
		1904	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
1556		1905
1557	if ("HASH" eq ref $ctx) {	1906	if ("HASH" eq ref $ctx) {
1558	require AnyEvent::TLS;	1907	require AnyEvent::TLS;
1559
1560	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context
1561		1908
1562	if ($ctx->{cache}) {	1909	if ($ctx->{cache}) {
1563	my $key = $ctx+0;	1910	my $key = $ctx+0;
1564	$ctx = $TLS_CACHE{$key} ||= new AnyEvent::TLS %$ctx;	1911	$ctx = $TLS_CACHE{$key} ||= new AnyEvent::TLS %$ctx;
1565	} else {	1912	} else {
1566	$ctx = new AnyEvent::TLS %$ctx;	1913	$ctx = new AnyEvent::TLS %$ctx;
1567	}	1914	}
1568	}	1915	}
1569		1916
1570	$self->{tls_ctx} = $ctx || TLS_CTX ();	1917	$self->{tls_ctx} = $ctx || TLS_CTX ();
1571	$self->{tls} = $ssl = $self->{tls_ctx}->_get_session ($ssl, $self, $self->{peername});	1918	$self->{tls} = $tls = $self->{tls_ctx}->_get_session ($tls, $self, $self->{peername});
1572		1919
1573	# basically, this is deep magic (because SSL_read should have the same issues)	1920	# basically, this is deep magic (because SSL_read should have the same issues)
1574	# but the openssl maintainers basically said: "trust us, it just works".	1921	# but the openssl maintainers basically said: "trust us, it just works".
1575	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1922	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1576	# and mismaintained ssleay-module doesn't even offer them).	1923	# and mismaintained ssleay-module doesn't even offer them).
…		…
1583	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to	1930	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
1584	# have identity issues in that area.	1931	# have identity issues in that area.
1585	# Net::SSLeay::CTX_set_mode ($ssl,	1932	# Net::SSLeay::CTX_set_mode ($ssl,
1586	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)	1933	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)
1587	# | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));	1934	# | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));
1588	Net::SSLeay::CTX_set_mode ($ssl, 1|2);	1935	Net::SSLeay::CTX_set_mode ($tls, 1|2);
1589		1936
1590	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1937	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1591	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1938	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1592		1939
		1940	Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf});
		1941
1593	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1942	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
1594		1943
1595	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }	1944	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1596	if $self->{on_starttls};	1945	if $self->{on_starttls};
1597		1946
1598	&_dotls; # need to trigger the initial handshake	1947	&_dotls; # need to trigger the initial handshake
…		…
1601		1950
1602	=item $handle->stoptls	1951	=item $handle->stoptls
1603		1952
1604	Shuts down the SSL connection - this makes a proper EOF handshake by	1953	Shuts down the SSL connection - this makes a proper EOF handshake by
1605	sending a close notify to the other side, but since OpenSSL doesn't	1954	sending a close notify to the other side, but since OpenSSL doesn't
1606	support non-blocking shut downs, it is not possible to re-use the stream	1955	support non-blocking shut downs, it is not guaranteed that you can re-use
1607	afterwards.	1956	the stream afterwards.
		1957
		1958	This method may invoke callbacks (and therefore the handle might be
		1959	destroyed after it returns).
1608		1960
1609	=cut	1961	=cut
1610		1962
1611	sub stoptls {	1963	sub stoptls {
1612	my ($self) = @_;	1964	my ($self) = @_;
1613		1965
1614	if ($self->{tls}) {	1966	if ($self->{tls} && $self->{fh}) {
1615	Net::SSLeay::shutdown ($self->{tls});	1967	Net::SSLeay::shutdown ($self->{tls});
1616		1968
1617	&_dotls;	1969	&_dotls;
1618		1970
1619	# # we don't give a shit. no, we do, but we can't. no...#d#	1971	# # we don't give a shit. no, we do, but we can't. no...#d#
…		…
1625	sub _freetls {	1977	sub _freetls {
1626	my ($self) = @_;	1978	my ($self) = @_;
1627		1979
1628	return unless $self->{tls};	1980	return unless $self->{tls};
1629		1981
1630	$self->{tls_ctx}->_put_session (delete $self->{tls});	1982	$self->{tls_ctx}->_put_session (delete $self->{tls})
		1983	if $self->{tls} > 0;
1631		1984
1632	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};	1985	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1633	}	1986	}
1634		1987
1635	sub DESTROY {	1988	sub DESTROY {
…		…
1637		1990
1638	&_freetls;	1991	&_freetls;
1639		1992
1640	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	1993	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1641		1994
1642	if ($linger && length $self->{wbuf}) {	1995	if ($linger && length $self->{wbuf} && $self->{fh}) {
1643	my $fh = delete $self->{fh};	1996	my $fh = delete $self->{fh};
1644	my $wbuf = delete $self->{wbuf};	1997	my $wbuf = delete $self->{wbuf};
1645		1998
1646	my @linger;	1999	my @linger;
1647		2000
1648	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {	2001	push @linger, AE::io $fh, 1, sub {
1649	my $len = syswrite $fh, $wbuf, length $wbuf;	2002	my $len = syswrite $fh, $wbuf, length $wbuf;
1650		2003
1651	if ($len > 0) {	2004	if ($len > 0) {
1652	substr $wbuf, 0, $len, "";	2005	substr $wbuf, 0, $len, "";
1653	} else {	2006	} else {
1654	@linger = (); # end	2007	@linger = (); # end
1655	}	2008	}
1656	});	2009	};
1657	push @linger, AnyEvent->timer (after => $linger, cb => sub {	2010	push @linger, AE::timer $linger, 0, sub {
1658	@linger = ();	2011	@linger = ();
1659	});	2012	};
1660	}	2013	}
1661	}	2014	}
1662		2015
1663	=item $handle->destroy	2016	=item $handle->destroy
1664		2017
1665	Shuts down the handle object as much as possible - this call ensures that	2018	Shuts down the handle object as much as possible - this call ensures that
1666	no further callbacks will be invoked and as many resources as possible	2019	no further callbacks will be invoked and as many resources as possible
1667	will be freed. You must not call any methods on the object afterwards.	2020	will be freed. Any method you will call on the handle object after
		2021	destroying it in this way will be silently ignored (and it will return the
		2022	empty list).
1668		2023
1669	Normally, you can just "forget" any references to an AnyEvent::Handle	2024	Normally, you can just "forget" any references to an AnyEvent::Handle
1670	object and it will simply shut down. This works in fatal error and EOF	2025	object and it will simply shut down. This works in fatal error and EOF
1671	callbacks, as well as code outside. It does I<NOT> work in a read or write	2026	callbacks, as well as code outside. It does I<NOT> work in a read or write
1672	callback, so when you want to destroy the AnyEvent::Handle object from	2027	callback, so when you want to destroy the AnyEvent::Handle object from
1673	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in	2028	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
1674	that case.	2029	that case.
1675		2030
		2031	Destroying the handle object in this way has the advantage that callbacks
		2032	will be removed as well, so if those are the only reference holders (as
		2033	is common), then one doesn't need to do anything special to break any
		2034	reference cycles.
		2035
1676	The handle might still linger in the background and write out remaining	2036	The handle might still linger in the background and write out remaining
1677	data, as specified by the C<linger> option, however.	2037	data, as specified by the C<linger> option, however.
1678		2038
1679	=cut	2039	=cut
1680		2040
1681	sub destroy {	2041	sub destroy {
1682	my ($self) = @_;	2042	my ($self) = @_;
1683		2043
1684	$self->DESTROY;	2044	$self->DESTROY;
1685	%$self = ();	2045	%$self = ();
		2046	bless $self, "AnyEvent::Handle::destroyed";
1686	}	2047	}
		2048
		2049	sub AnyEvent::Handle::destroyed::AUTOLOAD {
		2050	#nop
		2051	}
		2052
		2053	=item $handle->destroyed
		2054
		2055	Returns false as long as the handle hasn't been destroyed by a call to C<<
		2056	->destroy >>, true otherwise.
		2057
		2058	Can be useful to decide whether the handle is still valid after some
		2059	callback possibly destroyed the handle. For example, C<< ->push_write >>,
		2060	C<< ->starttls >> and other methods can call user callbacks, which in turn
		2061	can destroy the handle, so work can be avoided by checking sometimes:
		2062
		2063	$hdl->starttls ("accept");
		2064	return if $hdl->destroyed;
		2065	$hdl->push_write (...
		2066
		2067	Note that the call to C<push_write> will silently be ignored if the handle
		2068	has been destroyed, so often you can just ignore the possibility of the
		2069	handle being destroyed.
		2070
		2071	=cut
		2072
		2073	sub destroyed { 0 }
		2074	sub AnyEvent::Handle::destroyed::destroyed { 1 }
1687		2075
1688	=item AnyEvent::Handle::TLS_CTX	2076	=item AnyEvent::Handle::TLS_CTX
1689		2077
1690	This function creates and returns the AnyEvent::TLS object used by default	2078	This function creates and returns the AnyEvent::TLS object used by default
1691	for TLS mode.	2079	for TLS mode.
…		…
1747		2135
1748	$handle->on_read (sub { });	2136	$handle->on_read (sub { });
1749	$handle->on_eof (undef);	2137	$handle->on_eof (undef);
1750	$handle->on_error (sub {	2138	$handle->on_error (sub {
1751	my $data = delete $_[0]{rbuf};	2139	my $data = delete $_[0]{rbuf};
1752	undef $handle;
1753	});	2140	});
1754		2141
1755	The reason to use C<on_error> is that TCP connections, due to latencies	2142	The reason to use C<on_error> is that TCP connections, due to latencies
1756	and packets loss, might get closed quite violently with an error, when in	2143	and packets loss, might get closed quite violently with an error, when in
1757	fact, all data has been received.	2144	fact, all data has been received.

Diff Legend

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