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

Diff Legend

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