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.151 by root, Thu Jul 16 04:20:23 2009 UTC vs.
Revision 1.202 by root, Sat Oct 16 02:01:54 2010 UTC

1	package AnyEvent::Handle;
2
3	no warnings;
4	use strict qw(subs vars);
5
6	use AnyEvent ();
7	use AnyEvent::Util qw(WSAEWOULDBLOCK);
8	use Scalar::Util ();
9	use Carp ();
10	use Fcntl ();
11	use Errno qw(EAGAIN EINTR);
12
13	=head1 NAME	1	=head1 NAME
14		2
15	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent	3	AnyEvent::Handle - non-blocking I/O on streaming handles via AnyEvent
16
17	=cut
18
19	our $VERSION = 4.82;
20		4
21	=head1 SYNOPSIS	5	=head1 SYNOPSIS
22		6
23	use AnyEvent;	7	use AnyEvent;
24	use AnyEvent::Handle;	8	use AnyEvent::Handle;
…		…
30	on_error => sub {	14	on_error => sub {
31	my ($hdl, $fatal, $msg) = @_;	15	my ($hdl, $fatal, $msg) = @_;
32	warn "got error $msg\n";	16	warn "got error $msg\n";
33	$hdl->destroy;	17	$hdl->destroy;
34	$cv->send;	18	$cv->send;
35	);	19	};
36		20
37	# send some request line	21	# send some request line
38	$hdl->push_write ("getinfo\015\012");	22	$hdl->push_write ("getinfo\015\012");
39		23
40	# read the response line	24	# read the response line
…		…
46		30
47	$cv->recv;	31	$cv->recv;
48		32
49	=head1 DESCRIPTION	33	=head1 DESCRIPTION
50		34
51	This module is a helper module to make it easier to do event-based I/O on	35	This is a helper module to make it easier to do event-based I/O on
52	filehandles. For utility functions for doing non-blocking connects and accepts	36	stream-based filehandles (sockets, pipes, and other stream things).
53	on sockets see L<AnyEvent::Util>.
54		37
55	The L<AnyEvent::Intro> tutorial contains some well-documented	38	The L<AnyEvent::Intro> tutorial contains some well-documented
56	AnyEvent::Handle examples.	39	AnyEvent::Handle examples.
57		40
58	In the following, when the documentation refers to of "bytes" then this	41	In the following, where the documentation refers to "bytes", it means
59	means characters. As sysread and syswrite are used for all I/O, their	42	characters. As sysread and syswrite are used for all I/O, their
60	treatment of characters applies to this module as well.	43	treatment of characters applies to this module as well.
		44
		45	At the very minimum, you should specify C<fh> or C<connect>, and the
		46	C<on_error> callback.
61		47
62	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
63	argument.	49	argument.
64		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
65	=head1 METHODS	80	=head1 METHODS
66		81
67	=over 4	82	=over 4
68		83
69	=item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value...	84	=item $handle = B<new> AnyEvent::Handle fh => $filehandle, key => value...
70		85
71	The constructor supports these arguments (all as C<< key => value >> pairs).	86	The constructor supports these arguments (all as C<< key => value >> pairs).
72		87
73	=over 4	88	=over 4
74		89
75	=item fh => $filehandle [MANDATORY]	90	=item fh => $filehandle [C<fh> or C<connect> MANDATORY]
76		91
77	The filehandle this L<AnyEvent::Handle> object will operate on.	92	The filehandle this L<AnyEvent::Handle> object will operate on.
78
79	NOTE: The filehandle will be set to non-blocking mode (using	93	NOTE: The filehandle will be set to non-blocking mode (using
80	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
81	that mode.	95	that mode.
		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 that the
		124	default 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 peer's numeric host and port (the socket peername) are passed as
		131	parameters, together with a retry callback.
		132
		133	If, for some reason, the handle is not acceptable, calling C<$retry>
		134	will continue with the next connection target (in case of multi-homed
		135	hosts or SRV records there can be multiple connection endpoints). At the
		136	time it is called the read and write queues, eof status, tls status and
		137	similar properties of the handle will have been reset.
		138
		139	In most cases, you should ignore the C<$retry> parameter.
		140
		141	=item on_connect_error => $cb->($handle, $message)
		142
		143	This callback is called when the connection could not be
		144	established. C<$!> will contain the relevant error code, and C<$message> a
		145	message describing it (usually the same as C<"$!">).
		146
		147	If this callback isn't specified, then C<on_error> will be called with a
		148	fatal error instead.
		149
		150	=back
		151
		152	=item on_error => $cb->($handle, $fatal, $message)
		153
		154	This is the error callback, which is called when, well, some error
		155	occured, such as not being able to resolve the hostname, failure to
		156	connect, or a read error.
		157
		158	Some errors are fatal (which is indicated by C<$fatal> being true). On
		159	fatal errors the handle object will be destroyed (by a call to C<< ->
		160	destroy >>) after invoking the error callback (which means you are free to
		161	examine the handle object). Examples of fatal errors are an EOF condition
		162	with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors. In
		163	cases where the other side can close the connection at will, it is
		164	often easiest to not report C<EPIPE> errors in this callback.
		165
		166	AnyEvent::Handle tries to find an appropriate error code for you to check
		167	against, but in some cases (TLS errors), this does not work well. It is
		168	recommended to always output the C<$message> argument in human-readable
		169	error messages (it's usually the same as C<"$!">).
		170
		171	Non-fatal errors can be retried by returning, but it is recommended
		172	to simply ignore this parameter and instead abondon the handle object
		173	when this callback is invoked. Examples of non-fatal errors are timeouts
		174	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
		175
		176	On entry to the callback, the value of C<$!> contains the operating
		177	system error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
		178	C<EPROTO>).
		179
		180	While not mandatory, it is I<highly> recommended to set this callback, as
		181	you will not be notified of errors otherwise. The default just calls
		182	C<croak>.
		183
		184	=item on_read => $cb->($handle)
		185
		186	This sets the default read callback, which is called when data arrives
		187	and no read request is in the queue (unlike read queue callbacks, this
		188	callback will only be called when at least one octet of data is in the
		189	read buffer).
		190
		191	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
		192	method or access the C<< $handle->{rbuf} >> member directly. Note that you
		193	must not enlarge or modify the read buffer, you can only remove data at
		194	the beginning from it.
		195
		196	You can also call C<< ->push_read (...) >> or any other function that
		197	modifies the read queue. Or do both. Or ...
		198
		199	When an EOF condition is detected, AnyEvent::Handle will first try to
		200	feed all the remaining data to the queued callbacks and C<on_read> before
		201	calling the C<on_eof> callback. If no progress can be made, then a fatal
		202	error will be raised (with C<$!> set to C<EPIPE>).
		203
		204	Note that, unlike requests in the read queue, an C<on_read> callback
		205	doesn't mean you I<require> some data: if there is an EOF and there
		206	are outstanding read requests then an error will be flagged. With an
		207	C<on_read> callback, the C<on_eof> callback will be invoked.
82		208
83	=item on_eof => $cb->($handle)	209	=item on_eof => $cb->($handle)
84		210
85	Set the callback to be called when an end-of-file condition is detected,	211	Set the callback to be called when an end-of-file condition is detected,
86	i.e. in the case of a socket, when the other side has closed the	212	i.e. in the case of a socket, when the other side has closed the
…		…
94	down.	220	down.
95		221
96	If an EOF condition has been detected but no C<on_eof> callback has been	222	If an EOF condition has been detected but no C<on_eof> callback has been
97	set, then a fatal error will be raised with C<$!> set to <0>.	223	set, then a fatal error will be raised with C<$!> set to <0>.
98		224
99	=item on_error => $cb->($handle, $fatal, $message)
100
101	This is the error callback, which is called when, well, some error
102	occured, such as not being able to resolve the hostname, failure to
103	connect or a read error.
104
105	Some errors are fatal (which is indicated by C<$fatal> being true). On
106	fatal errors the handle object will be destroyed (by a call to C<< ->
107	destroy >>) after invoking the error callback (which means you are free to
108	examine the handle object). Examples of fatal errors are an EOF condition
109	with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors.
110
111	AnyEvent::Handle tries to find an appropriate error code for you to check
112	against, but in some cases (TLS errors), this does not work well. It is
113	recommended to always output the C<$message> argument in human-readable
114	error messages (it's usually the same as C<"$!">).
115
116	Non-fatal errors can be retried by simply returning, but it is recommended
117	to simply ignore this parameter and instead abondon the handle object
118	when this callback is invoked. Examples of non-fatal errors are timeouts
119	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
120
121	On callback entrance, the value of C<$!> contains the operating system
122	error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
123	C<EPROTO>).
124
125	While not mandatory, it is I<highly> recommended to set this callback, as
126	you will not be notified of errors otherwise. The default simply calls
127	C<croak>.
128
129	=item on_read => $cb->($handle)
130
131	This sets the default read callback, which is called when data arrives
132	and no read request is in the queue (unlike read queue callbacks, this
133	callback will only be called when at least one octet of data is in the
134	read buffer).
135
136	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
137	method or access the C<< $handle->{rbuf} >> member directly. Note that you
138	must not enlarge or modify the read buffer, you can only remove data at
139	the beginning from it.
140
141	When an EOF condition is detected then AnyEvent::Handle will first try to
142	feed all the remaining data to the queued callbacks and C<on_read> before
143	calling the C<on_eof> callback. If no progress can be made, then a fatal
144	error will be raised (with C<$!> set to C<EPIPE>).
145
146	Note that, unlike requests in the read queue, an C<on_read> callback
147	doesn't mean you I<require> some data: if there is an EOF and there
148	are outstanding read requests then an error will be flagged. With an
149	C<on_read> callback, the C<on_eof> callback will be invoked.
150
151	=item on_drain => $cb->($handle)	225	=item on_drain => $cb->($handle)
152		226
153	This sets the callback that is called when the write buffer becomes empty	227	This sets the callback that is called when the write buffer becomes empty
154	(or when the callback is set and the buffer is empty already).	228	(or immediately if the buffer is empty already).
155		229
156	To append to the write buffer, use the C<< ->push_write >> method.	230	To append to the write buffer, use the C<< ->push_write >> method.
157		231
158	This callback is useful when you don't want to put all of your write data	232	This callback is useful when you don't want to put all of your write data
159	into the queue at once, for example, when you want to write the contents	233	into the queue at once, for example, when you want to write the contents
…		…
161	memory and push it into the queue, but instead only read more data from	235	memory and push it into the queue, but instead only read more data from
162	the file when the write queue becomes empty.	236	the file when the write queue becomes empty.
163		237
164	=item timeout => $fractional_seconds	238	=item timeout => $fractional_seconds
165		239
		240	=item rtimeout => $fractional_seconds
		241
		242	=item wtimeout => $fractional_seconds
		243
166	If non-zero, then this enables an "inactivity" timeout: whenever this many	244	If non-zero, then these enables an "inactivity" timeout: whenever this
167	seconds pass without a successful read or write on the underlying file	245	many seconds pass without a successful read or write on the underlying
168	handle, the C<on_timeout> callback will be invoked (and if that one is	246	file handle (or a call to C<timeout_reset>), the C<on_timeout> callback
169	missing, a non-fatal C<ETIMEDOUT> error will be raised).	247	will be invoked (and if that one is missing, a non-fatal C<ETIMEDOUT>
		248	error will be raised).
170		249
		250	There are three variants of the timeouts that work independently
		251	of each other, for both read and write, just read, and just write:
		252	C<timeout>, C<rtimeout> and C<wtimeout>, with corresponding callbacks
		253	C<on_timeout>, C<on_rtimeout> and C<on_wtimeout>, and reset functions
		254	C<timeout_reset>, C<rtimeout_reset>, and C<wtimeout_reset>.
		255
171	Note that timeout processing is also active when you currently do not have	256	Note that timeout processing is active even when you do not have
172	any outstanding read or write requests: If you plan to keep the connection	257	any outstanding read or write requests: If you plan to keep the connection
173	idle then you should disable the timout temporarily or ignore the timeout	258	idle then you should disable the timeout temporarily or ignore the timeout
174	in the C<on_timeout> callback, in which case AnyEvent::Handle will simply	259	in the C<on_timeout> callback, in which case AnyEvent::Handle will simply
175	restart the timeout.	260	restart the timeout.
176		261
177	Zero (the default) disables this timeout.	262	Zero (the default) disables this timeout.
178		263
…		…
194	amount of data without a callback ever being called as long as the line	279	amount of data without a callback ever being called as long as the line
195	isn't finished).	280	isn't finished).
196		281
197	=item autocork => <boolean>	282	=item autocork => <boolean>
198		283
199	When disabled (the default), then C<push_write> will try to immediately	284	When disabled (the default), C<push_write> will try to immediately
200	write the data to the handle, if possible. This avoids having to register	285	write the data to the handle if possible. This avoids having to register
201	a write watcher and wait for the next event loop iteration, but can	286	a write watcher and wait for the next event loop iteration, but can
202	be inefficient if you write multiple small chunks (on the wire, this	287	be inefficient if you write multiple small chunks (on the wire, this
203	disadvantage is usually avoided by your kernel's nagle algorithm, see	288	disadvantage is usually avoided by your kernel's nagle algorithm, see
204	C<no_delay>, but this option can save costly syscalls).	289	C<no_delay>, but this option can save costly syscalls).
205		290
206	When enabled, then writes will always be queued till the next event loop	291	When enabled, writes will always be queued till the next event loop
207	iteration. This is efficient when you do many small writes per iteration,	292	iteration. This is efficient when you do many small writes per iteration,
208	but less efficient when you do a single write only per iteration (or when	293	but less efficient when you do a single write only per iteration (or when
209	the write buffer often is full). It also increases write latency.	294	the write buffer often is full). It also increases write latency.
210		295
211	=item no_delay => <boolean>	296	=item no_delay => <boolean>
…		…
215	the Nagle algorithm, and usually it is beneficial.	300	the Nagle algorithm, and usually it is beneficial.
216		301
217	In some situations you want as low a delay as possible, which can be	302	In some situations you want as low a delay as possible, which can be
218	accomplishd by setting this option to a true value.	303	accomplishd by setting this option to a true value.
219		304
220	The default is your opertaing system's default behaviour (most likely	305	The default is your operating system's default behaviour (most likely
221	enabled), this option explicitly enables or disables it, if possible.	306	enabled). This option explicitly enables or disables it, if possible.
		307
		308	=item keepalive => <boolean>
		309
		310	Enables (default disable) the SO_KEEPALIVE option on the stream socket:
		311	normally, TCP connections have no time-out once established, so TCP
		312	connections, once established, can stay alive forever even when the other
		313	side has long gone. TCP keepalives are a cheap way to take down long-lived
		314	TCP connections when the other side becomes unreachable. While the default
		315	is OS-dependent, TCP keepalives usually kick in after around two hours,
		316	and, if the other side doesn't reply, take down the TCP connection some 10
		317	to 15 minutes later.
		318
		319	It is harmless to specify this option for file handles that do not support
		320	keepalives, and enabling it on connections that are potentially long-lived
		321	is usually a good idea.
		322
		323	=item oobinline => <boolean>
		324
		325	BSD majorly fucked up the implementation of TCP urgent data. The result
		326	is that almost no OS implements TCP according to the specs, and every OS
		327	implements it slightly differently.
		328
		329	If you want to handle TCP urgent data, then setting this flag (the default
		330	is enabled) gives you the most portable way of getting urgent data, by
		331	putting it into the stream.
		332
		333	Since BSD emulation of OOB data on top of TCP's urgent data can have
		334	security implications, AnyEvent::Handle sets this flag automatically
		335	unless explicitly specified. Note that setting this flag after
		336	establishing a connection I<may> be a bit too late (data loss could
		337	already have occured on BSD systems), but at least it will protect you
		338	from most attacks.
222		339
223	=item read_size => <bytes>	340	=item read_size => <bytes>
224		341
225	The default read block size (the amount of bytes this module will	342	The default read block size (the number of bytes this module will
226	try to read during each loop iteration, which affects memory	343	try to read during each loop iteration, which affects memory
227	requirements). Default: C<8192>.	344	requirements). Default: C<8192>.
228		345
229	=item low_water_mark => <bytes>	346	=item low_water_mark => <bytes>
230		347
231	Sets the amount of bytes (default: C<0>) that make up an "empty" write	348	Sets the number of bytes (default: C<0>) that make up an "empty" write
232	buffer: If the write reaches this size or gets even samller it is	349	buffer: If the buffer reaches this size or gets even samller it is
233	considered empty.	350	considered empty.
234		351
235	Sometimes it can be beneficial (for performance reasons) to add data to	352	Sometimes it can be beneficial (for performance reasons) to add data to
236	the write buffer before it is fully drained, but this is a rare case, as	353	the write buffer before it is fully drained, but this is a rare case, as
237	the operating system kernel usually buffers data as well, so the default	354	the operating system kernel usually buffers data as well, so the default
238	is good in almost all cases.	355	is good in almost all cases.
239		356
240	=item linger => <seconds>	357	=item linger => <seconds>
241		358
242	If non-zero (default: C<3600>), then the destructor of the	359	If this is non-zero (default: C<3600>), the destructor of the
243	AnyEvent::Handle object will check whether there is still outstanding	360	AnyEvent::Handle object will check whether there is still outstanding
244	write data and will install a watcher that will write this data to the	361	write data and will install a watcher that will write this data to the
245	socket. No errors will be reported (this mostly matches how the operating	362	socket. No errors will be reported (this mostly matches how the operating
246	system treats outstanding data at socket close time).	363	system treats outstanding data at socket close time).
247		364
…		…
254	A string used to identify the remote site - usually the DNS hostname	371	A string used to identify the remote site - usually the DNS hostname
255	(I<not> IDN!) used to create the connection, rarely the IP address.	372	(I<not> IDN!) used to create the connection, rarely the IP address.
256		373
257	Apart from being useful in error messages, this string is also used in TLS	374	Apart from being useful in error messages, this string is also used in TLS
258	peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This	375	peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This
259	verification will be skipped when C<peername> is not specified or	376	verification will be skipped when C<peername> is not specified or is
260	C<undef>.	377	C<undef>.
261		378
262	=item tls => "accept" | "connect" | Net::SSLeay::SSL object	379	=item tls => "accept" | "connect" | Net::SSLeay::SSL object
263		380
264	When this parameter is given, it enables TLS (SSL) mode, that means	381	When this parameter is given, it enables TLS (SSL) mode, that means
265	AnyEvent will start a TLS handshake as soon as the conenction has been	382	AnyEvent will start a TLS handshake as soon as the connection has been
266	established and will transparently encrypt/decrypt data afterwards.	383	established and will transparently encrypt/decrypt data afterwards.
267		384
268	All TLS protocol errors will be signalled as C<EPROTO>, with an	385	All TLS protocol errors will be signalled as C<EPROTO>, with an
269	appropriate error message.	386	appropriate error message.
270		387
…		…
290	B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,	407	B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,
291	passing in the wrong integer will lead to certain crash. This most often	408	passing in the wrong integer will lead to certain crash. This most often
292	happens when one uses a stylish C<< tls => 1 >> and is surprised about the	409	happens when one uses a stylish C<< tls => 1 >> and is surprised about the
293	segmentation fault.	410	segmentation fault.
294		411
295	See the C<< ->starttls >> method for when need to start TLS negotiation later.	412	Use the C<< ->starttls >> method if you need to start TLS negotiation later.
296		413
297	=item tls_ctx => $anyevent_tls	414	=item tls_ctx => $anyevent_tls
298		415
299	Use the given C<AnyEvent::TLS> object to create the new TLS connection	416	Use the given C<AnyEvent::TLS> object to create the new TLS connection
300	(unless a connection object was specified directly). If this parameter is	417	(unless a connection object was specified directly). If this parameter is
…		…
315		432
316	TLS handshake failures will not cause C<on_error> to be invoked when this	433	TLS handshake failures will not cause C<on_error> to be invoked when this
317	callback is in effect, instead, the error message will be passed to C<on_starttls>.	434	callback is in effect, instead, the error message will be passed to C<on_starttls>.
318		435
319	Without this callback, handshake failures lead to C<on_error> being	436	Without this callback, handshake failures lead to C<on_error> being
320	called, as normal.	437	called as usual.
321		438
322	Note that you cannot call C<starttls> right again in this callback. If you	439	Note that you cannot just call C<starttls> again in this callback. If you
323	need to do that, start an zero-second timer instead whose callback can	440	need to do that, start an zero-second timer instead whose callback can
324	then call C<< ->starttls >> again.	441	then call C<< ->starttls >> again.
325		442
326	=item on_stoptls => $cb->($handle)	443	=item on_stoptls => $cb->($handle)
327		444
…		…
353		470
354	sub new {	471	sub new {
355	my $class = shift;	472	my $class = shift;
356	my $self = bless { @_ }, $class;	473	my $self = bless { @_ }, $class;
357		474
358	$self->{fh} or Carp::croak "mandatory argument fh is missing";	475	if ($self->{fh}) {
		476	$self->_start;
		477	return unless $self->{fh}; # could be gone by now
		478
		479	} elsif ($self->{connect}) {
		480	require AnyEvent::Socket;
		481
		482	$self->{peername} = $self->{connect}[0]
		483	unless exists $self->{peername};
		484
		485	$self->{_skip_drain_rbuf} = 1;
		486
		487	{
		488	Scalar::Util::weaken (my $self = $self);
		489
		490	$self->{_connect} =
		491	AnyEvent::Socket::tcp_connect (
		492	$self->{connect}[0],
		493	$self->{connect}[1],
		494	sub {
		495	my ($fh, $host, $port, $retry) = @_;
		496
		497	if ($fh) {
		498	$self->{fh} = $fh;
		499
		500	delete $self->{_skip_drain_rbuf};
		501	$self->_start;
		502
		503	$self->{on_connect}
		504	and $self->{on_connect}($self, $host, $port, sub {
		505	delete @$self{qw(fh _tw _rtw _wtw _ww _rw _eof _queue rbuf _wbuf tls _tls_rbuf _tls_wbuf)};
		506	$self->{_skip_drain_rbuf} = 1;
		507	&$retry;
		508	});
		509
		510	} else {
		511	if ($self->{on_connect_error}) {
		512	$self->{on_connect_error}($self, "$!");
		513	$self->destroy;
		514	} else {
		515	$self->_error ($!, 1);
		516	}
		517	}
		518	},
		519	sub {
		520	local $self->{fh} = $_[0];
		521
		522	$self->{on_prepare}
		523	? $self->{on_prepare}->($self)
		524	: ()
		525	}
		526	);
		527	}
		528
		529	} else {
		530	Carp::croak "AnyEvent::Handle: either an existing fh or the connect parameter must be specified";
		531	}
		532
		533	$self
		534	}
		535
		536	sub _start {
		537	my ($self) = @_;
		538
		539	# too many clueless people try to use udp and similar sockets
		540	# with AnyEvent::Handle, do them a favour.
		541	my $type = getsockopt $self->{fh}, Socket::SOL_SOCKET (), Socket::SO_TYPE ();
		542	Carp::croak "AnyEvent::Handle: only stream sockets supported, anything else will NOT work!"
		543	if Socket::SOCK_STREAM () != (unpack "I", $type) && defined $type;
359		544
360	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	545	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
361		546
		547	$self->{_activity} =
		548	$self->{_ractivity} =
362	$self->{_activity} = AnyEvent->now;	549	$self->{_wactivity} = AE::now;
363	$self->_timeout;
364		550
		551	$self->timeout (delete $self->{timeout} ) if $self->{timeout};
		552	$self->rtimeout (delete $self->{rtimeout} ) if $self->{rtimeout};
		553	$self->wtimeout (delete $self->{wtimeout} ) if $self->{wtimeout};
		554
365	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};	555	$self->no_delay (delete $self->{no_delay} ) if exists $self->{no_delay} && $self->{no_delay};
		556	$self->keepalive (delete $self->{keepalive}) if exists $self->{keepalive} && $self->{keepalive};
366		557
		558	$self->oobinline (exists $self->{oobinline} ? delete $self->{oobinline} : 1);
		559
367	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})	560	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
368	if $self->{tls};	561	if $self->{tls};
369		562
370	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	563	$self->on_drain (delete $self->{on_drain} ) if $self->{on_drain};
371		564
372	$self->start_read	565	$self->start_read
373	if $self->{on_read};	566	if $self->{on_read} || @{ $self->{_queue} };
374		567
375	$self->{fh} && $self	568	$self->_drain_wbuf;
376	}	569	}
377
378	#sub _shutdown {
379	# my ($self) = @_;
380	#
381	# delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)};
382	# $self->{_eof} = 1; # tell starttls et. al to stop trying
383	#
384	# &_freetls;
385	#}
386		570
387	sub _error {	571	sub _error {
388	my ($self, $errno, $fatal, $message) = @_;	572	my ($self, $errno, $fatal, $message) = @_;
389		573
390	$! = $errno;	574	$! = $errno;
391	$message ||= "$!";	575	$message ||= "$!";
392		576
393	if ($self->{on_error}) {	577	if ($self->{on_error}) {
394	$self->{on_error}($self, $fatal, $message);	578	$self->{on_error}($self, $fatal, $message);
395	$self->destroy if $fatal;	579	$self->destroy if $fatal;
396	} elsif ($self->{fh}) {	580	} elsif ($self->{fh} || $self->{connect}) {
397	$self->destroy;	581	$self->destroy;
398	Carp::croak "AnyEvent::Handle uncaught error: $message";	582	Carp::croak "AnyEvent::Handle uncaught error: $message";
399	}	583	}
400	}	584	}
401		585
…		…
427	$_[0]{on_eof} = $_[1];	611	$_[0]{on_eof} = $_[1];
428	}	612	}
429		613
430	=item $handle->on_timeout ($cb)	614	=item $handle->on_timeout ($cb)
431		615
432	Replace the current C<on_timeout> callback, or disables the callback (but	616	=item $handle->on_rtimeout ($cb)
433	not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
434	argument and method.
435		617
436	=cut	618	=item $handle->on_wtimeout ($cb)
437		619
438	sub on_timeout {	620	Replace the current C<on_timeout>, C<on_rtimeout> or C<on_wtimeout>
439	$_[0]{on_timeout} = $_[1];	621	callback, or disables the callback (but not the timeout) if C<$cb> =
440	}	622	C<undef>. See the C<timeout> constructor argument and method.
		623
		624	=cut
		625
		626	# see below
441		627
442	=item $handle->autocork ($boolean)	628	=item $handle->autocork ($boolean)
443		629
444	Enables or disables the current autocork behaviour (see C<autocork>	630	Enables or disables the current autocork behaviour (see C<autocork>
445	constructor argument). Changes will only take effect on the next write.	631	constructor argument). Changes will only take effect on the next write.
…		…
458	=cut	644	=cut
459		645
460	sub no_delay {	646	sub no_delay {
461	$_[0]{no_delay} = $_[1];	647	$_[0]{no_delay} = $_[1];
462		648
		649	setsockopt $_[0]{fh}, Socket::IPPROTO_TCP (), Socket::TCP_NODELAY (), int $_[1]
		650	if $_[0]{fh};
		651	}
		652
		653	=item $handle->keepalive ($boolean)
		654
		655	Enables or disables the C<keepalive> setting (see constructor argument of
		656	the same name for details).
		657
		658	=cut
		659
		660	sub keepalive {
		661	$_[0]{keepalive} = $_[1];
		662
463	eval {	663	eval {
464	local $SIG{__DIE__};	664	local $SIG{__DIE__};
465	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];	665	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
		666	if $_[0]{fh};
		667	};
		668	}
		669
		670	=item $handle->oobinline ($boolean)
		671
		672	Enables or disables the C<oobinline> setting (see constructor argument of
		673	the same name for details).
		674
		675	=cut
		676
		677	sub oobinline {
		678	$_[0]{oobinline} = $_[1];
		679
		680	eval {
		681	local $SIG{__DIE__};
		682	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_OOBINLINE (), int $_[1]
		683	if $_[0]{fh};
		684	};
		685	}
		686
		687	=item $handle->keepalive ($boolean)
		688
		689	Enables or disables the C<keepalive> setting (see constructor argument of
		690	the same name for details).
		691
		692	=cut
		693
		694	sub keepalive {
		695	$_[0]{keepalive} = $_[1];
		696
		697	eval {
		698	local $SIG{__DIE__};
		699	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
		700	if $_[0]{fh};
466	};	701	};
467	}	702	}
468		703
469	=item $handle->on_starttls ($cb)	704	=item $handle->on_starttls ($cb)
470		705
…		…
480		715
481	Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).	716	Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).
482		717
483	=cut	718	=cut
484		719
485	sub on_starttls {	720	sub on_stoptls {
486	$_[0]{on_stoptls} = $_[1];	721	$_[0]{on_stoptls} = $_[1];
487	}	722	}
488		723
		724	=item $handle->rbuf_max ($max_octets)
		725
		726	Configures the C<rbuf_max> setting (C<undef> disables it).
		727
		728	=cut
		729
		730	sub rbuf_max {
		731	$_[0]{rbuf_max} = $_[1];
		732	}
		733
489	#############################################################################	734	#############################################################################
490		735
491	=item $handle->timeout ($seconds)	736	=item $handle->timeout ($seconds)
492		737
		738	=item $handle->rtimeout ($seconds)
		739
		740	=item $handle->wtimeout ($seconds)
		741
493	Configures (or disables) the inactivity timeout.	742	Configures (or disables) the inactivity timeout.
494		743
495	=cut	744	=item $handle->timeout_reset
496		745
497	sub timeout {	746	=item $handle->rtimeout_reset
		747
		748	=item $handle->wtimeout_reset
		749
		750	Reset the activity timeout, as if data was received or sent.
		751
		752	These methods are cheap to call.
		753
		754	=cut
		755
		756	for my $dir ("", "r", "w") {
		757	my $timeout = "${dir}timeout";
		758	my $tw = "_${dir}tw";
		759	my $on_timeout = "on_${dir}timeout";
		760	my $activity = "_${dir}activity";
		761	my $cb;
		762
		763	*$on_timeout = sub {
		764	$_[0]{$on_timeout} = $_[1];
		765	};
		766
		767	*$timeout = sub {
498	my ($self, $timeout) = @_;	768	my ($self, $new_value) = @_;
499		769
		770	$new_value >= 0
		771	or Carp::croak "AnyEvent::Handle->$timeout called with negative timeout ($new_value), caught";
		772
500	$self->{timeout} = $timeout;	773	$self->{$timeout} = $new_value;
501	$self->_timeout;	774	delete $self->{$tw}; &$cb;
502	}	775	};
503		776
		777	*{"${dir}timeout_reset"} = sub {
		778	$_[0]{$activity} = AE::now;
		779	};
		780
		781	# main workhorse:
504	# reset the timeout watcher, as neccessary	782	# reset the timeout watcher, as neccessary
505	# also check for time-outs	783	# also check for time-outs
506	sub _timeout {	784	$cb = sub {
507	my ($self) = @_;	785	my ($self) = @_;
508		786
509	if ($self->{timeout}) {	787	if ($self->{$timeout} && $self->{fh}) {
510	my $NOW = AnyEvent->now;	788	my $NOW = AE::now;
511		789
512	# when would the timeout trigger?	790	# when would the timeout trigger?
513	my $after = $self->{_activity} + $self->{timeout} - $NOW;	791	my $after = $self->{$activity} + $self->{$timeout} - $NOW;
514		792
515	# now or in the past already?	793	# now or in the past already?
516	if ($after <= 0) {	794	if ($after <= 0) {
517	$self->{_activity} = $NOW;	795	$self->{$activity} = $NOW;
518		796
519	if ($self->{on_timeout}) {	797	if ($self->{$on_timeout}) {
520	$self->{on_timeout}($self);	798	$self->{$on_timeout}($self);
521	} else {	799	} else {
522	$self->_error (Errno::ETIMEDOUT);	800	$self->_error (Errno::ETIMEDOUT);
		801	}
		802
		803	# callback could have changed timeout value, optimise
		804	return unless $self->{$timeout};
		805
		806	# calculate new after
		807	$after = $self->{$timeout};
523	}	808	}
524		809
525	# callback could have changed timeout value, optimise	810	Scalar::Util::weaken $self;
526	return unless $self->{timeout};	811	return unless $self; # ->error could have destroyed $self
527		812
528	# calculate new after	813	$self->{$tw} ||= AE::timer $after, 0, sub {
529	$after = $self->{timeout};	814	delete $self->{$tw};
		815	$cb->($self);
		816	};
		817	} else {
		818	delete $self->{$tw};
530	}	819	}
531
532	Scalar::Util::weaken $self;
533	return unless $self; # ->error could have destroyed $self
534
535	$self->{_tw} ||= AnyEvent->timer (after => $after, cb => sub {
536	delete $self->{_tw};
537	$self->_timeout;
538	});
539	} else {
540	delete $self->{_tw};
541	}	820	}
542	}	821	}
543		822
544	#############################################################################	823	#############################################################################
545		824
…		…
560		839
561	=item $handle->on_drain ($cb)	840	=item $handle->on_drain ($cb)
562		841
563	Sets the C<on_drain> callback or clears it (see the description of	842	Sets the C<on_drain> callback or clears it (see the description of
564	C<on_drain> in the constructor).	843	C<on_drain> in the constructor).
		844
		845	This method may invoke callbacks (and therefore the handle might be
		846	destroyed after it returns).
565		847
566	=cut	848	=cut
567		849
568	sub on_drain {	850	sub on_drain {
569	my ($self, $cb) = @_;	851	my ($self, $cb) = @_;
…		…
578		860
579	Queues the given scalar to be written. You can push as much data as you	861	Queues the given scalar to be written. You can push as much data as you
580	want (only limited by the available memory), as C<AnyEvent::Handle>	862	want (only limited by the available memory), as C<AnyEvent::Handle>
581	buffers it independently of the kernel.	863	buffers it independently of the kernel.
582		864
		865	This method may invoke callbacks (and therefore the handle might be
		866	destroyed after it returns).
		867
583	=cut	868	=cut
584		869
585	sub _drain_wbuf {	870	sub _drain_wbuf {
586	my ($self) = @_;	871	my ($self) = @_;
587		872
…		…
593	my $len = syswrite $self->{fh}, $self->{wbuf};	878	my $len = syswrite $self->{fh}, $self->{wbuf};
594		879
595	if (defined $len) {	880	if (defined $len) {
596	substr $self->{wbuf}, 0, $len, "";	881	substr $self->{wbuf}, 0, $len, "";
597		882
598	$self->{_activity} = AnyEvent->now;	883	$self->{_activity} = $self->{_wactivity} = AE::now;
599		884
600	$self->{on_drain}($self)	885	$self->{on_drain}($self)
601	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})	886	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
602	&& $self->{on_drain};	887	&& $self->{on_drain};
603		888
…		…
609		894
610	# try to write data immediately	895	# try to write data immediately
611	$cb->() unless $self->{autocork};	896	$cb->() unless $self->{autocork};
612		897
613	# if still data left in wbuf, we need to poll	898	# if still data left in wbuf, we need to poll
614	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	899	$self->{_ww} = AE::io $self->{fh}, 1, $cb
615	if length $self->{wbuf};	900	if length $self->{wbuf};
616	};	901	};
617	}	902	}
618		903
619	our %WH;	904	our %WH;
620		905
		906	# deprecated
621	sub register_write_type($$) {	907	sub register_write_type($$) {
622	$WH{$_[0]} = $_[1];	908	$WH{$_[0]} = $_[1];
623	}	909	}
624		910
625	sub push_write {	911	sub push_write {
626	my $self = shift;	912	my $self = shift;
627		913
628	if (@_ > 1) {	914	if (@_ > 1) {
629	my $type = shift;	915	my $type = shift;
630		916
		917	@_ = ($WH{$type} ||= _load_func "$type\::anyevent_write_type"
631	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	918	or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_write")
632	->($self, @_);	919	->($self, @_);
633	}	920	}
634		921
		922	# we downgrade here to avoid hard-to-track-down bugs,
		923	# and diagnose the problem earlier and better.
		924
635	if ($self->{tls}) {	925	if ($self->{tls}) {
636	$self->{_tls_wbuf} .= $_[0];	926	utf8::downgrade $self->{_tls_wbuf} .= $_[0];
637		927	&_dotls ($self) if $self->{fh};
638	&_dotls ($self);
639	} else {	928	} else {
640	$self->{wbuf} .= $_[0];	929	utf8::downgrade $self->{wbuf} .= $_[0];
641	$self->_drain_wbuf;	930	$self->_drain_wbuf if $self->{fh};
642	}	931	}
643	}	932	}
644		933
645	=item $handle->push_write (type => @args)	934	=item $handle->push_write (type => @args)
646		935
647	Instead of formatting your data yourself, you can also let this module do	936	Instead of formatting your data yourself, you can also let this module
648	the job by specifying a type and type-specific arguments.	937	do the job by specifying a type and type-specific arguments. You
		938	can also specify the (fully qualified) name of a package, in which
		939	case AnyEvent tries to load the package and then expects to find the
		940	C<anyevent_write_type> function inside (see "custom write types", below).
649		941
650	Predefined types are (if you have ideas for additional types, feel free to	942	Predefined types are (if you have ideas for additional types, feel free to
651	drop by and tell us):	943	drop by and tell us):
652		944
653	=over 4	945	=over 4
…		…
710	Other languages could read single lines terminated by a newline and pass	1002	Other languages could read single lines terminated by a newline and pass
711	this line into their JSON decoder of choice.	1003	this line into their JSON decoder of choice.
712		1004
713	=cut	1005	=cut
714		1006
		1007	sub json_coder() {
		1008	eval { require JSON::XS; JSON::XS->new->utf8 }
		1009	|| do { require JSON; JSON->new->utf8 }
		1010	}
		1011
715	register_write_type json => sub {	1012	register_write_type json => sub {
716	my ($self, $ref) = @_;	1013	my ($self, $ref) = @_;
717		1014
718	require JSON;	1015	my $json = $self->{json} ||= json_coder;
719		1016
720	$self->{json} ? $self->{json}->encode ($ref)	1017	$json->encode ($ref)
721	: JSON::encode_json ($ref)
722	};	1018	};
723		1019
724	=item storable => $reference	1020	=item storable => $reference
725		1021
726	Freezes the given reference using L<Storable> and writes it to the	1022	Freezes the given reference using L<Storable> and writes it to the
…		…
752	the peer.	1048	the peer.
753		1049
754	You can rely on the normal read queue and C<on_eof> handling	1050	You can rely on the normal read queue and C<on_eof> handling
755	afterwards. This is the cleanest way to close a connection.	1051	afterwards. This is the cleanest way to close a connection.
756		1052
		1053	This method may invoke callbacks (and therefore the handle might be
		1054	destroyed after it returns).
		1055
757	=cut	1056	=cut
758		1057
759	sub push_shutdown {	1058	sub push_shutdown {
760	my ($self) = @_;	1059	my ($self) = @_;
761		1060
762	delete $self->{low_water_mark};	1061	delete $self->{low_water_mark};
763	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });	1062	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });
764	}	1063	}
765		1064
766	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	1065	=item custom write types - Package::anyevent_write_type $handle, @args
767		1066
768	This function (not method) lets you add your own types to C<push_write>.	1067	Instead of one of the predefined types, you can also specify the name of
		1068	a package. AnyEvent will try to load the package and then expects to find
		1069	a function named C<anyevent_write_type> inside. If it isn't found, it
		1070	progressively tries to load the parent package until it either finds the
		1071	function (good) or runs out of packages (bad).
		1072
769	Whenever the given C<type> is used, C<push_write> will invoke the code	1073	Whenever the given C<type> is used, C<push_write> will the function with
770	reference with the handle object and the remaining arguments.	1074	the handle object and the remaining arguments.
771		1075
772	The code reference is supposed to return a single octet string that will	1076	The function is supposed to return a single octet string that will be
773	be appended to the write buffer.	1077	appended to the write buffer, so you cna mentally treat this function as a
		1078	"arguments to on-the-wire-format" converter.
774		1079
775	Note that this is a function, and all types registered this way will be	1080	Example: implement a custom write type C<join> that joins the remaining
776	global, so try to use unique names.	1081	arguments using the first one.
		1082
		1083	$handle->push_write (My::Type => " ", 1,2,3);
		1084
		1085	# uses the following package, which can be defined in the "My::Type" or in
		1086	# the "My" modules to be auto-loaded, or just about anywhere when the
		1087	# My::Type::anyevent_write_type is defined before invoking it.
		1088
		1089	package My::Type;
		1090
		1091	sub anyevent_write_type {
		1092	my ($handle, $delim, @args) = @_;
		1093
		1094	join $delim, @args
		1095	}
777		1096
778	=cut	1097	=cut
779		1098
780	#############################################################################	1099	#############################################################################
781		1100
…		…
790	ways, the "simple" way, using only C<on_read> and the "complex" way, using	1109	ways, the "simple" way, using only C<on_read> and the "complex" way, using
791	a queue.	1110	a queue.
792		1111
793	In the simple case, you just install an C<on_read> callback and whenever	1112	In the simple case, you just install an C<on_read> callback and whenever
794	new data arrives, it will be called. You can then remove some data (if	1113	new data arrives, it will be called. You can then remove some data (if
795	enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna	1114	enough is there) from the read buffer (C<< $handle->rbuf >>). Or you can
796	leave the data there if you want to accumulate more (e.g. when only a	1115	leave the data there if you want to accumulate more (e.g. when only a
797	partial message has been received so far).	1116	partial message has been received so far), or change the read queue with
		1117	e.g. C<push_read>.
798		1118
799	In the more complex case, you want to queue multiple callbacks. In this	1119	In the more complex case, you want to queue multiple callbacks. In this
800	case, AnyEvent::Handle will call the first queued callback each time new	1120	case, AnyEvent::Handle will call the first queued callback each time new
801	data arrives (also the first time it is queued) and removes it when it has	1121	data arrives (also the first time it is queued) and remove it when it has
802	done its job (see C<push_read>, below).	1122	done its job (see C<push_read>, below).
803		1123
804	This way you can, for example, push three line-reads, followed by reading	1124	This way you can, for example, push three line-reads, followed by reading
805	a chunk of data, and AnyEvent::Handle will execute them in order.	1125	a chunk of data, and AnyEvent::Handle will execute them in order.
806		1126
…		…
863	=cut	1183	=cut
864		1184
865	sub _drain_rbuf {	1185	sub _drain_rbuf {
866	my ($self) = @_;	1186	my ($self) = @_;
867		1187
		1188	# avoid recursion
		1189	return if $self->{_skip_drain_rbuf};
868	local $self->{_in_drain} = 1;	1190	local $self->{_skip_drain_rbuf} = 1;
869
870	if (
871	defined $self->{rbuf_max}
872	&& $self->{rbuf_max} < length $self->{rbuf}
873	) {
874	$self->_error (Errno::ENOSPC, 1), return;
875	}
876		1191
877	while () {	1192	while () {
878	# we need to use a separate tls read buffer, as we must not receive data while	1193	# we need to use a separate tls read buffer, as we must not receive data while
879	# we are draining the buffer, and this can only happen with TLS.	1194	# we are draining the buffer, and this can only happen with TLS.
880	$self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf};	1195	$self->{rbuf} .= delete $self->{_tls_rbuf}
		1196	if exists $self->{_tls_rbuf};
881		1197
882	my $len = length $self->{rbuf};	1198	my $len = length $self->{rbuf};
883		1199
884	if (my $cb = shift @{ $self->{_queue} }) {	1200	if (my $cb = shift @{ $self->{_queue} }) {
885	unless ($cb->($self)) {	1201	unless ($cb->($self)) {
886	if ($self->{_eof}) {	1202	# no progress can be made
887	# no progress can be made (not enough data and no data forthcoming)	1203	# (not enough data and no data forthcoming)
888	$self->_error (Errno::EPIPE, 1), return;	1204	$self->_error (Errno::EPIPE, 1), return
889	}	1205	if $self->{_eof};
890		1206
891	unshift @{ $self->{_queue} }, $cb;	1207	unshift @{ $self->{_queue} }, $cb;
892	last;	1208	last;
893	}	1209	}
894	} elsif ($self->{on_read}) {	1210	} elsif ($self->{on_read}) {
…		…
914	last;	1230	last;
915	}	1231	}
916	}	1232	}
917		1233
918	if ($self->{_eof}) {	1234	if ($self->{_eof}) {
919	if ($self->{on_eof}) {	1235	$self->{on_eof}
920	$self->{on_eof}($self)	1236	? $self->{on_eof}($self)
921	} else {
922	$self->_error (0, 1, "Unexpected end-of-file");	1237	: $self->_error (0, 1, "Unexpected end-of-file");
923	}	1238
		1239	return;
		1240	}
		1241
		1242	if (
		1243	defined $self->{rbuf_max}
		1244	&& $self->{rbuf_max} < length $self->{rbuf}
		1245	) {
		1246	$self->_error (Errno::ENOSPC, 1), return;
924	}	1247	}
925		1248
926	# may need to restart read watcher	1249	# may need to restart read watcher
927	unless ($self->{_rw}) {	1250	unless ($self->{_rw}) {
928	$self->start_read	1251	$self->start_read
…		…
934		1257
935	This replaces the currently set C<on_read> callback, or clears it (when	1258	This replaces the currently set C<on_read> callback, or clears it (when
936	the new callback is C<undef>). See the description of C<on_read> in the	1259	the new callback is C<undef>). See the description of C<on_read> in the
937	constructor.	1260	constructor.
938		1261
		1262	This method may invoke callbacks (and therefore the handle might be
		1263	destroyed after it returns).
		1264
939	=cut	1265	=cut
940		1266
941	sub on_read {	1267	sub on_read {
942	my ($self, $cb) = @_;	1268	my ($self, $cb) = @_;
943		1269
944	$self->{on_read} = $cb;	1270	$self->{on_read} = $cb;
945	$self->_drain_rbuf if $cb && !$self->{_in_drain};	1271	$self->_drain_rbuf if $cb;
946	}	1272	}
947		1273
948	=item $handle->rbuf	1274	=item $handle->rbuf
949		1275
950	Returns the read buffer (as a modifiable lvalue).	1276	Returns the read buffer (as a modifiable lvalue). You can also access the
		1277	read buffer directly as the C<< ->{rbuf} >> member, if you want (this is
		1278	much faster, and no less clean).
951		1279
952	You can access the read buffer directly as the C<< ->{rbuf} >>	1280	The only operation allowed on the read buffer (apart from looking at it)
953	member, if you want. However, the only operation allowed on the	1281	is removing data from its beginning. Otherwise modifying or appending to
954	read buffer (apart from looking at it) is removing data from its	1282	it is not allowed and will lead to hard-to-track-down bugs.
955	beginning. Otherwise modifying or appending to it is not allowed and will
956	lead to hard-to-track-down bugs.
957		1283
958	NOTE: The read buffer should only be used or modified if the C<on_read>,	1284	NOTE: The read buffer should only be used or modified in the C<on_read>
959	C<push_read> or C<unshift_read> methods are used. The other read methods	1285	callback or when C<push_read> or C<unshift_read> are used with a single
960	automatically manage the read buffer.	1286	callback (i.e. untyped). Typed C<push_read> and C<unshift_read> methods
		1287	will manage the read buffer on their own.
961		1288
962	=cut	1289	=cut
963		1290
964	sub rbuf : lvalue {	1291	sub rbuf : lvalue {
965	$_[0]{rbuf}	1292	$_[0]{rbuf}
…		…
982		1309
983	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
984	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
985	true, it will be removed from the queue.	1312	true, it will be removed from the queue.
986		1313
		1314	These methods may invoke callbacks (and therefore the handle might be
		1315	destroyed after it returns).
		1316
987	=cut	1317	=cut
988		1318
989	our %RH;	1319	our %RH;
990		1320
991	sub register_read_type($$) {	1321	sub register_read_type($$) {
…		…
997	my $cb = pop;	1327	my $cb = pop;
998		1328
999	if (@_) {	1329	if (@_) {
1000	my $type = shift;	1330	my $type = shift;
1001		1331
		1332	$cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type"
1002	$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")
1003	->($self, $cb, @_);	1334	->($self, $cb, @_);
1004	}	1335	}
1005		1336
1006	push @{ $self->{_queue} }, $cb;	1337	push @{ $self->{_queue} }, $cb;
1007	$self->_drain_rbuf unless $self->{_in_drain};	1338	$self->_drain_rbuf;
1008	}	1339	}
1009		1340
1010	sub unshift_read {	1341	sub unshift_read {
1011	my $self = shift;	1342	my $self = shift;
1012	my $cb = pop;	1343	my $cb = pop;
1013		1344
1014	if (@_) {	1345	if (@_) {
1015	my $type = shift;	1346	my $type = shift;
1016		1347
		1348	$cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type"
1017	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")	1349	or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::unshift_read")
1018	->($self, $cb, @_);	1350	->($self, $cb, @_);
1019	}	1351	}
1020		1352
1021
1022	unshift @{ $self->{_queue} }, $cb;	1353	unshift @{ $self->{_queue} }, $cb;
1023	$self->_drain_rbuf unless $self->{_in_drain};	1354	$self->_drain_rbuf;
1024	}	1355	}
1025		1356
1026	=item $handle->push_read (type => @args, $cb)	1357	=item $handle->push_read (type => @args, $cb)
1027		1358
1028	=item $handle->unshift_read (type => @args, $cb)	1359	=item $handle->unshift_read (type => @args, $cb)
1029		1360
1030	Instead of providing a callback that parses the data itself you can chose	1361	Instead of providing a callback that parses the data itself you can chose
1031	between a number of predefined parsing formats, for chunks of data, lines	1362	between a number of predefined parsing formats, for chunks of data, lines
1032	etc.	1363	etc. You can also specify the (fully qualified) name of a package, in
		1364	which case AnyEvent tries to load the package and then expects to find the
		1365	C<anyevent_read_type> function inside (see "custom read types", below).
1033		1366
1034	Predefined types are (if you have ideas for additional types, feel free to	1367	Predefined types are (if you have ideas for additional types, feel free to
1035	drop by and tell us):	1368	drop by and tell us):
1036		1369
1037	=over 4	1370	=over 4
…		…
1129	the receive buffer when neither C<$accept> nor C<$reject> match,	1462	the receive buffer when neither C<$accept> nor C<$reject> match,
1130	and everything preceding and including the match will be accepted	1463	and everything preceding and including the match will be accepted
1131	unconditionally. This is useful to skip large amounts of data that you	1464	unconditionally. This is useful to skip large amounts of data that you
1132	know cannot be matched, so that the C<$accept> or C<$reject> regex do not	1465	know cannot be matched, so that the C<$accept> or C<$reject> regex do not
1133	have to start matching from the beginning. This is purely an optimisation	1466	have to start matching from the beginning. This is purely an optimisation
1134	and is usually worth only when you expect more than a few kilobytes.	1467	and is usually worth it only when you expect more than a few kilobytes.
1135		1468
1136	Example: expect a http header, which ends at C<\015\012\015\012>. Since we	1469	Example: expect a http header, which ends at C<\015\012\015\012>. Since we
1137	expect the header to be very large (it isn't in practise, but...), we use	1470	expect the header to be very large (it isn't in practice, but...), we use
1138	a skip regex to skip initial portions. The skip regex is tricky in that	1471	a skip regex to skip initial portions. The skip regex is tricky in that
1139	it only accepts something not ending in either \015 or \012, as these are	1472	it only accepts something not ending in either \015 or \012, as these are
1140	required for the accept regex.	1473	required for the accept regex.
1141		1474
1142	$handle->push_read (regex =>	1475	$handle->push_read (regex =>
…		…
1277	=cut	1610	=cut
1278		1611
1279	register_read_type json => sub {	1612	register_read_type json => sub {
1280	my ($self, $cb) = @_;	1613	my ($self, $cb) = @_;
1281		1614
1282	my $json = $self->{json} ||=	1615	my $json = $self->{json} ||= json_coder;
1283	eval { require JSON::XS; JSON::XS->new->utf8 }
1284	|| do { require JSON; JSON->new->utf8 };
1285		1616
1286	my $data;	1617	my $data;
1287	my $rbuf = \$self->{rbuf};	1618	my $rbuf = \$self->{rbuf};
1288		1619
1289	sub {	1620	sub {
…		…
1358	}	1689	}
1359	};	1690	};
1360		1691
1361	=back	1692	=back
1362		1693
1363	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)	1694	=item custom read types - Package::anyevent_read_type $handle, $cb, @args
1364		1695
1365	This function (not method) lets you add your own types to C<push_read>.	1696	Instead of one of the predefined types, you can also specify the name
		1697	of a package. AnyEvent will try to load the package and then expects to
		1698	find a function named C<anyevent_read_type> inside. If it isn't found, it
		1699	progressively tries to load the parent package until it either finds the
		1700	function (good) or runs out of packages (bad).
1366		1701
1367	Whenever the given C<type> is used, C<push_read> will invoke the code	1702	Whenever this type is used, C<push_read> will invoke the function with the
1368	reference with the handle object, the callback and the remaining	1703	handle object, the original callback and the remaining arguments.
1369	arguments.
1370		1704
1371	The code reference is supposed to return a callback (usually a closure)	1705	The function is supposed to return a callback (usually a closure) that
1372	that works as a plain read callback (see C<< ->push_read ($cb) >>).	1706	works as a plain read callback (see C<< ->push_read ($cb) >>), so you can
		1707	mentally treat the function as a "configurable read type to read callback"
		1708	converter.
1373		1709
1374	It should invoke the passed callback when it is done reading (remember to	1710	It should invoke the original callback when it is done reading (remember
1375	pass C<$handle> as first argument as all other callbacks do that).	1711	to pass C<$handle> as first argument as all other callbacks do that,
		1712	although there is no strict requirement on this).
1376		1713
1377	Note that this is a function, and all types registered this way will be
1378	global, so try to use unique names.
1379
1380	For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>,	1714	For examples, see the source of this module (F<perldoc -m
1381	search for C<register_read_type>)).	1715	AnyEvent::Handle>, search for C<register_read_type>)).
1382		1716
1383	=item $handle->stop_read	1717	=item $handle->stop_read
1384		1718
1385	=item $handle->start_read	1719	=item $handle->start_read
1386		1720
…		…
1406	}	1740	}
1407		1741
1408	sub start_read {	1742	sub start_read {
1409	my ($self) = @_;	1743	my ($self) = @_;
1410		1744
1411	unless ($self->{_rw} || $self->{_eof}) {	1745	unless ($self->{_rw} || $self->{_eof} || !$self->{fh}) {
1412	Scalar::Util::weaken $self;	1746	Scalar::Util::weaken $self;
1413		1747
1414	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1748	$self->{_rw} = AE::io $self->{fh}, 0, sub {
1415	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});	1749	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1416	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf;	1750	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf;
1417		1751
1418	if ($len > 0) {	1752	if ($len > 0) {
1419	$self->{_activity} = AnyEvent->now;	1753	$self->{_activity} = $self->{_ractivity} = AE::now;
1420		1754
1421	if ($self->{tls}) {	1755	if ($self->{tls}) {
1422	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);	1756	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1423		1757
1424	&_dotls ($self);	1758	&_dotls ($self);
1425	} else {	1759	} else {
1426	$self->_drain_rbuf unless $self->{_in_drain};	1760	$self->_drain_rbuf;
1427	}	1761	}
1428		1762
1429	} elsif (defined $len) {	1763	} elsif (defined $len) {
1430	delete $self->{_rw};	1764	delete $self->{_rw};
1431	$self->{_eof} = 1;	1765	$self->{_eof} = 1;
1432	$self->_drain_rbuf unless $self->{_in_drain};	1766	$self->_drain_rbuf;
1433		1767
1434	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1768	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1435	return $self->_error ($!, 1);	1769	return $self->_error ($!, 1);
1436	}	1770	}
1437	});	1771	};
1438	}	1772	}
1439	}	1773	}
1440		1774
1441	our $ERROR_SYSCALL;	1775	our $ERROR_SYSCALL;
1442	our $ERROR_WANT_READ;	1776	our $ERROR_WANT_READ;
…		…
1497	$self->{_eof} = 1;	1831	$self->{_eof} = 1;
1498	}	1832	}
1499	}	1833	}
1500		1834
1501	$self->{_tls_rbuf} .= $tmp;	1835	$self->{_tls_rbuf} .= $tmp;
1502	$self->_drain_rbuf unless $self->{_in_drain};	1836	$self->_drain_rbuf;
1503	$self->{tls} or return; # tls session might have gone away in callback	1837	$self->{tls} or return; # tls session might have gone away in callback
1504	}	1838	}
1505		1839
1506	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);	1840	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1507	return $self->_tls_error ($tmp)	1841	return $self->_tls_error ($tmp)
…		…
1509	&& ($tmp != $ERROR_SYSCALL || $!);	1843	&& ($tmp != $ERROR_SYSCALL || $!);
1510		1844
1511	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1845	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1512	$self->{wbuf} .= $tmp;	1846	$self->{wbuf} .= $tmp;
1513	$self->_drain_wbuf;	1847	$self->_drain_wbuf;
		1848	$self->{tls} or return; # tls session might have gone away in callback
1514	}	1849	}
1515		1850
1516	$self->{_on_starttls}	1851	$self->{_on_starttls}
1517	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()	1852	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
1518	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");	1853	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");
…		…
1521	=item $handle->starttls ($tls[, $tls_ctx])	1856	=item $handle->starttls ($tls[, $tls_ctx])
1522		1857
1523	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	1858	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
1524	object is created, you can also do that at a later time by calling	1859	object is created, you can also do that at a later time by calling
1525	C<starttls>.	1860	C<starttls>.
		1861
		1862	Starting TLS is currently an asynchronous operation - when you push some
		1863	write data and then call C<< ->starttls >> then TLS negotiation will start
		1864	immediately, after which the queued write data is then sent.
1526		1865
1527	The first argument is the same as the C<tls> constructor argument (either	1866	The first argument is the same as the C<tls> constructor argument (either
1528	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1867	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1529		1868
1530	The second argument is the optional C<AnyEvent::TLS> object that is used	1869	The second argument is the optional C<AnyEvent::TLS> object that is used
…		…
1535	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS	1874	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS
1536	context in C<< $handle->{tls_ctx} >> after this call and can be used or	1875	context in C<< $handle->{tls_ctx} >> after this call and can be used or
1537	changed to your liking. Note that the handshake might have already started	1876	changed to your liking. Note that the handshake might have already started
1538	when this function returns.	1877	when this function returns.
1539		1878
1540	If it an error to start a TLS handshake more than once per	1879	Due to bugs in OpenSSL, it might or might not be possible to do multiple
1541	AnyEvent::Handle object (this is due to bugs in OpenSSL).	1880	handshakes on the same stream. It is best to not attempt to use the
		1881	stream after stopping TLS.
		1882
		1883	This method may invoke callbacks (and therefore the handle might be
		1884	destroyed after it returns).
1542		1885
1543	=cut	1886	=cut
1544		1887
1545	our %TLS_CACHE; #TODO not yet documented, should we?	1888	our %TLS_CACHE; #TODO not yet documented, should we?
1546		1889
1547	sub starttls {	1890	sub starttls {
1548	my ($self, $ssl, $ctx) = @_;	1891	my ($self, $tls, $ctx) = @_;
		1892
		1893	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"
		1894	if $self->{tls};
		1895
		1896	$self->{tls} = $tls;
		1897	$self->{tls_ctx} = $ctx if @_ > 2;
		1898
		1899	return unless $self->{fh};
1549		1900
1550	require Net::SSLeay;	1901	require Net::SSLeay;
1551
1552	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"
1553	if $self->{tls};
1554		1902
1555	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();	1903	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1556	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();	1904	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1557		1905
		1906	$tls = delete $self->{tls};
1558	$ctx ||= $self->{tls_ctx};	1907	$ctx = $self->{tls_ctx};
		1908
		1909	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
1559		1910
1560	if ("HASH" eq ref $ctx) {	1911	if ("HASH" eq ref $ctx) {
1561	require AnyEvent::TLS;	1912	require AnyEvent::TLS;
1562
1563	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context
1564		1913
1565	if ($ctx->{cache}) {	1914	if ($ctx->{cache}) {
1566	my $key = $ctx+0;	1915	my $key = $ctx+0;
1567	$ctx = $TLS_CACHE{$key} ||= new AnyEvent::TLS %$ctx;	1916	$ctx = $TLS_CACHE{$key} ||= new AnyEvent::TLS %$ctx;
1568	} else {	1917	} else {
1569	$ctx = new AnyEvent::TLS %$ctx;	1918	$ctx = new AnyEvent::TLS %$ctx;
1570	}	1919	}
1571	}	1920	}
1572		1921
1573	$self->{tls_ctx} = $ctx || TLS_CTX ();	1922	$self->{tls_ctx} = $ctx || TLS_CTX ();
1574	$self->{tls} = $ssl = $self->{tls_ctx}->_get_session ($ssl, $self, $self->{peername});	1923	$self->{tls} = $tls = $self->{tls_ctx}->_get_session ($tls, $self, $self->{peername});
1575		1924
1576	# basically, this is deep magic (because SSL_read should have the same issues)	1925	# basically, this is deep magic (because SSL_read should have the same issues)
1577	# but the openssl maintainers basically said: "trust us, it just works".	1926	# but the openssl maintainers basically said: "trust us, it just works".
1578	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1927	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1579	# and mismaintained ssleay-module doesn't even offer them).	1928	# and mismaintained ssleay-module doesn't even offer them).
…		…
1586	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to	1935	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
1587	# have identity issues in that area.	1936	# have identity issues in that area.
1588	# Net::SSLeay::CTX_set_mode ($ssl,	1937	# Net::SSLeay::CTX_set_mode ($ssl,
1589	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)	1938	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)
1590	# | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));	1939	# | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));
1591	Net::SSLeay::CTX_set_mode ($ssl, 1|2);	1940	Net::SSLeay::CTX_set_mode ($tls, 1|2);
1592		1941
1593	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1942	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1594	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1943	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1595		1944
		1945	Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf});
		1946
1596	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1947	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
1597		1948
1598	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }	1949	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1599	if $self->{on_starttls};	1950	if $self->{on_starttls};
1600		1951
1601	&_dotls; # need to trigger the initial handshake	1952	&_dotls; # need to trigger the initial handshake
…		…
1604		1955
1605	=item $handle->stoptls	1956	=item $handle->stoptls
1606		1957
1607	Shuts down the SSL connection - this makes a proper EOF handshake by	1958	Shuts down the SSL connection - this makes a proper EOF handshake by
1608	sending a close notify to the other side, but since OpenSSL doesn't	1959	sending a close notify to the other side, but since OpenSSL doesn't
1609	support non-blocking shut downs, it is not possible to re-use the stream	1960	support non-blocking shut downs, it is not guaranteed that you can re-use
1610	afterwards.	1961	the stream afterwards.
		1962
		1963	This method may invoke callbacks (and therefore the handle might be
		1964	destroyed after it returns).
1611		1965
1612	=cut	1966	=cut
1613		1967
1614	sub stoptls {	1968	sub stoptls {
1615	my ($self) = @_;	1969	my ($self) = @_;
1616		1970
1617	if ($self->{tls}) {	1971	if ($self->{tls} && $self->{fh}) {
1618	Net::SSLeay::shutdown ($self->{tls});	1972	Net::SSLeay::shutdown ($self->{tls});
1619		1973
1620	&_dotls;	1974	&_dotls;
1621		1975
1622	# # we don't give a shit. no, we do, but we can't. no...#d#	1976	# # we don't give a shit. no, we do, but we can't. no...#d#
…		…
1628	sub _freetls {	1982	sub _freetls {
1629	my ($self) = @_;	1983	my ($self) = @_;
1630		1984
1631	return unless $self->{tls};	1985	return unless $self->{tls};
1632		1986
1633	$self->{tls_ctx}->_put_session (delete $self->{tls});	1987	$self->{tls_ctx}->_put_session (delete $self->{tls})
		1988	if $self->{tls} > 0;
1634		1989
1635	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};	1990	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1636	}	1991	}
1637		1992
1638	sub DESTROY {	1993	sub DESTROY {
…		…
1640		1995
1641	&_freetls;	1996	&_freetls;
1642		1997
1643	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	1998	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1644		1999
1645	if ($linger && length $self->{wbuf}) {	2000	if ($linger && length $self->{wbuf} && $self->{fh}) {
1646	my $fh = delete $self->{fh};	2001	my $fh = delete $self->{fh};
1647	my $wbuf = delete $self->{wbuf};	2002	my $wbuf = delete $self->{wbuf};
1648		2003
1649	my @linger;	2004	my @linger;
1650		2005
1651	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {	2006	push @linger, AE::io $fh, 1, sub {
1652	my $len = syswrite $fh, $wbuf, length $wbuf;	2007	my $len = syswrite $fh, $wbuf, length $wbuf;
1653		2008
1654	if ($len > 0) {	2009	if ($len > 0) {
1655	substr $wbuf, 0, $len, "";	2010	substr $wbuf, 0, $len, "";
1656	} else {	2011	} elsif (defined $len || ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK)) {
1657	@linger = (); # end	2012	@linger = (); # end
1658	}	2013	}
1659	});	2014	};
1660	push @linger, AnyEvent->timer (after => $linger, cb => sub {	2015	push @linger, AE::timer $linger, 0, sub {
1661	@linger = ();	2016	@linger = ();
1662	});	2017	};
1663	}	2018	}
1664	}	2019	}
1665		2020
1666	=item $handle->destroy	2021	=item $handle->destroy
1667		2022
1668	Shuts down the handle object as much as possible - this call ensures that	2023	Shuts down the handle object as much as possible - this call ensures that
1669	no further callbacks will be invoked and as many resources as possible	2024	no further callbacks will be invoked and as many resources as possible
1670	will be freed. You must not call any methods on the object afterwards.	2025	will be freed. Any method you will call on the handle object after
		2026	destroying it in this way will be silently ignored (and it will return the
		2027	empty list).
1671		2028
1672	Normally, you can just "forget" any references to an AnyEvent::Handle	2029	Normally, you can just "forget" any references to an AnyEvent::Handle
1673	object and it will simply shut down. This works in fatal error and EOF	2030	object and it will simply shut down. This works in fatal error and EOF
1674	callbacks, as well as code outside. It does I<NOT> work in a read or write	2031	callbacks, as well as code outside. It does I<NOT> work in a read or write
1675	callback, so when you want to destroy the AnyEvent::Handle object from	2032	callback, so when you want to destroy the AnyEvent::Handle object from
…		…
1689	sub destroy {	2046	sub destroy {
1690	my ($self) = @_;	2047	my ($self) = @_;
1691		2048
1692	$self->DESTROY;	2049	$self->DESTROY;
1693	%$self = ();	2050	%$self = ();
		2051	bless $self, "AnyEvent::Handle::destroyed";
1694	}	2052	}
		2053
		2054	sub AnyEvent::Handle::destroyed::AUTOLOAD {
		2055	#nop
		2056	}
		2057
		2058	=item $handle->destroyed
		2059
		2060	Returns false as long as the handle hasn't been destroyed by a call to C<<
		2061	->destroy >>, true otherwise.
		2062
		2063	Can be useful to decide whether the handle is still valid after some
		2064	callback possibly destroyed the handle. For example, C<< ->push_write >>,
		2065	C<< ->starttls >> and other methods can call user callbacks, which in turn
		2066	can destroy the handle, so work can be avoided by checking sometimes:
		2067
		2068	$hdl->starttls ("accept");
		2069	return if $hdl->destroyed;
		2070	$hdl->push_write (...
		2071
		2072	Note that the call to C<push_write> will silently be ignored if the handle
		2073	has been destroyed, so often you can just ignore the possibility of the
		2074	handle being destroyed.
		2075
		2076	=cut
		2077
		2078	sub destroyed { 0 }
		2079	sub AnyEvent::Handle::destroyed::destroyed { 1 }
1695		2080
1696	=item AnyEvent::Handle::TLS_CTX	2081	=item AnyEvent::Handle::TLS_CTX
1697		2082
1698	This function creates and returns the AnyEvent::TLS object used by default	2083	This function creates and returns the AnyEvent::TLS object used by default
1699	for TLS mode.	2084	for TLS mode.
…		…
1731		2116
1732	=item I get different callback invocations in TLS mode/Why can't I pause	2117	=item I get different callback invocations in TLS mode/Why can't I pause
1733	reading?	2118	reading?
1734		2119
1735	Unlike, say, TCP, TLS connections do not consist of two independent	2120	Unlike, say, TCP, TLS connections do not consist of two independent
1736	communication channels, one for each direction. Or put differently. The	2121	communication channels, one for each direction. Or put differently, the
1737	read and write directions are not independent of each other: you cannot	2122	read and write directions are not independent of each other: you cannot
1738	write data unless you are also prepared to read, and vice versa.	2123	write data unless you are also prepared to read, and vice versa.
1739		2124
1740	This can mean than, in TLS mode, you might get C<on_error> or C<on_eof>	2125	This means that, in TLS mode, you might get C<on_error> or C<on_eof>
1741	callback invocations when you are not expecting any read data - the reason	2126	callback invocations when you are not expecting any read data - the reason
1742	is that AnyEvent::Handle always reads in TLS mode.	2127	is that AnyEvent::Handle always reads in TLS mode.
1743		2128
1744	During the connection, you have to make sure that you always have a	2129	During the connection, you have to make sure that you always have a
1745	non-empty read-queue, or an C<on_read> watcher. At the end of the	2130	non-empty read-queue, or an C<on_read> watcher. At the end of the
…		…
1759	my $data = delete $_[0]{rbuf};	2144	my $data = delete $_[0]{rbuf};
1760	});	2145	});
1761		2146
1762	The reason to use C<on_error> is that TCP connections, due to latencies	2147	The reason to use C<on_error> is that TCP connections, due to latencies
1763	and packets loss, might get closed quite violently with an error, when in	2148	and packets loss, might get closed quite violently with an error, when in
1764	fact, all data has been received.	2149	fact all data has been received.
1765		2150
1766	It is usually better to use acknowledgements when transferring data,	2151	It is usually better to use acknowledgements when transferring data,
1767	to make sure the other side hasn't just died and you got the data	2152	to make sure the other side hasn't just died and you got the data
1768	intact. This is also one reason why so many internet protocols have an	2153	intact. This is also one reason why so many internet protocols have an
1769	explicit QUIT command.	2154	explicit QUIT command.
…		…
1786	consider using C<< ->push_shutdown >> instead.	2171	consider using C<< ->push_shutdown >> instead.
1787		2172
1788	=item I want to contact a TLS/SSL server, I don't care about security.	2173	=item I want to contact a TLS/SSL server, I don't care about security.
1789		2174
1790	If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS,	2175	If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS,
1791	simply connect to it and then create the AnyEvent::Handle with the C<tls>	2176	connect to it and then create the AnyEvent::Handle with the C<tls>
1792	parameter:	2177	parameter:
1793		2178
1794	tcp_connect $host, $port, sub {	2179	tcp_connect $host, $port, sub {
1795	my ($fh) = @_;	2180	my ($fh) = @_;
1796		2181
…		…
1896		2281
1897	=item * all members not documented here and not prefixed with an underscore	2282	=item * all members not documented here and not prefixed with an underscore
1898	are free to use in subclasses.	2283	are free to use in subclasses.
1899		2284
1900	Of course, new versions of AnyEvent::Handle may introduce more "public"	2285	Of course, new versions of AnyEvent::Handle may introduce more "public"
1901	member variables, but thats just life, at least it is documented.	2286	member variables, but that's just life. At least it is documented.
1902		2287
1903	=back	2288	=back
1904		2289
1905	=head1 AUTHOR	2290	=head1 AUTHOR
1906		2291

Diff Legend

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