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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.45 by root, Thu May 29 00:20:39 2008 UTC vs.
Revision 1.67 by root, Fri Jun 6 15:33:10 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
…		…
155	isn't finished).	159	isn't finished).
156		160
157	=item read_size => <bytes>	161	=item read_size => <bytes>
158		162
159	The default read block size (the amount of bytes this module will try to read	163	The default read block size (the amount of bytes this module will try to read
160	on each [loop iteration). Default: C<4096>.	164	during each (loop iteration). Default: C<8192>.
161		165
162	=item low_water_mark => <bytes>	166	=item low_water_mark => <bytes>
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.
		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.
167		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
…		…
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};
236		249
237	$self	250	$self
238	}	251	}
239		252
240	sub _shutdown {	253	sub _shutdown {
241	my ($self) = @_;	254	my ($self) = @_;
242		255
		256	delete $self->{_tw};
243	delete $self->{_rw};	257	delete $self->{_rw};
244	delete $self->{_ww};	258	delete $self->{_ww};
245	delete $self->{fh};	259	delete $self->{fh};
246	}
247		260
		261	$self->stoptls;
		262	}
		263
248	sub error {	264	sub _error {
249	my ($self) = @_;	265	my ($self, $errno, $fatal) = @_;
250		266
251	{
252	local $!;
253	$self->_shutdown;	267	$self->_shutdown
254	}	268	if $fatal;
255		269
256	$self->{on_error}($self)	270	$! = $errno;
		271
257	if $self->{on_error};	272	if ($self->{on_error}) {
258		273	$self->{on_error}($self, $fatal);
		274	} else {
259	Carp::croak "AnyEvent::Handle uncaught fatal error: $!";	275	Carp::croak "AnyEvent::Handle uncaught error: $!";
		276	}
260	}	277	}
261		278
262	=item $fh = $handle->fh	279	=item $fh = $handle->fh
263		280
264	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.
…		…
328	# now or in the past already?	345	# now or in the past already?
329	if ($after <= 0) {	346	if ($after <= 0) {
330	$self->{_activity} = $NOW;	347	$self->{_activity} = $NOW;
331		348
332	if ($self->{on_timeout}) {	349	if ($self->{on_timeout}) {
333	$self->{on_timeout}->($self);	350	$self->{on_timeout}($self);
334	} else {	351	} else {
335	$! = Errno::ETIMEDOUT;	352	$self->_error (&Errno::ETIMEDOUT);
336	$self->error;
337	}	353	}
338		354
339	# callbakx could have changed timeout value, optimise	355	# callback could have changed timeout value, optimise
340	return unless $self->{timeout};	356	return unless $self->{timeout};
341		357
342	# calculate new after	358	# calculate new after
343	$after = $self->{timeout};	359	$after = $self->{timeout};
344	}	360	}
345		361
346	Scalar::Util::weaken $self;	362	Scalar::Util::weaken $self;
		363	return unless $self; # ->error could have destroyed $self
347		364
348	$self->{_tw} \|\|= AnyEvent->timer (after => $after, cb => sub {	365	$self->{_tw} \|\|= AnyEvent->timer (after => $after, cb => sub {
349	delete $self->{_tw};	366	delete $self->{_tw};
350	$self->_timeout;	367	$self->_timeout;
351	});	368	});
…		…
414	if $self->{low_water_mark} >= length $self->{wbuf}	431	if $self->{low_water_mark} >= length $self->{wbuf}
415	&& $self->{on_drain};	432	&& $self->{on_drain};
416		433
417	delete $self->{_ww} unless length $self->{wbuf};	434	delete $self->{_ww} unless length $self->{wbuf};
418	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	435	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
419	$self->error;	436	$self->_error ($!, 1);
420	}	437	}
421	};	438	};
422		439
423	# try to write data immediately	440	# try to write data immediately
424	$cb->();	441	$cb->();
…		…
444	@_ = ($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")
445	->($self, @_);	462	->($self, @_);
446	}	463	}
447		464
448	if ($self->{filter_w}) {	465	if ($self->{filter_w}) {
449	$self->{filter_w}->($self, \$_[0]);	466	$self->{filter_w}($self, \$_[0]);
450	} else {	467	} else {
451	$self->{wbuf} .= $_[0];	468	$self->{wbuf} .= $_[0];
452	$self->_drain_wbuf;	469	$self->_drain_wbuf;
453	}	470	}
454	}	471	}
455		472
456	=item $handle->push_write (type => @args)	473	=item $handle->push_write (type => @args)
457		474
458	=item $handle->unshift_write (type => @args)
459
460	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
461	the job by specifying a type and type-specific arguments.	476	the job by specifying a type and type-specific arguments.
462		477
463	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
464	drop by and tell us):	479	drop by and tell us):
…		…
468	=item netstring => $string	483	=item netstring => $string
469		484
470	Formats the given value as netstring	485	Formats the given value as netstring
471	(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).
472		487
473	=back
474
475	=cut	488	=cut
476		489
477	register_write_type netstring => sub {	490	register_write_type netstring => sub {
478	my ($self, $string) = @_;	491	my ($self, $string) = @_;
479		492
480	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
481	};	509	};
482		510
483	=item json => $array_or_hashref	511	=item json => $array_or_hashref
484		512
485	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
…		…
519		547
520	$self->{json} ? $self->{json}->encode ($ref)	548	$self->{json} ? $self->{json}->encode ($ref)
521	: JSON::encode_json ($ref)	549	: JSON::encode_json ($ref)
522	};	550	};
523		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
524	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	569	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
525		570
526	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>.
527	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
528	reference with the handle object and the remaining arguments.	573	reference with the handle object and the remaining arguments.
…		…
553	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
554	or not.	599	or not.
555		600
556	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
557	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
558	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
559	below).	604	done its job (see C<push_read>, below).
560		605
561	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
562	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.
563		608
564	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
565	the specified number of bytes which give an XML datagram.	610	the specified number of bytes which give an XML datagram.
566		611
567	# in the default state, expect some header bytes	612	# in the default state, expect some header bytes
568	$handle->on_read (sub {	613	$handle->on_read (sub {
569	# 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)
570	shift->unshift_read_chunk (4, sub {	615	shift->unshift_read (chunk => 4, sub {
571	# header arrived, decode	616	# header arrived, decode
572	my $len = unpack "N", $_[1];	617	my $len = unpack "N", $_[1];
573		618
574	# now read the payload	619	# now read the payload
575	shift->unshift_read_chunk ($len, sub {	620	shift->unshift_read (chunk => $len, sub {
576	my $xml = $_[1];	621	my $xml = $_[1];
577	# handle xml	622	# handle xml
578	});	623	});
579	});	624	});
580	});	625	});
…		…
587		632
588	# request one	633	# request one
589	$handle->push_write ("request 1\015\012");	634	$handle->push_write ("request 1\015\012");
590		635
591	# 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
592	$handle->push_read_line (sub {	637	$handle->push_read (line => sub {
593	# if we got an "OK", we have to _prepend_ another line,	638	# if we got an "OK", we have to _prepend_ another line,
594	# 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
595	# which are already in the queue when this callback is called	640	# which are already in the queue when this callback is called
596	# we don't do this in case we got an error	641	# we don't do this in case we got an error
597	if ($_[1] eq "OK") {	642	if ($_[1] eq "OK") {
598	$_[0]->unshift_read_line (sub {	643	$_[0]->unshift_read (line => sub {
599	my $response = $_[1];	644	my $response = $_[1];
600	...	645	...
601	});	646	});
602	}	647	}
603	});	648	});
604		649
605	# request two	650	# request two
606	$handle->push_write ("request 2\015\012");	651	$handle->push_write ("request 2\015\012");
607		652
608	# simply read 64 bytes, always	653	# simply read 64 bytes, always
609	$handle->push_read_chunk (64, sub {	654	$handle->push_read (chunk => 64, sub {
610	my $response = $_[1];	655	my $response = $_[1];
611	...	656	...
612	});	657	});
613		658
614	=over 4	659	=over 4
615		660
616	=cut	661	=cut
617		662
618	sub _drain_rbuf {	663	sub _drain_rbuf {
619	my ($self) = @_;	664	my ($self) = @_;
		665
		666	local $self->{_in_drain} = 1;
620		667
621	if (	668	if (
622	defined $self->{rbuf_max}	669	defined $self->{rbuf_max}
623	&& $self->{rbuf_max} < length $self->{rbuf}	670	&& $self->{rbuf_max} < length $self->{rbuf}
624	) {	671	) {
625	$! = &Errno::ENOSPC;	672	return $self->_error (&Errno::ENOSPC, 1);
626	$self->error;
627	}	673	}
628		674
629	return if $self->{in_drain};	675	while () {
630	local $self->{in_drain} = 1;
631
632	while (my $len = length $self->{rbuf}) {
633	no strict 'refs';	676	no strict 'refs';
		677
		678	my $len = length $self->{rbuf};
		679
634	if (my $cb = shift @{ $self->{_queue} }) {	680	if (my $cb = shift @{ $self->{_queue} }) {
635	unless ($cb->($self)) {	681	unless ($cb->($self)) {
636	if ($self->{_eof}) {	682	if ($self->{_eof}) {
637	# 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)
638	$! = &Errno::EPIPE;	684	$self->_error (&Errno::EPIPE, 1), last;
639	$self->error;
640	}	685	}
641		686
642	unshift @{ $self->{_queue} }, $cb;	687	unshift @{ $self->{_queue} }, $cb;
643	return;	688	last;
644	}	689	}
645	} elsif ($self->{on_read}) {	690	} elsif ($self->{on_read}) {
		691	last unless $len;
		692
646	$self->{on_read}($self);	693	$self->{on_read}($self);
647		694
648	if (	695	if (
649	$self->{_eof} # if no further data will arrive
650	&& $len == length $self->{rbuf} # and no data has been consumed	696	$len == length $self->{rbuf} # if no data has been consumed
651	&& !@{ $self->{_queue} } # and the queue is still empty	697	&& !@{ $self->{_queue} } # and the queue is still empty
652	&& $self->{on_read} # and we still want to read data	698	&& $self->{on_read} # but we still have on_read
653	) {	699	) {
		700	# no further data will arrive
654	# then no progress can be made	701	# so no progress can be made
655	$! = &Errno::EPIPE;	702	$self->_error (&Errno::EPIPE, 1), last
656	$self->error;	703	if $self->{_eof};
		704
		705	last; # more data might arrive
657	}	706	}
658	} else {	707	} else {
659	# read side becomes idle	708	# read side becomes idle
660	delete $self->{_rw};	709	delete $self->{_rw};
661	return;	710	last;
662	}	711	}
663	}	712	}
664		713
665	if ($self->{_eof}) {
666	$self->_shutdown;
667	$self->{on_eof}($self)	714	$self->{on_eof}($self)
668	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} };
669	}	721	}
670	}	722	}
671		723
672	=item $handle->on_read ($cb)	724	=item $handle->on_read ($cb)
673		725
…		…
679		731
680	sub on_read {	732	sub on_read {
681	my ($self, $cb) = @_;	733	my ($self, $cb) = @_;
682		734
683	$self->{on_read} = $cb;	735	$self->{on_read} = $cb;
		736	$self->_drain_rbuf if $cb && !$self->{_in_drain};
684	}	737	}
685		738
686	=item $handle->rbuf	739	=item $handle->rbuf
687		740
688	Returns the read buffer (as a modifiable lvalue).	741	Returns the read buffer (as a modifiable lvalue).
…		…
737	$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")
738	->($self, $cb, @_);	791	->($self, $cb, @_);
739	}	792	}
740		793
741	push @{ $self->{_queue} }, $cb;	794	push @{ $self->{_queue} }, $cb;
742	$self->_drain_rbuf;	795	$self->_drain_rbuf unless $self->{_in_drain};
743	}	796	}
744		797
745	sub unshift_read {	798	sub unshift_read {
746	my $self = shift;	799	my $self = shift;
747	my $cb = pop;	800	my $cb = pop;
…		…
753	->($self, $cb, @_);	806	->($self, $cb, @_);
754	}	807	}
755		808
756		809
757	unshift @{ $self->{_queue} }, $cb;	810	unshift @{ $self->{_queue} }, $cb;
758	$self->_drain_rbuf;	811	$self->_drain_rbuf unless $self->{_in_drain};
759	}	812	}
760		813
761	=item $handle->push_read (type => @args, $cb)	814	=item $handle->push_read (type => @args, $cb)
762		815
763	=item $handle->unshift_read (type => @args, $cb)	816	=item $handle->unshift_read (type => @args, $cb)
…		…
848		901
849	sub unshift_read_line {	902	sub unshift_read_line {
850	my $self = shift;	903	my $self = shift;
851	$self->unshift_read (line => @_);	904	$self->unshift_read (line => @_);
852	}	905	}
853
854	=item netstring => $cb->($handle, $string)
855
856	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
857
858	Throws an error with C<$!> set to EBADMSG on format violations.
859
860	=cut
861
862	register_read_type netstring => sub {
863	my ($self, $cb) = @_;
864
865	sub {
866	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
867	if ($_[0]{rbuf} =~ /[^0-9]/) {
868	$! = &Errno::EBADMSG;
869	$self->error;
870	}
871	return;
872	}
873
874	my $len = $1;
875
876	$self->unshift_read (chunk => $len, sub {
877	my $string = $_[1];
878	$_[0]->unshift_read (chunk => 1, sub {
879	if ($_[1] eq ",") {
880	$cb->($_[0], $string);
881	} else {
882	$! = &Errno::EBADMSG;
883	$self->error;
884	}
885	});
886	});
887
888	1
889	}
890	};
891		906
892	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)	907	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
893		908
894	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
895	everything up to and including the match.	910	everything up to and including the match.
…		…
945	return 1;	960	return 1;
946	}	961	}
947		962
948	# reject	963	# reject
949	if ($reject && $$rbuf =~ $reject) {	964	if ($reject && $$rbuf =~ $reject) {
950	$! = &Errno::EBADMSG;	965	$self->_error (&Errno::EBADMSG);
951	$self->error;
952	}	966	}
953		967
954	# skip	968	# skip
955	if ($skip && $$rbuf =~ $skip) {	969	if ($skip && $$rbuf =~ $skip) {
956	$data .= substr $$rbuf, 0, $+[0], "";	970	$data .= substr $$rbuf, 0, $+[0], "";
…		…
958		972
959	()	973	()
960	}	974	}
961	};	975	};
962		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
963	=item json => $cb->($handle, $hash_or_arrayref)	1049	=item json => $cb->($handle, $hash_or_arrayref)
964		1050
965	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.
966		1052
967	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
…		…
977	the C<json> write type description, above, for an actual example.	1063	the C<json> write type description, above, for an actual example.
978		1064
979	=cut	1065	=cut
980		1066
981	register_read_type json => sub {	1067	register_read_type json => sub {
982	my ($self, $cb, $accept, $reject, $skip) = @_;	1068	my ($self, $cb) = @_;
983		1069
984	require JSON;	1070	require JSON;
985		1071
986	my $data;	1072	my $data;
987	my $rbuf = \$self->{rbuf};	1073	my $rbuf = \$self->{rbuf};
…		…
1002	()	1088	()
1003	}	1089	}
1004	}	1090	}
1005	};	1091	};
1006		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
1007	=back	1127	=back
1008		1128
1009	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)	1129	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)
1010		1130
1011	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>.
…		…
1029	=item $handle->stop_read	1149	=item $handle->stop_read
1030		1150
1031	=item $handle->start_read	1151	=item $handle->start_read
1032		1152
1033	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
1034	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
1035	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
1036	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.
1037		1162
1038	=cut	1163	=cut
1039		1164
1040	sub stop_read {	1165	sub stop_read {
1041	my ($self) = @_;	1166	my ($self) = @_;
…		…
1055		1180
1056	if ($len > 0) {	1181	if ($len > 0) {
1057	$self->{_activity} = AnyEvent->now;	1182	$self->{_activity} = AnyEvent->now;
1058		1183
1059	$self->{filter_r}	1184	$self->{filter_r}
1060	? $self->{filter_r}->($self, $rbuf)	1185	? $self->{filter_r}($self, $rbuf)
1061	: $self->_drain_rbuf;	1186	: $self->{_in_drain} \|\| $self->_drain_rbuf;
1062		1187
1063	} elsif (defined $len) {	1188	} elsif (defined $len) {
1064	delete $self->{_rw};	1189	delete $self->{_rw};
1065	delete $self->{_ww};
1066	delete $self->{_tw};
1067	$self->{_eof} = 1;	1190	$self->{_eof} = 1;
1068	$self->_drain_rbuf;	1191	$self->_drain_rbuf unless $self->{_in_drain};
1069		1192
1070	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1193	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1071	return $self->error;	1194	return $self->_error ($!, 1);
1072	}	1195	}
1073	});	1196	});
1074	}	1197	}
1075	}	1198	}
1076		1199
1077	sub _dotls {	1200	sub _dotls {
1078	my ($self) = @_;	1201	my ($self) = @_;
		1202
		1203	my $buf;
1079		1204
1080	if (length $self->{_tls_wbuf}) {	1205	if (length $self->{_tls_wbuf}) {
1081	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) {
1082	substr $self->{_tls_wbuf}, 0, $len, "";	1207	substr $self->{_tls_wbuf}, 0, $len, "";
1083	}	1208	}
1084	}	1209	}
1085		1210
1086	if (defined (my $buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1211	if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1087	$self->{wbuf} .= $buf;	1212	$self->{wbuf} .= $buf;
1088	$self->_drain_wbuf;	1213	$self->_drain_wbuf;
1089	}	1214	}
1090		1215
1091	while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) {	1216	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {
		1217	if (length $buf) {
1092	$self->{rbuf} .= $buf;	1218	$self->{rbuf} .= $buf;
1093	$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	}
1094	}	1226	}
1095		1227
1096	my $err = Net::SSLeay::get_error ($self->{tls}, -1);	1228	my $err = Net::SSLeay::get_error ($self->{tls}, -1);
1097		1229
1098	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {	1230	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
1099	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {	1231	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {
1100	$self->error;	1232	return $self->_error ($!, 1);
1101	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {	1233	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {
1102	$! = &Errno::EIO;	1234	return $self->_error (&Errno::EIO, 1);
1103	$self->error;
1104	}	1235	}
1105		1236
1106	# all others are fine for our purposes	1237	# all others are fine for our purposes
1107	}	1238	}
1108	}	1239	}
…		…
1123	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
1124	might have already started when this function returns.	1255	might have already started when this function returns.
1125		1256
1126	=cut	1257	=cut
1127		1258
1128	# TODO: maybe document...
1129	sub starttls {	1259	sub starttls {
1130	my ($self, $ssl, $ctx) = @_;	1260	my ($self, $ssl, $ctx) = @_;
1131		1261
1132	$self->stoptls;	1262	$self->stoptls;
1133		1263
…		…
1186		1316
1187	sub DESTROY {	1317	sub DESTROY {
1188	my $self = shift;	1318	my $self = shift;
1189		1319
1190	$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	}
1191	}	1343	}
1192		1344
1193	=item AnyEvent::Handle::TLS_CTX	1345	=item AnyEvent::Handle::TLS_CTX
1194		1346
1195	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.45 by root, Thu May 29 00:20:39 2008 UTC vs. Revision 1.67 by root, Fri Jun 6 15:33:10 2008 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.45 by root, Thu May 29 00:20:39 2008 UTC vs.
Revision 1.67 by root, Fri Jun 6 15:33:10 2008 UTC