[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.175 by root, Sat Aug 8 22:20:43 2009 UTC

…		…
1	package AnyEvent::Handle;	1	package AnyEvent::Handle;
2		2
3	no warnings;
4	use strict qw(subs vars);
5
6	use AnyEvent ();
7	use AnyEvent::Util qw(WSAEWOULDBLOCK);
8	use Scalar::Util ();	3	use Scalar::Util ();
9	use Carp ();	4	use Carp ();
10	use Fcntl ();
11	use Errno qw(EAGAIN EINTR);	5	use Errno qw(EAGAIN EINTR);
12		6
		7	use AnyEvent (); BEGIN { AnyEvent::common_sense }
		8	use AnyEvent::Util qw(WSAEWOULDBLOCK);
		9
13	=head1 NAME	10	=head1 NAME
14		11
15	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent	12	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent
16		13
17	=cut	14	=cut
18		15
19	our $VERSION = 4.82;	16	our $VERSION = 4.91;
20		17
21	=head1 SYNOPSIS	18	=head1 SYNOPSIS
22		19
23	use AnyEvent;	20	use AnyEvent;
24	use AnyEvent::Handle;	21	use AnyEvent::Handle;
26	my $cv = AnyEvent->condvar;	23	my $cv = AnyEvent->condvar;
27		24
28	my $hdl; $hdl = new AnyEvent::Handle	25	my $hdl; $hdl = new AnyEvent::Handle
29	fh => \*STDIN,	26	fh => \*STDIN,
30	on_error => sub {	27	on_error => sub {
		28	my ($hdl, $fatal, $msg) = @_;
31	warn "got error $_[2]\n";	29	warn "got error $msg\n";
		30	$hdl->destroy;
32	$cv->send;	31	$cv->send;
33	);	32	);
34		33
35	# send some request line	34	# send some request line
36	$hdl->push_write ("getinfo\015\012");	35	$hdl->push_write ("getinfo\015\012");
…		…
45	$cv->recv;	44	$cv->recv;
46		45
47	=head1 DESCRIPTION	46	=head1 DESCRIPTION
48		47
49	This module is a helper module to make it easier to do event-based I/O on	48	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	49	filehandles.
51	on sockets see L<AnyEvent::Util>.
52		50
53	The L<AnyEvent::Intro> tutorial contains some well-documented	51	The L<AnyEvent::Intro> tutorial contains some well-documented
54	AnyEvent::Handle examples.	52	AnyEvent::Handle examples.
55		53
56	In the following, when the documentation refers to of "bytes" then this	54	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	55	means characters. As sysread and syswrite are used for all I/O, their
58	treatment of characters applies to this module as well.	56	treatment of characters applies to this module as well.
59		57
		58	At the very minimum, you should specify C<fh> or C<connect>, and the
		59	C<on_error> callback.
		60
60	All callbacks will be invoked with the handle object as their first	61	All callbacks will be invoked with the handle object as their first
61	argument.	62	argument.
62		63
63	=head1 METHODS	64	=head1 METHODS
64		65
…		…
68		69
69	The constructor supports these arguments (all as C<< key => value >> pairs).	70	The constructor supports these arguments (all as C<< key => value >> pairs).
70		71
71	=over 4	72	=over 4
72		73
73	=item fh => $filehandle [MANDATORY]	74	=item fh => $filehandle [C<fh> or C<connect> MANDATORY]
74		75
75	The filehandle this L<AnyEvent::Handle> object will operate on.	76	The filehandle this L<AnyEvent::Handle> object will operate on.
76
77	NOTE: The filehandle will be set to non-blocking mode (using	77	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	78	C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in
79	that mode.	79	that mode.
		80
		81	=item connect => [$host, $service] [C<fh> or C<connect> MANDATORY]
		82
		83	Try to connect to the specified host and service (port), using
		84	C<AnyEvent::Socket::tcp_connect>. The C<$host> additionally becomes the
		85	default C<peername>.
		86
		87	You have to specify either this parameter, or C<fh>, above.
		88
		89	It is possible to push requests on the read and write queues, and modify
		90	properties of the stream, even while AnyEvent::Handle is connecting.
		91
		92	When this parameter is specified, then the C<on_prepare>,
		93	C<on_connect_error> and C<on_connect> callbacks will be called under the
		94	appropriate circumstances:
		95
		96	=over 4
		97
		98	=item on_prepare => $cb->($handle)
		99
		100	This (rarely used) callback is called before a new connection is
		101	attempted, but after the file handle has been created. It could be used to
		102	prepare the file handle with parameters required for the actual connect
		103	(as opposed to settings that can be changed when the connection is already
		104	established).
		105
		106	The return value of this callback should be the connect timeout value in
		107	seconds (or C<0>, or C<undef>, or the empty list, to indicate the default
		108	timeout is to be used).
		109
		110	=item on_connect => $cb->($handle, $host, $port, $retry->())
		111
		112	This callback is called when a connection has been successfully established.
		113
		114	The actual numeric host and port (the socket peername) are passed as
		115	parameters, together with a retry callback.
		116
		117	When, for some reason, the handle is not acceptable, then calling
		118	C<$retry> will continue with the next conenction target (in case of
		119	multi-homed hosts or SRV records there can be multiple connection
		120	endpoints). When it is called then the read and write queues, eof status,
		121	tls status and similar properties of the handle are being reset.
		122
		123	In most cases, ignoring the C<$retry> parameter is the way to go.
		124
		125	=item on_connect_error => $cb->($handle, $message)
		126
		127	This callback is called when the conenction could not be
		128	established. C<$!> will contain the relevant error code, and C<$message> a
		129	message describing it (usually the same as C<"$!">).
		130
		131	If this callback isn't specified, then C<on_error> will be called with a
		132	fatal error instead.
		133
		134	=back
		135
		136	=item on_error => $cb->($handle, $fatal, $message)
		137
		138	This is the error callback, which is called when, well, some error
		139	occured, such as not being able to resolve the hostname, failure to
		140	connect or a read error.
		141
		142	Some errors are fatal (which is indicated by C<$fatal> being true). On
		143	fatal errors the handle object will be destroyed (by a call to C<< ->
		144	destroy >>) after invoking the error callback (which means you are free to
		145	examine the handle object). Examples of fatal errors are an EOF condition
		146	with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors. In
		147	cases where the other side can close the connection at their will it is
		148	often easiest to not report C<EPIPE> errors in this callback.
		149
		150	AnyEvent::Handle tries to find an appropriate error code for you to check
		151	against, but in some cases (TLS errors), this does not work well. It is
		152	recommended to always output the C<$message> argument in human-readable
		153	error messages (it's usually the same as C<"$!">).
		154
		155	Non-fatal errors can be retried by simply returning, but it is recommended
		156	to simply ignore this parameter and instead abondon the handle object
		157	when this callback is invoked. Examples of non-fatal errors are timeouts
		158	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
		159
		160	On callback entrance, the value of C<$!> contains the operating system
		161	error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
		162	C<EPROTO>).
		163
		164	While not mandatory, it is I<highly> recommended to set this callback, as
		165	you will not be notified of errors otherwise. The default simply calls
		166	C<croak>.
		167
		168	=item on_read => $cb->($handle)
		169
		170	This sets the default read callback, which is called when data arrives
		171	and no read request is in the queue (unlike read queue callbacks, this
		172	callback will only be called when at least one octet of data is in the
		173	read buffer).
		174
		175	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
		176	method or access the C<< $handle->{rbuf} >> member directly. Note that you
		177	must not enlarge or modify the read buffer, you can only remove data at
		178	the beginning from it.
		179
		180	When an EOF condition is detected then AnyEvent::Handle will first try to
		181	feed all the remaining data to the queued callbacks and C<on_read> before
		182	calling the C<on_eof> callback. If no progress can be made, then a fatal
		183	error will be raised (with C<$!> set to C<EPIPE>).
		184
		185	Note that, unlike requests in the read queue, an C<on_read> callback
		186	doesn't mean you I<require> some data: if there is an EOF and there
		187	are outstanding read requests then an error will be flagged. With an
		188	C<on_read> callback, the C<on_eof> callback will be invoked.
80		189
81	=item on_eof => $cb->($handle)	190	=item on_eof => $cb->($handle)
82		191
83	Set the callback to be called when an end-of-file condition is detected,	192	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	193	i.e. in the case of a socket, when the other side has closed the
…		…
91	callback and continue writing data, as only the read part has been shut	200	callback and continue writing data, as only the read part has been shut
92	down.	201	down.
93		202
94	If an EOF condition has been detected but no C<on_eof> callback has been	203	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>.	204	set, then a fatal error will be raised with C<$!> set to <0>.
96
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		205
149	=item on_drain => $cb->($handle)	206	=item on_drain => $cb->($handle)
150		207
151	This sets the callback that is called when the write buffer becomes empty	208	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).	209	(or when the callback is set and the buffer is empty already).
…		…
351		408
352	sub new {	409	sub new {
353	my $class = shift;	410	my $class = shift;
354	my $self = bless { @_ }, $class;	411	my $self = bless { @_ }, $class;
355		412
356	$self->{fh} or Carp::croak "mandatory argument fh is missing";	413	if ($self->{fh}) {
		414	$self->_start;
		415	return unless $self->{fh}; # could be gone by now
		416
		417	} elsif ($self->{connect}) {
		418	require AnyEvent::Socket;
		419
		420	$self->{peername} = $self->{connect}[0]
		421	unless exists $self->{peername};
		422
		423	$self->{_skip_drain_rbuf} = 1;
		424
		425	{
		426	Scalar::Util::weaken (my $self = $self);
		427
		428	$self->{_connect} =
		429	AnyEvent::Socket::tcp_connect (
		430	$self->{connect}[0],
		431	$self->{connect}[1],
		432	sub {
		433	my ($fh, $host, $port, $retry) = @_;
		434
		435	if ($fh) {
		436	$self->{fh} = $fh;
		437
		438	delete $self->{_skip_drain_rbuf};
		439	$self->_start;
		440
		441	$self->{on_connect}
		442	and $self->{on_connect}($self, $host, $port, sub {
		443	delete @$self{qw(fh _tw _ww _rw _eof _queue rbuf _wbuf tls _tls_rbuf _tls_wbuf)};
		444	$self->{_skip_drain_rbuf} = 1;
		445	&$retry;
		446	});
		447
		448	} else {
		449	if ($self->{on_connect_error}) {
		450	$self->{on_connect_error}($self, "$!");
		451	$self->destroy;
		452	} else {
		453	$self->_error ($!, 1);
		454	}
		455	}
		456	},
		457	sub {
		458	local $self->{fh} = $_[0];
		459
		460	$self->{on_prepare}
		461	? $self->{on_prepare}->($self)
		462	: ()
		463	}
		464	);
		465	}
		466
		467	} else {
		468	Carp::croak "AnyEvent::Handle: either an existing fh or the connect parameter must be specified";
		469	}
		470
		471	$self
		472	}
		473
		474	sub _start {
		475	my ($self) = @_;
357		476
358	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	477	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
359		478
360	$self->{_activity} = AnyEvent->now;	479	$self->{_activity} = AE::now;
361	$self->_timeout;	480	$self->_timeout;
362		481
363	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};	482	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
364		483
365	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})	484	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
366	if $self->{tls};	485	if $self->{tls};
367		486
368	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	487	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
369		488
370	$self->start_read	489	$self->start_read
371	if $self->{on_read};	490	if $self->{on_read} \|\| @{ $self->{_queue} };
372		491
373	$self->{fh} && $self	492	$self->_drain_wbuf;
374	}	493	}
375		494
376	#sub _shutdown {	495	#sub _shutdown {
377	# my ($self) = @_;	496	# my ($self) = @_;
378	#	497	#
…		…
388	$! = $errno;	507	$! = $errno;
389	$message \|\|= "$!";	508	$message \|\|= "$!";
390		509
391	if ($self->{on_error}) {	510	if ($self->{on_error}) {
392	$self->{on_error}($self, $fatal, $message);	511	$self->{on_error}($self, $fatal, $message);
393	$self->destroy;	512	$self->destroy if $fatal;
394	} elsif ($self->{fh}) {	513	} elsif ($self->{fh}) {
395	$self->destroy;	514	$self->destroy;
396	Carp::croak "AnyEvent::Handle uncaught error: $message";	515	Carp::croak "AnyEvent::Handle uncaught error: $message";
397	}	516	}
398	}	517	}
…		…
458	sub no_delay {	577	sub no_delay {
459	$_[0]{no_delay} = $_[1];	578	$_[0]{no_delay} = $_[1];
460		579
461	eval {	580	eval {
462	local $SIG{__DIE__};	581	local $SIG{__DIE__};
463	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];	582	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1]
		583	if $_[0]{fh};
464	};	584	};
465	}	585	}
466		586
467	=item $handle->on_starttls ($cb)	587	=item $handle->on_starttls ($cb)
468		588
…		…
482		602
483	sub on_starttls {	603	sub on_starttls {
484	$_[0]{on_stoptls} = $_[1];	604	$_[0]{on_stoptls} = $_[1];
485	}	605	}
486		606
		607	=item $handle->rbuf_max ($max_octets)
		608
		609	Configures the C<rbuf_max> setting (C<undef> disables it).
		610
		611	=cut
		612
		613	sub rbuf_max {
		614	$_[0]{rbuf_max} = $_[1];
		615	}
		616
487	#############################################################################	617	#############################################################################
488		618
489	=item $handle->timeout ($seconds)	619	=item $handle->timeout ($seconds)
490		620
491	Configures (or disables) the inactivity timeout.	621	Configures (or disables) the inactivity timeout.
…		…
494		624
495	sub timeout {	625	sub timeout {
496	my ($self, $timeout) = @_;	626	my ($self, $timeout) = @_;
497		627
498	$self->{timeout} = $timeout;	628	$self->{timeout} = $timeout;
		629	delete $self->{_tw};
499	$self->_timeout;	630	$self->_timeout;
500	}	631	}
501		632
502	# reset the timeout watcher, as neccessary	633	# reset the timeout watcher, as neccessary
503	# also check for time-outs	634	# also check for time-outs
504	sub _timeout {	635	sub _timeout {
505	my ($self) = @_;	636	my ($self) = @_;
506		637
507	if ($self->{timeout}) {	638	if ($self->{timeout} && $self->{fh}) {
508	my $NOW = AnyEvent->now;	639	my $NOW = AE::now;
509		640
510	# when would the timeout trigger?	641	# when would the timeout trigger?
511	my $after = $self->{_activity} + $self->{timeout} - $NOW;	642	my $after = $self->{_activity} + $self->{timeout} - $NOW;
512		643
513	# now or in the past already?	644	# now or in the past already?
…		…
528	}	659	}
529		660
530	Scalar::Util::weaken $self;	661	Scalar::Util::weaken $self;
531	return unless $self; # ->error could have destroyed $self	662	return unless $self; # ->error could have destroyed $self
532		663
533	$self->{_tw} \|\|= AnyEvent->timer (after => $after, cb => sub {	664	$self->{_tw} \|\|= AE::timer $after, 0, sub {
534	delete $self->{_tw};	665	delete $self->{_tw};
535	$self->_timeout;	666	$self->_timeout;
536	});	667	};
537	} else {	668	} else {
538	delete $self->{_tw};	669	delete $self->{_tw};
539	}	670	}
540	}	671	}
541		672
…		…
591	my $len = syswrite $self->{fh}, $self->{wbuf};	722	my $len = syswrite $self->{fh}, $self->{wbuf};
592		723
593	if (defined $len) {	724	if (defined $len) {
594	substr $self->{wbuf}, 0, $len, "";	725	substr $self->{wbuf}, 0, $len, "";
595		726
596	$self->{_activity} = AnyEvent->now;	727	$self->{_activity} = AE::now;
597		728
598	$self->{on_drain}($self)	729	$self->{on_drain}($self)
599	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})	730	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
600	&& $self->{on_drain};	731	&& $self->{on_drain};
601		732
…		…
607		738
608	# try to write data immediately	739	# try to write data immediately
609	$cb->() unless $self->{autocork};	740	$cb->() unless $self->{autocork};
610		741
611	# if still data left in wbuf, we need to poll	742	# if still data left in wbuf, we need to poll
612	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	743	$self->{_ww} = AE::io $self->{fh}, 1, $cb
613	if length $self->{wbuf};	744	if length $self->{wbuf};
614	};	745	};
615	}	746	}
616		747
617	our %WH;	748	our %WH;
…		…
630	->($self, @_);	761	->($self, @_);
631	}	762	}
632		763
633	if ($self->{tls}) {	764	if ($self->{tls}) {
634	$self->{_tls_wbuf} .= $_[0];	765	$self->{_tls_wbuf} .= $_[0];
635		766	&_dotls ($self) if $self->{fh};
636	&_dotls ($self);
637	} else {	767	} else {
638	$self->{wbuf} .= $_[0];	768	$self->{wbuf} .= $_[0];
639	$self->_drain_wbuf;	769	$self->_drain_wbuf if $self->{fh};
640	}	770	}
641	}	771	}
642		772
643	=item $handle->push_write (type => @args)	773	=item $handle->push_write (type => @args)
644		774
…		…
861	=cut	991	=cut
862		992
863	sub _drain_rbuf {	993	sub _drain_rbuf {
864	my ($self) = @_;	994	my ($self) = @_;
865		995
		996	# avoid recursion
		997	return if $self->{_skip_drain_rbuf};
866	local $self->{_in_drain} = 1;	998	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		999
875	while () {	1000	while () {
876	# we need to use a separate tls read buffer, as we must not receive data while	1001	# 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.	1002	# we are draining the buffer, and this can only happen with TLS.
878	$self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf};	1003	$self->{rbuf} .= delete $self->{_tls_rbuf}
		1004	if exists $self->{_tls_rbuf};
879		1005
880	my $len = length $self->{rbuf};	1006	my $len = length $self->{rbuf};
881		1007
882	if (my $cb = shift @{ $self->{_queue} }) {	1008	if (my $cb = shift @{ $self->{_queue} }) {
883	unless ($cb->($self)) {	1009	unless ($cb->($self)) {
884	if ($self->{_eof}) {	1010	# no progress can be made
885	# no progress can be made (not enough data and no data forthcoming)	1011	# (not enough data and no data forthcoming)
886	$self->_error (Errno::EPIPE, 1), return;	1012	$self->_error (Errno::EPIPE, 1), return
887	}	1013	if $self->{_eof};
888		1014
889	unshift @{ $self->{_queue} }, $cb;	1015	unshift @{ $self->{_queue} }, $cb;
890	last;	1016	last;
891	}	1017	}
892	} elsif ($self->{on_read}) {	1018	} elsif ($self->{on_read}) {
…		…
912	last;	1038	last;
913	}	1039	}
914	}	1040	}
915		1041
916	if ($self->{_eof}) {	1042	if ($self->{_eof}) {
917	if ($self->{on_eof}) {	1043	$self->{on_eof}
918	$self->{on_eof}($self)	1044	? $self->{on_eof}($self)
919	} else {
920	$self->_error (0, 1, "Unexpected end-of-file");	1045	: $self->_error (0, 1, "Unexpected end-of-file");
921	}	1046
		1047	return;
		1048	}
		1049
		1050	if (
		1051	defined $self->{rbuf_max}
		1052	&& $self->{rbuf_max} < length $self->{rbuf}
		1053	) {
		1054	$self->_error (Errno::ENOSPC, 1), return;
922	}	1055	}
923		1056
924	# may need to restart read watcher	1057	# may need to restart read watcher
925	unless ($self->{_rw}) {	1058	unless ($self->{_rw}) {
926	$self->start_read	1059	$self->start_read
…		…
938		1071
939	sub on_read {	1072	sub on_read {
940	my ($self, $cb) = @_;	1073	my ($self, $cb) = @_;
941		1074
942	$self->{on_read} = $cb;	1075	$self->{on_read} = $cb;
943	$self->_drain_rbuf if $cb && !$self->{_in_drain};	1076	$self->_drain_rbuf if $cb;
944	}	1077	}
945		1078
946	=item $handle->rbuf	1079	=item $handle->rbuf
947		1080
948	Returns the read buffer (as a modifiable lvalue).	1081	Returns the read buffer (as a modifiable lvalue).
…		…
1000	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	1133	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
1001	->($self, $cb, @_);	1134	->($self, $cb, @_);
1002	}	1135	}
1003		1136
1004	push @{ $self->{_queue} }, $cb;	1137	push @{ $self->{_queue} }, $cb;
1005	$self->_drain_rbuf unless $self->{_in_drain};	1138	$self->_drain_rbuf;
1006	}	1139	}
1007		1140
1008	sub unshift_read {	1141	sub unshift_read {
1009	my $self = shift;	1142	my $self = shift;
1010	my $cb = pop;	1143	my $cb = pop;
…		…
1016	->($self, $cb, @_);	1149	->($self, $cb, @_);
1017	}	1150	}
1018		1151
1019		1152
1020	unshift @{ $self->{_queue} }, $cb;	1153	unshift @{ $self->{_queue} }, $cb;
1021	$self->_drain_rbuf unless $self->{_in_drain};	1154	$self->_drain_rbuf;
1022	}	1155	}
1023		1156
1024	=item $handle->push_read (type => @args, $cb)	1157	=item $handle->push_read (type => @args, $cb)
1025		1158
1026	=item $handle->unshift_read (type => @args, $cb)	1159	=item $handle->unshift_read (type => @args, $cb)
…		…
1407	my ($self) = @_;	1540	my ($self) = @_;
1408		1541
1409	unless ($self->{_rw} \|\| $self->{_eof}) {	1542	unless ($self->{_rw} \|\| $self->{_eof}) {
1410	Scalar::Util::weaken $self;	1543	Scalar::Util::weaken $self;
1411		1544
1412	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1545	$self->{_rw} = AE::io $self->{fh}, 0, sub {
1413	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});	1546	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1414	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;	1547	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;
1415		1548
1416	if ($len > 0) {	1549	if ($len > 0) {
1417	$self->{_activity} = AnyEvent->now;	1550	$self->{_activity} = AE::now;
1418		1551
1419	if ($self->{tls}) {	1552	if ($self->{tls}) {
1420	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);	1553	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1421		1554
1422	&_dotls ($self);	1555	&_dotls ($self);
1423	} else {	1556	} else {
1424	$self->_drain_rbuf unless $self->{_in_drain};	1557	$self->_drain_rbuf;
1425	}	1558	}
1426		1559
1427	} elsif (defined $len) {	1560	} elsif (defined $len) {
1428	delete $self->{_rw};	1561	delete $self->{_rw};
1429	$self->{_eof} = 1;	1562	$self->{_eof} = 1;
1430	$self->_drain_rbuf unless $self->{_in_drain};	1563	$self->_drain_rbuf;
1431		1564
1432	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1565	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1433	return $self->_error ($!, 1);	1566	return $self->_error ($!, 1);
1434	}	1567	}
1435	});	1568	};
1436	}	1569	}
1437	}	1570	}
1438		1571
1439	our $ERROR_SYSCALL;	1572	our $ERROR_SYSCALL;
1440	our $ERROR_WANT_READ;	1573	our $ERROR_WANT_READ;
…		…
1495	$self->{_eof} = 1;	1628	$self->{_eof} = 1;
1496	}	1629	}
1497	}	1630	}
1498		1631
1499	$self->{_tls_rbuf} .= $tmp;	1632	$self->{_tls_rbuf} .= $tmp;
1500	$self->_drain_rbuf unless $self->{_in_drain};	1633	$self->_drain_rbuf;
1501	$self->{tls} or return; # tls session might have gone away in callback	1634	$self->{tls} or return; # tls session might have gone away in callback
1502	}	1635	}
1503		1636
1504	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);	1637	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1505	return $self->_tls_error ($tmp)	1638	return $self->_tls_error ($tmp)
…		…
1520		1653
1521	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	1654	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	1655	object is created, you can also do that at a later time by calling
1523	C<starttls>.	1656	C<starttls>.
1524		1657
		1658	Starting TLS is currently an asynchronous operation - when you push some
		1659	write data and then call C<< ->starttls >> then TLS negotiation will start
		1660	immediately, after which the queued write data is then sent.
		1661
1525	The first argument is the same as the C<tls> constructor argument (either	1662	The first argument is the same as the C<tls> constructor argument (either
1526	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1663	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1527		1664
1528	The second argument is the optional C<AnyEvent::TLS> object that is used	1665	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	1666	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	1670	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	1671	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	1672	changed to your liking. Note that the handshake might have already started
1536	when this function returns.	1673	when this function returns.
1537		1674
1538	If it an error to start a TLS handshake more than once per	1675	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).	1676	handshakes on the same stream. Best do not attempt to use the stream after
		1677	stopping TLS.
1540		1678
1541	=cut	1679	=cut
1542		1680
1543	our %TLS_CACHE; #TODO not yet documented, should we?	1681	our %TLS_CACHE; #TODO not yet documented, should we?
1544		1682
1545	sub starttls {	1683	sub starttls {
1546	my ($self, $ssl, $ctx) = @_;	1684	my ($self, $tls, $ctx) = @_;
		1685
		1686	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"
		1687	if $self->{tls};
		1688
		1689	$self->{tls} = $tls;
		1690	$self->{tls_ctx} = $ctx if @_ > 2;
		1691
		1692	return unless $self->{fh};
1547		1693
1548	require Net::SSLeay;	1694	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		1695
1553	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();	1696	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1554	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();	1697	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1555		1698
		1699	$tls = $self->{tls};
1556	$ctx \|\|= $self->{tls_ctx};	1700	$ctx = $self->{tls_ctx};
		1701
		1702	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
1557		1703
1558	if ("HASH" eq ref $ctx) {	1704	if ("HASH" eq ref $ctx) {
1559	require AnyEvent::TLS;	1705	require AnyEvent::TLS;
1560
1561	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context
1562		1706
1563	if ($ctx->{cache}) {	1707	if ($ctx->{cache}) {
1564	my $key = $ctx+0;	1708	my $key = $ctx+0;
1565	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;	1709	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;
1566	} else {	1710	} else {
1567	$ctx = new AnyEvent::TLS %$ctx;	1711	$ctx = new AnyEvent::TLS %$ctx;
1568	}	1712	}
1569	}	1713	}
1570		1714
1571	$self->{tls_ctx} = $ctx \|\| TLS_CTX ();	1715	$self->{tls_ctx} = $ctx \|\| TLS_CTX ();
1572	$self->{tls} = $ssl = $self->{tls_ctx}->_get_session ($ssl, $self, $self->{peername});	1716	$self->{tls} = $tls = $self->{tls_ctx}->_get_session ($tls, $self, $self->{peername});
1573		1717
1574	# basically, this is deep magic (because SSL_read should have the same issues)	1718	# 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".	1719	# but the openssl maintainers basically said: "trust us, it just works".
1576	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1720	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1577	# and mismaintained ssleay-module doesn't even offer them).	1721	# 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	1728	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
1585	# have identity issues in that area.	1729	# have identity issues in that area.
1586	# Net::SSLeay::CTX_set_mode ($ssl,	1730	# Net::SSLeay::CTX_set_mode ($ssl,
1587	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1731	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
1588	# \| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));	1732	# \| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
1589	Net::SSLeay::CTX_set_mode ($ssl, 1\|2);	1733	Net::SSLeay::CTX_set_mode ($tls, 1\|2);
1590		1734
1591	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1735	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1592	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1736	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1593		1737
		1738	Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf});
		1739
1594	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1740	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
1595		1741
1596	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }	1742	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1597	if $self->{on_starttls};	1743	if $self->{on_starttls};
1598		1744
1599	&_dotls; # need to trigger the initial handshake	1745	&_dotls; # need to trigger the initial handshake
…		…
1602		1748
1603	=item $handle->stoptls	1749	=item $handle->stoptls
1604		1750
1605	Shuts down the SSL connection - this makes a proper EOF handshake by	1751	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	1752	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	1753	support non-blocking shut downs, it is not guarenteed that you can re-use
1608	afterwards.	1754	the stream afterwards.
1609		1755
1610	=cut	1756	=cut
1611		1757
1612	sub stoptls {	1758	sub stoptls {
1613	my ($self) = @_;	1759	my ($self) = @_;
…		…
1626	sub _freetls {	1772	sub _freetls {
1627	my ($self) = @_;	1773	my ($self) = @_;
1628		1774
1629	return unless $self->{tls};	1775	return unless $self->{tls};
1630		1776
1631	$self->{tls_ctx}->_put_session (delete $self->{tls});	1777	$self->{tls_ctx}->_put_session (delete $self->{tls})
		1778	if $self->{tls} > 0;
1632		1779
1633	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};	1780	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1634	}	1781	}
1635		1782
1636	sub DESTROY {	1783	sub DESTROY {
…		…
1638		1785
1639	&_freetls;	1786	&_freetls;
1640		1787
1641	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	1788	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1642		1789
1643	if ($linger && length $self->{wbuf}) {	1790	if ($linger && length $self->{wbuf} && $self->{fh}) {
1644	my $fh = delete $self->{fh};	1791	my $fh = delete $self->{fh};
1645	my $wbuf = delete $self->{wbuf};	1792	my $wbuf = delete $self->{wbuf};
1646		1793
1647	my @linger;	1794	my @linger;
1648		1795
1649	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {	1796	push @linger, AE::io $fh, 1, sub {
1650	my $len = syswrite $fh, $wbuf, length $wbuf;	1797	my $len = syswrite $fh, $wbuf, length $wbuf;
1651		1798
1652	if ($len > 0) {	1799	if ($len > 0) {
1653	substr $wbuf, 0, $len, "";	1800	substr $wbuf, 0, $len, "";
1654	} else {	1801	} else {
1655	@linger = (); # end	1802	@linger = (); # end
1656	}	1803	}
1657	});	1804	};
1658	push @linger, AnyEvent->timer (after => $linger, cb => sub {	1805	push @linger, AE::timer $linger, 0, sub {
1659	@linger = ();	1806	@linger = ();
1660	});	1807	};
1661	}	1808	}
1662	}	1809	}
1663		1810
1664	=item $handle->destroy	1811	=item $handle->destroy
1665		1812
1666	Shuts down the handle object as much as possible - this call ensures that	1813	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	1814	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.	1815	will be freed. Any method you will call on the handle object after
		1816	destroying it in this way will be silently ignored (and it will return the
		1817	empty list).
1669		1818
1670	Normally, you can just "forget" any references to an AnyEvent::Handle	1819	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	1820	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	1821	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	1822	callback, so when you want to destroy the AnyEvent::Handle object from
…		…
1687	sub destroy {	1836	sub destroy {
1688	my ($self) = @_;	1837	my ($self) = @_;
1689		1838
1690	$self->DESTROY;	1839	$self->DESTROY;
1691	%$self = ();	1840	%$self = ();
		1841	bless $self, "AnyEvent::Handle::destroyed";
		1842	}
		1843
		1844	sub AnyEvent::Handle::destroyed::AUTOLOAD {
		1845	#nop
1692	}	1846	}
1693		1847
1694	=item AnyEvent::Handle::TLS_CTX	1848	=item AnyEvent::Handle::TLS_CTX
1695		1849
1696	This function creates and returns the AnyEvent::TLS object used by default	1850	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.175 by root, Sat Aug 8 22:20:43 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.175 by root, Sat Aug 8 22:20:43 2009 UTC