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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.38 by root, Mon May 26 21:28:33 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;
…		…
73	The filehandle this L<AnyEvent::Handle> object will operate on.	73	The filehandle this L<AnyEvent::Handle> object will operate on.
74		74
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->($self)	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->($self)	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->($self)	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<$self->{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
114	feed all the remaining data to the queued callbacks and C<on_read> before	118	feed all the remaining data to the queued callbacks and C<on_read> before
115	calling the C<on_eof> callback. If no progress can be made, then a fatal	119	calling the C<on_eof> callback. If no progress can be made, then a fatal
116	error will be raised (with C<$!> set to C<EPIPE>).	120	error will be raised (with C<$!> set to C<EPIPE>).
117		121
118	=item on_drain => $cb->()	122	=item on_drain => $cb->($handle)
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
…		…
168		192
169	Use the given Net::SSLeay::CTX object to create the new TLS connection	193	Use the given Net::SSLeay::CTX object to create the new TLS connection
170	(unless a connection object was specified directly). If this parameter is	194	(unless a connection object was specified directly). If this parameter is
171	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	195	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
172		196
		197	=item json => JSON or JSON::XS object
		198
		199	This is the json coder object used by the C<json> read and write types.
		200
		201	If you don't supply it, then AnyEvent::Handle will create and use a
		202	suitable one, which will write and expect UTF-8 encoded JSON texts.
		203
		204	Note that you are responsible to depend on the JSON module if you want to
		205	use this functionality, as AnyEvent does not have a dependency itself.
		206
173	=item filter_r => $cb	207	=item filter_r => $cb
174		208
175	=item filter_w => $cb	209	=item filter_w => $cb
176		210
177	These exist, but are undocumented at this time.	211	These exist, but are undocumented at this time.
…		…
192	if ($self->{tls}) {	226	if ($self->{tls}) {
193	require Net::SSLeay;	227	require Net::SSLeay;
194	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});	228	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});
195	}	229	}
196		230
197	$self->on_eof (delete $self->{on_eof} ) if $self->{on_eof};	231	$self->{_activity} = AnyEvent->now;
198	$self->on_error (delete $self->{on_error}) if $self->{on_error};	232	$self->_timeout;
		233
199	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	234	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
200	$self->on_read (delete $self->{on_read} ) if $self->{on_read};
201
202	$self->start_read;
203		235
204	$self	236	$self
205	}	237	}
206		238
207	sub _shutdown {	239	sub _shutdown {
208	my ($self) = @_;	240	my ($self) = @_;
209		241
		242	delete $self->{_tw};
210	delete $self->{_rw};	243	delete $self->{_rw};
211	delete $self->{_ww};	244	delete $self->{_ww};
212	delete $self->{fh};	245	delete $self->{fh};
213	}
214		246
		247	$self->stoptls;
		248	}
		249
215	sub error {	250	sub _error {
216	my ($self) = @_;	251	my ($self, $errno, $fatal) = @_;
217		252
218	{
219	local $!;
220	$self->_shutdown;	253	$self->_shutdown
221	}	254	if $fatal;
222		255
223	$self->{on_error}($self)	256	$! = $errno;
		257
224	if $self->{on_error};	258	if ($self->{on_error}) {
225		259	$self->{on_error}($self, $fatal);
		260	} else {
226	Carp::croak "AnyEvent::Handle uncaught fatal error: $!";	261	Carp::croak "AnyEvent::Handle uncaught error: $!";
		262	}
227	}	263	}
228		264
229	=item $fh = $handle->fh	265	=item $fh = $handle->fh
230		266
231	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.
…		…
250		286
251	=cut	287	=cut
252		288
253	sub on_eof {	289	sub on_eof {
254	$_[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	}
255	}	358	}
256		359
257	#############################################################################	360	#############################################################################
258		361
259	=back	362	=back
…		…
306	my $len = syswrite $self->{fh}, $self->{wbuf};	409	my $len = syswrite $self->{fh}, $self->{wbuf};
307		410
308	if ($len >= 0) {	411	if ($len >= 0) {
309	substr $self->{wbuf}, 0, $len, "";	412	substr $self->{wbuf}, 0, $len, "";
310		413
		414	$self->{_activity} = AnyEvent->now;
		415
311	$self->{on_drain}($self)	416	$self->{on_drain}($self)
312	if $self->{low_water_mark} >= length $self->{wbuf}	417	if $self->{low_water_mark} >= length $self->{wbuf}
313	&& $self->{on_drain};	418	&& $self->{on_drain};
314		419
315	delete $self->{_ww} unless length $self->{wbuf};	420	delete $self->{_ww} unless length $self->{wbuf};
316	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAWOULDBLOCK) {	421	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
317	$self->error;	422	$self->_error ($!, 1);
318	}	423	}
319	};	424	};
320		425
321	# try to write data immediately	426	# try to write data immediately
322	$cb->();	427	$cb->();
…		…
342	@_ = ($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")
343	->($self, @_);	448	->($self, @_);
344	}	449	}
345		450
346	if ($self->{filter_w}) {	451	if ($self->{filter_w}) {
347	$self->{filter_w}->($self, \$_[0]);	452	$self->{filter_w}($self, \$_[0]);
348	} else {	453	} else {
349	$self->{wbuf} .= $_[0];	454	$self->{wbuf} .= $_[0];
350	$self->_drain_wbuf;	455	$self->_drain_wbuf;
351	}	456	}
352	}	457	}
353		458
354	=item $handle->push_write (type => @args)	459	=item $handle->push_write (type => @args)
355		460
356	=item $handle->unshift_write (type => @args)
357
358	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
359	the job by specifying a type and type-specific arguments.	462	the job by specifying a type and type-specific arguments.
360		463
361	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
362	drop by and tell us):	465	drop by and tell us):
…		…
366	=item netstring => $string	469	=item netstring => $string
367		470
368	Formats the given value as netstring	471	Formats the given value as netstring
369	(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).
370		473
371	=back
372
373	=cut	474	=cut
374		475
375	register_write_type netstring => sub {	476	register_write_type netstring => sub {
376	my ($self, $string) = @_;	477	my ($self, $string) = @_;
377		478
378	sprintf "%d:%s,", (length $string), $string	479	sprintf "%d:%s,", (length $string), $string
379	};	480	};
380		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
		495	};
		496
		497	=item json => $array_or_hashref
		498
		499	Encodes the given hash or array reference into a JSON object. Unless you
		500	provide your own JSON object, this means it will be encoded to JSON text
		501	in UTF-8.
		502
		503	JSON objects (and arrays) are self-delimiting, so you can write JSON at
		504	one end of a handle and read them at the other end without using any
		505	additional framing.
		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
		527	=cut
		528
		529	register_write_type json => sub {
		530	my ($self, $ref) = @_;
		531
		532	require JSON;
		533
		534	$self->{json} ? $self->{json}->encode ($ref)
		535	: JSON::encode_json ($ref)
		536	};
		537
		538	=back
		539
381	=item AnyEvent::Handle::register_write_type type => $coderef->($self, @args)	540	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
382		541
383	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>.
384	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
385	reference with the handle object and the remaining arguments.	544	reference with the handle object and the remaining arguments.
386		545
…		…
410	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
411	or not.	570	or not.
412		571
413	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
414	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
415	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
416	below).	575	done its job (see C<push_read>, below).
417		576
418	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
419	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.
420		579
421	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
422	the specified number of bytes which give an XML datagram.	581	the specified number of bytes which give an XML datagram.
423		582
424	# in the default state, expect some header bytes	583	# in the default state, expect some header bytes
425	$handle->on_read (sub {	584	$handle->on_read (sub {
426	# 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)
427	shift->unshift_read_chunk (4, sub {	586	shift->unshift_read (chunk => 4, sub {
428	# header arrived, decode	587	# header arrived, decode
429	my $len = unpack "N", $_[1];	588	my $len = unpack "N", $_[1];
430		589
431	# now read the payload	590	# now read the payload
432	shift->unshift_read_chunk ($len, sub {	591	shift->unshift_read (chunk => $len, sub {
433	my $xml = $_[1];	592	my $xml = $_[1];
434	# handle xml	593	# handle xml
435	});	594	});
436	});	595	});
437	});	596	});
…		…
444		603
445	# request one	604	# request one
446	$handle->push_write ("request 1\015\012");	605	$handle->push_write ("request 1\015\012");
447		606
448	# 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
449	$handle->push_read_line (sub {	608	$handle->push_read (line => sub {
450	# if we got an "OK", we have to _prepend_ another line,	609	# if we got an "OK", we have to _prepend_ another line,
451	# 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
452	# which are already in the queue when this callback is called	611	# which are already in the queue when this callback is called
453	# we don't do this in case we got an error	612	# we don't do this in case we got an error
454	if ($_[1] eq "OK") {	613	if ($_[1] eq "OK") {
455	$_[0]->unshift_read_line (sub {	614	$_[0]->unshift_read (line => sub {
456	my $response = $_[1];	615	my $response = $_[1];
457	...	616	...
458	});	617	});
459	}	618	}
460	});	619	});
461		620
462	# request two	621	# request two
463	$handle->push_write ("request 2\015\012");	622	$handle->push_write ("request 2\015\012");
464		623
465	# simply read 64 bytes, always	624	# simply read 64 bytes, always
466	$handle->push_read_chunk (64, sub {	625	$handle->push_read (chunk => 64, sub {
467	my $response = $_[1];	626	my $response = $_[1];
468	...	627	...
469	});	628	});
470		629
471	=over 4	630	=over 4
472		631
473	=cut	632	=cut
474		633
475	sub _drain_rbuf {	634	sub _drain_rbuf {
476	my ($self) = @_;	635	my ($self) = @_;
		636
		637	local $self->{_in_drain} = 1;
477		638
478	if (	639	if (
479	defined $self->{rbuf_max}	640	defined $self->{rbuf_max}
480	&& $self->{rbuf_max} < length $self->{rbuf}	641	&& $self->{rbuf_max} < length $self->{rbuf}
481	) {	642	) {
482	$! = &Errno::ENOSPC;	643	return $self->_error (&Errno::ENOSPC, 1);
483	$self->error;
484	}	644	}
485		645
486	return if $self->{in_drain};	646	while () {
487	local $self->{in_drain} = 1;
488
489	while (my $len = length $self->{rbuf}) {
490	no strict 'refs';	647	no strict 'refs';
		648
		649	my $len = length $self->{rbuf};
		650
491	if (my $cb = shift @{ $self->{_queue} }) {	651	if (my $cb = shift @{ $self->{_queue} }) {
492	unless ($cb->($self)) {	652	unless ($cb->($self)) {
493	if ($self->{_eof}) {	653	if ($self->{_eof}) {
494	# 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)
495	$! = &Errno::EPIPE;	655	$self->_error (&Errno::EPIPE, 1), last;
496	$self->error;
497	}	656	}
498		657
499	unshift @{ $self->{_queue} }, $cb;	658	unshift @{ $self->{_queue} }, $cb;
500	return;	659	last;
501	}	660	}
502	} elsif ($self->{on_read}) {	661	} elsif ($self->{on_read}) {
		662	last unless $len;
		663
503	$self->{on_read}($self);	664	$self->{on_read}($self);
504		665
505	if (	666	if (
506	$self->{_eof} # if no further data will arrive
507	&& $len == length $self->{rbuf} # and no data has been consumed	667	$len == length $self->{rbuf} # if no data has been consumed
508	&& !@{ $self->{_queue} } # and the queue is still empty	668	&& !@{ $self->{_queue} } # and the queue is still empty
509	&& $self->{on_read} # and we still want to read data	669	&& $self->{on_read} # but we still have on_read
510	) {	670	) {
		671	# no further data will arrive
511	# then no progress can be made	672	# so no progress can be made
512	$! = &Errno::EPIPE;	673	$self->_error (&Errno::EPIPE, 1), last
513	$self->error;	674	if $self->{_eof};
		675
		676	last; # more data might arrive
514	}	677	}
515	} else {	678	} else {
516	# read side becomes idle	679	# read side becomes idle
517	delete $self->{_rw};	680	delete $self->{_rw};
518	return;	681	last;
519	}	682	}
520	}	683	}
521		684
522	if ($self->{_eof}) {
523	$self->_shutdown;
524	$self->{on_eof}($self)	685	$self->{on_eof}($self)
525	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} };
526	}	692	}
527	}	693	}
528		694
529	=item $handle->on_read ($cb)	695	=item $handle->on_read ($cb)
530		696
…		…
536		702
537	sub on_read {	703	sub on_read {
538	my ($self, $cb) = @_;	704	my ($self, $cb) = @_;
539		705
540	$self->{on_read} = $cb;	706	$self->{on_read} = $cb;
		707	$self->_drain_rbuf if $cb && !$self->{_in_drain};
541	}	708	}
542		709
543	=item $handle->rbuf	710	=item $handle->rbuf
544		711
545	Returns the read buffer (as a modifiable lvalue).	712	Returns the read buffer (as a modifiable lvalue).
…		…
594	$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")
595	->($self, $cb, @_);	762	->($self, $cb, @_);
596	}	763	}
597		764
598	push @{ $self->{_queue} }, $cb;	765	push @{ $self->{_queue} }, $cb;
599	$self->_drain_rbuf;	766	$self->_drain_rbuf unless $self->{_in_drain};
600	}	767	}
601		768
602	sub unshift_read {	769	sub unshift_read {
603	my $self = shift;	770	my $self = shift;
604	my $cb = pop;	771	my $cb = pop;
…		…
610	->($self, $cb, @_);	777	->($self, $cb, @_);
611	}	778	}
612		779
613		780
614	unshift @{ $self->{_queue} }, $cb;	781	unshift @{ $self->{_queue} }, $cb;
615	$self->_drain_rbuf;	782	$self->_drain_rbuf unless $self->{_in_drain};
616	}	783	}
617		784
618	=item $handle->push_read (type => @args, $cb)	785	=item $handle->push_read (type => @args, $cb)
619		786
620	=item $handle->unshift_read (type => @args, $cb)	787	=item $handle->unshift_read (type => @args, $cb)
…		…
626	Predefined types are (if you have ideas for additional types, feel free to	793	Predefined types are (if you have ideas for additional types, feel free to
627	drop by and tell us):	794	drop by and tell us):
628		795
629	=over 4	796	=over 4
630		797
631	=item chunk => $octets, $cb->($self, $data)	798	=item chunk => $octets, $cb->($handle, $data)
632		799
633	Invoke the callback only once C<$octets> bytes have been read. Pass the	800	Invoke the callback only once C<$octets> bytes have been read. Pass the
634	data read to the callback. The callback will never be called with less	801	data read to the callback. The callback will never be called with less
635	data.	802	data.
636		803
…		…
659		826
660	sub unshift_read_chunk {	827	sub unshift_read_chunk {
661	$_[0]->unshift_read (chunk => $_[1], $_[2]);	828	$_[0]->unshift_read (chunk => $_[1], $_[2]);
662	}	829	}
663		830
664	=item line => [$eol, ]$cb->($self, $line, $eol)	831	=item line => [$eol, ]$cb->($handle, $line, $eol)
665		832
666	The callback will be called only once a full line (including the end of	833	The callback will be called only once a full line (including the end of
667	line marker, C<$eol>) has been read. This line (excluding the end of line	834	line marker, C<$eol>) has been read. This line (excluding the end of line
668	marker) will be passed to the callback as second argument (C<$line>), and	835	marker) will be passed to the callback as second argument (C<$line>), and
669	the end of line marker as the third argument (C<$eol>).	836	the end of line marker as the third argument (C<$eol>).
…		…
706	sub unshift_read_line {	873	sub unshift_read_line {
707	my $self = shift;	874	my $self = shift;
708	$self->unshift_read (line => @_);	875	$self->unshift_read (line => @_);
709	}	876	}
710		877
711	=item netstring => $cb->($string)
712
713	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
714
715	Throws an error with C<$!> set to EBADMSG on format violations.
716
717	=cut
718
719	register_read_type netstring => sub {
720	my ($self, $cb) = @_;
721
722	sub {
723	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
724	if ($_[0]{rbuf} =~ /[^0-9]/) {
725	$! = &Errno::EBADMSG;
726	$self->error;
727	}
728	return;
729	}
730
731	my $len = $1;
732
733	$self->unshift_read (chunk => $len, sub {
734	my $string = $_[1];
735	$_[0]->unshift_read (chunk => 1, sub {
736	if ($_[1] eq ",") {
737	$cb->($_[0], $string);
738	} else {
739	$! = &Errno::EBADMSG;
740	$self->error;
741	}
742	});
743	});
744
745	1
746	}
747	};
748
749	=item regex => $accept[, $reject[, $skip], $cb->($data)	878	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
750		879
751	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
752	everything up to and including the match.	881	everything up to and including the match.
753		882
754	Example: read a single line terminated by '\n'.	883	Example: read a single line terminated by '\n'.
…		…
802	return 1;	931	return 1;
803	}	932	}
804		933
805	# reject	934	# reject
806	if ($reject && $$rbuf =~ $reject) {	935	if ($reject && $$rbuf =~ $reject) {
807	$! = &Errno::EBADMSG;	936	$self->_error (&Errno::EBADMSG);
808	$self->error;
809	}	937	}
810		938
811	# skip	939	# skip
812	if ($skip && $$rbuf =~ $skip) {	940	if ($skip && $$rbuf =~ $skip) {
813	$data .= substr $$rbuf, 0, $+[0], "";	941	$data .= substr $$rbuf, 0, $+[0], "";
…		…
815		943
816	()	944	()
817	}	945	}
818	};	946	};
819		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
		1020	=item json => $cb->($handle, $hash_or_arrayref)
		1021
		1022	Reads a JSON object or array, decodes it and passes it to the callback.
		1023
		1024	If a C<json> object was passed to the constructor, then that will be used
		1025	for the final decode, otherwise it will create a JSON coder expecting UTF-8.
		1026
		1027	This read type uses the incremental parser available with JSON version
		1028	2.09 (and JSON::XS version 2.2) and above. You have to provide a
		1029	dependency on your own: this module will load the JSON module, but
		1030	AnyEvent does not depend on it itself.
		1031
		1032	Since JSON texts are fully self-delimiting, the C<json> read and write
		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.
		1035
		1036	=cut
		1037
		1038	register_read_type json => sub {
		1039	my ($self, $cb, $accept, $reject, $skip) = @_;
		1040
		1041	require JSON;
		1042
		1043	my $data;
		1044	my $rbuf = \$self->{rbuf};
		1045
		1046	my $json = $self->{json} \|\|= JSON->new->utf8;
		1047
		1048	sub {
		1049	my $ref = $json->incr_parse ($self->{rbuf});
		1050
		1051	if ($ref) {
		1052	$self->{rbuf} = $json->incr_text;
		1053	$json->incr_text = "";
		1054	$cb->($self, $ref);
		1055
		1056	1
		1057	} else {
		1058	$self->{rbuf} = "";
		1059	()
		1060	}
		1061	}
		1062	};
		1063
820	=back	1064	=back
821		1065
822	=item AnyEvent::Handle::register_read_type type => $coderef->($self, $cb, @args)	1066	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)
823		1067
824	This function (not method) lets you add your own types to C<push_read>.	1068	This function (not method) lets you add your own types to C<push_read>.
825		1069
826	Whenever the given C<type> is used, C<push_read> will invoke the code	1070	Whenever the given C<type> is used, C<push_read> will invoke the code
827	reference with the handle object, the callback and the remaining	1071	reference with the handle object, the callback and the remaining
…		…
829		1073
830	The code reference is supposed to return a callback (usually a closure)	1074	The code reference is supposed to return a callback (usually a closure)
831	that works as a plain read callback (see C<< ->push_read ($cb) >>).	1075	that works as a plain read callback (see C<< ->push_read ($cb) >>).
832		1076
833	It should invoke the passed callback when it is done reading (remember to	1077	It should invoke the passed callback when it is done reading (remember to
834	pass C<$self> as first argument as all other callbacks do that).	1078	pass C<$handle> as first argument as all other callbacks do that).
835		1079
836	Note that this is a function, and all types registered this way will be	1080	Note that this is a function, and all types registered this way will be
837	global, so try to use unique names.	1081	global, so try to use unique names.
838		1082
839	For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>,	1083	For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>,
…		…
842	=item $handle->stop_read	1086	=item $handle->stop_read
843		1087
844	=item $handle->start_read	1088	=item $handle->start_read
845		1089
846	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
847	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
848	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
849	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.
850		1099
851	=cut	1100	=cut
852		1101
853	sub stop_read {	1102	sub stop_read {
854	my ($self) = @_;	1103	my ($self) = @_;
…		…
865	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1114	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
866	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1115	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};
867	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;
868		1117
869	if ($len > 0) {	1118	if ($len > 0) {
		1119	$self->{_activity} = AnyEvent->now;
		1120
870	$self->{filter_r}	1121	$self->{filter_r}
871	? $self->{filter_r}->($self, $rbuf)	1122	? $self->{filter_r}($self, $rbuf)
872	: $self->_drain_rbuf;	1123	: $self->{_in_drain} \|\| $self->_drain_rbuf;
873		1124
874	} elsif (defined $len) {	1125	} elsif (defined $len) {
875	delete $self->{_rw};	1126	delete $self->{_rw};
876	$self->{_eof} = 1;	1127	$self->{_eof} = 1;
877	$self->_drain_rbuf;	1128	$self->_drain_rbuf unless $self->{_in_drain};
878		1129
879	} elsif ($! != EAGAIN && $! != EINTR && $! != &AnyEvent::Util::WSAWOULDBLOCK) {	1130	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
880	return $self->error;	1131	return $self->_error ($!, 1);
881	}	1132	}
882	});	1133	});
883	}	1134	}
884	}	1135	}
885		1136
886	sub _dotls {	1137	sub _dotls {
887	my ($self) = @_;	1138	my ($self) = @_;
		1139
		1140	my $buf;
888		1141
889	if (length $self->{_tls_wbuf}) {	1142	if (length $self->{_tls_wbuf}) {
890	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) {
891	substr $self->{_tls_wbuf}, 0, $len, "";	1144	substr $self->{_tls_wbuf}, 0, $len, "";
892	}	1145	}
893	}	1146	}
894		1147
895	if (defined (my $buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1148	if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {
896	$self->{wbuf} .= $buf;	1149	$self->{wbuf} .= $buf;
897	$self->_drain_wbuf;	1150	$self->_drain_wbuf;
898	}	1151	}
899		1152
900	while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) {	1153	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {
		1154	if (length $buf) {
901	$self->{rbuf} .= $buf;	1155	$self->{rbuf} .= $buf;
902	$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	}
903	}	1163	}
904		1164
905	my $err = Net::SSLeay::get_error ($self->{tls}, -1);	1165	my $err = Net::SSLeay::get_error ($self->{tls}, -1);
906		1166
907	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {	1167	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
908	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {	1168	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {
909	$self->error;	1169	return $self->_error ($!, 1);
910	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {	1170	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {
911	$! = &Errno::EIO;	1171	return $self->_error (&Errno::EIO, 1);
912	$self->error;
913	}	1172	}
914		1173
915	# all others are fine for our purposes	1174	# all others are fine for our purposes
916	}	1175	}
917	}	1176	}
…		…
932	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
933	might have already started when this function returns.	1192	might have already started when this function returns.
934		1193
935	=cut	1194	=cut
936		1195
937	# TODO: maybe document...
938	sub starttls {	1196	sub starttls {
939	my ($self, $ssl, $ctx) = @_;	1197	my ($self, $ssl, $ctx) = @_;
940		1198
941	$self->stoptls;	1199	$self->stoptls;
942		1200

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.38 by root, Mon May 26 21:28:33 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.38 by root, Mon May 26 21:28:33 2008 UTC vs.
Revision 1.61 by root, Fri Jun 6 10:23:50 2008 UTC