[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.193 by root, Mon Mar 15 18:51:30 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 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;
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
…		…
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 {
…		…
466	sub _start {	534	sub _start {
467	my ($self) = @_;	535	my ($self) = @_;
468		536
469	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	537	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
470		538
		539	$self->{_activity} =
		540	$self->{_ractivity} =
471	$self->{_activity} = AnyEvent->now;	541	$self->{_wactivity} = AE::now;
472	$self->_timeout;
473		542
		543	$self->timeout (delete $self->{timeout} ) if $self->{timeout};
		544	$self->rtimeout (delete $self->{rtimeout} ) if $self->{rtimeout};
		545	$self->wtimeout (delete $self->{wtimeout} ) if $self->{wtimeout};
		546
474	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};	547	$self->no_delay (delete $self->{no_delay} ) if exists $self->{no_delay} && $self->{no_delay};
		548	$self->keepalive (delete $self->{keepalive}) if exists $self->{keepalive} && $self->{keepalive};
475		549
		550	$self->oobinline (exists $self->{oobinline} ? delete $self->{oobinline} : 1);
		551
476	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})	552	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
477	if $self->{tls};	553	if $self->{tls};
478		554
479	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	555	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
480		556
481	$self->start_read	557	$self->start_read
482	if $self->{on_read} \|\| @{ $self->{_queue} };	558	if $self->{on_read} \|\| @{ $self->{_queue} };
483	}
484		559
485	#sub _shutdown {	560	$self->_drain_wbuf;
486	# my ($self) = @_;	561	}
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		562
494	sub _error {	563	sub _error {
495	my ($self, $errno, $fatal, $message) = @_;	564	my ($self, $errno, $fatal, $message) = @_;
496		565
497	$! = $errno;	566	$! = $errno;
498	$message \|\|= "$!";	567	$message \|\|= "$!";
499		568
500	if ($self->{on_error}) {	569	if ($self->{on_error}) {
501	$self->{on_error}($self, $fatal, $message);	570	$self->{on_error}($self, $fatal, $message);
502	$self->destroy if $fatal;	571	$self->destroy if $fatal;
503	} elsif ($self->{fh}) {	572	} elsif ($self->{fh} \|\| $self->{connect}) {
504	$self->destroy;	573	$self->destroy;
505	Carp::croak "AnyEvent::Handle uncaught error: $message";	574	Carp::croak "AnyEvent::Handle uncaught error: $message";
506	}	575	}
507	}	576	}
508		577
…		…
534	$_[0]{on_eof} = $_[1];	603	$_[0]{on_eof} = $_[1];
535	}	604	}
536		605
537	=item $handle->on_timeout ($cb)	606	=item $handle->on_timeout ($cb)
538		607
539	Replace the current C<on_timeout> callback, or disables the callback (but	608	=item $handle->on_rtimeout ($cb)
540	not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
541	argument and method.
542		609
543	=cut	610	=item $handle->on_wtimeout ($cb)
544		611
545	sub on_timeout {	612	Replace the current C<on_timeout>, C<on_rtimeout> or C<on_wtimeout>
546	$_[0]{on_timeout} = $_[1];	613	callback, or disables the callback (but not the timeout) if C<$cb> =
547	}	614	C<undef>. See the C<timeout> constructor argument and method.
		615
		616	=cut
		617
		618	# see below
548		619
549	=item $handle->autocork ($boolean)	620	=item $handle->autocork ($boolean)
550		621
551	Enables or disables the current autocork behaviour (see C<autocork>	622	Enables or disables the current autocork behaviour (see C<autocork>
552	constructor argument). Changes will only take effect on the next write.	623	constructor argument). Changes will only take effect on the next write.
…		…
567	sub no_delay {	638	sub no_delay {
568	$_[0]{no_delay} = $_[1];	639	$_[0]{no_delay} = $_[1];
569		640
570	eval {	641	eval {
571	local $SIG{__DIE__};	642	local $SIG{__DIE__};
572	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1]	643	setsockopt $_[0]{fh}, Socket::IPPROTO_TCP (), Socket::TCP_NODELAY (), int $_[1]
573	if $_[0]{fh};	644	if $_[0]{fh};
574	};	645	};
575	}	646	}
576		647
		648	=item $handle->keepalive ($boolean)
		649
		650	Enables or disables the C<keepalive> setting (see constructor argument of
		651	the same name for details).
		652
		653	=cut
		654
		655	sub keepalive {
		656	$_[0]{keepalive} = $_[1];
		657
		658	eval {
		659	local $SIG{__DIE__};
		660	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
		661	if $_[0]{fh};
		662	};
		663	}
		664
		665	=item $handle->oobinline ($boolean)
		666
		667	Enables or disables the C<oobinline> setting (see constructor argument of
		668	the same name for details).
		669
		670	=cut
		671
		672	sub oobinline {
		673	$_[0]{oobinline} = $_[1];
		674
		675	eval {
		676	local $SIG{__DIE__};
		677	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_OOBINLINE (), int $_[1]
		678	if $_[0]{fh};
		679	};
		680	}
		681
		682	=item $handle->keepalive ($boolean)
		683
		684	Enables or disables the C<keepalive> setting (see constructor argument of
		685	the same name for details).
		686
		687	=cut
		688
		689	sub keepalive {
		690	$_[0]{keepalive} = $_[1];
		691
		692	eval {
		693	local $SIG{__DIE__};
		694	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
		695	if $_[0]{fh};
		696	};
		697	}
		698
577	=item $handle->on_starttls ($cb)	699	=item $handle->on_starttls ($cb)
578		700
579	Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument).	701	Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument).
580		702
581	=cut	703	=cut
…		…
588		710
589	Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).	711	Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).
590		712
591	=cut	713	=cut
592		714
593	sub on_starttls {	715	sub on_stoptls {
594	$_[0]{on_stoptls} = $_[1];	716	$_[0]{on_stoptls} = $_[1];
595	}	717	}
596		718
		719	=item $handle->rbuf_max ($max_octets)
		720
		721	Configures the C<rbuf_max> setting (C<undef> disables it).
		722
		723	=cut
		724
		725	sub rbuf_max {
		726	$_[0]{rbuf_max} = $_[1];
		727	}
		728
597	#############################################################################	729	#############################################################################
598		730
599	=item $handle->timeout ($seconds)	731	=item $handle->timeout ($seconds)
600		732
		733	=item $handle->rtimeout ($seconds)
		734
		735	=item $handle->wtimeout ($seconds)
		736
601	Configures (or disables) the inactivity timeout.	737	Configures (or disables) the inactivity timeout.
602		738
603	=cut	739	=item $handle->timeout_reset
604		740
605	sub timeout {	741	=item $handle->rtimeout_reset
		742
		743	=item $handle->wtimeout_reset
		744
		745	Reset the activity timeout, as if data was received or sent.
		746
		747	These methods are cheap to call.
		748
		749	=cut
		750
		751	for my $dir ("", "r", "w") {
		752	my $timeout = "${dir}timeout";
		753	my $tw = "_${dir}tw";
		754	my $on_timeout = "on_${dir}timeout";
		755	my $activity = "_${dir}activity";
		756	my $cb;
		757
		758	*$on_timeout = sub {
		759	$_[0]{$on_timeout} = $_[1];
		760	};
		761
		762	*$timeout = sub {
606	my ($self, $timeout) = @_;	763	my ($self, $new_value) = @_;
607		764
608	$self->{timeout} = $timeout;	765	$self->{$timeout} = $new_value;
609	$self->_timeout;	766	delete $self->{$tw}; &$cb;
610	}	767	};
611		768
		769	*{"${dir}timeout_reset"} = sub {
		770	$_[0]{$activity} = AE::now;
		771	};
		772
		773	# main workhorse:
612	# reset the timeout watcher, as neccessary	774	# reset the timeout watcher, as neccessary
613	# also check for time-outs	775	# also check for time-outs
614	sub _timeout {	776	$cb = sub {
615	my ($self) = @_;	777	my ($self) = @_;
616		778
617	if ($self->{timeout} && $self->{fh}) {	779	if ($self->{$timeout} && $self->{fh}) {
618	my $NOW = AnyEvent->now;	780	my $NOW = AE::now;
619		781
620	# when would the timeout trigger?	782	# when would the timeout trigger?
621	my $after = $self->{_activity} + $self->{timeout} - $NOW;	783	my $after = $self->{$activity} + $self->{$timeout} - $NOW;
622		784
623	# now or in the past already?	785	# now or in the past already?
624	if ($after <= 0) {	786	if ($after <= 0) {
625	$self->{_activity} = $NOW;	787	$self->{$activity} = $NOW;
626		788
627	if ($self->{on_timeout}) {	789	if ($self->{$on_timeout}) {
628	$self->{on_timeout}($self);	790	$self->{$on_timeout}($self);
629	} else {	791	} else {
630	$self->_error (Errno::ETIMEDOUT);	792	$self->_error (Errno::ETIMEDOUT);
		793	}
		794
		795	# callback could have changed timeout value, optimise
		796	return unless $self->{$timeout};
		797
		798	# calculate new after
		799	$after = $self->{$timeout};
631	}	800	}
632		801
633	# callback could have changed timeout value, optimise	802	Scalar::Util::weaken $self;
634	return unless $self->{timeout};	803	return unless $self; # ->error could have destroyed $self
635		804
636	# calculate new after	805	$self->{$tw} \|\|= AE::timer $after, 0, sub {
637	$after = $self->{timeout};	806	delete $self->{$tw};
		807	$cb->($self);
		808	};
		809	} else {
		810	delete $self->{$tw};
638	}	811	}
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	}	812	}
650	}	813	}
651		814
652	#############################################################################	815	#############################################################################
653		816
…		…
668		831
669	=item $handle->on_drain ($cb)	832	=item $handle->on_drain ($cb)
670		833
671	Sets the C<on_drain> callback or clears it (see the description of	834	Sets the C<on_drain> callback or clears it (see the description of
672	C<on_drain> in the constructor).	835	C<on_drain> in the constructor).
		836
		837	This method may invoke callbacks (and therefore the handle might be
		838	destroyed after it returns).
673		839
674	=cut	840	=cut
675		841
676	sub on_drain {	842	sub on_drain {
677	my ($self, $cb) = @_;	843	my ($self, $cb) = @_;
…		…
686		852
687	Queues the given scalar to be written. You can push as much data as you	853	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>	854	want (only limited by the available memory), as C<AnyEvent::Handle>
689	buffers it independently of the kernel.	855	buffers it independently of the kernel.
690		856
		857	This method may invoke callbacks (and therefore the handle might be
		858	destroyed after it returns).
		859
691	=cut	860	=cut
692		861
693	sub _drain_wbuf {	862	sub _drain_wbuf {
694	my ($self) = @_;	863	my ($self) = @_;
695		864
…		…
701	my $len = syswrite $self->{fh}, $self->{wbuf};	870	my $len = syswrite $self->{fh}, $self->{wbuf};
702		871
703	if (defined $len) {	872	if (defined $len) {
704	substr $self->{wbuf}, 0, $len, "";	873	substr $self->{wbuf}, 0, $len, "";
705		874
706	$self->{_activity} = AnyEvent->now;	875	$self->{_activity} = $self->{_wactivity} = AE::now;
707		876
708	$self->{on_drain}($self)	877	$self->{on_drain}($self)
709	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})	878	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
710	&& $self->{on_drain};	879	&& $self->{on_drain};
711		880
…		…
717		886
718	# try to write data immediately	887	# try to write data immediately
719	$cb->() unless $self->{autocork};	888	$cb->() unless $self->{autocork};
720		889
721	# if still data left in wbuf, we need to poll	890	# if still data left in wbuf, we need to poll
722	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	891	$self->{_ww} = AE::io $self->{fh}, 1, $cb
723	if length $self->{wbuf};	892	if length $self->{wbuf};
724	};	893	};
725	}	894	}
726		895
727	our %WH;	896	our %WH;
728		897
		898	# deprecated
729	sub register_write_type($$) {	899	sub register_write_type($$) {
730	$WH{$_[0]} = $_[1];	900	$WH{$_[0]} = $_[1];
731	}	901	}
732		902
733	sub push_write {	903	sub push_write {
734	my $self = shift;	904	my $self = shift;
735		905
736	if (@_ > 1) {	906	if (@_ > 1) {
737	my $type = shift;	907	my $type = shift;
738		908
		909	@_ = ($WH{$type} \|\|= _load_func "$type\::anyevent_write_type"
739	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	910	or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_write")
740	->($self, @_);	911	->($self, @_);
741	}	912	}
742		913
		914	# we downgrade here to avoid hard-to-track-down bugs,
		915	# and diagnose the problem earlier and better.
		916
743	if ($self->{tls}) {	917	if ($self->{tls}) {
744	$self->{_tls_wbuf} .= $_[0];	918	utf8::downgrade $self->{_tls_wbuf} .= $_[0];
745		919	&_dotls ($self) if $self->{fh};
746	&_dotls ($self);
747	} else {	920	} else {
748	$self->{wbuf} .= $_[0];	921	utf8::downgrade $self->{wbuf} .= $_[0];
749	$self->_drain_wbuf if $self->{fh};	922	$self->_drain_wbuf if $self->{fh};
750	}	923	}
751	}	924	}
752		925
753	=item $handle->push_write (type => @args)	926	=item $handle->push_write (type => @args)
754		927
755	Instead of formatting your data yourself, you can also let this module do	928	Instead of formatting your data yourself, you can also let this module
756	the job by specifying a type and type-specific arguments.	929	do the job by specifying a type and type-specific arguments. You
		930	can also specify the (fully qualified) name of a package, in which
		931	case AnyEvent tries to load the package and then expects to find the
		932	C<anyevent_read_type> function inside (see "custom write types", below).
757		933
758	Predefined types are (if you have ideas for additional types, feel free to	934	Predefined types are (if you have ideas for additional types, feel free to
759	drop by and tell us):	935	drop by and tell us):
760		936
761	=over 4	937	=over 4
…		…
818	Other languages could read single lines terminated by a newline and pass	994	Other languages could read single lines terminated by a newline and pass
819	this line into their JSON decoder of choice.	995	this line into their JSON decoder of choice.
820		996
821	=cut	997	=cut
822		998
		999	sub json_coder() {
		1000	eval { require JSON::XS; JSON::XS->new->utf8 }
		1001	\|\| do { require JSON; JSON->new->utf8 }
		1002	}
		1003
823	register_write_type json => sub {	1004	register_write_type json => sub {
824	my ($self, $ref) = @_;	1005	my ($self, $ref) = @_;
825		1006
826	require JSON;	1007	my $json = $self->{json} \|\|= json_coder;
827		1008
828	$self->{json} ? $self->{json}->encode ($ref)	1009	$json->encode ($ref)
829	: JSON::encode_json ($ref)
830	};	1010	};
831		1011
832	=item storable => $reference	1012	=item storable => $reference
833		1013
834	Freezes the given reference using L<Storable> and writes it to the	1014	Freezes the given reference using L<Storable> and writes it to the
…		…
860	the peer.	1040	the peer.
861		1041
862	You can rely on the normal read queue and C<on_eof> handling	1042	You can rely on the normal read queue and C<on_eof> handling
863	afterwards. This is the cleanest way to close a connection.	1043	afterwards. This is the cleanest way to close a connection.
864		1044
		1045	This method may invoke callbacks (and therefore the handle might be
		1046	destroyed after it returns).
		1047
865	=cut	1048	=cut
866		1049
867	sub push_shutdown {	1050	sub push_shutdown {
868	my ($self) = @_;	1051	my ($self) = @_;
869		1052
870	delete $self->{low_water_mark};	1053	delete $self->{low_water_mark};
871	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });	1054	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });
872	}	1055	}
873		1056
874	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	1057	=item custom write types - Package::anyevent_write_type $handle, @args
875		1058
876	This function (not method) lets you add your own types to C<push_write>.	1059	Instead of one of the predefined types, you can also specify the name of
		1060	a package. AnyEvent will try to load the package and then expects to find
		1061	a function named C<anyevent_write_type> inside. If it isn't found, it
		1062	progressively tries to load the parent package until it either finds the
		1063	function (good) or runs out of packages (bad).
		1064
877	Whenever the given C<type> is used, C<push_write> will invoke the code	1065	Whenever the given C<type> is used, C<push_write> will the function with
878	reference with the handle object and the remaining arguments.	1066	the handle object and the remaining arguments.
879		1067
880	The code reference is supposed to return a single octet string that will	1068	The function is supposed to return a single octet string that will be
881	be appended to the write buffer.	1069	appended to the write buffer, so you cna mentally treat this function as a
		1070	"arguments to on-the-wire-format" converter.
882		1071
883	Note that this is a function, and all types registered this way will be	1072	Example: implement a custom write type C<join> that joins the remaining
884	global, so try to use unique names.	1073	arguments using the first one.
		1074
		1075	$handle->push_write (My::Type => " ", 1,2,3);
		1076
		1077	# uses the following package, which can be defined in the "My::Type" or in
		1078	# the "My" modules to be auto-loaded, or just about anywhere when the
		1079	# My::Type::anyevent_write_type is defined before invoking it.
		1080
		1081	package My::Type;
		1082
		1083	sub anyevent_write_type {
		1084	my ($handle, $delim, @args) = @_;
		1085
		1086	join $delim, @args
		1087	}
885		1088
886	=cut	1089	=cut
887		1090
888	#############################################################################	1091	#############################################################################
889		1092
…		…
972		1175
973	sub _drain_rbuf {	1176	sub _drain_rbuf {
974	my ($self) = @_;	1177	my ($self) = @_;
975		1178
976	# avoid recursion	1179	# avoid recursion
977	return if exists $self->{_skip_drain_rbuf};	1180	return if $self->{_skip_drain_rbuf};
978	local $self->{_skip_drain_rbuf} = 1;	1181	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		1182
987	while () {	1183	while () {
988	# we need to use a separate tls read buffer, as we must not receive data while	1184	# 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.	1185	# we are draining the buffer, and this can only happen with TLS.
990	$self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf};	1186	$self->{rbuf} .= delete $self->{_tls_rbuf}
		1187	if exists $self->{_tls_rbuf};
991		1188
992	my $len = length $self->{rbuf};	1189	my $len = length $self->{rbuf};
993		1190
994	if (my $cb = shift @{ $self->{_queue} }) {	1191	if (my $cb = shift @{ $self->{_queue} }) {
995	unless ($cb->($self)) {	1192	unless ($cb->($self)) {
996	if ($self->{_eof}) {	1193	# no progress can be made
997	# no progress can be made (not enough data and no data forthcoming)	1194	# (not enough data and no data forthcoming)
998	$self->_error (Errno::EPIPE, 1), return;	1195	$self->_error (Errno::EPIPE, 1), return
999	}	1196	if $self->{_eof};
1000		1197
1001	unshift @{ $self->{_queue} }, $cb;	1198	unshift @{ $self->{_queue} }, $cb;
1002	last;	1199	last;
1003	}	1200	}
1004	} elsif ($self->{on_read}) {	1201	} elsif ($self->{on_read}) {
…		…
1024	last;	1221	last;
1025	}	1222	}
1026	}	1223	}
1027		1224
1028	if ($self->{_eof}) {	1225	if ($self->{_eof}) {
1029	if ($self->{on_eof}) {	1226	$self->{on_eof}
1030	$self->{on_eof}($self)	1227	? $self->{on_eof}($self)
1031	} else {
1032	$self->_error (0, 1, "Unexpected end-of-file");	1228	: $self->_error (0, 1, "Unexpected end-of-file");
1033	}	1229
		1230	return;
		1231	}
		1232
		1233	if (
		1234	defined $self->{rbuf_max}
		1235	&& $self->{rbuf_max} < length $self->{rbuf}
		1236	) {
		1237	$self->_error (Errno::ENOSPC, 1), return;
1034	}	1238	}
1035		1239
1036	# may need to restart read watcher	1240	# may need to restart read watcher
1037	unless ($self->{_rw}) {	1241	unless ($self->{_rw}) {
1038	$self->start_read	1242	$self->start_read
…		…
1043	=item $handle->on_read ($cb)	1247	=item $handle->on_read ($cb)
1044		1248
1045	This replaces the currently set C<on_read> callback, or clears it (when	1249	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	1250	the new callback is C<undef>). See the description of C<on_read> in the
1047	constructor.	1251	constructor.
		1252
		1253	This method may invoke callbacks (and therefore the handle might be
		1254	destroyed after it returns).
1048		1255
1049	=cut	1256	=cut
1050		1257
1051	sub on_read {	1258	sub on_read {
1052	my ($self, $cb) = @_;	1259	my ($self, $cb) = @_;
…		…
1092		1299
1093	If enough data was available, then the callback must remove all data it is	1300	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	1301	interested in (which can be none at all) and return a true value. After returning
1095	true, it will be removed from the queue.	1302	true, it will be removed from the queue.
1096		1303
		1304	These methods may invoke callbacks (and therefore the handle might be
		1305	destroyed after it returns).
		1306
1097	=cut	1307	=cut
1098		1308
1099	our %RH;	1309	our %RH;
1100		1310
1101	sub register_read_type($$) {	1311	sub register_read_type($$) {
…		…
1107	my $cb = pop;	1317	my $cb = pop;
1108		1318
1109	if (@_) {	1319	if (@_) {
1110	my $type = shift;	1320	my $type = shift;
1111		1321
		1322	$cb = ($RH{$type} \|\|= _load_func "$type\::anyevent_read_type"
1112	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	1323	or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_read")
1113	->($self, $cb, @_);	1324	->($self, $cb, @_);
1114	}	1325	}
1115		1326
1116	push @{ $self->{_queue} }, $cb;	1327	push @{ $self->{_queue} }, $cb;
1117	$self->_drain_rbuf;	1328	$self->_drain_rbuf;
…		…
1126		1337
1127	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")	1338	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")
1128	->($self, $cb, @_);	1339	->($self, $cb, @_);
1129	}	1340	}
1130		1341
1131
1132	unshift @{ $self->{_queue} }, $cb;	1342	unshift @{ $self->{_queue} }, $cb;
1133	$self->_drain_rbuf;	1343	$self->_drain_rbuf;
1134	}	1344	}
1135		1345
1136	=item $handle->push_read (type => @args, $cb)	1346	=item $handle->push_read (type => @args, $cb)
1137		1347
1138	=item $handle->unshift_read (type => @args, $cb)	1348	=item $handle->unshift_read (type => @args, $cb)
1139		1349
1140	Instead of providing a callback that parses the data itself you can chose	1350	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	1351	between a number of predefined parsing formats, for chunks of data, lines
1142	etc.	1352	etc. You can also specify the (fully qualified) name of a package, in
		1353	which case AnyEvent tries to load the package and then expects to find the
		1354	C<anyevent_read_type> function inside (see "custom read types", below).
1143		1355
1144	Predefined types are (if you have ideas for additional types, feel free to	1356	Predefined types are (if you have ideas for additional types, feel free to
1145	drop by and tell us):	1357	drop by and tell us):
1146		1358
1147	=over 4	1359	=over 4
…		…
1387	=cut	1599	=cut
1388		1600
1389	register_read_type json => sub {	1601	register_read_type json => sub {
1390	my ($self, $cb) = @_;	1602	my ($self, $cb) = @_;
1391		1603
1392	my $json = $self->{json} \|\|=	1604	my $json = $self->{json} \|\|= json_coder;
1393	eval { require JSON::XS; JSON::XS->new->utf8 }
1394	\|\| do { require JSON; JSON->new->utf8 };
1395		1605
1396	my $data;	1606	my $data;
1397	my $rbuf = \$self->{rbuf};	1607	my $rbuf = \$self->{rbuf};
1398		1608
1399	sub {	1609	sub {
…		…
1468	}	1678	}
1469	};	1679	};
1470		1680
1471	=back	1681	=back
1472		1682
1473	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)	1683	=item custom read types - Package::anyevent_read_type $handle, $cb, @args
1474		1684
1475	This function (not method) lets you add your own types to C<push_read>.	1685	Instead of one of the predefined types, you can also specify the name
		1686	of a package. AnyEvent will try to load the package and then expects to
		1687	find a function named C<anyevent_read_type> inside. If it isn't found, it
		1688	progressively tries to load the parent package until it either finds the
		1689	function (good) or runs out of packages (bad).
1476		1690
1477	Whenever the given C<type> is used, C<push_read> will invoke the code	1691	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	1692	handle object, the original callback and the remaining arguments.
1479	arguments.
1480		1693
1481	The code reference is supposed to return a callback (usually a closure)	1694	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) >>).	1695	works as a plain read callback (see C<< ->push_read ($cb) >>), so you can
		1696	mentally treat the function as a "configurable read type to read callback"
		1697	converter.
1483		1698
1484	It should invoke the passed callback when it is done reading (remember to	1699	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).	1700	to pass C<$handle> as first argument as all other callbacks do that,
		1701	although there is no strict requirement on this).
1486		1702
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>,	1703	For examples, see the source of this module (F<perldoc -m
1491	search for C<register_read_type>)).	1704	AnyEvent::Handle>, search for C<register_read_type>)).
1492		1705
1493	=item $handle->stop_read	1706	=item $handle->stop_read
1494		1707
1495	=item $handle->start_read	1708	=item $handle->start_read
1496		1709
…		…
1516	}	1729	}
1517		1730
1518	sub start_read {	1731	sub start_read {
1519	my ($self) = @_;	1732	my ($self) = @_;
1520		1733
1521	unless ($self->{_rw} \|\| $self->{_eof}) {	1734	unless ($self->{_rw} \|\| $self->{_eof} \|\| !$self->{fh}) {
1522	Scalar::Util::weaken $self;	1735	Scalar::Util::weaken $self;
1523		1736
1524	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1737	$self->{_rw} = AE::io $self->{fh}, 0, sub {
1525	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});	1738	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1526	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;	1739	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;
1527		1740
1528	if ($len > 0) {	1741	if ($len > 0) {
1529	$self->{_activity} = AnyEvent->now;	1742	$self->{_activity} = $self->{_ractivity} = AE::now;
1530		1743
1531	if ($self->{tls}) {	1744	if ($self->{tls}) {
1532	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);	1745	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1533		1746
1534	&_dotls ($self);	1747	&_dotls ($self);
…		…
1542	$self->_drain_rbuf;	1755	$self->_drain_rbuf;
1543		1756
1544	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1757	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1545	return $self->_error ($!, 1);	1758	return $self->_error ($!, 1);
1546	}	1759	}
1547	});	1760	};
1548	}	1761	}
1549	}	1762	}
1550		1763
1551	our $ERROR_SYSCALL;	1764	our $ERROR_SYSCALL;
1552	our $ERROR_WANT_READ;	1765	our $ERROR_WANT_READ;
…		…
1619	&& ($tmp != $ERROR_SYSCALL \|\| $!);	1832	&& ($tmp != $ERROR_SYSCALL \|\| $!);
1620		1833
1621	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1834	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1622	$self->{wbuf} .= $tmp;	1835	$self->{wbuf} .= $tmp;
1623	$self->_drain_wbuf;	1836	$self->_drain_wbuf;
		1837	$self->{tls} or return; # tls session might have gone away in callback
1624	}	1838	}
1625		1839
1626	$self->{_on_starttls}	1840	$self->{_on_starttls}
1627	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()	1841	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
1628	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");	1842	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	1863	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	1864	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	1865	changed to your liking. Note that the handshake might have already started
1652	when this function returns.	1866	when this function returns.
1653		1867
1654	If it an error to start a TLS handshake more than once per	1868	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).	1869	handshakes on the same stream. Best do not attempt to use the stream after
		1870	stopping TLS.
		1871
		1872	This method may invoke callbacks (and therefore the handle might be
		1873	destroyed after it returns).
1656		1874
1657	=cut	1875	=cut
1658		1876
1659	our %TLS_CACHE; #TODO not yet documented, should we?	1877	our %TLS_CACHE; #TODO not yet documented, should we?
1660		1878
1661	sub starttls {	1879	sub starttls {
1662	my ($self, $ssl, $ctx) = @_;	1880	my ($self, $tls, $ctx) = @_;
		1881
		1882	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"
		1883	if $self->{tls};
		1884
		1885	$self->{tls} = $tls;
		1886	$self->{tls_ctx} = $ctx if @_ > 2;
		1887
		1888	return unless $self->{fh};
1663		1889
1664	require Net::SSLeay;	1890	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		1891
1669	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();	1892	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1670	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();	1893	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1671		1894
		1895	$tls = delete $self->{tls};
1672	$ctx \|\|= $self->{tls_ctx};	1896	$ctx = $self->{tls_ctx};
1673		1897
1674	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session	1898	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
1675		1899
1676	if ("HASH" eq ref $ctx) {	1900	if ("HASH" eq ref $ctx) {
1677	require AnyEvent::TLS;	1901	require AnyEvent::TLS;
…		…
1683	$ctx = new AnyEvent::TLS %$ctx;	1907	$ctx = new AnyEvent::TLS %$ctx;
1684	}	1908	}
1685	}	1909	}
1686		1910
1687	$self->{tls_ctx} = $ctx \|\| TLS_CTX ();	1911	$self->{tls_ctx} = $ctx \|\| TLS_CTX ();
1688	$self->{tls} = $ssl = $self->{tls_ctx}->_get_session ($ssl, $self, $self->{peername});	1912	$self->{tls} = $tls = $self->{tls_ctx}->_get_session ($tls, $self, $self->{peername});
1689		1913
1690	# basically, this is deep magic (because SSL_read should have the same issues)	1914	# 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".	1915	# but the openssl maintainers basically said: "trust us, it just works".
1692	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1916	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1693	# and mismaintained ssleay-module doesn't even offer them).	1917	# 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	1924	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
1701	# have identity issues in that area.	1925	# have identity issues in that area.
1702	# Net::SSLeay::CTX_set_mode ($ssl,	1926	# Net::SSLeay::CTX_set_mode ($ssl,
1703	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1927	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
1704	# \| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));	1928	# \| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
1705	Net::SSLeay::CTX_set_mode ($ssl, 1\|2);	1929	Net::SSLeay::CTX_set_mode ($tls, 1\|2);
1706		1930
1707	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1931	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1708	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1932	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1709		1933
		1934	Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf});
		1935
1710	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1936	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
1711		1937
1712	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }	1938	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1713	if $self->{on_starttls};	1939	if $self->{on_starttls};
1714		1940
1715	&_dotls; # need to trigger the initial handshake	1941	&_dotls; # need to trigger the initial handshake
…		…
1718		1944
1719	=item $handle->stoptls	1945	=item $handle->stoptls
1720		1946
1721	Shuts down the SSL connection - this makes a proper EOF handshake by	1947	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	1948	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	1949	support non-blocking shut downs, it is not guaranteed that you can re-use
1724	afterwards.	1950	the stream afterwards.
		1951
		1952	This method may invoke callbacks (and therefore the handle might be
		1953	destroyed after it returns).
1725		1954
1726	=cut	1955	=cut
1727		1956
1728	sub stoptls {	1957	sub stoptls {
1729	my ($self) = @_;	1958	my ($self) = @_;
1730		1959
1731	if ($self->{tls}) {	1960	if ($self->{tls} && $self->{fh}) {
1732	Net::SSLeay::shutdown ($self->{tls});	1961	Net::SSLeay::shutdown ($self->{tls});
1733		1962
1734	&_dotls;	1963	&_dotls;
1735		1964
1736	# # we don't give a shit. no, we do, but we can't. no...#d#	1965	# # we don't give a shit. no, we do, but we can't. no...#d#
…		…
1742	sub _freetls {	1971	sub _freetls {
1743	my ($self) = @_;	1972	my ($self) = @_;
1744		1973
1745	return unless $self->{tls};	1974	return unless $self->{tls};
1746		1975
1747	$self->{tls_ctx}->_put_session (delete $self->{tls});	1976	$self->{tls_ctx}->_put_session (delete $self->{tls})
		1977	if $self->{tls} > 0;
1748		1978
1749	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};	1979	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1750	}	1980	}
1751		1981
1752	sub DESTROY {	1982	sub DESTROY {
…		…
1760	my $fh = delete $self->{fh};	1990	my $fh = delete $self->{fh};
1761	my $wbuf = delete $self->{wbuf};	1991	my $wbuf = delete $self->{wbuf};
1762		1992
1763	my @linger;	1993	my @linger;
1764		1994
1765	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {	1995	push @linger, AE::io $fh, 1, sub {
1766	my $len = syswrite $fh, $wbuf, length $wbuf;	1996	my $len = syswrite $fh, $wbuf, length $wbuf;
1767		1997
1768	if ($len > 0) {	1998	if ($len > 0) {
1769	substr $wbuf, 0, $len, "";	1999	substr $wbuf, 0, $len, "";
1770	} else {	2000	} else {
1771	@linger = (); # end	2001	@linger = (); # end
1772	}	2002	}
1773	});	2003	};
1774	push @linger, AnyEvent->timer (after => $linger, cb => sub {	2004	push @linger, AE::timer $linger, 0, sub {
1775	@linger = ();	2005	@linger = ();
1776	});	2006	};
1777	}	2007	}
1778	}	2008	}
1779		2009
1780	=item $handle->destroy	2010	=item $handle->destroy
1781		2011
1782	Shuts down the handle object as much as possible - this call ensures that	2012	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	2013	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.	2014	will be freed. Any method you will call on the handle object after
		2015	destroying it in this way will be silently ignored (and it will return the
		2016	empty list).
1785		2017
1786	Normally, you can just "forget" any references to an AnyEvent::Handle	2018	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	2019	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	2020	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	2021	callback, so when you want to destroy the AnyEvent::Handle object from
…		…
1803	sub destroy {	2035	sub destroy {
1804	my ($self) = @_;	2036	my ($self) = @_;
1805		2037
1806	$self->DESTROY;	2038	$self->DESTROY;
1807	%$self = ();	2039	%$self = ();
		2040	bless $self, "AnyEvent::Handle::destroyed";
1808	}	2041	}
		2042
		2043	sub AnyEvent::Handle::destroyed::AUTOLOAD {
		2044	#nop
		2045	}
		2046
		2047	=item $handle->destroyed
		2048
		2049	Returns false as long as the handle hasn't been destroyed by a call to C<<
		2050	->destroy >>, true otherwise.
		2051
		2052	Can be useful to decide whether the handle is still valid after some
		2053	callback possibly destroyed the handle. For example, C<< ->push_write >>,
		2054	C<< ->starttls >> and other methods can call user callbacks, which in turn
		2055	can destroy the handle, so work can be avoided by checking sometimes:
		2056
		2057	$hdl->starttls ("accept");
		2058	return if $hdl->destroyed;
		2059	$hdl->push_write (...
		2060
		2061	Note that the call to C<push_write> will silently be ignored if the handle
		2062	has been destroyed, so often you can just ignore the possibility of the
		2063	handle being destroyed.
		2064
		2065	=cut
		2066
		2067	sub destroyed { 0 }
		2068	sub AnyEvent::Handle::destroyed::destroyed { 1 }
1809		2069
1810	=item AnyEvent::Handle::TLS_CTX	2070	=item AnyEvent::Handle::TLS_CTX
1811		2071
1812	This function creates and returns the AnyEvent::TLS object used by default	2072	This function creates and returns the AnyEvent::TLS object used by default
1813	for TLS mode.	2073	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.193 by root, Mon Mar 15 18:51:30 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.193 by root, Mon Mar 15 18:51:30 2010 UTC