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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.40 by root, Tue May 27 05:36:27 2008 UTC vs.
Revision 1.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;
…		…
75	NOTE: The filehandle will be set to non-blocking (using	75	NOTE: The filehandle will be set to non-blocking (using
76	AnyEvent::Util::fh_nonblocking).	76	AnyEvent::Util::fh_nonblocking).
77		77
78	=item on_eof => $cb->($handle)	78	=item on_eof => $cb->($handle)
79		79
80	Set the callback to be called on EOF.	80	Set the callback to be called when an end-of-file condition is detcted,
		81	i.e. in the case of a socket, when the other side has closed the
		82	connection cleanly.
81		83
82	While not mandatory, it is highly recommended to set an eof callback,	84	While not mandatory, it is highly recommended to set an eof callback,
83	otherwise you might end up with a closed socket while you are still	85	otherwise you might end up with a closed socket while you are still
84	waiting for data.	86	waiting for data.
85		87
86	=item on_error => $cb->($handle)	88	=item on_error => $cb->($handle, $fatal)
87		89
88	This is the fatal error callback, that is called when, well, a fatal error	90	This is the error callback, which is called when, well, some error
89	occurs, such as not being able to resolve the hostname, failure to connect	91	occured, such as not being able to resolve the hostname, failure to
90	or a read error.	92	connect or a read error.
91		93
92	The object will not be in a usable state when this callback has been	94	Some errors are fatal (which is indicated by C<$fatal> being true). On
93	called.	95	fatal errors the handle object will be shut down and will not be
		96	usable. Non-fatal errors can be retried by simply returning, but it is
		97	recommended to simply ignore this parameter and instead abondon the handle
		98	object when this callback is invoked.
94		99
95	On callback entrance, the value of C<$!> contains the operating system	100	On callback entrance, the value of C<$!> contains the operating system
96	error (or C<ENOSPC>, C<EPIPE> or C<EBADMSG>).	101	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).
97
98	The callback should throw an exception. If it returns, then
99	AnyEvent::Handle will C<croak> for you.
100		102
101	While not mandatory, it is I<highly> recommended to set this callback, as	103	While not mandatory, it is I<highly> recommended to set this callback, as
102	you will not be notified of errors otherwise. The default simply calls	104	you will not be notified of errors otherwise. The default simply calls
103	die.	105	C<croak>.
104		106
105	=item on_read => $cb->($handle)	107	=item on_read => $cb->($handle)
106		108
107	This sets the default read callback, which is called when data arrives	109	This sets the default read callback, which is called when data arrives
108	and no read request is in the queue.	110	and no read request is in the queue.
…		…
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
…		…
172		194
173	=item json => JSON or JSON::XS object	195	=item json => JSON or JSON::XS object
174		196
175	This is the json coder object used by the C<json> read and write types.	197	This is the json coder object used by the C<json> read and write types.
176		198
177	If you don't supply it, then AnyEvent::Handle will use C<encode_json> and	199	If you don't supply it, then AnyEvent::Handle will create and use a
178	C<decode_json>.	200	suitable one, which will write and expect UTF-8 encoded JSON texts.
179		201
180	Note that you are responsible to depend on the JSON module if you want to	202	Note that you are responsible to depend on the JSON module if you want to
181	use this functionality, as AnyEvent does not have a dependency itself.	203	use this functionality, as AnyEvent does not have a dependency itself.
182		204
183	=item filter_r => $cb	205	=item filter_r => $cb
…		…
202	if ($self->{tls}) {	224	if ($self->{tls}) {
203	require Net::SSLeay;	225	require Net::SSLeay;
204	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});	226	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});
205	}	227	}
206		228
207	$self->on_eof (delete $self->{on_eof} ) if $self->{on_eof};	229	# $self->on_eof (delete $self->{on_eof} ) if $self->{on_eof}; # nop
208	$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
209	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	232	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
210	$self->on_read (delete $self->{on_read} ) if $self->{on_read};	233
		234	$self->{_activity} = AnyEvent->now;
		235	$self->_timeout;
211		236
212	$self->start_read;	237	$self->start_read;
213		238
214	$self	239	$self
215	}	240	}
216		241
217	sub _shutdown {	242	sub _shutdown {
218	my ($self) = @_;	243	my ($self) = @_;
219		244
		245	delete $self->{_tw};
220	delete $self->{_rw};	246	delete $self->{_rw};
221	delete $self->{_ww};	247	delete $self->{_ww};
222	delete $self->{fh};	248	delete $self->{fh};
223	}
224		249
		250	$self->stoptls;
		251	}
		252
225	sub error {	253	sub _error {
226	my ($self) = @_;	254	my ($self, $errno, $fatal) = @_;
227		255
228	{
229	local $!;
230	$self->_shutdown;	256	$self->_shutdown
231	}	257	if $fatal;
232		258
233	$self->{on_error}($self)	259	$! = $errno;
		260
234	if $self->{on_error};	261	if ($self->{on_error}) {
235		262	$self->{on_error}($self, $fatal);
		263	} else {
236	Carp::croak "AnyEvent::Handle uncaught fatal error: $!";	264	Carp::croak "AnyEvent::Handle uncaught error: $!";
		265	}
237	}	266	}
238		267
239	=item $fh = $handle->fh	268	=item $fh = $handle->fh
240		269
241	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.
…		…
260		289
261	=cut	290	=cut
262		291
263	sub on_eof {	292	sub on_eof {
264	$_[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	}
265	}	361	}
266		362
267	#############################################################################	363	#############################################################################
268		364
269	=back	365	=back
…		…
316	my $len = syswrite $self->{fh}, $self->{wbuf};	412	my $len = syswrite $self->{fh}, $self->{wbuf};
317		413
318	if ($len >= 0) {	414	if ($len >= 0) {
319	substr $self->{wbuf}, 0, $len, "";	415	substr $self->{wbuf}, 0, $len, "";
320		416
		417	$self->{_activity} = AnyEvent->now;
		418
321	$self->{on_drain}($self)	419	$self->{on_drain}($self)
322	if $self->{low_water_mark} >= length $self->{wbuf}	420	if $self->{low_water_mark} >= length $self->{wbuf}
323	&& $self->{on_drain};	421	&& $self->{on_drain};
324		422
325	delete $self->{_ww} unless length $self->{wbuf};	423	delete $self->{_ww} unless length $self->{wbuf};
326	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAWOULDBLOCK) {	424	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
327	$self->error;	425	$self->_error ($!, 1);
328	}	426	}
329	};	427	};
330		428
331	# try to write data immediately	429	# try to write data immediately
332	$cb->();	430	$cb->();
…		…
352	@_ = ($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")
353	->($self, @_);	451	->($self, @_);
354	}	452	}
355		453
356	if ($self->{filter_w}) {	454	if ($self->{filter_w}) {
357	$self->{filter_w}->($self, \$_[0]);	455	$self->{filter_w}($self, \$_[0]);
358	} else {	456	} else {
359	$self->{wbuf} .= $_[0];	457	$self->{wbuf} .= $_[0];
360	$self->_drain_wbuf;	458	$self->_drain_wbuf;
361	}	459	}
362	}	460	}
363		461
364	=item $handle->push_write (type => @args)	462	=item $handle->push_write (type => @args)
365		463
366	=item $handle->unshift_write (type => @args)
367
368	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
369	the job by specifying a type and type-specific arguments.	465	the job by specifying a type and type-specific arguments.
370		466
371	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
372	drop by and tell us):	468	drop by and tell us):
…		…
375		471
376	=item netstring => $string	472	=item netstring => $string
377		473
378	Formats the given value as netstring	474	Formats the given value as netstring
379	(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).
380
381	=back
382		476
383	=cut	477	=cut
384		478
385	register_write_type netstring => sub {	479	register_write_type netstring => sub {
386	my ($self, $string) = @_;	480	my ($self, $string) = @_;
…		…
396		490
397	JSON objects (and arrays) are self-delimiting, so you can write JSON at	491	JSON objects (and arrays) are self-delimiting, so you can write JSON at
398	one end of a handle and read them at the other end without using any	492	one end of a handle and read them at the other end without using any
399	additional framing.	493	additional framing.
400		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
401	=cut	515	=cut
402		516
403	register_write_type json => sub {	517	register_write_type json => sub {
404	my ($self, $ref) = @_;	518	my ($self, $ref) = @_;
405		519
406	require JSON;	520	require JSON;
407		521
408	$self->{json} ? $self->{json}->encode ($ref)	522	$self->{json} ? $self->{json}->encode ($ref)
409	: JSON::encode_json ($ref)	523	: JSON::encode_json ($ref)
410	};	524	};
		525
		526	=back
411		527
412	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	528	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
413		529
414	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>.
415	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
…		…
453	the specified number of bytes which give an XML datagram.	569	the specified number of bytes which give an XML datagram.
454		570
455	# in the default state, expect some header bytes	571	# in the default state, expect some header bytes
456	$handle->on_read (sub {	572	$handle->on_read (sub {
457	# 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)
458	shift->unshift_read_chunk (4, sub {	574	shift->unshift_read (chunk => 4, sub {
459	# header arrived, decode	575	# header arrived, decode
460	my $len = unpack "N", $_[1];	576	my $len = unpack "N", $_[1];
461		577
462	# now read the payload	578	# now read the payload
463	shift->unshift_read_chunk ($len, sub {	579	shift->unshift_read (chunk => $len, sub {
464	my $xml = $_[1];	580	my $xml = $_[1];
465	# handle xml	581	# handle xml
466	});	582	});
467	});	583	});
468	});	584	});
…		…
475		591
476	# request one	592	# request one
477	$handle->push_write ("request 1\015\012");	593	$handle->push_write ("request 1\015\012");
478		594
479	# 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
480	$handle->push_read_line (sub {	596	$handle->push_read (line => sub {
481	# if we got an "OK", we have to _prepend_ another line,	597	# if we got an "OK", we have to _prepend_ another line,
482	# so it will be read before the second request reads its 64 bytes	598	# so it will be read before the second request reads its 64 bytes
483	# which are already in the queue when this callback is called	599	# which are already in the queue when this callback is called
484	# we don't do this in case we got an error	600	# we don't do this in case we got an error
485	if ($_[1] eq "OK") {	601	if ($_[1] eq "OK") {
486	$_[0]->unshift_read_line (sub {	602	$_[0]->unshift_read (line => sub {
487	my $response = $_[1];	603	my $response = $_[1];
488	...	604	...
489	});	605	});
490	}	606	}
491	});	607	});
492		608
493	# request two	609	# request two
494	$handle->push_write ("request 2\015\012");	610	$handle->push_write ("request 2\015\012");
495		611
496	# simply read 64 bytes, always	612	# simply read 64 bytes, always
497	$handle->push_read_chunk (64, sub {	613	$handle->push_read (chunk => 64, sub {
498	my $response = $_[1];	614	my $response = $_[1];
499	...	615	...
500	});	616	});
501		617
502	=over 4	618	=over 4
…		…
508		624
509	if (	625	if (
510	defined $self->{rbuf_max}	626	defined $self->{rbuf_max}
511	&& $self->{rbuf_max} < length $self->{rbuf}	627	&& $self->{rbuf_max} < length $self->{rbuf}
512	) {	628	) {
513	$! = &Errno::ENOSPC;	629	return $self->_error (&Errno::ENOSPC, 1);
514	$self->error;
515	}	630	}
516		631
517	return if $self->{in_drain};	632	return if $self->{in_drain};
518	local $self->{in_drain} = 1;	633	local $self->{in_drain} = 1;
519		634
…		…
521	no strict 'refs';	636	no strict 'refs';
522	if (my $cb = shift @{ $self->{_queue} }) {	637	if (my $cb = shift @{ $self->{_queue} }) {
523	unless ($cb->($self)) {	638	unless ($cb->($self)) {
524	if ($self->{_eof}) {	639	if ($self->{_eof}) {
525	# 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)
526	$! = &Errno::EPIPE;	641	return $self->_error (&Errno::EPIPE, 1);
527	$self->error;
528	}	642	}
529		643
530	unshift @{ $self->{_queue} }, $cb;	644	unshift @{ $self->{_queue} }, $cb;
531	return;	645	last;
532	}	646	}
533	} elsif ($self->{on_read}) {	647	} elsif ($self->{on_read}) {
534	$self->{on_read}($self);	648	$self->{on_read}($self);
535		649
536	if (	650	if (
537	$self->{_eof} # if no further data will arrive
538	&& $len == length $self->{rbuf} # and no data has been consumed	651	$len == length $self->{rbuf} # if no data has been consumed
539	&& !@{ $self->{_queue} } # and the queue is still empty	652	&& !@{ $self->{_queue} } # and the queue is still empty
540	&& $self->{on_read} # and we still want to read data	653	&& $self->{on_read} # but we still have on_read
541	) {	654	) {
		655	# no further data will arrive
542	# then no progress can be made	656	# so no progress can be made
543	$! = &Errno::EPIPE;	657	return $self->_error (&Errno::EPIPE, 1)
544	$self->error;	658	if $self->{_eof};
		659
		660	last; # more data might arrive
545	}	661	}
546	} else {	662	} else {
547	# read side becomes idle	663	# read side becomes idle
548	delete $self->{_rw};	664	delete $self->{_rw};
549	return;	665	last;
550	}	666	}
551	}	667	}
552		668
553	if ($self->{_eof}) {
554	$self->_shutdown;
555	$self->{on_eof}($self)	669	$self->{on_eof}($self)
556	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} };
557	}	676	}
558	}	677	}
559		678
560	=item $handle->on_read ($cb)	679	=item $handle->on_read ($cb)
561		680
…		…
751	my ($self, $cb) = @_;	870	my ($self, $cb) = @_;
752		871
753	sub {	872	sub {
754	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {	873	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
755	if ($_[0]{rbuf} =~ /[^0-9]/) {	874	if ($_[0]{rbuf} =~ /[^0-9]/) {
756	$! = &Errno::EBADMSG;	875	$self->_error (&Errno::EBADMSG);
757	$self->error;
758	}	876	}
759	return;	877	return;
760	}	878	}
761		879
762	my $len = $1;	880	my $len = $1;
…		…
765	my $string = $_[1];	883	my $string = $_[1];
766	$_[0]->unshift_read (chunk => 1, sub {	884	$_[0]->unshift_read (chunk => 1, sub {
767	if ($_[1] eq ",") {	885	if ($_[1] eq ",") {
768	$cb->($_[0], $string);	886	$cb->($_[0], $string);
769	} else {	887	} else {
770	$! = &Errno::EBADMSG;	888	$self->_error (&Errno::EBADMSG);
771	$self->error;
772	}	889	}
773	});	890	});
774	});	891	});
775		892
776	1	893	1
…		…
833	return 1;	950	return 1;
834	}	951	}
835		952
836	# reject	953	# reject
837	if ($reject && $$rbuf =~ $reject) {	954	if ($reject && $$rbuf =~ $reject) {
838	$! = &Errno::EBADMSG;	955	$self->_error (&Errno::EBADMSG);
839	$self->error;
840	}	956	}
841		957
842	# skip	958	# skip
843	if ($skip && $$rbuf =~ $skip) {	959	if ($skip && $$rbuf =~ $skip) {
844	$data .= substr $$rbuf, 0, $+[0], "";	960	$data .= substr $$rbuf, 0, $+[0], "";
…		…
859	2.09 (and JSON::XS version 2.2) and above. You have to provide a	975	2.09 (and JSON::XS version 2.2) and above. You have to provide a
860	dependency on your own: this module will load the JSON module, but	976	dependency on your own: this module will load the JSON module, but
861	AnyEvent does not depend on it itself.	977	AnyEvent does not depend on it itself.
862		978
863	Since JSON texts are fully self-delimiting, the C<json> read and write	979	Since JSON texts are fully self-delimiting, the C<json> read and write
864	types are an ideal simple RPC protocol: just exchange JSON datagrams.	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.
865		982
866	=cut	983	=cut
867		984
868	register_read_type json => sub {	985	register_read_type json => sub {
869	my ($self, $cb, $accept, $reject, $skip) = @_;	986	my ($self, $cb, $accept, $reject, $skip) = @_;
…		…
871	require JSON;	988	require JSON;
872		989
873	my $data;	990	my $data;
874	my $rbuf = \$self->{rbuf};	991	my $rbuf = \$self->{rbuf};
875		992
876	my $json = $self->{json} \|\|= JSON::XS->new->utf8;	993	my $json = $self->{json} \|\|= JSON->new->utf8;
877		994
878	sub {	995	sub {
879	my $ref = $json->incr_parse ($self->{rbuf});	996	my $ref = $json->incr_parse ($self->{rbuf});
880		997
881	if ($ref) {	998	if ($ref) {
…		…
920	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
921	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
922	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
923	C<start_read>.	1040	C<start_read>.
924		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
925	=cut	1047	=cut
926		1048
927	sub stop_read {	1049	sub stop_read {
928	my ($self) = @_;	1050	my ($self) = @_;
929		1051
…		…
939	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1061	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
940	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1062	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};
941	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;
942		1064
943	if ($len > 0) {	1065	if ($len > 0) {
		1066	$self->{_activity} = AnyEvent->now;
		1067
944	$self->{filter_r}	1068	$self->{filter_r}
945	? $self->{filter_r}->($self, $rbuf)	1069	? $self->{filter_r}($self, $rbuf)
946	: $self->_drain_rbuf;	1070	: $self->_drain_rbuf;
947		1071
948	} elsif (defined $len) {	1072	} elsif (defined $len) {
949	delete $self->{_rw};	1073	delete $self->{_rw};
950	$self->{_eof} = 1;	1074	$self->{_eof} = 1;
951	$self->_drain_rbuf;	1075	$self->_drain_rbuf;
952		1076
953	} elsif ($! != EAGAIN && $! != EINTR && $! != &AnyEvent::Util::WSAWOULDBLOCK) {	1077	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
954	return $self->error;	1078	return $self->_error ($!, 1);
955	}	1079	}
956	});	1080	});
957	}	1081	}
958	}	1082	}
959		1083
960	sub _dotls {	1084	sub _dotls {
961	my ($self) = @_;	1085	my ($self) = @_;
		1086
		1087	my $buf;
962		1088
963	if (length $self->{_tls_wbuf}) {	1089	if (length $self->{_tls_wbuf}) {
964	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) {
965	substr $self->{_tls_wbuf}, 0, $len, "";	1091	substr $self->{_tls_wbuf}, 0, $len, "";
966	}	1092	}
967	}	1093	}
968		1094
969	if (defined (my $buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1095	if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {
970	$self->{wbuf} .= $buf;	1096	$self->{wbuf} .= $buf;
971	$self->_drain_wbuf;	1097	$self->_drain_wbuf;
972	}	1098	}
973		1099
974	while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) {	1100	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {
		1101	if (length $buf) {
975	$self->{rbuf} .= $buf;	1102	$self->{rbuf} .= $buf;
976	$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	}
977	}	1110	}
978		1111
979	my $err = Net::SSLeay::get_error ($self->{tls}, -1);	1112	my $err = Net::SSLeay::get_error ($self->{tls}, -1);
980		1113
981	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {	1114	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
982	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {	1115	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {
983	$self->error;	1116	return $self->_error ($!, 1);
984	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {	1117	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {
985	$! = &Errno::EIO;	1118	return $self->_error (&Errno::EIO, 1);
986	$self->error;
987	}	1119	}
988		1120
989	# all others are fine for our purposes	1121	# all others are fine for our purposes
990	}	1122	}
991	}	1123	}
…		…
1006	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
1007	might have already started when this function returns.	1139	might have already started when this function returns.
1008		1140
1009	=cut	1141	=cut
1010		1142
1011	# TODO: maybe document...
1012	sub starttls {	1143	sub starttls {
1013	my ($self, $ssl, $ctx) = @_;	1144	my ($self, $ssl, $ctx) = @_;
1014		1145
1015	$self->stoptls;	1146	$self->stoptls;
1016		1147

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.40 by root, Tue May 27 05:36:27 2008 UTC vs. Revision 1.56 by root, Wed Jun 4 09:55:16 2008 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.40 by root, Tue May 27 05:36:27 2008 UTC vs.
Revision 1.56 by root, Wed Jun 4 09:55:16 2008 UTC