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.117 by root, Tue Feb 10 14:22:59 2009 UTC vs.
Revision 1.233 by root, Thu Apr 5 06:14:10 2012 UTC

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

Diff Legend

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