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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.57 by root, Wed Jun 4 11:45:21 2008 UTC vs.
Revision 1.85 by root, Thu Aug 21 19:53:19 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.13;	19	our $VERSION = 4.232;
20		20
21	=head1 SYNOPSIS	21	=head1 SYNOPSIS
22		22
23	use AnyEvent;	23	use AnyEvent;
24	use AnyEvent::Handle;	24	use AnyEvent::Handle;
…		…
49		49
50	This module is a helper module to make it easier to do event-based I/O on	50	This module is a helper module to make it easier to do event-based I/O on
51	filehandles. For utility functions for doing non-blocking connects and accepts	51	filehandles. For utility functions for doing non-blocking connects and accepts
52	on sockets see L<AnyEvent::Util>.	52	on sockets see L<AnyEvent::Util>.
53		53
		54	The L<AnyEvent::Intro> tutorial contains some well-documented
		55	AnyEvent::Handle examples.
		56
54	In the following, when the documentation refers to of "bytes" then this	57	In the following, when the documentation refers to of "bytes" then this
55	means characters. As sysread and syswrite are used for all I/O, their	58	means characters. As sysread and syswrite are used for all I/O, their
56	treatment of characters applies to this module as well.	59	treatment of characters applies to this module as well.
57		60
58	All callbacks will be invoked with the handle object as their first	61	All callbacks will be invoked with the handle object as their first
…		…
70		73
71	=item fh => $filehandle [MANDATORY]	74	=item fh => $filehandle [MANDATORY]
72		75
73	The filehandle this L<AnyEvent::Handle> object will operate on.	76	The filehandle this L<AnyEvent::Handle> object will operate on.
74		77
75	NOTE: The filehandle will be set to non-blocking (using	78	NOTE: The filehandle will be set to non-blocking mode (using
76	AnyEvent::Util::fh_nonblocking).	79	C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in
		80	that mode.
77		81
78	=item on_eof => $cb->($handle)	82	=item on_eof => $cb->($handle)
79		83
80	Set the callback to be called when an end-of-file condition is detcted,	84	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	85	i.e. in the case of a socket, when the other side has closed the
82	connection cleanly.	86	connection cleanly.
83		87
		88	For sockets, this just means that the other side has stopped sending data,
		89	you can still try to write data, and, in fact, one can return from the eof
		90	callback and continue writing data, as only the read part has been shut
		91	down.
		92
84	While not mandatory, it is highly recommended to set an eof callback,	93	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	94	otherwise you might end up with a closed socket while you are still
86	waiting for data.	95	waiting for data.
		96
		97	If an EOF condition has been detected but no C<on_eof> callback has been
		98	set, then a fatal error will be raised with C<$!> set to <0>.
87		99
88	=item on_error => $cb->($handle, $fatal)	100	=item on_error => $cb->($handle, $fatal)
89		101
90	This is the error callback, which is called when, well, some error	102	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	103	occured, such as not being able to resolve the hostname, failure to
92	connect or a read error.	104	connect or a read error.
93		105
94	Some errors are fatal (which is indicated by C<$fatal> being true). On	106	Some errors are fatal (which is indicated by C<$fatal> being true). On
95	fatal errors the handle object will be shut down and will not be	107	fatal errors the handle object will be shut down and will not be usable
		108	(but you are free to look at the current C< ->rbuf >). Examples of fatal
		109	errors are an EOF condition with active (but unsatisifable) read watchers
		110	(C<EPIPE>) or I/O errors.
		111
96	usable. Non-fatal errors can be retried by simply returning, but it is	112	Non-fatal errors can be retried by simply returning, but it is recommended
97	recommended to simply ignore this parameter and instead abondon the handle	113	to simply ignore this parameter and instead abondon the handle object
98	object when this callback is invoked.	114	when this callback is invoked. Examples of non-fatal errors are timeouts
		115	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
99		116
100	On callback entrance, the value of C<$!> contains the operating system	117	On callback entrance, the value of C<$!> contains the operating system
101	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).	118	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).
102		119
103	While not mandatory, it is I<highly> recommended to set this callback, as	120	While not mandatory, it is I<highly> recommended to set this callback, as
…		…
105	C<croak>.	122	C<croak>.
106		123
107	=item on_read => $cb->($handle)	124	=item on_read => $cb->($handle)
108		125
109	This sets the default read callback, which is called when data arrives	126	This sets the default read callback, which is called when data arrives
110	and no read request is in the queue.	127	and no read request is in the queue (unlike read queue callbacks, this
		128	callback will only be called when at least one octet of data is in the
		129	read buffer).
111		130
112	To access (and remove data from) the read buffer, use the C<< ->rbuf >>	131	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
113	method or access the C<$handle->{rbuf}> member directly.	132	method or access the C<$handle->{rbuf}> member directly.
114		133
115	When an EOF condition is detected then AnyEvent::Handle will first try to	134	When an EOF condition is detected then AnyEvent::Handle will first try to
…		…
121		140
122	This sets the callback that is called when the write buffer becomes empty	141	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).	142	(or when the callback is set and the buffer is empty already).
124		143
125	To append to the write buffer, use the C<< ->push_write >> method.	144	To append to the write buffer, use the C<< ->push_write >> method.
		145
		146	This callback is useful when you don't want to put all of your write data
		147	into the queue at once, for example, when you want to write the contents
		148	of some file to the socket you might not want to read the whole file into
		149	memory and push it into the queue, but instead only read more data from
		150	the file when the write queue becomes empty.
126		151
127	=item timeout => $fractional_seconds	152	=item timeout => $fractional_seconds
128		153
129	If non-zero, then this enables an "inactivity" timeout: whenever this many	154	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	155	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	179	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	180	(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	181	amount of data without a callback ever being called as long as the line
157	isn't finished).	182	isn't finished).
158		183
		184	=item autocork => <boolean>
		185
		186	When disabled (the default), then C<push_write> will try to immediately
		187	write the data to the handle if possible. This avoids having to register
		188	a write watcher and wait for the next event loop iteration, but can be
		189	inefficient if you write multiple small chunks (this disadvantage is
		190	usually avoided by your kernel's nagle algorithm, see C<low_delay>).
		191
		192	When enabled, then writes will always be queued till the next event loop
		193	iteration. This is efficient when you do many small writes per iteration,
		194	but less efficient when you do a single write only.
		195
		196	=item no_delay => <boolean>
		197
		198	When doing small writes on sockets, your operating system kernel might
		199	wait a bit for more data before actually sending it out. This is called
		200	the Nagle algorithm, and usually it is beneficial.
		201
		202	In some situations you want as low a delay as possible, which cna be
		203	accomplishd by setting this option to true.
		204
		205	The default is your opertaing system's default behaviour, this option
		206	explicitly enables or disables it, if possible.
		207
159	=item read_size => <bytes>	208	=item read_size => <bytes>
160		209
161	The default read block size (the amount of bytes this module will try to read	210	The default read block size (the amount of bytes this module will try to read
162	during each (loop iteration). Default: C<8192>.	211	during each (loop iteration). Default: C<8192>.
163		212
…		…
165		214
166	Sets the amount of bytes (default: C<0>) that make up an "empty" write	215	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	216	buffer: If the write reaches this size or gets even samller it is
168	considered empty.	217	considered empty.
169		218
		219	=item linger => <seconds>
		220
		221	If non-zero (default: C<3600>), then the destructor of the
		222	AnyEvent::Handle object will check wether there is still outstanding write
		223	data and will install a watcher that will write out this data. No errors
		224	will be reported (this mostly matches how the operating system treats
		225	outstanding data at socket close time).
		226
		227	This will not work for partial TLS data that could not yet been
		228	encoded. This data will be lost.
		229
170	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	230	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
171		231
172	When this parameter is given, it enables TLS (SSL) mode, that means it	232	When this parameter is given, it enables TLS (SSL) mode, that means
173	will start making tls handshake and will transparently encrypt/decrypt	233	AnyEvent will start a TLS handshake and will transparently encrypt/decrypt
174	data.	234	data.
175		235
176	TLS mode requires Net::SSLeay to be installed (it will be loaded	236	TLS mode requires Net::SSLeay to be installed (it will be loaded
177	automatically when you try to create a TLS handle).	237	automatically when you try to create a TLS handle).
178		238
179	For the TLS server side, use C<accept>, and for the TLS client side of a	239	Unlike TCP, TLS has a server and client side: for the TLS server side, use
180	connection, use C<connect> mode.	240	C<accept>, and for the TLS client side of a connection, use C<connect>
		241	mode.
181		242
182	You can also provide your own TLS connection object, but you have	243	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>	244	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	245	or C<Net::SSLeay::set_accept_state> on it before you pass it to
185	AnyEvent::Handle.	246	AnyEvent::Handle.
186		247
187	See the C<starttls> method if you need to start TLs negotiation later.	248	See the C<starttls> method for when need to start TLS negotiation later.
188		249
189	=item tls_ctx => $ssl_ctx	250	=item tls_ctx => $ssl_ctx
190		251
191	Use the given Net::SSLeay::CTX object to create the new TLS connection	252	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	253	(unless a connection object was specified directly). If this parameter is
…		…
224	if ($self->{tls}) {	285	if ($self->{tls}) {
225	require Net::SSLeay;	286	require Net::SSLeay;
226	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});	287	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});
227	}	288	}
228		289
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;	290	$self->{_activity} = AnyEvent->now;
235	$self->_timeout;	291	$self->_timeout;
236		292
		293	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};
		294	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
		295
237	$self->start_read;	296	$self->start_read
		297	if $self->{on_read};
238		298
239	$self	299	$self
240	}	300	}
241		301
242	sub _shutdown {	302	sub _shutdown {
…		…
246	delete $self->{_rw};	306	delete $self->{_rw};
247	delete $self->{_ww};	307	delete $self->{_ww};
248	delete $self->{fh};	308	delete $self->{fh};
249		309
250	$self->stoptls;	310	$self->stoptls;
		311
		312	delete $self->{on_read};
		313	delete $self->{_queue};
251	}	314	}
252		315
253	sub _error {	316	sub _error {
254	my ($self, $errno, $fatal) = @_;	317	my ($self, $errno, $fatal) = @_;
255		318
…		…
301		364
302	=cut	365	=cut
303		366
304	sub on_timeout {	367	sub on_timeout {
305	$_[0]{on_timeout} = $_[1];	368	$_[0]{on_timeout} = $_[1];
		369	}
		370
		371	=item $handle->autocork ($boolean)
		372
		373	Enables or disables the current autocork behaviour (see C<autocork>
		374	constructor argument).
		375
		376	=cut
		377
		378	=item $handle->no_delay ($boolean)
		379
		380	Enables or disables the C<no_delay> setting (see constructor argument of
		381	the same name for details).
		382
		383	=cut
		384
		385	sub no_delay {
		386	$_[0]{no_delay} = $_[1];
		387
		388	eval {
		389	local $SIG{__DIE__};
		390	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];
		391	};
306	}	392	}
307		393
308	#############################################################################	394	#############################################################################
309		395
310	=item $handle->timeout ($seconds)	396	=item $handle->timeout ($seconds)
…		…
425	$self->_error ($!, 1);	511	$self->_error ($!, 1);
426	}	512	}
427	};	513	};
428		514
429	# try to write data immediately	515	# try to write data immediately
430	$cb->();	516	$cb->() unless $self->{autocork};
431		517
432	# if still data left in wbuf, we need to poll	518	# if still data left in wbuf, we need to poll
433	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	519	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)
434	if length $self->{wbuf};	520	if length $self->{wbuf};
435	};	521	};
…		…
480	my ($self, $string) = @_;	566	my ($self, $string) = @_;
481		567
482	sprintf "%d:%s,", (length $string), $string	568	sprintf "%d:%s,", (length $string), $string
483	};	569	};
484		570
		571	=item packstring => $format, $data
		572
		573	An octet string prefixed with an encoded length. The encoding C<$format>
		574	uses the same format as a Perl C<pack> format, but must specify a single
		575	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
		576	optional C<!>, C<< < >> or C<< > >> modifier).
		577
		578	=cut
		579
		580	register_write_type packstring => sub {
		581	my ($self, $format, $string) = @_;
		582
		583	pack "$format/a*", $string
		584	};
		585
485	=item json => $array_or_hashref	586	=item json => $array_or_hashref
486		587
487	Encodes the given hash or array reference into a JSON object. Unless you	588	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	589	provide your own JSON object, this means it will be encoded to JSON text
489	in UTF-8.	590	in UTF-8.
…		…
521		622
522	$self->{json} ? $self->{json}->encode ($ref)	623	$self->{json} ? $self->{json}->encode ($ref)
523	: JSON::encode_json ($ref)	624	: JSON::encode_json ($ref)
524	};	625	};
525		626
		627	=item storable => $reference
		628
		629	Freezes the given reference using L<Storable> and writes it to the
		630	handle. Uses the C<nfreeze> format.
		631
		632	=cut
		633
		634	register_write_type storable => sub {
		635	my ($self, $ref) = @_;
		636
		637	require Storable;
		638
		639	pack "w/a*", Storable::nfreeze ($ref)
		640	};
		641
526	=back	642	=back
527		643
528	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	644	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
529		645
530	This function (not method) lets you add your own types to C<push_write>.	646	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	668	ways, the "simple" way, using only C<on_read> and the "complex" way, using
553	a queue.	669	a queue.
554		670
555	In the simple case, you just install an C<on_read> callback and whenever	671	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	672	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	673	enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna
558	or not.	674	leave the data there if you want to accumulate more (e.g. when only a
		675	partial message has been received so far).
559		676
560	In the more complex case, you want to queue multiple callbacks. In this	677	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	678	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>,	679	data arrives (also the first time it is queued) and removes it when it has
563	below).	680	done its job (see C<push_read>, below).
564		681
565	This way you can, for example, push three line-reads, followed by reading	682	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.	683	a chunk of data, and AnyEvent::Handle will execute them in order.
567		684
568	Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by	685	Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by
…		…
581	# handle xml	698	# handle xml
582	});	699	});
583	});	700	});
584	});	701	});
585		702
586	Example 2: Implement a client for a protocol that replies either with	703	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	704	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	705	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	706	just pipeline sending both requests and manipulate the queue as necessary
590	the callbacks:	707	in the callbacks.
591		708
592	# request one	709	When the first callback is called and sees an "OK" response, it will
		710	C<unshift> another line-read. This line-read will be queued I<before> the
		711	64-byte chunk callback.
		712
		713	# request one, returns either "OK + extra line" or "ERROR"
593	$handle->push_write ("request 1\015\012");	714	$handle->push_write ("request 1\015\012");
594		715
595	# we expect "ERROR" or "OK" as response, so push a line read	716	# we expect "ERROR" or "OK" as response, so push a line read
596	$handle->push_read (line => sub {	717	$handle->push_read (line => sub {
597	# if we got an "OK", we have to _prepend_ another line,	718	# if we got an "OK", we have to _prepend_ another line,
…		…
604	...	725	...
605	});	726	});
606	}	727	}
607	});	728	});
608		729
609	# request two	730	# request two, simply returns 64 octets
610	$handle->push_write ("request 2\015\012");	731	$handle->push_write ("request 2\015\012");
611		732
612	# simply read 64 bytes, always	733	# simply read 64 bytes, always
613	$handle->push_read (chunk => 64, sub {	734	$handle->push_read (chunk => 64, sub {
614	my $response = $_[1];	735	my $response = $_[1];
…		…
620	=cut	741	=cut
621		742
622	sub _drain_rbuf {	743	sub _drain_rbuf {
623	my ($self) = @_;	744	my ($self) = @_;
624		745
		746	local $self->{_in_drain} = 1;
		747
625	if (	748	if (
626	defined $self->{rbuf_max}	749	defined $self->{rbuf_max}
627	&& $self->{rbuf_max} < length $self->{rbuf}	750	&& $self->{rbuf_max} < length $self->{rbuf}
628	) {	751	) {
629	return $self->_error (&Errno::ENOSPC, 1);	752	$self->_error (&Errno::ENOSPC, 1), return;
630	}	753	}
631		754
632	return if $self->{in_drain};	755	while () {
633	local $self->{in_drain} = 1;
634
635	while (my $len = length $self->{rbuf}) {	756	my $len = length $self->{rbuf};
636	no strict 'refs';	757
637	if (my $cb = shift @{ $self->{_queue} }) {	758	if (my $cb = shift @{ $self->{_queue} }) {
638	unless ($cb->($self)) {	759	unless ($cb->($self)) {
639	if ($self->{_eof}) {	760	if ($self->{_eof}) {
640	# no progress can be made (not enough data and no data forthcoming)	761	# no progress can be made (not enough data and no data forthcoming)
641	return $self->_error (&Errno::EPIPE, 1);	762	$self->_error (&Errno::EPIPE, 1), return;
642	}	763	}
643		764
644	unshift @{ $self->{_queue} }, $cb;	765	unshift @{ $self->{_queue} }, $cb;
645	last;	766	last;
646	}	767	}
647	} elsif ($self->{on_read}) {	768	} elsif ($self->{on_read}) {
		769	last unless $len;
		770
648	$self->{on_read}($self);	771	$self->{on_read}($self);
649		772
650	if (	773	if (
651	$len == length $self->{rbuf} # if no data has been consumed	774	$len == length $self->{rbuf} # if no data has been consumed
652	&& !@{ $self->{_queue} } # and the queue is still empty	775	&& !@{ $self->{_queue} } # and the queue is still empty
653	&& $self->{on_read} # but we still have on_read	776	&& $self->{on_read} # but we still have on_read
654	) {	777	) {
655	# no further data will arrive	778	# no further data will arrive
656	# so no progress can be made	779	# so no progress can be made
657	return $self->_error (&Errno::EPIPE, 1)	780	$self->_error (&Errno::EPIPE, 1), return
658	if $self->{_eof};	781	if $self->{_eof};
659		782
660	last; # more data might arrive	783	last; # more data might arrive
661	}	784	}
662	} else {	785	} else {
…		…
664	delete $self->{_rw};	787	delete $self->{_rw};
665	last;	788	last;
666	}	789	}
667	}	790	}
668		791
		792	if ($self->{_eof}) {
		793	if ($self->{on_eof}) {
669	$self->{on_eof}($self)	794	$self->{on_eof}($self)
670	if $self->{_eof} && $self->{on_eof};	795	} else {
		796	$self->_error (0, 1);
		797	}
		798	}
671		799
672	# may need to restart read watcher	800	# may need to restart read watcher
673	unless ($self->{_rw}) {	801	unless ($self->{_rw}) {
674	$self->start_read	802	$self->start_read
675	if $self->{on_read} \|\| @{ $self->{_queue} };	803	if $self->{on_read} \|\| @{ $self->{_queue} };
…		…
686		814
687	sub on_read {	815	sub on_read {
688	my ($self, $cb) = @_;	816	my ($self, $cb) = @_;
689		817
690	$self->{on_read} = $cb;	818	$self->{on_read} = $cb;
		819	$self->_drain_rbuf if $cb && !$self->{_in_drain};
691	}	820	}
692		821
693	=item $handle->rbuf	822	=item $handle->rbuf
694		823
695	Returns the read buffer (as a modifiable lvalue).	824	Returns the read buffer (as a modifiable lvalue).
…		…
744	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	873	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
745	->($self, $cb, @_);	874	->($self, $cb, @_);
746	}	875	}
747		876
748	push @{ $self->{_queue} }, $cb;	877	push @{ $self->{_queue} }, $cb;
749	$self->_drain_rbuf;	878	$self->_drain_rbuf unless $self->{_in_drain};
750	}	879	}
751		880
752	sub unshift_read {	881	sub unshift_read {
753	my $self = shift;	882	my $self = shift;
754	my $cb = pop;	883	my $cb = pop;
…		…
760	->($self, $cb, @_);	889	->($self, $cb, @_);
761	}	890	}
762		891
763		892
764	unshift @{ $self->{_queue} }, $cb;	893	unshift @{ $self->{_queue} }, $cb;
765	$self->_drain_rbuf;	894	$self->_drain_rbuf unless $self->{_in_drain};
766	}	895	}
767		896
768	=item $handle->push_read (type => @args, $cb)	897	=item $handle->push_read (type => @args, $cb)
769		898
770	=item $handle->unshift_read (type => @args, $cb)	899	=item $handle->unshift_read (type => @args, $cb)
…		…
800	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");	929	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");
801	1	930	1
802	}	931	}
803	};	932	};
804		933
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)	934	=item line => [$eol, ]$cb->($handle, $line, $eol)
815		935
816	The callback will be called only once a full line (including the end of	936	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	937	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	938	marker) will be passed to the callback as second argument (C<$line>), and
…		…
833	=cut	953	=cut
834		954
835	register_read_type line => sub {	955	register_read_type line => sub {
836	my ($self, $cb, $eol) = @_;	956	my ($self, $cb, $eol) = @_;
837		957
838	$eol = qr\|(\015?\012)\| if @_ < 3;	958	if (@_ < 3) {
839	$eol = quotemeta $eol unless ref $eol;	959	# this is more than twice as fast as the generic code below
840	$eol = qr\|^(.*?)($eol)\|s;
841
842	sub {	960	sub {
843	$_[0]{rbuf} =~ s/$eol// or return;	961	$_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return;
844		962
845	$cb->($_[0], $1, $2);	963	$cb->($_[0], $1, $2);
846	1
847	}
848	};
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
861	=item netstring => $cb->($handle, $string)
862
863	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
864
865	Throws an error with C<$!> set to EBADMSG on format violations.
866
867	=cut
868
869	register_read_type netstring => sub {
870	my ($self, $cb) = @_;
871
872	sub {
873	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
874	if ($_[0]{rbuf} =~ /[^0-9]/) {
875	$self->_error (&Errno::EBADMSG);
876	}	964	1
877	return;
878	}	965	}
		966	} else {
		967	$eol = quotemeta $eol unless ref $eol;
		968	$eol = qr\|^(.*?)($eol)\|s;
879		969
880	my $len = $1;	970	sub {
		971	$_[0]{rbuf} =~ s/$eol// or return;
881		972
882	$self->unshift_read (chunk => $len, sub {	973	$cb->($_[0], $1, $2);
883	my $string = $_[1];
884	$_[0]->unshift_read (chunk => 1, sub {
885	if ($_[1] eq ",") {
886	$cb->($_[0], $string);
887	} else {
888	$self->_error (&Errno::EBADMSG);
889	}
890	});	974	1
891	});	975	}
892
893	1
894	}	976	}
895	};	977	};
896		978
897	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)	979	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
898		980
…		…
962		1044
963	()	1045	()
964	}	1046	}
965	};	1047	};
966		1048
		1049	=item netstring => $cb->($handle, $string)
		1050
		1051	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
		1052
		1053	Throws an error with C<$!> set to EBADMSG on format violations.
		1054
		1055	=cut
		1056
		1057	register_read_type netstring => sub {
		1058	my ($self, $cb) = @_;
		1059
		1060	sub {
		1061	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
		1062	if ($_[0]{rbuf} =~ /[^0-9]/) {
		1063	$self->_error (&Errno::EBADMSG);
		1064	}
		1065	return;
		1066	}
		1067
		1068	my $len = $1;
		1069
		1070	$self->unshift_read (chunk => $len, sub {
		1071	my $string = $_[1];
		1072	$_[0]->unshift_read (chunk => 1, sub {
		1073	if ($_[1] eq ",") {
		1074	$cb->($_[0], $string);
		1075	} else {
		1076	$self->_error (&Errno::EBADMSG);
		1077	}
		1078	});
		1079	});
		1080
		1081	1
		1082	}
		1083	};
		1084
		1085	=item packstring => $format, $cb->($handle, $string)
		1086
		1087	An octet string prefixed with an encoded length. The encoding C<$format>
		1088	uses the same format as a Perl C<pack> format, but must specify a single
		1089	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
		1090	optional C<!>, C<< < >> or C<< > >> modifier).
		1091
		1092	DNS over TCP uses a prefix of C<n>, EPP uses a prefix of C<N>.
		1093
		1094	Example: read a block of data prefixed by its length in BER-encoded
		1095	format (very efficient).
		1096
		1097	$handle->push_read (packstring => "w", sub {
		1098	my ($handle, $data) = @_;
		1099	});
		1100
		1101	=cut
		1102
		1103	register_read_type packstring => sub {
		1104	my ($self, $cb, $format) = @_;
		1105
		1106	sub {
		1107	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
		1108	defined (my $len = eval { unpack $format, $_[0]{rbuf} })
		1109	or return;
		1110
		1111	$format = length pack $format, $len;
		1112
		1113	# bypass unshift if we already have the remaining chunk
		1114	if ($format + $len <= length $_[0]{rbuf}) {
		1115	my $data = substr $_[0]{rbuf}, $format, $len;
		1116	substr $_[0]{rbuf}, 0, $format + $len, "";
		1117	$cb->($_[0], $data);
		1118	} else {
		1119	# remove prefix
		1120	substr $_[0]{rbuf}, 0, $format, "";
		1121
		1122	# read remaining chunk
		1123	$_[0]->unshift_read (chunk => $len, $cb);
		1124	}
		1125
		1126	1
		1127	}
		1128	};
		1129
967	=item json => $cb->($handle, $hash_or_arrayref)	1130	=item json => $cb->($handle, $hash_or_arrayref)
968		1131
969	Reads a JSON object or array, decodes it and passes it to the callback.	1132	Reads a JSON object or array, decodes it and passes it to the callback.
970		1133
971	If a C<json> object was passed to the constructor, then that will be used	1134	If a C<json> object was passed to the constructor, then that will be used
…		…
981	the C<json> write type description, above, for an actual example.	1144	the C<json> write type description, above, for an actual example.
982		1145
983	=cut	1146	=cut
984		1147
985	register_read_type json => sub {	1148	register_read_type json => sub {
986	my ($self, $cb, $accept, $reject, $skip) = @_;	1149	my ($self, $cb) = @_;
987		1150
988	require JSON;	1151	require JSON;
989		1152
990	my $data;	1153	my $data;
991	my $rbuf = \$self->{rbuf};	1154	my $rbuf = \$self->{rbuf};
…		…
1006	()	1169	()
1007	}	1170	}
1008	}	1171	}
1009	};	1172	};
1010		1173
		1174	=item storable => $cb->($handle, $ref)
		1175
		1176	Deserialises a L<Storable> frozen representation as written by the
		1177	C<storable> write type (BER-encoded length prefix followed by nfreeze'd
		1178	data).
		1179
		1180	Raises C<EBADMSG> error if the data could not be decoded.
		1181
		1182	=cut
		1183
		1184	register_read_type storable => sub {
		1185	my ($self, $cb) = @_;
		1186
		1187	require Storable;
		1188
		1189	sub {
		1190	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
		1191	defined (my $len = eval { unpack "w", $_[0]{rbuf} })
		1192	or return;
		1193
		1194	my $format = length pack "w", $len;
		1195
		1196	# bypass unshift if we already have the remaining chunk
		1197	if ($format + $len <= length $_[0]{rbuf}) {
		1198	my $data = substr $_[0]{rbuf}, $format, $len;
		1199	substr $_[0]{rbuf}, 0, $format + $len, "";
		1200	$cb->($_[0], Storable::thaw ($data));
		1201	} else {
		1202	# remove prefix
		1203	substr $_[0]{rbuf}, 0, $format, "";
		1204
		1205	# read remaining chunk
		1206	$_[0]->unshift_read (chunk => $len, sub {
		1207	if (my $ref = eval { Storable::thaw ($_[1]) }) {
		1208	$cb->($_[0], $ref);
		1209	} else {
		1210	$self->_error (&Errno::EBADMSG);
		1211	}
		1212	});
		1213	}
		1214
		1215	1
		1216	}
		1217	};
		1218
1011	=back	1219	=back
1012		1220
1013	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)	1221	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)
1014		1222
1015	This function (not method) lets you add your own types to C<push_read>.	1223	This function (not method) lets you add your own types to C<push_read>.
…		…
1033	=item $handle->stop_read	1241	=item $handle->stop_read
1034		1242
1035	=item $handle->start_read	1243	=item $handle->start_read
1036		1244
1037	In rare cases you actually do not want to read anything from the	1245	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	1246	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	1247	any queued callbacks will be executed then. To start reading again, call
1040	C<start_read>.	1248	C<start_read>.
1041		1249
1042	Note that AnyEvent::Handle will automatically C<start_read> for you when	1250	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	1251	you change the C<on_read> callback or push/unshift a read callback, and it
…		…
1065	if ($len > 0) {	1273	if ($len > 0) {
1066	$self->{_activity} = AnyEvent->now;	1274	$self->{_activity} = AnyEvent->now;
1067		1275
1068	$self->{filter_r}	1276	$self->{filter_r}
1069	? $self->{filter_r}($self, $rbuf)	1277	? $self->{filter_r}($self, $rbuf)
1070	: $self->_drain_rbuf;	1278	: $self->{_in_drain} \|\| $self->_drain_rbuf;
1071		1279
1072	} elsif (defined $len) {	1280	} elsif (defined $len) {
1073	delete $self->{_rw};	1281	delete $self->{_rw};
1074	$self->{_eof} = 1;	1282	$self->{_eof} = 1;
1075	$self->_drain_rbuf;	1283	$self->_drain_rbuf unless $self->{_in_drain};
1076		1284
1077	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1285	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1078	return $self->_error ($!, 1);	1286	return $self->_error ($!, 1);
1079	}	1287	}
1080	});	1288	});
…		…
1098	}	1306	}
1099		1307
1100	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {	1308	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {
1101	if (length $buf) {	1309	if (length $buf) {
1102	$self->{rbuf} .= $buf;	1310	$self->{rbuf} .= $buf;
1103	$self->_drain_rbuf;	1311	$self->_drain_rbuf unless $self->{_in_drain};
1104	} else {	1312	} else {
1105	# let's treat SSL-eof as we treat normal EOF	1313	# let's treat SSL-eof as we treat normal EOF
1106	$self->{_eof} = 1;	1314	$self->{_eof} = 1;
1107	$self->_shutdown;	1315	$self->_shutdown;
1108	return;	1316	return;
…		…
1200		1408
1201	sub DESTROY {	1409	sub DESTROY {
1202	my $self = shift;	1410	my $self = shift;
1203		1411
1204	$self->stoptls;	1412	$self->stoptls;
		1413
		1414	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
		1415
		1416	if ($linger && length $self->{wbuf}) {
		1417	my $fh = delete $self->{fh};
		1418	my $wbuf = delete $self->{wbuf};
		1419
		1420	my @linger;
		1421
		1422	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {
		1423	my $len = syswrite $fh, $wbuf, length $wbuf;
		1424
		1425	if ($len > 0) {
		1426	substr $wbuf, 0, $len, "";
		1427	} else {
		1428	@linger = (); # end
		1429	}
		1430	});
		1431	push @linger, AnyEvent->timer (after => $linger, cb => sub {
		1432	@linger = ();
		1433	});
		1434	}
1205	}	1435	}
1206		1436
1207	=item AnyEvent::Handle::TLS_CTX	1437	=item AnyEvent::Handle::TLS_CTX
1208		1438
1209	This function creates and returns the Net::SSLeay::CTX object used by	1439	This function creates and returns the Net::SSLeay::CTX object used by
…		…
1251	=over 4	1481	=over 4
1252		1482
1253	=item * all constructor arguments become object members.	1483	=item * all constructor arguments become object members.
1254		1484
1255	At least initially, when you pass a C<tls>-argument to the constructor it	1485	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	1486	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).	1487	mutated later on (for example C<tls> will hold the TLS connection object).
1258		1488
1259	=item * other object member names are prefixed with an C<_>.	1489	=item * other object member names are prefixed with an C<_>.
1260		1490
1261	All object members not explicitly documented (internal use) are prefixed	1491	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.57 by root, Wed Jun 4 11:45:21 2008 UTC vs. Revision 1.85 by root, Thu Aug 21 19:53:19 2008 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.57 by root, Wed Jun 4 11:45:21 2008 UTC vs.
Revision 1.85 by root, Thu Aug 21 19:53:19 2008 UTC