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

Diff Legend

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