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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.159 by root, Fri Jul 24 12:35:58 2009 UTC vs.
Revision 1.195 by root, Sat Jun 5 09:08:14 2010 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 streaming 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;
27	on_error => sub {	14	on_error => sub {
28	my ($hdl, $fatal, $msg) = @_;	15	my ($hdl, $fatal, $msg) = @_;
29	warn "got error $msg\n";	16	warn "got error $msg\n";
30	$hdl->destroy;	17	$hdl->destroy;
31	$cv->send;	18	$cv->send;
32	);	19	};
33		20
34	# send some request line	21	# send some request line
35	$hdl->push_write ("getinfo\015\012");	22	$hdl->push_write ("getinfo\015\012");
36		23
37	# read the response line	24	# read the response line
…		…
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.	36	stream-based filehandles (sockets, pipes or other stream things).
50		37
51	The L<AnyEvent::Intro> tutorial contains some well-documented	38	The L<AnyEvent::Intro> tutorial contains some well-documented
52	AnyEvent::Handle examples.	39	AnyEvent::Handle examples.
53		40
54	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	C<on_error> callback.	46	C<on_error> callback.
60		47
61	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
62	argument.	49	argument.
63		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	sub _load_func($) {
		66	my $func = $_[0];
		67
		68	unless (defined &$func) {
		69	my $pkg = $func;
		70	do {
		71	$pkg =~ s/::[^:]+$//
		72	or return;
		73	eval "require $pkg";
		74	} until defined &$func;
		75	}
		76
		77	\&$func
		78	}
		79
64	=head1 METHODS	80	=head1 METHODS
65		81
66	=over 4	82	=over 4
67		83
68	=item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value...	84	=item $handle = B<new> AnyEvent::Handle fh => $filehandle, key => value...
69		85
70	The constructor supports these arguments (all as C<< key => value >> pairs).	86	The constructor supports these arguments (all as C<< key => value >> pairs).
71		87
72	=over 4	88	=over 4
73		89
…		…
83	Try to connect to the specified host and service (port), using	99	Try to connect to the specified host and service (port), using
84	C<AnyEvent::Socket::tcp_connect>. The C<$host> additionally becomes the	100	C<AnyEvent::Socket::tcp_connect>. The C<$host> additionally becomes the
85	default C<peername>.	101	default C<peername>.
86		102
87	You have to specify either this parameter, or C<fh>, above.	103	You have to specify either this parameter, or C<fh>, above.
		104
		105	It is possible to push requests on the read and write queues, and modify
		106	properties of the stream, even while AnyEvent::Handle is connecting.
88		107
89	When this parameter is specified, then the C<on_prepare>,	108	When this parameter is specified, then the C<on_prepare>,
90	C<on_connect_error> and C<on_connect> callbacks will be called under the	109	C<on_connect_error> and C<on_connect> callbacks will be called under the
91	appropriate circumstances:	110	appropriate circumstances:
92		111
…		…
98	attempted, but after the file handle has been created. It could be used to	117	attempted, but after the file handle has been created. It could be used to
99	prepare the file handle with parameters required for the actual connect	118	prepare the file handle with parameters required for the actual connect
100	(as opposed to settings that can be changed when the connection is already	119	(as opposed to settings that can be changed when the connection is already
101	established).	120	established).
102		121
		122	The return value of this callback should be the connect timeout value in
		123	seconds (or C<0>, or C<undef>, or the empty list, to indicate the default
		124	timeout is to be used).
		125
103	=item on_connect => $cb->($handle, $host, $port, $retry->())	126	=item on_connect => $cb->($handle, $host, $port, $retry->())
104		127
105	This callback is called when a connection has been successfully established.	128	This callback is called when a connection has been successfully established.
106		129
107	The actual numeric host and port (the socket peername) are passed as	130	The actual numeric host and port (the socket peername) are passed as
108	parameters, together with a retry callback.	131	parameters, together with a retry callback.
109		132
110	When, for some reason, the handle is not acceptable, then calling	133	When, for some reason, the handle is not acceptable, then calling
111	C<$retry> will continue with the next conenction target (in case of	134	C<$retry> will continue with the next connection target (in case of
112	multi-homed hosts or SRV records there can be multiple connection	135	multi-homed hosts or SRV records there can be multiple connection
113	endpoints). When it is called then the read and write queues, eof status,	136	endpoints). At the time it is called the read and write queues, eof
114	tls status and similar properties of the handle are being reset.	137	status, tls status and similar properties of the handle will have been
		138	reset.
115		139
116	In most cases, ignoring the C<$retry> parameter is the way to go.	140	In most cases, ignoring the C<$retry> parameter is the way to go.
117		141
118	=item on_connect_error => $cb->($handle, $message)	142	=item on_connect_error => $cb->($handle, $message)
119		143
120	This callback is called when the conenction could not be	144	This callback is called when the connection could not be
121	established. C<$!> will contain the relevant error code, and C<$message> a	145	established. C<$!> will contain the relevant error code, and C<$message> a
122	message describing it (usually the same as C<"$!">).	146	message describing it (usually the same as C<"$!">).
123		147
124	If this callback isn't specified, then C<on_error> will be called with a	148	If this callback isn't specified, then C<on_error> will be called with a
125	fatal error instead.	149	fatal error instead.
…		…
209	memory and push it into the queue, but instead only read more data from	233	memory and push it into the queue, but instead only read more data from
210	the file when the write queue becomes empty.	234	the file when the write queue becomes empty.
211		235
212	=item timeout => $fractional_seconds	236	=item timeout => $fractional_seconds
213		237
		238	=item rtimeout => $fractional_seconds
		239
		240	=item wtimeout => $fractional_seconds
		241
214	If non-zero, then this enables an "inactivity" timeout: whenever this many	242	If non-zero, then these enables an "inactivity" timeout: whenever this
215	seconds pass without a successful read or write on the underlying file	243	many seconds pass without a successful read or write on the underlying
216	handle, the C<on_timeout> callback will be invoked (and if that one is	244	file handle (or a call to C<timeout_reset>), the C<on_timeout> callback
217	missing, a non-fatal C<ETIMEDOUT> error will be raised).	245	will be invoked (and if that one is missing, a non-fatal C<ETIMEDOUT>
		246	error will be raised).
		247
		248	There are three variants of the timeouts that work fully independent
		249	of each other, for both read and write, just read, and just write:
		250	C<timeout>, C<rtimeout> and C<wtimeout>, with corresponding callbacks
		251	C<on_timeout>, C<on_rtimeout> and C<on_wtimeout>, and reset functions
		252	C<timeout_reset>, C<rtimeout_reset>, and C<wtimeout_reset>.
218		253
219	Note that timeout processing is also active when you currently do not have	254	Note that timeout processing is also active when you currently do not have
220	any outstanding read or write requests: If you plan to keep the connection	255	any outstanding read or write requests: If you plan to keep the connection
221	idle then you should disable the timout temporarily or ignore the timeout	256	idle then you should disable the timout temporarily or ignore the timeout
222	in the C<on_timeout> callback, in which case AnyEvent::Handle will simply	257	in the C<on_timeout> callback, in which case AnyEvent::Handle will simply
…		…
266	accomplishd by setting this option to a true value.	301	accomplishd by setting this option to a true value.
267		302
268	The default is your opertaing system's default behaviour (most likely	303	The default is your opertaing system's default behaviour (most likely
269	enabled), this option explicitly enables or disables it, if possible.	304	enabled), this option explicitly enables or disables it, if possible.
270		305
		306	=item keepalive => <boolean>
		307
		308	Enables (default disable) the SO_KEEPALIVE option on the stream socket:
		309	normally, TCP connections have no time-out once established, so TCP
		310	connections, once established, can stay alive forever even when the other
		311	side has long gone. TCP keepalives are a cheap way to take down long-lived
		312	TCP connections whent he other side becomes unreachable. While the default
		313	is OS-dependent, TCP keepalives usually kick in after around two hours,
		314	and, if the other side doesn't reply, take down the TCP connection some 10
		315	to 15 minutes later.
		316
		317	It is harmless to specify this option for file handles that do not support
		318	keepalives, and enabling it on connections that are potentially long-lived
		319	is usually a good idea.
		320
		321	=item oobinline => <boolean>
		322
		323	BSD majorly fucked up the implementation of TCP urgent data. The result
		324	is that almost no OS implements TCP according to the specs, and every OS
		325	implements it slightly differently.
		326
		327	If you want to handle TCP urgent data, then setting this flag (the default
		328	is enabled) gives you the most portable way of getting urgent data, by
		329	putting it into the stream.
		330
		331	Since BSD emulation of OOB data on top of TCP's urgent data can have
		332	security implications, AnyEvent::Handle sets this flag automatically
		333	unless explicitly specified. Note that setting this flag after
		334	establishing a connection I<may> be a bit too late (data loss could
		335	already have occured on BSD systems), but at least it will protect you
		336	from most attacks.
		337
271	=item read_size => <bytes>	338	=item read_size => <bytes>
272		339
273	The default read block size (the amount of bytes this module will	340	The default read block size (the amount of bytes this module will
274	try to read during each loop iteration, which affects memory	341	try to read during each loop iteration, which affects memory
275	requirements). Default: C<8192>.	342	requirements). Default: C<8192>.
…		…
308	C<undef>.	375	C<undef>.
309		376
310	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	377	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
311		378
312	When this parameter is given, it enables TLS (SSL) mode, that means	379	When this parameter is given, it enables TLS (SSL) mode, that means
313	AnyEvent will start a TLS handshake as soon as the conenction has been	380	AnyEvent will start a TLS handshake as soon as the connection has been
314	established and will transparently encrypt/decrypt data afterwards.	381	established and will transparently encrypt/decrypt data afterwards.
315		382
316	All TLS protocol errors will be signalled as C<EPROTO>, with an	383	All TLS protocol errors will be signalled as C<EPROTO>, with an
317	appropriate error message.	384	appropriate error message.
318		385
…		…
431	delete $self->{_skip_drain_rbuf};	498	delete $self->{_skip_drain_rbuf};
432	$self->_start;	499	$self->_start;
433		500
434	$self->{on_connect}	501	$self->{on_connect}
435	and $self->{on_connect}($self, $host, $port, sub {	502	and $self->{on_connect}($self, $host, $port, sub {
436	delete @$self{qw(fh _tw _ww _rw _eof _queue rbuf _wbuf tls _tls_rbuf _tls_wbuf)};	503	delete @$self{qw(fh _tw _rtw _wtw _ww _rw _eof _queue rbuf _wbuf tls _tls_rbuf _tls_wbuf)};
437	$self->{_skip_drain_rbuf} = 1;	504	$self->{_skip_drain_rbuf} = 1;
438	&$retry;	505	&$retry;
439	});	506	});
440		507
441	} else {	508	} else {
442	if ($self->{on_connect_error}) {	509	if ($self->{on_connect_error}) {
443	$self->{on_connect_error}($self, "$!");	510	$self->{on_connect_error}($self, "$!");
444	$self->destroy;	511	$self->destroy;
445	} else {	512	} else {
446	$self->fatal ($!, 1);	513	$self->_error ($!, 1);
447	}	514	}
448	}	515	}
449	},	516	},
450	sub {	517	sub {
451	local $self->{fh} = $_[0];	518	local $self->{fh} = $_[0];
452		519
		520	$self->{on_prepare}
453	$self->{on_prepare}->($self)	521	? $self->{on_prepare}->($self)
454	if $self->{on_prepare};	522	: ()
455	}	523	}
456	);	524	);
457	}	525	}
458		526
459	} else {	527	} else {
…		…
464	}	532	}
465		533
466	sub _start {	534	sub _start {
467	my ($self) = @_;	535	my ($self) = @_;
468		536
		537	# too many clueless people try to use udp and similar sockets
		538	# with AnyEvent::Handle, do them a favour.
		539	my $type = getsockopt $self->{fh}, Socket::SOL_SOCKET (), Socket::SO_TYPE ();
		540	Carp::croak "AnyEvent::Handle: only stream sockets supported, anything else will NOT work!"
		541	if Socket::SOCK_STREAM != (unpack "I", $type) && defined $type;
		542
469	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	543	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
470		544
		545	$self->{_activity} =
		546	$self->{_ractivity} =
471	$self->{_activity} = AnyEvent->now;	547	$self->{_wactivity} = AE::now;
472	$self->_timeout;
473		548
		549	$self->timeout (delete $self->{timeout} ) if $self->{timeout};
		550	$self->rtimeout (delete $self->{rtimeout} ) if $self->{rtimeout};
		551	$self->wtimeout (delete $self->{wtimeout} ) if $self->{wtimeout};
		552
474	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};	553	$self->no_delay (delete $self->{no_delay} ) if exists $self->{no_delay} && $self->{no_delay};
		554	$self->keepalive (delete $self->{keepalive}) if exists $self->{keepalive} && $self->{keepalive};
475		555
		556	$self->oobinline (exists $self->{oobinline} ? delete $self->{oobinline} : 1);
		557
476	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})	558	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
477	if $self->{tls};	559	if $self->{tls};
478		560
479	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	561	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
480		562
481	$self->start_read	563	$self->start_read
482	if $self->{on_read} \|\| @{ $self->{_queue} };	564	if $self->{on_read} \|\| @{ $self->{_queue} };
483	}
484		565
485	#sub _shutdown {	566	$self->_drain_wbuf;
486	# my ($self) = @_;	567	}
487	#
488	# delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)};
489	# $self->{_eof} = 1; # tell starttls et. al to stop trying
490	#
491	# &_freetls;
492	#}
493		568
494	sub _error {	569	sub _error {
495	my ($self, $errno, $fatal, $message) = @_;	570	my ($self, $errno, $fatal, $message) = @_;
496		571
497	$! = $errno;	572	$! = $errno;
498	$message \|\|= "$!";	573	$message \|\|= "$!";
499		574
500	if ($self->{on_error}) {	575	if ($self->{on_error}) {
501	$self->{on_error}($self, $fatal, $message);	576	$self->{on_error}($self, $fatal, $message);
502	$self->destroy if $fatal;	577	$self->destroy if $fatal;
503	} elsif ($self->{fh}) {	578	} elsif ($self->{fh} \|\| $self->{connect}) {
504	$self->destroy;	579	$self->destroy;
505	Carp::croak "AnyEvent::Handle uncaught error: $message";	580	Carp::croak "AnyEvent::Handle uncaught error: $message";
506	}	581	}
507	}	582	}
508		583
…		…
534	$_[0]{on_eof} = $_[1];	609	$_[0]{on_eof} = $_[1];
535	}	610	}
536		611
537	=item $handle->on_timeout ($cb)	612	=item $handle->on_timeout ($cb)
538		613
539	Replace the current C<on_timeout> callback, or disables the callback (but	614	=item $handle->on_rtimeout ($cb)
540	not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
541	argument and method.
542		615
543	=cut	616	=item $handle->on_wtimeout ($cb)
544		617
545	sub on_timeout {	618	Replace the current C<on_timeout>, C<on_rtimeout> or C<on_wtimeout>
546	$_[0]{on_timeout} = $_[1];	619	callback, or disables the callback (but not the timeout) if C<$cb> =
547	}	620	C<undef>. See the C<timeout> constructor argument and method.
		621
		622	=cut
		623
		624	# see below
548		625
549	=item $handle->autocork ($boolean)	626	=item $handle->autocork ($boolean)
550		627
551	Enables or disables the current autocork behaviour (see C<autocork>	628	Enables or disables the current autocork behaviour (see C<autocork>
552	constructor argument). Changes will only take effect on the next write.	629	constructor argument). Changes will only take effect on the next write.
…		…
567	sub no_delay {	644	sub no_delay {
568	$_[0]{no_delay} = $_[1];	645	$_[0]{no_delay} = $_[1];
569		646
570	eval {	647	eval {
571	local $SIG{__DIE__};	648	local $SIG{__DIE__};
572	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1]	649	setsockopt $_[0]{fh}, Socket::IPPROTO_TCP (), Socket::TCP_NODELAY (), int $_[1]
573	if $_[0]{fh};	650	if $_[0]{fh};
574	};	651	};
575	}	652	}
576		653
		654	=item $handle->keepalive ($boolean)
		655
		656	Enables or disables the C<keepalive> setting (see constructor argument of
		657	the same name for details).
		658
		659	=cut
		660
		661	sub keepalive {
		662	$_[0]{keepalive} = $_[1];
		663
		664	eval {
		665	local $SIG{__DIE__};
		666	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
		667	if $_[0]{fh};
		668	};
		669	}
		670
		671	=item $handle->oobinline ($boolean)
		672
		673	Enables or disables the C<oobinline> setting (see constructor argument of
		674	the same name for details).
		675
		676	=cut
		677
		678	sub oobinline {
		679	$_[0]{oobinline} = $_[1];
		680
		681	eval {
		682	local $SIG{__DIE__};
		683	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_OOBINLINE (), int $_[1]
		684	if $_[0]{fh};
		685	};
		686	}
		687
		688	=item $handle->keepalive ($boolean)
		689
		690	Enables or disables the C<keepalive> setting (see constructor argument of
		691	the same name for details).
		692
		693	=cut
		694
		695	sub keepalive {
		696	$_[0]{keepalive} = $_[1];
		697
		698	eval {
		699	local $SIG{__DIE__};
		700	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
		701	if $_[0]{fh};
		702	};
		703	}
		704
577	=item $handle->on_starttls ($cb)	705	=item $handle->on_starttls ($cb)
578		706
579	Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument).	707	Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument).
580		708
581	=cut	709	=cut
…		…
588		716
589	Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).	717	Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).
590		718
591	=cut	719	=cut
592		720
593	sub on_starttls {	721	sub on_stoptls {
594	$_[0]{on_stoptls} = $_[1];	722	$_[0]{on_stoptls} = $_[1];
595	}	723	}
596		724
		725	=item $handle->rbuf_max ($max_octets)
		726
		727	Configures the C<rbuf_max> setting (C<undef> disables it).
		728
		729	=cut
		730
		731	sub rbuf_max {
		732	$_[0]{rbuf_max} = $_[1];
		733	}
		734
597	#############################################################################	735	#############################################################################
598		736
599	=item $handle->timeout ($seconds)	737	=item $handle->timeout ($seconds)
600		738
		739	=item $handle->rtimeout ($seconds)
		740
		741	=item $handle->wtimeout ($seconds)
		742
601	Configures (or disables) the inactivity timeout.	743	Configures (or disables) the inactivity timeout.
602		744
603	=cut	745	=item $handle->timeout_reset
604		746
605	sub timeout {	747	=item $handle->rtimeout_reset
		748
		749	=item $handle->wtimeout_reset
		750
		751	Reset the activity timeout, as if data was received or sent.
		752
		753	These methods are cheap to call.
		754
		755	=cut
		756
		757	for my $dir ("", "r", "w") {
		758	my $timeout = "${dir}timeout";
		759	my $tw = "_${dir}tw";
		760	my $on_timeout = "on_${dir}timeout";
		761	my $activity = "_${dir}activity";
		762	my $cb;
		763
		764	*$on_timeout = sub {
		765	$_[0]{$on_timeout} = $_[1];
		766	};
		767
		768	*$timeout = sub {
606	my ($self, $timeout) = @_;	769	my ($self, $new_value) = @_;
607		770
608	$self->{timeout} = $timeout;	771	$self->{$timeout} = $new_value;
609	$self->_timeout;	772	delete $self->{$tw}; &$cb;
610	}	773	};
611		774
		775	*{"${dir}timeout_reset"} = sub {
		776	$_[0]{$activity} = AE::now;
		777	};
		778
		779	# main workhorse:
612	# reset the timeout watcher, as neccessary	780	# reset the timeout watcher, as neccessary
613	# also check for time-outs	781	# also check for time-outs
614	sub _timeout {	782	$cb = sub {
615	my ($self) = @_;	783	my ($self) = @_;
616		784
617	if ($self->{timeout} && $self->{fh}) {	785	if ($self->{$timeout} && $self->{fh}) {
618	my $NOW = AnyEvent->now;	786	my $NOW = AE::now;
619		787
620	# when would the timeout trigger?	788	# when would the timeout trigger?
621	my $after = $self->{_activity} + $self->{timeout} - $NOW;	789	my $after = $self->{$activity} + $self->{$timeout} - $NOW;
622		790
623	# now or in the past already?	791	# now or in the past already?
624	if ($after <= 0) {	792	if ($after <= 0) {
625	$self->{_activity} = $NOW;	793	$self->{$activity} = $NOW;
626		794
627	if ($self->{on_timeout}) {	795	if ($self->{$on_timeout}) {
628	$self->{on_timeout}($self);	796	$self->{$on_timeout}($self);
629	} else {	797	} else {
630	$self->_error (Errno::ETIMEDOUT);	798	$self->_error (Errno::ETIMEDOUT);
		799	}
		800
		801	# callback could have changed timeout value, optimise
		802	return unless $self->{$timeout};
		803
		804	# calculate new after
		805	$after = $self->{$timeout};
631	}	806	}
632		807
633	# callback could have changed timeout value, optimise	808	Scalar::Util::weaken $self;
634	return unless $self->{timeout};	809	return unless $self; # ->error could have destroyed $self
635		810
636	# calculate new after	811	$self->{$tw} \|\|= AE::timer $after, 0, sub {
637	$after = $self->{timeout};	812	delete $self->{$tw};
		813	$cb->($self);
		814	};
		815	} else {
		816	delete $self->{$tw};
638	}	817	}
639
640	Scalar::Util::weaken $self;
641	return unless $self; # ->error could have destroyed $self
642
643	$self->{_tw} \|\|= AnyEvent->timer (after => $after, cb => sub {
644	delete $self->{_tw};
645	$self->_timeout;
646	});
647	} else {
648	delete $self->{_tw};
649	}	818	}
650	}	819	}
651		820
652	#############################################################################	821	#############################################################################
653		822
…		…
668		837
669	=item $handle->on_drain ($cb)	838	=item $handle->on_drain ($cb)
670		839
671	Sets the C<on_drain> callback or clears it (see the description of	840	Sets the C<on_drain> callback or clears it (see the description of
672	C<on_drain> in the constructor).	841	C<on_drain> in the constructor).
		842
		843	This method may invoke callbacks (and therefore the handle might be
		844	destroyed after it returns).
673		845
674	=cut	846	=cut
675		847
676	sub on_drain {	848	sub on_drain {
677	my ($self, $cb) = @_;	849	my ($self, $cb) = @_;
…		…
686		858
687	Queues the given scalar to be written. You can push as much data as you	859	Queues the given scalar to be written. You can push as much data as you
688	want (only limited by the available memory), as C<AnyEvent::Handle>	860	want (only limited by the available memory), as C<AnyEvent::Handle>
689	buffers it independently of the kernel.	861	buffers it independently of the kernel.
690		862
		863	This method may invoke callbacks (and therefore the handle might be
		864	destroyed after it returns).
		865
691	=cut	866	=cut
692		867
693	sub _drain_wbuf {	868	sub _drain_wbuf {
694	my ($self) = @_;	869	my ($self) = @_;
695		870
…		…
701	my $len = syswrite $self->{fh}, $self->{wbuf};	876	my $len = syswrite $self->{fh}, $self->{wbuf};
702		877
703	if (defined $len) {	878	if (defined $len) {
704	substr $self->{wbuf}, 0, $len, "";	879	substr $self->{wbuf}, 0, $len, "";
705		880
706	$self->{_activity} = AnyEvent->now;	881	$self->{_activity} = $self->{_wactivity} = AE::now;
707		882
708	$self->{on_drain}($self)	883	$self->{on_drain}($self)
709	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})	884	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
710	&& $self->{on_drain};	885	&& $self->{on_drain};
711		886
…		…
717		892
718	# try to write data immediately	893	# try to write data immediately
719	$cb->() unless $self->{autocork};	894	$cb->() unless $self->{autocork};
720		895
721	# if still data left in wbuf, we need to poll	896	# if still data left in wbuf, we need to poll
722	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	897	$self->{_ww} = AE::io $self->{fh}, 1, $cb
723	if length $self->{wbuf};	898	if length $self->{wbuf};
724	};	899	};
725	}	900	}
726		901
727	our %WH;	902	our %WH;
728		903
		904	# deprecated
729	sub register_write_type($$) {	905	sub register_write_type($$) {
730	$WH{$_[0]} = $_[1];	906	$WH{$_[0]} = $_[1];
731	}	907	}
732		908
733	sub push_write {	909	sub push_write {
734	my $self = shift;	910	my $self = shift;
735		911
736	if (@_ > 1) {	912	if (@_ > 1) {
737	my $type = shift;	913	my $type = shift;
738		914
		915	@_ = ($WH{$type} \|\|= _load_func "$type\::anyevent_write_type"
739	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	916	or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_write")
740	->($self, @_);	917	->($self, @_);
741	}	918	}
742		919
		920	# we downgrade here to avoid hard-to-track-down bugs,
		921	# and diagnose the problem earlier and better.
		922
743	if ($self->{tls}) {	923	if ($self->{tls}) {
744	$self->{_tls_wbuf} .= $_[0];	924	utf8::downgrade $self->{_tls_wbuf} .= $_[0];
745		925	&_dotls ($self) if $self->{fh};
746	&_dotls ($self);
747	} else {	926	} else {
748	$self->{wbuf} .= $_[0];	927	utf8::downgrade $self->{wbuf} .= $_[0];
749	$self->_drain_wbuf if $self->{fh};	928	$self->_drain_wbuf if $self->{fh};
750	}	929	}
751	}	930	}
752		931
753	=item $handle->push_write (type => @args)	932	=item $handle->push_write (type => @args)
754		933
755	Instead of formatting your data yourself, you can also let this module do	934	Instead of formatting your data yourself, you can also let this module
756	the job by specifying a type and type-specific arguments.	935	do the job by specifying a type and type-specific arguments. You
		936	can also specify the (fully qualified) name of a package, in which
		937	case AnyEvent tries to load the package and then expects to find the
		938	C<anyevent_read_type> function inside (see "custom write types", below).
757		939
758	Predefined types are (if you have ideas for additional types, feel free to	940	Predefined types are (if you have ideas for additional types, feel free to
759	drop by and tell us):	941	drop by and tell us):
760		942
761	=over 4	943	=over 4
…		…
818	Other languages could read single lines terminated by a newline and pass	1000	Other languages could read single lines terminated by a newline and pass
819	this line into their JSON decoder of choice.	1001	this line into their JSON decoder of choice.
820		1002
821	=cut	1003	=cut
822		1004
		1005	sub json_coder() {
		1006	eval { require JSON::XS; JSON::XS->new->utf8 }
		1007	\|\| do { require JSON; JSON->new->utf8 }
		1008	}
		1009
823	register_write_type json => sub {	1010	register_write_type json => sub {
824	my ($self, $ref) = @_;	1011	my ($self, $ref) = @_;
825		1012
826	require JSON;	1013	my $json = $self->{json} \|\|= json_coder;
827		1014
828	$self->{json} ? $self->{json}->encode ($ref)	1015	$json->encode ($ref)
829	: JSON::encode_json ($ref)
830	};	1016	};
831		1017
832	=item storable => $reference	1018	=item storable => $reference
833		1019
834	Freezes the given reference using L<Storable> and writes it to the	1020	Freezes the given reference using L<Storable> and writes it to the
…		…
860	the peer.	1046	the peer.
861		1047
862	You can rely on the normal read queue and C<on_eof> handling	1048	You can rely on the normal read queue and C<on_eof> handling
863	afterwards. This is the cleanest way to close a connection.	1049	afterwards. This is the cleanest way to close a connection.
864		1050
		1051	This method may invoke callbacks (and therefore the handle might be
		1052	destroyed after it returns).
		1053
865	=cut	1054	=cut
866		1055
867	sub push_shutdown {	1056	sub push_shutdown {
868	my ($self) = @_;	1057	my ($self) = @_;
869		1058
870	delete $self->{low_water_mark};	1059	delete $self->{low_water_mark};
871	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });	1060	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });
872	}	1061	}
873		1062
874	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	1063	=item custom write types - Package::anyevent_write_type $handle, @args
875		1064
876	This function (not method) lets you add your own types to C<push_write>.	1065	Instead of one of the predefined types, you can also specify the name of
		1066	a package. AnyEvent will try to load the package and then expects to find
		1067	a function named C<anyevent_write_type> inside. If it isn't found, it
		1068	progressively tries to load the parent package until it either finds the
		1069	function (good) or runs out of packages (bad).
		1070
877	Whenever the given C<type> is used, C<push_write> will invoke the code	1071	Whenever the given C<type> is used, C<push_write> will the function with
878	reference with the handle object and the remaining arguments.	1072	the handle object and the remaining arguments.
879		1073
880	The code reference is supposed to return a single octet string that will	1074	The function is supposed to return a single octet string that will be
881	be appended to the write buffer.	1075	appended to the write buffer, so you cna mentally treat this function as a
		1076	"arguments to on-the-wire-format" converter.
882		1077
883	Note that this is a function, and all types registered this way will be	1078	Example: implement a custom write type C<join> that joins the remaining
884	global, so try to use unique names.	1079	arguments using the first one.
		1080
		1081	$handle->push_write (My::Type => " ", 1,2,3);
		1082
		1083	# uses the following package, which can be defined in the "My::Type" or in
		1084	# the "My" modules to be auto-loaded, or just about anywhere when the
		1085	# My::Type::anyevent_write_type is defined before invoking it.
		1086
		1087	package My::Type;
		1088
		1089	sub anyevent_write_type {
		1090	my ($handle, $delim, @args) = @_;
		1091
		1092	join $delim, @args
		1093	}
885		1094
886	=cut	1095	=cut
887		1096
888	#############################################################################	1097	#############################################################################
889		1098
…		…
972		1181
973	sub _drain_rbuf {	1182	sub _drain_rbuf {
974	my ($self) = @_;	1183	my ($self) = @_;
975		1184
976	# avoid recursion	1185	# avoid recursion
977	return if exists $self->{_skip_drain_rbuf};	1186	return if $self->{_skip_drain_rbuf};
978	local $self->{_skip_drain_rbuf} = 1;	1187	local $self->{_skip_drain_rbuf} = 1;
979
980	if (
981	defined $self->{rbuf_max}
982	&& $self->{rbuf_max} < length $self->{rbuf}
983	) {
984	$self->_error (Errno::ENOSPC, 1), return;
985	}
986		1188
987	while () {	1189	while () {
988	# we need to use a separate tls read buffer, as we must not receive data while	1190	# we need to use a separate tls read buffer, as we must not receive data while
989	# we are draining the buffer, and this can only happen with TLS.	1191	# we are draining the buffer, and this can only happen with TLS.
990	$self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf};	1192	$self->{rbuf} .= delete $self->{_tls_rbuf}
		1193	if exists $self->{_tls_rbuf};
991		1194
992	my $len = length $self->{rbuf};	1195	my $len = length $self->{rbuf};
993		1196
994	if (my $cb = shift @{ $self->{_queue} }) {	1197	if (my $cb = shift @{ $self->{_queue} }) {
995	unless ($cb->($self)) {	1198	unless ($cb->($self)) {
996	if ($self->{_eof}) {	1199	# no progress can be made
997	# no progress can be made (not enough data and no data forthcoming)	1200	# (not enough data and no data forthcoming)
998	$self->_error (Errno::EPIPE, 1), return;	1201	$self->_error (Errno::EPIPE, 1), return
999	}	1202	if $self->{_eof};
1000		1203
1001	unshift @{ $self->{_queue} }, $cb;	1204	unshift @{ $self->{_queue} }, $cb;
1002	last;	1205	last;
1003	}	1206	}
1004	} elsif ($self->{on_read}) {	1207	} elsif ($self->{on_read}) {
…		…
1024	last;	1227	last;
1025	}	1228	}
1026	}	1229	}
1027		1230
1028	if ($self->{_eof}) {	1231	if ($self->{_eof}) {
1029	if ($self->{on_eof}) {	1232	$self->{on_eof}
1030	$self->{on_eof}($self)	1233	? $self->{on_eof}($self)
1031	} else {
1032	$self->_error (0, 1, "Unexpected end-of-file");	1234	: $self->_error (0, 1, "Unexpected end-of-file");
1033	}	1235
		1236	return;
		1237	}
		1238
		1239	if (
		1240	defined $self->{rbuf_max}
		1241	&& $self->{rbuf_max} < length $self->{rbuf}
		1242	) {
		1243	$self->_error (Errno::ENOSPC, 1), return;
1034	}	1244	}
1035		1245
1036	# may need to restart read watcher	1246	# may need to restart read watcher
1037	unless ($self->{_rw}) {	1247	unless ($self->{_rw}) {
1038	$self->start_read	1248	$self->start_read
…		…
1043	=item $handle->on_read ($cb)	1253	=item $handle->on_read ($cb)
1044		1254
1045	This replaces the currently set C<on_read> callback, or clears it (when	1255	This replaces the currently set C<on_read> callback, or clears it (when
1046	the new callback is C<undef>). See the description of C<on_read> in the	1256	the new callback is C<undef>). See the description of C<on_read> in the
1047	constructor.	1257	constructor.
		1258
		1259	This method may invoke callbacks (and therefore the handle might be
		1260	destroyed after it returns).
1048		1261
1049	=cut	1262	=cut
1050		1263
1051	sub on_read {	1264	sub on_read {
1052	my ($self, $cb) = @_;	1265	my ($self, $cb) = @_;
…		…
1092		1305
1093	If enough data was available, then the callback must remove all data it is	1306	If enough data was available, then the callback must remove all data it is
1094	interested in (which can be none at all) and return a true value. After returning	1307	interested in (which can be none at all) and return a true value. After returning
1095	true, it will be removed from the queue.	1308	true, it will be removed from the queue.
1096		1309
		1310	These methods may invoke callbacks (and therefore the handle might be
		1311	destroyed after it returns).
		1312
1097	=cut	1313	=cut
1098		1314
1099	our %RH;	1315	our %RH;
1100		1316
1101	sub register_read_type($$) {	1317	sub register_read_type($$) {
…		…
1107	my $cb = pop;	1323	my $cb = pop;
1108		1324
1109	if (@_) {	1325	if (@_) {
1110	my $type = shift;	1326	my $type = shift;
1111		1327
		1328	$cb = ($RH{$type} \|\|= _load_func "$type\::anyevent_read_type"
1112	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	1329	or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_read")
1113	->($self, $cb, @_);	1330	->($self, $cb, @_);
1114	}	1331	}
1115		1332
1116	push @{ $self->{_queue} }, $cb;	1333	push @{ $self->{_queue} }, $cb;
1117	$self->_drain_rbuf;	1334	$self->_drain_rbuf;
…		…
1126		1343
1127	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")	1344	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")
1128	->($self, $cb, @_);	1345	->($self, $cb, @_);
1129	}	1346	}
1130		1347
1131
1132	unshift @{ $self->{_queue} }, $cb;	1348	unshift @{ $self->{_queue} }, $cb;
1133	$self->_drain_rbuf;	1349	$self->_drain_rbuf;
1134	}	1350	}
1135		1351
1136	=item $handle->push_read (type => @args, $cb)	1352	=item $handle->push_read (type => @args, $cb)
1137		1353
1138	=item $handle->unshift_read (type => @args, $cb)	1354	=item $handle->unshift_read (type => @args, $cb)
1139		1355
1140	Instead of providing a callback that parses the data itself you can chose	1356	Instead of providing a callback that parses the data itself you can chose
1141	between a number of predefined parsing formats, for chunks of data, lines	1357	between a number of predefined parsing formats, for chunks of data, lines
1142	etc.	1358	etc. You can also specify the (fully qualified) name of a package, in
		1359	which case AnyEvent tries to load the package and then expects to find the
		1360	C<anyevent_read_type> function inside (see "custom read types", below).
1143		1361
1144	Predefined types are (if you have ideas for additional types, feel free to	1362	Predefined types are (if you have ideas for additional types, feel free to
1145	drop by and tell us):	1363	drop by and tell us):
1146		1364
1147	=over 4	1365	=over 4
…		…
1387	=cut	1605	=cut
1388		1606
1389	register_read_type json => sub {	1607	register_read_type json => sub {
1390	my ($self, $cb) = @_;	1608	my ($self, $cb) = @_;
1391		1609
1392	my $json = $self->{json} \|\|=	1610	my $json = $self->{json} \|\|= json_coder;
1393	eval { require JSON::XS; JSON::XS->new->utf8 }
1394	\|\| do { require JSON; JSON->new->utf8 };
1395		1611
1396	my $data;	1612	my $data;
1397	my $rbuf = \$self->{rbuf};	1613	my $rbuf = \$self->{rbuf};
1398		1614
1399	sub {	1615	sub {
…		…
1468	}	1684	}
1469	};	1685	};
1470		1686
1471	=back	1687	=back
1472		1688
1473	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)	1689	=item custom read types - Package::anyevent_read_type $handle, $cb, @args
1474		1690
1475	This function (not method) lets you add your own types to C<push_read>.	1691	Instead of one of the predefined types, you can also specify the name
		1692	of a package. AnyEvent will try to load the package and then expects to
		1693	find a function named C<anyevent_read_type> inside. If it isn't found, it
		1694	progressively tries to load the parent package until it either finds the
		1695	function (good) or runs out of packages (bad).
1476		1696
1477	Whenever the given C<type> is used, C<push_read> will invoke the code	1697	Whenever this type is used, C<push_read> will invoke the function with the
1478	reference with the handle object, the callback and the remaining	1698	handle object, the original callback and the remaining arguments.
1479	arguments.
1480		1699
1481	The code reference is supposed to return a callback (usually a closure)	1700	The function is supposed to return a callback (usually a closure) that
1482	that works as a plain read callback (see C<< ->push_read ($cb) >>).	1701	works as a plain read callback (see C<< ->push_read ($cb) >>), so you can
		1702	mentally treat the function as a "configurable read type to read callback"
		1703	converter.
1483		1704
1484	It should invoke the passed callback when it is done reading (remember to	1705	It should invoke the original callback when it is done reading (remember
1485	pass C<$handle> as first argument as all other callbacks do that).	1706	to pass C<$handle> as first argument as all other callbacks do that,
		1707	although there is no strict requirement on this).
1486		1708
1487	Note that this is a function, and all types registered this way will be
1488	global, so try to use unique names.
1489
1490	For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>,	1709	For examples, see the source of this module (F<perldoc -m
1491	search for C<register_read_type>)).	1710	AnyEvent::Handle>, search for C<register_read_type>)).
1492		1711
1493	=item $handle->stop_read	1712	=item $handle->stop_read
1494		1713
1495	=item $handle->start_read	1714	=item $handle->start_read
1496		1715
…		…
1516	}	1735	}
1517		1736
1518	sub start_read {	1737	sub start_read {
1519	my ($self) = @_;	1738	my ($self) = @_;
1520		1739
1521	unless ($self->{_rw} \|\| $self->{_eof}) {	1740	unless ($self->{_rw} \|\| $self->{_eof} \|\| !$self->{fh}) {
1522	Scalar::Util::weaken $self;	1741	Scalar::Util::weaken $self;
1523		1742
1524	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1743	$self->{_rw} = AE::io $self->{fh}, 0, sub {
1525	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});	1744	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1526	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;	1745	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;
1527		1746
1528	if ($len > 0) {	1747	if ($len > 0) {
1529	$self->{_activity} = AnyEvent->now;	1748	$self->{_activity} = $self->{_ractivity} = AE::now;
1530		1749
1531	if ($self->{tls}) {	1750	if ($self->{tls}) {
1532	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);	1751	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1533		1752
1534	&_dotls ($self);	1753	&_dotls ($self);
…		…
1542	$self->_drain_rbuf;	1761	$self->_drain_rbuf;
1543		1762
1544	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1763	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1545	return $self->_error ($!, 1);	1764	return $self->_error ($!, 1);
1546	}	1765	}
1547	});	1766	};
1548	}	1767	}
1549	}	1768	}
1550		1769
1551	our $ERROR_SYSCALL;	1770	our $ERROR_SYSCALL;
1552	our $ERROR_WANT_READ;	1771	our $ERROR_WANT_READ;
…		…
1619	&& ($tmp != $ERROR_SYSCALL \|\| $!);	1838	&& ($tmp != $ERROR_SYSCALL \|\| $!);
1620		1839
1621	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1840	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1622	$self->{wbuf} .= $tmp;	1841	$self->{wbuf} .= $tmp;
1623	$self->_drain_wbuf;	1842	$self->_drain_wbuf;
		1843	$self->{tls} or return; # tls session might have gone away in callback
1624	}	1844	}
1625		1845
1626	$self->{_on_starttls}	1846	$self->{_on_starttls}
1627	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()	1847	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
1628	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");	1848	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");
…		…
1649	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS	1869	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS
1650	context in C<< $handle->{tls_ctx} >> after this call and can be used or	1870	context in C<< $handle->{tls_ctx} >> after this call and can be used or
1651	changed to your liking. Note that the handshake might have already started	1871	changed to your liking. Note that the handshake might have already started
1652	when this function returns.	1872	when this function returns.
1653		1873
1654	If it an error to start a TLS handshake more than once per	1874	Due to bugs in OpenSSL, it might or might not be possible to do multiple
1655	AnyEvent::Handle object (this is due to bugs in OpenSSL).	1875	handshakes on the same stream. Best do not attempt to use the stream after
		1876	stopping TLS.
		1877
		1878	This method may invoke callbacks (and therefore the handle might be
		1879	destroyed after it returns).
1656		1880
1657	=cut	1881	=cut
1658		1882
1659	our %TLS_CACHE; #TODO not yet documented, should we?	1883	our %TLS_CACHE; #TODO not yet documented, should we?
1660		1884
1661	sub starttls {	1885	sub starttls {
1662	my ($self, $ssl, $ctx) = @_;	1886	my ($self, $tls, $ctx) = @_;
		1887
		1888	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"
		1889	if $self->{tls};
		1890
		1891	$self->{tls} = $tls;
		1892	$self->{tls_ctx} = $ctx if @_ > 2;
		1893
		1894	return unless $self->{fh};
1663		1895
1664	require Net::SSLeay;	1896	require Net::SSLeay;
1665
1666	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"
1667	if $self->{tls};
1668		1897
1669	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();	1898	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1670	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();	1899	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1671		1900
		1901	$tls = delete $self->{tls};
1672	$ctx \|\|= $self->{tls_ctx};	1902	$ctx = $self->{tls_ctx};
1673		1903
1674	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session	1904	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
1675		1905
1676	if ("HASH" eq ref $ctx) {	1906	if ("HASH" eq ref $ctx) {
1677	require AnyEvent::TLS;	1907	require AnyEvent::TLS;
…		…
1683	$ctx = new AnyEvent::TLS %$ctx;	1913	$ctx = new AnyEvent::TLS %$ctx;
1684	}	1914	}
1685	}	1915	}
1686		1916
1687	$self->{tls_ctx} = $ctx \|\| TLS_CTX ();	1917	$self->{tls_ctx} = $ctx \|\| TLS_CTX ();
1688	$self->{tls} = $ssl = $self->{tls_ctx}->_get_session ($ssl, $self, $self->{peername});	1918	$self->{tls} = $tls = $self->{tls_ctx}->_get_session ($tls, $self, $self->{peername});
1689		1919
1690	# basically, this is deep magic (because SSL_read should have the same issues)	1920	# basically, this is deep magic (because SSL_read should have the same issues)
1691	# but the openssl maintainers basically said: "trust us, it just works".	1921	# but the openssl maintainers basically said: "trust us, it just works".
1692	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1922	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1693	# and mismaintained ssleay-module doesn't even offer them).	1923	# and mismaintained ssleay-module doesn't even offer them).
…		…
1700	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to	1930	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
1701	# have identity issues in that area.	1931	# have identity issues in that area.
1702	# Net::SSLeay::CTX_set_mode ($ssl,	1932	# Net::SSLeay::CTX_set_mode ($ssl,
1703	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1933	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
1704	# \| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));	1934	# \| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
1705	Net::SSLeay::CTX_set_mode ($ssl, 1\|2);	1935	Net::SSLeay::CTX_set_mode ($tls, 1\|2);
1706		1936
1707	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1937	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1708	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1938	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1709		1939
		1940	Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf});
		1941
1710	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1942	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
1711		1943
1712	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }	1944	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1713	if $self->{on_starttls};	1945	if $self->{on_starttls};
1714		1946
1715	&_dotls; # need to trigger the initial handshake	1947	&_dotls; # need to trigger the initial handshake
…		…
1718		1950
1719	=item $handle->stoptls	1951	=item $handle->stoptls
1720		1952
1721	Shuts down the SSL connection - this makes a proper EOF handshake by	1953	Shuts down the SSL connection - this makes a proper EOF handshake by
1722	sending a close notify to the other side, but since OpenSSL doesn't	1954	sending a close notify to the other side, but since OpenSSL doesn't
1723	support non-blocking shut downs, it is not possible to re-use the stream	1955	support non-blocking shut downs, it is not guaranteed that you can re-use
1724	afterwards.	1956	the stream afterwards.
		1957
		1958	This method may invoke callbacks (and therefore the handle might be
		1959	destroyed after it returns).
1725		1960
1726	=cut	1961	=cut
1727		1962
1728	sub stoptls {	1963	sub stoptls {
1729	my ($self) = @_;	1964	my ($self) = @_;
1730		1965
1731	if ($self->{tls}) {	1966	if ($self->{tls} && $self->{fh}) {
1732	Net::SSLeay::shutdown ($self->{tls});	1967	Net::SSLeay::shutdown ($self->{tls});
1733		1968
1734	&_dotls;	1969	&_dotls;
1735		1970
1736	# # we don't give a shit. no, we do, but we can't. no...#d#	1971	# # we don't give a shit. no, we do, but we can't. no...#d#
…		…
1742	sub _freetls {	1977	sub _freetls {
1743	my ($self) = @_;	1978	my ($self) = @_;
1744		1979
1745	return unless $self->{tls};	1980	return unless $self->{tls};
1746		1981
1747	$self->{tls_ctx}->_put_session (delete $self->{tls});	1982	$self->{tls_ctx}->_put_session (delete $self->{tls})
		1983	if $self->{tls} > 0;
1748		1984
1749	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};	1985	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1750	}	1986	}
1751		1987
1752	sub DESTROY {	1988	sub DESTROY {
…		…
1760	my $fh = delete $self->{fh};	1996	my $fh = delete $self->{fh};
1761	my $wbuf = delete $self->{wbuf};	1997	my $wbuf = delete $self->{wbuf};
1762		1998
1763	my @linger;	1999	my @linger;
1764		2000
1765	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {	2001	push @linger, AE::io $fh, 1, sub {
1766	my $len = syswrite $fh, $wbuf, length $wbuf;	2002	my $len = syswrite $fh, $wbuf, length $wbuf;
1767		2003
1768	if ($len > 0) {	2004	if ($len > 0) {
1769	substr $wbuf, 0, $len, "";	2005	substr $wbuf, 0, $len, "";
1770	} else {	2006	} else {
1771	@linger = (); # end	2007	@linger = (); # end
1772	}	2008	}
1773	});	2009	};
1774	push @linger, AnyEvent->timer (after => $linger, cb => sub {	2010	push @linger, AE::timer $linger, 0, sub {
1775	@linger = ();	2011	@linger = ();
1776	});	2012	};
1777	}	2013	}
1778	}	2014	}
1779		2015
1780	=item $handle->destroy	2016	=item $handle->destroy
1781		2017
1782	Shuts down the handle object as much as possible - this call ensures that	2018	Shuts down the handle object as much as possible - this call ensures that
1783	no further callbacks will be invoked and as many resources as possible	2019	no further callbacks will be invoked and as many resources as possible
1784	will be freed. You must not call any methods on the object afterwards.	2020	will be freed. Any method you will call on the handle object after
		2021	destroying it in this way will be silently ignored (and it will return the
		2022	empty list).
1785		2023
1786	Normally, you can just "forget" any references to an AnyEvent::Handle	2024	Normally, you can just "forget" any references to an AnyEvent::Handle
1787	object and it will simply shut down. This works in fatal error and EOF	2025	object and it will simply shut down. This works in fatal error and EOF
1788	callbacks, as well as code outside. It does I<NOT> work in a read or write	2026	callbacks, as well as code outside. It does I<NOT> work in a read or write
1789	callback, so when you want to destroy the AnyEvent::Handle object from	2027	callback, so when you want to destroy the AnyEvent::Handle object from
…		…
1803	sub destroy {	2041	sub destroy {
1804	my ($self) = @_;	2042	my ($self) = @_;
1805		2043
1806	$self->DESTROY;	2044	$self->DESTROY;
1807	%$self = ();	2045	%$self = ();
		2046	bless $self, "AnyEvent::Handle::destroyed";
1808	}	2047	}
		2048
		2049	sub AnyEvent::Handle::destroyed::AUTOLOAD {
		2050	#nop
		2051	}
		2052
		2053	=item $handle->destroyed
		2054
		2055	Returns false as long as the handle hasn't been destroyed by a call to C<<
		2056	->destroy >>, true otherwise.
		2057
		2058	Can be useful to decide whether the handle is still valid after some
		2059	callback possibly destroyed the handle. For example, C<< ->push_write >>,
		2060	C<< ->starttls >> and other methods can call user callbacks, which in turn
		2061	can destroy the handle, so work can be avoided by checking sometimes:
		2062
		2063	$hdl->starttls ("accept");
		2064	return if $hdl->destroyed;
		2065	$hdl->push_write (...
		2066
		2067	Note that the call to C<push_write> will silently be ignored if the handle
		2068	has been destroyed, so often you can just ignore the possibility of the
		2069	handle being destroyed.
		2070
		2071	=cut
		2072
		2073	sub destroyed { 0 }
		2074	sub AnyEvent::Handle::destroyed::destroyed { 1 }
1809		2075
1810	=item AnyEvent::Handle::TLS_CTX	2076	=item AnyEvent::Handle::TLS_CTX
1811		2077
1812	This function creates and returns the AnyEvent::TLS object used by default	2078	This function creates and returns the AnyEvent::TLS object used by default
1813	for TLS mode.	2079	for TLS mode.

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.159 by root, Fri Jul 24 12:35:58 2009 UTC vs. Revision 1.195 by root, Sat Jun 5 09:08:14 2010 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.159 by root, Fri Jul 24 12:35:58 2009 UTC vs.
Revision 1.195 by root, Sat Jun 5 09:08:14 2010 UTC