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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.144 by root, Mon Jul 6 21:38:25 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.452;	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;
25		22
26	my $cv = AnyEvent->condvar;	23	my $cv = AnyEvent->condvar;
27		24
28	my $handle =	25	my $hdl; $hdl = new AnyEvent::Handle
29	AnyEvent::Handle->new (
30	fh => \*STDIN,	26	fh => \*STDIN,
31	on_eof => sub {	27	on_error => sub {
		28	my ($hdl, $fatal, $msg) = @_;
		29	warn "got error $msg\n";
		30	$hdl->destroy;
32	$cv->send;	31	$cv->send;
33	},
34	);	32	);
35		33
36	# send some request line	34	# send some request line
37	$handle->push_write ("getinfo\015\012");	35	$hdl->push_write ("getinfo\015\012");
38		36
39	# read the response line	37	# read the response line
40	$handle->push_read (line => sub {	38	$hdl->push_read (line => sub {
41	my ($handle, $line) = @_;	39	my ($hdl, $line) = @_;
42	warn "read line <$line>\n";	40	warn "got line <$line>\n";
43	$cv->send;	41	$cv->send;
44	});	42	});
45		43
46	$cv->recv;	44	$cv->recv;
47		45
48	=head1 DESCRIPTION	46	=head1 DESCRIPTION
49		47
50	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
51	filehandles. For utility functions for doing non-blocking connects and accepts	49	filehandles.
52	on sockets see L<AnyEvent::Util>.
53		50
54	The L<AnyEvent::Intro> tutorial contains some well-documented	51	The L<AnyEvent::Intro> tutorial contains some well-documented
55	AnyEvent::Handle examples.	52	AnyEvent::Handle examples.
56		53
57	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
58	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
59	treatment of characters applies to this module as well.	56	treatment of characters applies to this module as well.
60		57
		58	At the very minimum, you should specify C<fh> or C<connect>, and the
		59	C<on_error> callback.
		60
61	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
62	argument.	62	argument.
63		63
64	=head1 METHODS	64	=head1 METHODS
65		65
69		69
70	The constructor supports these arguments (all as C<< key => value >> pairs).	70	The constructor supports these arguments (all as C<< key => value >> pairs).
71		71
72	=over 4	72	=over 4
73		73
74	=item fh => $filehandle [MANDATORY]	74	=item fh => $filehandle [C<fh> or C<connect> MANDATORY]
75		75
76	The filehandle this L<AnyEvent::Handle> object will operate on.	76	The filehandle this L<AnyEvent::Handle> object will operate on.
77
78	NOTE: The filehandle will be set to non-blocking mode (using	77	NOTE: The filehandle will be set to non-blocking mode (using
79	C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in	78	C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in
80	that mode.	79	that mode.
81		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
82	=item on_eof => $cb->($handle)	186	=item on_eof => $cb->($handle)
83		187
84	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,
85	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
86	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).
87		193
88	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,
89	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
90	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
91	down.	197	down.
92		198
93	While not mandatory, it is I<highly> recommended to set an EOF callback,
94	otherwise you might end up with a closed socket while you are still
95	waiting for data.
96
97	If an EOF condition has been detected but no C<on_eof> callback has been	199	If an EOF condition has been detected but no C<on_eof> callback has been
98	set, then a fatal error will be raised with C<$!> set to <0>.	200	set, then a fatal error will be raised with C<$!> set to <0>.
99
100	=item on_error => $cb->($handle, $fatal, $message)
101
102	This is the error callback, which is called when, well, some error
103	occured, such as not being able to resolve the hostname, failure to
104	connect or a read error.
105
106	Some errors are fatal (which is indicated by C<$fatal> being true). On
107	fatal errors the handle object will be shut down and will not be usable
108	(but you are free to look at the current C<< ->rbuf >>). Examples of fatal
109	errors are an EOF condition with active (but unsatisifable) read watchers
110	(C<EPIPE>) or I/O errors.
111
112	AnyEvent::Handle tries to find an appropriate error code for you to check
113	against, but in some cases (TLS errors), this does not work well. It is
114	recommended to always output the C<$message> argument in human-readable
115	error messages (it's usually the same as C<"$!">).
116
117	Non-fatal errors can be retried by simply returning, but it is recommended
118	to simply ignore this parameter and instead abondon the handle object
119	when this callback is invoked. Examples of non-fatal errors are timeouts
120	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
121
122	On callback entrance, the value of C<$!> contains the operating system
123	error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
124	C<EPROTO>).
125
126	While not mandatory, it is I<highly> recommended to set this callback, as
127	you will not be notified of errors otherwise. The default simply calls
128	C<croak>.
129
130	=item on_read => $cb->($handle)
131
132	This sets the default read callback, which is called when data arrives
133	and no read request is in the queue (unlike read queue callbacks, this
134	callback will only be called when at least one octet of data is in the
135	read buffer).
136
137	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
138	method or access the C<< $handle->{rbuf} >> member directly. Note that you
139	must not enlarge or modify the read buffer, you can only remove data at
140	the beginning from it.
141
142	When an EOF condition is detected then AnyEvent::Handle will first try to
143	feed all the remaining data to the queued callbacks and C<on_read> before
144	calling the C<on_eof> callback. If no progress can be made, then a fatal
145	error will be raised (with C<$!> set to C<EPIPE>).
146		201
147	=item on_drain => $cb->($handle)	202	=item on_drain => $cb->($handle)
148		203
149	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
150	(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).
…		…
349		404
350	sub new {	405	sub new {
351	my $class = shift;	406	my $class = shift;
352	my $self = bless { @_ }, $class;	407	my $self = bless { @_ }, $class;
353		408
354	$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) = @_;
355		471
356	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	472	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
357		473
358	$self->{_activity} = AnyEvent->now;	474	$self->{_activity} = AnyEvent->now;
359	$self->_timeout;	475	$self->_timeout;
…		…
364	if $self->{tls};	480	if $self->{tls};
365		481
366	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	482	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
367		483
368	$self->start_read	484	$self->start_read
369	if $self->{on_read};	485	if $self->{on_read} \|\| @{ $self->{_queue} };
370		486
371	$self->{fh} && $self	487	$self->_drain_wbuf;
372	}	488	}
373		489
374	sub _shutdown {	490	#sub _shutdown {
375	my ($self) = @_;	491	# my ($self) = @_;
376		492	#
377	delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)};	493	# delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)};
378	$self->{_eof} = 1; # tell starttls et. al to stop trying	494	# $self->{_eof} = 1; # tell starttls et. al to stop trying
379		495	#
380	&_freetls;	496	# &_freetls;
381	}	497	#}
382		498
383	sub _error {	499	sub _error {
384	my ($self, $errno, $fatal, $message) = @_;	500	my ($self, $errno, $fatal, $message) = @_;
385		501
386	$self->_shutdown
387	if $fatal;
388
389	$! = $errno;	502	$! = $errno;
390	$message \|\|= "$!";	503	$message \|\|= "$!";
391		504
392	if ($self->{on_error}) {	505	if ($self->{on_error}) {
393	$self->{on_error}($self, $fatal, $message);	506	$self->{on_error}($self, $fatal, $message);
		507	$self->destroy if $fatal;
394	} elsif ($self->{fh}) {	508	} elsif ($self->{fh}) {
		509	$self->destroy;
395	Carp::croak "AnyEvent::Handle uncaught error: $message";	510	Carp::croak "AnyEvent::Handle uncaught error: $message";
396	}	511	}
397	}	512	}
398		513
399	=item $fh = $handle->fh	514	=item $fh = $handle->fh
…		…
457	sub no_delay {	572	sub no_delay {
458	$_[0]{no_delay} = $_[1];	573	$_[0]{no_delay} = $_[1];
459		574
460	eval {	575	eval {
461	local $SIG{__DIE__};	576	local $SIG{__DIE__};
462	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};
463	};	579	};
464	}	580	}
465		581
466	=item $handle->on_starttls ($cb)	582	=item $handle->on_starttls ($cb)
467		583
…		…
501	# reset the timeout watcher, as neccessary	617	# reset the timeout watcher, as neccessary
502	# also check for time-outs	618	# also check for time-outs
503	sub _timeout {	619	sub _timeout {
504	my ($self) = @_;	620	my ($self) = @_;
505		621
506	if ($self->{timeout}) {	622	if ($self->{timeout} && $self->{fh}) {
507	my $NOW = AnyEvent->now;	623	my $NOW = AnyEvent->now;
508		624
509	# when would the timeout trigger?	625	# when would the timeout trigger?
510	my $after = $self->{_activity} + $self->{timeout} - $NOW;	626	my $after = $self->{_activity} + $self->{timeout} - $NOW;
511		627
…		…
514	$self->{_activity} = $NOW;	630	$self->{_activity} = $NOW;
515		631
516	if ($self->{on_timeout}) {	632	if ($self->{on_timeout}) {
517	$self->{on_timeout}($self);	633	$self->{on_timeout}($self);
518	} else {	634	} else {
519	$self->_error (&Errno::ETIMEDOUT);	635	$self->_error (Errno::ETIMEDOUT);
520	}	636	}
521		637
522	# callback could have changed timeout value, optimise	638	# callback could have changed timeout value, optimise
523	return unless $self->{timeout};	639	return unless $self->{timeout};
524		640
…		…
587	Scalar::Util::weaken $self;	703	Scalar::Util::weaken $self;
588		704
589	my $cb = sub {	705	my $cb = sub {
590	my $len = syswrite $self->{fh}, $self->{wbuf};	706	my $len = syswrite $self->{fh}, $self->{wbuf};
591		707
592	if ($len >= 0) {	708	if (defined $len) {
593	substr $self->{wbuf}, 0, $len, "";	709	substr $self->{wbuf}, 0, $len, "";
594		710
595	$self->{_activity} = AnyEvent->now;	711	$self->{_activity} = AnyEvent->now;
596		712
597	$self->{on_drain}($self)	713	$self->{on_drain}($self)
…		…
629	->($self, @_);	745	->($self, @_);
630	}	746	}
631		747
632	if ($self->{tls}) {	748	if ($self->{tls}) {
633	$self->{_tls_wbuf} .= $_[0];	749	$self->{_tls_wbuf} .= $_[0];
634		750	&_dotls ($self) if $self->{fh};
635	&_dotls ($self);
636	} else {	751	} else {
637	$self->{wbuf} .= $_[0];	752	$self->{wbuf} .= $_[0];
638	$self->_drain_wbuf;	753	$self->_drain_wbuf if $self->{fh};
639	}	754	}
640	}	755	}
641		756
642	=item $handle->push_write (type => @args)	757	=item $handle->push_write (type => @args)
643		758
…		…
860	=cut	975	=cut
861		976
862	sub _drain_rbuf {	977	sub _drain_rbuf {
863	my ($self) = @_;	978	my ($self) = @_;
864		979
		980	# avoid recursion
		981	return if exists $self->{_skip_drain_rbuf};
865	local $self->{_in_drain} = 1;	982	local $self->{_skip_drain_rbuf} = 1;
866		983
867	if (	984	if (
868	defined $self->{rbuf_max}	985	defined $self->{rbuf_max}
869	&& $self->{rbuf_max} < length $self->{rbuf}	986	&& $self->{rbuf_max} < length $self->{rbuf}
870	) {	987	) {
871	$self->_error (&Errno::ENOSPC, 1), return;	988	$self->_error (Errno::ENOSPC, 1), return;
872	}	989	}
873		990
874	while () {	991	while () {
875	# 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
876	# 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.
…		…
880		997
881	if (my $cb = shift @{ $self->{_queue} }) {	998	if (my $cb = shift @{ $self->{_queue} }) {
882	unless ($cb->($self)) {	999	unless ($cb->($self)) {
883	if ($self->{_eof}) {	1000	if ($self->{_eof}) {
884	# 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)
885	$self->_error (&Errno::EPIPE, 1), return;	1002	$self->_error (Errno::EPIPE, 1), return;
886	}	1003	}
887		1004
888	unshift @{ $self->{_queue} }, $cb;	1005	unshift @{ $self->{_queue} }, $cb;
889	last;	1006	last;
890	}	1007	}
…		…
898	&& !@{ $self->{_queue} } # and the queue is still empty	1015	&& !@{ $self->{_queue} } # and the queue is still empty
899	&& $self->{on_read} # but we still have on_read	1016	&& $self->{on_read} # but we still have on_read
900	) {	1017	) {
901	# no further data will arrive	1018	# no further data will arrive
902	# so no progress can be made	1019	# so no progress can be made
903	$self->_error (&Errno::EPIPE, 1), return	1020	$self->_error (Errno::EPIPE, 1), return
904	if $self->{_eof};	1021	if $self->{_eof};
905		1022
906	last; # more data might arrive	1023	last; # more data might arrive
907	}	1024	}
908	} else {	1025	} else {
…		…
937		1054
938	sub on_read {	1055	sub on_read {
939	my ($self, $cb) = @_;	1056	my ($self, $cb) = @_;
940		1057
941	$self->{on_read} = $cb;	1058	$self->{on_read} = $cb;
942	$self->_drain_rbuf if $cb && !$self->{_in_drain};	1059	$self->_drain_rbuf if $cb;
943	}	1060	}
944		1061
945	=item $handle->rbuf	1062	=item $handle->rbuf
946		1063
947	Returns the read buffer (as a modifiable lvalue).	1064	Returns the read buffer (as a modifiable lvalue).
…		…
999	$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")
1000	->($self, $cb, @_);	1117	->($self, $cb, @_);
1001	}	1118	}
1002		1119
1003	push @{ $self->{_queue} }, $cb;	1120	push @{ $self->{_queue} }, $cb;
1004	$self->_drain_rbuf unless $self->{_in_drain};	1121	$self->_drain_rbuf;
1005	}	1122	}
1006		1123
1007	sub unshift_read {	1124	sub unshift_read {
1008	my $self = shift;	1125	my $self = shift;
1009	my $cb = pop;	1126	my $cb = pop;
…		…
1015	->($self, $cb, @_);	1132	->($self, $cb, @_);
1016	}	1133	}
1017		1134
1018		1135
1019	unshift @{ $self->{_queue} }, $cb;	1136	unshift @{ $self->{_queue} }, $cb;
1020	$self->_drain_rbuf unless $self->{_in_drain};	1137	$self->_drain_rbuf;
1021	}	1138	}
1022		1139
1023	=item $handle->push_read (type => @args, $cb)	1140	=item $handle->push_read (type => @args, $cb)
1024		1141
1025	=item $handle->unshift_read (type => @args, $cb)	1142	=item $handle->unshift_read (type => @args, $cb)
…		…
1158	return 1;	1275	return 1;
1159	}	1276	}
1160		1277
1161	# reject	1278	# reject
1162	if ($reject && $$rbuf =~ $reject) {	1279	if ($reject && $$rbuf =~ $reject) {
1163	$self->_error (&Errno::EBADMSG);	1280	$self->_error (Errno::EBADMSG);
1164	}	1281	}
1165		1282
1166	# skip	1283	# skip
1167	if ($skip && $$rbuf =~ $skip) {	1284	if ($skip && $$rbuf =~ $skip) {
1168	$data .= substr $$rbuf, 0, $+[0], "";	1285	$data .= substr $$rbuf, 0, $+[0], "";
…		…
1184	my ($self, $cb) = @_;	1301	my ($self, $cb) = @_;
1185		1302
1186	sub {	1303	sub {
1187	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {	1304	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
1188	if ($_[0]{rbuf} =~ /[^0-9]/) {	1305	if ($_[0]{rbuf} =~ /[^0-9]/) {
1189	$self->_error (&Errno::EBADMSG);	1306	$self->_error (Errno::EBADMSG);
1190	}	1307	}
1191	return;	1308	return;
1192	}	1309	}
1193		1310
1194	my $len = $1;	1311	my $len = $1;
…		…
1197	my $string = $_[1];	1314	my $string = $_[1];
1198	$_[0]->unshift_read (chunk => 1, sub {	1315	$_[0]->unshift_read (chunk => 1, sub {
1199	if ($_[1] eq ",") {	1316	if ($_[1] eq ",") {
1200	$cb->($_[0], $string);	1317	$cb->($_[0], $string);
1201	} else {	1318	} else {
1202	$self->_error (&Errno::EBADMSG);	1319	$self->_error (Errno::EBADMSG);
1203	}	1320	}
1204	});	1321	});
1205	});	1322	});
1206		1323
1207	1	1324	1
…		…
1297	$json->incr_skip;	1414	$json->incr_skip;
1298		1415
1299	$self->{rbuf} = $json->incr_text;	1416	$self->{rbuf} = $json->incr_text;
1300	$json->incr_text = "";	1417	$json->incr_text = "";
1301		1418
1302	$self->_error (&Errno::EBADMSG);	1419	$self->_error (Errno::EBADMSG);
1303		1420
1304	()	1421	()
1305	} else {	1422	} else {
1306	$self->{rbuf} = "";	1423	$self->{rbuf} = "";
1307		1424
…		…
1344	# read remaining chunk	1461	# read remaining chunk
1345	$_[0]->unshift_read (chunk => $len, sub {	1462	$_[0]->unshift_read (chunk => $len, sub {
1346	if (my $ref = eval { Storable::thaw ($_[1]) }) {	1463	if (my $ref = eval { Storable::thaw ($_[1]) }) {
1347	$cb->($_[0], $ref);	1464	$cb->($_[0], $ref);
1348	} else {	1465	} else {
1349	$self->_error (&Errno::EBADMSG);	1466	$self->_error (Errno::EBADMSG);
1350	}	1467	}
1351	});	1468	});
1352	}	1469	}
1353		1470
1354	1	1471	1
…		…
1418	if ($self->{tls}) {	1535	if ($self->{tls}) {
1419	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);	1536	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1420		1537
1421	&_dotls ($self);	1538	&_dotls ($self);
1422	} else {	1539	} else {
1423	$self->_drain_rbuf unless $self->{_in_drain};	1540	$self->_drain_rbuf;
1424	}	1541	}
1425		1542
1426	} elsif (defined $len) {	1543	} elsif (defined $len) {
1427	delete $self->{_rw};	1544	delete $self->{_rw};
1428	$self->{_eof} = 1;	1545	$self->{_eof} = 1;
1429	$self->_drain_rbuf unless $self->{_in_drain};	1546	$self->_drain_rbuf;
1430		1547
1431	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1548	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1432	return $self->_error ($!, 1);	1549	return $self->_error ($!, 1);
1433	}	1550	}
1434	});	1551	});
…		…
1452	if ($self->{_on_starttls}) {	1569	if ($self->{_on_starttls}) {
1453	(delete $self->{_on_starttls})->($self, undef, $err);	1570	(delete $self->{_on_starttls})->($self, undef, $err);
1454	&_freetls;	1571	&_freetls;
1455	} else {	1572	} else {
1456	&_freetls;	1573	&_freetls;
1457	$self->_error (&Errno::EPROTO, 1, $err);	1574	$self->_error (Errno::EPROTO, 1, $err);
1458	}	1575	}
1459	}	1576	}
1460		1577
1461	# poll the write BIO and send the data if applicable	1578	# poll the write BIO and send the data if applicable
1462	# also decode read data if possible	1579	# also decode read data if possible
…		…
1494	$self->{_eof} = 1;	1611	$self->{_eof} = 1;
1495	}	1612	}
1496	}	1613	}
1497		1614
1498	$self->{_tls_rbuf} .= $tmp;	1615	$self->{_tls_rbuf} .= $tmp;
1499	$self->_drain_rbuf unless $self->{_in_drain};	1616	$self->_drain_rbuf;
1500	$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
1501	}	1618	}
1502		1619
1503	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);	1620	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1504	return $self->_tls_error ($tmp)	1621	return $self->_tls_error ($tmp)
…		…
1519		1636
1520	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	1637	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
1521	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
1522	C<starttls>.	1639	C<starttls>.
1523		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
1524	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
1525	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1646	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1526		1647
1527	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
1528	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
…		…
1532	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
1533	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
1534	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
1535	when this function returns.	1656	when this function returns.
1536		1657
1537	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
1538	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.
1539		1661
1540	=cut	1662	=cut
1541		1663
1542	our %TLS_CACHE; #TODO not yet documented, should we?	1664	our %TLS_CACHE; #TODO not yet documented, should we?
1543		1665
1544	sub starttls {	1666	sub starttls {
1545	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};
1546		1676
1547	require Net::SSLeay;	1677	require Net::SSLeay;
1548
1549	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"
1550	if $self->{tls};
1551		1678
1552	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();	1679	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1553	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();	1680	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1554		1681
		1682	$tls = $self->{tls};
1555	$ctx \|\|= $self->{tls_ctx};	1683	$ctx = $self->{tls_ctx};
		1684
		1685	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
1556		1686
1557	if ("HASH" eq ref $ctx) {	1687	if ("HASH" eq ref $ctx) {
1558	require AnyEvent::TLS;	1688	require AnyEvent::TLS;
1559
1560	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context
1561		1689
1562	if ($ctx->{cache}) {	1690	if ($ctx->{cache}) {
1563	my $key = $ctx+0;	1691	my $key = $ctx+0;
1564	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;	1692	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;
1565	} else {	1693	} else {
1566	$ctx = new AnyEvent::TLS %$ctx;	1694	$ctx = new AnyEvent::TLS %$ctx;
1567	}	1695	}
1568	}	1696	}
1569		1697
1570	$self->{tls_ctx} = $ctx \|\| TLS_CTX ();	1698	$self->{tls_ctx} = $ctx \|\| TLS_CTX ();
1571	$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});
1572		1700
1573	# 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)
1574	# but the openssl maintainers basically said: "trust us, it just works".	1702	# but the openssl maintainers basically said: "trust us, it just works".
1575	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1703	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1576	# and mismaintained ssleay-module doesn't even offer them).	1704	# and mismaintained ssleay-module doesn't even offer them).
…		…
1583	# 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
1584	# have identity issues in that area.	1712	# have identity issues in that area.
1585	# Net::SSLeay::CTX_set_mode ($ssl,	1713	# Net::SSLeay::CTX_set_mode ($ssl,
1586	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1714	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
1587	# \| (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));
1588	Net::SSLeay::CTX_set_mode ($ssl, 1\|2);	1716	Net::SSLeay::CTX_set_mode ($tls, 1\|2);
1589		1717
1590	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1718	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1591	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1719	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1592		1720
1593	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1721	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
1594		1722
1595	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }	1723	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1596	if $self->{on_starttls};	1724	if $self->{on_starttls};
1597		1725
1598	&_dotls; # need to trigger the initial handshake	1726	&_dotls; # need to trigger the initial handshake
…		…
1601		1729
1602	=item $handle->stoptls	1730	=item $handle->stoptls
1603		1731
1604	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
1605	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
1606	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
1607	afterwards.	1735	the stream afterwards.
1608		1736
1609	=cut	1737	=cut
1610		1738
1611	sub stoptls {	1739	sub stoptls {
1612	my ($self) = @_;	1740	my ($self) = @_;
…		…
1625	sub _freetls {	1753	sub _freetls {
1626	my ($self) = @_;	1754	my ($self) = @_;
1627		1755
1628	return unless $self->{tls};	1756	return unless $self->{tls};
1629		1757
1630	$self->{tls_ctx}->_put_session (delete $self->{tls});	1758	$self->{tls_ctx}->_put_session (delete $self->{tls})
		1759	if ref $self->{tls};
1631		1760
1632	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};	1761	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1633	}	1762	}
1634		1763
1635	sub DESTROY {	1764	sub DESTROY {
…		…
1637		1766
1638	&_freetls;	1767	&_freetls;
1639		1768
1640	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	1769	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1641		1770
1642	if ($linger && length $self->{wbuf}) {	1771	if ($linger && length $self->{wbuf} && $self->{fh}) {
1643	my $fh = delete $self->{fh};	1772	my $fh = delete $self->{fh};
1644	my $wbuf = delete $self->{wbuf};	1773	my $wbuf = delete $self->{wbuf};
1645		1774
1646	my @linger;	1775	my @linger;
1647		1776
…		…
1671	callbacks, as well as code outside. It does I<NOT> work in a read or write	1800	callbacks, as well as code outside. It does I<NOT> work in a read or write
1672	callback, so when you want to destroy the AnyEvent::Handle object from	1801	callback, so when you want to destroy the AnyEvent::Handle object from
1673	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in	1802	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
1674	that case.	1803	that case.
1675		1804
		1805	Destroying the handle object in this way has the advantage that callbacks
		1806	will be removed as well, so if those are the only reference holders (as
		1807	is common), then one doesn't need to do anything special to break any
		1808	reference cycles.
		1809
1676	The handle might still linger in the background and write out remaining	1810	The handle might still linger in the background and write out remaining
1677	data, as specified by the C<linger> option, however.	1811	data, as specified by the C<linger> option, however.
1678		1812
1679	=cut	1813	=cut
1680		1814
…		…
1747		1881
1748	$handle->on_read (sub { });	1882	$handle->on_read (sub { });
1749	$handle->on_eof (undef);	1883	$handle->on_eof (undef);
1750	$handle->on_error (sub {	1884	$handle->on_error (sub {
1751	my $data = delete $_[0]{rbuf};	1885	my $data = delete $_[0]{rbuf};
1752	undef $handle;
1753	});	1886	});
1754		1887
1755	The reason to use C<on_error> is that TCP connections, due to latencies	1888	The reason to use C<on_error> is that TCP connections, due to latencies
1756	and packets loss, might get closed quite violently with an error, when in	1889	and packets loss, might get closed quite violently with an error, when in
1757	fact, all data has been received.	1890	fact, all data has been received.

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.144 by root, Mon Jul 6 21:38:25 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.144 by root, Mon Jul 6 21:38:25 2009 UTC vs.
Revision 1.160 by root, Fri Jul 24 22:47:04 2009 UTC