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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.158 by root, Fri Jul 24 08:40:35 2009 UTC vs.
Revision 1.179 by root, Wed Aug 12 15:50:44 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.86;
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]
73
74	#=item fh => $filehandle [C<fh> or C<connect> MANDATORY]	75	=item fh => $filehandle [C<fh> or C<connect> MANDATORY]
75		76
76	The filehandle this L<AnyEvent::Handle> object will operate on.	77	The filehandle this L<AnyEvent::Handle> object will operate on.
77	NOTE: The filehandle will be set to non-blocking mode (using	78	NOTE: The filehandle will be set to non-blocking mode (using
78	C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in	79	C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in
79	that mode.	80	that mode.
80		81
81	#=item connect => [$host, $service]	82	=item connect => [$host, $service] [C<fh> or C<connect> MANDATORY]
82	#	83
83	# You have to specify either this parameter, or C<connect>, below.
84	#Try to connect to the specified host and service (port), using	84	Try to connect to the specified host and service (port), using
85	#C<AnyEvent::Socket::tcp_connect>.	85	C<AnyEvent::Socket::tcp_connect>. The C<$host> additionally becomes the
86	#	86	default C<peername>.
87	#When this	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.
88		190
89	=item on_eof => $cb->($handle)	191	=item on_eof => $cb->($handle)
90		192
91	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,
92	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
…		…
100	down.	202	down.
101		203
102	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
103	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>.
104		206
105	=item on_error => $cb->($handle, $fatal, $message)
106
107	This is the error callback, which is called when, well, some error
108	occured, such as not being able to resolve the hostname, failure to
109	connect or a read error.
110
111	Some errors are fatal (which is indicated by C<$fatal> being true). On
112	fatal errors the handle object will be destroyed (by a call to C<< ->
113	destroy >>) after invoking the error callback (which means you are free to
114	examine the handle object). Examples of fatal errors are an EOF condition
115	with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors.
116
117	AnyEvent::Handle tries to find an appropriate error code for you to check
118	against, but in some cases (TLS errors), this does not work well. It is
119	recommended to always output the C<$message> argument in human-readable
120	error messages (it's usually the same as C<"$!">).
121
122	Non-fatal errors can be retried by simply returning, but it is recommended
123	to simply ignore this parameter and instead abondon the handle object
124	when this callback is invoked. Examples of non-fatal errors are timeouts
125	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
126
127	On callback entrance, the value of C<$!> contains the operating system
128	error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
129	C<EPROTO>).
130
131	While not mandatory, it is I<highly> recommended to set this callback, as
132	you will not be notified of errors otherwise. The default simply calls
133	C<croak>.
134
135	=item on_read => $cb->($handle)
136
137	This sets the default read callback, which is called when data arrives
138	and no read request is in the queue (unlike read queue callbacks, this
139	callback will only be called when at least one octet of data is in the
140	read buffer).
141
142	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
143	method or access the C<< $handle->{rbuf} >> member directly. Note that you
144	must not enlarge or modify the read buffer, you can only remove data at
145	the beginning from it.
146
147	When an EOF condition is detected then AnyEvent::Handle will first try to
148	feed all the remaining data to the queued callbacks and C<on_read> before
149	calling the C<on_eof> callback. If no progress can be made, then a fatal
150	error will be raised (with C<$!> set to C<EPIPE>).
151
152	Note that, unlike requests in the read queue, an C<on_read> callback
153	doesn't mean you I<require> some data: if there is an EOF and there
154	are outstanding read requests then an error will be flagged. With an
155	C<on_read> callback, the C<on_eof> callback will be invoked.
156
157	=item on_drain => $cb->($handle)	207	=item on_drain => $cb->($handle)
158		208
159	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
160	(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).
161		211
…		…
167	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
168	the file when the write queue becomes empty.	218	the file when the write queue becomes empty.
169		219
170	=item timeout => $fractional_seconds	220	=item timeout => $fractional_seconds
171		221
		222	=item rtimeout => $fractional_seconds
		223
		224	=item wtimeout => $fractional_seconds
		225
172	If non-zero, then this enables an "inactivity" timeout: whenever this many	226	If non-zero, then these enables an "inactivity" timeout: whenever this
173	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
174	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
175	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>.
176		237
177	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
178	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
179	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
180	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
…		…
359		420
360	sub new {	421	sub new {
361	my $class = shift;	422	my $class = shift;
362	my $self = bless { @_ }, $class;	423	my $self = bless { @_ }, $class;
363		424
364	$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) = @_;
365		488
366	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	489	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
367		490
		491	$self->{_activity} =
		492	$self->{_ractivity} =
368	$self->{_activity} = AnyEvent->now;	493	$self->{_wactivity} = AE::now;
369	$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};
370		498
371	$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};
372		500
373	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})	501	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
374	if $self->{tls};	502	if $self->{tls};
375		503
376	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	504	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
377		505
378	$self->start_read	506	$self->start_read
379	if $self->{on_read};	507	if $self->{on_read} \|\| @{ $self->{_queue} };
380		508
381	$self->{fh} && $self	509	$self->_drain_wbuf;
382	}	510	}
383
384	#sub _shutdown {
385	# my ($self) = @_;
386	#
387	# delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)};
388	# $self->{_eof} = 1; # tell starttls et. al to stop trying
389	#
390	# &_freetls;
391	#}
392		511
393	sub _error {	512	sub _error {
394	my ($self, $errno, $fatal, $message) = @_;	513	my ($self, $errno, $fatal, $message) = @_;
395		514
396	$! = $errno;	515	$! = $errno;
…		…
433	$_[0]{on_eof} = $_[1];	552	$_[0]{on_eof} = $_[1];
434	}	553	}
435		554
436	=item $handle->on_timeout ($cb)	555	=item $handle->on_timeout ($cb)
437		556
438	Replace the current C<on_timeout> callback, or disables the callback (but	557	=item $handle->on_rtimeout ($cb)
439	not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
440	argument and method.
441		558
442	=cut	559	=item $handle->on_wtimeout ($cb)
443		560
444	sub on_timeout {	561	Replace the current C<on_timeout>, C<on_rtimeout> or C<on_wtimeout>
445	$_[0]{on_timeout} = $_[1];	562	callback, or disables the callback (but not the timeout) if C<$cb> =
446	}	563	C<undef>. See the C<timeout> constructor argument and method.
		564
		565	=cut
		566
		567	# see below
447		568
448	=item $handle->autocork ($boolean)	569	=item $handle->autocork ($boolean)
449		570
450	Enables or disables the current autocork behaviour (see C<autocork>	571	Enables or disables the current autocork behaviour (see C<autocork>
451	constructor argument). Changes will only take effect on the next write.	572	constructor argument). Changes will only take effect on the next write.
…		…
466	sub no_delay {	587	sub no_delay {
467	$_[0]{no_delay} = $_[1];	588	$_[0]{no_delay} = $_[1];
468		589
469	eval {	590	eval {
470	local $SIG{__DIE__};	591	local $SIG{__DIE__};
471	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};
472	};	594	};
473	}	595	}
474		596
475	=item $handle->on_starttls ($cb)	597	=item $handle->on_starttls ($cb)
476		598
…		…
490		612
491	sub on_starttls {	613	sub on_starttls {
492	$_[0]{on_stoptls} = $_[1];	614	$_[0]{on_stoptls} = $_[1];
493	}	615	}
494		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
495	#############################################################################	627	#############################################################################
496		628
497	=item $handle->timeout ($seconds)	629	=item $handle->timeout ($seconds)
498		630
		631	=item $handle->rtimeout ($seconds)
		632
		633	=item $handle->wtimeout ($seconds)
		634
499	Configures (or disables) the inactivity timeout.	635	Configures (or disables) the inactivity timeout.
500		636
501	=cut	637	=item $handle->timeout_reset
502		638
503	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 {
504	my ($self, $timeout) = @_;	661	my ($self, $new_value) = @_;
505		662
506	$self->{timeout} = $timeout;	663	$self->{$timeout} = $new_value;
507	$self->_timeout;	664	delete $self->{$tw}; &$cb;
508	}	665	};
509		666
		667	*{"${dir}timeout_reset"} = sub {
		668	$_[0]{$activity} = AE::now;
		669	};
		670
		671	# main workhorse:
510	# reset the timeout watcher, as neccessary	672	# reset the timeout watcher, as neccessary
511	# also check for time-outs	673	# also check for time-outs
512	sub _timeout {	674	$cb = sub {
513	my ($self) = @_;	675	my ($self) = @_;
514		676
515	if ($self->{timeout}) {	677	if ($self->{$timeout} && $self->{fh}) {
516	my $NOW = AnyEvent->now;	678	my $NOW = AE::now;
517		679
518	# when would the timeout trigger?	680	# when would the timeout trigger?
519	my $after = $self->{_activity} + $self->{timeout} - $NOW;	681	my $after = $self->{$activity} + $self->{$timeout} - $NOW;
520		682
521	# now or in the past already?	683	# now or in the past already?
522	if ($after <= 0) {	684	if ($after <= 0) {
523	$self->{_activity} = $NOW;	685	$self->{$activity} = $NOW;
524		686
525	if ($self->{on_timeout}) {	687	if ($self->{$on_timeout}) {
526	$self->{on_timeout}($self);	688	$self->{$on_timeout}($self);
527	} else {	689	} else {
528	$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};
529	}	698	}
530		699
531	# callback could have changed timeout value, optimise	700	Scalar::Util::weaken $self;
532	return unless $self->{timeout};	701	return unless $self; # ->error could have destroyed $self
533		702
534	# calculate new after	703	$self->{$tw} \|\|= AE::timer $after, 0, sub {
535	$after = $self->{timeout};	704	delete $self->{$tw};
		705	$cb->($self);
		706	};
		707	} else {
		708	delete $self->{$tw};
536	}	709	}
537
538	Scalar::Util::weaken $self;
539	return unless $self; # ->error could have destroyed $self
540
541	$self->{_tw} \|\|= AnyEvent->timer (after => $after, cb => sub {
542	delete $self->{_tw};
543	$self->_timeout;
544	});
545	} else {
546	delete $self->{_tw};
547	}	710	}
548	}	711	}
549		712
550	#############################################################################	713	#############################################################################
551		714
…		…
599	my $len = syswrite $self->{fh}, $self->{wbuf};	762	my $len = syswrite $self->{fh}, $self->{wbuf};
600		763
601	if (defined $len) {	764	if (defined $len) {
602	substr $self->{wbuf}, 0, $len, "";	765	substr $self->{wbuf}, 0, $len, "";
603		766
604	$self->{_activity} = AnyEvent->now;	767	$self->{_activity} = $self->{_wactivity} = AE::now;
605		768
606	$self->{on_drain}($self)	769	$self->{on_drain}($self)
607	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})
608	&& $self->{on_drain};	771	&& $self->{on_drain};
609		772
…		…
615		778
616	# try to write data immediately	779	# try to write data immediately
617	$cb->() unless $self->{autocork};	780	$cb->() unless $self->{autocork};
618		781
619	# if still data left in wbuf, we need to poll	782	# if still data left in wbuf, we need to poll
620	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	783	$self->{_ww} = AE::io $self->{fh}, 1, $cb
621	if length $self->{wbuf};	784	if length $self->{wbuf};
622	};	785	};
623	}	786	}
624		787
625	our %WH;	788	our %WH;
…		…
638	->($self, @_);	801	->($self, @_);
639	}	802	}
640		803
641	if ($self->{tls}) {	804	if ($self->{tls}) {
642	$self->{_tls_wbuf} .= $_[0];	805	$self->{_tls_wbuf} .= $_[0];
643		806	&_dotls ($self) if $self->{fh};
644	&_dotls ($self);
645	} else {	807	} else {
646	$self->{wbuf} .= $_[0];	808	$self->{wbuf} .= $_[0];
647	$self->_drain_wbuf;	809	$self->_drain_wbuf if $self->{fh};
648	}	810	}
649	}	811	}
650		812
651	=item $handle->push_write (type => @args)	813	=item $handle->push_write (type => @args)
652		814
…		…
716	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
717	this line into their JSON decoder of choice.	879	this line into their JSON decoder of choice.
718		880
719	=cut	881	=cut
720		882
		883	sub json_coder() {
		884	eval { require JSON::XS; JSON::XS->new->utf8 }
		885	\|\| do { require JSON; JSON->new->utf8 }
		886	}
		887
721	register_write_type json => sub {	888	register_write_type json => sub {
722	my ($self, $ref) = @_;	889	my ($self, $ref) = @_;
723		890
724	require JSON;	891	my $json = $self->{json} \|\|= json_coder;
725		892
726	$self->{json} ? $self->{json}->encode ($ref)	893	$json->encode ($ref)
727	: JSON::encode_json ($ref)
728	};	894	};
729		895
730	=item storable => $reference	896	=item storable => $reference
731		897
732	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
…		…
869	=cut	1035	=cut
870		1036
871	sub _drain_rbuf {	1037	sub _drain_rbuf {
872	my ($self) = @_;	1038	my ($self) = @_;
873		1039
		1040	# avoid recursion
		1041	return if $self->{_skip_drain_rbuf};
874	local $self->{_in_drain} = 1;	1042	local $self->{_skip_drain_rbuf} = 1;
875
876	if (
877	defined $self->{rbuf_max}
878	&& $self->{rbuf_max} < length $self->{rbuf}
879	) {
880	$self->_error (Errno::ENOSPC, 1), return;
881	}
882		1043
883	while () {	1044	while () {
884	# 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
885	# 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.
886	$self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf};	1047	$self->{rbuf} .= delete $self->{_tls_rbuf}
		1048	if exists $self->{_tls_rbuf};
887		1049
888	my $len = length $self->{rbuf};	1050	my $len = length $self->{rbuf};
889		1051
890	if (my $cb = shift @{ $self->{_queue} }) {	1052	if (my $cb = shift @{ $self->{_queue} }) {
891	unless ($cb->($self)) {	1053	unless ($cb->($self)) {
892	if ($self->{_eof}) {	1054	# no progress can be made
893	# no progress can be made (not enough data and no data forthcoming)	1055	# (not enough data and no data forthcoming)
894	$self->_error (Errno::EPIPE, 1), return;	1056	$self->_error (Errno::EPIPE, 1), return
895	}	1057	if $self->{_eof};
896		1058
897	unshift @{ $self->{_queue} }, $cb;	1059	unshift @{ $self->{_queue} }, $cb;
898	last;	1060	last;
899	}	1061	}
900	} elsif ($self->{on_read}) {	1062	} elsif ($self->{on_read}) {
…		…
920	last;	1082	last;
921	}	1083	}
922	}	1084	}
923		1085
924	if ($self->{_eof}) {	1086	if ($self->{_eof}) {
925	if ($self->{on_eof}) {	1087	$self->{on_eof}
926	$self->{on_eof}($self)	1088	? $self->{on_eof}($self)
927	} else {
928	$self->_error (0, 1, "Unexpected end-of-file");	1089	: $self->_error (0, 1, "Unexpected end-of-file");
929	}	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;
930	}	1099	}
931		1100
932	# may need to restart read watcher	1101	# may need to restart read watcher
933	unless ($self->{_rw}) {	1102	unless ($self->{_rw}) {
934	$self->start_read	1103	$self->start_read
…		…
946		1115
947	sub on_read {	1116	sub on_read {
948	my ($self, $cb) = @_;	1117	my ($self, $cb) = @_;
949		1118
950	$self->{on_read} = $cb;	1119	$self->{on_read} = $cb;
951	$self->_drain_rbuf if $cb && !$self->{_in_drain};	1120	$self->_drain_rbuf if $cb;
952	}	1121	}
953		1122
954	=item $handle->rbuf	1123	=item $handle->rbuf
955		1124
956	Returns the read buffer (as a modifiable lvalue).	1125	Returns the read buffer (as a modifiable lvalue).
…		…
1008	$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")
1009	->($self, $cb, @_);	1178	->($self, $cb, @_);
1010	}	1179	}
1011		1180
1012	push @{ $self->{_queue} }, $cb;	1181	push @{ $self->{_queue} }, $cb;
1013	$self->_drain_rbuf unless $self->{_in_drain};	1182	$self->_drain_rbuf;
1014	}	1183	}
1015		1184
1016	sub unshift_read {	1185	sub unshift_read {
1017	my $self = shift;	1186	my $self = shift;
1018	my $cb = pop;	1187	my $cb = pop;
…		…
1024	->($self, $cb, @_);	1193	->($self, $cb, @_);
1025	}	1194	}
1026		1195
1027		1196
1028	unshift @{ $self->{_queue} }, $cb;	1197	unshift @{ $self->{_queue} }, $cb;
1029	$self->_drain_rbuf unless $self->{_in_drain};	1198	$self->_drain_rbuf;
1030	}	1199	}
1031		1200
1032	=item $handle->push_read (type => @args, $cb)	1201	=item $handle->push_read (type => @args, $cb)
1033		1202
1034	=item $handle->unshift_read (type => @args, $cb)	1203	=item $handle->unshift_read (type => @args, $cb)
…		…
1283	=cut	1452	=cut
1284		1453
1285	register_read_type json => sub {	1454	register_read_type json => sub {
1286	my ($self, $cb) = @_;	1455	my ($self, $cb) = @_;
1287		1456
1288	my $json = $self->{json} \|\|=	1457	my $json = $self->{json} \|\|= json_coder;
1289	eval { require JSON::XS; JSON::XS->new->utf8 }
1290	\|\| do { require JSON; JSON->new->utf8 };
1291		1458
1292	my $data;	1459	my $data;
1293	my $rbuf = \$self->{rbuf};	1460	my $rbuf = \$self->{rbuf};
1294		1461
1295	sub {	1462	sub {
…		…
1415	my ($self) = @_;	1582	my ($self) = @_;
1416		1583
1417	unless ($self->{_rw} \|\| $self->{_eof}) {	1584	unless ($self->{_rw} \|\| $self->{_eof}) {
1418	Scalar::Util::weaken $self;	1585	Scalar::Util::weaken $self;
1419		1586
1420	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1587	$self->{_rw} = AE::io $self->{fh}, 0, sub {
1421	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});	1588	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1422	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;
1423		1590
1424	if ($len > 0) {	1591	if ($len > 0) {
1425	$self->{_activity} = AnyEvent->now;	1592	$self->{_activity} = $self->{_ractivity} = AE::now;
1426		1593
1427	if ($self->{tls}) {	1594	if ($self->{tls}) {
1428	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);	1595	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1429		1596
1430	&_dotls ($self);	1597	&_dotls ($self);
1431	} else {	1598	} else {
1432	$self->_drain_rbuf unless $self->{_in_drain};	1599	$self->_drain_rbuf;
1433	}	1600	}
1434		1601
1435	} elsif (defined $len) {	1602	} elsif (defined $len) {
1436	delete $self->{_rw};	1603	delete $self->{_rw};
1437	$self->{_eof} = 1;	1604	$self->{_eof} = 1;
1438	$self->_drain_rbuf unless $self->{_in_drain};	1605	$self->_drain_rbuf;
1439		1606
1440	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1607	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1441	return $self->_error ($!, 1);	1608	return $self->_error ($!, 1);
1442	}	1609	}
1443	});	1610	};
1444	}	1611	}
1445	}	1612	}
1446		1613
1447	our $ERROR_SYSCALL;	1614	our $ERROR_SYSCALL;
1448	our $ERROR_WANT_READ;	1615	our $ERROR_WANT_READ;
…		…
1503	$self->{_eof} = 1;	1670	$self->{_eof} = 1;
1504	}	1671	}
1505	}	1672	}
1506		1673
1507	$self->{_tls_rbuf} .= $tmp;	1674	$self->{_tls_rbuf} .= $tmp;
1508	$self->_drain_rbuf unless $self->{_in_drain};	1675	$self->_drain_rbuf;
1509	$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
1510	}	1677	}
1511		1678
1512	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);	1679	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1513	return $self->_tls_error ($tmp)	1680	return $self->_tls_error ($tmp)
…		…
1545	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
1546	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
1547	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
1548	when this function returns.	1715	when this function returns.
1549		1716
1550	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
1551	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.
1552		1720
1553	=cut	1721	=cut
1554		1722
1555	our %TLS_CACHE; #TODO not yet documented, should we?	1723	our %TLS_CACHE; #TODO not yet documented, should we?
1556		1724
1557	sub starttls {	1725	sub starttls {
1558	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};
1559		1735
1560	require Net::SSLeay;	1736	require Net::SSLeay;
1561
1562	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"
1563	if $self->{tls};
1564		1737
1565	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();	1738	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1566	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();	1739	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1567		1740
		1741	$tls = $self->{tls};
1568	$ctx \|\|= $self->{tls_ctx};	1742	$ctx = $self->{tls_ctx};
1569		1743
1570	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session	1744	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
1571		1745
1572	if ("HASH" eq ref $ctx) {	1746	if ("HASH" eq ref $ctx) {
1573	require AnyEvent::TLS;	1747	require AnyEvent::TLS;
…		…
1579	$ctx = new AnyEvent::TLS %$ctx;	1753	$ctx = new AnyEvent::TLS %$ctx;
1580	}	1754	}
1581	}	1755	}
1582		1756
1583	$self->{tls_ctx} = $ctx \|\| TLS_CTX ();	1757	$self->{tls_ctx} = $ctx \|\| TLS_CTX ();
1584	$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});
1585		1759
1586	# 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)
1587	# but the openssl maintainers basically said: "trust us, it just works".	1761	# but the openssl maintainers basically said: "trust us, it just works".
1588	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1762	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1589	# and mismaintained ssleay-module doesn't even offer them).	1763	# and mismaintained ssleay-module doesn't even offer them).
…		…
1596	# 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
1597	# have identity issues in that area.	1771	# have identity issues in that area.
1598	# Net::SSLeay::CTX_set_mode ($ssl,	1772	# Net::SSLeay::CTX_set_mode ($ssl,
1599	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1773	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
1600	# \| (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));
1601	Net::SSLeay::CTX_set_mode ($ssl, 1\|2);	1775	Net::SSLeay::CTX_set_mode ($tls, 1\|2);
1602		1776
1603	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1777	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1604	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1778	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1605		1779
		1780	Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf});
		1781
1606	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1782	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
1607		1783
1608	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }	1784	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1609	if $self->{on_starttls};	1785	if $self->{on_starttls};
1610		1786
1611	&_dotls; # need to trigger the initial handshake	1787	&_dotls; # need to trigger the initial handshake
…		…
1614		1790
1615	=item $handle->stoptls	1791	=item $handle->stoptls
1616		1792
1617	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
1618	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
1619	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
1620	afterwards.	1796	the stream afterwards.
1621		1797
1622	=cut	1798	=cut
1623		1799
1624	sub stoptls {	1800	sub stoptls {
1625	my ($self) = @_;	1801	my ($self) = @_;
…		…
1638	sub _freetls {	1814	sub _freetls {
1639	my ($self) = @_;	1815	my ($self) = @_;
1640		1816
1641	return unless $self->{tls};	1817	return unless $self->{tls};
1642		1818
1643	$self->{tls_ctx}->_put_session (delete $self->{tls});	1819	$self->{tls_ctx}->_put_session (delete $self->{tls})
		1820	if $self->{tls} > 0;
1644		1821
1645	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};	1822	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1646	}	1823	}
1647		1824
1648	sub DESTROY {	1825	sub DESTROY {
…		…
1656	my $fh = delete $self->{fh};	1833	my $fh = delete $self->{fh};
1657	my $wbuf = delete $self->{wbuf};	1834	my $wbuf = delete $self->{wbuf};
1658		1835
1659	my @linger;	1836	my @linger;
1660		1837
1661	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {	1838	push @linger, AE::io $fh, 1, sub {
1662	my $len = syswrite $fh, $wbuf, length $wbuf;	1839	my $len = syswrite $fh, $wbuf, length $wbuf;
1663		1840
1664	if ($len > 0) {	1841	if ($len > 0) {
1665	substr $wbuf, 0, $len, "";	1842	substr $wbuf, 0, $len, "";
1666	} else {	1843	} else {
1667	@linger = (); # end	1844	@linger = (); # end
1668	}	1845	}
1669	});	1846	};
1670	push @linger, AnyEvent->timer (after => $linger, cb => sub {	1847	push @linger, AE::timer $linger, 0, sub {
1671	@linger = ();	1848	@linger = ();
1672	});	1849	};
1673	}	1850	}
1674	}	1851	}
1675		1852
1676	=item $handle->destroy	1853	=item $handle->destroy
1677		1854
1678	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
1679	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
1680	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).
1681		1860
1682	Normally, you can just "forget" any references to an AnyEvent::Handle	1861	Normally, you can just "forget" any references to an AnyEvent::Handle
1683	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
1684	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
1685	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
…		…
1699	sub destroy {	1878	sub destroy {
1700	my ($self) = @_;	1879	my ($self) = @_;
1701		1880
1702	$self->DESTROY;	1881	$self->DESTROY;
1703	%$self = ();	1882	%$self = ();
		1883	bless $self, "AnyEvent::Handle::destroyed";
		1884	}
		1885
		1886	sub AnyEvent::Handle::destroyed::AUTOLOAD {
		1887	#nop
1704	}	1888	}
1705		1889
1706	=item AnyEvent::Handle::TLS_CTX	1890	=item AnyEvent::Handle::TLS_CTX
1707		1891
1708	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.158 by root, Fri Jul 24 08:40:35 2009 UTC vs. Revision 1.179 by root, Wed Aug 12 15:50:44 2009 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.158 by root, Fri Jul 24 08:40:35 2009 UTC vs.
Revision 1.179 by root, Wed Aug 12 15:50:44 2009 UTC