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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.150 by root, Thu Jul 16 04:16:25 2009 UTC vs.
Revision 1.177 by root, Sun Aug 9 00:24:35 2009 UTC

…		…
1	package AnyEvent::Handle;
2
3	no warnings;
4	use strict qw(subs vars);
5
6	use AnyEvent ();
7	use AnyEvent::Util qw(WSAEWOULDBLOCK);
8	use Scalar::Util ();
9	use Carp ();
10	use Fcntl ();
11	use Errno qw(EAGAIN EINTR);
12
13	=head1 NAME	1	=head1 NAME
14		2
15	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent	3	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent
16
17	=cut
18
19	our $VERSION = 4.82;
20		4
21	=head1 SYNOPSIS	5	=head1 SYNOPSIS
22		6
23	use AnyEvent;	7	use AnyEvent;
24	use AnyEvent::Handle;	8	use AnyEvent::Handle;
26	my $cv = AnyEvent->condvar;	10	my $cv = AnyEvent->condvar;
27		11
28	my $hdl; $hdl = new AnyEvent::Handle	12	my $hdl; $hdl = new AnyEvent::Handle
29	fh => \*STDIN,	13	fh => \*STDIN,
30	on_error => sub {	14	on_error => sub {
		15	my ($hdl, $fatal, $msg) = @_;
31	warn "got error $_[2]\n";	16	warn "got error $msg\n";
		17	$hdl->destroy;
32	$cv->send;	18	$cv->send;
33	);	19	);
34		20
35	# send some request line	21	# send some request line
36	$hdl->push_write ("getinfo\015\012");	22	$hdl->push_write ("getinfo\015\012");
…		…
45	$cv->recv;	31	$cv->recv;
46		32
47	=head1 DESCRIPTION	33	=head1 DESCRIPTION
48		34
49	This module is a helper module to make it easier to do event-based I/O on	35	This module is a helper module to make it easier to do event-based I/O on
50	filehandles. For utility functions for doing non-blocking connects and accepts	36	filehandles.
51	on sockets see L<AnyEvent::Util>.
52		37
53	The L<AnyEvent::Intro> tutorial contains some well-documented	38	The L<AnyEvent::Intro> tutorial contains some well-documented
54	AnyEvent::Handle examples.	39	AnyEvent::Handle examples.
55		40
56	In the following, when the documentation refers to of "bytes" then this	41	In the following, when the documentation refers to of "bytes" then this
57	means characters. As sysread and syswrite are used for all I/O, their	42	means characters. As sysread and syswrite are used for all I/O, their
58	treatment of characters applies to this module as well.	43	treatment of characters applies to this module as well.
59		44
		45	At the very minimum, you should specify C<fh> or C<connect>, and the
		46	C<on_error> callback.
		47
60	All callbacks will be invoked with the handle object as their first	48	All callbacks will be invoked with the handle object as their first
61	argument.	49	argument.
62		50
		51	=cut
		52
		53	package AnyEvent::Handle;
		54
		55	use Scalar::Util ();
		56	use List::Util ();
		57	use Carp ();
		58	use Errno qw(EAGAIN EINTR);
		59
		60	use AnyEvent (); BEGIN { AnyEvent::common_sense }
		61	use AnyEvent::Util qw(WSAEWOULDBLOCK);
		62
		63	our $VERSION = $AnyEvent::VERSION;
		64
63	=head1 METHODS	65	=head1 METHODS
64		66
65	=over 4	67	=over 4
66		68
67	=item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value...	69	=item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value...
68		70
69	The constructor supports these arguments (all as C<< key => value >> pairs).	71	The constructor supports these arguments (all as C<< key => value >> pairs).
70		72
71	=over 4	73	=over 4
72		74
73	=item fh => $filehandle [MANDATORY]	75	=item fh => $filehandle [C<fh> or C<connect> MANDATORY]
74		76
75	The filehandle this L<AnyEvent::Handle> object will operate on.	77	The filehandle this L<AnyEvent::Handle> object will operate on.
76
77	NOTE: The filehandle will be set to non-blocking mode (using	78	NOTE: The filehandle will be set to non-blocking mode (using
78	C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in	79	C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in
79	that mode.	80	that mode.
		81
		82	=item connect => [$host, $service] [C<fh> or C<connect> MANDATORY]
		83
		84	Try to connect to the specified host and service (port), using
		85	C<AnyEvent::Socket::tcp_connect>. The C<$host> additionally becomes the
		86	default C<peername>.
		87
		88	You have to specify either this parameter, or C<fh>, above.
		89
		90	It is possible to push requests on the read and write queues, and modify
		91	properties of the stream, even while AnyEvent::Handle is connecting.
		92
		93	When this parameter is specified, then the C<on_prepare>,
		94	C<on_connect_error> and C<on_connect> callbacks will be called under the
		95	appropriate circumstances:
		96
		97	=over 4
		98
		99	=item on_prepare => $cb->($handle)
		100
		101	This (rarely used) callback is called before a new connection is
		102	attempted, but after the file handle has been created. It could be used to
		103	prepare the file handle with parameters required for the actual connect
		104	(as opposed to settings that can be changed when the connection is already
		105	established).
		106
		107	The return value of this callback should be the connect timeout value in
		108	seconds (or C<0>, or C<undef>, or the empty list, to indicate the default
		109	timeout is to be used).
		110
		111	=item on_connect => $cb->($handle, $host, $port, $retry->())
		112
		113	This callback is called when a connection has been successfully established.
		114
		115	The actual numeric host and port (the socket peername) are passed as
		116	parameters, together with a retry callback.
		117
		118	When, for some reason, the handle is not acceptable, then calling
		119	C<$retry> will continue with the next conenction target (in case of
		120	multi-homed hosts or SRV records there can be multiple connection
		121	endpoints). When it is called then the read and write queues, eof status,
		122	tls status and similar properties of the handle are being reset.
		123
		124	In most cases, ignoring the C<$retry> parameter is the way to go.
		125
		126	=item on_connect_error => $cb->($handle, $message)
		127
		128	This callback is called when the conenction could not be
		129	established. C<$!> will contain the relevant error code, and C<$message> a
		130	message describing it (usually the same as C<"$!">).
		131
		132	If this callback isn't specified, then C<on_error> will be called with a
		133	fatal error instead.
		134
		135	=back
		136
		137	=item on_error => $cb->($handle, $fatal, $message)
		138
		139	This is the error callback, which is called when, well, some error
		140	occured, such as not being able to resolve the hostname, failure to
		141	connect or a read error.
		142
		143	Some errors are fatal (which is indicated by C<$fatal> being true). On
		144	fatal errors the handle object will be destroyed (by a call to C<< ->
		145	destroy >>) after invoking the error callback (which means you are free to
		146	examine the handle object). Examples of fatal errors are an EOF condition
		147	with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors. In
		148	cases where the other side can close the connection at their will it is
		149	often easiest to not report C<EPIPE> errors in this callback.
		150
		151	AnyEvent::Handle tries to find an appropriate error code for you to check
		152	against, but in some cases (TLS errors), this does not work well. It is
		153	recommended to always output the C<$message> argument in human-readable
		154	error messages (it's usually the same as C<"$!">).
		155
		156	Non-fatal errors can be retried by simply returning, but it is recommended
		157	to simply ignore this parameter and instead abondon the handle object
		158	when this callback is invoked. Examples of non-fatal errors are timeouts
		159	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
		160
		161	On callback entrance, the value of C<$!> contains the operating system
		162	error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
		163	C<EPROTO>).
		164
		165	While not mandatory, it is I<highly> recommended to set this callback, as
		166	you will not be notified of errors otherwise. The default simply calls
		167	C<croak>.
		168
		169	=item on_read => $cb->($handle)
		170
		171	This sets the default read callback, which is called when data arrives
		172	and no read request is in the queue (unlike read queue callbacks, this
		173	callback will only be called when at least one octet of data is in the
		174	read buffer).
		175
		176	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
		177	method or access the C<< $handle->{rbuf} >> member directly. Note that you
		178	must not enlarge or modify the read buffer, you can only remove data at
		179	the beginning from it.
		180
		181	When an EOF condition is detected then AnyEvent::Handle will first try to
		182	feed all the remaining data to the queued callbacks and C<on_read> before
		183	calling the C<on_eof> callback. If no progress can be made, then a fatal
		184	error will be raised (with C<$!> set to C<EPIPE>).
		185
		186	Note that, unlike requests in the read queue, an C<on_read> callback
		187	doesn't mean you I<require> some data: if there is an EOF and there
		188	are outstanding read requests then an error will be flagged. With an
		189	C<on_read> callback, the C<on_eof> callback will be invoked.
80		190
81	=item on_eof => $cb->($handle)	191	=item on_eof => $cb->($handle)
82		192
83	Set the callback to be called when an end-of-file condition is detected,	193	Set the callback to be called when an end-of-file condition is detected,
84	i.e. in the case of a socket, when the other side has closed the	194	i.e. in the case of a socket, when the other side has closed the
…		…
92	down.	202	down.
93		203
94	If an EOF condition has been detected but no C<on_eof> callback has been	204	If an EOF condition has been detected but no C<on_eof> callback has been
95	set, then a fatal error will be raised with C<$!> set to <0>.	205	set, then a fatal error will be raised with C<$!> set to <0>.
96		206
97	=item on_error => $cb->($handle, $fatal, $message)
98
99	This is the error callback, which is called when, well, some error
100	occured, such as not being able to resolve the hostname, failure to
101	connect or a read error.
102
103	Some errors are fatal (which is indicated by C<$fatal> being true). On
104	fatal errors the handle object will be destroyed (by a call to C<< ->
105	destroy >>) after invoking the error callback (which means you are free to
106	examine the handle object). Examples of fatal errors are an EOF condition
107	with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors.
108
109	AnyEvent::Handle tries to find an appropriate error code for you to check
110	against, but in some cases (TLS errors), this does not work well. It is
111	recommended to always output the C<$message> argument in human-readable
112	error messages (it's usually the same as C<"$!">).
113
114	Non-fatal errors can be retried by simply returning, but it is recommended
115	to simply ignore this parameter and instead abondon the handle object
116	when this callback is invoked. Examples of non-fatal errors are timeouts
117	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
118
119	On callback entrance, the value of C<$!> contains the operating system
120	error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
121	C<EPROTO>).
122
123	While not mandatory, it is I<highly> recommended to set this callback, as
124	you will not be notified of errors otherwise. The default simply calls
125	C<croak>.
126
127	=item on_read => $cb->($handle)
128
129	This sets the default read callback, which is called when data arrives
130	and no read request is in the queue (unlike read queue callbacks, this
131	callback will only be called when at least one octet of data is in the
132	read buffer).
133
134	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
135	method or access the C<< $handle->{rbuf} >> member directly. Note that you
136	must not enlarge or modify the read buffer, you can only remove data at
137	the beginning from it.
138
139	When an EOF condition is detected then AnyEvent::Handle will first try to
140	feed all the remaining data to the queued callbacks and C<on_read> before
141	calling the C<on_eof> callback. If no progress can be made, then a fatal
142	error will be raised (with C<$!> set to C<EPIPE>).
143
144	Note that, unlike requests in the read queue, an C<on_read> callback
145	doesn't mean you I<require> some data: if there is an EOF and there
146	are outstanding read requests then an error will be flagged. With an
147	C<on_read> callback, the C<on_eof> callback will be invoked.
148
149	=item on_drain => $cb->($handle)	207	=item on_drain => $cb->($handle)
150		208
151	This sets the callback that is called when the write buffer becomes empty	209	This sets the callback that is called when the write buffer becomes empty
152	(or when the callback is set and the buffer is empty already).	210	(or when the callback is set and the buffer is empty already).
153		211
…		…
159	memory and push it into the queue, but instead only read more data from	217	memory and push it into the queue, but instead only read more data from
160	the file when the write queue becomes empty.	218	the file when the write queue becomes empty.
161		219
162	=item timeout => $fractional_seconds	220	=item timeout => $fractional_seconds
163		221
		222	=item rtimeout => $fractional_seconds
		223
		224	=item wtimeout => $fractional_seconds
		225
164	If non-zero, then this enables an "inactivity" timeout: whenever this many	226	If non-zero, then these enables an "inactivity" timeout: whenever this
165	seconds pass without a successful read or write on the underlying file	227	many seconds pass without a successful read or write on the underlying
166	handle, the C<on_timeout> callback will be invoked (and if that one is	228	file handle (or a call to C<timeout_reset>), the C<on_timeout> callback
167	missing, a non-fatal C<ETIMEDOUT> error will be raised).	229	will be invoked (and if that one is missing, a non-fatal C<ETIMEDOUT>
		230	error will be raised).
		231
		232	There are three variants of the timeouts that work fully independent
		233	of each other, for both read and write, just read, and just write:
		234	C<timeout>, C<rtimeout> and C<wtimeout>, with corresponding callbacks
		235	C<on_timeout>, C<on_rtimeout> and C<on_wtimeout>, and reset functions
		236	C<timeout_reset>, C<rtimeout_reset>, and C<wtimeout_reset>.
168		237
169	Note that timeout processing is also active when you currently do not have	238	Note that timeout processing is also active when you currently do not have
170	any outstanding read or write requests: If you plan to keep the connection	239	any outstanding read or write requests: If you plan to keep the connection
171	idle then you should disable the timout temporarily or ignore the timeout	240	idle then you should disable the timout temporarily or ignore the timeout
172	in the C<on_timeout> callback, in which case AnyEvent::Handle will simply	241	in the C<on_timeout> callback, in which case AnyEvent::Handle will simply
…		…
351		420
352	sub new {	421	sub new {
353	my $class = shift;	422	my $class = shift;
354	my $self = bless { @_ }, $class;	423	my $self = bless { @_ }, $class;
355		424
356	$self->{fh} or Carp::croak "mandatory argument fh is missing";	425	if ($self->{fh}) {
		426	$self->_start;
		427	return unless $self->{fh}; # could be gone by now
		428
		429	} elsif ($self->{connect}) {
		430	require AnyEvent::Socket;
		431
		432	$self->{peername} = $self->{connect}[0]
		433	unless exists $self->{peername};
		434
		435	$self->{_skip_drain_rbuf} = 1;
		436
		437	{
		438	Scalar::Util::weaken (my $self = $self);
		439
		440	$self->{_connect} =
		441	AnyEvent::Socket::tcp_connect (
		442	$self->{connect}[0],
		443	$self->{connect}[1],
		444	sub {
		445	my ($fh, $host, $port, $retry) = @_;
		446
		447	if ($fh) {
		448	$self->{fh} = $fh;
		449
		450	delete $self->{_skip_drain_rbuf};
		451	$self->_start;
		452
		453	$self->{on_connect}
		454	and $self->{on_connect}($self, $host, $port, sub {
		455	delete @$self{qw(fh _tw _ww _rw _eof _queue rbuf _wbuf tls _tls_rbuf _tls_wbuf)};
		456	$self->{_skip_drain_rbuf} = 1;
		457	&$retry;
		458	});
		459
		460	} else {
		461	if ($self->{on_connect_error}) {
		462	$self->{on_connect_error}($self, "$!");
		463	$self->destroy;
		464	} else {
		465	$self->_error ($!, 1);
		466	}
		467	}
		468	},
		469	sub {
		470	local $self->{fh} = $_[0];
		471
		472	$self->{on_prepare}
		473	? $self->{on_prepare}->($self)
		474	: ()
		475	}
		476	);
		477	}
		478
		479	} else {
		480	Carp::croak "AnyEvent::Handle: either an existing fh or the connect parameter must be specified";
		481	}
		482
		483	$self
		484	}
		485
		486	sub _start {
		487	my ($self) = @_;
357		488
358	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	489	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
359		490
		491	$self->{_activity} =
		492	$self->{_ractivity} =
360	$self->{_activity} = AnyEvent->now;	493	$self->{_wactivity} = AE::now;
361	$self->_timeout;	494
		495	$self->timeout (delete $self->{timeout} ) if $self->{timeout};
		496	$self->rtimeout (delete $self->{rtimeout}) if $self->{rtimeout};
		497	$self->wtimeout (delete $self->{wtimeout}) if $self->{wtimeout};
362		498
363	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};	499	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
364		500
365	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})	501	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
366	if $self->{tls};	502	if $self->{tls};
367		503
368	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	504	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
369		505
370	$self->start_read	506	$self->start_read
371	if $self->{on_read};	507	if $self->{on_read} \|\| @{ $self->{_queue} };
372		508
373	$self->{fh} && $self	509	$self->_drain_wbuf;
374	}	510	}
375		511
376	#sub _shutdown {	512	#sub _shutdown {
377	# my ($self) = @_;	513	# my ($self) = @_;
378	#	514	#
…		…
388	$! = $errno;	524	$! = $errno;
389	$message \|\|= "$!";	525	$message \|\|= "$!";
390		526
391	if ($self->{on_error}) {	527	if ($self->{on_error}) {
392	$self->{on_error}($self, $fatal, $message);	528	$self->{on_error}($self, $fatal, $message);
393	$self->destroy;	529	$self->destroy if $fatal;
394	} elsif ($self->{fh}) {	530	} elsif ($self->{fh}) {
395	$self->destroy;	531	$self->destroy;
396	Carp::croak "AnyEvent::Handle uncaught error: $message";	532	Carp::croak "AnyEvent::Handle uncaught error: $message";
397	}	533	}
398	}	534	}
…		…
425	$_[0]{on_eof} = $_[1];	561	$_[0]{on_eof} = $_[1];
426	}	562	}
427		563
428	=item $handle->on_timeout ($cb)	564	=item $handle->on_timeout ($cb)
429		565
430	Replace the current C<on_timeout> callback, or disables the callback (but	566	=item $handle->on_rtimeout ($cb)
431	not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
432	argument and method.
433		567
434	=cut	568	=item $handle->on_wtimeout ($cb)
435		569
436	sub on_timeout {	570	Replace the current C<on_timeout>, C<on_rtimeout> or C<on_wtimeout>
437	$_[0]{on_timeout} = $_[1];	571	callback, or disables the callback (but not the timeout) if C<$cb> =
438	}	572	C<undef>. See the C<timeout> constructor argument and method.
		573
		574	=cut
		575
		576	# see below
439		577
440	=item $handle->autocork ($boolean)	578	=item $handle->autocork ($boolean)
441		579
442	Enables or disables the current autocork behaviour (see C<autocork>	580	Enables or disables the current autocork behaviour (see C<autocork>
443	constructor argument). Changes will only take effect on the next write.	581	constructor argument). Changes will only take effect on the next write.
…		…
458	sub no_delay {	596	sub no_delay {
459	$_[0]{no_delay} = $_[1];	597	$_[0]{no_delay} = $_[1];
460		598
461	eval {	599	eval {
462	local $SIG{__DIE__};	600	local $SIG{__DIE__};
463	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];	601	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1]
		602	if $_[0]{fh};
464	};	603	};
465	}	604	}
466		605
467	=item $handle->on_starttls ($cb)	606	=item $handle->on_starttls ($cb)
468		607
…		…
482		621
483	sub on_starttls {	622	sub on_starttls {
484	$_[0]{on_stoptls} = $_[1];	623	$_[0]{on_stoptls} = $_[1];
485	}	624	}
486		625
		626	=item $handle->rbuf_max ($max_octets)
		627
		628	Configures the C<rbuf_max> setting (C<undef> disables it).
		629
		630	=cut
		631
		632	sub rbuf_max {
		633	$_[0]{rbuf_max} = $_[1];
		634	}
		635
487	#############################################################################	636	#############################################################################
488		637
489	=item $handle->timeout ($seconds)	638	=item $handle->timeout ($seconds)
490		639
		640	=item $handle->rtimeout ($seconds)
		641
		642	=item $handle->wtimeout ($seconds)
		643
491	Configures (or disables) the inactivity timeout.	644	Configures (or disables) the inactivity timeout.
492		645
493	=cut	646	=item $handle->timeout_reset
494		647
495	sub timeout {	648	=item $handle->rtimeout_reset
		649
		650	=item $handle->wtimeout_reset
		651
		652	Reset the activity timeout, as if data was received or sent.
		653
		654	These methods are cheap to call.
		655
		656	=cut
		657
		658	for my $dir ("", "r", "w") {
		659	my $timeout = "${dir}timeout";
		660	my $tw = "_${dir}tw";
		661	my $on_timeout = "on_${dir}timeout";
		662	my $activity = "_${dir}activity";
		663	my $cb;
		664
		665	*$on_timeout = sub {
		666	$_[0]{$on_timeout} = $_[1];
		667	};
		668
		669	*$timeout = sub {
496	my ($self, $timeout) = @_;	670	my ($self, $new_value) = @_;
497		671
498	$self->{timeout} = $timeout;	672	$self->{$timeout} = $new_value;
499	$self->_timeout;	673	delete $self->{$tw}; &$cb;
500	}	674	};
501		675
		676	*{"${dir}timeout_reset"} = sub {
		677	$_[0]{$activity} = AE::now;
		678	};
		679
		680	# main workhorse:
502	# reset the timeout watcher, as neccessary	681	# reset the timeout watcher, as neccessary
503	# also check for time-outs	682	# also check for time-outs
504	sub _timeout {	683	$cb = sub {
505	my ($self) = @_;	684	my ($self) = @_;
506		685
507	if ($self->{timeout}) {	686	if ($self->{$timeout} && $self->{fh}) {
508	my $NOW = AnyEvent->now;	687	my $NOW = AE::now;
509		688
510	# when would the timeout trigger?	689	# when would the timeout trigger?
511	my $after = $self->{_activity} + $self->{timeout} - $NOW;	690	my $after = $self->{$activity} + $self->{$timeout} - $NOW;
512		691
513	# now or in the past already?	692	# now or in the past already?
514	if ($after <= 0) {	693	if ($after <= 0) {
515	$self->{_activity} = $NOW;	694	$self->{$activity} = $NOW;
516		695
517	if ($self->{on_timeout}) {	696	if ($self->{$on_timeout}) {
518	$self->{on_timeout}($self);	697	$self->{$on_timeout}($self);
519	} else {	698	} else {
520	$self->_error (Errno::ETIMEDOUT);	699	$self->_error (Errno::ETIMEDOUT);
		700	}
		701
		702	# callback could have changed timeout value, optimise
		703	return unless $self->{$timeout};
		704
		705	# calculate new after
		706	$after = $self->{$timeout};
521	}	707	}
522		708
523	# callback could have changed timeout value, optimise	709	Scalar::Util::weaken $self;
524	return unless $self->{timeout};	710	return unless $self; # ->error could have destroyed $self
525		711
526	# calculate new after	712	$self->{$tw} \|\|= AE::timer $after, 0, sub {
527	$after = $self->{timeout};	713	delete $self->{$tw};
		714	$cb->($self);
		715	};
		716	} else {
		717	delete $self->{$tw};
528	}	718	}
529
530	Scalar::Util::weaken $self;
531	return unless $self; # ->error could have destroyed $self
532
533	$self->{_tw} \|\|= AnyEvent->timer (after => $after, cb => sub {
534	delete $self->{_tw};
535	$self->_timeout;
536	});
537	} else {
538	delete $self->{_tw};
539	}	719	}
540	}	720	}
541		721
542	#############################################################################	722	#############################################################################
543		723
…		…
591	my $len = syswrite $self->{fh}, $self->{wbuf};	771	my $len = syswrite $self->{fh}, $self->{wbuf};
592		772
593	if (defined $len) {	773	if (defined $len) {
594	substr $self->{wbuf}, 0, $len, "";	774	substr $self->{wbuf}, 0, $len, "";
595		775
596	$self->{_activity} = AnyEvent->now;	776	$self->{_activity} = $self->{_wactivity} = AE::now;
597		777
598	$self->{on_drain}($self)	778	$self->{on_drain}($self)
599	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})	779	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
600	&& $self->{on_drain};	780	&& $self->{on_drain};
601		781
…		…
607		787
608	# try to write data immediately	788	# try to write data immediately
609	$cb->() unless $self->{autocork};	789	$cb->() unless $self->{autocork};
610		790
611	# if still data left in wbuf, we need to poll	791	# if still data left in wbuf, we need to poll
612	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	792	$self->{_ww} = AE::io $self->{fh}, 1, $cb
613	if length $self->{wbuf};	793	if length $self->{wbuf};
614	};	794	};
615	}	795	}
616		796
617	our %WH;	797	our %WH;
…		…
630	->($self, @_);	810	->($self, @_);
631	}	811	}
632		812
633	if ($self->{tls}) {	813	if ($self->{tls}) {
634	$self->{_tls_wbuf} .= $_[0];	814	$self->{_tls_wbuf} .= $_[0];
635		815	&_dotls ($self) if $self->{fh};
636	&_dotls ($self);
637	} else {	816	} else {
638	$self->{wbuf} .= $_[0];	817	$self->{wbuf} .= $_[0];
639	$self->_drain_wbuf;	818	$self->_drain_wbuf if $self->{fh};
640	}	819	}
641	}	820	}
642		821
643	=item $handle->push_write (type => @args)	822	=item $handle->push_write (type => @args)
644		823
…		…
861	=cut	1040	=cut
862		1041
863	sub _drain_rbuf {	1042	sub _drain_rbuf {
864	my ($self) = @_;	1043	my ($self) = @_;
865		1044
		1045	# avoid recursion
		1046	return if $self->{_skip_drain_rbuf};
866	local $self->{_in_drain} = 1;	1047	local $self->{_skip_drain_rbuf} = 1;
867
868	if (
869	defined $self->{rbuf_max}
870	&& $self->{rbuf_max} < length $self->{rbuf}
871	) {
872	$self->_error (Errno::ENOSPC, 1), return;
873	}
874		1048
875	while () {	1049	while () {
876	# we need to use a separate tls read buffer, as we must not receive data while	1050	# we need to use a separate tls read buffer, as we must not receive data while
877	# we are draining the buffer, and this can only happen with TLS.	1051	# we are draining the buffer, and this can only happen with TLS.
878	$self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf};	1052	$self->{rbuf} .= delete $self->{_tls_rbuf}
		1053	if exists $self->{_tls_rbuf};
879		1054
880	my $len = length $self->{rbuf};	1055	my $len = length $self->{rbuf};
881		1056
882	if (my $cb = shift @{ $self->{_queue} }) {	1057	if (my $cb = shift @{ $self->{_queue} }) {
883	unless ($cb->($self)) {	1058	unless ($cb->($self)) {
884	if ($self->{_eof}) {	1059	# no progress can be made
885	# no progress can be made (not enough data and no data forthcoming)	1060	# (not enough data and no data forthcoming)
886	$self->_error (Errno::EPIPE, 1), return;	1061	$self->_error (Errno::EPIPE, 1), return
887	}	1062	if $self->{_eof};
888		1063
889	unshift @{ $self->{_queue} }, $cb;	1064	unshift @{ $self->{_queue} }, $cb;
890	last;	1065	last;
891	}	1066	}
892	} elsif ($self->{on_read}) {	1067	} elsif ($self->{on_read}) {
…		…
912	last;	1087	last;
913	}	1088	}
914	}	1089	}
915		1090
916	if ($self->{_eof}) {	1091	if ($self->{_eof}) {
917	if ($self->{on_eof}) {	1092	$self->{on_eof}
918	$self->{on_eof}($self)	1093	? $self->{on_eof}($self)
919	} else {
920	$self->_error (0, 1, "Unexpected end-of-file");	1094	: $self->_error (0, 1, "Unexpected end-of-file");
921	}	1095
		1096	return;
		1097	}
		1098
		1099	if (
		1100	defined $self->{rbuf_max}
		1101	&& $self->{rbuf_max} < length $self->{rbuf}
		1102	) {
		1103	$self->_error (Errno::ENOSPC, 1), return;
922	}	1104	}
923		1105
924	# may need to restart read watcher	1106	# may need to restart read watcher
925	unless ($self->{_rw}) {	1107	unless ($self->{_rw}) {
926	$self->start_read	1108	$self->start_read
…		…
938		1120
939	sub on_read {	1121	sub on_read {
940	my ($self, $cb) = @_;	1122	my ($self, $cb) = @_;
941		1123
942	$self->{on_read} = $cb;	1124	$self->{on_read} = $cb;
943	$self->_drain_rbuf if $cb && !$self->{_in_drain};	1125	$self->_drain_rbuf if $cb;
944	}	1126	}
945		1127
946	=item $handle->rbuf	1128	=item $handle->rbuf
947		1129
948	Returns the read buffer (as a modifiable lvalue).	1130	Returns the read buffer (as a modifiable lvalue).
…		…
1000	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	1182	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
1001	->($self, $cb, @_);	1183	->($self, $cb, @_);
1002	}	1184	}
1003		1185
1004	push @{ $self->{_queue} }, $cb;	1186	push @{ $self->{_queue} }, $cb;
1005	$self->_drain_rbuf unless $self->{_in_drain};	1187	$self->_drain_rbuf;
1006	}	1188	}
1007		1189
1008	sub unshift_read {	1190	sub unshift_read {
1009	my $self = shift;	1191	my $self = shift;
1010	my $cb = pop;	1192	my $cb = pop;
…		…
1016	->($self, $cb, @_);	1198	->($self, $cb, @_);
1017	}	1199	}
1018		1200
1019		1201
1020	unshift @{ $self->{_queue} }, $cb;	1202	unshift @{ $self->{_queue} }, $cb;
1021	$self->_drain_rbuf unless $self->{_in_drain};	1203	$self->_drain_rbuf;
1022	}	1204	}
1023		1205
1024	=item $handle->push_read (type => @args, $cb)	1206	=item $handle->push_read (type => @args, $cb)
1025		1207
1026	=item $handle->unshift_read (type => @args, $cb)	1208	=item $handle->unshift_read (type => @args, $cb)
…		…
1407	my ($self) = @_;	1589	my ($self) = @_;
1408		1590
1409	unless ($self->{_rw} \|\| $self->{_eof}) {	1591	unless ($self->{_rw} \|\| $self->{_eof}) {
1410	Scalar::Util::weaken $self;	1592	Scalar::Util::weaken $self;
1411		1593
1412	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1594	$self->{_rw} = AE::io $self->{fh}, 0, sub {
1413	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});	1595	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1414	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;	1596	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;
1415		1597
1416	if ($len > 0) {	1598	if ($len > 0) {
1417	$self->{_activity} = AnyEvent->now;	1599	$self->{_activity} = $self->{_ractivity} = AE::now;
1418		1600
1419	if ($self->{tls}) {	1601	if ($self->{tls}) {
1420	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);	1602	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1421		1603
1422	&_dotls ($self);	1604	&_dotls ($self);
1423	} else {	1605	} else {
1424	$self->_drain_rbuf unless $self->{_in_drain};	1606	$self->_drain_rbuf;
1425	}	1607	}
1426		1608
1427	} elsif (defined $len) {	1609	} elsif (defined $len) {
1428	delete $self->{_rw};	1610	delete $self->{_rw};
1429	$self->{_eof} = 1;	1611	$self->{_eof} = 1;
1430	$self->_drain_rbuf unless $self->{_in_drain};	1612	$self->_drain_rbuf;
1431		1613
1432	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1614	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1433	return $self->_error ($!, 1);	1615	return $self->_error ($!, 1);
1434	}	1616	}
1435	});	1617	};
1436	}	1618	}
1437	}	1619	}
1438		1620
1439	our $ERROR_SYSCALL;	1621	our $ERROR_SYSCALL;
1440	our $ERROR_WANT_READ;	1622	our $ERROR_WANT_READ;
…		…
1495	$self->{_eof} = 1;	1677	$self->{_eof} = 1;
1496	}	1678	}
1497	}	1679	}
1498		1680
1499	$self->{_tls_rbuf} .= $tmp;	1681	$self->{_tls_rbuf} .= $tmp;
1500	$self->_drain_rbuf unless $self->{_in_drain};	1682	$self->_drain_rbuf;
1501	$self->{tls} or return; # tls session might have gone away in callback	1683	$self->{tls} or return; # tls session might have gone away in callback
1502	}	1684	}
1503		1685
1504	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);	1686	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1505	return $self->_tls_error ($tmp)	1687	return $self->_tls_error ($tmp)
…		…
1520		1702
1521	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	1703	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
1522	object is created, you can also do that at a later time by calling	1704	object is created, you can also do that at a later time by calling
1523	C<starttls>.	1705	C<starttls>.
1524		1706
		1707	Starting TLS is currently an asynchronous operation - when you push some
		1708	write data and then call C<< ->starttls >> then TLS negotiation will start
		1709	immediately, after which the queued write data is then sent.
		1710
1525	The first argument is the same as the C<tls> constructor argument (either	1711	The first argument is the same as the C<tls> constructor argument (either
1526	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1712	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1527		1713
1528	The second argument is the optional C<AnyEvent::TLS> object that is used	1714	The second argument is the optional C<AnyEvent::TLS> object that is used
1529	when AnyEvent::Handle has to create its own TLS connection object, or	1715	when AnyEvent::Handle has to create its own TLS connection object, or
…		…
1533	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS	1719	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS
1534	context in C<< $handle->{tls_ctx} >> after this call and can be used or	1720	context in C<< $handle->{tls_ctx} >> after this call and can be used or
1535	changed to your liking. Note that the handshake might have already started	1721	changed to your liking. Note that the handshake might have already started
1536	when this function returns.	1722	when this function returns.
1537		1723
1538	If it an error to start a TLS handshake more than once per	1724	Due to bugs in OpenSSL, it might or might not be possible to do multiple
1539	AnyEvent::Handle object (this is due to bugs in OpenSSL).	1725	handshakes on the same stream. Best do not attempt to use the stream after
		1726	stopping TLS.
1540		1727
1541	=cut	1728	=cut
1542		1729
1543	our %TLS_CACHE; #TODO not yet documented, should we?	1730	our %TLS_CACHE; #TODO not yet documented, should we?
1544		1731
1545	sub starttls {	1732	sub starttls {
1546	my ($self, $ssl, $ctx) = @_;	1733	my ($self, $tls, $ctx) = @_;
		1734
		1735	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"
		1736	if $self->{tls};
		1737
		1738	$self->{tls} = $tls;
		1739	$self->{tls_ctx} = $ctx if @_ > 2;
		1740
		1741	return unless $self->{fh};
1547		1742
1548	require Net::SSLeay;	1743	require Net::SSLeay;
1549
1550	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"
1551	if $self->{tls};
1552		1744
1553	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();	1745	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1554	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();	1746	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1555		1747
		1748	$tls = $self->{tls};
1556	$ctx \|\|= $self->{tls_ctx};	1749	$ctx = $self->{tls_ctx};
		1750
		1751	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
1557		1752
1558	if ("HASH" eq ref $ctx) {	1753	if ("HASH" eq ref $ctx) {
1559	require AnyEvent::TLS;	1754	require AnyEvent::TLS;
1560
1561	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context
1562		1755
1563	if ($ctx->{cache}) {	1756	if ($ctx->{cache}) {
1564	my $key = $ctx+0;	1757	my $key = $ctx+0;
1565	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;	1758	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;
1566	} else {	1759	} else {
1567	$ctx = new AnyEvent::TLS %$ctx;	1760	$ctx = new AnyEvent::TLS %$ctx;
1568	}	1761	}
1569	}	1762	}
1570		1763
1571	$self->{tls_ctx} = $ctx \|\| TLS_CTX ();	1764	$self->{tls_ctx} = $ctx \|\| TLS_CTX ();
1572	$self->{tls} = $ssl = $self->{tls_ctx}->_get_session ($ssl, $self, $self->{peername});	1765	$self->{tls} = $tls = $self->{tls_ctx}->_get_session ($tls, $self, $self->{peername});
1573		1766
1574	# basically, this is deep magic (because SSL_read should have the same issues)	1767	# basically, this is deep magic (because SSL_read should have the same issues)
1575	# but the openssl maintainers basically said: "trust us, it just works".	1768	# but the openssl maintainers basically said: "trust us, it just works".
1576	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1769	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1577	# and mismaintained ssleay-module doesn't even offer them).	1770	# and mismaintained ssleay-module doesn't even offer them).
…		…
1584	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to	1777	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
1585	# have identity issues in that area.	1778	# have identity issues in that area.
1586	# Net::SSLeay::CTX_set_mode ($ssl,	1779	# Net::SSLeay::CTX_set_mode ($ssl,
1587	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1780	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
1588	# \| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));	1781	# \| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
1589	Net::SSLeay::CTX_set_mode ($ssl, 1\|2);	1782	Net::SSLeay::CTX_set_mode ($tls, 1\|2);
1590		1783
1591	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1784	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1592	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1785	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1593		1786
		1787	Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf});
		1788
1594	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1789	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
1595		1790
1596	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }	1791	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1597	if $self->{on_starttls};	1792	if $self->{on_starttls};
1598		1793
1599	&_dotls; # need to trigger the initial handshake	1794	&_dotls; # need to trigger the initial handshake
…		…
1602		1797
1603	=item $handle->stoptls	1798	=item $handle->stoptls
1604		1799
1605	Shuts down the SSL connection - this makes a proper EOF handshake by	1800	Shuts down the SSL connection - this makes a proper EOF handshake by
1606	sending a close notify to the other side, but since OpenSSL doesn't	1801	sending a close notify to the other side, but since OpenSSL doesn't
1607	support non-blocking shut downs, it is not possible to re-use the stream	1802	support non-blocking shut downs, it is not guarenteed that you can re-use
1608	afterwards.	1803	the stream afterwards.
1609		1804
1610	=cut	1805	=cut
1611		1806
1612	sub stoptls {	1807	sub stoptls {
1613	my ($self) = @_;	1808	my ($self) = @_;
…		…
1626	sub _freetls {	1821	sub _freetls {
1627	my ($self) = @_;	1822	my ($self) = @_;
1628		1823
1629	return unless $self->{tls};	1824	return unless $self->{tls};
1630		1825
1631	$self->{tls_ctx}->_put_session (delete $self->{tls});	1826	$self->{tls_ctx}->_put_session (delete $self->{tls})
		1827	if $self->{tls} > 0;
1632		1828
1633	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};	1829	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1634	}	1830	}
1635		1831
1636	sub DESTROY {	1832	sub DESTROY {
…		…
1638		1834
1639	&_freetls;	1835	&_freetls;
1640		1836
1641	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	1837	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1642		1838
1643	if ($linger && length $self->{wbuf}) {	1839	if ($linger && length $self->{wbuf} && $self->{fh}) {
1644	my $fh = delete $self->{fh};	1840	my $fh = delete $self->{fh};
1645	my $wbuf = delete $self->{wbuf};	1841	my $wbuf = delete $self->{wbuf};
1646		1842
1647	my @linger;	1843	my @linger;
1648		1844
1649	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {	1845	push @linger, AE::io $fh, 1, sub {
1650	my $len = syswrite $fh, $wbuf, length $wbuf;	1846	my $len = syswrite $fh, $wbuf, length $wbuf;
1651		1847
1652	if ($len > 0) {	1848	if ($len > 0) {
1653	substr $wbuf, 0, $len, "";	1849	substr $wbuf, 0, $len, "";
1654	} else {	1850	} else {
1655	@linger = (); # end	1851	@linger = (); # end
1656	}	1852	}
1657	});	1853	};
1658	push @linger, AnyEvent->timer (after => $linger, cb => sub {	1854	push @linger, AE::timer $linger, 0, sub {
1659	@linger = ();	1855	@linger = ();
1660	});	1856	};
1661	}	1857	}
1662	}	1858	}
1663		1859
1664	=item $handle->destroy	1860	=item $handle->destroy
1665		1861
1666	Shuts down the handle object as much as possible - this call ensures that	1862	Shuts down the handle object as much as possible - this call ensures that
1667	no further callbacks will be invoked and as many resources as possible	1863	no further callbacks will be invoked and as many resources as possible
1668	will be freed. You must not call any methods on the object afterwards.	1864	will be freed. Any method you will call on the handle object after
		1865	destroying it in this way will be silently ignored (and it will return the
		1866	empty list).
1669		1867
1670	Normally, you can just "forget" any references to an AnyEvent::Handle	1868	Normally, you can just "forget" any references to an AnyEvent::Handle
1671	object and it will simply shut down. This works in fatal error and EOF	1869	object and it will simply shut down. This works in fatal error and EOF
1672	callbacks, as well as code outside. It does I<NOT> work in a read or write	1870	callbacks, as well as code outside. It does I<NOT> work in a read or write
1673	callback, so when you want to destroy the AnyEvent::Handle object from	1871	callback, so when you want to destroy the AnyEvent::Handle object from
…		…
1687	sub destroy {	1885	sub destroy {
1688	my ($self) = @_;	1886	my ($self) = @_;
1689		1887
1690	$self->DESTROY;	1888	$self->DESTROY;
1691	%$self = ();	1889	%$self = ();
		1890	bless $self, "AnyEvent::Handle::destroyed";
		1891	}
		1892
		1893	sub AnyEvent::Handle::destroyed::AUTOLOAD {
		1894	#nop
1692	}	1895	}
1693		1896
1694	=item AnyEvent::Handle::TLS_CTX	1897	=item AnyEvent::Handle::TLS_CTX
1695		1898
1696	This function creates and returns the AnyEvent::TLS object used by default	1899	This function creates and returns the AnyEvent::TLS object used by default

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.150 by root, Thu Jul 16 04:16:25 2009 UTC vs. Revision 1.177 by root, Sun Aug 9 00:24:35 2009 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.150 by root, Thu Jul 16 04:16:25 2009 UTC vs.
Revision 1.177 by root, Sun Aug 9 00:24:35 2009 UTC