ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/AnyEvent/lib/AnyEvent/Handle.pm

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.144 by root, Mon Jul 6 21:38:25 2009 UTC vs.
Revision 1.245 by root, Tue Jun 16 03:22:20 2015 UTC

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

Diff Legend

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