[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.67 by root, Fri Jun 6 15:33:10 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;
…		…
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
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
…		…
168		203
169	Use the given Net::SSLeay::CTX object to create the new TLS connection	204	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	205	(unless a connection object was specified directly). If this parameter is
171	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	206	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
172		207
		208	=item json => JSON or JSON::XS object
		209
		210	This is the json coder object used by the C<json> read and write types.
		211
		212	If you don't supply it, then AnyEvent::Handle will create and use a
		213	suitable one, which will write and expect UTF-8 encoded JSON texts.
		214
		215	Note that you are responsible to depend on the JSON module if you want to
		216	use this functionality, as AnyEvent does not have a dependency itself.
		217
173	=item filter_r => $cb	218	=item filter_r => $cb
174		219
175	=item filter_w => $cb	220	=item filter_w => $cb
176		221
177	These exist, but are undocumented at this time.	222	These exist, but are undocumented at this time.
…		…
192	if ($self->{tls}) {	237	if ($self->{tls}) {
193	require Net::SSLeay;	238	require Net::SSLeay;
194	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});	239	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});
195	}	240	}
196		241
197	$self->on_eof (delete $self->{on_eof} ) if $self->{on_eof};	242	$self->{_activity} = AnyEvent->now;
198	$self->on_error (delete $self->{on_error}) if $self->{on_error};	243	$self->_timeout;
		244
199	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	245	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
200	$self->on_read (delete $self->{on_read} ) if $self->{on_read};
201		246
202	$self->start_read;	247	$self->start_read
		248	if $self->{on_read};
203		249
204	$self	250	$self
205	}	251	}
206		252
207	sub _shutdown {	253	sub _shutdown {
208	my ($self) = @_;	254	my ($self) = @_;
209		255
		256	delete $self->{_tw};
210	delete $self->{_rw};	257	delete $self->{_rw};
211	delete $self->{_ww};	258	delete $self->{_ww};
212	delete $self->{fh};	259	delete $self->{fh};
213	}
214		260
		261	$self->stoptls;
		262	}
		263
215	sub error {	264	sub _error {
216	my ($self) = @_;	265	my ($self, $errno, $fatal) = @_;
217		266
218	{
219	local $!;
220	$self->_shutdown;	267	$self->_shutdown
221	}	268	if $fatal;
222		269
223	$self->{on_error}($self)	270	$! = $errno;
		271
224	if $self->{on_error};	272	if ($self->{on_error}) {
225		273	$self->{on_error}($self, $fatal);
		274	} else {
226	Carp::croak "AnyEvent::Handle uncaught fatal error: $!";	275	Carp::croak "AnyEvent::Handle uncaught error: $!";
		276	}
227	}	277	}
228		278
229	=item $fh = $handle->fh	279	=item $fh = $handle->fh
230		280
231	This method returns the file handle of the L<AnyEvent::Handle> object.	281	This method returns the file handle of the L<AnyEvent::Handle> object.
…		…
250		300
251	=cut	301	=cut
252		302
253	sub on_eof {	303	sub on_eof {
254	$_[0]{on_eof} = $_[1];	304	$_[0]{on_eof} = $_[1];
		305	}
		306
		307	=item $handle->on_timeout ($cb)
		308
		309	Replace the current C<on_timeout> callback, or disables the callback
		310	(but not the timeout) if C<$cb> = C<undef>. See C<timeout> constructor
		311	argument.
		312
		313	=cut
		314
		315	sub on_timeout {
		316	$_[0]{on_timeout} = $_[1];
		317	}
		318
		319	#############################################################################
		320
		321	=item $handle->timeout ($seconds)
		322
		323	Configures (or disables) the inactivity timeout.
		324
		325	=cut
		326
		327	sub timeout {
		328	my ($self, $timeout) = @_;
		329
		330	$self->{timeout} = $timeout;
		331	$self->_timeout;
		332	}
		333
		334	# reset the timeout watcher, as neccessary
		335	# also check for time-outs
		336	sub _timeout {
		337	my ($self) = @_;
		338
		339	if ($self->{timeout}) {
		340	my $NOW = AnyEvent->now;
		341
		342	# when would the timeout trigger?
		343	my $after = $self->{_activity} + $self->{timeout} - $NOW;
		344
		345	# now or in the past already?
		346	if ($after <= 0) {
		347	$self->{_activity} = $NOW;
		348
		349	if ($self->{on_timeout}) {
		350	$self->{on_timeout}($self);
		351	} else {
		352	$self->_error (&Errno::ETIMEDOUT);
		353	}
		354
		355	# callback could have changed timeout value, optimise
		356	return unless $self->{timeout};
		357
		358	# calculate new after
		359	$after = $self->{timeout};
		360	}
		361
		362	Scalar::Util::weaken $self;
		363	return unless $self; # ->error could have destroyed $self
		364
		365	$self->{_tw} \|\|= AnyEvent->timer (after => $after, cb => sub {
		366	delete $self->{_tw};
		367	$self->_timeout;
		368	});
		369	} else {
		370	delete $self->{_tw};
		371	}
255	}	372	}
256		373
257	#############################################################################	374	#############################################################################
258		375
259	=back	376	=back
…		…
306	my $len = syswrite $self->{fh}, $self->{wbuf};	423	my $len = syswrite $self->{fh}, $self->{wbuf};
307		424
308	if ($len >= 0) {	425	if ($len >= 0) {
309	substr $self->{wbuf}, 0, $len, "";	426	substr $self->{wbuf}, 0, $len, "";
310		427
		428	$self->{_activity} = AnyEvent->now;
		429
311	$self->{on_drain}($self)	430	$self->{on_drain}($self)
312	if $self->{low_water_mark} >= length $self->{wbuf}	431	if $self->{low_water_mark} >= length $self->{wbuf}
313	&& $self->{on_drain};	432	&& $self->{on_drain};
314		433
315	delete $self->{_ww} unless length $self->{wbuf};	434	delete $self->{_ww} unless length $self->{wbuf};
316	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAWOULDBLOCK) {	435	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
317	$self->error;	436	$self->_error ($!, 1);
318	}	437	}
319	};	438	};
320		439
321	# try to write data immediately	440	# try to write data immediately
322	$cb->();	441	$cb->();
…		…
342	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	461	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")
343	->($self, @_);	462	->($self, @_);
344	}	463	}
345		464
346	if ($self->{filter_w}) {	465	if ($self->{filter_w}) {
347	$self->{filter_w}->($self, \$_[0]);	466	$self->{filter_w}($self, \$_[0]);
348	} else {	467	} else {
349	$self->{wbuf} .= $_[0];	468	$self->{wbuf} .= $_[0];
350	$self->_drain_wbuf;	469	$self->_drain_wbuf;
351	}	470	}
352	}	471	}
353		472
354	=item $handle->push_write (type => @args)	473	=item $handle->push_write (type => @args)
355		474
356	=item $handle->unshift_write (type => @args)
357
358	Instead of formatting your data yourself, you can also let this module do	475	Instead of formatting your data yourself, you can also let this module do
359	the job by specifying a type and type-specific arguments.	476	the job by specifying a type and type-specific arguments.
360		477
361	Predefined types are (if you have ideas for additional types, feel free to	478	Predefined types are (if you have ideas for additional types, feel free to
362	drop by and tell us):	479	drop by and tell us):
…		…
366	=item netstring => $string	483	=item netstring => $string
367		484
368	Formats the given value as netstring	485	Formats the given value as netstring
369	(http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them).	486	(http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them).
370		487
371	=back
372
373	=cut	488	=cut
374		489
375	register_write_type netstring => sub {	490	register_write_type netstring => sub {
376	my ($self, $string) = @_;	491	my ($self, $string) = @_;
377		492
378	sprintf "%d:%s,", (length $string), $string	493	sprintf "%d:%s,", (length $string), $string
379	};	494	};
380		495
		496	=item packstring => $format, $data
		497
		498	An octet string prefixed with an encoded length. The encoding C<$format>
		499	uses the same format as a Perl C<pack> format, but must specify a single
		500	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
		501	optional C<!>, C<< < >> or C<< > >> modifier).
		502
		503	=cut
		504
		505	register_write_type packstring => sub {
		506	my ($self, $format, $string) = @_;
		507
		508	pack "$format/a*", $string
		509	};
		510
		511	=item json => $array_or_hashref
		512
		513	Encodes the given hash or array reference into a JSON object. Unless you
		514	provide your own JSON object, this means it will be encoded to JSON text
		515	in UTF-8.
		516
		517	JSON objects (and arrays) are self-delimiting, so you can write JSON at
		518	one end of a handle and read them at the other end without using any
		519	additional framing.
		520
		521	The generated JSON text is guaranteed not to contain any newlines: While
		522	this module doesn't need delimiters after or between JSON texts to be
		523	able to read them, many other languages depend on that.
		524
		525	A simple RPC protocol that interoperates easily with others is to send
		526	JSON arrays (or objects, although arrays are usually the better choice as
		527	they mimic how function argument passing works) and a newline after each
		528	JSON text:
		529
		530	$handle->push_write (json => ["method", "arg1", "arg2"]); # whatever
		531	$handle->push_write ("\012");
		532
		533	An AnyEvent::Handle receiver would simply use the C<json> read type and
		534	rely on the fact that the newline will be skipped as leading whitespace:
		535
		536	$handle->push_read (json => sub { my $array = $_[1]; ... });
		537
		538	Other languages could read single lines terminated by a newline and pass
		539	this line into their JSON decoder of choice.
		540
		541	=cut
		542
		543	register_write_type json => sub {
		544	my ($self, $ref) = @_;
		545
		546	require JSON;
		547
		548	$self->{json} ? $self->{json}->encode ($ref)
		549	: JSON::encode_json ($ref)
		550	};
		551
		552	=item storable => $reference
		553
		554	Freezes the given reference using L<Storable> and writes it to the
		555	handle. Uses the C<nfreeze> format.
		556
		557	=cut
		558
		559	register_write_type storable => sub {
		560	my ($self, $ref) = @_;
		561
		562	require Storable;
		563
		564	pack "w/a*", Storable::nfreeze ($ref)
		565	};
		566
		567	=back
		568
381	=item AnyEvent::Handle::register_write_type type => $coderef->($self, @args)	569	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
382		570
383	This function (not method) lets you add your own types to C<push_write>.	571	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	572	Whenever the given C<type> is used, C<push_write> will invoke the code
385	reference with the handle object and the remaining arguments.	573	reference with the handle object and the remaining arguments.
386		574
…		…
410	enough is there) from the read buffer (C<< $handle->rbuf >>) if you want	598	enough is there) from the read buffer (C<< $handle->rbuf >>) if you want
411	or not.	599	or not.
412		600
413	In the more complex case, you want to queue multiple callbacks. In this	601	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	602	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>,	603	data arrives (also the first time it is queued) and removes it when it has
416	below).	604	done its job (see C<push_read>, below).
417		605
418	This way you can, for example, push three line-reads, followed by reading	606	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.	607	a chunk of data, and AnyEvent::Handle will execute them in order.
420		608
421	Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by	609	Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by
422	the specified number of bytes which give an XML datagram.	610	the specified number of bytes which give an XML datagram.
423		611
424	# in the default state, expect some header bytes	612	# in the default state, expect some header bytes
425	$handle->on_read (sub {	613	$handle->on_read (sub {
426	# some data is here, now queue the length-header-read (4 octets)	614	# some data is here, now queue the length-header-read (4 octets)
427	shift->unshift_read_chunk (4, sub {	615	shift->unshift_read (chunk => 4, sub {
428	# header arrived, decode	616	# header arrived, decode
429	my $len = unpack "N", $_[1];	617	my $len = unpack "N", $_[1];
430		618
431	# now read the payload	619	# now read the payload
432	shift->unshift_read_chunk ($len, sub {	620	shift->unshift_read (chunk => $len, sub {
433	my $xml = $_[1];	621	my $xml = $_[1];
434	# handle xml	622	# handle xml
435	});	623	});
436	});	624	});
437	});	625	});
…		…
444		632
445	# request one	633	# request one
446	$handle->push_write ("request 1\015\012");	634	$handle->push_write ("request 1\015\012");
447		635
448	# we expect "ERROR" or "OK" as response, so push a line read	636	# we expect "ERROR" or "OK" as response, so push a line read
449	$handle->push_read_line (sub {	637	$handle->push_read (line => sub {
450	# if we got an "OK", we have to _prepend_ another line,	638	# 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	639	# 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	640	# which are already in the queue when this callback is called
453	# we don't do this in case we got an error	641	# we don't do this in case we got an error
454	if ($_[1] eq "OK") {	642	if ($_[1] eq "OK") {
455	$_[0]->unshift_read_line (sub {	643	$_[0]->unshift_read (line => sub {
456	my $response = $_[1];	644	my $response = $_[1];
457	...	645	...
458	});	646	});
459	}	647	}
460	});	648	});
461		649
462	# request two	650	# request two
463	$handle->push_write ("request 2\015\012");	651	$handle->push_write ("request 2\015\012");
464		652
465	# simply read 64 bytes, always	653	# simply read 64 bytes, always
466	$handle->push_read_chunk (64, sub {	654	$handle->push_read (chunk => 64, sub {
467	my $response = $_[1];	655	my $response = $_[1];
468	...	656	...
469	});	657	});
470		658
471	=over 4	659	=over 4
472		660
473	=cut	661	=cut
474		662
475	sub _drain_rbuf {	663	sub _drain_rbuf {
476	my ($self) = @_;	664	my ($self) = @_;
		665
		666	local $self->{_in_drain} = 1;
477		667
478	if (	668	if (
479	defined $self->{rbuf_max}	669	defined $self->{rbuf_max}
480	&& $self->{rbuf_max} < length $self->{rbuf}	670	&& $self->{rbuf_max} < length $self->{rbuf}
481	) {	671	) {
482	$! = &Errno::ENOSPC;	672	return $self->_error (&Errno::ENOSPC, 1);
483	$self->error;
484	}	673	}
485		674
486	return if $self->{in_drain};	675	while () {
487	local $self->{in_drain} = 1;
488
489	while (my $len = length $self->{rbuf}) {
490	no strict 'refs';	676	no strict 'refs';
		677
		678	my $len = length $self->{rbuf};
		679
491	if (my $cb = shift @{ $self->{_queue} }) {	680	if (my $cb = shift @{ $self->{_queue} }) {
492	unless ($cb->($self)) {	681	unless ($cb->($self)) {
493	if ($self->{_eof}) {	682	if ($self->{_eof}) {
494	# no progress can be made (not enough data and no data forthcoming)	683	# no progress can be made (not enough data and no data forthcoming)
495	$! = &Errno::EPIPE;	684	$self->_error (&Errno::EPIPE, 1), last;
496	$self->error;
497	}	685	}
498		686
499	unshift @{ $self->{_queue} }, $cb;	687	unshift @{ $self->{_queue} }, $cb;
500	return;	688	last;
501	}	689	}
502	} elsif ($self->{on_read}) {	690	} elsif ($self->{on_read}) {
		691	last unless $len;
		692
503	$self->{on_read}($self);	693	$self->{on_read}($self);
504		694
505	if (	695	if (
506	$self->{_eof} # if no further data will arrive
507	&& $len == length $self->{rbuf} # and no data has been consumed	696	$len == length $self->{rbuf} # if no data has been consumed
508	&& !@{ $self->{_queue} } # and the queue is still empty	697	&& !@{ $self->{_queue} } # and the queue is still empty
509	&& $self->{on_read} # and we still want to read data	698	&& $self->{on_read} # but we still have on_read
510	) {	699	) {
		700	# no further data will arrive
511	# then no progress can be made	701	# so no progress can be made
512	$! = &Errno::EPIPE;	702	$self->_error (&Errno::EPIPE, 1), last
513	$self->error;	703	if $self->{_eof};
		704
		705	last; # more data might arrive
514	}	706	}
515	} else {	707	} else {
516	# read side becomes idle	708	# read side becomes idle
517	delete $self->{_rw};	709	delete $self->{_rw};
518	return;	710	last;
519	}	711	}
520	}	712	}
521		713
522	if ($self->{_eof}) {
523	$self->_shutdown;
524	$self->{on_eof}($self)	714	$self->{on_eof}($self)
525	if $self->{on_eof};	715	if $self->{_eof} && $self->{on_eof};
		716
		717	# may need to restart read watcher
		718	unless ($self->{_rw}) {
		719	$self->start_read
		720	if $self->{on_read} \|\| @{ $self->{_queue} };
526	}	721	}
527	}	722	}
528		723
529	=item $handle->on_read ($cb)	724	=item $handle->on_read ($cb)
530		725
…		…
536		731
537	sub on_read {	732	sub on_read {
538	my ($self, $cb) = @_;	733	my ($self, $cb) = @_;
539		734
540	$self->{on_read} = $cb;	735	$self->{on_read} = $cb;
		736	$self->_drain_rbuf if $cb && !$self->{_in_drain};
541	}	737	}
542		738
543	=item $handle->rbuf	739	=item $handle->rbuf
544		740
545	Returns the read buffer (as a modifiable lvalue).	741	Returns the read buffer (as a modifiable lvalue).
…		…
594	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	790	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
595	->($self, $cb, @_);	791	->($self, $cb, @_);
596	}	792	}
597		793
598	push @{ $self->{_queue} }, $cb;	794	push @{ $self->{_queue} }, $cb;
599	$self->_drain_rbuf;	795	$self->_drain_rbuf unless $self->{_in_drain};
600	}	796	}
601		797
602	sub unshift_read {	798	sub unshift_read {
603	my $self = shift;	799	my $self = shift;
604	my $cb = pop;	800	my $cb = pop;
…		…
610	->($self, $cb, @_);	806	->($self, $cb, @_);
611	}	807	}
612		808
613		809
614	unshift @{ $self->{_queue} }, $cb;	810	unshift @{ $self->{_queue} }, $cb;
615	$self->_drain_rbuf;	811	$self->_drain_rbuf unless $self->{_in_drain};
616	}	812	}
617		813
618	=item $handle->push_read (type => @args, $cb)	814	=item $handle->push_read (type => @args, $cb)
619		815
620	=item $handle->unshift_read (type => @args, $cb)	816	=item $handle->unshift_read (type => @args, $cb)
…		…
626	Predefined types are (if you have ideas for additional types, feel free to	822	Predefined types are (if you have ideas for additional types, feel free to
627	drop by and tell us):	823	drop by and tell us):
628		824
629	=over 4	825	=over 4
630		826
631	=item chunk => $octets, $cb->($self, $data)	827	=item chunk => $octets, $cb->($handle, $data)
632		828
633	Invoke the callback only once C<$octets> bytes have been read. Pass the	829	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	830	data read to the callback. The callback will never be called with less
635	data.	831	data.
636		832
…		…
659		855
660	sub unshift_read_chunk {	856	sub unshift_read_chunk {
661	$_[0]->unshift_read (chunk => $_[1], $_[2]);	857	$_[0]->unshift_read (chunk => $_[1], $_[2]);
662	}	858	}
663		859
664	=item line => [$eol, ]$cb->($self, $line, $eol)	860	=item line => [$eol, ]$cb->($handle, $line, $eol)
665		861
666	The callback will be called only once a full line (including the end of	862	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	863	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	864	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>).	865	the end of line marker as the third argument (C<$eol>).
…		…
706	sub unshift_read_line {	902	sub unshift_read_line {
707	my $self = shift;	903	my $self = shift;
708	$self->unshift_read (line => @_);	904	$self->unshift_read (line => @_);
709	}	905	}
710		906
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)	907	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
750		908
751	Makes a regex match against the regex object C<$accept> and returns	909	Makes a regex match against the regex object C<$accept> and returns
752	everything up to and including the match.	910	everything up to and including the match.
753		911
754	Example: read a single line terminated by '\n'.	912	Example: read a single line terminated by '\n'.
…		…
802	return 1;	960	return 1;
803	}	961	}
804		962
805	# reject	963	# reject
806	if ($reject && $$rbuf =~ $reject) {	964	if ($reject && $$rbuf =~ $reject) {
807	$! = &Errno::EBADMSG;	965	$self->_error (&Errno::EBADMSG);
808	$self->error;
809	}	966	}
810		967
811	# skip	968	# skip
812	if ($skip && $$rbuf =~ $skip) {	969	if ($skip && $$rbuf =~ $skip) {
813	$data .= substr $$rbuf, 0, $+[0], "";	970	$data .= substr $$rbuf, 0, $+[0], "";
…		…
815		972
816	()	973	()
817	}	974	}
818	};	975	};
819		976
		977	=item netstring => $cb->($handle, $string)
		978
		979	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
		980
		981	Throws an error with C<$!> set to EBADMSG on format violations.
		982
		983	=cut
		984
		985	register_read_type netstring => sub {
		986	my ($self, $cb) = @_;
		987
		988	sub {
		989	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
		990	if ($_[0]{rbuf} =~ /[^0-9]/) {
		991	$self->_error (&Errno::EBADMSG);
		992	}
		993	return;
		994	}
		995
		996	my $len = $1;
		997
		998	$self->unshift_read (chunk => $len, sub {
		999	my $string = $_[1];
		1000	$_[0]->unshift_read (chunk => 1, sub {
		1001	if ($_[1] eq ",") {
		1002	$cb->($_[0], $string);
		1003	} else {
		1004	$self->_error (&Errno::EBADMSG);
		1005	}
		1006	});
		1007	});
		1008
		1009	1
		1010	}
		1011	};
		1012
		1013	=item packstring => $format, $cb->($handle, $string)
		1014
		1015	An octet string prefixed with an encoded length. The encoding C<$format>
		1016	uses the same format as a Perl C<pack> format, but must specify a single
		1017	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
		1018	optional C<!>, C<< < >> or C<< > >> modifier).
		1019
		1020	DNS over TCP uses a prefix of C<n>, EPP uses a prefix of C<N>.
		1021
		1022	Example: read a block of data prefixed by its length in BER-encoded
		1023	format (very efficient).
		1024
		1025	$handle->push_read (packstring => "w", sub {
		1026	my ($handle, $data) = @_;
		1027	});
		1028
		1029	=cut
		1030
		1031	register_read_type packstring => sub {
		1032	my ($self, $cb, $format) = @_;
		1033
		1034	sub {
		1035	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
		1036	defined (my $len = eval { unpack $format, $_[0]->{rbuf} })
		1037	or return;
		1038
		1039	# remove prefix
		1040	substr $_[0]->{rbuf}, 0, (length pack $format, $len), "";
		1041
		1042	# read rest
		1043	$_[0]->unshift_read (chunk => $len, $cb);
		1044
		1045	1
		1046	}
		1047	};
		1048
		1049	=item json => $cb->($handle, $hash_or_arrayref)
		1050
		1051	Reads a JSON object or array, decodes it and passes it to the callback.
		1052
		1053	If a C<json> object was passed to the constructor, then that will be used
		1054	for the final decode, otherwise it will create a JSON coder expecting UTF-8.
		1055
		1056	This read type uses the incremental parser available with JSON version
		1057	2.09 (and JSON::XS version 2.2) and above. You have to provide a
		1058	dependency on your own: this module will load the JSON module, but
		1059	AnyEvent does not depend on it itself.
		1060
		1061	Since JSON texts are fully self-delimiting, the C<json> read and write
		1062	types are an ideal simple RPC protocol: just exchange JSON datagrams. See
		1063	the C<json> write type description, above, for an actual example.
		1064
		1065	=cut
		1066
		1067	register_read_type json => sub {
		1068	my ($self, $cb) = @_;
		1069
		1070	require JSON;
		1071
		1072	my $data;
		1073	my $rbuf = \$self->{rbuf};
		1074
		1075	my $json = $self->{json} \|\|= JSON->new->utf8;
		1076
		1077	sub {
		1078	my $ref = $json->incr_parse ($self->{rbuf});
		1079
		1080	if ($ref) {
		1081	$self->{rbuf} = $json->incr_text;
		1082	$json->incr_text = "";
		1083	$cb->($self, $ref);
		1084
		1085	1
		1086	} else {
		1087	$self->{rbuf} = "";
		1088	()
		1089	}
		1090	}
		1091	};
		1092
		1093	=item storable => $cb->($handle, $ref)
		1094
		1095	Deserialises a L<Storable> frozen representation as written by the
		1096	C<storable> write type (BER-encoded length prefix followed by nfreeze'd
		1097	data).
		1098
		1099	Raises C<EBADMSG> error if the data could not be decoded.
		1100
		1101	=cut
		1102
		1103	register_read_type storable => sub {
		1104	my ($self, $cb) = @_;
		1105
		1106	require Storable;
		1107
		1108	sub {
		1109	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
		1110	defined (my $len = eval { unpack "w", $_[0]->{rbuf} })
		1111	or return;
		1112
		1113	# remove prefix
		1114	substr $_[0]->{rbuf}, 0, (length pack "w", $len), "";
		1115
		1116	# read rest
		1117	$_[0]->unshift_read (chunk => $len, sub {
		1118	if (my $ref = eval { Storable::thaw ($_[1]) }) {
		1119	$cb->($_[0], $ref);
		1120	} else {
		1121	$self->_error (&Errno::EBADMSG);
		1122	}
		1123	});
		1124	}
		1125	};
		1126
820	=back	1127	=back
821		1128
822	=item AnyEvent::Handle::register_read_type type => $coderef->($self, $cb, @args)	1129	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)
823		1130
824	This function (not method) lets you add your own types to C<push_read>.	1131	This function (not method) lets you add your own types to C<push_read>.
825		1132
826	Whenever the given C<type> is used, C<push_read> will invoke the code	1133	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	1134	reference with the handle object, the callback and the remaining
…		…
829		1136
830	The code reference is supposed to return a callback (usually a closure)	1137	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) >>).	1138	that works as a plain read callback (see C<< ->push_read ($cb) >>).
832		1139
833	It should invoke the passed callback when it is done reading (remember to	1140	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).	1141	pass C<$handle> as first argument as all other callbacks do that).
835		1142
836	Note that this is a function, and all types registered this way will be	1143	Note that this is a function, and all types registered this way will be
837	global, so try to use unique names.	1144	global, so try to use unique names.
838		1145
839	For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>,	1146	For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>,
…		…
842	=item $handle->stop_read	1149	=item $handle->stop_read
843		1150
844	=item $handle->start_read	1151	=item $handle->start_read
845		1152
846	In rare cases you actually do not want to read anything from the	1153	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	1154	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	1155	any queued callbacks will be executed then. To start reading again, call
849	C<start_read>.	1156	C<start_read>.
		1157
		1158	Note that AnyEvent::Handle will automatically C<start_read> for you when
		1159	you change the C<on_read> callback or push/unshift a read callback, and it
		1160	will automatically C<stop_read> for you when neither C<on_read> is set nor
		1161	there are any read requests in the queue.
850		1162
851	=cut	1163	=cut
852		1164
853	sub stop_read {	1165	sub stop_read {
854	my ($self) = @_;	1166	my ($self) = @_;
…		…
865	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1177	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
866	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1178	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};
867	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;	1179	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;
868		1180
869	if ($len > 0) {	1181	if ($len > 0) {
		1182	$self->{_activity} = AnyEvent->now;
		1183
870	$self->{filter_r}	1184	$self->{filter_r}
871	? $self->{filter_r}->($self, $rbuf)	1185	? $self->{filter_r}($self, $rbuf)
872	: $self->_drain_rbuf;	1186	: $self->{_in_drain} \|\| $self->_drain_rbuf;
873		1187
874	} elsif (defined $len) {	1188	} elsif (defined $len) {
875	delete $self->{_rw};	1189	delete $self->{_rw};
876	$self->{_eof} = 1;	1190	$self->{_eof} = 1;
877	$self->_drain_rbuf;	1191	$self->_drain_rbuf unless $self->{_in_drain};
878		1192
879	} elsif ($! != EAGAIN && $! != EINTR && $! != &AnyEvent::Util::WSAWOULDBLOCK) {	1193	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
880	return $self->error;	1194	return $self->_error ($!, 1);
881	}	1195	}
882	});	1196	});
883	}	1197	}
884	}	1198	}
885		1199
886	sub _dotls {	1200	sub _dotls {
887	my ($self) = @_;	1201	my ($self) = @_;
		1202
		1203	my $buf;
888		1204
889	if (length $self->{_tls_wbuf}) {	1205	if (length $self->{_tls_wbuf}) {
890	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1206	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
891	substr $self->{_tls_wbuf}, 0, $len, "";	1207	substr $self->{_tls_wbuf}, 0, $len, "";
892	}	1208	}
893	}	1209	}
894		1210
895	if (defined (my $buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1211	if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {
896	$self->{wbuf} .= $buf;	1212	$self->{wbuf} .= $buf;
897	$self->_drain_wbuf;	1213	$self->_drain_wbuf;
898	}	1214	}
899		1215
900	while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) {	1216	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {
		1217	if (length $buf) {
901	$self->{rbuf} .= $buf;	1218	$self->{rbuf} .= $buf;
902	$self->_drain_rbuf;	1219	$self->_drain_rbuf unless $self->{_in_drain};
		1220	} else {
		1221	# let's treat SSL-eof as we treat normal EOF
		1222	$self->{_eof} = 1;
		1223	$self->_shutdown;
		1224	return;
		1225	}
903	}	1226	}
904		1227
905	my $err = Net::SSLeay::get_error ($self->{tls}, -1);	1228	my $err = Net::SSLeay::get_error ($self->{tls}, -1);
906		1229
907	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {	1230	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
908	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {	1231	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {
909	$self->error;	1232	return $self->_error ($!, 1);
910	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {	1233	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {
911	$! = &Errno::EIO;	1234	return $self->_error (&Errno::EIO, 1);
912	$self->error;
913	}	1235	}
914		1236
915	# all others are fine for our purposes	1237	# all others are fine for our purposes
916	}	1238	}
917	}	1239	}
…		…
932	call and can be used or changed to your liking. Note that the handshake	1254	call and can be used or changed to your liking. Note that the handshake
933	might have already started when this function returns.	1255	might have already started when this function returns.
934		1256
935	=cut	1257	=cut
936		1258
937	# TODO: maybe document...
938	sub starttls {	1259	sub starttls {
939	my ($self, $ssl, $ctx) = @_;	1260	my ($self, $ssl, $ctx) = @_;
940		1261
941	$self->stoptls;	1262	$self->stoptls;
942		1263
…		…
995		1316
996	sub DESTROY {	1317	sub DESTROY {
997	my $self = shift;	1318	my $self = shift;
998		1319
999	$self->stoptls;	1320	$self->stoptls;
		1321
		1322	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
		1323
		1324	if ($linger && length $self->{wbuf}) {
		1325	my $fh = delete $self->{fh};
		1326	my $wbuf = delete $self->{wbuf};
		1327
		1328	my @linger;
		1329
		1330	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {
		1331	my $len = syswrite $fh, $wbuf, length $wbuf;
		1332
		1333	if ($len > 0) {
		1334	substr $wbuf, 0, $len, "";
		1335	} else {
		1336	@linger = (); # end
		1337	}
		1338	});
		1339	push @linger, AnyEvent->timer (after => $linger, cb => sub {
		1340	@linger = ();
		1341	});
		1342	}
1000	}	1343	}
1001		1344
1002	=item AnyEvent::Handle::TLS_CTX	1345	=item AnyEvent::Handle::TLS_CTX
1003		1346
1004	This function creates and returns the Net::SSLeay::CTX object used by	1347	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.38 by root, Mon May 26 21:28:33 2008 UTC vs. Revision 1.67 by root, Fri Jun 6 15:33:10 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.67 by root, Fri Jun 6 15:33:10 2008 UTC