[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.174 by root, Sat Aug 8 20:52:06 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.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;
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	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.
		189
82	=item on_eof => $cb->($handle)	190	=item on_eof => $cb->($handle)
83		191
84	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,
85	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
86	connection cleanly.	194	connection cleanly, and there are no outstanding read requests in the
		195	queue (if there are read requests, then an EOF counts as an unexpected
		196	connection close and will be flagged as an error).
87		197
88	For sockets, this just means that the other side has stopped sending data,	198	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	199	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	200	callback and continue writing data, as only the read part has been shut
91	down.	201	down.
92		202
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	203	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>.	204	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		205
147	=item on_drain => $cb->($handle)	206	=item on_drain => $cb->($handle)
148		207
149	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
150	(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).
…		…
349		408
350	sub new {	409	sub new {
351	my $class = shift;	410	my $class = shift;
352	my $self = bless { @_ }, $class;	411	my $self = bless { @_ }, $class;
353		412
354	$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) = @_;
355		476
356	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	477	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
357		478
358	$self->{_activity} = AnyEvent->now;	479	$self->{_activity} = AnyEvent->now;
359	$self->_timeout;	480	$self->_timeout;
…		…
364	if $self->{tls};	485	if $self->{tls};
365		486
366	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	487	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
367		488
368	$self->start_read	489	$self->start_read
369	if $self->{on_read};	490	if $self->{on_read} \|\| @{ $self->{_queue} };
370		491
371	$self->{fh} && $self	492	$self->_drain_wbuf;
372	}	493	}
373		494
374	sub _shutdown {	495	#sub _shutdown {
375	my ($self) = @_;	496	# my ($self) = @_;
376		497	#
377	delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)};	498	# delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)};
378	$self->{_eof} = 1; # tell starttls et. al to stop trying	499	# $self->{_eof} = 1; # tell starttls et. al to stop trying
379		500	#
380	&_freetls;	501	# &_freetls;
381	}	502	#}
382		503
383	sub _error {	504	sub _error {
384	my ($self, $errno, $fatal, $message) = @_;	505	my ($self, $errno, $fatal, $message) = @_;
385		506
386	$self->_shutdown
387	if $fatal;
388
389	$! = $errno;	507	$! = $errno;
390	$message \|\|= "$!";	508	$message \|\|= "$!";
391		509
392	if ($self->{on_error}) {	510	if ($self->{on_error}) {
393	$self->{on_error}($self, $fatal, $message);	511	$self->{on_error}($self, $fatal, $message);
		512	$self->destroy if $fatal;
394	} elsif ($self->{fh}) {	513	} elsif ($self->{fh}) {
		514	$self->destroy;
395	Carp::croak "AnyEvent::Handle uncaught error: $message";	515	Carp::croak "AnyEvent::Handle uncaught error: $message";
396	}	516	}
397	}	517	}
398		518
399	=item $fh = $handle->fh	519	=item $fh = $handle->fh
…		…
457	sub no_delay {	577	sub no_delay {
458	$_[0]{no_delay} = $_[1];	578	$_[0]{no_delay} = $_[1];
459		579
460	eval {	580	eval {
461	local $SIG{__DIE__};	581	local $SIG{__DIE__};
462	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};
463	};	584	};
464	}	585	}
465		586
466	=item $handle->on_starttls ($cb)	587	=item $handle->on_starttls ($cb)
467		588
…		…
481		602
482	sub on_starttls {	603	sub on_starttls {
483	$_[0]{on_stoptls} = $_[1];	604	$_[0]{on_stoptls} = $_[1];
484	}	605	}
485		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
486	#############################################################################	617	#############################################################################
487		618
488	=item $handle->timeout ($seconds)	619	=item $handle->timeout ($seconds)
489		620
490	Configures (or disables) the inactivity timeout.	621	Configures (or disables) the inactivity timeout.
…		…
493		624
494	sub timeout {	625	sub timeout {
495	my ($self, $timeout) = @_;	626	my ($self, $timeout) = @_;
496		627
497	$self->{timeout} = $timeout;	628	$self->{timeout} = $timeout;
		629	delete $self->{_tw};
498	$self->_timeout;	630	$self->_timeout;
499	}	631	}
500		632
501	# reset the timeout watcher, as neccessary	633	# reset the timeout watcher, as neccessary
502	# also check for time-outs	634	# also check for time-outs
503	sub _timeout {	635	sub _timeout {
504	my ($self) = @_;	636	my ($self) = @_;
505		637
506	if ($self->{timeout}) {	638	if ($self->{timeout} && $self->{fh}) {
507	my $NOW = AnyEvent->now;	639	my $NOW = AnyEvent->now;
508		640
509	# when would the timeout trigger?	641	# when would the timeout trigger?
510	my $after = $self->{_activity} + $self->{timeout} - $NOW;	642	my $after = $self->{_activity} + $self->{timeout} - $NOW;
511		643
…		…
514	$self->{_activity} = $NOW;	646	$self->{_activity} = $NOW;
515		647
516	if ($self->{on_timeout}) {	648	if ($self->{on_timeout}) {
517	$self->{on_timeout}($self);	649	$self->{on_timeout}($self);
518	} else {	650	} else {
519	$self->_error (&Errno::ETIMEDOUT);	651	$self->_error (Errno::ETIMEDOUT);
520	}	652	}
521		653
522	# callback could have changed timeout value, optimise	654	# callback could have changed timeout value, optimise
523	return unless $self->{timeout};	655	return unless $self->{timeout};
524		656
…		…
587	Scalar::Util::weaken $self;	719	Scalar::Util::weaken $self;
588		720
589	my $cb = sub {	721	my $cb = sub {
590	my $len = syswrite $self->{fh}, $self->{wbuf};	722	my $len = syswrite $self->{fh}, $self->{wbuf};
591		723
592	if ($len >= 0) {	724	if (defined $len) {
593	substr $self->{wbuf}, 0, $len, "";	725	substr $self->{wbuf}, 0, $len, "";
594		726
595	$self->{_activity} = AnyEvent->now;	727	$self->{_activity} = AnyEvent->now;
596		728
597	$self->{on_drain}($self)	729	$self->{on_drain}($self)
…		…
629	->($self, @_);	761	->($self, @_);
630	}	762	}
631		763
632	if ($self->{tls}) {	764	if ($self->{tls}) {
633	$self->{_tls_wbuf} .= $_[0];	765	$self->{_tls_wbuf} .= $_[0];
634		766	&_dotls ($self) if $self->{fh};
635	&_dotls ($self);
636	} else {	767	} else {
637	$self->{wbuf} .= $_[0];	768	$self->{wbuf} .= $_[0];
638	$self->_drain_wbuf;	769	$self->_drain_wbuf if $self->{fh};
639	}	770	}
640	}	771	}
641		772
642	=item $handle->push_write (type => @args)	773	=item $handle->push_write (type => @args)
643		774
…		…
860	=cut	991	=cut
861		992
862	sub _drain_rbuf {	993	sub _drain_rbuf {
863	my ($self) = @_;	994	my ($self) = @_;
864		995
		996	# avoid recursion
		997	return if $self->{_skip_drain_rbuf};
865	local $self->{_in_drain} = 1;	998	local $self->{_skip_drain_rbuf} = 1;
866
867	if (
868	defined $self->{rbuf_max}
869	&& $self->{rbuf_max} < length $self->{rbuf}
870	) {
871	$self->_error (&Errno::ENOSPC, 1), return;
872	}
873		999
874	while () {	1000	while () {
875	# 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
876	# 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.
877	$self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf};	1003	$self->{rbuf} .= delete $self->{_tls_rbuf}
		1004	if exists $self->{_tls_rbuf};
878		1005
879	my $len = length $self->{rbuf};	1006	my $len = length $self->{rbuf};
880		1007
881	if (my $cb = shift @{ $self->{_queue} }) {	1008	if (my $cb = shift @{ $self->{_queue} }) {
882	unless ($cb->($self)) {	1009	unless ($cb->($self)) {
883	if ($self->{_eof}) {	1010	# no progress can be made
884	# no progress can be made (not enough data and no data forthcoming)	1011	# (not enough data and no data forthcoming)
885	$self->_error (&Errno::EPIPE, 1), return;	1012	$self->_error (Errno::EPIPE, 1), return
886	}	1013	if $self->{_eof};
887		1014
888	unshift @{ $self->{_queue} }, $cb;	1015	unshift @{ $self->{_queue} }, $cb;
889	last;	1016	last;
890	}	1017	}
891	} elsif ($self->{on_read}) {	1018	} elsif ($self->{on_read}) {
…		…
898	&& !@{ $self->{_queue} } # and the queue is still empty	1025	&& !@{ $self->{_queue} } # and the queue is still empty
899	&& $self->{on_read} # but we still have on_read	1026	&& $self->{on_read} # but we still have on_read
900	) {	1027	) {
901	# no further data will arrive	1028	# no further data will arrive
902	# so no progress can be made	1029	# so no progress can be made
903	$self->_error (&Errno::EPIPE, 1), return	1030	$self->_error (Errno::EPIPE, 1), return
904	if $self->{_eof};	1031	if $self->{_eof};
905		1032
906	last; # more data might arrive	1033	last; # more data might arrive
907	}	1034	}
908	} else {	1035	} else {
…		…
911	last;	1038	last;
912	}	1039	}
913	}	1040	}
914		1041
915	if ($self->{_eof}) {	1042	if ($self->{_eof}) {
916	if ($self->{on_eof}) {	1043	$self->{on_eof}
917	$self->{on_eof}($self)	1044	? $self->{on_eof}($self)
918	} else {
919	$self->_error (0, 1, "Unexpected end-of-file");	1045	: $self->_error (0, 1, "Unexpected end-of-file");
920	}	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;
921	}	1055	}
922		1056
923	# may need to restart read watcher	1057	# may need to restart read watcher
924	unless ($self->{_rw}) {	1058	unless ($self->{_rw}) {
925	$self->start_read	1059	$self->start_read
…		…
937		1071
938	sub on_read {	1072	sub on_read {
939	my ($self, $cb) = @_;	1073	my ($self, $cb) = @_;
940		1074
941	$self->{on_read} = $cb;	1075	$self->{on_read} = $cb;
942	$self->_drain_rbuf if $cb && !$self->{_in_drain};	1076	$self->_drain_rbuf if $cb;
943	}	1077	}
944		1078
945	=item $handle->rbuf	1079	=item $handle->rbuf
946		1080
947	Returns the read buffer (as a modifiable lvalue).	1081	Returns the read buffer (as a modifiable lvalue).
…		…
999	$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")
1000	->($self, $cb, @_);	1134	->($self, $cb, @_);
1001	}	1135	}
1002		1136
1003	push @{ $self->{_queue} }, $cb;	1137	push @{ $self->{_queue} }, $cb;
1004	$self->_drain_rbuf unless $self->{_in_drain};	1138	$self->_drain_rbuf;
1005	}	1139	}
1006		1140
1007	sub unshift_read {	1141	sub unshift_read {
1008	my $self = shift;	1142	my $self = shift;
1009	my $cb = pop;	1143	my $cb = pop;
…		…
1015	->($self, $cb, @_);	1149	->($self, $cb, @_);
1016	}	1150	}
1017		1151
1018		1152
1019	unshift @{ $self->{_queue} }, $cb;	1153	unshift @{ $self->{_queue} }, $cb;
1020	$self->_drain_rbuf unless $self->{_in_drain};	1154	$self->_drain_rbuf;
1021	}	1155	}
1022		1156
1023	=item $handle->push_read (type => @args, $cb)	1157	=item $handle->push_read (type => @args, $cb)
1024		1158
1025	=item $handle->unshift_read (type => @args, $cb)	1159	=item $handle->unshift_read (type => @args, $cb)
…		…
1158	return 1;	1292	return 1;
1159	}	1293	}
1160		1294
1161	# reject	1295	# reject
1162	if ($reject && $$rbuf =~ $reject) {	1296	if ($reject && $$rbuf =~ $reject) {
1163	$self->_error (&Errno::EBADMSG);	1297	$self->_error (Errno::EBADMSG);
1164	}	1298	}
1165		1299
1166	# skip	1300	# skip
1167	if ($skip && $$rbuf =~ $skip) {	1301	if ($skip && $$rbuf =~ $skip) {
1168	$data .= substr $$rbuf, 0, $+[0], "";	1302	$data .= substr $$rbuf, 0, $+[0], "";
…		…
1184	my ($self, $cb) = @_;	1318	my ($self, $cb) = @_;
1185		1319
1186	sub {	1320	sub {
1187	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {	1321	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
1188	if ($_[0]{rbuf} =~ /[^0-9]/) {	1322	if ($_[0]{rbuf} =~ /[^0-9]/) {
1189	$self->_error (&Errno::EBADMSG);	1323	$self->_error (Errno::EBADMSG);
1190	}	1324	}
1191	return;	1325	return;
1192	}	1326	}
1193		1327
1194	my $len = $1;	1328	my $len = $1;
…		…
1197	my $string = $_[1];	1331	my $string = $_[1];
1198	$_[0]->unshift_read (chunk => 1, sub {	1332	$_[0]->unshift_read (chunk => 1, sub {
1199	if ($_[1] eq ",") {	1333	if ($_[1] eq ",") {
1200	$cb->($_[0], $string);	1334	$cb->($_[0], $string);
1201	} else {	1335	} else {
1202	$self->_error (&Errno::EBADMSG);	1336	$self->_error (Errno::EBADMSG);
1203	}	1337	}
1204	});	1338	});
1205	});	1339	});
1206		1340
1207	1	1341	1
…		…
1297	$json->incr_skip;	1431	$json->incr_skip;
1298		1432
1299	$self->{rbuf} = $json->incr_text;	1433	$self->{rbuf} = $json->incr_text;
1300	$json->incr_text = "";	1434	$json->incr_text = "";
1301		1435
1302	$self->_error (&Errno::EBADMSG);	1436	$self->_error (Errno::EBADMSG);
1303		1437
1304	()	1438	()
1305	} else {	1439	} else {
1306	$self->{rbuf} = "";	1440	$self->{rbuf} = "";
1307		1441
…		…
1344	# read remaining chunk	1478	# read remaining chunk
1345	$_[0]->unshift_read (chunk => $len, sub {	1479	$_[0]->unshift_read (chunk => $len, sub {
1346	if (my $ref = eval { Storable::thaw ($_[1]) }) {	1480	if (my $ref = eval { Storable::thaw ($_[1]) }) {
1347	$cb->($_[0], $ref);	1481	$cb->($_[0], $ref);
1348	} else {	1482	} else {
1349	$self->_error (&Errno::EBADMSG);	1483	$self->_error (Errno::EBADMSG);
1350	}	1484	}
1351	});	1485	});
1352	}	1486	}
1353		1487
1354	1	1488	1
…		…
1418	if ($self->{tls}) {	1552	if ($self->{tls}) {
1419	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);	1553	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1420		1554
1421	&_dotls ($self);	1555	&_dotls ($self);
1422	} else {	1556	} else {
1423	$self->_drain_rbuf unless $self->{_in_drain};	1557	$self->_drain_rbuf;
1424	}	1558	}
1425		1559
1426	} elsif (defined $len) {	1560	} elsif (defined $len) {
1427	delete $self->{_rw};	1561	delete $self->{_rw};
1428	$self->{_eof} = 1;	1562	$self->{_eof} = 1;
1429	$self->_drain_rbuf unless $self->{_in_drain};	1563	$self->_drain_rbuf;
1430		1564
1431	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1565	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1432	return $self->_error ($!, 1);	1566	return $self->_error ($!, 1);
1433	}	1567	}
1434	});	1568	});
…		…
1452	if ($self->{_on_starttls}) {	1586	if ($self->{_on_starttls}) {
1453	(delete $self->{_on_starttls})->($self, undef, $err);	1587	(delete $self->{_on_starttls})->($self, undef, $err);
1454	&_freetls;	1588	&_freetls;
1455	} else {	1589	} else {
1456	&_freetls;	1590	&_freetls;
1457	$self->_error (&Errno::EPROTO, 1, $err);	1591	$self->_error (Errno::EPROTO, 1, $err);
1458	}	1592	}
1459	}	1593	}
1460		1594
1461	# poll the write BIO and send the data if applicable	1595	# poll the write BIO and send the data if applicable
1462	# also decode read data if possible	1596	# also decode read data if possible
…		…
1494	$self->{_eof} = 1;	1628	$self->{_eof} = 1;
1495	}	1629	}
1496	}	1630	}
1497		1631
1498	$self->{_tls_rbuf} .= $tmp;	1632	$self->{_tls_rbuf} .= $tmp;
1499	$self->_drain_rbuf unless $self->{_in_drain};	1633	$self->_drain_rbuf;
1500	$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
1501	}	1635	}
1502		1636
1503	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);	1637	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1504	return $self->_tls_error ($tmp)	1638	return $self->_tls_error ($tmp)
…		…
1519		1653
1520	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	1654	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	1655	object is created, you can also do that at a later time by calling
1522	C<starttls>.	1656	C<starttls>.
1523		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
1524	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
1525	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1663	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1526		1664
1527	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
1528	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
…		…
1532	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
1533	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
1534	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
1535	when this function returns.	1673	when this function returns.
1536		1674
1537	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
1538	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.
1539		1678
1540	=cut	1679	=cut
1541		1680
1542	our %TLS_CACHE; #TODO not yet documented, should we?	1681	our %TLS_CACHE; #TODO not yet documented, should we?
1543		1682
1544	sub starttls {	1683	sub starttls {
1545	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};
1546		1693
1547	require Net::SSLeay;	1694	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		1695
1552	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();	1696	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1553	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();	1697	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1554		1698
		1699	$tls = $self->{tls};
1555	$ctx \|\|= $self->{tls_ctx};	1700	$ctx = $self->{tls_ctx};
		1701
		1702	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
1556		1703
1557	if ("HASH" eq ref $ctx) {	1704	if ("HASH" eq ref $ctx) {
1558	require AnyEvent::TLS;	1705	require AnyEvent::TLS;
1559
1560	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context
1561		1706
1562	if ($ctx->{cache}) {	1707	if ($ctx->{cache}) {
1563	my $key = $ctx+0;	1708	my $key = $ctx+0;
1564	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;	1709	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;
1565	} else {	1710	} else {
1566	$ctx = new AnyEvent::TLS %$ctx;	1711	$ctx = new AnyEvent::TLS %$ctx;
1567	}	1712	}
1568	}	1713	}
1569		1714
1570	$self->{tls_ctx} = $ctx \|\| TLS_CTX ();	1715	$self->{tls_ctx} = $ctx \|\| TLS_CTX ();
1571	$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});
1572		1717
1573	# 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)
1574	# but the openssl maintainers basically said: "trust us, it just works".	1719	# but the openssl maintainers basically said: "trust us, it just works".
1575	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1720	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1576	# and mismaintained ssleay-module doesn't even offer them).	1721	# 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	1728	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
1584	# have identity issues in that area.	1729	# have identity issues in that area.
1585	# Net::SSLeay::CTX_set_mode ($ssl,	1730	# Net::SSLeay::CTX_set_mode ($ssl,
1586	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1731	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
1587	# \| (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));
1588	Net::SSLeay::CTX_set_mode ($ssl, 1\|2);	1733	Net::SSLeay::CTX_set_mode ($tls, 1\|2);
1589		1734
1590	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1735	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1591	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1736	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1592		1737
		1738	Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf});
		1739
1593	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1740	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
1594		1741
1595	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }	1742	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1596	if $self->{on_starttls};	1743	if $self->{on_starttls};
1597		1744
1598	&_dotls; # need to trigger the initial handshake	1745	&_dotls; # need to trigger the initial handshake
…		…
1601		1748
1602	=item $handle->stoptls	1749	=item $handle->stoptls
1603		1750
1604	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
1605	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
1606	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
1607	afterwards.	1754	the stream afterwards.
1608		1755
1609	=cut	1756	=cut
1610		1757
1611	sub stoptls {	1758	sub stoptls {
1612	my ($self) = @_;	1759	my ($self) = @_;
…		…
1625	sub _freetls {	1772	sub _freetls {
1626	my ($self) = @_;	1773	my ($self) = @_;
1627		1774
1628	return unless $self->{tls};	1775	return unless $self->{tls};
1629		1776
1630	$self->{tls_ctx}->_put_session (delete $self->{tls});	1777	$self->{tls_ctx}->_put_session (delete $self->{tls})
		1778	if $self->{tls} > 0;
1631		1779
1632	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};	1780	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1633	}	1781	}
1634		1782
1635	sub DESTROY {	1783	sub DESTROY {
…		…
1637		1785
1638	&_freetls;	1786	&_freetls;
1639		1787
1640	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	1788	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1641		1789
1642	if ($linger && length $self->{wbuf}) {	1790	if ($linger && length $self->{wbuf} && $self->{fh}) {
1643	my $fh = delete $self->{fh};	1791	my $fh = delete $self->{fh};
1644	my $wbuf = delete $self->{wbuf};	1792	my $wbuf = delete $self->{wbuf};
1645		1793
1646	my @linger;	1794	my @linger;
1647		1795
…		…
1662		1810
1663	=item $handle->destroy	1811	=item $handle->destroy
1664		1812
1665	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
1666	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
1667	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).
1668		1818
1669	Normally, you can just "forget" any references to an AnyEvent::Handle	1819	Normally, you can just "forget" any references to an AnyEvent::Handle
1670	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
1671	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
1672	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
1673	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in	1823	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
1674	that case.	1824	that case.
1675		1825
		1826	Destroying the handle object in this way has the advantage that callbacks
		1827	will be removed as well, so if those are the only reference holders (as
		1828	is common), then one doesn't need to do anything special to break any
		1829	reference cycles.
		1830
1676	The handle might still linger in the background and write out remaining	1831	The handle might still linger in the background and write out remaining
1677	data, as specified by the C<linger> option, however.	1832	data, as specified by the C<linger> option, however.
1678		1833
1679	=cut	1834	=cut
1680		1835
1681	sub destroy {	1836	sub destroy {
1682	my ($self) = @_;	1837	my ($self) = @_;
1683		1838
1684	$self->DESTROY;	1839	$self->DESTROY;
1685	%$self = ();	1840	%$self = ();
		1841	bless $self, "AnyEvent::Handle::destroyed";
		1842	}
		1843
		1844	sub AnyEvent::Handle::destroyed::AUTOLOAD {
		1845	#nop
1686	}	1846	}
1687		1847
1688	=item AnyEvent::Handle::TLS_CTX	1848	=item AnyEvent::Handle::TLS_CTX
1689		1849
1690	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
…		…
1747		1907
1748	$handle->on_read (sub { });	1908	$handle->on_read (sub { });
1749	$handle->on_eof (undef);	1909	$handle->on_eof (undef);
1750	$handle->on_error (sub {	1910	$handle->on_error (sub {
1751	my $data = delete $_[0]{rbuf};	1911	my $data = delete $_[0]{rbuf};
1752	undef $handle;
1753	});	1912	});
1754		1913
1755	The reason to use C<on_error> is that TCP connections, due to latencies	1914	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	1915	and packets loss, might get closed quite violently with an error, when in
1757	fact, all data has been received.	1916	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.174 by root, Sat Aug 8 20:52:06 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.174 by root, Sat Aug 8 20:52:06 2009 UTC