[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.61 by root, Fri Jun 6 10:23:50 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.14;
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
…		…
172		196
173	=item json => JSON or JSON::XS object	197	=item json => JSON or JSON::XS object
174		198
175	This is the json coder object used by the C<json> read and write types.	199	This is the json coder object used by the C<json> read and write types.
176		200
177	If you don't supply it, then AnyEvent::Handle will use C<encode_json> and	201	If you don't supply it, then AnyEvent::Handle will create and use a
178	C<decode_json>.	202	suitable one, which will write and expect UTF-8 encoded JSON texts.
179		203
180	Note that you are responsible to depend on the JSON module if you want to	204	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.	205	use this functionality, as AnyEvent does not have a dependency itself.
182		206
183	=item filter_r => $cb	207	=item filter_r => $cb
…		…
202	if ($self->{tls}) {	226	if ($self->{tls}) {
203	require Net::SSLeay;	227	require Net::SSLeay;
204	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});	228	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});
205	}	229	}
206		230
207	$self->on_eof (delete $self->{on_eof} ) if $self->{on_eof};	231	$self->{_activity} = AnyEvent->now;
208	$self->on_error (delete $self->{on_error}) if $self->{on_error};	232	$self->_timeout;
		233
209	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	234	$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		235
214	$self	236	$self
215	}	237	}
216		238
217	sub _shutdown {	239	sub _shutdown {
218	my ($self) = @_;	240	my ($self) = @_;
219		241
		242	delete $self->{_tw};
220	delete $self->{_rw};	243	delete $self->{_rw};
221	delete $self->{_ww};	244	delete $self->{_ww};
222	delete $self->{fh};	245	delete $self->{fh};
223	}
224		246
		247	$self->stoptls;
		248	}
		249
225	sub error {	250	sub _error {
226	my ($self) = @_;	251	my ($self, $errno, $fatal) = @_;
227		252
228	{
229	local $!;
230	$self->_shutdown;	253	$self->_shutdown
231	}	254	if $fatal;
232		255
233	$self->{on_error}($self)	256	$! = $errno;
		257
234	if $self->{on_error};	258	if ($self->{on_error}) {
235		259	$self->{on_error}($self, $fatal);
		260	} else {
236	Carp::croak "AnyEvent::Handle uncaught fatal error: $!";	261	Carp::croak "AnyEvent::Handle uncaught error: $!";
		262	}
237	}	263	}
238		264
239	=item $fh = $handle->fh	265	=item $fh = $handle->fh
240		266
241	This method returns the file handle of the L<AnyEvent::Handle> object.	267	This method returns the file handle of the L<AnyEvent::Handle> object.
…		…
260		286
261	=cut	287	=cut
262		288
263	sub on_eof {	289	sub on_eof {
264	$_[0]{on_eof} = $_[1];	290	$_[0]{on_eof} = $_[1];
		291	}
		292
		293	=item $handle->on_timeout ($cb)
		294
		295	Replace the current C<on_timeout> callback, or disables the callback
		296	(but not the timeout) if C<$cb> = C<undef>. See C<timeout> constructor
		297	argument.
		298
		299	=cut
		300
		301	sub on_timeout {
		302	$_[0]{on_timeout} = $_[1];
		303	}
		304
		305	#############################################################################
		306
		307	=item $handle->timeout ($seconds)
		308
		309	Configures (or disables) the inactivity timeout.
		310
		311	=cut
		312
		313	sub timeout {
		314	my ($self, $timeout) = @_;
		315
		316	$self->{timeout} = $timeout;
		317	$self->_timeout;
		318	}
		319
		320	# reset the timeout watcher, as neccessary
		321	# also check for time-outs
		322	sub _timeout {
		323	my ($self) = @_;
		324
		325	if ($self->{timeout}) {
		326	my $NOW = AnyEvent->now;
		327
		328	# when would the timeout trigger?
		329	my $after = $self->{_activity} + $self->{timeout} - $NOW;
		330
		331	# now or in the past already?
		332	if ($after <= 0) {
		333	$self->{_activity} = $NOW;
		334
		335	if ($self->{on_timeout}) {
		336	$self->{on_timeout}($self);
		337	} else {
		338	$self->_error (&Errno::ETIMEDOUT);
		339	}
		340
		341	# callback could have changed timeout value, optimise
		342	return unless $self->{timeout};
		343
		344	# calculate new after
		345	$after = $self->{timeout};
		346	}
		347
		348	Scalar::Util::weaken $self;
		349	return unless $self; # ->error could have destroyed $self
		350
		351	$self->{_tw} \|\|= AnyEvent->timer (after => $after, cb => sub {
		352	delete $self->{_tw};
		353	$self->_timeout;
		354	});
		355	} else {
		356	delete $self->{_tw};
		357	}
265	}	358	}
266		359
267	#############################################################################	360	#############################################################################
268		361
269	=back	362	=back
…		…
316	my $len = syswrite $self->{fh}, $self->{wbuf};	409	my $len = syswrite $self->{fh}, $self->{wbuf};
317		410
318	if ($len >= 0) {	411	if ($len >= 0) {
319	substr $self->{wbuf}, 0, $len, "";	412	substr $self->{wbuf}, 0, $len, "";
320		413
		414	$self->{_activity} = AnyEvent->now;
		415
321	$self->{on_drain}($self)	416	$self->{on_drain}($self)
322	if $self->{low_water_mark} >= length $self->{wbuf}	417	if $self->{low_water_mark} >= length $self->{wbuf}
323	&& $self->{on_drain};	418	&& $self->{on_drain};
324		419
325	delete $self->{_ww} unless length $self->{wbuf};	420	delete $self->{_ww} unless length $self->{wbuf};
326	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAWOULDBLOCK) {	421	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
327	$self->error;	422	$self->_error ($!, 1);
328	}	423	}
329	};	424	};
330		425
331	# try to write data immediately	426	# try to write data immediately
332	$cb->();	427	$cb->();
…		…
352	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	447	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")
353	->($self, @_);	448	->($self, @_);
354	}	449	}
355		450
356	if ($self->{filter_w}) {	451	if ($self->{filter_w}) {
357	$self->{filter_w}->($self, \$_[0]);	452	$self->{filter_w}($self, \$_[0]);
358	} else {	453	} else {
359	$self->{wbuf} .= $_[0];	454	$self->{wbuf} .= $_[0];
360	$self->_drain_wbuf;	455	$self->_drain_wbuf;
361	}	456	}
362	}	457	}
363		458
364	=item $handle->push_write (type => @args)	459	=item $handle->push_write (type => @args)
365		460
366	=item $handle->unshift_write (type => @args)
367
368	Instead of formatting your data yourself, you can also let this module do	461	Instead of formatting your data yourself, you can also let this module do
369	the job by specifying a type and type-specific arguments.	462	the job by specifying a type and type-specific arguments.
370		463
371	Predefined types are (if you have ideas for additional types, feel free to	464	Predefined types are (if you have ideas for additional types, feel free to
372	drop by and tell us):	465	drop by and tell us):
…		…
376	=item netstring => $string	469	=item netstring => $string
377		470
378	Formats the given value as netstring	471	Formats the given value as netstring
379	(http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them).	472	(http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them).
380		473
381	=back
382
383	=cut	474	=cut
384		475
385	register_write_type netstring => sub {	476	register_write_type netstring => sub {
386	my ($self, $string) = @_;	477	my ($self, $string) = @_;
387		478
388	sprintf "%d:%s,", (length $string), $string	479	sprintf "%d:%s,", (length $string), $string
		480	};
		481
		482	=item packstring => $format, $data
		483
		484	An octet string prefixed with an encoded length. The encoding C<$format>
		485	uses the same format as a Perl C<pack> format, but must specify a single
		486	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
		487	optional C<!>, C<< < >> or C<< > >> modifier).
		488
		489	=cut
		490
		491	register_write_type packstring => sub {
		492	my ($self, $format, $string) = @_;
		493
		494	pack "$format/a", $string
389	};	495	};
390		496
391	=item json => $array_or_hashref	497	=item json => $array_or_hashref
392		498
393	Encodes the given hash or array reference into a JSON object. Unless you	499	Encodes the given hash or array reference into a JSON object. Unless you
…		…
396		502
397	JSON objects (and arrays) are self-delimiting, so you can write JSON at	503	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	504	one end of a handle and read them at the other end without using any
399	additional framing.	505	additional framing.
400		506
		507	The generated JSON text is guaranteed not to contain any newlines: While
		508	this module doesn't need delimiters after or between JSON texts to be
		509	able to read them, many other languages depend on that.
		510
		511	A simple RPC protocol that interoperates easily with others is to send
		512	JSON arrays (or objects, although arrays are usually the better choice as
		513	they mimic how function argument passing works) and a newline after each
		514	JSON text:
		515
		516	$handle->push_write (json => ["method", "arg1", "arg2"]); # whatever
		517	$handle->push_write ("\012");
		518
		519	An AnyEvent::Handle receiver would simply use the C<json> read type and
		520	rely on the fact that the newline will be skipped as leading whitespace:
		521
		522	$handle->push_read (json => sub { my $array = $_[1]; ... });
		523
		524	Other languages could read single lines terminated by a newline and pass
		525	this line into their JSON decoder of choice.
		526
401	=cut	527	=cut
402		528
403	register_write_type json => sub {	529	register_write_type json => sub {
404	my ($self, $ref) = @_;	530	my ($self, $ref) = @_;
405		531
406	require JSON;	532	require JSON;
407		533
408	$self->{json} ? $self->{json}->encode ($ref)	534	$self->{json} ? $self->{json}->encode ($ref)
409	: JSON::encode_json ($ref)	535	: JSON::encode_json ($ref)
410	};	536	};
		537
		538	=back
411		539
412	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	540	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
413		541
414	This function (not method) lets you add your own types to C<push_write>.	542	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	543	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	569	enough is there) from the read buffer (C<< $handle->rbuf >>) if you want
442	or not.	570	or not.
443		571
444	In the more complex case, you want to queue multiple callbacks. In this	572	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	573	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>,	574	data arrives (also the first time it is queued) and removes it when it has
447	below).	575	done its job (see C<push_read>, below).
448		576
449	This way you can, for example, push three line-reads, followed by reading	577	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.	578	a chunk of data, and AnyEvent::Handle will execute them in order.
451		579
452	Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by	580	Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by
453	the specified number of bytes which give an XML datagram.	581	the specified number of bytes which give an XML datagram.
454		582
455	# in the default state, expect some header bytes	583	# in the default state, expect some header bytes
456	$handle->on_read (sub {	584	$handle->on_read (sub {
457	# some data is here, now queue the length-header-read (4 octets)	585	# some data is here, now queue the length-header-read (4 octets)
458	shift->unshift_read_chunk (4, sub {	586	shift->unshift_read (chunk => 4, sub {
459	# header arrived, decode	587	# header arrived, decode
460	my $len = unpack "N", $_[1];	588	my $len = unpack "N", $_[1];
461		589
462	# now read the payload	590	# now read the payload
463	shift->unshift_read_chunk ($len, sub {	591	shift->unshift_read (chunk => $len, sub {
464	my $xml = $_[1];	592	my $xml = $_[1];
465	# handle xml	593	# handle xml
466	});	594	});
467	});	595	});
468	});	596	});
…		…
475		603
476	# request one	604	# request one
477	$handle->push_write ("request 1\015\012");	605	$handle->push_write ("request 1\015\012");
478		606
479	# we expect "ERROR" or "OK" as response, so push a line read	607	# we expect "ERROR" or "OK" as response, so push a line read
480	$handle->push_read_line (sub {	608	$handle->push_read (line => sub {
481	# if we got an "OK", we have to _prepend_ another line,	609	# 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	610	# 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	611	# which are already in the queue when this callback is called
484	# we don't do this in case we got an error	612	# we don't do this in case we got an error
485	if ($_[1] eq "OK") {	613	if ($_[1] eq "OK") {
486	$_[0]->unshift_read_line (sub {	614	$_[0]->unshift_read (line => sub {
487	my $response = $_[1];	615	my $response = $_[1];
488	...	616	...
489	});	617	});
490	}	618	}
491	});	619	});
492		620
493	# request two	621	# request two
494	$handle->push_write ("request 2\015\012");	622	$handle->push_write ("request 2\015\012");
495		623
496	# simply read 64 bytes, always	624	# simply read 64 bytes, always
497	$handle->push_read_chunk (64, sub {	625	$handle->push_read (chunk => 64, sub {
498	my $response = $_[1];	626	my $response = $_[1];
499	...	627	...
500	});	628	});
501		629
502	=over 4	630	=over 4
503		631
504	=cut	632	=cut
505		633
506	sub _drain_rbuf {	634	sub _drain_rbuf {
507	my ($self) = @_;	635	my ($self) = @_;
		636
		637	local $self->{_in_drain} = 1;
508		638
509	if (	639	if (
510	defined $self->{rbuf_max}	640	defined $self->{rbuf_max}
511	&& $self->{rbuf_max} < length $self->{rbuf}	641	&& $self->{rbuf_max} < length $self->{rbuf}
512	) {	642	) {
513	$! = &Errno::ENOSPC;	643	return $self->_error (&Errno::ENOSPC, 1);
514	$self->error;
515	}	644	}
516		645
517	return if $self->{in_drain};	646	while () {
518	local $self->{in_drain} = 1;
519
520	while (my $len = length $self->{rbuf}) {
521	no strict 'refs';	647	no strict 'refs';
		648
		649	my $len = length $self->{rbuf};
		650
522	if (my $cb = shift @{ $self->{_queue} }) {	651	if (my $cb = shift @{ $self->{_queue} }) {
523	unless ($cb->($self)) {	652	unless ($cb->($self)) {
524	if ($self->{_eof}) {	653	if ($self->{_eof}) {
525	# no progress can be made (not enough data and no data forthcoming)	654	# no progress can be made (not enough data and no data forthcoming)
526	$! = &Errno::EPIPE;	655	$self->_error (&Errno::EPIPE, 1), last;
527	$self->error;
528	}	656	}
529		657
530	unshift @{ $self->{_queue} }, $cb;	658	unshift @{ $self->{_queue} }, $cb;
531	return;	659	last;
532	}	660	}
533	} elsif ($self->{on_read}) {	661	} elsif ($self->{on_read}) {
		662	last unless $len;
		663
534	$self->{on_read}($self);	664	$self->{on_read}($self);
535		665
536	if (	666	if (
537	$self->{_eof} # if no further data will arrive
538	&& $len == length $self->{rbuf} # and no data has been consumed	667	$len == length $self->{rbuf} # if no data has been consumed
539	&& !@{ $self->{_queue} } # and the queue is still empty	668	&& !@{ $self->{_queue} } # and the queue is still empty
540	&& $self->{on_read} # and we still want to read data	669	&& $self->{on_read} # but we still have on_read
541	) {	670	) {
		671	# no further data will arrive
542	# then no progress can be made	672	# so no progress can be made
543	$! = &Errno::EPIPE;	673	$self->_error (&Errno::EPIPE, 1), last
544	$self->error;	674	if $self->{_eof};
		675
		676	last; # more data might arrive
545	}	677	}
546	} else {	678	} else {
547	# read side becomes idle	679	# read side becomes idle
548	delete $self->{_rw};	680	delete $self->{_rw};
549	return;	681	last;
550	}	682	}
551	}	683	}
552		684
553	if ($self->{_eof}) {
554	$self->_shutdown;
555	$self->{on_eof}($self)	685	$self->{on_eof}($self)
556	if $self->{on_eof};	686	if $self->{_eof} && $self->{on_eof};
		687
		688	# may need to restart read watcher
		689	unless ($self->{_rw}) {
		690	$self->start_read
		691	if $self->{on_read} \|\| @{ $self->{_queue} };
557	}	692	}
558	}	693	}
559		694
560	=item $handle->on_read ($cb)	695	=item $handle->on_read ($cb)
561		696
…		…
567		702
568	sub on_read {	703	sub on_read {
569	my ($self, $cb) = @_;	704	my ($self, $cb) = @_;
570		705
571	$self->{on_read} = $cb;	706	$self->{on_read} = $cb;
		707	$self->_drain_rbuf if $cb && !$self->{_in_drain};
572	}	708	}
573		709
574	=item $handle->rbuf	710	=item $handle->rbuf
575		711
576	Returns the read buffer (as a modifiable lvalue).	712	Returns the read buffer (as a modifiable lvalue).
…		…
625	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	761	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
626	->($self, $cb, @_);	762	->($self, $cb, @_);
627	}	763	}
628		764
629	push @{ $self->{_queue} }, $cb;	765	push @{ $self->{_queue} }, $cb;
630	$self->_drain_rbuf;	766	$self->_drain_rbuf unless $self->{_in_drain};
631	}	767	}
632		768
633	sub unshift_read {	769	sub unshift_read {
634	my $self = shift;	770	my $self = shift;
635	my $cb = pop;	771	my $cb = pop;
…		…
641	->($self, $cb, @_);	777	->($self, $cb, @_);
642	}	778	}
643		779
644		780
645	unshift @{ $self->{_queue} }, $cb;	781	unshift @{ $self->{_queue} }, $cb;
646	$self->_drain_rbuf;	782	$self->_drain_rbuf unless $self->{_in_drain};
647	}	783	}
648		784
649	=item $handle->push_read (type => @args, $cb)	785	=item $handle->push_read (type => @args, $cb)
650		786
651	=item $handle->unshift_read (type => @args, $cb)	787	=item $handle->unshift_read (type => @args, $cb)
…		…
736		872
737	sub unshift_read_line {	873	sub unshift_read_line {
738	my $self = shift;	874	my $self = shift;
739	$self->unshift_read (line => @_);	875	$self->unshift_read (line => @_);
740	}	876	}
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		877
780	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)	878	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
781		879
782	Makes a regex match against the regex object C<$accept> and returns	880	Makes a regex match against the regex object C<$accept> and returns
783	everything up to and including the match.	881	everything up to and including the match.
…		…
833	return 1;	931	return 1;
834	}	932	}
835		933
836	# reject	934	# reject
837	if ($reject && $$rbuf =~ $reject) {	935	if ($reject && $$rbuf =~ $reject) {
838	$! = &Errno::EBADMSG;	936	$self->_error (&Errno::EBADMSG);
839	$self->error;
840	}	937	}
841		938
842	# skip	939	# skip
843	if ($skip && $$rbuf =~ $skip) {	940	if ($skip && $$rbuf =~ $skip) {
844	$data .= substr $$rbuf, 0, $+[0], "";	941	$data .= substr $$rbuf, 0, $+[0], "";
…		…
846		943
847	()	944	()
848	}	945	}
849	};	946	};
850		947
		948	=item netstring => $cb->($handle, $string)
		949
		950	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
		951
		952	Throws an error with C<$!> set to EBADMSG on format violations.
		953
		954	=cut
		955
		956	register_read_type netstring => sub {
		957	my ($self, $cb) = @_;
		958
		959	sub {
		960	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
		961	if ($_[0]{rbuf} =~ /[^0-9]/) {
		962	$self->_error (&Errno::EBADMSG);
		963	}
		964	return;
		965	}
		966
		967	my $len = $1;
		968
		969	$self->unshift_read (chunk => $len, sub {
		970	my $string = $_[1];
		971	$_[0]->unshift_read (chunk => 1, sub {
		972	if ($_[1] eq ",") {
		973	$cb->($_[0], $string);
		974	} else {
		975	$self->_error (&Errno::EBADMSG);
		976	}
		977	});
		978	});
		979
		980	1
		981	}
		982	};
		983
		984	=item packstring => $format, $cb->($handle, $string)
		985
		986	An octet string prefixed with an encoded length. The encoding C<$format>
		987	uses the same format as a Perl C<pack> format, but must specify a single
		988	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
		989	optional C<!>, C<< < >> or C<< > >> modifier).
		990
		991	DNS over TCP uses a prefix of C<n>, EPP uses a prefix of C<N>.
		992
		993	Example: read a block of data prefixed by its length in BER-encoded
		994	format (very efficient).
		995
		996	$handle->push_read (packstring => "w", sub {
		997	my ($handle, $data) = @_;
		998	});
		999
		1000	=cut
		1001
		1002	register_read_type packstring => sub {
		1003	my ($self, $cb, $format) = @_;
		1004
		1005	sub {
		1006	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
		1007	defined (my $len = eval { unpack $format, $_[0]->{rbuf} })
		1008	or return;
		1009
		1010	# remove prefix
		1011	substr $_[0]->{rbuf}, 0, (length pack $format, $len), "";
		1012
		1013	# read rest
		1014	$_[0]->unshift_read (chunk => $len, $cb);
		1015
		1016	1
		1017	}
		1018	};
		1019
851	=item json => $cb->($handle, $hash_or_arrayref)	1020	=item json => $cb->($handle, $hash_or_arrayref)
852		1021
853	Reads a JSON object or array, decodes it and passes it to the callback.	1022	Reads a JSON object or array, decodes it and passes it to the callback.
854		1023
855	If a C<json> object was passed to the constructor, then that will be used	1024	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	1028	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	1029	dependency on your own: this module will load the JSON module, but
861	AnyEvent does not depend on it itself.	1030	AnyEvent does not depend on it itself.
862		1031
863	Since JSON texts are fully self-delimiting, the C<json> read and write	1032	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.	1033	types are an ideal simple RPC protocol: just exchange JSON datagrams. See
		1034	the C<json> write type description, above, for an actual example.
865		1035
866	=cut	1036	=cut
867		1037
868	register_read_type json => sub {	1038	register_read_type json => sub {
869	my ($self, $cb, $accept, $reject, $skip) = @_;	1039	my ($self, $cb, $accept, $reject, $skip) = @_;
…		…
871	require JSON;	1041	require JSON;
872		1042
873	my $data;	1043	my $data;
874	my $rbuf = \$self->{rbuf};	1044	my $rbuf = \$self->{rbuf};
875		1045
876	my $json = $self->{json} \|\|= JSON::XS->new->utf8;	1046	my $json = $self->{json} \|\|= JSON->new->utf8;
877		1047
878	sub {	1048	sub {
879	my $ref = $json->incr_parse ($self->{rbuf});	1049	my $ref = $json->incr_parse ($self->{rbuf});
880		1050
881	if ($ref) {	1051	if ($ref) {
…		…
916	=item $handle->stop_read	1086	=item $handle->stop_read
917		1087
918	=item $handle->start_read	1088	=item $handle->start_read
919		1089
920	In rare cases you actually do not want to read anything from the	1090	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	1091	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	1092	any queued callbacks will be executed then. To start reading again, call
923	C<start_read>.	1093	C<start_read>.
		1094
		1095	Note that AnyEvent::Handle will automatically C<start_read> for you when
		1096	you change the C<on_read> callback or push/unshift a read callback, and it
		1097	will automatically C<stop_read> for you when neither C<on_read> is set nor
		1098	there are any read requests in the queue.
924		1099
925	=cut	1100	=cut
926		1101
927	sub stop_read {	1102	sub stop_read {
928	my ($self) = @_;	1103	my ($self) = @_;
…		…
939	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1114	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
940	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1115	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};
941	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;	1116	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;
942		1117
943	if ($len > 0) {	1118	if ($len > 0) {
		1119	$self->{_activity} = AnyEvent->now;
		1120
944	$self->{filter_r}	1121	$self->{filter_r}
945	? $self->{filter_r}->($self, $rbuf)	1122	? $self->{filter_r}($self, $rbuf)
946	: $self->_drain_rbuf;	1123	: $self->{_in_drain} \|\| $self->_drain_rbuf;
947		1124
948	} elsif (defined $len) {	1125	} elsif (defined $len) {
949	delete $self->{_rw};	1126	delete $self->{_rw};
950	$self->{_eof} = 1;	1127	$self->{_eof} = 1;
951	$self->_drain_rbuf;	1128	$self->_drain_rbuf unless $self->{_in_drain};
952		1129
953	} elsif ($! != EAGAIN && $! != EINTR && $! != &AnyEvent::Util::WSAWOULDBLOCK) {	1130	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
954	return $self->error;	1131	return $self->_error ($!, 1);
955	}	1132	}
956	});	1133	});
957	}	1134	}
958	}	1135	}
959		1136
960	sub _dotls {	1137	sub _dotls {
961	my ($self) = @_;	1138	my ($self) = @_;
		1139
		1140	my $buf;
962		1141
963	if (length $self->{_tls_wbuf}) {	1142	if (length $self->{_tls_wbuf}) {
964	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1143	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
965	substr $self->{_tls_wbuf}, 0, $len, "";	1144	substr $self->{_tls_wbuf}, 0, $len, "";
966	}	1145	}
967	}	1146	}
968		1147
969	if (defined (my $buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1148	if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {
970	$self->{wbuf} .= $buf;	1149	$self->{wbuf} .= $buf;
971	$self->_drain_wbuf;	1150	$self->_drain_wbuf;
972	}	1151	}
973		1152
974	while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) {	1153	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {
		1154	if (length $buf) {
975	$self->{rbuf} .= $buf;	1155	$self->{rbuf} .= $buf;
976	$self->_drain_rbuf;	1156	$self->_drain_rbuf unless $self->{_in_drain};
		1157	} else {
		1158	# let's treat SSL-eof as we treat normal EOF
		1159	$self->{_eof} = 1;
		1160	$self->_shutdown;
		1161	return;
		1162	}
977	}	1163	}
978		1164
979	my $err = Net::SSLeay::get_error ($self->{tls}, -1);	1165	my $err = Net::SSLeay::get_error ($self->{tls}, -1);
980		1166
981	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {	1167	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
982	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {	1168	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {
983	$self->error;	1169	return $self->_error ($!, 1);
984	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {	1170	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {
985	$! = &Errno::EIO;	1171	return $self->_error (&Errno::EIO, 1);
986	$self->error;
987	}	1172	}
988		1173
989	# all others are fine for our purposes	1174	# all others are fine for our purposes
990	}	1175	}
991	}	1176	}
…		…
1006	call and can be used or changed to your liking. Note that the handshake	1191	call and can be used or changed to your liking. Note that the handshake
1007	might have already started when this function returns.	1192	might have already started when this function returns.
1008		1193
1009	=cut	1194	=cut
1010		1195
1011	# TODO: maybe document...
1012	sub starttls {	1196	sub starttls {
1013	my ($self, $ssl, $ctx) = @_;	1197	my ($self, $ssl, $ctx) = @_;
1014		1198
1015	$self->stoptls;	1199	$self->stoptls;
1016		1200

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.61 by root, Fri Jun 6 10:23:50 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.61 by root, Fri Jun 6 10:23:50 2008 UTC