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.140 by root, Mon Jul 6 00:45:00 2009 UTC vs.
Revision 1.197 by root, Tue Aug 31 00:59:55 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.452;
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	You can also call C<< ->push_read (...) >> or any other function that
		198	modifies the read queue. Or do both. Or ...
		199
		200	When an EOF condition is detected then AnyEvent::Handle will first try to
		201	feed all the remaining data to the queued callbacks and C<on_read> before
		202	calling the C<on_eof> callback. If no progress can be made, then a fatal
		203	error will be raised (with C<$!> set to C<EPIPE>).
		204
		205	Note that, unlike requests in the read queue, an C<on_read> callback
		206	doesn't mean you I<require> some data: if there is an EOF and there
		207	are outstanding read requests then an error will be flagged. With an
		208	C<on_read> callback, the C<on_eof> callback will be invoked.
		209
82	=item on_eof => $cb->($handle)	210	=item on_eof => $cb->($handle)
83		211
84	Set the callback to be called when an end-of-file condition is detected,	212	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	213	i.e. in the case of a socket, when the other side has closed the
86	connection cleanly.	214	connection cleanly, and there are no outstanding read requests in the
		215	queue (if there are read requests, then an EOF counts as an unexpected
		216	connection close and will be flagged as an error).
87		217
88	For sockets, this just means that the other side has stopped sending data,	218	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	219	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	220	callback and continue writing data, as only the read part has been shut
91	down.	221	down.
92		222
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	223	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>.	224	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		225
147	=item on_drain => $cb->($handle)	226	=item on_drain => $cb->($handle)
148		227
149	This sets the callback that is called when the write buffer becomes empty	228	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).	229	(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	236	memory and push it into the queue, but instead only read more data from
158	the file when the write queue becomes empty.	237	the file when the write queue becomes empty.
159		238
160	=item timeout => $fractional_seconds	239	=item timeout => $fractional_seconds
161		240
		241	=item rtimeout => $fractional_seconds
		242
		243	=item wtimeout => $fractional_seconds
		244
162	If non-zero, then this enables an "inactivity" timeout: whenever this many	245	If non-zero, then these enables an "inactivity" timeout: whenever this
163	seconds pass without a successful read or write on the underlying file	246	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	247	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).	248	will be invoked (and if that one is missing, a non-fatal C<ETIMEDOUT>
		249	error will be raised).
		250
		251	There are three variants of the timeouts that work fully independent
		252	of each other, for both read and write, just read, and just write:
		253	C<timeout>, C<rtimeout> and C<wtimeout>, with corresponding callbacks
		254	C<on_timeout>, C<on_rtimeout> and C<on_wtimeout>, and reset functions
		255	C<timeout_reset>, C<rtimeout_reset>, and C<wtimeout_reset>.
166		256
167	Note that timeout processing is also active when you currently do not have	257	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	258	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	259	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	260	in the C<on_timeout> callback, in which case AnyEvent::Handle will simply
…		…
214	accomplishd by setting this option to a true value.	304	accomplishd by setting this option to a true value.
215		305
216	The default is your opertaing system's default behaviour (most likely	306	The default is your opertaing system's default behaviour (most likely
217	enabled), this option explicitly enables or disables it, if possible.	307	enabled), this option explicitly enables or disables it, if possible.
218		308
		309	=item keepalive => <boolean>
		310
		311	Enables (default disable) the SO_KEEPALIVE option on the stream socket:
		312	normally, TCP connections have no time-out once established, so TCP
		313	connections, once established, can stay alive forever even when the other
		314	side has long gone. TCP keepalives are a cheap way to take down long-lived
		315	TCP connections whent he other side becomes unreachable. While the default
		316	is OS-dependent, TCP keepalives usually kick in after around two hours,
		317	and, if the other side doesn't reply, take down the TCP connection some 10
		318	to 15 minutes later.
		319
		320	It is harmless to specify this option for file handles that do not support
		321	keepalives, and enabling it on connections that are potentially long-lived
		322	is usually a good idea.
		323
		324	=item oobinline => <boolean>
		325
		326	BSD majorly fucked up the implementation of TCP urgent data. The result
		327	is that almost no OS implements TCP according to the specs, and every OS
		328	implements it slightly differently.
		329
		330	If you want to handle TCP urgent data, then setting this flag (the default
		331	is enabled) gives you the most portable way of getting urgent data, by
		332	putting it into the stream.
		333
		334	Since BSD emulation of OOB data on top of TCP's urgent data can have
		335	security implications, AnyEvent::Handle sets this flag automatically
		336	unless explicitly specified. Note that setting this flag after
		337	establishing a connection I<may> be a bit too late (data loss could
		338	already have occured on BSD systems), but at least it will protect you
		339	from most attacks.
		340
219	=item read_size => <bytes>	341	=item read_size => <bytes>
220		342
221	The default read block size (the amount of bytes this module will	343	The default read block size (the amount of bytes this module will
222	try to read during each loop iteration, which affects memory	344	try to read during each loop iteration, which affects memory
223	requirements). Default: C<8192>.	345	requirements). Default: C<8192>.
…		…
249		371
250	A string used to identify the remote site - usually the DNS hostname	372	A string used to identify the remote site - usually the DNS hostname
251	(I<not> IDN!) used to create the connection, rarely the IP address.	373	(I<not> IDN!) used to create the connection, rarely the IP address.
252		374
253	Apart from being useful in error messages, this string is also used in TLS	375	Apart from being useful in error messages, this string is also used in TLS
254	peername verification (see C<verify_peername> in L<AnyEvent::TLS>).	376	peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This
		377	verification will be skipped when C<peername> is not specified or
		378	C<undef>.
255		379
256	=item tls => "accept" | "connect" | Net::SSLeay::SSL object	380	=item tls => "accept" | "connect" | Net::SSLeay::SSL object
257		381
258	When this parameter is given, it enables TLS (SSL) mode, that means	382	When this parameter is given, it enables TLS (SSL) mode, that means
259	AnyEvent will start a TLS handshake as soon as the conenction has been	383	AnyEvent will start a TLS handshake as soon as the connection has been
260	established and will transparently encrypt/decrypt data afterwards.	384	established and will transparently encrypt/decrypt data afterwards.
261		385
262	All TLS protocol errors will be signalled as C<EPROTO>, with an	386	All TLS protocol errors will be signalled as C<EPROTO>, with an
263	appropriate error message.	387	appropriate error message.
264		388
…		…
296		420
297	Instead of an object, you can also specify a hash reference with C<< key	421	Instead of an object, you can also specify a hash reference with C<< key
298	=> value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a	422	=> value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a
299	new TLS context object.	423	new TLS context object.
300		424
		425	=item on_starttls => $cb->($handle, $success[, $error_message])
		426
		427	This callback will be invoked when the TLS/SSL handshake has finished. If
		428	C<$success> is true, then the TLS handshake succeeded, otherwise it failed
		429	(C<on_stoptls> will not be called in this case).
		430
		431	The session in C<< $handle->{tls} >> can still be examined in this
		432	callback, even when the handshake was not successful.
		433
		434	TLS handshake failures will not cause C<on_error> to be invoked when this
		435	callback is in effect, instead, the error message will be passed to C<on_starttls>.
		436
		437	Without this callback, handshake failures lead to C<on_error> being
		438	called, as normal.
		439
		440	Note that you cannot call C<starttls> right again in this callback. If you
		441	need to do that, start an zero-second timer instead whose callback can
		442	then call C<< ->starttls >> again.
		443
		444	=item on_stoptls => $cb->($handle)
		445
		446	When a SSLv3/TLS shutdown/close notify/EOF is detected and this callback is
		447	set, then it will be invoked after freeing the TLS session. If it is not,
		448	then a TLS shutdown condition will be treated like a normal EOF condition
		449	on the handle.
		450
		451	The session in C<< $handle->{tls} >> can still be examined in this
		452	callback.
		453
		454	This callback will only be called on TLS shutdowns, not when the
		455	underlying handle signals EOF.
		456
301	=item json => JSON or JSON::XS object	457	=item json => JSON or JSON::XS object
302		458
303	This is the json coder object used by the C<json> read and write types.	459	This is the json coder object used by the C<json> read and write types.
304		460
305	If you don't supply it, then AnyEvent::Handle will create and use a	461	If you don't supply it, then AnyEvent::Handle will create and use a
…		…
315		471
316	sub new {	472	sub new {
317	my $class = shift;	473	my $class = shift;
318	my $self = bless { @_ }, $class;	474	my $self = bless { @_ }, $class;
319		475
320	$self->{fh} or Carp::croak "mandatory argument fh is missing";	476	if ($self->{fh}) {
		477	$self->_start;
		478	return unless $self->{fh}; # could be gone by now
		479
		480	} elsif ($self->{connect}) {
		481	require AnyEvent::Socket;
		482
		483	$self->{peername} = $self->{connect}[0]
		484	unless exists $self->{peername};
		485
		486	$self->{_skip_drain_rbuf} = 1;
		487
		488	{
		489	Scalar::Util::weaken (my $self = $self);
		490
		491	$self->{_connect} =
		492	AnyEvent::Socket::tcp_connect (
		493	$self->{connect}[0],
		494	$self->{connect}[1],
		495	sub {
		496	my ($fh, $host, $port, $retry) = @_;
		497
		498	if ($fh) {
		499	$self->{fh} = $fh;
		500
		501	delete $self->{_skip_drain_rbuf};
		502	$self->_start;
		503
		504	$self->{on_connect}
		505	and $self->{on_connect}($self, $host, $port, sub {
		506	delete @$self{qw(fh _tw _rtw _wtw _ww _rw _eof _queue rbuf _wbuf tls _tls_rbuf _tls_wbuf)};
		507	$self->{_skip_drain_rbuf} = 1;
		508	&$retry;
		509	});
		510
		511	} else {
		512	if ($self->{on_connect_error}) {
		513	$self->{on_connect_error}($self, "$!");
		514	$self->destroy;
		515	} else {
		516	$self->_error ($!, 1);
		517	}
		518	}
		519	},
		520	sub {
		521	local $self->{fh} = $_[0];
		522
		523	$self->{on_prepare}
		524	? $self->{on_prepare}->($self)
		525	: ()
		526	}
		527	);
		528	}
		529
		530	} else {
		531	Carp::croak "AnyEvent::Handle: either an existing fh or the connect parameter must be specified";
		532	}
		533
		534	$self
		535	}
		536
		537	sub _start {
		538	my ($self) = @_;
		539
		540	# too many clueless people try to use udp and similar sockets
		541	# with AnyEvent::Handle, do them a favour.
		542	my $type = getsockopt $self->{fh}, Socket::SOL_SOCKET (), Socket::SO_TYPE ();
		543	Carp::croak "AnyEvent::Handle: only stream sockets supported, anything else will NOT work!"
		544	if Socket::SOCK_STREAM () != (unpack "I", $type) && defined $type;
321		545
322	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	546	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
323		547
		548	$self->{_activity} =
		549	$self->{_ractivity} =
324	$self->{_activity} = AnyEvent->now;	550	$self->{_wactivity} = AE::now;
325	$self->_timeout;
326		551
		552	$self->timeout (delete $self->{timeout} ) if $self->{timeout};
		553	$self->rtimeout (delete $self->{rtimeout} ) if $self->{rtimeout};
		554	$self->wtimeout (delete $self->{wtimeout} ) if $self->{wtimeout};
		555
327	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};	556	$self->no_delay (delete $self->{no_delay} ) if exists $self->{no_delay} && $self->{no_delay};
		557	$self->keepalive (delete $self->{keepalive}) if exists $self->{keepalive} && $self->{keepalive};
328		558
		559	$self->oobinline (exists $self->{oobinline} ? delete $self->{oobinline} : 1);
		560
329	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})	561	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
330	if $self->{tls};	562	if $self->{tls};
331		563
332	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};	564	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
333		565
334	$self->start_read	566	$self->start_read
335	if $self->{on_read};	567	if $self->{on_read} || @{ $self->{_queue} };
336		568
337	$self->{fh} && $self	569	$self->_drain_wbuf;
338	}
339
340	sub _shutdown {
341	my ($self) = @_;
342
343	delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)};
344	$self->{_eof} = 1; # tell starttls et. al to stop trying
345
346	&_freetls;
347	}	570	}
348		571
349	sub _error {	572	sub _error {
350	my ($self, $errno, $fatal, $message) = @_;	573	my ($self, $errno, $fatal, $message) = @_;
351		574
352	$self->_shutdown
353	if $fatal;
354
355	$! = $errno;	575	$! = $errno;
356	$message ||= "$!";	576	$message ||= "$!";
357		577
358	if ($self->{on_error}) {	578	if ($self->{on_error}) {
359	$self->{on_error}($self, $fatal, $message);	579	$self->{on_error}($self, $fatal, $message);
360	} elsif ($self->{fh}) {	580	$self->destroy if $fatal;
		581	} elsif ($self->{fh} || $self->{connect}) {
		582	$self->destroy;
361	Carp::croak "AnyEvent::Handle uncaught error: $message";	583	Carp::croak "AnyEvent::Handle uncaught error: $message";
362	}	584	}
363	}	585	}
364		586
365	=item $fh = $handle->fh	587	=item $fh = $handle->fh
…		…
390	$_[0]{on_eof} = $_[1];	612	$_[0]{on_eof} = $_[1];
391	}	613	}
392		614
393	=item $handle->on_timeout ($cb)	615	=item $handle->on_timeout ($cb)
394		616
395	Replace the current C<on_timeout> callback, or disables the callback (but	617	=item $handle->on_rtimeout ($cb)
396	not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
397	argument and method.
398		618
399	=cut	619	=item $handle->on_wtimeout ($cb)
400		620
401	sub on_timeout {	621	Replace the current C<on_timeout>, C<on_rtimeout> or C<on_wtimeout>
402	$_[0]{on_timeout} = $_[1];	622	callback, or disables the callback (but not the timeout) if C<$cb> =
403	}	623	C<undef>. See the C<timeout> constructor argument and method.
		624
		625	=cut
		626
		627	# see below
404		628
405	=item $handle->autocork ($boolean)	629	=item $handle->autocork ($boolean)
406		630
407	Enables or disables the current autocork behaviour (see C<autocork>	631	Enables or disables the current autocork behaviour (see C<autocork>
408	constructor argument). Changes will only take effect on the next write.	632	constructor argument). Changes will only take effect on the next write.
…		…
423	sub no_delay {	647	sub no_delay {
424	$_[0]{no_delay} = $_[1];	648	$_[0]{no_delay} = $_[1];
425		649
426	eval {	650	eval {
427	local $SIG{__DIE__};	651	local $SIG{__DIE__};
428	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];	652	setsockopt $_[0]{fh}, Socket::IPPROTO_TCP (), Socket::TCP_NODELAY (), int $_[1]
		653	if $_[0]{fh};
429	};	654	};
430	}	655	}
431		656
		657	=item $handle->keepalive ($boolean)
		658
		659	Enables or disables the C<keepalive> setting (see constructor argument of
		660	the same name for details).
		661
		662	=cut
		663
		664	sub keepalive {
		665	$_[0]{keepalive} = $_[1];
		666
		667	eval {
		668	local $SIG{__DIE__};
		669	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
		670	if $_[0]{fh};
		671	};
		672	}
		673
		674	=item $handle->oobinline ($boolean)
		675
		676	Enables or disables the C<oobinline> setting (see constructor argument of
		677	the same name for details).
		678
		679	=cut
		680
		681	sub oobinline {
		682	$_[0]{oobinline} = $_[1];
		683
		684	eval {
		685	local $SIG{__DIE__};
		686	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_OOBINLINE (), int $_[1]
		687	if $_[0]{fh};
		688	};
		689	}
		690
		691	=item $handle->keepalive ($boolean)
		692
		693	Enables or disables the C<keepalive> setting (see constructor argument of
		694	the same name for details).
		695
		696	=cut
		697
		698	sub keepalive {
		699	$_[0]{keepalive} = $_[1];
		700
		701	eval {
		702	local $SIG{__DIE__};
		703	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
		704	if $_[0]{fh};
		705	};
		706	}
		707
		708	=item $handle->on_starttls ($cb)
		709
		710	Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument).
		711
		712	=cut
		713
		714	sub on_starttls {
		715	$_[0]{on_starttls} = $_[1];
		716	}
		717
		718	=item $handle->on_stoptls ($cb)
		719
		720	Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).
		721
		722	=cut
		723
		724	sub on_stoptls {
		725	$_[0]{on_stoptls} = $_[1];
		726	}
		727
		728	=item $handle->rbuf_max ($max_octets)
		729
		730	Configures the C<rbuf_max> setting (C<undef> disables it).
		731
		732	=cut
		733
		734	sub rbuf_max {
		735	$_[0]{rbuf_max} = $_[1];
		736	}
		737
432	#############################################################################	738	#############################################################################
433		739
434	=item $handle->timeout ($seconds)	740	=item $handle->timeout ($seconds)
435		741
		742	=item $handle->rtimeout ($seconds)
		743
		744	=item $handle->wtimeout ($seconds)
		745
436	Configures (or disables) the inactivity timeout.	746	Configures (or disables) the inactivity timeout.
437		747
438	=cut	748	=item $handle->timeout_reset
439		749
440	sub timeout {	750	=item $handle->rtimeout_reset
		751
		752	=item $handle->wtimeout_reset
		753
		754	Reset the activity timeout, as if data was received or sent.
		755
		756	These methods are cheap to call.
		757
		758	=cut
		759
		760	for my $dir ("", "r", "w") {
		761	my $timeout = "${dir}timeout";
		762	my $tw = "_${dir}tw";
		763	my $on_timeout = "on_${dir}timeout";
		764	my $activity = "_${dir}activity";
		765	my $cb;
		766
		767	*$on_timeout = sub {
		768	$_[0]{$on_timeout} = $_[1];
		769	};
		770
		771	*$timeout = sub {
441	my ($self, $timeout) = @_;	772	my ($self, $new_value) = @_;
442		773
443	$self->{timeout} = $timeout;	774	$self->{$timeout} = $new_value;
444	$self->_timeout;	775	delete $self->{$tw}; &$cb;
445	}	776	};
446		777
		778	*{"${dir}timeout_reset"} = sub {
		779	$_[0]{$activity} = AE::now;
		780	};
		781
		782	# main workhorse:
447	# reset the timeout watcher, as neccessary	783	# reset the timeout watcher, as neccessary
448	# also check for time-outs	784	# also check for time-outs
449	sub _timeout {	785	$cb = sub {
450	my ($self) = @_;	786	my ($self) = @_;
451		787
452	if ($self->{timeout}) {	788	if ($self->{$timeout} && $self->{fh}) {
453	my $NOW = AnyEvent->now;	789	my $NOW = AE::now;
454		790
455	# when would the timeout trigger?	791	# when would the timeout trigger?
456	my $after = $self->{_activity} + $self->{timeout} - $NOW;	792	my $after = $self->{$activity} + $self->{$timeout} - $NOW;
457		793
458	# now or in the past already?	794	# now or in the past already?
459	if ($after <= 0) {	795	if ($after <= 0) {
460	$self->{_activity} = $NOW;	796	$self->{$activity} = $NOW;
461		797
462	if ($self->{on_timeout}) {	798	if ($self->{$on_timeout}) {
463	$self->{on_timeout}($self);	799	$self->{$on_timeout}($self);
464	} else {	800	} else {
465	$self->_error (&Errno::ETIMEDOUT);	801	$self->_error (Errno::ETIMEDOUT);
		802	}
		803
		804	# callback could have changed timeout value, optimise
		805	return unless $self->{$timeout};
		806
		807	# calculate new after
		808	$after = $self->{$timeout};
466	}	809	}
467		810
468	# callback could have changed timeout value, optimise	811	Scalar::Util::weaken $self;
469	return unless $self->{timeout};	812	return unless $self; # ->error could have destroyed $self
470		813
471	# calculate new after	814	$self->{$tw} ||= AE::timer $after, 0, sub {
472	$after = $self->{timeout};	815	delete $self->{$tw};
		816	$cb->($self);
		817	};
		818	} else {
		819	delete $self->{$tw};
473	}	820	}
474
475	Scalar::Util::weaken $self;
476	return unless $self; # ->error could have destroyed $self
477
478	$self->{_tw} ||= AnyEvent->timer (after => $after, cb => sub {
479	delete $self->{_tw};
480	$self->_timeout;
481	});
482	} else {
483	delete $self->{_tw};
484	}	821	}
485	}	822	}
486		823
487	#############################################################################	824	#############################################################################
488		825
…		…
503		840
504	=item $handle->on_drain ($cb)	841	=item $handle->on_drain ($cb)
505		842
506	Sets the C<on_drain> callback or clears it (see the description of	843	Sets the C<on_drain> callback or clears it (see the description of
507	C<on_drain> in the constructor).	844	C<on_drain> in the constructor).
		845
		846	This method may invoke callbacks (and therefore the handle might be
		847	destroyed after it returns).
508		848
509	=cut	849	=cut
510		850
511	sub on_drain {	851	sub on_drain {
512	my ($self, $cb) = @_;	852	my ($self, $cb) = @_;
…		…
521		861
522	Queues the given scalar to be written. You can push as much data as you	862	Queues the given scalar to be written. You can push as much data as you
523	want (only limited by the available memory), as C<AnyEvent::Handle>	863	want (only limited by the available memory), as C<AnyEvent::Handle>
524	buffers it independently of the kernel.	864	buffers it independently of the kernel.
525		865
		866	This method may invoke callbacks (and therefore the handle might be
		867	destroyed after it returns).
		868
526	=cut	869	=cut
527		870
528	sub _drain_wbuf {	871	sub _drain_wbuf {
529	my ($self) = @_;	872	my ($self) = @_;
530		873
…		…
533	Scalar::Util::weaken $self;	876	Scalar::Util::weaken $self;
534		877
535	my $cb = sub {	878	my $cb = sub {
536	my $len = syswrite $self->{fh}, $self->{wbuf};	879	my $len = syswrite $self->{fh}, $self->{wbuf};
537		880
538	if ($len >= 0) {	881	if (defined $len) {
539	substr $self->{wbuf}, 0, $len, "";	882	substr $self->{wbuf}, 0, $len, "";
540		883
541	$self->{_activity} = AnyEvent->now;	884	$self->{_activity} = $self->{_wactivity} = AE::now;
542		885
543	$self->{on_drain}($self)	886	$self->{on_drain}($self)
544	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})	887	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
545	&& $self->{on_drain};	888	&& $self->{on_drain};
546		889
…		…
552		895
553	# try to write data immediately	896	# try to write data immediately
554	$cb->() unless $self->{autocork};	897	$cb->() unless $self->{autocork};
555		898
556	# if still data left in wbuf, we need to poll	899	# if still data left in wbuf, we need to poll
557	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	900	$self->{_ww} = AE::io $self->{fh}, 1, $cb
558	if length $self->{wbuf};	901	if length $self->{wbuf};
559	};	902	};
560	}	903	}
561		904
562	our %WH;	905	our %WH;
563		906
		907	# deprecated
564	sub register_write_type($$) {	908	sub register_write_type($$) {
565	$WH{$_[0]} = $_[1];	909	$WH{$_[0]} = $_[1];
566	}	910	}
567		911
568	sub push_write {	912	sub push_write {
569	my $self = shift;	913	my $self = shift;
570		914
571	if (@_ > 1) {	915	if (@_ > 1) {
572	my $type = shift;	916	my $type = shift;
573		917
		918	@_ = ($WH{$type} ||= _load_func "$type\::anyevent_write_type"
574	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	919	or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_write")
575	->($self, @_);	920	->($self, @_);
576	}	921	}
577		922
		923	# we downgrade here to avoid hard-to-track-down bugs,
		924	# and diagnose the problem earlier and better.
		925
578	if ($self->{tls}) {	926	if ($self->{tls}) {
579	$self->{_tls_wbuf} .= $_[0];	927	utf8::downgrade $self->{_tls_wbuf} .= $_[0];
580		928	&_dotls ($self) if $self->{fh};
581	&_dotls ($self);
582	} else {	929	} else {
583	$self->{wbuf} .= $_[0];	930	utf8::downgrade $self->{wbuf} .= $_[0];
584	$self->_drain_wbuf;	931	$self->_drain_wbuf if $self->{fh};
585	}	932	}
586	}	933	}
587		934
588	=item $handle->push_write (type => @args)	935	=item $handle->push_write (type => @args)
589		936
590	Instead of formatting your data yourself, you can also let this module do	937	Instead of formatting your data yourself, you can also let this module
591	the job by specifying a type and type-specific arguments.	938	do the job by specifying a type and type-specific arguments. You
		939	can also specify the (fully qualified) name of a package, in which
		940	case AnyEvent tries to load the package and then expects to find the
		941	C<anyevent_write_type> function inside (see "custom write types", below).
592		942
593	Predefined types are (if you have ideas for additional types, feel free to	943	Predefined types are (if you have ideas for additional types, feel free to
594	drop by and tell us):	944	drop by and tell us):
595		945
596	=over 4	946	=over 4
…		…
653	Other languages could read single lines terminated by a newline and pass	1003	Other languages could read single lines terminated by a newline and pass
654	this line into their JSON decoder of choice.	1004	this line into their JSON decoder of choice.
655		1005
656	=cut	1006	=cut
657		1007
		1008	sub json_coder() {
		1009	eval { require JSON::XS; JSON::XS->new->utf8 }
		1010	|| do { require JSON; JSON->new->utf8 }
		1011	}
		1012
658	register_write_type json => sub {	1013	register_write_type json => sub {
659	my ($self, $ref) = @_;	1014	my ($self, $ref) = @_;
660		1015
661	require JSON;	1016	my $json = $self->{json} ||= json_coder;
662		1017
663	$self->{json} ? $self->{json}->encode ($ref)	1018	$json->encode ($ref)
664	: JSON::encode_json ($ref)
665	};	1019	};
666		1020
667	=item storable => $reference	1021	=item storable => $reference
668		1022
669	Freezes the given reference using L<Storable> and writes it to the	1023	Freezes the given reference using L<Storable> and writes it to the
…		…
683		1037
684	=item $handle->push_shutdown	1038	=item $handle->push_shutdown
685		1039
686	Sometimes you know you want to close the socket after writing your data	1040	Sometimes you know you want to close the socket after writing your data
687	before it was actually written. One way to do that is to replace your	1041	before it was actually written. One way to do that is to replace your
688	C<on_drain> handler by a callback that shuts down the socket. This method	1042	C<on_drain> handler by a callback that shuts down the socket (and set
689	is a shorthand for just that, and replaces the C<on_drain> callback with:	1043	C<low_water_mark> to C<0>). This method is a shorthand for just that, and
		1044	replaces the C<on_drain> callback with:
690		1045
691	sub { shutdown $_[0]{fh}, 1 } # for push_shutdown	1046	sub { shutdown $_[0]{fh}, 1 } # for push_shutdown
692		1047
693	This simply shuts down the write side and signals an EOF condition to the	1048	This simply shuts down the write side and signals an EOF condition to the
694	the peer.	1049	the peer.
695		1050
696	You can rely on the normal read queue and C<on_eof> handling	1051	You can rely on the normal read queue and C<on_eof> handling
697	afterwards. This is the cleanest way to close a connection.	1052	afterwards. This is the cleanest way to close a connection.
698		1053
		1054	This method may invoke callbacks (and therefore the handle might be
		1055	destroyed after it returns).
		1056
699	=cut	1057	=cut
700		1058
701	sub push_shutdown {	1059	sub push_shutdown {
		1060	my ($self) = @_;
		1061
		1062	delete $self->{low_water_mark};
702	$_[0]->{on_drain} = sub { shutdown $_[0]{fh}, 1 };	1063	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });
703	}	1064	}
704		1065
705	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	1066	=item custom write types - Package::anyevent_write_type $handle, @args
706		1067
707	This function (not method) lets you add your own types to C<push_write>.	1068	Instead of one of the predefined types, you can also specify the name of
		1069	a package. AnyEvent will try to load the package and then expects to find
		1070	a function named C<anyevent_write_type> inside. If it isn't found, it
		1071	progressively tries to load the parent package until it either finds the
		1072	function (good) or runs out of packages (bad).
		1073
708	Whenever the given C<type> is used, C<push_write> will invoke the code	1074	Whenever the given C<type> is used, C<push_write> will the function with
709	reference with the handle object and the remaining arguments.	1075	the handle object and the remaining arguments.
710		1076
711	The code reference is supposed to return a single octet string that will	1077	The function is supposed to return a single octet string that will be
712	be appended to the write buffer.	1078	appended to the write buffer, so you cna mentally treat this function as a
		1079	"arguments to on-the-wire-format" converter.
713		1080
714	Note that this is a function, and all types registered this way will be	1081	Example: implement a custom write type C<join> that joins the remaining
715	global, so try to use unique names.	1082	arguments using the first one.
		1083
		1084	$handle->push_write (My::Type => " ", 1,2,3);
		1085
		1086	# uses the following package, which can be defined in the "My::Type" or in
		1087	# the "My" modules to be auto-loaded, or just about anywhere when the
		1088	# My::Type::anyevent_write_type is defined before invoking it.
		1089
		1090	package My::Type;
		1091
		1092	sub anyevent_write_type {
		1093	my ($handle, $delim, @args) = @_;
		1094
		1095	join $delim, @args
		1096	}
716		1097
717	=cut	1098	=cut
718		1099
719	#############################################################################	1100	#############################################################################
720		1101
…		…
729	ways, the "simple" way, using only C<on_read> and the "complex" way, using	1110	ways, the "simple" way, using only C<on_read> and the "complex" way, using
730	a queue.	1111	a queue.
731		1112
732	In the simple case, you just install an C<on_read> callback and whenever	1113	In the simple case, you just install an C<on_read> callback and whenever
733	new data arrives, it will be called. You can then remove some data (if	1114	new data arrives, it will be called. You can then remove some data (if
734	enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna	1115	enough is there) from the read buffer (C<< $handle->rbuf >>). Or you can
735	leave the data there if you want to accumulate more (e.g. when only a	1116	leave the data there if you want to accumulate more (e.g. when only a
736	partial message has been received so far).	1117	partial message has been received so far), or change the read queue with
		1118	e.g. C<push_read>.
737		1119
738	In the more complex case, you want to queue multiple callbacks. In this	1120	In the more complex case, you want to queue multiple callbacks. In this
739	case, AnyEvent::Handle will call the first queued callback each time new	1121	case, AnyEvent::Handle will call the first queued callback each time new
740	data arrives (also the first time it is queued) and removes it when it has	1122	data arrives (also the first time it is queued) and removes it when it has
741	done its job (see C<push_read>, below).	1123	done its job (see C<push_read>, below).
…		…
802	=cut	1184	=cut
803		1185
804	sub _drain_rbuf {	1186	sub _drain_rbuf {
805	my ($self) = @_;	1187	my ($self) = @_;
806		1188
		1189	# avoid recursion
		1190	return if $self->{_skip_drain_rbuf};
807	local $self->{_in_drain} = 1;	1191	local $self->{_skip_drain_rbuf} = 1;
808
809	if (
810	defined $self->{rbuf_max}
811	&& $self->{rbuf_max} < length $self->{rbuf}
812	) {
813	$self->_error (&Errno::ENOSPC, 1), return;
814	}
815		1192
816	while () {	1193	while () {
817	# we need to use a separate tls read buffer, as we must not receive data while	1194	# we need to use a separate tls read buffer, as we must not receive data while
818	# we are draining the buffer, and this can only happen with TLS.	1195	# we are draining the buffer, and this can only happen with TLS.
819	$self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf};	1196	$self->{rbuf} .= delete $self->{_tls_rbuf}
		1197	if exists $self->{_tls_rbuf};
820		1198
821	my $len = length $self->{rbuf};	1199	my $len = length $self->{rbuf};
822		1200
823	if (my $cb = shift @{ $self->{_queue} }) {	1201	if (my $cb = shift @{ $self->{_queue} }) {
824	unless ($cb->($self)) {	1202	unless ($cb->($self)) {
825	if ($self->{_eof}) {	1203	# no progress can be made
826	# no progress can be made (not enough data and no data forthcoming)	1204	# (not enough data and no data forthcoming)
827	$self->_error (&Errno::EPIPE, 1), return;	1205	$self->_error (Errno::EPIPE, 1), return
828	}	1206	if $self->{_eof};
829		1207
830	unshift @{ $self->{_queue} }, $cb;	1208	unshift @{ $self->{_queue} }, $cb;
831	last;	1209	last;
832	}	1210	}
833	} elsif ($self->{on_read}) {	1211	} elsif ($self->{on_read}) {
…		…
840	&& !@{ $self->{_queue} } # and the queue is still empty	1218	&& !@{ $self->{_queue} } # and the queue is still empty
841	&& $self->{on_read} # but we still have on_read	1219	&& $self->{on_read} # but we still have on_read
842	) {	1220	) {
843	# no further data will arrive	1221	# no further data will arrive
844	# so no progress can be made	1222	# so no progress can be made
845	$self->_error (&Errno::EPIPE, 1), return	1223	$self->_error (Errno::EPIPE, 1), return
846	if $self->{_eof};	1224	if $self->{_eof};
847		1225
848	last; # more data might arrive	1226	last; # more data might arrive
849	}	1227	}
850	} else {	1228	} else {
…		…
853	last;	1231	last;
854	}	1232	}
855	}	1233	}
856		1234
857	if ($self->{_eof}) {	1235	if ($self->{_eof}) {
858	if ($self->{on_eof}) {	1236	$self->{on_eof}
859	$self->{on_eof}($self)	1237	? $self->{on_eof}($self)
860	} else {
861	$self->_error (0, 1, "Unexpected end-of-file");	1238	: $self->_error (0, 1, "Unexpected end-of-file");
862	}	1239
		1240	return;
		1241	}
		1242
		1243	if (
		1244	defined $self->{rbuf_max}
		1245	&& $self->{rbuf_max} < length $self->{rbuf}
		1246	) {
		1247	$self->_error (Errno::ENOSPC, 1), return;
863	}	1248	}
864		1249
865	# may need to restart read watcher	1250	# may need to restart read watcher
866	unless ($self->{_rw}) {	1251	unless ($self->{_rw}) {
867	$self->start_read	1252	$self->start_read
…		…
873		1258
874	This replaces the currently set C<on_read> callback, or clears it (when	1259	This replaces the currently set C<on_read> callback, or clears it (when
875	the new callback is C<undef>). See the description of C<on_read> in the	1260	the new callback is C<undef>). See the description of C<on_read> in the
876	constructor.	1261	constructor.
877		1262
		1263	This method may invoke callbacks (and therefore the handle might be
		1264	destroyed after it returns).
		1265
878	=cut	1266	=cut
879		1267
880	sub on_read {	1268	sub on_read {
881	my ($self, $cb) = @_;	1269	my ($self, $cb) = @_;
882		1270
883	$self->{on_read} = $cb;	1271	$self->{on_read} = $cb;
884	$self->_drain_rbuf if $cb && !$self->{_in_drain};	1272	$self->_drain_rbuf if $cb;
885	}	1273	}
886		1274
887	=item $handle->rbuf	1275	=item $handle->rbuf
888		1276
889	Returns the read buffer (as a modifiable lvalue).	1277	Returns the read buffer (as a modifiable lvalue).
…		…
921		1309
922	If enough data was available, then the callback must remove all data it is	1310	If enough data was available, then the callback must remove all data it is
923	interested in (which can be none at all) and return a true value. After returning	1311	interested in (which can be none at all) and return a true value. After returning
924	true, it will be removed from the queue.	1312	true, it will be removed from the queue.
925		1313
		1314	These methods may invoke callbacks (and therefore the handle might be
		1315	destroyed after it returns).
		1316
926	=cut	1317	=cut
927		1318
928	our %RH;	1319	our %RH;
929		1320
930	sub register_read_type($$) {	1321	sub register_read_type($$) {
…		…
936	my $cb = pop;	1327	my $cb = pop;
937		1328
938	if (@_) {	1329	if (@_) {
939	my $type = shift;	1330	my $type = shift;
940		1331
		1332	$cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type"
941	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	1333	or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_read")
942	->($self, $cb, @_);	1334	->($self, $cb, @_);
943	}	1335	}
944		1336
945	push @{ $self->{_queue} }, $cb;	1337	push @{ $self->{_queue} }, $cb;
946	$self->_drain_rbuf unless $self->{_in_drain};	1338	$self->_drain_rbuf;
947	}	1339	}
948		1340
949	sub unshift_read {	1341	sub unshift_read {
950	my $self = shift;	1342	my $self = shift;
951	my $cb = pop;	1343	my $cb = pop;
…		…
955		1347
956	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")	1348	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")
957	->($self, $cb, @_);	1349	->($self, $cb, @_);
958	}	1350	}
959		1351
960
961	unshift @{ $self->{_queue} }, $cb;	1352	unshift @{ $self->{_queue} }, $cb;
962	$self->_drain_rbuf unless $self->{_in_drain};	1353	$self->_drain_rbuf;
963	}	1354	}
964		1355
965	=item $handle->push_read (type => @args, $cb)	1356	=item $handle->push_read (type => @args, $cb)
966		1357
967	=item $handle->unshift_read (type => @args, $cb)	1358	=item $handle->unshift_read (type => @args, $cb)
968		1359
969	Instead of providing a callback that parses the data itself you can chose	1360	Instead of providing a callback that parses the data itself you can chose
970	between a number of predefined parsing formats, for chunks of data, lines	1361	between a number of predefined parsing formats, for chunks of data, lines
971	etc.	1362	etc. You can also specify the (fully qualified) name of a package, in
		1363	which case AnyEvent tries to load the package and then expects to find the
		1364	C<anyevent_read_type> function inside (see "custom read types", below).
972		1365
973	Predefined types are (if you have ideas for additional types, feel free to	1366	Predefined types are (if you have ideas for additional types, feel free to
974	drop by and tell us):	1367	drop by and tell us):
975		1368
976	=over 4	1369	=over 4
…		…
1100	return 1;	1493	return 1;
1101	}	1494	}
1102		1495
1103	# reject	1496	# reject
1104	if ($reject && $$rbuf =~ $reject) {	1497	if ($reject && $$rbuf =~ $reject) {
1105	$self->_error (&Errno::EBADMSG);	1498	$self->_error (Errno::EBADMSG);
1106	}	1499	}
1107		1500
1108	# skip	1501	# skip
1109	if ($skip && $$rbuf =~ $skip) {	1502	if ($skip && $$rbuf =~ $skip) {
1110	$data .= substr $$rbuf, 0, $+[0], "";	1503	$data .= substr $$rbuf, 0, $+[0], "";
…		…
1126	my ($self, $cb) = @_;	1519	my ($self, $cb) = @_;
1127		1520
1128	sub {	1521	sub {
1129	unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {	1522	unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {
1130	if ($_[0]{rbuf} =~ /[^0-9]/) {	1523	if ($_[0]{rbuf} =~ /[^0-9]/) {
1131	$self->_error (&Errno::EBADMSG);	1524	$self->_error (Errno::EBADMSG);
1132	}	1525	}
1133	return;	1526	return;
1134	}	1527	}
1135		1528
1136	my $len = $1;	1529	my $len = $1;
…		…
1139	my $string = $_[1];	1532	my $string = $_[1];
1140	$_[0]->unshift_read (chunk => 1, sub {	1533	$_[0]->unshift_read (chunk => 1, sub {
1141	if ($_[1] eq ",") {	1534	if ($_[1] eq ",") {
1142	$cb->($_[0], $string);	1535	$cb->($_[0], $string);
1143	} else {	1536	} else {
1144	$self->_error (&Errno::EBADMSG);	1537	$self->_error (Errno::EBADMSG);
1145	}	1538	}
1146	});	1539	});
1147	});	1540	});
1148		1541
1149	1	1542	1
…		…
1216	=cut	1609	=cut
1217		1610
1218	register_read_type json => sub {	1611	register_read_type json => sub {
1219	my ($self, $cb) = @_;	1612	my ($self, $cb) = @_;
1220		1613
1221	my $json = $self->{json} ||=	1614	my $json = $self->{json} ||= json_coder;
1222	eval { require JSON::XS; JSON::XS->new->utf8 }
1223	|| do { require JSON; JSON->new->utf8 };
1224		1615
1225	my $data;	1616	my $data;
1226	my $rbuf = \$self->{rbuf};	1617	my $rbuf = \$self->{rbuf};
1227		1618
1228	sub {	1619	sub {
…		…
1239	$json->incr_skip;	1630	$json->incr_skip;
1240		1631
1241	$self->{rbuf} = $json->incr_text;	1632	$self->{rbuf} = $json->incr_text;
1242	$json->incr_text = "";	1633	$json->incr_text = "";
1243		1634
1244	$self->_error (&Errno::EBADMSG);	1635	$self->_error (Errno::EBADMSG);
1245		1636
1246	()	1637	()
1247	} else {	1638	} else {
1248	$self->{rbuf} = "";	1639	$self->{rbuf} = "";
1249		1640
…		…
1286	# read remaining chunk	1677	# read remaining chunk
1287	$_[0]->unshift_read (chunk => $len, sub {	1678	$_[0]->unshift_read (chunk => $len, sub {
1288	if (my $ref = eval { Storable::thaw ($_[1]) }) {	1679	if (my $ref = eval { Storable::thaw ($_[1]) }) {
1289	$cb->($_[0], $ref);	1680	$cb->($_[0], $ref);
1290	} else {	1681	} else {
1291	$self->_error (&Errno::EBADMSG);	1682	$self->_error (Errno::EBADMSG);
1292	}	1683	}
1293	});	1684	});
1294	}	1685	}
1295		1686
1296	1	1687	1
1297	}	1688	}
1298	};	1689	};
1299		1690
1300	=back	1691	=back
1301		1692
1302	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)	1693	=item custom read types - Package::anyevent_read_type $handle, $cb, @args
1303		1694
1304	This function (not method) lets you add your own types to C<push_read>.	1695	Instead of one of the predefined types, you can also specify the name
		1696	of a package. AnyEvent will try to load the package and then expects to
		1697	find a function named C<anyevent_read_type> inside. If it isn't found, it
		1698	progressively tries to load the parent package until it either finds the
		1699	function (good) or runs out of packages (bad).
1305		1700
1306	Whenever the given C<type> is used, C<push_read> will invoke the code	1701	Whenever this type is used, C<push_read> will invoke the function with the
1307	reference with the handle object, the callback and the remaining	1702	handle object, the original callback and the remaining arguments.
1308	arguments.
1309		1703
1310	The code reference is supposed to return a callback (usually a closure)	1704	The function is supposed to return a callback (usually a closure) that
1311	that works as a plain read callback (see C<< ->push_read ($cb) >>).	1705	works as a plain read callback (see C<< ->push_read ($cb) >>), so you can
		1706	mentally treat the function as a "configurable read type to read callback"
		1707	converter.
1312		1708
1313	It should invoke the passed callback when it is done reading (remember to	1709	It should invoke the original callback when it is done reading (remember
1314	pass C<$handle> as first argument as all other callbacks do that).	1710	to pass C<$handle> as first argument as all other callbacks do that,
		1711	although there is no strict requirement on this).
1315		1712
1316	Note that this is a function, and all types registered this way will be
1317	global, so try to use unique names.
1318
1319	For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>,	1713	For examples, see the source of this module (F<perldoc -m
1320	search for C<register_read_type>)).	1714	AnyEvent::Handle>, search for C<register_read_type>)).
1321		1715
1322	=item $handle->stop_read	1716	=item $handle->stop_read
1323		1717
1324	=item $handle->start_read	1718	=item $handle->start_read
1325		1719
…		…
1345	}	1739	}
1346		1740
1347	sub start_read {	1741	sub start_read {
1348	my ($self) = @_;	1742	my ($self) = @_;
1349		1743
1350	unless ($self->{_rw} || $self->{_eof}) {	1744	unless ($self->{_rw} || $self->{_eof} || !$self->{fh}) {
1351	Scalar::Util::weaken $self;	1745	Scalar::Util::weaken $self;
1352		1746
1353	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1747	$self->{_rw} = AE::io $self->{fh}, 0, sub {
1354	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});	1748	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1355	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf;	1749	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf;
1356		1750
1357	if ($len > 0) {	1751	if ($len > 0) {
1358	$self->{_activity} = AnyEvent->now;	1752	$self->{_activity} = $self->{_ractivity} = AE::now;
1359		1753
1360	if ($self->{tls}) {	1754	if ($self->{tls}) {
1361	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);	1755	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1362		1756
1363	&_dotls ($self);	1757	&_dotls ($self);
1364	} else {	1758	} else {
1365	$self->_drain_rbuf unless $self->{_in_drain};	1759	$self->_drain_rbuf;
1366	}	1760	}
1367		1761
1368	} elsif (defined $len) {	1762	} elsif (defined $len) {
1369	delete $self->{_rw};	1763	delete $self->{_rw};
1370	$self->{_eof} = 1;	1764	$self->{_eof} = 1;
1371	$self->_drain_rbuf unless $self->{_in_drain};	1765	$self->_drain_rbuf;
1372		1766
1373	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1767	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1374	return $self->_error ($!, 1);	1768	return $self->_error ($!, 1);
1375	}	1769	}
1376	});	1770	};
1377	}	1771	}
1378	}	1772	}
1379		1773
1380	our $ERROR_SYSCALL;	1774	our $ERROR_SYSCALL;
1381	our $ERROR_WANT_READ;	1775	our $ERROR_WANT_READ;
1382	our $ERROR_ZERO_RETURN;
1383		1776
1384	sub _tls_error {	1777	sub _tls_error {
1385	my ($self, $err) = @_;	1778	my ($self, $err) = @_;
1386		1779
1387	return $self->_error ($!, 1)	1780	return $self->_error ($!, 1)
…		…
1390	my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());	1783	my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());
1391		1784
1392	# reduce error string to look less scary	1785	# reduce error string to look less scary
1393	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;	1786	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;
1394		1787
		1788	if ($self->{_on_starttls}) {
		1789	(delete $self->{_on_starttls})->($self, undef, $err);
		1790	&_freetls;
		1791	} else {
		1792	&_freetls;
1395	$self->_error (&Errno::EPROTO, 1, $err);	1793	$self->_error (Errno::EPROTO, 1, $err);
		1794	}
1396	}	1795	}
1397		1796
1398	# poll the write BIO and send the data if applicable	1797	# poll the write BIO and send the data if applicable
1399	# also decode read data if possible	1798	# also decode read data if possible
1400	# this is basiclaly our TLS state machine	1799	# this is basiclaly our TLS state machine
…		…
1411	}	1810	}
1412		1811
1413	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);	1812	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);
1414	return $self->_tls_error ($tmp)	1813	return $self->_tls_error ($tmp)
1415	if $tmp != $ERROR_WANT_READ	1814	if $tmp != $ERROR_WANT_READ
1416	&& ($tmp != $ERROR_SYSCALL || $!)	1815	&& ($tmp != $ERROR_SYSCALL || $!);
1417	&& $tmp != $ERROR_ZERO_RETURN;
1418	}	1816	}
1419		1817
1420	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {	1818	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
1421	unless (length $tmp) {	1819	unless (length $tmp) {
1422	# let's treat SSL-eof as we treat normal EOF	1820	$self->{_on_starttls}
1423	delete $self->{_rw};	1821	and (delete $self->{_on_starttls})->($self, undef, "EOF during handshake"); # ???
1424	$self->{_eof} = 1;
1425	&_freetls;	1822	&_freetls;
		1823
		1824	if ($self->{on_stoptls}) {
		1825	$self->{on_stoptls}($self);
		1826	return;
		1827	} else {
		1828	# let's treat SSL-eof as we treat normal EOF
		1829	delete $self->{_rw};
		1830	$self->{_eof} = 1;
		1831	}
1426	}	1832	}
1427		1833
1428	$self->{_tls_rbuf} .= $tmp;	1834	$self->{_tls_rbuf} .= $tmp;
1429	$self->_drain_rbuf unless $self->{_in_drain};	1835	$self->_drain_rbuf;
1430	$self->{tls} or return; # tls session might have gone away in callback	1836	$self->{tls} or return; # tls session might have gone away in callback
1431	}	1837	}
1432		1838
1433	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);	1839	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1434	return $self->_tls_error ($tmp)	1840	return $self->_tls_error ($tmp)
1435	if $tmp != $ERROR_WANT_READ	1841	if $tmp != $ERROR_WANT_READ
1436	&& ($tmp != $ERROR_SYSCALL || $!)	1842	&& ($tmp != $ERROR_SYSCALL || $!);
1437	&& $tmp != $ERROR_ZERO_RETURN;
1438		1843
1439	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1844	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1440	$self->{wbuf} .= $tmp;	1845	$self->{wbuf} .= $tmp;
1441	$self->_drain_wbuf;	1846	$self->_drain_wbuf;
		1847	$self->{tls} or return; # tls session might have gone away in callback
1442	}	1848	}
		1849
		1850	$self->{_on_starttls}
		1851	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
		1852	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");
1443	}	1853	}
1444		1854
1445	=item $handle->starttls ($tls[, $tls_ctx])	1855	=item $handle->starttls ($tls[, $tls_ctx])
1446		1856
1447	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	1857	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
1448	object is created, you can also do that at a later time by calling	1858	object is created, you can also do that at a later time by calling
1449	C<starttls>.	1859	C<starttls>.
		1860
		1861	Starting TLS is currently an asynchronous operation - when you push some
		1862	write data and then call C<< ->starttls >> then TLS negotiation will start
		1863	immediately, after which the queued write data is then sent.
1450		1864
1451	The first argument is the same as the C<tls> constructor argument (either	1865	The first argument is the same as the C<tls> constructor argument (either
1452	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1866	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1453		1867
1454	The second argument is the optional C<AnyEvent::TLS> object that is used	1868	The second argument is the optional C<AnyEvent::TLS> object that is used
…		…
1459	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS	1873	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS
1460	context in C<< $handle->{tls_ctx} >> after this call and can be used or	1874	context in C<< $handle->{tls_ctx} >> after this call and can be used or
1461	changed to your liking. Note that the handshake might have already started	1875	changed to your liking. Note that the handshake might have already started
1462	when this function returns.	1876	when this function returns.
1463		1877
1464	If it an error to start a TLS handshake more than once per	1878	Due to bugs in OpenSSL, it might or might not be possible to do multiple
1465	AnyEvent::Handle object (this is due to bugs in OpenSSL).	1879	handshakes on the same stream. Best do not attempt to use the stream after
		1880	stopping TLS.
		1881
		1882	This method may invoke callbacks (and therefore the handle might be
		1883	destroyed after it returns).
1466		1884
1467	=cut	1885	=cut
1468		1886
1469	our %TLS_CACHE; #TODO not yet documented, should we?	1887	our %TLS_CACHE; #TODO not yet documented, should we?
1470		1888
1471	sub starttls {	1889	sub starttls {
1472	my ($self, $ssl, $ctx) = @_;	1890	my ($self, $tls, $ctx) = @_;
		1891
		1892	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"
		1893	if $self->{tls};
		1894
		1895	$self->{tls} = $tls;
		1896	$self->{tls_ctx} = $ctx if @_ > 2;
		1897
		1898	return unless $self->{fh};
1473		1899
1474	require Net::SSLeay;	1900	require Net::SSLeay;
1475		1901
1476	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"
1477	if $self->{tls};
1478
1479	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();	1902	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1480	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();	1903	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1481	$ERROR_ZERO_RETURN = Net::SSLeay::ERROR_ZERO_RETURN ();
1482		1904
		1905	$tls = delete $self->{tls};
1483	$ctx ||= $self->{tls_ctx};	1906	$ctx = $self->{tls_ctx};
		1907
		1908	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
1484		1909
1485	if ("HASH" eq ref $ctx) {	1910	if ("HASH" eq ref $ctx) {
1486	require AnyEvent::TLS;	1911	require AnyEvent::TLS;
1487
1488	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context
1489		1912
1490	if ($ctx->{cache}) {	1913	if ($ctx->{cache}) {
1491	my $key = $ctx+0;	1914	my $key = $ctx+0;
1492	$ctx = $TLS_CACHE{$key} ||= new AnyEvent::TLS %$ctx;	1915	$ctx = $TLS_CACHE{$key} ||= new AnyEvent::TLS %$ctx;
1493	} else {	1916	} else {
1494	$ctx = new AnyEvent::TLS %$ctx;	1917	$ctx = new AnyEvent::TLS %$ctx;
1495	}	1918	}
1496	}	1919	}
1497		1920
1498	$self->{tls_ctx} = $ctx || TLS_CTX ();	1921	$self->{tls_ctx} = $ctx || TLS_CTX ();
1499	$self->{tls} = $ssl = $self->{tls_ctx}->_get_session ($ssl, $self, $self->{peername});	1922	$self->{tls} = $tls = $self->{tls_ctx}->_get_session ($tls, $self, $self->{peername});
1500		1923
1501	# basically, this is deep magic (because SSL_read should have the same issues)	1924	# basically, this is deep magic (because SSL_read should have the same issues)
1502	# but the openssl maintainers basically said: "trust us, it just works".	1925	# but the openssl maintainers basically said: "trust us, it just works".
1503	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1926	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1504	# and mismaintained ssleay-module doesn't even offer them).	1927	# and mismaintained ssleay-module doesn't even offer them).
…		…
1511	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to	1934	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
1512	# have identity issues in that area.	1935	# have identity issues in that area.
1513	# Net::SSLeay::CTX_set_mode ($ssl,	1936	# Net::SSLeay::CTX_set_mode ($ssl,
1514	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)	1937	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)
1515	# | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));	1938	# | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));
1516	Net::SSLeay::CTX_set_mode ($ssl, 1|2);	1939	Net::SSLeay::CTX_set_mode ($tls, 1|2);
1517		1940
1518	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1941	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1519	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1942	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1520		1943
		1944	Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf});
		1945
1521	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1946	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
		1947
		1948	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
		1949	if $self->{on_starttls};
1522		1950
1523	&_dotls; # need to trigger the initial handshake	1951	&_dotls; # need to trigger the initial handshake
1524	$self->start_read; # make sure we actually do read	1952	$self->start_read; # make sure we actually do read
1525	}	1953	}
1526		1954
1527	=item $handle->stoptls	1955	=item $handle->stoptls
1528		1956
1529	Shuts down the SSL connection - this makes a proper EOF handshake by	1957	Shuts down the SSL connection - this makes a proper EOF handshake by
1530	sending a close notify to the other side, but since OpenSSL doesn't	1958	sending a close notify to the other side, but since OpenSSL doesn't
1531	support non-blocking shut downs, it is not possible to re-use the stream	1959	support non-blocking shut downs, it is not guaranteed that you can re-use
1532	afterwards.	1960	the stream afterwards.
		1961
		1962	This method may invoke callbacks (and therefore the handle might be
		1963	destroyed after it returns).
1533		1964
1534	=cut	1965	=cut
1535		1966
1536	sub stoptls {	1967	sub stoptls {
1537	my ($self) = @_;	1968	my ($self) = @_;
1538		1969
1539	if ($self->{tls}) {	1970	if ($self->{tls} && $self->{fh}) {
1540	Net::SSLeay::shutdown ($self->{tls});	1971	Net::SSLeay::shutdown ($self->{tls});
1541		1972
1542	&_dotls;	1973	&_dotls;
1543		1974
1544	# we don't give a shit. no, we do, but we can't. no...	1975	# # we don't give a shit. no, we do, but we can't. no...#d#
1545	# we, we... have to use openssl :/	1976	# # we, we... have to use openssl :/#d#
1546	&_freetls;	1977	# &_freetls;#d#
1547	}	1978	}
1548	}	1979	}
1549		1980
1550	sub _freetls {	1981	sub _freetls {
1551	my ($self) = @_;	1982	my ($self) = @_;
1552		1983
1553	return unless $self->{tls};	1984	return unless $self->{tls};
1554		1985
1555	$self->{tls_ctx}->_put_session (delete $self->{tls});	1986	$self->{tls_ctx}->_put_session (delete $self->{tls})
		1987	if $self->{tls} > 0;
1556		1988
1557	delete @$self{qw(_rbio _wbio _tls_wbuf)};	1989	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1558	}	1990	}
1559		1991
1560	sub DESTROY {	1992	sub DESTROY {
1561	my ($self) = @_;	1993	my ($self) = @_;
1562		1994
1563	&_freetls;	1995	&_freetls;
1564		1996
1565	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	1997	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1566		1998
1567	if ($linger && length $self->{wbuf}) {	1999	if ($linger && length $self->{wbuf} && $self->{fh}) {
1568	my $fh = delete $self->{fh};	2000	my $fh = delete $self->{fh};
1569	my $wbuf = delete $self->{wbuf};	2001	my $wbuf = delete $self->{wbuf};
1570		2002
1571	my @linger;	2003	my @linger;
1572		2004
1573	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {	2005	push @linger, AE::io $fh, 1, sub {
1574	my $len = syswrite $fh, $wbuf, length $wbuf;	2006	my $len = syswrite $fh, $wbuf, length $wbuf;
1575		2007
1576	if ($len > 0) {	2008	if ($len > 0) {
1577	substr $wbuf, 0, $len, "";	2009	substr $wbuf, 0, $len, "";
1578	} else {	2010	} else {
1579	@linger = (); # end	2011	@linger = (); # end
1580	}	2012	}
1581	});	2013	};
1582	push @linger, AnyEvent->timer (after => $linger, cb => sub {	2014	push @linger, AE::timer $linger, 0, sub {
1583	@linger = ();	2015	@linger = ();
1584	});	2016	};
1585	}	2017	}
1586	}	2018	}
1587		2019
1588	=item $handle->destroy	2020	=item $handle->destroy
1589		2021
1590	Shuts down the handle object as much as possible - this call ensures that	2022	Shuts down the handle object as much as possible - this call ensures that
1591	no further callbacks will be invoked and resources will be freed as much	2023	no further callbacks will be invoked and as many resources as possible
1592	as possible. You must not call any methods on the object afterwards.	2024	will be freed. Any method you will call on the handle object after
		2025	destroying it in this way will be silently ignored (and it will return the
		2026	empty list).
1593		2027
1594	Normally, you can just "forget" any references to an AnyEvent::Handle	2028	Normally, you can just "forget" any references to an AnyEvent::Handle
1595	object and it will simply shut down. This works in fatal error and EOF	2029	object and it will simply shut down. This works in fatal error and EOF
1596	callbacks, as well as code outside. It does I<NOT> work in a read or write	2030	callbacks, as well as code outside. It does I<NOT> work in a read or write
1597	callback, so when you want to destroy the AnyEvent::Handle object from	2031	callback, so when you want to destroy the AnyEvent::Handle object from
1598	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in	2032	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
1599	that case.	2033	that case.
1600		2034
		2035	Destroying the handle object in this way has the advantage that callbacks
		2036	will be removed as well, so if those are the only reference holders (as
		2037	is common), then one doesn't need to do anything special to break any
		2038	reference cycles.
		2039
1601	The handle might still linger in the background and write out remaining	2040	The handle might still linger in the background and write out remaining
1602	data, as specified by the C<linger> option, however.	2041	data, as specified by the C<linger> option, however.
1603		2042
1604	=cut	2043	=cut
1605		2044
1606	sub destroy {	2045	sub destroy {
1607	my ($self) = @_;	2046	my ($self) = @_;
1608		2047
1609	$self->DESTROY;	2048	$self->DESTROY;
1610	%$self = ();	2049	%$self = ();
		2050	bless $self, "AnyEvent::Handle::destroyed";
1611	}	2051	}
		2052
		2053	sub AnyEvent::Handle::destroyed::AUTOLOAD {
		2054	#nop
		2055	}
		2056
		2057	=item $handle->destroyed
		2058
		2059	Returns false as long as the handle hasn't been destroyed by a call to C<<
		2060	->destroy >>, true otherwise.
		2061
		2062	Can be useful to decide whether the handle is still valid after some
		2063	callback possibly destroyed the handle. For example, C<< ->push_write >>,
		2064	C<< ->starttls >> and other methods can call user callbacks, which in turn
		2065	can destroy the handle, so work can be avoided by checking sometimes:
		2066
		2067	$hdl->starttls ("accept");
		2068	return if $hdl->destroyed;
		2069	$hdl->push_write (...
		2070
		2071	Note that the call to C<push_write> will silently be ignored if the handle
		2072	has been destroyed, so often you can just ignore the possibility of the
		2073	handle being destroyed.
		2074
		2075	=cut
		2076
		2077	sub destroyed { 0 }
		2078	sub AnyEvent::Handle::destroyed::destroyed { 1 }
1612		2079
1613	=item AnyEvent::Handle::TLS_CTX	2080	=item AnyEvent::Handle::TLS_CTX
1614		2081
1615	This function creates and returns the AnyEvent::TLS object used by default	2082	This function creates and returns the AnyEvent::TLS object used by default
1616	for TLS mode.	2083	for TLS mode.
…		…
1672		2139
1673	$handle->on_read (sub { });	2140	$handle->on_read (sub { });
1674	$handle->on_eof (undef);	2141	$handle->on_eof (undef);
1675	$handle->on_error (sub {	2142	$handle->on_error (sub {
1676	my $data = delete $_[0]{rbuf};	2143	my $data = delete $_[0]{rbuf};
1677	undef $handle;
1678	});	2144	});
1679		2145
1680	The reason to use C<on_error> is that TCP connections, due to latencies	2146	The reason to use C<on_error> is that TCP connections, due to latencies
1681	and packets loss, might get closed quite violently with an error, when in	2147	and packets loss, might get closed quite violently with an error, when in
1682	fact, all data has been received.	2148	fact, all data has been received.
…		…
1698	$handle->on_drain (sub {	2164	$handle->on_drain (sub {
1699	warn "all data submitted to the kernel\n";	2165	warn "all data submitted to the kernel\n";
1700	undef $handle;	2166	undef $handle;
1701	});	2167	});
1702		2168
		2169	If you just want to queue some data and then signal EOF to the other side,
		2170	consider using C<< ->push_shutdown >> instead.
		2171
		2172	=item I want to contact a TLS/SSL server, I don't care about security.
		2173
		2174	If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS,
		2175	simply connect to it and then create the AnyEvent::Handle with the C<tls>
		2176	parameter:
		2177
		2178	tcp_connect $host, $port, sub {
		2179	my ($fh) = @_;
		2180
		2181	my $handle = new AnyEvent::Handle
		2182	fh => $fh,
		2183	tls => "connect",
		2184	on_error => sub { ... };
		2185
		2186	$handle->push_write (...);
		2187	};
		2188
		2189	=item I want to contact a TLS/SSL server, I do care about security.
		2190
		2191	Then you should additionally enable certificate verification, including
		2192	peername verification, if the protocol you use supports it (see
		2193	L<AnyEvent::TLS>, C<verify_peername>).
		2194
		2195	E.g. for HTTPS:
		2196
		2197	tcp_connect $host, $port, sub {
		2198	my ($fh) = @_;
		2199
		2200	my $handle = new AnyEvent::Handle
		2201	fh => $fh,
		2202	peername => $host,
		2203	tls => "connect",
		2204	tls_ctx => { verify => 1, verify_peername => "https" },
		2205	...
		2206
		2207	Note that you must specify the hostname you connected to (or whatever
		2208	"peername" the protocol needs) as the C<peername> argument, otherwise no
		2209	peername verification will be done.
		2210
		2211	The above will use the system-dependent default set of trusted CA
		2212	certificates. If you want to check against a specific CA, add the
		2213	C<ca_file> (or C<ca_cert>) arguments to C<tls_ctx>:
		2214
		2215	tls_ctx => {
		2216	verify => 1,
		2217	verify_peername => "https",
		2218	ca_file => "my-ca-cert.pem",
		2219	},
		2220
		2221	=item I want to create a TLS/SSL server, how do I do that?
		2222
		2223	Well, you first need to get a server certificate and key. You have
		2224	three options: a) ask a CA (buy one, use cacert.org etc.) b) create a
		2225	self-signed certificate (cheap. check the search engine of your choice,
		2226	there are many tutorials on the net) or c) make your own CA (tinyca2 is a
		2227	nice program for that purpose).
		2228
		2229	Then create a file with your private key (in PEM format, see
		2230	L<AnyEvent::TLS>), followed by the certificate (also in PEM format). The
		2231	file should then look like this:
		2232
		2233	-----BEGIN RSA PRIVATE KEY-----
		2234	...header data
		2235	... lots of base64'y-stuff
		2236	-----END RSA PRIVATE KEY-----
		2237
		2238	-----BEGIN CERTIFICATE-----
		2239	... lots of base64'y-stuff
		2240	-----END CERTIFICATE-----
		2241
		2242	The important bits are the "PRIVATE KEY" and "CERTIFICATE" parts. Then
		2243	specify this file as C<cert_file>:
		2244
		2245	tcp_server undef, $port, sub {
		2246	my ($fh) = @_;
		2247
		2248	my $handle = new AnyEvent::Handle
		2249	fh => $fh,
		2250	tls => "accept",
		2251	tls_ctx => { cert_file => "my-server-keycert.pem" },
		2252	...
		2253
		2254	When you have intermediate CA certificates that your clients might not
		2255	know about, just append them to the C<cert_file>.
		2256
1703	=back	2257	=back
1704		2258
1705		2259
1706	=head1 SUBCLASSING AnyEvent::Handle	2260	=head1 SUBCLASSING AnyEvent::Handle
1707		2261

Diff Legend

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