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.96 by root, Thu Oct 2 08:10:27 2008 UTC vs.
Revision 1.200 by root, Tue Oct 12 06:47:54 2010 UTC

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

Diff Legend

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