[ViewVC] Diff of: cvs/AnyEvent/lib/AnyEvent/Handle.pm

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

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.132 by elmex, Thu Jul 2 22:25:13 2009 UTC vs. Revision 1.177 by root, Sun Aug 9 00:24:35 2009 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.132 by elmex, Thu Jul 2 22:25:13 2009 UTC vs.
Revision 1.177 by root, Sun Aug 9 00:24:35 2009 UTC