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.59 by root, Thu Jun 5 16:53:11 2008 UTC vs.
Revision 1.198 by root, Tue Aug 31 01:03:37 2010 UTC

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

Diff Legend

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