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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.136 by root, Fri Jul 3 21:44:14 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.452;	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 $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value...	71	=item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value...
69		72
70	The constructor supports these arguments (all as C<< 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, $message)
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	AnyEvent::Handle tries to find an appropriate error code for you to check
113	against, but in some cases (TLS errors), this does not work well. It is
114	recommended to always output the C<$message> argument in human-readable
115	error messages (it's usually the same as C<"$!">).
116
117	Non-fatal errors can be retried by simply returning, but it is recommended
118	to simply ignore this parameter and instead abondon the handle object
119	when this callback is invoked. Examples of non-fatal errors are timeouts
120	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
121
122	On callback entrance, the value of C<$!> contains the operating system
123	error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
124	C<EPROTO>).
125
126	While not mandatory, it is I<highly> recommended to set this callback, as
127	you will not be notified of errors otherwise. The default simply calls
128	C<croak>.
129
130	=item on_read => $cb->($handle)
131
132	This sets the default read callback, which is called when data arrives
133	and no read request is in the queue (unlike read queue callbacks, this
134	callback will only be called when at least one octet of data is in the
135	read buffer).
136
137	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
138	method or access the C<$handle->{rbuf}> member directly. Note that you
139	must not enlarge or modify the read buffer, you can only remove data at
140	the beginning from it.
141
142	When an EOF condition is detected then AnyEvent::Handle will first try to
143	feed all the remaining data to the queued callbacks and C<on_read> before
144	calling the C<on_eof> callback. If no progress can be made, then a fatal
145	error will be raised (with C<$!> set to C<EPIPE>).
146		208
147	=item on_drain => $cb->($handle)	209	=item on_drain => $cb->($handle)
148		210
149	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
150	(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).
157	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
158	the file when the write queue becomes empty.	220	the file when the write queue becomes empty.
159		221
160	=item timeout => $fractional_seconds	222	=item timeout => $fractional_seconds
161		223
		224	=item rtimeout => $fractional_seconds
		225
		226	=item wtimeout => $fractional_seconds
		227
162	If non-zero, then this enables an "inactivity" timeout: whenever this many	228	If non-zero, then these enables an "inactivity" timeout: whenever this
163	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
164	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
165	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>.
166		239
167	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
168	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
169	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
170	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
…		…
249		322
250	A string used to identify the remote site - usually the DNS hostname	323	A string used to identify the remote site - usually the DNS hostname
251	(I<not> IDN!) used to create the connection, rarely the IP address.	324	(I<not> IDN!) used to create the connection, rarely the IP address.
252		325
253	Apart from being useful in error messages, this string is also used in TLS	326	Apart from being useful in error messages, this string is also used in TLS
254	common name verification (see C<verify_cn> in L<AnyEvent::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>.
255		330
256	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	331	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
257		332
258	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
259	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
…		…
296		371
297	Instead of an object, you can also specify a hash reference with C<< key	372	Instead of an object, you can also specify a hash reference with C<< key
298	=> value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a	373	=> value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a
299	new TLS context object.	374	new TLS context object.
300		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.
		407
301	=item json => JSON or JSON::XS object	408	=item json => JSON or JSON::XS object
302		409
303	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.
304		411
305	If you don't supply it, then AnyEvent::Handle will create and use a	412	If you don't supply it, then AnyEvent::Handle will create and use a
…		…
315		422
316	sub new {	423	sub new {
317	my $class = shift;	424	my $class = shift;
318	my $self = bless { @_ }, $class;	425	my $self = bless { @_ }, $class;
319		426
320	$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) = @_;
321		490
322	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	491	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
323		492
		493	$self->{_activity} =
		494	$self->{_ractivity} =
324	$self->{_activity} = AnyEvent->now;	495	$self->{_wactivity} = AE::now;
325	$self->_timeout;	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};
326		500
327	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};	501	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
328		502
329	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})	503	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
330	if $self->{tls};	504	if $self->{tls};
331		505
332	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};	506	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
333		507
334	$self->start_read	508	$self->start_read
335	if $self->{on_read};	509	if $self->{on_read} \|\| @{ $self->{_queue} };
336		510
337	$self->{fh} && $self	511	$self->_drain_wbuf;
338	}	512	}
339		513
340	sub _shutdown {	514	#sub _shutdown {
341	my ($self) = @_;	515	# my ($self) = @_;
342		516	#
343	delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)};	517	# delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)};
344	$self->{_eof} = 1; # tell starttls et. al to stop trying	518	# $self->{_eof} = 1; # tell starttls et. al to stop trying
345		519	#
346	&_freetls;	520	# &_freetls;
347	}	521	#}
348		522
349	sub _error {	523	sub _error {
350	my ($self, $errno, $fatal, $message) = @_;	524	my ($self, $errno, $fatal, $message) = @_;
351		525
352	$self->_shutdown
353	if $fatal;
354
355	$! = $errno;	526	$! = $errno;
356	$message \|\|= "$!";	527	$message \|\|= "$!";
357		528
358	if ($self->{on_error}) {	529	if ($self->{on_error}) {
359	$self->{on_error}($self, $fatal, $message);	530	$self->{on_error}($self, $fatal, $message);
		531	$self->destroy if $fatal;
360	} elsif ($self->{fh}) {	532	} elsif ($self->{fh}) {
		533	$self->destroy;
361	Carp::croak "AnyEvent::Handle uncaught error: $message";	534	Carp::croak "AnyEvent::Handle uncaught error: $message";
362	}	535	}
363	}	536	}
364		537
365	=item $fh = $handle->fh	538	=item $fh = $handle->fh
…		…
390	$_[0]{on_eof} = $_[1];	563	$_[0]{on_eof} = $_[1];
391	}	564	}
392		565
393	=item $handle->on_timeout ($cb)	566	=item $handle->on_timeout ($cb)
394		567
395	Replace the current C<on_timeout> callback, or disables the callback (but	568	=item $handle->on_rtimeout ($cb)
396	not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
397	argument and method.
398		569
399	=cut	570	=item $handle->on_wtimeout ($cb)
400		571
401	sub on_timeout {	572	Replace the current C<on_timeout>, C<on_rtimeout> or C<on_wtimeout>
402	$_[0]{on_timeout} = $_[1];	573	callback, or disables the callback (but not the timeout) if C<$cb> =
403	}	574	C<undef>. See the C<timeout> constructor argument and method.
		575
		576	=cut
		577
		578	# see below
404		579
405	=item $handle->autocork ($boolean)	580	=item $handle->autocork ($boolean)
406		581
407	Enables or disables the current autocork behaviour (see C<autocork>	582	Enables or disables the current autocork behaviour (see C<autocork>
408	constructor argument). Changes will only take effect on the next write.	583	constructor argument). Changes will only take effect on the next write.
…		…
423	sub no_delay {	598	sub no_delay {
424	$_[0]{no_delay} = $_[1];	599	$_[0]{no_delay} = $_[1];
425		600
426	eval {	601	eval {
427	local $SIG{__DIE__};	602	local $SIG{__DIE__};
428	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};
429	};	605	};
430	}	606	}
431		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
432	#############################################################################	638	#############################################################################
433		639
434	=item $handle->timeout ($seconds)	640	=item $handle->timeout ($seconds)
435		641
		642	=item $handle->rtimeout ($seconds)
		643
		644	=item $handle->wtimeout ($seconds)
		645
436	Configures (or disables) the inactivity timeout.	646	Configures (or disables) the inactivity timeout.
437		647
438	=cut	648	=item $handle->timeout_reset
439		649
440	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 {
441	my ($self, $timeout) = @_;	672	my ($self, $new_value) = @_;
442		673
443	$self->{timeout} = $timeout;	674	$self->{$timeout} = $new_value;
444	$self->_timeout;	675	delete $self->{$tw}; &$cb;
445	}	676	};
446		677
		678	*{"${dir}timeout_reset"} = sub {
		679	$_[0]{$activity} = AE::now;
		680	};
		681
		682	# main workhorse:
447	# reset the timeout watcher, as neccessary	683	# reset the timeout watcher, as neccessary
448	# also check for time-outs	684	# also check for time-outs
449	sub _timeout {	685	$cb = sub {
450	my ($self) = @_;	686	my ($self) = @_;
451		687
452	if ($self->{timeout}) {	688	if ($self->{$timeout} && $self->{fh}) {
453	my $NOW = AnyEvent->now;	689	my $NOW = AE::now;
454		690
455	# when would the timeout trigger?	691	# when would the timeout trigger?
456	my $after = $self->{_activity} + $self->{timeout} - $NOW;	692	my $after = $self->{$activity} + $self->{$timeout} - $NOW;
457		693
458	# now or in the past already?	694	# now or in the past already?
459	if ($after <= 0) {	695	if ($after <= 0) {
460	$self->{_activity} = $NOW;	696	$self->{$activity} = $NOW;
461		697
462	if ($self->{on_timeout}) {	698	if ($self->{$on_timeout}) {
463	$self->{on_timeout}($self);	699	$self->{$on_timeout}($self);
464	} else {	700	} else {
465	$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};
466	}	709	}
467		710
468	# callback could have changed timeout value, optimise	711	Scalar::Util::weaken $self;
469	return unless $self->{timeout};	712	return unless $self; # ->error could have destroyed $self
470		713
471	# calculate new after	714	$self->{$tw} \|\|= AE::timer $after, 0, sub {
472	$after = $self->{timeout};	715	delete $self->{$tw};
		716	$cb->($self);
		717	};
		718	} else {
		719	delete $self->{$tw};
473	}	720	}
474
475	Scalar::Util::weaken $self;
476	return unless $self; # ->error could have destroyed $self
477
478	$self->{_tw} \|\|= AnyEvent->timer (after => $after, cb => sub {
479	delete $self->{_tw};
480	$self->_timeout;
481	});
482	} else {
483	delete $self->{_tw};
484	}	721	}
485	}	722	}
486		723
487	#############################################################################	724	#############################################################################
488		725
…		…
533	Scalar::Util::weaken $self;	770	Scalar::Util::weaken $self;
534		771
535	my $cb = sub {	772	my $cb = sub {
536	my $len = syswrite $self->{fh}, $self->{wbuf};	773	my $len = syswrite $self->{fh}, $self->{wbuf};
537		774
538	if ($len >= 0) {	775	if (defined $len) {
539	substr $self->{wbuf}, 0, $len, "";	776	substr $self->{wbuf}, 0, $len, "";
540		777
541	$self->{_activity} = AnyEvent->now;	778	$self->{_activity} = $self->{_wactivity} = AE::now;
542		779
543	$self->{on_drain}($self)	780	$self->{on_drain}($self)
544	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})
545	&& $self->{on_drain};	782	&& $self->{on_drain};
546		783
…		…
552		789
553	# try to write data immediately	790	# try to write data immediately
554	$cb->() unless $self->{autocork};	791	$cb->() unless $self->{autocork};
555		792
556	# if still data left in wbuf, we need to poll	793	# if still data left in wbuf, we need to poll
557	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	794	$self->{_ww} = AE::io $self->{fh}, 1, $cb
558	if length $self->{wbuf};	795	if length $self->{wbuf};
559	};	796	};
560	}	797	}
561		798
562	our %WH;	799	our %WH;
…		…
575	->($self, @_);	812	->($self, @_);
576	}	813	}
577		814
578	if ($self->{tls}) {	815	if ($self->{tls}) {
579	$self->{_tls_wbuf} .= $_[0];	816	$self->{_tls_wbuf} .= $_[0];
580		817	&_dotls ($self) if $self->{fh};
581	&_dotls ($self);
582	} else {	818	} else {
583	$self->{wbuf} .= $_[0];	819	$self->{wbuf} .= $_[0];
584	$self->_drain_wbuf;	820	$self->_drain_wbuf if $self->{fh};
585	}	821	}
586	}	822	}
587		823
588	=item $handle->push_write (type => @args)	824	=item $handle->push_write (type => @args)
589		825
…		…
683		919
684	=item $handle->push_shutdown	920	=item $handle->push_shutdown
685		921
686	Sometimes you know you want to close the socket after writing your data	922	Sometimes you know you want to close the socket after writing your data
687	before it was actually written. One way to do that is to replace your	923	before it was actually written. One way to do that is to replace your
688	C<on_drain> handler by a callback that shuts down the socket. This method	924	C<on_drain> handler by a callback that shuts down the socket (and set
689	is a shorthand for just that, and replaces the C<on_drain> callback with:	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:
690		927
691	sub { shutdown $_[0]{fh}, 1 } # for push_shutdown	928	sub { shutdown $_[0]{fh}, 1 } # for push_shutdown
692		929
693	This simply shuts down the write side and signals an EOF condition to the	930	This simply shuts down the write side and signals an EOF condition to the
694	the peer.	931	the peer.
…		…
697	afterwards. This is the cleanest way to close a connection.	934	afterwards. This is the cleanest way to close a connection.
698		935
699	=cut	936	=cut
700		937
701	sub push_shutdown {	938	sub push_shutdown {
		939	my ($self) = @_;
		940
		941	delete $self->{low_water_mark};
702	$_[0]->{on_drain} = sub { shutdown $_[0]{fh}, 1 };	942	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });
703	}	943	}
704		944
705	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	945	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
706		946
707	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>.
…		…
802	=cut	1042	=cut
803		1043
804	sub _drain_rbuf {	1044	sub _drain_rbuf {
805	my ($self) = @_;	1045	my ($self) = @_;
806		1046
		1047	# avoid recursion
		1048	return if $self->{_skip_drain_rbuf};
807	local $self->{_in_drain} = 1;	1049	local $self->{_skip_drain_rbuf} = 1;
808
809	if (
810	defined $self->{rbuf_max}
811	&& $self->{rbuf_max} < length $self->{rbuf}
812	) {
813	$self->_error (&Errno::ENOSPC, 1), return;
814	}
815		1050
816	while () {	1051	while () {
817	# 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
818	# 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.
819	$self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf};	1054	$self->{rbuf} .= delete $self->{_tls_rbuf}
		1055	if exists $self->{_tls_rbuf};
820		1056
821	my $len = length $self->{rbuf};	1057	my $len = length $self->{rbuf};
822		1058
823	if (my $cb = shift @{ $self->{_queue} }) {	1059	if (my $cb = shift @{ $self->{_queue} }) {
824	unless ($cb->($self)) {	1060	unless ($cb->($self)) {
825	if ($self->{_eof}) {	1061	# no progress can be made
826	# no progress can be made (not enough data and no data forthcoming)	1062	# (not enough data and no data forthcoming)
827	$self->_error (&Errno::EPIPE, 1), return;	1063	$self->_error (Errno::EPIPE, 1), return
828	}	1064	if $self->{_eof};
829		1065
830	unshift @{ $self->{_queue} }, $cb;	1066	unshift @{ $self->{_queue} }, $cb;
831	last;	1067	last;
832	}	1068	}
833	} elsif ($self->{on_read}) {	1069	} elsif ($self->{on_read}) {
…		…
840	&& !@{ $self->{_queue} } # and the queue is still empty	1076	&& !@{ $self->{_queue} } # and the queue is still empty
841	&& $self->{on_read} # but we still have on_read	1077	&& $self->{on_read} # but we still have on_read
842	) {	1078	) {
843	# no further data will arrive	1079	# no further data will arrive
844	# so no progress can be made	1080	# so no progress can be made
845	$self->_error (&Errno::EPIPE, 1), return	1081	$self->_error (Errno::EPIPE, 1), return
846	if $self->{_eof};	1082	if $self->{_eof};
847		1083
848	last; # more data might arrive	1084	last; # more data might arrive
849	}	1085	}
850	} else {	1086	} else {
…		…
853	last;	1089	last;
854	}	1090	}
855	}	1091	}
856		1092
857	if ($self->{_eof}) {	1093	if ($self->{_eof}) {
858	if ($self->{on_eof}) {	1094	$self->{on_eof}
859	$self->{on_eof}($self)	1095	? $self->{on_eof}($self)
860	} else {	1096	: $self->_error (0, 1, "Unexpected end-of-file");
861	$self->_error (0, 1);	1097
862	}	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;
863	}	1106	}
864		1107
865	# may need to restart read watcher	1108	# may need to restart read watcher
866	unless ($self->{_rw}) {	1109	unless ($self->{_rw}) {
867	$self->start_read	1110	$self->start_read
…		…
879		1122
880	sub on_read {	1123	sub on_read {
881	my ($self, $cb) = @_;	1124	my ($self, $cb) = @_;
882		1125
883	$self->{on_read} = $cb;	1126	$self->{on_read} = $cb;
884	$self->_drain_rbuf if $cb && !$self->{_in_drain};	1127	$self->_drain_rbuf if $cb;
885	}	1128	}
886		1129
887	=item $handle->rbuf	1130	=item $handle->rbuf
888		1131
889	Returns the read buffer (as a modifiable lvalue).	1132	Returns the read buffer (as a modifiable lvalue).
…		…
941	$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")
942	->($self, $cb, @_);	1185	->($self, $cb, @_);
943	}	1186	}
944		1187
945	push @{ $self->{_queue} }, $cb;	1188	push @{ $self->{_queue} }, $cb;
946	$self->_drain_rbuf unless $self->{_in_drain};	1189	$self->_drain_rbuf;
947	}	1190	}
948		1191
949	sub unshift_read {	1192	sub unshift_read {
950	my $self = shift;	1193	my $self = shift;
951	my $cb = pop;	1194	my $cb = pop;
…		…
957	->($self, $cb, @_);	1200	->($self, $cb, @_);
958	}	1201	}
959		1202
960		1203
961	unshift @{ $self->{_queue} }, $cb;	1204	unshift @{ $self->{_queue} }, $cb;
962	$self->_drain_rbuf unless $self->{_in_drain};	1205	$self->_drain_rbuf;
963	}	1206	}
964		1207
965	=item $handle->push_read (type => @args, $cb)	1208	=item $handle->push_read (type => @args, $cb)
966		1209
967	=item $handle->unshift_read (type => @args, $cb)	1210	=item $handle->unshift_read (type => @args, $cb)
…		…
1100	return 1;	1343	return 1;
1101	}	1344	}
1102		1345
1103	# reject	1346	# reject
1104	if ($reject && $$rbuf =~ $reject) {	1347	if ($reject && $$rbuf =~ $reject) {
1105	$self->_error (&Errno::EBADMSG);	1348	$self->_error (Errno::EBADMSG);
1106	}	1349	}
1107		1350
1108	# skip	1351	# skip
1109	if ($skip && $$rbuf =~ $skip) {	1352	if ($skip && $$rbuf =~ $skip) {
1110	$data .= substr $$rbuf, 0, $+[0], "";	1353	$data .= substr $$rbuf, 0, $+[0], "";
…		…
1126	my ($self, $cb) = @_;	1369	my ($self, $cb) = @_;
1127		1370
1128	sub {	1371	sub {
1129	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {	1372	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
1130	if ($_[0]{rbuf} =~ /[^0-9]/) {	1373	if ($_[0]{rbuf} =~ /[^0-9]/) {
1131	$self->_error (&Errno::EBADMSG);	1374	$self->_error (Errno::EBADMSG);
1132	}	1375	}
1133	return;	1376	return;
1134	}	1377	}
1135		1378
1136	my $len = $1;	1379	my $len = $1;
…		…
1139	my $string = $_[1];	1382	my $string = $_[1];
1140	$_[0]->unshift_read (chunk => 1, sub {	1383	$_[0]->unshift_read (chunk => 1, sub {
1141	if ($_[1] eq ",") {	1384	if ($_[1] eq ",") {
1142	$cb->($_[0], $string);	1385	$cb->($_[0], $string);
1143	} else {	1386	} else {
1144	$self->_error (&Errno::EBADMSG);	1387	$self->_error (Errno::EBADMSG);
1145	}	1388	}
1146	});	1389	});
1147	});	1390	});
1148		1391
1149	1	1392	1
…		…
1239	$json->incr_skip;	1482	$json->incr_skip;
1240		1483
1241	$self->{rbuf} = $json->incr_text;	1484	$self->{rbuf} = $json->incr_text;
1242	$json->incr_text = "";	1485	$json->incr_text = "";
1243		1486
1244	$self->_error (&Errno::EBADMSG);	1487	$self->_error (Errno::EBADMSG);
1245		1488
1246	()	1489	()
1247	} else {	1490	} else {
1248	$self->{rbuf} = "";	1491	$self->{rbuf} = "";
1249		1492
…		…
1286	# read remaining chunk	1529	# read remaining chunk
1287	$_[0]->unshift_read (chunk => $len, sub {	1530	$_[0]->unshift_read (chunk => $len, sub {
1288	if (my $ref = eval { Storable::thaw ($_[1]) }) {	1531	if (my $ref = eval { Storable::thaw ($_[1]) }) {
1289	$cb->($_[0], $ref);	1532	$cb->($_[0], $ref);
1290	} else {	1533	} else {
1291	$self->_error (&Errno::EBADMSG);	1534	$self->_error (Errno::EBADMSG);
1292	}	1535	}
1293	});	1536	});
1294	}	1537	}
1295		1538
1296	1	1539	1
…		…
1348	my ($self) = @_;	1591	my ($self) = @_;
1349		1592
1350	unless ($self->{_rw} \|\| $self->{_eof}) {	1593	unless ($self->{_rw} \|\| $self->{_eof}) {
1351	Scalar::Util::weaken $self;	1594	Scalar::Util::weaken $self;
1352		1595
1353	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1596	$self->{_rw} = AE::io $self->{fh}, 0, sub {
1354	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});	1597	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1355	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;
1356		1599
1357	if ($len > 0) {	1600	if ($len > 0) {
1358	$self->{_activity} = AnyEvent->now;	1601	$self->{_activity} = $self->{_ractivity} = AE::now;
1359		1602
1360	if ($self->{tls}) {	1603	if ($self->{tls}) {
1361	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);	1604	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1362		1605
1363	&_dotls ($self);	1606	&_dotls ($self);
1364	} else {	1607	} else {
1365	$self->_drain_rbuf unless $self->{_in_drain};	1608	$self->_drain_rbuf;
1366	}	1609	}
1367		1610
1368	} elsif (defined $len) {	1611	} elsif (defined $len) {
1369	delete $self->{_rw};	1612	delete $self->{_rw};
1370	$self->{_eof} = 1;	1613	$self->{_eof} = 1;
1371	$self->_drain_rbuf unless $self->{_in_drain};	1614	$self->_drain_rbuf;
1372		1615
1373	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1616	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1374	return $self->_error ($!, 1);	1617	return $self->_error ($!, 1);
1375	}	1618	}
1376	});	1619	};
1377	}	1620	}
1378	}	1621	}
1379		1622
1380	our $ERROR_SYSCALL;	1623	our $ERROR_SYSCALL;
1381	our $ERROR_WANT_READ;	1624	our $ERROR_WANT_READ;
1382	our $ERROR_ZERO_RETURN;
1383		1625
1384	sub _tls_error {	1626	sub _tls_error {
1385	my ($self, $err) = @_;	1627	my ($self, $err) = @_;
1386	warn "$err,$!\n";#d#
1387		1628
1388	return $self->_error ($!, 1)	1629	return $self->_error ($!, 1)
1389	if $err == Net::SSLeay::ERROR_SYSCALL ();	1630	if $err == Net::SSLeay::ERROR_SYSCALL ();
1390		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;
1391	$self->_error (&Errno::EPROTO, 1,	1642	$self->_error (Errno::EPROTO, 1, $err);
1392	Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ()));	1643	}
1393	}	1644	}
1394		1645
1395	# poll the write BIO and send the data if applicable	1646	# poll the write BIO and send the data if applicable
1396	# also decode read data if possible	1647	# also decode read data if possible
1397	# this is basiclaly our TLS state machine	1648	# this is basiclaly our TLS state machine
…		…
1408	}	1659	}
1409		1660
1410	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);	1661	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);
1411	return $self->_tls_error ($tmp)	1662	return $self->_tls_error ($tmp)
1412	if $tmp != $ERROR_WANT_READ	1663	if $tmp != $ERROR_WANT_READ
1413	&& ($tmp != $ERROR_SYSCALL \|\| $!)	1664	&& ($tmp != $ERROR_SYSCALL \|\| $!);
1414	&& $tmp != $ERROR_ZERO_RETURN;
1415	}	1665	}
1416		1666
1417	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {	1667	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
1418	unless (length $tmp) {	1668	unless (length $tmp) {
1419	# let's treat SSL-eof as we treat normal EOF	1669	$self->{_on_starttls}
1420	delete $self->{_rw};	1670	and (delete $self->{_on_starttls})->($self, undef, "EOF during handshake"); # ???
1421	$self->{_eof} = 1;
1422	&_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	}
1423	}	1681	}
1424		1682
1425	$self->{_tls_rbuf} .= $tmp;	1683	$self->{_tls_rbuf} .= $tmp;
1426	$self->_drain_rbuf unless $self->{_in_drain};	1684	$self->_drain_rbuf;
1427	$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
1428	}	1686	}
1429		1687
1430	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);	1688	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1431	return $self->_tls_error ($tmp)	1689	return $self->_tls_error ($tmp)
1432	if $tmp != $ERROR_WANT_READ	1690	if $tmp != $ERROR_WANT_READ
1433	&& ($tmp != $ERROR_SYSCALL \|\| $!)	1691	&& ($tmp != $ERROR_SYSCALL \|\| $!);
1434	&& $tmp != $ERROR_ZERO_RETURN;
1435		1692
1436	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1693	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1437	$self->{wbuf} .= $tmp;	1694	$self->{wbuf} .= $tmp;
1438	$self->_drain_wbuf;	1695	$self->_drain_wbuf;
1439	}	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");
1440	}	1701	}
1441		1702
1442	=item $handle->starttls ($tls[, $tls_ctx])	1703	=item $handle->starttls ($tls[, $tls_ctx])
1443		1704
1444	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	1705	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
1445	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
1446	C<starttls>.	1707	C<starttls>.
		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.
1447		1712
1448	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
1449	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1714	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1450		1715
1451	The second argument is the optional C<AnyEvent::TLS> object that is used	1716	The second argument is the optional C<AnyEvent::TLS> object that is used
…		…
1456	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS	1721	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS
1457	context in C<< $handle->{tls_ctx} >> after this call and can be used or	1722	context in C<< $handle->{tls_ctx} >> after this call and can be used or
1458	changed to your liking. Note that the handshake might have already started	1723	changed to your liking. Note that the handshake might have already started
1459	when this function returns.	1724	when this function returns.
1460		1725
1461	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
1462	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.
1463		1729
1464	=cut	1730	=cut
		1731
		1732	our %TLS_CACHE; #TODO not yet documented, should we?
1465		1733
1466	sub starttls {	1734	sub starttls {
1467	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};
1468		1744
1469	require Net::SSLeay;	1745	require Net::SSLeay;
1470		1746
1471	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"
1472	if $self->{tls};
1473
1474	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();	1747	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1475	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();	1748	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1476	$ERROR_ZERO_RETURN = Net::SSLeay::ERROR_ZERO_RETURN ();
1477		1749
		1750	$tls = $self->{tls};
1478	$ctx \|\|= $self->{tls_ctx};	1751	$ctx = $self->{tls_ctx};
		1752
		1753	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
1479		1754
1480	if ("HASH" eq ref $ctx) {	1755	if ("HASH" eq ref $ctx) {
1481	require AnyEvent::TLS;	1756	require AnyEvent::TLS;
1482		1757
1483	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context	1758	if ($ctx->{cache}) {
		1759	my $key = $ctx+0;
		1760	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;
		1761	} else {
1484	$ctx = new AnyEvent::TLS %$ctx;	1762	$ctx = new AnyEvent::TLS %$ctx;
		1763	}
1485	}	1764	}
1486		1765
1487	$self->{tls_ctx} = $ctx \|\| TLS_CTX ();	1766	$self->{tls_ctx} = $ctx \|\| TLS_CTX ();
1488	$self->{tls} = $ssl = $self->{tls_ctx}->_get_session ($ssl, $self, $self->{peername});	1767	$self->{tls} = $tls = $self->{tls_ctx}->_get_session ($tls, $self, $self->{peername});
1489		1768
1490	# 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)
1491	# but the openssl maintainers basically said: "trust us, it just works".	1770	# but the openssl maintainers basically said: "trust us, it just works".
1492	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1771	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1493	# and mismaintained ssleay-module doesn't even offer them).	1772	# and mismaintained ssleay-module doesn't even offer them).
…		…
1500	# 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
1501	# have identity issues in that area.	1780	# have identity issues in that area.
1502	# Net::SSLeay::CTX_set_mode ($ssl,	1781	# Net::SSLeay::CTX_set_mode ($ssl,
1503	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1782	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
1504	# \| (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));
1505	Net::SSLeay::CTX_set_mode ($ssl, 1\|2);	1784	Net::SSLeay::CTX_set_mode ($tls, 1\|2);
1506		1785
1507	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1786	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1508	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1787	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1509		1788
		1789	Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf});
		1790
1510	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};
1511		1795
1512	&_dotls; # need to trigger the initial handshake	1796	&_dotls; # need to trigger the initial handshake
1513	$self->start_read; # make sure we actually do read	1797	$self->start_read; # make sure we actually do read
1514	}	1798	}
1515		1799
1516	=item $handle->stoptls	1800	=item $handle->stoptls
1517		1801
1518	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
1519	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
1520	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
1521	afterwards.	1805	the stream afterwards.
1522		1806
1523	=cut	1807	=cut
1524		1808
1525	sub stoptls {	1809	sub stoptls {
1526	my ($self) = @_;	1810	my ($self) = @_;
…		…
1528	if ($self->{tls}) {	1812	if ($self->{tls}) {
1529	Net::SSLeay::shutdown ($self->{tls});	1813	Net::SSLeay::shutdown ($self->{tls});
1530		1814
1531	&_dotls;	1815	&_dotls;
1532		1816
1533	# 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#
1534	# we, we... have to use openssl :/	1818	# # we, we... have to use openssl :/#d#
1535	&_freetls;	1819	# &_freetls;#d#
1536	}	1820	}
1537	}	1821	}
1538		1822
1539	sub _freetls {	1823	sub _freetls {
1540	my ($self) = @_;	1824	my ($self) = @_;
1541		1825
1542	return unless $self->{tls};	1826	return unless $self->{tls};
1543		1827
1544	$self->{tls_ctx}->_put_session (delete $self->{tls});	1828	$self->{tls_ctx}->_put_session (delete $self->{tls})
		1829	if $self->{tls} > 0;
1545		1830
1546	delete @$self{qw(_rbio _wbio _tls_wbuf)};	1831	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1547	}	1832	}
1548		1833
1549	sub DESTROY {	1834	sub DESTROY {
1550	my ($self) = @_;	1835	my ($self) = @_;
1551		1836
1552	&_freetls;	1837	&_freetls;
1553		1838
1554	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	1839	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1555		1840
1556	if ($linger && length $self->{wbuf}) {	1841	if ($linger && length $self->{wbuf} && $self->{fh}) {
1557	my $fh = delete $self->{fh};	1842	my $fh = delete $self->{fh};
1558	my $wbuf = delete $self->{wbuf};	1843	my $wbuf = delete $self->{wbuf};
1559		1844
1560	my @linger;	1845	my @linger;
1561		1846
1562	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {	1847	push @linger, AE::io $fh, 1, sub {
1563	my $len = syswrite $fh, $wbuf, length $wbuf;	1848	my $len = syswrite $fh, $wbuf, length $wbuf;
1564		1849
1565	if ($len > 0) {	1850	if ($len > 0) {
1566	substr $wbuf, 0, $len, "";	1851	substr $wbuf, 0, $len, "";
1567	} else {	1852	} else {
1568	@linger = (); # end	1853	@linger = (); # end
1569	}	1854	}
1570	});	1855	};
1571	push @linger, AnyEvent->timer (after => $linger, cb => sub {	1856	push @linger, AE::timer $linger, 0, sub {
1572	@linger = ();	1857	@linger = ();
1573	});	1858	};
1574	}	1859	}
1575	}	1860	}
1576		1861
1577	=item $handle->destroy	1862	=item $handle->destroy
1578		1863
1579	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
1580	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
1581	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).
1582		1869
1583	Normally, you can just "forget" any references to an AnyEvent::Handle	1870	Normally, you can just "forget" any references to an AnyEvent::Handle
1584	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
1585	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
1586	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
1587	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
1588	that case.	1875	that case.
1589		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
1590	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
1591	data, as specified by the C<linger> option, however.	1883	data, as specified by the C<linger> option, however.
1592		1884
1593	=cut	1885	=cut
1594		1886
1595	sub destroy {	1887	sub destroy {
1596	my ($self) = @_;	1888	my ($self) = @_;
1597		1889
1598	$self->DESTROY;	1890	$self->DESTROY;
1599	%$self = ();	1891	%$self = ();
		1892	bless $self, "AnyEvent::Handle::destroyed";
		1893	}
		1894
		1895	sub AnyEvent::Handle::destroyed::AUTOLOAD {
		1896	#nop
1600	}	1897	}
1601		1898
1602	=item AnyEvent::Handle::TLS_CTX	1899	=item AnyEvent::Handle::TLS_CTX
1603		1900
1604	This function creates and returns the AnyEvent::TLS object used by default	1901	This function creates and returns the AnyEvent::TLS object used by default
…		…
1661		1958
1662	$handle->on_read (sub { });	1959	$handle->on_read (sub { });
1663	$handle->on_eof (undef);	1960	$handle->on_eof (undef);
1664	$handle->on_error (sub {	1961	$handle->on_error (sub {
1665	my $data = delete $_[0]{rbuf};	1962	my $data = delete $_[0]{rbuf};
1666	undef $handle;
1667	});	1963	});
1668		1964
1669	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
1670	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
1671	fact, all data has been received.	1967	fact, all data has been received.
…		…
1687	$handle->on_drain (sub {	1983	$handle->on_drain (sub {
1688	warn "all data submitted to the kernel\n";	1984	warn "all data submitted to the kernel\n";
1689	undef $handle;	1985	undef $handle;
1690	});	1986	});
1691		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
1692	=back	2076	=back
1693		2077
1694		2078
1695	=head1 SUBCLASSING AnyEvent::Handle	2079	=head1 SUBCLASSING AnyEvent::Handle
1696		2080

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.136 by root, Fri Jul 3 21:44:14 2009 UTC vs. Revision 1.176 by root, Sun Aug 9 00:20:35 2009 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.136 by root, Fri Jul 3 21:44:14 2009 UTC vs.
Revision 1.176 by root, Sun Aug 9 00:20:35 2009 UTC