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.134 by root, Fri Jul 3 00:09:04 2009 UTC vs.
Revision 1.193 by root, Mon Mar 15 18:51:30 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 file handles via AnyEvent
16
17	=cut
18
19	our $VERSION = 4.45;
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	filehandles.
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>.
…		…
249		368
250	A string used to identify the remote site - usually the DNS hostname	369	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.	370	(I<not> IDN!) used to create the connection, rarely the IP address.
252		371
253	Apart from being useful in error messages, this string is also used in TLS	372	Apart from being useful in error messages, this string is also used in TLS
254	common name verification (see C<verify_cn> in L<AnyEvent::TLS>).	373	peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This
		374	verification will be skipped when C<peername> is not specified or
		375	C<undef>.
255		376
256	=item tls => "accept" | "connect" | Net::SSLeay::SSL object	377	=item tls => "accept" | "connect" | Net::SSLeay::SSL object
257		378
258	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
259	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
260	established and will transparently encrypt/decrypt data afterwards.	381	established and will transparently encrypt/decrypt data afterwards.
261		382
262	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
263	appropriate error message.	384	appropriate error message.
264		385
…		…
296		417
297	Instead of an object, you can also specify a hash reference with C<< key	418	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	419	=> value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a
299	new TLS context object.	420	new TLS context object.
300		421
		422	=item on_starttls => $cb->($handle, $success[, $error_message])
		423
		424	This callback will be invoked when the TLS/SSL handshake has finished. If
		425	C<$success> is true, then the TLS handshake succeeded, otherwise it failed
		426	(C<on_stoptls> will not be called in this case).
		427
		428	The session in C<< $handle->{tls} >> can still be examined in this
		429	callback, even when the handshake was not successful.
		430
		431	TLS handshake failures will not cause C<on_error> to be invoked when this
		432	callback is in effect, instead, the error message will be passed to C<on_starttls>.
		433
		434	Without this callback, handshake failures lead to C<on_error> being
		435	called, as normal.
		436
		437	Note that you cannot call C<starttls> right again in this callback. If you
		438	need to do that, start an zero-second timer instead whose callback can
		439	then call C<< ->starttls >> again.
		440
		441	=item on_stoptls => $cb->($handle)
		442
		443	When a SSLv3/TLS shutdown/close notify/EOF is detected and this callback is
		444	set, then it will be invoked after freeing the TLS session. If it is not,
		445	then a TLS shutdown condition will be treated like a normal EOF condition
		446	on the handle.
		447
		448	The session in C<< $handle->{tls} >> can still be examined in this
		449	callback.
		450
		451	This callback will only be called on TLS shutdowns, not when the
		452	underlying handle signals EOF.
		453
301	=item json => JSON or JSON::XS object	454	=item json => JSON or JSON::XS object
302		455
303	This is the json coder object used by the C<json> read and write types.	456	This is the json coder object used by the C<json> read and write types.
304		457
305	If you don't supply it, then AnyEvent::Handle will create and use a	458	If you don't supply it, then AnyEvent::Handle will create and use a
…		…
315		468
316	sub new {	469	sub new {
317	my $class = shift;	470	my $class = shift;
318	my $self = bless { @_ }, $class;	471	my $self = bless { @_ }, $class;
319		472
320	$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) = @_;
321		536
322	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	537	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
323		538
		539	$self->{_activity} =
		540	$self->{_ractivity} =
324	$self->{_activity} = AnyEvent->now;	541	$self->{_wactivity} = AE::now;
325	$self->_timeout;
326		542
		543	$self->timeout (delete $self->{timeout} ) if $self->{timeout};
		544	$self->rtimeout (delete $self->{rtimeout} ) if $self->{rtimeout};
		545	$self->wtimeout (delete $self->{wtimeout} ) if $self->{wtimeout};
		546
327	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};	547	$self->no_delay (delete $self->{no_delay} ) if exists $self->{no_delay} && $self->{no_delay};
		548	$self->keepalive (delete $self->{keepalive}) if exists $self->{keepalive} && $self->{keepalive};
328		549
		550	$self->oobinline (exists $self->{oobinline} ? delete $self->{oobinline} : 1);
		551
329	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})	552	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
330	if $self->{tls};	553	if $self->{tls};
331		554
332	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};	555	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
333		556
334	$self->start_read	557	$self->start_read
335	if $self->{on_read};	558	if $self->{on_read} || @{ $self->{_queue} };
336		559
337	$self->{fh} && $self	560	$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	}	561	}
348		562
349	sub _error {	563	sub _error {
350	my ($self, $errno, $fatal, $message) = @_;	564	my ($self, $errno, $fatal, $message) = @_;
351		565
352	$self->_shutdown
353	if $fatal;
354
355	$! = $errno;	566	$! = $errno;
356	$message ||= "$!";	567	$message ||= "$!";
357		568
358	if ($self->{on_error}) {	569	if ($self->{on_error}) {
359	$self->{on_error}($self, $fatal, $message);	570	$self->{on_error}($self, $fatal, $message);
360	} elsif ($self->{fh}) {	571	$self->destroy if $fatal;
		572	} elsif ($self->{fh} || $self->{connect}) {
		573	$self->destroy;
361	Carp::croak "AnyEvent::Handle uncaught error: $message";	574	Carp::croak "AnyEvent::Handle uncaught error: $message";
362	}	575	}
363	}	576	}
364		577
365	=item $fh = $handle->fh	578	=item $fh = $handle->fh
…		…
390	$_[0]{on_eof} = $_[1];	603	$_[0]{on_eof} = $_[1];
391	}	604	}
392		605
393	=item $handle->on_timeout ($cb)	606	=item $handle->on_timeout ($cb)
394		607
395	Replace the current C<on_timeout> callback, or disables the callback (but	608	=item $handle->on_rtimeout ($cb)
396	not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
397	argument and method.
398		609
399	=cut	610	=item $handle->on_wtimeout ($cb)
400		611
401	sub on_timeout {	612	Replace the current C<on_timeout>, C<on_rtimeout> or C<on_wtimeout>
402	$_[0]{on_timeout} = $_[1];	613	callback, or disables the callback (but not the timeout) if C<$cb> =
403	}	614	C<undef>. See the C<timeout> constructor argument and method.
		615
		616	=cut
		617
		618	# see below
404		619
405	=item $handle->autocork ($boolean)	620	=item $handle->autocork ($boolean)
406		621
407	Enables or disables the current autocork behaviour (see C<autocork>	622	Enables or disables the current autocork behaviour (see C<autocork>
408	constructor argument). Changes will only take effect on the next write.	623	constructor argument). Changes will only take effect on the next write.
…		…
423	sub no_delay {	638	sub no_delay {
424	$_[0]{no_delay} = $_[1];	639	$_[0]{no_delay} = $_[1];
425		640
426	eval {	641	eval {
427	local $SIG{__DIE__};	642	local $SIG{__DIE__};
428	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];	643	setsockopt $_[0]{fh}, Socket::IPPROTO_TCP (), Socket::TCP_NODELAY (), int $_[1]
		644	if $_[0]{fh};
429	};	645	};
430	}	646	}
431		647
		648	=item $handle->keepalive ($boolean)
		649
		650	Enables or disables the C<keepalive> setting (see constructor argument of
		651	the same name for details).
		652
		653	=cut
		654
		655	sub keepalive {
		656	$_[0]{keepalive} = $_[1];
		657
		658	eval {
		659	local $SIG{__DIE__};
		660	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
		661	if $_[0]{fh};
		662	};
		663	}
		664
		665	=item $handle->oobinline ($boolean)
		666
		667	Enables or disables the C<oobinline> setting (see constructor argument of
		668	the same name for details).
		669
		670	=cut
		671
		672	sub oobinline {
		673	$_[0]{oobinline} = $_[1];
		674
		675	eval {
		676	local $SIG{__DIE__};
		677	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_OOBINLINE (), int $_[1]
		678	if $_[0]{fh};
		679	};
		680	}
		681
		682	=item $handle->keepalive ($boolean)
		683
		684	Enables or disables the C<keepalive> setting (see constructor argument of
		685	the same name for details).
		686
		687	=cut
		688
		689	sub keepalive {
		690	$_[0]{keepalive} = $_[1];
		691
		692	eval {
		693	local $SIG{__DIE__};
		694	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
		695	if $_[0]{fh};
		696	};
		697	}
		698
		699	=item $handle->on_starttls ($cb)
		700
		701	Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument).
		702
		703	=cut
		704
		705	sub on_starttls {
		706	$_[0]{on_starttls} = $_[1];
		707	}
		708
		709	=item $handle->on_stoptls ($cb)
		710
		711	Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).
		712
		713	=cut
		714
		715	sub on_stoptls {
		716	$_[0]{on_stoptls} = $_[1];
		717	}
		718
		719	=item $handle->rbuf_max ($max_octets)
		720
		721	Configures the C<rbuf_max> setting (C<undef> disables it).
		722
		723	=cut
		724
		725	sub rbuf_max {
		726	$_[0]{rbuf_max} = $_[1];
		727	}
		728
432	#############################################################################	729	#############################################################################
433		730
434	=item $handle->timeout ($seconds)	731	=item $handle->timeout ($seconds)
435		732
		733	=item $handle->rtimeout ($seconds)
		734
		735	=item $handle->wtimeout ($seconds)
		736
436	Configures (or disables) the inactivity timeout.	737	Configures (or disables) the inactivity timeout.
437		738
438	=cut	739	=item $handle->timeout_reset
439		740
440	sub timeout {	741	=item $handle->rtimeout_reset
		742
		743	=item $handle->wtimeout_reset
		744
		745	Reset the activity timeout, as if data was received or sent.
		746
		747	These methods are cheap to call.
		748
		749	=cut
		750
		751	for my $dir ("", "r", "w") {
		752	my $timeout = "${dir}timeout";
		753	my $tw = "_${dir}tw";
		754	my $on_timeout = "on_${dir}timeout";
		755	my $activity = "_${dir}activity";
		756	my $cb;
		757
		758	*$on_timeout = sub {
		759	$_[0]{$on_timeout} = $_[1];
		760	};
		761
		762	*$timeout = sub {
441	my ($self, $timeout) = @_;	763	my ($self, $new_value) = @_;
442		764
443	$self->{timeout} = $timeout;	765	$self->{$timeout} = $new_value;
444	$self->_timeout;	766	delete $self->{$tw}; &$cb;
445	}	767	};
446		768
		769	*{"${dir}timeout_reset"} = sub {
		770	$_[0]{$activity} = AE::now;
		771	};
		772
		773	# main workhorse:
447	# reset the timeout watcher, as neccessary	774	# reset the timeout watcher, as neccessary
448	# also check for time-outs	775	# also check for time-outs
449	sub _timeout {	776	$cb = sub {
450	my ($self) = @_;	777	my ($self) = @_;
451		778
452	if ($self->{timeout}) {	779	if ($self->{$timeout} && $self->{fh}) {
453	my $NOW = AnyEvent->now;	780	my $NOW = AE::now;
454		781
455	# when would the timeout trigger?	782	# when would the timeout trigger?
456	my $after = $self->{_activity} + $self->{timeout} - $NOW;	783	my $after = $self->{$activity} + $self->{$timeout} - $NOW;
457		784
458	# now or in the past already?	785	# now or in the past already?
459	if ($after <= 0) {	786	if ($after <= 0) {
460	$self->{_activity} = $NOW;	787	$self->{$activity} = $NOW;
461		788
462	if ($self->{on_timeout}) {	789	if ($self->{$on_timeout}) {
463	$self->{on_timeout}($self);	790	$self->{$on_timeout}($self);
464	} else {	791	} else {
465	$self->_error (&Errno::ETIMEDOUT);	792	$self->_error (Errno::ETIMEDOUT);
		793	}
		794
		795	# callback could have changed timeout value, optimise
		796	return unless $self->{$timeout};
		797
		798	# calculate new after
		799	$after = $self->{$timeout};
466	}	800	}
467		801
468	# callback could have changed timeout value, optimise	802	Scalar::Util::weaken $self;
469	return unless $self->{timeout};	803	return unless $self; # ->error could have destroyed $self
470		804
471	# calculate new after	805	$self->{$tw} ||= AE::timer $after, 0, sub {
472	$after = $self->{timeout};	806	delete $self->{$tw};
		807	$cb->($self);
		808	};
		809	} else {
		810	delete $self->{$tw};
473	}	811	}
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	}	812	}
485	}	813	}
486		814
487	#############################################################################	815	#############################################################################
488		816
…		…
503		831
504	=item $handle->on_drain ($cb)	832	=item $handle->on_drain ($cb)
505		833
506	Sets the C<on_drain> callback or clears it (see the description of	834	Sets the C<on_drain> callback or clears it (see the description of
507	C<on_drain> in the constructor).	835	C<on_drain> in the constructor).
		836
		837	This method may invoke callbacks (and therefore the handle might be
		838	destroyed after it returns).
508		839
509	=cut	840	=cut
510		841
511	sub on_drain {	842	sub on_drain {
512	my ($self, $cb) = @_;	843	my ($self, $cb) = @_;
…		…
521		852
522	Queues the given scalar to be written. You can push as much data as you	853	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>	854	want (only limited by the available memory), as C<AnyEvent::Handle>
524	buffers it independently of the kernel.	855	buffers it independently of the kernel.
525		856
		857	This method may invoke callbacks (and therefore the handle might be
		858	destroyed after it returns).
		859
526	=cut	860	=cut
527		861
528	sub _drain_wbuf {	862	sub _drain_wbuf {
529	my ($self) = @_;	863	my ($self) = @_;
530		864
…		…
533	Scalar::Util::weaken $self;	867	Scalar::Util::weaken $self;
534		868
535	my $cb = sub {	869	my $cb = sub {
536	my $len = syswrite $self->{fh}, $self->{wbuf};	870	my $len = syswrite $self->{fh}, $self->{wbuf};
537		871
538	if ($len >= 0) {	872	if (defined $len) {
539	substr $self->{wbuf}, 0, $len, "";	873	substr $self->{wbuf}, 0, $len, "";
540		874
541	$self->{_activity} = AnyEvent->now;	875	$self->{_activity} = $self->{_wactivity} = AE::now;
542		876
543	$self->{on_drain}($self)	877	$self->{on_drain}($self)
544	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})	878	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
545	&& $self->{on_drain};	879	&& $self->{on_drain};
546		880
…		…
552		886
553	# try to write data immediately	887	# try to write data immediately
554	$cb->() unless $self->{autocork};	888	$cb->() unless $self->{autocork};
555		889
556	# if still data left in wbuf, we need to poll	890	# if still data left in wbuf, we need to poll
557	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	891	$self->{_ww} = AE::io $self->{fh}, 1, $cb
558	if length $self->{wbuf};	892	if length $self->{wbuf};
559	};	893	};
560	}	894	}
561		895
562	our %WH;	896	our %WH;
563		897
		898	# deprecated
564	sub register_write_type($$) {	899	sub register_write_type($$) {
565	$WH{$_[0]} = $_[1];	900	$WH{$_[0]} = $_[1];
566	}	901	}
567		902
568	sub push_write {	903	sub push_write {
569	my $self = shift;	904	my $self = shift;
570		905
571	if (@_ > 1) {	906	if (@_ > 1) {
572	my $type = shift;	907	my $type = shift;
573		908
		909	@_ = ($WH{$type} ||= _load_func "$type\::anyevent_write_type"
574	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	910	or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_write")
575	->($self, @_);	911	->($self, @_);
576	}	912	}
577		913
		914	# we downgrade here to avoid hard-to-track-down bugs,
		915	# and diagnose the problem earlier and better.
		916
578	if ($self->{tls}) {	917	if ($self->{tls}) {
579	$self->{_tls_wbuf} .= $_[0];	918	utf8::downgrade $self->{_tls_wbuf} .= $_[0];
580		919	&_dotls ($self) if $self->{fh};
581	&_dotls ($self);
582	} else {	920	} else {
583	$self->{wbuf} .= $_[0];	921	utf8::downgrade $self->{wbuf} .= $_[0];
584	$self->_drain_wbuf;	922	$self->_drain_wbuf if $self->{fh};
585	}	923	}
586	}	924	}
587		925
588	=item $handle->push_write (type => @args)	926	=item $handle->push_write (type => @args)
589		927
590	Instead of formatting your data yourself, you can also let this module do	928	Instead of formatting your data yourself, you can also let this module
591	the job by specifying a type and type-specific arguments.	929	do the job by specifying a type and type-specific arguments. You
		930	can also specify the (fully qualified) name of a package, in which
		931	case AnyEvent tries to load the package and then expects to find the
		932	C<anyevent_read_type> function inside (see "custom write types", below).
592		933
593	Predefined types are (if you have ideas for additional types, feel free to	934	Predefined types are (if you have ideas for additional types, feel free to
594	drop by and tell us):	935	drop by and tell us):
595		936
596	=over 4	937	=over 4
…		…
653	Other languages could read single lines terminated by a newline and pass	994	Other languages could read single lines terminated by a newline and pass
654	this line into their JSON decoder of choice.	995	this line into their JSON decoder of choice.
655		996
656	=cut	997	=cut
657		998
		999	sub json_coder() {
		1000	eval { require JSON::XS; JSON::XS->new->utf8 }
		1001	|| do { require JSON; JSON->new->utf8 }
		1002	}
		1003
658	register_write_type json => sub {	1004	register_write_type json => sub {
659	my ($self, $ref) = @_;	1005	my ($self, $ref) = @_;
660		1006
661	require JSON;	1007	my $json = $self->{json} ||= json_coder;
662		1008
663	$self->{json} ? $self->{json}->encode ($ref)	1009	$json->encode ($ref)
664	: JSON::encode_json ($ref)
665	};	1010	};
666		1011
667	=item storable => $reference	1012	=item storable => $reference
668		1013
669	Freezes the given reference using L<Storable> and writes it to the	1014	Freezes the given reference using L<Storable> and writes it to the
…		…
683		1028
684	=item $handle->push_shutdown	1029	=item $handle->push_shutdown
685		1030
686	Sometimes you know you want to close the socket after writing your data	1031	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	1032	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	1033	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:	1034	C<low_water_mark> to C<0>). This method is a shorthand for just that, and
		1035	replaces the C<on_drain> callback with:
690		1036
691	sub { shutdown $_[0]{fh}, 1 } # for push_shutdown	1037	sub { shutdown $_[0]{fh}, 1 } # for push_shutdown
692		1038
693	This simply shuts down the write side and signals an EOF condition to the	1039	This simply shuts down the write side and signals an EOF condition to the
694	the peer.	1040	the peer.
695		1041
696	You can rely on the normal read queue and C<on_eof> handling	1042	You can rely on the normal read queue and C<on_eof> handling
697	afterwards. This is the cleanest way to close a connection.	1043	afterwards. This is the cleanest way to close a connection.
698		1044
		1045	This method may invoke callbacks (and therefore the handle might be
		1046	destroyed after it returns).
		1047
699	=cut	1048	=cut
700		1049
701	sub push_shutdown {	1050	sub push_shutdown {
		1051	my ($self) = @_;
		1052
		1053	delete $self->{low_water_mark};
702	$_[0]->{on_drain} = sub { shutdown $_[0]{fh}, 1 };	1054	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });
703	}	1055	}
704		1056
705	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	1057	=item custom write types - Package::anyevent_write_type $handle, @args
706		1058
707	This function (not method) lets you add your own types to C<push_write>.	1059	Instead of one of the predefined types, you can also specify the name of
		1060	a package. AnyEvent will try to load the package and then expects to find
		1061	a function named C<anyevent_write_type> inside. If it isn't found, it
		1062	progressively tries to load the parent package until it either finds the
		1063	function (good) or runs out of packages (bad).
		1064
708	Whenever the given C<type> is used, C<push_write> will invoke the code	1065	Whenever the given C<type> is used, C<push_write> will the function with
709	reference with the handle object and the remaining arguments.	1066	the handle object and the remaining arguments.
710		1067
711	The code reference is supposed to return a single octet string that will	1068	The function is supposed to return a single octet string that will be
712	be appended to the write buffer.	1069	appended to the write buffer, so you cna mentally treat this function as a
		1070	"arguments to on-the-wire-format" converter.
713		1071
714	Note that this is a function, and all types registered this way will be	1072	Example: implement a custom write type C<join> that joins the remaining
715	global, so try to use unique names.	1073	arguments using the first one.
		1074
		1075	$handle->push_write (My::Type => " ", 1,2,3);
		1076
		1077	# uses the following package, which can be defined in the "My::Type" or in
		1078	# the "My" modules to be auto-loaded, or just about anywhere when the
		1079	# My::Type::anyevent_write_type is defined before invoking it.
		1080
		1081	package My::Type;
		1082
		1083	sub anyevent_write_type {
		1084	my ($handle, $delim, @args) = @_;
		1085
		1086	join $delim, @args
		1087	}
716		1088
717	=cut	1089	=cut
718		1090
719	#############################################################################	1091	#############################################################################
720		1092
…		…
802	=cut	1174	=cut
803		1175
804	sub _drain_rbuf {	1176	sub _drain_rbuf {
805	my ($self) = @_;	1177	my ($self) = @_;
806		1178
		1179	# avoid recursion
		1180	return if $self->{_skip_drain_rbuf};
807	local $self->{_in_drain} = 1;	1181	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		1182
816	while () {	1183	while () {
817	# we need to use a separate tls read buffer, as we must not receive data while	1184	# 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.	1185	# we are draining the buffer, and this can only happen with TLS.
819	$self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf};	1186	$self->{rbuf} .= delete $self->{_tls_rbuf}
		1187	if exists $self->{_tls_rbuf};
820		1188
821	my $len = length $self->{rbuf};	1189	my $len = length $self->{rbuf};
822		1190
823	if (my $cb = shift @{ $self->{_queue} }) {	1191	if (my $cb = shift @{ $self->{_queue} }) {
824	unless ($cb->($self)) {	1192	unless ($cb->($self)) {
825	if ($self->{_eof}) {	1193	# no progress can be made
826	# no progress can be made (not enough data and no data forthcoming)	1194	# (not enough data and no data forthcoming)
827	$self->_error (&Errno::EPIPE, 1), return;	1195	$self->_error (Errno::EPIPE, 1), return
828	}	1196	if $self->{_eof};
829		1197
830	unshift @{ $self->{_queue} }, $cb;	1198	unshift @{ $self->{_queue} }, $cb;
831	last;	1199	last;
832	}	1200	}
833	} elsif ($self->{on_read}) {	1201	} elsif ($self->{on_read}) {
…		…
840	&& !@{ $self->{_queue} } # and the queue is still empty	1208	&& !@{ $self->{_queue} } # and the queue is still empty
841	&& $self->{on_read} # but we still have on_read	1209	&& $self->{on_read} # but we still have on_read
842	) {	1210	) {
843	# no further data will arrive	1211	# no further data will arrive
844	# so no progress can be made	1212	# so no progress can be made
845	$self->_error (&Errno::EPIPE, 1), return	1213	$self->_error (Errno::EPIPE, 1), return
846	if $self->{_eof};	1214	if $self->{_eof};
847		1215
848	last; # more data might arrive	1216	last; # more data might arrive
849	}	1217	}
850	} else {	1218	} else {
…		…
853	last;	1221	last;
854	}	1222	}
855	}	1223	}
856		1224
857	if ($self->{_eof}) {	1225	if ($self->{_eof}) {
858	if ($self->{on_eof}) {	1226	$self->{on_eof}
859	$self->{on_eof}($self)	1227	? $self->{on_eof}($self)
860	} else {	1228	: $self->_error (0, 1, "Unexpected end-of-file");
861	$self->_error (0, 1);	1229
862	}	1230	return;
		1231	}
		1232
		1233	if (
		1234	defined $self->{rbuf_max}
		1235	&& $self->{rbuf_max} < length $self->{rbuf}
		1236	) {
		1237	$self->_error (Errno::ENOSPC, 1), return;
863	}	1238	}
864		1239
865	# may need to restart read watcher	1240	# may need to restart read watcher
866	unless ($self->{_rw}) {	1241	unless ($self->{_rw}) {
867	$self->start_read	1242	$self->start_read
…		…
873		1248
874	This replaces the currently set C<on_read> callback, or clears it (when	1249	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	1250	the new callback is C<undef>). See the description of C<on_read> in the
876	constructor.	1251	constructor.
877		1252
		1253	This method may invoke callbacks (and therefore the handle might be
		1254	destroyed after it returns).
		1255
878	=cut	1256	=cut
879		1257
880	sub on_read {	1258	sub on_read {
881	my ($self, $cb) = @_;	1259	my ($self, $cb) = @_;
882		1260
883	$self->{on_read} = $cb;	1261	$self->{on_read} = $cb;
884	$self->_drain_rbuf if $cb && !$self->{_in_drain};	1262	$self->_drain_rbuf if $cb;
885	}	1263	}
886		1264
887	=item $handle->rbuf	1265	=item $handle->rbuf
888		1266
889	Returns the read buffer (as a modifiable lvalue).	1267	Returns the read buffer (as a modifiable lvalue).
…		…
921		1299
922	If enough data was available, then the callback must remove all data it is	1300	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	1301	interested in (which can be none at all) and return a true value. After returning
924	true, it will be removed from the queue.	1302	true, it will be removed from the queue.
925		1303
		1304	These methods may invoke callbacks (and therefore the handle might be
		1305	destroyed after it returns).
		1306
926	=cut	1307	=cut
927		1308
928	our %RH;	1309	our %RH;
929		1310
930	sub register_read_type($$) {	1311	sub register_read_type($$) {
…		…
936	my $cb = pop;	1317	my $cb = pop;
937		1318
938	if (@_) {	1319	if (@_) {
939	my $type = shift;	1320	my $type = shift;
940		1321
		1322	$cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type"
941	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	1323	or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_read")
942	->($self, $cb, @_);	1324	->($self, $cb, @_);
943	}	1325	}
944		1326
945	push @{ $self->{_queue} }, $cb;	1327	push @{ $self->{_queue} }, $cb;
946	$self->_drain_rbuf unless $self->{_in_drain};	1328	$self->_drain_rbuf;
947	}	1329	}
948		1330
949	sub unshift_read {	1331	sub unshift_read {
950	my $self = shift;	1332	my $self = shift;
951	my $cb = pop;	1333	my $cb = pop;
…		…
955		1337
956	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")	1338	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")
957	->($self, $cb, @_);	1339	->($self, $cb, @_);
958	}	1340	}
959		1341
960
961	unshift @{ $self->{_queue} }, $cb;	1342	unshift @{ $self->{_queue} }, $cb;
962	$self->_drain_rbuf unless $self->{_in_drain};	1343	$self->_drain_rbuf;
963	}	1344	}
964		1345
965	=item $handle->push_read (type => @args, $cb)	1346	=item $handle->push_read (type => @args, $cb)
966		1347
967	=item $handle->unshift_read (type => @args, $cb)	1348	=item $handle->unshift_read (type => @args, $cb)
968		1349
969	Instead of providing a callback that parses the data itself you can chose	1350	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	1351	between a number of predefined parsing formats, for chunks of data, lines
971	etc.	1352	etc. You can also specify the (fully qualified) name of a package, in
		1353	which case AnyEvent tries to load the package and then expects to find the
		1354	C<anyevent_read_type> function inside (see "custom read types", below).
972		1355
973	Predefined types are (if you have ideas for additional types, feel free to	1356	Predefined types are (if you have ideas for additional types, feel free to
974	drop by and tell us):	1357	drop by and tell us):
975		1358
976	=over 4	1359	=over 4
…		…
1100	return 1;	1483	return 1;
1101	}	1484	}
1102		1485
1103	# reject	1486	# reject
1104	if ($reject && $$rbuf =~ $reject) {	1487	if ($reject && $$rbuf =~ $reject) {
1105	$self->_error (&Errno::EBADMSG);	1488	$self->_error (Errno::EBADMSG);
1106	}	1489	}
1107		1490
1108	# skip	1491	# skip
1109	if ($skip && $$rbuf =~ $skip) {	1492	if ($skip && $$rbuf =~ $skip) {
1110	$data .= substr $$rbuf, 0, $+[0], "";	1493	$data .= substr $$rbuf, 0, $+[0], "";
…		…
1126	my ($self, $cb) = @_;	1509	my ($self, $cb) = @_;
1127		1510
1128	sub {	1511	sub {
1129	unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {	1512	unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {
1130	if ($_[0]{rbuf} =~ /[^0-9]/) {	1513	if ($_[0]{rbuf} =~ /[^0-9]/) {
1131	$self->_error (&Errno::EBADMSG);	1514	$self->_error (Errno::EBADMSG);
1132	}	1515	}
1133	return;	1516	return;
1134	}	1517	}
1135		1518
1136	my $len = $1;	1519	my $len = $1;
…		…
1139	my $string = $_[1];	1522	my $string = $_[1];
1140	$_[0]->unshift_read (chunk => 1, sub {	1523	$_[0]->unshift_read (chunk => 1, sub {
1141	if ($_[1] eq ",") {	1524	if ($_[1] eq ",") {
1142	$cb->($_[0], $string);	1525	$cb->($_[0], $string);
1143	} else {	1526	} else {
1144	$self->_error (&Errno::EBADMSG);	1527	$self->_error (Errno::EBADMSG);
1145	}	1528	}
1146	});	1529	});
1147	});	1530	});
1148		1531
1149	1	1532	1
…		…
1216	=cut	1599	=cut
1217		1600
1218	register_read_type json => sub {	1601	register_read_type json => sub {
1219	my ($self, $cb) = @_;	1602	my ($self, $cb) = @_;
1220		1603
1221	require JSON;	1604	my $json = $self->{json} ||= json_coder;
1222		1605
1223	my $data;	1606	my $data;
1224	my $rbuf = \$self->{rbuf};	1607	my $rbuf = \$self->{rbuf};
1225
1226	my $json = $self->{json} ||= JSON->new->utf8;
1227		1608
1228	sub {	1609	sub {
1229	my $ref = eval { $json->incr_parse ($self->{rbuf}) };	1610	my $ref = eval { $json->incr_parse ($self->{rbuf}) };
1230		1611
1231	if ($ref) {	1612	if ($ref) {
…		…
1239	$json->incr_skip;	1620	$json->incr_skip;
1240		1621
1241	$self->{rbuf} = $json->incr_text;	1622	$self->{rbuf} = $json->incr_text;
1242	$json->incr_text = "";	1623	$json->incr_text = "";
1243		1624
1244	$self->_error (&Errno::EBADMSG);	1625	$self->_error (Errno::EBADMSG);
1245		1626
1246	()	1627	()
1247	} else {	1628	} else {
1248	$self->{rbuf} = "";	1629	$self->{rbuf} = "";
1249		1630
…		…
1286	# read remaining chunk	1667	# read remaining chunk
1287	$_[0]->unshift_read (chunk => $len, sub {	1668	$_[0]->unshift_read (chunk => $len, sub {
1288	if (my $ref = eval { Storable::thaw ($_[1]) }) {	1669	if (my $ref = eval { Storable::thaw ($_[1]) }) {
1289	$cb->($_[0], $ref);	1670	$cb->($_[0], $ref);
1290	} else {	1671	} else {
1291	$self->_error (&Errno::EBADMSG);	1672	$self->_error (Errno::EBADMSG);
1292	}	1673	}
1293	});	1674	});
1294	}	1675	}
1295		1676
1296	1	1677	1
1297	}	1678	}
1298	};	1679	};
1299		1680
1300	=back	1681	=back
1301		1682
1302	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)	1683	=item custom read types - Package::anyevent_read_type $handle, $cb, @args
1303		1684
1304	This function (not method) lets you add your own types to C<push_read>.	1685	Instead of one of the predefined types, you can also specify the name
		1686	of a package. AnyEvent will try to load the package and then expects to
		1687	find a function named C<anyevent_read_type> inside. If it isn't found, it
		1688	progressively tries to load the parent package until it either finds the
		1689	function (good) or runs out of packages (bad).
1305		1690
1306	Whenever the given C<type> is used, C<push_read> will invoke the code	1691	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	1692	handle object, the original callback and the remaining arguments.
1308	arguments.
1309		1693
1310	The code reference is supposed to return a callback (usually a closure)	1694	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) >>).	1695	works as a plain read callback (see C<< ->push_read ($cb) >>), so you can
		1696	mentally treat the function as a "configurable read type to read callback"
		1697	converter.
1312		1698
1313	It should invoke the passed callback when it is done reading (remember to	1699	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).	1700	to pass C<$handle> as first argument as all other callbacks do that,
		1701	although there is no strict requirement on this).
1315		1702
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>,	1703	For examples, see the source of this module (F<perldoc -m
1320	search for C<register_read_type>)).	1704	AnyEvent::Handle>, search for C<register_read_type>)).
1321		1705
1322	=item $handle->stop_read	1706	=item $handle->stop_read
1323		1707
1324	=item $handle->start_read	1708	=item $handle->start_read
1325		1709
…		…
1345	}	1729	}
1346		1730
1347	sub start_read {	1731	sub start_read {
1348	my ($self) = @_;	1732	my ($self) = @_;
1349		1733
1350	unless ($self->{_rw} || $self->{_eof}) {	1734	unless ($self->{_rw} || $self->{_eof} || !$self->{fh}) {
1351	Scalar::Util::weaken $self;	1735	Scalar::Util::weaken $self;
1352		1736
1353	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1737	$self->{_rw} = AE::io $self->{fh}, 0, sub {
1354	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});	1738	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1355	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf;	1739	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf;
1356		1740
1357	if ($len > 0) {	1741	if ($len > 0) {
1358	$self->{_activity} = AnyEvent->now;	1742	$self->{_activity} = $self->{_ractivity} = AE::now;
1359		1743
1360	if ($self->{tls}) {	1744	if ($self->{tls}) {
1361	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);	1745	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1362		1746
1363	&_dotls ($self);	1747	&_dotls ($self);
1364	} else {	1748	} else {
1365	$self->_drain_rbuf unless $self->{_in_drain};	1749	$self->_drain_rbuf;
1366	}	1750	}
1367		1751
1368	} elsif (defined $len) {	1752	} elsif (defined $len) {
1369	delete $self->{_rw};	1753	delete $self->{_rw};
1370	$self->{_eof} = 1;	1754	$self->{_eof} = 1;
1371	$self->_drain_rbuf unless $self->{_in_drain};	1755	$self->_drain_rbuf;
1372		1756
1373	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1757	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1374	return $self->_error ($!, 1);	1758	return $self->_error ($!, 1);
1375	}	1759	}
1376	});	1760	};
1377	}	1761	}
1378	}	1762	}
1379		1763
1380	our $ERROR_SYSCALL;	1764	our $ERROR_SYSCALL;
1381	our $ERROR_WANT_READ;	1765	our $ERROR_WANT_READ;
1382	our $ERROR_ZERO_RETURN;
1383		1766
1384	sub _tls_error {	1767	sub _tls_error {
1385	my ($self, $err) = @_;	1768	my ($self, $err) = @_;
1386	warn "$err,$!\n";#d#
1387		1769
1388	return $self->_error ($!, 1)	1770	return $self->_error ($!, 1)
1389	if $err == Net::SSLeay::ERROR_SYSCALL ();	1771	if $err == Net::SSLeay::ERROR_SYSCALL ();
1390		1772
		1773	my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());
		1774
		1775	# reduce error string to look less scary
		1776	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;
		1777
		1778	if ($self->{_on_starttls}) {
		1779	(delete $self->{_on_starttls})->($self, undef, $err);
		1780	&_freetls;
		1781	} else {
		1782	&_freetls;
1391	$self->_error (&Errno::EPROTO, 1,	1783	$self->_error (Errno::EPROTO, 1, $err);
1392	Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ()));	1784	}
1393	}	1785	}
1394		1786
1395	# poll the write BIO and send the data if applicable	1787	# poll the write BIO and send the data if applicable
1396	# also decode read data if possible	1788	# also decode read data if possible
1397	# this is basiclaly our TLS state machine	1789	# this is basiclaly our TLS state machine
…		…
1408	}	1800	}
1409		1801
1410	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);	1802	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);
1411	return $self->_tls_error ($tmp)	1803	return $self->_tls_error ($tmp)
1412	if $tmp != $ERROR_WANT_READ	1804	if $tmp != $ERROR_WANT_READ
1413	&& ($tmp != $ERROR_SYSCALL || $!)	1805	&& ($tmp != $ERROR_SYSCALL || $!);
1414	&& $tmp != $ERROR_ZERO_RETURN;
1415	}	1806	}
1416		1807
1417	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {	1808	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
1418	unless (length $tmp) {	1809	unless (length $tmp) {
1419	# let's treat SSL-eof as we treat normal EOF	1810	$self->{_on_starttls}
1420	delete $self->{_rw};	1811	and (delete $self->{_on_starttls})->($self, undef, "EOF during handshake"); # ???
1421	$self->{_eof} = 1;
1422	&_freetls;	1812	&_freetls;
		1813
		1814	if ($self->{on_stoptls}) {
		1815	$self->{on_stoptls}($self);
		1816	return;
		1817	} else {
		1818	# let's treat SSL-eof as we treat normal EOF
		1819	delete $self->{_rw};
		1820	$self->{_eof} = 1;
		1821	}
1423	}	1822	}
1424		1823
1425	$self->{_tls_rbuf} .= $tmp;	1824	$self->{_tls_rbuf} .= $tmp;
1426	$self->_drain_rbuf unless $self->{_in_drain};	1825	$self->_drain_rbuf;
1427	$self->{tls} or return; # tls session might have gone away in callback	1826	$self->{tls} or return; # tls session might have gone away in callback
1428	}	1827	}
1429		1828
1430	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);	1829	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1431	return $self->_tls_error ($tmp)	1830	return $self->_tls_error ($tmp)
1432	if $tmp != $ERROR_WANT_READ	1831	if $tmp != $ERROR_WANT_READ
1433	&& ($tmp != $ERROR_SYSCALL || $!)	1832	&& ($tmp != $ERROR_SYSCALL || $!);
1434	&& $tmp != $ERROR_ZERO_RETURN;
1435		1833
1436	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1834	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1437	$self->{wbuf} .= $tmp;	1835	$self->{wbuf} .= $tmp;
1438	$self->_drain_wbuf;	1836	$self->_drain_wbuf;
		1837	$self->{tls} or return; # tls session might have gone away in callback
1439	}	1838	}
		1839
		1840	$self->{_on_starttls}
		1841	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
		1842	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");
1440	}	1843	}
1441		1844
1442	=item $handle->starttls ($tls[, $tls_ctx])	1845	=item $handle->starttls ($tls[, $tls_ctx])
1443		1846
1444	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	1847	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
1445	object is created, you can also do that at a later time by calling	1848	object is created, you can also do that at a later time by calling
1446	C<starttls>.	1849	C<starttls>.
		1850
		1851	Starting TLS is currently an asynchronous operation - when you push some
		1852	write data and then call C<< ->starttls >> then TLS negotiation will start
		1853	immediately, after which the queued write data is then sent.
1447		1854
1448	The first argument is the same as the C<tls> constructor argument (either	1855	The first argument is the same as the C<tls> constructor argument (either
1449	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1856	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1450		1857
1451	The second argument is the optional C<AnyEvent::TLS> object that is used	1858	The second argument is the optional C<AnyEvent::TLS> object that is used
…		…
1456	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS	1863	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS
1457	context in C<< $handle->{tls_ctx} >> after this call and can be used or	1864	context in C<< $handle->{tls_ctx} >> after this call and can be used or
1458	changed to your liking. Note that the handshake might have already started	1865	changed to your liking. Note that the handshake might have already started
1459	when this function returns.	1866	when this function returns.
1460		1867
1461	If it an error to start a TLS handshake more than once per	1868	Due to bugs in OpenSSL, it might or might not be possible to do multiple
1462	AnyEvent::Handle object (this is due to bugs in OpenSSL).	1869	handshakes on the same stream. Best do not attempt to use the stream after
		1870	stopping TLS.
1463		1871
		1872	This method may invoke callbacks (and therefore the handle might be
		1873	destroyed after it returns).
		1874
1464	=cut	1875	=cut
		1876
		1877	our %TLS_CACHE; #TODO not yet documented, should we?
1465		1878
1466	sub starttls {	1879	sub starttls {
1467	my ($self, $ssl, $ctx) = @_;	1880	my ($self, $tls, $ctx) = @_;
		1881
		1882	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"
		1883	if $self->{tls};
		1884
		1885	$self->{tls} = $tls;
		1886	$self->{tls_ctx} = $ctx if @_ > 2;
		1887
		1888	return unless $self->{fh};
1468		1889
1469	require Net::SSLeay;	1890	require Net::SSLeay;
1470		1891
1471	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"
1472	if $self->{tls};
1473
1474	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();	1892	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1475	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();	1893	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1476	$ERROR_ZERO_RETURN = Net::SSLeay::ERROR_ZERO_RETURN ();
1477		1894
		1895	$tls = delete $self->{tls};
1478	$ctx ||= $self->{tls_ctx};	1896	$ctx = $self->{tls_ctx};
		1897
		1898	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
1479		1899
1480	if ("HASH" eq ref $ctx) {	1900	if ("HASH" eq ref $ctx) {
1481	require AnyEvent::TLS;	1901	require AnyEvent::TLS;
1482		1902
1483	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context	1903	if ($ctx->{cache}) {
		1904	my $key = $ctx+0;
		1905	$ctx = $TLS_CACHE{$key} ||= new AnyEvent::TLS %$ctx;
		1906	} else {
1484	$ctx = new AnyEvent::TLS %$ctx;	1907	$ctx = new AnyEvent::TLS %$ctx;
		1908	}
1485	}	1909	}
1486		1910
1487	$self->{tls_ctx} = $ctx || TLS_CTX ();	1911	$self->{tls_ctx} = $ctx || TLS_CTX ();
1488	$self->{tls} = $ssl = $self->{tls_ctx}->_get_session ($ssl, $self, $self->{peername});	1912	$self->{tls} = $tls = $self->{tls_ctx}->_get_session ($tls, $self, $self->{peername});
1489		1913
1490	# basically, this is deep magic (because SSL_read should have the same issues)	1914	# basically, this is deep magic (because SSL_read should have the same issues)
1491	# but the openssl maintainers basically said: "trust us, it just works".	1915	# but the openssl maintainers basically said: "trust us, it just works".
1492	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1916	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1493	# and mismaintained ssleay-module doesn't even offer them).	1917	# and mismaintained ssleay-module doesn't even offer them).
…		…
1500	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to	1924	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
1501	# have identity issues in that area.	1925	# have identity issues in that area.
1502	# Net::SSLeay::CTX_set_mode ($ssl,	1926	# Net::SSLeay::CTX_set_mode ($ssl,
1503	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)	1927	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)
1504	# | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));	1928	# | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));
1505	Net::SSLeay::CTX_set_mode ($ssl, 1|2);	1929	Net::SSLeay::CTX_set_mode ($tls, 1|2);
1506		1930
1507	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1931	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1508	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1932	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1509		1933
		1934	Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf});
		1935
1510	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1936	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
		1937
		1938	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
		1939	if $self->{on_starttls};
1511		1940
1512	&_dotls; # need to trigger the initial handshake	1941	&_dotls; # need to trigger the initial handshake
1513	$self->start_read; # make sure we actually do read	1942	$self->start_read; # make sure we actually do read
1514	}	1943	}
1515		1944
1516	=item $handle->stoptls	1945	=item $handle->stoptls
1517		1946
1518	Shuts down the SSL connection - this makes a proper EOF handshake by	1947	Shuts down the SSL connection - this makes a proper EOF handshake by
1519	sending a close notify to the other side, but since OpenSSL doesn't	1948	sending a close notify to the other side, but since OpenSSL doesn't
1520	support non-blocking shut downs, it is not possible to re-use the stream	1949	support non-blocking shut downs, it is not guaranteed that you can re-use
1521	afterwards.	1950	the stream afterwards.
		1951
		1952	This method may invoke callbacks (and therefore the handle might be
		1953	destroyed after it returns).
1522		1954
1523	=cut	1955	=cut
1524		1956
1525	sub stoptls {	1957	sub stoptls {
1526	my ($self) = @_;	1958	my ($self) = @_;
1527		1959
1528	if ($self->{tls}) {	1960	if ($self->{tls} && $self->{fh}) {
1529	Net::SSLeay::shutdown ($self->{tls});	1961	Net::SSLeay::shutdown ($self->{tls});
1530		1962
1531	&_dotls;	1963	&_dotls;
1532		1964
1533	# we don't give a shit. no, we do, but we can't. no...	1965	# # we don't give a shit. no, we do, but we can't. no...#d#
1534	# we, we... have to use openssl :/	1966	# # we, we... have to use openssl :/#d#
1535	&_freetls;	1967	# &_freetls;#d#
1536	}	1968	}
1537	}	1969	}
1538		1970
1539	sub _freetls {	1971	sub _freetls {
1540	my ($self) = @_;	1972	my ($self) = @_;
1541		1973
1542	return unless $self->{tls};	1974	return unless $self->{tls};
1543		1975
1544	$self->{tls_ctx}->_put_session (delete $self->{tls});	1976	$self->{tls_ctx}->_put_session (delete $self->{tls})
		1977	if $self->{tls} > 0;
1545		1978
1546	delete @$self{qw(_rbio _wbio _tls_wbuf)};	1979	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1547	}	1980	}
1548		1981
1549	sub DESTROY {	1982	sub DESTROY {
1550	my ($self) = @_;	1983	my ($self) = @_;
1551		1984
1552	&_freetls;	1985	&_freetls;
1553		1986
1554	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	1987	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1555		1988
1556	if ($linger && length $self->{wbuf}) {	1989	if ($linger && length $self->{wbuf} && $self->{fh}) {
1557	my $fh = delete $self->{fh};	1990	my $fh = delete $self->{fh};
1558	my $wbuf = delete $self->{wbuf};	1991	my $wbuf = delete $self->{wbuf};
1559		1992
1560	my @linger;	1993	my @linger;
1561		1994
1562	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {	1995	push @linger, AE::io $fh, 1, sub {
1563	my $len = syswrite $fh, $wbuf, length $wbuf;	1996	my $len = syswrite $fh, $wbuf, length $wbuf;
1564		1997
1565	if ($len > 0) {	1998	if ($len > 0) {
1566	substr $wbuf, 0, $len, "";	1999	substr $wbuf, 0, $len, "";
1567	} else {	2000	} else {
1568	@linger = (); # end	2001	@linger = (); # end
1569	}	2002	}
1570	});	2003	};
1571	push @linger, AnyEvent->timer (after => $linger, cb => sub {	2004	push @linger, AE::timer $linger, 0, sub {
1572	@linger = ();	2005	@linger = ();
1573	});	2006	};
1574	}	2007	}
1575	}	2008	}
1576		2009
1577	=item $handle->destroy	2010	=item $handle->destroy
1578		2011
1579	Shuts down the handle object as much as possible - this call ensures that	2012	Shuts down the handle object as much as possible - this call ensures that
1580	no further callbacks will be invoked and resources will be freed as much	2013	no further callbacks will be invoked and as many resources as possible
1581	as possible. You must not call any methods on the object afterwards.	2014	will be freed. Any method you will call on the handle object after
		2015	destroying it in this way will be silently ignored (and it will return the
		2016	empty list).
1582		2017
1583	Normally, you can just "forget" any references to an AnyEvent::Handle	2018	Normally, you can just "forget" any references to an AnyEvent::Handle
1584	object and it will simply shut down. This works in fatal error and EOF	2019	object and it will simply shut down. This works in fatal error and EOF
1585	callbacks, as well as code outside. It does I<NOT> work in a read or write	2020	callbacks, as well as code outside. It does I<NOT> work in a read or write
1586	callback, so when you want to destroy the AnyEvent::Handle object from	2021	callback, so when you want to destroy the AnyEvent::Handle object from
1587	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in	2022	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
1588	that case.	2023	that case.
1589		2024
		2025	Destroying the handle object in this way has the advantage that callbacks
		2026	will be removed as well, so if those are the only reference holders (as
		2027	is common), then one doesn't need to do anything special to break any
		2028	reference cycles.
		2029
1590	The handle might still linger in the background and write out remaining	2030	The handle might still linger in the background and write out remaining
1591	data, as specified by the C<linger> option, however.	2031	data, as specified by the C<linger> option, however.
1592		2032
1593	=cut	2033	=cut
1594		2034
1595	sub destroy {	2035	sub destroy {
1596	my ($self) = @_;	2036	my ($self) = @_;
1597		2037
1598	$self->DESTROY;	2038	$self->DESTROY;
1599	%$self = ();	2039	%$self = ();
		2040	bless $self, "AnyEvent::Handle::destroyed";
1600	}	2041	}
		2042
		2043	sub AnyEvent::Handle::destroyed::AUTOLOAD {
		2044	#nop
		2045	}
		2046
		2047	=item $handle->destroyed
		2048
		2049	Returns false as long as the handle hasn't been destroyed by a call to C<<
		2050	->destroy >>, true otherwise.
		2051
		2052	Can be useful to decide whether the handle is still valid after some
		2053	callback possibly destroyed the handle. For example, C<< ->push_write >>,
		2054	C<< ->starttls >> and other methods can call user callbacks, which in turn
		2055	can destroy the handle, so work can be avoided by checking sometimes:
		2056
		2057	$hdl->starttls ("accept");
		2058	return if $hdl->destroyed;
		2059	$hdl->push_write (...
		2060
		2061	Note that the call to C<push_write> will silently be ignored if the handle
		2062	has been destroyed, so often you can just ignore the possibility of the
		2063	handle being destroyed.
		2064
		2065	=cut
		2066
		2067	sub destroyed { 0 }
		2068	sub AnyEvent::Handle::destroyed::destroyed { 1 }
1601		2069
1602	=item AnyEvent::Handle::TLS_CTX	2070	=item AnyEvent::Handle::TLS_CTX
1603		2071
1604	This function creates and returns the AnyEvent::TLS object used by default	2072	This function creates and returns the AnyEvent::TLS object used by default
1605	for TLS mode.	2073	for TLS mode.
…		…
1661		2129
1662	$handle->on_read (sub { });	2130	$handle->on_read (sub { });
1663	$handle->on_eof (undef);	2131	$handle->on_eof (undef);
1664	$handle->on_error (sub {	2132	$handle->on_error (sub {
1665	my $data = delete $_[0]{rbuf};	2133	my $data = delete $_[0]{rbuf};
1666	undef $handle;
1667	});	2134	});
1668		2135
1669	The reason to use C<on_error> is that TCP connections, due to latencies	2136	The reason to use C<on_error> is that TCP connections, due to latencies
1670	and packets loss, might get closed quite violently with an error, when in	2137	and packets loss, might get closed quite violently with an error, when in
1671	fact, all data has been received.	2138	fact, all data has been received.
…		…
1687	$handle->on_drain (sub {	2154	$handle->on_drain (sub {
1688	warn "all data submitted to the kernel\n";	2155	warn "all data submitted to the kernel\n";
1689	undef $handle;	2156	undef $handle;
1690	});	2157	});
1691		2158
		2159	If you just want to queue some data and then signal EOF to the other side,
		2160	consider using C<< ->push_shutdown >> instead.
		2161
		2162	=item I want to contact a TLS/SSL server, I don't care about security.
		2163
		2164	If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS,
		2165	simply connect to it and then create the AnyEvent::Handle with the C<tls>
		2166	parameter:
		2167
		2168	tcp_connect $host, $port, sub {
		2169	my ($fh) = @_;
		2170
		2171	my $handle = new AnyEvent::Handle
		2172	fh => $fh,
		2173	tls => "connect",
		2174	on_error => sub { ... };
		2175
		2176	$handle->push_write (...);
		2177	};
		2178
		2179	=item I want to contact a TLS/SSL server, I do care about security.
		2180
		2181	Then you should additionally enable certificate verification, including
		2182	peername verification, if the protocol you use supports it (see
		2183	L<AnyEvent::TLS>, C<verify_peername>).
		2184
		2185	E.g. for HTTPS:
		2186
		2187	tcp_connect $host, $port, sub {
		2188	my ($fh) = @_;
		2189
		2190	my $handle = new AnyEvent::Handle
		2191	fh => $fh,
		2192	peername => $host,
		2193	tls => "connect",
		2194	tls_ctx => { verify => 1, verify_peername => "https" },
		2195	...
		2196
		2197	Note that you must specify the hostname you connected to (or whatever
		2198	"peername" the protocol needs) as the C<peername> argument, otherwise no
		2199	peername verification will be done.
		2200
		2201	The above will use the system-dependent default set of trusted CA
		2202	certificates. If you want to check against a specific CA, add the
		2203	C<ca_file> (or C<ca_cert>) arguments to C<tls_ctx>:
		2204
		2205	tls_ctx => {
		2206	verify => 1,
		2207	verify_peername => "https",
		2208	ca_file => "my-ca-cert.pem",
		2209	},
		2210
		2211	=item I want to create a TLS/SSL server, how do I do that?
		2212
		2213	Well, you first need to get a server certificate and key. You have
		2214	three options: a) ask a CA (buy one, use cacert.org etc.) b) create a
		2215	self-signed certificate (cheap. check the search engine of your choice,
		2216	there are many tutorials on the net) or c) make your own CA (tinyca2 is a
		2217	nice program for that purpose).
		2218
		2219	Then create a file with your private key (in PEM format, see
		2220	L<AnyEvent::TLS>), followed by the certificate (also in PEM format). The
		2221	file should then look like this:
		2222
		2223	-----BEGIN RSA PRIVATE KEY-----
		2224	...header data
		2225	... lots of base64'y-stuff
		2226	-----END RSA PRIVATE KEY-----
		2227
		2228	-----BEGIN CERTIFICATE-----
		2229	... lots of base64'y-stuff
		2230	-----END CERTIFICATE-----
		2231
		2232	The important bits are the "PRIVATE KEY" and "CERTIFICATE" parts. Then
		2233	specify this file as C<cert_file>:
		2234
		2235	tcp_server undef, $port, sub {
		2236	my ($fh) = @_;
		2237
		2238	my $handle = new AnyEvent::Handle
		2239	fh => $fh,
		2240	tls => "accept",
		2241	tls_ctx => { cert_file => "my-server-keycert.pem" },
		2242	...
		2243
		2244	When you have intermediate CA certificates that your clients might not
		2245	know about, just append them to the C<cert_file>.
		2246
1692	=back	2247	=back
1693		2248
1694		2249
1695	=head1 SUBCLASSING AnyEvent::Handle	2250	=head1 SUBCLASSING AnyEvent::Handle
1696		2251

Diff Legend

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