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.149 by root, Thu Jul 16 03:48:33 2009 UTC vs.
Revision 1.233 by root, Thu Apr 5 06:14:10 2012 UTC

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

Diff Legend

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