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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.162 by root, Sun Jul 26 00:17:25 2009 UTC vs.
Revision 1.188 by root, Thu Sep 17 08:20:14 2009 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.87;
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::TLS fh => $filehandle, key => value...
…		…
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
…		…
602		714
603	sub on_starttls {	715	sub on_starttls {
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
753	if ($self->{tls}) {	908	if ($self->{tls}) {
754	$self->{_tls_wbuf} .= $_[0];	909	$self->{_tls_wbuf} .= $_[0];
…		…
759	}	914	}
760	}	915	}
761		916
762	=item $handle->push_write (type => @args)	917	=item $handle->push_write (type => @args)
763		918
764	Instead of formatting your data yourself, you can also let this module do	919	Instead of formatting your data yourself, you can also let this module
765	the job by specifying a type and type-specific arguments.	920	do the job by specifying a type and type-specific arguments. You
		921	can also specify the (fully qualified) name of a package, in which
		922	case AnyEvent tries to load the package and then expects to find the
		923	C<anyevent_read_type> function inside (see "custom write types", below).
766		924
767	Predefined types are (if you have ideas for additional types, feel free to	925	Predefined types are (if you have ideas for additional types, feel free to
768	drop by and tell us):	926	drop by and tell us):
769		927
770	=over 4	928	=over 4
…		…
827	Other languages could read single lines terminated by a newline and pass	985	Other languages could read single lines terminated by a newline and pass
828	this line into their JSON decoder of choice.	986	this line into their JSON decoder of choice.
829		987
830	=cut	988	=cut
831		989
		990	sub json_coder() {
		991	eval { require JSON::XS; JSON::XS->new->utf8 }
		992	\|\| do { require JSON; JSON->new->utf8 }
		993	}
		994
832	register_write_type json => sub {	995	register_write_type json => sub {
833	my ($self, $ref) = @_;	996	my ($self, $ref) = @_;
834		997
835	require JSON;	998	my $json = $self->{json} \|\|= json_coder;
836		999
837	$self->{json} ? $self->{json}->encode ($ref)	1000	$json->encode ($ref)
838	: JSON::encode_json ($ref)
839	};	1001	};
840		1002
841	=item storable => $reference	1003	=item storable => $reference
842		1004
843	Freezes the given reference using L<Storable> and writes it to the	1005	Freezes the given reference using L<Storable> and writes it to the
…		…
878		1040
879	delete $self->{low_water_mark};	1041	delete $self->{low_water_mark};
880	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });	1042	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });
881	}	1043	}
882		1044
883	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	1045	=item custom write types - Package::anyevent_write_type $handle, @args
884		1046
885	This function (not method) lets you add your own types to C<push_write>.	1047	Instead of one of the predefined types, you can also specify the name of
		1048	a package. AnyEvent will try to load the package and then expects to find
		1049	a function named C<anyevent_write_type> inside. If it isn't found, it
		1050	progressively tries to load the parent package until it either finds the
		1051	function (good) or runs out of packages (bad).
		1052
886	Whenever the given C<type> is used, C<push_write> will invoke the code	1053	Whenever the given C<type> is used, C<push_write> will the function with
887	reference with the handle object and the remaining arguments.	1054	the handle object and the remaining arguments.
888		1055
889	The code reference is supposed to return a single octet string that will	1056	The function is supposed to return a single octet string that will be
890	be appended to the write buffer.	1057	appended to the write buffer, so you cna mentally treat this function as a
		1058	"arguments to on-the-wire-format" converter.
891		1059
892	Note that this is a function, and all types registered this way will be	1060	Example: implement a custom write type C<join> that joins the remaining
893	global, so try to use unique names.	1061	arguments using the first one.
		1062
		1063	$handle->push_write (My::Type => " ", 1,2,3);
		1064
		1065	# uses the following package, which can be defined in the "My::Type" or in
		1066	# the "My" modules to be auto-loaded, or just about anywhere when the
		1067	# My::Type::anyevent_write_type is defined before invoking it.
		1068
		1069	package My::Type;
		1070
		1071	sub anyevent_write_type {
		1072	my ($handle, $delim, @args) = @_;
		1073
		1074	join $delim, @args
		1075	}
894		1076
895	=cut	1077	=cut
896		1078
897	#############################################################################	1079	#############################################################################
898		1080
…		…
981		1163
982	sub _drain_rbuf {	1164	sub _drain_rbuf {
983	my ($self) = @_;	1165	my ($self) = @_;
984		1166
985	# avoid recursion	1167	# avoid recursion
986	return if exists $self->{_skip_drain_rbuf};	1168	return if $self->{_skip_drain_rbuf};
987	local $self->{_skip_drain_rbuf} = 1;	1169	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		1170
996	while () {	1171	while () {
997	# we need to use a separate tls read buffer, as we must not receive data while	1172	# 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.	1173	# we are draining the buffer, and this can only happen with TLS.
999	$self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf};	1174	$self->{rbuf} .= delete $self->{_tls_rbuf}
		1175	if exists $self->{_tls_rbuf};
1000		1176
1001	my $len = length $self->{rbuf};	1177	my $len = length $self->{rbuf};
1002		1178
1003	if (my $cb = shift @{ $self->{_queue} }) {	1179	if (my $cb = shift @{ $self->{_queue} }) {
1004	unless ($cb->($self)) {	1180	unless ($cb->($self)) {
1005	if ($self->{_eof}) {	1181	# no progress can be made
1006	# no progress can be made (not enough data and no data forthcoming)	1182	# (not enough data and no data forthcoming)
1007	$self->_error (Errno::EPIPE, 1), return;	1183	$self->_error (Errno::EPIPE, 1), return
1008	}	1184	if $self->{_eof};
1009		1185
1010	unshift @{ $self->{_queue} }, $cb;	1186	unshift @{ $self->{_queue} }, $cb;
1011	last;	1187	last;
1012	}	1188	}
1013	} elsif ($self->{on_read}) {	1189	} elsif ($self->{on_read}) {
…		…
1033	last;	1209	last;
1034	}	1210	}
1035	}	1211	}
1036		1212
1037	if ($self->{_eof}) {	1213	if ($self->{_eof}) {
1038	if ($self->{on_eof}) {	1214	$self->{on_eof}
1039	$self->{on_eof}($self)	1215	? $self->{on_eof}($self)
1040	} else {
1041	$self->_error (0, 1, "Unexpected end-of-file");	1216	: $self->_error (0, 1, "Unexpected end-of-file");
1042	}	1217
		1218	return;
		1219	}
		1220
		1221	if (
		1222	defined $self->{rbuf_max}
		1223	&& $self->{rbuf_max} < length $self->{rbuf}
		1224	) {
		1225	$self->_error (Errno::ENOSPC, 1), return;
1043	}	1226	}
1044		1227
1045	# may need to restart read watcher	1228	# may need to restart read watcher
1046	unless ($self->{_rw}) {	1229	unless ($self->{_rw}) {
1047	$self->start_read	1230	$self->start_read
…		…
1116	my $cb = pop;	1299	my $cb = pop;
1117		1300
1118	if (@_) {	1301	if (@_) {
1119	my $type = shift;	1302	my $type = shift;
1120		1303
		1304	$cb = ($RH{$type} \|\|= _load_func "$type\::anyevent_read_type"
1121	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	1305	or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_read")
1122	->($self, $cb, @_);	1306	->($self, $cb, @_);
1123	}	1307	}
1124		1308
1125	push @{ $self->{_queue} }, $cb;	1309	push @{ $self->{_queue} }, $cb;
1126	$self->_drain_rbuf;	1310	$self->_drain_rbuf;
…		…
1135		1319
1136	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")	1320	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")
1137	->($self, $cb, @_);	1321	->($self, $cb, @_);
1138	}	1322	}
1139		1323
1140
1141	unshift @{ $self->{_queue} }, $cb;	1324	unshift @{ $self->{_queue} }, $cb;
1142	$self->_drain_rbuf;	1325	$self->_drain_rbuf;
1143	}	1326	}
1144		1327
1145	=item $handle->push_read (type => @args, $cb)	1328	=item $handle->push_read (type => @args, $cb)
1146		1329
1147	=item $handle->unshift_read (type => @args, $cb)	1330	=item $handle->unshift_read (type => @args, $cb)
1148		1331
1149	Instead of providing a callback that parses the data itself you can chose	1332	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	1333	between a number of predefined parsing formats, for chunks of data, lines
1151	etc.	1334	etc. You can also specify the (fully qualified) name of a package, in
		1335	which case AnyEvent tries to load the package and then expects to find the
		1336	C<anyevent_read_type> function inside (see "custom read types", below).
1152		1337
1153	Predefined types are (if you have ideas for additional types, feel free to	1338	Predefined types are (if you have ideas for additional types, feel free to
1154	drop by and tell us):	1339	drop by and tell us):
1155		1340
1156	=over 4	1341	=over 4
…		…
1396	=cut	1581	=cut
1397		1582
1398	register_read_type json => sub {	1583	register_read_type json => sub {
1399	my ($self, $cb) = @_;	1584	my ($self, $cb) = @_;
1400		1585
1401	my $json = $self->{json} \|\|=	1586	my $json = $self->{json} \|\|= json_coder;
1402	eval { require JSON::XS; JSON::XS->new->utf8 }
1403	\|\| do { require JSON; JSON->new->utf8 };
1404		1587
1405	my $data;	1588	my $data;
1406	my $rbuf = \$self->{rbuf};	1589	my $rbuf = \$self->{rbuf};
1407		1590
1408	sub {	1591	sub {
…		…
1477	}	1660	}
1478	};	1661	};
1479		1662
1480	=back	1663	=back
1481		1664
1482	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)	1665	=item custom read types - Package::anyevent_read_type $handle, $cb, @args
1483		1666
1484	This function (not method) lets you add your own types to C<push_read>.	1667	Instead of one of the predefined types, you can also specify the name
		1668	of a package. AnyEvent will try to load the package and then expects to
		1669	find a function named C<anyevent_read_type> inside. If it isn't found, it
		1670	progressively tries to load the parent package until it either finds the
		1671	function (good) or runs out of packages (bad).
1485		1672
1486	Whenever the given C<type> is used, C<push_read> will invoke the code	1673	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	1674	handle object, the original callback and the remaining arguments.
1488	arguments.
1489		1675
1490	The code reference is supposed to return a callback (usually a closure)	1676	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) >>).	1677	works as a plain read callback (see C<< ->push_read ($cb) >>), so you can
		1678	mentally treat the function as a "configurable read type to read callback"
		1679	converter.
1492		1680
1493	It should invoke the passed callback when it is done reading (remember to	1681	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).	1682	to pass C<$handle> as first argument as all other callbacks do that,
		1683	although there is no strict requirement on this).
1495		1684
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>,	1685	For examples, see the source of this module (F<perldoc -m
1500	search for C<register_read_type>)).	1686	AnyEvent::Handle>, search for C<register_read_type>)).
1501		1687
1502	=item $handle->stop_read	1688	=item $handle->stop_read
1503		1689
1504	=item $handle->start_read	1690	=item $handle->start_read
1505		1691
…		…
1528	my ($self) = @_;	1714	my ($self) = @_;
1529		1715
1530	unless ($self->{_rw} \|\| $self->{_eof}) {	1716	unless ($self->{_rw} \|\| $self->{_eof}) {
1531	Scalar::Util::weaken $self;	1717	Scalar::Util::weaken $self;
1532		1718
1533	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1719	$self->{_rw} = AE::io $self->{fh}, 0, sub {
1534	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});	1720	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1535	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;	1721	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;
1536		1722
1537	if ($len > 0) {	1723	if ($len > 0) {
1538	$self->{_activity} = AnyEvent->now;	1724	$self->{_activity} = $self->{_ractivity} = AE::now;
1539		1725
1540	if ($self->{tls}) {	1726	if ($self->{tls}) {
1541	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);	1727	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1542		1728
1543	&_dotls ($self);	1729	&_dotls ($self);
…		…
1551	$self->_drain_rbuf;	1737	$self->_drain_rbuf;
1552		1738
1553	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1739	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1554	return $self->_error ($!, 1);	1740	return $self->_error ($!, 1);
1555	}	1741	}
1556	});	1742	};
1557	}	1743	}
1558	}	1744	}
1559		1745
1560	our $ERROR_SYSCALL;	1746	our $ERROR_SYSCALL;
1561	our $ERROR_WANT_READ;	1747	our $ERROR_WANT_READ;
…		…
1682	require Net::SSLeay;	1868	require Net::SSLeay;
1683		1869
1684	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();	1870	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1685	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();	1871	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1686		1872
1687	$tls = $self->{tls};	1873	$tls = delete $self->{tls};
1688	$ctx = $self->{tls_ctx};	1874	$ctx = $self->{tls_ctx};
1689		1875
1690	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session	1876	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
1691		1877
1692	if ("HASH" eq ref $ctx) {	1878	if ("HASH" eq ref $ctx) {
…		…
1721	Net::SSLeay::CTX_set_mode ($tls, 1\|2);	1907	Net::SSLeay::CTX_set_mode ($tls, 1\|2);
1722		1908
1723	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1909	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1724	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1910	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1725		1911
		1912	Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf});
		1913
1726	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});	1914	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
1727		1915
1728	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }	1916	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1729	if $self->{on_starttls};	1917	if $self->{on_starttls};
1730		1918
…		…
1759	my ($self) = @_;	1947	my ($self) = @_;
1760		1948
1761	return unless $self->{tls};	1949	return unless $self->{tls};
1762		1950
1763	$self->{tls_ctx}->_put_session (delete $self->{tls})	1951	$self->{tls_ctx}->_put_session (delete $self->{tls})
1764	if ref $self->{tls};	1952	if $self->{tls} > 0;
1765		1953
1766	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};	1954	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1767	}	1955	}
1768		1956
1769	sub DESTROY {	1957	sub DESTROY {
…		…
1777	my $fh = delete $self->{fh};	1965	my $fh = delete $self->{fh};
1778	my $wbuf = delete $self->{wbuf};	1966	my $wbuf = delete $self->{wbuf};
1779		1967
1780	my @linger;	1968	my @linger;
1781		1969
1782	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {	1970	push @linger, AE::io $fh, 1, sub {
1783	my $len = syswrite $fh, $wbuf, length $wbuf;	1971	my $len = syswrite $fh, $wbuf, length $wbuf;
1784		1972
1785	if ($len > 0) {	1973	if ($len > 0) {
1786	substr $wbuf, 0, $len, "";	1974	substr $wbuf, 0, $len, "";
1787	} else {	1975	} else {
1788	@linger = (); # end	1976	@linger = (); # end
1789	}	1977	}
1790	});	1978	};
1791	push @linger, AnyEvent->timer (after => $linger, cb => sub {	1979	push @linger, AE::timer $linger, 0, sub {
1792	@linger = ();	1980	@linger = ();
1793	});	1981	};
1794	}	1982	}
1795	}	1983	}
1796		1984
1797	=item $handle->destroy	1985	=item $handle->destroy
1798		1986
1799	Shuts down the handle object as much as possible - this call ensures that	1987	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	1988	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.	1989	will be freed. Any method you will call on the handle object after
		1990	destroying it in this way will be silently ignored (and it will return the
		1991	empty list).
1802		1992
1803	Normally, you can just "forget" any references to an AnyEvent::Handle	1993	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	1994	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	1995	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	1996	callback, so when you want to destroy the AnyEvent::Handle object from
…		…
1820	sub destroy {	2010	sub destroy {
1821	my ($self) = @_;	2011	my ($self) = @_;
1822		2012
1823	$self->DESTROY;	2013	$self->DESTROY;
1824	%$self = ();	2014	%$self = ();
		2015	bless $self, "AnyEvent::Handle::destroyed";
		2016	}
		2017
		2018	sub AnyEvent::Handle::destroyed::AUTOLOAD {
		2019	#nop
1825	}	2020	}
1826		2021
1827	=item AnyEvent::Handle::TLS_CTX	2022	=item AnyEvent::Handle::TLS_CTX
1828		2023
1829	This function creates and returns the AnyEvent::TLS object used by default	2024	This function creates and returns the AnyEvent::TLS object used by default

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.162 by root, Sun Jul 26 00:17:25 2009 UTC vs. Revision 1.188 by root, Thu Sep 17 08:20:14 2009 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.162 by root, Sun Jul 26 00:17:25 2009 UTC vs.
Revision 1.188 by root, Thu Sep 17 08:20:14 2009 UTC