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

Diff Legend

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