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.152 by root, Fri Jul 17 14:57:03 2009 UTC vs.
Revision 1.200 by root, Tue Oct 12 06:47: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.83;
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
500	$self->{timeout} = $timeout;	770	$self->{$timeout} = $new_value;
501	$self->_timeout;	771	delete $self->{$tw}; &$cb;
502	}	772	};
503		773
		774	*{"${dir}timeout_reset"} = sub {
		775	$_[0]{$activity} = AE::now;
		776	};
		777
		778	# main workhorse:
504	# reset the timeout watcher, as neccessary	779	# reset the timeout watcher, as neccessary
505	# also check for time-outs	780	# also check for time-outs
506	sub _timeout {	781	$cb = sub {
507	my ($self) = @_;	782	my ($self) = @_;
508		783
509	if ($self->{timeout}) {	784	if ($self->{$timeout} && $self->{fh}) {
510	my $NOW = AnyEvent->now;	785	my $NOW = AE::now;
511		786
512	# when would the timeout trigger?	787	# when would the timeout trigger?
513	my $after = $self->{_activity} + $self->{timeout} - $NOW;	788	my $after = $self->{$activity} + $self->{$timeout} - $NOW;
514		789
515	# now or in the past already?	790	# now or in the past already?
516	if ($after <= 0) {	791	if ($after <= 0) {
517	$self->{_activity} = $NOW;	792	$self->{$activity} = $NOW;
518		793
519	if ($self->{on_timeout}) {	794	if ($self->{$on_timeout}) {
520	$self->{on_timeout}($self);	795	$self->{$on_timeout}($self);
521	} else {	796	} else {
522	$self->_error (Errno::ETIMEDOUT);	797	$self->_error (Errno::ETIMEDOUT);
		798	}
		799
		800	# callback could have changed timeout value, optimise
		801	return unless $self->{$timeout};
		802
		803	# calculate new after
		804	$after = $self->{$timeout};
523	}	805	}
524		806
525	# callback could have changed timeout value, optimise	807	Scalar::Util::weaken $self;
526	return unless $self->{timeout};	808	return unless $self; # ->error could have destroyed $self
527		809
528	# calculate new after	810	$self->{$tw} ||= AE::timer $after, 0, sub {
529	$after = $self->{timeout};	811	delete $self->{$tw};
		812	$cb->($self);
		813	};
		814	} else {
		815	delete $self->{$tw};
530	}	816	}
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	}	817	}
542	}	818	}
543		819
544	#############################################################################	820	#############################################################################
545		821
…		…
560		836
561	=item $handle->on_drain ($cb)	837	=item $handle->on_drain ($cb)
562		838
563	Sets the C<on_drain> callback or clears it (see the description of	839	Sets the C<on_drain> callback or clears it (see the description of
564	C<on_drain> in the constructor).	840	C<on_drain> in the constructor).
		841
		842	This method may invoke callbacks (and therefore the handle might be
		843	destroyed after it returns).
565		844
566	=cut	845	=cut
567		846
568	sub on_drain {	847	sub on_drain {
569	my ($self, $cb) = @_;	848	my ($self, $cb) = @_;
…		…
578		857
579	Queues the given scalar to be written. You can push as much data as you	858	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>	859	want (only limited by the available memory), as C<AnyEvent::Handle>
581	buffers it independently of the kernel.	860	buffers it independently of the kernel.
582		861
		862	This method may invoke callbacks (and therefore the handle might be
		863	destroyed after it returns).
		864
583	=cut	865	=cut
584		866
585	sub _drain_wbuf {	867	sub _drain_wbuf {
586	my ($self) = @_;	868	my ($self) = @_;
587		869
…		…
593	my $len = syswrite $self->{fh}, $self->{wbuf};	875	my $len = syswrite $self->{fh}, $self->{wbuf};
594		876
595	if (defined $len) {	877	if (defined $len) {
596	substr $self->{wbuf}, 0, $len, "";	878	substr $self->{wbuf}, 0, $len, "";
597		879
598	$self->{_activity} = AnyEvent->now;	880	$self->{_activity} = $self->{_wactivity} = AE::now;
599		881
600	$self->{on_drain}($self)	882	$self->{on_drain}($self)
601	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})	883	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
602	&& $self->{on_drain};	884	&& $self->{on_drain};
603		885
…		…
609		891
610	# try to write data immediately	892	# try to write data immediately
611	$cb->() unless $self->{autocork};	893	$cb->() unless $self->{autocork};
612		894
613	# if still data left in wbuf, we need to poll	895	# if still data left in wbuf, we need to poll
614	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	896	$self->{_ww} = AE::io $self->{fh}, 1, $cb
615	if length $self->{wbuf};	897	if length $self->{wbuf};
616	};	898	};
617	}	899	}
618		900
619	our %WH;	901	our %WH;
620		902
		903	# deprecated
621	sub register_write_type($$) {	904	sub register_write_type($$) {
622	$WH{$_[0]} = $_[1];	905	$WH{$_[0]} = $_[1];
623	}	906	}
624		907
625	sub push_write {	908	sub push_write {
626	my $self = shift;	909	my $self = shift;
627		910
628	if (@_ > 1) {	911	if (@_ > 1) {
629	my $type = shift;	912	my $type = shift;
630		913
		914	@_ = ($WH{$type} ||= _load_func "$type\::anyevent_write_type"
631	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	915	or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_write")
632	->($self, @_);	916	->($self, @_);
633	}	917	}
634		918
		919	# we downgrade here to avoid hard-to-track-down bugs,
		920	# and diagnose the problem earlier and better.
		921
635	if ($self->{tls}) {	922	if ($self->{tls}) {
636	$self->{_tls_wbuf} .= $_[0];	923	utf8::downgrade $self->{_tls_wbuf} .= $_[0];
637		924	&_dotls ($self) if $self->{fh};
638	&_dotls ($self);
639	} else {	925	} else {
640	$self->{wbuf} .= $_[0];	926	utf8::downgrade $self->{wbuf} .= $_[0];
641	$self->_drain_wbuf;	927	$self->_drain_wbuf if $self->{fh};
642	}	928	}
643	}	929	}
644		930
645	=item $handle->push_write (type => @args)	931	=item $handle->push_write (type => @args)
646		932
647	Instead of formatting your data yourself, you can also let this module do	933	Instead of formatting your data yourself, you can also let this module
648	the job by specifying a type and type-specific arguments.	934	do the job by specifying a type and type-specific arguments. You
		935	can also specify the (fully qualified) name of a package, in which
		936	case AnyEvent tries to load the package and then expects to find the
		937	C<anyevent_write_type> function inside (see "custom write types", below).
649		938
650	Predefined types are (if you have ideas for additional types, feel free to	939	Predefined types are (if you have ideas for additional types, feel free to
651	drop by and tell us):	940	drop by and tell us):
652		941
653	=over 4	942	=over 4
…		…
710	Other languages could read single lines terminated by a newline and pass	999	Other languages could read single lines terminated by a newline and pass
711	this line into their JSON decoder of choice.	1000	this line into their JSON decoder of choice.
712		1001
713	=cut	1002	=cut
714		1003
		1004	sub json_coder() {
		1005	eval { require JSON::XS; JSON::XS->new->utf8 }
		1006	|| do { require JSON; JSON->new->utf8 }
		1007	}
		1008
715	register_write_type json => sub {	1009	register_write_type json => sub {
716	my ($self, $ref) = @_;	1010	my ($self, $ref) = @_;
717		1011
718	require JSON;	1012	my $json = $self->{json} ||= json_coder;
719		1013
720	$self->{json} ? $self->{json}->encode ($ref)	1014	$json->encode ($ref)
721	: JSON::encode_json ($ref)
722	};	1015	};
723		1016
724	=item storable => $reference	1017	=item storable => $reference
725		1018
726	Freezes the given reference using L<Storable> and writes it to the	1019	Freezes the given reference using L<Storable> and writes it to the
…		…
752	the peer.	1045	the peer.
753		1046
754	You can rely on the normal read queue and C<on_eof> handling	1047	You can rely on the normal read queue and C<on_eof> handling
755	afterwards. This is the cleanest way to close a connection.	1048	afterwards. This is the cleanest way to close a connection.
756		1049
		1050	This method may invoke callbacks (and therefore the handle might be
		1051	destroyed after it returns).
		1052
757	=cut	1053	=cut
758		1054
759	sub push_shutdown {	1055	sub push_shutdown {
760	my ($self) = @_;	1056	my ($self) = @_;
761		1057
762	delete $self->{low_water_mark};	1058	delete $self->{low_water_mark};
763	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });	1059	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });
764	}	1060	}
765		1061
766	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	1062	=item custom write types - Package::anyevent_write_type $handle, @args
767		1063
768	This function (not method) lets you add your own types to C<push_write>.	1064	Instead of one of the predefined types, you can also specify the name of
		1065	a package. AnyEvent will try to load the package and then expects to find
		1066	a function named C<anyevent_write_type> inside. If it isn't found, it
		1067	progressively tries to load the parent package until it either finds the
		1068	function (good) or runs out of packages (bad).
		1069
769	Whenever the given C<type> is used, C<push_write> will invoke the code	1070	Whenever the given C<type> is used, C<push_write> will the function with
770	reference with the handle object and the remaining arguments.	1071	the handle object and the remaining arguments.
771		1072
772	The code reference is supposed to return a single octet string that will	1073	The function is supposed to return a single octet string that will be
773	be appended to the write buffer.	1074	appended to the write buffer, so you cna mentally treat this function as a
		1075	"arguments to on-the-wire-format" converter.
774		1076
775	Note that this is a function, and all types registered this way will be	1077	Example: implement a custom write type C<join> that joins the remaining
776	global, so try to use unique names.	1078	arguments using the first one.
		1079
		1080	$handle->push_write (My::Type => " ", 1,2,3);
		1081
		1082	# uses the following package, which can be defined in the "My::Type" or in
		1083	# the "My" modules to be auto-loaded, or just about anywhere when the
		1084	# My::Type::anyevent_write_type is defined before invoking it.
		1085
		1086	package My::Type;
		1087
		1088	sub anyevent_write_type {
		1089	my ($handle, $delim, @args) = @_;
		1090
		1091	join $delim, @args
		1092	}
777		1093
778	=cut	1094	=cut
779		1095
780	#############################################################################	1096	#############################################################################
781		1097
…		…
790	ways, the "simple" way, using only C<on_read> and the "complex" way, using	1106	ways, the "simple" way, using only C<on_read> and the "complex" way, using
791	a queue.	1107	a queue.
792		1108
793	In the simple case, you just install an C<on_read> callback and whenever	1109	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	1110	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	1111	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	1112	leave the data there if you want to accumulate more (e.g. when only a
797	partial message has been received so far).	1113	partial message has been received so far), or change the read queue with
		1114	e.g. C<push_read>.
798		1115
799	In the more complex case, you want to queue multiple callbacks. In this	1116	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	1117	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	1118	data arrives (also the first time it is queued) and remove it when it has
802	done its job (see C<push_read>, below).	1119	done its job (see C<push_read>, below).
803		1120
804	This way you can, for example, push three line-reads, followed by reading	1121	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.	1122	a chunk of data, and AnyEvent::Handle will execute them in order.
806		1123
…		…
863	=cut	1180	=cut
864		1181
865	sub _drain_rbuf {	1182	sub _drain_rbuf {
866	my ($self) = @_;	1183	my ($self) = @_;
867		1184
		1185	# avoid recursion
		1186	return if $self->{_skip_drain_rbuf};
868	local $self->{_in_drain} = 1;	1187	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		1188
877	while () {	1189	while () {
878	# we need to use a separate tls read buffer, as we must not receive data while	1190	# we need to use a separate tls read buffer, as we must not receive data while
879	# we are draining the buffer, and this can only happen with TLS.	1191	# we are draining the buffer, and this can only happen with TLS.
880	$self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf};	1192	$self->{rbuf} .= delete $self->{_tls_rbuf}
		1193	if exists $self->{_tls_rbuf};
881		1194
882	my $len = length $self->{rbuf};	1195	my $len = length $self->{rbuf};
883		1196
884	if (my $cb = shift @{ $self->{_queue} }) {	1197	if (my $cb = shift @{ $self->{_queue} }) {
885	unless ($cb->($self)) {	1198	unless ($cb->($self)) {
886	if ($self->{_eof}) {	1199	# no progress can be made
887	# no progress can be made (not enough data and no data forthcoming)	1200	# (not enough data and no data forthcoming)
888	$self->_error (Errno::EPIPE, 1), return;	1201	$self->_error (Errno::EPIPE, 1), return
889	}	1202	if $self->{_eof};
890		1203
891	unshift @{ $self->{_queue} }, $cb;	1204	unshift @{ $self->{_queue} }, $cb;
892	last;	1205	last;
893	}	1206	}
894	} elsif ($self->{on_read}) {	1207	} elsif ($self->{on_read}) {
…		…
914	last;	1227	last;
915	}	1228	}
916	}	1229	}
917		1230
918	if ($self->{_eof}) {	1231	if ($self->{_eof}) {
919	if ($self->{on_eof}) {	1232	$self->{on_eof}
920	$self->{on_eof}($self)	1233	? $self->{on_eof}($self)
921	} else {
922	$self->_error (0, 1, "Unexpected end-of-file");	1234	: $self->_error (0, 1, "Unexpected end-of-file");
923	}	1235
		1236	return;
		1237	}
		1238
		1239	if (
		1240	defined $self->{rbuf_max}
		1241	&& $self->{rbuf_max} < length $self->{rbuf}
		1242	) {
		1243	$self->_error (Errno::ENOSPC, 1), return;
924	}	1244	}
925		1245
926	# may need to restart read watcher	1246	# may need to restart read watcher
927	unless ($self->{_rw}) {	1247	unless ($self->{_rw}) {
928	$self->start_read	1248	$self->start_read
…		…
934		1254
935	This replaces the currently set C<on_read> callback, or clears it (when	1255	This replaces the currently set C<on_read> callback, or clears it (when
936	the new callback is C<undef>). See the description of C<on_read> in the	1256	the new callback is C<undef>). See the description of C<on_read> in the
937	constructor.	1257	constructor.
938		1258
		1259	This method may invoke callbacks (and therefore the handle might be
		1260	destroyed after it returns).
		1261
939	=cut	1262	=cut
940		1263
941	sub on_read {	1264	sub on_read {
942	my ($self, $cb) = @_;	1265	my ($self, $cb) = @_;
943		1266
944	$self->{on_read} = $cb;	1267	$self->{on_read} = $cb;
945	$self->_drain_rbuf if $cb && !$self->{_in_drain};	1268	$self->_drain_rbuf if $cb;
946	}	1269	}
947		1270
948	=item $handle->rbuf	1271	=item $handle->rbuf
949		1272
950	Returns the read buffer (as a modifiable lvalue).	1273	Returns the read buffer (as a modifiable lvalue). You can also access the
		1274	read buffer directly as the C<< ->{rbuf} >> member, if you want (this is
		1275	much faster, and no less clean).
951		1276
952	You can access the read buffer directly as the C<< ->{rbuf} >>	1277	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	1278	is removing data from its beginning. Otherwise modifying or appending to
954	read buffer (apart from looking at it) is removing data from its	1279	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		1280
958	NOTE: The read buffer should only be used or modified if the C<on_read>,	1281	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	1282	callback or when C<push_read> or C<unshift_read> are used with a single
960	automatically manage the read buffer.	1283	callback (i.e. untyped). Typed C<push_read> and C<unshift_read> methods
		1284	will manage the read buffer on their own.
961		1285
962	=cut	1286	=cut
963		1287
964	sub rbuf : lvalue {	1288	sub rbuf : lvalue {
965	$_[0]{rbuf}	1289	$_[0]{rbuf}
…		…
982		1306
983	If enough data was available, then the callback must remove all data it is	1307	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	1308	interested in (which can be none at all) and return a true value. After returning
985	true, it will be removed from the queue.	1309	true, it will be removed from the queue.
986		1310
		1311	These methods may invoke callbacks (and therefore the handle might be
		1312	destroyed after it returns).
		1313
987	=cut	1314	=cut
988		1315
989	our %RH;	1316	our %RH;
990		1317
991	sub register_read_type($$) {	1318	sub register_read_type($$) {
…		…
997	my $cb = pop;	1324	my $cb = pop;
998		1325
999	if (@_) {	1326	if (@_) {
1000	my $type = shift;	1327	my $type = shift;
1001		1328
		1329	$cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type"
1002	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	1330	or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_read")
1003	->($self, $cb, @_);	1331	->($self, $cb, @_);
1004	}	1332	}
1005		1333
1006	push @{ $self->{_queue} }, $cb;	1334	push @{ $self->{_queue} }, $cb;
1007	$self->_drain_rbuf unless $self->{_in_drain};	1335	$self->_drain_rbuf;
1008	}	1336	}
1009		1337
1010	sub unshift_read {	1338	sub unshift_read {
1011	my $self = shift;	1339	my $self = shift;
1012	my $cb = pop;	1340	my $cb = pop;
1013		1341
1014	if (@_) {	1342	if (@_) {
1015	my $type = shift;	1343	my $type = shift;
1016		1344
		1345	$cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type"
1017	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")	1346	or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::unshift_read")
1018	->($self, $cb, @_);	1347	->($self, $cb, @_);
1019	}	1348	}
1020		1349
1021
1022	unshift @{ $self->{_queue} }, $cb;	1350	unshift @{ $self->{_queue} }, $cb;
1023	$self->_drain_rbuf unless $self->{_in_drain};	1351	$self->_drain_rbuf;
1024	}	1352	}
1025		1353
1026	=item $handle->push_read (type => @args, $cb)	1354	=item $handle->push_read (type => @args, $cb)
1027		1355
1028	=item $handle->unshift_read (type => @args, $cb)	1356	=item $handle->unshift_read (type => @args, $cb)
1029		1357
1030	Instead of providing a callback that parses the data itself you can chose	1358	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	1359	between a number of predefined parsing formats, for chunks of data, lines
1032	etc.	1360	etc. You can also specify the (fully qualified) name of a package, in
		1361	which case AnyEvent tries to load the package and then expects to find the
		1362	C<anyevent_read_type> function inside (see "custom read types", below).
1033		1363
1034	Predefined types are (if you have ideas for additional types, feel free to	1364	Predefined types are (if you have ideas for additional types, feel free to
1035	drop by and tell us):	1365	drop by and tell us):
1036		1366
1037	=over 4	1367	=over 4
…		…
1129	the receive buffer when neither C<$accept> nor C<$reject> match,	1459	the receive buffer when neither C<$accept> nor C<$reject> match,
1130	and everything preceding and including the match will be accepted	1460	and everything preceding and including the match will be accepted
1131	unconditionally. This is useful to skip large amounts of data that you	1461	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	1462	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	1463	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.	1464	and is usually worth it only when you expect more than a few kilobytes.
1135		1465
1136	Example: expect a http header, which ends at C<\015\012\015\012>. Since we	1466	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	1467	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	1468	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	1469	it only accepts something not ending in either \015 or \012, as these are
1140	required for the accept regex.	1470	required for the accept regex.
1141		1471
1142	$handle->push_read (regex =>	1472	$handle->push_read (regex =>
…		…
1277	=cut	1607	=cut
1278		1608
1279	register_read_type json => sub {	1609	register_read_type json => sub {
1280	my ($self, $cb) = @_;	1610	my ($self, $cb) = @_;
1281		1611
1282	my $json = $self->{json} ||=	1612	my $json = $self->{json} ||= json_coder;
1283	eval { require JSON::XS; JSON::XS->new->utf8 }
1284	|| do { require JSON; JSON->new->utf8 };
1285		1613
1286	my $data;	1614	my $data;
1287	my $rbuf = \$self->{rbuf};	1615	my $rbuf = \$self->{rbuf};
1288		1616
1289	sub {	1617	sub {
…		…
1358	}	1686	}
1359	};	1687	};
1360		1688
1361	=back	1689	=back
1362		1690
1363	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)	1691	=item custom read types - Package::anyevent_read_type $handle, $cb, @args
1364		1692
1365	This function (not method) lets you add your own types to C<push_read>.	1693	Instead of one of the predefined types, you can also specify the name
		1694	of a package. AnyEvent will try to load the package and then expects to
		1695	find a function named C<anyevent_read_type> inside. If it isn't found, it
		1696	progressively tries to load the parent package until it either finds the
		1697	function (good) or runs out of packages (bad).
1366		1698
1367	Whenever the given C<type> is used, C<push_read> will invoke the code	1699	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	1700	handle object, the original callback and the remaining arguments.
1369	arguments.
1370		1701
1371	The code reference is supposed to return a callback (usually a closure)	1702	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) >>).	1703	works as a plain read callback (see C<< ->push_read ($cb) >>), so you can
		1704	mentally treat the function as a "configurable read type to read callback"
		1705	converter.
1373		1706
1374	It should invoke the passed callback when it is done reading (remember to	1707	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).	1708	to pass C<$handle> as first argument as all other callbacks do that,
		1709	although there is no strict requirement on this).
1376		1710
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>,	1711	For examples, see the source of this module (F<perldoc -m
1381	search for C<register_read_type>)).	1712	AnyEvent::Handle>, search for C<register_read_type>)).
1382		1713
1383	=item $handle->stop_read	1714	=item $handle->stop_read
1384		1715
1385	=item $handle->start_read	1716	=item $handle->start_read
1386		1717
…		…
1406	}	1737	}
1407		1738
1408	sub start_read {	1739	sub start_read {
1409	my ($self) = @_;	1740	my ($self) = @_;
1410		1741
1411	unless ($self->{_rw} || $self->{_eof}) {	1742	unless ($self->{_rw} || $self->{_eof} || !$self->{fh}) {
1412	Scalar::Util::weaken $self;	1743	Scalar::Util::weaken $self;
1413		1744
1414	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1745	$self->{_rw} = AE::io $self->{fh}, 0, sub {
1415	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});	1746	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1416	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf;	1747	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf;
1417		1748
1418	if ($len > 0) {	1749	if ($len > 0) {
1419	$self->{_activity} = AnyEvent->now;	1750	$self->{_activity} = $self->{_ractivity} = AE::now;
1420		1751
1421	if ($self->{tls}) {	1752	if ($self->{tls}) {
1422	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);	1753	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1423		1754
1424	&_dotls ($self);	1755	&_dotls ($self);
1425	} else {	1756	} else {
1426	$self->_drain_rbuf unless $self->{_in_drain};	1757	$self->_drain_rbuf;
1427	}	1758	}
1428		1759
1429	} elsif (defined $len) {	1760	} elsif (defined $len) {
1430	delete $self->{_rw};	1761	delete $self->{_rw};
1431	$self->{_eof} = 1;	1762	$self->{_eof} = 1;
1432	$self->_drain_rbuf unless $self->{_in_drain};	1763	$self->_drain_rbuf;
1433		1764
1434	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1765	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1435	return $self->_error ($!, 1);	1766	return $self->_error ($!, 1);
1436	}	1767	}
1437	});	1768	};
1438	}	1769	}
1439	}	1770	}
1440		1771
1441	our $ERROR_SYSCALL;	1772	our $ERROR_SYSCALL;
1442	our $ERROR_WANT_READ;	1773	our $ERROR_WANT_READ;
…		…
1497	$self->{_eof} = 1;	1828	$self->{_eof} = 1;
1498	}	1829	}
1499	}	1830	}
1500		1831
1501	$self->{_tls_rbuf} .= $tmp;	1832	$self->{_tls_rbuf} .= $tmp;
1502	$self->_drain_rbuf unless $self->{_in_drain};	1833	$self->_drain_rbuf;
1503	$self->{tls} or return; # tls session might have gone away in callback	1834	$self->{tls} or return; # tls session might have gone away in callback
1504	}	1835	}
1505		1836
1506	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);	1837	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1507	return $self->_tls_error ($tmp)	1838	return $self->_tls_error ($tmp)
…		…
1509	&& ($tmp != $ERROR_SYSCALL || $!);	1840	&& ($tmp != $ERROR_SYSCALL || $!);
1510		1841
1511	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1842	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1512	$self->{wbuf} .= $tmp;	1843	$self->{wbuf} .= $tmp;
1513	$self->_drain_wbuf;	1844	$self->_drain_wbuf;
		1845	$self->{tls} or return; # tls session might have gone away in callback
1514	}	1846	}
1515		1847
1516	$self->{_on_starttls}	1848	$self->{_on_starttls}
1517	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()	1849	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
1518	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");	1850	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");
…		…
1521	=item $handle->starttls ($tls[, $tls_ctx])	1853	=item $handle->starttls ($tls[, $tls_ctx])
1522		1854
1523	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	1855	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	1856	object is created, you can also do that at a later time by calling
1525	C<starttls>.	1857	C<starttls>.
		1858
		1859	Starting TLS is currently an asynchronous operation - when you push some
		1860	write data and then call C<< ->starttls >> then TLS negotiation will start
		1861	immediately, after which the queued write data is then sent.
1526		1862
1527	The first argument is the same as the C<tls> constructor argument (either	1863	The first argument is the same as the C<tls> constructor argument (either
1528	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1864	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1529		1865
1530	The second argument is the optional C<AnyEvent::TLS> object that is used	1866	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	1871	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	1872	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	1873	changed to your liking. Note that the handshake might have already started
1538	when this function returns.	1874	when this function returns.
1539		1875
1540	If it an error to start a TLS handshake more than once per	1876	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).	1877	handshakes on the same stream. It is best to not attempt to use the
		1878	stream after stopping TLS.
		1879
		1880	This method may invoke callbacks (and therefore the handle might be
		1881	destroyed after it returns).
1542		1882
1543	=cut	1883	=cut
1544		1884
1545	our %TLS_CACHE; #TODO not yet documented, should we?	1885	our %TLS_CACHE; #TODO not yet documented, should we?
1546		1886
1547	sub starttls {	1887	sub starttls {
1548	my ($self, $ssl, $ctx) = @_;	1888	my ($self, $tls, $ctx) = @_;
		1889
		1890	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"
		1891	if $self->{tls};
		1892
		1893	$self->{tls} = $tls;
		1894	$self->{tls_ctx} = $ctx if @_ > 2;
		1895
		1896	return unless $self->{fh};
1549		1897
1550	require Net::SSLeay;	1898	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		1899
1555	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();	1900	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1556	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();	1901	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1557		1902
		1903	$tls = delete $self->{tls};
1558	$ctx ||= $self->{tls_ctx};	1904	$ctx = $self->{tls_ctx};
		1905
		1906	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
1559		1907
1560	if ("HASH" eq ref $ctx) {	1908	if ("HASH" eq ref $ctx) {
1561	require AnyEvent::TLS;	1909	require AnyEvent::TLS;
1562
1563	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context
1564		1910
1565	if ($ctx->{cache}) {	1911	if ($ctx->{cache}) {
1566	my $key = $ctx+0;	1912	my $key = $ctx+0;
1567	$ctx = $TLS_CACHE{$key} ||= new AnyEvent::TLS %$ctx;	1913	$ctx = $TLS_CACHE{$key} ||= new AnyEvent::TLS %$ctx;
1568	} else {	1914	} else {
1569	$ctx = new AnyEvent::TLS %$ctx;	1915	$ctx = new AnyEvent::TLS %$ctx;
1570	}	1916	}
1571	}	1917	}
1572		1918
1573	$self->{tls_ctx} = $ctx || TLS_CTX ();	1919	$self->{tls_ctx} = $ctx || TLS_CTX ();
1574	$self->{tls} = $ssl = $self->{tls_ctx}->_get_session ($ssl, $self, $self->{peername});	1920	$self->{tls} = $tls = $self->{tls_ctx}->_get_session ($tls, $self, $self->{peername});
1575		1921
1576	# basically, this is deep magic (because SSL_read should have the same issues)	1922	# 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".	1923	# but the openssl maintainers basically said: "trust us, it just works".
1578	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1924	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1579	# and mismaintained ssleay-module doesn't even offer them).	1925	# 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	1932	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
1587	# have identity issues in that area.	1933	# have identity issues in that area.
1588	# Net::SSLeay::CTX_set_mode ($ssl,	1934	# Net::SSLeay::CTX_set_mode ($ssl,
1589	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)	1935	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)
1590	# | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));	1936	# | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));
1591	Net::SSLeay::CTX_set_mode ($ssl, 1|2);	1937	Net::SSLeay::CTX_set_mode ($tls, 1|2);
1592		1938
1593	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1939	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1594	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1940	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1595		1941
		1942	Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf});
		1943
1596	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1944	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
1597		1945
1598	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }	1946	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1599	if $self->{on_starttls};	1947	if $self->{on_starttls};
1600		1948
1601	&_dotls; # need to trigger the initial handshake	1949	&_dotls; # need to trigger the initial handshake
…		…
1604		1952
1605	=item $handle->stoptls	1953	=item $handle->stoptls
1606		1954
1607	Shuts down the SSL connection - this makes a proper EOF handshake by	1955	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	1956	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	1957	support non-blocking shut downs, it is not guaranteed that you can re-use
1610	afterwards.	1958	the stream afterwards.
		1959
		1960	This method may invoke callbacks (and therefore the handle might be
		1961	destroyed after it returns).
1611		1962
1612	=cut	1963	=cut
1613		1964
1614	sub stoptls {	1965	sub stoptls {
1615	my ($self) = @_;	1966	my ($self) = @_;
1616		1967
1617	if ($self->{tls}) {	1968	if ($self->{tls} && $self->{fh}) {
1618	Net::SSLeay::shutdown ($self->{tls});	1969	Net::SSLeay::shutdown ($self->{tls});
1619		1970
1620	&_dotls;	1971	&_dotls;
1621		1972
1622	# # we don't give a shit. no, we do, but we can't. no...#d#	1973	# # we don't give a shit. no, we do, but we can't. no...#d#
…		…
1628	sub _freetls {	1979	sub _freetls {
1629	my ($self) = @_;	1980	my ($self) = @_;
1630		1981
1631	return unless $self->{tls};	1982	return unless $self->{tls};
1632		1983
1633	$self->{tls_ctx}->_put_session (delete $self->{tls});	1984	$self->{tls_ctx}->_put_session (delete $self->{tls})
		1985	if $self->{tls} > 0;
1634		1986
1635	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};	1987	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1636	}	1988	}
1637		1989
1638	sub DESTROY {	1990	sub DESTROY {
…		…
1640		1992
1641	&_freetls;	1993	&_freetls;
1642		1994
1643	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	1995	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1644		1996
1645	if ($linger && length $self->{wbuf}) {	1997	if ($linger && length $self->{wbuf} && $self->{fh}) {
1646	my $fh = delete $self->{fh};	1998	my $fh = delete $self->{fh};
1647	my $wbuf = delete $self->{wbuf};	1999	my $wbuf = delete $self->{wbuf};
1648		2000
1649	my @linger;	2001	my @linger;
1650		2002
1651	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {	2003	push @linger, AE::io $fh, 1, sub {
1652	my $len = syswrite $fh, $wbuf, length $wbuf;	2004	my $len = syswrite $fh, $wbuf, length $wbuf;
1653		2005
1654	if ($len > 0) {	2006	if ($len > 0) {
1655	substr $wbuf, 0, $len, "";	2007	substr $wbuf, 0, $len, "";
1656	} else {	2008	} else {
1657	@linger = (); # end	2009	@linger = (); # end
1658	}	2010	}
1659	});	2011	};
1660	push @linger, AnyEvent->timer (after => $linger, cb => sub {	2012	push @linger, AE::timer $linger, 0, sub {
1661	@linger = ();	2013	@linger = ();
1662	});	2014	};
1663	}	2015	}
1664	}	2016	}
1665		2017
1666	=item $handle->destroy	2018	=item $handle->destroy
1667		2019
1668	Shuts down the handle object as much as possible - this call ensures that	2020	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	2021	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.	2022	will be freed. Any method you will call on the handle object after
		2023	destroying it in this way will be silently ignored (and it will return the
		2024	empty list).
1671		2025
1672	Normally, you can just "forget" any references to an AnyEvent::Handle	2026	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	2027	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	2028	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	2029	callback, so when you want to destroy the AnyEvent::Handle object from
…		…
1689	sub destroy {	2043	sub destroy {
1690	my ($self) = @_;	2044	my ($self) = @_;
1691		2045
1692	$self->DESTROY;	2046	$self->DESTROY;
1693	%$self = ();	2047	%$self = ();
		2048	bless $self, "AnyEvent::Handle::destroyed";
1694	}	2049	}
		2050
		2051	sub AnyEvent::Handle::destroyed::AUTOLOAD {
		2052	#nop
		2053	}
		2054
		2055	=item $handle->destroyed
		2056
		2057	Returns false as long as the handle hasn't been destroyed by a call to C<<
		2058	->destroy >>, true otherwise.
		2059
		2060	Can be useful to decide whether the handle is still valid after some
		2061	callback possibly destroyed the handle. For example, C<< ->push_write >>,
		2062	C<< ->starttls >> and other methods can call user callbacks, which in turn
		2063	can destroy the handle, so work can be avoided by checking sometimes:
		2064
		2065	$hdl->starttls ("accept");
		2066	return if $hdl->destroyed;
		2067	$hdl->push_write (...
		2068
		2069	Note that the call to C<push_write> will silently be ignored if the handle
		2070	has been destroyed, so often you can just ignore the possibility of the
		2071	handle being destroyed.
		2072
		2073	=cut
		2074
		2075	sub destroyed { 0 }
		2076	sub AnyEvent::Handle::destroyed::destroyed { 1 }
1695		2077
1696	=item AnyEvent::Handle::TLS_CTX	2078	=item AnyEvent::Handle::TLS_CTX
1697		2079
1698	This function creates and returns the AnyEvent::TLS object used by default	2080	This function creates and returns the AnyEvent::TLS object used by default
1699	for TLS mode.	2081	for TLS mode.
…		…
1731		2113
1732	=item I get different callback invocations in TLS mode/Why can't I pause	2114	=item I get different callback invocations in TLS mode/Why can't I pause
1733	reading?	2115	reading?
1734		2116
1735	Unlike, say, TCP, TLS connections do not consist of two independent	2117	Unlike, say, TCP, TLS connections do not consist of two independent
1736	communication channels, one for each direction. Or put differently. The	2118	communication channels, one for each direction. Or put differently, the
1737	read and write directions are not independent of each other: you cannot	2119	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.	2120	write data unless you are also prepared to read, and vice versa.
1739		2121
1740	This can mean than, in TLS mode, you might get C<on_error> or C<on_eof>	2122	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	2123	callback invocations when you are not expecting any read data - the reason
1742	is that AnyEvent::Handle always reads in TLS mode.	2124	is that AnyEvent::Handle always reads in TLS mode.
1743		2125
1744	During the connection, you have to make sure that you always have a	2126	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	2127	non-empty read-queue, or an C<on_read> watcher. At the end of the
…		…
1759	my $data = delete $_[0]{rbuf};	2141	my $data = delete $_[0]{rbuf};
1760	});	2142	});
1761		2143
1762	The reason to use C<on_error> is that TCP connections, due to latencies	2144	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	2145	and packets loss, might get closed quite violently with an error, when in
1764	fact, all data has been received.	2146	fact all data has been received.
1765		2147
1766	It is usually better to use acknowledgements when transferring data,	2148	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	2149	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	2150	intact. This is also one reason why so many internet protocols have an
1769	explicit QUIT command.	2151	explicit QUIT command.
…		…
1786	consider using C<< ->push_shutdown >> instead.	2168	consider using C<< ->push_shutdown >> instead.
1787		2169
1788	=item I want to contact a TLS/SSL server, I don't care about security.	2170	=item I want to contact a TLS/SSL server, I don't care about security.
1789		2171
1790	If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS,	2172	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>	2173	connect to it and then create the AnyEvent::Handle with the C<tls>
1792	parameter:	2174	parameter:
1793		2175
1794	tcp_connect $host, $port, sub {	2176	tcp_connect $host, $port, sub {
1795	my ($fh) = @_;	2177	my ($fh) = @_;
1796		2178
…		…
1896		2278
1897	=item * all members not documented here and not prefixed with an underscore	2279	=item * all members not documented here and not prefixed with an underscore
1898	are free to use in subclasses.	2280	are free to use in subclasses.
1899		2281
1900	Of course, new versions of AnyEvent::Handle may introduce more "public"	2282	Of course, new versions of AnyEvent::Handle may introduce more "public"
1901	member variables, but thats just life, at least it is documented.	2283	member variables, but that's just life. At least it is documented.
1902		2284
1903	=back	2285	=back
1904		2286
1905	=head1 AUTHOR	2287	=head1 AUTHOR
1906		2288

Diff Legend

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