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.118 by root, Thu Feb 12 17:33:38 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.34;	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. Note that you
133	must not enlarge or modify the read buffer, you can only remove data at
134	the beginning from it.
135
136	When an EOF condition is detected then AnyEvent::Handle will first try to
137	feed all the remaining data to the queued callbacks and C<on_read> before
138	calling the C<on_eof> callback. If no progress can be made, then a fatal
139	error will be raised (with C<$!> set to C<EPIPE>).
140		208
141	=item on_drain => $cb->($handle)	209	=item on_drain => $cb->($handle)
142		210
143	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
144	(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).
…		…
151	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
152	the file when the write queue becomes empty.	220	the file when the write queue becomes empty.
153		221
154	=item timeout => $fractional_seconds	222	=item timeout => $fractional_seconds
155		223
		224	=item rtimeout => $fractional_seconds
		225
		226	=item wtimeout => $fractional_seconds
		227
156	If non-zero, then this enables an "inactivity" timeout: whenever this many	228	If non-zero, then these enables an "inactivity" timeout: whenever this
157	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
158	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
159	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>.
160		239
161	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
162	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
163	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
164	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
…		…
237		316
238	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
239	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
240	help.	319	help.
241		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
242	=item tls => "accept" | "connect" | Net::SSLeay::SSL object	331	=item tls => "accept" | "connect" | Net::SSLeay::SSL object
243		332
244	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
245	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
246	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.
247		339
248	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
249	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
250	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
251	to add the dependency yourself.	343	to add the dependency yourself.
…		…
255	mode.	347	mode.
256		348
257	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
258	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>
259	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
260	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.
261		358
262	B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,	359	B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,
263	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
264	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
265	segmentation fault.	362	segmentation fault.
266		363
267	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.
268		365
269	=item tls_ctx => $ssl_ctx	366	=item tls_ctx => $anyevent_tls
270		367
271	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
272	(unless a connection object was specified directly). If this parameter is	369	(unless a connection object was specified directly). If this parameter is
273	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.
274		407
275	=item json => JSON or JSON::XS object	408	=item json => JSON or JSON::XS object
276		409
277	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.
278		411
…		…
287		420
288	=cut	421	=cut
289		422
290	sub new {	423	sub new {
291	my $class = shift;	424	my $class = shift;
292
293	my $self = bless { @_ }, $class;	425	my $self = bless { @_ }, $class;
294		426
295	$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) = @_;
296		490
297	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};
298		502
299	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})	503	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
300	if $self->{tls};	504	if $self->{tls};
301		505
302	$self->{_activity} = AnyEvent->now;
303	$self->_timeout;
304
305	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};	506	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
306	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
307		507
308	$self->start_read	508	$self->start_read
309	if $self->{on_read};	509	if $self->{on_read} || @{ $self->{_queue} };
310		510
311	$self	511	$self->_drain_wbuf;
312	}	512	}
313		513
314	sub _shutdown {	514	#sub _shutdown {
315	my ($self) = @_;	515	# my ($self) = @_;
316		516	#
317	delete $self->{_tw};	517	# delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)};
318	delete $self->{_rw};	518	# $self->{_eof} = 1; # tell starttls et. al to stop trying
319	delete $self->{_ww};	519	#
320	delete $self->{fh};
321
322	&_freetls;	520	# &_freetls;
323		521	#}
324	delete $self->{on_read};
325	delete $self->{_queue};
326	}
327		522
328	sub _error {	523	sub _error {
329	my ($self, $errno, $fatal) = @_;	524	my ($self, $errno, $fatal, $message) = @_;
330
331	$self->_shutdown
332	if $fatal;
333		525
334	$! = $errno;	526	$! = $errno;
		527	$message ||= "$!";
335		528
336	if ($self->{on_error}) {	529	if ($self->{on_error}) {
337	$self->{on_error}($self, $fatal);	530	$self->{on_error}($self, $fatal, $message);
		531	$self->destroy if $fatal;
338	} elsif ($self->{fh}) {	532	} elsif ($self->{fh}) {
		533	$self->destroy;
339	Carp::croak "AnyEvent::Handle uncaught error: $!";	534	Carp::croak "AnyEvent::Handle uncaught error: $message";
340	}	535	}
341	}	536	}
342		537
343	=item $fh = $handle->fh	538	=item $fh = $handle->fh
344		539
…		…
368	$_[0]{on_eof} = $_[1];	563	$_[0]{on_eof} = $_[1];
369	}	564	}
370		565
371	=item $handle->on_timeout ($cb)	566	=item $handle->on_timeout ($cb)
372		567
373	Replace the current C<on_timeout> callback, or disables the callback (but	568	=item $handle->on_rtimeout ($cb)
374	not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
375	argument and method.
376		569
377	=cut	570	=item $handle->on_wtimeout ($cb)
378		571
379	sub on_timeout {	572	Replace the current C<on_timeout>, C<on_rtimeout> or C<on_wtimeout>
380	$_[0]{on_timeout} = $_[1];	573	callback, or disables the callback (but not the timeout) if C<$cb> =
381	}	574	C<undef>. See the C<timeout> constructor argument and method.
		575
		576	=cut
		577
		578	# see below
382		579
383	=item $handle->autocork ($boolean)	580	=item $handle->autocork ($boolean)
384		581
385	Enables or disables the current autocork behaviour (see C<autocork>	582	Enables or disables the current autocork behaviour (see C<autocork>
386	constructor argument). Changes will only take effect on the next write.	583	constructor argument). Changes will only take effect on the next write.
…		…
401	sub no_delay {	598	sub no_delay {
402	$_[0]{no_delay} = $_[1];	599	$_[0]{no_delay} = $_[1];
403		600
404	eval {	601	eval {
405	local $SIG{__DIE__};	602	local $SIG{__DIE__};
406	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};
407	};	605	};
408	}	606	}
409		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
410	#############################################################################	638	#############################################################################
411		639
412	=item $handle->timeout ($seconds)	640	=item $handle->timeout ($seconds)
413		641
		642	=item $handle->rtimeout ($seconds)
		643
		644	=item $handle->wtimeout ($seconds)
		645
414	Configures (or disables) the inactivity timeout.	646	Configures (or disables) the inactivity timeout.
415		647
416	=cut	648	=item $handle->timeout_reset
417		649
418	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 {
419	my ($self, $timeout) = @_;	672	my ($self, $new_value) = @_;
420		673
421	$self->{timeout} = $timeout;	674	$self->{$timeout} = $new_value;
422	$self->_timeout;	675	delete $self->{$tw}; &$cb;
423	}	676	};
424		677
		678	*{"${dir}timeout_reset"} = sub {
		679	$_[0]{$activity} = AE::now;
		680	};
		681
		682	# main workhorse:
425	# reset the timeout watcher, as neccessary	683	# reset the timeout watcher, as neccessary
426	# also check for time-outs	684	# also check for time-outs
427	sub _timeout {	685	$cb = sub {
428	my ($self) = @_;	686	my ($self) = @_;
429		687
430	if ($self->{timeout}) {	688	if ($self->{$timeout} && $self->{fh}) {
431	my $NOW = AnyEvent->now;	689	my $NOW = AE::now;
432		690
433	# when would the timeout trigger?	691	# when would the timeout trigger?
434	my $after = $self->{_activity} + $self->{timeout} - $NOW;	692	my $after = $self->{$activity} + $self->{$timeout} - $NOW;
435		693
436	# now or in the past already?	694	# now or in the past already?
437	if ($after <= 0) {	695	if ($after <= 0) {
438	$self->{_activity} = $NOW;	696	$self->{$activity} = $NOW;
439		697
440	if ($self->{on_timeout}) {	698	if ($self->{$on_timeout}) {
441	$self->{on_timeout}($self);	699	$self->{$on_timeout}($self);
442	} else {	700	} else {
443	$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};
444	}	709	}
445		710
446	# callback could have changed timeout value, optimise	711	Scalar::Util::weaken $self;
447	return unless $self->{timeout};	712	return unless $self; # ->error could have destroyed $self
448		713
449	# calculate new after	714	$self->{$tw} ||= AE::timer $after, 0, sub {
450	$after = $self->{timeout};	715	delete $self->{$tw};
		716	$cb->($self);
		717	};
		718	} else {
		719	delete $self->{$tw};
451	}	720	}
452
453	Scalar::Util::weaken $self;
454	return unless $self; # ->error could have destroyed $self
455
456	$self->{_tw} ||= AnyEvent->timer (after => $after, cb => sub {
457	delete $self->{_tw};
458	$self->_timeout;
459	});
460	} else {
461	delete $self->{_tw};
462	}	721	}
463	}	722	}
464		723
465	#############################################################################	724	#############################################################################
466		725
…		…
511	Scalar::Util::weaken $self;	770	Scalar::Util::weaken $self;
512		771
513	my $cb = sub {	772	my $cb = sub {
514	my $len = syswrite $self->{fh}, $self->{wbuf};	773	my $len = syswrite $self->{fh}, $self->{wbuf};
515		774
516	if ($len >= 0) {	775	if (defined $len) {
517	substr $self->{wbuf}, 0, $len, "";	776	substr $self->{wbuf}, 0, $len, "";
518		777
519	$self->{_activity} = AnyEvent->now;	778	$self->{_activity} = $self->{_wactivity} = AE::now;
520		779
521	$self->{on_drain}($self)	780	$self->{on_drain}($self)
522	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})
523	&& $self->{on_drain};	782	&& $self->{on_drain};
524		783
…		…
530		789
531	# try to write data immediately	790	# try to write data immediately
532	$cb->() unless $self->{autocork};	791	$cb->() unless $self->{autocork};
533		792
534	# if still data left in wbuf, we need to poll	793	# if still data left in wbuf, we need to poll
535	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	794	$self->{_ww} = AE::io $self->{fh}, 1, $cb
536	if length $self->{wbuf};	795	if length $self->{wbuf};
537	};	796	};
538	}	797	}
539		798
540	our %WH;	799	our %WH;
…		…
553	->($self, @_);	812	->($self, @_);
554	}	813	}
555		814
556	if ($self->{tls}) {	815	if ($self->{tls}) {
557	$self->{_tls_wbuf} .= $_[0];	816	$self->{_tls_wbuf} .= $_[0];
558		817	&_dotls ($self) if $self->{fh};
559	&_dotls ($self);
560	} else {	818	} else {
561	$self->{wbuf} .= $_[0];	819	$self->{wbuf} .= $_[0];
562	$self->_drain_wbuf;	820	$self->_drain_wbuf if $self->{fh};
563	}	821	}
564	}	822	}
565		823
566	=item $handle->push_write (type => @args)	824	=item $handle->push_write (type => @args)
567		825
…		…
656		914
657	pack "w/a*", Storable::nfreeze ($ref)	915	pack "w/a*", Storable::nfreeze ($ref)
658	};	916	};
659		917
660	=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	}
661		944
662	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	945	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
663		946
664	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>.
665	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
…		…
759	=cut	1042	=cut
760		1043
761	sub _drain_rbuf {	1044	sub _drain_rbuf {
762	my ($self) = @_;	1045	my ($self) = @_;
763		1046
		1047	# avoid recursion
		1048	return if $self->{_skip_drain_rbuf};
764	local $self->{_in_drain} = 1;	1049	local $self->{_skip_drain_rbuf} = 1;
765
766	if (
767	defined $self->{rbuf_max}
768	&& $self->{rbuf_max} < length $self->{rbuf}
769	) {
770	$self->_error (&Errno::ENOSPC, 1), return;
771	}
772		1050
773	while () {	1051	while () {
774	# we need to use a separate tls read buffer, as we must not receive data while	1052	# we need to use a separate tls read buffer, as we must not receive data while
775	# we are draining the buffer, and this can only happen with TLS.	1053	# we are draining the buffer, and this can only happen with TLS.
776	$self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf};	1054	$self->{rbuf} .= delete $self->{_tls_rbuf}
		1055	if exists $self->{_tls_rbuf};
777		1056
778	my $len = length $self->{rbuf};	1057	my $len = length $self->{rbuf};
779		1058
780	if (my $cb = shift @{ $self->{_queue} }) {	1059	if (my $cb = shift @{ $self->{_queue} }) {
781	unless ($cb->($self)) {	1060	unless ($cb->($self)) {
782	if ($self->{_eof}) {	1061	# no progress can be made
783	# no progress can be made (not enough data and no data forthcoming)	1062	# (not enough data and no data forthcoming)
784	$self->_error (&Errno::EPIPE, 1), return;	1063	$self->_error (Errno::EPIPE, 1), return
785	}	1064	if $self->{_eof};
786		1065
787	unshift @{ $self->{_queue} }, $cb;	1066	unshift @{ $self->{_queue} }, $cb;
788	last;	1067	last;
789	}	1068	}
790	} elsif ($self->{on_read}) {	1069	} elsif ($self->{on_read}) {
…		…
797	&& !@{ $self->{_queue} } # and the queue is still empty	1076	&& !@{ $self->{_queue} } # and the queue is still empty
798	&& $self->{on_read} # but we still have on_read	1077	&& $self->{on_read} # but we still have on_read
799	) {	1078	) {
800	# no further data will arrive	1079	# no further data will arrive
801	# so no progress can be made	1080	# so no progress can be made
802	$self->_error (&Errno::EPIPE, 1), return	1081	$self->_error (Errno::EPIPE, 1), return
803	if $self->{_eof};	1082	if $self->{_eof};
804		1083
805	last; # more data might arrive	1084	last; # more data might arrive
806	}	1085	}
807	} else {	1086	} else {
…		…
810	last;	1089	last;
811	}	1090	}
812	}	1091	}
813		1092
814	if ($self->{_eof}) {	1093	if ($self->{_eof}) {
815	if ($self->{on_eof}) {	1094	$self->{on_eof}
816	$self->{on_eof}($self)	1095	? $self->{on_eof}($self)
817	} else {	1096	: $self->_error (0, 1, "Unexpected end-of-file");
818	$self->_error (0, 1);	1097
819	}	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;
820	}	1106	}
821		1107
822	# may need to restart read watcher	1108	# may need to restart read watcher
823	unless ($self->{_rw}) {	1109	unless ($self->{_rw}) {
824	$self->start_read	1110	$self->start_read
…		…
836		1122
837	sub on_read {	1123	sub on_read {
838	my ($self, $cb) = @_;	1124	my ($self, $cb) = @_;
839		1125
840	$self->{on_read} = $cb;	1126	$self->{on_read} = $cb;
841	$self->_drain_rbuf if $cb && !$self->{_in_drain};	1127	$self->_drain_rbuf if $cb;
842	}	1128	}
843		1129
844	=item $handle->rbuf	1130	=item $handle->rbuf
845		1131
846	Returns the read buffer (as a modifiable lvalue).	1132	Returns the read buffer (as a modifiable lvalue).
…		…
898	$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")
899	->($self, $cb, @_);	1185	->($self, $cb, @_);
900	}	1186	}
901		1187
902	push @{ $self->{_queue} }, $cb;	1188	push @{ $self->{_queue} }, $cb;
903	$self->_drain_rbuf unless $self->{_in_drain};	1189	$self->_drain_rbuf;
904	}	1190	}
905		1191
906	sub unshift_read {	1192	sub unshift_read {
907	my $self = shift;	1193	my $self = shift;
908	my $cb = pop;	1194	my $cb = pop;
…		…
914	->($self, $cb, @_);	1200	->($self, $cb, @_);
915	}	1201	}
916		1202
917		1203
918	unshift @{ $self->{_queue} }, $cb;	1204	unshift @{ $self->{_queue} }, $cb;
919	$self->_drain_rbuf unless $self->{_in_drain};	1205	$self->_drain_rbuf;
920	}	1206	}
921		1207
922	=item $handle->push_read (type => @args, $cb)	1208	=item $handle->push_read (type => @args, $cb)
923		1209
924	=item $handle->unshift_read (type => @args, $cb)	1210	=item $handle->unshift_read (type => @args, $cb)
…		…
1057	return 1;	1343	return 1;
1058	}	1344	}
1059		1345
1060	# reject	1346	# reject
1061	if ($reject && $$rbuf =~ $reject) {	1347	if ($reject && $$rbuf =~ $reject) {
1062	$self->_error (&Errno::EBADMSG);	1348	$self->_error (Errno::EBADMSG);
1063	}	1349	}
1064		1350
1065	# skip	1351	# skip
1066	if ($skip && $$rbuf =~ $skip) {	1352	if ($skip && $$rbuf =~ $skip) {
1067	$data .= substr $$rbuf, 0, $+[0], "";	1353	$data .= substr $$rbuf, 0, $+[0], "";
…		…
1083	my ($self, $cb) = @_;	1369	my ($self, $cb) = @_;
1084		1370
1085	sub {	1371	sub {
1086	unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {	1372	unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {
1087	if ($_[0]{rbuf} =~ /[^0-9]/) {	1373	if ($_[0]{rbuf} =~ /[^0-9]/) {
1088	$self->_error (&Errno::EBADMSG);	1374	$self->_error (Errno::EBADMSG);
1089	}	1375	}
1090	return;	1376	return;
1091	}	1377	}
1092		1378
1093	my $len = $1;	1379	my $len = $1;
…		…
1096	my $string = $_[1];	1382	my $string = $_[1];
1097	$_[0]->unshift_read (chunk => 1, sub {	1383	$_[0]->unshift_read (chunk => 1, sub {
1098	if ($_[1] eq ",") {	1384	if ($_[1] eq ",") {
1099	$cb->($_[0], $string);	1385	$cb->($_[0], $string);
1100	} else {	1386	} else {
1101	$self->_error (&Errno::EBADMSG);	1387	$self->_error (Errno::EBADMSG);
1102	}	1388	}
1103	});	1389	});
1104	});	1390	});
1105		1391
1106	1	1392	1
…		…
1173	=cut	1459	=cut
1174		1460
1175	register_read_type json => sub {	1461	register_read_type json => sub {
1176	my ($self, $cb) = @_;	1462	my ($self, $cb) = @_;
1177		1463
1178	require JSON;	1464	my $json = $self->{json} ||=
		1465	eval { require JSON::XS; JSON::XS->new->utf8 }
		1466	|| do { require JSON; JSON->new->utf8 };
1179		1467
1180	my $data;	1468	my $data;
1181	my $rbuf = \$self->{rbuf};	1469	my $rbuf = \$self->{rbuf};
1182
1183	my $json = $self->{json} ||= JSON->new->utf8;
1184		1470
1185	sub {	1471	sub {
1186	my $ref = eval { $json->incr_parse ($self->{rbuf}) };	1472	my $ref = eval { $json->incr_parse ($self->{rbuf}) };
1187		1473
1188	if ($ref) {	1474	if ($ref) {
…		…
1196	$json->incr_skip;	1482	$json->incr_skip;
1197		1483
1198	$self->{rbuf} = $json->incr_text;	1484	$self->{rbuf} = $json->incr_text;
1199	$json->incr_text = "";	1485	$json->incr_text = "";
1200		1486
1201	$self->_error (&Errno::EBADMSG);	1487	$self->_error (Errno::EBADMSG);
1202		1488
1203	()	1489	()
1204	} else {	1490	} else {
1205	$self->{rbuf} = "";	1491	$self->{rbuf} = "";
1206		1492
…		…
1243	# read remaining chunk	1529	# read remaining chunk
1244	$_[0]->unshift_read (chunk => $len, sub {	1530	$_[0]->unshift_read (chunk => $len, sub {
1245	if (my $ref = eval { Storable::thaw ($_[1]) }) {	1531	if (my $ref = eval { Storable::thaw ($_[1]) }) {
1246	$cb->($_[0], $ref);	1532	$cb->($_[0], $ref);
1247	} else {	1533	} else {
1248	$self->_error (&Errno::EBADMSG);	1534	$self->_error (Errno::EBADMSG);
1249	}	1535	}
1250	});	1536	});
1251	}	1537	}
1252		1538
1253	1	1539	1
…		…
1305	my ($self) = @_;	1591	my ($self) = @_;
1306		1592
1307	unless ($self->{_rw} || $self->{_eof}) {	1593	unless ($self->{_rw} || $self->{_eof}) {
1308	Scalar::Util::weaken $self;	1594	Scalar::Util::weaken $self;
1309		1595
1310	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1596	$self->{_rw} = AE::io $self->{fh}, 0, sub {
1311	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});	1597	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1312	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;
1313		1599
1314	if ($len > 0) {	1600	if ($len > 0) {
1315	$self->{_activity} = AnyEvent->now;	1601	$self->{_activity} = $self->{_ractivity} = AE::now;
1316		1602
1317	if ($self->{tls}) {	1603	if ($self->{tls}) {
1318	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);	1604	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1319		1605
1320	&_dotls ($self);	1606	&_dotls ($self);
1321	} else {	1607	} else {
1322	$self->_drain_rbuf unless $self->{_in_drain};	1608	$self->_drain_rbuf;
1323	}	1609	}
1324		1610
1325	} elsif (defined $len) {	1611	} elsif (defined $len) {
1326	delete $self->{_rw};	1612	delete $self->{_rw};
1327	$self->{_eof} = 1;	1613	$self->{_eof} = 1;
1328	$self->_drain_rbuf unless $self->{_in_drain};	1614	$self->_drain_rbuf;
1329		1615
1330	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1616	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1331	return $self->_error ($!, 1);	1617	return $self->_error ($!, 1);
1332	}	1618	}
1333	});	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);
1334	}	1643	}
1335	}	1644	}
1336		1645
1337	# 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.
1338	sub _dotls {	1651	sub _dotls {
1339	my ($self) = @_;	1652	my ($self) = @_;
1340		1653
1341	my $tmp;	1654	my $tmp;
1342		1655
1343	if (length $self->{_tls_wbuf}) {	1656	if (length $self->{_tls_wbuf}) {
1344	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1657	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1345	substr $self->{_tls_wbuf}, 0, $tmp, "";	1658	substr $self->{_tls_wbuf}, 0, $tmp, "";
1346	}	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 || $!);
1347	}	1665	}
1348		1666
1349	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {	1667	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
1350	unless (length $tmp) {	1668	unless (length $tmp) {
1351	# let's treat SSL-eof as we treat normal EOF	1669	$self->{_on_starttls}
1352	delete $self->{_rw};	1670	and (delete $self->{_on_starttls})->($self, undef, "EOF during handshake"); # ???
1353	$self->{_eof} = 1;
1354	&_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	}
1355	}	1681	}
1356		1682
1357	$self->{_tls_rbuf} .= $tmp;	1683	$self->{_tls_rbuf} .= $tmp;
1358	$self->_drain_rbuf unless $self->{_in_drain};	1684	$self->_drain_rbuf;
1359	$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
1360	}	1686	}
1361		1687
1362	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);	1688	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1363
1364	if ($tmp != Net::SSLeay::ERROR_WANT_READ ()) {
1365	if ($tmp == Net::SSLeay::ERROR_SYSCALL ()) {
1366	return $self->_error ($!, 1);	1689	return $self->_tls_error ($tmp)
1367	} elsif ($tmp == Net::SSLeay::ERROR_SSL ()) {	1690	if $tmp != $ERROR_WANT_READ
1368	return $self->_error (&Errno::EIO, 1);	1691	&& ($tmp != $ERROR_SYSCALL || $!);
1369	}
1370
1371	# all other errors are fine for our purposes
1372	}
1373		1692
1374	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1693	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1375	$self->{wbuf} .= $tmp;	1694	$self->{wbuf} .= $tmp;
1376	$self->_drain_wbuf;	1695	$self->_drain_wbuf;
1377	}	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");
1378	}	1701	}
1379		1702
1380	=item $handle->starttls ($tls[, $tls_ctx])	1703	=item $handle->starttls ($tls[, $tls_ctx])
1381		1704
1382	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	1705	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
1383	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
1384	C<starttls>.	1707	C<starttls>.
1385		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
1386	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
1387	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1714	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1388		1715
1389	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
1390	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.
1391		1720
1392	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
1393	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
1394	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.
1395		1725
1396	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
1397	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.
1398		1729
1399	=cut	1730	=cut
		1731
		1732	our %TLS_CACHE; #TODO not yet documented, should we?
1400		1733
1401	sub starttls {	1734	sub starttls {
1402	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};
1403		1744
1404	require Net::SSLeay;	1745	require Net::SSLeay;
1405		1746
1406	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
1407	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	}
1408		1765
1409	if ($ssl eq "accept") {	1766	$self->{tls_ctx} = $ctx || TLS_CTX ();
1410	$ssl = Net::SSLeay::new ($ctx || TLS_CTX ());	1767	$self->{tls} = $tls = $self->{tls_ctx}->_get_session ($tls, $self, $self->{peername});
1411	Net::SSLeay::set_accept_state ($ssl);
1412	} elsif ($ssl eq "connect") {
1413	$ssl = Net::SSLeay::new ($ctx || TLS_CTX ());
1414	Net::SSLeay::set_connect_state ($ssl);
1415	}
1416
1417	$self->{tls} = $ssl;
1418		1768
1419	# 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)
1420	# but the openssl maintainers basically said: "trust us, it just works".	1770	# but the openssl maintainers basically said: "trust us, it just works".
1421	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1771	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1422	# and mismaintained ssleay-module doesn't even offer them).	1772	# and mismaintained ssleay-module doesn't even offer them).
…		…
1426	#	1776	#
1427	# 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.
1428	# 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,
1429	# 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
1430	# have identity issues in that area.	1780	# have identity issues in that area.
1431	Net::SSLeay::CTX_set_mode ($self->{tls},	1781	# Net::SSLeay::CTX_set_mode ($ssl,
1432	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)	1782	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)
1433	| (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);
1434		1785
1435	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1786	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1436	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1787	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1437		1788
		1789	Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf});
		1790
1438	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};
1439		1795
1440	&_dotls; # need to trigger the initial handshake	1796	&_dotls; # need to trigger the initial handshake
1441	$self->start_read; # make sure we actually do read	1797	$self->start_read; # make sure we actually do read
1442	}	1798	}
1443		1799
1444	=item $handle->stoptls	1800	=item $handle->stoptls
1445		1801
1446	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
1447	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
1448	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
1449	afterwards.	1805	the stream afterwards.
1450		1806
1451	=cut	1807	=cut
1452		1808
1453	sub stoptls {	1809	sub stoptls {
1454	my ($self) = @_;	1810	my ($self) = @_;
…		…
1456	if ($self->{tls}) {	1812	if ($self->{tls}) {
1457	Net::SSLeay::shutdown ($self->{tls});	1813	Net::SSLeay::shutdown ($self->{tls});
1458		1814
1459	&_dotls;	1815	&_dotls;
1460		1816
1461	# 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#
1462	# we, we... have to use openssl :/	1818	# # we, we... have to use openssl :/#d#
1463	&_freetls;	1819	# &_freetls;#d#
1464	}	1820	}
1465	}	1821	}
1466		1822
1467	sub _freetls {	1823	sub _freetls {
1468	my ($self) = @_;	1824	my ($self) = @_;
1469		1825
1470	return unless $self->{tls};	1826	return unless $self->{tls};
1471		1827
1472	Net::SSLeay::free (delete $self->{tls});	1828	$self->{tls_ctx}->_put_session (delete $self->{tls})
		1829	if $self->{tls} > 0;
1473		1830
1474	delete @$self{qw(_rbio _wbio _tls_wbuf)};	1831	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1475	}	1832	}
1476		1833
1477	sub DESTROY {	1834	sub DESTROY {
1478	my $self = shift;	1835	my ($self) = @_;
1479		1836
1480	&_freetls;	1837	&_freetls;
1481		1838
1482	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	1839	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1483		1840
1484	if ($linger && length $self->{wbuf}) {	1841	if ($linger && length $self->{wbuf} && $self->{fh}) {
1485	my $fh = delete $self->{fh};	1842	my $fh = delete $self->{fh};
1486	my $wbuf = delete $self->{wbuf};	1843	my $wbuf = delete $self->{wbuf};
1487		1844
1488	my @linger;	1845	my @linger;
1489		1846
1490	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {	1847	push @linger, AE::io $fh, 1, sub {
1491	my $len = syswrite $fh, $wbuf, length $wbuf;	1848	my $len = syswrite $fh, $wbuf, length $wbuf;
1492		1849
1493	if ($len > 0) {	1850	if ($len > 0) {
1494	substr $wbuf, 0, $len, "";	1851	substr $wbuf, 0, $len, "";
1495	} else {	1852	} else {
1496	@linger = (); # end	1853	@linger = (); # end
1497	}	1854	}
1498	});	1855	};
1499	push @linger, AnyEvent->timer (after => $linger, cb => sub {	1856	push @linger, AE::timer $linger, 0, sub {
1500	@linger = ();	1857	@linger = ();
1501	});	1858	};
1502	}	1859	}
1503	}	1860	}
1504		1861
1505	=item $handle->destroy	1862	=item $handle->destroy
1506		1863
1507	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
1508	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
1509	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).
1510		1869
1511	Normally, you can just "forget" any references to an AnyEvent::Handle	1870	Normally, you can just "forget" any references to an AnyEvent::Handle
1512	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
1513	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
1514	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
1515	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
1516	that case.	1875	that case.
1517		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
1518	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
1519	data, as specified by the C<linger> option, however.	1883	data, as specified by the C<linger> option, however.
1520		1884
1521	=cut	1885	=cut
1522		1886
1523	sub destroy {	1887	sub destroy {
1524	my ($self) = @_;	1888	my ($self) = @_;
1525		1889
1526	$self->DESTROY;	1890	$self->DESTROY;
1527	%$self = ();	1891	%$self = ();
		1892	bless $self, "AnyEvent::Handle::destroyed";
		1893	}
		1894
		1895	sub AnyEvent::Handle::destroyed::AUTOLOAD {
		1896	#nop
1528	}	1897	}
1529		1898
1530	=item AnyEvent::Handle::TLS_CTX	1899	=item AnyEvent::Handle::TLS_CTX
1531		1900
1532	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
1533	default for TLS mode.	1902	for TLS mode.
1534		1903
1535	The context is created like this:	1904	The context is created by calling L<AnyEvent::TLS> without any arguments.
1536
1537	Net::SSLeay::load_error_strings;
1538	Net::SSLeay::SSLeay_add_ssl_algorithms;
1539	Net::SSLeay::randomize;
1540
1541	my $CTX = Net::SSLeay::CTX_new;
1542
1543	Net::SSLeay::CTX_set_options $CTX, Net::SSLeay::OP_ALL
1544		1905
1545	=cut	1906	=cut
1546		1907
1547	our $TLS_CTX;	1908	our $TLS_CTX;
1548		1909
1549	sub TLS_CTX() {	1910	sub TLS_CTX() {
1550	$TLS_CTX || do {	1911	$TLS_CTX ||= do {
1551	require Net::SSLeay;	1912	require AnyEvent::TLS;
1552		1913
1553	Net::SSLeay::load_error_strings ();	1914	new AnyEvent::TLS
1554	Net::SSLeay::SSLeay_add_ssl_algorithms ();
1555	Net::SSLeay::randomize ();
1556
1557	$TLS_CTX = Net::SSLeay::CTX_new ();
1558
1559	Net::SSLeay::CTX_set_options ($TLS_CTX, Net::SSLeay::OP_ALL ());
1560
1561	$TLS_CTX
1562	}	1915	}
1563	}	1916	}
1564		1917
1565	=back	1918	=back
1566		1919
…		…
1605		1958
1606	$handle->on_read (sub { });	1959	$handle->on_read (sub { });
1607	$handle->on_eof (undef);	1960	$handle->on_eof (undef);
1608	$handle->on_error (sub {	1961	$handle->on_error (sub {
1609	my $data = delete $_[0]{rbuf};	1962	my $data = delete $_[0]{rbuf};
1610	undef $handle;
1611	});	1963	});
1612		1964
1613	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
1614	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
1615	fact, all data has been received.	1967	fact, all data has been received.
…		…
1631	$handle->on_drain (sub {	1983	$handle->on_drain (sub {
1632	warn "all data submitted to the kernel\n";	1984	warn "all data submitted to the kernel\n";
1633	undef $handle;	1985	undef $handle;
1634	});	1986	});
1635		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
1636	=back	2076	=back
1637		2077
1638		2078
1639	=head1 SUBCLASSING AnyEvent::Handle	2079	=head1 SUBCLASSING AnyEvent::Handle
1640		2080

Diff Legend

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