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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.151 by root, Thu Jul 16 04:20:23 2009 UTC vs.
Revision 1.180 by root, Thu Aug 20 22:58:35 2009 UTC

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

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.151 by root, Thu Jul 16 04:20:23 2009 UTC vs. Revision 1.180 by root, Thu Aug 20 22:58:35 2009 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.151 by root, Thu Jul 16 04:20:23 2009 UTC vs.
Revision 1.180 by root, Thu Aug 20 22:58:35 2009 UTC