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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.56 by root, Wed Jun 4 09:55:16 2008 UTC vs.
Revision 1.80 by root, Sun Jul 27 08:43:32 2008 UTC

…		…
1	package AnyEvent::Handle;	1	package AnyEvent::Handle;
2		2
3	no warnings;	3	no warnings;
4	use strict;	4	use strict qw(subs vars);
5		5
6	use AnyEvent ();	6	use AnyEvent ();
7	use AnyEvent::Util qw(WSAEWOULDBLOCK);	7	use AnyEvent::Util qw(WSAEWOULDBLOCK);
8	use Scalar::Util ();	8	use Scalar::Util ();
9	use Carp ();	9	use Carp ();
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 = 4.12;	19	our $VERSION = 4.22;
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 when an end-of-file condition is detcted,	80	Set the callback to be called when an end-of-file condition is detected,
81	i.e. in the case of a socket, when the other side has closed the	81	i.e. in the case of a socket, when the other side has closed the
82	connection cleanly.	82	connection cleanly.
83		83
84	While not mandatory, it is highly recommended to set an eof callback,	84	While not mandatory, it is I<highly> recommended to set an eof callback,
85	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
86	waiting for data.	86	waiting for data.
		87
		88	If an EOF condition has been detected but no C<on_eof> callback has been
		89	set, then a fatal error will be raised with C<$!> set to <0>.
87		90
88	=item on_error => $cb->($handle, $fatal)	91	=item on_error => $cb->($handle, $fatal)
89		92
90	This is the error callback, which is called when, well, some error	93	This is the error callback, which is called when, well, some error
91	occured, such as not being able to resolve the hostname, failure to	94	occured, such as not being able to resolve the hostname, failure to
…		…
105	C<croak>.	108	C<croak>.
106		109
107	=item on_read => $cb->($handle)	110	=item on_read => $cb->($handle)
108		111
109	This sets the default read callback, which is called when data arrives	112	This sets the default read callback, which is called when data arrives
110	and no read request is in the queue.	113	and no read request is in the queue (unlike read queue callbacks, this
		114	callback will only be called when at least one octet of data is in the
		115	read buffer).
111		116
112	To access (and remove data from) the read buffer, use the C<< ->rbuf >>	117	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
113	method or access the C<$handle->{rbuf}> member directly.	118	method or access the C<$handle->{rbuf}> member directly.
114		119
115	When an EOF condition is detected then AnyEvent::Handle will first try to	120	When an EOF condition is detected then AnyEvent::Handle will first try to
…		…
121		126
122	This sets the callback that is called when the write buffer becomes empty	127	This sets the callback that is called when the write buffer becomes empty
123	(or when the callback is set and the buffer is empty already).	128	(or when the callback is set and the buffer is empty already).
124		129
125	To append to the write buffer, use the C<< ->push_write >> method.	130	To append to the write buffer, use the C<< ->push_write >> method.
		131
		132	This callback is useful when you don't want to put all of your write data
		133	into the queue at once, for example, when you want to write the contents
		134	of some file to the socket you might not want to read the whole file into
		135	memory and push it into the queue, but instead only read more data from
		136	the file when the write queue becomes empty.
126		137
127	=item timeout => $fractional_seconds	138	=item timeout => $fractional_seconds
128		139
129	If non-zero, then this enables an "inactivity" timeout: whenever this many	140	If non-zero, then this enables an "inactivity" timeout: whenever this many
130	seconds pass without a successful read or write on the underlying file	141	seconds pass without a successful read or write on the underlying file
…		…
154	be configured to accept only so-and-so much data that it cannot act on	165	be configured to accept only so-and-so much data that it cannot act on
155	(for example, when expecting a line, an attacker could send an unlimited	166	(for example, when expecting a line, an attacker could send an unlimited
156	amount of data without a callback ever being called as long as the line	167	amount of data without a callback ever being called as long as the line
157	isn't finished).	168	isn't finished).
158		169
		170	=item autocork => <boolean>
		171
		172	When disabled (the default), then C<push_write> will try to immediately
		173	write the data to the handle if possible. This avoids having to register
		174	a write watcher and wait for the next event loop iteration, but can be
		175	inefficient if you write multiple small chunks (this disadvantage is
		176	usually avoided by your kernel's nagle algorithm, see C<low_delay>).
		177
		178	When enabled, then writes will always be queued till the next event loop
		179	iteration. This is efficient when you do many small writes per iteration,
		180	but less efficient when you do a single write only.
		181
		182	=item no_delay => <boolean>
		183
		184	When doing small writes on sockets, your operating system kernel might
		185	wait a bit for more data before actually sending it out. This is called
		186	the Nagle algorithm, and usually it is beneficial.
		187
		188	In some situations you want as low a delay as possible, which cna be
		189	accomplishd by setting this option to true.
		190
		191	The default is your opertaing system's default behaviour, this option
		192	explicitly enables or disables it, if possible.
		193
159	=item read_size => <bytes>	194	=item read_size => <bytes>
160		195
161	The default read block size (the amount of bytes this module will try to read	196	The default read block size (the amount of bytes this module will try to read
162	during each (loop iteration). Default: C<8192>.	197	during each (loop iteration). Default: C<8192>.
163		198
164	=item low_water_mark => <bytes>	199	=item low_water_mark => <bytes>
165		200
166	Sets the amount of bytes (default: C<0>) that make up an "empty" write	201	Sets the amount of bytes (default: C<0>) that make up an "empty" write
167	buffer: If the write reaches this size or gets even samller it is	202	buffer: If the write reaches this size or gets even samller it is
168	considered empty.	203	considered empty.
		204
		205	=item linger => <seconds>
		206
		207	If non-zero (default: C<3600>), then the destructor of the
		208	AnyEvent::Handle object will check wether there is still outstanding write
		209	data and will install a watcher that will write out this data. No errors
		210	will be reported (this mostly matches how the operating system treats
		211	outstanding data at socket close time).
		212
		213	This will not work for partial TLS data that could not yet been
		214	encoded. This data will be lost.
169		215
170	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	216	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
171		217
172	When this parameter is given, it enables TLS (SSL) mode, that means it	218	When this parameter is given, it enables TLS (SSL) mode, that means it
173	will start making tls handshake and will transparently encrypt/decrypt	219	will start making tls handshake and will transparently encrypt/decrypt
…		…
182	You can also provide your own TLS connection object, but you have	228	You can also provide your own TLS connection object, but you have
183	to make sure that you call either C<Net::SSLeay::set_connect_state>	229	to make sure that you call either C<Net::SSLeay::set_connect_state>
184	or C<Net::SSLeay::set_accept_state> on it before you pass it to	230	or C<Net::SSLeay::set_accept_state> on it before you pass it to
185	AnyEvent::Handle.	231	AnyEvent::Handle.
186		232
187	See the C<starttls> method if you need to start TLs negotiation later.	233	See the C<starttls> method if you need to start TLS negotiation later.
188		234
189	=item tls_ctx => $ssl_ctx	235	=item tls_ctx => $ssl_ctx
190		236
191	Use the given Net::SSLeay::CTX object to create the new TLS connection	237	Use the given Net::SSLeay::CTX object to create the new TLS connection
192	(unless a connection object was specified directly). If this parameter is	238	(unless a connection object was specified directly). If this parameter is
…		…
224	if ($self->{tls}) {	270	if ($self->{tls}) {
225	require Net::SSLeay;	271	require Net::SSLeay;
226	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});	272	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});
227	}	273	}
228		274
229	# $self->on_eof (delete $self->{on_eof} ) if $self->{on_eof}; # nop
230	# $self->on_error (delete $self->{on_error}) if $self->{on_error}; # nop
231	# $self->on_read (delete $self->{on_read} ) if $self->{on_read}; # nop
232	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
233
234	$self->{_activity} = AnyEvent->now;	275	$self->{_activity} = AnyEvent->now;
235	$self->_timeout;	276	$self->_timeout;
236		277
		278	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};
		279	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
		280
237	$self->start_read;	281	$self->start_read
		282	if $self->{on_read};
238		283
239	$self	284	$self
240	}	285	}
241		286
242	sub _shutdown {	287	sub _shutdown {
…		…
301		346
302	=cut	347	=cut
303		348
304	sub on_timeout {	349	sub on_timeout {
305	$_[0]{on_timeout} = $_[1];	350	$_[0]{on_timeout} = $_[1];
		351	}
		352
		353	=item $handle->autocork ($boolean)
		354
		355	Enables or disables the current autocork behaviour (see C<autocork>
		356	constructor argument).
		357
		358	=cut
		359
		360	=item $handle->no_delay ($boolean)
		361
		362	Enables or disables the C<no_delay> setting (see constructor argument of
		363	the same name for details).
		364
		365	=cut
		366
		367	sub no_delay {
		368	$_[0]{no_delay} = $_[1];
		369
		370	eval {
		371	local $SIG{__DIE__};
		372	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];
		373	};
306	}	374	}
307		375
308	#############################################################################	376	#############################################################################
309		377
310	=item $handle->timeout ($seconds)	378	=item $handle->timeout ($seconds)
…		…
425	$self->_error ($!, 1);	493	$self->_error ($!, 1);
426	}	494	}
427	};	495	};
428		496
429	# try to write data immediately	497	# try to write data immediately
430	$cb->();	498	$cb->() unless $self->{autocork};
431		499
432	# if still data left in wbuf, we need to poll	500	# if still data left in wbuf, we need to poll
433	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	501	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)
434	if length $self->{wbuf};	502	if length $self->{wbuf};
435	};	503	};
…		…
480	my ($self, $string) = @_;	548	my ($self, $string) = @_;
481		549
482	sprintf "%d:%s,", (length $string), $string	550	sprintf "%d:%s,", (length $string), $string
483	};	551	};
484		552
		553	=item packstring => $format, $data
		554
		555	An octet string prefixed with an encoded length. The encoding C<$format>
		556	uses the same format as a Perl C<pack> format, but must specify a single
		557	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
		558	optional C<!>, C<< < >> or C<< > >> modifier).
		559
		560	=cut
		561
		562	register_write_type packstring => sub {
		563	my ($self, $format, $string) = @_;
		564
		565	pack "$format/a*", $string
		566	};
		567
485	=item json => $array_or_hashref	568	=item json => $array_or_hashref
486		569
487	Encodes the given hash or array reference into a JSON object. Unless you	570	Encodes the given hash or array reference into a JSON object. Unless you
488	provide your own JSON object, this means it will be encoded to JSON text	571	provide your own JSON object, this means it will be encoded to JSON text
489	in UTF-8.	572	in UTF-8.
…		…
521		604
522	$self->{json} ? $self->{json}->encode ($ref)	605	$self->{json} ? $self->{json}->encode ($ref)
523	: JSON::encode_json ($ref)	606	: JSON::encode_json ($ref)
524	};	607	};
525		608
		609	=item storable => $reference
		610
		611	Freezes the given reference using L<Storable> and writes it to the
		612	handle. Uses the C<nfreeze> format.
		613
		614	=cut
		615
		616	register_write_type storable => sub {
		617	my ($self, $ref) = @_;
		618
		619	require Storable;
		620
		621	pack "w/a*", Storable::nfreeze ($ref)
		622	};
		623
526	=back	624	=back
527		625
528	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	626	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
529		627
530	This function (not method) lets you add your own types to C<push_write>.	628	This function (not method) lets you add your own types to C<push_write>.
…		…
552	ways, the "simple" way, using only C<on_read> and the "complex" way, using	650	ways, the "simple" way, using only C<on_read> and the "complex" way, using
553	a queue.	651	a queue.
554		652
555	In the simple case, you just install an C<on_read> callback and whenever	653	In the simple case, you just install an C<on_read> callback and whenever
556	new data arrives, it will be called. You can then remove some data (if	654	new data arrives, it will be called. You can then remove some data (if
557	enough is there) from the read buffer (C<< $handle->rbuf >>) if you want	655	enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna
558	or not.	656	leave the data there if you want to accumulate more (e.g. when only a
		657	partial message has been received so far).
559		658
560	In the more complex case, you want to queue multiple callbacks. In this	659	In the more complex case, you want to queue multiple callbacks. In this
561	case, AnyEvent::Handle will call the first queued callback each time new	660	case, AnyEvent::Handle will call the first queued callback each time new
562	data arrives and removes it when it has done its job (see C<push_read>,	661	data arrives (also the first time it is queued) and removes it when it has
563	below).	662	done its job (see C<push_read>, below).
564		663
565	This way you can, for example, push three line-reads, followed by reading	664	This way you can, for example, push three line-reads, followed by reading
566	a chunk of data, and AnyEvent::Handle will execute them in order.	665	a chunk of data, and AnyEvent::Handle will execute them in order.
567		666
568	Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by	667	Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by
…		…
581	# handle xml	680	# handle xml
582	});	681	});
583	});	682	});
584	});	683	});
585		684
586	Example 2: Implement a client for a protocol that replies either with	685	Example 2: Implement a client for a protocol that replies either with "OK"
587	"OK" and another line or "ERROR" for one request, and 64 bytes for the	686	and another line or "ERROR" for the first request that is sent, and 64
588	second request. Due tot he availability of a full queue, we can just	687	bytes for the second request. Due to the availability of a queue, we can
589	pipeline sending both requests and manipulate the queue as necessary in	688	just pipeline sending both requests and manipulate the queue as necessary
590	the callbacks:	689	in the callbacks.
591		690
592	# request one	691	When the first callback is called and sees an "OK" response, it will
		692	C<unshift> another line-read. This line-read will be queued I<before> the
		693	64-byte chunk callback.
		694
		695	# request one, returns either "OK + extra line" or "ERROR"
593	$handle->push_write ("request 1\015\012");	696	$handle->push_write ("request 1\015\012");
594		697
595	# we expect "ERROR" or "OK" as response, so push a line read	698	# we expect "ERROR" or "OK" as response, so push a line read
596	$handle->push_read (line => sub {	699	$handle->push_read (line => sub {
597	# if we got an "OK", we have to _prepend_ another line,	700	# if we got an "OK", we have to _prepend_ another line,
…		…
604	...	707	...
605	});	708	});
606	}	709	}
607	});	710	});
608		711
609	# request two	712	# request two, simply returns 64 octets
610	$handle->push_write ("request 2\015\012");	713	$handle->push_write ("request 2\015\012");
611		714
612	# simply read 64 bytes, always	715	# simply read 64 bytes, always
613	$handle->push_read (chunk => 64, sub {	716	$handle->push_read (chunk => 64, sub {
614	my $response = $_[1];	717	my $response = $_[1];
…		…
620	=cut	723	=cut
621		724
622	sub _drain_rbuf {	725	sub _drain_rbuf {
623	my ($self) = @_;	726	my ($self) = @_;
624		727
		728	local $self->{_in_drain} = 1;
		729
625	if (	730	if (
626	defined $self->{rbuf_max}	731	defined $self->{rbuf_max}
627	&& $self->{rbuf_max} < length $self->{rbuf}	732	&& $self->{rbuf_max} < length $self->{rbuf}
628	) {	733	) {
629	return $self->_error (&Errno::ENOSPC, 1);	734	return $self->_error (&Errno::ENOSPC, 1);
630	}	735	}
631		736
632	return if $self->{in_drain};	737	while () {
633	local $self->{in_drain} = 1;
634
635	while (my $len = length $self->{rbuf}) {	738	my $len = length $self->{rbuf};
636	no strict 'refs';	739
637	if (my $cb = shift @{ $self->{_queue} }) {	740	if (my $cb = shift @{ $self->{_queue} }) {
638	unless ($cb->($self)) {	741	unless ($cb->($self)) {
639	if ($self->{_eof}) {	742	if ($self->{_eof}) {
640	# no progress can be made (not enough data and no data forthcoming)	743	# no progress can be made (not enough data and no data forthcoming)
641	return $self->_error (&Errno::EPIPE, 1);	744	$self->_error (&Errno::EPIPE, 1), last;
642	}	745	}
643		746
644	unshift @{ $self->{_queue} }, $cb;	747	unshift @{ $self->{_queue} }, $cb;
645	last;	748	last;
646	}	749	}
647	} elsif ($self->{on_read}) {	750	} elsif ($self->{on_read}) {
		751	last unless $len;
		752
648	$self->{on_read}($self);	753	$self->{on_read}($self);
649		754
650	if (	755	if (
651	$len == length $self->{rbuf} # if no data has been consumed	756	$len == length $self->{rbuf} # if no data has been consumed
652	&& !@{ $self->{_queue} } # and the queue is still empty	757	&& !@{ $self->{_queue} } # and the queue is still empty
653	&& $self->{on_read} # but we still have on_read	758	&& $self->{on_read} # but we still have on_read
654	) {	759	) {
655	# no further data will arrive	760	# no further data will arrive
656	# so no progress can be made	761	# so no progress can be made
657	return $self->_error (&Errno::EPIPE, 1)	762	$self->_error (&Errno::EPIPE, 1), last
658	if $self->{_eof};	763	if $self->{_eof};
659		764
660	last; # more data might arrive	765	last; # more data might arrive
661	}	766	}
662	} else {	767	} else {
…		…
664	delete $self->{_rw};	769	delete $self->{_rw};
665	last;	770	last;
666	}	771	}
667	}	772	}
668		773
		774	if ($self->{_eof}) {
		775	if ($self->{on_eof}) {
669	$self->{on_eof}($self)	776	$self->{on_eof}($self)
670	if $self->{_eof} && $self->{on_eof};	777	} else {
		778	$self->_error (0, 1);
		779	}
		780	}
671		781
672	# may need to restart read watcher	782	# may need to restart read watcher
673	unless ($self->{_rw}) {	783	unless ($self->{_rw}) {
674	$self->start_read	784	$self->start_read
675	if $self->{on_read} \|\| @{ $self->{_queue} };	785	if $self->{on_read} \|\| @{ $self->{_queue} };
…		…
686		796
687	sub on_read {	797	sub on_read {
688	my ($self, $cb) = @_;	798	my ($self, $cb) = @_;
689		799
690	$self->{on_read} = $cb;	800	$self->{on_read} = $cb;
		801	$self->_drain_rbuf if $cb && !$self->{_in_drain};
691	}	802	}
692		803
693	=item $handle->rbuf	804	=item $handle->rbuf
694		805
695	Returns the read buffer (as a modifiable lvalue).	806	Returns the read buffer (as a modifiable lvalue).
…		…
744	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	855	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
745	->($self, $cb, @_);	856	->($self, $cb, @_);
746	}	857	}
747		858
748	push @{ $self->{_queue} }, $cb;	859	push @{ $self->{_queue} }, $cb;
749	$self->_drain_rbuf;	860	$self->_drain_rbuf unless $self->{_in_drain};
750	}	861	}
751		862
752	sub unshift_read {	863	sub unshift_read {
753	my $self = shift;	864	my $self = shift;
754	my $cb = pop;	865	my $cb = pop;
…		…
760	->($self, $cb, @_);	871	->($self, $cb, @_);
761	}	872	}
762		873
763		874
764	unshift @{ $self->{_queue} }, $cb;	875	unshift @{ $self->{_queue} }, $cb;
765	$self->_drain_rbuf;	876	$self->_drain_rbuf unless $self->{_in_drain};
766	}	877	}
767		878
768	=item $handle->push_read (type => @args, $cb)	879	=item $handle->push_read (type => @args, $cb)
769		880
770	=item $handle->unshift_read (type => @args, $cb)	881	=item $handle->unshift_read (type => @args, $cb)
…		…
800	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");	911	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");
801	1	912	1
802	}	913	}
803	};	914	};
804		915
805	# compatibility with older API
806	sub push_read_chunk {
807	$_[0]->push_read (chunk => $_[1], $_[2]);
808	}
809
810	sub unshift_read_chunk {
811	$_[0]->unshift_read (chunk => $_[1], $_[2]);
812	}
813
814	=item line => [$eol, ]$cb->($handle, $line, $eol)	916	=item line => [$eol, ]$cb->($handle, $line, $eol)
815		917
816	The callback will be called only once a full line (including the end of	918	The callback will be called only once a full line (including the end of
817	line marker, C<$eol>) has been read. This line (excluding the end of line	919	line marker, C<$eol>) has been read. This line (excluding the end of line
818	marker) will be passed to the callback as second argument (C<$line>), and	920	marker) will be passed to the callback as second argument (C<$line>), and
…		…
833	=cut	935	=cut
834		936
835	register_read_type line => sub {	937	register_read_type line => sub {
836	my ($self, $cb, $eol) = @_;	938	my ($self, $cb, $eol) = @_;
837		939
838	$eol = qr\|(\015?\012)\| if @_ < 3;	940	if (@_ < 3) {
		941	# this is more than twice as fast as the generic code below
		942	sub {
		943	$_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return;
		944
		945	$cb->($_[0], $1, $2);
		946	1
		947	}
		948	} else {
839	$eol = quotemeta $eol unless ref $eol;	949	$eol = quotemeta $eol unless ref $eol;
840	$eol = qr\|^(.*?)($eol)\|s;	950	$eol = qr\|^(.*?)($eol)\|s;
		951
		952	sub {
		953	$_[0]{rbuf} =~ s/$eol// or return;
		954
		955	$cb->($_[0], $1, $2);
		956	1
		957	}
		958	}
		959	};
		960
		961	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
		962
		963	Makes a regex match against the regex object C<$accept> and returns
		964	everything up to and including the match.
		965
		966	Example: read a single line terminated by '\n'.
		967
		968	$handle->push_read (regex => qr<\n>, sub { ... });
		969
		970	If C<$reject> is given and not undef, then it determines when the data is
		971	to be rejected: it is matched against the data when the C<$accept> regex
		972	does not match and generates an C<EBADMSG> error when it matches. This is
		973	useful to quickly reject wrong data (to avoid waiting for a timeout or a
		974	receive buffer overflow).
		975
		976	Example: expect a single decimal number followed by whitespace, reject
		977	anything else (not the use of an anchor).
		978
		979	$handle->push_read (regex => qr<^[0-9]+\s>, qr<[^0-9]>, sub { ... });
		980
		981	If C<$skip> is given and not C<undef>, then it will be matched against
		982	the receive buffer when neither C<$accept> nor C<$reject> match,
		983	and everything preceding and including the match will be accepted
		984	unconditionally. This is useful to skip large amounts of data that you
		985	know cannot be matched, so that the C<$accept> or C<$reject> regex do not
		986	have to start matching from the beginning. This is purely an optimisation
		987	and is usually worth only when you expect more than a few kilobytes.
		988
		989	Example: expect a http header, which ends at C<\015\012\015\012>. Since we
		990	expect the header to be very large (it isn't in practise, but...), we use
		991	a skip regex to skip initial portions. The skip regex is tricky in that
		992	it only accepts something not ending in either \015 or \012, as these are
		993	required for the accept regex.
		994
		995	$handle->push_read (regex =>
		996	qr<\015\012\015\012>,
		997	undef, # no reject
		998	qr<^.*[^\015\012]>,
		999	sub { ... });
		1000
		1001	=cut
		1002
		1003	register_read_type regex => sub {
		1004	my ($self, $cb, $accept, $reject, $skip) = @_;
		1005
		1006	my $data;
		1007	my $rbuf = \$self->{rbuf};
841		1008
842	sub {	1009	sub {
843	$_[0]{rbuf} =~ s/$eol// or return;	1010	# accept
844		1011	if ($$rbuf =~ $accept) {
845	$cb->($_[0], $1, $2);	1012	$data .= substr $$rbuf, 0, $+[0], "";
		1013	$cb->($self, $data);
		1014	return 1;
		1015	}
846	1	1016
		1017	# reject
		1018	if ($reject && $$rbuf =~ $reject) {
		1019	$self->_error (&Errno::EBADMSG);
		1020	}
		1021
		1022	# skip
		1023	if ($skip && $$rbuf =~ $skip) {
		1024	$data .= substr $$rbuf, 0, $+[0], "";
		1025	}
		1026
		1027	()
847	}	1028	}
848	};	1029	};
849
850	# compatibility with older API
851	sub push_read_line {
852	my $self = shift;
853	$self->push_read (line => @_);
854	}
855
856	sub unshift_read_line {
857	my $self = shift;
858	$self->unshift_read (line => @_);
859	}
860		1030
861	=item netstring => $cb->($handle, $string)	1031	=item netstring => $cb->($handle, $string)
862		1032
863	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).	1033	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
864		1034
…		…
892		1062
893	1	1063	1
894	}	1064	}
895	};	1065	};
896		1066
897	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)	1067	=item packstring => $format, $cb->($handle, $string)
898		1068
899	Makes a regex match against the regex object C<$accept> and returns	1069	An octet string prefixed with an encoded length. The encoding C<$format>
900	everything up to and including the match.	1070	uses the same format as a Perl C<pack> format, but must specify a single
		1071	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
		1072	optional C<!>, C<< < >> or C<< > >> modifier).
901		1073
902	Example: read a single line terminated by '\n'.	1074	DNS over TCP uses a prefix of C<n>, EPP uses a prefix of C<N>.
903		1075
904	$handle->push_read (regex => qr<\n>, sub { ... });	1076	Example: read a block of data prefixed by its length in BER-encoded
		1077	format (very efficient).
905		1078
906	If C<$reject> is given and not undef, then it determines when the data is	1079	$handle->push_read (packstring => "w", sub {
907	to be rejected: it is matched against the data when the C<$accept> regex	1080	my ($handle, $data) = @_;
908	does not match and generates an C<EBADMSG> error when it matches. This is	1081	});
909	useful to quickly reject wrong data (to avoid waiting for a timeout or a
910	receive buffer overflow).
911		1082
912	Example: expect a single decimal number followed by whitespace, reject
913	anything else (not the use of an anchor).
914
915	$handle->push_read (regex => qr<^[0-9]+\s>, qr<[^0-9]>, sub { ... });
916
917	If C<$skip> is given and not C<undef>, then it will be matched against
918	the receive buffer when neither C<$accept> nor C<$reject> match,
919	and everything preceding and including the match will be accepted
920	unconditionally. This is useful to skip large amounts of data that you
921	know cannot be matched, so that the C<$accept> or C<$reject> regex do not
922	have to start matching from the beginning. This is purely an optimisation
923	and is usually worth only when you expect more than a few kilobytes.
924
925	Example: expect a http header, which ends at C<\015\012\015\012>. Since we
926	expect the header to be very large (it isn't in practise, but...), we use
927	a skip regex to skip initial portions. The skip regex is tricky in that
928	it only accepts something not ending in either \015 or \012, as these are
929	required for the accept regex.
930
931	$handle->push_read (regex =>
932	qr<\015\012\015\012>,
933	undef, # no reject
934	qr<^.*[^\015\012]>,
935	sub { ... });
936
937	=cut	1083	=cut
938		1084
939	register_read_type regex => sub {	1085	register_read_type packstring => sub {
940	my ($self, $cb, $accept, $reject, $skip) = @_;	1086	my ($self, $cb, $format) = @_;
941
942	my $data;
943	my $rbuf = \$self->{rbuf};
944		1087
945	sub {	1088	sub {
946	# accept	1089	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
947	if ($$rbuf =~ $accept) {	1090	defined (my $len = eval { unpack $format, $_[0]{rbuf} })
948	$data .= substr $$rbuf, 0, $+[0], "";
949	$cb->($self, $data);
950	return 1;	1091	or return;
951	}	1092
		1093	$format = length pack $format, $len;
		1094
		1095	# bypass unshift if we already have the remaining chunk
		1096	if ($format + $len <= length $_[0]{rbuf}) {
		1097	my $data = substr $_[0]{rbuf}, $format, $len;
		1098	substr $_[0]{rbuf}, 0, $format + $len, "";
		1099	$cb->($_[0], $data);
		1100	} else {
		1101	# remove prefix
		1102	substr $_[0]{rbuf}, 0, $format, "";
		1103
		1104	# read remaining chunk
		1105	$_[0]->unshift_read (chunk => $len, $cb);
952		1106	}
953	# reject	1107
954	if ($reject && $$rbuf =~ $reject) {
955	$self->_error (&Errno::EBADMSG);
956	}	1108	1
957
958	# skip
959	if ($skip && $$rbuf =~ $skip) {
960	$data .= substr $$rbuf, 0, $+[0], "";
961	}
962
963	()
964	}	1109	}
965	};	1110	};
966		1111
967	=item json => $cb->($handle, $hash_or_arrayref)	1112	=item json => $cb->($handle, $hash_or_arrayref)
968		1113
…		…
981	the C<json> write type description, above, for an actual example.	1126	the C<json> write type description, above, for an actual example.
982		1127
983	=cut	1128	=cut
984		1129
985	register_read_type json => sub {	1130	register_read_type json => sub {
986	my ($self, $cb, $accept, $reject, $skip) = @_;	1131	my ($self, $cb) = @_;
987		1132
988	require JSON;	1133	require JSON;
989		1134
990	my $data;	1135	my $data;
991	my $rbuf = \$self->{rbuf};	1136	my $rbuf = \$self->{rbuf};
…		…
1006	()	1151	()
1007	}	1152	}
1008	}	1153	}
1009	};	1154	};
1010		1155
		1156	=item storable => $cb->($handle, $ref)
		1157
		1158	Deserialises a L<Storable> frozen representation as written by the
		1159	C<storable> write type (BER-encoded length prefix followed by nfreeze'd
		1160	data).
		1161
		1162	Raises C<EBADMSG> error if the data could not be decoded.
		1163
		1164	=cut
		1165
		1166	register_read_type storable => sub {
		1167	my ($self, $cb) = @_;
		1168
		1169	require Storable;
		1170
		1171	sub {
		1172	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
		1173	defined (my $len = eval { unpack "w", $_[0]{rbuf} })
		1174	or return;
		1175
		1176	my $format = length pack "w", $len;
		1177
		1178	# bypass unshift if we already have the remaining chunk
		1179	if ($format + $len <= length $_[0]{rbuf}) {
		1180	my $data = substr $_[0]{rbuf}, $format, $len;
		1181	substr $_[0]{rbuf}, 0, $format + $len, "";
		1182	$cb->($_[0], Storable::thaw ($data));
		1183	} else {
		1184	# remove prefix
		1185	substr $_[0]{rbuf}, 0, $format, "";
		1186
		1187	# read remaining chunk
		1188	$_[0]->unshift_read (chunk => $len, sub {
		1189	if (my $ref = eval { Storable::thaw ($_[1]) }) {
		1190	$cb->($_[0], $ref);
		1191	} else {
		1192	$self->_error (&Errno::EBADMSG);
		1193	}
		1194	});
		1195	}
		1196
		1197	1
		1198	}
		1199	};
		1200
1011	=back	1201	=back
1012		1202
1013	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)	1203	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)
1014		1204
1015	This function (not method) lets you add your own types to C<push_read>.	1205	This function (not method) lets you add your own types to C<push_read>.
…		…
1033	=item $handle->stop_read	1223	=item $handle->stop_read
1034		1224
1035	=item $handle->start_read	1225	=item $handle->start_read
1036		1226
1037	In rare cases you actually do not want to read anything from the	1227	In rare cases you actually do not want to read anything from the
1038	socket. In this case you can call C<stop_read>. Neither C<on_read> no	1228	socket. In this case you can call C<stop_read>. Neither C<on_read> nor
1039	any queued callbacks will be executed then. To start reading again, call	1229	any queued callbacks will be executed then. To start reading again, call
1040	C<start_read>.	1230	C<start_read>.
1041		1231
1042	Note that AnyEvent::Handle will automatically C<start_read> for you when	1232	Note that AnyEvent::Handle will automatically C<start_read> for you when
1043	you change the C<on_read> callback or push/unshift a read callback, and it	1233	you change the C<on_read> callback or push/unshift a read callback, and it
…		…
1065	if ($len > 0) {	1255	if ($len > 0) {
1066	$self->{_activity} = AnyEvent->now;	1256	$self->{_activity} = AnyEvent->now;
1067		1257
1068	$self->{filter_r}	1258	$self->{filter_r}
1069	? $self->{filter_r}($self, $rbuf)	1259	? $self->{filter_r}($self, $rbuf)
1070	: $self->_drain_rbuf;	1260	: $self->{_in_drain} \|\| $self->_drain_rbuf;
1071		1261
1072	} elsif (defined $len) {	1262	} elsif (defined $len) {
1073	delete $self->{_rw};	1263	delete $self->{_rw};
1074	$self->{_eof} = 1;	1264	$self->{_eof} = 1;
1075	$self->_drain_rbuf;	1265	$self->_drain_rbuf unless $self->{_in_drain};
1076		1266
1077	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1267	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1078	return $self->_error ($!, 1);	1268	return $self->_error ($!, 1);
1079	}	1269	}
1080	});	1270	});
…		…
1098	}	1288	}
1099		1289
1100	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {	1290	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {
1101	if (length $buf) {	1291	if (length $buf) {
1102	$self->{rbuf} .= $buf;	1292	$self->{rbuf} .= $buf;
1103	$self->_drain_rbuf;	1293	$self->_drain_rbuf unless $self->{_in_drain};
1104	} else {	1294	} else {
1105	# let's treat SSL-eof as we treat normal EOF	1295	# let's treat SSL-eof as we treat normal EOF
1106	$self->{_eof} = 1;	1296	$self->{_eof} = 1;
1107	$self->_shutdown;	1297	$self->_shutdown;
1108	return;	1298	return;
…		…
1200		1390
1201	sub DESTROY {	1391	sub DESTROY {
1202	my $self = shift;	1392	my $self = shift;
1203		1393
1204	$self->stoptls;	1394	$self->stoptls;
		1395
		1396	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
		1397
		1398	if ($linger && length $self->{wbuf}) {
		1399	my $fh = delete $self->{fh};
		1400	my $wbuf = delete $self->{wbuf};
		1401
		1402	my @linger;
		1403
		1404	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {
		1405	my $len = syswrite $fh, $wbuf, length $wbuf;
		1406
		1407	if ($len > 0) {
		1408	substr $wbuf, 0, $len, "";
		1409	} else {
		1410	@linger = (); # end
		1411	}
		1412	});
		1413	push @linger, AnyEvent->timer (after => $linger, cb => sub {
		1414	@linger = ();
		1415	});
		1416	}
1205	}	1417	}
1206		1418
1207	=item AnyEvent::Handle::TLS_CTX	1419	=item AnyEvent::Handle::TLS_CTX
1208		1420
1209	This function creates and returns the Net::SSLeay::CTX object used by	1421	This function creates and returns the Net::SSLeay::CTX object used by
…		…
1251	=over 4	1463	=over 4
1252		1464
1253	=item * all constructor arguments become object members.	1465	=item * all constructor arguments become object members.
1254		1466
1255	At least initially, when you pass a C<tls>-argument to the constructor it	1467	At least initially, when you pass a C<tls>-argument to the constructor it
1256	will end up in C<< $handle->{tls} >>. Those members might be changes or	1468	will end up in C<< $handle->{tls} >>. Those members might be changed or
1257	mutated later on (for example C<tls> will hold the TLS connection object).	1469	mutated later on (for example C<tls> will hold the TLS connection object).
1258		1470
1259	=item * other object member names are prefixed with an C<_>.	1471	=item * other object member names are prefixed with an C<_>.
1260		1472
1261	All object members not explicitly documented (internal use) are prefixed	1473	All object members not explicitly documented (internal use) are prefixed

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.56 by root, Wed Jun 4 09:55:16 2008 UTC vs. Revision 1.80 by root, Sun Jul 27 08:43:32 2008 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.56 by root, Wed Jun 4 09:55:16 2008 UTC vs.
Revision 1.80 by root, Sun Jul 27 08:43:32 2008 UTC