[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.196 by root, Tue Jun 8 10:04:17 2010 UTC

…		…
1	package AnyEvent::Handle;
2
3	use Scalar::Util ();
4	use Carp ();
5	use Errno qw(EAGAIN EINTR);
6
7	use AnyEvent (); BEGIN { AnyEvent::common_sense }
8	use AnyEvent::Util qw(WSAEWOULDBLOCK);
9
10	=head1 NAME	1	=head1 NAME
11		2
12	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent	3	AnyEvent::Handle - non-blocking I/O on streaming handles via AnyEvent
13
14	=cut
15
16	our $VERSION = 4.86;
17		4
18	=head1 SYNOPSIS	5	=head1 SYNOPSIS
19		6
20	use AnyEvent;	7	use AnyEvent;
21	use AnyEvent::Handle;	8	use AnyEvent::Handle;
27	on_error => sub {	14	on_error => sub {
28	my ($hdl, $fatal, $msg) = @_;	15	my ($hdl, $fatal, $msg) = @_;
29	warn "got error $msg\n";	16	warn "got error $msg\n";
30	$hdl->destroy;	17	$hdl->destroy;
31	$cv->send;	18	$cv->send;
32	);	19	};
33		20
34	# send some request line	21	# send some request line
35	$hdl->push_write ("getinfo\015\012");	22	$hdl->push_write ("getinfo\015\012");
36		23
37	# read the response line	24	# read the response line
…		…
44	$cv->recv;	31	$cv->recv;
45		32
46	=head1 DESCRIPTION	33	=head1 DESCRIPTION
47		34
48	This module is a helper module to make it easier to do event-based I/O on	35	This module is a helper module to make it easier to do event-based I/O on
49	filehandles.	36	stream-based filehandles (sockets, pipes or other stream things).
50		37
51	The L<AnyEvent::Intro> tutorial contains some well-documented	38	The L<AnyEvent::Intro> tutorial contains some well-documented
52	AnyEvent::Handle examples.	39	AnyEvent::Handle examples.
53		40
54	In the following, when the documentation refers to of "bytes" then this	41	In the following, when the documentation refers to of "bytes" then this
…		…
59	C<on_error> callback.	46	C<on_error> callback.
60		47
61	All callbacks will be invoked with the handle object as their first	48	All callbacks will be invoked with the handle object as their first
62	argument.	49	argument.
63		50
		51	=cut
		52
		53	package AnyEvent::Handle;
		54
		55	use Scalar::Util ();
		56	use List::Util ();
		57	use Carp ();
		58	use Errno qw(EAGAIN EINTR);
		59
		60	use AnyEvent (); BEGIN { AnyEvent::common_sense }
		61	use AnyEvent::Util qw(WSAEWOULDBLOCK);
		62
		63	our $VERSION = $AnyEvent::VERSION;
		64
		65	sub _load_func($) {
		66	my $func = $_[0];
		67
		68	unless (defined &$func) {
		69	my $pkg = $func;
		70	do {
		71	$pkg =~ s/::[^:]+$//
		72	or return;
		73	eval "require $pkg";
		74	} until defined &$func;
		75	}
		76
		77	\&$func
		78	}
		79
64	=head1 METHODS	80	=head1 METHODS
65		81
66	=over 4	82	=over 4
67		83
68	=item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value...	84	=item $handle = B<new> AnyEvent::Handle fh => $filehandle, key => value...
69		85
70	The constructor supports these arguments (all as C<< key => value >> pairs).	86	The constructor supports these arguments (all as C<< key => value >> pairs).
71		87
72	=over 4	88	=over 4
73		89
…		…
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 {
…		…
472	}	532	}
473		533
474	sub _start {	534	sub _start {
475	my ($self) = @_;	535	my ($self) = @_;
476		536
		537	# too many clueless people try to use udp and similar sockets
		538	# with AnyEvent::Handle, do them a favour.
		539	my $type = getsockopt $self->{fh}, Socket::SOL_SOCKET (), Socket::SO_TYPE ();
		540	Carp::croak "AnyEvent::Handle: only stream sockets supported, anything else will NOT work!"
		541	if Socket::SOCK_STREAM () != (unpack "I", $type) && defined $type;
		542
477	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	543	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
478		544
		545	$self->{_activity} =
		546	$self->{_ractivity} =
479	$self->{_activity} = AnyEvent->now;	547	$self->{_wactivity} = AE::now;
480	$self->_timeout;
481		548
		549	$self->timeout (delete $self->{timeout} ) if $self->{timeout};
		550	$self->rtimeout (delete $self->{rtimeout} ) if $self->{rtimeout};
		551	$self->wtimeout (delete $self->{wtimeout} ) if $self->{wtimeout};
		552
482	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};	553	$self->no_delay (delete $self->{no_delay} ) if exists $self->{no_delay} && $self->{no_delay};
		554	$self->keepalive (delete $self->{keepalive}) if exists $self->{keepalive} && $self->{keepalive};
483		555
		556	$self->oobinline (exists $self->{oobinline} ? delete $self->{oobinline} : 1);
		557
484	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})	558	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
485	if $self->{tls};	559	if $self->{tls};
486		560
487	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	561	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
488		562
489	$self->start_read	563	$self->start_read
490	if $self->{on_read} \|\| @{ $self->{_queue} };	564	if $self->{on_read} \|\| @{ $self->{_queue} };
491		565
492	$self->_drain_wbuf;	566	$self->_drain_wbuf;
493	}	567	}
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		568
504	sub _error {	569	sub _error {
505	my ($self, $errno, $fatal, $message) = @_;	570	my ($self, $errno, $fatal, $message) = @_;
506		571
507	$! = $errno;	572	$! = $errno;
508	$message \|\|= "$!";	573	$message \|\|= "$!";
509		574
510	if ($self->{on_error}) {	575	if ($self->{on_error}) {
511	$self->{on_error}($self, $fatal, $message);	576	$self->{on_error}($self, $fatal, $message);
512	$self->destroy if $fatal;	577	$self->destroy if $fatal;
513	} elsif ($self->{fh}) {	578	} elsif ($self->{fh} \|\| $self->{connect}) {
514	$self->destroy;	579	$self->destroy;
515	Carp::croak "AnyEvent::Handle uncaught error: $message";	580	Carp::croak "AnyEvent::Handle uncaught error: $message";
516	}	581	}
517	}	582	}
518		583
…		…
544	$_[0]{on_eof} = $_[1];	609	$_[0]{on_eof} = $_[1];
545	}	610	}
546		611
547	=item $handle->on_timeout ($cb)	612	=item $handle->on_timeout ($cb)
548		613
549	Replace the current C<on_timeout> callback, or disables the callback (but	614	=item $handle->on_rtimeout ($cb)
550	not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
551	argument and method.
552		615
553	=cut	616	=item $handle->on_wtimeout ($cb)
554		617
555	sub on_timeout {	618	Replace the current C<on_timeout>, C<on_rtimeout> or C<on_wtimeout>
556	$_[0]{on_timeout} = $_[1];	619	callback, or disables the callback (but not the timeout) if C<$cb> =
557	}	620	C<undef>. See the C<timeout> constructor argument and method.
		621
		622	=cut
		623
		624	# see below
558		625
559	=item $handle->autocork ($boolean)	626	=item $handle->autocork ($boolean)
560		627
561	Enables or disables the current autocork behaviour (see C<autocork>	628	Enables or disables the current autocork behaviour (see C<autocork>
562	constructor argument). Changes will only take effect on the next write.	629	constructor argument). Changes will only take effect on the next write.
…		…
577	sub no_delay {	644	sub no_delay {
578	$_[0]{no_delay} = $_[1];	645	$_[0]{no_delay} = $_[1];
579		646
580	eval {	647	eval {
581	local $SIG{__DIE__};	648	local $SIG{__DIE__};
582	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1]	649	setsockopt $_[0]{fh}, Socket::IPPROTO_TCP (), Socket::TCP_NODELAY (), int $_[1]
583	if $_[0]{fh};	650	if $_[0]{fh};
584	};	651	};
585	}	652	}
586		653
		654	=item $handle->keepalive ($boolean)
		655
		656	Enables or disables the C<keepalive> setting (see constructor argument of
		657	the same name for details).
		658
		659	=cut
		660
		661	sub keepalive {
		662	$_[0]{keepalive} = $_[1];
		663
		664	eval {
		665	local $SIG{__DIE__};
		666	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
		667	if $_[0]{fh};
		668	};
		669	}
		670
		671	=item $handle->oobinline ($boolean)
		672
		673	Enables or disables the C<oobinline> setting (see constructor argument of
		674	the same name for details).
		675
		676	=cut
		677
		678	sub oobinline {
		679	$_[0]{oobinline} = $_[1];
		680
		681	eval {
		682	local $SIG{__DIE__};
		683	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_OOBINLINE (), int $_[1]
		684	if $_[0]{fh};
		685	};
		686	}
		687
		688	=item $handle->keepalive ($boolean)
		689
		690	Enables or disables the C<keepalive> setting (see constructor argument of
		691	the same name for details).
		692
		693	=cut
		694
		695	sub keepalive {
		696	$_[0]{keepalive} = $_[1];
		697
		698	eval {
		699	local $SIG{__DIE__};
		700	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
		701	if $_[0]{fh};
		702	};
		703	}
		704
587	=item $handle->on_starttls ($cb)	705	=item $handle->on_starttls ($cb)
588		706
589	Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument).	707	Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument).
590		708
591	=cut	709	=cut
…		…
598		716
599	Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).	717	Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).
600		718
601	=cut	719	=cut
602		720
603	sub on_starttls {	721	sub on_stoptls {
604	$_[0]{on_stoptls} = $_[1];	722	$_[0]{on_stoptls} = $_[1];
605	}	723	}
606		724
		725	=item $handle->rbuf_max ($max_octets)
		726
		727	Configures the C<rbuf_max> setting (C<undef> disables it).
		728
		729	=cut
		730
		731	sub rbuf_max {
		732	$_[0]{rbuf_max} = $_[1];
		733	}
		734
607	#############################################################################	735	#############################################################################
608		736
609	=item $handle->timeout ($seconds)	737	=item $handle->timeout ($seconds)
610		738
		739	=item $handle->rtimeout ($seconds)
		740
		741	=item $handle->wtimeout ($seconds)
		742
611	Configures (or disables) the inactivity timeout.	743	Configures (or disables) the inactivity timeout.
612		744
613	=cut	745	=item $handle->timeout_reset
614		746
615	sub timeout {	747	=item $handle->rtimeout_reset
		748
		749	=item $handle->wtimeout_reset
		750
		751	Reset the activity timeout, as if data was received or sent.
		752
		753	These methods are cheap to call.
		754
		755	=cut
		756
		757	for my $dir ("", "r", "w") {
		758	my $timeout = "${dir}timeout";
		759	my $tw = "_${dir}tw";
		760	my $on_timeout = "on_${dir}timeout";
		761	my $activity = "_${dir}activity";
		762	my $cb;
		763
		764	*$on_timeout = sub {
		765	$_[0]{$on_timeout} = $_[1];
		766	};
		767
		768	*$timeout = sub {
616	my ($self, $timeout) = @_;	769	my ($self, $new_value) = @_;
617		770
618	$self->{timeout} = $timeout;	771	$self->{$timeout} = $new_value;
619	$self->_timeout;	772	delete $self->{$tw}; &$cb;
620	}	773	};
621		774
		775	*{"${dir}timeout_reset"} = sub {
		776	$_[0]{$activity} = AE::now;
		777	};
		778
		779	# main workhorse:
622	# reset the timeout watcher, as neccessary	780	# reset the timeout watcher, as neccessary
623	# also check for time-outs	781	# also check for time-outs
624	sub _timeout {	782	$cb = sub {
625	my ($self) = @_;	783	my ($self) = @_;
626		784
627	if ($self->{timeout} && $self->{fh}) {	785	if ($self->{$timeout} && $self->{fh}) {
628	my $NOW = AnyEvent->now;	786	my $NOW = AE::now;
629		787
630	# when would the timeout trigger?	788	# when would the timeout trigger?
631	my $after = $self->{_activity} + $self->{timeout} - $NOW;	789	my $after = $self->{$activity} + $self->{$timeout} - $NOW;
632		790
633	# now or in the past already?	791	# now or in the past already?
634	if ($after <= 0) {	792	if ($after <= 0) {
635	$self->{_activity} = $NOW;	793	$self->{$activity} = $NOW;
636		794
637	if ($self->{on_timeout}) {	795	if ($self->{$on_timeout}) {
638	$self->{on_timeout}($self);	796	$self->{$on_timeout}($self);
639	} else {	797	} else {
640	$self->_error (Errno::ETIMEDOUT);	798	$self->_error (Errno::ETIMEDOUT);
		799	}
		800
		801	# callback could have changed timeout value, optimise
		802	return unless $self->{$timeout};
		803
		804	# calculate new after
		805	$after = $self->{$timeout};
641	}	806	}
642		807
643	# callback could have changed timeout value, optimise	808	Scalar::Util::weaken $self;
644	return unless $self->{timeout};	809	return unless $self; # ->error could have destroyed $self
645		810
646	# calculate new after	811	$self->{$tw} \|\|= AE::timer $after, 0, sub {
647	$after = $self->{timeout};	812	delete $self->{$tw};
		813	$cb->($self);
		814	};
		815	} else {
		816	delete $self->{$tw};
648	}	817	}
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	}	818	}
660	}	819	}
661		820
662	#############################################################################	821	#############################################################################
663		822
…		…
678		837
679	=item $handle->on_drain ($cb)	838	=item $handle->on_drain ($cb)
680		839
681	Sets the C<on_drain> callback or clears it (see the description of	840	Sets the C<on_drain> callback or clears it (see the description of
682	C<on_drain> in the constructor).	841	C<on_drain> in the constructor).
		842
		843	This method may invoke callbacks (and therefore the handle might be
		844	destroyed after it returns).
683		845
684	=cut	846	=cut
685		847
686	sub on_drain {	848	sub on_drain {
687	my ($self, $cb) = @_;	849	my ($self, $cb) = @_;
…		…
696		858
697	Queues the given scalar to be written. You can push as much data as you	859	Queues the given scalar to be written. You can push as much data as you
698	want (only limited by the available memory), as C<AnyEvent::Handle>	860	want (only limited by the available memory), as C<AnyEvent::Handle>
699	buffers it independently of the kernel.	861	buffers it independently of the kernel.
700		862
		863	This method may invoke callbacks (and therefore the handle might be
		864	destroyed after it returns).
		865
701	=cut	866	=cut
702		867
703	sub _drain_wbuf {	868	sub _drain_wbuf {
704	my ($self) = @_;	869	my ($self) = @_;
705		870
…		…
711	my $len = syswrite $self->{fh}, $self->{wbuf};	876	my $len = syswrite $self->{fh}, $self->{wbuf};
712		877
713	if (defined $len) {	878	if (defined $len) {
714	substr $self->{wbuf}, 0, $len, "";	879	substr $self->{wbuf}, 0, $len, "";
715		880
716	$self->{_activity} = AnyEvent->now;	881	$self->{_activity} = $self->{_wactivity} = AE::now;
717		882
718	$self->{on_drain}($self)	883	$self->{on_drain}($self)
719	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})	884	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
720	&& $self->{on_drain};	885	&& $self->{on_drain};
721		886
…		…
727		892
728	# try to write data immediately	893	# try to write data immediately
729	$cb->() unless $self->{autocork};	894	$cb->() unless $self->{autocork};
730		895
731	# if still data left in wbuf, we need to poll	896	# if still data left in wbuf, we need to poll
732	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	897	$self->{_ww} = AE::io $self->{fh}, 1, $cb
733	if length $self->{wbuf};	898	if length $self->{wbuf};
734	};	899	};
735	}	900	}
736		901
737	our %WH;	902	our %WH;
738		903
		904	# deprecated
739	sub register_write_type($$) {	905	sub register_write_type($$) {
740	$WH{$_[0]} = $_[1];	906	$WH{$_[0]} = $_[1];
741	}	907	}
742		908
743	sub push_write {	909	sub push_write {
744	my $self = shift;	910	my $self = shift;
745		911
746	if (@_ > 1) {	912	if (@_ > 1) {
747	my $type = shift;	913	my $type = shift;
748		914
		915	@_ = ($WH{$type} \|\|= _load_func "$type\::anyevent_write_type"
749	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	916	or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_write")
750	->($self, @_);	917	->($self, @_);
751	}	918	}
752		919
		920	# we downgrade here to avoid hard-to-track-down bugs,
		921	# and diagnose the problem earlier and better.
		922
753	if ($self->{tls}) {	923	if ($self->{tls}) {
754	$self->{_tls_wbuf} .= $_[0];	924	utf8::downgrade $self->{_tls_wbuf} .= $_[0];
755	&_dotls ($self) if $self->{fh};	925	&_dotls ($self) if $self->{fh};
756	} else {	926	} else {
757	$self->{wbuf} .= $_[0];	927	utf8::downgrade $self->{wbuf} .= $_[0];
758	$self->_drain_wbuf if $self->{fh};	928	$self->_drain_wbuf if $self->{fh};
759	}	929	}
760	}	930	}
761		931
762	=item $handle->push_write (type => @args)	932	=item $handle->push_write (type => @args)
763		933
764	Instead of formatting your data yourself, you can also let this module do	934	Instead of formatting your data yourself, you can also let this module
765	the job by specifying a type and type-specific arguments.	935	do the job by specifying a type and type-specific arguments. You
		936	can also specify the (fully qualified) name of a package, in which
		937	case AnyEvent tries to load the package and then expects to find the
		938	C<anyevent_read_type> function inside (see "custom write types", below).
766		939
767	Predefined types are (if you have ideas for additional types, feel free to	940	Predefined types are (if you have ideas for additional types, feel free to
768	drop by and tell us):	941	drop by and tell us):
769		942
770	=over 4	943	=over 4
…		…
827	Other languages could read single lines terminated by a newline and pass	1000	Other languages could read single lines terminated by a newline and pass
828	this line into their JSON decoder of choice.	1001	this line into their JSON decoder of choice.
829		1002
830	=cut	1003	=cut
831		1004
		1005	sub json_coder() {
		1006	eval { require JSON::XS; JSON::XS->new->utf8 }
		1007	\|\| do { require JSON; JSON->new->utf8 }
		1008	}
		1009
832	register_write_type json => sub {	1010	register_write_type json => sub {
833	my ($self, $ref) = @_;	1011	my ($self, $ref) = @_;
834		1012
835	require JSON;	1013	my $json = $self->{json} \|\|= json_coder;
836		1014
837	$self->{json} ? $self->{json}->encode ($ref)	1015	$json->encode ($ref)
838	: JSON::encode_json ($ref)
839	};	1016	};
840		1017
841	=item storable => $reference	1018	=item storable => $reference
842		1019
843	Freezes the given reference using L<Storable> and writes it to the	1020	Freezes the given reference using L<Storable> and writes it to the
…		…
869	the peer.	1046	the peer.
870		1047
871	You can rely on the normal read queue and C<on_eof> handling	1048	You can rely on the normal read queue and C<on_eof> handling
872	afterwards. This is the cleanest way to close a connection.	1049	afterwards. This is the cleanest way to close a connection.
873		1050
		1051	This method may invoke callbacks (and therefore the handle might be
		1052	destroyed after it returns).
		1053
874	=cut	1054	=cut
875		1055
876	sub push_shutdown {	1056	sub push_shutdown {
877	my ($self) = @_;	1057	my ($self) = @_;
878		1058
879	delete $self->{low_water_mark};	1059	delete $self->{low_water_mark};
880	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });	1060	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });
881	}	1061	}
882		1062
883	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	1063	=item custom write types - Package::anyevent_write_type $handle, @args
884		1064
885	This function (not method) lets you add your own types to C<push_write>.	1065	Instead of one of the predefined types, you can also specify the name of
		1066	a package. AnyEvent will try to load the package and then expects to find
		1067	a function named C<anyevent_write_type> inside. If it isn't found, it
		1068	progressively tries to load the parent package until it either finds the
		1069	function (good) or runs out of packages (bad).
		1070
886	Whenever the given C<type> is used, C<push_write> will invoke the code	1071	Whenever the given C<type> is used, C<push_write> will the function with
887	reference with the handle object and the remaining arguments.	1072	the handle object and the remaining arguments.
888		1073
889	The code reference is supposed to return a single octet string that will	1074	The function is supposed to return a single octet string that will be
890	be appended to the write buffer.	1075	appended to the write buffer, so you cna mentally treat this function as a
		1076	"arguments to on-the-wire-format" converter.
891		1077
892	Note that this is a function, and all types registered this way will be	1078	Example: implement a custom write type C<join> that joins the remaining
893	global, so try to use unique names.	1079	arguments using the first one.
		1080
		1081	$handle->push_write (My::Type => " ", 1,2,3);
		1082
		1083	# uses the following package, which can be defined in the "My::Type" or in
		1084	# the "My" modules to be auto-loaded, or just about anywhere when the
		1085	# My::Type::anyevent_write_type is defined before invoking it.
		1086
		1087	package My::Type;
		1088
		1089	sub anyevent_write_type {
		1090	my ($handle, $delim, @args) = @_;
		1091
		1092	join $delim, @args
		1093	}
894		1094
895	=cut	1095	=cut
896		1096
897	#############################################################################	1097	#############################################################################
898		1098
…		…
981		1181
982	sub _drain_rbuf {	1182	sub _drain_rbuf {
983	my ($self) = @_;	1183	my ($self) = @_;
984		1184
985	# avoid recursion	1185	# avoid recursion
986	return if exists $self->{_skip_drain_rbuf};	1186	return if $self->{_skip_drain_rbuf};
987	local $self->{_skip_drain_rbuf} = 1;	1187	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		1188
996	while () {	1189	while () {
997	# we need to use a separate tls read buffer, as we must not receive data while	1190	# we need to use a separate tls read buffer, as we must not receive data while
998	# we are draining the buffer, and this can only happen with TLS.	1191	# we are draining the buffer, and this can only happen with TLS.
999	$self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf};	1192	$self->{rbuf} .= delete $self->{_tls_rbuf}
		1193	if exists $self->{_tls_rbuf};
1000		1194
1001	my $len = length $self->{rbuf};	1195	my $len = length $self->{rbuf};
1002		1196
1003	if (my $cb = shift @{ $self->{_queue} }) {	1197	if (my $cb = shift @{ $self->{_queue} }) {
1004	unless ($cb->($self)) {	1198	unless ($cb->($self)) {
1005	if ($self->{_eof}) {	1199	# no progress can be made
1006	# no progress can be made (not enough data and no data forthcoming)	1200	# (not enough data and no data forthcoming)
1007	$self->_error (Errno::EPIPE, 1), return;	1201	$self->_error (Errno::EPIPE, 1), return
1008	}	1202	if $self->{_eof};
1009		1203
1010	unshift @{ $self->{_queue} }, $cb;	1204	unshift @{ $self->{_queue} }, $cb;
1011	last;	1205	last;
1012	}	1206	}
1013	} elsif ($self->{on_read}) {	1207	} elsif ($self->{on_read}) {
…		…
1033	last;	1227	last;
1034	}	1228	}
1035	}	1229	}
1036		1230
1037	if ($self->{_eof}) {	1231	if ($self->{_eof}) {
1038	if ($self->{on_eof}) {	1232	$self->{on_eof}
1039	$self->{on_eof}($self)	1233	? $self->{on_eof}($self)
1040	} else {
1041	$self->_error (0, 1, "Unexpected end-of-file");	1234	: $self->_error (0, 1, "Unexpected end-of-file");
1042	}	1235
		1236	return;
		1237	}
		1238
		1239	if (
		1240	defined $self->{rbuf_max}
		1241	&& $self->{rbuf_max} < length $self->{rbuf}
		1242	) {
		1243	$self->_error (Errno::ENOSPC, 1), return;
1043	}	1244	}
1044		1245
1045	# may need to restart read watcher	1246	# may need to restart read watcher
1046	unless ($self->{_rw}) {	1247	unless ($self->{_rw}) {
1047	$self->start_read	1248	$self->start_read
…		…
1052	=item $handle->on_read ($cb)	1253	=item $handle->on_read ($cb)
1053		1254
1054	This replaces the currently set C<on_read> callback, or clears it (when	1255	This replaces the currently set C<on_read> callback, or clears it (when
1055	the new callback is C<undef>). See the description of C<on_read> in the	1256	the new callback is C<undef>). See the description of C<on_read> in the
1056	constructor.	1257	constructor.
		1258
		1259	This method may invoke callbacks (and therefore the handle might be
		1260	destroyed after it returns).
1057		1261
1058	=cut	1262	=cut
1059		1263
1060	sub on_read {	1264	sub on_read {
1061	my ($self, $cb) = @_;	1265	my ($self, $cb) = @_;
…		…
1101		1305
1102	If enough data was available, then the callback must remove all data it is	1306	If enough data was available, then the callback must remove all data it is
1103	interested in (which can be none at all) and return a true value. After returning	1307	interested in (which can be none at all) and return a true value. After returning
1104	true, it will be removed from the queue.	1308	true, it will be removed from the queue.
1105		1309
		1310	These methods may invoke callbacks (and therefore the handle might be
		1311	destroyed after it returns).
		1312
1106	=cut	1313	=cut
1107		1314
1108	our %RH;	1315	our %RH;
1109		1316
1110	sub register_read_type($$) {	1317	sub register_read_type($$) {
…		…
1116	my $cb = pop;	1323	my $cb = pop;
1117		1324
1118	if (@_) {	1325	if (@_) {
1119	my $type = shift;	1326	my $type = shift;
1120		1327
		1328	$cb = ($RH{$type} \|\|= _load_func "$type\::anyevent_read_type"
1121	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	1329	or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_read")
1122	->($self, $cb, @_);	1330	->($self, $cb, @_);
1123	}	1331	}
1124		1332
1125	push @{ $self->{_queue} }, $cb;	1333	push @{ $self->{_queue} }, $cb;
1126	$self->_drain_rbuf;	1334	$self->_drain_rbuf;
…		…
1135		1343
1136	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")	1344	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")
1137	->($self, $cb, @_);	1345	->($self, $cb, @_);
1138	}	1346	}
1139		1347
1140
1141	unshift @{ $self->{_queue} }, $cb;	1348	unshift @{ $self->{_queue} }, $cb;
1142	$self->_drain_rbuf;	1349	$self->_drain_rbuf;
1143	}	1350	}
1144		1351
1145	=item $handle->push_read (type => @args, $cb)	1352	=item $handle->push_read (type => @args, $cb)
1146		1353
1147	=item $handle->unshift_read (type => @args, $cb)	1354	=item $handle->unshift_read (type => @args, $cb)
1148		1355
1149	Instead of providing a callback that parses the data itself you can chose	1356	Instead of providing a callback that parses the data itself you can chose
1150	between a number of predefined parsing formats, for chunks of data, lines	1357	between a number of predefined parsing formats, for chunks of data, lines
1151	etc.	1358	etc. You can also specify the (fully qualified) name of a package, in
		1359	which case AnyEvent tries to load the package and then expects to find the
		1360	C<anyevent_read_type> function inside (see "custom read types", below).
1152		1361
1153	Predefined types are (if you have ideas for additional types, feel free to	1362	Predefined types are (if you have ideas for additional types, feel free to
1154	drop by and tell us):	1363	drop by and tell us):
1155		1364
1156	=over 4	1365	=over 4
…		…
1396	=cut	1605	=cut
1397		1606
1398	register_read_type json => sub {	1607	register_read_type json => sub {
1399	my ($self, $cb) = @_;	1608	my ($self, $cb) = @_;
1400		1609
1401	my $json = $self->{json} \|\|=	1610	my $json = $self->{json} \|\|= json_coder;
1402	eval { require JSON::XS; JSON::XS->new->utf8 }
1403	\|\| do { require JSON; JSON->new->utf8 };
1404		1611
1405	my $data;	1612	my $data;
1406	my $rbuf = \$self->{rbuf};	1613	my $rbuf = \$self->{rbuf};
1407		1614
1408	sub {	1615	sub {
…		…
1477	}	1684	}
1478	};	1685	};
1479		1686
1480	=back	1687	=back
1481		1688
1482	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)	1689	=item custom read types - Package::anyevent_read_type $handle, $cb, @args
1483		1690
1484	This function (not method) lets you add your own types to C<push_read>.	1691	Instead of one of the predefined types, you can also specify the name
		1692	of a package. AnyEvent will try to load the package and then expects to
		1693	find a function named C<anyevent_read_type> inside. If it isn't found, it
		1694	progressively tries to load the parent package until it either finds the
		1695	function (good) or runs out of packages (bad).
1485		1696
1486	Whenever the given C<type> is used, C<push_read> will invoke the code	1697	Whenever this type is used, C<push_read> will invoke the function with the
1487	reference with the handle object, the callback and the remaining	1698	handle object, the original callback and the remaining arguments.
1488	arguments.
1489		1699
1490	The code reference is supposed to return a callback (usually a closure)	1700	The function is supposed to return a callback (usually a closure) that
1491	that works as a plain read callback (see C<< ->push_read ($cb) >>).	1701	works as a plain read callback (see C<< ->push_read ($cb) >>), so you can
		1702	mentally treat the function as a "configurable read type to read callback"
		1703	converter.
1492		1704
1493	It should invoke the passed callback when it is done reading (remember to	1705	It should invoke the original callback when it is done reading (remember
1494	pass C<$handle> as first argument as all other callbacks do that).	1706	to pass C<$handle> as first argument as all other callbacks do that,
		1707	although there is no strict requirement on this).
1495		1708
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>,	1709	For examples, see the source of this module (F<perldoc -m
1500	search for C<register_read_type>)).	1710	AnyEvent::Handle>, search for C<register_read_type>)).
1501		1711
1502	=item $handle->stop_read	1712	=item $handle->stop_read
1503		1713
1504	=item $handle->start_read	1714	=item $handle->start_read
1505		1715
…		…
1525	}	1735	}
1526		1736
1527	sub start_read {	1737	sub start_read {
1528	my ($self) = @_;	1738	my ($self) = @_;
1529		1739
1530	unless ($self->{_rw} \|\| $self->{_eof}) {	1740	unless ($self->{_rw} \|\| $self->{_eof} \|\| !$self->{fh}) {
1531	Scalar::Util::weaken $self;	1741	Scalar::Util::weaken $self;
1532		1742
1533	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1743	$self->{_rw} = AE::io $self->{fh}, 0, sub {
1534	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});	1744	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1535	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;	1745	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;
1536		1746
1537	if ($len > 0) {	1747	if ($len > 0) {
1538	$self->{_activity} = AnyEvent->now;	1748	$self->{_activity} = $self->{_ractivity} = AE::now;
1539		1749
1540	if ($self->{tls}) {	1750	if ($self->{tls}) {
1541	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);	1751	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1542		1752
1543	&_dotls ($self);	1753	&_dotls ($self);
…		…
1551	$self->_drain_rbuf;	1761	$self->_drain_rbuf;
1552		1762
1553	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1763	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1554	return $self->_error ($!, 1);	1764	return $self->_error ($!, 1);
1555	}	1765	}
1556	});	1766	};
1557	}	1767	}
1558	}	1768	}
1559		1769
1560	our $ERROR_SYSCALL;	1770	our $ERROR_SYSCALL;
1561	our $ERROR_WANT_READ;	1771	our $ERROR_WANT_READ;
…		…
1628	&& ($tmp != $ERROR_SYSCALL \|\| $!);	1838	&& ($tmp != $ERROR_SYSCALL \|\| $!);
1629		1839
1630	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1840	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1631	$self->{wbuf} .= $tmp;	1841	$self->{wbuf} .= $tmp;
1632	$self->_drain_wbuf;	1842	$self->_drain_wbuf;
		1843	$self->{tls} or return; # tls session might have gone away in callback
1633	}	1844	}
1634		1845
1635	$self->{_on_starttls}	1846	$self->{_on_starttls}
1636	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()	1847	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
1637	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");	1848	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");
…		…
1662		1873
1663	Due to bugs in OpenSSL, it might or might not be possible to do multiple	1874	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	1875	handshakes on the same stream. Best do not attempt to use the stream after
1665	stopping TLS.	1876	stopping TLS.
1666		1877
		1878	This method may invoke callbacks (and therefore the handle might be
		1879	destroyed after it returns).
		1880
1667	=cut	1881	=cut
1668		1882
1669	our %TLS_CACHE; #TODO not yet documented, should we?	1883	our %TLS_CACHE; #TODO not yet documented, should we?
1670		1884
1671	sub starttls {	1885	sub starttls {
…		…
1682	require Net::SSLeay;	1896	require Net::SSLeay;
1683		1897
1684	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();	1898	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1685	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();	1899	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1686		1900
1687	$tls = $self->{tls};	1901	$tls = delete $self->{tls};
1688	$ctx = $self->{tls_ctx};	1902	$ctx = $self->{tls_ctx};
1689		1903
1690	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session	1904	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
1691		1905
1692	if ("HASH" eq ref $ctx) {	1906	if ("HASH" eq ref $ctx) {
…		…
1721	Net::SSLeay::CTX_set_mode ($tls, 1\|2);	1935	Net::SSLeay::CTX_set_mode ($tls, 1\|2);
1722		1936
1723	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1937	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1724	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1938	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1725		1939
		1940	Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf});
		1941
1726	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});	1942	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
1727		1943
1728	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }	1944	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1729	if $self->{on_starttls};	1945	if $self->{on_starttls};
1730		1946
…		…
1734		1950
1735	=item $handle->stoptls	1951	=item $handle->stoptls
1736		1952
1737	Shuts down the SSL connection - this makes a proper EOF handshake by	1953	Shuts down the SSL connection - this makes a proper EOF handshake by
1738	sending a close notify to the other side, but since OpenSSL doesn't	1954	sending a close notify to the other side, but since OpenSSL doesn't
1739	support non-blocking shut downs, it is not guarenteed that you can re-use	1955	support non-blocking shut downs, it is not guaranteed that you can re-use
1740	the stream afterwards.	1956	the stream afterwards.
		1957
		1958	This method may invoke callbacks (and therefore the handle might be
		1959	destroyed after it returns).
1741		1960
1742	=cut	1961	=cut
1743		1962
1744	sub stoptls {	1963	sub stoptls {
1745	my ($self) = @_;	1964	my ($self) = @_;
1746		1965
1747	if ($self->{tls}) {	1966	if ($self->{tls} && $self->{fh}) {
1748	Net::SSLeay::shutdown ($self->{tls});	1967	Net::SSLeay::shutdown ($self->{tls});
1749		1968
1750	&_dotls;	1969	&_dotls;
1751		1970
1752	# # we don't give a shit. no, we do, but we can't. no...#d#	1971	# # we don't give a shit. no, we do, but we can't. no...#d#
…		…
1759	my ($self) = @_;	1978	my ($self) = @_;
1760		1979
1761	return unless $self->{tls};	1980	return unless $self->{tls};
1762		1981
1763	$self->{tls_ctx}->_put_session (delete $self->{tls})	1982	$self->{tls_ctx}->_put_session (delete $self->{tls})
1764	if ref $self->{tls};	1983	if $self->{tls} > 0;
1765		1984
1766	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};	1985	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1767	}	1986	}
1768		1987
1769	sub DESTROY {	1988	sub DESTROY {
…		…
1777	my $fh = delete $self->{fh};	1996	my $fh = delete $self->{fh};
1778	my $wbuf = delete $self->{wbuf};	1997	my $wbuf = delete $self->{wbuf};
1779		1998
1780	my @linger;	1999	my @linger;
1781		2000
1782	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {	2001	push @linger, AE::io $fh, 1, sub {
1783	my $len = syswrite $fh, $wbuf, length $wbuf;	2002	my $len = syswrite $fh, $wbuf, length $wbuf;
1784		2003
1785	if ($len > 0) {	2004	if ($len > 0) {
1786	substr $wbuf, 0, $len, "";	2005	substr $wbuf, 0, $len, "";
1787	} else {	2006	} else {
1788	@linger = (); # end	2007	@linger = (); # end
1789	}	2008	}
1790	});	2009	};
1791	push @linger, AnyEvent->timer (after => $linger, cb => sub {	2010	push @linger, AE::timer $linger, 0, sub {
1792	@linger = ();	2011	@linger = ();
1793	});	2012	};
1794	}	2013	}
1795	}	2014	}
1796		2015
1797	=item $handle->destroy	2016	=item $handle->destroy
1798		2017
1799	Shuts down the handle object as much as possible - this call ensures that	2018	Shuts down the handle object as much as possible - this call ensures that
1800	no further callbacks will be invoked and as many resources as possible	2019	no further callbacks will be invoked and as many resources as possible
1801	will be freed. You must not call any methods on the object afterwards.	2020	will be freed. Any method you will call on the handle object after
		2021	destroying it in this way will be silently ignored (and it will return the
		2022	empty list).
1802		2023
1803	Normally, you can just "forget" any references to an AnyEvent::Handle	2024	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	2025	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	2026	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	2027	callback, so when you want to destroy the AnyEvent::Handle object from
…		…
1820	sub destroy {	2041	sub destroy {
1821	my ($self) = @_;	2042	my ($self) = @_;
1822		2043
1823	$self->DESTROY;	2044	$self->DESTROY;
1824	%$self = ();	2045	%$self = ();
		2046	bless $self, "AnyEvent::Handle::destroyed";
1825	}	2047	}
		2048
		2049	sub AnyEvent::Handle::destroyed::AUTOLOAD {
		2050	#nop
		2051	}
		2052
		2053	=item $handle->destroyed
		2054
		2055	Returns false as long as the handle hasn't been destroyed by a call to C<<
		2056	->destroy >>, true otherwise.
		2057
		2058	Can be useful to decide whether the handle is still valid after some
		2059	callback possibly destroyed the handle. For example, C<< ->push_write >>,
		2060	C<< ->starttls >> and other methods can call user callbacks, which in turn
		2061	can destroy the handle, so work can be avoided by checking sometimes:
		2062
		2063	$hdl->starttls ("accept");
		2064	return if $hdl->destroyed;
		2065	$hdl->push_write (...
		2066
		2067	Note that the call to C<push_write> will silently be ignored if the handle
		2068	has been destroyed, so often you can just ignore the possibility of the
		2069	handle being destroyed.
		2070
		2071	=cut
		2072
		2073	sub destroyed { 0 }
		2074	sub AnyEvent::Handle::destroyed::destroyed { 1 }
1826		2075
1827	=item AnyEvent::Handle::TLS_CTX	2076	=item AnyEvent::Handle::TLS_CTX
1828		2077
1829	This function creates and returns the AnyEvent::TLS object used by default	2078	This function creates and returns the AnyEvent::TLS object used by default
1830	for TLS mode.	2079	for TLS mode.

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.161 by root, Sat Jul 25 06:16:45 2009 UTC vs. Revision 1.196 by root, Tue Jun 8 10:04:17 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.196 by root, Tue Jun 8 10:04:17 2010 UTC