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.66 by root, Fri Jun 6 15:32:54 2008 UTC vs.
Revision 1.233 by root, Thu Apr 5 06:14:10 2012 UTC

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

Diff Legend

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