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.56 by root, Wed Jun 4 09:55:16 2008 UTC vs.
Revision 1.237 by root, Tue Jul 30 23:14:32 2013 UTC

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

Diff Legend

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