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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.31 by root, Sun May 25 00:08:49 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 ();	7	use AnyEvent::Util qw(WSAEWOULDBLOCK);
8	use Scalar::Util ();	8	use Scalar::Util ();
9	use Carp ();	9	use Carp ();
10	use Fcntl ();	10	use Fcntl ();
11	use Errno qw/EAGAIN EINTR/;	11	use Errno qw(EAGAIN EINTR);
12		12
13	=head1 NAME	13	=head1 NAME
14		14
15	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent	15	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent
16		16
17	=cut	17	=cut
18		18
19	our $VERSION = '0.04';	19	our $VERSION = 4.12;
20		20
21	=head1 SYNOPSIS	21	=head1 SYNOPSIS
22		22
23	use AnyEvent;	23	use AnyEvent;
24	use AnyEvent::Handle;	24	use AnyEvent::Handle;
…		…
73	The filehandle this L<AnyEvent::Handle> object will operate on.	73	The filehandle this L<AnyEvent::Handle> object will operate on.
74		74
75	NOTE: The filehandle will be set to non-blocking (using	75	NOTE: The filehandle will be set to non-blocking (using
76	AnyEvent::Util::fh_nonblocking).	76	AnyEvent::Util::fh_nonblocking).
77		77
78	=item on_eof => $cb->($self)	78	=item on_eof => $cb->($handle)
79		79
80	Set the callback to be called on EOF.	80	Set the callback to be called when an end-of-file condition is detcted,
		81	i.e. in the case of a socket, when the other side has closed the
		82	connection cleanly.
81		83
82	While not mandatory, it is highly recommended to set an eof callback,	84	While not mandatory, it is highly recommended to set an eof callback,
83	otherwise you might end up with a closed socket while you are still	85	otherwise you might end up with a closed socket while you are still
84	waiting for data.	86	waiting for data.
85		87
86	=item on_error => $cb->($self)	88	=item on_error => $cb->($handle, $fatal)
87		89
88	This is the fatal error callback, that is called when, well, a fatal error	90	This is the error callback, which is called when, well, some error
89	occurs, such as not being able to resolve the hostname, failure to connect	91	occured, such as not being able to resolve the hostname, failure to
90	or a read error.	92	connect or a read error.
91		93
92	The object will not be in a usable state when this callback has been	94	Some errors are fatal (which is indicated by C<$fatal> being true). On
93	called.	95	fatal errors the handle object will be shut down and will not be
		96	usable. Non-fatal errors can be retried by simply returning, but it is
		97	recommended to simply ignore this parameter and instead abondon the handle
		98	object when this callback is invoked.
94		99
95	On callback entrance, the value of C<$!> contains the operating system	100	On callback entrance, the value of C<$!> contains the operating system
96	error (or C<ENOSPC>, C<EPIPE> or C<EBADMSG>).	101	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).
97		102
98	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
99	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
100	die.	105	C<croak>.
101		106
102	=item on_read => $cb->($self)	107	=item on_read => $cb->($handle)
103		108
104	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
105	and no read request is in the queue.	110	and no read request is in the queue.
106		111
107	To access (and remove data from) the read buffer, use the C<< ->rbuf >>	112	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
108	method or access the C<$self->{rbuf}> member directly.	113	method or access the C<$handle->{rbuf}> member directly.
109		114
110	When an EOF condition is detected then AnyEvent::Handle will first try to	115	When an EOF condition is detected then AnyEvent::Handle will first try to
111	feed all the remaining data to the queued callbacks and C<on_read> before	116	feed all the remaining data to the queued callbacks and C<on_read> before
112	calling the C<on_eof> callback. If no progress can be made, then a fatal	117	calling the C<on_eof> callback. If no progress can be made, then a fatal
113	error will be raised (with C<$!> set to C<EPIPE>).	118	error will be raised (with C<$!> set to C<EPIPE>).
114		119
115	=item on_drain => $cb->()	120	=item on_drain => $cb->($handle)
116		121
117	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
118	(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).
119		124
120	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.
121		146
122	=item rbuf_max => <bytes>	147	=item rbuf_max => <bytes>
123		148
124	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>)
125	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
…		…
132	isn't finished).	157	isn't finished).
133		158
134	=item read_size => <bytes>	159	=item read_size => <bytes>
135		160
136	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
137	on each [loop iteration). Default: C<4096>.	162	during each (loop iteration). Default: C<8192>.
138		163
139	=item low_water_mark => <bytes>	164	=item low_water_mark => <bytes>
140		165
141	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
142	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
…		…
165		190
166	Use the given Net::SSLeay::CTX object to create the new TLS connection	191	Use the given Net::SSLeay::CTX object to create the new TLS connection
167	(unless a connection object was specified directly). If this parameter is	192	(unless a connection object was specified directly). If this parameter is
168	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	193	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
169		194
		195	=item json => JSON or JSON::XS object
		196
		197	This is the json coder object used by the C<json> read and write types.
		198
		199	If you don't supply it, then AnyEvent::Handle will create and use a
		200	suitable one, which will write and expect UTF-8 encoded JSON texts.
		201
		202	Note that you are responsible to depend on the JSON module if you want to
		203	use this functionality, as AnyEvent does not have a dependency itself.
		204
		205	=item filter_r => $cb
		206
		207	=item filter_w => $cb
		208
		209	These exist, but are undocumented at this time.
		210
170	=back	211	=back
171		212
172	=cut	213	=cut
173		214
174	sub new {	215	sub new {
…		…
183	if ($self->{tls}) {	224	if ($self->{tls}) {
184	require Net::SSLeay;	225	require Net::SSLeay;
185	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});	226	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});
186	}	227	}
187		228
188	$self->on_eof (delete $self->{on_eof} ) if $self->{on_eof};	229	# $self->on_eof (delete $self->{on_eof} ) if $self->{on_eof}; # nop
189	$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
190	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	232	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
191	$self->on_read (delete $self->{on_read} ) if $self->{on_read};	233
		234	$self->{_activity} = AnyEvent->now;
		235	$self->_timeout;
192		236
193	$self->start_read;	237	$self->start_read;
194		238
195	$self	239	$self
196	}	240	}
197		241
198	sub _shutdown {	242	sub _shutdown {
199	my ($self) = @_;	243	my ($self) = @_;
200		244
		245	delete $self->{_tw};
201	delete $self->{rw};	246	delete $self->{_rw};
202	delete $self->{ww};	247	delete $self->{_ww};
203	delete $self->{fh};	248	delete $self->{fh};
204	}
205		249
		250	$self->stoptls;
		251	}
		252
206	sub error {	253	sub _error {
207	my ($self) = @_;	254	my ($self, $errno, $fatal) = @_;
208		255
209	{
210	local $!;
211	$self->_shutdown;	256	$self->_shutdown
212	}	257	if $fatal;
		258
		259	$! = $errno;
213		260
214	if ($self->{on_error}) {	261	if ($self->{on_error}) {
215	$self->{on_error}($self);	262	$self->{on_error}($self, $fatal);
216	} else {	263	} else {
217	Carp::croak "AnyEvent::Handle uncaught fatal error: $!";	264	Carp::croak "AnyEvent::Handle uncaught error: $!";
218	}	265	}
219	}	266	}
220		267
221	=item $fh = $handle->fh	268	=item $fh = $handle->fh
222		269
223	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.
224		271
225	=cut	272	=cut
226		273
227	sub fh { $_[0]->{fh} }	274	sub fh { $_[0]{fh} }
228		275
229	=item $handle->on_error ($cb)	276	=item $handle->on_error ($cb)
230		277
231	Replace the current C<on_error> callback (see the C<on_error> constructor argument).	278	Replace the current C<on_error> callback (see the C<on_error> constructor argument).
232		279
…		…
242		289
243	=cut	290	=cut
244		291
245	sub on_eof {	292	sub on_eof {
246	$_[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	}
247	}	361	}
248		362
249	#############################################################################	363	#############################################################################
250		364
251	=back	365	=back
…		…
288	=cut	402	=cut
289		403
290	sub _drain_wbuf {	404	sub _drain_wbuf {
291	my ($self) = @_;	405	my ($self) = @_;
292		406
293	if (!$self->{ww} && length $self->{wbuf}) {	407	if (!$self->{_ww} && length $self->{wbuf}) {
		408
294	Scalar::Util::weaken $self;	409	Scalar::Util::weaken $self;
		410
295	my $cb = sub {	411	my $cb = sub {
296	my $len = syswrite $self->{fh}, $self->{wbuf};	412	my $len = syswrite $self->{fh}, $self->{wbuf};
297		413
298	if ($len >= 0) {	414	if ($len >= 0) {
299	substr $self->{wbuf}, 0, $len, "";	415	substr $self->{wbuf}, 0, $len, "";
		416
		417	$self->{_activity} = AnyEvent->now;
300		418
301	$self->{on_drain}($self)	419	$self->{on_drain}($self)
302	if $self->{low_water_mark} >= length $self->{wbuf}	420	if $self->{low_water_mark} >= length $self->{wbuf}
303	&& $self->{on_drain};	421	&& $self->{on_drain};
304		422
305	delete $self->{ww} unless length $self->{wbuf};	423	delete $self->{_ww} unless length $self->{wbuf};
306	} elsif ($! != EAGAIN && $! != EINTR) {	424	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
307	$self->error;	425	$self->_error ($!, 1);
308	}	426	}
309	};	427	};
310		428
		429	# try to write data immediately
		430	$cb->();
		431
		432	# if still data left in wbuf, we need to poll
311	$self->{ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb);	433	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)
312		434	if length $self->{wbuf};
313	$cb->($self);
314	};	435	};
315	}	436	}
316		437
317	our %WH;	438	our %WH;
318		439
…		…
329	@_ = ($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")
330	->($self, @_);	451	->($self, @_);
331	}	452	}
332		453
333	if ($self->{filter_w}) {	454	if ($self->{filter_w}) {
334	$self->{filter_w}->($self, \$_[0]);	455	$self->{filter_w}($self, \$_[0]);
335	} else {	456	} else {
336	$self->{wbuf} .= $_[0];	457	$self->{wbuf} .= $_[0];
337	$self->_drain_wbuf;	458	$self->_drain_wbuf;
338	}	459	}
339	}	460	}
340		461
341	=item $handle->push_write (type => @args)	462	=item $handle->push_write (type => @args)
342		463
343	=item $handle->unshift_write (type => @args)
344
345	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
346	the job by specifying a type and type-specific arguments.	465	the job by specifying a type and type-specific arguments.
347		466
348	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
349	drop by and tell us):	468	drop by and tell us):
…		…
353	=item netstring => $string	472	=item netstring => $string
354		473
355	Formats the given value as netstring	474	Formats the given value as netstring
356	(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).
357		476
358	=back
359
360	=cut	477	=cut
361		478
362	register_write_type netstring => sub {	479	register_write_type netstring => sub {
363	my ($self, $string) = @_;	480	my ($self, $string) = @_;
364		481
365	sprintf "%d:%s,", (length $string), $string	482	sprintf "%d:%s,", (length $string), $string
366	};	483	};
367		484
		485	=item json => $array_or_hashref
		486
		487	Encodes the given hash or array reference into a JSON object. Unless you
		488	provide your own JSON object, this means it will be encoded to JSON text
		489	in UTF-8.
		490
		491	JSON objects (and arrays) are self-delimiting, so you can write JSON at
		492	one end of a handle and read them at the other end without using any
		493	additional framing.
		494
		495	The generated JSON text is guaranteed not to contain any newlines: While
		496	this module doesn't need delimiters after or between JSON texts to be
		497	able to read them, many other languages depend on that.
		498
		499	A simple RPC protocol that interoperates easily with others is to send
		500	JSON arrays (or objects, although arrays are usually the better choice as
		501	they mimic how function argument passing works) and a newline after each
		502	JSON text:
		503
		504	$handle->push_write (json => ["method", "arg1", "arg2"]); # whatever
		505	$handle->push_write ("\012");
		506
		507	An AnyEvent::Handle receiver would simply use the C<json> read type and
		508	rely on the fact that the newline will be skipped as leading whitespace:
		509
		510	$handle->push_read (json => sub { my $array = $_[1]; ... });
		511
		512	Other languages could read single lines terminated by a newline and pass
		513	this line into their JSON decoder of choice.
		514
		515	=cut
		516
		517	register_write_type json => sub {
		518	my ($self, $ref) = @_;
		519
		520	require JSON;
		521
		522	$self->{json} ? $self->{json}->encode ($ref)
		523	: JSON::encode_json ($ref)
		524	};
		525
		526	=back
		527
368	=item AnyEvent::Handle::register_write_type type => $coderef->($self, @args)	528	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
369		529
370	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>.
371	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
372	reference with the handle object and the remaining arguments.	532	reference with the handle object and the remaining arguments.
373		533
…		…
409	the specified number of bytes which give an XML datagram.	569	the specified number of bytes which give an XML datagram.
410		570
411	# in the default state, expect some header bytes	571	# in the default state, expect some header bytes
412	$handle->on_read (sub {	572	$handle->on_read (sub {
413	# 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)
414	shift->unshift_read_chunk (4, sub {	574	shift->unshift_read (chunk => 4, sub {
415	# header arrived, decode	575	# header arrived, decode
416	my $len = unpack "N", $_[1];	576	my $len = unpack "N", $_[1];
417		577
418	# now read the payload	578	# now read the payload
419	shift->unshift_read_chunk ($len, sub {	579	shift->unshift_read (chunk => $len, sub {
420	my $xml = $_[1];	580	my $xml = $_[1];
421	# handle xml	581	# handle xml
422	});	582	});
423	});	583	});
424	});	584	});
…		…
431		591
432	# request one	592	# request one
433	$handle->push_write ("request 1\015\012");	593	$handle->push_write ("request 1\015\012");
434		594
435	# 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
436	$handle->push_read_line (sub {	596	$handle->push_read (line => sub {
437	# if we got an "OK", we have to _prepend_ another line,	597	# if we got an "OK", we have to _prepend_ another line,
438	# 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
439	# which are already in the queue when this callback is called	599	# which are already in the queue when this callback is called
440	# we don't do this in case we got an error	600	# we don't do this in case we got an error
441	if ($_[1] eq "OK") {	601	if ($_[1] eq "OK") {
442	$_[0]->unshift_read_line (sub {	602	$_[0]->unshift_read (line => sub {
443	my $response = $_[1];	603	my $response = $_[1];
444	...	604	...
445	});	605	});
446	}	606	}
447	});	607	});
448		608
449	# request two	609	# request two
450	$handle->push_write ("request 2\015\012");	610	$handle->push_write ("request 2\015\012");
451		611
452	# simply read 64 bytes, always	612	# simply read 64 bytes, always
453	$handle->push_read_chunk (64, sub {	613	$handle->push_read (chunk => 64, sub {
454	my $response = $_[1];	614	my $response = $_[1];
455	...	615	...
456	});	616	});
457		617
458	=over 4	618	=over 4
…		…
464		624
465	if (	625	if (
466	defined $self->{rbuf_max}	626	defined $self->{rbuf_max}
467	&& $self->{rbuf_max} < length $self->{rbuf}	627	&& $self->{rbuf_max} < length $self->{rbuf}
468	) {	628	) {
469	$! = &Errno::ENOSPC; return $self->error;	629	return $self->_error (&Errno::ENOSPC, 1);
470	}	630	}
471		631
472	return if $self->{in_drain};	632	return if $self->{in_drain};
473	local $self->{in_drain} = 1;	633	local $self->{in_drain} = 1;
474		634
475	while (my $len = length $self->{rbuf}) {	635	while (my $len = length $self->{rbuf}) {
476	no strict 'refs';	636	no strict 'refs';
477	if (my $cb = shift @{ $self->{queue} }) {	637	if (my $cb = shift @{ $self->{_queue} }) {
478	unless ($cb->($self)) {	638	unless ($cb->($self)) {
479	if ($self->{eof}) {	639	if ($self->{_eof}) {
480	# 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)
481	$! = &Errno::EPIPE; return $self->error;	641	return $self->_error (&Errno::EPIPE, 1);
482	}	642	}
483		643
484	unshift @{ $self->{queue} }, $cb;	644	unshift @{ $self->{_queue} }, $cb;
485	return;	645	last;
486	}	646	}
487	} elsif ($self->{on_read}) {	647	} elsif ($self->{on_read}) {
488	$self->{on_read}($self);	648	$self->{on_read}($self);
489		649
490	if (	650	if (
491	$self->{eof} # if no further data will arrive
492	&& $len == length $self->{rbuf} # and no data has been consumed	651	$len == length $self->{rbuf} # if no data has been consumed
493	&& !@{ $self->{queue} } # and the queue is still empty	652	&& !@{ $self->{_queue} } # and the queue is still empty
494	&& $self->{on_read} # and we still want to read data	653	&& $self->{on_read} # but we still have on_read
495	) {	654	) {
		655	# no further data will arrive
496	# then no progress can be made	656	# so no progress can be made
497	$! = &Errno::EPIPE; return $self->error;	657	return $self->_error (&Errno::EPIPE, 1)
		658	if $self->{_eof};
		659
		660	last; # more data might arrive
498	}	661	}
499	} else {	662	} else {
500	# read side becomes idle	663	# read side becomes idle
501	delete $self->{rw};	664	delete $self->{_rw};
502	return;	665	last;
503	}	666	}
504	}	667	}
505		668
506	if ($self->{eof}) {
507	$self->_shutdown;
508	$self->{on_eof}($self)	669	$self->{on_eof}($self)
509	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} };
510	}	676	}
511	}	677	}
512		678
513	=item $handle->on_read ($cb)	679	=item $handle->on_read ($cb)
514		680
…		…
577		743
578	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	744	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
579	->($self, $cb, @_);	745	->($self, $cb, @_);
580	}	746	}
581		747
582	push @{ $self->{queue} }, $cb;	748	push @{ $self->{_queue} }, $cb;
583	$self->_drain_rbuf;	749	$self->_drain_rbuf;
584	}	750	}
585		751
586	sub unshift_read {	752	sub unshift_read {
587	my $self = shift;	753	my $self = shift;
…		…
593	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")	759	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")
594	->($self, $cb, @_);	760	->($self, $cb, @_);
595	}	761	}
596		762
597		763
598	unshift @{ $self->{queue} }, $cb;	764	unshift @{ $self->{_queue} }, $cb;
599	$self->_drain_rbuf;	765	$self->_drain_rbuf;
600	}	766	}
601		767
602	=item $handle->push_read (type => @args, $cb)	768	=item $handle->push_read (type => @args, $cb)
603		769
…		…
610	Predefined types are (if you have ideas for additional types, feel free to	776	Predefined types are (if you have ideas for additional types, feel free to
611	drop by and tell us):	777	drop by and tell us):
612		778
613	=over 4	779	=over 4
614		780
615	=item chunk => $octets, $cb->($self, $data)	781	=item chunk => $octets, $cb->($handle, $data)
616		782
617	Invoke the callback only once C<$octets> bytes have been read. Pass the	783	Invoke the callback only once C<$octets> bytes have been read. Pass the
618	data read to the callback. The callback will never be called with less	784	data read to the callback. The callback will never be called with less
619	data.	785	data.
620		786
…		…
643		809
644	sub unshift_read_chunk {	810	sub unshift_read_chunk {
645	$_[0]->unshift_read (chunk => $_[1], $_[2]);	811	$_[0]->unshift_read (chunk => $_[1], $_[2]);
646	}	812	}
647		813
648	=item line => [$eol, ]$cb->($self, $line, $eol)	814	=item line => [$eol, ]$cb->($handle, $line, $eol)
649		815
650	The callback will be called only once a full line (including the end of	816	The callback will be called only once a full line (including the end of
651	line marker, C<$eol>) has been read. This line (excluding the end of line	817	line marker, C<$eol>) has been read. This line (excluding the end of line
652	marker) will be passed to the callback as second argument (C<$line>), and	818	marker) will be passed to the callback as second argument (C<$line>), and
653	the end of line marker as the third argument (C<$eol>).	819	the end of line marker as the third argument (C<$eol>).
…		…
690	sub unshift_read_line {	856	sub unshift_read_line {
691	my $self = shift;	857	my $self = shift;
692	$self->unshift_read (line => @_);	858	$self->unshift_read (line => @_);
693	}	859	}
694		860
695	=item netstring => $cb->($string)	861	=item netstring => $cb->($handle, $string)
696		862
697	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).	863	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
698		864
699	Throws an error with C<$!> set to EBADMSG on format violations.	865	Throws an error with C<$!> set to EBADMSG on format violations.
700		866
…		…
704	my ($self, $cb) = @_;	870	my ($self, $cb) = @_;
705		871
706	sub {	872	sub {
707	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {	873	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
708	if ($_[0]{rbuf} =~ /[^0-9]/) {	874	if ($_[0]{rbuf} =~ /[^0-9]/) {
709	$! = &Errno::EBADMSG;	875	$self->_error (&Errno::EBADMSG);
710	$self->error;
711	}	876	}
712	return;	877	return;
713	}	878	}
714		879
715	my $len = $1;	880	my $len = $1;
…		…
718	my $string = $_[1];	883	my $string = $_[1];
719	$_[0]->unshift_read (chunk => 1, sub {	884	$_[0]->unshift_read (chunk => 1, sub {
720	if ($_[1] eq ",") {	885	if ($_[1] eq ",") {
721	$cb->($_[0], $string);	886	$cb->($_[0], $string);
722	} else {	887	} else {
723	$! = &Errno::EBADMSG;	888	$self->_error (&Errno::EBADMSG);
724	$self->error;
725	}	889	}
726	});	890	});
727	});	891	});
728		892
729	1	893	1
730	}	894	}
731	};	895	};
732		896
		897	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
		898
		899	Makes a regex match against the regex object C<$accept> and returns
		900	everything up to and including the match.
		901
		902	Example: read a single line terminated by '\n'.
		903
		904	$handle->push_read (regex => qr<\n>, sub { ... });
		905
		906	If C<$reject> is given and not undef, then it determines when the data is
		907	to be rejected: it is matched against the data when the C<$accept> regex
		908	does not match and generates an C<EBADMSG> error when it matches. This is
		909	useful to quickly reject wrong data (to avoid waiting for a timeout or a
		910	receive buffer overflow).
		911
		912	Example: expect a single decimal number followed by whitespace, reject
		913	anything else (not the use of an anchor).
		914
		915	$handle->push_read (regex => qr<^[0-9]+\s>, qr<[^0-9]>, sub { ... });
		916
		917	If C<$skip> is given and not C<undef>, then it will be matched against
		918	the receive buffer when neither C<$accept> nor C<$reject> match,
		919	and everything preceding and including the match will be accepted
		920	unconditionally. This is useful to skip large amounts of data that you
		921	know cannot be matched, so that the C<$accept> or C<$reject> regex do not
		922	have to start matching from the beginning. This is purely an optimisation
		923	and is usually worth only when you expect more than a few kilobytes.
		924
		925	Example: expect a http header, which ends at C<\015\012\015\012>. Since we
		926	expect the header to be very large (it isn't in practise, but...), we use
		927	a skip regex to skip initial portions. The skip regex is tricky in that
		928	it only accepts something not ending in either \015 or \012, as these are
		929	required for the accept regex.
		930
		931	$handle->push_read (regex =>
		932	qr<\015\012\015\012>,
		933	undef, # no reject
		934	qr<^.*[^\015\012]>,
		935	sub { ... });
		936
		937	=cut
		938
		939	register_read_type regex => sub {
		940	my ($self, $cb, $accept, $reject, $skip) = @_;
		941
		942	my $data;
		943	my $rbuf = \$self->{rbuf};
		944
		945	sub {
		946	# accept
		947	if ($$rbuf =~ $accept) {
		948	$data .= substr $$rbuf, 0, $+[0], "";
		949	$cb->($self, $data);
		950	return 1;
		951	}
		952
		953	# reject
		954	if ($reject && $$rbuf =~ $reject) {
		955	$self->_error (&Errno::EBADMSG);
		956	}
		957
		958	# skip
		959	if ($skip && $$rbuf =~ $skip) {
		960	$data .= substr $$rbuf, 0, $+[0], "";
		961	}
		962
		963	()
		964	}
		965	};
		966
		967	=item json => $cb->($handle, $hash_or_arrayref)
		968
		969	Reads a JSON object or array, decodes it and passes it to the callback.
		970
		971	If a C<json> object was passed to the constructor, then that will be used
		972	for the final decode, otherwise it will create a JSON coder expecting UTF-8.
		973
		974	This read type uses the incremental parser available with JSON version
		975	2.09 (and JSON::XS version 2.2) and above. You have to provide a
		976	dependency on your own: this module will load the JSON module, but
		977	AnyEvent does not depend on it itself.
		978
		979	Since JSON texts are fully self-delimiting, the C<json> read and write
		980	types are an ideal simple RPC protocol: just exchange JSON datagrams. See
		981	the C<json> write type description, above, for an actual example.
		982
		983	=cut
		984
		985	register_read_type json => sub {
		986	my ($self, $cb, $accept, $reject, $skip) = @_;
		987
		988	require JSON;
		989
		990	my $data;
		991	my $rbuf = \$self->{rbuf};
		992
		993	my $json = $self->{json} \|\|= JSON->new->utf8;
		994
		995	sub {
		996	my $ref = $json->incr_parse ($self->{rbuf});
		997
		998	if ($ref) {
		999	$self->{rbuf} = $json->incr_text;
		1000	$json->incr_text = "";
		1001	$cb->($self, $ref);
		1002
		1003	1
		1004	} else {
		1005	$self->{rbuf} = "";
		1006	()
		1007	}
		1008	}
		1009	};
		1010
733	=back	1011	=back
734		1012
735	=item AnyEvent::Handle::register_read_type type => $coderef->($self, $cb, @args)	1013	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)
736		1014
737	This function (not method) lets you add your own types to C<push_read>.	1015	This function (not method) lets you add your own types to C<push_read>.
738		1016
739	Whenever the given C<type> is used, C<push_read> will invoke the code	1017	Whenever the given C<type> is used, C<push_read> will invoke the code
740	reference with the handle object, the callback and the remaining	1018	reference with the handle object, the callback and the remaining
…		…
742		1020
743	The code reference is supposed to return a callback (usually a closure)	1021	The code reference is supposed to return a callback (usually a closure)
744	that works as a plain read callback (see C<< ->push_read ($cb) >>).	1022	that works as a plain read callback (see C<< ->push_read ($cb) >>).
745		1023
746	It should invoke the passed callback when it is done reading (remember to	1024	It should invoke the passed callback when it is done reading (remember to
747	pass C<$self> as first argument as all other callbacks do that).	1025	pass C<$handle> as first argument as all other callbacks do that).
748		1026
749	Note that this is a function, and all types registered this way will be	1027	Note that this is a function, and all types registered this way will be
750	global, so try to use unique names.	1028	global, so try to use unique names.
751		1029
752	For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>,	1030	For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>,
…		…
759	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
760	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
761	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
762	C<start_read>.	1040	C<start_read>.
763		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
764	=cut	1047	=cut
765		1048
766	sub stop_read {	1049	sub stop_read {
767	my ($self) = @_;	1050	my ($self) = @_;
768		1051
769	delete $self->{rw};	1052	delete $self->{_rw};
770	}	1053	}
771		1054
772	sub start_read {	1055	sub start_read {
773	my ($self) = @_;	1056	my ($self) = @_;
774		1057
775	unless ($self->{rw} \|\| $self->{eof}) {	1058	unless ($self->{_rw} \|\| $self->{_eof}) {
776	Scalar::Util::weaken $self;	1059	Scalar::Util::weaken $self;
777		1060
778	$self->{rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1061	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
779	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1062	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};
780	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;
781		1064
782	if ($len > 0) {	1065	if ($len > 0) {
		1066	$self->{_activity} = AnyEvent->now;
		1067
783	$self->{filter_r}	1068	$self->{filter_r}
784	? $self->{filter_r}->($self, $rbuf)	1069	? $self->{filter_r}($self, $rbuf)
785	: $self->_drain_rbuf;	1070	: $self->_drain_rbuf;
786		1071
787	} elsif (defined $len) {	1072	} elsif (defined $len) {
788	delete $self->{rw};	1073	delete $self->{_rw};
789	$self->{eof} = 1;	1074	$self->{_eof} = 1;
790	$self->_drain_rbuf;	1075	$self->_drain_rbuf;
791		1076
792	} elsif ($! != EAGAIN && $! != EINTR) {	1077	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
793	return $self->error;	1078	return $self->_error ($!, 1);
794	}	1079	}
795	});	1080	});
796	}	1081	}
797	}	1082	}
798		1083
799	sub _dotls {	1084	sub _dotls {
800	my ($self) = @_;	1085	my ($self) = @_;
801		1086
		1087	my $buf;
		1088
802	if (length $self->{tls_wbuf}) {	1089	if (length $self->{_tls_wbuf}) {
803	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) {
804	substr $self->{tls_wbuf}, 0, $len, "";	1091	substr $self->{_tls_wbuf}, 0, $len, "";
805	}	1092	}
806	}	1093	}
807		1094
808	if (defined (my $buf = Net::SSLeay::BIO_read ($self->{tls_wbio}))) {	1095	if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {
809	$self->{wbuf} .= $buf;	1096	$self->{wbuf} .= $buf;
810	$self->_drain_wbuf;	1097	$self->_drain_wbuf;
811	}	1098	}
812		1099
813	while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) {	1100	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {
		1101	if (length $buf) {
814	$self->{rbuf} .= $buf;	1102	$self->{rbuf} .= $buf;
815	$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	}
816	}	1110	}
817		1111
818	my $err = Net::SSLeay::get_error ($self->{tls}, -1);	1112	my $err = Net::SSLeay::get_error ($self->{tls}, -1);
819		1113
820	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {	1114	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
821	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {	1115	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {
822	$self->error;	1116	return $self->_error ($!, 1);
823	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {	1117	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {
824	$! = &Errno::EIO;	1118	return $self->_error (&Errno::EIO, 1);
825	$self->error;
826	}	1119	}
827		1120
828	# all others are fine for our purposes	1121	# all others are fine for our purposes
829	}	1122	}
830	}	1123	}
…		…
839	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1132	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
840		1133
841	The second argument is the optional C<Net::SSLeay::CTX> object that is	1134	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.	1135	used when AnyEvent::Handle has to create its own TLS connection object.
843		1136
844	=cut	1137	The TLS connection object will end up in C<< $handle->{tls} >> after this
		1138	call and can be used or changed to your liking. Note that the handshake
		1139	might have already started when this function returns.
845		1140
846	# TODO: maybe document...	1141	=cut
		1142
847	sub starttls {	1143	sub starttls {
848	my ($self, $ssl, $ctx) = @_;	1144	my ($self, $ssl, $ctx) = @_;
849		1145
850	$self->stoptls;	1146	$self->stoptls;
851		1147
…		…
863	# but the openssl maintainers basically said: "trust us, it just works".	1159	# but the openssl maintainers basically said: "trust us, it just works".
864	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1160	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
865	# and mismaintained ssleay-module doesn't even offer them).	1161	# and mismaintained ssleay-module doesn't even offer them).
866	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html	1162	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
867	Net::SSLeay::CTX_set_mode ($self->{tls},	1163	Net::SSLeay::CTX_set_mode ($self->{tls},
868	(eval { Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1164	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
869	\| (eval { Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));	1165	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
870		1166
871	$self->{tls_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1167	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
872	$self->{tls_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1168	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
873		1169
874	Net::SSLeay::set_bio ($ssl, $self->{tls_rbio}, $self->{tls_wbio});	1170	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
875		1171
876	$self->{filter_w} = sub {	1172	$self->{filter_w} = sub {
877	$_[0]{tls_wbuf} .= ${$_[1]};	1173	$_[0]{_tls_wbuf} .= ${$_[1]};
878	&_dotls;	1174	&_dotls;
879	};	1175	};
880	$self->{filter_r} = sub {	1176	$self->{filter_r} = sub {
881	Net::SSLeay::BIO_write ($_[0]{tls_rbio}, ${$_[1]});	1177	Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});
882	&_dotls;	1178	&_dotls;
883	};	1179	};
884	}	1180	}
885		1181
886	=item $handle->stoptls	1182	=item $handle->stoptls
…		…
892		1188
893	sub stoptls {	1189	sub stoptls {
894	my ($self) = @_;	1190	my ($self) = @_;
895		1191
896	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};	1192	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};
		1193
897	delete $self->{tls_rbio};	1194	delete $self->{_rbio};
898	delete $self->{tls_wbio};	1195	delete $self->{_wbio};
899	delete $self->{tls_wbuf};	1196	delete $self->{_tls_wbuf};
900	delete $self->{filter_r};	1197	delete $self->{filter_r};
901	delete $self->{filter_w};	1198	delete $self->{filter_w};
902	}	1199	}
903		1200
904	sub DESTROY {	1201	sub DESTROY {
…		…
942	}	1239	}
943	}	1240	}
944		1241
945	=back	1242	=back
946		1243
		1244	=head1 SUBCLASSING AnyEvent::Handle
		1245
		1246	In many cases, you might want to subclass AnyEvent::Handle.
		1247
		1248	To make this easier, a given version of AnyEvent::Handle uses these
		1249	conventions:
		1250
		1251	=over 4
		1252
		1253	=item * all constructor arguments become object members.
		1254
		1255	At least initially, when you pass a C<tls>-argument to the constructor it
		1256	will end up in C<< $handle->{tls} >>. Those members might be changes or
		1257	mutated later on (for example C<tls> will hold the TLS connection object).
		1258
		1259	=item * other object member names are prefixed with an C<_>.
		1260
		1261	All object members not explicitly documented (internal use) are prefixed
		1262	with an underscore character, so the remaining non-C<_>-namespace is free
		1263	for use for subclasses.
		1264
		1265	=item * all members not documented here and not prefixed with an underscore
		1266	are free to use in subclasses.
		1267
		1268	Of course, new versions of AnyEvent::Handle may introduce more "public"
		1269	member variables, but thats just life, at least it is documented.
		1270
		1271	=back
		1272
947	=head1 AUTHOR	1273	=head1 AUTHOR
948		1274
949	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.	1275	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.
950		1276
951	=cut	1277	=cut

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.31 by root, Sun May 25 00:08:49 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.31 by root, Sun May 25 00:08:49 2008 UTC vs.
Revision 1.56 by root, Wed Jun 4 09:55:16 2008 UTC