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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.35 by root, Mon May 26 05:46:35 2008 UTC vs.
Revision 1.50 by root, Fri May 30 21:38:46 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.1;
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 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
…		…
132	isn't finished).	155	isn't finished).
133		156
134	=item read_size => <bytes>	157	=item read_size => <bytes>
135		158
136	The default read block size (the amount of bytes this module will try to read	159	The default read block size (the amount of bytes this module will try to read
137	on each [loop iteration). Default: C<4096>.	160	during each (loop iteration). Default: C<8192>.
138		161
139	=item low_water_mark => <bytes>	162	=item low_water_mark => <bytes>
140		163
141	Sets the amount of bytes (default: C<0>) that make up an "empty" write	164	Sets the amount of bytes (default: C<0>) that make up an "empty" write
142	buffer: If the write reaches this size or gets even samller it is	165	buffer: If the write reaches this size or gets even samller it is
…		…
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
		243	delete $self->{_tw};
201	delete $self->{rw};	244	delete $self->{_rw};
202	delete $self->{ww};	245	delete $self->{_ww};
203	delete $self->{fh};	246	delete $self->{fh};
204	}	247	}
205		248
206	sub error {	249	sub error {
207	my ($self) = @_;	250	my ($self) = @_;
…		…
209	{	252	{
210	local $!;	253	local $!;
211	$self->_shutdown;	254	$self->_shutdown;
212	}	255	}
213		256
214	if ($self->{on_error}) {
215	$self->{on_error}($self);	257	$self->{on_error}($self)
216	} else {	258	if $self->{on_error};
		259
217	Carp::croak "AnyEvent::Handle uncaught fatal error: $!";	260	Carp::croak "AnyEvent::Handle uncaught fatal error: $!";
218	}
219	}	261	}
220		262
221	=item $fh = $handle->fh	263	=item $fh = $handle->fh
222		264
223	This method returns the file handle of the L<AnyEvent::Handle> object.	265	This method returns the file handle of the L<AnyEvent::Handle> object.
224		266
225	=cut	267	=cut
226		268
227	sub fh { $_[0]->{fh} }	269	sub fh { $_[0]{fh} }
228		270
229	=item $handle->on_error ($cb)	271	=item $handle->on_error ($cb)
230		272
231	Replace the current C<on_error> callback (see the C<on_error> constructor argument).	273	Replace the current C<on_error> callback (see the C<on_error> constructor argument).
232		274
…		…
242		284
243	=cut	285	=cut
244		286
245	sub on_eof {	287	sub on_eof {
246	$_[0]{on_eof} = $_[1];	288	$_[0]{on_eof} = $_[1];
		289	}
		290
		291	=item $handle->on_timeout ($cb)
		292
		293	Replace the current C<on_timeout> callback, or disables the callback
		294	(but not the timeout) if C<$cb> = C<undef>. See C<timeout> constructor
		295	argument.
		296
		297	=cut
		298
		299	sub on_timeout {
		300	$_[0]{on_timeout} = $_[1];
		301	}
		302
		303	#############################################################################
		304
		305	=item $handle->timeout ($seconds)
		306
		307	Configures (or disables) the inactivity timeout.
		308
		309	=cut
		310
		311	sub timeout {
		312	my ($self, $timeout) = @_;
		313
		314	$self->{timeout} = $timeout;
		315	$self->_timeout;
		316	}
		317
		318	# reset the timeout watcher, as neccessary
		319	# also check for time-outs
		320	sub _timeout {
		321	my ($self) = @_;
		322
		323	if ($self->{timeout}) {
		324	my $NOW = AnyEvent->now;
		325
		326	# when would the timeout trigger?
		327	my $after = $self->{_activity} + $self->{timeout} - $NOW;
		328
		329	# now or in the past already?
		330	if ($after <= 0) {
		331	$self->{_activity} = $NOW;
		332
		333	if ($self->{on_timeout}) {
		334	$self->{on_timeout}($self);
		335	} else {
		336	$! = Errno::ETIMEDOUT;
		337	$self->error;
		338	}
		339
		340	# callbakx could have changed timeout value, optimise
		341	return unless $self->{timeout};
		342
		343	# calculate new after
		344	$after = $self->{timeout};
		345	}
		346
		347	Scalar::Util::weaken $self;
		348
		349	$self->{_tw} \|\|= AnyEvent->timer (after => $after, cb => sub {
		350	delete $self->{_tw};
		351	$self->_timeout;
		352	});
		353	} else {
		354	delete $self->{_tw};
		355	}
247	}	356	}
248		357
249	#############################################################################	358	#############################################################################
250		359
251	=back	360	=back
…		…
288	=cut	397	=cut
289		398
290	sub _drain_wbuf {	399	sub _drain_wbuf {
291	my ($self) = @_;	400	my ($self) = @_;
292		401
293	if (!$self->{ww} && length $self->{wbuf}) {	402	if (!$self->{_ww} && length $self->{wbuf}) {
294		403
295	Scalar::Util::weaken $self;	404	Scalar::Util::weaken $self;
296		405
297	my $cb = sub {	406	my $cb = sub {
298	my $len = syswrite $self->{fh}, $self->{wbuf};	407	my $len = syswrite $self->{fh}, $self->{wbuf};
299		408
300	if ($len >= 0) {	409	if ($len >= 0) {
301	substr $self->{wbuf}, 0, $len, "";	410	substr $self->{wbuf}, 0, $len, "";
		411
		412	$self->{_activity} = AnyEvent->now;
302		413
303	$self->{on_drain}($self)	414	$self->{on_drain}($self)
304	if $self->{low_water_mark} >= length $self->{wbuf}	415	if $self->{low_water_mark} >= length $self->{wbuf}
305	&& $self->{on_drain};	416	&& $self->{on_drain};
306		417
307	delete $self->{ww} unless length $self->{wbuf};	418	delete $self->{_ww} unless length $self->{wbuf};
308	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAWOULDBLOCK) {	419	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
309	$self->error;	420	$self->error;
310	}	421	}
311	};	422	};
312		423
313	# try to write data immediately	424	# try to write data immediately
314	$cb->();	425	$cb->();
315		426
316	# if still data left in wbuf, we need to poll	427	# if still data left in wbuf, we need to poll
317	$self->{ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	428	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)
318	if length $self->{wbuf};	429	if length $self->{wbuf};
319	};	430	};
320	}	431	}
321		432
322	our %WH;	433	our %WH;
…		…
334	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	445	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")
335	->($self, @_);	446	->($self, @_);
336	}	447	}
337		448
338	if ($self->{filter_w}) {	449	if ($self->{filter_w}) {
339	$self->{filter_w}->($self, \$_[0]);	450	$self->{filter_w}($self, \$_[0]);
340	} else {	451	} else {
341	$self->{wbuf} .= $_[0];	452	$self->{wbuf} .= $_[0];
342	$self->_drain_wbuf;	453	$self->_drain_wbuf;
343	}	454	}
344	}	455	}
…		…
368	my ($self, $string) = @_;	479	my ($self, $string) = @_;
369		480
370	sprintf "%d:%s,", (length $string), $string	481	sprintf "%d:%s,", (length $string), $string
371	};	482	};
372		483
		484	=item json => $array_or_hashref
		485
		486	Encodes the given hash or array reference into a JSON object. Unless you
		487	provide your own JSON object, this means it will be encoded to JSON text
		488	in UTF-8.
		489
		490	JSON objects (and arrays) are self-delimiting, so you can write JSON at
		491	one end of a handle and read them at the other end without using any
		492	additional framing.
		493
		494	The generated JSON text is guaranteed not to contain any newlines: While
		495	this module doesn't need delimiters after or between JSON texts to be
		496	able to read them, many other languages depend on that.
		497
		498	A simple RPC protocol that interoperates easily with others is to send
		499	JSON arrays (or objects, although arrays are usually the better choice as
		500	they mimic how function argument passing works) and a newline after each
		501	JSON text:
		502
		503	$handle->push_write (json => ["method", "arg1", "arg2"]); # whatever
		504	$handle->push_write ("\012");
		505
		506	An AnyEvent::Handle receiver would simply use the C<json> read type and
		507	rely on the fact that the newline will be skipped as leading whitespace:
		508
		509	$handle->push_read (json => sub { my $array = $_[1]; ... });
		510
		511	Other languages could read single lines terminated by a newline and pass
		512	this line into their JSON decoder of choice.
		513
		514	=cut
		515
		516	register_write_type json => sub {
		517	my ($self, $ref) = @_;
		518
		519	require JSON;
		520
		521	$self->{json} ? $self->{json}->encode ($ref)
		522	: JSON::encode_json ($ref)
		523	};
		524
373	=item AnyEvent::Handle::register_write_type type => $coderef->($self, @args)	525	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
374		526
375	This function (not method) lets you add your own types to C<push_write>.	527	This function (not method) lets you add your own types to C<push_write>.
376	Whenever the given C<type> is used, C<push_write> will invoke the code	528	Whenever the given C<type> is used, C<push_write> will invoke the code
377	reference with the handle object and the remaining arguments.	529	reference with the handle object and the remaining arguments.
378		530
…		…
469		621
470	if (	622	if (
471	defined $self->{rbuf_max}	623	defined $self->{rbuf_max}
472	&& $self->{rbuf_max} < length $self->{rbuf}	624	&& $self->{rbuf_max} < length $self->{rbuf}
473	) {	625	) {
474	$! = &Errno::ENOSPC; return $self->error;	626	$! = &Errno::ENOSPC;
		627	$self->error;
475	}	628	}
476		629
477	return if $self->{in_drain};	630	return if $self->{in_drain};
478	local $self->{in_drain} = 1;	631	local $self->{in_drain} = 1;
479		632
480	while (my $len = length $self->{rbuf}) {	633	while (my $len = length $self->{rbuf}) {
481	no strict 'refs';	634	no strict 'refs';
482	if (my $cb = shift @{ $self->{queue} }) {	635	if (my $cb = shift @{ $self->{_queue} }) {
483	unless ($cb->($self)) {	636	unless ($cb->($self)) {
484	if ($self->{eof}) {	637	if ($self->{_eof}) {
485	# no progress can be made (not enough data and no data forthcoming)	638	# no progress can be made (not enough data and no data forthcoming)
486	$! = &Errno::EPIPE; return $self->error;	639	$! = &Errno::EPIPE;
		640	$self->error;
487	}	641	}
488		642
489	unshift @{ $self->{queue} }, $cb;	643	unshift @{ $self->{_queue} }, $cb;
490	return;	644	return;
491	}	645	}
492	} elsif ($self->{on_read}) {	646	} elsif ($self->{on_read}) {
493	$self->{on_read}($self);	647	$self->{on_read}($self);
494		648
495	if (	649	if (
496	$self->{eof} # if no further data will arrive	650	$self->{_eof} # if no further data will arrive
497	&& $len == length $self->{rbuf} # and no data has been consumed	651	&& $len == length $self->{rbuf} # and no data has been consumed
498	&& !@{ $self->{queue} } # and the queue is still empty	652	&& !@{ $self->{_queue} } # and the queue is still empty
499	&& $self->{on_read} # and we still want to read data	653	&& $self->{on_read} # and we still want to read data
500	) {	654	) {
501	# then no progress can be made	655	# then no progress can be made
502	$! = &Errno::EPIPE; return $self->error;	656	$! = &Errno::EPIPE;
		657	$self->error;
503	}	658	}
504	} else {	659	} else {
505	# read side becomes idle	660	# read side becomes idle
506	delete $self->{rw};	661	delete $self->{_rw};
507	return;	662	return;
508	}	663	}
509	}	664	}
510		665
511	if ($self->{eof}) {
512	$self->_shutdown;
513	$self->{on_eof}($self)	666	$self->{on_eof}($self)
514	if $self->{on_eof};	667	if $self->{_eof} && $self->{on_eof};
515	}
516	}	668	}
517		669
518	=item $handle->on_read ($cb)	670	=item $handle->on_read ($cb)
519		671
520	This replaces the currently set C<on_read> callback, or clears it (when	672	This replaces the currently set C<on_read> callback, or clears it (when
…		…
582		734
583	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	735	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
584	->($self, $cb, @_);	736	->($self, $cb, @_);
585	}	737	}
586		738
587	push @{ $self->{queue} }, $cb;	739	push @{ $self->{_queue} }, $cb;
588	$self->_drain_rbuf;	740	$self->_drain_rbuf;
589	}	741	}
590		742
591	sub unshift_read {	743	sub unshift_read {
592	my $self = shift;	744	my $self = shift;
…		…
598	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")	750	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")
599	->($self, $cb, @_);	751	->($self, $cb, @_);
600	}	752	}
601		753
602		754
603	unshift @{ $self->{queue} }, $cb;	755	unshift @{ $self->{_queue} }, $cb;
604	$self->_drain_rbuf;	756	$self->_drain_rbuf;
605	}	757	}
606		758
607	=item $handle->push_read (type => @args, $cb)	759	=item $handle->push_read (type => @args, $cb)
608		760
…		…
615	Predefined types are (if you have ideas for additional types, feel free to	767	Predefined types are (if you have ideas for additional types, feel free to
616	drop by and tell us):	768	drop by and tell us):
617		769
618	=over 4	770	=over 4
619		771
620	=item chunk => $octets, $cb->($self, $data)	772	=item chunk => $octets, $cb->($handle, $data)
621		773
622	Invoke the callback only once C<$octets> bytes have been read. Pass the	774	Invoke the callback only once C<$octets> bytes have been read. Pass the
623	data read to the callback. The callback will never be called with less	775	data read to the callback. The callback will never be called with less
624	data.	776	data.
625		777
…		…
648		800
649	sub unshift_read_chunk {	801	sub unshift_read_chunk {
650	$_[0]->unshift_read (chunk => $_[1], $_[2]);	802	$_[0]->unshift_read (chunk => $_[1], $_[2]);
651	}	803	}
652		804
653	=item line => [$eol, ]$cb->($self, $line, $eol)	805	=item line => [$eol, ]$cb->($handle, $line, $eol)
654		806
655	The callback will be called only once a full line (including the end of	807	The callback will be called only once a full line (including the end of
656	line marker, C<$eol>) has been read. This line (excluding the end of line	808	line marker, C<$eol>) has been read. This line (excluding the end of line
657	marker) will be passed to the callback as second argument (C<$line>), and	809	marker) will be passed to the callback as second argument (C<$line>), and
658	the end of line marker as the third argument (C<$eol>).	810	the end of line marker as the third argument (C<$eol>).
…		…
695	sub unshift_read_line {	847	sub unshift_read_line {
696	my $self = shift;	848	my $self = shift;
697	$self->unshift_read (line => @_);	849	$self->unshift_read (line => @_);
698	}	850	}
699		851
700	=item netstring => $cb->($string)	852	=item netstring => $cb->($handle, $string)
701		853
702	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).	854	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
703		855
704	Throws an error with C<$!> set to EBADMSG on format violations.	856	Throws an error with C<$!> set to EBADMSG on format violations.
705		857
…		…
733		885
734	1	886	1
735	}	887	}
736	};	888	};
737		889
		890	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
		891
		892	Makes a regex match against the regex object C<$accept> and returns
		893	everything up to and including the match.
		894
		895	Example: read a single line terminated by '\n'.
		896
		897	$handle->push_read (regex => qr<\n>, sub { ... });
		898
		899	If C<$reject> is given and not undef, then it determines when the data is
		900	to be rejected: it is matched against the data when the C<$accept> regex
		901	does not match and generates an C<EBADMSG> error when it matches. This is
		902	useful to quickly reject wrong data (to avoid waiting for a timeout or a
		903	receive buffer overflow).
		904
		905	Example: expect a single decimal number followed by whitespace, reject
		906	anything else (not the use of an anchor).
		907
		908	$handle->push_read (regex => qr<^[0-9]+\s>, qr<[^0-9]>, sub { ... });
		909
		910	If C<$skip> is given and not C<undef>, then it will be matched against
		911	the receive buffer when neither C<$accept> nor C<$reject> match,
		912	and everything preceding and including the match will be accepted
		913	unconditionally. This is useful to skip large amounts of data that you
		914	know cannot be matched, so that the C<$accept> or C<$reject> regex do not
		915	have to start matching from the beginning. This is purely an optimisation
		916	and is usually worth only when you expect more than a few kilobytes.
		917
		918	Example: expect a http header, which ends at C<\015\012\015\012>. Since we
		919	expect the header to be very large (it isn't in practise, but...), we use
		920	a skip regex to skip initial portions. The skip regex is tricky in that
		921	it only accepts something not ending in either \015 or \012, as these are
		922	required for the accept regex.
		923
		924	$handle->push_read (regex =>
		925	qr<\015\012\015\012>,
		926	undef, # no reject
		927	qr<^.*[^\015\012]>,
		928	sub { ... });
		929
		930	=cut
		931
		932	register_read_type regex => sub {
		933	my ($self, $cb, $accept, $reject, $skip) = @_;
		934
		935	my $data;
		936	my $rbuf = \$self->{rbuf};
		937
		938	sub {
		939	# accept
		940	if ($$rbuf =~ $accept) {
		941	$data .= substr $$rbuf, 0, $+[0], "";
		942	$cb->($self, $data);
		943	return 1;
		944	}
		945
		946	# reject
		947	if ($reject && $$rbuf =~ $reject) {
		948	$! = &Errno::EBADMSG;
		949	$self->error;
		950	}
		951
		952	# skip
		953	if ($skip && $$rbuf =~ $skip) {
		954	$data .= substr $$rbuf, 0, $+[0], "";
		955	}
		956
		957	()
		958	}
		959	};
		960
		961	=item json => $cb->($handle, $hash_or_arrayref)
		962
		963	Reads a JSON object or array, decodes it and passes it to the callback.
		964
		965	If a C<json> object was passed to the constructor, then that will be used
		966	for the final decode, otherwise it will create a JSON coder expecting UTF-8.
		967
		968	This read type uses the incremental parser available with JSON version
		969	2.09 (and JSON::XS version 2.2) and above. You have to provide a
		970	dependency on your own: this module will load the JSON module, but
		971	AnyEvent does not depend on it itself.
		972
		973	Since JSON texts are fully self-delimiting, the C<json> read and write
		974	types are an ideal simple RPC protocol: just exchange JSON datagrams. See
		975	the C<json> write type description, above, for an actual example.
		976
		977	=cut
		978
		979	register_read_type json => sub {
		980	my ($self, $cb, $accept, $reject, $skip) = @_;
		981
		982	require JSON;
		983
		984	my $data;
		985	my $rbuf = \$self->{rbuf};
		986
		987	my $json = $self->{json} \|\|= JSON->new->utf8;
		988
		989	sub {
		990	my $ref = $json->incr_parse ($self->{rbuf});
		991
		992	if ($ref) {
		993	$self->{rbuf} = $json->incr_text;
		994	$json->incr_text = "";
		995	$cb->($self, $ref);
		996
		997	1
		998	} else {
		999	$self->{rbuf} = "";
		1000	()
		1001	}
		1002	}
		1003	};
		1004
738	=back	1005	=back
739		1006
740	=item AnyEvent::Handle::register_read_type type => $coderef->($self, $cb, @args)	1007	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)
741		1008
742	This function (not method) lets you add your own types to C<push_read>.	1009	This function (not method) lets you add your own types to C<push_read>.
743		1010
744	Whenever the given C<type> is used, C<push_read> will invoke the code	1011	Whenever the given C<type> is used, C<push_read> will invoke the code
745	reference with the handle object, the callback and the remaining	1012	reference with the handle object, the callback and the remaining
…		…
747		1014
748	The code reference is supposed to return a callback (usually a closure)	1015	The code reference is supposed to return a callback (usually a closure)
749	that works as a plain read callback (see C<< ->push_read ($cb) >>).	1016	that works as a plain read callback (see C<< ->push_read ($cb) >>).
750		1017
751	It should invoke the passed callback when it is done reading (remember to	1018	It should invoke the passed callback when it is done reading (remember to
752	pass C<$self> as first argument as all other callbacks do that).	1019	pass C<$handle> as first argument as all other callbacks do that).
753		1020
754	Note that this is a function, and all types registered this way will be	1021	Note that this is a function, and all types registered this way will be
755	global, so try to use unique names.	1022	global, so try to use unique names.
756		1023
757	For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>,	1024	For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>,
…		…
769	=cut	1036	=cut
770		1037
771	sub stop_read {	1038	sub stop_read {
772	my ($self) = @_;	1039	my ($self) = @_;
773		1040
774	delete $self->{rw};	1041	delete $self->{_rw};
775	}	1042	}
776		1043
777	sub start_read {	1044	sub start_read {
778	my ($self) = @_;	1045	my ($self) = @_;
779		1046
780	unless ($self->{rw} \|\| $self->{eof}) {	1047	unless ($self->{_rw} \|\| $self->{_eof}) {
781	Scalar::Util::weaken $self;	1048	Scalar::Util::weaken $self;
782		1049
783	$self->{rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1050	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
784	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1051	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};
785	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;	1052	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;
786		1053
787	if ($len > 0) {	1054	if ($len > 0) {
		1055	$self->{_activity} = AnyEvent->now;
		1056
788	$self->{filter_r}	1057	$self->{filter_r}
789	? $self->{filter_r}->($self, $rbuf)	1058	? $self->{filter_r}($self, $rbuf)
790	: $self->_drain_rbuf;	1059	: $self->_drain_rbuf;
791		1060
792	} elsif (defined $len) {	1061	} elsif (defined $len) {
793	delete $self->{rw};	1062	delete $self->{_rw};
794	$self->{eof} = 1;	1063	$self->{_eof} = 1;
795	$self->_drain_rbuf;	1064	$self->_drain_rbuf;
796		1065
797	} elsif ($! != EAGAIN && $! != EINTR && $! != &AnyEvent::Util::WSAWOULDBLOCK) {	1066	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
798	return $self->error;	1067	return $self->error;
799	}	1068	}
800	});	1069	});
801	}	1070	}
802	}	1071	}
803		1072
804	sub _dotls {	1073	sub _dotls {
805	my ($self) = @_;	1074	my ($self) = @_;
806		1075
807	if (length $self->{tls_wbuf}) {	1076	if (length $self->{_tls_wbuf}) {
808	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{tls_wbuf})) > 0) {	1077	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
809	substr $self->{tls_wbuf}, 0, $len, "";	1078	substr $self->{_tls_wbuf}, 0, $len, "";
810	}	1079	}
811	}	1080	}
812		1081
813	if (defined (my $buf = Net::SSLeay::BIO_read ($self->{tls_wbio}))) {	1082	if (defined (my $buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {
814	$self->{wbuf} .= $buf;	1083	$self->{wbuf} .= $buf;
815	$self->_drain_wbuf;	1084	$self->_drain_wbuf;
816	}	1085	}
817		1086
818	while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) {	1087	while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) {
…		…
843	The first argument is the same as the C<tls> constructor argument (either	1112	The first argument is the same as the C<tls> constructor argument (either
844	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1113	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
845		1114
846	The second argument is the optional C<Net::SSLeay::CTX> object that is	1115	The second argument is the optional C<Net::SSLeay::CTX> object that is
847	used when AnyEvent::Handle has to create its own TLS connection object.	1116	used when AnyEvent::Handle has to create its own TLS connection object.
		1117
		1118	The TLS connection object will end up in C<< $handle->{tls} >> after this
		1119	call and can be used or changed to your liking. Note that the handshake
		1120	might have already started when this function returns.
848		1121
849	=cut	1122	=cut
850		1123
851	# TODO: maybe document...	1124	# TODO: maybe document...
852	sub starttls {	1125	sub starttls {
…		…
871	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html	1144	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
872	Net::SSLeay::CTX_set_mode ($self->{tls},	1145	Net::SSLeay::CTX_set_mode ($self->{tls},
873	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1146	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
874	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));	1147	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
875		1148
876	$self->{tls_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1149	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
877	$self->{tls_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1150	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
878		1151
879	Net::SSLeay::set_bio ($ssl, $self->{tls_rbio}, $self->{tls_wbio});	1152	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
880		1153
881	$self->{filter_w} = sub {	1154	$self->{filter_w} = sub {
882	$_[0]{tls_wbuf} .= ${$_[1]};	1155	$_[0]{_tls_wbuf} .= ${$_[1]};
883	&_dotls;	1156	&_dotls;
884	};	1157	};
885	$self->{filter_r} = sub {	1158	$self->{filter_r} = sub {
886	Net::SSLeay::BIO_write ($_[0]{tls_rbio}, ${$_[1]});	1159	Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});
887	&_dotls;	1160	&_dotls;
888	};	1161	};
889	}	1162	}
890		1163
891	=item $handle->stoptls	1164	=item $handle->stoptls
…		…
897		1170
898	sub stoptls {	1171	sub stoptls {
899	my ($self) = @_;	1172	my ($self) = @_;
900		1173
901	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};	1174	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};
		1175
902	delete $self->{tls_rbio};	1176	delete $self->{_rbio};
903	delete $self->{tls_wbio};	1177	delete $self->{_wbio};
904	delete $self->{tls_wbuf};	1178	delete $self->{_tls_wbuf};
905	delete $self->{filter_r};	1179	delete $self->{filter_r};
906	delete $self->{filter_w};	1180	delete $self->{filter_w};
907	}	1181	}
908		1182
909	sub DESTROY {	1183	sub DESTROY {
…		…
947	}	1221	}
948	}	1222	}
949		1223
950	=back	1224	=back
951		1225
		1226	=head1 SUBCLASSING AnyEvent::Handle
		1227
		1228	In many cases, you might want to subclass AnyEvent::Handle.
		1229
		1230	To make this easier, a given version of AnyEvent::Handle uses these
		1231	conventions:
		1232
		1233	=over 4
		1234
		1235	=item * all constructor arguments become object members.
		1236
		1237	At least initially, when you pass a C<tls>-argument to the constructor it
		1238	will end up in C<< $handle->{tls} >>. Those members might be changes or
		1239	mutated later on (for example C<tls> will hold the TLS connection object).
		1240
		1241	=item * other object member names are prefixed with an C<_>.
		1242
		1243	All object members not explicitly documented (internal use) are prefixed
		1244	with an underscore character, so the remaining non-C<_>-namespace is free
		1245	for use for subclasses.
		1246
		1247	=item * all members not documented here and not prefixed with an underscore
		1248	are free to use in subclasses.
		1249
		1250	Of course, new versions of AnyEvent::Handle may introduce more "public"
		1251	member variables, but thats just life, at least it is documented.
		1252
		1253	=back
		1254
952	=head1 AUTHOR	1255	=head1 AUTHOR
953		1256
954	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.	1257	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.
955		1258
956	=cut	1259	=cut

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.35 by root, Mon May 26 05:46:35 2008 UTC vs. Revision 1.50 by root, Fri May 30 21:38:46 2008 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.35 by root, Mon May 26 05:46:35 2008 UTC vs.
Revision 1.50 by root, Fri May 30 21:38:46 2008 UTC