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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.161 by root, Sat Jul 25 06:16:45 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
…		…
113		129
114	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
115	parameters, together with a retry callback.	131	parameters, together with a retry callback.
116		132
117	When, for some reason, the handle is not acceptable, then calling	133	When, for some reason, the handle is not acceptable, then calling
118	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
119	multi-homed hosts or SRV records there can be multiple connection	135	multi-homed hosts or SRV records there can be multiple connection
120	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
121	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.
122		139
123	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.
124		141
125	=item on_connect_error => $cb->($handle, $message)	142	=item on_connect_error => $cb->($handle, $message)
126		143
127	This callback is called when the conenction could not be	144	This callback is called when the connection could not be
128	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
129	message describing it (usually the same as C<"$!">).	146	message describing it (usually the same as C<"$!">).
130		147
131	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
132	fatal error instead.	149	fatal error instead.
…		…
216	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
217	the file when the write queue becomes empty.	234	the file when the write queue becomes empty.
218		235
219	=item timeout => $fractional_seconds	236	=item timeout => $fractional_seconds
220		237
		238	=item rtimeout => $fractional_seconds
		239
		240	=item wtimeout => $fractional_seconds
		241
221	If non-zero, then this enables an "inactivity" timeout: whenever this many	242	If non-zero, then these enables an "inactivity" timeout: whenever this
222	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
223	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
224	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>.
225		253
226	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
227	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
228	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
229	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
…		…
273	accomplishd by setting this option to a true value.	301	accomplishd by setting this option to a true value.
274		302
275	The default is your opertaing system's default behaviour (most likely	303	The default is your opertaing system's default behaviour (most likely
276	enabled), this option explicitly enables or disables it, if possible.	304	enabled), this option explicitly enables or disables it, if possible.
277		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
278	=item read_size => <bytes>	338	=item read_size => <bytes>
279		339
280	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
281	try to read during each loop iteration, which affects memory	341	try to read during each loop iteration, which affects memory
282	requirements). Default: C<8192>.	342	requirements). Default: C<8192>.
…		…
315	C<undef>.	375	C<undef>.
316		376
317	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	377	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
318		378
319	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
320	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
321	established and will transparently encrypt/decrypt data afterwards.	381	established and will transparently encrypt/decrypt data afterwards.
322		382
323	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
324	appropriate error message.	384	appropriate error message.
325		385
…		…
438	delete $self->{_skip_drain_rbuf};	498	delete $self->{_skip_drain_rbuf};
439	$self->_start;	499	$self->_start;
440		500
441	$self->{on_connect}	501	$self->{on_connect}
442	and $self->{on_connect}($self, $host, $port, sub {	502	and $self->{on_connect}($self, $host, $port, sub {
443	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)};
444	$self->{_skip_drain_rbuf} = 1;	504	$self->{_skip_drain_rbuf} = 1;
445	&$retry;	505	&$retry;
446	});	506	});
447		507
448	} else {	508	} else {
…		…
474	sub _start {	534	sub _start {
475	my ($self) = @_;	535	my ($self) = @_;
476		536
477	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	537	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
478		538
		539	$self->{_activity} =
		540	$self->{_ractivity} =
479	$self->{_activity} = AnyEvent->now;	541	$self->{_wactivity} = AE::now;
480	$self->_timeout;
481		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
482	$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};
483		549
		550	$self->oobinline (exists $self->{oobinline} ? delete $self->{oobinline} : 1);
		551
484	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})	552	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
485	if $self->{tls};	553	if $self->{tls};
486		554
487	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	555	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
488		556
489	$self->start_read	557	$self->start_read
490	if $self->{on_read} \|\| @{ $self->{_queue} };	558	if $self->{on_read} \|\| @{ $self->{_queue} };
491		559
492	$self->_drain_wbuf;	560	$self->_drain_wbuf;
493	}	561	}
494
495	#sub _shutdown {
496	# my ($self) = @_;
497	#
498	# delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)};
499	# $self->{_eof} = 1; # tell starttls et. al to stop trying
500	#
501	# &_freetls;
502	#}
503		562
504	sub _error {	563	sub _error {
505	my ($self, $errno, $fatal, $message) = @_;	564	my ($self, $errno, $fatal, $message) = @_;
506		565
507	$! = $errno;	566	$! = $errno;
508	$message \|\|= "$!";	567	$message \|\|= "$!";
509		568
510	if ($self->{on_error}) {	569	if ($self->{on_error}) {
511	$self->{on_error}($self, $fatal, $message);	570	$self->{on_error}($self, $fatal, $message);
512	$self->destroy if $fatal;	571	$self->destroy if $fatal;
513	} elsif ($self->{fh}) {	572	} elsif ($self->{fh} \|\| $self->{connect}) {
514	$self->destroy;	573	$self->destroy;
515	Carp::croak "AnyEvent::Handle uncaught error: $message";	574	Carp::croak "AnyEvent::Handle uncaught error: $message";
516	}	575	}
517	}	576	}
518		577
…		…
544	$_[0]{on_eof} = $_[1];	603	$_[0]{on_eof} = $_[1];
545	}	604	}
546		605
547	=item $handle->on_timeout ($cb)	606	=item $handle->on_timeout ($cb)
548		607
549	Replace the current C<on_timeout> callback, or disables the callback (but	608	=item $handle->on_rtimeout ($cb)
550	not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
551	argument and method.
552		609
553	=cut	610	=item $handle->on_wtimeout ($cb)
554		611
555	sub on_timeout {	612	Replace the current C<on_timeout>, C<on_rtimeout> or C<on_wtimeout>
556	$_[0]{on_timeout} = $_[1];	613	callback, or disables the callback (but not the timeout) if C<$cb> =
557	}	614	C<undef>. See the C<timeout> constructor argument and method.
		615
		616	=cut
		617
		618	# see below
558		619
559	=item $handle->autocork ($boolean)	620	=item $handle->autocork ($boolean)
560		621
561	Enables or disables the current autocork behaviour (see C<autocork>	622	Enables or disables the current autocork behaviour (see C<autocork>
562	constructor argument). Changes will only take effect on the next write.	623	constructor argument). Changes will only take effect on the next write.
…		…
577	sub no_delay {	638	sub no_delay {
578	$_[0]{no_delay} = $_[1];	639	$_[0]{no_delay} = $_[1];
579		640
580	eval {	641	eval {
581	local $SIG{__DIE__};	642	local $SIG{__DIE__};
582	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1]	643	setsockopt $_[0]{fh}, Socket::IPPROTO_TCP (), Socket::TCP_NODELAY (), int $_[1]
583	if $_[0]{fh};	644	if $_[0]{fh};
584	};	645	};
585	}	646	}
586		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
587	=item $handle->on_starttls ($cb)	699	=item $handle->on_starttls ($cb)
588		700
589	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).
590		702
591	=cut	703	=cut
…		…
598		710
599	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).
600		712
601	=cut	713	=cut
602		714
603	sub on_starttls {	715	sub on_stoptls {
604	$_[0]{on_stoptls} = $_[1];	716	$_[0]{on_stoptls} = $_[1];
605	}	717	}
606		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
607	#############################################################################	729	#############################################################################
608		730
609	=item $handle->timeout ($seconds)	731	=item $handle->timeout ($seconds)
610		732
		733	=item $handle->rtimeout ($seconds)
		734
		735	=item $handle->wtimeout ($seconds)
		736
611	Configures (or disables) the inactivity timeout.	737	Configures (or disables) the inactivity timeout.
612		738
613	=cut	739	=item $handle->timeout_reset
614		740
615	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 {
616	my ($self, $timeout) = @_;	763	my ($self, $new_value) = @_;
617		764
618	$self->{timeout} = $timeout;	765	$self->{$timeout} = $new_value;
619	$self->_timeout;	766	delete $self->{$tw}; &$cb;
620	}	767	};
621		768
		769	*{"${dir}timeout_reset"} = sub {
		770	$_[0]{$activity} = AE::now;
		771	};
		772
		773	# main workhorse:
622	# reset the timeout watcher, as neccessary	774	# reset the timeout watcher, as neccessary
623	# also check for time-outs	775	# also check for time-outs
624	sub _timeout {	776	$cb = sub {
625	my ($self) = @_;	777	my ($self) = @_;
626		778
627	if ($self->{timeout} && $self->{fh}) {	779	if ($self->{$timeout} && $self->{fh}) {
628	my $NOW = AnyEvent->now;	780	my $NOW = AE::now;
629		781
630	# when would the timeout trigger?	782	# when would the timeout trigger?
631	my $after = $self->{_activity} + $self->{timeout} - $NOW;	783	my $after = $self->{$activity} + $self->{$timeout} - $NOW;
632		784
633	# now or in the past already?	785	# now or in the past already?
634	if ($after <= 0) {	786	if ($after <= 0) {
635	$self->{_activity} = $NOW;	787	$self->{$activity} = $NOW;
636		788
637	if ($self->{on_timeout}) {	789	if ($self->{$on_timeout}) {
638	$self->{on_timeout}($self);	790	$self->{$on_timeout}($self);
639	} else {	791	} else {
640	$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};
641	}	800	}
642		801
643	# callback could have changed timeout value, optimise	802	Scalar::Util::weaken $self;
644	return unless $self->{timeout};	803	return unless $self; # ->error could have destroyed $self
645		804
646	# calculate new after	805	$self->{$tw} \|\|= AE::timer $after, 0, sub {
647	$after = $self->{timeout};	806	delete $self->{$tw};
		807	$cb->($self);
		808	};
		809	} else {
		810	delete $self->{$tw};
648	}	811	}
649
650	Scalar::Util::weaken $self;
651	return unless $self; # ->error could have destroyed $self
652
653	$self->{_tw} \|\|= AnyEvent->timer (after => $after, cb => sub {
654	delete $self->{_tw};
655	$self->_timeout;
656	});
657	} else {
658	delete $self->{_tw};
659	}	812	}
660	}	813	}
661		814
662	#############################################################################	815	#############################################################################
663		816
…		…
678		831
679	=item $handle->on_drain ($cb)	832	=item $handle->on_drain ($cb)
680		833
681	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
682	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).
683		839
684	=cut	840	=cut
685		841
686	sub on_drain {	842	sub on_drain {
687	my ($self, $cb) = @_;	843	my ($self, $cb) = @_;
…		…
696		852
697	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
698	want (only limited by the available memory), as C<AnyEvent::Handle>	854	want (only limited by the available memory), as C<AnyEvent::Handle>
699	buffers it independently of the kernel.	855	buffers it independently of the kernel.
700		856
		857	This method may invoke callbacks (and therefore the handle might be
		858	destroyed after it returns).
		859
701	=cut	860	=cut
702		861
703	sub _drain_wbuf {	862	sub _drain_wbuf {
704	my ($self) = @_;	863	my ($self) = @_;
705		864
…		…
711	my $len = syswrite $self->{fh}, $self->{wbuf};	870	my $len = syswrite $self->{fh}, $self->{wbuf};
712		871
713	if (defined $len) {	872	if (defined $len) {
714	substr $self->{wbuf}, 0, $len, "";	873	substr $self->{wbuf}, 0, $len, "";
715		874
716	$self->{_activity} = AnyEvent->now;	875	$self->{_activity} = $self->{_wactivity} = AE::now;
717		876
718	$self->{on_drain}($self)	877	$self->{on_drain}($self)
719	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})
720	&& $self->{on_drain};	879	&& $self->{on_drain};
721		880
…		…
727		886
728	# try to write data immediately	887	# try to write data immediately
729	$cb->() unless $self->{autocork};	888	$cb->() unless $self->{autocork};
730		889
731	# if still data left in wbuf, we need to poll	890	# if still data left in wbuf, we need to poll
732	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	891	$self->{_ww} = AE::io $self->{fh}, 1, $cb
733	if length $self->{wbuf};	892	if length $self->{wbuf};
734	};	893	};
735	}	894	}
736		895
737	our %WH;	896	our %WH;
738		897
		898	# deprecated
739	sub register_write_type($$) {	899	sub register_write_type($$) {
740	$WH{$_[0]} = $_[1];	900	$WH{$_[0]} = $_[1];
741	}	901	}
742		902
743	sub push_write {	903	sub push_write {
744	my $self = shift;	904	my $self = shift;
745		905
746	if (@_ > 1) {	906	if (@_ > 1) {
747	my $type = shift;	907	my $type = shift;
748		908
		909	@_ = ($WH{$type} \|\|= _load_func "$type\::anyevent_write_type"
749	@_ = ($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")
750	->($self, @_);	911	->($self, @_);
751	}	912	}
752		913
		914	# we downgrade here to avoid hard-to-track-down bugs,
		915	# and diagnose the problem earlier and better.
		916
753	if ($self->{tls}) {	917	if ($self->{tls}) {
754	$self->{_tls_wbuf} .= $_[0];	918	utf8::downgrade $self->{_tls_wbuf} .= $_[0];
755	&_dotls ($self) if $self->{fh};	919	&_dotls ($self) if $self->{fh};
756	} else {	920	} else {
757	$self->{wbuf} .= $_[0];	921	utf8::downgrade $self->{wbuf} .= $_[0];
758	$self->_drain_wbuf if $self->{fh};	922	$self->_drain_wbuf if $self->{fh};
759	}	923	}
760	}	924	}
761		925
762	=item $handle->push_write (type => @args)	926	=item $handle->push_write (type => @args)
763		927
764	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
765	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).
766		933
767	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
768	drop by and tell us):	935	drop by and tell us):
769		936
770	=over 4	937	=over 4
…		…
827	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
828	this line into their JSON decoder of choice.	995	this line into their JSON decoder of choice.
829		996
830	=cut	997	=cut
831		998
		999	sub json_coder() {
		1000	eval { require JSON::XS; JSON::XS->new->utf8 }
		1001	\|\| do { require JSON; JSON->new->utf8 }
		1002	}
		1003
832	register_write_type json => sub {	1004	register_write_type json => sub {
833	my ($self, $ref) = @_;	1005	my ($self, $ref) = @_;
834		1006
835	require JSON;	1007	my $json = $self->{json} \|\|= json_coder;
836		1008
837	$self->{json} ? $self->{json}->encode ($ref)	1009	$json->encode ($ref)
838	: JSON::encode_json ($ref)
839	};	1010	};
840		1011
841	=item storable => $reference	1012	=item storable => $reference
842		1013
843	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
…		…
869	the peer.	1040	the peer.
870		1041
871	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
872	afterwards. This is the cleanest way to close a connection.	1043	afterwards. This is the cleanest way to close a connection.
873		1044
		1045	This method may invoke callbacks (and therefore the handle might be
		1046	destroyed after it returns).
		1047
874	=cut	1048	=cut
875		1049
876	sub push_shutdown {	1050	sub push_shutdown {
877	my ($self) = @_;	1051	my ($self) = @_;
878		1052
879	delete $self->{low_water_mark};	1053	delete $self->{low_water_mark};
880	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });	1054	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });
881	}	1055	}
882		1056
883	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	1057	=item custom write types - Package::anyevent_write_type $handle, @args
884		1058
885	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
886	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
887	reference with the handle object and the remaining arguments.	1066	the handle object and the remaining arguments.
888		1067
889	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
890	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.
891		1071
892	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
893	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	}
894		1088
895	=cut	1089	=cut
896		1090
897	#############################################################################	1091	#############################################################################
898		1092
…		…
981		1175
982	sub _drain_rbuf {	1176	sub _drain_rbuf {
983	my ($self) = @_;	1177	my ($self) = @_;
984		1178
985	# avoid recursion	1179	# avoid recursion
986	return if exists $self->{_skip_drain_rbuf};	1180	return if $self->{_skip_drain_rbuf};
987	local $self->{_skip_drain_rbuf} = 1;	1181	local $self->{_skip_drain_rbuf} = 1;
988
989	if (
990	defined $self->{rbuf_max}
991	&& $self->{rbuf_max} < length $self->{rbuf}
992	) {
993	$self->_error (Errno::ENOSPC, 1), return;
994	}
995		1182
996	while () {	1183	while () {
997	# 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
998	# 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.
999	$self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf};	1186	$self->{rbuf} .= delete $self->{_tls_rbuf}
		1187	if exists $self->{_tls_rbuf};
1000		1188
1001	my $len = length $self->{rbuf};	1189	my $len = length $self->{rbuf};
1002		1190
1003	if (my $cb = shift @{ $self->{_queue} }) {	1191	if (my $cb = shift @{ $self->{_queue} }) {
1004	unless ($cb->($self)) {	1192	unless ($cb->($self)) {
1005	if ($self->{_eof}) {	1193	# no progress can be made
1006	# no progress can be made (not enough data and no data forthcoming)	1194	# (not enough data and no data forthcoming)
1007	$self->_error (Errno::EPIPE, 1), return;	1195	$self->_error (Errno::EPIPE, 1), return
1008	}	1196	if $self->{_eof};
1009		1197
1010	unshift @{ $self->{_queue} }, $cb;	1198	unshift @{ $self->{_queue} }, $cb;
1011	last;	1199	last;
1012	}	1200	}
1013	} elsif ($self->{on_read}) {	1201	} elsif ($self->{on_read}) {
…		…
1033	last;	1221	last;
1034	}	1222	}
1035	}	1223	}
1036		1224
1037	if ($self->{_eof}) {	1225	if ($self->{_eof}) {
1038	if ($self->{on_eof}) {	1226	$self->{on_eof}
1039	$self->{on_eof}($self)	1227	? $self->{on_eof}($self)
1040	} else {
1041	$self->_error (0, 1, "Unexpected end-of-file");	1228	: $self->_error (0, 1, "Unexpected end-of-file");
1042	}	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;
1043	}	1238	}
1044		1239
1045	# may need to restart read watcher	1240	# may need to restart read watcher
1046	unless ($self->{_rw}) {	1241	unless ($self->{_rw}) {
1047	$self->start_read	1242	$self->start_read
…		…
1052	=item $handle->on_read ($cb)	1247	=item $handle->on_read ($cb)
1053		1248
1054	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
1055	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
1056	constructor.	1251	constructor.
		1252
		1253	This method may invoke callbacks (and therefore the handle might be
		1254	destroyed after it returns).
1057		1255
1058	=cut	1256	=cut
1059		1257
1060	sub on_read {	1258	sub on_read {
1061	my ($self, $cb) = @_;	1259	my ($self, $cb) = @_;
…		…
1101		1299
1102	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
1103	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
1104	true, it will be removed from the queue.	1302	true, it will be removed from the queue.
1105		1303
		1304	These methods may invoke callbacks (and therefore the handle might be
		1305	destroyed after it returns).
		1306
1106	=cut	1307	=cut
1107		1308
1108	our %RH;	1309	our %RH;
1109		1310
1110	sub register_read_type($$) {	1311	sub register_read_type($$) {
…		…
1116	my $cb = pop;	1317	my $cb = pop;
1117		1318
1118	if (@_) {	1319	if (@_) {
1119	my $type = shift;	1320	my $type = shift;
1120		1321
		1322	$cb = ($RH{$type} \|\|= _load_func "$type\::anyevent_read_type"
1121	$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")
1122	->($self, $cb, @_);	1324	->($self, $cb, @_);
1123	}	1325	}
1124		1326
1125	push @{ $self->{_queue} }, $cb;	1327	push @{ $self->{_queue} }, $cb;
1126	$self->_drain_rbuf;	1328	$self->_drain_rbuf;
…		…
1135		1337
1136	$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")
1137	->($self, $cb, @_);	1339	->($self, $cb, @_);
1138	}	1340	}
1139		1341
1140
1141	unshift @{ $self->{_queue} }, $cb;	1342	unshift @{ $self->{_queue} }, $cb;
1142	$self->_drain_rbuf;	1343	$self->_drain_rbuf;
1143	}	1344	}
1144		1345
1145	=item $handle->push_read (type => @args, $cb)	1346	=item $handle->push_read (type => @args, $cb)
1146		1347
1147	=item $handle->unshift_read (type => @args, $cb)	1348	=item $handle->unshift_read (type => @args, $cb)
1148		1349
1149	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
1150	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
1151	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).
1152		1355
1153	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
1154	drop by and tell us):	1357	drop by and tell us):
1155		1358
1156	=over 4	1359	=over 4
…		…
1396	=cut	1599	=cut
1397		1600
1398	register_read_type json => sub {	1601	register_read_type json => sub {
1399	my ($self, $cb) = @_;	1602	my ($self, $cb) = @_;
1400		1603
1401	my $json = $self->{json} \|\|=	1604	my $json = $self->{json} \|\|= json_coder;
1402	eval { require JSON::XS; JSON::XS->new->utf8 }
1403	\|\| do { require JSON; JSON->new->utf8 };
1404		1605
1405	my $data;	1606	my $data;
1406	my $rbuf = \$self->{rbuf};	1607	my $rbuf = \$self->{rbuf};
1407		1608
1408	sub {	1609	sub {
…		…
1477	}	1678	}
1478	};	1679	};
1479		1680
1480	=back	1681	=back
1481		1682
1482	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)	1683	=item custom read types - Package::anyevent_read_type $handle, $cb, @args
1483		1684
1484	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).
1485		1690
1486	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
1487	reference with the handle object, the callback and the remaining	1692	handle object, the original callback and the remaining arguments.
1488	arguments.
1489		1693
1490	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
1491	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.
1492		1698
1493	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
1494	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).
1495		1702
1496	Note that this is a function, and all types registered this way will be
1497	global, so try to use unique names.
1498
1499	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
1500	search for C<register_read_type>)).	1704	AnyEvent::Handle>, search for C<register_read_type>)).
1501		1705
1502	=item $handle->stop_read	1706	=item $handle->stop_read
1503		1707
1504	=item $handle->start_read	1708	=item $handle->start_read
1505		1709
…		…
1525	}	1729	}
1526		1730
1527	sub start_read {	1731	sub start_read {
1528	my ($self) = @_;	1732	my ($self) = @_;
1529		1733
1530	unless ($self->{_rw} \|\| $self->{_eof}) {	1734	unless ($self->{_rw} \|\| $self->{_eof} \|\| !$self->{fh}) {
1531	Scalar::Util::weaken $self;	1735	Scalar::Util::weaken $self;
1532		1736
1533	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1737	$self->{_rw} = AE::io $self->{fh}, 0, sub {
1534	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});	1738	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1535	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;
1536		1740
1537	if ($len > 0) {	1741	if ($len > 0) {
1538	$self->{_activity} = AnyEvent->now;	1742	$self->{_activity} = $self->{_ractivity} = AE::now;
1539		1743
1540	if ($self->{tls}) {	1744	if ($self->{tls}) {
1541	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);	1745	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1542		1746
1543	&_dotls ($self);	1747	&_dotls ($self);
…		…
1551	$self->_drain_rbuf;	1755	$self->_drain_rbuf;
1552		1756
1553	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1757	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1554	return $self->_error ($!, 1);	1758	return $self->_error ($!, 1);
1555	}	1759	}
1556	});	1760	};
1557	}	1761	}
1558	}	1762	}
1559		1763
1560	our $ERROR_SYSCALL;	1764	our $ERROR_SYSCALL;
1561	our $ERROR_WANT_READ;	1765	our $ERROR_WANT_READ;
…		…
1628	&& ($tmp != $ERROR_SYSCALL \|\| $!);	1832	&& ($tmp != $ERROR_SYSCALL \|\| $!);
1629		1833
1630	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1834	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1631	$self->{wbuf} .= $tmp;	1835	$self->{wbuf} .= $tmp;
1632	$self->_drain_wbuf;	1836	$self->_drain_wbuf;
		1837	$self->{tls} or return; # tls session might have gone away in callback
1633	}	1838	}
1634		1839
1635	$self->{_on_starttls}	1840	$self->{_on_starttls}
1636	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()	1841	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
1637	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");	1842	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");
…		…
1662		1867
1663	Due to bugs in OpenSSL, it might or might not be possible to do multiple	1868	Due to bugs in OpenSSL, it might or might not be possible to do multiple
1664	handshakes on the same stream. Best do not attempt to use the stream after	1869	handshakes on the same stream. Best do not attempt to use the stream after
1665	stopping TLS.	1870	stopping TLS.
1666		1871
		1872	This method may invoke callbacks (and therefore the handle might be
		1873	destroyed after it returns).
		1874
1667	=cut	1875	=cut
1668		1876
1669	our %TLS_CACHE; #TODO not yet documented, should we?	1877	our %TLS_CACHE; #TODO not yet documented, should we?
1670		1878
1671	sub starttls {	1879	sub starttls {
…		…
1682	require Net::SSLeay;	1890	require Net::SSLeay;
1683		1891
1684	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();	1892	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1685	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();	1893	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1686		1894
1687	$tls = $self->{tls};	1895	$tls = delete $self->{tls};
1688	$ctx = $self->{tls_ctx};	1896	$ctx = $self->{tls_ctx};
1689		1897
1690	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
1691		1899
1692	if ("HASH" eq ref $ctx) {	1900	if ("HASH" eq ref $ctx) {
…		…
1721	Net::SSLeay::CTX_set_mode ($tls, 1\|2);	1929	Net::SSLeay::CTX_set_mode ($tls, 1\|2);
1722		1930
1723	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1931	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1724	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1932	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1725		1933
		1934	Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf});
		1935
1726	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});	1936	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
1727		1937
1728	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }	1938	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1729	if $self->{on_starttls};	1939	if $self->{on_starttls};
1730		1940
…		…
1734		1944
1735	=item $handle->stoptls	1945	=item $handle->stoptls
1736		1946
1737	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
1738	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
1739	support non-blocking shut downs, it is not guarenteed that you can re-use	1949	support non-blocking shut downs, it is not guaranteed that you can re-use
1740	the stream afterwards.	1950	the stream afterwards.
		1951
		1952	This method may invoke callbacks (and therefore the handle might be
		1953	destroyed after it returns).
1741		1954
1742	=cut	1955	=cut
1743		1956
1744	sub stoptls {	1957	sub stoptls {
1745	my ($self) = @_;	1958	my ($self) = @_;
1746		1959
1747	if ($self->{tls}) {	1960	if ($self->{tls} && $self->{fh}) {
1748	Net::SSLeay::shutdown ($self->{tls});	1961	Net::SSLeay::shutdown ($self->{tls});
1749		1962
1750	&_dotls;	1963	&_dotls;
1751		1964
1752	# # 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#
…		…
1759	my ($self) = @_;	1972	my ($self) = @_;
1760		1973
1761	return unless $self->{tls};	1974	return unless $self->{tls};
1762		1975
1763	$self->{tls_ctx}->_put_session (delete $self->{tls})	1976	$self->{tls_ctx}->_put_session (delete $self->{tls})
1764	if ref $self->{tls};	1977	if $self->{tls} > 0;
1765		1978
1766	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};	1979	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1767	}	1980	}
1768		1981
1769	sub DESTROY {	1982	sub DESTROY {
…		…
1777	my $fh = delete $self->{fh};	1990	my $fh = delete $self->{fh};
1778	my $wbuf = delete $self->{wbuf};	1991	my $wbuf = delete $self->{wbuf};
1779		1992
1780	my @linger;	1993	my @linger;
1781		1994
1782	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {	1995	push @linger, AE::io $fh, 1, sub {
1783	my $len = syswrite $fh, $wbuf, length $wbuf;	1996	my $len = syswrite $fh, $wbuf, length $wbuf;
1784		1997
1785	if ($len > 0) {	1998	if ($len > 0) {
1786	substr $wbuf, 0, $len, "";	1999	substr $wbuf, 0, $len, "";
1787	} else {	2000	} else {
1788	@linger = (); # end	2001	@linger = (); # end
1789	}	2002	}
1790	});	2003	};
1791	push @linger, AnyEvent->timer (after => $linger, cb => sub {	2004	push @linger, AE::timer $linger, 0, sub {
1792	@linger = ();	2005	@linger = ();
1793	});	2006	};
1794	}	2007	}
1795	}	2008	}
1796		2009
1797	=item $handle->destroy	2010	=item $handle->destroy
1798		2011
1799	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
1800	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
1801	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).
1802		2017
1803	Normally, you can just "forget" any references to an AnyEvent::Handle	2018	Normally, you can just "forget" any references to an AnyEvent::Handle
1804	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
1805	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
1806	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
…		…
1820	sub destroy {	2035	sub destroy {
1821	my ($self) = @_;	2036	my ($self) = @_;
1822		2037
1823	$self->DESTROY;	2038	$self->DESTROY;
1824	%$self = ();	2039	%$self = ();
		2040	bless $self, "AnyEvent::Handle::destroyed";
1825	}	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 }
1826		2069
1827	=item AnyEvent::Handle::TLS_CTX	2070	=item AnyEvent::Handle::TLS_CTX
1828		2071
1829	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
1830	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.161 by root, Sat Jul 25 06:16:45 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.161 by root, Sat Jul 25 06:16:45 2009 UTC vs.
Revision 1.193 by root, Mon Mar 15 18:51:30 2010 UTC