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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.152 by root, Fri Jul 17 14:57:03 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.83;	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;
47	$cv->recv;	35	$cv->recv;
48		36
49	=head1 DESCRIPTION	37	=head1 DESCRIPTION
50		38
51	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
52	filehandles. For utility functions for doing non-blocking connects and accepts	40	filehandles.
53	on sockets see L<AnyEvent::Util>.
54		41
55	The L<AnyEvent::Intro> tutorial contains some well-documented	42	The L<AnyEvent::Intro> tutorial contains some well-documented
56	AnyEvent::Handle examples.	43	AnyEvent::Handle examples.
57		44
58	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
59	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
60	treatment of characters applies to this module as well.	47	treatment of characters applies to this module as well.
61		48
		49	At the very minimum, you should specify C<fh> or C<connect>, and the
		50	C<on_error> callback.
		51
62	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
63	argument.	53	argument.
64		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
65	=head1 METHODS	67	=head1 METHODS
66		68
67	=over 4	69	=over 4
68		70
69	=item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value...	71	=item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value...
70		72
71	The constructor supports these arguments (all as C<< key => value >> pairs).	73	The constructor supports these arguments (all as C<< key => value >> pairs).
72		74
73	=over 4	75	=over 4
74		76
75	=item fh => $filehandle [MANDATORY]	77	=item fh => $filehandle [C<fh> or C<connect> MANDATORY]
76		78
77	The filehandle this L<AnyEvent::Handle> object will operate on.	79	The filehandle this L<AnyEvent::Handle> object will operate on.
78
79	NOTE: The filehandle will be set to non-blocking mode (using	80	NOTE: The filehandle will be set to non-blocking mode (using
80	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
81	that mode.	82	that mode.
		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.
82		192
83	=item on_eof => $cb->($handle)	193	=item on_eof => $cb->($handle)
84		194
85	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,
86	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
…		…
94	down.	204	down.
95		205
96	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
97	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>.
98		208
99	=item on_error => $cb->($handle, $fatal, $message)
100
101	This is the error callback, which is called when, well, some error
102	occured, such as not being able to resolve the hostname, failure to
103	connect or a read error.
104
105	Some errors are fatal (which is indicated by C<$fatal> being true). On
106	fatal errors the handle object will be destroyed (by a call to C<< ->
107	destroy >>) after invoking the error callback (which means you are free to
108	examine the handle object). Examples of fatal errors are an EOF condition
109	with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors.
110
111	AnyEvent::Handle tries to find an appropriate error code for you to check
112	against, but in some cases (TLS errors), this does not work well. It is
113	recommended to always output the C<$message> argument in human-readable
114	error messages (it's usually the same as C<"$!">).
115
116	Non-fatal errors can be retried by simply returning, but it is recommended
117	to simply ignore this parameter and instead abondon the handle object
118	when this callback is invoked. Examples of non-fatal errors are timeouts
119	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
120
121	On callback entrance, the value of C<$!> contains the operating system
122	error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
123	C<EPROTO>).
124
125	While not mandatory, it is I<highly> recommended to set this callback, as
126	you will not be notified of errors otherwise. The default simply calls
127	C<croak>.
128
129	=item on_read => $cb->($handle)
130
131	This sets the default read callback, which is called when data arrives
132	and no read request is in the queue (unlike read queue callbacks, this
133	callback will only be called when at least one octet of data is in the
134	read buffer).
135
136	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
137	method or access the C<< $handle->{rbuf} >> member directly. Note that you
138	must not enlarge or modify the read buffer, you can only remove data at
139	the beginning from it.
140
141	When an EOF condition is detected then AnyEvent::Handle will first try to
142	feed all the remaining data to the queued callbacks and C<on_read> before
143	calling the C<on_eof> callback. If no progress can be made, then a fatal
144	error will be raised (with C<$!> set to C<EPIPE>).
145
146	Note that, unlike requests in the read queue, an C<on_read> callback
147	doesn't mean you I<require> some data: if there is an EOF and there
148	are outstanding read requests then an error will be flagged. With an
149	C<on_read> callback, the C<on_eof> callback will be invoked.
150
151	=item on_drain => $cb->($handle)	209	=item on_drain => $cb->($handle)
152		210
153	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
154	(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).
155		213
…		…
161	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
162	the file when the write queue becomes empty.	220	the file when the write queue becomes empty.
163		221
164	=item timeout => $fractional_seconds	222	=item timeout => $fractional_seconds
165		223
		224	=item rtimeout => $fractional_seconds
		225
		226	=item wtimeout => $fractional_seconds
		227
166	If non-zero, then this enables an "inactivity" timeout: whenever this many	228	If non-zero, then these enables an "inactivity" timeout: whenever this
167	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
168	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
169	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>.
170		239
171	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
172	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
173	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
174	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
…		…
353		422
354	sub new {	423	sub new {
355	my $class = shift;	424	my $class = shift;
356	my $self = bless { @_ }, $class;	425	my $self = bless { @_ }, $class;
357		426
358	$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) = @_;
359		490
360	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	491	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
361		492
		493	$self->{_activity} =
		494	$self->{_ractivity} =
362	$self->{_activity} = AnyEvent->now;	495	$self->{_wactivity} = AE::now;
363	$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};
364		500
365	$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};
366		502
367	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})	503	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
368	if $self->{tls};	504	if $self->{tls};
369		505
370	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	506	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
371		507
372	$self->start_read	508	$self->start_read
373	if $self->{on_read};	509	if $self->{on_read} \|\| @{ $self->{_queue} };
374		510
375	$self->{fh} && $self	511	$self->_drain_wbuf;
376	}	512	}
377		513
378	#sub _shutdown {	514	#sub _shutdown {
379	# my ($self) = @_;	515	# my ($self) = @_;
380	#	516	#
…		…
427	$_[0]{on_eof} = $_[1];	563	$_[0]{on_eof} = $_[1];
428	}	564	}
429		565
430	=item $handle->on_timeout ($cb)	566	=item $handle->on_timeout ($cb)
431		567
432	Replace the current C<on_timeout> callback, or disables the callback (but	568	=item $handle->on_rtimeout ($cb)
433	not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
434	argument and method.
435		569
436	=cut	570	=item $handle->on_wtimeout ($cb)
437		571
438	sub on_timeout {	572	Replace the current C<on_timeout>, C<on_rtimeout> or C<on_wtimeout>
439	$_[0]{on_timeout} = $_[1];	573	callback, or disables the callback (but not the timeout) if C<$cb> =
440	}	574	C<undef>. See the C<timeout> constructor argument and method.
		575
		576	=cut
		577
		578	# see below
441		579
442	=item $handle->autocork ($boolean)	580	=item $handle->autocork ($boolean)
443		581
444	Enables or disables the current autocork behaviour (see C<autocork>	582	Enables or disables the current autocork behaviour (see C<autocork>
445	constructor argument). Changes will only take effect on the next write.	583	constructor argument). Changes will only take effect on the next write.
…		…
460	sub no_delay {	598	sub no_delay {
461	$_[0]{no_delay} = $_[1];	599	$_[0]{no_delay} = $_[1];
462		600
463	eval {	601	eval {
464	local $SIG{__DIE__};	602	local $SIG{__DIE__};
465	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};
466	};	605	};
467	}	606	}
468		607
469	=item $handle->on_starttls ($cb)	608	=item $handle->on_starttls ($cb)
470		609
…		…
484		623
485	sub on_starttls {	624	sub on_starttls {
486	$_[0]{on_stoptls} = $_[1];	625	$_[0]{on_stoptls} = $_[1];
487	}	626	}
488		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
489	#############################################################################	638	#############################################################################
490		639
491	=item $handle->timeout ($seconds)	640	=item $handle->timeout ($seconds)
492		641
		642	=item $handle->rtimeout ($seconds)
		643
		644	=item $handle->wtimeout ($seconds)
		645
493	Configures (or disables) the inactivity timeout.	646	Configures (or disables) the inactivity timeout.
494		647
495	=cut	648	=item $handle->timeout_reset
496		649
497	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 {
498	my ($self, $timeout) = @_;	672	my ($self, $new_value) = @_;
499		673
500	$self->{timeout} = $timeout;	674	$self->{$timeout} = $new_value;
501	$self->_timeout;	675	delete $self->{$tw}; &$cb;
502	}	676	};
503		677
		678	*{"${dir}timeout_reset"} = sub {
		679	$_[0]{$activity} = AE::now;
		680	};
		681
		682	# main workhorse:
504	# reset the timeout watcher, as neccessary	683	# reset the timeout watcher, as neccessary
505	# also check for time-outs	684	# also check for time-outs
506	sub _timeout {	685	$cb = sub {
507	my ($self) = @_;	686	my ($self) = @_;
508		687
509	if ($self->{timeout}) {	688	if ($self->{$timeout} && $self->{fh}) {
510	my $NOW = AnyEvent->now;	689	my $NOW = AE::now;
511		690
512	# when would the timeout trigger?	691	# when would the timeout trigger?
513	my $after = $self->{_activity} + $self->{timeout} - $NOW;	692	my $after = $self->{$activity} + $self->{$timeout} - $NOW;
514		693
515	# now or in the past already?	694	# now or in the past already?
516	if ($after <= 0) {	695	if ($after <= 0) {
517	$self->{_activity} = $NOW;	696	$self->{$activity} = $NOW;
518		697
519	if ($self->{on_timeout}) {	698	if ($self->{$on_timeout}) {
520	$self->{on_timeout}($self);	699	$self->{$on_timeout}($self);
521	} else {	700	} else {
522	$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};
523	}	709	}
524		710
525	# callback could have changed timeout value, optimise	711	Scalar::Util::weaken $self;
526	return unless $self->{timeout};	712	return unless $self; # ->error could have destroyed $self
527		713
528	# calculate new after	714	$self->{$tw} \|\|= AE::timer $after, 0, sub {
529	$after = $self->{timeout};	715	delete $self->{$tw};
		716	$cb->($self);
		717	};
		718	} else {
		719	delete $self->{$tw};
530	}	720	}
531
532	Scalar::Util::weaken $self;
533	return unless $self; # ->error could have destroyed $self
534
535	$self->{_tw} \|\|= AnyEvent->timer (after => $after, cb => sub {
536	delete $self->{_tw};
537	$self->_timeout;
538	});
539	} else {
540	delete $self->{_tw};
541	}	721	}
542	}	722	}
543		723
544	#############################################################################	724	#############################################################################
545		725
…		…
593	my $len = syswrite $self->{fh}, $self->{wbuf};	773	my $len = syswrite $self->{fh}, $self->{wbuf};
594		774
595	if (defined $len) {	775	if (defined $len) {
596	substr $self->{wbuf}, 0, $len, "";	776	substr $self->{wbuf}, 0, $len, "";
597		777
598	$self->{_activity} = AnyEvent->now;	778	$self->{_activity} = $self->{_wactivity} = AE::now;
599		779
600	$self->{on_drain}($self)	780	$self->{on_drain}($self)
601	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})
602	&& $self->{on_drain};	782	&& $self->{on_drain};
603		783
…		…
609		789
610	# try to write data immediately	790	# try to write data immediately
611	$cb->() unless $self->{autocork};	791	$cb->() unless $self->{autocork};
612		792
613	# if still data left in wbuf, we need to poll	793	# if still data left in wbuf, we need to poll
614	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	794	$self->{_ww} = AE::io $self->{fh}, 1, $cb
615	if length $self->{wbuf};	795	if length $self->{wbuf};
616	};	796	};
617	}	797	}
618		798
619	our %WH;	799	our %WH;
…		…
632	->($self, @_);	812	->($self, @_);
633	}	813	}
634		814
635	if ($self->{tls}) {	815	if ($self->{tls}) {
636	$self->{_tls_wbuf} .= $_[0];	816	$self->{_tls_wbuf} .= $_[0];
637		817	&_dotls ($self) if $self->{fh};
638	&_dotls ($self);
639	} else {	818	} else {
640	$self->{wbuf} .= $_[0];	819	$self->{wbuf} .= $_[0];
641	$self->_drain_wbuf;	820	$self->_drain_wbuf if $self->{fh};
642	}	821	}
643	}	822	}
644		823
645	=item $handle->push_write (type => @args)	824	=item $handle->push_write (type => @args)
646		825
…		…
863	=cut	1042	=cut
864		1043
865	sub _drain_rbuf {	1044	sub _drain_rbuf {
866	my ($self) = @_;	1045	my ($self) = @_;
867		1046
		1047	# avoid recursion
		1048	return if $self->{_skip_drain_rbuf};
868	local $self->{_in_drain} = 1;	1049	local $self->{_skip_drain_rbuf} = 1;
869
870	if (
871	defined $self->{rbuf_max}
872	&& $self->{rbuf_max} < length $self->{rbuf}
873	) {
874	$self->_error (Errno::ENOSPC, 1), return;
875	}
876		1050
877	while () {	1051	while () {
878	# 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
879	# 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.
880	$self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf};	1054	$self->{rbuf} .= delete $self->{_tls_rbuf}
		1055	if exists $self->{_tls_rbuf};
881		1056
882	my $len = length $self->{rbuf};	1057	my $len = length $self->{rbuf};
883		1058
884	if (my $cb = shift @{ $self->{_queue} }) {	1059	if (my $cb = shift @{ $self->{_queue} }) {
885	unless ($cb->($self)) {	1060	unless ($cb->($self)) {
886	if ($self->{_eof}) {	1061	# no progress can be made
887	# no progress can be made (not enough data and no data forthcoming)	1062	# (not enough data and no data forthcoming)
888	$self->_error (Errno::EPIPE, 1), return;	1063	$self->_error (Errno::EPIPE, 1), return
889	}	1064	if $self->{_eof};
890		1065
891	unshift @{ $self->{_queue} }, $cb;	1066	unshift @{ $self->{_queue} }, $cb;
892	last;	1067	last;
893	}	1068	}
894	} elsif ($self->{on_read}) {	1069	} elsif ($self->{on_read}) {
…		…
914	last;	1089	last;
915	}	1090	}
916	}	1091	}
917		1092
918	if ($self->{_eof}) {	1093	if ($self->{_eof}) {
919	if ($self->{on_eof}) {	1094	$self->{on_eof}
920	$self->{on_eof}($self)	1095	? $self->{on_eof}($self)
921	} else {
922	$self->_error (0, 1, "Unexpected end-of-file");	1096	: $self->_error (0, 1, "Unexpected end-of-file");
923	}	1097
		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;
924	}	1106	}
925		1107
926	# may need to restart read watcher	1108	# may need to restart read watcher
927	unless ($self->{_rw}) {	1109	unless ($self->{_rw}) {
928	$self->start_read	1110	$self->start_read
…		…
940		1122
941	sub on_read {	1123	sub on_read {
942	my ($self, $cb) = @_;	1124	my ($self, $cb) = @_;
943		1125
944	$self->{on_read} = $cb;	1126	$self->{on_read} = $cb;
945	$self->_drain_rbuf if $cb && !$self->{_in_drain};	1127	$self->_drain_rbuf if $cb;
946	}	1128	}
947		1129
948	=item $handle->rbuf	1130	=item $handle->rbuf
949		1131
950	Returns the read buffer (as a modifiable lvalue).	1132	Returns the read buffer (as a modifiable lvalue).
…		…
1002	$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")
1003	->($self, $cb, @_);	1185	->($self, $cb, @_);
1004	}	1186	}
1005		1187
1006	push @{ $self->{_queue} }, $cb;	1188	push @{ $self->{_queue} }, $cb;
1007	$self->_drain_rbuf unless $self->{_in_drain};	1189	$self->_drain_rbuf;
1008	}	1190	}
1009		1191
1010	sub unshift_read {	1192	sub unshift_read {
1011	my $self = shift;	1193	my $self = shift;
1012	my $cb = pop;	1194	my $cb = pop;
…		…
1018	->($self, $cb, @_);	1200	->($self, $cb, @_);
1019	}	1201	}
1020		1202
1021		1203
1022	unshift @{ $self->{_queue} }, $cb;	1204	unshift @{ $self->{_queue} }, $cb;
1023	$self->_drain_rbuf unless $self->{_in_drain};	1205	$self->_drain_rbuf;
1024	}	1206	}
1025		1207
1026	=item $handle->push_read (type => @args, $cb)	1208	=item $handle->push_read (type => @args, $cb)
1027		1209
1028	=item $handle->unshift_read (type => @args, $cb)	1210	=item $handle->unshift_read (type => @args, $cb)
…		…
1409	my ($self) = @_;	1591	my ($self) = @_;
1410		1592
1411	unless ($self->{_rw} \|\| $self->{_eof}) {	1593	unless ($self->{_rw} \|\| $self->{_eof}) {
1412	Scalar::Util::weaken $self;	1594	Scalar::Util::weaken $self;
1413		1595
1414	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1596	$self->{_rw} = AE::io $self->{fh}, 0, sub {
1415	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});	1597	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1416	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;
1417		1599
1418	if ($len > 0) {	1600	if ($len > 0) {
1419	$self->{_activity} = AnyEvent->now;	1601	$self->{_activity} = $self->{_ractivity} = AE::now;
1420		1602
1421	if ($self->{tls}) {	1603	if ($self->{tls}) {
1422	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);	1604	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1423		1605
1424	&_dotls ($self);	1606	&_dotls ($self);
1425	} else {	1607	} else {
1426	$self->_drain_rbuf unless $self->{_in_drain};	1608	$self->_drain_rbuf;
1427	}	1609	}
1428		1610
1429	} elsif (defined $len) {	1611	} elsif (defined $len) {
1430	delete $self->{_rw};	1612	delete $self->{_rw};
1431	$self->{_eof} = 1;	1613	$self->{_eof} = 1;
1432	$self->_drain_rbuf unless $self->{_in_drain};	1614	$self->_drain_rbuf;
1433		1615
1434	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1616	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1435	return $self->_error ($!, 1);	1617	return $self->_error ($!, 1);
1436	}	1618	}
1437	});	1619	};
1438	}	1620	}
1439	}	1621	}
1440		1622
1441	our $ERROR_SYSCALL;	1623	our $ERROR_SYSCALL;
1442	our $ERROR_WANT_READ;	1624	our $ERROR_WANT_READ;
…		…
1497	$self->{_eof} = 1;	1679	$self->{_eof} = 1;
1498	}	1680	}
1499	}	1681	}
1500		1682
1501	$self->{_tls_rbuf} .= $tmp;	1683	$self->{_tls_rbuf} .= $tmp;
1502	$self->_drain_rbuf unless $self->{_in_drain};	1684	$self->_drain_rbuf;
1503	$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
1504	}	1686	}
1505		1687
1506	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);	1688	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1507	return $self->_tls_error ($tmp)	1689	return $self->_tls_error ($tmp)
…		…
1522		1704
1523	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	1705	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
1524	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
1525	C<starttls>.	1707	C<starttls>.
1526		1708
		1709	Starting TLS is currently an asynchronous operation - when you push some
		1710	write data and then call C<< ->starttls >> then TLS negotiation will start
		1711	immediately, after which the queued write data is then sent.
		1712
1527	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
1528	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1714	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1529		1715
1530	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
1531	when AnyEvent::Handle has to create its own TLS connection object, or	1717	when AnyEvent::Handle has to create its own TLS connection object, or
…		…
1535	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
1536	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
1537	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
1538	when this function returns.	1724	when this function returns.
1539		1725
1540	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
1541	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.
1542		1729
1543	=cut	1730	=cut
1544		1731
1545	our %TLS_CACHE; #TODO not yet documented, should we?	1732	our %TLS_CACHE; #TODO not yet documented, should we?
1546		1733
1547	sub starttls {	1734	sub starttls {
1548	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};
1549		1744
1550	require Net::SSLeay;	1745	require Net::SSLeay;
1551
1552	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"
1553	if $self->{tls};
1554		1746
1555	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();	1747	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1556	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();	1748	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1557		1749
		1750	$tls = $self->{tls};
1558	$ctx \|\|= $self->{tls_ctx};	1751	$ctx = $self->{tls_ctx};
		1752
		1753	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
1559		1754
1560	if ("HASH" eq ref $ctx) {	1755	if ("HASH" eq ref $ctx) {
1561	require AnyEvent::TLS;	1756	require AnyEvent::TLS;
1562
1563	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context
1564		1757
1565	if ($ctx->{cache}) {	1758	if ($ctx->{cache}) {
1566	my $key = $ctx+0;	1759	my $key = $ctx+0;
1567	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;	1760	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;
1568	} else {	1761	} else {
1569	$ctx = new AnyEvent::TLS %$ctx;	1762	$ctx = new AnyEvent::TLS %$ctx;
1570	}	1763	}
1571	}	1764	}
1572		1765
1573	$self->{tls_ctx} = $ctx \|\| TLS_CTX ();	1766	$self->{tls_ctx} = $ctx \|\| TLS_CTX ();
1574	$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});
1575		1768
1576	# 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)
1577	# but the openssl maintainers basically said: "trust us, it just works".	1770	# but the openssl maintainers basically said: "trust us, it just works".
1578	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1771	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1579	# and mismaintained ssleay-module doesn't even offer them).	1772	# and mismaintained ssleay-module doesn't even offer them).
…		…
1586	# 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
1587	# have identity issues in that area.	1780	# have identity issues in that area.
1588	# Net::SSLeay::CTX_set_mode ($ssl,	1781	# Net::SSLeay::CTX_set_mode ($ssl,
1589	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1782	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
1590	# \| (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));
1591	Net::SSLeay::CTX_set_mode ($ssl, 1\|2);	1784	Net::SSLeay::CTX_set_mode ($tls, 1\|2);
1592		1785
1593	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1786	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1594	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1787	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1595		1788
		1789	Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf});
		1790
1596	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1791	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
1597		1792
1598	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }	1793	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1599	if $self->{on_starttls};	1794	if $self->{on_starttls};
1600		1795
1601	&_dotls; # need to trigger the initial handshake	1796	&_dotls; # need to trigger the initial handshake
…		…
1604		1799
1605	=item $handle->stoptls	1800	=item $handle->stoptls
1606		1801
1607	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
1608	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
1609	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
1610	afterwards.	1805	the stream afterwards.
1611		1806
1612	=cut	1807	=cut
1613		1808
1614	sub stoptls {	1809	sub stoptls {
1615	my ($self) = @_;	1810	my ($self) = @_;
…		…
1628	sub _freetls {	1823	sub _freetls {
1629	my ($self) = @_;	1824	my ($self) = @_;
1630		1825
1631	return unless $self->{tls};	1826	return unless $self->{tls};
1632		1827
1633	$self->{tls_ctx}->_put_session (delete $self->{tls});	1828	$self->{tls_ctx}->_put_session (delete $self->{tls})
		1829	if $self->{tls} > 0;
1634		1830
1635	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};	1831	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1636	}	1832	}
1637		1833
1638	sub DESTROY {	1834	sub DESTROY {
…		…
1640		1836
1641	&_freetls;	1837	&_freetls;
1642		1838
1643	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	1839	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1644		1840
1645	if ($linger && length $self->{wbuf}) {	1841	if ($linger && length $self->{wbuf} && $self->{fh}) {
1646	my $fh = delete $self->{fh};	1842	my $fh = delete $self->{fh};
1647	my $wbuf = delete $self->{wbuf};	1843	my $wbuf = delete $self->{wbuf};
1648		1844
1649	my @linger;	1845	my @linger;
1650		1846
1651	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {	1847	push @linger, AE::io $fh, 1, sub {
1652	my $len = syswrite $fh, $wbuf, length $wbuf;	1848	my $len = syswrite $fh, $wbuf, length $wbuf;
1653		1849
1654	if ($len > 0) {	1850	if ($len > 0) {
1655	substr $wbuf, 0, $len, "";	1851	substr $wbuf, 0, $len, "";
1656	} else {	1852	} else {
1657	@linger = (); # end	1853	@linger = (); # end
1658	}	1854	}
1659	});	1855	};
1660	push @linger, AnyEvent->timer (after => $linger, cb => sub {	1856	push @linger, AE::timer $linger, 0, sub {
1661	@linger = ();	1857	@linger = ();
1662	});	1858	};
1663	}	1859	}
1664	}	1860	}
1665		1861
1666	=item $handle->destroy	1862	=item $handle->destroy
1667		1863
1668	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
1669	no further callbacks will be invoked and as many resources as possible	1865	no further callbacks will be invoked and as many resources as possible
1670	will be freed. 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).
1671		1869
1672	Normally, you can just "forget" any references to an AnyEvent::Handle	1870	Normally, you can just "forget" any references to an AnyEvent::Handle
1673	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
1674	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
1675	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
…		…
1689	sub destroy {	1887	sub destroy {
1690	my ($self) = @_;	1888	my ($self) = @_;
1691		1889
1692	$self->DESTROY;	1890	$self->DESTROY;
1693	%$self = ();	1891	%$self = ();
		1892	bless $self, "AnyEvent::Handle::destroyed";
		1893	}
		1894
		1895	sub AnyEvent::Handle::destroyed::AUTOLOAD {
		1896	#nop
1694	}	1897	}
1695		1898
1696	=item AnyEvent::Handle::TLS_CTX	1899	=item AnyEvent::Handle::TLS_CTX
1697		1900
1698	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

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.152 by root, Fri Jul 17 14:57:03 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.152 by root, Fri Jul 17 14:57:03 2009 UTC vs.
Revision 1.176 by root, Sun Aug 9 00:20:35 2009 UTC