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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.160 by root, Fri Jul 24 22:47:04 2009 UTC vs.
Revision 1.186 by root, Mon Sep 7 19:54:57 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.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;
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...
…		…
101	attempted, but after the file handle has been created. It could be used to	117	attempted, but after the file handle has been created. It could be used to
102	prepare the file handle with parameters required for the actual connect	118	prepare the file handle with parameters required for the actual connect
103	(as opposed to settings that can be changed when the connection is already	119	(as opposed to settings that can be changed when the connection is already
104	established).	120	established).
105		121
		122	The return value of this callback should be the connect timeout value in
		123	seconds (or C<0>, or C<undef>, or the empty list, to indicate the default
		124	timeout is to be used).
		125
106	=item on_connect => $cb->($handle, $host, $port, $retry->())	126	=item on_connect => $cb->($handle, $host, $port, $retry->())
107		127
108	This callback is called when a connection has been successfully established.	128	This callback is called when a connection has been successfully established.
109		129
110	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
111	parameters, together with a retry callback.	131	parameters, together with a retry callback.
112		132
113	When, for some reason, the handle is not acceptable, then calling	133	When, for some reason, the handle is not acceptable, then calling
114	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
115	multi-homed hosts or SRV records there can be multiple connection	135	multi-homed hosts or SRV records there can be multiple connection
116	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
117	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.
118		139
119	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.
120		141
121	=item on_connect_error => $cb->($handle, $message)	142	=item on_connect_error => $cb->($handle, $message)
122		143
123	This callback is called when the conenction could not be	144	This callback is called when the connection could not be
124	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
125	message describing it (usually the same as C<"$!">).	146	message describing it (usually the same as C<"$!">).
126		147
127	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
128	fatal error instead.	149	fatal error instead.
…		…
212	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
213	the file when the write queue becomes empty.	234	the file when the write queue becomes empty.
214		235
215	=item timeout => $fractional_seconds	236	=item timeout => $fractional_seconds
216		237
		238	=item rtimeout => $fractional_seconds
		239
		240	=item wtimeout => $fractional_seconds
		241
217	If non-zero, then this enables an "inactivity" timeout: whenever this many	242	If non-zero, then these enables an "inactivity" timeout: whenever this
218	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
219	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
220	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>.
221		253
222	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
223	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
224	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
225	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
…		…
269	accomplishd by setting this option to a true value.	301	accomplishd by setting this option to a true value.
270		302
271	The default is your opertaing system's default behaviour (most likely	303	The default is your opertaing system's default behaviour (most likely
272	enabled), this option explicitly enables or disables it, if possible.	304	enabled), this option explicitly enables or disables it, if possible.
273		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
274	=item read_size => <bytes>	338	=item read_size => <bytes>
275		339
276	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
277	try to read during each loop iteration, which affects memory	341	try to read during each loop iteration, which affects memory
278	requirements). Default: C<8192>.	342	requirements). Default: C<8192>.
…		…
311	C<undef>.	375	C<undef>.
312		376
313	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	377	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
314		378
315	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
316	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
317	established and will transparently encrypt/decrypt data afterwards.	381	established and will transparently encrypt/decrypt data afterwards.
318		382
319	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
320	appropriate error message.	384	appropriate error message.
321		385
…		…
434	delete $self->{_skip_drain_rbuf};	498	delete $self->{_skip_drain_rbuf};
435	$self->_start;	499	$self->_start;
436		500
437	$self->{on_connect}	501	$self->{on_connect}
438	and $self->{on_connect}($self, $host, $port, sub {	502	and $self->{on_connect}($self, $host, $port, sub {
439	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)};
440	$self->{_skip_drain_rbuf} = 1;	504	$self->{_skip_drain_rbuf} = 1;
441	&$retry;	505	&$retry;
442	});	506	});
443		507
444	} else {	508	} else {
445	if ($self->{on_connect_error}) {	509	if ($self->{on_connect_error}) {
446	$self->{on_connect_error}($self, "$!");	510	$self->{on_connect_error}($self, "$!");
447	$self->destroy;	511	$self->destroy;
448	} else {	512	} else {
449	$self->fatal ($!, 1);	513	$self->_error ($!, 1);
450	}	514	}
451	}	515	}
452	},	516	},
453	sub {	517	sub {
454	local $self->{fh} = $_[0];	518	local $self->{fh} = $_[0];
455		519
		520	$self->{on_prepare}
456	$self->{on_prepare}->($self)	521	? $self->{on_prepare}->($self)
457	if $self->{on_prepare};	522	: ()
458	}	523	}
459	);	524	);
460	}	525	}
461		526
462	} else {	527	} else {
…		…
469	sub _start {	534	sub _start {
470	my ($self) = @_;	535	my ($self) = @_;
471		536
472	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	537	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
473		538
		539	$self->{_activity} =
		540	$self->{_ractivity} =
474	$self->{_activity} = AnyEvent->now;	541	$self->{_wactivity} = AE::now;
475	$self->_timeout;
476		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
477	$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};
478		549
		550	$self->oobinline (exists $self->{oobinline} ? delete $self->{oobinline} : 1);
		551
479	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})	552	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
480	if $self->{tls};	553	if $self->{tls};
481		554
482	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	555	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
483		556
484	$self->start_read	557	$self->start_read
485	if $self->{on_read} \|\| @{ $self->{_queue} };	558	if $self->{on_read} \|\| @{ $self->{_queue} };
486		559
487	$self->_drain_wbuf;	560	$self->_drain_wbuf;
488	}	561	}
489
490	#sub _shutdown {
491	# my ($self) = @_;
492	#
493	# delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)};
494	# $self->{_eof} = 1; # tell starttls et. al to stop trying
495	#
496	# &_freetls;
497	#}
498		562
499	sub _error {	563	sub _error {
500	my ($self, $errno, $fatal, $message) = @_;	564	my ($self, $errno, $fatal, $message) = @_;
501		565
502	$! = $errno;	566	$! = $errno;
…		…
539	$_[0]{on_eof} = $_[1];	603	$_[0]{on_eof} = $_[1];
540	}	604	}
541		605
542	=item $handle->on_timeout ($cb)	606	=item $handle->on_timeout ($cb)
543		607
544	Replace the current C<on_timeout> callback, or disables the callback (but	608	=item $handle->on_rtimeout ($cb)
545	not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
546	argument and method.
547		609
548	=cut	610	=item $handle->on_wtimeout ($cb)
549		611
550	sub on_timeout {	612	Replace the current C<on_timeout>, C<on_rtimeout> or C<on_wtimeout>
551	$_[0]{on_timeout} = $_[1];	613	callback, or disables the callback (but not the timeout) if C<$cb> =
552	}	614	C<undef>. See the C<timeout> constructor argument and method.
		615
		616	=cut
		617
		618	# see below
553		619
554	=item $handle->autocork ($boolean)	620	=item $handle->autocork ($boolean)
555		621
556	Enables or disables the current autocork behaviour (see C<autocork>	622	Enables or disables the current autocork behaviour (see C<autocork>
557	constructor argument). Changes will only take effect on the next write.	623	constructor argument). Changes will only take effect on the next write.
…		…
572	sub no_delay {	638	sub no_delay {
573	$_[0]{no_delay} = $_[1];	639	$_[0]{no_delay} = $_[1];
574		640
575	eval {	641	eval {
576	local $SIG{__DIE__};	642	local $SIG{__DIE__};
577	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1]	643	setsockopt $_[0]{fh}, Socket::IPPROTO_TCP (), Socket::TCP_NODELAY (), int $_[1]
578	if $_[0]{fh};	644	if $_[0]{fh};
579	};	645	};
580	}	646	}
581		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
582	=item $handle->on_starttls ($cb)	699	=item $handle->on_starttls ($cb)
583		700
584	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).
585		702
586	=cut	703	=cut
…		…
597		714
598	sub on_starttls {	715	sub on_starttls {
599	$_[0]{on_stoptls} = $_[1];	716	$_[0]{on_stoptls} = $_[1];
600	}	717	}
601		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
602	#############################################################################	729	#############################################################################
603		730
604	=item $handle->timeout ($seconds)	731	=item $handle->timeout ($seconds)
605		732
		733	=item $handle->rtimeout ($seconds)
		734
		735	=item $handle->wtimeout ($seconds)
		736
606	Configures (or disables) the inactivity timeout.	737	Configures (or disables) the inactivity timeout.
607		738
608	=cut	739	=item $handle->timeout_reset
609		740
610	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 {
611	my ($self, $timeout) = @_;	763	my ($self, $new_value) = @_;
612		764
613	$self->{timeout} = $timeout;	765	$self->{$timeout} = $new_value;
614	$self->_timeout;	766	delete $self->{$tw}; &$cb;
615	}	767	};
616		768
		769	*{"${dir}timeout_reset"} = sub {
		770	$_[0]{$activity} = AE::now;
		771	};
		772
		773	# main workhorse:
617	# reset the timeout watcher, as neccessary	774	# reset the timeout watcher, as neccessary
618	# also check for time-outs	775	# also check for time-outs
619	sub _timeout {	776	$cb = sub {
620	my ($self) = @_;	777	my ($self) = @_;
621		778
622	if ($self->{timeout} && $self->{fh}) {	779	if ($self->{$timeout} && $self->{fh}) {
623	my $NOW = AnyEvent->now;	780	my $NOW = AE::now;
624		781
625	# when would the timeout trigger?	782	# when would the timeout trigger?
626	my $after = $self->{_activity} + $self->{timeout} - $NOW;	783	my $after = $self->{$activity} + $self->{$timeout} - $NOW;
627		784
628	# now or in the past already?	785	# now or in the past already?
629	if ($after <= 0) {	786	if ($after <= 0) {
630	$self->{_activity} = $NOW;	787	$self->{$activity} = $NOW;
631		788
632	if ($self->{on_timeout}) {	789	if ($self->{$on_timeout}) {
633	$self->{on_timeout}($self);	790	$self->{$on_timeout}($self);
634	} else {	791	} else {
635	$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};
636	}	800	}
637		801
638	# callback could have changed timeout value, optimise	802	Scalar::Util::weaken $self;
639	return unless $self->{timeout};	803	return unless $self; # ->error could have destroyed $self
640		804
641	# calculate new after	805	$self->{$tw} \|\|= AE::timer $after, 0, sub {
642	$after = $self->{timeout};	806	delete $self->{$tw};
		807	$cb->($self);
		808	};
		809	} else {
		810	delete $self->{$tw};
643	}	811	}
644
645	Scalar::Util::weaken $self;
646	return unless $self; # ->error could have destroyed $self
647
648	$self->{_tw} \|\|= AnyEvent->timer (after => $after, cb => sub {
649	delete $self->{_tw};
650	$self->_timeout;
651	});
652	} else {
653	delete $self->{_tw};
654	}	812	}
655	}	813	}
656		814
657	#############################################################################	815	#############################################################################
658		816
…		…
706	my $len = syswrite $self->{fh}, $self->{wbuf};	864	my $len = syswrite $self->{fh}, $self->{wbuf};
707		865
708	if (defined $len) {	866	if (defined $len) {
709	substr $self->{wbuf}, 0, $len, "";	867	substr $self->{wbuf}, 0, $len, "";
710		868
711	$self->{_activity} = AnyEvent->now;	869	$self->{_activity} = $self->{_wactivity} = AE::now;
712		870
713	$self->{on_drain}($self)	871	$self->{on_drain}($self)
714	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})
715	&& $self->{on_drain};	873	&& $self->{on_drain};
716		874
…		…
722		880
723	# try to write data immediately	881	# try to write data immediately
724	$cb->() unless $self->{autocork};	882	$cb->() unless $self->{autocork};
725		883
726	# if still data left in wbuf, we need to poll	884	# if still data left in wbuf, we need to poll
727	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	885	$self->{_ww} = AE::io $self->{fh}, 1, $cb
728	if length $self->{wbuf};	886	if length $self->{wbuf};
729	};	887	};
730	}	888	}
731		889
732	our %WH;	890	our %WH;
733		891
		892	# deprecated
734	sub register_write_type($$) {	893	sub register_write_type($$) {
735	$WH{$_[0]} = $_[1];	894	$WH{$_[0]} = $_[1];
736	}	895	}
737		896
738	sub push_write {	897	sub push_write {
739	my $self = shift;	898	my $self = shift;
740		899
741	if (@_ > 1) {	900	if (@_ > 1) {
742	my $type = shift;	901	my $type = shift;
743		902
		903	@_ = ($WH{$type} \|\|= _load_func "$type\::anyevent_write_type"
744	@_ = ($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")
745	->($self, @_);	905	->($self, @_);
746	}	906	}
747		907
748	if ($self->{tls}) {	908	if ($self->{tls}) {
749	$self->{_tls_wbuf} .= $_[0];	909	$self->{_tls_wbuf} .= $_[0];
…		…
754	}	914	}
755	}	915	}
756		916
757	=item $handle->push_write (type => @args)	917	=item $handle->push_write (type => @args)
758		918
759	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
760	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).
761		924
762	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
763	drop by and tell us):	926	drop by and tell us):
764		927
765	=over 4	928	=over 4
…		…
822	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
823	this line into their JSON decoder of choice.	986	this line into their JSON decoder of choice.
824		987
825	=cut	988	=cut
826		989
		990	sub json_coder() {
		991	eval { require JSON::XS; JSON::XS->new->utf8 }
		992	\|\| do { require JSON; JSON->new->utf8 }
		993	}
		994
827	register_write_type json => sub {	995	register_write_type json => sub {
828	my ($self, $ref) = @_;	996	my ($self, $ref) = @_;
829		997
830	require JSON;	998	my $json = $self->{json} \|\|= json_coder;
831		999
832	$self->{json} ? $self->{json}->encode ($ref)	1000	$json->encode ($ref)
833	: JSON::encode_json ($ref)
834	};	1001	};
835		1002
836	=item storable => $reference	1003	=item storable => $reference
837		1004
838	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
…		…
873		1040
874	delete $self->{low_water_mark};	1041	delete $self->{low_water_mark};
875	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });	1042	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });
876	}	1043	}
877		1044
878	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	1045	=item custom write types - Package::anyevent_write_type $handle, @args
879		1046
880	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
881	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
882	reference with the handle object and the remaining arguments.	1054	the handle object and the remaining arguments.
883		1055
884	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
885	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.
886		1059
887	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
888	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	}
889		1076
890	=cut	1077	=cut
891		1078
892	#############################################################################	1079	#############################################################################
893		1080
…		…
976		1163
977	sub _drain_rbuf {	1164	sub _drain_rbuf {
978	my ($self) = @_;	1165	my ($self) = @_;
979		1166
980	# avoid recursion	1167	# avoid recursion
981	return if exists $self->{_skip_drain_rbuf};	1168	return if $self->{_skip_drain_rbuf};
982	local $self->{_skip_drain_rbuf} = 1;	1169	local $self->{_skip_drain_rbuf} = 1;
983
984	if (
985	defined $self->{rbuf_max}
986	&& $self->{rbuf_max} < length $self->{rbuf}
987	) {
988	$self->_error (Errno::ENOSPC, 1), return;
989	}
990		1170
991	while () {	1171	while () {
992	# 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
993	# 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.
994	$self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf};	1174	$self->{rbuf} .= delete $self->{_tls_rbuf}
		1175	if exists $self->{_tls_rbuf};
995		1176
996	my $len = length $self->{rbuf};	1177	my $len = length $self->{rbuf};
997		1178
998	if (my $cb = shift @{ $self->{_queue} }) {	1179	if (my $cb = shift @{ $self->{_queue} }) {
999	unless ($cb->($self)) {	1180	unless ($cb->($self)) {
1000	if ($self->{_eof}) {	1181	# no progress can be made
1001	# no progress can be made (not enough data and no data forthcoming)	1182	# (not enough data and no data forthcoming)
1002	$self->_error (Errno::EPIPE, 1), return;	1183	$self->_error (Errno::EPIPE, 1), return
1003	}	1184	if $self->{_eof};
1004		1185
1005	unshift @{ $self->{_queue} }, $cb;	1186	unshift @{ $self->{_queue} }, $cb;
1006	last;	1187	last;
1007	}	1188	}
1008	} elsif ($self->{on_read}) {	1189	} elsif ($self->{on_read}) {
…		…
1028	last;	1209	last;
1029	}	1210	}
1030	}	1211	}
1031		1212
1032	if ($self->{_eof}) {	1213	if ($self->{_eof}) {
1033	if ($self->{on_eof}) {	1214	$self->{on_eof}
1034	$self->{on_eof}($self)	1215	? $self->{on_eof}($self)
1035	} else {
1036	$self->_error (0, 1, "Unexpected end-of-file");	1216	: $self->_error (0, 1, "Unexpected end-of-file");
1037	}	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;
1038	}	1226	}
1039		1227
1040	# may need to restart read watcher	1228	# may need to restart read watcher
1041	unless ($self->{_rw}) {	1229	unless ($self->{_rw}) {
1042	$self->start_read	1230	$self->start_read
…		…
1111	my $cb = pop;	1299	my $cb = pop;
1112		1300
1113	if (@_) {	1301	if (@_) {
1114	my $type = shift;	1302	my $type = shift;
1115		1303
		1304	$cb = ($RH{$type} \|\|= _load_func "$type\::anyevent_read_type"
1116	$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")
1117	->($self, $cb, @_);	1306	->($self, $cb, @_);
1118	}	1307	}
1119		1308
1120	push @{ $self->{_queue} }, $cb;	1309	push @{ $self->{_queue} }, $cb;
1121	$self->_drain_rbuf;	1310	$self->_drain_rbuf;
…		…
1130		1319
1131	$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")
1132	->($self, $cb, @_);	1321	->($self, $cb, @_);
1133	}	1322	}
1134		1323
1135
1136	unshift @{ $self->{_queue} }, $cb;	1324	unshift @{ $self->{_queue} }, $cb;
1137	$self->_drain_rbuf;	1325	$self->_drain_rbuf;
1138	}	1326	}
1139		1327
1140	=item $handle->push_read (type => @args, $cb)	1328	=item $handle->push_read (type => @args, $cb)
1141		1329
1142	=item $handle->unshift_read (type => @args, $cb)	1330	=item $handle->unshift_read (type => @args, $cb)
1143		1331
1144	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
1145	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
1146	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).
1147		1337
1148	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
1149	drop by and tell us):	1339	drop by and tell us):
1150		1340
1151	=over 4	1341	=over 4
…		…
1391	=cut	1581	=cut
1392		1582
1393	register_read_type json => sub {	1583	register_read_type json => sub {
1394	my ($self, $cb) = @_;	1584	my ($self, $cb) = @_;
1395		1585
1396	my $json = $self->{json} \|\|=	1586	my $json = $self->{json} \|\|= json_coder;
1397	eval { require JSON::XS; JSON::XS->new->utf8 }
1398	\|\| do { require JSON; JSON->new->utf8 };
1399		1587
1400	my $data;	1588	my $data;
1401	my $rbuf = \$self->{rbuf};	1589	my $rbuf = \$self->{rbuf};
1402		1590
1403	sub {	1591	sub {
…		…
1472	}	1660	}
1473	};	1661	};
1474		1662
1475	=back	1663	=back
1476		1664
1477	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)	1665	=item custom read types - Package::anyevent_read_type $handle, $cb, @args
1478		1666
1479	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).
1480		1672
1481	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
1482	reference with the handle object, the callback and the remaining	1674	handle object, the original callback and the remaining arguments.
1483	arguments.
1484		1675
1485	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
1486	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.
1487		1680
1488	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
1489	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).
1490		1684
1491	Note that this is a function, and all types registered this way will be
1492	global, so try to use unique names.
1493
1494	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
1495	search for C<register_read_type>)).	1686	AnyEvent::Handle>, search for C<register_read_type>)).
1496		1687
1497	=item $handle->stop_read	1688	=item $handle->stop_read
1498		1689
1499	=item $handle->start_read	1690	=item $handle->start_read
1500		1691
…		…
1523	my ($self) = @_;	1714	my ($self) = @_;
1524		1715
1525	unless ($self->{_rw} \|\| $self->{_eof}) {	1716	unless ($self->{_rw} \|\| $self->{_eof}) {
1526	Scalar::Util::weaken $self;	1717	Scalar::Util::weaken $self;
1527		1718
1528	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1719	$self->{_rw} = AE::io $self->{fh}, 0, sub {
1529	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});	1720	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1530	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;
1531		1722
1532	if ($len > 0) {	1723	if ($len > 0) {
1533	$self->{_activity} = AnyEvent->now;	1724	$self->{_activity} = $self->{_ractivity} = AE::now;
1534		1725
1535	if ($self->{tls}) {	1726	if ($self->{tls}) {
1536	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);	1727	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1537		1728
1538	&_dotls ($self);	1729	&_dotls ($self);
…		…
1546	$self->_drain_rbuf;	1737	$self->_drain_rbuf;
1547		1738
1548	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1739	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1549	return $self->_error ($!, 1);	1740	return $self->_error ($!, 1);
1550	}	1741	}
1551	});	1742	};
1552	}	1743	}
1553	}	1744	}
1554		1745
1555	our $ERROR_SYSCALL;	1746	our $ERROR_SYSCALL;
1556	our $ERROR_WANT_READ;	1747	our $ERROR_WANT_READ;
…		…
1677	require Net::SSLeay;	1868	require Net::SSLeay;
1678		1869
1679	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();	1870	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1680	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();	1871	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1681		1872
1682	$tls = $self->{tls};	1873	$tls = delete $self->{tls};
1683	$ctx = $self->{tls_ctx};	1874	$ctx = $self->{tls_ctx};
1684		1875
1685	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
1686		1877
1687	if ("HASH" eq ref $ctx) {	1878	if ("HASH" eq ref $ctx) {
…		…
1716	Net::SSLeay::CTX_set_mode ($tls, 1\|2);	1907	Net::SSLeay::CTX_set_mode ($tls, 1\|2);
1717		1908
1718	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1909	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1719	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1910	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1720		1911
		1912	Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf});
		1913
1721	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});	1914	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
1722		1915
1723	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }	1916	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1724	if $self->{on_starttls};	1917	if $self->{on_starttls};
1725		1918
…		…
1754	my ($self) = @_;	1947	my ($self) = @_;
1755		1948
1756	return unless $self->{tls};	1949	return unless $self->{tls};
1757		1950
1758	$self->{tls_ctx}->_put_session (delete $self->{tls})	1951	$self->{tls_ctx}->_put_session (delete $self->{tls})
1759	if ref $self->{tls};	1952	if $self->{tls} > 0;
1760		1953
1761	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};	1954	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1762	}	1955	}
1763		1956
1764	sub DESTROY {	1957	sub DESTROY {
…		…
1772	my $fh = delete $self->{fh};	1965	my $fh = delete $self->{fh};
1773	my $wbuf = delete $self->{wbuf};	1966	my $wbuf = delete $self->{wbuf};
1774		1967
1775	my @linger;	1968	my @linger;
1776		1969
1777	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {	1970	push @linger, AE::io $fh, 1, sub {
1778	my $len = syswrite $fh, $wbuf, length $wbuf;	1971	my $len = syswrite $fh, $wbuf, length $wbuf;
1779		1972
1780	if ($len > 0) {	1973	if ($len > 0) {
1781	substr $wbuf, 0, $len, "";	1974	substr $wbuf, 0, $len, "";
1782	} else {	1975	} else {
1783	@linger = (); # end	1976	@linger = (); # end
1784	}	1977	}
1785	});	1978	};
1786	push @linger, AnyEvent->timer (after => $linger, cb => sub {	1979	push @linger, AE::timer $linger, 0, sub {
1787	@linger = ();	1980	@linger = ();
1788	});	1981	};
1789	}	1982	}
1790	}	1983	}
1791		1984
1792	=item $handle->destroy	1985	=item $handle->destroy
1793		1986
1794	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
1795	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
1796	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).
1797		1992
1798	Normally, you can just "forget" any references to an AnyEvent::Handle	1993	Normally, you can just "forget" any references to an AnyEvent::Handle
1799	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
1800	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
1801	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
…		…
1815	sub destroy {	2010	sub destroy {
1816	my ($self) = @_;	2011	my ($self) = @_;
1817		2012
1818	$self->DESTROY;	2013	$self->DESTROY;
1819	%$self = ();	2014	%$self = ();
		2015	bless $self, "AnyEvent::Handle::destroyed";
		2016	}
		2017
		2018	sub AnyEvent::Handle::destroyed::AUTOLOAD {
		2019	#nop
1820	}	2020	}
1821		2021
1822	=item AnyEvent::Handle::TLS_CTX	2022	=item AnyEvent::Handle::TLS_CTX
1823		2023
1824	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.160 by root, Fri Jul 24 22:47:04 2009 UTC vs. Revision 1.186 by root, Mon Sep 7 19:54:57 2009 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.160 by root, Fri Jul 24 22:47:04 2009 UTC vs.
Revision 1.186 by root, Mon Sep 7 19:54:57 2009 UTC