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

Diff Legend

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