[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.192 by root, Fri Mar 12 23:22:14 2010 UTC

…		…
1	package AnyEvent::Handle;
2
3	use Scalar::Util ();
4	use Carp ();
5	use Errno qw(EAGAIN EINTR);
6
7	use AnyEvent (); BEGIN { AnyEvent::common_sense }
8	use AnyEvent::Util qw(WSAEWOULDBLOCK);
9
10	=head1 NAME	1	=head1 NAME
11		2
12	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent	3	AnyEvent::Handle - non-blocking I/O on 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
…		…
711	my $len = syswrite $self->{fh}, $self->{wbuf};	864	my $len = syswrite $self->{fh}, $self->{wbuf};
712		865
713	if (defined $len) {	866	if (defined $len) {
714	substr $self->{wbuf}, 0, $len, "";	867	substr $self->{wbuf}, 0, $len, "";
715		868
716	$self->{_activity} = AnyEvent->now;	869	$self->{_activity} = $self->{_wactivity} = AE::now;
717		870
718	$self->{on_drain}($self)	871	$self->{on_drain}($self)
719	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})	872	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
720	&& $self->{on_drain};	873	&& $self->{on_drain};
721		874
…		…
727		880
728	# try to write data immediately	881	# try to write data immediately
729	$cb->() unless $self->{autocork};	882	$cb->() unless $self->{autocork};
730		883
731	# if still data left in wbuf, we need to poll	884	# if still data left in wbuf, we need to poll
732	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	885	$self->{_ww} = AE::io $self->{fh}, 1, $cb
733	if length $self->{wbuf};	886	if length $self->{wbuf};
734	};	887	};
735	}	888	}
736		889
737	our %WH;	890	our %WH;
738		891
		892	# deprecated
739	sub register_write_type($$) {	893	sub register_write_type($$) {
740	$WH{$_[0]} = $_[1];	894	$WH{$_[0]} = $_[1];
741	}	895	}
742		896
743	sub push_write {	897	sub push_write {
744	my $self = shift;	898	my $self = shift;
745		899
746	if (@_ > 1) {	900	if (@_ > 1) {
747	my $type = shift;	901	my $type = shift;
748		902
		903	@_ = ($WH{$type} \|\|= _load_func "$type\::anyevent_write_type"
749	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	904	or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_write")
750	->($self, @_);	905	->($self, @_);
751	}	906	}
752		907
		908	# we downgrade here to avoid hard-to-track-down bugs,
		909	# and diagnose the problem earlier and better.
		910
753	if ($self->{tls}) {	911	if ($self->{tls}) {
754	$self->{_tls_wbuf} .= $_[0];	912	utf8::downgrade $self->{_tls_wbuf} .= $_[0];
755	&_dotls ($self) if $self->{fh};	913	&_dotls ($self) if $self->{fh};
756	} else {	914	} else {
757	$self->{wbuf} .= $_[0];	915	utf8::downgrade $self->{wbuf} .= $_[0];
758	$self->_drain_wbuf if $self->{fh};	916	$self->_drain_wbuf if $self->{fh};
759	}	917	}
760	}	918	}
761		919
762	=item $handle->push_write (type => @args)	920	=item $handle->push_write (type => @args)
763		921
764	Instead of formatting your data yourself, you can also let this module do	922	Instead of formatting your data yourself, you can also let this module
765	the job by specifying a type and type-specific arguments.	923	do the job by specifying a type and type-specific arguments. You
		924	can also specify the (fully qualified) name of a package, in which
		925	case AnyEvent tries to load the package and then expects to find the
		926	C<anyevent_read_type> function inside (see "custom write types", below).
766		927
767	Predefined types are (if you have ideas for additional types, feel free to	928	Predefined types are (if you have ideas for additional types, feel free to
768	drop by and tell us):	929	drop by and tell us):
769		930
770	=over 4	931	=over 4
…		…
827	Other languages could read single lines terminated by a newline and pass	988	Other languages could read single lines terminated by a newline and pass
828	this line into their JSON decoder of choice.	989	this line into their JSON decoder of choice.
829		990
830	=cut	991	=cut
831		992
		993	sub json_coder() {
		994	eval { require JSON::XS; JSON::XS->new->utf8 }
		995	\|\| do { require JSON; JSON->new->utf8 }
		996	}
		997
832	register_write_type json => sub {	998	register_write_type json => sub {
833	my ($self, $ref) = @_;	999	my ($self, $ref) = @_;
834		1000
835	require JSON;	1001	my $json = $self->{json} \|\|= json_coder;
836		1002
837	$self->{json} ? $self->{json}->encode ($ref)	1003	$json->encode ($ref)
838	: JSON::encode_json ($ref)
839	};	1004	};
840		1005
841	=item storable => $reference	1006	=item storable => $reference
842		1007
843	Freezes the given reference using L<Storable> and writes it to the	1008	Freezes the given reference using L<Storable> and writes it to the
…		…
878		1043
879	delete $self->{low_water_mark};	1044	delete $self->{low_water_mark};
880	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });	1045	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });
881	}	1046	}
882		1047
883	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	1048	=item custom write types - Package::anyevent_write_type $handle, @args
884		1049
885	This function (not method) lets you add your own types to C<push_write>.	1050	Instead of one of the predefined types, you can also specify the name of
		1051	a package. AnyEvent will try to load the package and then expects to find
		1052	a function named C<anyevent_write_type> inside. If it isn't found, it
		1053	progressively tries to load the parent package until it either finds the
		1054	function (good) or runs out of packages (bad).
		1055
886	Whenever the given C<type> is used, C<push_write> will invoke the code	1056	Whenever the given C<type> is used, C<push_write> will the function with
887	reference with the handle object and the remaining arguments.	1057	the handle object and the remaining arguments.
888		1058
889	The code reference is supposed to return a single octet string that will	1059	The function is supposed to return a single octet string that will be
890	be appended to the write buffer.	1060	appended to the write buffer, so you cna mentally treat this function as a
		1061	"arguments to on-the-wire-format" converter.
891		1062
892	Note that this is a function, and all types registered this way will be	1063	Example: implement a custom write type C<join> that joins the remaining
893	global, so try to use unique names.	1064	arguments using the first one.
		1065
		1066	$handle->push_write (My::Type => " ", 1,2,3);
		1067
		1068	# uses the following package, which can be defined in the "My::Type" or in
		1069	# the "My" modules to be auto-loaded, or just about anywhere when the
		1070	# My::Type::anyevent_write_type is defined before invoking it.
		1071
		1072	package My::Type;
		1073
		1074	sub anyevent_write_type {
		1075	my ($handle, $delim, @args) = @_;
		1076
		1077	join $delim, @args
		1078	}
894		1079
895	=cut	1080	=cut
896		1081
897	#############################################################################	1082	#############################################################################
898		1083
…		…
981		1166
982	sub _drain_rbuf {	1167	sub _drain_rbuf {
983	my ($self) = @_;	1168	my ($self) = @_;
984		1169
985	# avoid recursion	1170	# avoid recursion
986	return if exists $self->{_skip_drain_rbuf};	1171	return if $self->{_skip_drain_rbuf};
987	local $self->{_skip_drain_rbuf} = 1;	1172	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		1173
996	while () {	1174	while () {
997	# we need to use a separate tls read buffer, as we must not receive data while	1175	# 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.	1176	# we are draining the buffer, and this can only happen with TLS.
999	$self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf};	1177	$self->{rbuf} .= delete $self->{_tls_rbuf}
		1178	if exists $self->{_tls_rbuf};
1000		1179
1001	my $len = length $self->{rbuf};	1180	my $len = length $self->{rbuf};
1002		1181
1003	if (my $cb = shift @{ $self->{_queue} }) {	1182	if (my $cb = shift @{ $self->{_queue} }) {
1004	unless ($cb->($self)) {	1183	unless ($cb->($self)) {
1005	if ($self->{_eof}) {	1184	# no progress can be made
1006	# no progress can be made (not enough data and no data forthcoming)	1185	# (not enough data and no data forthcoming)
1007	$self->_error (Errno::EPIPE, 1), return;	1186	$self->_error (Errno::EPIPE, 1), return
1008	}	1187	if $self->{_eof};
1009		1188
1010	unshift @{ $self->{_queue} }, $cb;	1189	unshift @{ $self->{_queue} }, $cb;
1011	last;	1190	last;
1012	}	1191	}
1013	} elsif ($self->{on_read}) {	1192	} elsif ($self->{on_read}) {
…		…
1033	last;	1212	last;
1034	}	1213	}
1035	}	1214	}
1036		1215
1037	if ($self->{_eof}) {	1216	if ($self->{_eof}) {
1038	if ($self->{on_eof}) {	1217	$self->{on_eof}
1039	$self->{on_eof}($self)	1218	? $self->{on_eof}($self)
1040	} else {
1041	$self->_error (0, 1, "Unexpected end-of-file");	1219	: $self->_error (0, 1, "Unexpected end-of-file");
1042	}	1220
		1221	return;
		1222	}
		1223
		1224	if (
		1225	defined $self->{rbuf_max}
		1226	&& $self->{rbuf_max} < length $self->{rbuf}
		1227	) {
		1228	$self->_error (Errno::ENOSPC, 1), return;
1043	}	1229	}
1044		1230
1045	# may need to restart read watcher	1231	# may need to restart read watcher
1046	unless ($self->{_rw}) {	1232	unless ($self->{_rw}) {
1047	$self->start_read	1233	$self->start_read
…		…
1116	my $cb = pop;	1302	my $cb = pop;
1117		1303
1118	if (@_) {	1304	if (@_) {
1119	my $type = shift;	1305	my $type = shift;
1120		1306
		1307	$cb = ($RH{$type} \|\|= _load_func "$type\::anyevent_read_type"
1121	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	1308	or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_read")
1122	->($self, $cb, @_);	1309	->($self, $cb, @_);
1123	}	1310	}
1124		1311
1125	push @{ $self->{_queue} }, $cb;	1312	push @{ $self->{_queue} }, $cb;
1126	$self->_drain_rbuf;	1313	$self->_drain_rbuf;
…		…
1135		1322
1136	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")	1323	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")
1137	->($self, $cb, @_);	1324	->($self, $cb, @_);
1138	}	1325	}
1139		1326
1140
1141	unshift @{ $self->{_queue} }, $cb;	1327	unshift @{ $self->{_queue} }, $cb;
1142	$self->_drain_rbuf;	1328	$self->_drain_rbuf;
1143	}	1329	}
1144		1330
1145	=item $handle->push_read (type => @args, $cb)	1331	=item $handle->push_read (type => @args, $cb)
1146		1332
1147	=item $handle->unshift_read (type => @args, $cb)	1333	=item $handle->unshift_read (type => @args, $cb)
1148		1334
1149	Instead of providing a callback that parses the data itself you can chose	1335	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	1336	between a number of predefined parsing formats, for chunks of data, lines
1151	etc.	1337	etc. You can also specify the (fully qualified) name of a package, in
		1338	which case AnyEvent tries to load the package and then expects to find the
		1339	C<anyevent_read_type> function inside (see "custom read types", below).
1152		1340
1153	Predefined types are (if you have ideas for additional types, feel free to	1341	Predefined types are (if you have ideas for additional types, feel free to
1154	drop by and tell us):	1342	drop by and tell us):
1155		1343
1156	=over 4	1344	=over 4
…		…
1396	=cut	1584	=cut
1397		1585
1398	register_read_type json => sub {	1586	register_read_type json => sub {
1399	my ($self, $cb) = @_;	1587	my ($self, $cb) = @_;
1400		1588
1401	my $json = $self->{json} \|\|=	1589	my $json = $self->{json} \|\|= json_coder;
1402	eval { require JSON::XS; JSON::XS->new->utf8 }
1403	\|\| do { require JSON; JSON->new->utf8 };
1404		1590
1405	my $data;	1591	my $data;
1406	my $rbuf = \$self->{rbuf};	1592	my $rbuf = \$self->{rbuf};
1407		1593
1408	sub {	1594	sub {
…		…
1477	}	1663	}
1478	};	1664	};
1479		1665
1480	=back	1666	=back
1481		1667
1482	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)	1668	=item custom read types - Package::anyevent_read_type $handle, $cb, @args
1483		1669
1484	This function (not method) lets you add your own types to C<push_read>.	1670	Instead of one of the predefined types, you can also specify the name
		1671	of a package. AnyEvent will try to load the package and then expects to
		1672	find a function named C<anyevent_read_type> inside. If it isn't found, it
		1673	progressively tries to load the parent package until it either finds the
		1674	function (good) or runs out of packages (bad).
1485		1675
1486	Whenever the given C<type> is used, C<push_read> will invoke the code	1676	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	1677	handle object, the original callback and the remaining arguments.
1488	arguments.
1489		1678
1490	The code reference is supposed to return a callback (usually a closure)	1679	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) >>).	1680	works as a plain read callback (see C<< ->push_read ($cb) >>), so you can
		1681	mentally treat the function as a "configurable read type to read callback"
		1682	converter.
1492		1683
1493	It should invoke the passed callback when it is done reading (remember to	1684	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).	1685	to pass C<$handle> as first argument as all other callbacks do that,
		1686	although there is no strict requirement on this).
1495		1687
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>,	1688	For examples, see the source of this module (F<perldoc -m
1500	search for C<register_read_type>)).	1689	AnyEvent::Handle>, search for C<register_read_type>)).
1501		1690
1502	=item $handle->stop_read	1691	=item $handle->stop_read
1503		1692
1504	=item $handle->start_read	1693	=item $handle->start_read
1505		1694
…		…
1525	}	1714	}
1526		1715
1527	sub start_read {	1716	sub start_read {
1528	my ($self) = @_;	1717	my ($self) = @_;
1529		1718
1530	unless ($self->{_rw} \|\| $self->{_eof}) {	1719	unless ($self->{_rw} \|\| $self->{_eof} \|\| !$self->{fh}) {
1531	Scalar::Util::weaken $self;	1720	Scalar::Util::weaken $self;
1532		1721
1533	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1722	$self->{_rw} = AE::io $self->{fh}, 0, sub {
1534	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});	1723	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1535	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;	1724	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;
1536		1725
1537	if ($len > 0) {	1726	if ($len > 0) {
1538	$self->{_activity} = AnyEvent->now;	1727	$self->{_activity} = $self->{_ractivity} = AE::now;
1539		1728
1540	if ($self->{tls}) {	1729	if ($self->{tls}) {
1541	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);	1730	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1542		1731
1543	&_dotls ($self);	1732	&_dotls ($self);
…		…
1551	$self->_drain_rbuf;	1740	$self->_drain_rbuf;
1552		1741
1553	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1742	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1554	return $self->_error ($!, 1);	1743	return $self->_error ($!, 1);
1555	}	1744	}
1556	});	1745	};
1557	}	1746	}
1558	}	1747	}
1559		1748
1560	our $ERROR_SYSCALL;	1749	our $ERROR_SYSCALL;
1561	our $ERROR_WANT_READ;	1750	our $ERROR_WANT_READ;
…		…
1628	&& ($tmp != $ERROR_SYSCALL \|\| $!);	1817	&& ($tmp != $ERROR_SYSCALL \|\| $!);
1629		1818
1630	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1819	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1631	$self->{wbuf} .= $tmp;	1820	$self->{wbuf} .= $tmp;
1632	$self->_drain_wbuf;	1821	$self->_drain_wbuf;
		1822	$self->{tls} or return; # tls session might have gone away in callback
1633	}	1823	}
1634		1824
1635	$self->{_on_starttls}	1825	$self->{_on_starttls}
1636	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()	1826	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
1637	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");	1827	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");
…		…
1682	require Net::SSLeay;	1872	require Net::SSLeay;
1683		1873
1684	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();	1874	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1685	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();	1875	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1686		1876
1687	$tls = $self->{tls};	1877	$tls = delete $self->{tls};
1688	$ctx = $self->{tls_ctx};	1878	$ctx = $self->{tls_ctx};
1689		1879
1690	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session	1880	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
1691		1881
1692	if ("HASH" eq ref $ctx) {	1882	if ("HASH" eq ref $ctx) {
…		…
1721	Net::SSLeay::CTX_set_mode ($tls, 1\|2);	1911	Net::SSLeay::CTX_set_mode ($tls, 1\|2);
1722		1912
1723	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1913	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1724	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1914	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1725		1915
		1916	Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf});
		1917
1726	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});	1918	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
1727		1919
1728	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }	1920	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1729	if $self->{on_starttls};	1921	if $self->{on_starttls};
1730		1922
…		…
1734		1926
1735	=item $handle->stoptls	1927	=item $handle->stoptls
1736		1928
1737	Shuts down the SSL connection - this makes a proper EOF handshake by	1929	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	1930	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	1931	support non-blocking shut downs, it is not guaranteed that you can re-use
1740	the stream afterwards.	1932	the stream afterwards.
1741		1933
1742	=cut	1934	=cut
1743		1935
1744	sub stoptls {	1936	sub stoptls {
1745	my ($self) = @_;	1937	my ($self) = @_;
1746		1938
1747	if ($self->{tls}) {	1939	if ($self->{tls} && $self->{fh}) {
1748	Net::SSLeay::shutdown ($self->{tls});	1940	Net::SSLeay::shutdown ($self->{tls});
1749		1941
1750	&_dotls;	1942	&_dotls;
1751		1943
1752	# # we don't give a shit. no, we do, but we can't. no...#d#	1944	# # we don't give a shit. no, we do, but we can't. no...#d#
…		…
1759	my ($self) = @_;	1951	my ($self) = @_;
1760		1952
1761	return unless $self->{tls};	1953	return unless $self->{tls};
1762		1954
1763	$self->{tls_ctx}->_put_session (delete $self->{tls})	1955	$self->{tls_ctx}->_put_session (delete $self->{tls})
1764	if ref $self->{tls};	1956	if $self->{tls} > 0;
1765		1957
1766	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};	1958	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1767	}	1959	}
1768		1960
1769	sub DESTROY {	1961	sub DESTROY {
…		…
1777	my $fh = delete $self->{fh};	1969	my $fh = delete $self->{fh};
1778	my $wbuf = delete $self->{wbuf};	1970	my $wbuf = delete $self->{wbuf};
1779		1971
1780	my @linger;	1972	my @linger;
1781		1973
1782	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {	1974	push @linger, AE::io $fh, 1, sub {
1783	my $len = syswrite $fh, $wbuf, length $wbuf;	1975	my $len = syswrite $fh, $wbuf, length $wbuf;
1784		1976
1785	if ($len > 0) {	1977	if ($len > 0) {
1786	substr $wbuf, 0, $len, "";	1978	substr $wbuf, 0, $len, "";
1787	} else {	1979	} else {
1788	@linger = (); # end	1980	@linger = (); # end
1789	}	1981	}
1790	});	1982	};
1791	push @linger, AnyEvent->timer (after => $linger, cb => sub {	1983	push @linger, AE::timer $linger, 0, sub {
1792	@linger = ();	1984	@linger = ();
1793	});	1985	};
1794	}	1986	}
1795	}	1987	}
1796		1988
1797	=item $handle->destroy	1989	=item $handle->destroy
1798		1990
1799	Shuts down the handle object as much as possible - this call ensures that	1991	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	1992	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.	1993	will be freed. Any method you will call on the handle object after
		1994	destroying it in this way will be silently ignored (and it will return the
		1995	empty list).
1802		1996
1803	Normally, you can just "forget" any references to an AnyEvent::Handle	1997	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	1998	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	1999	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	2000	callback, so when you want to destroy the AnyEvent::Handle object from
…		…
1820	sub destroy {	2014	sub destroy {
1821	my ($self) = @_;	2015	my ($self) = @_;
1822		2016
1823	$self->DESTROY;	2017	$self->DESTROY;
1824	%$self = ();	2018	%$self = ();
		2019	bless $self, "AnyEvent::Handle::destroyed";
1825	}	2020	}
		2021
		2022	sub AnyEvent::Handle::destroyed::AUTOLOAD {
		2023	#nop
		2024	}
		2025
		2026	=item $handle->destroyed
		2027
		2028	Returns false as long as the handle hasn't been destroyed by a call to C<<
		2029	->destroy >>, true otherwise.
		2030
		2031	Can be useful to decide whether the handle is still valid after some
		2032	callback possibly destroyed the handle. For example, C<< ->push_write >>,
		2033	C<< ->starttls >> and other methods can call user callbacks, which in turn
		2034	can destroy the handle, so work can be avoided by checking sometimes:
		2035
		2036	$hdl->starttls ("accept");
		2037	return if $hdl->destroyed;
		2038	$hdl->push_write (...
		2039
		2040	Note that the call to C<push_write> will silently be ignored if the handle
		2041	has been destroyed, so often you can just ignore the possibility of the
		2042	handle being destroyed.
		2043
		2044	=cut
		2045
		2046	sub destroyed { 0 }
		2047	sub AnyEvent::Handle::destroyed::destroyed { 1 }
1826		2048
1827	=item AnyEvent::Handle::TLS_CTX	2049	=item AnyEvent::Handle::TLS_CTX
1828		2050
1829	This function creates and returns the AnyEvent::TLS object used by default	2051	This function creates and returns the AnyEvent::TLS object used by default
1830	for TLS mode.	2052	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.192 by root, Fri Mar 12 23:22:14 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.192 by root, Fri Mar 12 23:22:14 2010 UTC