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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.34 by root, Mon May 26 03:27:52 2008 UTC vs.
Revision 1.45 by root, Thu May 29 00:20:39 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
…		…
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 on EOF.
81		81
82	While not mandatory, it is highly recommended to set an eof callback,	82	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	83	otherwise you might end up with a closed socket while you are still
84	waiting for data.	84	waiting for data.
85		85
86	=item on_error => $cb->($self)	86	=item on_error => $cb->($handle)
87		87
88	This is the fatal error callback, that is called when, well, a fatal error	88	This is the fatal error callback, that is called when, well, a fatal error
89	occurs, such as not being able to resolve the hostname, failure to connect	89	occurs, such as not being able to resolve the hostname, failure to connect
90	or a read error.	90	or a read error.
91		91
92	The object will not be in a usable state when this callback has been	92	The object will not be in a usable state when this callback has been
93	called.	93	called.
94		94
95	On callback entrance, the value of C<$!> contains the operating system	95	On callback entrance, the value of C<$!> contains the operating system
96	error (or C<ENOSPC>, C<EPIPE> or C<EBADMSG>).	96	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.
97		100
98	While not mandatory, it is I<highly> recommended to set this callback, as	101	While not mandatory, it is I<highly> recommended to set this callback, as
99	you will not be notified of errors otherwise. The default simply calls	102	you will not be notified of errors otherwise. The default simply calls
100	die.	103	die.
101		104
102	=item on_read => $cb->($self)	105	=item on_read => $cb->($handle)
103		106
104	This sets the default read callback, which is called when data arrives	107	This sets the default read callback, which is called when data arrives
105	and no read request is in the queue.	108	and no read request is in the queue.
106		109
107	To access (and remove data from) the read buffer, use the C<< ->rbuf >>	110	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
108	method or access the C<$self->{rbuf}> member directly.	111	method or access the C<$handle->{rbuf}> member directly.
109		112
110	When an EOF condition is detected then AnyEvent::Handle will first try to	113	When an EOF condition is detected then AnyEvent::Handle will first try to
111	feed all the remaining data to the queued callbacks and C<on_read> before	114	feed all the remaining data to the queued callbacks and C<on_read> before
112	calling the C<on_eof> callback. If no progress can be made, then a fatal	115	calling the C<on_eof> callback. If no progress can be made, then a fatal
113	error will be raised (with C<$!> set to C<EPIPE>).	116	error will be raised (with C<$!> set to C<EPIPE>).
114		117
115	=item on_drain => $cb->()	118	=item on_drain => $cb->($handle)
116		119
117	This sets the callback that is called when the write buffer becomes empty	120	This sets the callback that is called when the write buffer becomes empty
118	(or when the callback is set and the buffer is empty already).	121	(or when the callback is set and the buffer is empty already).
119		122
120	To append to the write buffer, use the C<< ->push_write >> method.	123	To append to the write buffer, use the C<< ->push_write >> method.
		124
		125	=item timeout => $fractional_seconds
		126
		127	If non-zero, then this enables an "inactivity" timeout: whenever this many
		128	seconds pass without a successful read or write on the underlying file
		129	handle, the C<on_timeout> callback will be invoked (and if that one is
		130	missing, an C<ETIMEDOUT> error will be raised).
		131
		132	Note that timeout processing is also active when you currently do not have
		133	any outstanding read or write requests: If you plan to keep the connection
		134	idle then you should disable the timout temporarily or ignore the timeout
		135	in the C<on_timeout> callback.
		136
		137	Zero (the default) disables this timeout.
		138
		139	=item on_timeout => $cb->($handle)
		140
		141	Called whenever the inactivity timeout passes. If you return from this
		142	callback, then the timeout will be reset as if some activity had happened,
		143	so this condition is not fatal in any way.
121		144
122	=item rbuf_max => <bytes>	145	=item rbuf_max => <bytes>
123		146
124	If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)	147	If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)
125	when the read buffer ever (strictly) exceeds this size. This is useful to	148	when the read buffer ever (strictly) exceeds this size. This is useful to
…		…
165		188
166	Use the given Net::SSLeay::CTX object to create the new TLS connection	189	Use the given Net::SSLeay::CTX object to create the new TLS connection
167	(unless a connection object was specified directly). If this parameter is	190	(unless a connection object was specified directly). If this parameter is
168	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	191	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
169		192
		193	=item json => JSON or JSON::XS object
		194
		195	This is the json coder object used by the C<json> read and write types.
		196
		197	If you don't supply it, then AnyEvent::Handle will create and use a
		198	suitable one, which will write and expect UTF-8 encoded JSON texts.
		199
		200	Note that you are responsible to depend on the JSON module if you want to
		201	use this functionality, as AnyEvent does not have a dependency itself.
		202
		203	=item filter_r => $cb
		204
		205	=item filter_w => $cb
		206
		207	These exist, but are undocumented at this time.
		208
170	=back	209	=back
171		210
172	=cut	211	=cut
173		212
174	sub new {	213	sub new {
…		…
183	if ($self->{tls}) {	222	if ($self->{tls}) {
184	require Net::SSLeay;	223	require Net::SSLeay;
185	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});	224	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});
186	}	225	}
187		226
188	$self->on_eof (delete $self->{on_eof} ) if $self->{on_eof};	227	# $self->on_eof (delete $self->{on_eof} ) if $self->{on_eof}; # nop
189	$self->on_error (delete $self->{on_error}) if $self->{on_error};	228	# $self->on_error (delete $self->{on_error}) if $self->{on_error}; # nop
		229	# $self->on_read (delete $self->{on_read} ) if $self->{on_read}; # nop
190	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	230	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
191	$self->on_read (delete $self->{on_read} ) if $self->{on_read};	231
		232	$self->{_activity} = AnyEvent->now;
		233	$self->_timeout;
192		234
193	$self->start_read;	235	$self->start_read;
194		236
195	$self	237	$self
196	}	238	}
197		239
198	sub _shutdown {	240	sub _shutdown {
199	my ($self) = @_;	241	my ($self) = @_;
200		242
201	delete $self->{rw};	243	delete $self->{_rw};
202	delete $self->{ww};	244	delete $self->{_ww};
203	delete $self->{fh};	245	delete $self->{fh};
204	}	246	}
205		247
206	sub error {	248	sub error {
207	my ($self) = @_;	249	my ($self) = @_;
…		…
209	{	251	{
210	local $!;	252	local $!;
211	$self->_shutdown;	253	$self->_shutdown;
212	}	254	}
213		255
214	if ($self->{on_error}) {
215	$self->{on_error}($self);	256	$self->{on_error}($self)
216	} else {	257	if $self->{on_error};
		258
217	Carp::croak "AnyEvent::Handle uncaught fatal error: $!";	259	Carp::croak "AnyEvent::Handle uncaught fatal error: $!";
218	}
219	}	260	}
220		261
221	=item $fh = $handle->fh	262	=item $fh = $handle->fh
222		263
223	This method returns the file handle of the L<AnyEvent::Handle> object.	264	This method returns the file handle of the L<AnyEvent::Handle> object.
224		265
225	=cut	266	=cut
226		267
227	sub fh { $_[0]->{fh} }	268	sub fh { $_[0]{fh} }
228		269
229	=item $handle->on_error ($cb)	270	=item $handle->on_error ($cb)
230		271
231	Replace the current C<on_error> callback (see the C<on_error> constructor argument).	272	Replace the current C<on_error> callback (see the C<on_error> constructor argument).
232		273
…		…
242		283
243	=cut	284	=cut
244		285
245	sub on_eof {	286	sub on_eof {
246	$_[0]{on_eof} = $_[1];	287	$_[0]{on_eof} = $_[1];
		288	}
		289
		290	=item $handle->on_timeout ($cb)
		291
		292	Replace the current C<on_timeout> callback, or disables the callback
		293	(but not the timeout) if C<$cb> = C<undef>. See C<timeout> constructor
		294	argument.
		295
		296	=cut
		297
		298	sub on_timeout {
		299	$_[0]{on_timeout} = $_[1];
		300	}
		301
		302	#############################################################################
		303
		304	=item $handle->timeout ($seconds)
		305
		306	Configures (or disables) the inactivity timeout.
		307
		308	=cut
		309
		310	sub timeout {
		311	my ($self, $timeout) = @_;
		312
		313	$self->{timeout} = $timeout;
		314	$self->_timeout;
		315	}
		316
		317	# reset the timeout watcher, as neccessary
		318	# also check for time-outs
		319	sub _timeout {
		320	my ($self) = @_;
		321
		322	if ($self->{timeout}) {
		323	my $NOW = AnyEvent->now;
		324
		325	# when would the timeout trigger?
		326	my $after = $self->{_activity} + $self->{timeout} - $NOW;
		327
		328	# now or in the past already?
		329	if ($after <= 0) {
		330	$self->{_activity} = $NOW;
		331
		332	if ($self->{on_timeout}) {
		333	$self->{on_timeout}->($self);
		334	} else {
		335	$! = Errno::ETIMEDOUT;
		336	$self->error;
		337	}
		338
		339	# callbakx could have changed timeout value, optimise
		340	return unless $self->{timeout};
		341
		342	# calculate new after
		343	$after = $self->{timeout};
		344	}
		345
		346	Scalar::Util::weaken $self;
		347
		348	$self->{_tw} \|\|= AnyEvent->timer (after => $after, cb => sub {
		349	delete $self->{_tw};
		350	$self->_timeout;
		351	});
		352	} else {
		353	delete $self->{_tw};
		354	}
247	}	355	}
248		356
249	#############################################################################	357	#############################################################################
250		358
251	=back	359	=back
…		…
288	=cut	396	=cut
289		397
290	sub _drain_wbuf {	398	sub _drain_wbuf {
291	my ($self) = @_;	399	my ($self) = @_;
292		400
293	if (!$self->{ww} && length $self->{wbuf}) {	401	if (!$self->{_ww} && length $self->{wbuf}) {
		402
294	Scalar::Util::weaken $self;	403	Scalar::Util::weaken $self;
		404
295	my $cb = sub {	405	my $cb = sub {
296	my $len = syswrite $self->{fh}, $self->{wbuf};	406	my $len = syswrite $self->{fh}, $self->{wbuf};
297		407
298	if ($len >= 0) {	408	if ($len >= 0) {
299	substr $self->{wbuf}, 0, $len, "";	409	substr $self->{wbuf}, 0, $len, "";
		410
		411	$self->{_activity} = AnyEvent->now;
300		412
301	$self->{on_drain}($self)	413	$self->{on_drain}($self)
302	if $self->{low_water_mark} >= length $self->{wbuf}	414	if $self->{low_water_mark} >= length $self->{wbuf}
303	&& $self->{on_drain};	415	&& $self->{on_drain};
304		416
305	delete $self->{ww} unless length $self->{wbuf};	417	delete $self->{_ww} unless length $self->{wbuf};
306	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAWOULDBLOCK) {	418	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
307	$self->error;	419	$self->error;
308	}	420	}
309	};	421	};
310		422
		423	# try to write data immediately
		424	$cb->();
		425
		426	# if still data left in wbuf, we need to poll
311	$self->{ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb);	427	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)
312		428	if length $self->{wbuf};
313	$cb->($self);
314	};	429	};
315	}	430	}
316		431
317	our %WH;	432	our %WH;
318		433
…		…
363	my ($self, $string) = @_;	478	my ($self, $string) = @_;
364		479
365	sprintf "%d:%s,", (length $string), $string	480	sprintf "%d:%s,", (length $string), $string
366	};	481	};
367		482
		483	=item json => $array_or_hashref
		484
		485	Encodes the given hash or array reference into a JSON object. Unless you
		486	provide your own JSON object, this means it will be encoded to JSON text
		487	in UTF-8.
		488
		489	JSON objects (and arrays) are self-delimiting, so you can write JSON at
		490	one end of a handle and read them at the other end without using any
		491	additional framing.
		492
		493	The generated JSON text is guaranteed not to contain any newlines: While
		494	this module doesn't need delimiters after or between JSON texts to be
		495	able to read them, many other languages depend on that.
		496
		497	A simple RPC protocol that interoperates easily with others is to send
		498	JSON arrays (or objects, although arrays are usually the better choice as
		499	they mimic how function argument passing works) and a newline after each
		500	JSON text:
		501
		502	$handle->push_write (json => ["method", "arg1", "arg2"]); # whatever
		503	$handle->push_write ("\012");
		504
		505	An AnyEvent::Handle receiver would simply use the C<json> read type and
		506	rely on the fact that the newline will be skipped as leading whitespace:
		507
		508	$handle->push_read (json => sub { my $array = $_[1]; ... });
		509
		510	Other languages could read single lines terminated by a newline and pass
		511	this line into their JSON decoder of choice.
		512
		513	=cut
		514
		515	register_write_type json => sub {
		516	my ($self, $ref) = @_;
		517
		518	require JSON;
		519
		520	$self->{json} ? $self->{json}->encode ($ref)
		521	: JSON::encode_json ($ref)
		522	};
		523
368	=item AnyEvent::Handle::register_write_type type => $coderef->($self, @args)	524	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
369		525
370	This function (not method) lets you add your own types to C<push_write>.	526	This function (not method) lets you add your own types to C<push_write>.
371	Whenever the given C<type> is used, C<push_write> will invoke the code	527	Whenever the given C<type> is used, C<push_write> will invoke the code
372	reference with the handle object and the remaining arguments.	528	reference with the handle object and the remaining arguments.
373		529
…		…
464		620
465	if (	621	if (
466	defined $self->{rbuf_max}	622	defined $self->{rbuf_max}
467	&& $self->{rbuf_max} < length $self->{rbuf}	623	&& $self->{rbuf_max} < length $self->{rbuf}
468	) {	624	) {
469	$! = &Errno::ENOSPC; return $self->error;	625	$! = &Errno::ENOSPC;
		626	$self->error;
470	}	627	}
471		628
472	return if $self->{in_drain};	629	return if $self->{in_drain};
473	local $self->{in_drain} = 1;	630	local $self->{in_drain} = 1;
474		631
475	while (my $len = length $self->{rbuf}) {	632	while (my $len = length $self->{rbuf}) {
476	no strict 'refs';	633	no strict 'refs';
477	if (my $cb = shift @{ $self->{queue} }) {	634	if (my $cb = shift @{ $self->{_queue} }) {
478	unless ($cb->($self)) {	635	unless ($cb->($self)) {
479	if ($self->{eof}) {	636	if ($self->{_eof}) {
480	# no progress can be made (not enough data and no data forthcoming)	637	# no progress can be made (not enough data and no data forthcoming)
481	$! = &Errno::EPIPE; return $self->error;	638	$! = &Errno::EPIPE;
		639	$self->error;
482	}	640	}
483		641
484	unshift @{ $self->{queue} }, $cb;	642	unshift @{ $self->{_queue} }, $cb;
485	return;	643	return;
486	}	644	}
487	} elsif ($self->{on_read}) {	645	} elsif ($self->{on_read}) {
488	$self->{on_read}($self);	646	$self->{on_read}($self);
489		647
490	if (	648	if (
491	$self->{eof} # if no further data will arrive	649	$self->{_eof} # if no further data will arrive
492	&& $len == length $self->{rbuf} # and no data has been consumed	650	&& $len == length $self->{rbuf} # and no data has been consumed
493	&& !@{ $self->{queue} } # and the queue is still empty	651	&& !@{ $self->{_queue} } # and the queue is still empty
494	&& $self->{on_read} # and we still want to read data	652	&& $self->{on_read} # and we still want to read data
495	) {	653	) {
496	# then no progress can be made	654	# then no progress can be made
497	$! = &Errno::EPIPE; return $self->error;	655	$! = &Errno::EPIPE;
		656	$self->error;
498	}	657	}
499	} else {	658	} else {
500	# read side becomes idle	659	# read side becomes idle
501	delete $self->{rw};	660	delete $self->{_rw};
502	return;	661	return;
503	}	662	}
504	}	663	}
505		664
506	if ($self->{eof}) {	665	if ($self->{_eof}) {
507	$self->_shutdown;	666	$self->_shutdown;
508	$self->{on_eof}($self)	667	$self->{on_eof}($self)
509	if $self->{on_eof};	668	if $self->{on_eof};
510	}	669	}
511	}	670	}
…		…
577		736
578	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	737	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
579	->($self, $cb, @_);	738	->($self, $cb, @_);
580	}	739	}
581		740
582	push @{ $self->{queue} }, $cb;	741	push @{ $self->{_queue} }, $cb;
583	$self->_drain_rbuf;	742	$self->_drain_rbuf;
584	}	743	}
585		744
586	sub unshift_read {	745	sub unshift_read {
587	my $self = shift;	746	my $self = shift;
…		…
593	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")	752	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")
594	->($self, $cb, @_);	753	->($self, $cb, @_);
595	}	754	}
596		755
597		756
598	unshift @{ $self->{queue} }, $cb;	757	unshift @{ $self->{_queue} }, $cb;
599	$self->_drain_rbuf;	758	$self->_drain_rbuf;
600	}	759	}
601		760
602	=item $handle->push_read (type => @args, $cb)	761	=item $handle->push_read (type => @args, $cb)
603		762
…		…
610	Predefined types are (if you have ideas for additional types, feel free to	769	Predefined types are (if you have ideas for additional types, feel free to
611	drop by and tell us):	770	drop by and tell us):
612		771
613	=over 4	772	=over 4
614		773
615	=item chunk => $octets, $cb->($self, $data)	774	=item chunk => $octets, $cb->($handle, $data)
616		775
617	Invoke the callback only once C<$octets> bytes have been read. Pass the	776	Invoke the callback only once C<$octets> bytes have been read. Pass the
618	data read to the callback. The callback will never be called with less	777	data read to the callback. The callback will never be called with less
619	data.	778	data.
620		779
…		…
643		802
644	sub unshift_read_chunk {	803	sub unshift_read_chunk {
645	$_[0]->unshift_read (chunk => $_[1], $_[2]);	804	$_[0]->unshift_read (chunk => $_[1], $_[2]);
646	}	805	}
647		806
648	=item line => [$eol, ]$cb->($self, $line, $eol)	807	=item line => [$eol, ]$cb->($handle, $line, $eol)
649		808
650	The callback will be called only once a full line (including the end of	809	The callback will be called only once a full line (including the end of
651	line marker, C<$eol>) has been read. This line (excluding the end of line	810	line marker, C<$eol>) has been read. This line (excluding the end of line
652	marker) will be passed to the callback as second argument (C<$line>), and	811	marker) will be passed to the callback as second argument (C<$line>), and
653	the end of line marker as the third argument (C<$eol>).	812	the end of line marker as the third argument (C<$eol>).
…		…
690	sub unshift_read_line {	849	sub unshift_read_line {
691	my $self = shift;	850	my $self = shift;
692	$self->unshift_read (line => @_);	851	$self->unshift_read (line => @_);
693	}	852	}
694		853
695	=item netstring => $cb->($string)	854	=item netstring => $cb->($handle, $string)
696		855
697	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).	856	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
698		857
699	Throws an error with C<$!> set to EBADMSG on format violations.	858	Throws an error with C<$!> set to EBADMSG on format violations.
700		859
…		…
728		887
729	1	888	1
730	}	889	}
731	};	890	};
732		891
		892	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
		893
		894	Makes a regex match against the regex object C<$accept> and returns
		895	everything up to and including the match.
		896
		897	Example: read a single line terminated by '\n'.
		898
		899	$handle->push_read (regex => qr<\n>, sub { ... });
		900
		901	If C<$reject> is given and not undef, then it determines when the data is
		902	to be rejected: it is matched against the data when the C<$accept> regex
		903	does not match and generates an C<EBADMSG> error when it matches. This is
		904	useful to quickly reject wrong data (to avoid waiting for a timeout or a
		905	receive buffer overflow).
		906
		907	Example: expect a single decimal number followed by whitespace, reject
		908	anything else (not the use of an anchor).
		909
		910	$handle->push_read (regex => qr<^[0-9]+\s>, qr<[^0-9]>, sub { ... });
		911
		912	If C<$skip> is given and not C<undef>, then it will be matched against
		913	the receive buffer when neither C<$accept> nor C<$reject> match,
		914	and everything preceding and including the match will be accepted
		915	unconditionally. This is useful to skip large amounts of data that you
		916	know cannot be matched, so that the C<$accept> or C<$reject> regex do not
		917	have to start matching from the beginning. This is purely an optimisation
		918	and is usually worth only when you expect more than a few kilobytes.
		919
		920	Example: expect a http header, which ends at C<\015\012\015\012>. Since we
		921	expect the header to be very large (it isn't in practise, but...), we use
		922	a skip regex to skip initial portions. The skip regex is tricky in that
		923	it only accepts something not ending in either \015 or \012, as these are
		924	required for the accept regex.
		925
		926	$handle->push_read (regex =>
		927	qr<\015\012\015\012>,
		928	undef, # no reject
		929	qr<^.*[^\015\012]>,
		930	sub { ... });
		931
		932	=cut
		933
		934	register_read_type regex => sub {
		935	my ($self, $cb, $accept, $reject, $skip) = @_;
		936
		937	my $data;
		938	my $rbuf = \$self->{rbuf};
		939
		940	sub {
		941	# accept
		942	if ($$rbuf =~ $accept) {
		943	$data .= substr $$rbuf, 0, $+[0], "";
		944	$cb->($self, $data);
		945	return 1;
		946	}
		947
		948	# reject
		949	if ($reject && $$rbuf =~ $reject) {
		950	$! = &Errno::EBADMSG;
		951	$self->error;
		952	}
		953
		954	# skip
		955	if ($skip && $$rbuf =~ $skip) {
		956	$data .= substr $$rbuf, 0, $+[0], "";
		957	}
		958
		959	()
		960	}
		961	};
		962
		963	=item json => $cb->($handle, $hash_or_arrayref)
		964
		965	Reads a JSON object or array, decodes it and passes it to the callback.
		966
		967	If a C<json> object was passed to the constructor, then that will be used
		968	for the final decode, otherwise it will create a JSON coder expecting UTF-8.
		969
		970	This read type uses the incremental parser available with JSON version
		971	2.09 (and JSON::XS version 2.2) and above. You have to provide a
		972	dependency on your own: this module will load the JSON module, but
		973	AnyEvent does not depend on it itself.
		974
		975	Since JSON texts are fully self-delimiting, the C<json> read and write
		976	types are an ideal simple RPC protocol: just exchange JSON datagrams. See
		977	the C<json> write type description, above, for an actual example.
		978
		979	=cut
		980
		981	register_read_type json => sub {
		982	my ($self, $cb, $accept, $reject, $skip) = @_;
		983
		984	require JSON;
		985
		986	my $data;
		987	my $rbuf = \$self->{rbuf};
		988
		989	my $json = $self->{json} \|\|= JSON->new->utf8;
		990
		991	sub {
		992	my $ref = $json->incr_parse ($self->{rbuf});
		993
		994	if ($ref) {
		995	$self->{rbuf} = $json->incr_text;
		996	$json->incr_text = "";
		997	$cb->($self, $ref);
		998
		999	1
		1000	} else {
		1001	$self->{rbuf} = "";
		1002	()
		1003	}
		1004	}
		1005	};
		1006
733	=back	1007	=back
734		1008
735	=item AnyEvent::Handle::register_read_type type => $coderef->($self, $cb, @args)	1009	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)
736		1010
737	This function (not method) lets you add your own types to C<push_read>.	1011	This function (not method) lets you add your own types to C<push_read>.
738		1012
739	Whenever the given C<type> is used, C<push_read> will invoke the code	1013	Whenever the given C<type> is used, C<push_read> will invoke the code
740	reference with the handle object, the callback and the remaining	1014	reference with the handle object, the callback and the remaining
…		…
742		1016
743	The code reference is supposed to return a callback (usually a closure)	1017	The code reference is supposed to return a callback (usually a closure)
744	that works as a plain read callback (see C<< ->push_read ($cb) >>).	1018	that works as a plain read callback (see C<< ->push_read ($cb) >>).
745		1019
746	It should invoke the passed callback when it is done reading (remember to	1020	It should invoke the passed callback when it is done reading (remember to
747	pass C<$self> as first argument as all other callbacks do that).	1021	pass C<$handle> as first argument as all other callbacks do that).
748		1022
749	Note that this is a function, and all types registered this way will be	1023	Note that this is a function, and all types registered this way will be
750	global, so try to use unique names.	1024	global, so try to use unique names.
751		1025
752	For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>,	1026	For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>,
…		…
764	=cut	1038	=cut
765		1039
766	sub stop_read {	1040	sub stop_read {
767	my ($self) = @_;	1041	my ($self) = @_;
768		1042
769	delete $self->{rw};	1043	delete $self->{_rw};
770	}	1044	}
771		1045
772	sub start_read {	1046	sub start_read {
773	my ($self) = @_;	1047	my ($self) = @_;
774		1048
775	unless ($self->{rw} \|\| $self->{eof}) {	1049	unless ($self->{_rw} \|\| $self->{_eof}) {
776	Scalar::Util::weaken $self;	1050	Scalar::Util::weaken $self;
777		1051
778	$self->{rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1052	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
779	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1053	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};
780	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;	1054	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;
781		1055
782	if ($len > 0) {	1056	if ($len > 0) {
		1057	$self->{_activity} = AnyEvent->now;
		1058
783	$self->{filter_r}	1059	$self->{filter_r}
784	? $self->{filter_r}->($self, $rbuf)	1060	? $self->{filter_r}->($self, $rbuf)
785	: $self->_drain_rbuf;	1061	: $self->_drain_rbuf;
786		1062
787	} elsif (defined $len) {	1063	} elsif (defined $len) {
788	delete $self->{rw};	1064	delete $self->{_rw};
		1065	delete $self->{_ww};
		1066	delete $self->{_tw};
789	$self->{eof} = 1;	1067	$self->{_eof} = 1;
790	$self->_drain_rbuf;	1068	$self->_drain_rbuf;
791		1069
792	} elsif ($! != EAGAIN && $! != EINTR && $! != &AnyEvent::Util::WSAWOULDBLOCK) {	1070	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
793	return $self->error;	1071	return $self->error;
794	}	1072	}
795	});	1073	});
796	}	1074	}
797	}	1075	}
798		1076
799	sub _dotls {	1077	sub _dotls {
800	my ($self) = @_;	1078	my ($self) = @_;
801		1079
802	if (length $self->{tls_wbuf}) {	1080	if (length $self->{_tls_wbuf}) {
803	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{tls_wbuf})) > 0) {	1081	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
804	substr $self->{tls_wbuf}, 0, $len, "";	1082	substr $self->{_tls_wbuf}, 0, $len, "";
805	}	1083	}
806	}	1084	}
807		1085
808	if (defined (my $buf = Net::SSLeay::BIO_read ($self->{tls_wbio}))) {	1086	if (defined (my $buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {
809	$self->{wbuf} .= $buf;	1087	$self->{wbuf} .= $buf;
810	$self->_drain_wbuf;	1088	$self->_drain_wbuf;
811	}	1089	}
812		1090
813	while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) {	1091	while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) {
…		…
838	The first argument is the same as the C<tls> constructor argument (either	1116	The first argument is the same as the C<tls> constructor argument (either
839	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1117	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
840		1118
841	The second argument is the optional C<Net::SSLeay::CTX> object that is	1119	The second argument is the optional C<Net::SSLeay::CTX> object that is
842	used when AnyEvent::Handle has to create its own TLS connection object.	1120	used when AnyEvent::Handle has to create its own TLS connection object.
		1121
		1122	The TLS connection object will end up in C<< $handle->{tls} >> after this
		1123	call and can be used or changed to your liking. Note that the handshake
		1124	might have already started when this function returns.
843		1125
844	=cut	1126	=cut
845		1127
846	# TODO: maybe document...	1128	# TODO: maybe document...
847	sub starttls {	1129	sub starttls {
…		…
866	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html	1148	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
867	Net::SSLeay::CTX_set_mode ($self->{tls},	1149	Net::SSLeay::CTX_set_mode ($self->{tls},
868	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1150	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
869	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));	1151	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
870		1152
871	$self->{tls_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1153	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
872	$self->{tls_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1154	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
873		1155
874	Net::SSLeay::set_bio ($ssl, $self->{tls_rbio}, $self->{tls_wbio});	1156	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
875		1157
876	$self->{filter_w} = sub {	1158	$self->{filter_w} = sub {
877	$_[0]{tls_wbuf} .= ${$_[1]};	1159	$_[0]{_tls_wbuf} .= ${$_[1]};
878	&_dotls;	1160	&_dotls;
879	};	1161	};
880	$self->{filter_r} = sub {	1162	$self->{filter_r} = sub {
881	Net::SSLeay::BIO_write ($_[0]{tls_rbio}, ${$_[1]});	1163	Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});
882	&_dotls;	1164	&_dotls;
883	};	1165	};
884	}	1166	}
885		1167
886	=item $handle->stoptls	1168	=item $handle->stoptls
…		…
892		1174
893	sub stoptls {	1175	sub stoptls {
894	my ($self) = @_;	1176	my ($self) = @_;
895		1177
896	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};	1178	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};
		1179
897	delete $self->{tls_rbio};	1180	delete $self->{_rbio};
898	delete $self->{tls_wbio};	1181	delete $self->{_wbio};
899	delete $self->{tls_wbuf};	1182	delete $self->{_tls_wbuf};
900	delete $self->{filter_r};	1183	delete $self->{filter_r};
901	delete $self->{filter_w};	1184	delete $self->{filter_w};
902	}	1185	}
903		1186
904	sub DESTROY {	1187	sub DESTROY {
…		…
942	}	1225	}
943	}	1226	}
944		1227
945	=back	1228	=back
946		1229
		1230	=head1 SUBCLASSING AnyEvent::Handle
		1231
		1232	In many cases, you might want to subclass AnyEvent::Handle.
		1233
		1234	To make this easier, a given version of AnyEvent::Handle uses these
		1235	conventions:
		1236
		1237	=over 4
		1238
		1239	=item * all constructor arguments become object members.
		1240
		1241	At least initially, when you pass a C<tls>-argument to the constructor it
		1242	will end up in C<< $handle->{tls} >>. Those members might be changes or
		1243	mutated later on (for example C<tls> will hold the TLS connection object).
		1244
		1245	=item * other object member names are prefixed with an C<_>.
		1246
		1247	All object members not explicitly documented (internal use) are prefixed
		1248	with an underscore character, so the remaining non-C<_>-namespace is free
		1249	for use for subclasses.
		1250
		1251	=item * all members not documented here and not prefixed with an underscore
		1252	are free to use in subclasses.
		1253
		1254	Of course, new versions of AnyEvent::Handle may introduce more "public"
		1255	member variables, but thats just life, at least it is documented.
		1256
		1257	=back
		1258
947	=head1 AUTHOR	1259	=head1 AUTHOR
948		1260
949	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.	1261	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.
950		1262
951	=cut	1263	=cut

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.34 by root, Mon May 26 03:27:52 2008 UTC vs. Revision 1.45 by root, Thu May 29 00:20:39 2008 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.34 by root, Mon May 26 03:27:52 2008 UTC vs.
Revision 1.45 by root, Thu May 29 00:20:39 2008 UTC