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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.40 by root, Tue May 27 05:36:27 2008 UTC vs.
Revision 1.64 by root, Fri Jun 6 11:01:17 2008 UTC

…		…
2		2
3	no warnings;	3	no warnings;
4	use strict;	4	use strict;
5		5
6	use AnyEvent ();	6	use AnyEvent ();
7	use AnyEvent::Util qw(WSAWOULDBLOCK);	7	use AnyEvent::Util qw(WSAEWOULDBLOCK);
8	use Scalar::Util ();	8	use Scalar::Util ();
9	use Carp ();	9	use Carp ();
10	use Fcntl ();	10	use Fcntl ();
11	use Errno qw/EAGAIN EINTR/;	11	use Errno qw(EAGAIN EINTR);
12		12
13	=head1 NAME	13	=head1 NAME
14		14
15	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent	15	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent
16		16
17	=cut	17	=cut
18		18
19	our $VERSION = '0.04';	19	our $VERSION = 4.15;
20		20
21	=head1 SYNOPSIS	21	=head1 SYNOPSIS
22		22
23	use AnyEvent;	23	use AnyEvent;
24	use AnyEvent::Handle;	24	use AnyEvent::Handle;
…		…
75	NOTE: The filehandle will be set to non-blocking (using	75	NOTE: The filehandle will be set to non-blocking (using
76	AnyEvent::Util::fh_nonblocking).	76	AnyEvent::Util::fh_nonblocking).
77		77
78	=item on_eof => $cb->($handle)	78	=item on_eof => $cb->($handle)
79		79
80	Set the callback to be called on EOF.	80	Set the callback to be called when an end-of-file condition is detcted,
		81	i.e. in the case of a socket, when the other side has closed the
		82	connection cleanly.
81		83
82	While not mandatory, it is highly recommended to set an eof callback,	84	While not mandatory, it is highly recommended to set an eof callback,
83	otherwise you might end up with a closed socket while you are still	85	otherwise you might end up with a closed socket while you are still
84	waiting for data.	86	waiting for data.
85		87
86	=item on_error => $cb->($handle)	88	=item on_error => $cb->($handle, $fatal)
87		89
88	This is the fatal error callback, that is called when, well, a fatal error	90	This is the error callback, which is called when, well, some error
89	occurs, such as not being able to resolve the hostname, failure to connect	91	occured, such as not being able to resolve the hostname, failure to
90	or a read error.	92	connect or a read error.
91		93
92	The object will not be in a usable state when this callback has been	94	Some errors are fatal (which is indicated by C<$fatal> being true). On
93	called.	95	fatal errors the handle object will be shut down and will not be
		96	usable. Non-fatal errors can be retried by simply returning, but it is
		97	recommended to simply ignore this parameter and instead abondon the handle
		98	object when this callback is invoked.
94		99
95	On callback entrance, the value of C<$!> contains the operating system	100	On callback entrance, the value of C<$!> contains the operating system
96	error (or C<ENOSPC>, C<EPIPE> or C<EBADMSG>).	101	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).
97
98	The callback should throw an exception. If it returns, then
99	AnyEvent::Handle will C<croak> for you.
100		102
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	=item timeout => $fractional_seconds
		130
		131	If non-zero, then this enables an "inactivity" timeout: whenever this many
		132	seconds pass without a successful read or write on the underlying file
		133	handle, the C<on_timeout> callback will be invoked (and if that one is
		134	missing, an C<ETIMEDOUT> error will be raised).
		135
		136	Note that timeout processing is also active when you currently do not have
		137	any outstanding read or write requests: If you plan to keep the connection
		138	idle then you should disable the timout temporarily or ignore the timeout
		139	in the C<on_timeout> callback.
		140
		141	Zero (the default) disables this timeout.
		142
		143	=item on_timeout => $cb->($handle)
		144
		145	Called whenever the inactivity timeout passes. If you return from this
		146	callback, then the timeout will be reset as if some activity had happened,
		147	so this condition is not fatal in any way.
124		148
125	=item rbuf_max => <bytes>	149	=item rbuf_max => <bytes>
126		150
127	If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)	151	If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)
128	when the read buffer ever (strictly) exceeds this size. This is useful to	152	when the read buffer ever (strictly) exceeds this size. This is useful to
…		…
135	isn't finished).	159	isn't finished).
136		160
137	=item read_size => <bytes>	161	=item read_size => <bytes>
138		162
139	The default read block size (the amount of bytes this module will try to read	163	The default read block size (the amount of bytes this module will try to read
140	on each [loop iteration). Default: C<4096>.	164	during each (loop iteration). Default: C<8192>.
141		165
142	=item low_water_mark => <bytes>	166	=item low_water_mark => <bytes>
143		167
144	Sets the amount of bytes (default: C<0>) that make up an "empty" write	168	Sets the amount of bytes (default: C<0>) that make up an "empty" write
145	buffer: If the write reaches this size or gets even samller it is	169	buffer: If the write reaches this size or gets even samller it is
146	considered empty.	170	considered empty.
		171
		172	=item linger => <seconds>
		173
		174	If non-zero (default: C<3600>), then the destructor of the
		175	AnyEvent::Handle object will check wether there is still outstanding write
		176	data and will install a watcher that will write out this data. No errors
		177	will be reported (this mostly matches how the operating system treats
		178	outstanding data at socket close time).
		179
		180	This will not work for partial TLS data that could not yet been
		181	encoded. This data will be lost.
147		182
148	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	183	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
149		184
150	When this parameter is given, it enables TLS (SSL) mode, that means it	185	When this parameter is given, it enables TLS (SSL) mode, that means it
151	will start making tls handshake and will transparently encrypt/decrypt	186	will start making tls handshake and will transparently encrypt/decrypt
…		…
172		207
173	=item json => JSON or JSON::XS object	208	=item json => JSON or JSON::XS object
174		209
175	This is the json coder object used by the C<json> read and write types.	210	This is the json coder object used by the C<json> read and write types.
176		211
177	If you don't supply it, then AnyEvent::Handle will use C<encode_json> and	212	If you don't supply it, then AnyEvent::Handle will create and use a
178	C<decode_json>.	213	suitable one, which will write and expect UTF-8 encoded JSON texts.
179		214
180	Note that you are responsible to depend on the JSON module if you want to	215	Note that you are responsible to depend on the JSON module if you want to
181	use this functionality, as AnyEvent does not have a dependency itself.	216	use this functionality, as AnyEvent does not have a dependency itself.
182		217
183	=item filter_r => $cb	218	=item filter_r => $cb
…		…
202	if ($self->{tls}) {	237	if ($self->{tls}) {
203	require Net::SSLeay;	238	require Net::SSLeay;
204	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});	239	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});
205	}	240	}
206		241
207	$self->on_eof (delete $self->{on_eof} ) if $self->{on_eof};	242	$self->{_activity} = AnyEvent->now;
208	$self->on_error (delete $self->{on_error}) if $self->{on_error};	243	$self->_timeout;
		244
209	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	245	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
210	$self->on_read (delete $self->{on_read} ) if $self->{on_read};
211
212	$self->start_read;
213		246
214	$self	247	$self
215	}	248	}
216		249
217	sub _shutdown {	250	sub _shutdown {
218	my ($self) = @_;	251	my ($self) = @_;
219		252
		253	delete $self->{_tw};
220	delete $self->{_rw};	254	delete $self->{_rw};
221	delete $self->{_ww};	255	delete $self->{_ww};
222	delete $self->{fh};	256	delete $self->{fh};
223	}
224		257
		258	$self->stoptls;
		259	}
		260
225	sub error {	261	sub _error {
226	my ($self) = @_;	262	my ($self, $errno, $fatal) = @_;
227		263
228	{
229	local $!;
230	$self->_shutdown;	264	$self->_shutdown
231	}	265	if $fatal;
232		266
233	$self->{on_error}($self)	267	$! = $errno;
		268
234	if $self->{on_error};	269	if ($self->{on_error}) {
235		270	$self->{on_error}($self, $fatal);
		271	} else {
236	Carp::croak "AnyEvent::Handle uncaught fatal error: $!";	272	Carp::croak "AnyEvent::Handle uncaught error: $!";
		273	}
237	}	274	}
238		275
239	=item $fh = $handle->fh	276	=item $fh = $handle->fh
240		277
241	This method returns the file handle of the L<AnyEvent::Handle> object.	278	This method returns the file handle of the L<AnyEvent::Handle> object.
…		…
260		297
261	=cut	298	=cut
262		299
263	sub on_eof {	300	sub on_eof {
264	$_[0]{on_eof} = $_[1];	301	$_[0]{on_eof} = $_[1];
		302	}
		303
		304	=item $handle->on_timeout ($cb)
		305
		306	Replace the current C<on_timeout> callback, or disables the callback
		307	(but not the timeout) if C<$cb> = C<undef>. See C<timeout> constructor
		308	argument.
		309
		310	=cut
		311
		312	sub on_timeout {
		313	$_[0]{on_timeout} = $_[1];
		314	}
		315
		316	#############################################################################
		317
		318	=item $handle->timeout ($seconds)
		319
		320	Configures (or disables) the inactivity timeout.
		321
		322	=cut
		323
		324	sub timeout {
		325	my ($self, $timeout) = @_;
		326
		327	$self->{timeout} = $timeout;
		328	$self->_timeout;
		329	}
		330
		331	# reset the timeout watcher, as neccessary
		332	# also check for time-outs
		333	sub _timeout {
		334	my ($self) = @_;
		335
		336	if ($self->{timeout}) {
		337	my $NOW = AnyEvent->now;
		338
		339	# when would the timeout trigger?
		340	my $after = $self->{_activity} + $self->{timeout} - $NOW;
		341
		342	# now or in the past already?
		343	if ($after <= 0) {
		344	$self->{_activity} = $NOW;
		345
		346	if ($self->{on_timeout}) {
		347	$self->{on_timeout}($self);
		348	} else {
		349	$self->_error (&Errno::ETIMEDOUT);
		350	}
		351
		352	# callback could have changed timeout value, optimise
		353	return unless $self->{timeout};
		354
		355	# calculate new after
		356	$after = $self->{timeout};
		357	}
		358
		359	Scalar::Util::weaken $self;
		360	return unless $self; # ->error could have destroyed $self
		361
		362	$self->{_tw} \|\|= AnyEvent->timer (after => $after, cb => sub {
		363	delete $self->{_tw};
		364	$self->_timeout;
		365	});
		366	} else {
		367	delete $self->{_tw};
		368	}
265	}	369	}
266		370
267	#############################################################################	371	#############################################################################
268		372
269	=back	373	=back
…		…
316	my $len = syswrite $self->{fh}, $self->{wbuf};	420	my $len = syswrite $self->{fh}, $self->{wbuf};
317		421
318	if ($len >= 0) {	422	if ($len >= 0) {
319	substr $self->{wbuf}, 0, $len, "";	423	substr $self->{wbuf}, 0, $len, "";
320		424
		425	$self->{_activity} = AnyEvent->now;
		426
321	$self->{on_drain}($self)	427	$self->{on_drain}($self)
322	if $self->{low_water_mark} >= length $self->{wbuf}	428	if $self->{low_water_mark} >= length $self->{wbuf}
323	&& $self->{on_drain};	429	&& $self->{on_drain};
324		430
325	delete $self->{_ww} unless length $self->{wbuf};	431	delete $self->{_ww} unless length $self->{wbuf};
326	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAWOULDBLOCK) {	432	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
327	$self->error;	433	$self->_error ($!, 1);
328	}	434	}
329	};	435	};
330		436
331	# try to write data immediately	437	# try to write data immediately
332	$cb->();	438	$cb->();
…		…
352	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	458	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")
353	->($self, @_);	459	->($self, @_);
354	}	460	}
355		461
356	if ($self->{filter_w}) {	462	if ($self->{filter_w}) {
357	$self->{filter_w}->($self, \$_[0]);	463	$self->{filter_w}($self, \$_[0]);
358	} else {	464	} else {
359	$self->{wbuf} .= $_[0];	465	$self->{wbuf} .= $_[0];
360	$self->_drain_wbuf;	466	$self->_drain_wbuf;
361	}	467	}
362	}	468	}
363		469
364	=item $handle->push_write (type => @args)	470	=item $handle->push_write (type => @args)
365		471
366	=item $handle->unshift_write (type => @args)
367
368	Instead of formatting your data yourself, you can also let this module do	472	Instead of formatting your data yourself, you can also let this module do
369	the job by specifying a type and type-specific arguments.	473	the job by specifying a type and type-specific arguments.
370		474
371	Predefined types are (if you have ideas for additional types, feel free to	475	Predefined types are (if you have ideas for additional types, feel free to
372	drop by and tell us):	476	drop by and tell us):
…		…
376	=item netstring => $string	480	=item netstring => $string
377		481
378	Formats the given value as netstring	482	Formats the given value as netstring
379	(http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them).	483	(http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them).
380		484
381	=back
382
383	=cut	485	=cut
384		486
385	register_write_type netstring => sub {	487	register_write_type netstring => sub {
386	my ($self, $string) = @_;	488	my ($self, $string) = @_;
387		489
388	sprintf "%d:%s,", (length $string), $string	490	sprintf "%d:%s,", (length $string), $string
		491	};
		492
		493	=item packstring => $format, $data
		494
		495	An octet string prefixed with an encoded length. The encoding C<$format>
		496	uses the same format as a Perl C<pack> format, but must specify a single
		497	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
		498	optional C<!>, C<< < >> or C<< > >> modifier).
		499
		500	=cut
		501
		502	register_write_type packstring => sub {
		503	my ($self, $format, $string) = @_;
		504
		505	pack "$format/a", $string
389	};	506	};
390		507
391	=item json => $array_or_hashref	508	=item json => $array_or_hashref
392		509
393	Encodes the given hash or array reference into a JSON object. Unless you	510	Encodes the given hash or array reference into a JSON object. Unless you
…		…
396		513
397	JSON objects (and arrays) are self-delimiting, so you can write JSON at	514	JSON objects (and arrays) are self-delimiting, so you can write JSON at
398	one end of a handle and read them at the other end without using any	515	one end of a handle and read them at the other end without using any
399	additional framing.	516	additional framing.
400		517
		518	The generated JSON text is guaranteed not to contain any newlines: While
		519	this module doesn't need delimiters after or between JSON texts to be
		520	able to read them, many other languages depend on that.
		521
		522	A simple RPC protocol that interoperates easily with others is to send
		523	JSON arrays (or objects, although arrays are usually the better choice as
		524	they mimic how function argument passing works) and a newline after each
		525	JSON text:
		526
		527	$handle->push_write (json => ["method", "arg1", "arg2"]); # whatever
		528	$handle->push_write ("\012");
		529
		530	An AnyEvent::Handle receiver would simply use the C<json> read type and
		531	rely on the fact that the newline will be skipped as leading whitespace:
		532
		533	$handle->push_read (json => sub { my $array = $_[1]; ... });
		534
		535	Other languages could read single lines terminated by a newline and pass
		536	this line into their JSON decoder of choice.
		537
401	=cut	538	=cut
402		539
403	register_write_type json => sub {	540	register_write_type json => sub {
404	my ($self, $ref) = @_;	541	my ($self, $ref) = @_;
405		542
406	require JSON;	543	require JSON;
407		544
408	$self->{json} ? $self->{json}->encode ($ref)	545	$self->{json} ? $self->{json}->encode ($ref)
409	: JSON::encode_json ($ref)	546	: JSON::encode_json ($ref)
410	};	547	};
		548
		549	=item storable => $reference
		550
		551	Freezes the given reference using L<Storable> and writes it to the
		552	handle. Uses the C<nfreeze> format.
		553
		554	=cut
		555
		556	register_write_type storable => sub {
		557	my ($self, $ref) = @_;
		558
		559	require Storable;
		560
		561	pack "w/a", Storable::nfreeze ($ref)
		562	};
		563
		564	=back
411		565
412	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	566	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
413		567
414	This function (not method) lets you add your own types to C<push_write>.	568	This function (not method) lets you add your own types to C<push_write>.
415	Whenever the given C<type> is used, C<push_write> will invoke the code	569	Whenever the given C<type> is used, C<push_write> will invoke the code
…		…
441	enough is there) from the read buffer (C<< $handle->rbuf >>) if you want	595	enough is there) from the read buffer (C<< $handle->rbuf >>) if you want
442	or not.	596	or not.
443		597
444	In the more complex case, you want to queue multiple callbacks. In this	598	In the more complex case, you want to queue multiple callbacks. In this
445	case, AnyEvent::Handle will call the first queued callback each time new	599	case, AnyEvent::Handle will call the first queued callback each time new
446	data arrives and removes it when it has done its job (see C<push_read>,	600	data arrives (also the first time it is queued) and removes it when it has
447	below).	601	done its job (see C<push_read>, below).
448		602
449	This way you can, for example, push three line-reads, followed by reading	603	This way you can, for example, push three line-reads, followed by reading
450	a chunk of data, and AnyEvent::Handle will execute them in order.	604	a chunk of data, and AnyEvent::Handle will execute them in order.
451		605
452	Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by	606	Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by
453	the specified number of bytes which give an XML datagram.	607	the specified number of bytes which give an XML datagram.
454		608
455	# in the default state, expect some header bytes	609	# in the default state, expect some header bytes
456	$handle->on_read (sub {	610	$handle->on_read (sub {
457	# some data is here, now queue the length-header-read (4 octets)	611	# some data is here, now queue the length-header-read (4 octets)
458	shift->unshift_read_chunk (4, sub {	612	shift->unshift_read (chunk => 4, sub {
459	# header arrived, decode	613	# header arrived, decode
460	my $len = unpack "N", $_[1];	614	my $len = unpack "N", $_[1];
461		615
462	# now read the payload	616	# now read the payload
463	shift->unshift_read_chunk ($len, sub {	617	shift->unshift_read (chunk => $len, sub {
464	my $xml = $_[1];	618	my $xml = $_[1];
465	# handle xml	619	# handle xml
466	});	620	});
467	});	621	});
468	});	622	});
…		…
475		629
476	# request one	630	# request one
477	$handle->push_write ("request 1\015\012");	631	$handle->push_write ("request 1\015\012");
478		632
479	# we expect "ERROR" or "OK" as response, so push a line read	633	# we expect "ERROR" or "OK" as response, so push a line read
480	$handle->push_read_line (sub {	634	$handle->push_read (line => sub {
481	# if we got an "OK", we have to _prepend_ another line,	635	# if we got an "OK", we have to _prepend_ another line,
482	# so it will be read before the second request reads its 64 bytes	636	# so it will be read before the second request reads its 64 bytes
483	# which are already in the queue when this callback is called	637	# which are already in the queue when this callback is called
484	# we don't do this in case we got an error	638	# we don't do this in case we got an error
485	if ($_[1] eq "OK") {	639	if ($_[1] eq "OK") {
486	$_[0]->unshift_read_line (sub {	640	$_[0]->unshift_read (line => sub {
487	my $response = $_[1];	641	my $response = $_[1];
488	...	642	...
489	});	643	});
490	}	644	}
491	});	645	});
492		646
493	# request two	647	# request two
494	$handle->push_write ("request 2\015\012");	648	$handle->push_write ("request 2\015\012");
495		649
496	# simply read 64 bytes, always	650	# simply read 64 bytes, always
497	$handle->push_read_chunk (64, sub {	651	$handle->push_read (chunk => 64, sub {
498	my $response = $_[1];	652	my $response = $_[1];
499	...	653	...
500	});	654	});
501		655
502	=over 4	656	=over 4
503		657
504	=cut	658	=cut
505		659
506	sub _drain_rbuf {	660	sub _drain_rbuf {
507	my ($self) = @_;	661	my ($self) = @_;
		662
		663	local $self->{_in_drain} = 1;
508		664
509	if (	665	if (
510	defined $self->{rbuf_max}	666	defined $self->{rbuf_max}
511	&& $self->{rbuf_max} < length $self->{rbuf}	667	&& $self->{rbuf_max} < length $self->{rbuf}
512	) {	668	) {
513	$! = &Errno::ENOSPC;	669	return $self->_error (&Errno::ENOSPC, 1);
514	$self->error;
515	}	670	}
516		671
517	return if $self->{in_drain};	672	while () {
518	local $self->{in_drain} = 1;
519
520	while (my $len = length $self->{rbuf}) {
521	no strict 'refs';	673	no strict 'refs';
		674
		675	my $len = length $self->{rbuf};
		676
522	if (my $cb = shift @{ $self->{_queue} }) {	677	if (my $cb = shift @{ $self->{_queue} }) {
523	unless ($cb->($self)) {	678	unless ($cb->($self)) {
524	if ($self->{_eof}) {	679	if ($self->{_eof}) {
525	# no progress can be made (not enough data and no data forthcoming)	680	# no progress can be made (not enough data and no data forthcoming)
526	$! = &Errno::EPIPE;	681	$self->_error (&Errno::EPIPE, 1), last;
527	$self->error;
528	}	682	}
529		683
530	unshift @{ $self->{_queue} }, $cb;	684	unshift @{ $self->{_queue} }, $cb;
531	return;	685	last;
532	}	686	}
533	} elsif ($self->{on_read}) {	687	} elsif ($self->{on_read}) {
		688	last unless $len;
		689
534	$self->{on_read}($self);	690	$self->{on_read}($self);
535		691
536	if (	692	if (
537	$self->{_eof} # if no further data will arrive
538	&& $len == length $self->{rbuf} # and no data has been consumed	693	$len == length $self->{rbuf} # if no data has been consumed
539	&& !@{ $self->{_queue} } # and the queue is still empty	694	&& !@{ $self->{_queue} } # and the queue is still empty
540	&& $self->{on_read} # and we still want to read data	695	&& $self->{on_read} # but we still have on_read
541	) {	696	) {
		697	# no further data will arrive
542	# then no progress can be made	698	# so no progress can be made
543	$! = &Errno::EPIPE;	699	$self->_error (&Errno::EPIPE, 1), last
544	$self->error;	700	if $self->{_eof};
		701
		702	last; # more data might arrive
545	}	703	}
546	} else {	704	} else {
547	# read side becomes idle	705	# read side becomes idle
548	delete $self->{_rw};	706	delete $self->{_rw};
549	return;	707	last;
550	}	708	}
551	}	709	}
552		710
553	if ($self->{_eof}) {
554	$self->_shutdown;
555	$self->{on_eof}($self)	711	$self->{on_eof}($self)
556	if $self->{on_eof};	712	if $self->{_eof} && $self->{on_eof};
		713
		714	# may need to restart read watcher
		715	unless ($self->{_rw}) {
		716	$self->start_read
		717	if $self->{on_read} \|\| @{ $self->{_queue} };
557	}	718	}
558	}	719	}
559		720
560	=item $handle->on_read ($cb)	721	=item $handle->on_read ($cb)
561		722
…		…
567		728
568	sub on_read {	729	sub on_read {
569	my ($self, $cb) = @_;	730	my ($self, $cb) = @_;
570		731
571	$self->{on_read} = $cb;	732	$self->{on_read} = $cb;
		733	$self->_drain_rbuf if $cb && !$self->{_in_drain};
572	}	734	}
573		735
574	=item $handle->rbuf	736	=item $handle->rbuf
575		737
576	Returns the read buffer (as a modifiable lvalue).	738	Returns the read buffer (as a modifiable lvalue).
…		…
625	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	787	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
626	->($self, $cb, @_);	788	->($self, $cb, @_);
627	}	789	}
628		790
629	push @{ $self->{_queue} }, $cb;	791	push @{ $self->{_queue} }, $cb;
630	$self->_drain_rbuf;	792	$self->_drain_rbuf unless $self->{_in_drain};
631	}	793	}
632		794
633	sub unshift_read {	795	sub unshift_read {
634	my $self = shift;	796	my $self = shift;
635	my $cb = pop;	797	my $cb = pop;
…		…
641	->($self, $cb, @_);	803	->($self, $cb, @_);
642	}	804	}
643		805
644		806
645	unshift @{ $self->{_queue} }, $cb;	807	unshift @{ $self->{_queue} }, $cb;
646	$self->_drain_rbuf;	808	$self->_drain_rbuf unless $self->{_in_drain};
647	}	809	}
648		810
649	=item $handle->push_read (type => @args, $cb)	811	=item $handle->push_read (type => @args, $cb)
650		812
651	=item $handle->unshift_read (type => @args, $cb)	813	=item $handle->unshift_read (type => @args, $cb)
…		…
736		898
737	sub unshift_read_line {	899	sub unshift_read_line {
738	my $self = shift;	900	my $self = shift;
739	$self->unshift_read (line => @_);	901	$self->unshift_read (line => @_);
740	}	902	}
741
742	=item netstring => $cb->($handle, $string)
743
744	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
745
746	Throws an error with C<$!> set to EBADMSG on format violations.
747
748	=cut
749
750	register_read_type netstring => sub {
751	my ($self, $cb) = @_;
752
753	sub {
754	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
755	if ($_[0]{rbuf} =~ /[^0-9]/) {
756	$! = &Errno::EBADMSG;
757	$self->error;
758	}
759	return;
760	}
761
762	my $len = $1;
763
764	$self->unshift_read (chunk => $len, sub {
765	my $string = $_[1];
766	$_[0]->unshift_read (chunk => 1, sub {
767	if ($_[1] eq ",") {
768	$cb->($_[0], $string);
769	} else {
770	$! = &Errno::EBADMSG;
771	$self->error;
772	}
773	});
774	});
775
776	1
777	}
778	};
779		903
780	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)	904	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
781		905
782	Makes a regex match against the regex object C<$accept> and returns	906	Makes a regex match against the regex object C<$accept> and returns
783	everything up to and including the match.	907	everything up to and including the match.
…		…
833	return 1;	957	return 1;
834	}	958	}
835		959
836	# reject	960	# reject
837	if ($reject && $$rbuf =~ $reject) {	961	if ($reject && $$rbuf =~ $reject) {
838	$! = &Errno::EBADMSG;	962	$self->_error (&Errno::EBADMSG);
839	$self->error;
840	}	963	}
841		964
842	# skip	965	# skip
843	if ($skip && $$rbuf =~ $skip) {	966	if ($skip && $$rbuf =~ $skip) {
844	$data .= substr $$rbuf, 0, $+[0], "";	967	$data .= substr $$rbuf, 0, $+[0], "";
…		…
846		969
847	()	970	()
848	}	971	}
849	};	972	};
850		973
		974	=item netstring => $cb->($handle, $string)
		975
		976	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
		977
		978	Throws an error with C<$!> set to EBADMSG on format violations.
		979
		980	=cut
		981
		982	register_read_type netstring => sub {
		983	my ($self, $cb) = @_;
		984
		985	sub {
		986	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
		987	if ($_[0]{rbuf} =~ /[^0-9]/) {
		988	$self->_error (&Errno::EBADMSG);
		989	}
		990	return;
		991	}
		992
		993	my $len = $1;
		994
		995	$self->unshift_read (chunk => $len, sub {
		996	my $string = $_[1];
		997	$_[0]->unshift_read (chunk => 1, sub {
		998	if ($_[1] eq ",") {
		999	$cb->($_[0], $string);
		1000	} else {
		1001	$self->_error (&Errno::EBADMSG);
		1002	}
		1003	});
		1004	});
		1005
		1006	1
		1007	}
		1008	};
		1009
		1010	=item packstring => $format, $cb->($handle, $string)
		1011
		1012	An octet string prefixed with an encoded length. The encoding C<$format>
		1013	uses the same format as a Perl C<pack> format, but must specify a single
		1014	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
		1015	optional C<!>, C<< < >> or C<< > >> modifier).
		1016
		1017	DNS over TCP uses a prefix of C<n>, EPP uses a prefix of C<N>.
		1018
		1019	Example: read a block of data prefixed by its length in BER-encoded
		1020	format (very efficient).
		1021
		1022	$handle->push_read (packstring => "w", sub {
		1023	my ($handle, $data) = @_;
		1024	});
		1025
		1026	=cut
		1027
		1028	register_read_type packstring => sub {
		1029	my ($self, $cb, $format) = @_;
		1030
		1031	sub {
		1032	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
		1033	defined (my $len = eval { unpack $format, $_[0]->{rbuf} })
		1034	or return;
		1035
		1036	# remove prefix
		1037	substr $_[0]->{rbuf}, 0, (length pack $format, $len), "";
		1038
		1039	# read rest
		1040	$_[0]->unshift_read (chunk => $len, $cb);
		1041
		1042	1
		1043	}
		1044	};
		1045
851	=item json => $cb->($handle, $hash_or_arrayref)	1046	=item json => $cb->($handle, $hash_or_arrayref)
852		1047
853	Reads a JSON object or array, decodes it and passes it to the callback.	1048	Reads a JSON object or array, decodes it and passes it to the callback.
854		1049
855	If a C<json> object was passed to the constructor, then that will be used	1050	If a C<json> object was passed to the constructor, then that will be used
…		…
859	2.09 (and JSON::XS version 2.2) and above. You have to provide a	1054	2.09 (and JSON::XS version 2.2) and above. You have to provide a
860	dependency on your own: this module will load the JSON module, but	1055	dependency on your own: this module will load the JSON module, but
861	AnyEvent does not depend on it itself.	1056	AnyEvent does not depend on it itself.
862		1057
863	Since JSON texts are fully self-delimiting, the C<json> read and write	1058	Since JSON texts are fully self-delimiting, the C<json> read and write
864	types are an ideal simple RPC protocol: just exchange JSON datagrams.	1059	types are an ideal simple RPC protocol: just exchange JSON datagrams. See
		1060	the C<json> write type description, above, for an actual example.
865		1061
866	=cut	1062	=cut
867		1063
868	register_read_type json => sub {	1064	register_read_type json => sub {
869	my ($self, $cb, $accept, $reject, $skip) = @_;	1065	my ($self, $cb) = @_;
870		1066
871	require JSON;	1067	require JSON;
872		1068
873	my $data;	1069	my $data;
874	my $rbuf = \$self->{rbuf};	1070	my $rbuf = \$self->{rbuf};
875		1071
876	my $json = $self->{json} \|\|= JSON::XS->new->utf8;	1072	my $json = $self->{json} \|\|= JSON->new->utf8;
877		1073
878	sub {	1074	sub {
879	my $ref = $json->incr_parse ($self->{rbuf});	1075	my $ref = $json->incr_parse ($self->{rbuf});
880		1076
881	if ($ref) {	1077	if ($ref) {
…		…
889	()	1085	()
890	}	1086	}
891	}	1087	}
892	};	1088	};
893		1089
		1090	=item storable => $cb->($handle, $ref)
		1091
		1092	Deserialises a L<Storable> frozen representation as written by the
		1093	C<storable> write type (BER-encoded length prefix followed by nfreeze'd
		1094	data).
		1095
		1096	Raises C<EBADMSG> error if the data could not be decoded.
		1097
		1098	=cut
		1099
		1100	register_read_type storable => sub {
		1101	my ($self, $cb) = @_;
		1102
		1103	require Storable;
		1104
		1105	sub {
		1106	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
		1107	defined (my $len = eval { unpack "w", $_[0]->{rbuf} })
		1108	or return;
		1109
		1110	# remove prefix
		1111	substr $_[0]->{rbuf}, 0, (length pack "w", $len), "";
		1112
		1113	# read rest
		1114	$_[0]->unshift_read (chunk => $len, sub {
		1115	if (my $ref = eval { Storable::thaw ($_[1]) }) {
		1116	$cb->($_[0], $ref);
		1117	} else {
		1118	$self->_error (&Errno::EBADMSG);
		1119	}
		1120	});
		1121	}
		1122	};
		1123
894	=back	1124	=back
895		1125
896	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)	1126	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)
897		1127
898	This function (not method) lets you add your own types to C<push_read>.	1128	This function (not method) lets you add your own types to C<push_read>.
…		…
916	=item $handle->stop_read	1146	=item $handle->stop_read
917		1147
918	=item $handle->start_read	1148	=item $handle->start_read
919		1149
920	In rare cases you actually do not want to read anything from the	1150	In rare cases you actually do not want to read anything from the
921	socket. In this case you can call C<stop_read>. Neither C<on_read> no	1151	socket. In this case you can call C<stop_read>. Neither C<on_read> nor
922	any queued callbacks will be executed then. To start reading again, call	1152	any queued callbacks will be executed then. To start reading again, call
923	C<start_read>.	1153	C<start_read>.
		1154
		1155	Note that AnyEvent::Handle will automatically C<start_read> for you when
		1156	you change the C<on_read> callback or push/unshift a read callback, and it
		1157	will automatically C<stop_read> for you when neither C<on_read> is set nor
		1158	there are any read requests in the queue.
924		1159
925	=cut	1160	=cut
926		1161
927	sub stop_read {	1162	sub stop_read {
928	my ($self) = @_;	1163	my ($self) = @_;
…		…
939	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1174	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
940	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1175	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};
941	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;	1176	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;
942		1177
943	if ($len > 0) {	1178	if ($len > 0) {
		1179	$self->{_activity} = AnyEvent->now;
		1180
944	$self->{filter_r}	1181	$self->{filter_r}
945	? $self->{filter_r}->($self, $rbuf)	1182	? $self->{filter_r}($self, $rbuf)
946	: $self->_drain_rbuf;	1183	: $self->{_in_drain} \|\| $self->_drain_rbuf;
947		1184
948	} elsif (defined $len) {	1185	} elsif (defined $len) {
949	delete $self->{_rw};	1186	delete $self->{_rw};
950	$self->{_eof} = 1;	1187	$self->{_eof} = 1;
951	$self->_drain_rbuf;	1188	$self->_drain_rbuf unless $self->{_in_drain};
952		1189
953	} elsif ($! != EAGAIN && $! != EINTR && $! != &AnyEvent::Util::WSAWOULDBLOCK) {	1190	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
954	return $self->error;	1191	return $self->_error ($!, 1);
955	}	1192	}
956	});	1193	});
957	}	1194	}
958	}	1195	}
959		1196
960	sub _dotls {	1197	sub _dotls {
961	my ($self) = @_;	1198	my ($self) = @_;
		1199
		1200	my $buf;
962		1201
963	if (length $self->{_tls_wbuf}) {	1202	if (length $self->{_tls_wbuf}) {
964	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1203	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
965	substr $self->{_tls_wbuf}, 0, $len, "";	1204	substr $self->{_tls_wbuf}, 0, $len, "";
966	}	1205	}
967	}	1206	}
968		1207
969	if (defined (my $buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1208	if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {
970	$self->{wbuf} .= $buf;	1209	$self->{wbuf} .= $buf;
971	$self->_drain_wbuf;	1210	$self->_drain_wbuf;
972	}	1211	}
973		1212
974	while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) {	1213	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {
		1214	if (length $buf) {
975	$self->{rbuf} .= $buf;	1215	$self->{rbuf} .= $buf;
976	$self->_drain_rbuf;	1216	$self->_drain_rbuf unless $self->{_in_drain};
		1217	} else {
		1218	# let's treat SSL-eof as we treat normal EOF
		1219	$self->{_eof} = 1;
		1220	$self->_shutdown;
		1221	return;
		1222	}
977	}	1223	}
978		1224
979	my $err = Net::SSLeay::get_error ($self->{tls}, -1);	1225	my $err = Net::SSLeay::get_error ($self->{tls}, -1);
980		1226
981	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {	1227	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
982	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {	1228	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {
983	$self->error;	1229	return $self->_error ($!, 1);
984	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {	1230	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {
985	$! = &Errno::EIO;	1231	return $self->_error (&Errno::EIO, 1);
986	$self->error;
987	}	1232	}
988		1233
989	# all others are fine for our purposes	1234	# all others are fine for our purposes
990	}	1235	}
991	}	1236	}
…		…
1006	call and can be used or changed to your liking. Note that the handshake	1251	call and can be used or changed to your liking. Note that the handshake
1007	might have already started when this function returns.	1252	might have already started when this function returns.
1008		1253
1009	=cut	1254	=cut
1010		1255
1011	# TODO: maybe document...
1012	sub starttls {	1256	sub starttls {
1013	my ($self, $ssl, $ctx) = @_;	1257	my ($self, $ssl, $ctx) = @_;
1014		1258
1015	$self->stoptls;	1259	$self->stoptls;
1016		1260
…		…
1069		1313
1070	sub DESTROY {	1314	sub DESTROY {
1071	my $self = shift;	1315	my $self = shift;
1072		1316
1073	$self->stoptls;	1317	$self->stoptls;
		1318
		1319	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
		1320
		1321	if ($linger && length $self->{wbuf}) {
		1322	my $fh = delete $self->{fh};
		1323	my $wbuf = delete $self->{wbuf};
		1324
		1325	my @linger;
		1326
		1327	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {
		1328	my $len = syswrite $fh, $wbuf, length $wbuf;
		1329
		1330	if ($len > 0) {
		1331	substr $wbuf, 0, $len, "";
		1332	} else {
		1333	@linger = (); # end
		1334	}
		1335	});
		1336	push @linger, AnyEvent->timer (after => $linger, cb => sub {
		1337	@linger = ();
		1338	});
		1339	}
1074	}	1340	}
1075		1341
1076	=item AnyEvent::Handle::TLS_CTX	1342	=item AnyEvent::Handle::TLS_CTX
1077		1343
1078	This function creates and returns the Net::SSLeay::CTX object used by	1344	This function creates and returns the Net::SSLeay::CTX object used by

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.40 by root, Tue May 27 05:36:27 2008 UTC vs. Revision 1.64 by root, Fri Jun 6 11:01:17 2008 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.40 by root, Tue May 27 05:36:27 2008 UTC vs.
Revision 1.64 by root, Fri Jun 6 11:01:17 2008 UTC