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.68 by root, Fri Jun 6 15:35:30 2008 UTC vs.
Revision 1.236 by root, Sat May 12 23:14:29 2012 UTC

1	package AnyEvent::Handle;
2
3	no warnings;
4	use strict;
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.151;
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 {
32	$cv->broadcast;	15	my ($hdl, $fatal, $msg) = @_;
33	},	16	AE::log error => $msg;
		17	$hdl->destroy;
		18	$cv->send;
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	say "got line <$line>";
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
		38	The L<AnyEvent::Intro> tutorial contains some well-documented
		39	AnyEvent::Handle examples.
		40
54	In the following, when the documentation refers to of "bytes" then this	41	In the following, where the documentation refers to "bytes", it means
55	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
56	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.
57		47
58	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
59	argument.	49	argument.
60		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
		80	sub MAX_READ_SIZE() { 131072 }
		81
61	=head1 METHODS	82	=head1 METHODS
62		83
63	=over 4	84	=over 4
64		85
65	=item B<new (%args)>	86	=item $handle = B<new> AnyEvent::Handle fh => $filehandle, key => value...
66		87
67	The constructor supports these arguments (all as key => value pairs).	88	The constructor supports these arguments (all as C<< key => value >> pairs).
68		89
69	=over 4	90	=over 4
70		91
71	=item fh => $filehandle [MANDATORY]	92	=item fh => $filehandle [C<fh> or C<connect> MANDATORY]
72		93
73	The filehandle this L<AnyEvent::Handle> object will operate on.	94	The filehandle this L<AnyEvent::Handle> object will operate on.
74
75	NOTE: The filehandle will be set to non-blocking (using	95	NOTE: The filehandle will be set to non-blocking mode (using
76	AnyEvent::Util::fh_nonblocking).	96	C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in
		97	that mode.
77		98
		99	=item connect => [$host, $service] [C<fh> or C<connect> MANDATORY]
		100
		101	Try to connect to the specified host and service (port), using
		102	C<AnyEvent::Socket::tcp_connect>. The C<$host> additionally becomes the
		103	default C<peername>.
		104
		105	You have to specify either this parameter, or C<fh>, above.
		106
		107	It is possible to push requests on the read and write queues, and modify
		108	properties of the stream, even while AnyEvent::Handle is connecting.
		109
		110	When this parameter is specified, then the C<on_prepare>,
		111	C<on_connect_error> and C<on_connect> callbacks will be called under the
		112	appropriate circumstances:
		113
		114	=over 4
		115
78	=item on_eof => $cb->($handle)	116	=item on_prepare => $cb->($handle)
79		117
80	Set the callback to be called when an end-of-file condition is detcted,	118	This (rarely used) callback is called before a new connection is
81	i.e. in the case of a socket, when the other side has closed the	119	attempted, but after the file handle has been created (you can access that
82	connection cleanly.	120	file handle via C<< $handle->{fh} >>). It could be used to prepare the
		121	file handle with parameters required for the actual connect (as opposed to
		122	settings that can be changed when the connection is already established).
83		123
84	While not mandatory, it is highly recommended to set an eof callback,	124	The return value of this callback should be the connect timeout value in
85	otherwise you might end up with a closed socket while you are still	125	seconds (or C<0>, or C<undef>, or the empty list, to indicate that the
86	waiting for data.	126	default timeout is to be used).
87		127
		128	=item on_connect => $cb->($handle, $host, $port, $retry->())
		129
		130	This callback is called when a connection has been successfully established.
		131
		132	The peer's numeric host and port (the socket peername) are passed as
		133	parameters, together with a retry callback. At the time it is called the
		134	read and write queues, EOF status, TLS status and similar properties of
		135	the handle will have been reset.
		136
		137	It is not allowed to use the read or write queues while the handle object
		138	is connecting.
		139
		140	If, for some reason, the handle is not acceptable, calling C<$retry> will
		141	continue with the next connection target (in case of multi-homed hosts or
		142	SRV records there can be multiple connection endpoints). The C<$retry>
		143	callback can be invoked after the connect callback returns, i.e. one can
		144	start a handshake and then decide to retry with the next host if the
		145	handshake fails.
		146
		147	In most cases, you should ignore the C<$retry> parameter.
		148
		149	=item on_connect_error => $cb->($handle, $message)
		150
		151	This callback is called when the connection could not be
		152	established. C<$!> will contain the relevant error code, and C<$message> a
		153	message describing it (usually the same as C<"$!">).
		154
		155	If this callback isn't specified, then C<on_error> will be called with a
		156	fatal error instead.
		157
		158	=back
		159
88	=item on_error => $cb->($handle, $fatal)	160	=item on_error => $cb->($handle, $fatal, $message)
89		161
90	This is the error callback, which is called when, well, some error	162	This is the error callback, which is called when, well, some error
91	occured, such as not being able to resolve the hostname, failure to	163	occured, such as not being able to resolve the hostname, failure to
92	connect or a read error.	164	connect, or a read error.
93		165
94	Some errors are fatal (which is indicated by C<$fatal> being true). On	166	Some errors are fatal (which is indicated by C<$fatal> being true). On
95	fatal errors the handle object will be shut down and will not be	167	fatal errors the handle object will be destroyed (by a call to C<< ->
		168	destroy >>) after invoking the error callback (which means you are free to
		169	examine the handle object). Examples of fatal errors are an EOF condition
		170	with active (but unsatisfiable) read watchers (C<EPIPE>) or I/O errors. In
		171	cases where the other side can close the connection at will, it is
		172	often easiest to not report C<EPIPE> errors in this callback.
		173
		174	AnyEvent::Handle tries to find an appropriate error code for you to check
		175	against, but in some cases (TLS errors), this does not work well.
		176
		177	If you report the error to the user, it is recommended to always output
		178	the C<$message> argument in human-readable error messages (you don't need
		179	to report C<"$!"> if you report C<$message>).
		180
		181	If you want to react programmatically to the error, then looking at C<$!>
		182	and comparing it against some of the documented C<Errno> values is usually
		183	better than looking at the C<$message>.
		184
96	usable. Non-fatal errors can be retried by simply returning, but it is	185	Non-fatal errors can be retried by returning, but it is recommended
97	recommended to simply ignore this parameter and instead abondon the handle	186	to simply ignore this parameter and instead abondon the handle object
98	object when this callback is invoked.	187	when this callback is invoked. Examples of non-fatal errors are timeouts
		188	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
99		189
100	On callback entrance, the value of C<$!> contains the operating system	190	On entry to the callback, the value of C<$!> contains the operating
101	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).	191	system error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
		192	C<EPROTO>).
102		193
103	While not mandatory, it is I<highly> recommended to set this callback, as	194	While not mandatory, it is I<highly> recommended to set this callback, as
104	you will not be notified of errors otherwise. The default simply calls	195	you will not be notified of errors otherwise. The default just calls
105	C<croak>.	196	C<croak>.
106		197
107	=item on_read => $cb->($handle)	198	=item on_read => $cb->($handle)
108		199
109	This sets the default read callback, which is called when data arrives	200	This sets the default read callback, which is called when data arrives
110	and no read request is in the queue (unlike read queue callbacks, this	201	and no read request is in the queue (unlike read queue callbacks, this
111	callback will only be called when at least one octet of data is in the	202	callback will only be called when at least one octet of data is in the
112	read buffer).	203	read buffer).
113		204
114	To access (and remove data from) the read buffer, use the C<< ->rbuf >>	205	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
115	method or access the C<$handle->{rbuf}> member directly.	206	method or access the C<< $handle->{rbuf} >> member directly. Note that you
		207	must not enlarge or modify the read buffer, you can only remove data at
		208	the beginning from it.
116		209
		210	You can also call C<< ->push_read (...) >> or any other function that
		211	modifies the read queue. Or do both. Or ...
		212
117	When an EOF condition is detected then AnyEvent::Handle will first try to	213	When an EOF condition is detected, AnyEvent::Handle will first try to
118	feed all the remaining data to the queued callbacks and C<on_read> before	214	feed all the remaining data to the queued callbacks and C<on_read> before
119	calling the C<on_eof> callback. If no progress can be made, then a fatal	215	calling the C<on_eof> callback. If no progress can be made, then a fatal
120	error will be raised (with C<$!> set to C<EPIPE>).	216	error will be raised (with C<$!> set to C<EPIPE>).
121		217
		218	Note that, unlike requests in the read queue, an C<on_read> callback
		219	doesn't mean you I<require> some data: if there is an EOF and there
		220	are outstanding read requests then an error will be flagged. With an
		221	C<on_read> callback, the C<on_eof> callback will be invoked.
		222
		223	=item on_eof => $cb->($handle)
		224
		225	Set the callback to be called when an end-of-file condition is detected,
		226	i.e. in the case of a socket, when the other side has closed the
		227	connection cleanly, and there are no outstanding read requests in the
		228	queue (if there are read requests, then an EOF counts as an unexpected
		229	connection close and will be flagged as an error).
		230
		231	For sockets, this just means that the other side has stopped sending data,
		232	you can still try to write data, and, in fact, one can return from the EOF
		233	callback and continue writing data, as only the read part has been shut
		234	down.
		235
		236	If an EOF condition has been detected but no C<on_eof> callback has been
		237	set, then a fatal error will be raised with C<$!> set to <0>.
		238
122	=item on_drain => $cb->($handle)	239	=item on_drain => $cb->($handle)
123		240
124	This sets the callback that is called when the write buffer becomes empty	241	This sets the callback that is called once when the write buffer becomes
125	(or when the callback is set and the buffer is empty already).	242	empty (and immediately when the handle object is created).
126		243
127	To append to the write buffer, use the C<< ->push_write >> method.	244	To append to the write buffer, use the C<< ->push_write >> method.
128		245
		246	This callback is useful when you don't want to put all of your write data
		247	into the queue at once, for example, when you want to write the contents
		248	of some file to the socket you might not want to read the whole file into
		249	memory and push it into the queue, but instead only read more data from
		250	the file when the write queue becomes empty.
		251
129	=item timeout => $fractional_seconds	252	=item timeout => $fractional_seconds
130		253
		254	=item rtimeout => $fractional_seconds
		255
		256	=item wtimeout => $fractional_seconds
		257
131	If non-zero, then this enables an "inactivity" timeout: whenever this many	258	If non-zero, then these enables an "inactivity" timeout: whenever this
132	seconds pass without a successful read or write on the underlying file	259	many seconds pass without a successful read or write on the underlying
133	handle, the C<on_timeout> callback will be invoked (and if that one is	260	file handle (or a call to C<timeout_reset>), the C<on_timeout> callback
134	missing, an C<ETIMEDOUT> error will be raised).	261	will be invoked (and if that one is missing, a non-fatal C<ETIMEDOUT>
		262	error will be raised).
135		263
		264	There are three variants of the timeouts that work independently of each
		265	other, for both read and write (triggered when nothing was read I<OR>
		266	written), just read (triggered when nothing was read), and just write:
		267	C<timeout>, C<rtimeout> and C<wtimeout>, with corresponding callbacks
		268	C<on_timeout>, C<on_rtimeout> and C<on_wtimeout>, and reset functions
		269	C<timeout_reset>, C<rtimeout_reset>, and C<wtimeout_reset>.
		270
136	Note that timeout processing is also active when you currently do not have	271	Note that timeout processing is active even when you do not have any
137	any outstanding read or write requests: If you plan to keep the connection	272	outstanding read or write requests: If you plan to keep the connection
138	idle then you should disable the timout temporarily or ignore the timeout	273	idle then you should disable the timeout temporarily or ignore the
139	in the C<on_timeout> callback.	274	timeout in the corresponding C<on_timeout> callback, in which case
		275	AnyEvent::Handle will simply restart the timeout.
140		276
141	Zero (the default) disables this timeout.	277	Zero (the default) disables the corresponding timeout.
142		278
143	=item on_timeout => $cb->($handle)	279	=item on_timeout => $cb->($handle)
		280
		281	=item on_rtimeout => $cb->($handle)
		282
		283	=item on_wtimeout => $cb->($handle)
144		284
145	Called whenever the inactivity timeout passes. If you return from this	285	Called whenever the inactivity timeout passes. If you return from this
146	callback, then the timeout will be reset as if some activity had happened,	286	callback, then the timeout will be reset as if some activity had happened,
147	so this condition is not fatal in any way.	287	so this condition is not fatal in any way.
148		288
149	=item rbuf_max => <bytes>	289	=item rbuf_max => <bytes>
150		290
151	If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)	291	If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)
152	when the read buffer ever (strictly) exceeds this size. This is useful to	292	when the read buffer ever (strictly) exceeds this size. This is useful to
153	avoid denial-of-service attacks.	293	avoid some forms of denial-of-service attacks.
154		294
155	For example, a server accepting connections from untrusted sources should	295	For example, a server accepting connections from untrusted sources should
156	be configured to accept only so-and-so much data that it cannot act on	296	be configured to accept only so-and-so much data that it cannot act on
157	(for example, when expecting a line, an attacker could send an unlimited	297	(for example, when expecting a line, an attacker could send an unlimited
158	amount of data without a callback ever being called as long as the line	298	amount of data without a callback ever being called as long as the line
159	isn't finished).	299	isn't finished).
160		300
		301	=item wbuf_max => <bytes>
		302
		303	If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)
		304	when the write buffer ever (strictly) exceeds this size. This is useful to
		305	avoid some forms of denial-of-service attacks.
		306
		307	Although the units of this parameter is bytes, this is the I<raw> number
		308	of bytes not yet accepted by the kernel. This can make a difference when
		309	you e.g. use TLS, as TLS typically makes your write data larger (but it
		310	can also make it smaller due to compression).
		311
		312	As an example of when this limit is useful, take a chat server that sends
		313	chat messages to a client. If the client does not read those in a timely
		314	manner then the send buffer in the server would grow unbounded.
		315
		316	=item autocork => <boolean>
		317
		318	When disabled (the default), C<push_write> will try to immediately
		319	write the data to the handle if possible. This avoids having to register
		320	a write watcher and wait for the next event loop iteration, but can
		321	be inefficient if you write multiple small chunks (on the wire, this
		322	disadvantage is usually avoided by your kernel's nagle algorithm, see
		323	C<no_delay>, but this option can save costly syscalls).
		324
		325	When enabled, writes will always be queued till the next event loop
		326	iteration. This is efficient when you do many small writes per iteration,
		327	but less efficient when you do a single write only per iteration (or when
		328	the write buffer often is full). It also increases write latency.
		329
		330	=item no_delay => <boolean>
		331
		332	When doing small writes on sockets, your operating system kernel might
		333	wait a bit for more data before actually sending it out. This is called
		334	the Nagle algorithm, and usually it is beneficial.
		335
		336	In some situations you want as low a delay as possible, which can be
		337	accomplishd by setting this option to a true value.
		338
		339	The default is your operating system's default behaviour (most likely
		340	enabled). This option explicitly enables or disables it, if possible.
		341
		342	=item keepalive => <boolean>
		343
		344	Enables (default disable) the SO_KEEPALIVE option on the stream socket:
		345	normally, TCP connections have no time-out once established, so TCP
		346	connections, once established, can stay alive forever even when the other
		347	side has long gone. TCP keepalives are a cheap way to take down long-lived
		348	TCP connections when the other side becomes unreachable. While the default
		349	is OS-dependent, TCP keepalives usually kick in after around two hours,
		350	and, if the other side doesn't reply, take down the TCP connection some 10
		351	to 15 minutes later.
		352
		353	It is harmless to specify this option for file handles that do not support
		354	keepalives, and enabling it on connections that are potentially long-lived
		355	is usually a good idea.
		356
		357	=item oobinline => <boolean>
		358
		359	BSD majorly fucked up the implementation of TCP urgent data. The result
		360	is that almost no OS implements TCP according to the specs, and every OS
		361	implements it slightly differently.
		362
		363	If you want to handle TCP urgent data, then setting this flag (the default
		364	is enabled) gives you the most portable way of getting urgent data, by
		365	putting it into the stream.
		366
		367	Since BSD emulation of OOB data on top of TCP's urgent data can have
		368	security implications, AnyEvent::Handle sets this flag automatically
		369	unless explicitly specified. Note that setting this flag after
		370	establishing a connection I<may> be a bit too late (data loss could
		371	already have occured on BSD systems), but at least it will protect you
		372	from most attacks.
		373
161	=item read_size => <bytes>	374	=item read_size => <bytes>
162		375
163	The default read block size (the amount of bytes this module will try to read	376	The initial read block size, the number of bytes this module will try
164	during each (loop iteration). Default: C<8192>.	377	to read during each loop iteration. Each handle object will consume
		378	at least this amount of memory for the read buffer as well, so when
		379	handling many connections watch out for memory requirements). See also
		380	C<max_read_size>. Default: C<2048>.
		381
		382	=item max_read_size => <bytes>
		383
		384	The maximum read buffer size used by the dynamic adjustment
		385	algorithm: Each time AnyEvent::Handle can read C<read_size> bytes in
		386	one go it will double C<read_size> up to the maximum given by this
		387	option. Default: C<131072> or C<read_size>, whichever is higher.
165		388
166	=item low_water_mark => <bytes>	389	=item low_water_mark => <bytes>
167		390
168	Sets the amount of bytes (default: C<0>) that make up an "empty" write	391	Sets the number of bytes (default: C<0>) that make up an "empty" write
169	buffer: If the write reaches this size or gets even samller it is	392	buffer: If the buffer reaches this size or gets even samller it is
170	considered empty.	393	considered empty.
171		394
		395	Sometimes it can be beneficial (for performance reasons) to add data to
		396	the write buffer before it is fully drained, but this is a rare case, as
		397	the operating system kernel usually buffers data as well, so the default
		398	is good in almost all cases.
		399
172	=item linger => <seconds>	400	=item linger => <seconds>
173		401
174	If non-zero (default: C<3600>), then the destructor of the	402	If this is non-zero (default: C<3600>), the destructor of the
175	AnyEvent::Handle object will check wether there is still outstanding write	403	AnyEvent::Handle object will check whether there is still outstanding
176	data and will install a watcher that will write out this data. No errors	404	write data and will install a watcher that will write this data to the
177	will be reported (this mostly matches how the operating system treats	405	socket. No errors will be reported (this mostly matches how the operating
178	outstanding data at socket close time).	406	system treats outstanding data at socket close time).
179		407
180	This will not work for partial TLS data that could not yet been	408	This will not work for partial TLS data that could not be encoded
181	encoded. This data will be lost.	409	yet. This data will be lost. Calling the C<stoptls> method in time might
		410	help.
		411
		412	=item peername => $string
		413
		414	A string used to identify the remote site - usually the DNS hostname
		415	(I<not> IDN!) used to create the connection, rarely the IP address.
		416
		417	Apart from being useful in error messages, this string is also used in TLS
		418	peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This
		419	verification will be skipped when C<peername> is not specified or is
		420	C<undef>.
182		421
183	=item tls => "accept" | "connect" | Net::SSLeay::SSL object	422	=item tls => "accept" | "connect" | Net::SSLeay::SSL object
184		423
185	When this parameter is given, it enables TLS (SSL) mode, that means it	424	When this parameter is given, it enables TLS (SSL) mode, that means
186	will start making tls handshake and will transparently encrypt/decrypt	425	AnyEvent will start a TLS handshake as soon as the connection has been
187	data.	426	established and will transparently encrypt/decrypt data afterwards.
		427
		428	All TLS protocol errors will be signalled as C<EPROTO>, with an
		429	appropriate error message.
188		430
189	TLS mode requires Net::SSLeay to be installed (it will be loaded	431	TLS mode requires Net::SSLeay to be installed (it will be loaded
190	automatically when you try to create a TLS handle).	432	automatically when you try to create a TLS handle): this module doesn't
		433	have a dependency on that module, so if your module requires it, you have
		434	to add the dependency yourself. If Net::SSLeay cannot be loaded or is too
		435	old, you get an C<EPROTO> error.
191		436
192	For the TLS server side, use C<accept>, and for the TLS client side of a	437	Unlike TCP, TLS has a server and client side: for the TLS server side, use
193	connection, use C<connect> mode.	438	C<accept>, and for the TLS client side of a connection, use C<connect>
		439	mode.
194		440
195	You can also provide your own TLS connection object, but you have	441	You can also provide your own TLS connection object, but you have
196	to make sure that you call either C<Net::SSLeay::set_connect_state>	442	to make sure that you call either C<Net::SSLeay::set_connect_state>
197	or C<Net::SSLeay::set_accept_state> on it before you pass it to	443	or C<Net::SSLeay::set_accept_state> on it before you pass it to
198	AnyEvent::Handle.	444	AnyEvent::Handle. Also, this module will take ownership of this connection
		445	object.
199		446
		447	At some future point, AnyEvent::Handle might switch to another TLS
		448	implementation, then the option to use your own session object will go
		449	away.
		450
		451	B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,
		452	passing in the wrong integer will lead to certain crash. This most often
		453	happens when one uses a stylish C<< tls => 1 >> and is surprised about the
		454	segmentation fault.
		455
200	See the C<starttls> method if you need to start TLs negotiation later.	456	Use the C<< ->starttls >> method if you need to start TLS negotiation later.
201		457
202	=item tls_ctx => $ssl_ctx	458	=item tls_ctx => $anyevent_tls
203		459
204	Use the given Net::SSLeay::CTX object to create the new TLS connection	460	Use the given C<AnyEvent::TLS> object to create the new TLS connection
205	(unless a connection object was specified directly). If this parameter is	461	(unless a connection object was specified directly). If this
206	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	462	parameter is missing (or C<undef>), then AnyEvent::Handle will use
		463	C<AnyEvent::Handle::TLS_CTX>.
		464
		465	Instead of an object, you can also specify a hash reference with C<< key
		466	=> value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a
		467	new TLS context object.
		468
		469	=item on_starttls => $cb->($handle, $success[, $error_message])
		470
		471	This callback will be invoked when the TLS/SSL handshake has finished. If
		472	C<$success> is true, then the TLS handshake succeeded, otherwise it failed
		473	(C<on_stoptls> will not be called in this case).
		474
		475	The session in C<< $handle->{tls} >> can still be examined in this
		476	callback, even when the handshake was not successful.
		477
		478	TLS handshake failures will not cause C<on_error> to be invoked when this
		479	callback is in effect, instead, the error message will be passed to C<on_starttls>.
		480
		481	Without this callback, handshake failures lead to C<on_error> being
		482	called as usual.
		483
		484	Note that you cannot just call C<starttls> again in this callback. If you
		485	need to do that, start an zero-second timer instead whose callback can
		486	then call C<< ->starttls >> again.
		487
		488	=item on_stoptls => $cb->($handle)
		489
		490	When a SSLv3/TLS shutdown/close notify/EOF is detected and this callback is
		491	set, then it will be invoked after freeing the TLS session. If it is not,
		492	then a TLS shutdown condition will be treated like a normal EOF condition
		493	on the handle.
		494
		495	The session in C<< $handle->{tls} >> can still be examined in this
		496	callback.
		497
		498	This callback will only be called on TLS shutdowns, not when the
		499	underlying handle signals EOF.
207		500
208	=item json => JSON or JSON::XS object	501	=item json => JSON or JSON::XS object
209		502
210	This is the json coder object used by the C<json> read and write types.	503	This is the json coder object used by the C<json> read and write types.
211		504
212	If you don't supply it, then AnyEvent::Handle will create and use a	505	If you don't supply it, then AnyEvent::Handle will create and use a
213	suitable one, which will write and expect UTF-8 encoded JSON texts.	506	suitable one (on demand), which will write and expect UTF-8 encoded JSON
		507	texts.
214		508
215	Note that you are responsible to depend on the JSON module if you want to	509	Note that you are responsible to depend on the JSON module if you want to
216	use this functionality, as AnyEvent does not have a dependency itself.	510	use this functionality, as AnyEvent does not have a dependency itself.
217		511
218	=item filter_r => $cb
219
220	=item filter_w => $cb
221
222	These exist, but are undocumented at this time.
223
224	=back	512	=back
225		513
226	=cut	514	=cut
227		515
228	sub new {	516	sub new {
229	my $class = shift;	517	my $class = shift;
230
231	my $self = bless { @_ }, $class;	518	my $self = bless { @_ }, $class;
232		519
233	$self->{fh} or Carp::croak "mandatory argument fh is missing";	520	if ($self->{fh}) {
		521	$self->_start;
		522	return unless $self->{fh}; # could be gone by now
		523
		524	} elsif ($self->{connect}) {
		525	require AnyEvent::Socket;
		526
		527	$self->{peername} = $self->{connect}[0]
		528	unless exists $self->{peername};
		529
		530	$self->{_skip_drain_rbuf} = 1;
		531
		532	{
		533	Scalar::Util::weaken (my $self = $self);
		534
		535	$self->{_connect} =
		536	AnyEvent::Socket::tcp_connect (
		537	$self->{connect}[0],
		538	$self->{connect}[1],
		539	sub {
		540	my ($fh, $host, $port, $retry) = @_;
		541
		542	delete $self->{_connect}; # no longer needed
		543
		544	if ($fh) {
		545	$self->{fh} = $fh;
		546
		547	delete $self->{_skip_drain_rbuf};
		548	$self->_start;
		549
		550	$self->{on_connect}
		551	and $self->{on_connect}($self, $host, $port, sub {
		552	delete @$self{qw(fh _tw _rtw _wtw _ww _rw _eof _queue rbuf _wbuf tls _tls_rbuf _tls_wbuf)};
		553	$self->{_skip_drain_rbuf} = 1;
		554	&$retry;
		555	});
		556
		557	} else {
		558	if ($self->{on_connect_error}) {
		559	$self->{on_connect_error}($self, "$!");
		560	$self->destroy if $self;
		561	} else {
		562	$self->_error ($!, 1);
		563	}
		564	}
		565	},
		566	sub {
		567	local $self->{fh} = $_[0];
		568
		569	$self->{on_prepare}
		570	? $self->{on_prepare}->($self)
		571	: ()
		572	}
		573	);
		574	}
		575
		576	} else {
		577	Carp::croak "AnyEvent::Handle: either an existing fh or the connect parameter must be specified";
		578	}
		579
		580	$self
		581	}
		582
		583	sub _start {
		584	my ($self) = @_;
		585
		586	# too many clueless people try to use udp and similar sockets
		587	# with AnyEvent::Handle, do them a favour.
		588	my $type = getsockopt $self->{fh}, Socket::SOL_SOCKET (), Socket::SO_TYPE ();
		589	Carp::croak "AnyEvent::Handle: only stream sockets supported, anything else will NOT work!"
		590	if Socket::SOCK_STREAM () != (unpack "I", $type) && defined $type;
234		591
235	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	592	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
236		593
237	if ($self->{tls}) {	594	$self->{_activity} =
238	require Net::SSLeay;	595	$self->{_ractivity} =
		596	$self->{_wactivity} = AE::now;
		597
		598	$self->{read_size} ||= 2048;
		599	$self->{max_read_size} = $self->{read_size}
		600	if $self->{read_size} > ($self->{max_read_size} || MAX_READ_SIZE);
		601
		602	$self->timeout (delete $self->{timeout} ) if $self->{timeout};
		603	$self->rtimeout (delete $self->{rtimeout} ) if $self->{rtimeout};
		604	$self->wtimeout (delete $self->{wtimeout} ) if $self->{wtimeout};
		605
		606	$self->no_delay (delete $self->{no_delay} ) if exists $self->{no_delay} && $self->{no_delay};
		607	$self->keepalive (delete $self->{keepalive}) if exists $self->{keepalive} && $self->{keepalive};
		608
		609	$self->oobinline (exists $self->{oobinline} ? delete $self->{oobinline} : 1);
		610
239	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});	611	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
240	}	612	if $self->{tls};
241		613
242	$self->{_activity} = AnyEvent->now;
243	$self->_timeout;
244
245	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	614	$self->on_drain (delete $self->{on_drain} ) if $self->{on_drain};
246		615
247	$self->start_read	616	$self->start_read
248	if $self->{on_read};	617	if $self->{on_read} || @{ $self->{_queue} };
249		618
250	$self	619	$self->_drain_wbuf;
251	}
252
253	sub _shutdown {
254	my ($self) = @_;
255
256	delete $self->{_tw};
257	delete $self->{_rw};
258	delete $self->{_ww};
259	delete $self->{fh};
260
261	$self->stoptls;
262	}	620	}
263		621
264	sub _error {	622	sub _error {
265	my ($self, $errno, $fatal) = @_;	623	my ($self, $errno, $fatal, $message) = @_;
266
267	$self->_shutdown
268	if $fatal;
269		624
270	$! = $errno;	625	$! = $errno;
		626	$message ||= "$!";
271		627
272	if ($self->{on_error}) {	628	if ($self->{on_error}) {
273	$self->{on_error}($self, $fatal);	629	$self->{on_error}($self, $fatal, $message);
274	} else {	630	$self->destroy if $fatal;
		631	} elsif ($self->{fh} || $self->{connect}) {
		632	$self->destroy;
275	Carp::croak "AnyEvent::Handle uncaught error: $!";	633	Carp::croak "AnyEvent::Handle uncaught error: $message";
276	}	634	}
277	}	635	}
278		636
279	=item $fh = $handle->fh	637	=item $fh = $handle->fh
280		638
281	This method returns the file handle of the L<AnyEvent::Handle> object.	639	This method returns the file handle used to create the L<AnyEvent::Handle> object.
282		640
283	=cut	641	=cut
284		642
285	sub fh { $_[0]{fh} }	643	sub fh { $_[0]{fh} }
286		644
…		…
304	$_[0]{on_eof} = $_[1];	662	$_[0]{on_eof} = $_[1];
305	}	663	}
306		664
307	=item $handle->on_timeout ($cb)	665	=item $handle->on_timeout ($cb)
308		666
309	Replace the current C<on_timeout> callback, or disables the callback	667	=item $handle->on_rtimeout ($cb)
310	(but not the timeout) if C<$cb> = C<undef>. See C<timeout> constructor
311	argument.
312		668
313	=cut	669	=item $handle->on_wtimeout ($cb)
314		670
		671	Replace the current C<on_timeout>, C<on_rtimeout> or C<on_wtimeout>
		672	callback, or disables the callback (but not the timeout) if C<$cb> =
		673	C<undef>. See the C<timeout> constructor argument and method.
		674
		675	=cut
		676
		677	# see below
		678
		679	=item $handle->autocork ($boolean)
		680
		681	Enables or disables the current autocork behaviour (see C<autocork>
		682	constructor argument). Changes will only take effect on the next write.
		683
		684	=cut
		685
		686	sub autocork {
		687	$_[0]{autocork} = $_[1];
		688	}
		689
		690	=item $handle->no_delay ($boolean)
		691
		692	Enables or disables the C<no_delay> setting (see constructor argument of
		693	the same name for details).
		694
		695	=cut
		696
		697	sub no_delay {
		698	$_[0]{no_delay} = $_[1];
		699
		700	setsockopt $_[0]{fh}, Socket::IPPROTO_TCP (), Socket::TCP_NODELAY (), int $_[1]
		701	if $_[0]{fh};
		702	}
		703
		704	=item $handle->keepalive ($boolean)
		705
		706	Enables or disables the C<keepalive> setting (see constructor argument of
		707	the same name for details).
		708
		709	=cut
		710
		711	sub keepalive {
		712	$_[0]{keepalive} = $_[1];
		713
		714	eval {
		715	local $SIG{__DIE__};
		716	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
		717	if $_[0]{fh};
		718	};
		719	}
		720
		721	=item $handle->oobinline ($boolean)
		722
		723	Enables or disables the C<oobinline> setting (see constructor argument of
		724	the same name for details).
		725
		726	=cut
		727
		728	sub oobinline {
		729	$_[0]{oobinline} = $_[1];
		730
		731	eval {
		732	local $SIG{__DIE__};
		733	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_OOBINLINE (), int $_[1]
		734	if $_[0]{fh};
		735	};
		736	}
		737
		738	=item $handle->keepalive ($boolean)
		739
		740	Enables or disables the C<keepalive> setting (see constructor argument of
		741	the same name for details).
		742
		743	=cut
		744
		745	sub keepalive {
		746	$_[0]{keepalive} = $_[1];
		747
		748	eval {
		749	local $SIG{__DIE__};
		750	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
		751	if $_[0]{fh};
		752	};
		753	}
		754
		755	=item $handle->on_starttls ($cb)
		756
		757	Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument).
		758
		759	=cut
		760
		761	sub on_starttls {
		762	$_[0]{on_starttls} = $_[1];
		763	}
		764
		765	=item $handle->on_stoptls ($cb)
		766
		767	Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).
		768
		769	=cut
		770
315	sub on_timeout {	771	sub on_stoptls {
316	$_[0]{on_timeout} = $_[1];	772	$_[0]{on_stoptls} = $_[1];
		773	}
		774
		775	=item $handle->rbuf_max ($max_octets)
		776
		777	Configures the C<rbuf_max> setting (C<undef> disables it).
		778
		779	=item $handle->wbuf_max ($max_octets)
		780
		781	Configures the C<wbuf_max> setting (C<undef> disables it).
		782
		783	=cut
		784
		785	sub rbuf_max {
		786	$_[0]{rbuf_max} = $_[1];
		787	}
		788
		789	sub wbuf_max {
		790	$_[0]{wbuf_max} = $_[1];
317	}	791	}
318		792
319	#############################################################################	793	#############################################################################
320		794
321	=item $handle->timeout ($seconds)	795	=item $handle->timeout ($seconds)
322		796
		797	=item $handle->rtimeout ($seconds)
		798
		799	=item $handle->wtimeout ($seconds)
		800
323	Configures (or disables) the inactivity timeout.	801	Configures (or disables) the inactivity timeout.
324		802
325	=cut	803	The timeout will be checked instantly, so this method might destroy the
		804	handle before it returns.
326		805
327	sub timeout {	806	=item $handle->timeout_reset
		807
		808	=item $handle->rtimeout_reset
		809
		810	=item $handle->wtimeout_reset
		811
		812	Reset the activity timeout, as if data was received or sent.
		813
		814	These methods are cheap to call.
		815
		816	=cut
		817
		818	for my $dir ("", "r", "w") {
		819	my $timeout = "${dir}timeout";
		820	my $tw = "_${dir}tw";
		821	my $on_timeout = "on_${dir}timeout";
		822	my $activity = "_${dir}activity";
		823	my $cb;
		824
		825	*$on_timeout = sub {
		826	$_[0]{$on_timeout} = $_[1];
		827	};
		828
		829	*$timeout = sub {
328	my ($self, $timeout) = @_;	830	my ($self, $new_value) = @_;
329		831
		832	$new_value >= 0
		833	or Carp::croak "AnyEvent::Handle->$timeout called with negative timeout ($new_value), caught";
		834
330	$self->{timeout} = $timeout;	835	$self->{$timeout} = $new_value;
331	$self->_timeout;	836	delete $self->{$tw}; &$cb;
332	}	837	};
333		838
		839	*{"${dir}timeout_reset"} = sub {
		840	$_[0]{$activity} = AE::now;
		841	};
		842
		843	# main workhorse:
334	# reset the timeout watcher, as neccessary	844	# reset the timeout watcher, as neccessary
335	# also check for time-outs	845	# also check for time-outs
336	sub _timeout {	846	$cb = sub {
337	my ($self) = @_;	847	my ($self) = @_;
338		848
339	if ($self->{timeout}) {	849	if ($self->{$timeout} && $self->{fh}) {
340	my $NOW = AnyEvent->now;	850	my $NOW = AE::now;
341		851
342	# when would the timeout trigger?	852	# when would the timeout trigger?
343	my $after = $self->{_activity} + $self->{timeout} - $NOW;	853	my $after = $self->{$activity} + $self->{$timeout} - $NOW;
344		854
345	# now or in the past already?	855	# now or in the past already?
346	if ($after <= 0) {	856	if ($after <= 0) {
347	$self->{_activity} = $NOW;	857	$self->{$activity} = $NOW;
348		858
349	if ($self->{on_timeout}) {	859	if ($self->{$on_timeout}) {
350	$self->{on_timeout}($self);	860	$self->{$on_timeout}($self);
351	} else {	861	} else {
352	$self->_error (&Errno::ETIMEDOUT);	862	$self->_error (Errno::ETIMEDOUT);
		863	}
		864
		865	# callback could have changed timeout value, optimise
		866	return unless $self->{$timeout};
		867
		868	# calculate new after
		869	$after = $self->{$timeout};
353	}	870	}
354		871
355	# callback could have changed timeout value, optimise	872	Scalar::Util::weaken $self;
356	return unless $self->{timeout};	873	return unless $self; # ->error could have destroyed $self
357		874
358	# calculate new after	875	$self->{$tw} ||= AE::timer $after, 0, sub {
359	$after = $self->{timeout};	876	delete $self->{$tw};
		877	$cb->($self);
		878	};
		879	} else {
		880	delete $self->{$tw};
360	}	881	}
361
362	Scalar::Util::weaken $self;
363	return unless $self; # ->error could have destroyed $self
364
365	$self->{_tw} ||= AnyEvent->timer (after => $after, cb => sub {
366	delete $self->{_tw};
367	$self->_timeout;
368	});
369	} else {
370	delete $self->{_tw};
371	}	882	}
372	}	883	}
373		884
374	#############################################################################	885	#############################################################################
375		886
…		…
382		893
383	The write queue is very simple: you can add data to its end, and	894	The write queue is very simple: you can add data to its end, and
384	AnyEvent::Handle will automatically try to get rid of it for you.	895	AnyEvent::Handle will automatically try to get rid of it for you.
385		896
386	When data could be written and the write buffer is shorter then the low	897	When data could be written and the write buffer is shorter then the low
387	water mark, the C<on_drain> callback will be invoked.	898	water mark, the C<on_drain> callback will be invoked once.
388		899
389	=over 4	900	=over 4
390		901
391	=item $handle->on_drain ($cb)	902	=item $handle->on_drain ($cb)
392		903
393	Sets the C<on_drain> callback or clears it (see the description of	904	Sets the C<on_drain> callback or clears it (see the description of
394	C<on_drain> in the constructor).	905	C<on_drain> in the constructor).
395		906
		907	This method may invoke callbacks (and therefore the handle might be
		908	destroyed after it returns).
		909
396	=cut	910	=cut
397		911
398	sub on_drain {	912	sub on_drain {
399	my ($self, $cb) = @_;	913	my ($self, $cb) = @_;
400		914
401	$self->{on_drain} = $cb;	915	$self->{on_drain} = $cb;
402		916
403	$cb->($self)	917	$cb->($self)
404	if $cb && $self->{low_water_mark} >= length $self->{wbuf};	918	if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});
405	}	919	}
406		920
407	=item $handle->push_write ($data)	921	=item $handle->push_write ($data)
408		922
409	Queues the given scalar to be written. You can push as much data as you	923	Queues the given scalar to be written. You can push as much data as
410	want (only limited by the available memory), as C<AnyEvent::Handle>	924	you want (only limited by the available memory and C<wbuf_max>), as
411	buffers it independently of the kernel.	925	C<AnyEvent::Handle> buffers it independently of the kernel.
		926
		927	This method may invoke callbacks (and therefore the handle might be
		928	destroyed after it returns).
412		929
413	=cut	930	=cut
414		931
415	sub _drain_wbuf {	932	sub _drain_wbuf {
416	my ($self) = @_;	933	my ($self) = @_;
…		…
420	Scalar::Util::weaken $self;	937	Scalar::Util::weaken $self;
421		938
422	my $cb = sub {	939	my $cb = sub {
423	my $len = syswrite $self->{fh}, $self->{wbuf};	940	my $len = syswrite $self->{fh}, $self->{wbuf};
424		941
425	if ($len >= 0) {	942	if (defined $len) {
426	substr $self->{wbuf}, 0, $len, "";	943	substr $self->{wbuf}, 0, $len, "";
427		944
428	$self->{_activity} = AnyEvent->now;	945	$self->{_activity} = $self->{_wactivity} = AE::now;
429		946
430	$self->{on_drain}($self)	947	$self->{on_drain}($self)
431	if $self->{low_water_mark} >= length $self->{wbuf}	948	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
432	&& $self->{on_drain};	949	&& $self->{on_drain};
433		950
434	delete $self->{_ww} unless length $self->{wbuf};	951	delete $self->{_ww} unless length $self->{wbuf};
435	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	952	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
436	$self->_error ($!, 1);	953	$self->_error ($!, 1);
437	}	954	}
438	};	955	};
439		956
440	# try to write data immediately	957	# try to write data immediately
441	$cb->();	958	$cb->() unless $self->{autocork};
442		959
443	# if still data left in wbuf, we need to poll	960	# if still data left in wbuf, we need to poll
444	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	961	$self->{_ww} = AE::io $self->{fh}, 1, $cb
445	if length $self->{wbuf};	962	if length $self->{wbuf};
		963
		964	if (
		965	defined $self->{wbuf_max}
		966	&& $self->{wbuf_max} < length $self->{wbuf}
		967	) {
		968	$self->_error (Errno::ENOSPC, 1), return;
		969	}
446	};	970	};
447	}	971	}
448		972
449	our %WH;	973	our %WH;
450		974
		975	# deprecated
451	sub register_write_type($$) {	976	sub register_write_type($$) {
452	$WH{$_[0]} = $_[1];	977	$WH{$_[0]} = $_[1];
453	}	978	}
454		979
455	sub push_write {	980	sub push_write {
456	my $self = shift;	981	my $self = shift;
457		982
458	if (@_ > 1) {	983	if (@_ > 1) {
459	my $type = shift;	984	my $type = shift;
460		985
		986	@_ = ($WH{$type} ||= _load_func "$type\::anyevent_write_type"
461	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	987	or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_write")
462	->($self, @_);	988	->($self, @_);
463	}	989	}
464		990
		991	# we downgrade here to avoid hard-to-track-down bugs,
		992	# and diagnose the problem earlier and better.
		993
465	if ($self->{filter_w}) {	994	if ($self->{tls}) {
466	$self->{filter_w}($self, \$_[0]);	995	utf8::downgrade $self->{_tls_wbuf} .= $_[0];
		996	&_dotls ($self) if $self->{fh};
467	} else {	997	} else {
468	$self->{wbuf} .= $_[0];	998	utf8::downgrade $self->{wbuf} .= $_[0];
469	$self->_drain_wbuf;	999	$self->_drain_wbuf if $self->{fh};
470	}	1000	}
471	}	1001	}
472		1002
473	=item $handle->push_write (type => @args)	1003	=item $handle->push_write (type => @args)
474		1004
475	Instead of formatting your data yourself, you can also let this module do	1005	Instead of formatting your data yourself, you can also let this module
476	the job by specifying a type and type-specific arguments.	1006	do the job by specifying a type and type-specific arguments. You
		1007	can also specify the (fully qualified) name of a package, in which
		1008	case AnyEvent tries to load the package and then expects to find the
		1009	C<anyevent_write_type> function inside (see "custom write types", below).
477		1010
478	Predefined types are (if you have ideas for additional types, feel free to	1011	Predefined types are (if you have ideas for additional types, feel free to
479	drop by and tell us):	1012	drop by and tell us):
480		1013
481	=over 4	1014	=over 4
…		…
488	=cut	1021	=cut
489		1022
490	register_write_type netstring => sub {	1023	register_write_type netstring => sub {
491	my ($self, $string) = @_;	1024	my ($self, $string) = @_;
492		1025
493	sprintf "%d:%s,", (length $string), $string	1026	(length $string) . ":$string,"
494	};	1027	};
495		1028
496	=item packstring => $format, $data	1029	=item packstring => $format, $data
497		1030
498	An octet string prefixed with an encoded length. The encoding C<$format>	1031	An octet string prefixed with an encoded length. The encoding C<$format>
…		…
538	Other languages could read single lines terminated by a newline and pass	1071	Other languages could read single lines terminated by a newline and pass
539	this line into their JSON decoder of choice.	1072	this line into their JSON decoder of choice.
540		1073
541	=cut	1074	=cut
542		1075
		1076	sub json_coder() {
		1077	eval { require JSON::XS; JSON::XS->new->utf8 }
		1078	|| do { require JSON; JSON->new->utf8 }
		1079	}
		1080
543	register_write_type json => sub {	1081	register_write_type json => sub {
544	my ($self, $ref) = @_;	1082	my ($self, $ref) = @_;
545		1083
546	require JSON;	1084	my $json = $self->{json} ||= json_coder;
547		1085
548	$self->{json} ? $self->{json}->encode ($ref)	1086	$json->encode ($ref)
549	: JSON::encode_json ($ref)
550	};	1087	};
551		1088
552	=item storable => $reference	1089	=item storable => $reference
553		1090
554	Freezes the given reference using L<Storable> and writes it to the	1091	Freezes the given reference using L<Storable> and writes it to the
…		…
557	=cut	1094	=cut
558		1095
559	register_write_type storable => sub {	1096	register_write_type storable => sub {
560	my ($self, $ref) = @_;	1097	my ($self, $ref) = @_;
561		1098
562	require Storable;	1099	require Storable unless $Storable::VERSION;
563		1100
564	pack "w/a*", Storable::nfreeze ($ref)	1101	pack "w/a*", Storable::nfreeze ($ref)
565	};	1102	};
566		1103
567	=back	1104	=back
568		1105
569	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	1106	=item $handle->push_shutdown
570		1107
571	This function (not method) lets you add your own types to C<push_write>.	1108	Sometimes you know you want to close the socket after writing your data
		1109	before it was actually written. One way to do that is to replace your
		1110	C<on_drain> handler by a callback that shuts down the socket (and set
		1111	C<low_water_mark> to C<0>). This method is a shorthand for just that, and
		1112	replaces the C<on_drain> callback with:
		1113
		1114	sub { shutdown $_[0]{fh}, 1 }
		1115
		1116	This simply shuts down the write side and signals an EOF condition to the
		1117	the peer.
		1118
		1119	You can rely on the normal read queue and C<on_eof> handling
		1120	afterwards. This is the cleanest way to close a connection.
		1121
		1122	This method may invoke callbacks (and therefore the handle might be
		1123	destroyed after it returns).
		1124
		1125	=cut
		1126
		1127	sub push_shutdown {
		1128	my ($self) = @_;
		1129
		1130	delete $self->{low_water_mark};
		1131	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });
		1132	}
		1133
		1134	=item custom write types - Package::anyevent_write_type $handle, @args
		1135
		1136	Instead of one of the predefined types, you can also specify the name of
		1137	a package. AnyEvent will try to load the package and then expects to find
		1138	a function named C<anyevent_write_type> inside. If it isn't found, it
		1139	progressively tries to load the parent package until it either finds the
		1140	function (good) or runs out of packages (bad).
		1141
572	Whenever the given C<type> is used, C<push_write> will invoke the code	1142	Whenever the given C<type> is used, C<push_write> will the function with
573	reference with the handle object and the remaining arguments.	1143	the handle object and the remaining arguments.
574		1144
575	The code reference is supposed to return a single octet string that will	1145	The function is supposed to return a single octet string that will be
576	be appended to the write buffer.	1146	appended to the write buffer, so you can mentally treat this function as a
		1147	"arguments to on-the-wire-format" converter.
577		1148
578	Note that this is a function, and all types registered this way will be	1149	Example: implement a custom write type C<join> that joins the remaining
579	global, so try to use unique names.	1150	arguments using the first one.
		1151
		1152	$handle->push_write (My::Type => " ", 1,2,3);
		1153
		1154	# uses the following package, which can be defined in the "My::Type" or in
		1155	# the "My" modules to be auto-loaded, or just about anywhere when the
		1156	# My::Type::anyevent_write_type is defined before invoking it.
		1157
		1158	package My::Type;
		1159
		1160	sub anyevent_write_type {
		1161	my ($handle, $delim, @args) = @_;
		1162
		1163	join $delim, @args
		1164	}
580		1165
581	=cut	1166	=cut
582		1167
583	#############################################################################	1168	#############################################################################
584		1169
…		…
593	ways, the "simple" way, using only C<on_read> and the "complex" way, using	1178	ways, the "simple" way, using only C<on_read> and the "complex" way, using
594	a queue.	1179	a queue.
595		1180
596	In the simple case, you just install an C<on_read> callback and whenever	1181	In the simple case, you just install an C<on_read> callback and whenever
597	new data arrives, it will be called. You can then remove some data (if	1182	new data arrives, it will be called. You can then remove some data (if
598	enough is there) from the read buffer (C<< $handle->rbuf >>) if you want	1183	enough is there) from the read buffer (C<< $handle->rbuf >>). Or you can
599	or not.	1184	leave the data there if you want to accumulate more (e.g. when only a
		1185	partial message has been received so far), or change the read queue with
		1186	e.g. C<push_read>.
600		1187
601	In the more complex case, you want to queue multiple callbacks. In this	1188	In the more complex case, you want to queue multiple callbacks. In this
602	case, AnyEvent::Handle will call the first queued callback each time new	1189	case, AnyEvent::Handle will call the first queued callback each time new
603	data arrives (also the first time it is queued) and removes it when it has	1190	data arrives (also the first time it is queued) and remove it when it has
604	done its job (see C<push_read>, below).	1191	done its job (see C<push_read>, below).
605		1192
606	This way you can, for example, push three line-reads, followed by reading	1193	This way you can, for example, push three line-reads, followed by reading
607	a chunk of data, and AnyEvent::Handle will execute them in order.	1194	a chunk of data, and AnyEvent::Handle will execute them in order.
608		1195
…		…
622	# handle xml	1209	# handle xml
623	});	1210	});
624	});	1211	});
625	});	1212	});
626		1213
627	Example 2: Implement a client for a protocol that replies either with	1214	Example 2: Implement a client for a protocol that replies either with "OK"
628	"OK" and another line or "ERROR" for one request, and 64 bytes for the	1215	and another line or "ERROR" for the first request that is sent, and 64
629	second request. Due tot he availability of a full queue, we can just	1216	bytes for the second request. Due to the availability of a queue, we can
630	pipeline sending both requests and manipulate the queue as necessary in	1217	just pipeline sending both requests and manipulate the queue as necessary
631	the callbacks:	1218	in the callbacks.
632		1219
633	# request one	1220	When the first callback is called and sees an "OK" response, it will
		1221	C<unshift> another line-read. This line-read will be queued I<before> the
		1222	64-byte chunk callback.
		1223
		1224	# request one, returns either "OK + extra line" or "ERROR"
634	$handle->push_write ("request 1\015\012");	1225	$handle->push_write ("request 1\015\012");
635		1226
636	# we expect "ERROR" or "OK" as response, so push a line read	1227	# we expect "ERROR" or "OK" as response, so push a line read
637	$handle->push_read (line => sub {	1228	$handle->push_read (line => sub {
638	# if we got an "OK", we have to _prepend_ another line,	1229	# if we got an "OK", we have to _prepend_ another line,
…		…
645	...	1236	...
646	});	1237	});
647	}	1238	}
648	});	1239	});
649		1240
650	# request two	1241	# request two, simply returns 64 octets
651	$handle->push_write ("request 2\015\012");	1242	$handle->push_write ("request 2\015\012");
652		1243
653	# simply read 64 bytes, always	1244	# simply read 64 bytes, always
654	$handle->push_read (chunk => 64, sub {	1245	$handle->push_read (chunk => 64, sub {
655	my $response = $_[1];	1246	my $response = $_[1];
…		…
661	=cut	1252	=cut
662		1253
663	sub _drain_rbuf {	1254	sub _drain_rbuf {
664	my ($self) = @_;	1255	my ($self) = @_;
665		1256
		1257	# avoid recursion
		1258	return if $self->{_skip_drain_rbuf};
666	local $self->{_in_drain} = 1;	1259	local $self->{_skip_drain_rbuf} = 1;
667
668	if (
669	defined $self->{rbuf_max}
670	&& $self->{rbuf_max} < length $self->{rbuf}
671	) {
672	return $self->_error (&Errno::ENOSPC, 1);
673	}
674		1260
675	while () {	1261	while () {
676	no strict 'refs';	1262	# we need to use a separate tls read buffer, as we must not receive data while
		1263	# we are draining the buffer, and this can only happen with TLS.
		1264	$self->{rbuf} .= delete $self->{_tls_rbuf}
		1265	if exists $self->{_tls_rbuf};
677		1266
678	my $len = length $self->{rbuf};	1267	my $len = length $self->{rbuf};
679		1268
680	if (my $cb = shift @{ $self->{_queue} }) {	1269	if (my $cb = shift @{ $self->{_queue} }) {
681	unless ($cb->($self)) {	1270	unless ($cb->($self)) {
682	if ($self->{_eof}) {	1271	# no progress can be made
683	# no progress can be made (not enough data and no data forthcoming)	1272	# (not enough data and no data forthcoming)
684	$self->_error (&Errno::EPIPE, 1), last;	1273	$self->_error (Errno::EPIPE, 1), return
685	}	1274	if $self->{_eof};
686		1275
687	unshift @{ $self->{_queue} }, $cb;	1276	unshift @{ $self->{_queue} }, $cb;
688	last;	1277	last;
689	}	1278	}
690	} elsif ($self->{on_read}) {	1279	} elsif ($self->{on_read}) {
…		…
697	&& !@{ $self->{_queue} } # and the queue is still empty	1286	&& !@{ $self->{_queue} } # and the queue is still empty
698	&& $self->{on_read} # but we still have on_read	1287	&& $self->{on_read} # but we still have on_read
699	) {	1288	) {
700	# no further data will arrive	1289	# no further data will arrive
701	# so no progress can be made	1290	# so no progress can be made
702	$self->_error (&Errno::EPIPE, 1), last	1291	$self->_error (Errno::EPIPE, 1), return
703	if $self->{_eof};	1292	if $self->{_eof};
704		1293
705	last; # more data might arrive	1294	last; # more data might arrive
706	}	1295	}
707	} else {	1296	} else {
708	# read side becomes idle	1297	# read side becomes idle
709	delete $self->{_rw};	1298	delete $self->{_rw} unless $self->{tls};
710	last;	1299	last;
711	}	1300	}
712	}	1301	}
713		1302
		1303	if ($self->{_eof}) {
		1304	$self->{on_eof}
714	$self->{on_eof}($self)	1305	? $self->{on_eof}($self)
715	if $self->{_eof} && $self->{on_eof};	1306	: $self->_error (0, 1, "Unexpected end-of-file");
		1307
		1308	return;
		1309	}
		1310
		1311	if (
		1312	defined $self->{rbuf_max}
		1313	&& $self->{rbuf_max} < length $self->{rbuf}
		1314	) {
		1315	$self->_error (Errno::ENOSPC, 1), return;
		1316	}
716		1317
717	# may need to restart read watcher	1318	# may need to restart read watcher
718	unless ($self->{_rw}) {	1319	unless ($self->{_rw}) {
719	$self->start_read	1320	$self->start_read
720	if $self->{on_read} || @{ $self->{_queue} };	1321	if $self->{on_read} || @{ $self->{_queue} };
…		…
725		1326
726	This replaces the currently set C<on_read> callback, or clears it (when	1327	This replaces the currently set C<on_read> callback, or clears it (when
727	the new callback is C<undef>). See the description of C<on_read> in the	1328	the new callback is C<undef>). See the description of C<on_read> in the
728	constructor.	1329	constructor.
729		1330
		1331	This method may invoke callbacks (and therefore the handle might be
		1332	destroyed after it returns).
		1333
730	=cut	1334	=cut
731		1335
732	sub on_read {	1336	sub on_read {
733	my ($self, $cb) = @_;	1337	my ($self, $cb) = @_;
734		1338
735	$self->{on_read} = $cb;	1339	$self->{on_read} = $cb;
736	$self->_drain_rbuf if $cb && !$self->{_in_drain};	1340	$self->_drain_rbuf if $cb;
737	}	1341	}
738		1342
739	=item $handle->rbuf	1343	=item $handle->rbuf
740		1344
741	Returns the read buffer (as a modifiable lvalue).	1345	Returns the read buffer (as a modifiable lvalue). You can also access the
		1346	read buffer directly as the C<< ->{rbuf} >> member, if you want (this is
		1347	much faster, and no less clean).
742		1348
743	You can access the read buffer directly as the C<< ->{rbuf} >> member, if	1349	The only operation allowed on the read buffer (apart from looking at it)
744	you want.	1350	is removing data from its beginning. Otherwise modifying or appending to
		1351	it is not allowed and will lead to hard-to-track-down bugs.
745		1352
746	NOTE: The read buffer should only be used or modified if the C<on_read>,	1353	NOTE: The read buffer should only be used or modified in the C<on_read>
747	C<push_read> or C<unshift_read> methods are used. The other read methods	1354	callback or when C<push_read> or C<unshift_read> are used with a single
748	automatically manage the read buffer.	1355	callback (i.e. untyped). Typed C<push_read> and C<unshift_read> methods
		1356	will manage the read buffer on their own.
749		1357
750	=cut	1358	=cut
751		1359
752	sub rbuf : lvalue {	1360	sub rbuf : lvalue {
753	$_[0]{rbuf}	1361	$_[0]{rbuf}
…		…
770		1378
771	If enough data was available, then the callback must remove all data it is	1379	If enough data was available, then the callback must remove all data it is
772	interested in (which can be none at all) and return a true value. After returning	1380	interested in (which can be none at all) and return a true value. After returning
773	true, it will be removed from the queue.	1381	true, it will be removed from the queue.
774		1382
		1383	These methods may invoke callbacks (and therefore the handle might be
		1384	destroyed after it returns).
		1385
775	=cut	1386	=cut
776		1387
777	our %RH;	1388	our %RH;
778		1389
779	sub register_read_type($$) {	1390	sub register_read_type($$) {
…		…
785	my $cb = pop;	1396	my $cb = pop;
786		1397
787	if (@_) {	1398	if (@_) {
788	my $type = shift;	1399	my $type = shift;
789		1400
		1401	$cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type"
790	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	1402	or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_read")
791	->($self, $cb, @_);	1403	->($self, $cb, @_);
792	}	1404	}
793		1405
794	push @{ $self->{_queue} }, $cb;	1406	push @{ $self->{_queue} }, $cb;
795	$self->_drain_rbuf unless $self->{_in_drain};	1407	$self->_drain_rbuf;
796	}	1408	}
797		1409
798	sub unshift_read {	1410	sub unshift_read {
799	my $self = shift;	1411	my $self = shift;
800	my $cb = pop;	1412	my $cb = pop;
801		1413
802	if (@_) {	1414	if (@_) {
803	my $type = shift;	1415	my $type = shift;
804		1416
		1417	$cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type"
805	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")	1418	or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::unshift_read")
806	->($self, $cb, @_);	1419	->($self, $cb, @_);
807	}	1420	}
808		1421
809
810	unshift @{ $self->{_queue} }, $cb;	1422	unshift @{ $self->{_queue} }, $cb;
811	$self->_drain_rbuf unless $self->{_in_drain};	1423	$self->_drain_rbuf;
812	}	1424	}
813		1425
814	=item $handle->push_read (type => @args, $cb)	1426	=item $handle->push_read (type => @args, $cb)
815		1427
816	=item $handle->unshift_read (type => @args, $cb)	1428	=item $handle->unshift_read (type => @args, $cb)
817		1429
818	Instead of providing a callback that parses the data itself you can chose	1430	Instead of providing a callback that parses the data itself you can chose
819	between a number of predefined parsing formats, for chunks of data, lines	1431	between a number of predefined parsing formats, for chunks of data, lines
820	etc.	1432	etc. You can also specify the (fully qualified) name of a package, in
		1433	which case AnyEvent tries to load the package and then expects to find the
		1434	C<anyevent_read_type> function inside (see "custom read types", below).
821		1435
822	Predefined types are (if you have ideas for additional types, feel free to	1436	Predefined types are (if you have ideas for additional types, feel free to
823	drop by and tell us):	1437	drop by and tell us):
824		1438
825	=over 4	1439	=over 4
…		…
831	data.	1445	data.
832		1446
833	Example: read 2 bytes.	1447	Example: read 2 bytes.
834		1448
835	$handle->push_read (chunk => 2, sub {	1449	$handle->push_read (chunk => 2, sub {
836	warn "yay ", unpack "H*", $_[1];	1450	say "yay " . unpack "H*", $_[1];
837	});	1451	});
838		1452
839	=cut	1453	=cut
840		1454
841	register_read_type chunk => sub {	1455	register_read_type chunk => sub {
…		…
846	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");	1460	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");
847	1	1461	1
848	}	1462	}
849	};	1463	};
850		1464
851	# compatibility with older API
852	sub push_read_chunk {
853	$_[0]->push_read (chunk => $_[1], $_[2]);
854	}
855
856	sub unshift_read_chunk {
857	$_[0]->unshift_read (chunk => $_[1], $_[2]);
858	}
859
860	=item line => [$eol, ]$cb->($handle, $line, $eol)	1465	=item line => [$eol, ]$cb->($handle, $line, $eol)
861		1466
862	The callback will be called only once a full line (including the end of	1467	The callback will be called only once a full line (including the end of
863	line marker, C<$eol>) has been read. This line (excluding the end of line	1468	line marker, C<$eol>) has been read. This line (excluding the end of line
864	marker) will be passed to the callback as second argument (C<$line>), and	1469	marker) will be passed to the callback as second argument (C<$line>), and
…		…
879	=cut	1484	=cut
880		1485
881	register_read_type line => sub {	1486	register_read_type line => sub {
882	my ($self, $cb, $eol) = @_;	1487	my ($self, $cb, $eol) = @_;
883		1488
884	$eol = qr|(\015?\012)| if @_ < 3;	1489	if (@_ < 3) {
		1490	# this is more than twice as fast as the generic code below
		1491	sub {
		1492	$_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return;
		1493
		1494	$cb->($_[0], "$1", "$2");
		1495	1
		1496	}
		1497	} else {
885	$eol = quotemeta $eol unless ref $eol;	1498	$eol = quotemeta $eol unless ref $eol;
886	$eol = qr|^(.*?)($eol)|s;	1499	$eol = qr|^(.*?)($eol)|s;
887		1500
888	sub {	1501	sub {
889	$_[0]{rbuf} =~ s/$eol// or return;	1502	$_[0]{rbuf} =~ s/$eol// or return;
890		1503
891	$cb->($_[0], $1, $2);	1504	$cb->($_[0], "$1", "$2");
		1505	1
892	1	1506	}
893	}	1507	}
894	};	1508	};
895
896	# compatibility with older API
897	sub push_read_line {
898	my $self = shift;
899	$self->push_read (line => @_);
900	}
901
902	sub unshift_read_line {
903	my $self = shift;
904	$self->unshift_read (line => @_);
905	}
906		1509
907	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)	1510	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
908		1511
909	Makes a regex match against the regex object C<$accept> and returns	1512	Makes a regex match against the regex object C<$accept> and returns
910	everything up to and including the match.	1513	everything up to and including the match.
…		…
928	the receive buffer when neither C<$accept> nor C<$reject> match,	1531	the receive buffer when neither C<$accept> nor C<$reject> match,
929	and everything preceding and including the match will be accepted	1532	and everything preceding and including the match will be accepted
930	unconditionally. This is useful to skip large amounts of data that you	1533	unconditionally. This is useful to skip large amounts of data that you
931	know cannot be matched, so that the C<$accept> or C<$reject> regex do not	1534	know cannot be matched, so that the C<$accept> or C<$reject> regex do not
932	have to start matching from the beginning. This is purely an optimisation	1535	have to start matching from the beginning. This is purely an optimisation
933	and is usually worth only when you expect more than a few kilobytes.	1536	and is usually worth it only when you expect more than a few kilobytes.
934		1537
935	Example: expect a http header, which ends at C<\015\012\015\012>. Since we	1538	Example: expect a http header, which ends at C<\015\012\015\012>. Since we
936	expect the header to be very large (it isn't in practise, but...), we use	1539	expect the header to be very large (it isn't in practice, but...), we use
937	a skip regex to skip initial portions. The skip regex is tricky in that	1540	a skip regex to skip initial portions. The skip regex is tricky in that
938	it only accepts something not ending in either \015 or \012, as these are	1541	it only accepts something not ending in either \015 or \012, as these are
939	required for the accept regex.	1542	required for the accept regex.
940		1543
941	$handle->push_read (regex =>	1544	$handle->push_read (regex =>
…		…
954		1557
955	sub {	1558	sub {
956	# accept	1559	# accept
957	if ($$rbuf =~ $accept) {	1560	if ($$rbuf =~ $accept) {
958	$data .= substr $$rbuf, 0, $+[0], "";	1561	$data .= substr $$rbuf, 0, $+[0], "";
959	$cb->($self, $data);	1562	$cb->($_[0], $data);
960	return 1;	1563	return 1;
961	}	1564	}
962		1565
963	# reject	1566	# reject
964	if ($reject && $$rbuf =~ $reject) {	1567	if ($reject && $$rbuf =~ $reject) {
965	$self->_error (&Errno::EBADMSG);	1568	$_[0]->_error (Errno::EBADMSG);
966	}	1569	}
967		1570
968	# skip	1571	# skip
969	if ($skip && $$rbuf =~ $skip) {	1572	if ($skip && $$rbuf =~ $skip) {
970	$data .= substr $$rbuf, 0, $+[0], "";	1573	$data .= substr $$rbuf, 0, $+[0], "";
…		…
986	my ($self, $cb) = @_;	1589	my ($self, $cb) = @_;
987		1590
988	sub {	1591	sub {
989	unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {	1592	unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {
990	if ($_[0]{rbuf} =~ /[^0-9]/) {	1593	if ($_[0]{rbuf} =~ /[^0-9]/) {
991	$self->_error (&Errno::EBADMSG);	1594	$_[0]->_error (Errno::EBADMSG);
992	}	1595	}
993	return;	1596	return;
994	}	1597	}
995		1598
996	my $len = $1;	1599	my $len = $1;
997		1600
998	$self->unshift_read (chunk => $len, sub {	1601	$_[0]->unshift_read (chunk => $len, sub {
999	my $string = $_[1];	1602	my $string = $_[1];
1000	$_[0]->unshift_read (chunk => 1, sub {	1603	$_[0]->unshift_read (chunk => 1, sub {
1001	if ($_[1] eq ",") {	1604	if ($_[1] eq ",") {
1002	$cb->($_[0], $string);	1605	$cb->($_[0], $string);
1003	} else {	1606	} else {
1004	$self->_error (&Errno::EBADMSG);	1607	$_[0]->_error (Errno::EBADMSG);
1005	}	1608	}
1006	});	1609	});
1007	});	1610	});
1008		1611
1009	1	1612	1
…		…
1015	An octet string prefixed with an encoded length. The encoding C<$format>	1618	An octet string prefixed with an encoded length. The encoding C<$format>
1016	uses the same format as a Perl C<pack> format, but must specify a single	1619	uses the same format as a Perl C<pack> format, but must specify a single
1017	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an	1620	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
1018	optional C<!>, C<< < >> or C<< > >> modifier).	1621	optional C<!>, C<< < >> or C<< > >> modifier).
1019		1622
1020	DNS over TCP uses a prefix of C<n>, EPP uses a prefix of C<N>.	1623	For example, DNS over TCP uses a prefix of C<n> (2 octet network order),
		1624	EPP uses a prefix of C<N> (4 octtes).
1021		1625
1022	Example: read a block of data prefixed by its length in BER-encoded	1626	Example: read a block of data prefixed by its length in BER-encoded
1023	format (very efficient).	1627	format (very efficient).
1024		1628
1025	$handle->push_read (packstring => "w", sub {	1629	$handle->push_read (packstring => "w", sub {
…		…
1031	register_read_type packstring => sub {	1635	register_read_type packstring => sub {
1032	my ($self, $cb, $format) = @_;	1636	my ($self, $cb, $format) = @_;
1033		1637
1034	sub {	1638	sub {
1035	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method	1639	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
1036	defined (my $len = eval { unpack $format, $_[0]->{rbuf} })	1640	defined (my $len = eval { unpack $format, $_[0]{rbuf} })
1037	or return;	1641	or return;
1038		1642
		1643	$format = length pack $format, $len;
		1644
		1645	# bypass unshift if we already have the remaining chunk
		1646	if ($format + $len <= length $_[0]{rbuf}) {
		1647	my $data = substr $_[0]{rbuf}, $format, $len;
		1648	substr $_[0]{rbuf}, 0, $format + $len, "";
		1649	$cb->($_[0], $data);
		1650	} else {
1039	# remove prefix	1651	# remove prefix
1040	substr $_[0]->{rbuf}, 0, (length pack $format, $len), "";	1652	substr $_[0]{rbuf}, 0, $format, "";
1041		1653
1042	# read rest	1654	# read remaining chunk
1043	$_[0]->unshift_read (chunk => $len, $cb);	1655	$_[0]->unshift_read (chunk => $len, $cb);
		1656	}
1044		1657
1045	1	1658	1
1046	}	1659	}
1047	};	1660	};
1048		1661
1049	=item json => $cb->($handle, $hash_or_arrayref)	1662	=item json => $cb->($handle, $hash_or_arrayref)
1050		1663
1051	Reads a JSON object or array, decodes it and passes it to the callback.	1664	Reads a JSON object or array, decodes it and passes it to the
		1665	callback. When a parse error occurs, an C<EBADMSG> error will be raised.
1052		1666
1053	If a C<json> object was passed to the constructor, then that will be used	1667	If a C<json> object was passed to the constructor, then that will be used
1054	for the final decode, otherwise it will create a JSON coder expecting UTF-8.	1668	for the final decode, otherwise it will create a JSON coder expecting UTF-8.
1055		1669
1056	This read type uses the incremental parser available with JSON version	1670	This read type uses the incremental parser available with JSON version
…		…
1065	=cut	1679	=cut
1066		1680
1067	register_read_type json => sub {	1681	register_read_type json => sub {
1068	my ($self, $cb) = @_;	1682	my ($self, $cb) = @_;
1069		1683
1070	require JSON;	1684	my $json = $self->{json} ||= json_coder;
1071		1685
1072	my $data;	1686	my $data;
1073	my $rbuf = \$self->{rbuf};	1687	my $rbuf = \$self->{rbuf};
1074		1688
1075	my $json = $self->{json} ||= JSON->new->utf8;
1076
1077	sub {	1689	sub {
1078	my $ref = $json->incr_parse ($self->{rbuf});	1690	my $ref = eval { $json->incr_parse ($_[0]{rbuf}) };
1079		1691
1080	if ($ref) {	1692	if ($ref) {
1081	$self->{rbuf} = $json->incr_text;	1693	$_[0]{rbuf} = $json->incr_text;
1082	$json->incr_text = "";	1694	$json->incr_text = "";
1083	$cb->($self, $ref);	1695	$cb->($_[0], $ref);
1084		1696
1085	1	1697	1
		1698	} elsif ($@) {
		1699	# error case
		1700	$json->incr_skip;
		1701
		1702	$_[0]{rbuf} = $json->incr_text;
		1703	$json->incr_text = "";
		1704
		1705	$_[0]->_error (Errno::EBADMSG);
		1706
		1707	()
1086	} else {	1708	} else {
1087	$self->{rbuf} = "";	1709	$_[0]{rbuf} = "";
		1710
1088	()	1711	()
1089	}	1712	}
1090	}	1713	}
1091	};	1714	};
1092		1715
…		…
1101	=cut	1724	=cut
1102		1725
1103	register_read_type storable => sub {	1726	register_read_type storable => sub {
1104	my ($self, $cb) = @_;	1727	my ($self, $cb) = @_;
1105		1728
1106	require Storable;	1729	require Storable unless $Storable::VERSION;
1107		1730
1108	sub {	1731	sub {
1109	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method	1732	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
1110	defined (my $len = eval { unpack "w", $_[0]->{rbuf} })	1733	defined (my $len = eval { unpack "w", $_[0]{rbuf} })
1111	or return;	1734	or return;
1112		1735
		1736	my $format = length pack "w", $len;
		1737
		1738	# bypass unshift if we already have the remaining chunk
		1739	if ($format + $len <= length $_[0]{rbuf}) {
		1740	my $data = substr $_[0]{rbuf}, $format, $len;
		1741	substr $_[0]{rbuf}, 0, $format + $len, "";
		1742
		1743	eval { $cb->($_[0], Storable::thaw ($data)); 1 }
		1744	or return $_[0]->_error (Errno::EBADMSG);
		1745	} else {
1113	# remove prefix	1746	# remove prefix
1114	substr $_[0]->{rbuf}, 0, (length pack "w", $len), "";	1747	substr $_[0]{rbuf}, 0, $format, "";
1115		1748
1116	# read rest	1749	# read remaining chunk
1117	$_[0]->unshift_read (chunk => $len, sub {	1750	$_[0]->unshift_read (chunk => $len, sub {
1118	if (my $ref = eval { Storable::thaw ($_[1]) }) {	1751	eval { $cb->($_[0], Storable::thaw ($_[1])); 1 }
1119	$cb->($_[0], $ref);
1120	} else {
1121	$self->_error (&Errno::EBADMSG);	1752	or $_[0]->_error (Errno::EBADMSG);
1122	}	1753	});
1123	});	1754	}
		1755
		1756	1
1124	}	1757	}
1125	};	1758	};
1126		1759
		1760	=item tls_detect => $cb->($handle, $detect, $major, $minor)
		1761
		1762	Checks the input stream for a valid SSL or TLS handshake TLSPaintext
		1763	record without consuming anything. Only SSL version 3 or higher
		1764	is handled, up to the fictituous protocol 4.x (but both SSL3+ and
		1765	SSL2-compatible framing is supported).
		1766
		1767	If it detects that the input data is likely TLS, it calls the callback
		1768	with a true value for C<$detect> and the (on-wire) TLS version as second
		1769	and third argument (C<$major> is C<3>, and C<$minor> is 0..3 for SSL
		1770	3.0, TLS 1.0, 1.1 and 1.2, respectively). If it detects the input to
		1771	be definitely not TLS, it calls the callback with a false value for
		1772	C<$detect>.
		1773
		1774	The callback could use this information to decide whether or not to start
		1775	TLS negotiation.
		1776
		1777	In all cases the data read so far is passed to the following read
		1778	handlers.
		1779
		1780	Usually you want to use the C<tls_autostart> read type instead.
		1781
		1782	If you want to design a protocol that works in the presence of TLS
		1783	dtection, make sure that any non-TLS data doesn't start with the octet 22
		1784	(ASCII SYN, 16 hex) or 128-255 (i.e. highest bit set). The checks this
		1785	read type does are a bit more strict, but might losen in the future to
		1786	accomodate protocol changes.
		1787
		1788	This read type does not rely on L<AnyEvent::TLS> (and thus, not on
		1789	L<Net::SSLeay>).
		1790
		1791	=item tls_autostart => $tls[, $tls_ctx]
		1792
		1793	Tries to detect a valid SSL or TLS handshake. If one is detected, it tries
		1794	to start tls by calling C<starttls> with the given arguments.
		1795
		1796	In practise, C<$tls> must be C<accept>, or a Net::SSLeay context that has
		1797	been configured to accept, as servers do not normally send a handshake on
		1798	their own and ths cannot be detected in this way.
		1799
		1800	See C<tls_detect> above for more details.
		1801
		1802	Example: give the client a chance to start TLS before accepting a text
		1803	line.
		1804
		1805	$hdl->push_read (tls_detect => "accept");
		1806	$hdl->push_read (line => sub {
		1807	print "received ", ($_[0]{tls} ? "encrypted" : "cleartext"), " <$_[1]>\n";
		1808	});
		1809
		1810	=cut
		1811
		1812	register_read_type tls_detect => sub {
		1813	my ($self, $cb) = @_;
		1814
		1815	sub {
		1816	# this regex matches a full or partial tls record
		1817	if (
		1818	# ssl3+: type(22=handshake) major(=3) minor(any) length_hi
		1819	$self->{rbuf} =~ /^(?:\z| \x16 (\z| [\x03\x04] (?:\z| . (?:\z| [\x00-\x40] ))))/xs
		1820	# ssl2 comapatible: len_hi len_lo type(1) major minor dummy(forlength)
		1821	or $self->{rbuf} =~ /^(?:\z| [\x80-\xff] (?:\z| . (?:\z| \x01 (\z| [\x03\x04] (?:\z| . (?:\z| . ))))))/xs
		1822	) {
		1823	return if 3 != length $1; # partial match, can't decide yet
		1824
		1825	# full match, valid TLS record
		1826	my ($major, $minor) = unpack "CC", $1;
		1827	$cb->($self, "accept", $major + $minor * 0.1);
		1828	} else {
		1829	# mismatch == guaranteed not TLS
		1830	$cb->($self, undef);
		1831	}
		1832
		1833	1
		1834	}
		1835	};
		1836
		1837	register_read_type tls_autostart => sub {
		1838	my ($self, @tls) = @_;
		1839
		1840	$RH{tls_detect}($self, sub {
		1841	return unless $_[1];
		1842	$_[0]->starttls (@tls);
		1843	})
		1844	};
		1845
1127	=back	1846	=back
1128		1847
1129	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)	1848	=item custom read types - Package::anyevent_read_type $handle, $cb, @args
1130		1849
1131	This function (not method) lets you add your own types to C<push_read>.	1850	Instead of one of the predefined types, you can also specify the name
		1851	of a package. AnyEvent will try to load the package and then expects to
		1852	find a function named C<anyevent_read_type> inside. If it isn't found, it
		1853	progressively tries to load the parent package until it either finds the
		1854	function (good) or runs out of packages (bad).
1132		1855
1133	Whenever the given C<type> is used, C<push_read> will invoke the code	1856	Whenever this type is used, C<push_read> will invoke the function with the
1134	reference with the handle object, the callback and the remaining	1857	handle object, the original callback and the remaining arguments.
1135	arguments.
1136		1858
1137	The code reference is supposed to return a callback (usually a closure)	1859	The function is supposed to return a callback (usually a closure) that
1138	that works as a plain read callback (see C<< ->push_read ($cb) >>).	1860	works as a plain read callback (see C<< ->push_read ($cb) >>), so you can
		1861	mentally treat the function as a "configurable read type to read callback"
		1862	converter.
1139		1863
1140	It should invoke the passed callback when it is done reading (remember to	1864	It should invoke the original callback when it is done reading (remember
1141	pass C<$handle> as first argument as all other callbacks do that).	1865	to pass C<$handle> as first argument as all other callbacks do that,
		1866	although there is no strict requirement on this).
1142		1867
1143	Note that this is a function, and all types registered this way will be
1144	global, so try to use unique names.
1145
1146	For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>,	1868	For examples, see the source of this module (F<perldoc -m
1147	search for C<register_read_type>)).	1869	AnyEvent::Handle>, search for C<register_read_type>)).
1148		1870
1149	=item $handle->stop_read	1871	=item $handle->stop_read
1150		1872
1151	=item $handle->start_read	1873	=item $handle->start_read
1152		1874
…		…
1158	Note that AnyEvent::Handle will automatically C<start_read> for you when	1880	Note that AnyEvent::Handle will automatically C<start_read> for you when
1159	you change the C<on_read> callback or push/unshift a read callback, and it	1881	you change the C<on_read> callback or push/unshift a read callback, and it
1160	will automatically C<stop_read> for you when neither C<on_read> is set nor	1882	will automatically C<stop_read> for you when neither C<on_read> is set nor
1161	there are any read requests in the queue.	1883	there are any read requests in the queue.
1162		1884
		1885	In older versions of this module (<= 5.3), these methods had no effect,
		1886	as TLS does not support half-duplex connections. In current versions they
		1887	work as expected, as this behaviour is required to avoid certain resource
		1888	attacks, where the program would be forced to read (and buffer) arbitrary
		1889	amounts of data before being able to send some data. The drawback is that
		1890	some readings of the the SSL/TLS specifications basically require this
		1891	attack to be working, as SSL/TLS implementations might stall sending data
		1892	during a rehandshake.
		1893
		1894	As a guideline, during the initial handshake, you should not stop reading,
		1895	and as a client, it might cause problems, depending on your application.
		1896
1163	=cut	1897	=cut
1164		1898
1165	sub stop_read {	1899	sub stop_read {
1166	my ($self) = @_;	1900	my ($self) = @_;
1167		1901
…		…
1169	}	1903	}
1170		1904
1171	sub start_read {	1905	sub start_read {
1172	my ($self) = @_;	1906	my ($self) = @_;
1173		1907
1174	unless ($self->{_rw} || $self->{_eof}) {	1908	unless ($self->{_rw} || $self->{_eof} || !$self->{fh}) {
1175	Scalar::Util::weaken $self;	1909	Scalar::Util::weaken $self;
1176		1910
1177	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1911	$self->{_rw} = AE::io $self->{fh}, 0, sub {
1178	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1912	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1179	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf;	1913	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size}, length $$rbuf;
1180		1914
1181	if ($len > 0) {	1915	if ($len > 0) {
1182	$self->{_activity} = AnyEvent->now;	1916	$self->{_activity} = $self->{_ractivity} = AE::now;
1183		1917
1184	$self->{filter_r}	1918	if ($self->{tls}) {
1185	? $self->{filter_r}($self, $rbuf)	1919	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1186	: $self->{_in_drain} || $self->_drain_rbuf;	1920
		1921	&_dotls ($self);
		1922	} else {
		1923	$self->_drain_rbuf;
		1924	}
		1925
		1926	if ($len == $self->{read_size}) {
		1927	$self->{read_size} *= 2;
		1928	$self->{read_size} = $self->{max_read_size} || MAX_READ_SIZE
		1929	if $self->{read_size} > ($self->{max_read_size} || MAX_READ_SIZE);
		1930	}
1187		1931
1188	} elsif (defined $len) {	1932	} elsif (defined $len) {
1189	delete $self->{_rw};	1933	delete $self->{_rw};
1190	$self->{_eof} = 1;	1934	$self->{_eof} = 1;
1191	$self->_drain_rbuf unless $self->{_in_drain};	1935	$self->_drain_rbuf;
1192		1936
1193	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1937	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1194	return $self->_error ($!, 1);	1938	return $self->_error ($!, 1);
1195	}	1939	}
1196	});	1940	};
1197	}	1941	}
1198	}	1942	}
1199		1943
		1944	our $ERROR_SYSCALL;
		1945	our $ERROR_WANT_READ;
		1946
		1947	sub _tls_error {
		1948	my ($self, $err) = @_;
		1949
		1950	return $self->_error ($!, 1)
		1951	if $err == Net::SSLeay::ERROR_SYSCALL ();
		1952
		1953	my $err = Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());
		1954
		1955	# reduce error string to look less scary
		1956	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;
		1957
		1958	if ($self->{_on_starttls}) {
		1959	(delete $self->{_on_starttls})->($self, undef, $err);
		1960	&_freetls;
		1961	} else {
		1962	&_freetls;
		1963	$self->_error (Errno::EPROTO, 1, $err);
		1964	}
		1965	}
		1966
		1967	# poll the write BIO and send the data if applicable
		1968	# also decode read data if possible
		1969	# this is basiclaly our TLS state machine
		1970	# more efficient implementations are possible with openssl,
		1971	# but not with the buggy and incomplete Net::SSLeay.
1200	sub _dotls {	1972	sub _dotls {
1201	my ($self) = @_;	1973	my ($self) = @_;
1202		1974
1203	my $buf;	1975	my $tmp;
1204		1976
1205	if (length $self->{_tls_wbuf}) {	1977	if (length $self->{_tls_wbuf}) {
1206	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1978	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1207	substr $self->{_tls_wbuf}, 0, $len, "";	1979	substr $self->{_tls_wbuf}, 0, $tmp, "";
1208	}	1980	}
1209	}
1210		1981
		1982	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);
		1983	return $self->_tls_error ($tmp)
		1984	if $tmp != $ERROR_WANT_READ
		1985	&& ($tmp != $ERROR_SYSCALL || $!);
		1986	}
		1987
		1988	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
		1989	unless (length $tmp) {
		1990	$self->{_on_starttls}
		1991	and (delete $self->{_on_starttls})->($self, undef, "EOF during handshake"); # ???
		1992	&_freetls;
		1993
		1994	if ($self->{on_stoptls}) {
		1995	$self->{on_stoptls}($self);
		1996	return;
		1997	} else {
		1998	# let's treat SSL-eof as we treat normal EOF
		1999	delete $self->{_rw};
		2000	$self->{_eof} = 1;
		2001	}
		2002	}
		2003
		2004	$self->{_tls_rbuf} .= $tmp;
		2005	$self->_drain_rbuf;
		2006	$self->{tls} or return; # tls session might have gone away in callback
		2007	}
		2008
		2009	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
		2010	return $self->_tls_error ($tmp)
		2011	if $tmp != $ERROR_WANT_READ
		2012	&& ($tmp != $ERROR_SYSCALL || $!);
		2013
1211	if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {	2014	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1212	$self->{wbuf} .= $buf;	2015	$self->{wbuf} .= $tmp;
1213	$self->_drain_wbuf;	2016	$self->_drain_wbuf;
		2017	$self->{tls} or return; # tls session might have gone away in callback
1214	}	2018	}
1215		2019
1216	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {	2020	$self->{_on_starttls}
1217	if (length $buf) {	2021	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
1218	$self->{rbuf} .= $buf;	2022	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");
1219	$self->_drain_rbuf unless $self->{_in_drain};
1220	} else {
1221	# let's treat SSL-eof as we treat normal EOF
1222	$self->{_eof} = 1;
1223	$self->_shutdown;
1224	return;
1225	}
1226	}
1227
1228	my $err = Net::SSLeay::get_error ($self->{tls}, -1);
1229
1230	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
1231	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {
1232	return $self->_error ($!, 1);
1233	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {
1234	return $self->_error (&Errno::EIO, 1);
1235	}
1236
1237	# all others are fine for our purposes
1238	}
1239	}	2023	}
1240		2024
1241	=item $handle->starttls ($tls[, $tls_ctx])	2025	=item $handle->starttls ($tls[, $tls_ctx])
1242		2026
1243	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	2027	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
1244	object is created, you can also do that at a later time by calling	2028	object is created, you can also do that at a later time by calling
1245	C<starttls>.	2029	C<starttls>. See the C<tls> constructor argument for general info.
		2030
		2031	Starting TLS is currently an asynchronous operation - when you push some
		2032	write data and then call C<< ->starttls >> then TLS negotiation will start
		2033	immediately, after which the queued write data is then sent. This might
		2034	change in future versions, so best make sure you have no outstanding write
		2035	data when calling this method.
1246		2036
1247	The first argument is the same as the C<tls> constructor argument (either	2037	The first argument is the same as the C<tls> constructor argument (either
1248	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	2038	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1249		2039
1250	The second argument is the optional C<Net::SSLeay::CTX> object that is	2040	The second argument is the optional C<AnyEvent::TLS> object that is used
1251	used when AnyEvent::Handle has to create its own TLS connection object.	2041	when AnyEvent::Handle has to create its own TLS connection object, or
		2042	a hash reference with C<< key => value >> pairs that will be used to
		2043	construct a new context.
1252		2044
1253	The TLS connection object will end up in C<< $handle->{tls} >> after this	2045	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS
1254	call and can be used or changed to your liking. Note that the handshake	2046	context in C<< $handle->{tls_ctx} >> after this call and can be used or
1255	might have already started when this function returns.	2047	changed to your liking. Note that the handshake might have already started
		2048	when this function returns.
1256		2049
		2050	Due to bugs in OpenSSL, it might or might not be possible to do multiple
		2051	handshakes on the same stream. It is best to not attempt to use the
		2052	stream after stopping TLS.
		2053
		2054	This method may invoke callbacks (and therefore the handle might be
		2055	destroyed after it returns).
		2056
1257	=cut	2057	=cut
		2058
		2059	our %TLS_CACHE; #TODO not yet documented, should we?
1258		2060
1259	sub starttls {	2061	sub starttls {
1260	my ($self, $ssl, $ctx) = @_;	2062	my ($self, $tls, $ctx) = @_;
1261		2063
1262	$self->stoptls;	2064	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"
		2065	if $self->{tls};
1263		2066
1264	if ($ssl eq "accept") {	2067	unless (defined $AnyEvent::TLS::VERSION) {
1265	$ssl = Net::SSLeay::new ($ctx || TLS_CTX ());	2068	eval {
1266	Net::SSLeay::set_accept_state ($ssl);	2069	require Net::SSLeay;
1267	} elsif ($ssl eq "connect") {	2070	require AnyEvent::TLS;
1268	$ssl = Net::SSLeay::new ($ctx || TLS_CTX ());	2071	1
1269	Net::SSLeay::set_connect_state ($ssl);	2072	} or return $self->_error (Errno::EPROTO, 1, "TLS support not available on this system");
		2073	}
		2074
		2075	$self->{tls} = $tls;
		2076	$self->{tls_ctx} = $ctx if @_ > 2;
		2077
		2078	return unless $self->{fh};
		2079
		2080	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
		2081	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
		2082
		2083	$tls = delete $self->{tls};
		2084	$ctx = $self->{tls_ctx};
		2085
		2086	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
		2087
		2088	if ("HASH" eq ref $ctx) {
		2089	if ($ctx->{cache}) {
		2090	my $key = $ctx+0;
		2091	$ctx = $TLS_CACHE{$key} ||= new AnyEvent::TLS %$ctx;
		2092	} else {
		2093	$ctx = new AnyEvent::TLS %$ctx;
		2094	}
		2095	}
1270	}	2096
1271		2097	$self->{tls_ctx} = $ctx || TLS_CTX ();
1272	$self->{tls} = $ssl;	2098	$self->{tls} = $tls = $self->{tls_ctx}->_get_session ($tls, $self, $self->{peername});
1273		2099
1274	# basically, this is deep magic (because SSL_read should have the same issues)	2100	# basically, this is deep magic (because SSL_read should have the same issues)
1275	# but the openssl maintainers basically said: "trust us, it just works".	2101	# but the openssl maintainers basically said: "trust us, it just works".
1276	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	2102	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1277	# and mismaintained ssleay-module doesn't even offer them).	2103	# and mismaintained ssleay-module doesn't even offer them).
1278	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html	2104	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
		2105	#
		2106	# in short: this is a mess.
		2107	#
		2108	# note that we do not try to keep the length constant between writes as we are required to do.
		2109	# we assume that most (but not all) of this insanity only applies to non-blocking cases,
		2110	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
		2111	# have identity issues in that area.
1279	Net::SSLeay::CTX_set_mode ($self->{tls},	2112	# Net::SSLeay::CTX_set_mode ($ssl,
1280	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)	2113	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)
1281	| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));	2114	# | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));
		2115	Net::SSLeay::CTX_set_mode ($tls, 1|2);
1282		2116
1283	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	2117	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1284	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	2118	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1285		2119
		2120	Net::SSLeay::BIO_write ($self->{_rbio}, $self->{rbuf});
		2121	$self->{rbuf} = "";
		2122
1286	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	2123	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
1287		2124
1288	$self->{filter_w} = sub {	2125	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1289	$_[0]{_tls_wbuf} .= ${$_[1]};	2126	if $self->{on_starttls};
1290	&_dotls;	2127
1291	};	2128	&_dotls; # need to trigger the initial handshake
1292	$self->{filter_r} = sub {	2129	$self->start_read; # make sure we actually do read
1293	Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});
1294	&_dotls;
1295	};
1296	}	2130	}
1297		2131
1298	=item $handle->stoptls	2132	=item $handle->stoptls
1299		2133
1300	Destroys the SSL connection, if any. Partial read or write data will be	2134	Shuts down the SSL connection - this makes a proper EOF handshake by
1301	lost.	2135	sending a close notify to the other side, but since OpenSSL doesn't
		2136	support non-blocking shut downs, it is not guaranteed that you can re-use
		2137	the stream afterwards.
		2138
		2139	This method may invoke callbacks (and therefore the handle might be
		2140	destroyed after it returns).
1302		2141
1303	=cut	2142	=cut
1304		2143
1305	sub stoptls {	2144	sub stoptls {
1306	my ($self) = @_;	2145	my ($self) = @_;
1307		2146
1308	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};	2147	if ($self->{tls} && $self->{fh}) {
		2148	Net::SSLeay::shutdown ($self->{tls});
1309		2149
1310	delete $self->{_rbio};	2150	&_dotls;
1311	delete $self->{_wbio};	2151
1312	delete $self->{_tls_wbuf};	2152	# # we don't give a shit. no, we do, but we can't. no...#d#
1313	delete $self->{filter_r};	2153	# # we, we... have to use openssl :/#d#
1314	delete $self->{filter_w};	2154	# &_freetls;#d#
		2155	}
1315	}	2156	}
		2157
		2158	sub _freetls {
		2159	my ($self) = @_;
		2160
		2161	return unless $self->{tls};
		2162
		2163	$self->{tls_ctx}->_put_session (delete $self->{tls})
		2164	if $self->{tls} > 0;
		2165
		2166	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
		2167	}
		2168
		2169	=item $handle->resettls
		2170
		2171	This rarely-used method simply resets and TLS state on the handle, usually
		2172	causing data loss.
		2173
		2174	One case where it may be useful is when you want to skip over the data in
		2175	the stream but you are not interested in interpreting it, so data loss is
		2176	no concern.
		2177
		2178	=cut
		2179
		2180	*resettls = \&_freetls;
1316		2181
1317	sub DESTROY {	2182	sub DESTROY {
1318	my $self = shift;	2183	my ($self) = @_;
1319		2184
1320	$self->stoptls;	2185	&_freetls;
1321		2186
1322	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	2187	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1323		2188
1324	if ($linger && length $self->{wbuf}) {	2189	if ($linger && length $self->{wbuf} && $self->{fh}) {
1325	my $fh = delete $self->{fh};	2190	my $fh = delete $self->{fh};
1326	my $wbuf = delete $self->{wbuf};	2191	my $wbuf = delete $self->{wbuf};
1327		2192
1328	my @linger;	2193	my @linger;
1329		2194
1330	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {	2195	push @linger, AE::io $fh, 1, sub {
1331	my $len = syswrite $fh, $wbuf, length $wbuf;	2196	my $len = syswrite $fh, $wbuf, length $wbuf;
1332		2197
1333	if ($len > 0) {	2198	if ($len > 0) {
1334	substr $wbuf, 0, $len, "";	2199	substr $wbuf, 0, $len, "";
1335	} else {	2200	} elsif (defined $len || ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK)) {
1336	@linger = (); # end	2201	@linger = (); # end
1337	}	2202	}
		2203	};
		2204	push @linger, AE::timer $linger, 0, sub {
		2205	@linger = ();
		2206	};
		2207	}
		2208	}
		2209
		2210	=item $handle->destroy
		2211
		2212	Shuts down the handle object as much as possible - this call ensures that
		2213	no further callbacks will be invoked and as many resources as possible
		2214	will be freed. Any method you will call on the handle object after
		2215	destroying it in this way will be silently ignored (and it will return the
		2216	empty list).
		2217
		2218	Normally, you can just "forget" any references to an AnyEvent::Handle
		2219	object and it will simply shut down. This works in fatal error and EOF
		2220	callbacks, as well as code outside. It does I<NOT> work in a read or write
		2221	callback, so when you want to destroy the AnyEvent::Handle object from
		2222	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
		2223	that case.
		2224
		2225	Destroying the handle object in this way has the advantage that callbacks
		2226	will be removed as well, so if those are the only reference holders (as
		2227	is common), then one doesn't need to do anything special to break any
		2228	reference cycles.
		2229
		2230	The handle might still linger in the background and write out remaining
		2231	data, as specified by the C<linger> option, however.
		2232
		2233	=cut
		2234
		2235	sub destroy {
		2236	my ($self) = @_;
		2237
		2238	$self->DESTROY;
		2239	%$self = ();
		2240	bless $self, "AnyEvent::Handle::destroyed";
		2241	}
		2242
		2243	sub AnyEvent::Handle::destroyed::AUTOLOAD {
		2244	#nop
		2245	}
		2246
		2247	=item $handle->destroyed
		2248
		2249	Returns false as long as the handle hasn't been destroyed by a call to C<<
		2250	->destroy >>, true otherwise.
		2251
		2252	Can be useful to decide whether the handle is still valid after some
		2253	callback possibly destroyed the handle. For example, C<< ->push_write >>,
		2254	C<< ->starttls >> and other methods can call user callbacks, which in turn
		2255	can destroy the handle, so work can be avoided by checking sometimes:
		2256
		2257	$hdl->starttls ("accept");
		2258	return if $hdl->destroyed;
		2259	$hdl->push_write (...
		2260
		2261	Note that the call to C<push_write> will silently be ignored if the handle
		2262	has been destroyed, so often you can just ignore the possibility of the
		2263	handle being destroyed.
		2264
		2265	=cut
		2266
		2267	sub destroyed { 0 }
		2268	sub AnyEvent::Handle::destroyed::destroyed { 1 }
		2269
		2270	=item AnyEvent::Handle::TLS_CTX
		2271
		2272	This function creates and returns the AnyEvent::TLS object used by default
		2273	for TLS mode.
		2274
		2275	The context is created by calling L<AnyEvent::TLS> without any arguments.
		2276
		2277	=cut
		2278
		2279	our $TLS_CTX;
		2280
		2281	sub TLS_CTX() {
		2282	$TLS_CTX ||= do {
		2283	require AnyEvent::TLS;
		2284
		2285	new AnyEvent::TLS
		2286	}
		2287	}
		2288
		2289	=back
		2290
		2291
		2292	=head1 NONFREQUENTLY ASKED QUESTIONS
		2293
		2294	=over 4
		2295
		2296	=item I C<undef> the AnyEvent::Handle reference inside my callback and
		2297	still get further invocations!
		2298
		2299	That's because AnyEvent::Handle keeps a reference to itself when handling
		2300	read or write callbacks.
		2301
		2302	It is only safe to "forget" the reference inside EOF or error callbacks,
		2303	from within all other callbacks, you need to explicitly call the C<<
		2304	->destroy >> method.
		2305
		2306	=item Why is my C<on_eof> callback never called?
		2307
		2308	Probably because your C<on_error> callback is being called instead: When
		2309	you have outstanding requests in your read queue, then an EOF is
		2310	considered an error as you clearly expected some data.
		2311
		2312	To avoid this, make sure you have an empty read queue whenever your handle
		2313	is supposed to be "idle" (i.e. connection closes are O.K.). You can set
		2314	an C<on_read> handler that simply pushes the first read requests in the
		2315	queue.
		2316
		2317	See also the next question, which explains this in a bit more detail.
		2318
		2319	=item How can I serve requests in a loop?
		2320
		2321	Most protocols consist of some setup phase (authentication for example)
		2322	followed by a request handling phase, where the server waits for requests
		2323	and handles them, in a loop.
		2324
		2325	There are two important variants: The first (traditional, better) variant
		2326	handles requests until the server gets some QUIT command, causing it to
		2327	close the connection first (highly desirable for a busy TCP server). A
		2328	client dropping the connection is an error, which means this variant can
		2329	detect an unexpected detection close.
		2330
		2331	To handle this case, always make sure you have a non-empty read queue, by
		2332	pushing the "read request start" handler on it:
		2333
		2334	# we assume a request starts with a single line
		2335	my @start_request; @start_request = (line => sub {
		2336	my ($hdl, $line) = @_;
		2337
		2338	... handle request
		2339
		2340	# push next request read, possibly from a nested callback
		2341	$hdl->push_read (@start_request);
		2342	});
		2343
		2344	# auth done, now go into request handling loop
		2345	# now push the first @start_request
		2346	$hdl->push_read (@start_request);
		2347
		2348	By always having an outstanding C<push_read>, the handle always expects
		2349	some data and raises the C<EPIPE> error when the connction is dropped
		2350	unexpectedly.
		2351
		2352	The second variant is a protocol where the client can drop the connection
		2353	at any time. For TCP, this means that the server machine may run out of
		2354	sockets easier, and in general, it means you cannot distinguish a protocl
		2355	failure/client crash from a normal connection close. Nevertheless, these
		2356	kinds of protocols are common (and sometimes even the best solution to the
		2357	problem).
		2358
		2359	Having an outstanding read request at all times is possible if you ignore
		2360	C<EPIPE> errors, but this doesn't help with when the client drops the
		2361	connection during a request, which would still be an error.
		2362
		2363	A better solution is to push the initial request read in an C<on_read>
		2364	callback. This avoids an error, as when the server doesn't expect data
		2365	(i.e. is idly waiting for the next request, an EOF will not raise an
		2366	error, but simply result in an C<on_eof> callback. It is also a bit slower
		2367	and simpler:
		2368
		2369	# auth done, now go into request handling loop
		2370	$hdl->on_read (sub {
		2371	my ($hdl) = @_;
		2372
		2373	# called each time we receive data but the read queue is empty
		2374	# simply start read the request
		2375
		2376	$hdl->push_read (line => sub {
		2377	my ($hdl, $line) = @_;
		2378
		2379	... handle request
		2380
		2381	# do nothing special when the request has been handled, just
		2382	# let the request queue go empty.
1338	});	2383	});
1339	push @linger, AnyEvent->timer (after => $linger, cb => sub {
1340	@linger = ();
1341	});	2384	});
		2385
		2386	=item I get different callback invocations in TLS mode/Why can't I pause
		2387	reading?
		2388
		2389	Unlike, say, TCP, TLS connections do not consist of two independent
		2390	communication channels, one for each direction. Or put differently, the
		2391	read and write directions are not independent of each other: you cannot
		2392	write data unless you are also prepared to read, and vice versa.
		2393
		2394	This means that, in TLS mode, you might get C<on_error> or C<on_eof>
		2395	callback invocations when you are not expecting any read data - the reason
		2396	is that AnyEvent::Handle always reads in TLS mode.
		2397
		2398	During the connection, you have to make sure that you always have a
		2399	non-empty read-queue, or an C<on_read> watcher. At the end of the
		2400	connection (or when you no longer want to use it) you can call the
		2401	C<destroy> method.
		2402
		2403	=item How do I read data until the other side closes the connection?
		2404
		2405	If you just want to read your data into a perl scalar, the easiest way
		2406	to achieve this is by setting an C<on_read> callback that does nothing,
		2407	clearing the C<on_eof> callback and in the C<on_error> callback, the data
		2408	will be in C<$_[0]{rbuf}>:
		2409
		2410	$handle->on_read (sub { });
		2411	$handle->on_eof (undef);
		2412	$handle->on_error (sub {
		2413	my $data = delete $_[0]{rbuf};
		2414	});
		2415
		2416	Note that this example removes the C<rbuf> member from the handle object,
		2417	which is not normally allowed by the API. It is expressly permitted in
		2418	this case only, as the handle object needs to be destroyed afterwards.
		2419
		2420	The reason to use C<on_error> is that TCP connections, due to latencies
		2421	and packets loss, might get closed quite violently with an error, when in
		2422	fact all data has been received.
		2423
		2424	It is usually better to use acknowledgements when transferring data,
		2425	to make sure the other side hasn't just died and you got the data
		2426	intact. This is also one reason why so many internet protocols have an
		2427	explicit QUIT command.
		2428
		2429	=item I don't want to destroy the handle too early - how do I wait until
		2430	all data has been written?
		2431
		2432	After writing your last bits of data, set the C<on_drain> callback
		2433	and destroy the handle in there - with the default setting of
		2434	C<low_water_mark> this will be called precisely when all data has been
		2435	written to the socket:
		2436
		2437	$handle->push_write (...);
		2438	$handle->on_drain (sub {
		2439	AE::log debug => "All data submitted to the kernel.";
		2440	undef $handle;
		2441	});
		2442
		2443	If you just want to queue some data and then signal EOF to the other side,
		2444	consider using C<< ->push_shutdown >> instead.
		2445
		2446	=item I want to contact a TLS/SSL server, I don't care about security.
		2447
		2448	If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS,
		2449	connect to it and then create the AnyEvent::Handle with the C<tls>
		2450	parameter:
		2451
		2452	tcp_connect $host, $port, sub {
		2453	my ($fh) = @_;
		2454
		2455	my $handle = new AnyEvent::Handle
		2456	fh => $fh,
		2457	tls => "connect",
		2458	on_error => sub { ... };
		2459
		2460	$handle->push_write (...);
1342	}	2461	};
1343	}
1344		2462
1345	=item AnyEvent::Handle::TLS_CTX	2463	=item I want to contact a TLS/SSL server, I do care about security.
1346		2464
1347	This function creates and returns the Net::SSLeay::CTX object used by	2465	Then you should additionally enable certificate verification, including
1348	default for TLS mode.	2466	peername verification, if the protocol you use supports it (see
		2467	L<AnyEvent::TLS>, C<verify_peername>).
1349		2468
1350	The context is created like this:	2469	E.g. for HTTPS:
1351		2470
1352	Net::SSLeay::load_error_strings;	2471	tcp_connect $host, $port, sub {
1353	Net::SSLeay::SSLeay_add_ssl_algorithms;	2472	my ($fh) = @_;
1354	Net::SSLeay::randomize;
1355		2473
1356	my $CTX = Net::SSLeay::CTX_new;	2474	my $handle = new AnyEvent::Handle
		2475	fh => $fh,
		2476	peername => $host,
		2477	tls => "connect",
		2478	tls_ctx => { verify => 1, verify_peername => "https" },
		2479	...
1357		2480
1358	Net::SSLeay::CTX_set_options $CTX, Net::SSLeay::OP_ALL	2481	Note that you must specify the hostname you connected to (or whatever
		2482	"peername" the protocol needs) as the C<peername> argument, otherwise no
		2483	peername verification will be done.
1359		2484
1360	=cut	2485	The above will use the system-dependent default set of trusted CA
		2486	certificates. If you want to check against a specific CA, add the
		2487	C<ca_file> (or C<ca_cert>) arguments to C<tls_ctx>:
1361		2488
1362	our $TLS_CTX;	2489	tls_ctx => {
		2490	verify => 1,
		2491	verify_peername => "https",
		2492	ca_file => "my-ca-cert.pem",
		2493	},
1363		2494
1364	sub TLS_CTX() {	2495	=item I want to create a TLS/SSL server, how do I do that?
1365	$TLS_CTX || do {
1366	require Net::SSLeay;
1367		2496
1368	Net::SSLeay::load_error_strings ();	2497	Well, you first need to get a server certificate and key. You have
1369	Net::SSLeay::SSLeay_add_ssl_algorithms ();	2498	three options: a) ask a CA (buy one, use cacert.org etc.) b) create a
1370	Net::SSLeay::randomize ();	2499	self-signed certificate (cheap. check the search engine of your choice,
		2500	there are many tutorials on the net) or c) make your own CA (tinyca2 is a
		2501	nice program for that purpose).
1371		2502
1372	$TLS_CTX = Net::SSLeay::CTX_new ();	2503	Then create a file with your private key (in PEM format, see
		2504	L<AnyEvent::TLS>), followed by the certificate (also in PEM format). The
		2505	file should then look like this:
1373		2506
1374	Net::SSLeay::CTX_set_options ($TLS_CTX, Net::SSLeay::OP_ALL ());	2507	-----BEGIN RSA PRIVATE KEY-----
		2508	...header data
		2509	... lots of base64'y-stuff
		2510	-----END RSA PRIVATE KEY-----
1375		2511
1376	$TLS_CTX	2512	-----BEGIN CERTIFICATE-----
1377	}	2513	... lots of base64'y-stuff
1378	}	2514	-----END CERTIFICATE-----
		2515
		2516	The important bits are the "PRIVATE KEY" and "CERTIFICATE" parts. Then
		2517	specify this file as C<cert_file>:
		2518
		2519	tcp_server undef, $port, sub {
		2520	my ($fh) = @_;
		2521
		2522	my $handle = new AnyEvent::Handle
		2523	fh => $fh,
		2524	tls => "accept",
		2525	tls_ctx => { cert_file => "my-server-keycert.pem" },
		2526	...
		2527
		2528	When you have intermediate CA certificates that your clients might not
		2529	know about, just append them to the C<cert_file>.
1379		2530
1380	=back	2531	=back
1381		2532
1382	=head1 SUBCLASSING AnyEvent::Handle	2533	=head1 SUBCLASSING AnyEvent::Handle
1383		2534
…		…
1389	=over 4	2540	=over 4
1390		2541
1391	=item * all constructor arguments become object members.	2542	=item * all constructor arguments become object members.
1392		2543
1393	At least initially, when you pass a C<tls>-argument to the constructor it	2544	At least initially, when you pass a C<tls>-argument to the constructor it
1394	will end up in C<< $handle->{tls} >>. Those members might be changes or	2545	will end up in C<< $handle->{tls} >>. Those members might be changed or
1395	mutated later on (for example C<tls> will hold the TLS connection object).	2546	mutated later on (for example C<tls> will hold the TLS connection object).
1396		2547
1397	=item * other object member names are prefixed with an C<_>.	2548	=item * other object member names are prefixed with an C<_>.
1398		2549
1399	All object members not explicitly documented (internal use) are prefixed	2550	All object members not explicitly documented (internal use) are prefixed
…		…
1402		2553
1403	=item * all members not documented here and not prefixed with an underscore	2554	=item * all members not documented here and not prefixed with an underscore
1404	are free to use in subclasses.	2555	are free to use in subclasses.
1405		2556
1406	Of course, new versions of AnyEvent::Handle may introduce more "public"	2557	Of course, new versions of AnyEvent::Handle may introduce more "public"
1407	member variables, but thats just life, at least it is documented.	2558	member variables, but that's just life. At least it is documented.
1408		2559
1409	=back	2560	=back
1410		2561
1411	=head1 AUTHOR	2562	=head1 AUTHOR
1412		2563
1413	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.	2564	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.
1414		2565
1415	=cut	2566	=cut
1416		2567
1417	1; # End of AnyEvent::Handle	2568	1
		2569

Diff Legend

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