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

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

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.37 by root, Mon May 26 20:02:22 2008 UTC vs. Revision 1.59 by root, Thu Jun 5 16:53:11 2008 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.37 by root, Mon May 26 20:02:22 2008 UTC vs.
Revision 1.59 by root, Thu Jun 5 16:53:11 2008 UTC