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.159 by root, Fri Jul 24 12:35:58 2009 UTC vs.
Revision 1.240 by root, Tue Dec 17 16:43:15 2013 UTC

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

Diff Legend

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