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.56 by root, Wed Jun 4 09:55:16 2008 UTC vs.
Revision 1.221 by root, Thu Aug 4 09:35:37 2011 UTC

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

Diff Legend

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