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.111 by root, Wed Jan 21 06:01:29 2009 UTC vs.
Revision 1.176 by root, Sun Aug 9 00:20:35 2009 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 file handles via AnyEvent
16		4
17	=cut	5	=cut
18		6
19	our $VERSION = 4.331;	7	our $VERSION = 4.92;
20		8
21	=head1 SYNOPSIS	9	=head1 SYNOPSIS
22		10
23	use AnyEvent;	11	use AnyEvent;
24	use AnyEvent::Handle;	12	use AnyEvent::Handle;
25		13
26	my $cv = AnyEvent->condvar;	14	my $cv = AnyEvent->condvar;
27		15
28	my $handle =	16	my $hdl; $hdl = new AnyEvent::Handle
29	AnyEvent::Handle->new (
30	fh => \*STDIN,	17	fh => \*STDIN,
31	on_eof => sub {	18	on_error => sub {
		19	my ($hdl, $fatal, $msg) = @_;
		20	warn "got error $msg\n";
		21	$hdl->destroy;
32	$cv->send;	22	$cv->send;
33	},
34	);	23	);
35		24
36	# send some request line	25	# send some request line
37	$handle->push_write ("getinfo\015\012");	26	$hdl->push_write ("getinfo\015\012");
38		27
39	# read the response line	28	# read the response line
40	$handle->push_read (line => sub {	29	$hdl->push_read (line => sub {
41	my ($handle, $line) = @_;	30	my ($hdl, $line) = @_;
42	warn "read line <$line>\n";	31	warn "got line <$line>\n";
43	$cv->send;	32	$cv->send;
44	});	33	});
45		34
46	$cv->recv;	35	$cv->recv;
47		36
48	=head1 DESCRIPTION	37	=head1 DESCRIPTION
49		38
50	This module is a helper module to make it easier to do event-based I/O on	39	This module is a helper module to make it easier to do event-based I/O on
51	filehandles. For utility functions for doing non-blocking connects and accepts	40	filehandles.
52	on sockets see L<AnyEvent::Util>.
53		41
54	The L<AnyEvent::Intro> tutorial contains some well-documented	42	The L<AnyEvent::Intro> tutorial contains some well-documented
55	AnyEvent::Handle examples.	43	AnyEvent::Handle examples.
56		44
57	In the following, when the documentation refers to of "bytes" then this	45	In the following, when the documentation refers to of "bytes" then this
58	means characters. As sysread and syswrite are used for all I/O, their	46	means characters. As sysread and syswrite are used for all I/O, their
59	treatment of characters applies to this module as well.	47	treatment of characters applies to this module as well.
60		48
		49	At the very minimum, you should specify C<fh> or C<connect>, and the
		50	C<on_error> callback.
		51
61	All callbacks will be invoked with the handle object as their first	52	All callbacks will be invoked with the handle object as their first
62	argument.	53	argument.
63		54
		55	=cut
		56
		57	package AnyEvent::Handle;
		58
		59	use Scalar::Util ();
		60	use List::Util ();
		61	use Carp ();
		62	use Errno qw(EAGAIN EINTR);
		63
		64	use AnyEvent (); BEGIN { AnyEvent::common_sense }
		65	use AnyEvent::Util qw(WSAEWOULDBLOCK);
		66
64	=head1 METHODS	67	=head1 METHODS
65		68
66	=over 4	69	=over 4
67		70
68	=item B<new (%args)>	71	=item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value...
69		72
70	The constructor supports these arguments (all as key => value pairs).	73	The constructor supports these arguments (all as C<< key => value >> pairs).
71		74
72	=over 4	75	=over 4
73		76
74	=item fh => $filehandle [MANDATORY]	77	=item fh => $filehandle [C<fh> or C<connect> MANDATORY]
75		78
76	The filehandle this L<AnyEvent::Handle> object will operate on.	79	The filehandle this L<AnyEvent::Handle> object will operate on.
77
78	NOTE: The filehandle will be set to non-blocking mode (using	80	NOTE: The filehandle will be set to non-blocking mode (using
79	C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in	81	C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in
80	that mode.	82	that mode.
81		83
		84	=item connect => [$host, $service] [C<fh> or C<connect> MANDATORY]
		85
		86	Try to connect to the specified host and service (port), using
		87	C<AnyEvent::Socket::tcp_connect>. The C<$host> additionally becomes the
		88	default C<peername>.
		89
		90	You have to specify either this parameter, or C<fh>, above.
		91
		92	It is possible to push requests on the read and write queues, and modify
		93	properties of the stream, even while AnyEvent::Handle is connecting.
		94
		95	When this parameter is specified, then the C<on_prepare>,
		96	C<on_connect_error> and C<on_connect> callbacks will be called under the
		97	appropriate circumstances:
		98
		99	=over 4
		100
		101	=item on_prepare => $cb->($handle)
		102
		103	This (rarely used) callback is called before a new connection is
		104	attempted, but after the file handle has been created. It could be used to
		105	prepare the file handle with parameters required for the actual connect
		106	(as opposed to settings that can be changed when the connection is already
		107	established).
		108
		109	The return value of this callback should be the connect timeout value in
		110	seconds (or C<0>, or C<undef>, or the empty list, to indicate the default
		111	timeout is to be used).
		112
		113	=item on_connect => $cb->($handle, $host, $port, $retry->())
		114
		115	This callback is called when a connection has been successfully established.
		116
		117	The actual numeric host and port (the socket peername) are passed as
		118	parameters, together with a retry callback.
		119
		120	When, for some reason, the handle is not acceptable, then calling
		121	C<$retry> will continue with the next conenction target (in case of
		122	multi-homed hosts or SRV records there can be multiple connection
		123	endpoints). When it is called then the read and write queues, eof status,
		124	tls status and similar properties of the handle are being reset.
		125
		126	In most cases, ignoring the C<$retry> parameter is the way to go.
		127
		128	=item on_connect_error => $cb->($handle, $message)
		129
		130	This callback is called when the conenction could not be
		131	established. C<$!> will contain the relevant error code, and C<$message> a
		132	message describing it (usually the same as C<"$!">).
		133
		134	If this callback isn't specified, then C<on_error> will be called with a
		135	fatal error instead.
		136
		137	=back
		138
		139	=item on_error => $cb->($handle, $fatal, $message)
		140
		141	This is the error callback, which is called when, well, some error
		142	occured, such as not being able to resolve the hostname, failure to
		143	connect or a read error.
		144
		145	Some errors are fatal (which is indicated by C<$fatal> being true). On
		146	fatal errors the handle object will be destroyed (by a call to C<< ->
		147	destroy >>) after invoking the error callback (which means you are free to
		148	examine the handle object). Examples of fatal errors are an EOF condition
		149	with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors. In
		150	cases where the other side can close the connection at their will it is
		151	often easiest to not report C<EPIPE> errors in this callback.
		152
		153	AnyEvent::Handle tries to find an appropriate error code for you to check
		154	against, but in some cases (TLS errors), this does not work well. It is
		155	recommended to always output the C<$message> argument in human-readable
		156	error messages (it's usually the same as C<"$!">).
		157
		158	Non-fatal errors can be retried by simply returning, but it is recommended
		159	to simply ignore this parameter and instead abondon the handle object
		160	when this callback is invoked. Examples of non-fatal errors are timeouts
		161	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
		162
		163	On callback entrance, the value of C<$!> contains the operating system
		164	error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
		165	C<EPROTO>).
		166
		167	While not mandatory, it is I<highly> recommended to set this callback, as
		168	you will not be notified of errors otherwise. The default simply calls
		169	C<croak>.
		170
		171	=item on_read => $cb->($handle)
		172
		173	This sets the default read callback, which is called when data arrives
		174	and no read request is in the queue (unlike read queue callbacks, this
		175	callback will only be called when at least one octet of data is in the
		176	read buffer).
		177
		178	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
		179	method or access the C<< $handle->{rbuf} >> member directly. Note that you
		180	must not enlarge or modify the read buffer, you can only remove data at
		181	the beginning from it.
		182
		183	When an EOF condition is detected then AnyEvent::Handle will first try to
		184	feed all the remaining data to the queued callbacks and C<on_read> before
		185	calling the C<on_eof> callback. If no progress can be made, then a fatal
		186	error will be raised (with C<$!> set to C<EPIPE>).
		187
		188	Note that, unlike requests in the read queue, an C<on_read> callback
		189	doesn't mean you I<require> some data: if there is an EOF and there
		190	are outstanding read requests then an error will be flagged. With an
		191	C<on_read> callback, the C<on_eof> callback will be invoked.
		192
82	=item on_eof => $cb->($handle)	193	=item on_eof => $cb->($handle)
83		194
84	Set the callback to be called when an end-of-file condition is detected,	195	Set the callback to be called when an end-of-file condition is detected,
85	i.e. in the case of a socket, when the other side has closed the	196	i.e. in the case of a socket, when the other side has closed the
86	connection cleanly.	197	connection cleanly, and there are no outstanding read requests in the
		198	queue (if there are read requests, then an EOF counts as an unexpected
		199	connection close and will be flagged as an error).
87		200
88	For sockets, this just means that the other side has stopped sending data,	201	For sockets, this just means that the other side has stopped sending data,
89	you can still try to write data, and, in fact, one can return from the EOF	202	you can still try to write data, and, in fact, one can return from the EOF
90	callback and continue writing data, as only the read part has been shut	203	callback and continue writing data, as only the read part has been shut
91	down.	204	down.
92		205
93	While not mandatory, it is I<highly> recommended to set an EOF callback,
94	otherwise you might end up with a closed socket while you are still
95	waiting for data.
96
97	If an EOF condition has been detected but no C<on_eof> callback has been	206	If an EOF condition has been detected but no C<on_eof> callback has been
98	set, then a fatal error will be raised with C<$!> set to <0>.	207	set, then a fatal error will be raised with C<$!> set to <0>.
99
100	=item on_error => $cb->($handle, $fatal)
101
102	This is the error callback, which is called when, well, some error
103	occured, such as not being able to resolve the hostname, failure to
104	connect or a read error.
105
106	Some errors are fatal (which is indicated by C<$fatal> being true). On
107	fatal errors the handle object will be shut down and will not be usable
108	(but you are free to look at the current C<< ->rbuf >>). Examples of fatal
109	errors are an EOF condition with active (but unsatisifable) read watchers
110	(C<EPIPE>) or I/O errors.
111
112	Non-fatal errors can be retried by simply returning, but it is recommended
113	to simply ignore this parameter and instead abondon the handle object
114	when this callback is invoked. Examples of non-fatal errors are timeouts
115	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
116
117	On callback entrance, the value of C<$!> contains the operating system
118	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).
119
120	While not mandatory, it is I<highly> recommended to set this callback, as
121	you will not be notified of errors otherwise. The default simply calls
122	C<croak>.
123
124	=item on_read => $cb->($handle)
125
126	This sets the default read callback, which is called when data arrives
127	and no read request is in the queue (unlike read queue callbacks, this
128	callback will only be called when at least one octet of data is in the
129	read buffer).
130
131	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
132	method or access the C<$handle->{rbuf}> member directly.
133
134	When an EOF condition is detected then AnyEvent::Handle will first try to
135	feed all the remaining data to the queued callbacks and C<on_read> before
136	calling the C<on_eof> callback. If no progress can be made, then a fatal
137	error will be raised (with C<$!> set to C<EPIPE>).
138		208
139	=item on_drain => $cb->($handle)	209	=item on_drain => $cb->($handle)
140		210
141	This sets the callback that is called when the write buffer becomes empty	211	This sets the callback that is called when the write buffer becomes empty
142	(or when the callback is set and the buffer is empty already).	212	(or when the callback is set and the buffer is empty already).
…		…
149	memory and push it into the queue, but instead only read more data from	219	memory and push it into the queue, but instead only read more data from
150	the file when the write queue becomes empty.	220	the file when the write queue becomes empty.
151		221
152	=item timeout => $fractional_seconds	222	=item timeout => $fractional_seconds
153		223
		224	=item rtimeout => $fractional_seconds
		225
		226	=item wtimeout => $fractional_seconds
		227
154	If non-zero, then this enables an "inactivity" timeout: whenever this many	228	If non-zero, then these enables an "inactivity" timeout: whenever this
155	seconds pass without a successful read or write on the underlying file	229	many seconds pass without a successful read or write on the underlying
156	handle, the C<on_timeout> callback will be invoked (and if that one is	230	file handle (or a call to C<timeout_reset>), the C<on_timeout> callback
157	missing, a non-fatal C<ETIMEDOUT> error will be raised).	231	will be invoked (and if that one is missing, a non-fatal C<ETIMEDOUT>
		232	error will be raised).
		233
		234	There are three variants of the timeouts that work fully independent
		235	of each other, for both read and write, just read, and just write:
		236	C<timeout>, C<rtimeout> and C<wtimeout>, with corresponding callbacks
		237	C<on_timeout>, C<on_rtimeout> and C<on_wtimeout>, and reset functions
		238	C<timeout_reset>, C<rtimeout_reset>, and C<wtimeout_reset>.
158		239
159	Note that timeout processing is also active when you currently do not have	240	Note that timeout processing is also active when you currently do not have
160	any outstanding read or write requests: If you plan to keep the connection	241	any outstanding read or write requests: If you plan to keep the connection
161	idle then you should disable the timout temporarily or ignore the timeout	242	idle then you should disable the timout temporarily or ignore the timeout
162	in the C<on_timeout> callback, in which case AnyEvent::Handle will simply	243	in the C<on_timeout> callback, in which case AnyEvent::Handle will simply
…		…
235		316
236	This will not work for partial TLS data that could not be encoded	317	This will not work for partial TLS data that could not be encoded
237	yet. This data will be lost. Calling the C<stoptls> method in time might	318	yet. This data will be lost. Calling the C<stoptls> method in time might
238	help.	319	help.
239		320
		321	=item peername => $string
		322
		323	A string used to identify the remote site - usually the DNS hostname
		324	(I<not> IDN!) used to create the connection, rarely the IP address.
		325
		326	Apart from being useful in error messages, this string is also used in TLS
		327	peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This
		328	verification will be skipped when C<peername> is not specified or
		329	C<undef>.
		330
240	=item tls => "accept" | "connect" | Net::SSLeay::SSL object	331	=item tls => "accept" | "connect" | Net::SSLeay::SSL object
241		332
242	When this parameter is given, it enables TLS (SSL) mode, that means	333	When this parameter is given, it enables TLS (SSL) mode, that means
243	AnyEvent will start a TLS handshake as soon as the conenction has been	334	AnyEvent will start a TLS handshake as soon as the conenction has been
244	established and will transparently encrypt/decrypt data afterwards.	335	established and will transparently encrypt/decrypt data afterwards.
		336
		337	All TLS protocol errors will be signalled as C<EPROTO>, with an
		338	appropriate error message.
245		339
246	TLS mode requires Net::SSLeay to be installed (it will be loaded	340	TLS mode requires Net::SSLeay to be installed (it will be loaded
247	automatically when you try to create a TLS handle): this module doesn't	341	automatically when you try to create a TLS handle): this module doesn't
248	have a dependency on that module, so if your module requires it, you have	342	have a dependency on that module, so if your module requires it, you have
249	to add the dependency yourself.	343	to add the dependency yourself.
…		…
253	mode.	347	mode.
254		348
255	You can also provide your own TLS connection object, but you have	349	You can also provide your own TLS connection object, but you have
256	to make sure that you call either C<Net::SSLeay::set_connect_state>	350	to make sure that you call either C<Net::SSLeay::set_connect_state>
257	or C<Net::SSLeay::set_accept_state> on it before you pass it to	351	or C<Net::SSLeay::set_accept_state> on it before you pass it to
258	AnyEvent::Handle.	352	AnyEvent::Handle. Also, this module will take ownership of this connection
		353	object.
		354
		355	At some future point, AnyEvent::Handle might switch to another TLS
		356	implementation, then the option to use your own session object will go
		357	away.
259		358
260	B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,	359	B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,
261	passing in the wrong integer will lead to certain crash. This most often	360	passing in the wrong integer will lead to certain crash. This most often
262	happens when one uses a stylish C<< tls => 1 >> and is surprised about the	361	happens when one uses a stylish C<< tls => 1 >> and is surprised about the
263	segmentation fault.	362	segmentation fault.
264		363
265	See the C<< ->starttls >> method for when need to start TLS negotiation later.	364	See the C<< ->starttls >> method for when need to start TLS negotiation later.
266		365
267	=item tls_ctx => $ssl_ctx	366	=item tls_ctx => $anyevent_tls
268		367
269	Use the given C<Net::SSLeay::CTX> object to create the new TLS connection	368	Use the given C<AnyEvent::TLS> object to create the new TLS connection
270	(unless a connection object was specified directly). If this parameter is	369	(unless a connection object was specified directly). If this parameter is
271	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	370	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
		371
		372	Instead of an object, you can also specify a hash reference with C<< key
		373	=> value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a
		374	new TLS context object.
		375
		376	=item on_starttls => $cb->($handle, $success[, $error_message])
		377
		378	This callback will be invoked when the TLS/SSL handshake has finished. If
		379	C<$success> is true, then the TLS handshake succeeded, otherwise it failed
		380	(C<on_stoptls> will not be called in this case).
		381
		382	The session in C<< $handle->{tls} >> can still be examined in this
		383	callback, even when the handshake was not successful.
		384
		385	TLS handshake failures will not cause C<on_error> to be invoked when this
		386	callback is in effect, instead, the error message will be passed to C<on_starttls>.
		387
		388	Without this callback, handshake failures lead to C<on_error> being
		389	called, as normal.
		390
		391	Note that you cannot call C<starttls> right again in this callback. If you
		392	need to do that, start an zero-second timer instead whose callback can
		393	then call C<< ->starttls >> again.
		394
		395	=item on_stoptls => $cb->($handle)
		396
		397	When a SSLv3/TLS shutdown/close notify/EOF is detected and this callback is
		398	set, then it will be invoked after freeing the TLS session. If it is not,
		399	then a TLS shutdown condition will be treated like a normal EOF condition
		400	on the handle.
		401
		402	The session in C<< $handle->{tls} >> can still be examined in this
		403	callback.
		404
		405	This callback will only be called on TLS shutdowns, not when the
		406	underlying handle signals EOF.
272		407
273	=item json => JSON or JSON::XS object	408	=item json => JSON or JSON::XS object
274		409
275	This is the json coder object used by the C<json> read and write types.	410	This is the json coder object used by the C<json> read and write types.
276		411
…		…
285		420
286	=cut	421	=cut
287		422
288	sub new {	423	sub new {
289	my $class = shift;	424	my $class = shift;
290
291	my $self = bless { @_ }, $class;	425	my $self = bless { @_ }, $class;
292		426
293	$self->{fh} or Carp::croak "mandatory argument fh is missing";	427	if ($self->{fh}) {
		428	$self->_start;
		429	return unless $self->{fh}; # could be gone by now
		430
		431	} elsif ($self->{connect}) {
		432	require AnyEvent::Socket;
		433
		434	$self->{peername} = $self->{connect}[0]
		435	unless exists $self->{peername};
		436
		437	$self->{_skip_drain_rbuf} = 1;
		438
		439	{
		440	Scalar::Util::weaken (my $self = $self);
		441
		442	$self->{_connect} =
		443	AnyEvent::Socket::tcp_connect (
		444	$self->{connect}[0],
		445	$self->{connect}[1],
		446	sub {
		447	my ($fh, $host, $port, $retry) = @_;
		448
		449	if ($fh) {
		450	$self->{fh} = $fh;
		451
		452	delete $self->{_skip_drain_rbuf};
		453	$self->_start;
		454
		455	$self->{on_connect}
		456	and $self->{on_connect}($self, $host, $port, sub {
		457	delete @$self{qw(fh _tw _ww _rw _eof _queue rbuf _wbuf tls _tls_rbuf _tls_wbuf)};
		458	$self->{_skip_drain_rbuf} = 1;
		459	&$retry;
		460	});
		461
		462	} else {
		463	if ($self->{on_connect_error}) {
		464	$self->{on_connect_error}($self, "$!");
		465	$self->destroy;
		466	} else {
		467	$self->_error ($!, 1);
		468	}
		469	}
		470	},
		471	sub {
		472	local $self->{fh} = $_[0];
		473
		474	$self->{on_prepare}
		475	? $self->{on_prepare}->($self)
		476	: ()
		477	}
		478	);
		479	}
		480
		481	} else {
		482	Carp::croak "AnyEvent::Handle: either an existing fh or the connect parameter must be specified";
		483	}
		484
		485	$self
		486	}
		487
		488	sub _start {
		489	my ($self) = @_;
294		490
295	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	491	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
		492
		493	$self->{_activity} =
		494	$self->{_ractivity} =
		495	$self->{_wactivity} = AE::now;
		496
		497	$self->timeout (delete $self->{timeout} ) if $self->{timeout};
		498	$self->rtimeout (delete $self->{rtimeout}) if $self->{rtimeout};
		499	$self->wtimeout (delete $self->{wtimeout}) if $self->{wtimeout};
		500
		501	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
296		502
297	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})	503	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
298	if $self->{tls};	504	if $self->{tls};
299		505
300	$self->{_activity} = AnyEvent->now;
301	$self->_timeout;
302
303	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};	506	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
304	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
305		507
306	$self->start_read	508	$self->start_read
307	if $self->{on_read};	509	if $self->{on_read} || @{ $self->{_queue} };
308		510
309	$self	511	$self->_drain_wbuf;
310	}	512	}
311		513
312	sub _shutdown {	514	#sub _shutdown {
313	my ($self) = @_;	515	# my ($self) = @_;
314		516	#
315	delete $self->{_tw};	517	# delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)};
316	delete $self->{_rw};	518	# $self->{_eof} = 1; # tell starttls et. al to stop trying
317	delete $self->{_ww};	519	#
318	delete $self->{fh};
319
320	&_freetls;	520	# &_freetls;
321		521	#}
322	delete $self->{on_read};
323	delete $self->{_queue};
324	}
325		522
326	sub _error {	523	sub _error {
327	my ($self, $errno, $fatal) = @_;	524	my ($self, $errno, $fatal, $message) = @_;
328
329	$self->_shutdown
330	if $fatal;
331		525
332	$! = $errno;	526	$! = $errno;
		527	$message ||= "$!";
333		528
334	if ($self->{on_error}) {	529	if ($self->{on_error}) {
335	$self->{on_error}($self, $fatal);	530	$self->{on_error}($self, $fatal, $message);
		531	$self->destroy if $fatal;
336	} elsif ($self->{fh}) {	532	} elsif ($self->{fh}) {
		533	$self->destroy;
337	Carp::croak "AnyEvent::Handle uncaught error: $!";	534	Carp::croak "AnyEvent::Handle uncaught error: $message";
338	}	535	}
339	}	536	}
340		537
341	=item $fh = $handle->fh	538	=item $fh = $handle->fh
342		539
…		…
366	$_[0]{on_eof} = $_[1];	563	$_[0]{on_eof} = $_[1];
367	}	564	}
368		565
369	=item $handle->on_timeout ($cb)	566	=item $handle->on_timeout ($cb)
370		567
371	Replace the current C<on_timeout> callback, or disables the callback (but	568	=item $handle->on_rtimeout ($cb)
372	not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
373	argument and method.
374		569
375	=cut	570	=item $handle->on_wtimeout ($cb)
376		571
377	sub on_timeout {	572	Replace the current C<on_timeout>, C<on_rtimeout> or C<on_wtimeout>
378	$_[0]{on_timeout} = $_[1];	573	callback, or disables the callback (but not the timeout) if C<$cb> =
379	}	574	C<undef>. See the C<timeout> constructor argument and method.
		575
		576	=cut
		577
		578	# see below
380		579
381	=item $handle->autocork ($boolean)	580	=item $handle->autocork ($boolean)
382		581
383	Enables or disables the current autocork behaviour (see C<autocork>	582	Enables or disables the current autocork behaviour (see C<autocork>
384	constructor argument). Changes will only take effect on the next write.	583	constructor argument). Changes will only take effect on the next write.
…		…
399	sub no_delay {	598	sub no_delay {
400	$_[0]{no_delay} = $_[1];	599	$_[0]{no_delay} = $_[1];
401		600
402	eval {	601	eval {
403	local $SIG{__DIE__};	602	local $SIG{__DIE__};
404	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];	603	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1]
		604	if $_[0]{fh};
405	};	605	};
406	}	606	}
407		607
		608	=item $handle->on_starttls ($cb)
		609
		610	Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument).
		611
		612	=cut
		613
		614	sub on_starttls {
		615	$_[0]{on_starttls} = $_[1];
		616	}
		617
		618	=item $handle->on_stoptls ($cb)
		619
		620	Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).
		621
		622	=cut
		623
		624	sub on_starttls {
		625	$_[0]{on_stoptls} = $_[1];
		626	}
		627
		628	=item $handle->rbuf_max ($max_octets)
		629
		630	Configures the C<rbuf_max> setting (C<undef> disables it).
		631
		632	=cut
		633
		634	sub rbuf_max {
		635	$_[0]{rbuf_max} = $_[1];
		636	}
		637
408	#############################################################################	638	#############################################################################
409		639
410	=item $handle->timeout ($seconds)	640	=item $handle->timeout ($seconds)
411		641
		642	=item $handle->rtimeout ($seconds)
		643
		644	=item $handle->wtimeout ($seconds)
		645
412	Configures (or disables) the inactivity timeout.	646	Configures (or disables) the inactivity timeout.
413		647
414	=cut	648	=item $handle->timeout_reset
415		649
416	sub timeout {	650	=item $handle->rtimeout_reset
		651
		652	=item $handle->wtimeout_reset
		653
		654	Reset the activity timeout, as if data was received or sent.
		655
		656	These methods are cheap to call.
		657
		658	=cut
		659
		660	for my $dir ("", "r", "w") {
		661	my $timeout = "${dir}timeout";
		662	my $tw = "_${dir}tw";
		663	my $on_timeout = "on_${dir}timeout";
		664	my $activity = "_${dir}activity";
		665	my $cb;
		666
		667	*$on_timeout = sub {
		668	$_[0]{$on_timeout} = $_[1];
		669	};
		670
		671	*$timeout = sub {
417	my ($self, $timeout) = @_;	672	my ($self, $new_value) = @_;
418		673
419	$self->{timeout} = $timeout;	674	$self->{$timeout} = $new_value;
420	$self->_timeout;	675	delete $self->{$tw}; &$cb;
421	}	676	};
422		677
		678	*{"${dir}timeout_reset"} = sub {
		679	$_[0]{$activity} = AE::now;
		680	};
		681
		682	# main workhorse:
423	# reset the timeout watcher, as neccessary	683	# reset the timeout watcher, as neccessary
424	# also check for time-outs	684	# also check for time-outs
425	sub _timeout {	685	$cb = sub {
426	my ($self) = @_;	686	my ($self) = @_;
427		687
428	if ($self->{timeout}) {	688	if ($self->{$timeout} && $self->{fh}) {
429	my $NOW = AnyEvent->now;	689	my $NOW = AE::now;
430		690
431	# when would the timeout trigger?	691	# when would the timeout trigger?
432	my $after = $self->{_activity} + $self->{timeout} - $NOW;	692	my $after = $self->{$activity} + $self->{$timeout} - $NOW;
433		693
434	# now or in the past already?	694	# now or in the past already?
435	if ($after <= 0) {	695	if ($after <= 0) {
436	$self->{_activity} = $NOW;	696	$self->{$activity} = $NOW;
437		697
438	if ($self->{on_timeout}) {	698	if ($self->{$on_timeout}) {
439	$self->{on_timeout}($self);	699	$self->{$on_timeout}($self);
440	} else {	700	} else {
441	$self->_error (&Errno::ETIMEDOUT);	701	$self->_error (Errno::ETIMEDOUT);
		702	}
		703
		704	# callback could have changed timeout value, optimise
		705	return unless $self->{$timeout};
		706
		707	# calculate new after
		708	$after = $self->{$timeout};
442	}	709	}
443		710
444	# callback could have changed timeout value, optimise	711	Scalar::Util::weaken $self;
445	return unless $self->{timeout};	712	return unless $self; # ->error could have destroyed $self
446		713
447	# calculate new after	714	$self->{$tw} ||= AE::timer $after, 0, sub {
448	$after = $self->{timeout};	715	delete $self->{$tw};
		716	$cb->($self);
		717	};
		718	} else {
		719	delete $self->{$tw};
449	}	720	}
450
451	Scalar::Util::weaken $self;
452	return unless $self; # ->error could have destroyed $self
453
454	$self->{_tw} ||= AnyEvent->timer (after => $after, cb => sub {
455	delete $self->{_tw};
456	$self->_timeout;
457	});
458	} else {
459	delete $self->{_tw};
460	}	721	}
461	}	722	}
462		723
463	#############################################################################	724	#############################################################################
464		725
…		…
509	Scalar::Util::weaken $self;	770	Scalar::Util::weaken $self;
510		771
511	my $cb = sub {	772	my $cb = sub {
512	my $len = syswrite $self->{fh}, $self->{wbuf};	773	my $len = syswrite $self->{fh}, $self->{wbuf};
513		774
514	if ($len >= 0) {	775	if (defined $len) {
515	substr $self->{wbuf}, 0, $len, "";	776	substr $self->{wbuf}, 0, $len, "";
516		777
517	$self->{_activity} = AnyEvent->now;	778	$self->{_activity} = $self->{_wactivity} = AE::now;
518		779
519	$self->{on_drain}($self)	780	$self->{on_drain}($self)
520	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})	781	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
521	&& $self->{on_drain};	782	&& $self->{on_drain};
522		783
…		…
528		789
529	# try to write data immediately	790	# try to write data immediately
530	$cb->() unless $self->{autocork};	791	$cb->() unless $self->{autocork};
531		792
532	# if still data left in wbuf, we need to poll	793	# if still data left in wbuf, we need to poll
533	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	794	$self->{_ww} = AE::io $self->{fh}, 1, $cb
534	if length $self->{wbuf};	795	if length $self->{wbuf};
535	};	796	};
536	}	797	}
537		798
538	our %WH;	799	our %WH;
…		…
551	->($self, @_);	812	->($self, @_);
552	}	813	}
553		814
554	if ($self->{tls}) {	815	if ($self->{tls}) {
555	$self->{_tls_wbuf} .= $_[0];	816	$self->{_tls_wbuf} .= $_[0];
556		817	&_dotls ($self) if $self->{fh};
557	&_dotls ($self);
558	} else {	818	} else {
559	$self->{wbuf} .= $_[0];	819	$self->{wbuf} .= $_[0];
560	$self->_drain_wbuf;	820	$self->_drain_wbuf if $self->{fh};
561	}	821	}
562	}	822	}
563		823
564	=item $handle->push_write (type => @args)	824	=item $handle->push_write (type => @args)
565		825
…		…
654		914
655	pack "w/a*", Storable::nfreeze ($ref)	915	pack "w/a*", Storable::nfreeze ($ref)
656	};	916	};
657		917
658	=back	918	=back
		919
		920	=item $handle->push_shutdown
		921
		922	Sometimes you know you want to close the socket after writing your data
		923	before it was actually written. One way to do that is to replace your
		924	C<on_drain> handler by a callback that shuts down the socket (and set
		925	C<low_water_mark> to C<0>). This method is a shorthand for just that, and
		926	replaces the C<on_drain> callback with:
		927
		928	sub { shutdown $_[0]{fh}, 1 } # for push_shutdown
		929
		930	This simply shuts down the write side and signals an EOF condition to the
		931	the peer.
		932
		933	You can rely on the normal read queue and C<on_eof> handling
		934	afterwards. This is the cleanest way to close a connection.
		935
		936	=cut
		937
		938	sub push_shutdown {
		939	my ($self) = @_;
		940
		941	delete $self->{low_water_mark};
		942	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });
		943	}
659		944
660	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	945	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
661		946
662	This function (not method) lets you add your own types to C<push_write>.	947	This function (not method) lets you add your own types to C<push_write>.
663	Whenever the given C<type> is used, C<push_write> will invoke the code	948	Whenever the given C<type> is used, C<push_write> will invoke the code
…		…
757	=cut	1042	=cut
758		1043
759	sub _drain_rbuf {	1044	sub _drain_rbuf {
760	my ($self) = @_;	1045	my ($self) = @_;
761		1046
		1047	# avoid recursion
		1048	return if $self->{_skip_drain_rbuf};
762	local $self->{_in_drain} = 1;	1049	local $self->{_skip_drain_rbuf} = 1;
763
764	if (
765	defined $self->{rbuf_max}
766	&& $self->{rbuf_max} < length $self->{rbuf}
767	) {
768	$self->_error (&Errno::ENOSPC, 1), return;
769	}
770		1050
771	while () {	1051	while () {
		1052	# we need to use a separate tls read buffer, as we must not receive data while
		1053	# we are draining the buffer, and this can only happen with TLS.
		1054	$self->{rbuf} .= delete $self->{_tls_rbuf}
		1055	if exists $self->{_tls_rbuf};
		1056
772	my $len = length $self->{rbuf};	1057	my $len = length $self->{rbuf};
773		1058
774	if (my $cb = shift @{ $self->{_queue} }) {	1059	if (my $cb = shift @{ $self->{_queue} }) {
775	unless ($cb->($self)) {	1060	unless ($cb->($self)) {
776	if ($self->{_eof}) {	1061	# no progress can be made
777	# no progress can be made (not enough data and no data forthcoming)	1062	# (not enough data and no data forthcoming)
778	$self->_error (&Errno::EPIPE, 1), return;	1063	$self->_error (Errno::EPIPE, 1), return
779	}	1064	if $self->{_eof};
780		1065
781	unshift @{ $self->{_queue} }, $cb;	1066	unshift @{ $self->{_queue} }, $cb;
782	last;	1067	last;
783	}	1068	}
784	} elsif ($self->{on_read}) {	1069	} elsif ($self->{on_read}) {
…		…
791	&& !@{ $self->{_queue} } # and the queue is still empty	1076	&& !@{ $self->{_queue} } # and the queue is still empty
792	&& $self->{on_read} # but we still have on_read	1077	&& $self->{on_read} # but we still have on_read
793	) {	1078	) {
794	# no further data will arrive	1079	# no further data will arrive
795	# so no progress can be made	1080	# so no progress can be made
796	$self->_error (&Errno::EPIPE, 1), return	1081	$self->_error (Errno::EPIPE, 1), return
797	if $self->{_eof};	1082	if $self->{_eof};
798		1083
799	last; # more data might arrive	1084	last; # more data might arrive
800	}	1085	}
801	} else {	1086	} else {
…		…
804	last;	1089	last;
805	}	1090	}
806	}	1091	}
807		1092
808	if ($self->{_eof}) {	1093	if ($self->{_eof}) {
809	if ($self->{on_eof}) {	1094	$self->{on_eof}
810	$self->{on_eof}($self)	1095	? $self->{on_eof}($self)
811	} else {	1096	: $self->_error (0, 1, "Unexpected end-of-file");
812	$self->_error (0, 1);	1097
813	}	1098	return;
		1099	}
		1100
		1101	if (
		1102	defined $self->{rbuf_max}
		1103	&& $self->{rbuf_max} < length $self->{rbuf}
		1104	) {
		1105	$self->_error (Errno::ENOSPC, 1), return;
814	}	1106	}
815		1107
816	# may need to restart read watcher	1108	# may need to restart read watcher
817	unless ($self->{_rw}) {	1109	unless ($self->{_rw}) {
818	$self->start_read	1110	$self->start_read
…		…
830		1122
831	sub on_read {	1123	sub on_read {
832	my ($self, $cb) = @_;	1124	my ($self, $cb) = @_;
833		1125
834	$self->{on_read} = $cb;	1126	$self->{on_read} = $cb;
835	$self->_drain_rbuf if $cb && !$self->{_in_drain};	1127	$self->_drain_rbuf if $cb;
836	}	1128	}
837		1129
838	=item $handle->rbuf	1130	=item $handle->rbuf
839		1131
840	Returns the read buffer (as a modifiable lvalue).	1132	Returns the read buffer (as a modifiable lvalue).
841		1133
842	You can access the read buffer directly as the C<< ->{rbuf} >> member, if	1134	You can access the read buffer directly as the C<< ->{rbuf} >>
843	you want.	1135	member, if you want. However, the only operation allowed on the
		1136	read buffer (apart from looking at it) is removing data from its
		1137	beginning. Otherwise modifying or appending to it is not allowed and will
		1138	lead to hard-to-track-down bugs.
844		1139
845	NOTE: The read buffer should only be used or modified if the C<on_read>,	1140	NOTE: The read buffer should only be used or modified if the C<on_read>,
846	C<push_read> or C<unshift_read> methods are used. The other read methods	1141	C<push_read> or C<unshift_read> methods are used. The other read methods
847	automatically manage the read buffer.	1142	automatically manage the read buffer.
848		1143
…		…
889	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	1184	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
890	->($self, $cb, @_);	1185	->($self, $cb, @_);
891	}	1186	}
892		1187
893	push @{ $self->{_queue} }, $cb;	1188	push @{ $self->{_queue} }, $cb;
894	$self->_drain_rbuf unless $self->{_in_drain};	1189	$self->_drain_rbuf;
895	}	1190	}
896		1191
897	sub unshift_read {	1192	sub unshift_read {
898	my $self = shift;	1193	my $self = shift;
899	my $cb = pop;	1194	my $cb = pop;
…		…
905	->($self, $cb, @_);	1200	->($self, $cb, @_);
906	}	1201	}
907		1202
908		1203
909	unshift @{ $self->{_queue} }, $cb;	1204	unshift @{ $self->{_queue} }, $cb;
910	$self->_drain_rbuf unless $self->{_in_drain};	1205	$self->_drain_rbuf;
911	}	1206	}
912		1207
913	=item $handle->push_read (type => @args, $cb)	1208	=item $handle->push_read (type => @args, $cb)
914		1209
915	=item $handle->unshift_read (type => @args, $cb)	1210	=item $handle->unshift_read (type => @args, $cb)
…		…
1048	return 1;	1343	return 1;
1049	}	1344	}
1050		1345
1051	# reject	1346	# reject
1052	if ($reject && $$rbuf =~ $reject) {	1347	if ($reject && $$rbuf =~ $reject) {
1053	$self->_error (&Errno::EBADMSG);	1348	$self->_error (Errno::EBADMSG);
1054	}	1349	}
1055		1350
1056	# skip	1351	# skip
1057	if ($skip && $$rbuf =~ $skip) {	1352	if ($skip && $$rbuf =~ $skip) {
1058	$data .= substr $$rbuf, 0, $+[0], "";	1353	$data .= substr $$rbuf, 0, $+[0], "";
…		…
1074	my ($self, $cb) = @_;	1369	my ($self, $cb) = @_;
1075		1370
1076	sub {	1371	sub {
1077	unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {	1372	unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {
1078	if ($_[0]{rbuf} =~ /[^0-9]/) {	1373	if ($_[0]{rbuf} =~ /[^0-9]/) {
1079	$self->_error (&Errno::EBADMSG);	1374	$self->_error (Errno::EBADMSG);
1080	}	1375	}
1081	return;	1376	return;
1082	}	1377	}
1083		1378
1084	my $len = $1;	1379	my $len = $1;
…		…
1087	my $string = $_[1];	1382	my $string = $_[1];
1088	$_[0]->unshift_read (chunk => 1, sub {	1383	$_[0]->unshift_read (chunk => 1, sub {
1089	if ($_[1] eq ",") {	1384	if ($_[1] eq ",") {
1090	$cb->($_[0], $string);	1385	$cb->($_[0], $string);
1091	} else {	1386	} else {
1092	$self->_error (&Errno::EBADMSG);	1387	$self->_error (Errno::EBADMSG);
1093	}	1388	}
1094	});	1389	});
1095	});	1390	});
1096		1391
1097	1	1392	1
…		…
1164	=cut	1459	=cut
1165		1460
1166	register_read_type json => sub {	1461	register_read_type json => sub {
1167	my ($self, $cb) = @_;	1462	my ($self, $cb) = @_;
1168		1463
1169	require JSON;	1464	my $json = $self->{json} ||=
		1465	eval { require JSON::XS; JSON::XS->new->utf8 }
		1466	|| do { require JSON; JSON->new->utf8 };
1170		1467
1171	my $data;	1468	my $data;
1172	my $rbuf = \$self->{rbuf};	1469	my $rbuf = \$self->{rbuf};
1173		1470
1174	my $json = $self->{json} ||= JSON->new->utf8;
1175
1176	sub {	1471	sub {
1177	eval {
1178	my $ref = $json->incr_parse ($self->{rbuf});	1472	my $ref = eval { $json->incr_parse ($self->{rbuf}) };
1179		1473
1180	if ($ref) {	1474	if ($ref) {
1181	$self->{rbuf} = $json->incr_text;	1475	$self->{rbuf} = $json->incr_text;
1182	$json->incr_text = "";	1476	$json->incr_text = "";
1183	$cb->($self, $ref);	1477	$cb->($self, $ref);
1184
1185	1
1186	} else {
1187	$self->{rbuf} = "";
1188	()
1189	}
1190		1478
1191	1	1479	1
1192	} or do {	1480	} elsif ($@) {
1193	# error case	1481	# error case
1194	$json->incr_skip;	1482	$json->incr_skip;
1195		1483
1196	$self->{rbuf} = $json->incr_text;	1484	$self->{rbuf} = $json->incr_text;
1197	$json->incr_text = "";	1485	$json->incr_text = "";
1198		1486
1199	$self->_error (&Errno::EBADMSG);	1487	$self->_error (Errno::EBADMSG);
		1488
		1489	()
		1490	} else {
		1491	$self->{rbuf} = "";
		1492
		1493	()
1200	};	1494	}
1201
1202	}	1495	}
1203	};	1496	};
1204		1497
1205	=item storable => $cb->($handle, $ref)	1498	=item storable => $cb->($handle, $ref)
1206		1499
…		…
1236	# read remaining chunk	1529	# read remaining chunk
1237	$_[0]->unshift_read (chunk => $len, sub {	1530	$_[0]->unshift_read (chunk => $len, sub {
1238	if (my $ref = eval { Storable::thaw ($_[1]) }) {	1531	if (my $ref = eval { Storable::thaw ($_[1]) }) {
1239	$cb->($_[0], $ref);	1532	$cb->($_[0], $ref);
1240	} else {	1533	} else {
1241	$self->_error (&Errno::EBADMSG);	1534	$self->_error (Errno::EBADMSG);
1242	}	1535	}
1243	});	1536	});
1244	}	1537	}
1245		1538
1246	1	1539	1
…		…
1298	my ($self) = @_;	1591	my ($self) = @_;
1299		1592
1300	unless ($self->{_rw} || $self->{_eof}) {	1593	unless ($self->{_rw} || $self->{_eof}) {
1301	Scalar::Util::weaken $self;	1594	Scalar::Util::weaken $self;
1302		1595
1303	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1596	$self->{_rw} = AE::io $self->{fh}, 0, sub {
1304	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});	1597	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1305	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf;	1598	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf;
1306		1599
1307	if ($len > 0) {	1600	if ($len > 0) {
1308	$self->{_activity} = AnyEvent->now;	1601	$self->{_activity} = $self->{_ractivity} = AE::now;
1309		1602
1310	if ($self->{tls}) {	1603	if ($self->{tls}) {
1311	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);	1604	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1312		1605
1313	&_dotls ($self);	1606	&_dotls ($self);
1314	} else {	1607	} else {
1315	$self->_drain_rbuf unless $self->{_in_drain};	1608	$self->_drain_rbuf;
1316	}	1609	}
1317		1610
1318	} elsif (defined $len) {	1611	} elsif (defined $len) {
1319	delete $self->{_rw};	1612	delete $self->{_rw};
1320	$self->{_eof} = 1;	1613	$self->{_eof} = 1;
1321	$self->_drain_rbuf unless $self->{_in_drain};	1614	$self->_drain_rbuf;
1322		1615
1323	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1616	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1324	return $self->_error ($!, 1);	1617	return $self->_error ($!, 1);
1325	}	1618	}
1326	});	1619	};
		1620	}
		1621	}
		1622
		1623	our $ERROR_SYSCALL;
		1624	our $ERROR_WANT_READ;
		1625
		1626	sub _tls_error {
		1627	my ($self, $err) = @_;
		1628
		1629	return $self->_error ($!, 1)
		1630	if $err == Net::SSLeay::ERROR_SYSCALL ();
		1631
		1632	my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());
		1633
		1634	# reduce error string to look less scary
		1635	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;
		1636
		1637	if ($self->{_on_starttls}) {
		1638	(delete $self->{_on_starttls})->($self, undef, $err);
		1639	&_freetls;
		1640	} else {
		1641	&_freetls;
		1642	$self->_error (Errno::EPROTO, 1, $err);
1327	}	1643	}
1328	}	1644	}
1329		1645
1330	# poll the write BIO and send the data if applicable	1646	# poll the write BIO and send the data if applicable
		1647	# also decode read data if possible
		1648	# this is basiclaly our TLS state machine
		1649	# more efficient implementations are possible with openssl,
		1650	# but not with the buggy and incomplete Net::SSLeay.
1331	sub _dotls {	1651	sub _dotls {
1332	my ($self) = @_;	1652	my ($self) = @_;
1333		1653
1334	my $tmp;	1654	my $tmp;
1335		1655
1336	if (length $self->{_tls_wbuf}) {	1656	if (length $self->{_tls_wbuf}) {
1337	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1657	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1338	substr $self->{_tls_wbuf}, 0, $tmp, "";	1658	substr $self->{_tls_wbuf}, 0, $tmp, "";
1339	}	1659	}
		1660
		1661	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);
		1662	return $self->_tls_error ($tmp)
		1663	if $tmp != $ERROR_WANT_READ
		1664	&& ($tmp != $ERROR_SYSCALL || $!);
1340	}	1665	}
1341		1666
1342	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {	1667	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
1343	unless (length $tmp) {	1668	unless (length $tmp) {
1344	# let's treat SSL-eof as we treat normal EOF	1669	$self->{_on_starttls}
1345	delete $self->{_rw};	1670	and (delete $self->{_on_starttls})->($self, undef, "EOF during handshake"); # ???
1346	$self->{_eof} = 1;
1347	&_freetls;	1671	&_freetls;
		1672
		1673	if ($self->{on_stoptls}) {
		1674	$self->{on_stoptls}($self);
		1675	return;
		1676	} else {
		1677	# let's treat SSL-eof as we treat normal EOF
		1678	delete $self->{_rw};
		1679	$self->{_eof} = 1;
		1680	}
1348	}	1681	}
1349		1682
1350	$self->{rbuf} .= $tmp;	1683	$self->{_tls_rbuf} .= $tmp;
1351	$self->_drain_rbuf unless $self->{_in_drain};	1684	$self->_drain_rbuf;
1352	$self->{tls} or return; # tls session might have gone away in callback	1685	$self->{tls} or return; # tls session might have gone away in callback
1353	}	1686	}
1354		1687
1355	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);	1688	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1356
1357	if ($tmp != Net::SSLeay::ERROR_WANT_READ ()) {
1358	if ($tmp == Net::SSLeay::ERROR_SYSCALL ()) {
1359	return $self->_error ($!, 1);	1689	return $self->_tls_error ($tmp)
1360	} elsif ($tmp == Net::SSLeay::ERROR_SSL ()) {	1690	if $tmp != $ERROR_WANT_READ
1361	return $self->_error (&Errno::EIO, 1);	1691	&& ($tmp != $ERROR_SYSCALL || $!);
1362	}
1363
1364	# all other errors are fine for our purposes
1365	}
1366		1692
1367	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1693	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1368	$self->{wbuf} .= $tmp;	1694	$self->{wbuf} .= $tmp;
1369	$self->_drain_wbuf;	1695	$self->_drain_wbuf;
1370	}	1696	}
		1697
		1698	$self->{_on_starttls}
		1699	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
		1700	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");
1371	}	1701	}
1372		1702
1373	=item $handle->starttls ($tls[, $tls_ctx])	1703	=item $handle->starttls ($tls[, $tls_ctx])
1374		1704
1375	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	1705	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
1376	object is created, you can also do that at a later time by calling	1706	object is created, you can also do that at a later time by calling
1377	C<starttls>.	1707	C<starttls>.
1378		1708
		1709	Starting TLS is currently an asynchronous operation - when you push some
		1710	write data and then call C<< ->starttls >> then TLS negotiation will start
		1711	immediately, after which the queued write data is then sent.
		1712
1379	The first argument is the same as the C<tls> constructor argument (either	1713	The first argument is the same as the C<tls> constructor argument (either
1380	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1714	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1381		1715
1382	The second argument is the optional C<Net::SSLeay::CTX> object that is	1716	The second argument is the optional C<AnyEvent::TLS> object that is used
1383	used when AnyEvent::Handle has to create its own TLS connection object.	1717	when AnyEvent::Handle has to create its own TLS connection object, or
		1718	a hash reference with C<< key => value >> pairs that will be used to
		1719	construct a new context.
1384		1720
1385	The TLS connection object will end up in C<< $handle->{tls} >> after this	1721	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS
1386	call and can be used or changed to your liking. Note that the handshake	1722	context in C<< $handle->{tls_ctx} >> after this call and can be used or
1387	might have already started when this function returns.	1723	changed to your liking. Note that the handshake might have already started
		1724	when this function returns.
1388		1725
1389	If it an error to start a TLS handshake more than once per	1726	Due to bugs in OpenSSL, it might or might not be possible to do multiple
1390	AnyEvent::Handle object (this is due to bugs in OpenSSL).	1727	handshakes on the same stream. Best do not attempt to use the stream after
		1728	stopping TLS.
1391		1729
1392	=cut	1730	=cut
		1731
		1732	our %TLS_CACHE; #TODO not yet documented, should we?
1393		1733
1394	sub starttls {	1734	sub starttls {
1395	my ($self, $ssl, $ctx) = @_;	1735	my ($self, $tls, $ctx) = @_;
		1736
		1737	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"
		1738	if $self->{tls};
		1739
		1740	$self->{tls} = $tls;
		1741	$self->{tls_ctx} = $ctx if @_ > 2;
		1742
		1743	return unless $self->{fh};
1396		1744
1397	require Net::SSLeay;	1745	require Net::SSLeay;
1398		1746
1399	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"	1747	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
		1748	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
		1749
1400	if $self->{tls};	1750	$tls = $self->{tls};
		1751	$ctx = $self->{tls_ctx};
		1752
		1753	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
		1754
		1755	if ("HASH" eq ref $ctx) {
		1756	require AnyEvent::TLS;
		1757
		1758	if ($ctx->{cache}) {
		1759	my $key = $ctx+0;
		1760	$ctx = $TLS_CACHE{$key} ||= new AnyEvent::TLS %$ctx;
		1761	} else {
		1762	$ctx = new AnyEvent::TLS %$ctx;
		1763	}
		1764	}
1401		1765
1402	if ($ssl eq "accept") {	1766	$self->{tls_ctx} = $ctx || TLS_CTX ();
1403	$ssl = Net::SSLeay::new ($ctx || TLS_CTX ());	1767	$self->{tls} = $tls = $self->{tls_ctx}->_get_session ($tls, $self, $self->{peername});
1404	Net::SSLeay::set_accept_state ($ssl);
1405	} elsif ($ssl eq "connect") {
1406	$ssl = Net::SSLeay::new ($ctx || TLS_CTX ());
1407	Net::SSLeay::set_connect_state ($ssl);
1408	}
1409
1410	$self->{tls} = $ssl;
1411		1768
1412	# basically, this is deep magic (because SSL_read should have the same issues)	1769	# basically, this is deep magic (because SSL_read should have the same issues)
1413	# but the openssl maintainers basically said: "trust us, it just works".	1770	# but the openssl maintainers basically said: "trust us, it just works".
1414	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1771	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1415	# and mismaintained ssleay-module doesn't even offer them).	1772	# and mismaintained ssleay-module doesn't even offer them).
…		…
1419	#	1776	#
1420	# note that we do not try to keep the length constant between writes as we are required to do.	1777	# note that we do not try to keep the length constant between writes as we are required to do.
1421	# we assume that most (but not all) of this insanity only applies to non-blocking cases,	1778	# we assume that most (but not all) of this insanity only applies to non-blocking cases,
1422	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to	1779	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
1423	# have identity issues in that area.	1780	# have identity issues in that area.
1424	Net::SSLeay::CTX_set_mode ($self->{tls},	1781	# Net::SSLeay::CTX_set_mode ($ssl,
1425	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)	1782	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)
1426	| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));	1783	# | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));
		1784	Net::SSLeay::CTX_set_mode ($tls, 1|2);
1427		1785
1428	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1786	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1429	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1787	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1430		1788
		1789	Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf});
		1790
1431	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1791	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
		1792
		1793	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
		1794	if $self->{on_starttls};
1432		1795
1433	&_dotls; # need to trigger the initial handshake	1796	&_dotls; # need to trigger the initial handshake
1434	$self->start_read; # make sure we actually do read	1797	$self->start_read; # make sure we actually do read
1435	}	1798	}
1436		1799
1437	=item $handle->stoptls	1800	=item $handle->stoptls
1438		1801
1439	Shuts down the SSL connection - this makes a proper EOF handshake by	1802	Shuts down the SSL connection - this makes a proper EOF handshake by
1440	sending a close notify to the other side, but since OpenSSL doesn't	1803	sending a close notify to the other side, but since OpenSSL doesn't
1441	support non-blocking shut downs, it is not possible to re-use the stream	1804	support non-blocking shut downs, it is not guarenteed that you can re-use
1442	afterwards.	1805	the stream afterwards.
1443		1806
1444	=cut	1807	=cut
1445		1808
1446	sub stoptls {	1809	sub stoptls {
1447	my ($self) = @_;	1810	my ($self) = @_;
…		…
1449	if ($self->{tls}) {	1812	if ($self->{tls}) {
1450	Net::SSLeay::shutdown ($self->{tls});	1813	Net::SSLeay::shutdown ($self->{tls});
1451		1814
1452	&_dotls;	1815	&_dotls;
1453		1816
1454	# we don't give a shit. no, we do, but we can't. no...	1817	# # we don't give a shit. no, we do, but we can't. no...#d#
1455	# we, we... have to use openssl :/	1818	# # we, we... have to use openssl :/#d#
1456	&_freetls;	1819	# &_freetls;#d#
1457	}	1820	}
1458	}	1821	}
1459		1822
1460	sub _freetls {	1823	sub _freetls {
1461	my ($self) = @_;	1824	my ($self) = @_;
1462		1825
1463	return unless $self->{tls};	1826	return unless $self->{tls};
1464		1827
1465	Net::SSLeay::free (delete $self->{tls});	1828	$self->{tls_ctx}->_put_session (delete $self->{tls})
		1829	if $self->{tls} > 0;
1466		1830
1467	delete @$self{qw(_rbio _wbio _tls_wbuf)};	1831	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1468	}	1832	}
1469		1833
1470	sub DESTROY {	1834	sub DESTROY {
1471	my $self = shift;	1835	my ($self) = @_;
1472		1836
1473	&_freetls;	1837	&_freetls;
1474		1838
1475	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	1839	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1476		1840
1477	if ($linger && length $self->{wbuf}) {	1841	if ($linger && length $self->{wbuf} && $self->{fh}) {
1478	my $fh = delete $self->{fh};	1842	my $fh = delete $self->{fh};
1479	my $wbuf = delete $self->{wbuf};	1843	my $wbuf = delete $self->{wbuf};
1480		1844
1481	my @linger;	1845	my @linger;
1482		1846
1483	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {	1847	push @linger, AE::io $fh, 1, sub {
1484	my $len = syswrite $fh, $wbuf, length $wbuf;	1848	my $len = syswrite $fh, $wbuf, length $wbuf;
1485		1849
1486	if ($len > 0) {	1850	if ($len > 0) {
1487	substr $wbuf, 0, $len, "";	1851	substr $wbuf, 0, $len, "";
1488	} else {	1852	} else {
1489	@linger = (); # end	1853	@linger = (); # end
1490	}	1854	}
1491	});	1855	};
1492	push @linger, AnyEvent->timer (after => $linger, cb => sub {	1856	push @linger, AE::timer $linger, 0, sub {
1493	@linger = ();	1857	@linger = ();
1494	});	1858	};
1495	}	1859	}
1496	}	1860	}
1497		1861
1498	=item $handle->destroy	1862	=item $handle->destroy
1499		1863
1500	Shuts down the handle object as much as possible - this call ensures that	1864	Shuts down the handle object as much as possible - this call ensures that
1501	no further callbacks will be invoked and resources will be freed as much	1865	no further callbacks will be invoked and as many resources as possible
1502	as possible. You must not call any methods on the object afterwards.	1866	will be freed. Any method you will call on the handle object after
		1867	destroying it in this way will be silently ignored (and it will return the
		1868	empty list).
1503		1869
1504	Normally, you can just "forget" any references to an AnyEvent::Handle	1870	Normally, you can just "forget" any references to an AnyEvent::Handle
1505	object and it will simply shut down. This works in fatal error and EOF	1871	object and it will simply shut down. This works in fatal error and EOF
1506	callbacks, as well as code outside. It does I<NOT> work in a read or write	1872	callbacks, as well as code outside. It does I<NOT> work in a read or write
1507	callback, so when you want to destroy the AnyEvent::Handle object from	1873	callback, so when you want to destroy the AnyEvent::Handle object from
1508	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in	1874	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
1509	that case.	1875	that case.
1510		1876
		1877	Destroying the handle object in this way has the advantage that callbacks
		1878	will be removed as well, so if those are the only reference holders (as
		1879	is common), then one doesn't need to do anything special to break any
		1880	reference cycles.
		1881
1511	The handle might still linger in the background and write out remaining	1882	The handle might still linger in the background and write out remaining
1512	data, as specified by the C<linger> option, however.	1883	data, as specified by the C<linger> option, however.
1513		1884
1514	=cut	1885	=cut
1515		1886
1516	sub destroy {	1887	sub destroy {
1517	my ($self) = @_;	1888	my ($self) = @_;
1518		1889
1519	$self->DESTROY;	1890	$self->DESTROY;
1520	%$self = ();	1891	%$self = ();
		1892	bless $self, "AnyEvent::Handle::destroyed";
		1893	}
		1894
		1895	sub AnyEvent::Handle::destroyed::AUTOLOAD {
		1896	#nop
1521	}	1897	}
1522		1898
1523	=item AnyEvent::Handle::TLS_CTX	1899	=item AnyEvent::Handle::TLS_CTX
1524		1900
1525	This function creates and returns the Net::SSLeay::CTX object used by	1901	This function creates and returns the AnyEvent::TLS object used by default
1526	default for TLS mode.	1902	for TLS mode.
1527		1903
1528	The context is created like this:	1904	The context is created by calling L<AnyEvent::TLS> without any arguments.
1529
1530	Net::SSLeay::load_error_strings;
1531	Net::SSLeay::SSLeay_add_ssl_algorithms;
1532	Net::SSLeay::randomize;
1533
1534	my $CTX = Net::SSLeay::CTX_new;
1535
1536	Net::SSLeay::CTX_set_options $CTX, Net::SSLeay::OP_ALL
1537		1905
1538	=cut	1906	=cut
1539		1907
1540	our $TLS_CTX;	1908	our $TLS_CTX;
1541		1909
1542	sub TLS_CTX() {	1910	sub TLS_CTX() {
1543	$TLS_CTX || do {	1911	$TLS_CTX ||= do {
1544	require Net::SSLeay;	1912	require AnyEvent::TLS;
1545		1913
1546	Net::SSLeay::load_error_strings ();	1914	new AnyEvent::TLS
1547	Net::SSLeay::SSLeay_add_ssl_algorithms ();
1548	Net::SSLeay::randomize ();
1549
1550	$TLS_CTX = Net::SSLeay::CTX_new ();
1551
1552	Net::SSLeay::CTX_set_options ($TLS_CTX, Net::SSLeay::OP_ALL ());
1553
1554	$TLS_CTX
1555	}	1915	}
1556	}	1916	}
1557		1917
1558	=back	1918	=back
1559		1919
…		…
1598		1958
1599	$handle->on_read (sub { });	1959	$handle->on_read (sub { });
1600	$handle->on_eof (undef);	1960	$handle->on_eof (undef);
1601	$handle->on_error (sub {	1961	$handle->on_error (sub {
1602	my $data = delete $_[0]{rbuf};	1962	my $data = delete $_[0]{rbuf};
1603	undef $handle;
1604	});	1963	});
1605		1964
1606	The reason to use C<on_error> is that TCP connections, due to latencies	1965	The reason to use C<on_error> is that TCP connections, due to latencies
1607	and packets loss, might get closed quite violently with an error, when in	1966	and packets loss, might get closed quite violently with an error, when in
1608	fact, all data has been received.	1967	fact, all data has been received.
…		…
1624	$handle->on_drain (sub {	1983	$handle->on_drain (sub {
1625	warn "all data submitted to the kernel\n";	1984	warn "all data submitted to the kernel\n";
1626	undef $handle;	1985	undef $handle;
1627	});	1986	});
1628		1987
		1988	If you just want to queue some data and then signal EOF to the other side,
		1989	consider using C<< ->push_shutdown >> instead.
		1990
		1991	=item I want to contact a TLS/SSL server, I don't care about security.
		1992
		1993	If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS,
		1994	simply connect to it and then create the AnyEvent::Handle with the C<tls>
		1995	parameter:
		1996
		1997	tcp_connect $host, $port, sub {
		1998	my ($fh) = @_;
		1999
		2000	my $handle = new AnyEvent::Handle
		2001	fh => $fh,
		2002	tls => "connect",
		2003	on_error => sub { ... };
		2004
		2005	$handle->push_write (...);
		2006	};
		2007
		2008	=item I want to contact a TLS/SSL server, I do care about security.
		2009
		2010	Then you should additionally enable certificate verification, including
		2011	peername verification, if the protocol you use supports it (see
		2012	L<AnyEvent::TLS>, C<verify_peername>).
		2013
		2014	E.g. for HTTPS:
		2015
		2016	tcp_connect $host, $port, sub {
		2017	my ($fh) = @_;
		2018
		2019	my $handle = new AnyEvent::Handle
		2020	fh => $fh,
		2021	peername => $host,
		2022	tls => "connect",
		2023	tls_ctx => { verify => 1, verify_peername => "https" },
		2024	...
		2025
		2026	Note that you must specify the hostname you connected to (or whatever
		2027	"peername" the protocol needs) as the C<peername> argument, otherwise no
		2028	peername verification will be done.
		2029
		2030	The above will use the system-dependent default set of trusted CA
		2031	certificates. If you want to check against a specific CA, add the
		2032	C<ca_file> (or C<ca_cert>) arguments to C<tls_ctx>:
		2033
		2034	tls_ctx => {
		2035	verify => 1,
		2036	verify_peername => "https",
		2037	ca_file => "my-ca-cert.pem",
		2038	},
		2039
		2040	=item I want to create a TLS/SSL server, how do I do that?
		2041
		2042	Well, you first need to get a server certificate and key. You have
		2043	three options: a) ask a CA (buy one, use cacert.org etc.) b) create a
		2044	self-signed certificate (cheap. check the search engine of your choice,
		2045	there are many tutorials on the net) or c) make your own CA (tinyca2 is a
		2046	nice program for that purpose).
		2047
		2048	Then create a file with your private key (in PEM format, see
		2049	L<AnyEvent::TLS>), followed by the certificate (also in PEM format). The
		2050	file should then look like this:
		2051
		2052	-----BEGIN RSA PRIVATE KEY-----
		2053	...header data
		2054	... lots of base64'y-stuff
		2055	-----END RSA PRIVATE KEY-----
		2056
		2057	-----BEGIN CERTIFICATE-----
		2058	... lots of base64'y-stuff
		2059	-----END CERTIFICATE-----
		2060
		2061	The important bits are the "PRIVATE KEY" and "CERTIFICATE" parts. Then
		2062	specify this file as C<cert_file>:
		2063
		2064	tcp_server undef, $port, sub {
		2065	my ($fh) = @_;
		2066
		2067	my $handle = new AnyEvent::Handle
		2068	fh => $fh,
		2069	tls => "accept",
		2070	tls_ctx => { cert_file => "my-server-keycert.pem" },
		2071	...
		2072
		2073	When you have intermediate CA certificates that your clients might not
		2074	know about, just append them to the C<cert_file>.
		2075
1629	=back	2076	=back
1630		2077
1631		2078
1632	=head1 SUBCLASSING AnyEvent::Handle	2079	=head1 SUBCLASSING AnyEvent::Handle
1633		2080

Diff Legend

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