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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.154 by root, Sat Jul 18 05:19:09 2009 UTC vs.
Revision 1.181 by root, Tue Sep 1 10:40:05 2009 UTC

…		…
1	package AnyEvent::Handle;
2
3	use Scalar::Util ();
4	use Carp ();
5	use Errno qw(EAGAIN EINTR);
6
7	use AnyEvent (); BEGIN { AnyEvent::common_sense }
8	use AnyEvent::Util qw(WSAEWOULDBLOCK);
9
10	=head1 NAME	1	=head1 NAME
11		2
12	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent	3	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent
13
14	=cut
15
16	our $VERSION = 4.85;
17		4
18	=head1 SYNOPSIS	5	=head1 SYNOPSIS
19		6
20	use AnyEvent;	7	use AnyEvent;
21	use AnyEvent::Handle;	8	use AnyEvent::Handle;
44	$cv->recv;	31	$cv->recv;
45		32
46	=head1 DESCRIPTION	33	=head1 DESCRIPTION
47		34
48	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
49	filehandles. For utility functions for doing non-blocking connects and accepts	36	filehandles.
50	on sockets see L<AnyEvent::Util>.
51		37
52	The L<AnyEvent::Intro> tutorial contains some well-documented	38	The L<AnyEvent::Intro> tutorial contains some well-documented
53	AnyEvent::Handle examples.	39	AnyEvent::Handle examples.
54		40
55	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
56	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
57	treatment of characters applies to this module as well.	43	treatment of characters applies to this module as well.
58		44
		45	At the very minimum, you should specify C<fh> or C<connect>, and the
		46	C<on_error> callback.
		47
59	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
60	argument.	49	argument.
61		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
62	=head1 METHODS	65	=head1 METHODS
63		66
64	=over 4	67	=over 4
65		68
66	=item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value...	69	=item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value...
67		70
68	The constructor supports these arguments (all as C<< key => value >> pairs).	71	The constructor supports these arguments (all as C<< key => value >> pairs).
69		72
70	=over 4	73	=over 4
71		74
72	=item fh => $filehandle [MANDATORY]	75	=item fh => $filehandle [C<fh> or C<connect> MANDATORY]
73		76
74	The filehandle this L<AnyEvent::Handle> object will operate on.	77	The filehandle this L<AnyEvent::Handle> object will operate on.
75
76	NOTE: The filehandle will be set to non-blocking mode (using	78	NOTE: The filehandle will be set to non-blocking mode (using
77	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
78	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.
79		190
80	=item on_eof => $cb->($handle)	191	=item on_eof => $cb->($handle)
81		192
82	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,
83	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
…		…
91	down.	202	down.
92		203
93	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
94	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>.
95		206
96	=item on_error => $cb->($handle, $fatal, $message)
97
98	This is the error callback, which is called when, well, some error
99	occured, such as not being able to resolve the hostname, failure to
100	connect or a read error.
101
102	Some errors are fatal (which is indicated by C<$fatal> being true). On
103	fatal errors the handle object will be destroyed (by a call to C<< ->
104	destroy >>) after invoking the error callback (which means you are free to
105	examine the handle object). Examples of fatal errors are an EOF condition
106	with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors.
107
108	AnyEvent::Handle tries to find an appropriate error code for you to check
109	against, but in some cases (TLS errors), this does not work well. It is
110	recommended to always output the C<$message> argument in human-readable
111	error messages (it's usually the same as C<"$!">).
112
113	Non-fatal errors can be retried by simply returning, but it is recommended
114	to simply ignore this parameter and instead abondon the handle object
115	when this callback is invoked. Examples of non-fatal errors are timeouts
116	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
117
118	On callback entrance, the value of C<$!> contains the operating system
119	error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
120	C<EPROTO>).
121
122	While not mandatory, it is I<highly> recommended to set this callback, as
123	you will not be notified of errors otherwise. The default simply calls
124	C<croak>.
125
126	=item on_read => $cb->($handle)
127
128	This sets the default read callback, which is called when data arrives
129	and no read request is in the queue (unlike read queue callbacks, this
130	callback will only be called when at least one octet of data is in the
131	read buffer).
132
133	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
134	method or access the C<< $handle->{rbuf} >> member directly. Note that you
135	must not enlarge or modify the read buffer, you can only remove data at
136	the beginning from it.
137
138	When an EOF condition is detected then AnyEvent::Handle will first try to
139	feed all the remaining data to the queued callbacks and C<on_read> before
140	calling the C<on_eof> callback. If no progress can be made, then a fatal
141	error will be raised (with C<$!> set to C<EPIPE>).
142
143	Note that, unlike requests in the read queue, an C<on_read> callback
144	doesn't mean you I<require> some data: if there is an EOF and there
145	are outstanding read requests then an error will be flagged. With an
146	C<on_read> callback, the C<on_eof> callback will be invoked.
147
148	=item on_drain => $cb->($handle)	207	=item on_drain => $cb->($handle)
149		208
150	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
151	(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).
152		211
…		…
158	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
159	the file when the write queue becomes empty.	218	the file when the write queue becomes empty.
160		219
161	=item timeout => $fractional_seconds	220	=item timeout => $fractional_seconds
162		221
		222	=item rtimeout => $fractional_seconds
		223
		224	=item wtimeout => $fractional_seconds
		225
163	If non-zero, then this enables an "inactivity" timeout: whenever this many	226	If non-zero, then these enables an "inactivity" timeout: whenever this
164	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
165	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
166	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>.
167		237
168	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
169	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
170	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
171	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
…		…
350		420
351	sub new {	421	sub new {
352	my $class = shift;	422	my $class = shift;
353	my $self = bless { @_ }, $class;	423	my $self = bless { @_ }, $class;
354		424
355	$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) = @_;
356		488
357	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	489	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
358		490
		491	$self->{_activity} =
		492	$self->{_ractivity} =
359	$self->{_activity} = AnyEvent->now;	493	$self->{_wactivity} = AE::now;
360	$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};
361		498
362	$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};
363		500
364	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})	501	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
365	if $self->{tls};	502	if $self->{tls};
366		503
367	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	504	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
368		505
369	$self->start_read	506	$self->start_read
370	if $self->{on_read};	507	if $self->{on_read} \|\| @{ $self->{_queue} };
371		508
372	$self->{fh} && $self	509	$self->_drain_wbuf;
373	}	510	}
374
375	#sub _shutdown {
376	# my ($self) = @_;
377	#
378	# delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)};
379	# $self->{_eof} = 1; # tell starttls et. al to stop trying
380	#
381	# &_freetls;
382	#}
383		511
384	sub _error {	512	sub _error {
385	my ($self, $errno, $fatal, $message) = @_;	513	my ($self, $errno, $fatal, $message) = @_;
386		514
387	$! = $errno;	515	$! = $errno;
…		…
424	$_[0]{on_eof} = $_[1];	552	$_[0]{on_eof} = $_[1];
425	}	553	}
426		554
427	=item $handle->on_timeout ($cb)	555	=item $handle->on_timeout ($cb)
428		556
429	Replace the current C<on_timeout> callback, or disables the callback (but	557	=item $handle->on_rtimeout ($cb)
430	not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
431	argument and method.
432		558
433	=cut	559	=item $handle->on_wtimeout ($cb)
434		560
435	sub on_timeout {	561	Replace the current C<on_timeout>, C<on_rtimeout> or C<on_wtimeout>
436	$_[0]{on_timeout} = $_[1];	562	callback, or disables the callback (but not the timeout) if C<$cb> =
437	}	563	C<undef>. See the C<timeout> constructor argument and method.
		564
		565	=cut
		566
		567	# see below
438		568
439	=item $handle->autocork ($boolean)	569	=item $handle->autocork ($boolean)
440		570
441	Enables or disables the current autocork behaviour (see C<autocork>	571	Enables or disables the current autocork behaviour (see C<autocork>
442	constructor argument). Changes will only take effect on the next write.	572	constructor argument). Changes will only take effect on the next write.
…		…
457	sub no_delay {	587	sub no_delay {
458	$_[0]{no_delay} = $_[1];	588	$_[0]{no_delay} = $_[1];
459		589
460	eval {	590	eval {
461	local $SIG{__DIE__};	591	local $SIG{__DIE__};
462	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};
463	};	594	};
464	}	595	}
465		596
466	=item $handle->on_starttls ($cb)	597	=item $handle->on_starttls ($cb)
467		598
…		…
481		612
482	sub on_starttls {	613	sub on_starttls {
483	$_[0]{on_stoptls} = $_[1];	614	$_[0]{on_stoptls} = $_[1];
484	}	615	}
485		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
486	#############################################################################	627	#############################################################################
487		628
488	=item $handle->timeout ($seconds)	629	=item $handle->timeout ($seconds)
489		630
		631	=item $handle->rtimeout ($seconds)
		632
		633	=item $handle->wtimeout ($seconds)
		634
490	Configures (or disables) the inactivity timeout.	635	Configures (or disables) the inactivity timeout.
491		636
492	=cut	637	=item $handle->timeout_reset
493		638
494	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 {
495	my ($self, $timeout) = @_;	661	my ($self, $new_value) = @_;
496		662
497	$self->{timeout} = $timeout;	663	$self->{$timeout} = $new_value;
498	$self->_timeout;	664	delete $self->{$tw}; &$cb;
499	}	665	};
500		666
		667	*{"${dir}timeout_reset"} = sub {
		668	$_[0]{$activity} = AE::now;
		669	};
		670
		671	# main workhorse:
501	# reset the timeout watcher, as neccessary	672	# reset the timeout watcher, as neccessary
502	# also check for time-outs	673	# also check for time-outs
503	sub _timeout {	674	$cb = sub {
504	my ($self) = @_;	675	my ($self) = @_;
505		676
506	if ($self->{timeout}) {	677	if ($self->{$timeout} && $self->{fh}) {
507	my $NOW = AnyEvent->now;	678	my $NOW = AE::now;
508		679
509	# when would the timeout trigger?	680	# when would the timeout trigger?
510	my $after = $self->{_activity} + $self->{timeout} - $NOW;	681	my $after = $self->{$activity} + $self->{$timeout} - $NOW;
511		682
512	# now or in the past already?	683	# now or in the past already?
513	if ($after <= 0) {	684	if ($after <= 0) {
514	$self->{_activity} = $NOW;	685	$self->{$activity} = $NOW;
515		686
516	if ($self->{on_timeout}) {	687	if ($self->{$on_timeout}) {
517	$self->{on_timeout}($self);	688	$self->{$on_timeout}($self);
518	} else {	689	} else {
519	$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};
520	}	698	}
521		699
522	# callback could have changed timeout value, optimise	700	Scalar::Util::weaken $self;
523	return unless $self->{timeout};	701	return unless $self; # ->error could have destroyed $self
524		702
525	# calculate new after	703	$self->{$tw} \|\|= AE::timer $after, 0, sub {
526	$after = $self->{timeout};	704	delete $self->{$tw};
		705	$cb->($self);
		706	};
		707	} else {
		708	delete $self->{$tw};
527	}	709	}
528
529	Scalar::Util::weaken $self;
530	return unless $self; # ->error could have destroyed $self
531
532	$self->{_tw} \|\|= AnyEvent->timer (after => $after, cb => sub {
533	delete $self->{_tw};
534	$self->_timeout;
535	});
536	} else {
537	delete $self->{_tw};
538	}	710	}
539	}	711	}
540		712
541	#############################################################################	713	#############################################################################
542		714
…		…
590	my $len = syswrite $self->{fh}, $self->{wbuf};	762	my $len = syswrite $self->{fh}, $self->{wbuf};
591		763
592	if (defined $len) {	764	if (defined $len) {
593	substr $self->{wbuf}, 0, $len, "";	765	substr $self->{wbuf}, 0, $len, "";
594		766
595	$self->{_activity} = AnyEvent->now;	767	$self->{_activity} = $self->{_wactivity} = AE::now;
596		768
597	$self->{on_drain}($self)	769	$self->{on_drain}($self)
598	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})
599	&& $self->{on_drain};	771	&& $self->{on_drain};
600		772
…		…
606		778
607	# try to write data immediately	779	# try to write data immediately
608	$cb->() unless $self->{autocork};	780	$cb->() unless $self->{autocork};
609		781
610	# if still data left in wbuf, we need to poll	782	# if still data left in wbuf, we need to poll
611	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	783	$self->{_ww} = AE::io $self->{fh}, 1, $cb
612	if length $self->{wbuf};	784	if length $self->{wbuf};
613	};	785	};
614	}	786	}
615		787
616	our %WH;	788	our %WH;
…		…
629	->($self, @_);	801	->($self, @_);
630	}	802	}
631		803
632	if ($self->{tls}) {	804	if ($self->{tls}) {
633	$self->{_tls_wbuf} .= $_[0];	805	$self->{_tls_wbuf} .= $_[0];
634		806	&_dotls ($self) if $self->{fh};
635	&_dotls ($self);
636	} else {	807	} else {
637	$self->{wbuf} .= $_[0];	808	$self->{wbuf} .= $_[0];
638	$self->_drain_wbuf;	809	$self->_drain_wbuf if $self->{fh};
639	}	810	}
640	}	811	}
641		812
642	=item $handle->push_write (type => @args)	813	=item $handle->push_write (type => @args)
643		814
…		…
707	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
708	this line into their JSON decoder of choice.	879	this line into their JSON decoder of choice.
709		880
710	=cut	881	=cut
711		882
		883	sub json_coder() {
		884	eval { require JSON::XS; JSON::XS->new->utf8 }
		885	\|\| do { require JSON; JSON->new->utf8 }
		886	}
		887
712	register_write_type json => sub {	888	register_write_type json => sub {
713	my ($self, $ref) = @_;	889	my ($self, $ref) = @_;
714		890
715	require JSON;	891	my $json = $self->{json} \|\|= json_coder;
716		892
717	$self->{json} ? $self->{json}->encode ($ref)	893	$json->encode ($ref)
718	: JSON::encode_json ($ref)
719	};	894	};
720		895
721	=item storable => $reference	896	=item storable => $reference
722		897
723	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
…		…
860	=cut	1035	=cut
861		1036
862	sub _drain_rbuf {	1037	sub _drain_rbuf {
863	my ($self) = @_;	1038	my ($self) = @_;
864		1039
		1040	# avoid recursion
		1041	return if $self->{_skip_drain_rbuf};
865	local $self->{_in_drain} = 1;	1042	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		1043
874	while () {	1044	while () {
875	# 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
876	# 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.
877	$self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf};	1047	$self->{rbuf} .= delete $self->{_tls_rbuf}
		1048	if exists $self->{_tls_rbuf};
878		1049
879	my $len = length $self->{rbuf};	1050	my $len = length $self->{rbuf};
880		1051
881	if (my $cb = shift @{ $self->{_queue} }) {	1052	if (my $cb = shift @{ $self->{_queue} }) {
882	unless ($cb->($self)) {	1053	unless ($cb->($self)) {
883	if ($self->{_eof}) {	1054	# no progress can be made
884	# no progress can be made (not enough data and no data forthcoming)	1055	# (not enough data and no data forthcoming)
885	$self->_error (Errno::EPIPE, 1), return;	1056	$self->_error (Errno::EPIPE, 1), return
886	}	1057	if $self->{_eof};
887		1058
888	unshift @{ $self->{_queue} }, $cb;	1059	unshift @{ $self->{_queue} }, $cb;
889	last;	1060	last;
890	}	1061	}
891	} elsif ($self->{on_read}) {	1062	} elsif ($self->{on_read}) {
…		…
911	last;	1082	last;
912	}	1083	}
913	}	1084	}
914		1085
915	if ($self->{_eof}) {	1086	if ($self->{_eof}) {
916	if ($self->{on_eof}) {	1087	$self->{on_eof}
917	$self->{on_eof}($self)	1088	? $self->{on_eof}($self)
918	} else {
919	$self->_error (0, 1, "Unexpected end-of-file");	1089	: $self->_error (0, 1, "Unexpected end-of-file");
920	}	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;
921	}	1099	}
922		1100
923	# may need to restart read watcher	1101	# may need to restart read watcher
924	unless ($self->{_rw}) {	1102	unless ($self->{_rw}) {
925	$self->start_read	1103	$self->start_read
…		…
937		1115
938	sub on_read {	1116	sub on_read {
939	my ($self, $cb) = @_;	1117	my ($self, $cb) = @_;
940		1118
941	$self->{on_read} = $cb;	1119	$self->{on_read} = $cb;
942	$self->_drain_rbuf if $cb && !$self->{_in_drain};	1120	$self->_drain_rbuf if $cb;
943	}	1121	}
944		1122
945	=item $handle->rbuf	1123	=item $handle->rbuf
946		1124
947	Returns the read buffer (as a modifiable lvalue).	1125	Returns the read buffer (as a modifiable lvalue).
…		…
999	$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")
1000	->($self, $cb, @_);	1178	->($self, $cb, @_);
1001	}	1179	}
1002		1180
1003	push @{ $self->{_queue} }, $cb;	1181	push @{ $self->{_queue} }, $cb;
1004	$self->_drain_rbuf unless $self->{_in_drain};	1182	$self->_drain_rbuf;
1005	}	1183	}
1006		1184
1007	sub unshift_read {	1185	sub unshift_read {
1008	my $self = shift;	1186	my $self = shift;
1009	my $cb = pop;	1187	my $cb = pop;
…		…
1013		1191
1014	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")	1192	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")
1015	->($self, $cb, @_);	1193	->($self, $cb, @_);
1016	}	1194	}
1017		1195
1018
1019	unshift @{ $self->{_queue} }, $cb;	1196	unshift @{ $self->{_queue} }, $cb;
1020	$self->_drain_rbuf unless $self->{_in_drain};	1197	$self->_drain_rbuf;
1021	}	1198	}
1022		1199
1023	=item $handle->push_read (type => @args, $cb)	1200	=item $handle->push_read (type => @args, $cb)
1024		1201
1025	=item $handle->unshift_read (type => @args, $cb)	1202	=item $handle->unshift_read (type => @args, $cb)
…		…
1274	=cut	1451	=cut
1275		1452
1276	register_read_type json => sub {	1453	register_read_type json => sub {
1277	my ($self, $cb) = @_;	1454	my ($self, $cb) = @_;
1278		1455
1279	my $json = $self->{json} \|\|=	1456	my $json = $self->{json} \|\|= json_coder;
1280	eval { require JSON::XS; JSON::XS->new->utf8 }
1281	\|\| do { require JSON; JSON->new->utf8 };
1282		1457
1283	my $data;	1458	my $data;
1284	my $rbuf = \$self->{rbuf};	1459	my $rbuf = \$self->{rbuf};
1285		1460
1286	sub {	1461	sub {
…		…
1406	my ($self) = @_;	1581	my ($self) = @_;
1407		1582
1408	unless ($self->{_rw} \|\| $self->{_eof}) {	1583	unless ($self->{_rw} \|\| $self->{_eof}) {
1409	Scalar::Util::weaken $self;	1584	Scalar::Util::weaken $self;
1410		1585
1411	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1586	$self->{_rw} = AE::io $self->{fh}, 0, sub {
1412	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});	1587	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1413	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;	1588	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;
1414		1589
1415	if ($len > 0) {	1590	if ($len > 0) {
1416	$self->{_activity} = AnyEvent->now;	1591	$self->{_activity} = $self->{_ractivity} = AE::now;
1417		1592
1418	if ($self->{tls}) {	1593	if ($self->{tls}) {
1419	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);	1594	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1420		1595
1421	&_dotls ($self);	1596	&_dotls ($self);
1422	} else {	1597	} else {
1423	$self->_drain_rbuf unless $self->{_in_drain};	1598	$self->_drain_rbuf;
1424	}	1599	}
1425		1600
1426	} elsif (defined $len) {	1601	} elsif (defined $len) {
1427	delete $self->{_rw};	1602	delete $self->{_rw};
1428	$self->{_eof} = 1;	1603	$self->{_eof} = 1;
1429	$self->_drain_rbuf unless $self->{_in_drain};	1604	$self->_drain_rbuf;
1430		1605
1431	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1606	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1432	return $self->_error ($!, 1);	1607	return $self->_error ($!, 1);
1433	}	1608	}
1434	});	1609	};
1435	}	1610	}
1436	}	1611	}
1437		1612
1438	our $ERROR_SYSCALL;	1613	our $ERROR_SYSCALL;
1439	our $ERROR_WANT_READ;	1614	our $ERROR_WANT_READ;
…		…
1494	$self->{_eof} = 1;	1669	$self->{_eof} = 1;
1495	}	1670	}
1496	}	1671	}
1497		1672
1498	$self->{_tls_rbuf} .= $tmp;	1673	$self->{_tls_rbuf} .= $tmp;
1499	$self->_drain_rbuf unless $self->{_in_drain};	1674	$self->_drain_rbuf;
1500	$self->{tls} or return; # tls session might have gone away in callback	1675	$self->{tls} or return; # tls session might have gone away in callback
1501	}	1676	}
1502		1677
1503	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);	1678	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1504	return $self->_tls_error ($tmp)	1679	return $self->_tls_error ($tmp)
…		…
1519		1694
1520	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	1695	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	1696	object is created, you can also do that at a later time by calling
1522	C<starttls>.	1697	C<starttls>.
1523		1698
		1699	Starting TLS is currently an asynchronous operation - when you push some
		1700	write data and then call C<< ->starttls >> then TLS negotiation will start
		1701	immediately, after which the queued write data is then sent.
		1702
1524	The first argument is the same as the C<tls> constructor argument (either	1703	The first argument is the same as the C<tls> constructor argument (either
1525	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1704	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1526		1705
1527	The second argument is the optional C<AnyEvent::TLS> object that is used	1706	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	1707	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	1711	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	1712	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	1713	changed to your liking. Note that the handshake might have already started
1535	when this function returns.	1714	when this function returns.
1536		1715
1537	If it an error to start a TLS handshake more than once per	1716	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).	1717	handshakes on the same stream. Best do not attempt to use the stream after
		1718	stopping TLS.
1539		1719
1540	=cut	1720	=cut
1541		1721
1542	our %TLS_CACHE; #TODO not yet documented, should we?	1722	our %TLS_CACHE; #TODO not yet documented, should we?
1543		1723
1544	sub starttls {	1724	sub starttls {
1545	my ($self, $ssl, $ctx) = @_;	1725	my ($self, $tls, $ctx) = @_;
		1726
		1727	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"
		1728	if $self->{tls};
		1729
		1730	$self->{tls} = $tls;
		1731	$self->{tls_ctx} = $ctx if @_ > 2;
		1732
		1733	return unless $self->{fh};
1546		1734
1547	require Net::SSLeay;	1735	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		1736
1552	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();	1737	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1553	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();	1738	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1554		1739
		1740	$tls = delete $self->{tls};
1555	$ctx \|\|= $self->{tls_ctx};	1741	$ctx = $self->{tls_ctx};
		1742
		1743	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
1556		1744
1557	if ("HASH" eq ref $ctx) {	1745	if ("HASH" eq ref $ctx) {
1558	require AnyEvent::TLS;	1746	require AnyEvent::TLS;
1559
1560	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context
1561		1747
1562	if ($ctx->{cache}) {	1748	if ($ctx->{cache}) {
1563	my $key = $ctx+0;	1749	my $key = $ctx+0;
1564	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;	1750	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;
1565	} else {	1751	} else {
1566	$ctx = new AnyEvent::TLS %$ctx;	1752	$ctx = new AnyEvent::TLS %$ctx;
1567	}	1753	}
1568	}	1754	}
1569		1755
1570	$self->{tls_ctx} = $ctx \|\| TLS_CTX ();	1756	$self->{tls_ctx} = $ctx \|\| TLS_CTX ();
1571	$self->{tls} = $ssl = $self->{tls_ctx}->_get_session ($ssl, $self, $self->{peername});	1757	$self->{tls} = $tls = $self->{tls_ctx}->_get_session ($tls, $self, $self->{peername});
1572		1758
1573	# basically, this is deep magic (because SSL_read should have the same issues)	1759	# 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".	1760	# but the openssl maintainers basically said: "trust us, it just works".
1575	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1761	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1576	# and mismaintained ssleay-module doesn't even offer them).	1762	# 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	1769	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
1584	# have identity issues in that area.	1770	# have identity issues in that area.
1585	# Net::SSLeay::CTX_set_mode ($ssl,	1771	# Net::SSLeay::CTX_set_mode ($ssl,
1586	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1772	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
1587	# \| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));	1773	# \| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
1588	Net::SSLeay::CTX_set_mode ($ssl, 1\|2);	1774	Net::SSLeay::CTX_set_mode ($tls, 1\|2);
1589		1775
1590	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1776	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1591	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1777	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1592		1778
		1779	Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf});
		1780
1593	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1781	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
1594		1782
1595	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }	1783	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1596	if $self->{on_starttls};	1784	if $self->{on_starttls};
1597		1785
1598	&_dotls; # need to trigger the initial handshake	1786	&_dotls; # need to trigger the initial handshake
…		…
1601		1789
1602	=item $handle->stoptls	1790	=item $handle->stoptls
1603		1791
1604	Shuts down the SSL connection - this makes a proper EOF handshake by	1792	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	1793	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	1794	support non-blocking shut downs, it is not guarenteed that you can re-use
1607	afterwards.	1795	the stream afterwards.
1608		1796
1609	=cut	1797	=cut
1610		1798
1611	sub stoptls {	1799	sub stoptls {
1612	my ($self) = @_;	1800	my ($self) = @_;
…		…
1625	sub _freetls {	1813	sub _freetls {
1626	my ($self) = @_;	1814	my ($self) = @_;
1627		1815
1628	return unless $self->{tls};	1816	return unless $self->{tls};
1629		1817
1630	$self->{tls_ctx}->_put_session (delete $self->{tls});	1818	$self->{tls_ctx}->_put_session (delete $self->{tls})
		1819	if $self->{tls} > 0;
1631		1820
1632	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};	1821	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1633	}	1822	}
1634		1823
1635	sub DESTROY {	1824	sub DESTROY {
…		…
1637		1826
1638	&_freetls;	1827	&_freetls;
1639		1828
1640	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	1829	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1641		1830
1642	if ($linger && length $self->{wbuf}) {	1831	if ($linger && length $self->{wbuf} && $self->{fh}) {
1643	my $fh = delete $self->{fh};	1832	my $fh = delete $self->{fh};
1644	my $wbuf = delete $self->{wbuf};	1833	my $wbuf = delete $self->{wbuf};
1645		1834
1646	my @linger;	1835	my @linger;
1647		1836
1648	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {	1837	push @linger, AE::io $fh, 1, sub {
1649	my $len = syswrite $fh, $wbuf, length $wbuf;	1838	my $len = syswrite $fh, $wbuf, length $wbuf;
1650		1839
1651	if ($len > 0) {	1840	if ($len > 0) {
1652	substr $wbuf, 0, $len, "";	1841	substr $wbuf, 0, $len, "";
1653	} else {	1842	} else {
1654	@linger = (); # end	1843	@linger = (); # end
1655	}	1844	}
1656	});	1845	};
1657	push @linger, AnyEvent->timer (after => $linger, cb => sub {	1846	push @linger, AE::timer $linger, 0, sub {
1658	@linger = ();	1847	@linger = ();
1659	});	1848	};
1660	}	1849	}
1661	}	1850	}
1662		1851
1663	=item $handle->destroy	1852	=item $handle->destroy
1664		1853
1665	Shuts down the handle object as much as possible - this call ensures that	1854	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	1855	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.	1856	will be freed. Any method you will call on the handle object after
		1857	destroying it in this way will be silently ignored (and it will return the
		1858	empty list).
1668		1859
1669	Normally, you can just "forget" any references to an AnyEvent::Handle	1860	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	1861	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	1862	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	1863	callback, so when you want to destroy the AnyEvent::Handle object from
…		…
1686	sub destroy {	1877	sub destroy {
1687	my ($self) = @_;	1878	my ($self) = @_;
1688		1879
1689	$self->DESTROY;	1880	$self->DESTROY;
1690	%$self = ();	1881	%$self = ();
		1882	bless $self, "AnyEvent::Handle::destroyed";
		1883	}
		1884
		1885	sub AnyEvent::Handle::destroyed::AUTOLOAD {
		1886	#nop
1691	}	1887	}
1692		1888
1693	=item AnyEvent::Handle::TLS_CTX	1889	=item AnyEvent::Handle::TLS_CTX
1694		1890
1695	This function creates and returns the AnyEvent::TLS object used by default	1891	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.154 by root, Sat Jul 18 05:19:09 2009 UTC vs. Revision 1.181 by root, Tue Sep 1 10:40:05 2009 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.154 by root, Sat Jul 18 05:19:09 2009 UTC vs.
Revision 1.181 by root, Tue Sep 1 10:40:05 2009 UTC