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.150 by root, Thu Jul 16 04:16:25 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;
…		…
26	my $cv = AnyEvent->condvar;	10	my $cv = AnyEvent->condvar;
27		11
28	my $hdl; $hdl = new AnyEvent::Handle	12	my $hdl; $hdl = new AnyEvent::Handle
29	fh => \*STDIN,	13	fh => \*STDIN,
30	on_error => sub {	14	on_error => sub {
		15	my ($hdl, $fatal, $msg) = @_;
31	warn "got error $_[2]\n";	16	warn "got error $msg\n";
		17	$hdl->destroy;
32	$cv->send;	18	$cv->send;
33	);	19	};
34		20
35	# send some request line	21	# send some request line
36	$hdl->push_write ("getinfo\015\012");	22	$hdl->push_write ("getinfo\015\012");
37		23
38	# read the response line	24	# read the response line
…		…
44		30
45	$cv->recv;	31	$cv->recv;
46		32
47	=head1 DESCRIPTION	33	=head1 DESCRIPTION
48		34
49	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
50	filehandles. For utility functions for doing non-blocking connects and accepts	36	stream-based filehandles (sockets, pipes, and other stream things).
51	on sockets see L<AnyEvent::Util>.
52		37
53	The L<AnyEvent::Intro> tutorial contains some well-documented	38	The L<AnyEvent::Intro> tutorial contains some well-documented
54	AnyEvent::Handle examples.	39	AnyEvent::Handle examples.
55		40
56	In the following, when the documentation refers to of "bytes" then this	41	In the following, where the documentation refers to "bytes", it means
57	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
58	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.
59		47
60	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
61	argument.	49	argument.
62		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
63	=head1 METHODS	80	=head1 METHODS
64		81
65	=over 4	82	=over 4
66		83
67	=item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value...	84	=item $handle = B<new> AnyEvent::Handle fh => $filehandle, key => value...
68		85
69	The constructor supports these arguments (all as C<< key => value >> pairs).	86	The constructor supports these arguments (all as C<< key => value >> pairs).
70		87
71	=over 4	88	=over 4
72		89
73	=item fh => $filehandle [MANDATORY]	90	=item fh => $filehandle [C<fh> or C<connect> MANDATORY]
74		91
75	The filehandle this L<AnyEvent::Handle> object will operate on.	92	The filehandle this L<AnyEvent::Handle> object will operate on.
76
77	NOTE: The filehandle will be set to non-blocking mode (using	93	NOTE: The filehandle will be set to non-blocking mode (using
78	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
79	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.
80		208
81	=item on_eof => $cb->($handle)	209	=item on_eof => $cb->($handle)
82		210
83	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,
84	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
…		…
92	down.	220	down.
93		221
94	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
95	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>.
96		224
97	=item on_error => $cb->($handle, $fatal, $message)
98
99	This is the error callback, which is called when, well, some error
100	occured, such as not being able to resolve the hostname, failure to
101	connect or a read error.
102
103	Some errors are fatal (which is indicated by C<$fatal> being true). On
104	fatal errors the handle object will be destroyed (by a call to C<< ->
105	destroy >>) after invoking the error callback (which means you are free to
106	examine the handle object). Examples of fatal errors are an EOF condition
107	with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors.
108
109	AnyEvent::Handle tries to find an appropriate error code for you to check
110	against, but in some cases (TLS errors), this does not work well. It is
111	recommended to always output the C<$message> argument in human-readable
112	error messages (it's usually the same as C<"$!">).
113
114	Non-fatal errors can be retried by simply returning, but it is recommended
115	to simply ignore this parameter and instead abondon the handle object
116	when this callback is invoked. Examples of non-fatal errors are timeouts
117	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
118
119	On callback entrance, the value of C<$!> contains the operating system
120	error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
121	C<EPROTO>).
122
123	While not mandatory, it is I<highly> recommended to set this callback, as
124	you will not be notified of errors otherwise. The default simply calls
125	C<croak>.
126
127	=item on_read => $cb->($handle)
128
129	This sets the default read callback, which is called when data arrives
130	and no read request is in the queue (unlike read queue callbacks, this
131	callback will only be called when at least one octet of data is in the
132	read buffer).
133
134	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
135	method or access the C<< $handle->{rbuf} >> member directly. Note that you
136	must not enlarge or modify the read buffer, you can only remove data at
137	the beginning from it.
138
139	When an EOF condition is detected then AnyEvent::Handle will first try to
140	feed all the remaining data to the queued callbacks and C<on_read> before
141	calling the C<on_eof> callback. If no progress can be made, then a fatal
142	error will be raised (with C<$!> set to C<EPIPE>).
143
144	Note that, unlike requests in the read queue, an C<on_read> callback
145	doesn't mean you I<require> some data: if there is an EOF and there
146	are outstanding read requests then an error will be flagged. With an
147	C<on_read> callback, the C<on_eof> callback will be invoked.
148
149	=item on_drain => $cb->($handle)	225	=item on_drain => $cb->($handle)
150		226
151	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
152	(or when the callback is set and the buffer is empty already).	228	(or immediately if the buffer is empty already).
153		229
154	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.
155		231
156	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
157	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
…		…
159	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
160	the file when the write queue becomes empty.	236	the file when the write queue becomes empty.
161		237
162	=item timeout => $fractional_seconds	238	=item timeout => $fractional_seconds
163		239
		240	=item rtimeout => $fractional_seconds
		241
		242	=item wtimeout => $fractional_seconds
		243
164	If non-zero, then this enables an "inactivity" timeout: whenever this many	244	If non-zero, then these enables an "inactivity" timeout: whenever this
165	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
166	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
167	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).
168		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
169	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
170	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
171	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
172	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
173	restart the timeout.	260	restart the timeout.
174		261
175	Zero (the default) disables this timeout.	262	Zero (the default) disables this timeout.
176		263
…		…
192	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
193	isn't finished).	280	isn't finished).
194		281
195	=item autocork => <boolean>	282	=item autocork => <boolean>
196		283
197	When disabled (the default), then C<push_write> will try to immediately	284	When disabled (the default), C<push_write> will try to immediately
198	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
199	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
200	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
201	disadvantage is usually avoided by your kernel's nagle algorithm, see	288	disadvantage is usually avoided by your kernel's nagle algorithm, see
202	C<no_delay>, but this option can save costly syscalls).	289	C<no_delay>, but this option can save costly syscalls).
203		290
204	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
205	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,
206	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
207	the write buffer often is full). It also increases write latency.	294	the write buffer often is full). It also increases write latency.
208		295
209	=item no_delay => <boolean>	296	=item no_delay => <boolean>
…		…
213	the Nagle algorithm, and usually it is beneficial.	300	the Nagle algorithm, and usually it is beneficial.
214		301
215	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
216	accomplishd by setting this option to a true value.	303	accomplishd by setting this option to a true value.
217		304
218	The default is your opertaing system's default behaviour (most likely	305	The default is your operating system's default behaviour (most likely
219	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.
220		339
221	=item read_size => <bytes>	340	=item read_size => <bytes>
222		341
223	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
224	try to read during each loop iteration, which affects memory	343	try to read during each loop iteration, which affects memory
225	requirements). Default: C<8192>.	344	requirements). Default: C<8192>.
226		345
227	=item low_water_mark => <bytes>	346	=item low_water_mark => <bytes>
228		347
229	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
230	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
231	considered empty.	350	considered empty.
232		351
233	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
234	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
235	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
236	is good in almost all cases.	355	is good in almost all cases.
237		356
238	=item linger => <seconds>	357	=item linger => <seconds>
239		358
240	If non-zero (default: C<3600>), then the destructor of the	359	If this is non-zero (default: C<3600>), the destructor of the
241	AnyEvent::Handle object will check whether there is still outstanding	360	AnyEvent::Handle object will check whether there is still outstanding
242	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
243	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
244	system treats outstanding data at socket close time).	363	system treats outstanding data at socket close time).
245		364
…		…
252	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
253	(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.
254		373
255	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
256	peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This	375	peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This
257	verification will be skipped when C<peername> is not specified or	376	verification will be skipped when C<peername> is not specified or is
258	C<undef>.	377	C<undef>.
259		378
260	=item tls => "accept" | "connect" | Net::SSLeay::SSL object	379	=item tls => "accept" | "connect" | Net::SSLeay::SSL object
261		380
262	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
263	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
264	established and will transparently encrypt/decrypt data afterwards.	383	established and will transparently encrypt/decrypt data afterwards.
265		384
266	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
267	appropriate error message.	386	appropriate error message.
268		387
…		…
288	B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,	407	B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,
289	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
290	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
291	segmentation fault.	410	segmentation fault.
292		411
293	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.
294		413
295	=item tls_ctx => $anyevent_tls	414	=item tls_ctx => $anyevent_tls
296		415
297	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
298	(unless a connection object was specified directly). If this parameter is	417	(unless a connection object was specified directly). If this parameter is
…		…
313		432
314	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
315	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>.
316		435
317	Without this callback, handshake failures lead to C<on_error> being	436	Without this callback, handshake failures lead to C<on_error> being
318	called, as normal.	437	called as usual.
319		438
320	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
321	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
322	then call C<< ->starttls >> again.	441	then call C<< ->starttls >> again.
323		442
324	=item on_stoptls => $cb->($handle)	443	=item on_stoptls => $cb->($handle)
325		444
…		…
351		470
352	sub new {	471	sub new {
353	my $class = shift;	472	my $class = shift;
354	my $self = bless { @_ }, $class;	473	my $self = bless { @_ }, $class;
355		474
356	$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;
357		544
358	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	545	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
359		546
		547	$self->{_activity} =
		548	$self->{_ractivity} =
360	$self->{_activity} = AnyEvent->now;	549	$self->{_wactivity} = AE::now;
361	$self->_timeout;
362		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
363	$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};
364		557
		558	$self->oobinline (exists $self->{oobinline} ? delete $self->{oobinline} : 1);
		559
365	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})	560	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
366	if $self->{tls};	561	if $self->{tls};
367		562
368	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	563	$self->on_drain (delete $self->{on_drain} ) if $self->{on_drain};
369		564
370	$self->start_read	565	$self->start_read
371	if $self->{on_read};	566	if $self->{on_read} || @{ $self->{_queue} };
372		567
373	$self->{fh} && $self	568	$self->_drain_wbuf;
374	}	569	}
375
376	#sub _shutdown {
377	# my ($self) = @_;
378	#
379	# delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)};
380	# $self->{_eof} = 1; # tell starttls et. al to stop trying
381	#
382	# &_freetls;
383	#}
384		570
385	sub _error {	571	sub _error {
386	my ($self, $errno, $fatal, $message) = @_;	572	my ($self, $errno, $fatal, $message) = @_;
387		573
388	$! = $errno;	574	$! = $errno;
389	$message ||= "$!";	575	$message ||= "$!";
390		576
391	if ($self->{on_error}) {	577	if ($self->{on_error}) {
392	$self->{on_error}($self, $fatal, $message);	578	$self->{on_error}($self, $fatal, $message);
393	$self->destroy;	579	$self->destroy if $fatal;
394	} elsif ($self->{fh}) {	580	} elsif ($self->{fh} || $self->{connect}) {
395	$self->destroy;	581	$self->destroy;
396	Carp::croak "AnyEvent::Handle uncaught error: $message";	582	Carp::croak "AnyEvent::Handle uncaught error: $message";
397	}	583	}
398	}	584	}
399		585
…		…
425	$_[0]{on_eof} = $_[1];	611	$_[0]{on_eof} = $_[1];
426	}	612	}
427		613
428	=item $handle->on_timeout ($cb)	614	=item $handle->on_timeout ($cb)
429		615
430	Replace the current C<on_timeout> callback, or disables the callback (but	616	=item $handle->on_rtimeout ($cb)
431	not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
432	argument and method.
433		617
434	=cut	618	=item $handle->on_wtimeout ($cb)
435		619
436	sub on_timeout {	620	Replace the current C<on_timeout>, C<on_rtimeout> or C<on_wtimeout>
437	$_[0]{on_timeout} = $_[1];	621	callback, or disables the callback (but not the timeout) if C<$cb> =
438	}	622	C<undef>. See the C<timeout> constructor argument and method.
		623
		624	=cut
		625
		626	# see below
439		627
440	=item $handle->autocork ($boolean)	628	=item $handle->autocork ($boolean)
441		629
442	Enables or disables the current autocork behaviour (see C<autocork>	630	Enables or disables the current autocork behaviour (see C<autocork>
443	constructor argument). Changes will only take effect on the next write.	631	constructor argument). Changes will only take effect on the next write.
…		…
456	=cut	644	=cut
457		645
458	sub no_delay {	646	sub no_delay {
459	$_[0]{no_delay} = $_[1];	647	$_[0]{no_delay} = $_[1];
460		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
461	eval {	663	eval {
462	local $SIG{__DIE__};	664	local $SIG{__DIE__};
463	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};
464	};	701	};
465	}	702	}
466		703
467	=item $handle->on_starttls ($cb)	704	=item $handle->on_starttls ($cb)
468		705
…		…
478		715
479	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).
480		717
481	=cut	718	=cut
482		719
483	sub on_starttls {	720	sub on_stoptls {
484	$_[0]{on_stoptls} = $_[1];	721	$_[0]{on_stoptls} = $_[1];
485	}	722	}
486		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
487	#############################################################################	734	#############################################################################
488		735
489	=item $handle->timeout ($seconds)	736	=item $handle->timeout ($seconds)
490		737
		738	=item $handle->rtimeout ($seconds)
		739
		740	=item $handle->wtimeout ($seconds)
		741
491	Configures (or disables) the inactivity timeout.	742	Configures (or disables) the inactivity timeout.
492		743
493	=cut	744	=item $handle->timeout_reset
494		745
495	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 {
496	my ($self, $timeout) = @_;	768	my ($self, $new_value) = @_;
497		769
		770	$new_value >= 0
		771	or Carp::croak "AnyEvent::Handle->$timeout called with negative timeout ($new_value), caught";
		772
498	$self->{timeout} = $timeout;	773	$self->{$timeout} = $new_value;
499	$self->_timeout;	774	delete $self->{$tw}; &$cb;
500	}	775	};
501		776
		777	*{"${dir}timeout_reset"} = sub {
		778	$_[0]{$activity} = AE::now;
		779	};
		780
		781	# main workhorse:
502	# reset the timeout watcher, as neccessary	782	# reset the timeout watcher, as neccessary
503	# also check for time-outs	783	# also check for time-outs
504	sub _timeout {	784	$cb = sub {
505	my ($self) = @_;	785	my ($self) = @_;
506		786
507	if ($self->{timeout}) {	787	if ($self->{$timeout} && $self->{fh}) {
508	my $NOW = AnyEvent->now;	788	my $NOW = AE::now;
509		789
510	# when would the timeout trigger?	790	# when would the timeout trigger?
511	my $after = $self->{_activity} + $self->{timeout} - $NOW;	791	my $after = $self->{$activity} + $self->{$timeout} - $NOW;
512		792
513	# now or in the past already?	793	# now or in the past already?
514	if ($after <= 0) {	794	if ($after <= 0) {
515	$self->{_activity} = $NOW;	795	$self->{$activity} = $NOW;
516		796
517	if ($self->{on_timeout}) {	797	if ($self->{$on_timeout}) {
518	$self->{on_timeout}($self);	798	$self->{$on_timeout}($self);
519	} else {	799	} else {
520	$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};
521	}	808	}
522		809
523	# callback could have changed timeout value, optimise	810	Scalar::Util::weaken $self;
524	return unless $self->{timeout};	811	return unless $self; # ->error could have destroyed $self
525		812
526	# calculate new after	813	$self->{$tw} ||= AE::timer $after, 0, sub {
527	$after = $self->{timeout};	814	delete $self->{$tw};
		815	$cb->($self);
		816	};
		817	} else {
		818	delete $self->{$tw};
528	}	819	}
529
530	Scalar::Util::weaken $self;
531	return unless $self; # ->error could have destroyed $self
532
533	$self->{_tw} ||= AnyEvent->timer (after => $after, cb => sub {
534	delete $self->{_tw};
535	$self->_timeout;
536	});
537	} else {
538	delete $self->{_tw};
539	}	820	}
540	}	821	}
541		822
542	#############################################################################	823	#############################################################################
543		824
…		…
558		839
559	=item $handle->on_drain ($cb)	840	=item $handle->on_drain ($cb)
560		841
561	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
562	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).
563		847
564	=cut	848	=cut
565		849
566	sub on_drain {	850	sub on_drain {
567	my ($self, $cb) = @_;	851	my ($self, $cb) = @_;
…		…
576		860
577	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
578	want (only limited by the available memory), as C<AnyEvent::Handle>	862	want (only limited by the available memory), as C<AnyEvent::Handle>
579	buffers it independently of the kernel.	863	buffers it independently of the kernel.
580		864
		865	This method may invoke callbacks (and therefore the handle might be
		866	destroyed after it returns).
		867
581	=cut	868	=cut
582		869
583	sub _drain_wbuf {	870	sub _drain_wbuf {
584	my ($self) = @_;	871	my ($self) = @_;
585		872
…		…
591	my $len = syswrite $self->{fh}, $self->{wbuf};	878	my $len = syswrite $self->{fh}, $self->{wbuf};
592		879
593	if (defined $len) {	880	if (defined $len) {
594	substr $self->{wbuf}, 0, $len, "";	881	substr $self->{wbuf}, 0, $len, "";
595		882
596	$self->{_activity} = AnyEvent->now;	883	$self->{_activity} = $self->{_wactivity} = AE::now;
597		884
598	$self->{on_drain}($self)	885	$self->{on_drain}($self)
599	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})
600	&& $self->{on_drain};	887	&& $self->{on_drain};
601		888
…		…
607		894
608	# try to write data immediately	895	# try to write data immediately
609	$cb->() unless $self->{autocork};	896	$cb->() unless $self->{autocork};
610		897
611	# if still data left in wbuf, we need to poll	898	# if still data left in wbuf, we need to poll
612	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	899	$self->{_ww} = AE::io $self->{fh}, 1, $cb
613	if length $self->{wbuf};	900	if length $self->{wbuf};
614	};	901	};
615	}	902	}
616		903
617	our %WH;	904	our %WH;
618		905
		906	# deprecated
619	sub register_write_type($$) {	907	sub register_write_type($$) {
620	$WH{$_[0]} = $_[1];	908	$WH{$_[0]} = $_[1];
621	}	909	}
622		910
623	sub push_write {	911	sub push_write {
624	my $self = shift;	912	my $self = shift;
625		913
626	if (@_ > 1) {	914	if (@_ > 1) {
627	my $type = shift;	915	my $type = shift;
628		916
		917	@_ = ($WH{$type} ||= _load_func "$type\::anyevent_write_type"
629	@_ = ($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")
630	->($self, @_);	919	->($self, @_);
631	}	920	}
632		921
		922	# we downgrade here to avoid hard-to-track-down bugs,
		923	# and diagnose the problem earlier and better.
		924
633	if ($self->{tls}) {	925	if ($self->{tls}) {
634	$self->{_tls_wbuf} .= $_[0];	926	utf8::downgrade $self->{_tls_wbuf} .= $_[0];
635		927	&_dotls ($self) if $self->{fh};
636	&_dotls ($self);
637	} else {	928	} else {
638	$self->{wbuf} .= $_[0];	929	utf8::downgrade $self->{wbuf} .= $_[0];
639	$self->_drain_wbuf;	930	$self->_drain_wbuf if $self->{fh};
640	}	931	}
641	}	932	}
642		933
643	=item $handle->push_write (type => @args)	934	=item $handle->push_write (type => @args)
644		935
645	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
646	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).
647		941
648	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
649	drop by and tell us):	943	drop by and tell us):
650		944
651	=over 4	945	=over 4
…		…
708	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
709	this line into their JSON decoder of choice.	1003	this line into their JSON decoder of choice.
710		1004
711	=cut	1005	=cut
712		1006
		1007	sub json_coder() {
		1008	eval { require JSON::XS; JSON::XS->new->utf8 }
		1009	|| do { require JSON; JSON->new->utf8 }
		1010	}
		1011
713	register_write_type json => sub {	1012	register_write_type json => sub {
714	my ($self, $ref) = @_;	1013	my ($self, $ref) = @_;
715		1014
716	require JSON;	1015	my $json = $self->{json} ||= json_coder;
717		1016
718	$self->{json} ? $self->{json}->encode ($ref)	1017	$json->encode ($ref)
719	: JSON::encode_json ($ref)
720	};	1018	};
721		1019
722	=item storable => $reference	1020	=item storable => $reference
723		1021
724	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
…		…
750	the peer.	1048	the peer.
751		1049
752	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
753	afterwards. This is the cleanest way to close a connection.	1051	afterwards. This is the cleanest way to close a connection.
754		1052
		1053	This method may invoke callbacks (and therefore the handle might be
		1054	destroyed after it returns).
		1055
755	=cut	1056	=cut
756		1057
757	sub push_shutdown {	1058	sub push_shutdown {
758	my ($self) = @_;	1059	my ($self) = @_;
759		1060
760	delete $self->{low_water_mark};	1061	delete $self->{low_water_mark};
761	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });	1062	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });
762	}	1063	}
763		1064
764	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	1065	=item custom write types - Package::anyevent_write_type $handle, @args
765		1066
766	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
767	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
768	reference with the handle object and the remaining arguments.	1074	the handle object and the remaining arguments.
769		1075
770	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
771	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.
772		1079
773	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
774	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	}
775		1096
776	=cut	1097	=cut
777		1098
778	#############################################################################	1099	#############################################################################
779		1100
…		…
788	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
789	a queue.	1110	a queue.
790		1111
791	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
792	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
793	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
794	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
795	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>.
796		1118
797	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
798	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
799	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
800	done its job (see C<push_read>, below).	1122	done its job (see C<push_read>, below).
801		1123
802	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
803	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.
804		1126
…		…
861	=cut	1183	=cut
862		1184
863	sub _drain_rbuf {	1185	sub _drain_rbuf {
864	my ($self) = @_;	1186	my ($self) = @_;
865		1187
		1188	# avoid recursion
		1189	return if $self->{_skip_drain_rbuf};
866	local $self->{_in_drain} = 1;	1190	local $self->{_skip_drain_rbuf} = 1;
867
868	if (
869	defined $self->{rbuf_max}
870	&& $self->{rbuf_max} < length $self->{rbuf}
871	) {
872	$self->_error (Errno::ENOSPC, 1), return;
873	}
874		1191
875	while () {	1192	while () {
876	# 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
877	# 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.
878	$self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf};	1195	$self->{rbuf} .= delete $self->{_tls_rbuf}
		1196	if exists $self->{_tls_rbuf};
879		1197
880	my $len = length $self->{rbuf};	1198	my $len = length $self->{rbuf};
881		1199
882	if (my $cb = shift @{ $self->{_queue} }) {	1200	if (my $cb = shift @{ $self->{_queue} }) {
883	unless ($cb->($self)) {	1201	unless ($cb->($self)) {
884	if ($self->{_eof}) {	1202	# no progress can be made
885	# no progress can be made (not enough data and no data forthcoming)	1203	# (not enough data and no data forthcoming)
886	$self->_error (Errno::EPIPE, 1), return;	1204	$self->_error (Errno::EPIPE, 1), return
887	}	1205	if $self->{_eof};
888		1206
889	unshift @{ $self->{_queue} }, $cb;	1207	unshift @{ $self->{_queue} }, $cb;
890	last;	1208	last;
891	}	1209	}
892	} elsif ($self->{on_read}) {	1210	} elsif ($self->{on_read}) {
…		…
912	last;	1230	last;
913	}	1231	}
914	}	1232	}
915		1233
916	if ($self->{_eof}) {	1234	if ($self->{_eof}) {
917	if ($self->{on_eof}) {	1235	$self->{on_eof}
918	$self->{on_eof}($self)	1236	? $self->{on_eof}($self)
919	} else {
920	$self->_error (0, 1, "Unexpected end-of-file");	1237	: $self->_error (0, 1, "Unexpected end-of-file");
921	}	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;
922	}	1247	}
923		1248
924	# may need to restart read watcher	1249	# may need to restart read watcher
925	unless ($self->{_rw}) {	1250	unless ($self->{_rw}) {
926	$self->start_read	1251	$self->start_read
…		…
932		1257
933	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
934	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
935	constructor.	1260	constructor.
936		1261
		1262	This method may invoke callbacks (and therefore the handle might be
		1263	destroyed after it returns).
		1264
937	=cut	1265	=cut
938		1266
939	sub on_read {	1267	sub on_read {
940	my ($self, $cb) = @_;	1268	my ($self, $cb) = @_;
941		1269
942	$self->{on_read} = $cb;	1270	$self->{on_read} = $cb;
943	$self->_drain_rbuf if $cb && !$self->{_in_drain};	1271	$self->_drain_rbuf if $cb;
944	}	1272	}
945		1273
946	=item $handle->rbuf	1274	=item $handle->rbuf
947		1275
948	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).
949		1279
950	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)
951	member, if you want. However, the only operation allowed on the	1281	is removing data from its beginning. Otherwise modifying or appending to
952	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.
953	beginning. Otherwise modifying or appending to it is not allowed and will
954	lead to hard-to-track-down bugs.
955		1283
956	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>
957	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
958	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.
959		1288
960	=cut	1289	=cut
961		1290
962	sub rbuf : lvalue {	1291	sub rbuf : lvalue {
963	$_[0]{rbuf}	1292	$_[0]{rbuf}
…		…
980		1309
981	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
982	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
983	true, it will be removed from the queue.	1312	true, it will be removed from the queue.
984		1313
		1314	These methods may invoke callbacks (and therefore the handle might be
		1315	destroyed after it returns).
		1316
985	=cut	1317	=cut
986		1318
987	our %RH;	1319	our %RH;
988		1320
989	sub register_read_type($$) {	1321	sub register_read_type($$) {
…		…
995	my $cb = pop;	1327	my $cb = pop;
996		1328
997	if (@_) {	1329	if (@_) {
998	my $type = shift;	1330	my $type = shift;
999		1331
		1332	$cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type"
1000	$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")
1001	->($self, $cb, @_);	1334	->($self, $cb, @_);
1002	}	1335	}
1003		1336
1004	push @{ $self->{_queue} }, $cb;	1337	push @{ $self->{_queue} }, $cb;
1005	$self->_drain_rbuf unless $self->{_in_drain};	1338	$self->_drain_rbuf;
1006	}	1339	}
1007		1340
1008	sub unshift_read {	1341	sub unshift_read {
1009	my $self = shift;	1342	my $self = shift;
1010	my $cb = pop;	1343	my $cb = pop;
1011		1344
1012	if (@_) {	1345	if (@_) {
1013	my $type = shift;	1346	my $type = shift;
1014		1347
		1348	$cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type"
1015	$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")
1016	->($self, $cb, @_);	1350	->($self, $cb, @_);
1017	}	1351	}
1018		1352
1019
1020	unshift @{ $self->{_queue} }, $cb;	1353	unshift @{ $self->{_queue} }, $cb;
1021	$self->_drain_rbuf unless $self->{_in_drain};	1354	$self->_drain_rbuf;
1022	}	1355	}
1023		1356
1024	=item $handle->push_read (type => @args, $cb)	1357	=item $handle->push_read (type => @args, $cb)
1025		1358
1026	=item $handle->unshift_read (type => @args, $cb)	1359	=item $handle->unshift_read (type => @args, $cb)
1027		1360
1028	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
1029	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
1030	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).
1031		1366
1032	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
1033	drop by and tell us):	1368	drop by and tell us):
1034		1369
1035	=over 4	1370	=over 4
…		…
1127	the receive buffer when neither C<$accept> nor C<$reject> match,	1462	the receive buffer when neither C<$accept> nor C<$reject> match,
1128	and everything preceding and including the match will be accepted	1463	and everything preceding and including the match will be accepted
1129	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
1130	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
1131	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
1132	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.
1133		1468
1134	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
1135	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
1136	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
1137	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
1138	required for the accept regex.	1473	required for the accept regex.
1139		1474
1140	$handle->push_read (regex =>	1475	$handle->push_read (regex =>
…		…
1275	=cut	1610	=cut
1276		1611
1277	register_read_type json => sub {	1612	register_read_type json => sub {
1278	my ($self, $cb) = @_;	1613	my ($self, $cb) = @_;
1279		1614
1280	my $json = $self->{json} ||=	1615	my $json = $self->{json} ||= json_coder;
1281	eval { require JSON::XS; JSON::XS->new->utf8 }
1282	|| do { require JSON; JSON->new->utf8 };
1283		1616
1284	my $data;	1617	my $data;
1285	my $rbuf = \$self->{rbuf};	1618	my $rbuf = \$self->{rbuf};
1286		1619
1287	sub {	1620	sub {
…		…
1356	}	1689	}
1357	};	1690	};
1358		1691
1359	=back	1692	=back
1360		1693
1361	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)	1694	=item custom read types - Package::anyevent_read_type $handle, $cb, @args
1362		1695
1363	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).
1364		1701
1365	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
1366	reference with the handle object, the callback and the remaining	1703	handle object, the original callback and the remaining arguments.
1367	arguments.
1368		1704
1369	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
1370	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.
1371		1709
1372	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
1373	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).
1374		1713
1375	Note that this is a function, and all types registered this way will be
1376	global, so try to use unique names.
1377
1378	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
1379	search for C<register_read_type>)).	1715	AnyEvent::Handle>, search for C<register_read_type>)).
1380		1716
1381	=item $handle->stop_read	1717	=item $handle->stop_read
1382		1718
1383	=item $handle->start_read	1719	=item $handle->start_read
1384		1720
…		…
1404	}	1740	}
1405		1741
1406	sub start_read {	1742	sub start_read {
1407	my ($self) = @_;	1743	my ($self) = @_;
1408		1744
1409	unless ($self->{_rw} || $self->{_eof}) {	1745	unless ($self->{_rw} || $self->{_eof} || !$self->{fh}) {
1410	Scalar::Util::weaken $self;	1746	Scalar::Util::weaken $self;
1411		1747
1412	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1748	$self->{_rw} = AE::io $self->{fh}, 0, sub {
1413	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});	1749	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1414	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;
1415		1751
1416	if ($len > 0) {	1752	if ($len > 0) {
1417	$self->{_activity} = AnyEvent->now;	1753	$self->{_activity} = $self->{_ractivity} = AE::now;
1418		1754
1419	if ($self->{tls}) {	1755	if ($self->{tls}) {
1420	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);	1756	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1421		1757
1422	&_dotls ($self);	1758	&_dotls ($self);
1423	} else {	1759	} else {
1424	$self->_drain_rbuf unless $self->{_in_drain};	1760	$self->_drain_rbuf;
1425	}	1761	}
1426		1762
1427	} elsif (defined $len) {	1763	} elsif (defined $len) {
1428	delete $self->{_rw};	1764	delete $self->{_rw};
1429	$self->{_eof} = 1;	1765	$self->{_eof} = 1;
1430	$self->_drain_rbuf unless $self->{_in_drain};	1766	$self->_drain_rbuf;
1431		1767
1432	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1768	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1433	return $self->_error ($!, 1);	1769	return $self->_error ($!, 1);
1434	}	1770	}
1435	});	1771	};
1436	}	1772	}
1437	}	1773	}
1438		1774
1439	our $ERROR_SYSCALL;	1775	our $ERROR_SYSCALL;
1440	our $ERROR_WANT_READ;	1776	our $ERROR_WANT_READ;
…		…
1495	$self->{_eof} = 1;	1831	$self->{_eof} = 1;
1496	}	1832	}
1497	}	1833	}
1498		1834
1499	$self->{_tls_rbuf} .= $tmp;	1835	$self->{_tls_rbuf} .= $tmp;
1500	$self->_drain_rbuf unless $self->{_in_drain};	1836	$self->_drain_rbuf;
1501	$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
1502	}	1838	}
1503		1839
1504	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);	1840	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1505	return $self->_tls_error ($tmp)	1841	return $self->_tls_error ($tmp)
…		…
1507	&& ($tmp != $ERROR_SYSCALL || $!);	1843	&& ($tmp != $ERROR_SYSCALL || $!);
1508		1844
1509	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1845	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1510	$self->{wbuf} .= $tmp;	1846	$self->{wbuf} .= $tmp;
1511	$self->_drain_wbuf;	1847	$self->_drain_wbuf;
		1848	$self->{tls} or return; # tls session might have gone away in callback
1512	}	1849	}
1513		1850
1514	$self->{_on_starttls}	1851	$self->{_on_starttls}
1515	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()	1852	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
1516	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");	1853	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");
…		…
1519	=item $handle->starttls ($tls[, $tls_ctx])	1856	=item $handle->starttls ($tls[, $tls_ctx])
1520		1857
1521	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	1858	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
1522	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
1523	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.
1524		1865
1525	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
1526	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1867	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1527		1868
1528	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
…		…
1533	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
1534	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
1535	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
1536	when this function returns.	1877	when this function returns.
1537		1878
1538	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
1539	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).
1540		1885
1541	=cut	1886	=cut
1542		1887
1543	our %TLS_CACHE; #TODO not yet documented, should we?	1888	our %TLS_CACHE; #TODO not yet documented, should we?
1544		1889
1545	sub starttls {	1890	sub starttls {
1546	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};
1547		1900
1548	require Net::SSLeay;	1901	require Net::SSLeay;
1549
1550	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"
1551	if $self->{tls};
1552		1902
1553	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();	1903	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1554	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();	1904	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1555		1905
		1906	$tls = delete $self->{tls};
1556	$ctx ||= $self->{tls_ctx};	1907	$ctx = $self->{tls_ctx};
		1908
		1909	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
1557		1910
1558	if ("HASH" eq ref $ctx) {	1911	if ("HASH" eq ref $ctx) {
1559	require AnyEvent::TLS;	1912	require AnyEvent::TLS;
1560
1561	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context
1562		1913
1563	if ($ctx->{cache}) {	1914	if ($ctx->{cache}) {
1564	my $key = $ctx+0;	1915	my $key = $ctx+0;
1565	$ctx = $TLS_CACHE{$key} ||= new AnyEvent::TLS %$ctx;	1916	$ctx = $TLS_CACHE{$key} ||= new AnyEvent::TLS %$ctx;
1566	} else {	1917	} else {
1567	$ctx = new AnyEvent::TLS %$ctx;	1918	$ctx = new AnyEvent::TLS %$ctx;
1568	}	1919	}
1569	}	1920	}
1570		1921
1571	$self->{tls_ctx} = $ctx || TLS_CTX ();	1922	$self->{tls_ctx} = $ctx || TLS_CTX ();
1572	$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});
1573		1924
1574	# 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)
1575	# but the openssl maintainers basically said: "trust us, it just works".	1926	# but the openssl maintainers basically said: "trust us, it just works".
1576	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1927	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1577	# and mismaintained ssleay-module doesn't even offer them).	1928	# and mismaintained ssleay-module doesn't even offer them).
…		…
1584	# 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
1585	# have identity issues in that area.	1936	# have identity issues in that area.
1586	# Net::SSLeay::CTX_set_mode ($ssl,	1937	# Net::SSLeay::CTX_set_mode ($ssl,
1587	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)	1938	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)
1588	# | (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));
1589	Net::SSLeay::CTX_set_mode ($ssl, 1|2);	1940	Net::SSLeay::CTX_set_mode ($tls, 1|2);
1590		1941
1591	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1942	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1592	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1943	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1593		1944
		1945	Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf});
		1946
1594	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1947	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
1595		1948
1596	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }	1949	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1597	if $self->{on_starttls};	1950	if $self->{on_starttls};
1598		1951
1599	&_dotls; # need to trigger the initial handshake	1952	&_dotls; # need to trigger the initial handshake
…		…
1602		1955
1603	=item $handle->stoptls	1956	=item $handle->stoptls
1604		1957
1605	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
1606	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
1607	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
1608	afterwards.	1961	the stream afterwards.
		1962
		1963	This method may invoke callbacks (and therefore the handle might be
		1964	destroyed after it returns).
1609		1965
1610	=cut	1966	=cut
1611		1967
1612	sub stoptls {	1968	sub stoptls {
1613	my ($self) = @_;	1969	my ($self) = @_;
1614		1970
1615	if ($self->{tls}) {	1971	if ($self->{tls} && $self->{fh}) {
1616	Net::SSLeay::shutdown ($self->{tls});	1972	Net::SSLeay::shutdown ($self->{tls});
1617		1973
1618	&_dotls;	1974	&_dotls;
1619		1975
1620	# # 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#
…		…
1626	sub _freetls {	1982	sub _freetls {
1627	my ($self) = @_;	1983	my ($self) = @_;
1628		1984
1629	return unless $self->{tls};	1985	return unless $self->{tls};
1630		1986
1631	$self->{tls_ctx}->_put_session (delete $self->{tls});	1987	$self->{tls_ctx}->_put_session (delete $self->{tls})
		1988	if $self->{tls} > 0;
1632		1989
1633	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};	1990	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1634	}	1991	}
1635		1992
1636	sub DESTROY {	1993	sub DESTROY {
…		…
1638		1995
1639	&_freetls;	1996	&_freetls;
1640		1997
1641	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	1998	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1642		1999
1643	if ($linger && length $self->{wbuf}) {	2000	if ($linger && length $self->{wbuf} && $self->{fh}) {
1644	my $fh = delete $self->{fh};	2001	my $fh = delete $self->{fh};
1645	my $wbuf = delete $self->{wbuf};	2002	my $wbuf = delete $self->{wbuf};
1646		2003
1647	my @linger;	2004	my @linger;
1648		2005
1649	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {	2006	push @linger, AE::io $fh, 1, sub {
1650	my $len = syswrite $fh, $wbuf, length $wbuf;	2007	my $len = syswrite $fh, $wbuf, length $wbuf;
1651		2008
1652	if ($len > 0) {	2009	if ($len > 0) {
1653	substr $wbuf, 0, $len, "";	2010	substr $wbuf, 0, $len, "";
1654	} else {	2011	} elsif (defined $len || ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK)) {
1655	@linger = (); # end	2012	@linger = (); # end
1656	}	2013	}
1657	});	2014	};
1658	push @linger, AnyEvent->timer (after => $linger, cb => sub {	2015	push @linger, AE::timer $linger, 0, sub {
1659	@linger = ();	2016	@linger = ();
1660	});	2017	};
1661	}	2018	}
1662	}	2019	}
1663		2020
1664	=item $handle->destroy	2021	=item $handle->destroy
1665		2022
1666	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
1667	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
1668	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).
1669		2028
1670	Normally, you can just "forget" any references to an AnyEvent::Handle	2029	Normally, you can just "forget" any references to an AnyEvent::Handle
1671	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
1672	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
1673	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
…		…
1687	sub destroy {	2046	sub destroy {
1688	my ($self) = @_;	2047	my ($self) = @_;
1689		2048
1690	$self->DESTROY;	2049	$self->DESTROY;
1691	%$self = ();	2050	%$self = ();
		2051	bless $self, "AnyEvent::Handle::destroyed";
1692	}	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 }
1693		2080
1694	=item AnyEvent::Handle::TLS_CTX	2081	=item AnyEvent::Handle::TLS_CTX
1695		2082
1696	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
1697	for TLS mode.	2084	for TLS mode.
…		…
1729		2116
1730	=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
1731	reading?	2118	reading?
1732		2119
1733	Unlike, say, TCP, TLS connections do not consist of two independent	2120	Unlike, say, TCP, TLS connections do not consist of two independent
1734	communication channels, one for each direction. Or put differently. The	2121	communication channels, one for each direction. Or put differently, the
1735	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
1736	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.
1737		2124
1738	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>
1739	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
1740	is that AnyEvent::Handle always reads in TLS mode.	2127	is that AnyEvent::Handle always reads in TLS mode.
1741		2128
1742	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
1743	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
…		…
1757	my $data = delete $_[0]{rbuf};	2144	my $data = delete $_[0]{rbuf};
1758	});	2145	});
1759		2146
1760	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
1761	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
1762	fact, all data has been received.	2149	fact all data has been received.
1763		2150
1764	It is usually better to use acknowledgements when transferring data,	2151	It is usually better to use acknowledgements when transferring data,
1765	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
1766	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
1767	explicit QUIT command.	2154	explicit QUIT command.
…		…
1784	consider using C<< ->push_shutdown >> instead.	2171	consider using C<< ->push_shutdown >> instead.
1785		2172
1786	=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.
1787		2174
1788	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,
1789	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>
1790	parameter:	2177	parameter:
1791		2178
1792	tcp_connect $host, $port, sub {	2179	tcp_connect $host, $port, sub {
1793	my ($fh) = @_;	2180	my ($fh) = @_;
1794		2181
…		…
1894		2281
1895	=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
1896	are free to use in subclasses.	2283	are free to use in subclasses.
1897		2284
1898	Of course, new versions of AnyEvent::Handle may introduce more "public"	2285	Of course, new versions of AnyEvent::Handle may introduce more "public"
1899	member variables, but thats just life, at least it is documented.	2286	member variables, but that's just life. At least it is documented.
1900		2287
1901	=back	2288	=back
1902		2289
1903	=head1 AUTHOR	2290	=head1 AUTHOR
1904		2291

Diff Legend

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