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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.149 by root, Thu Jul 16 03:48:33 2009 UTC vs.
Revision 1.160 by root, Fri Jul 24 22:47:04 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.86;
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		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	=item on_connect => $cb->($handle, $host, $port, $retry->())
		107
		108	This callback is called when a connection has been successfully established.
		109
		110	The actual numeric host and port (the socket peername) are passed as
		111	parameters, together with a retry callback.
		112
		113	When, for some reason, the handle is not acceptable, then calling
		114	C<$retry> will continue with the next conenction target (in case of
		115	multi-homed hosts or SRV records there can be multiple connection
		116	endpoints). When it is called then the read and write queues, eof status,
		117	tls status and similar properties of the handle are being reset.
		118
		119	In most cases, ignoring the C<$retry> parameter is the way to go.
		120
		121	=item on_connect_error => $cb->($handle, $message)
		122
		123	This callback is called when the conenction could not be
		124	established. C<$!> will contain the relevant error code, and C<$message> a
		125	message describing it (usually the same as C<"$!">).
		126
		127	If this callback isn't specified, then C<on_error> will be called with a
		128	fatal error instead.
		129
		130	=back
		131
		132	=item on_error => $cb->($handle, $fatal, $message)
		133
		134	This is the error callback, which is called when, well, some error
		135	occured, such as not being able to resolve the hostname, failure to
		136	connect or a read error.
		137
		138	Some errors are fatal (which is indicated by C<$fatal> being true). On
		139	fatal errors the handle object will be destroyed (by a call to C<< ->
		140	destroy >>) after invoking the error callback (which means you are free to
		141	examine the handle object). Examples of fatal errors are an EOF condition
		142	with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors. In
		143	cases where the other side can close the connection at their will it is
		144	often easiest to not report C<EPIPE> errors in this callback.
		145
		146	AnyEvent::Handle tries to find an appropriate error code for you to check
		147	against, but in some cases (TLS errors), this does not work well. It is
		148	recommended to always output the C<$message> argument in human-readable
		149	error messages (it's usually the same as C<"$!">).
		150
		151	Non-fatal errors can be retried by simply returning, but it is recommended
		152	to simply ignore this parameter and instead abondon the handle object
		153	when this callback is invoked. Examples of non-fatal errors are timeouts
		154	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
		155
		156	On callback entrance, the value of C<$!> contains the operating system
		157	error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
		158	C<EPROTO>).
		159
		160	While not mandatory, it is I<highly> recommended to set this callback, as
		161	you will not be notified of errors otherwise. The default simply calls
		162	C<croak>.
		163
		164	=item on_read => $cb->($handle)
		165
		166	This sets the default read callback, which is called when data arrives
		167	and no read request is in the queue (unlike read queue callbacks, this
		168	callback will only be called when at least one octet of data is in the
		169	read buffer).
		170
		171	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
		172	method or access the C<< $handle->{rbuf} >> member directly. Note that you
		173	must not enlarge or modify the read buffer, you can only remove data at
		174	the beginning from it.
		175
		176	When an EOF condition is detected then AnyEvent::Handle will first try to
		177	feed all the remaining data to the queued callbacks and C<on_read> before
		178	calling the C<on_eof> callback. If no progress can be made, then a fatal
		179	error will be raised (with C<$!> set to C<EPIPE>).
		180
		181	Note that, unlike requests in the read queue, an C<on_read> callback
		182	doesn't mean you I<require> some data: if there is an EOF and there
		183	are outstanding read requests then an error will be flagged. With an
		184	C<on_read> callback, the C<on_eof> callback will be invoked.
		185
81	=item on_eof => $cb->($handle)	186	=item on_eof => $cb->($handle)
82		187
83	Set the callback to be called when an end-of-file condition is detected,	188	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	189	i.e. in the case of a socket, when the other side has closed the
85	connection cleanly.	190	connection cleanly, and there are no outstanding read requests in the
		191	queue (if there are read requests, then an EOF counts as an unexpected
		192	connection close and will be flagged as an error).
86		193
87	For sockets, this just means that the other side has stopped sending data,	194	For sockets, this just means that the other side has stopped sending data,
88	you can still try to write data, and, in fact, one can return from the EOF	195	you can still try to write data, and, in fact, one can return from the EOF
89	callback and continue writing data, as only the read part has been shut	196	callback and continue writing data, as only the read part has been shut
90	down.	197	down.
91		198
92	While not mandatory, it is I<highly> recommended to set an EOF callback,
93	otherwise you might end up with a closed socket while you are still
94	waiting for data.
95
96	If an EOF condition has been detected but no C<on_eof> callback has been	199	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>.	200	set, then a fatal error will be raised with C<$!> set to <0>.
98
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		201
146	=item on_drain => $cb->($handle)	202	=item on_drain => $cb->($handle)
147		203
148	This sets the callback that is called when the write buffer becomes empty	204	This sets the callback that is called when the write buffer becomes empty
149	(or when the callback is set and the buffer is empty already).	205	(or when the callback is set and the buffer is empty already).
…		…
348		404
349	sub new {	405	sub new {
350	my $class = shift;	406	my $class = shift;
351	my $self = bless { @_ }, $class;	407	my $self = bless { @_ }, $class;
352		408
353	$self->{fh} or Carp::croak "mandatory argument fh is missing";	409	if ($self->{fh}) {
		410	$self->_start;
		411	return unless $self->{fh}; # could be gone by now
		412
		413	} elsif ($self->{connect}) {
		414	require AnyEvent::Socket;
		415
		416	$self->{peername} = $self->{connect}[0]
		417	unless exists $self->{peername};
		418
		419	$self->{_skip_drain_rbuf} = 1;
		420
		421	{
		422	Scalar::Util::weaken (my $self = $self);
		423
		424	$self->{_connect} =
		425	AnyEvent::Socket::tcp_connect (
		426	$self->{connect}[0],
		427	$self->{connect}[1],
		428	sub {
		429	my ($fh, $host, $port, $retry) = @_;
		430
		431	if ($fh) {
		432	$self->{fh} = $fh;
		433
		434	delete $self->{_skip_drain_rbuf};
		435	$self->_start;
		436
		437	$self->{on_connect}
		438	and $self->{on_connect}($self, $host, $port, sub {
		439	delete @$self{qw(fh _tw _ww _rw _eof _queue rbuf _wbuf tls _tls_rbuf _tls_wbuf)};
		440	$self->{_skip_drain_rbuf} = 1;
		441	&$retry;
		442	});
		443
		444	} else {
		445	if ($self->{on_connect_error}) {
		446	$self->{on_connect_error}($self, "$!");
		447	$self->destroy;
		448	} else {
		449	$self->fatal ($!, 1);
		450	}
		451	}
		452	},
		453	sub {
		454	local $self->{fh} = $_[0];
		455
		456	$self->{on_prepare}->($self)
		457	if $self->{on_prepare};
		458	}
		459	);
		460	}
		461
		462	} else {
		463	Carp::croak "AnyEvent::Handle: either an existing fh or the connect parameter must be specified";
		464	}
		465
		466	$self
		467	}
		468
		469	sub _start {
		470	my ($self) = @_;
354		471
355	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	472	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
356		473
357	$self->{_activity} = AnyEvent->now;	474	$self->{_activity} = AnyEvent->now;
358	$self->_timeout;	475	$self->_timeout;
…		…
363	if $self->{tls};	480	if $self->{tls};
364		481
365	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	482	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
366		483
367	$self->start_read	484	$self->start_read
368	if $self->{on_read};	485	if $self->{on_read} \|\| @{ $self->{_queue} };
369		486
370	$self->{fh} && $self	487	$self->_drain_wbuf;
371	}	488	}
372		489
373	#sub _shutdown {	490	#sub _shutdown {
374	# my ($self) = @_;	491	# my ($self) = @_;
375	#	492	#
…		…
385	$! = $errno;	502	$! = $errno;
386	$message \|\|= "$!";	503	$message \|\|= "$!";
387		504
388	if ($self->{on_error}) {	505	if ($self->{on_error}) {
389	$self->{on_error}($self, $fatal, $message);	506	$self->{on_error}($self, $fatal, $message);
390	$self->destroy;	507	$self->destroy if $fatal;
391	} elsif ($self->{fh}) {	508	} elsif ($self->{fh}) {
392	$self->destroy;	509	$self->destroy;
393	Carp::croak "AnyEvent::Handle uncaught error: $message";	510	Carp::croak "AnyEvent::Handle uncaught error: $message";
394	}	511	}
395	}	512	}
…		…
455	sub no_delay {	572	sub no_delay {
456	$_[0]{no_delay} = $_[1];	573	$_[0]{no_delay} = $_[1];
457		574
458	eval {	575	eval {
459	local $SIG{__DIE__};	576	local $SIG{__DIE__};
460	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];	577	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1]
		578	if $_[0]{fh};
461	};	579	};
462	}	580	}
463		581
464	=item $handle->on_starttls ($cb)	582	=item $handle->on_starttls ($cb)
465		583
…		…
499	# reset the timeout watcher, as neccessary	617	# reset the timeout watcher, as neccessary
500	# also check for time-outs	618	# also check for time-outs
501	sub _timeout {	619	sub _timeout {
502	my ($self) = @_;	620	my ($self) = @_;
503		621
504	if ($self->{timeout}) {	622	if ($self->{timeout} && $self->{fh}) {
505	my $NOW = AnyEvent->now;	623	my $NOW = AnyEvent->now;
506		624
507	# when would the timeout trigger?	625	# when would the timeout trigger?
508	my $after = $self->{_activity} + $self->{timeout} - $NOW;	626	my $after = $self->{_activity} + $self->{timeout} - $NOW;
509		627
…		…
512	$self->{_activity} = $NOW;	630	$self->{_activity} = $NOW;
513		631
514	if ($self->{on_timeout}) {	632	if ($self->{on_timeout}) {
515	$self->{on_timeout}($self);	633	$self->{on_timeout}($self);
516	} else {	634	} else {
517	$self->_error (&Errno::ETIMEDOUT);	635	$self->_error (Errno::ETIMEDOUT);
518	}	636	}
519		637
520	# callback could have changed timeout value, optimise	638	# callback could have changed timeout value, optimise
521	return unless $self->{timeout};	639	return unless $self->{timeout};
522		640
…		…
627	->($self, @_);	745	->($self, @_);
628	}	746	}
629		747
630	if ($self->{tls}) {	748	if ($self->{tls}) {
631	$self->{_tls_wbuf} .= $_[0];	749	$self->{_tls_wbuf} .= $_[0];
632		750	&_dotls ($self) if $self->{fh};
633	&_dotls ($self);
634	} else {	751	} else {
635	$self->{wbuf} .= $_[0];	752	$self->{wbuf} .= $_[0];
636	$self->_drain_wbuf;	753	$self->_drain_wbuf if $self->{fh};
637	}	754	}
638	}	755	}
639		756
640	=item $handle->push_write (type => @args)	757	=item $handle->push_write (type => @args)
641		758
…		…
858	=cut	975	=cut
859		976
860	sub _drain_rbuf {	977	sub _drain_rbuf {
861	my ($self) = @_;	978	my ($self) = @_;
862		979
		980	# avoid recursion
		981	return if exists $self->{_skip_drain_rbuf};
863	local $self->{_in_drain} = 1;	982	local $self->{_skip_drain_rbuf} = 1;
864		983
865	if (	984	if (
866	defined $self->{rbuf_max}	985	defined $self->{rbuf_max}
867	&& $self->{rbuf_max} < length $self->{rbuf}	986	&& $self->{rbuf_max} < length $self->{rbuf}
868	) {	987	) {
869	$self->_error (&Errno::ENOSPC, 1), return;	988	$self->_error (Errno::ENOSPC, 1), return;
870	}	989	}
871		990
872	while () {	991	while () {
873	# we need to use a separate tls read buffer, as we must not receive data while	992	# we need to use a separate tls read buffer, as we must not receive data while
874	# we are draining the buffer, and this can only happen with TLS.	993	# we are draining the buffer, and this can only happen with TLS.
…		…
878		997
879	if (my $cb = shift @{ $self->{_queue} }) {	998	if (my $cb = shift @{ $self->{_queue} }) {
880	unless ($cb->($self)) {	999	unless ($cb->($self)) {
881	if ($self->{_eof}) {	1000	if ($self->{_eof}) {
882	# no progress can be made (not enough data and no data forthcoming)	1001	# no progress can be made (not enough data and no data forthcoming)
883	$self->_error (&Errno::EPIPE, 1), return;	1002	$self->_error (Errno::EPIPE, 1), return;
884	}	1003	}
885		1004
886	unshift @{ $self->{_queue} }, $cb;	1005	unshift @{ $self->{_queue} }, $cb;
887	last;	1006	last;
888	}	1007	}
…		…
896	&& !@{ $self->{_queue} } # and the queue is still empty	1015	&& !@{ $self->{_queue} } # and the queue is still empty
897	&& $self->{on_read} # but we still have on_read	1016	&& $self->{on_read} # but we still have on_read
898	) {	1017	) {
899	# no further data will arrive	1018	# no further data will arrive
900	# so no progress can be made	1019	# so no progress can be made
901	$self->_error (&Errno::EPIPE, 1), return	1020	$self->_error (Errno::EPIPE, 1), return
902	if $self->{_eof};	1021	if $self->{_eof};
903		1022
904	last; # more data might arrive	1023	last; # more data might arrive
905	}	1024	}
906	} else {	1025	} else {
…		…
935		1054
936	sub on_read {	1055	sub on_read {
937	my ($self, $cb) = @_;	1056	my ($self, $cb) = @_;
938		1057
939	$self->{on_read} = $cb;	1058	$self->{on_read} = $cb;
940	$self->_drain_rbuf if $cb && !$self->{_in_drain};	1059	$self->_drain_rbuf if $cb;
941	}	1060	}
942		1061
943	=item $handle->rbuf	1062	=item $handle->rbuf
944		1063
945	Returns the read buffer (as a modifiable lvalue).	1064	Returns the read buffer (as a modifiable lvalue).
…		…
997	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	1116	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
998	->($self, $cb, @_);	1117	->($self, $cb, @_);
999	}	1118	}
1000		1119
1001	push @{ $self->{_queue} }, $cb;	1120	push @{ $self->{_queue} }, $cb;
1002	$self->_drain_rbuf unless $self->{_in_drain};	1121	$self->_drain_rbuf;
1003	}	1122	}
1004		1123
1005	sub unshift_read {	1124	sub unshift_read {
1006	my $self = shift;	1125	my $self = shift;
1007	my $cb = pop;	1126	my $cb = pop;
…		…
1013	->($self, $cb, @_);	1132	->($self, $cb, @_);
1014	}	1133	}
1015		1134
1016		1135
1017	unshift @{ $self->{_queue} }, $cb;	1136	unshift @{ $self->{_queue} }, $cb;
1018	$self->_drain_rbuf unless $self->{_in_drain};	1137	$self->_drain_rbuf;
1019	}	1138	}
1020		1139
1021	=item $handle->push_read (type => @args, $cb)	1140	=item $handle->push_read (type => @args, $cb)
1022		1141
1023	=item $handle->unshift_read (type => @args, $cb)	1142	=item $handle->unshift_read (type => @args, $cb)
…		…
1156	return 1;	1275	return 1;
1157	}	1276	}
1158		1277
1159	# reject	1278	# reject
1160	if ($reject && $$rbuf =~ $reject) {	1279	if ($reject && $$rbuf =~ $reject) {
1161	$self->_error (&Errno::EBADMSG);	1280	$self->_error (Errno::EBADMSG);
1162	}	1281	}
1163		1282
1164	# skip	1283	# skip
1165	if ($skip && $$rbuf =~ $skip) {	1284	if ($skip && $$rbuf =~ $skip) {
1166	$data .= substr $$rbuf, 0, $+[0], "";	1285	$data .= substr $$rbuf, 0, $+[0], "";
…		…
1182	my ($self, $cb) = @_;	1301	my ($self, $cb) = @_;
1183		1302
1184	sub {	1303	sub {
1185	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {	1304	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
1186	if ($_[0]{rbuf} =~ /[^0-9]/) {	1305	if ($_[0]{rbuf} =~ /[^0-9]/) {
1187	$self->_error (&Errno::EBADMSG);	1306	$self->_error (Errno::EBADMSG);
1188	}	1307	}
1189	return;	1308	return;
1190	}	1309	}
1191		1310
1192	my $len = $1;	1311	my $len = $1;
…		…
1195	my $string = $_[1];	1314	my $string = $_[1];
1196	$_[0]->unshift_read (chunk => 1, sub {	1315	$_[0]->unshift_read (chunk => 1, sub {
1197	if ($_[1] eq ",") {	1316	if ($_[1] eq ",") {
1198	$cb->($_[0], $string);	1317	$cb->($_[0], $string);
1199	} else {	1318	} else {
1200	$self->_error (&Errno::EBADMSG);	1319	$self->_error (Errno::EBADMSG);
1201	}	1320	}
1202	});	1321	});
1203	});	1322	});
1204		1323
1205	1	1324	1
…		…
1295	$json->incr_skip;	1414	$json->incr_skip;
1296		1415
1297	$self->{rbuf} = $json->incr_text;	1416	$self->{rbuf} = $json->incr_text;
1298	$json->incr_text = "";	1417	$json->incr_text = "";
1299		1418
1300	$self->_error (&Errno::EBADMSG);	1419	$self->_error (Errno::EBADMSG);
1301		1420
1302	()	1421	()
1303	} else {	1422	} else {
1304	$self->{rbuf} = "";	1423	$self->{rbuf} = "";
1305		1424
…		…
1342	# read remaining chunk	1461	# read remaining chunk
1343	$_[0]->unshift_read (chunk => $len, sub {	1462	$_[0]->unshift_read (chunk => $len, sub {
1344	if (my $ref = eval { Storable::thaw ($_[1]) }) {	1463	if (my $ref = eval { Storable::thaw ($_[1]) }) {
1345	$cb->($_[0], $ref);	1464	$cb->($_[0], $ref);
1346	} else {	1465	} else {
1347	$self->_error (&Errno::EBADMSG);	1466	$self->_error (Errno::EBADMSG);
1348	}	1467	}
1349	});	1468	});
1350	}	1469	}
1351		1470
1352	1	1471	1
…		…
1416	if ($self->{tls}) {	1535	if ($self->{tls}) {
1417	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);	1536	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1418		1537
1419	&_dotls ($self);	1538	&_dotls ($self);
1420	} else {	1539	} else {
1421	$self->_drain_rbuf unless $self->{_in_drain};	1540	$self->_drain_rbuf;
1422	}	1541	}
1423		1542
1424	} elsif (defined $len) {	1543	} elsif (defined $len) {
1425	delete $self->{_rw};	1544	delete $self->{_rw};
1426	$self->{_eof} = 1;	1545	$self->{_eof} = 1;
1427	$self->_drain_rbuf unless $self->{_in_drain};	1546	$self->_drain_rbuf;
1428		1547
1429	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1548	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1430	return $self->_error ($!, 1);	1549	return $self->_error ($!, 1);
1431	}	1550	}
1432	});	1551	});
…		…
1450	if ($self->{_on_starttls}) {	1569	if ($self->{_on_starttls}) {
1451	(delete $self->{_on_starttls})->($self, undef, $err);	1570	(delete $self->{_on_starttls})->($self, undef, $err);
1452	&_freetls;	1571	&_freetls;
1453	} else {	1572	} else {
1454	&_freetls;	1573	&_freetls;
1455	$self->_error (&Errno::EPROTO, 1, $err);	1574	$self->_error (Errno::EPROTO, 1, $err);
1456	}	1575	}
1457	}	1576	}
1458		1577
1459	# poll the write BIO and send the data if applicable	1578	# poll the write BIO and send the data if applicable
1460	# also decode read data if possible	1579	# also decode read data if possible
…		…
1492	$self->{_eof} = 1;	1611	$self->{_eof} = 1;
1493	}	1612	}
1494	}	1613	}
1495		1614
1496	$self->{_tls_rbuf} .= $tmp;	1615	$self->{_tls_rbuf} .= $tmp;
1497	$self->_drain_rbuf unless $self->{_in_drain};	1616	$self->_drain_rbuf;
1498	$self->{tls} or return; # tls session might have gone away in callback	1617	$self->{tls} or return; # tls session might have gone away in callback
1499	}	1618	}
1500		1619
1501	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);	1620	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1502	return $self->_tls_error ($tmp)	1621	return $self->_tls_error ($tmp)
…		…
1517		1636
1518	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	1637	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
1519	object is created, you can also do that at a later time by calling	1638	object is created, you can also do that at a later time by calling
1520	C<starttls>.	1639	C<starttls>.
1521		1640
		1641	Starting TLS is currently an asynchronous operation - when you push some
		1642	write data and then call C<< ->starttls >> then TLS negotiation will start
		1643	immediately, after which the queued write data is then sent.
		1644
1522	The first argument is the same as the C<tls> constructor argument (either	1645	The first argument is the same as the C<tls> constructor argument (either
1523	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1646	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1524		1647
1525	The second argument is the optional C<AnyEvent::TLS> object that is used	1648	The second argument is the optional C<AnyEvent::TLS> object that is used
1526	when AnyEvent::Handle has to create its own TLS connection object, or	1649	when AnyEvent::Handle has to create its own TLS connection object, or
…		…
1530	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS	1653	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS
1531	context in C<< $handle->{tls_ctx} >> after this call and can be used or	1654	context in C<< $handle->{tls_ctx} >> after this call and can be used or
1532	changed to your liking. Note that the handshake might have already started	1655	changed to your liking. Note that the handshake might have already started
1533	when this function returns.	1656	when this function returns.
1534		1657
1535	If it an error to start a TLS handshake more than once per	1658	Due to bugs in OpenSSL, it might or might not be possible to do multiple
1536	AnyEvent::Handle object (this is due to bugs in OpenSSL).	1659	handshakes on the same stream. Best do not attempt to use the stream after
		1660	stopping TLS.
1537		1661
1538	=cut	1662	=cut
1539		1663
1540	our %TLS_CACHE; #TODO not yet documented, should we?	1664	our %TLS_CACHE; #TODO not yet documented, should we?
1541		1665
1542	sub starttls {	1666	sub starttls {
1543	my ($self, $ssl, $ctx) = @_;	1667	my ($self, $tls, $ctx) = @_;
		1668
		1669	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"
		1670	if $self->{tls};
		1671
		1672	$self->{tls} = $tls;
		1673	$self->{tls_ctx} = $ctx if @_ > 2;
		1674
		1675	return unless $self->{fh};
1544		1676
1545	require Net::SSLeay;	1677	require Net::SSLeay;
1546
1547	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"
1548	if $self->{tls};
1549		1678
1550	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();	1679	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1551	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();	1680	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1552		1681
		1682	$tls = $self->{tls};
1553	$ctx \|\|= $self->{tls_ctx};	1683	$ctx = $self->{tls_ctx};
		1684
		1685	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
1554		1686
1555	if ("HASH" eq ref $ctx) {	1687	if ("HASH" eq ref $ctx) {
1556	require AnyEvent::TLS;	1688	require AnyEvent::TLS;
1557
1558	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context
1559		1689
1560	if ($ctx->{cache}) {	1690	if ($ctx->{cache}) {
1561	my $key = $ctx+0;	1691	my $key = $ctx+0;
1562	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;	1692	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;
1563	} else {	1693	} else {
1564	$ctx = new AnyEvent::TLS %$ctx;	1694	$ctx = new AnyEvent::TLS %$ctx;
1565	}	1695	}
1566	}	1696	}
1567		1697
1568	$self->{tls_ctx} = $ctx \|\| TLS_CTX ();	1698	$self->{tls_ctx} = $ctx \|\| TLS_CTX ();
1569	$self->{tls} = $ssl = $self->{tls_ctx}->_get_session ($ssl, $self, $self->{peername});	1699	$self->{tls} = $tls = $self->{tls_ctx}->_get_session ($tls, $self, $self->{peername});
1570		1700
1571	# basically, this is deep magic (because SSL_read should have the same issues)	1701	# basically, this is deep magic (because SSL_read should have the same issues)
1572	# but the openssl maintainers basically said: "trust us, it just works".	1702	# but the openssl maintainers basically said: "trust us, it just works".
1573	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1703	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1574	# and mismaintained ssleay-module doesn't even offer them).	1704	# and mismaintained ssleay-module doesn't even offer them).
…		…
1581	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to	1711	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
1582	# have identity issues in that area.	1712	# have identity issues in that area.
1583	# Net::SSLeay::CTX_set_mode ($ssl,	1713	# Net::SSLeay::CTX_set_mode ($ssl,
1584	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1714	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
1585	# \| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));	1715	# \| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
1586	Net::SSLeay::CTX_set_mode ($ssl, 1\|2);	1716	Net::SSLeay::CTX_set_mode ($tls, 1\|2);
1587		1717
1588	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1718	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1589	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1719	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1590		1720
1591	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1721	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
1592		1722
1593	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }	1723	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1594	if $self->{on_starttls};	1724	if $self->{on_starttls};
1595		1725
1596	&_dotls; # need to trigger the initial handshake	1726	&_dotls; # need to trigger the initial handshake
…		…
1599		1729
1600	=item $handle->stoptls	1730	=item $handle->stoptls
1601		1731
1602	Shuts down the SSL connection - this makes a proper EOF handshake by	1732	Shuts down the SSL connection - this makes a proper EOF handshake by
1603	sending a close notify to the other side, but since OpenSSL doesn't	1733	sending a close notify to the other side, but since OpenSSL doesn't
1604	support non-blocking shut downs, it is not possible to re-use the stream	1734	support non-blocking shut downs, it is not guarenteed that you can re-use
1605	afterwards.	1735	the stream afterwards.
1606		1736
1607	=cut	1737	=cut
1608		1738
1609	sub stoptls {	1739	sub stoptls {
1610	my ($self) = @_;	1740	my ($self) = @_;
…		…
1623	sub _freetls {	1753	sub _freetls {
1624	my ($self) = @_;	1754	my ($self) = @_;
1625		1755
1626	return unless $self->{tls};	1756	return unless $self->{tls};
1627		1757
1628	$self->{tls_ctx}->_put_session (delete $self->{tls});	1758	$self->{tls_ctx}->_put_session (delete $self->{tls})
		1759	if ref $self->{tls};
1629		1760
1630	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};	1761	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1631	}	1762	}
1632		1763
1633	sub DESTROY {	1764	sub DESTROY {
…		…
1635		1766
1636	&_freetls;	1767	&_freetls;
1637		1768
1638	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	1769	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1639		1770
1640	if ($linger && length $self->{wbuf}) {	1771	if ($linger && length $self->{wbuf} && $self->{fh}) {
1641	my $fh = delete $self->{fh};	1772	my $fh = delete $self->{fh};
1642	my $wbuf = delete $self->{wbuf};	1773	my $wbuf = delete $self->{wbuf};
1643		1774
1644	my @linger;	1775	my @linger;
1645		1776

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.149 by root, Thu Jul 16 03:48:33 2009 UTC vs. Revision 1.160 by root, Fri Jul 24 22:47:04 2009 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.149 by root, Thu Jul 16 03:48:33 2009 UTC vs.
Revision 1.160 by root, Fri Jul 24 22:47:04 2009 UTC