[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.56 by root, Wed Jun 4 09:55:16 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.12;
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.
109		111
110	To access (and remove data from) the read buffer, use the C<< ->rbuf >>	112	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
111	method or access the C<$self->{rbuf}> member directly.	113	method or access the C<$handle->{rbuf}> member directly.
112		114
113	When an EOF condition is detected then AnyEvent::Handle will first try to	115	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	116	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	117	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>).	118	error will be raised (with C<$!> set to C<EPIPE>).
117		119
118	=item on_drain => $cb->()	120	=item on_drain => $cb->($handle)
119		121
120	This sets the callback that is called when the write buffer becomes empty	122	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).	123	(or when the callback is set and the buffer is empty already).
122		124
123	To append to the write buffer, use the C<< ->push_write >> method.	125	To append to the write buffer, use the C<< ->push_write >> method.
		126
		127	=item timeout => $fractional_seconds
		128
		129	If non-zero, then this enables an "inactivity" timeout: whenever this many
		130	seconds pass without a successful read or write on the underlying file
		131	handle, the C<on_timeout> callback will be invoked (and if that one is
		132	missing, an C<ETIMEDOUT> error will be raised).
		133
		134	Note that timeout processing is also active when you currently do not have
		135	any outstanding read or write requests: If you plan to keep the connection
		136	idle then you should disable the timout temporarily or ignore the timeout
		137	in the C<on_timeout> callback.
		138
		139	Zero (the default) disables this timeout.
		140
		141	=item on_timeout => $cb->($handle)
		142
		143	Called whenever the inactivity timeout passes. If you return from this
		144	callback, then the timeout will be reset as if some activity had happened,
		145	so this condition is not fatal in any way.
124		146
125	=item rbuf_max => <bytes>	147	=item rbuf_max => <bytes>
126		148
127	If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)	149	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	150	when the read buffer ever (strictly) exceeds this size. This is useful to
…		…
135	isn't finished).	157	isn't finished).
136		158
137	=item read_size => <bytes>	159	=item read_size => <bytes>
138		160
139	The default read block size (the amount of bytes this module will try to read	161	The default read block size (the amount of bytes this module will try to read
140	on each [loop iteration). Default: C<4096>.	162	during each (loop iteration). Default: C<8192>.
141		163
142	=item low_water_mark => <bytes>	164	=item low_water_mark => <bytes>
143		165
144	Sets the amount of bytes (default: C<0>) that make up an "empty" write	166	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	167	buffer: If the write reaches this size or gets even samller it is
…		…
168		190
169	Use the given Net::SSLeay::CTX object to create the new TLS connection	191	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	192	(unless a connection object was specified directly). If this parameter is
171	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	193	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
172		194
		195	=item json => JSON or JSON::XS object
		196
		197	This is the json coder object used by the C<json> read and write types.
		198
		199	If you don't supply it, then AnyEvent::Handle will create and use a
		200	suitable one, which will write and expect UTF-8 encoded JSON texts.
		201
		202	Note that you are responsible to depend on the JSON module if you want to
		203	use this functionality, as AnyEvent does not have a dependency itself.
		204
173	=item filter_r => $cb	205	=item filter_r => $cb
174		206
175	=item filter_w => $cb	207	=item filter_w => $cb
176		208
177	These exist, but are undocumented at this time.	209	These exist, but are undocumented at this time.
…		…
192	if ($self->{tls}) {	224	if ($self->{tls}) {
193	require Net::SSLeay;	225	require Net::SSLeay;
194	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});	226	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});
195	}	227	}
196		228
197	$self->on_eof (delete $self->{on_eof} ) if $self->{on_eof};	229	# $self->on_eof (delete $self->{on_eof} ) if $self->{on_eof}; # nop
198	$self->on_error (delete $self->{on_error}) if $self->{on_error};	230	# $self->on_error (delete $self->{on_error}) if $self->{on_error}; # nop
		231	# $self->on_read (delete $self->{on_read} ) if $self->{on_read}; # nop
199	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	232	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
200	$self->on_read (delete $self->{on_read} ) if $self->{on_read};	233
		234	$self->{_activity} = AnyEvent->now;
		235	$self->_timeout;
201		236
202	$self->start_read;	237	$self->start_read;
203		238
204	$self	239	$self
205	}	240	}
206		241
207	sub _shutdown {	242	sub _shutdown {
208	my ($self) = @_;	243	my ($self) = @_;
209		244
		245	delete $self->{_tw};
210	delete $self->{_rw};	246	delete $self->{_rw};
211	delete $self->{_ww};	247	delete $self->{_ww};
212	delete $self->{fh};	248	delete $self->{fh};
213	}
214		249
		250	$self->stoptls;
		251	}
		252
215	sub error {	253	sub _error {
216	my ($self) = @_;	254	my ($self, $errno, $fatal) = @_;
217		255
218	{
219	local $!;
220	$self->_shutdown;	256	$self->_shutdown
221	}	257	if $fatal;
222		258
223	$self->{on_error}($self)	259	$! = $errno;
		260
224	if $self->{on_error};	261	if ($self->{on_error}) {
225		262	$self->{on_error}($self, $fatal);
		263	} else {
226	Carp::croak "AnyEvent::Handle uncaught fatal error: $!";	264	Carp::croak "AnyEvent::Handle uncaught error: $!";
		265	}
227	}	266	}
228		267
229	=item $fh = $handle->fh	268	=item $fh = $handle->fh
230		269
231	This method returns the file handle of the L<AnyEvent::Handle> object.	270	This method returns the file handle of the L<AnyEvent::Handle> object.
…		…
250		289
251	=cut	290	=cut
252		291
253	sub on_eof {	292	sub on_eof {
254	$_[0]{on_eof} = $_[1];	293	$_[0]{on_eof} = $_[1];
		294	}
		295
		296	=item $handle->on_timeout ($cb)
		297
		298	Replace the current C<on_timeout> callback, or disables the callback
		299	(but not the timeout) if C<$cb> = C<undef>. See C<timeout> constructor
		300	argument.
		301
		302	=cut
		303
		304	sub on_timeout {
		305	$_[0]{on_timeout} = $_[1];
		306	}
		307
		308	#############################################################################
		309
		310	=item $handle->timeout ($seconds)
		311
		312	Configures (or disables) the inactivity timeout.
		313
		314	=cut
		315
		316	sub timeout {
		317	my ($self, $timeout) = @_;
		318
		319	$self->{timeout} = $timeout;
		320	$self->_timeout;
		321	}
		322
		323	# reset the timeout watcher, as neccessary
		324	# also check for time-outs
		325	sub _timeout {
		326	my ($self) = @_;
		327
		328	if ($self->{timeout}) {
		329	my $NOW = AnyEvent->now;
		330
		331	# when would the timeout trigger?
		332	my $after = $self->{_activity} + $self->{timeout} - $NOW;
		333
		334	# now or in the past already?
		335	if ($after <= 0) {
		336	$self->{_activity} = $NOW;
		337
		338	if ($self->{on_timeout}) {
		339	$self->{on_timeout}($self);
		340	} else {
		341	$self->_error (&Errno::ETIMEDOUT);
		342	}
		343
		344	# callback could have changed timeout value, optimise
		345	return unless $self->{timeout};
		346
		347	# calculate new after
		348	$after = $self->{timeout};
		349	}
		350
		351	Scalar::Util::weaken $self;
		352	return unless $self; # ->error could have destroyed $self
		353
		354	$self->{_tw} \|\|= AnyEvent->timer (after => $after, cb => sub {
		355	delete $self->{_tw};
		356	$self->_timeout;
		357	});
		358	} else {
		359	delete $self->{_tw};
		360	}
255	}	361	}
256		362
257	#############################################################################	363	#############################################################################
258		364
259	=back	365	=back
…		…
306	my $len = syswrite $self->{fh}, $self->{wbuf};	412	my $len = syswrite $self->{fh}, $self->{wbuf};
307		413
308	if ($len >= 0) {	414	if ($len >= 0) {
309	substr $self->{wbuf}, 0, $len, "";	415	substr $self->{wbuf}, 0, $len, "";
310		416
		417	$self->{_activity} = AnyEvent->now;
		418
311	$self->{on_drain}($self)	419	$self->{on_drain}($self)
312	if $self->{low_water_mark} >= length $self->{wbuf}	420	if $self->{low_water_mark} >= length $self->{wbuf}
313	&& $self->{on_drain};	421	&& $self->{on_drain};
314		422
315	delete $self->{_ww} unless length $self->{wbuf};	423	delete $self->{_ww} unless length $self->{wbuf};
316	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAWOULDBLOCK) {	424	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
317	$self->error;	425	$self->_error ($!, 1);
318	}	426	}
319	};	427	};
320		428
321	# try to write data immediately	429	# try to write data immediately
322	$cb->();	430	$cb->();
…		…
342	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	450	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")
343	->($self, @_);	451	->($self, @_);
344	}	452	}
345		453
346	if ($self->{filter_w}) {	454	if ($self->{filter_w}) {
347	$self->{filter_w}->($self, \$_[0]);	455	$self->{filter_w}($self, \$_[0]);
348	} else {	456	} else {
349	$self->{wbuf} .= $_[0];	457	$self->{wbuf} .= $_[0];
350	$self->_drain_wbuf;	458	$self->_drain_wbuf;
351	}	459	}
352	}	460	}
353		461
354	=item $handle->push_write (type => @args)	462	=item $handle->push_write (type => @args)
355		463
356	=item $handle->unshift_write (type => @args)
357
358	Instead of formatting your data yourself, you can also let this module do	464	Instead of formatting your data yourself, you can also let this module do
359	the job by specifying a type and type-specific arguments.	465	the job by specifying a type and type-specific arguments.
360		466
361	Predefined types are (if you have ideas for additional types, feel free to	467	Predefined types are (if you have ideas for additional types, feel free to
362	drop by and tell us):	468	drop by and tell us):
…		…
366	=item netstring => $string	472	=item netstring => $string
367		473
368	Formats the given value as netstring	474	Formats the given value as netstring
369	(http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them).	475	(http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them).
370		476
371	=back
372
373	=cut	477	=cut
374		478
375	register_write_type netstring => sub {	479	register_write_type netstring => sub {
376	my ($self, $string) = @_;	480	my ($self, $string) = @_;
377		481
378	sprintf "%d:%s,", (length $string), $string	482	sprintf "%d:%s,", (length $string), $string
379	};	483	};
380		484
		485	=item json => $array_or_hashref
		486
		487	Encodes the given hash or array reference into a JSON object. Unless you
		488	provide your own JSON object, this means it will be encoded to JSON text
		489	in UTF-8.
		490
		491	JSON objects (and arrays) are self-delimiting, so you can write JSON at
		492	one end of a handle and read them at the other end without using any
		493	additional framing.
		494
		495	The generated JSON text is guaranteed not to contain any newlines: While
		496	this module doesn't need delimiters after or between JSON texts to be
		497	able to read them, many other languages depend on that.
		498
		499	A simple RPC protocol that interoperates easily with others is to send
		500	JSON arrays (or objects, although arrays are usually the better choice as
		501	they mimic how function argument passing works) and a newline after each
		502	JSON text:
		503
		504	$handle->push_write (json => ["method", "arg1", "arg2"]); # whatever
		505	$handle->push_write ("\012");
		506
		507	An AnyEvent::Handle receiver would simply use the C<json> read type and
		508	rely on the fact that the newline will be skipped as leading whitespace:
		509
		510	$handle->push_read (json => sub { my $array = $_[1]; ... });
		511
		512	Other languages could read single lines terminated by a newline and pass
		513	this line into their JSON decoder of choice.
		514
		515	=cut
		516
		517	register_write_type json => sub {
		518	my ($self, $ref) = @_;
		519
		520	require JSON;
		521
		522	$self->{json} ? $self->{json}->encode ($ref)
		523	: JSON::encode_json ($ref)
		524	};
		525
		526	=back
		527
381	=item AnyEvent::Handle::register_write_type type => $coderef->($self, @args)	528	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
382		529
383	This function (not method) lets you add your own types to C<push_write>.	530	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	531	Whenever the given C<type> is used, C<push_write> will invoke the code
385	reference with the handle object and the remaining arguments.	532	reference with the handle object and the remaining arguments.
386		533
…		…
422	the specified number of bytes which give an XML datagram.	569	the specified number of bytes which give an XML datagram.
423		570
424	# in the default state, expect some header bytes	571	# in the default state, expect some header bytes
425	$handle->on_read (sub {	572	$handle->on_read (sub {
426	# some data is here, now queue the length-header-read (4 octets)	573	# some data is here, now queue the length-header-read (4 octets)
427	shift->unshift_read_chunk (4, sub {	574	shift->unshift_read (chunk => 4, sub {
428	# header arrived, decode	575	# header arrived, decode
429	my $len = unpack "N", $_[1];	576	my $len = unpack "N", $_[1];
430		577
431	# now read the payload	578	# now read the payload
432	shift->unshift_read_chunk ($len, sub {	579	shift->unshift_read (chunk => $len, sub {
433	my $xml = $_[1];	580	my $xml = $_[1];
434	# handle xml	581	# handle xml
435	});	582	});
436	});	583	});
437	});	584	});
…		…
444		591
445	# request one	592	# request one
446	$handle->push_write ("request 1\015\012");	593	$handle->push_write ("request 1\015\012");
447		594
448	# we expect "ERROR" or "OK" as response, so push a line read	595	# we expect "ERROR" or "OK" as response, so push a line read
449	$handle->push_read_line (sub {	596	$handle->push_read (line => sub {
450	# if we got an "OK", we have to _prepend_ another line,	597	# 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	598	# 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	599	# which are already in the queue when this callback is called
453	# we don't do this in case we got an error	600	# we don't do this in case we got an error
454	if ($_[1] eq "OK") {	601	if ($_[1] eq "OK") {
455	$_[0]->unshift_read_line (sub {	602	$_[0]->unshift_read (line => sub {
456	my $response = $_[1];	603	my $response = $_[1];
457	...	604	...
458	});	605	});
459	}	606	}
460	});	607	});
461		608
462	# request two	609	# request two
463	$handle->push_write ("request 2\015\012");	610	$handle->push_write ("request 2\015\012");
464		611
465	# simply read 64 bytes, always	612	# simply read 64 bytes, always
466	$handle->push_read_chunk (64, sub {	613	$handle->push_read (chunk => 64, sub {
467	my $response = $_[1];	614	my $response = $_[1];
468	...	615	...
469	});	616	});
470		617
471	=over 4	618	=over 4
…		…
477		624
478	if (	625	if (
479	defined $self->{rbuf_max}	626	defined $self->{rbuf_max}
480	&& $self->{rbuf_max} < length $self->{rbuf}	627	&& $self->{rbuf_max} < length $self->{rbuf}
481	) {	628	) {
482	$! = &Errno::ENOSPC;	629	return $self->_error (&Errno::ENOSPC, 1);
483	$self->error;
484	}	630	}
485		631
486	return if $self->{in_drain};	632	return if $self->{in_drain};
487	local $self->{in_drain} = 1;	633	local $self->{in_drain} = 1;
488		634
…		…
490	no strict 'refs';	636	no strict 'refs';
491	if (my $cb = shift @{ $self->{_queue} }) {	637	if (my $cb = shift @{ $self->{_queue} }) {
492	unless ($cb->($self)) {	638	unless ($cb->($self)) {
493	if ($self->{_eof}) {	639	if ($self->{_eof}) {
494	# no progress can be made (not enough data and no data forthcoming)	640	# no progress can be made (not enough data and no data forthcoming)
495	$! = &Errno::EPIPE;	641	return $self->_error (&Errno::EPIPE, 1);
496	$self->error;
497	}	642	}
498		643
499	unshift @{ $self->{_queue} }, $cb;	644	unshift @{ $self->{_queue} }, $cb;
500	return;	645	last;
501	}	646	}
502	} elsif ($self->{on_read}) {	647	} elsif ($self->{on_read}) {
503	$self->{on_read}($self);	648	$self->{on_read}($self);
504		649
505	if (	650	if (
506	$self->{_eof} # if no further data will arrive
507	&& $len == length $self->{rbuf} # and no data has been consumed	651	$len == length $self->{rbuf} # if no data has been consumed
508	&& !@{ $self->{_queue} } # and the queue is still empty	652	&& !@{ $self->{_queue} } # and the queue is still empty
509	&& $self->{on_read} # and we still want to read data	653	&& $self->{on_read} # but we still have on_read
510	) {	654	) {
		655	# no further data will arrive
511	# then no progress can be made	656	# so no progress can be made
512	$! = &Errno::EPIPE;	657	return $self->_error (&Errno::EPIPE, 1)
513	$self->error;	658	if $self->{_eof};
		659
		660	last; # more data might arrive
514	}	661	}
515	} else {	662	} else {
516	# read side becomes idle	663	# read side becomes idle
517	delete $self->{_rw};	664	delete $self->{_rw};
518	return;	665	last;
519	}	666	}
520	}	667	}
521		668
522	if ($self->{_eof}) {
523	$self->_shutdown;
524	$self->{on_eof}($self)	669	$self->{on_eof}($self)
525	if $self->{on_eof};	670	if $self->{_eof} && $self->{on_eof};
		671
		672	# may need to restart read watcher
		673	unless ($self->{_rw}) {
		674	$self->start_read
		675	if $self->{on_read} \|\| @{ $self->{_queue} };
526	}	676	}
527	}	677	}
528		678
529	=item $handle->on_read ($cb)	679	=item $handle->on_read ($cb)
530		680
…		…
626	Predefined types are (if you have ideas for additional types, feel free to	776	Predefined types are (if you have ideas for additional types, feel free to
627	drop by and tell us):	777	drop by and tell us):
628		778
629	=over 4	779	=over 4
630		780
631	=item chunk => $octets, $cb->($self, $data)	781	=item chunk => $octets, $cb->($handle, $data)
632		782
633	Invoke the callback only once C<$octets> bytes have been read. Pass the	783	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	784	data read to the callback. The callback will never be called with less
635	data.	785	data.
636		786
…		…
659		809
660	sub unshift_read_chunk {	810	sub unshift_read_chunk {
661	$_[0]->unshift_read (chunk => $_[1], $_[2]);	811	$_[0]->unshift_read (chunk => $_[1], $_[2]);
662	}	812	}
663		813
664	=item line => [$eol, ]$cb->($self, $line, $eol)	814	=item line => [$eol, ]$cb->($handle, $line, $eol)
665		815
666	The callback will be called only once a full line (including the end of	816	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	817	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	818	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>).	819	the end of line marker as the third argument (C<$eol>).
…		…
706	sub unshift_read_line {	856	sub unshift_read_line {
707	my $self = shift;	857	my $self = shift;
708	$self->unshift_read (line => @_);	858	$self->unshift_read (line => @_);
709	}	859	}
710		860
711	=item netstring => $cb->($string)	861	=item netstring => $cb->($handle, $string)
712		862
713	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).	863	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
714		864
715	Throws an error with C<$!> set to EBADMSG on format violations.	865	Throws an error with C<$!> set to EBADMSG on format violations.
716		866
…		…
720	my ($self, $cb) = @_;	870	my ($self, $cb) = @_;
721		871
722	sub {	872	sub {
723	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {	873	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
724	if ($_[0]{rbuf} =~ /[^0-9]/) {	874	if ($_[0]{rbuf} =~ /[^0-9]/) {
725	$! = &Errno::EBADMSG;	875	$self->_error (&Errno::EBADMSG);
726	$self->error;
727	}	876	}
728	return;	877	return;
729	}	878	}
730		879
731	my $len = $1;	880	my $len = $1;
…		…
734	my $string = $_[1];	883	my $string = $_[1];
735	$_[0]->unshift_read (chunk => 1, sub {	884	$_[0]->unshift_read (chunk => 1, sub {
736	if ($_[1] eq ",") {	885	if ($_[1] eq ",") {
737	$cb->($_[0], $string);	886	$cb->($_[0], $string);
738	} else {	887	} else {
739	$! = &Errno::EBADMSG;	888	$self->_error (&Errno::EBADMSG);
740	$self->error;
741	}	889	}
742	});	890	});
743	});	891	});
744		892
745	1	893	1
746	}	894	}
747	};	895	};
748		896
749	=item regex => $accept[, $reject[, $skip], $cb->($data)	897	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
750		898
751	Makes a regex match against the regex object C<$accept> and returns	899	Makes a regex match against the regex object C<$accept> and returns
752	everything up to and including the match.	900	everything up to and including the match.
753		901
754	Example: read a single line terminated by '\n'.	902	Example: read a single line terminated by '\n'.
…		…
802	return 1;	950	return 1;
803	}	951	}
804		952
805	# reject	953	# reject
806	if ($reject && $$rbuf =~ $reject) {	954	if ($reject && $$rbuf =~ $reject) {
807	$! = &Errno::EBADMSG;	955	$self->_error (&Errno::EBADMSG);
808	$self->error;
809	}	956	}
810		957
811	# skip	958	# skip
812	if ($skip && $$rbuf =~ $skip) {	959	if ($skip && $$rbuf =~ $skip) {
813	$data .= substr $$rbuf, 0, $+[0], "";	960	$data .= substr $$rbuf, 0, $+[0], "";
…		…
815		962
816	()	963	()
817	}	964	}
818	};	965	};
819		966
		967	=item json => $cb->($handle, $hash_or_arrayref)
		968
		969	Reads a JSON object or array, decodes it and passes it to the callback.
		970
		971	If a C<json> object was passed to the constructor, then that will be used
		972	for the final decode, otherwise it will create a JSON coder expecting UTF-8.
		973
		974	This read type uses the incremental parser available with JSON version
		975	2.09 (and JSON::XS version 2.2) and above. You have to provide a
		976	dependency on your own: this module will load the JSON module, but
		977	AnyEvent does not depend on it itself.
		978
		979	Since JSON texts are fully self-delimiting, the C<json> read and write
		980	types are an ideal simple RPC protocol: just exchange JSON datagrams. See
		981	the C<json> write type description, above, for an actual example.
		982
		983	=cut
		984
		985	register_read_type json => sub {
		986	my ($self, $cb, $accept, $reject, $skip) = @_;
		987
		988	require JSON;
		989
		990	my $data;
		991	my $rbuf = \$self->{rbuf};
		992
		993	my $json = $self->{json} \|\|= JSON->new->utf8;
		994
		995	sub {
		996	my $ref = $json->incr_parse ($self->{rbuf});
		997
		998	if ($ref) {
		999	$self->{rbuf} = $json->incr_text;
		1000	$json->incr_text = "";
		1001	$cb->($self, $ref);
		1002
		1003	1
		1004	} else {
		1005	$self->{rbuf} = "";
		1006	()
		1007	}
		1008	}
		1009	};
		1010
820	=back	1011	=back
821		1012
822	=item AnyEvent::Handle::register_read_type type => $coderef->($self, $cb, @args)	1013	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)
823		1014
824	This function (not method) lets you add your own types to C<push_read>.	1015	This function (not method) lets you add your own types to C<push_read>.
825		1016
826	Whenever the given C<type> is used, C<push_read> will invoke the code	1017	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	1018	reference with the handle object, the callback and the remaining
…		…
829		1020
830	The code reference is supposed to return a callback (usually a closure)	1021	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) >>).	1022	that works as a plain read callback (see C<< ->push_read ($cb) >>).
832		1023
833	It should invoke the passed callback when it is done reading (remember to	1024	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).	1025	pass C<$handle> as first argument as all other callbacks do that).
835		1026
836	Note that this is a function, and all types registered this way will be	1027	Note that this is a function, and all types registered this way will be
837	global, so try to use unique names.	1028	global, so try to use unique names.
838		1029
839	For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>,	1030	For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>,
…		…
846	In rare cases you actually do not want to read anything from the	1037	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	1038	socket. In this case you can call C<stop_read>. Neither C<on_read> no
848	any queued callbacks will be executed then. To start reading again, call	1039	any queued callbacks will be executed then. To start reading again, call
849	C<start_read>.	1040	C<start_read>.
850		1041
		1042	Note that AnyEvent::Handle will automatically C<start_read> for you when
		1043	you change the C<on_read> callback or push/unshift a read callback, and it
		1044	will automatically C<stop_read> for you when neither C<on_read> is set nor
		1045	there are any read requests in the queue.
		1046
851	=cut	1047	=cut
852		1048
853	sub stop_read {	1049	sub stop_read {
854	my ($self) = @_;	1050	my ($self) = @_;
855		1051
…		…
865	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1061	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
866	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1062	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};
867	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;	1063	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;
868		1064
869	if ($len > 0) {	1065	if ($len > 0) {
		1066	$self->{_activity} = AnyEvent->now;
		1067
870	$self->{filter_r}	1068	$self->{filter_r}
871	? $self->{filter_r}->($self, $rbuf)	1069	? $self->{filter_r}($self, $rbuf)
872	: $self->_drain_rbuf;	1070	: $self->_drain_rbuf;
873		1071
874	} elsif (defined $len) {	1072	} elsif (defined $len) {
875	delete $self->{_rw};	1073	delete $self->{_rw};
876	$self->{_eof} = 1;	1074	$self->{_eof} = 1;
877	$self->_drain_rbuf;	1075	$self->_drain_rbuf;
878		1076
879	} elsif ($! != EAGAIN && $! != EINTR && $! != &AnyEvent::Util::WSAWOULDBLOCK) {	1077	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
880	return $self->error;	1078	return $self->_error ($!, 1);
881	}	1079	}
882	});	1080	});
883	}	1081	}
884	}	1082	}
885		1083
886	sub _dotls {	1084	sub _dotls {
887	my ($self) = @_;	1085	my ($self) = @_;
		1086
		1087	my $buf;
888		1088
889	if (length $self->{_tls_wbuf}) {	1089	if (length $self->{_tls_wbuf}) {
890	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1090	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
891	substr $self->{_tls_wbuf}, 0, $len, "";	1091	substr $self->{_tls_wbuf}, 0, $len, "";
892	}	1092	}
893	}	1093	}
894		1094
895	if (defined (my $buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1095	if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {
896	$self->{wbuf} .= $buf;	1096	$self->{wbuf} .= $buf;
897	$self->_drain_wbuf;	1097	$self->_drain_wbuf;
898	}	1098	}
899		1099
900	while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) {	1100	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {
		1101	if (length $buf) {
901	$self->{rbuf} .= $buf;	1102	$self->{rbuf} .= $buf;
902	$self->_drain_rbuf;	1103	$self->_drain_rbuf;
		1104	} else {
		1105	# let's treat SSL-eof as we treat normal EOF
		1106	$self->{_eof} = 1;
		1107	$self->_shutdown;
		1108	return;
		1109	}
903	}	1110	}
904		1111
905	my $err = Net::SSLeay::get_error ($self->{tls}, -1);	1112	my $err = Net::SSLeay::get_error ($self->{tls}, -1);
906		1113
907	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {	1114	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
908	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {	1115	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {
909	$self->error;	1116	return $self->_error ($!, 1);
910	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {	1117	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {
911	$! = &Errno::EIO;	1118	return $self->_error (&Errno::EIO, 1);
912	$self->error;
913	}	1119	}
914		1120
915	# all others are fine for our purposes	1121	# all others are fine for our purposes
916	}	1122	}
917	}	1123	}
…		…
932	call and can be used or changed to your liking. Note that the handshake	1138	call and can be used or changed to your liking. Note that the handshake
933	might have already started when this function returns.	1139	might have already started when this function returns.
934		1140
935	=cut	1141	=cut
936		1142
937	# TODO: maybe document...
938	sub starttls {	1143	sub starttls {
939	my ($self, $ssl, $ctx) = @_;	1144	my ($self, $ssl, $ctx) = @_;
940		1145
941	$self->stoptls;	1146	$self->stoptls;
942		1147

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.56 by root, Wed Jun 4 09:55:16 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.56 by root, Wed Jun 4 09:55:16 2008 UTC