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.144 by root, Mon Jul 6 21:38:25 2009 UTC vs.
Revision 1.199 by root, Mon Oct 11 03:41:39 2010 UTC

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

Diff Legend

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