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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.47 by root, Thu May 29 00:25:28 2008 UTC vs.
Revision 1.66 by root, Fri Jun 6 15:32:54 2008 UTC

…		…
14		14
15	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent	15	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent
16		16
17	=cut	17	=cut
18		18
19	our $VERSION = '0.04';	19	our $VERSION = 4.15;
20		20
21	=head1 SYNOPSIS	21	=head1 SYNOPSIS
22		22
23	use AnyEvent;	23	use AnyEvent;
24	use AnyEvent::Handle;	24	use AnyEvent::Handle;
…		…
75	NOTE: The filehandle will be set to non-blocking (using	75	NOTE: The filehandle will be set to non-blocking (using
76	AnyEvent::Util::fh_nonblocking).	76	AnyEvent::Util::fh_nonblocking).
77		77
78	=item on_eof => $cb->($handle)	78	=item on_eof => $cb->($handle)
79		79
80	Set the callback to be called on EOF.	80	Set the callback to be called when an end-of-file condition is detcted,
		81	i.e. in the case of a socket, when the other side has closed the
		82	connection cleanly.
81		83
82	While not mandatory, it is highly recommended to set an eof callback,	84	While not mandatory, it is highly recommended to set an eof callback,
83	otherwise you might end up with a closed socket while you are still	85	otherwise you might end up with a closed socket while you are still
84	waiting for data.	86	waiting for data.
85		87
86	=item on_error => $cb->($handle)	88	=item on_error => $cb->($handle, $fatal)
87		89
88	This is the fatal error callback, that is called when, well, a fatal error	90	This is the error callback, which is called when, well, some error
89	occurs, such as not being able to resolve the hostname, failure to connect	91	occured, such as not being able to resolve the hostname, failure to
90	or a read error.	92	connect or a read error.
91		93
92	The object will not be in a usable state when this callback has been	94	Some errors are fatal (which is indicated by C<$fatal> being true). On
93	called.	95	fatal errors the handle object will be shut down and will not be
		96	usable. Non-fatal errors can be retried by simply returning, but it is
		97	recommended to simply ignore this parameter and instead abondon the handle
		98	object when this callback is invoked.
94		99
95	On callback entrance, the value of C<$!> contains the operating system	100	On callback entrance, the value of C<$!> contains the operating system
96	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).	101	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).
97		102
98	The callback should throw an exception. If it returns, then
99	AnyEvent::Handle will C<croak> for you.
100
101	While not mandatory, it is I<highly> recommended to set this callback, as	103	While not mandatory, it is I<highly> recommended to set this callback, as
102	you will not be notified of errors otherwise. The default simply calls	104	you will not be notified of errors otherwise. The default simply calls
103	die.	105	C<croak>.
104		106
105	=item on_read => $cb->($handle)	107	=item on_read => $cb->($handle)
106		108
107	This sets the default read callback, which is called when data arrives	109	This sets the default read callback, which is called when data arrives
108	and no read request is in the queue.	110	and no read request is in the queue (unlike read queue callbacks, this
		111	callback will only be called when at least one octet of data is in the
		112	read buffer).
109		113
110	To access (and remove data from) the read buffer, use the C<< ->rbuf >>	114	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
111	method or access the C<$handle->{rbuf}> member directly.	115	method or access the C<$handle->{rbuf}> member directly.
112		116
113	When an EOF condition is detected then AnyEvent::Handle will first try to	117	When an EOF condition is detected then AnyEvent::Handle will first try to
…		…
163		167
164	Sets the amount of bytes (default: C<0>) that make up an "empty" write	168	Sets the amount of bytes (default: C<0>) that make up an "empty" write
165	buffer: If the write reaches this size or gets even samller it is	169	buffer: If the write reaches this size or gets even samller it is
166	considered empty.	170	considered empty.
167		171
		172	=item linger => <seconds>
		173
		174	If non-zero (default: C<3600>), then the destructor of the
		175	AnyEvent::Handle object will check wether there is still outstanding write
		176	data and will install a watcher that will write out this data. No errors
		177	will be reported (this mostly matches how the operating system treats
		178	outstanding data at socket close time).
		179
		180	This will not work for partial TLS data that could not yet been
		181	encoded. This data will be lost.
		182
168	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	183	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
169		184
170	When this parameter is given, it enables TLS (SSL) mode, that means it	185	When this parameter is given, it enables TLS (SSL) mode, that means it
171	will start making tls handshake and will transparently encrypt/decrypt	186	will start making tls handshake and will transparently encrypt/decrypt
172	data.	187	data.
…		…
222	if ($self->{tls}) {	237	if ($self->{tls}) {
223	require Net::SSLeay;	238	require Net::SSLeay;
224	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});	239	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});
225	}	240	}
226		241
227	# $self->on_eof (delete $self->{on_eof} ) if $self->{on_eof}; # nop
228	# $self->on_error (delete $self->{on_error}) if $self->{on_error}; # nop
229	# $self->on_read (delete $self->{on_read} ) if $self->{on_read}; # nop
230	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
231
232	$self->{_activity} = AnyEvent->now;	242	$self->{_activity} = AnyEvent->now;
233	$self->_timeout;	243	$self->_timeout;
234		244
		245	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
		246
235	$self->start_read;	247	$self->start_read
		248	if $self->{on_read} \|\| @{ $self->{_queue} };
236		249
237	$self	250	$self
238	}	251	}
239		252
240	sub _shutdown {	253	sub _shutdown {
…		…
242		255
243	delete $self->{_tw};	256	delete $self->{_tw};
244	delete $self->{_rw};	257	delete $self->{_rw};
245	delete $self->{_ww};	258	delete $self->{_ww};
246	delete $self->{fh};	259	delete $self->{fh};
247	}
248		260
		261	$self->stoptls;
		262	}
		263
249	sub error {	264	sub _error {
250	my ($self) = @_;	265	my ($self, $errno, $fatal) = @_;
251		266
252	{
253	local $!;
254	$self->_shutdown;	267	$self->_shutdown
255	}	268	if $fatal;
256		269
257	$self->{on_error}($self)	270	$! = $errno;
		271
258	if $self->{on_error};	272	if ($self->{on_error}) {
259		273	$self->{on_error}($self, $fatal);
		274	} else {
260	Carp::croak "AnyEvent::Handle uncaught fatal error: $!";	275	Carp::croak "AnyEvent::Handle uncaught error: $!";
		276	}
261	}	277	}
262		278
263	=item $fh = $handle->fh	279	=item $fh = $handle->fh
264		280
265	This method returns the file handle of the L<AnyEvent::Handle> object.	281	This method returns the file handle of the L<AnyEvent::Handle> object.
…		…
329	# now or in the past already?	345	# now or in the past already?
330	if ($after <= 0) {	346	if ($after <= 0) {
331	$self->{_activity} = $NOW;	347	$self->{_activity} = $NOW;
332		348
333	if ($self->{on_timeout}) {	349	if ($self->{on_timeout}) {
334	$self->{on_timeout}->($self);	350	$self->{on_timeout}($self);
335	} else {	351	} else {
336	$! = Errno::ETIMEDOUT;	352	$self->_error (&Errno::ETIMEDOUT);
337	$self->error;
338	}	353	}
339		354
340	# callbakx could have changed timeout value, optimise	355	# callback could have changed timeout value, optimise
341	return unless $self->{timeout};	356	return unless $self->{timeout};
342		357
343	# calculate new after	358	# calculate new after
344	$after = $self->{timeout};	359	$after = $self->{timeout};
345	}	360	}
346		361
347	Scalar::Util::weaken $self;	362	Scalar::Util::weaken $self;
		363	return unless $self; # ->error could have destroyed $self
348		364
349	$self->{_tw} \|\|= AnyEvent->timer (after => $after, cb => sub {	365	$self->{_tw} \|\|= AnyEvent->timer (after => $after, cb => sub {
350	delete $self->{_tw};	366	delete $self->{_tw};
351	$self->_timeout;	367	$self->_timeout;
352	});	368	});
…		…
415	if $self->{low_water_mark} >= length $self->{wbuf}	431	if $self->{low_water_mark} >= length $self->{wbuf}
416	&& $self->{on_drain};	432	&& $self->{on_drain};
417		433
418	delete $self->{_ww} unless length $self->{wbuf};	434	delete $self->{_ww} unless length $self->{wbuf};
419	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	435	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
420	$self->error;	436	$self->_error ($!, 1);
421	}	437	}
422	};	438	};
423		439
424	# try to write data immediately	440	# try to write data immediately
425	$cb->();	441	$cb->();
…		…
445	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	461	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")
446	->($self, @_);	462	->($self, @_);
447	}	463	}
448		464
449	if ($self->{filter_w}) {	465	if ($self->{filter_w}) {
450	$self->{filter_w}->($self, \$_[0]);	466	$self->{filter_w}($self, \$_[0]);
451	} else {	467	} else {
452	$self->{wbuf} .= $_[0];	468	$self->{wbuf} .= $_[0];
453	$self->_drain_wbuf;	469	$self->_drain_wbuf;
454	}	470	}
455	}	471	}
456		472
457	=item $handle->push_write (type => @args)	473	=item $handle->push_write (type => @args)
458		474
459	=item $handle->unshift_write (type => @args)
460
461	Instead of formatting your data yourself, you can also let this module do	475	Instead of formatting your data yourself, you can also let this module do
462	the job by specifying a type and type-specific arguments.	476	the job by specifying a type and type-specific arguments.
463		477
464	Predefined types are (if you have ideas for additional types, feel free to	478	Predefined types are (if you have ideas for additional types, feel free to
465	drop by and tell us):	479	drop by and tell us):
…		…
469	=item netstring => $string	483	=item netstring => $string
470		484
471	Formats the given value as netstring	485	Formats the given value as netstring
472	(http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them).	486	(http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them).
473		487
474	=back
475
476	=cut	488	=cut
477		489
478	register_write_type netstring => sub {	490	register_write_type netstring => sub {
479	my ($self, $string) = @_;	491	my ($self, $string) = @_;
480		492
481	sprintf "%d:%s,", (length $string), $string	493	sprintf "%d:%s,", (length $string), $string
		494	};
		495
		496	=item packstring => $format, $data
		497
		498	An octet string prefixed with an encoded length. The encoding C<$format>
		499	uses the same format as a Perl C<pack> format, but must specify a single
		500	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
		501	optional C<!>, C<< < >> or C<< > >> modifier).
		502
		503	=cut
		504
		505	register_write_type packstring => sub {
		506	my ($self, $format, $string) = @_;
		507
		508	pack "$format/a*", $string
482	};	509	};
483		510
484	=item json => $array_or_hashref	511	=item json => $array_or_hashref
485		512
486	Encodes the given hash or array reference into a JSON object. Unless you	513	Encodes the given hash or array reference into a JSON object. Unless you
…		…
520		547
521	$self->{json} ? $self->{json}->encode ($ref)	548	$self->{json} ? $self->{json}->encode ($ref)
522	: JSON::encode_json ($ref)	549	: JSON::encode_json ($ref)
523	};	550	};
524		551
		552	=item storable => $reference
		553
		554	Freezes the given reference using L<Storable> and writes it to the
		555	handle. Uses the C<nfreeze> format.
		556
		557	=cut
		558
		559	register_write_type storable => sub {
		560	my ($self, $ref) = @_;
		561
		562	require Storable;
		563
		564	pack "w/a*", Storable::nfreeze ($ref)
		565	};
		566
		567	=back
		568
525	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	569	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
526		570
527	This function (not method) lets you add your own types to C<push_write>.	571	This function (not method) lets you add your own types to C<push_write>.
528	Whenever the given C<type> is used, C<push_write> will invoke the code	572	Whenever the given C<type> is used, C<push_write> will invoke the code
529	reference with the handle object and the remaining arguments.	573	reference with the handle object and the remaining arguments.
…		…
554	enough is there) from the read buffer (C<< $handle->rbuf >>) if you want	598	enough is there) from the read buffer (C<< $handle->rbuf >>) if you want
555	or not.	599	or not.
556		600
557	In the more complex case, you want to queue multiple callbacks. In this	601	In the more complex case, you want to queue multiple callbacks. In this
558	case, AnyEvent::Handle will call the first queued callback each time new	602	case, AnyEvent::Handle will call the first queued callback each time new
559	data arrives and removes it when it has done its job (see C<push_read>,	603	data arrives (also the first time it is queued) and removes it when it has
560	below).	604	done its job (see C<push_read>, below).
561		605
562	This way you can, for example, push three line-reads, followed by reading	606	This way you can, for example, push three line-reads, followed by reading
563	a chunk of data, and AnyEvent::Handle will execute them in order.	607	a chunk of data, and AnyEvent::Handle will execute them in order.
564		608
565	Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by	609	Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by
566	the specified number of bytes which give an XML datagram.	610	the specified number of bytes which give an XML datagram.
567		611
568	# in the default state, expect some header bytes	612	# in the default state, expect some header bytes
569	$handle->on_read (sub {	613	$handle->on_read (sub {
570	# some data is here, now queue the length-header-read (4 octets)	614	# some data is here, now queue the length-header-read (4 octets)
571	shift->unshift_read_chunk (4, sub {	615	shift->unshift_read (chunk => 4, sub {
572	# header arrived, decode	616	# header arrived, decode
573	my $len = unpack "N", $_[1];	617	my $len = unpack "N", $_[1];
574		618
575	# now read the payload	619	# now read the payload
576	shift->unshift_read_chunk ($len, sub {	620	shift->unshift_read (chunk => $len, sub {
577	my $xml = $_[1];	621	my $xml = $_[1];
578	# handle xml	622	# handle xml
579	});	623	});
580	});	624	});
581	});	625	});
…		…
588		632
589	# request one	633	# request one
590	$handle->push_write ("request 1\015\012");	634	$handle->push_write ("request 1\015\012");
591		635
592	# we expect "ERROR" or "OK" as response, so push a line read	636	# we expect "ERROR" or "OK" as response, so push a line read
593	$handle->push_read_line (sub {	637	$handle->push_read (line => sub {
594	# if we got an "OK", we have to _prepend_ another line,	638	# if we got an "OK", we have to _prepend_ another line,
595	# so it will be read before the second request reads its 64 bytes	639	# so it will be read before the second request reads its 64 bytes
596	# which are already in the queue when this callback is called	640	# which are already in the queue when this callback is called
597	# we don't do this in case we got an error	641	# we don't do this in case we got an error
598	if ($_[1] eq "OK") {	642	if ($_[1] eq "OK") {
599	$_[0]->unshift_read_line (sub {	643	$_[0]->unshift_read (line => sub {
600	my $response = $_[1];	644	my $response = $_[1];
601	...	645	...
602	});	646	});
603	}	647	}
604	});	648	});
605		649
606	# request two	650	# request two
607	$handle->push_write ("request 2\015\012");	651	$handle->push_write ("request 2\015\012");
608		652
609	# simply read 64 bytes, always	653	# simply read 64 bytes, always
610	$handle->push_read_chunk (64, sub {	654	$handle->push_read (chunk => 64, sub {
611	my $response = $_[1];	655	my $response = $_[1];
612	...	656	...
613	});	657	});
614		658
615	=over 4	659	=over 4
616		660
617	=cut	661	=cut
618		662
619	sub _drain_rbuf {	663	sub _drain_rbuf {
620	my ($self) = @_;	664	my ($self) = @_;
		665
		666	local $self->{_in_drain} = 1;
621		667
622	if (	668	if (
623	defined $self->{rbuf_max}	669	defined $self->{rbuf_max}
624	&& $self->{rbuf_max} < length $self->{rbuf}	670	&& $self->{rbuf_max} < length $self->{rbuf}
625	) {	671	) {
626	$! = &Errno::ENOSPC;	672	return $self->_error (&Errno::ENOSPC, 1);
627	$self->error;
628	}	673	}
629		674
630	return if $self->{in_drain};	675	while () {
631	local $self->{in_drain} = 1;
632
633	while (my $len = length $self->{rbuf}) {
634	no strict 'refs';	676	no strict 'refs';
		677
		678	my $len = length $self->{rbuf};
		679
635	if (my $cb = shift @{ $self->{_queue} }) {	680	if (my $cb = shift @{ $self->{_queue} }) {
636	unless ($cb->($self)) {	681	unless ($cb->($self)) {
637	if ($self->{_eof}) {	682	if ($self->{_eof}) {
638	# no progress can be made (not enough data and no data forthcoming)	683	# no progress can be made (not enough data and no data forthcoming)
639	$! = &Errno::EPIPE;	684	$self->_error (&Errno::EPIPE, 1), last;
640	$self->error;
641	}	685	}
642		686
643	unshift @{ $self->{_queue} }, $cb;	687	unshift @{ $self->{_queue} }, $cb;
644	return;	688	last;
645	}	689	}
646	} elsif ($self->{on_read}) {	690	} elsif ($self->{on_read}) {
		691	last unless $len;
		692
647	$self->{on_read}($self);	693	$self->{on_read}($self);
648		694
649	if (	695	if (
650	$self->{_eof} # if no further data will arrive
651	&& $len == length $self->{rbuf} # and no data has been consumed	696	$len == length $self->{rbuf} # if no data has been consumed
652	&& !@{ $self->{_queue} } # and the queue is still empty	697	&& !@{ $self->{_queue} } # and the queue is still empty
653	&& $self->{on_read} # and we still want to read data	698	&& $self->{on_read} # but we still have on_read
654	) {	699	) {
		700	# no further data will arrive
655	# then no progress can be made	701	# so no progress can be made
656	$! = &Errno::EPIPE;	702	$self->_error (&Errno::EPIPE, 1), last
657	$self->error;	703	if $self->{_eof};
		704
		705	last; # more data might arrive
658	}	706	}
659	} else {	707	} else {
660	# read side becomes idle	708	# read side becomes idle
661	delete $self->{_rw};	709	delete $self->{_rw};
662	return;	710	last;
663	}	711	}
664	}	712	}
665		713
666	if ($self->{_eof}) {
667	$self->_shutdown;
668	$self->{on_eof}($self)	714	$self->{on_eof}($self)
669	if $self->{on_eof};	715	if $self->{_eof} && $self->{on_eof};
		716
		717	# may need to restart read watcher
		718	unless ($self->{_rw}) {
		719	$self->start_read
		720	if $self->{on_read} \|\| @{ $self->{_queue} };
670	}	721	}
671	}	722	}
672		723
673	=item $handle->on_read ($cb)	724	=item $handle->on_read ($cb)
674		725
…		…
680		731
681	sub on_read {	732	sub on_read {
682	my ($self, $cb) = @_;	733	my ($self, $cb) = @_;
683		734
684	$self->{on_read} = $cb;	735	$self->{on_read} = $cb;
		736	$self->_drain_rbuf if $cb && !$self->{_in_drain};
685	}	737	}
686		738
687	=item $handle->rbuf	739	=item $handle->rbuf
688		740
689	Returns the read buffer (as a modifiable lvalue).	741	Returns the read buffer (as a modifiable lvalue).
…		…
738	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	790	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
739	->($self, $cb, @_);	791	->($self, $cb, @_);
740	}	792	}
741		793
742	push @{ $self->{_queue} }, $cb;	794	push @{ $self->{_queue} }, $cb;
743	$self->_drain_rbuf;	795	$self->_drain_rbuf unless $self->{_in_drain};
744	}	796	}
745		797
746	sub unshift_read {	798	sub unshift_read {
747	my $self = shift;	799	my $self = shift;
748	my $cb = pop;	800	my $cb = pop;
…		…
754	->($self, $cb, @_);	806	->($self, $cb, @_);
755	}	807	}
756		808
757		809
758	unshift @{ $self->{_queue} }, $cb;	810	unshift @{ $self->{_queue} }, $cb;
759	$self->_drain_rbuf;	811	$self->_drain_rbuf unless $self->{_in_drain};
760	}	812	}
761		813
762	=item $handle->push_read (type => @args, $cb)	814	=item $handle->push_read (type => @args, $cb)
763		815
764	=item $handle->unshift_read (type => @args, $cb)	816	=item $handle->unshift_read (type => @args, $cb)
…		…
849		901
850	sub unshift_read_line {	902	sub unshift_read_line {
851	my $self = shift;	903	my $self = shift;
852	$self->unshift_read (line => @_);	904	$self->unshift_read (line => @_);
853	}	905	}
854
855	=item netstring => $cb->($handle, $string)
856
857	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
858
859	Throws an error with C<$!> set to EBADMSG on format violations.
860
861	=cut
862
863	register_read_type netstring => sub {
864	my ($self, $cb) = @_;
865
866	sub {
867	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
868	if ($_[0]{rbuf} =~ /[^0-9]/) {
869	$! = &Errno::EBADMSG;
870	$self->error;
871	}
872	return;
873	}
874
875	my $len = $1;
876
877	$self->unshift_read (chunk => $len, sub {
878	my $string = $_[1];
879	$_[0]->unshift_read (chunk => 1, sub {
880	if ($_[1] eq ",") {
881	$cb->($_[0], $string);
882	} else {
883	$! = &Errno::EBADMSG;
884	$self->error;
885	}
886	});
887	});
888
889	1
890	}
891	};
892		906
893	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)	907	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
894		908
895	Makes a regex match against the regex object C<$accept> and returns	909	Makes a regex match against the regex object C<$accept> and returns
896	everything up to and including the match.	910	everything up to and including the match.
…		…
946	return 1;	960	return 1;
947	}	961	}
948		962
949	# reject	963	# reject
950	if ($reject && $$rbuf =~ $reject) {	964	if ($reject && $$rbuf =~ $reject) {
951	$! = &Errno::EBADMSG;	965	$self->_error (&Errno::EBADMSG);
952	$self->error;
953	}	966	}
954		967
955	# skip	968	# skip
956	if ($skip && $$rbuf =~ $skip) {	969	if ($skip && $$rbuf =~ $skip) {
957	$data .= substr $$rbuf, 0, $+[0], "";	970	$data .= substr $$rbuf, 0, $+[0], "";
…		…
959		972
960	()	973	()
961	}	974	}
962	};	975	};
963		976
		977	=item netstring => $cb->($handle, $string)
		978
		979	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
		980
		981	Throws an error with C<$!> set to EBADMSG on format violations.
		982
		983	=cut
		984
		985	register_read_type netstring => sub {
		986	my ($self, $cb) = @_;
		987
		988	sub {
		989	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
		990	if ($_[0]{rbuf} =~ /[^0-9]/) {
		991	$self->_error (&Errno::EBADMSG);
		992	}
		993	return;
		994	}
		995
		996	my $len = $1;
		997
		998	$self->unshift_read (chunk => $len, sub {
		999	my $string = $_[1];
		1000	$_[0]->unshift_read (chunk => 1, sub {
		1001	if ($_[1] eq ",") {
		1002	$cb->($_[0], $string);
		1003	} else {
		1004	$self->_error (&Errno::EBADMSG);
		1005	}
		1006	});
		1007	});
		1008
		1009	1
		1010	}
		1011	};
		1012
		1013	=item packstring => $format, $cb->($handle, $string)
		1014
		1015	An octet string prefixed with an encoded length. The encoding C<$format>
		1016	uses the same format as a Perl C<pack> format, but must specify a single
		1017	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
		1018	optional C<!>, C<< < >> or C<< > >> modifier).
		1019
		1020	DNS over TCP uses a prefix of C<n>, EPP uses a prefix of C<N>.
		1021
		1022	Example: read a block of data prefixed by its length in BER-encoded
		1023	format (very efficient).
		1024
		1025	$handle->push_read (packstring => "w", sub {
		1026	my ($handle, $data) = @_;
		1027	});
		1028
		1029	=cut
		1030
		1031	register_read_type packstring => sub {
		1032	my ($self, $cb, $format) = @_;
		1033
		1034	sub {
		1035	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
		1036	defined (my $len = eval { unpack $format, $_[0]->{rbuf} })
		1037	or return;
		1038
		1039	# remove prefix
		1040	substr $_[0]->{rbuf}, 0, (length pack $format, $len), "";
		1041
		1042	# read rest
		1043	$_[0]->unshift_read (chunk => $len, $cb);
		1044
		1045	1
		1046	}
		1047	};
		1048
964	=item json => $cb->($handle, $hash_or_arrayref)	1049	=item json => $cb->($handle, $hash_or_arrayref)
965		1050
966	Reads a JSON object or array, decodes it and passes it to the callback.	1051	Reads a JSON object or array, decodes it and passes it to the callback.
967		1052
968	If a C<json> object was passed to the constructor, then that will be used	1053	If a C<json> object was passed to the constructor, then that will be used
…		…
978	the C<json> write type description, above, for an actual example.	1063	the C<json> write type description, above, for an actual example.
979		1064
980	=cut	1065	=cut
981		1066
982	register_read_type json => sub {	1067	register_read_type json => sub {
983	my ($self, $cb, $accept, $reject, $skip) = @_;	1068	my ($self, $cb) = @_;
984		1069
985	require JSON;	1070	require JSON;
986		1071
987	my $data;	1072	my $data;
988	my $rbuf = \$self->{rbuf};	1073	my $rbuf = \$self->{rbuf};
…		…
1003	()	1088	()
1004	}	1089	}
1005	}	1090	}
1006	};	1091	};
1007		1092
		1093	=item storable => $cb->($handle, $ref)
		1094
		1095	Deserialises a L<Storable> frozen representation as written by the
		1096	C<storable> write type (BER-encoded length prefix followed by nfreeze'd
		1097	data).
		1098
		1099	Raises C<EBADMSG> error if the data could not be decoded.
		1100
		1101	=cut
		1102
		1103	register_read_type storable => sub {
		1104	my ($self, $cb) = @_;
		1105
		1106	require Storable;
		1107
		1108	sub {
		1109	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
		1110	defined (my $len = eval { unpack "w", $_[0]->{rbuf} })
		1111	or return;
		1112
		1113	# remove prefix
		1114	substr $_[0]->{rbuf}, 0, (length pack "w", $len), "";
		1115
		1116	# read rest
		1117	$_[0]->unshift_read (chunk => $len, sub {
		1118	if (my $ref = eval { Storable::thaw ($_[1]) }) {
		1119	$cb->($_[0], $ref);
		1120	} else {
		1121	$self->_error (&Errno::EBADMSG);
		1122	}
		1123	});
		1124	}
		1125	};
		1126
1008	=back	1127	=back
1009		1128
1010	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)	1129	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)
1011		1130
1012	This function (not method) lets you add your own types to C<push_read>.	1131	This function (not method) lets you add your own types to C<push_read>.
…		…
1030	=item $handle->stop_read	1149	=item $handle->stop_read
1031		1150
1032	=item $handle->start_read	1151	=item $handle->start_read
1033		1152
1034	In rare cases you actually do not want to read anything from the	1153	In rare cases you actually do not want to read anything from the
1035	socket. In this case you can call C<stop_read>. Neither C<on_read> no	1154	socket. In this case you can call C<stop_read>. Neither C<on_read> nor
1036	any queued callbacks will be executed then. To start reading again, call	1155	any queued callbacks will be executed then. To start reading again, call
1037	C<start_read>.	1156	C<start_read>.
		1157
		1158	Note that AnyEvent::Handle will automatically C<start_read> for you when
		1159	you change the C<on_read> callback or push/unshift a read callback, and it
		1160	will automatically C<stop_read> for you when neither C<on_read> is set nor
		1161	there are any read requests in the queue.
1038		1162
1039	=cut	1163	=cut
1040		1164
1041	sub stop_read {	1165	sub stop_read {
1042	my ($self) = @_;	1166	my ($self) = @_;
…		…
1056		1180
1057	if ($len > 0) {	1181	if ($len > 0) {
1058	$self->{_activity} = AnyEvent->now;	1182	$self->{_activity} = AnyEvent->now;
1059		1183
1060	$self->{filter_r}	1184	$self->{filter_r}
1061	? $self->{filter_r}->($self, $rbuf)	1185	? $self->{filter_r}($self, $rbuf)
1062	: $self->_drain_rbuf;	1186	: $self->{_in_drain} \|\| $self->_drain_rbuf;
1063		1187
1064	} elsif (defined $len) {	1188	} elsif (defined $len) {
1065	delete $self->{_rw};	1189	delete $self->{_rw};
1066	$self->{_eof} = 1;	1190	$self->{_eof} = 1;
1067	$self->_drain_rbuf;	1191	$self->_drain_rbuf unless $self->{_in_drain};
1068		1192
1069	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1193	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1070	return $self->error;	1194	return $self->_error ($!, 1);
1071	}	1195	}
1072	});	1196	});
1073	}	1197	}
1074	}	1198	}
1075		1199
1076	sub _dotls {	1200	sub _dotls {
1077	my ($self) = @_;	1201	my ($self) = @_;
		1202
		1203	my $buf;
1078		1204
1079	if (length $self->{_tls_wbuf}) {	1205	if (length $self->{_tls_wbuf}) {
1080	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1206	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1081	substr $self->{_tls_wbuf}, 0, $len, "";	1207	substr $self->{_tls_wbuf}, 0, $len, "";
1082	}	1208	}
1083	}	1209	}
1084		1210
1085	if (defined (my $buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1211	if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1086	$self->{wbuf} .= $buf;	1212	$self->{wbuf} .= $buf;
1087	$self->_drain_wbuf;	1213	$self->_drain_wbuf;
1088	}	1214	}
1089		1215
1090	while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) {	1216	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {
		1217	if (length $buf) {
1091	$self->{rbuf} .= $buf;	1218	$self->{rbuf} .= $buf;
1092	$self->_drain_rbuf;	1219	$self->_drain_rbuf unless $self->{_in_drain};
		1220	} else {
		1221	# let's treat SSL-eof as we treat normal EOF
		1222	$self->{_eof} = 1;
		1223	$self->_shutdown;
		1224	return;
		1225	}
1093	}	1226	}
1094		1227
1095	my $err = Net::SSLeay::get_error ($self->{tls}, -1);	1228	my $err = Net::SSLeay::get_error ($self->{tls}, -1);
1096		1229
1097	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {	1230	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
1098	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {	1231	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {
1099	$self->error;	1232	return $self->_error ($!, 1);
1100	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {	1233	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {
1101	$! = &Errno::EIO;	1234	return $self->_error (&Errno::EIO, 1);
1102	$self->error;
1103	}	1235	}
1104		1236
1105	# all others are fine for our purposes	1237	# all others are fine for our purposes
1106	}	1238	}
1107	}	1239	}
…		…
1122	call and can be used or changed to your liking. Note that the handshake	1254	call and can be used or changed to your liking. Note that the handshake
1123	might have already started when this function returns.	1255	might have already started when this function returns.
1124		1256
1125	=cut	1257	=cut
1126		1258
1127	# TODO: maybe document...
1128	sub starttls {	1259	sub starttls {
1129	my ($self, $ssl, $ctx) = @_;	1260	my ($self, $ssl, $ctx) = @_;
1130		1261
1131	$self->stoptls;	1262	$self->stoptls;
1132		1263
…		…
1185		1316
1186	sub DESTROY {	1317	sub DESTROY {
1187	my $self = shift;	1318	my $self = shift;
1188		1319
1189	$self->stoptls;	1320	$self->stoptls;
		1321
		1322	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
		1323
		1324	if ($linger && length $self->{wbuf}) {
		1325	my $fh = delete $self->{fh};
		1326	my $wbuf = delete $self->{wbuf};
		1327
		1328	my @linger;
		1329
		1330	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {
		1331	my $len = syswrite $fh, $wbuf, length $wbuf;
		1332
		1333	if ($len > 0) {
		1334	substr $wbuf, 0, $len, "";
		1335	} else {
		1336	@linger = (); # end
		1337	}
		1338	});
		1339	push @linger, AnyEvent->timer (after => $linger, cb => sub {
		1340	@linger = ();
		1341	});
		1342	}
1190	}	1343	}
1191		1344
1192	=item AnyEvent::Handle::TLS_CTX	1345	=item AnyEvent::Handle::TLS_CTX
1193		1346
1194	This function creates and returns the Net::SSLeay::CTX object used by	1347	This function creates and returns the Net::SSLeay::CTX object used by

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.47 by root, Thu May 29 00:25:28 2008 UTC vs. Revision 1.66 by root, Fri Jun 6 15:32:54 2008 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.47 by root, Thu May 29 00:25:28 2008 UTC vs.
Revision 1.66 by root, Fri Jun 6 15:32:54 2008 UTC