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

Diff Legend

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