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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.46 by root, Thu May 29 00:22:36 2008 UTC vs.
Revision 1.79 by root, Sun Jul 27 08:37:56 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 = '0.04';	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 on EOF.	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
		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
…		…
119		123
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.
		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.
124		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
…		…
152	be configured to accept only so-and-so much data that it cannot act on	162	be configured to accept only so-and-so much data that it cannot act on
153	(for example, when expecting a line, an attacker could send an unlimited	163	(for example, when expecting a line, an attacker could send an unlimited
154	amount of data without a callback ever being called as long as the line	164	amount of data without a callback ever being called as long as the line
155	isn't finished).	165	isn't finished).
156		166
		167	=item autocork => <boolean>
		168
		169	When disabled (the default), then C<push_write> will try to immediately
		170	write the data to the handle if possible. This avoids having to register
		171	a write watcher and wait for the next event loop iteration, but can be
		172	inefficient if you write multiple small chunks (this disadvantage is
		173	usually avoided by your kernel's nagle algorithm, see C<low_delay>).
		174
		175	When enabled, then writes will always be queued till the next event loop
		176	iteration. This is efficient when you do many small writes per iteration,
		177	but less efficient when you do a single write only.
		178
		179	=item no_delay => <boolean>
		180
		181	When doing small writes on sockets, your operating system kernel might
		182	wait a bit for more data before actually sending it out. This is called
		183	the Nagle algorithm, and usually it is beneficial.
		184
		185	In some situations you want as low a delay as possible, which cna be
		186	accomplishd by setting this option to true.
		187
		188	The default is your opertaing system's default behaviour, this option
		189	explicitly enables or disables it, if possible.
		190
157	=item read_size => <bytes>	191	=item read_size => <bytes>
158		192
159	The default read block size (the amount of bytes this module will try to read	193	The default read block size (the amount of bytes this module will try to read
160	during each (loop iteration). Default: C<8192>.	194	during each (loop iteration). Default: C<8192>.
161		195
162	=item low_water_mark => <bytes>	196	=item low_water_mark => <bytes>
163		197
164	Sets the amount of bytes (default: C<0>) that make up an "empty" write	198	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	199	buffer: If the write reaches this size or gets even samller it is
166	considered empty.	200	considered empty.
		201
		202	=item linger => <seconds>
		203
		204	If non-zero (default: C<3600>), then the destructor of the
		205	AnyEvent::Handle object will check wether there is still outstanding write
		206	data and will install a watcher that will write out this data. No errors
		207	will be reported (this mostly matches how the operating system treats
		208	outstanding data at socket close time).
		209
		210	This will not work for partial TLS data that could not yet been
		211	encoded. This data will be lost.
167		212
168	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	213	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
169		214
170	When this parameter is given, it enables TLS (SSL) mode, that means it	215	When this parameter is given, it enables TLS (SSL) mode, that means it
171	will start making tls handshake and will transparently encrypt/decrypt	216	will start making tls handshake and will transparently encrypt/decrypt
…		…
180	You can also provide your own TLS connection object, but you have	225	You can also provide your own TLS connection object, but you have
181	to make sure that you call either C<Net::SSLeay::set_connect_state>	226	to make sure that you call either C<Net::SSLeay::set_connect_state>
182	or C<Net::SSLeay::set_accept_state> on it before you pass it to	227	or C<Net::SSLeay::set_accept_state> on it before you pass it to
183	AnyEvent::Handle.	228	AnyEvent::Handle.
184		229
185	See the C<starttls> method if you need to start TLs negotiation later.	230	See the C<starttls> method if you need to start TLS negotiation later.
186		231
187	=item tls_ctx => $ssl_ctx	232	=item tls_ctx => $ssl_ctx
188		233
189	Use the given Net::SSLeay::CTX object to create the new TLS connection	234	Use the given Net::SSLeay::CTX object to create the new TLS connection
190	(unless a connection object was specified directly). If this parameter is	235	(unless a connection object was specified directly). If this parameter is
…		…
222	if ($self->{tls}) {	267	if ($self->{tls}) {
223	require Net::SSLeay;	268	require Net::SSLeay;
224	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});	269	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});
225	}	270	}
226		271
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;	272	$self->{_activity} = AnyEvent->now;
233	$self->_timeout;	273	$self->_timeout;
234		274
		275	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};
		276	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
		277
235	$self->start_read;	278	$self->start_read
		279	if $self->{on_read};
236		280
237	$self	281	$self
238	}	282	}
239		283
240	sub _shutdown {	284	sub _shutdown {
…		…
242		286
243	delete $self->{_tw};	287	delete $self->{_tw};
244	delete $self->{_rw};	288	delete $self->{_rw};
245	delete $self->{_ww};	289	delete $self->{_ww};
246	delete $self->{fh};	290	delete $self->{fh};
247	}
248		291
		292	$self->stoptls;
		293	}
		294
249	sub error {	295	sub _error {
250	my ($self) = @_;	296	my ($self, $errno, $fatal) = @_;
251		297
252	{
253	local $!;
254	$self->_shutdown;	298	$self->_shutdown
255	}	299	if $fatal;
256		300
257	$self->{on_error}($self)	301	$! = $errno;
		302
258	if $self->{on_error};	303	if ($self->{on_error}) {
259		304	$self->{on_error}($self, $fatal);
		305	} else {
260	Carp::croak "AnyEvent::Handle uncaught fatal error: $!";	306	Carp::croak "AnyEvent::Handle uncaught error: $!";
		307	}
261	}	308	}
262		309
263	=item $fh = $handle->fh	310	=item $fh = $handle->fh
264		311
265	This method returns the file handle of the L<AnyEvent::Handle> object.	312	This method returns the file handle of the L<AnyEvent::Handle> object.
…		…
296		343
297	=cut	344	=cut
298		345
299	sub on_timeout {	346	sub on_timeout {
300	$_[0]{on_timeout} = $_[1];	347	$_[0]{on_timeout} = $_[1];
		348	}
		349
		350	=item $handle->autocork ($boolean)
		351
		352	Enables or disables the current autocork behaviour (see C<autocork>
		353	constructor argument).
		354
		355	=cut
		356
		357	=item $handle->no_delay ($boolean)
		358
		359	Enables or disables the C<no_delay> setting (see constructor argument of
		360	the same name for details).
		361
		362	=cut
		363
		364	sub no_delay {
		365	$_[0]{no_delay} = $_[1];
		366
		367	eval {
		368	local $SIG{__DIE__};
		369	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];
		370	};
301	}	371	}
302		372
303	#############################################################################	373	#############################################################################
304		374
305	=item $handle->timeout ($seconds)	375	=item $handle->timeout ($seconds)
…		…
329	# now or in the past already?	399	# now or in the past already?
330	if ($after <= 0) {	400	if ($after <= 0) {
331	$self->{_activity} = $NOW;	401	$self->{_activity} = $NOW;
332		402
333	if ($self->{on_timeout}) {	403	if ($self->{on_timeout}) {
334	$self->{on_timeout}->($self);	404	$self->{on_timeout}($self);
335	} else {	405	} else {
336	$! = Errno::ETIMEDOUT;	406	$self->_error (&Errno::ETIMEDOUT);
337	$self->error;
338	}	407	}
339		408
340	# callbakx could have changed timeout value, optimise	409	# callback could have changed timeout value, optimise
341	return unless $self->{timeout};	410	return unless $self->{timeout};
342		411
343	# calculate new after	412	# calculate new after
344	$after = $self->{timeout};	413	$after = $self->{timeout};
345	}	414	}
346		415
347	Scalar::Util::weaken $self;	416	Scalar::Util::weaken $self;
		417	return unless $self; # ->error could have destroyed $self
348		418
349	$self->{_tw} \|\|= AnyEvent->timer (after => $after, cb => sub {	419	$self->{_tw} \|\|= AnyEvent->timer (after => $after, cb => sub {
350	delete $self->{_tw};	420	delete $self->{_tw};
351	$self->_timeout;	421	$self->_timeout;
352	});	422	});
…		…
415	if $self->{low_water_mark} >= length $self->{wbuf}	485	if $self->{low_water_mark} >= length $self->{wbuf}
416	&& $self->{on_drain};	486	&& $self->{on_drain};
417		487
418	delete $self->{_ww} unless length $self->{wbuf};	488	delete $self->{_ww} unless length $self->{wbuf};
419	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	489	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
420	$self->error;	490	$self->_error ($!, 1);
421	}	491	}
422	};	492	};
423		493
424	# try to write data immediately	494	# try to write data immediately
425	$cb->();	495	$cb->() unless $self->{autocork};
426		496
427	# if still data left in wbuf, we need to poll	497	# if still data left in wbuf, we need to poll
428	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	498	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)
429	if length $self->{wbuf};	499	if length $self->{wbuf};
430	};	500	};
…		…
445	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	515	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")
446	->($self, @_);	516	->($self, @_);
447	}	517	}
448		518
449	if ($self->{filter_w}) {	519	if ($self->{filter_w}) {
450	$self->{filter_w}->($self, \$_[0]);	520	$self->{filter_w}($self, \$_[0]);
451	} else {	521	} else {
452	$self->{wbuf} .= $_[0];	522	$self->{wbuf} .= $_[0];
453	$self->_drain_wbuf;	523	$self->_drain_wbuf;
454	}	524	}
455	}	525	}
456		526
457	=item $handle->push_write (type => @args)	527	=item $handle->push_write (type => @args)
458		528
459	=item $handle->unshift_write (type => @args)
460
461	Instead of formatting your data yourself, you can also let this module do	529	Instead of formatting your data yourself, you can also let this module do
462	the job by specifying a type and type-specific arguments.	530	the job by specifying a type and type-specific arguments.
463		531
464	Predefined types are (if you have ideas for additional types, feel free to	532	Predefined types are (if you have ideas for additional types, feel free to
465	drop by and tell us):	533	drop by and tell us):
…		…
469	=item netstring => $string	537	=item netstring => $string
470		538
471	Formats the given value as netstring	539	Formats the given value as netstring
472	(http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them).	540	(http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them).
473		541
474	=back
475
476	=cut	542	=cut
477		543
478	register_write_type netstring => sub {	544	register_write_type netstring => sub {
479	my ($self, $string) = @_;	545	my ($self, $string) = @_;
480		546
481	sprintf "%d:%s,", (length $string), $string	547	sprintf "%d:%s,", (length $string), $string
		548	};
		549
		550	=item packstring => $format, $data
		551
		552	An octet string prefixed with an encoded length. The encoding C<$format>
		553	uses the same format as a Perl C<pack> format, but must specify a single
		554	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
		555	optional C<!>, C<< < >> or C<< > >> modifier).
		556
		557	=cut
		558
		559	register_write_type packstring => sub {
		560	my ($self, $format, $string) = @_;
		561
		562	pack "$format/a*", $string
482	};	563	};
483		564
484	=item json => $array_or_hashref	565	=item json => $array_or_hashref
485		566
486	Encodes the given hash or array reference into a JSON object. Unless you	567	Encodes the given hash or array reference into a JSON object. Unless you
…		…
520		601
521	$self->{json} ? $self->{json}->encode ($ref)	602	$self->{json} ? $self->{json}->encode ($ref)
522	: JSON::encode_json ($ref)	603	: JSON::encode_json ($ref)
523	};	604	};
524		605
		606	=item storable => $reference
		607
		608	Freezes the given reference using L<Storable> and writes it to the
		609	handle. Uses the C<nfreeze> format.
		610
		611	=cut
		612
		613	register_write_type storable => sub {
		614	my ($self, $ref) = @_;
		615
		616	require Storable;
		617
		618	pack "w/a*", Storable::nfreeze ($ref)
		619	};
		620
		621	=back
		622
525	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	623	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
526		624
527	This function (not method) lets you add your own types to C<push_write>.	625	This function (not method) lets you add your own types to C<push_write>.
528	Whenever the given C<type> is used, C<push_write> will invoke the code	626	Whenever the given C<type> is used, C<push_write> will invoke the code
529	reference with the handle object and the remaining arguments.	627	reference with the handle object and the remaining arguments.
…		…
549	ways, the "simple" way, using only C<on_read> and the "complex" way, using	647	ways, the "simple" way, using only C<on_read> and the "complex" way, using
550	a queue.	648	a queue.
551		649
552	In the simple case, you just install an C<on_read> callback and whenever	650	In the simple case, you just install an C<on_read> callback and whenever
553	new data arrives, it will be called. You can then remove some data (if	651	new data arrives, it will be called. You can then remove some data (if
554	enough is there) from the read buffer (C<< $handle->rbuf >>) if you want	652	enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna
555	or not.	653	leave the data there if you want to accumulate more (e.g. when only a
		654	partial message has been received so far).
556		655
557	In the more complex case, you want to queue multiple callbacks. In this	656	In the more complex case, you want to queue multiple callbacks. In this
558	case, AnyEvent::Handle will call the first queued callback each time new	657	case, AnyEvent::Handle will call the first queued callback each time new
559	data arrives and removes it when it has done its job (see C<push_read>,	658	data arrives (also the first time it is queued) and removes it when it has
560	below).	659	done its job (see C<push_read>, below).
561		660
562	This way you can, for example, push three line-reads, followed by reading	661	This way you can, for example, push three line-reads, followed by reading
563	a chunk of data, and AnyEvent::Handle will execute them in order.	662	a chunk of data, and AnyEvent::Handle will execute them in order.
564		663
565	Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by	664	Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by
566	the specified number of bytes which give an XML datagram.	665	the specified number of bytes which give an XML datagram.
567		666
568	# in the default state, expect some header bytes	667	# in the default state, expect some header bytes
569	$handle->on_read (sub {	668	$handle->on_read (sub {
570	# some data is here, now queue the length-header-read (4 octets)	669	# some data is here, now queue the length-header-read (4 octets)
571	shift->unshift_read_chunk (4, sub {	670	shift->unshift_read (chunk => 4, sub {
572	# header arrived, decode	671	# header arrived, decode
573	my $len = unpack "N", $_[1];	672	my $len = unpack "N", $_[1];
574		673
575	# now read the payload	674	# now read the payload
576	shift->unshift_read_chunk ($len, sub {	675	shift->unshift_read (chunk => $len, sub {
577	my $xml = $_[1];	676	my $xml = $_[1];
578	# handle xml	677	# handle xml
579	});	678	});
580	});	679	});
581	});	680	});
582		681
583	Example 2: Implement a client for a protocol that replies either with	682	Example 2: Implement a client for a protocol that replies either with "OK"
584	"OK" and another line or "ERROR" for one request, and 64 bytes for the	683	and another line or "ERROR" for the first request that is sent, and 64
585	second request. Due tot he availability of a full queue, we can just	684	bytes for the second request. Due to the availability of a queue, we can
586	pipeline sending both requests and manipulate the queue as necessary in	685	just pipeline sending both requests and manipulate the queue as necessary
587	the callbacks:	686	in the callbacks.
588		687
589	# request one	688	When the first callback is called and sees an "OK" response, it will
		689	C<unshift> another line-read. This line-read will be queued I<before> the
		690	64-byte chunk callback.
		691
		692	# request one, returns either "OK + extra line" or "ERROR"
590	$handle->push_write ("request 1\015\012");	693	$handle->push_write ("request 1\015\012");
591		694
592	# we expect "ERROR" or "OK" as response, so push a line read	695	# we expect "ERROR" or "OK" as response, so push a line read
593	$handle->push_read_line (sub {	696	$handle->push_read (line => sub {
594	# if we got an "OK", we have to _prepend_ another line,	697	# if we got an "OK", we have to _prepend_ another line,
595	# so it will be read before the second request reads its 64 bytes	698	# so it will be read before the second request reads its 64 bytes
596	# which are already in the queue when this callback is called	699	# which are already in the queue when this callback is called
597	# we don't do this in case we got an error	700	# we don't do this in case we got an error
598	if ($_[1] eq "OK") {	701	if ($_[1] eq "OK") {
599	$_[0]->unshift_read_line (sub {	702	$_[0]->unshift_read (line => sub {
600	my $response = $_[1];	703	my $response = $_[1];
601	...	704	...
602	});	705	});
603	}	706	}
604	});	707	});
605		708
606	# request two	709	# request two, simply returns 64 octets
607	$handle->push_write ("request 2\015\012");	710	$handle->push_write ("request 2\015\012");
608		711
609	# simply read 64 bytes, always	712	# simply read 64 bytes, always
610	$handle->push_read_chunk (64, sub {	713	$handle->push_read (chunk => 64, sub {
611	my $response = $_[1];	714	my $response = $_[1];
612	...	715	...
613	});	716	});
614		717
615	=over 4	718	=over 4
616		719
617	=cut	720	=cut
618		721
619	sub _drain_rbuf {	722	sub _drain_rbuf {
620	my ($self) = @_;	723	my ($self) = @_;
		724
		725	local $self->{_in_drain} = 1;
621		726
622	if (	727	if (
623	defined $self->{rbuf_max}	728	defined $self->{rbuf_max}
624	&& $self->{rbuf_max} < length $self->{rbuf}	729	&& $self->{rbuf_max} < length $self->{rbuf}
625	) {	730	) {
626	$! = &Errno::ENOSPC;	731	return $self->_error (&Errno::ENOSPC, 1);
627	$self->error;
628	}	732	}
629		733
630	return if $self->{in_drain};	734	while () {
631	local $self->{in_drain} = 1;
632
633	while (my $len = length $self->{rbuf}) {	735	my $len = length $self->{rbuf};
634	no strict 'refs';	736
635	if (my $cb = shift @{ $self->{_queue} }) {	737	if (my $cb = shift @{ $self->{_queue} }) {
636	unless ($cb->($self)) {	738	unless ($cb->($self)) {
637	if ($self->{_eof}) {	739	if ($self->{_eof}) {
638	# no progress can be made (not enough data and no data forthcoming)	740	# no progress can be made (not enough data and no data forthcoming)
639	$! = &Errno::EPIPE;	741	$self->_error (&Errno::EPIPE, 1), last;
640	$self->error;
641	}	742	}
642		743
643	unshift @{ $self->{_queue} }, $cb;	744	unshift @{ $self->{_queue} }, $cb;
644	return;	745	last;
645	}	746	}
646	} elsif ($self->{on_read}) {	747	} elsif ($self->{on_read}) {
		748	last unless $len;
		749
647	$self->{on_read}($self);	750	$self->{on_read}($self);
648		751
649	if (	752	if (
650	$self->{_eof} # if no further data will arrive
651	&& $len == length $self->{rbuf} # and no data has been consumed	753	$len == length $self->{rbuf} # if no data has been consumed
652	&& !@{ $self->{_queue} } # and the queue is still empty	754	&& !@{ $self->{_queue} } # and the queue is still empty
653	&& $self->{on_read} # and we still want to read data	755	&& $self->{on_read} # but we still have on_read
654	) {	756	) {
		757	# no further data will arrive
655	# then no progress can be made	758	# so no progress can be made
656	$! = &Errno::EPIPE;	759	$self->_error (&Errno::EPIPE, 1), last
657	$self->error;	760	if $self->{_eof};
		761
		762	last; # more data might arrive
658	}	763	}
659	} else {	764	} else {
660	# read side becomes idle	765	# read side becomes idle
661	delete $self->{_rw};	766	delete $self->{_rw};
662	return;	767	last;
663	}	768	}
664	}	769	}
665		770
666	if ($self->{_eof}) {
667	$self->_shutdown;
668	$self->{on_eof}($self)	771	$self->{on_eof}($self)
669	if $self->{on_eof};	772	if $self->{_eof} && $self->{on_eof};
		773
		774	# may need to restart read watcher
		775	unless ($self->{_rw}) {
		776	$self->start_read
		777	if $self->{on_read} \|\| @{ $self->{_queue} };
670	}	778	}
671	}	779	}
672		780
673	=item $handle->on_read ($cb)	781	=item $handle->on_read ($cb)
674		782
…		…
680		788
681	sub on_read {	789	sub on_read {
682	my ($self, $cb) = @_;	790	my ($self, $cb) = @_;
683		791
684	$self->{on_read} = $cb;	792	$self->{on_read} = $cb;
		793	$self->_drain_rbuf if $cb && !$self->{_in_drain};
685	}	794	}
686		795
687	=item $handle->rbuf	796	=item $handle->rbuf
688		797
689	Returns the read buffer (as a modifiable lvalue).	798	Returns the read buffer (as a modifiable lvalue).
…		…
738	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	847	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
739	->($self, $cb, @_);	848	->($self, $cb, @_);
740	}	849	}
741		850
742	push @{ $self->{_queue} }, $cb;	851	push @{ $self->{_queue} }, $cb;
743	$self->_drain_rbuf;	852	$self->_drain_rbuf unless $self->{_in_drain};
744	}	853	}
745		854
746	sub unshift_read {	855	sub unshift_read {
747	my $self = shift;	856	my $self = shift;
748	my $cb = pop;	857	my $cb = pop;
…		…
754	->($self, $cb, @_);	863	->($self, $cb, @_);
755	}	864	}
756		865
757		866
758	unshift @{ $self->{_queue} }, $cb;	867	unshift @{ $self->{_queue} }, $cb;
759	$self->_drain_rbuf;	868	$self->_drain_rbuf unless $self->{_in_drain};
760	}	869	}
761		870
762	=item $handle->push_read (type => @args, $cb)	871	=item $handle->push_read (type => @args, $cb)
763		872
764	=item $handle->unshift_read (type => @args, $cb)	873	=item $handle->unshift_read (type => @args, $cb)
…		…
794	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");	903	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");
795	1	904	1
796	}	905	}
797	};	906	};
798		907
799	# compatibility with older API
800	sub push_read_chunk {
801	$_[0]->push_read (chunk => $_[1], $_[2]);
802	}
803
804	sub unshift_read_chunk {
805	$_[0]->unshift_read (chunk => $_[1], $_[2]);
806	}
807
808	=item line => [$eol, ]$cb->($handle, $line, $eol)	908	=item line => [$eol, ]$cb->($handle, $line, $eol)
809		909
810	The callback will be called only once a full line (including the end of	910	The callback will be called only once a full line (including the end of
811	line marker, C<$eol>) has been read. This line (excluding the end of line	911	line marker, C<$eol>) has been read. This line (excluding the end of line
812	marker) will be passed to the callback as second argument (C<$line>), and	912	marker) will be passed to the callback as second argument (C<$line>), and
…		…
827	=cut	927	=cut
828		928
829	register_read_type line => sub {	929	register_read_type line => sub {
830	my ($self, $cb, $eol) = @_;	930	my ($self, $cb, $eol) = @_;
831		931
832	$eol = qr\|(\015?\012)\| if @_ < 3;	932	if (@_ < 3) {
833	$eol = quotemeta $eol unless ref $eol;	933	# this is more than twice as fast as the generic code below
834	$eol = qr\|^(.*?)($eol)\|s;
835
836	sub {	934	sub {
837	$_[0]{rbuf} =~ s/$eol// or return;	935	$_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return;
838		936
839	$cb->($_[0], $1, $2);	937	$cb->($_[0], $1, $2);
840	1
841	}
842	};
843
844	# compatibility with older API
845	sub push_read_line {
846	my $self = shift;
847	$self->push_read (line => @_);
848	}
849
850	sub unshift_read_line {
851	my $self = shift;
852	$self->unshift_read (line => @_);
853	}
854
855	=item netstring => $cb->($handle, $string)
856
857	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
858
859	Throws an error with C<$!> set to EBADMSG on format violations.
860
861	=cut
862
863	register_read_type netstring => sub {
864	my ($self, $cb) = @_;
865
866	sub {
867	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
868	if ($_[0]{rbuf} =~ /[^0-9]/) {
869	$! = &Errno::EBADMSG;
870	$self->error;
871	}	938	1
872	return;
873	}	939	}
		940	} else {
		941	$eol = quotemeta $eol unless ref $eol;
		942	$eol = qr\|^(.*?)($eol)\|s;
874		943
875	my $len = $1;	944	sub {
		945	$_[0]{rbuf} =~ s/$eol// or return;
876		946
877	$self->unshift_read (chunk => $len, sub {	947	$cb->($_[0], $1, $2);
878	my $string = $_[1];
879	$_[0]->unshift_read (chunk => 1, sub {
880	if ($_[1] eq ",") {
881	$cb->($_[0], $string);
882	} else {
883	$! = &Errno::EBADMSG;
884	$self->error;
885	}
886	});	948	1
887	});	949	}
888
889	1
890	}	950	}
891	};	951	};
892		952
893	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)	953	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
894		954
…		…
946	return 1;	1006	return 1;
947	}	1007	}
948		1008
949	# reject	1009	# reject
950	if ($reject && $$rbuf =~ $reject) {	1010	if ($reject && $$rbuf =~ $reject) {
951	$! = &Errno::EBADMSG;	1011	$self->_error (&Errno::EBADMSG);
952	$self->error;
953	}	1012	}
954		1013
955	# skip	1014	# skip
956	if ($skip && $$rbuf =~ $skip) {	1015	if ($skip && $$rbuf =~ $skip) {
957	$data .= substr $$rbuf, 0, $+[0], "";	1016	$data .= substr $$rbuf, 0, $+[0], "";
…		…
959		1018
960	()	1019	()
961	}	1020	}
962	};	1021	};
963		1022
		1023	=item netstring => $cb->($handle, $string)
		1024
		1025	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
		1026
		1027	Throws an error with C<$!> set to EBADMSG on format violations.
		1028
		1029	=cut
		1030
		1031	register_read_type netstring => sub {
		1032	my ($self, $cb) = @_;
		1033
		1034	sub {
		1035	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
		1036	if ($_[0]{rbuf} =~ /[^0-9]/) {
		1037	$self->_error (&Errno::EBADMSG);
		1038	}
		1039	return;
		1040	}
		1041
		1042	my $len = $1;
		1043
		1044	$self->unshift_read (chunk => $len, sub {
		1045	my $string = $_[1];
		1046	$_[0]->unshift_read (chunk => 1, sub {
		1047	if ($_[1] eq ",") {
		1048	$cb->($_[0], $string);
		1049	} else {
		1050	$self->_error (&Errno::EBADMSG);
		1051	}
		1052	});
		1053	});
		1054
		1055	1
		1056	}
		1057	};
		1058
		1059	=item packstring => $format, $cb->($handle, $string)
		1060
		1061	An octet string prefixed with an encoded length. The encoding C<$format>
		1062	uses the same format as a Perl C<pack> format, but must specify a single
		1063	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
		1064	optional C<!>, C<< < >> or C<< > >> modifier).
		1065
		1066	DNS over TCP uses a prefix of C<n>, EPP uses a prefix of C<N>.
		1067
		1068	Example: read a block of data prefixed by its length in BER-encoded
		1069	format (very efficient).
		1070
		1071	$handle->push_read (packstring => "w", sub {
		1072	my ($handle, $data) = @_;
		1073	});
		1074
		1075	=cut
		1076
		1077	register_read_type packstring => sub {
		1078	my ($self, $cb, $format) = @_;
		1079
		1080	sub {
		1081	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
		1082	defined (my $len = eval { unpack $format, $_[0]{rbuf} })
		1083	or return;
		1084
		1085	$format = length pack $format, $len;
		1086
		1087	# bypass unshift if we already have the remaining chunk
		1088	if ($format + $len <= length $_[0]{rbuf}) {
		1089	my $data = substr $_[0]{rbuf}, $format, $len;
		1090	substr $_[0]{rbuf}, 0, $format + $len, "";
		1091	$cb->($_[0], $data);
		1092	} else {
		1093	# remove prefix
		1094	substr $_[0]{rbuf}, 0, $format, "";
		1095
		1096	# read remaining chunk
		1097	$_[0]->unshift_read (chunk => $len, $cb);
		1098	}
		1099
		1100	1
		1101	}
		1102	};
		1103
964	=item json => $cb->($handle, $hash_or_arrayref)	1104	=item json => $cb->($handle, $hash_or_arrayref)
965		1105
966	Reads a JSON object or array, decodes it and passes it to the callback.	1106	Reads a JSON object or array, decodes it and passes it to the callback.
967		1107
968	If a C<json> object was passed to the constructor, then that will be used	1108	If a C<json> object was passed to the constructor, then that will be used
…		…
978	the C<json> write type description, above, for an actual example.	1118	the C<json> write type description, above, for an actual example.
979		1119
980	=cut	1120	=cut
981		1121
982	register_read_type json => sub {	1122	register_read_type json => sub {
983	my ($self, $cb, $accept, $reject, $skip) = @_;	1123	my ($self, $cb) = @_;
984		1124
985	require JSON;	1125	require JSON;
986		1126
987	my $data;	1127	my $data;
988	my $rbuf = \$self->{rbuf};	1128	my $rbuf = \$self->{rbuf};
…		…
1003	()	1143	()
1004	}	1144	}
1005	}	1145	}
1006	};	1146	};
1007		1147
		1148	=item storable => $cb->($handle, $ref)
		1149
		1150	Deserialises a L<Storable> frozen representation as written by the
		1151	C<storable> write type (BER-encoded length prefix followed by nfreeze'd
		1152	data).
		1153
		1154	Raises C<EBADMSG> error if the data could not be decoded.
		1155
		1156	=cut
		1157
		1158	register_read_type storable => sub {
		1159	my ($self, $cb) = @_;
		1160
		1161	require Storable;
		1162
		1163	sub {
		1164	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
		1165	defined (my $len = eval { unpack "w", $_[0]{rbuf} })
		1166	or return;
		1167
		1168	my $format = length pack "w", $len;
		1169
		1170	# bypass unshift if we already have the remaining chunk
		1171	if ($format + $len <= length $_[0]{rbuf}) {
		1172	my $data = substr $_[0]{rbuf}, $format, $len;
		1173	substr $_[0]{rbuf}, 0, $format + $len, "";
		1174	$cb->($_[0], Storable::thaw ($data));
		1175	} else {
		1176	# remove prefix
		1177	substr $_[0]{rbuf}, 0, $format, "";
		1178
		1179	# read remaining chunk
		1180	$_[0]->unshift_read (chunk => $len, sub {
		1181	if (my $ref = eval { Storable::thaw ($_[1]) }) {
		1182	$cb->($_[0], $ref);
		1183	} else {
		1184	$self->_error (&Errno::EBADMSG);
		1185	}
		1186	});
		1187	}
		1188
		1189	1
		1190	}
		1191	};
		1192
1008	=back	1193	=back
1009		1194
1010	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)	1195	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)
1011		1196
1012	This function (not method) lets you add your own types to C<push_read>.	1197	This function (not method) lets you add your own types to C<push_read>.
…		…
1030	=item $handle->stop_read	1215	=item $handle->stop_read
1031		1216
1032	=item $handle->start_read	1217	=item $handle->start_read
1033		1218
1034	In rare cases you actually do not want to read anything from the	1219	In rare cases you actually do not want to read anything from the
1035	socket. In this case you can call C<stop_read>. Neither C<on_read> no	1220	socket. In this case you can call C<stop_read>. Neither C<on_read> nor
1036	any queued callbacks will be executed then. To start reading again, call	1221	any queued callbacks will be executed then. To start reading again, call
1037	C<start_read>.	1222	C<start_read>.
		1223
		1224	Note that AnyEvent::Handle will automatically C<start_read> for you when
		1225	you change the C<on_read> callback or push/unshift a read callback, and it
		1226	will automatically C<stop_read> for you when neither C<on_read> is set nor
		1227	there are any read requests in the queue.
1038		1228
1039	=cut	1229	=cut
1040		1230
1041	sub stop_read {	1231	sub stop_read {
1042	my ($self) = @_;	1232	my ($self) = @_;
…		…
1056		1246
1057	if ($len > 0) {	1247	if ($len > 0) {
1058	$self->{_activity} = AnyEvent->now;	1248	$self->{_activity} = AnyEvent->now;
1059		1249
1060	$self->{filter_r}	1250	$self->{filter_r}
1061	? $self->{filter_r}->($self, $rbuf)	1251	? $self->{filter_r}($self, $rbuf)
1062	: $self->_drain_rbuf;	1252	: $self->{_in_drain} \|\| $self->_drain_rbuf;
1063		1253
1064	} elsif (defined $len) {	1254	} elsif (defined $len) {
1065	delete $self->{_rw};	1255	delete $self->{_rw};
1066	delete $self->{_ww};
1067	delete $self->{_tw};
1068	$self->{_eof} = 1;	1256	$self->{_eof} = 1;
1069	$self->_drain_rbuf;	1257	$self->_drain_rbuf unless $self->{_in_drain};
1070		1258
1071	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1259	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1072	return $self->error;	1260	return $self->_error ($!, 1);
1073	}	1261	}
1074	});	1262	});
1075	}	1263	}
1076	}	1264	}
1077		1265
1078	sub _dotls {	1266	sub _dotls {
1079	my ($self) = @_;	1267	my ($self) = @_;
		1268
		1269	my $buf;
1080		1270
1081	if (length $self->{_tls_wbuf}) {	1271	if (length $self->{_tls_wbuf}) {
1082	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1272	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1083	substr $self->{_tls_wbuf}, 0, $len, "";	1273	substr $self->{_tls_wbuf}, 0, $len, "";
1084	}	1274	}
1085	}	1275	}
1086		1276
1087	if (defined (my $buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1277	if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1088	$self->{wbuf} .= $buf;	1278	$self->{wbuf} .= $buf;
1089	$self->_drain_wbuf;	1279	$self->_drain_wbuf;
1090	}	1280	}
1091		1281
1092	while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) {	1282	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {
		1283	if (length $buf) {
1093	$self->{rbuf} .= $buf;	1284	$self->{rbuf} .= $buf;
1094	$self->_drain_rbuf;	1285	$self->_drain_rbuf unless $self->{_in_drain};
		1286	} else {
		1287	# let's treat SSL-eof as we treat normal EOF
		1288	$self->{_eof} = 1;
		1289	$self->_shutdown;
		1290	return;
		1291	}
1095	}	1292	}
1096		1293
1097	my $err = Net::SSLeay::get_error ($self->{tls}, -1);	1294	my $err = Net::SSLeay::get_error ($self->{tls}, -1);
1098		1295
1099	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {	1296	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
1100	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {	1297	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {
1101	$self->error;	1298	return $self->_error ($!, 1);
1102	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {	1299	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {
1103	$! = &Errno::EIO;	1300	return $self->_error (&Errno::EIO, 1);
1104	$self->error;
1105	}	1301	}
1106		1302
1107	# all others are fine for our purposes	1303	# all others are fine for our purposes
1108	}	1304	}
1109	}	1305	}
…		…
1124	call and can be used or changed to your liking. Note that the handshake	1320	call and can be used or changed to your liking. Note that the handshake
1125	might have already started when this function returns.	1321	might have already started when this function returns.
1126		1322
1127	=cut	1323	=cut
1128		1324
1129	# TODO: maybe document...
1130	sub starttls {	1325	sub starttls {
1131	my ($self, $ssl, $ctx) = @_;	1326	my ($self, $ssl, $ctx) = @_;
1132		1327
1133	$self->stoptls;	1328	$self->stoptls;
1134		1329
…		…
1187		1382
1188	sub DESTROY {	1383	sub DESTROY {
1189	my $self = shift;	1384	my $self = shift;
1190		1385
1191	$self->stoptls;	1386	$self->stoptls;
		1387
		1388	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
		1389
		1390	if ($linger && length $self->{wbuf}) {
		1391	my $fh = delete $self->{fh};
		1392	my $wbuf = delete $self->{wbuf};
		1393
		1394	my @linger;
		1395
		1396	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {
		1397	my $len = syswrite $fh, $wbuf, length $wbuf;
		1398
		1399	if ($len > 0) {
		1400	substr $wbuf, 0, $len, "";
		1401	} else {
		1402	@linger = (); # end
		1403	}
		1404	});
		1405	push @linger, AnyEvent->timer (after => $linger, cb => sub {
		1406	@linger = ();
		1407	});
		1408	}
1192	}	1409	}
1193		1410
1194	=item AnyEvent::Handle::TLS_CTX	1411	=item AnyEvent::Handle::TLS_CTX
1195		1412
1196	This function creates and returns the Net::SSLeay::CTX object used by	1413	This function creates and returns the Net::SSLeay::CTX object used by
…		…
1238	=over 4	1455	=over 4
1239		1456
1240	=item * all constructor arguments become object members.	1457	=item * all constructor arguments become object members.
1241		1458
1242	At least initially, when you pass a C<tls>-argument to the constructor it	1459	At least initially, when you pass a C<tls>-argument to the constructor it
1243	will end up in C<< $handle->{tls} >>. Those members might be changes or	1460	will end up in C<< $handle->{tls} >>. Those members might be changed or
1244	mutated later on (for example C<tls> will hold the TLS connection object).	1461	mutated later on (for example C<tls> will hold the TLS connection object).
1245		1462
1246	=item * other object member names are prefixed with an C<_>.	1463	=item * other object member names are prefixed with an C<_>.
1247		1464
1248	All object members not explicitly documented (internal use) are prefixed	1465	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.46 by root, Thu May 29 00:22:36 2008 UTC vs. Revision 1.79 by root, Sun Jul 27 08:37:56 2008 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.46 by root, Thu May 29 00:22:36 2008 UTC vs.
Revision 1.79 by root, Sun Jul 27 08:37:56 2008 UTC