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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.44 by root, Thu May 29 00:00:07 2008 UTC vs.
Revision 1.69 by root, Sun Jun 15 21:44:56 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.151;
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
…		…
120	This sets the callback that is called when the write buffer becomes empty	124	This sets the callback that is called when the write buffer becomes empty
121	(or when the callback is set and the buffer is empty already).	125	(or when the callback is set and the buffer is empty already).
122		126
123	To append to the write buffer, use the C<< ->push_write >> method.	127	To append to the write buffer, use the C<< ->push_write >> method.
124		128
		129	This callback is useful when you don't want to put all of your write data
		130	into the queue at once, for example, when you want to write the contents
		131	of some file to the socket you might not want to read the whole file into
		132	memory and push it into the queue, but instead only read more data from
		133	the file when the write queue becomes empty.
		134
125	=item timeout => $fractional_seconds	135	=item timeout => $fractional_seconds
126		136
127	If non-zero, then this enables an "inactivity" timeout: whenever this many	137	If non-zero, then this enables an "inactivity" timeout: whenever this many
128	seconds pass without a successful read or write on the underlying file	138	seconds pass without a successful read or write on the underlying file
129	handle, the C<on_timeout> callback will be invoked (and if that one is	139	handle, the C<on_timeout> callback will be invoked (and if that one is
130	missing, an C<ETIMEDOUT> errror will be raised).	140	missing, an C<ETIMEDOUT> error will be raised).
131		141
132	Note that timeout processing is also active when you currently do not have	142	Note that timeout processing is also active when you currently do not have
133	any outstanding read or write requests: If you plan to keep the connection	143	any outstanding read or write requests: If you plan to keep the connection
134	idle then you should disable the timout temporarily or ignore the timeout	144	idle then you should disable the timout temporarily or ignore the timeout
135	in the C<on_timeout> callback.	145	in the C<on_timeout> callback.
…		…
155	isn't finished).	165	isn't finished).
156		166
157	=item read_size => <bytes>	167	=item read_size => <bytes>
158		168
159	The default read block size (the amount of bytes this module will try to read	169	The default read block size (the amount of bytes this module will try to read
160	on each [loop iteration). Default: C<4096>.	170	during each (loop iteration). Default: C<8192>.
161		171
162	=item low_water_mark => <bytes>	172	=item low_water_mark => <bytes>
163		173
164	Sets the amount of bytes (default: C<0>) that make up an "empty" write	174	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	175	buffer: If the write reaches this size or gets even samller it is
166	considered empty.	176	considered empty.
		177
		178	=item linger => <seconds>
		179
		180	If non-zero (default: C<3600>), then the destructor of the
		181	AnyEvent::Handle object will check wether there is still outstanding write
		182	data and will install a watcher that will write out this data. No errors
		183	will be reported (this mostly matches how the operating system treats
		184	outstanding data at socket close time).
		185
		186	This will not work for partial TLS data that could not yet been
		187	encoded. This data will be lost.
167		188
168	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	189	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
169		190
170	When this parameter is given, it enables TLS (SSL) mode, that means it	191	When this parameter is given, it enables TLS (SSL) mode, that means it
171	will start making tls handshake and will transparently encrypt/decrypt	192	will start making tls handshake and will transparently encrypt/decrypt
…		…
222	if ($self->{tls}) {	243	if ($self->{tls}) {
223	require Net::SSLeay;	244	require Net::SSLeay;
224	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});	245	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});
225	}	246	}
226		247
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;	248	$self->{_activity} = AnyEvent->now;
233	$self->_timeout;	249	$self->_timeout;
234		250
		251	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
		252
235	$self->start_read;	253	$self->start_read
		254	if $self->{on_read};
236		255
237	$self	256	$self
238	}	257	}
239		258
240	sub _shutdown {	259	sub _shutdown {
241	my ($self) = @_;	260	my ($self) = @_;
242		261
		262	delete $self->{_tw};
243	delete $self->{_rw};	263	delete $self->{_rw};
244	delete $self->{_ww};	264	delete $self->{_ww};
245	delete $self->{fh};	265	delete $self->{fh};
246	}
247		266
		267	$self->stoptls;
		268	}
		269
248	sub error {	270	sub _error {
249	my ($self) = @_;	271	my ($self, $errno, $fatal) = @_;
250		272
251	{
252	local $!;
253	$self->_shutdown;	273	$self->_shutdown
254	}	274	if $fatal;
255		275
256	$self->{on_error}($self)	276	$! = $errno;
		277
257	if $self->{on_error};	278	if ($self->{on_error}) {
258		279	$self->{on_error}($self, $fatal);
		280	} else {
259	Carp::croak "AnyEvent::Handle uncaught fatal error: $!";	281	Carp::croak "AnyEvent::Handle uncaught error: $!";
		282	}
260	}	283	}
261		284
262	=item $fh = $handle->fh	285	=item $fh = $handle->fh
263		286
264	This method returns the file handle of the L<AnyEvent::Handle> object.	287	This method returns the file handle of the L<AnyEvent::Handle> object.
…		…
328	# now or in the past already?	351	# now or in the past already?
329	if ($after <= 0) {	352	if ($after <= 0) {
330	$self->{_activity} = $NOW;	353	$self->{_activity} = $NOW;
331		354
332	if ($self->{on_timeout}) {	355	if ($self->{on_timeout}) {
333	$self->{on_timeout}->($self);	356	$self->{on_timeout}($self);
334	} else {	357	} else {
335	$! = Errno::ETIMEDOUT;	358	$self->_error (&Errno::ETIMEDOUT);
336	$self->error;
337	}	359	}
338		360
339	# callbakx could have changed timeout value, optimise	361	# callback could have changed timeout value, optimise
340	return unless $self->{timeout};	362	return unless $self->{timeout};
341		363
342	# calculate new after	364	# calculate new after
343	$after = $self->{timeout};	365	$after = $self->{timeout};
344	}	366	}
345		367
346	Scalar::Util::weaken $self;	368	Scalar::Util::weaken $self;
		369	return unless $self; # ->error could have destroyed $self
347		370
348	$self->{_tw} \|\|= AnyEvent->timer (after => $after, cb => sub {	371	$self->{_tw} \|\|= AnyEvent->timer (after => $after, cb => sub {
349	delete $self->{_tw};	372	delete $self->{_tw};
350	$self->_timeout;	373	$self->_timeout;
351	});	374	});
…		…
414	if $self->{low_water_mark} >= length $self->{wbuf}	437	if $self->{low_water_mark} >= length $self->{wbuf}
415	&& $self->{on_drain};	438	&& $self->{on_drain};
416		439
417	delete $self->{_ww} unless length $self->{wbuf};	440	delete $self->{_ww} unless length $self->{wbuf};
418	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	441	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
419	$self->error;	442	$self->_error ($!, 1);
420	}	443	}
421	};	444	};
422		445
423	# try to write data immediately	446	# try to write data immediately
424	$cb->();	447	$cb->();
…		…
444	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	467	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")
445	->($self, @_);	468	->($self, @_);
446	}	469	}
447		470
448	if ($self->{filter_w}) {	471	if ($self->{filter_w}) {
449	$self->{filter_w}->($self, \$_[0]);	472	$self->{filter_w}($self, \$_[0]);
450	} else {	473	} else {
451	$self->{wbuf} .= $_[0];	474	$self->{wbuf} .= $_[0];
452	$self->_drain_wbuf;	475	$self->_drain_wbuf;
453	}	476	}
454	}	477	}
455		478
456	=item $handle->push_write (type => @args)	479	=item $handle->push_write (type => @args)
457		480
458	=item $handle->unshift_write (type => @args)
459
460	Instead of formatting your data yourself, you can also let this module do	481	Instead of formatting your data yourself, you can also let this module do
461	the job by specifying a type and type-specific arguments.	482	the job by specifying a type and type-specific arguments.
462		483
463	Predefined types are (if you have ideas for additional types, feel free to	484	Predefined types are (if you have ideas for additional types, feel free to
464	drop by and tell us):	485	drop by and tell us):
…		…
468	=item netstring => $string	489	=item netstring => $string
469		490
470	Formats the given value as netstring	491	Formats the given value as netstring
471	(http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them).	492	(http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them).
472		493
473	=back
474
475	=cut	494	=cut
476		495
477	register_write_type netstring => sub {	496	register_write_type netstring => sub {
478	my ($self, $string) = @_;	497	my ($self, $string) = @_;
479		498
480	sprintf "%d:%s,", (length $string), $string	499	sprintf "%d:%s,", (length $string), $string
		500	};
		501
		502	=item packstring => $format, $data
		503
		504	An octet string prefixed with an encoded length. The encoding C<$format>
		505	uses the same format as a Perl C<pack> format, but must specify a single
		506	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
		507	optional C<!>, C<< < >> or C<< > >> modifier).
		508
		509	=cut
		510
		511	register_write_type packstring => sub {
		512	my ($self, $format, $string) = @_;
		513
		514	pack "$format/a*", $string
481	};	515	};
482		516
483	=item json => $array_or_hashref	517	=item json => $array_or_hashref
484		518
485	Encodes the given hash or array reference into a JSON object. Unless you	519	Encodes the given hash or array reference into a JSON object. Unless you
…		…
519		553
520	$self->{json} ? $self->{json}->encode ($ref)	554	$self->{json} ? $self->{json}->encode ($ref)
521	: JSON::encode_json ($ref)	555	: JSON::encode_json ($ref)
522	};	556	};
523		557
		558	=item storable => $reference
		559
		560	Freezes the given reference using L<Storable> and writes it to the
		561	handle. Uses the C<nfreeze> format.
		562
		563	=cut
		564
		565	register_write_type storable => sub {
		566	my ($self, $ref) = @_;
		567
		568	require Storable;
		569
		570	pack "w/a*", Storable::nfreeze ($ref)
		571	};
		572
		573	=back
		574
524	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	575	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
525		576
526	This function (not method) lets you add your own types to C<push_write>.	577	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	578	Whenever the given C<type> is used, C<push_write> will invoke the code
528	reference with the handle object and the remaining arguments.	579	reference with the handle object and the remaining arguments.
…		…
548	ways, the "simple" way, using only C<on_read> and the "complex" way, using	599	ways, the "simple" way, using only C<on_read> and the "complex" way, using
549	a queue.	600	a queue.
550		601
551	In the simple case, you just install an C<on_read> callback and whenever	602	In the simple case, you just install an C<on_read> callback and whenever
552	new data arrives, it will be called. You can then remove some data (if	603	new data arrives, it will be called. You can then remove some data (if
553	enough is there) from the read buffer (C<< $handle->rbuf >>) if you want	604	enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna
554	or not.	605	leave the data there if you want to accumulate more (e.g. when only a
		606	partial message has been received so far).
555		607
556	In the more complex case, you want to queue multiple callbacks. In this	608	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	609	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>,	610	data arrives (also the first time it is queued) and removes it when it has
559	below).	611	done its job (see C<push_read>, below).
560		612
561	This way you can, for example, push three line-reads, followed by reading	613	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.	614	a chunk of data, and AnyEvent::Handle will execute them in order.
563		615
564	Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by	616	Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by
565	the specified number of bytes which give an XML datagram.	617	the specified number of bytes which give an XML datagram.
566		618
567	# in the default state, expect some header bytes	619	# in the default state, expect some header bytes
568	$handle->on_read (sub {	620	$handle->on_read (sub {
569	# some data is here, now queue the length-header-read (4 octets)	621	# some data is here, now queue the length-header-read (4 octets)
570	shift->unshift_read_chunk (4, sub {	622	shift->unshift_read (chunk => 4, sub {
571	# header arrived, decode	623	# header arrived, decode
572	my $len = unpack "N", $_[1];	624	my $len = unpack "N", $_[1];
573		625
574	# now read the payload	626	# now read the payload
575	shift->unshift_read_chunk ($len, sub {	627	shift->unshift_read (chunk => $len, sub {
576	my $xml = $_[1];	628	my $xml = $_[1];
577	# handle xml	629	# handle xml
578	});	630	});
579	});	631	});
580	});	632	});
581		633
582	Example 2: Implement a client for a protocol that replies either with	634	Example 2: Implement a client for a protocol that replies either with "OK"
583	"OK" and another line or "ERROR" for one request, and 64 bytes for the	635	and another line or "ERROR" for the first request that is sent, and 64
584	second request. Due tot he availability of a full queue, we can just	636	bytes for the second request. Due to the availability of a queue, we can
585	pipeline sending both requests and manipulate the queue as necessary in	637	just pipeline sending both requests and manipulate the queue as necessary
586	the callbacks:	638	in the callbacks.
587		639
588	# request one	640	When the first callback is called and sees an "OK" response, it will
		641	C<unshift> another line-read. This line-read will be queued I<before> the
		642	64-byte chunk callback.
		643
		644	# request one, returns either "OK + extra line" or "ERROR"
589	$handle->push_write ("request 1\015\012");	645	$handle->push_write ("request 1\015\012");
590		646
591	# we expect "ERROR" or "OK" as response, so push a line read	647	# we expect "ERROR" or "OK" as response, so push a line read
592	$handle->push_read_line (sub {	648	$handle->push_read (line => sub {
593	# if we got an "OK", we have to _prepend_ another line,	649	# 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	650	# 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	651	# which are already in the queue when this callback is called
596	# we don't do this in case we got an error	652	# we don't do this in case we got an error
597	if ($_[1] eq "OK") {	653	if ($_[1] eq "OK") {
598	$_[0]->unshift_read_line (sub {	654	$_[0]->unshift_read (line => sub {
599	my $response = $_[1];	655	my $response = $_[1];
600	...	656	...
601	});	657	});
602	}	658	}
603	});	659	});
604		660
605	# request two	661	# request two, simply returns 64 octets
606	$handle->push_write ("request 2\015\012");	662	$handle->push_write ("request 2\015\012");
607		663
608	# simply read 64 bytes, always	664	# simply read 64 bytes, always
609	$handle->push_read_chunk (64, sub {	665	$handle->push_read (chunk => 64, sub {
610	my $response = $_[1];	666	my $response = $_[1];
611	...	667	...
612	});	668	});
613		669
614	=over 4	670	=over 4
615		671
616	=cut	672	=cut
617		673
618	sub _drain_rbuf {	674	sub _drain_rbuf {
619	my ($self) = @_;	675	my ($self) = @_;
		676
		677	local $self->{_in_drain} = 1;
620		678
621	if (	679	if (
622	defined $self->{rbuf_max}	680	defined $self->{rbuf_max}
623	&& $self->{rbuf_max} < length $self->{rbuf}	681	&& $self->{rbuf_max} < length $self->{rbuf}
624	) {	682	) {
625	$! = &Errno::ENOSPC;	683	return $self->_error (&Errno::ENOSPC, 1);
626	$self->error;
627	}	684	}
628		685
629	return if $self->{in_drain};	686	while () {
630	local $self->{in_drain} = 1;
631
632	while (my $len = length $self->{rbuf}) {
633	no strict 'refs';	687	no strict 'refs';
		688
		689	my $len = length $self->{rbuf};
		690
634	if (my $cb = shift @{ $self->{_queue} }) {	691	if (my $cb = shift @{ $self->{_queue} }) {
635	unless ($cb->($self)) {	692	unless ($cb->($self)) {
636	if ($self->{_eof}) {	693	if ($self->{_eof}) {
637	# no progress can be made (not enough data and no data forthcoming)	694	# no progress can be made (not enough data and no data forthcoming)
638	$! = &Errno::EPIPE;	695	$self->_error (&Errno::EPIPE, 1), last;
639	$self->error;
640	}	696	}
641		697
642	unshift @{ $self->{_queue} }, $cb;	698	unshift @{ $self->{_queue} }, $cb;
643	return;	699	last;
644	}	700	}
645	} elsif ($self->{on_read}) {	701	} elsif ($self->{on_read}) {
		702	last unless $len;
		703
646	$self->{on_read}($self);	704	$self->{on_read}($self);
647		705
648	if (	706	if (
649	$self->{_eof} # if no further data will arrive
650	&& $len == length $self->{rbuf} # and no data has been consumed	707	$len == length $self->{rbuf} # if no data has been consumed
651	&& !@{ $self->{_queue} } # and the queue is still empty	708	&& !@{ $self->{_queue} } # and the queue is still empty
652	&& $self->{on_read} # and we still want to read data	709	&& $self->{on_read} # but we still have on_read
653	) {	710	) {
		711	# no further data will arrive
654	# then no progress can be made	712	# so no progress can be made
655	$! = &Errno::EPIPE;	713	$self->_error (&Errno::EPIPE, 1), last
656	$self->error;	714	if $self->{_eof};
		715
		716	last; # more data might arrive
657	}	717	}
658	} else {	718	} else {
659	# read side becomes idle	719	# read side becomes idle
660	delete $self->{_rw};	720	delete $self->{_rw};
661	return;	721	last;
662	}	722	}
663	}	723	}
664		724
665	if ($self->{_eof}) {
666	$self->_shutdown;
667	$self->{on_eof}($self)	725	$self->{on_eof}($self)
668	if $self->{on_eof};	726	if $self->{_eof} && $self->{on_eof};
		727
		728	# may need to restart read watcher
		729	unless ($self->{_rw}) {
		730	$self->start_read
		731	if $self->{on_read} \|\| @{ $self->{_queue} };
669	}	732	}
670	}	733	}
671		734
672	=item $handle->on_read ($cb)	735	=item $handle->on_read ($cb)
673		736
…		…
679		742
680	sub on_read {	743	sub on_read {
681	my ($self, $cb) = @_;	744	my ($self, $cb) = @_;
682		745
683	$self->{on_read} = $cb;	746	$self->{on_read} = $cb;
		747	$self->_drain_rbuf if $cb && !$self->{_in_drain};
684	}	748	}
685		749
686	=item $handle->rbuf	750	=item $handle->rbuf
687		751
688	Returns the read buffer (as a modifiable lvalue).	752	Returns the read buffer (as a modifiable lvalue).
…		…
737	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	801	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
738	->($self, $cb, @_);	802	->($self, $cb, @_);
739	}	803	}
740		804
741	push @{ $self->{_queue} }, $cb;	805	push @{ $self->{_queue} }, $cb;
742	$self->_drain_rbuf;	806	$self->_drain_rbuf unless $self->{_in_drain};
743	}	807	}
744		808
745	sub unshift_read {	809	sub unshift_read {
746	my $self = shift;	810	my $self = shift;
747	my $cb = pop;	811	my $cb = pop;
…		…
753	->($self, $cb, @_);	817	->($self, $cb, @_);
754	}	818	}
755		819
756		820
757	unshift @{ $self->{_queue} }, $cb;	821	unshift @{ $self->{_queue} }, $cb;
758	$self->_drain_rbuf;	822	$self->_drain_rbuf unless $self->{_in_drain};
759	}	823	}
760		824
761	=item $handle->push_read (type => @args, $cb)	825	=item $handle->push_read (type => @args, $cb)
762		826
763	=item $handle->unshift_read (type => @args, $cb)	827	=item $handle->unshift_read (type => @args, $cb)
…		…
848		912
849	sub unshift_read_line {	913	sub unshift_read_line {
850	my $self = shift;	914	my $self = shift;
851	$self->unshift_read (line => @_);	915	$self->unshift_read (line => @_);
852	}	916	}
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		917
892	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)	918	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
893		919
894	Makes a regex match against the regex object C<$accept> and returns	920	Makes a regex match against the regex object C<$accept> and returns
895	everything up to and including the match.	921	everything up to and including the match.
…		…
945	return 1;	971	return 1;
946	}	972	}
947		973
948	# reject	974	# reject
949	if ($reject && $$rbuf =~ $reject) {	975	if ($reject && $$rbuf =~ $reject) {
950	$! = &Errno::EBADMSG;	976	$self->_error (&Errno::EBADMSG);
951	$self->error;
952	}	977	}
953		978
954	# skip	979	# skip
955	if ($skip && $$rbuf =~ $skip) {	980	if ($skip && $$rbuf =~ $skip) {
956	$data .= substr $$rbuf, 0, $+[0], "";	981	$data .= substr $$rbuf, 0, $+[0], "";
…		…
958		983
959	()	984	()
960	}	985	}
961	};	986	};
962		987
		988	=item netstring => $cb->($handle, $string)
		989
		990	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
		991
		992	Throws an error with C<$!> set to EBADMSG on format violations.
		993
		994	=cut
		995
		996	register_read_type netstring => sub {
		997	my ($self, $cb) = @_;
		998
		999	sub {
		1000	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
		1001	if ($_[0]{rbuf} =~ /[^0-9]/) {
		1002	$self->_error (&Errno::EBADMSG);
		1003	}
		1004	return;
		1005	}
		1006
		1007	my $len = $1;
		1008
		1009	$self->unshift_read (chunk => $len, sub {
		1010	my $string = $_[1];
		1011	$_[0]->unshift_read (chunk => 1, sub {
		1012	if ($_[1] eq ",") {
		1013	$cb->($_[0], $string);
		1014	} else {
		1015	$self->_error (&Errno::EBADMSG);
		1016	}
		1017	});
		1018	});
		1019
		1020	1
		1021	}
		1022	};
		1023
		1024	=item packstring => $format, $cb->($handle, $string)
		1025
		1026	An octet string prefixed with an encoded length. The encoding C<$format>
		1027	uses the same format as a Perl C<pack> format, but must specify a single
		1028	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
		1029	optional C<!>, C<< < >> or C<< > >> modifier).
		1030
		1031	DNS over TCP uses a prefix of C<n>, EPP uses a prefix of C<N>.
		1032
		1033	Example: read a block of data prefixed by its length in BER-encoded
		1034	format (very efficient).
		1035
		1036	$handle->push_read (packstring => "w", sub {
		1037	my ($handle, $data) = @_;
		1038	});
		1039
		1040	=cut
		1041
		1042	register_read_type packstring => sub {
		1043	my ($self, $cb, $format) = @_;
		1044
		1045	sub {
		1046	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
		1047	defined (my $len = eval { unpack $format, $_[0]->{rbuf} })
		1048	or return;
		1049
		1050	# remove prefix
		1051	substr $_[0]->{rbuf}, 0, (length pack $format, $len), "";
		1052
		1053	# read rest
		1054	$_[0]->unshift_read (chunk => $len, $cb);
		1055
		1056	1
		1057	}
		1058	};
		1059
963	=item json => $cb->($handle, $hash_or_arrayref)	1060	=item json => $cb->($handle, $hash_or_arrayref)
964		1061
965	Reads a JSON object or array, decodes it and passes it to the callback.	1062	Reads a JSON object or array, decodes it and passes it to the callback.
966		1063
967	If a C<json> object was passed to the constructor, then that will be used	1064	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.	1074	the C<json> write type description, above, for an actual example.
978		1075
979	=cut	1076	=cut
980		1077
981	register_read_type json => sub {	1078	register_read_type json => sub {
982	my ($self, $cb, $accept, $reject, $skip) = @_;	1079	my ($self, $cb) = @_;
983		1080
984	require JSON;	1081	require JSON;
985		1082
986	my $data;	1083	my $data;
987	my $rbuf = \$self->{rbuf};	1084	my $rbuf = \$self->{rbuf};
…		…
1002	()	1099	()
1003	}	1100	}
1004	}	1101	}
1005	};	1102	};
1006		1103
		1104	=item storable => $cb->($handle, $ref)
		1105
		1106	Deserialises a L<Storable> frozen representation as written by the
		1107	C<storable> write type (BER-encoded length prefix followed by nfreeze'd
		1108	data).
		1109
		1110	Raises C<EBADMSG> error if the data could not be decoded.
		1111
		1112	=cut
		1113
		1114	register_read_type storable => sub {
		1115	my ($self, $cb) = @_;
		1116
		1117	require Storable;
		1118
		1119	sub {
		1120	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
		1121	defined (my $len = eval { unpack "w", $_[0]->{rbuf} })
		1122	or return;
		1123
		1124	# remove prefix
		1125	substr $_[0]->{rbuf}, 0, (length pack "w", $len), "";
		1126
		1127	# read rest
		1128	$_[0]->unshift_read (chunk => $len, sub {
		1129	if (my $ref = eval { Storable::thaw ($_[1]) }) {
		1130	$cb->($_[0], $ref);
		1131	} else {
		1132	$self->_error (&Errno::EBADMSG);
		1133	}
		1134	});
		1135	}
		1136	};
		1137
1007	=back	1138	=back
1008		1139
1009	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)	1140	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)
1010		1141
1011	This function (not method) lets you add your own types to C<push_read>.	1142	This function (not method) lets you add your own types to C<push_read>.
…		…
1029	=item $handle->stop_read	1160	=item $handle->stop_read
1030		1161
1031	=item $handle->start_read	1162	=item $handle->start_read
1032		1163
1033	In rare cases you actually do not want to read anything from the	1164	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	1165	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	1166	any queued callbacks will be executed then. To start reading again, call
1036	C<start_read>.	1167	C<start_read>.
		1168
		1169	Note that AnyEvent::Handle will automatically C<start_read> for you when
		1170	you change the C<on_read> callback or push/unshift a read callback, and it
		1171	will automatically C<stop_read> for you when neither C<on_read> is set nor
		1172	there are any read requests in the queue.
1037		1173
1038	=cut	1174	=cut
1039		1175
1040	sub stop_read {	1176	sub stop_read {
1041	my ($self) = @_;	1177	my ($self) = @_;
…		…
1055		1191
1056	if ($len > 0) {	1192	if ($len > 0) {
1057	$self->{_activity} = AnyEvent->now;	1193	$self->{_activity} = AnyEvent->now;
1058		1194
1059	$self->{filter_r}	1195	$self->{filter_r}
1060	? $self->{filter_r}->($self, $rbuf)	1196	? $self->{filter_r}($self, $rbuf)
1061	: $self->_drain_rbuf;	1197	: $self->{_in_drain} \|\| $self->_drain_rbuf;
1062		1198
1063	} elsif (defined $len) {	1199	} elsif (defined $len) {
1064	delete $self->{_rw};	1200	delete $self->{_rw};
1065	delete $self->{_ww};
1066	delete $self->{_tw};
1067	$self->{_eof} = 1;	1201	$self->{_eof} = 1;
1068	$self->_drain_rbuf;	1202	$self->_drain_rbuf unless $self->{_in_drain};
1069		1203
1070	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1204	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1071	return $self->error;	1205	return $self->_error ($!, 1);
1072	}	1206	}
1073	});	1207	});
1074	}	1208	}
1075	}	1209	}
1076		1210
1077	sub _dotls {	1211	sub _dotls {
1078	my ($self) = @_;	1212	my ($self) = @_;
		1213
		1214	my $buf;
1079		1215
1080	if (length $self->{_tls_wbuf}) {	1216	if (length $self->{_tls_wbuf}) {
1081	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1217	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1082	substr $self->{_tls_wbuf}, 0, $len, "";	1218	substr $self->{_tls_wbuf}, 0, $len, "";
1083	}	1219	}
1084	}	1220	}
1085		1221
1086	if (defined (my $buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1222	if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1087	$self->{wbuf} .= $buf;	1223	$self->{wbuf} .= $buf;
1088	$self->_drain_wbuf;	1224	$self->_drain_wbuf;
1089	}	1225	}
1090		1226
1091	while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) {	1227	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {
		1228	if (length $buf) {
1092	$self->{rbuf} .= $buf;	1229	$self->{rbuf} .= $buf;
1093	$self->_drain_rbuf;	1230	$self->_drain_rbuf unless $self->{_in_drain};
		1231	} else {
		1232	# let's treat SSL-eof as we treat normal EOF
		1233	$self->{_eof} = 1;
		1234	$self->_shutdown;
		1235	return;
		1236	}
1094	}	1237	}
1095		1238
1096	my $err = Net::SSLeay::get_error ($self->{tls}, -1);	1239	my $err = Net::SSLeay::get_error ($self->{tls}, -1);
1097		1240
1098	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {	1241	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
1099	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {	1242	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {
1100	$self->error;	1243	return $self->_error ($!, 1);
1101	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {	1244	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {
1102	$! = &Errno::EIO;	1245	return $self->_error (&Errno::EIO, 1);
1103	$self->error;
1104	}	1246	}
1105		1247
1106	# all others are fine for our purposes	1248	# all others are fine for our purposes
1107	}	1249	}
1108	}	1250	}
…		…
1123	call and can be used or changed to your liking. Note that the handshake	1265	call and can be used or changed to your liking. Note that the handshake
1124	might have already started when this function returns.	1266	might have already started when this function returns.
1125		1267
1126	=cut	1268	=cut
1127		1269
1128	# TODO: maybe document...
1129	sub starttls {	1270	sub starttls {
1130	my ($self, $ssl, $ctx) = @_;	1271	my ($self, $ssl, $ctx) = @_;
1131		1272
1132	$self->stoptls;	1273	$self->stoptls;
1133		1274
…		…
1186		1327
1187	sub DESTROY {	1328	sub DESTROY {
1188	my $self = shift;	1329	my $self = shift;
1189		1330
1190	$self->stoptls;	1331	$self->stoptls;
		1332
		1333	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
		1334
		1335	if ($linger && length $self->{wbuf}) {
		1336	my $fh = delete $self->{fh};
		1337	my $wbuf = delete $self->{wbuf};
		1338
		1339	my @linger;
		1340
		1341	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {
		1342	my $len = syswrite $fh, $wbuf, length $wbuf;
		1343
		1344	if ($len > 0) {
		1345	substr $wbuf, 0, $len, "";
		1346	} else {
		1347	@linger = (); # end
		1348	}
		1349	});
		1350	push @linger, AnyEvent->timer (after => $linger, cb => sub {
		1351	@linger = ();
		1352	});
		1353	}
1191	}	1354	}
1192		1355
1193	=item AnyEvent::Handle::TLS_CTX	1356	=item AnyEvent::Handle::TLS_CTX
1194		1357
1195	This function creates and returns the Net::SSLeay::CTX object used by	1358	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.44 by root, Thu May 29 00:00:07 2008 UTC vs. Revision 1.69 by root, Sun Jun 15 21:44:56 2008 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.44 by root, Thu May 29 00:00:07 2008 UTC vs.
Revision 1.69 by root, Sun Jun 15 21:44:56 2008 UTC