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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.30 by root, Sat May 24 23:56:26 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 ();	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	This module is experimental.
18
19	=cut	17	=cut
20		18
21	our $VERSION = '0.04';	19	our $VERSION = 4.13;
22		20
23	=head1 SYNOPSIS	21	=head1 SYNOPSIS
24		22
25	use AnyEvent;	23	use AnyEvent;
26	use AnyEvent::Handle;	24	use AnyEvent::Handle;
27		25
28	my $cv = AnyEvent->condvar;	26	my $cv = AnyEvent->condvar;
29		27
30	my $ae_fh = AnyEvent::Handle->new (fh => \*STDIN);	28	my $handle =
31
32	#TODO
33
34	# or use the constructor to pass the callback:
35
36	my $ae_fh2 =
37	AnyEvent::Handle->new (	29	AnyEvent::Handle->new (
38	fh => \*STDIN,	30	fh => \*STDIN,
39	on_eof => sub {	31	on_eof => sub {
40	$cv->broadcast;	32	$cv->broadcast;
41	},	33	},
42	#TODO
43	);	34	);
44		35
45	$cv->wait;	36	# send some request line
		37	$handle->push_write ("getinfo\015\012");
		38
		39	# read the response line
		40	$handle->push_read (line => sub {
		41	my ($handle, $line) = @_;
		42	warn "read line <$line>\n";
		43	$cv->send;
		44	});
		45
		46	$cv->recv;
46		47
47	=head1 DESCRIPTION	48	=head1 DESCRIPTION
48		49
49	This module is a helper module to make it easier to do event-based I/O on	50	This module is a helper module to make it easier to do event-based I/O on
50	filehandles. For utility functions for doing non-blocking connects and accepts	51	filehandles. For utility functions for doing non-blocking connects and accepts
…		…
72	The filehandle this L<AnyEvent::Handle> object will operate on.	73	The filehandle this L<AnyEvent::Handle> object will operate on.
73		74
74	NOTE: The filehandle will be set to non-blocking (using	75	NOTE: The filehandle will be set to non-blocking (using
75	AnyEvent::Util::fh_nonblocking).	76	AnyEvent::Util::fh_nonblocking).
76		77
77	=item on_eof => $cb->($self)	78	=item on_eof => $cb->($handle)
78		79
79	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.
80		83
81	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,
82	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
83	waiting for data.	86	waiting for data.
84		87
85	=item on_error => $cb->($self)	88	=item on_error => $cb->($handle, $fatal)
86		89
87	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
88	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
89	or a read error.	92	connect or a read error.
90		93
91	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
92	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.
93		99
94	On callback entrance, the value of C<$!> contains the operating system	100	On callback entrance, the value of C<$!> contains the operating system
95	error (or C<ENOSPC>, C<EPIPE> or C<EBADMSG>).	101	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).
96		102
97	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
98	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
99	die.	105	C<croak>.
100		106
101	=item on_read => $cb->($self)	107	=item on_read => $cb->($handle)
102		108
103	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
104	and no read request is in the queue.	110	and no read request is in the queue.
105		111
106	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 >>
107	method or access the C<$self->{rbuf}> member directly.	113	method or access the C<$handle->{rbuf}> member directly.
108		114
109	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
110	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
111	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
112	error will be raised (with C<$!> set to C<EPIPE>).	118	error will be raised (with C<$!> set to C<EPIPE>).
113		119
114	=item on_drain => $cb->()	120	=item on_drain => $cb->($handle)
115		121
116	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
117	(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).
118		124
119	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.
120		146
121	=item rbuf_max => <bytes>	147	=item rbuf_max => <bytes>
122		148
123	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>)
124	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
…		…
131	isn't finished).	157	isn't finished).
132		158
133	=item read_size => <bytes>	159	=item read_size => <bytes>
134		160
135	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
136	on each [loop iteration). Default: C<4096>.	162	during each (loop iteration). Default: C<8192>.
137		163
138	=item low_water_mark => <bytes>	164	=item low_water_mark => <bytes>
139		165
140	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
141	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
…		…
164		190
165	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
166	(unless a connection object was specified directly). If this parameter is	192	(unless a connection object was specified directly). If this parameter is
167	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	193	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
168		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
169	=back	211	=back
170		212
171	=cut	213	=cut
172		214
173	sub new {	215	sub new {
…		…
182	if ($self->{tls}) {	224	if ($self->{tls}) {
183	require Net::SSLeay;	225	require Net::SSLeay;
184	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});	226	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});
185	}	227	}
186		228
187	$self->on_eof (delete $self->{on_eof} ) if $self->{on_eof};	229	$self->{_activity} = AnyEvent->now;
188	$self->on_error (delete $self->{on_error}) if $self->{on_error};	230	$self->_timeout;
		231
189	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	232	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
190	$self->on_read (delete $self->{on_read} ) if $self->{on_read};	233	$self->on_read (delete $self->{on_read} ) if $self->{on_read};
191		234
192	$self->start_read;
193
194	$self	235	$self
195	}	236	}
196		237
197	sub _shutdown {	238	sub _shutdown {
198	my ($self) = @_;	239	my ($self) = @_;
199		240
		241	delete $self->{_tw};
200	delete $self->{rw};	242	delete $self->{_rw};
201	delete $self->{ww};	243	delete $self->{_ww};
202	delete $self->{fh};	244	delete $self->{fh};
203	}
204		245
		246	$self->stoptls;
		247	}
		248
205	sub error {	249	sub _error {
206	my ($self) = @_;	250	my ($self, $errno, $fatal) = @_;
207		251
208	{
209	local $!;
210	$self->_shutdown;	252	$self->_shutdown
211	}	253	if $fatal;
		254
		255	$! = $errno;
212		256
213	if ($self->{on_error}) {	257	if ($self->{on_error}) {
214	$self->{on_error}($self);	258	$self->{on_error}($self, $fatal);
215	} else {	259	} else {
216	Carp::croak "AnyEvent::Handle uncaught fatal error: $!";	260	Carp::croak "AnyEvent::Handle uncaught error: $!";
217	}	261	}
218	}	262	}
219		263
220	=item $fh = $handle->fh	264	=item $fh = $handle->fh
221		265
222	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.
223		267
224	=cut	268	=cut
225		269
226	sub fh { $_[0]->{fh} }	270	sub fh { $_[0]{fh} }
227		271
228	=item $handle->on_error ($cb)	272	=item $handle->on_error ($cb)
229		273
230	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).
231		275
…		…
241		285
242	=cut	286	=cut
243		287
244	sub on_eof {	288	sub on_eof {
245	$_[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	}
246	}	357	}
247		358
248	#############################################################################	359	#############################################################################
249		360
250	=back	361	=back
…		…
287	=cut	398	=cut
288		399
289	sub _drain_wbuf {	400	sub _drain_wbuf {
290	my ($self) = @_;	401	my ($self) = @_;
291		402
292	if (!$self->{ww} && length $self->{wbuf}) {	403	if (!$self->{_ww} && length $self->{wbuf}) {
		404
293	Scalar::Util::weaken $self;	405	Scalar::Util::weaken $self;
		406
294	my $cb = sub {	407	my $cb = sub {
295	my $len = syswrite $self->{fh}, $self->{wbuf};	408	my $len = syswrite $self->{fh}, $self->{wbuf};
296		409
297	if ($len >= 0) {	410	if ($len >= 0) {
298	substr $self->{wbuf}, 0, $len, "";	411	substr $self->{wbuf}, 0, $len, "";
		412
		413	$self->{_activity} = AnyEvent->now;
299		414
300	$self->{on_drain}($self)	415	$self->{on_drain}($self)
301	if $self->{low_water_mark} >= length $self->{wbuf}	416	if $self->{low_water_mark} >= length $self->{wbuf}
302	&& $self->{on_drain};	417	&& $self->{on_drain};
303		418
304	delete $self->{ww} unless length $self->{wbuf};	419	delete $self->{_ww} unless length $self->{wbuf};
305	} elsif ($! != EAGAIN && $! != EINTR) {	420	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
306	$self->error;	421	$self->_error ($!, 1);
307	}	422	}
308	};	423	};
309		424
		425	# try to write data immediately
		426	$cb->();
		427
		428	# if still data left in wbuf, we need to poll
310	$self->{ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb);	429	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)
311		430	if length $self->{wbuf};
312	$cb->($self);
313	};	431	};
314	}	432	}
315		433
316	our %WH;	434	our %WH;
317		435
…		…
328	@_ = ($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")
329	->($self, @_);	447	->($self, @_);
330	}	448	}
331		449
332	if ($self->{filter_w}) {	450	if ($self->{filter_w}) {
333	$self->{filter_w}->($self, \$_[0]);	451	$self->{filter_w}($self, \$_[0]);
334	} else {	452	} else {
335	$self->{wbuf} .= $_[0];	453	$self->{wbuf} .= $_[0];
336	$self->_drain_wbuf;	454	$self->_drain_wbuf;
337	}	455	}
338	}	456	}
339		457
340	=item $handle->push_write (type => @args)	458	=item $handle->push_write (type => @args)
341		459
342	=item $handle->unshift_write (type => @args)
343
344	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
345	the job by specifying a type and type-specific arguments.	461	the job by specifying a type and type-specific arguments.
346		462
347	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
348	drop by and tell us):	464	drop by and tell us):
…		…
352	=item netstring => $string	468	=item netstring => $string
353		469
354	Formats the given value as netstring	470	Formats the given value as netstring
355	(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).
356		472
357	=back
358
359	=cut	473	=cut
360		474
361	register_write_type netstring => sub {	475	register_write_type netstring => sub {
362	my ($self, $string) = @_;	476	my ($self, $string) = @_;
363		477
364	sprintf "%d:%s,", (length $string), $string	478	sprintf "%d:%s,", (length $string), $string
365	};	479	};
366		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
367	=item AnyEvent::Handle::register_write_type type => $coderef->($self, @args)	524	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
368		525
369	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>.
370	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
371	reference with the handle object and the remaining arguments.	528	reference with the handle object and the remaining arguments.
372		529
…		…
408	the specified number of bytes which give an XML datagram.	565	the specified number of bytes which give an XML datagram.
409		566
410	# in the default state, expect some header bytes	567	# in the default state, expect some header bytes
411	$handle->on_read (sub {	568	$handle->on_read (sub {
412	# 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)
413	shift->unshift_read_chunk (4, sub {	570	shift->unshift_read (chunk => 4, sub {
414	# header arrived, decode	571	# header arrived, decode
415	my $len = unpack "N", $_[1];	572	my $len = unpack "N", $_[1];
416		573
417	# now read the payload	574	# now read the payload
418	shift->unshift_read_chunk ($len, sub {	575	shift->unshift_read (chunk => $len, sub {
419	my $xml = $_[1];	576	my $xml = $_[1];
420	# handle xml	577	# handle xml
421	});	578	});
422	});	579	});
423	});	580	});
…		…
430		587
431	# request one	588	# request one
432	$handle->push_write ("request 1\015\012");	589	$handle->push_write ("request 1\015\012");
433		590
434	# 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
435	$handle->push_read_line (sub {	592	$handle->push_read (line => sub {
436	# if we got an "OK", we have to _prepend_ another line,	593	# if we got an "OK", we have to _prepend_ another line,
437	# 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
438	# which are already in the queue when this callback is called	595	# which are already in the queue when this callback is called
439	# we don't do this in case we got an error	596	# we don't do this in case we got an error
440	if ($_[1] eq "OK") {	597	if ($_[1] eq "OK") {
441	$_[0]->unshift_read_line (sub {	598	$_[0]->unshift_read (line => sub {
442	my $response = $_[1];	599	my $response = $_[1];
443	...	600	...
444	});	601	});
445	}	602	}
446	});	603	});
447		604
448	# request two	605	# request two
449	$handle->push_write ("request 2\015\012");	606	$handle->push_write ("request 2\015\012");
450		607
451	# simply read 64 bytes, always	608	# simply read 64 bytes, always
452	$handle->push_read_chunk (64, sub {	609	$handle->push_read (chunk => 64, sub {
453	my $response = $_[1];	610	my $response = $_[1];
454	...	611	...
455	});	612	});
456		613
457	=over 4	614	=over 4
458		615
459	=cut	616	=cut
460		617
461	sub _drain_rbuf {	618	sub _drain_rbuf {
462	my ($self) = @_;	619	my ($self) = @_;
		620
		621	local $self->{_in_drain} = 1;
463		622
464	if (	623	if (
465	defined $self->{rbuf_max}	624	defined $self->{rbuf_max}
466	&& $self->{rbuf_max} < length $self->{rbuf}	625	&& $self->{rbuf_max} < length $self->{rbuf}
467	) {	626	) {
468	$! = &Errno::ENOSPC; return $self->error;	627	return $self->_error (&Errno::ENOSPC, 1);
469	}	628	}
470		629
471	return if $self->{in_drain};	630	while () {
472	local $self->{in_drain} = 1;
473
474	while (my $len = length $self->{rbuf}) {
475	no strict 'refs';	631	no strict 'refs';
		632
		633	my $len = length $self->{rbuf};
		634
476	if (my $cb = shift @{ $self->{queue} }) {	635	if (my $cb = shift @{ $self->{_queue} }) {
477	unless ($cb->($self)) {	636	unless ($cb->($self)) {
478	if ($self->{eof}) {	637	if ($self->{_eof}) {
479	# 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)
480	$! = &Errno::EPIPE; return $self->error;	639	return $self->_error (&Errno::EPIPE, 1);
481	}	640	}
482		641
483	unshift @{ $self->{queue} }, $cb;	642	unshift @{ $self->{_queue} }, $cb;
484	return;	643	last;
485	}	644	}
486	} elsif ($self->{on_read}) {	645	} elsif ($self->{on_read}) {
487	$self->{on_read}($self);	646	$self->{on_read}($self);
488		647
489	if (	648	if (
490	$self->{eof} # if no further data will arrive
491	&& $len == length $self->{rbuf} # and no data has been consumed	649	$len == length $self->{rbuf} # if no data has been consumed
492	&& !@{ $self->{queue} } # and the queue is still empty	650	&& !@{ $self->{_queue} } # and the queue is still empty
493	&& $self->{on_read} # and we still want to read data	651	&& $self->{on_read} # but we still have on_read
494	) {	652	) {
		653	# no further data will arrive
495	# then no progress can be made	654	# so no progress can be made
496	$! = &Errno::EPIPE; return $self->error;	655	return $self->_error (&Errno::EPIPE, 1)
		656	if $self->{_eof};
		657
		658	last; # more data might arrive
497	}	659	}
498	} else {	660	} else {
499	# read side becomes idle	661	# read side becomes idle
500	delete $self->{rw};	662	delete $self->{_rw};
501	return;	663	last;
502	}	664	}
503	}	665	}
504		666
505	if ($self->{eof}) {
506	$self->_shutdown;
507	$self->{on_eof}($self)	667	$self->{on_eof}($self)
508	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} };
509	}	674	}
510	}	675	}
511		676
512	=item $handle->on_read ($cb)	677	=item $handle->on_read ($cb)
513		678
…		…
519		684
520	sub on_read {	685	sub on_read {
521	my ($self, $cb) = @_;	686	my ($self, $cb) = @_;
522		687
523	$self->{on_read} = $cb;	688	$self->{on_read} = $cb;
		689	$self->_drain_rbuf if $cb && !$self->{_in_drain};
524	}	690	}
525		691
526	=item $handle->rbuf	692	=item $handle->rbuf
527		693
528	Returns the read buffer (as a modifiable lvalue).	694	Returns the read buffer (as a modifiable lvalue).
…		…
576		742
577	$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")
578	->($self, $cb, @_);	744	->($self, $cb, @_);
579	}	745	}
580		746
581	push @{ $self->{queue} }, $cb;	747	push @{ $self->{_queue} }, $cb;
582	$self->_drain_rbuf;	748	$self->_drain_rbuf unless $self->{_in_drain};
583	}	749	}
584		750
585	sub unshift_read {	751	sub unshift_read {
586	my $self = shift;	752	my $self = shift;
587	my $cb = pop;	753	my $cb = pop;
…		…
592	$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")
593	->($self, $cb, @_);	759	->($self, $cb, @_);
594	}	760	}
595		761
596		762
597	unshift @{ $self->{queue} }, $cb;	763	unshift @{ $self->{_queue} }, $cb;
598	$self->_drain_rbuf;	764	$self->_drain_rbuf unless $self->{_in_drain};
599	}	765	}
600		766
601	=item $handle->push_read (type => @args, $cb)	767	=item $handle->push_read (type => @args, $cb)
602		768
603	=item $handle->unshift_read (type => @args, $cb)	769	=item $handle->unshift_read (type => @args, $cb)
…		…
609	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
610	drop by and tell us):	776	drop by and tell us):
611		777
612	=over 4	778	=over 4
613		779
614	=item chunk => $octets, $cb->($self, $data)	780	=item chunk => $octets, $cb->($handle, $data)
615		781
616	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
617	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
618	data.	784	data.
619		785
…		…
642		808
643	sub unshift_read_chunk {	809	sub unshift_read_chunk {
644	$_[0]->unshift_read (chunk => $_[1], $_[2]);	810	$_[0]->unshift_read (chunk => $_[1], $_[2]);
645	}	811	}
646		812
647	=item line => [$eol, ]$cb->($self, $line, $eol)	813	=item line => [$eol, ]$cb->($handle, $line, $eol)
648		814
649	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
650	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
651	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
652	the end of line marker as the third argument (C<$eol>).	818	the end of line marker as the third argument (C<$eol>).
…		…
689	sub unshift_read_line {	855	sub unshift_read_line {
690	my $self = shift;	856	my $self = shift;
691	$self->unshift_read (line => @_);	857	$self->unshift_read (line => @_);
692	}	858	}
693		859
694	=item netstring => $cb->($string)	860	=item netstring => $cb->($handle, $string)
695		861
696	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).
697		863
698	Throws an error with C<$!> set to EBADMSG on format violations.	864	Throws an error with C<$!> set to EBADMSG on format violations.
699		865
…		…
703	my ($self, $cb) = @_;	869	my ($self, $cb) = @_;
704		870
705	sub {	871	sub {
706	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {	872	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
707	if ($_[0]{rbuf} =~ /[^0-9]/) {	873	if ($_[0]{rbuf} =~ /[^0-9]/) {
708	$! = &Errno::EBADMSG;	874	$self->_error (&Errno::EBADMSG);
709	$self->error;
710	}	875	}
711	return;	876	return;
712	}	877	}
713		878
714	my $len = $1;	879	my $len = $1;
…		…
717	my $string = $_[1];	882	my $string = $_[1];
718	$_[0]->unshift_read (chunk => 1, sub {	883	$_[0]->unshift_read (chunk => 1, sub {
719	if ($_[1] eq ",") {	884	if ($_[1] eq ",") {
720	$cb->($_[0], $string);	885	$cb->($_[0], $string);
721	} else {	886	} else {
722	$! = &Errno::EBADMSG;	887	$self->_error (&Errno::EBADMSG);
723	$self->error;
724	}	888	}
725	});	889	});
726	});	890	});
727		891
728	1	892	1
729	}	893	}
730	};	894	};
731		895
		896	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
		897
		898	Makes a regex match against the regex object C<$accept> and returns
		899	everything up to and including the match.
		900
		901	Example: read a single line terminated by '\n'.
		902
		903	$handle->push_read (regex => qr<\n>, sub { ... });
		904
		905	If C<$reject> is given and not undef, then it determines when the data is
		906	to be rejected: it is matched against the data when the C<$accept> regex
		907	does not match and generates an C<EBADMSG> error when it matches. This is
		908	useful to quickly reject wrong data (to avoid waiting for a timeout or a
		909	receive buffer overflow).
		910
		911	Example: expect a single decimal number followed by whitespace, reject
		912	anything else (not the use of an anchor).
		913
		914	$handle->push_read (regex => qr<^[0-9]+\s>, qr<[^0-9]>, sub { ... });
		915
		916	If C<$skip> is given and not C<undef>, then it will be matched against
		917	the receive buffer when neither C<$accept> nor C<$reject> match,
		918	and everything preceding and including the match will be accepted
		919	unconditionally. This is useful to skip large amounts of data that you
		920	know cannot be matched, so that the C<$accept> or C<$reject> regex do not
		921	have to start matching from the beginning. This is purely an optimisation
		922	and is usually worth only when you expect more than a few kilobytes.
		923
		924	Example: expect a http header, which ends at C<\015\012\015\012>. Since we
		925	expect the header to be very large (it isn't in practise, but...), we use
		926	a skip regex to skip initial portions. The skip regex is tricky in that
		927	it only accepts something not ending in either \015 or \012, as these are
		928	required for the accept regex.
		929
		930	$handle->push_read (regex =>
		931	qr<\015\012\015\012>,
		932	undef, # no reject
		933	qr<^.*[^\015\012]>,
		934	sub { ... });
		935
		936	=cut
		937
		938	register_read_type regex => sub {
		939	my ($self, $cb, $accept, $reject, $skip) = @_;
		940
		941	my $data;
		942	my $rbuf = \$self->{rbuf};
		943
		944	sub {
		945	# accept
		946	if ($$rbuf =~ $accept) {
		947	$data .= substr $$rbuf, 0, $+[0], "";
		948	$cb->($self, $data);
		949	return 1;
		950	}
		951
		952	# reject
		953	if ($reject && $$rbuf =~ $reject) {
		954	$self->_error (&Errno::EBADMSG);
		955	}
		956
		957	# skip
		958	if ($skip && $$rbuf =~ $skip) {
		959	$data .= substr $$rbuf, 0, $+[0], "";
		960	}
		961
		962	()
		963	}
		964	};
		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
732	=back	1010	=back
733		1011
734	=item AnyEvent::Handle::register_read_type type => $coderef->($self, $cb, @args)	1012	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)
735		1013
736	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>.
737		1015
738	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
739	reference with the handle object, the callback and the remaining	1017	reference with the handle object, the callback and the remaining
…		…
741		1019
742	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)
743	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) >>).
744		1022
745	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
746	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).
747		1025
748	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
749	global, so try to use unique names.	1027	global, so try to use unique names.
750		1028
751	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>,
…		…
754	=item $handle->stop_read	1032	=item $handle->stop_read
755		1033
756	=item $handle->start_read	1034	=item $handle->start_read
757		1035
758	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
759	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
760	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
761	C<start_read>.	1039	C<start_read>.
762		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
763	=cut	1046	=cut
764		1047
765	sub stop_read {	1048	sub stop_read {
766	my ($self) = @_;	1049	my ($self) = @_;
767		1050
768	delete $self->{rw};	1051	delete $self->{_rw};
769	}	1052	}
770		1053
771	sub start_read {	1054	sub start_read {
772	my ($self) = @_;	1055	my ($self) = @_;
773		1056
774	unless ($self->{rw} \|\| $self->{eof}) {	1057	unless ($self->{_rw} \|\| $self->{_eof}) {
775	Scalar::Util::weaken $self;	1058	Scalar::Util::weaken $self;
776		1059
777	$self->{rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1060	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
778	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1061	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};
779	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;
780		1063
781	if ($len > 0) {	1064	if ($len > 0) {
		1065	$self->{_activity} = AnyEvent->now;
		1066
782	$self->{filter_r}	1067	$self->{filter_r}
783	? $self->{filter_r}->($self, $rbuf)	1068	? $self->{filter_r}($self, $rbuf)
784	: $self->_drain_rbuf;	1069	: $self->{_in_drain} \|\| $self->_drain_rbuf;
785		1070
786	} elsif (defined $len) {	1071	} elsif (defined $len) {
787	delete $self->{rw};	1072	delete $self->{_rw};
788	$self->{eof} = 1;	1073	$self->{_eof} = 1;
789	$self->_drain_rbuf;	1074	$self->_drain_rbuf unless $self->{_in_drain};
790		1075
791	} elsif ($! != EAGAIN && $! != EINTR) {	1076	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
792	return $self->error;	1077	return $self->_error ($!, 1);
793	}	1078	}
794	});	1079	});
795	}	1080	}
796	}	1081	}
797		1082
798	sub _dotls {	1083	sub _dotls {
799	my ($self) = @_;	1084	my ($self) = @_;
800		1085
		1086	my $buf;
		1087
801	if (length $self->{tls_wbuf}) {	1088	if (length $self->{_tls_wbuf}) {
802	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) {
803	substr $self->{tls_wbuf}, 0, $len, "";	1090	substr $self->{_tls_wbuf}, 0, $len, "";
804	}	1091	}
805	}	1092	}
806		1093
807	if (defined (my $buf = Net::SSLeay::BIO_read ($self->{tls_wbio}))) {	1094	if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {
808	$self->{wbuf} .= $buf;	1095	$self->{wbuf} .= $buf;
809	$self->_drain_wbuf;	1096	$self->_drain_wbuf;
810	}	1097	}
811		1098
812	while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) {	1099	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {
		1100	if (length $buf) {
813	$self->{rbuf} .= $buf;	1101	$self->{rbuf} .= $buf;
814	$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	}
815	}	1109	}
816		1110
817	my $err = Net::SSLeay::get_error ($self->{tls}, -1);	1111	my $err = Net::SSLeay::get_error ($self->{tls}, -1);
818		1112
819	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {	1113	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
820	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {	1114	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {
821	$self->error;	1115	return $self->_error ($!, 1);
822	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {	1116	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {
823	$! = &Errno::EIO;	1117	return $self->_error (&Errno::EIO, 1);
824	$self->error;
825	}	1118	}
826		1119
827	# all others are fine for our purposes	1120	# all others are fine for our purposes
828	}	1121	}
829	}	1122	}
…		…
838	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1131	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
839		1132
840	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
841	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.
842		1135
843	=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.
844		1139
845	# TODO: maybe document...	1140	=cut
		1141
846	sub starttls {	1142	sub starttls {
847	my ($self, $ssl, $ctx) = @_;	1143	my ($self, $ssl, $ctx) = @_;
848		1144
849	$self->stoptls;	1145	$self->stoptls;
850		1146
…		…
862	# but the openssl maintainers basically said: "trust us, it just works".	1158	# but the openssl maintainers basically said: "trust us, it just works".
863	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1159	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
864	# and mismaintained ssleay-module doesn't even offer them).	1160	# and mismaintained ssleay-module doesn't even offer them).
865	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html	1161	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
866	Net::SSLeay::CTX_set_mode ($self->{tls},	1162	Net::SSLeay::CTX_set_mode ($self->{tls},
867	(eval { Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1163	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
868	\| (eval { Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));	1164	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
869		1165
870	$self->{tls_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1166	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
871	$self->{tls_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1167	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
872		1168
873	Net::SSLeay::set_bio ($ssl, $self->{tls_rbio}, $self->{tls_wbio});	1169	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
874		1170
875	$self->{filter_w} = sub {	1171	$self->{filter_w} = sub {
876	$_[0]{tls_wbuf} .= ${$_[1]};	1172	$_[0]{_tls_wbuf} .= ${$_[1]};
877	&_dotls;	1173	&_dotls;
878	};	1174	};
879	$self->{filter_r} = sub {	1175	$self->{filter_r} = sub {
880	Net::SSLeay::BIO_write ($_[0]{tls_rbio}, ${$_[1]});	1176	Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});
881	&_dotls;	1177	&_dotls;
882	};	1178	};
883	}	1179	}
884		1180
885	=item $handle->stoptls	1181	=item $handle->stoptls
…		…
891		1187
892	sub stoptls {	1188	sub stoptls {
893	my ($self) = @_;	1189	my ($self) = @_;
894		1190
895	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};	1191	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};
		1192
896	delete $self->{tls_rbio};	1193	delete $self->{_rbio};
897	delete $self->{tls_wbio};	1194	delete $self->{_wbio};
898	delete $self->{tls_wbuf};	1195	delete $self->{_tls_wbuf};
899	delete $self->{filter_r};	1196	delete $self->{filter_r};
900	delete $self->{filter_w};	1197	delete $self->{filter_w};
901	}	1198	}
902		1199
903	sub DESTROY {	1200	sub DESTROY {
…		…
941	}	1238	}
942	}	1239	}
943		1240
944	=back	1241	=back
945		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
946	=head1 AUTHOR	1272	=head1 AUTHOR
947		1273
948	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>.
949		1275
950	=cut	1276	=cut

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.30 by root, Sat May 24 23:56:26 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.30 by root, Sat May 24 23:56:26 2008 UTC vs.
Revision 1.59 by root, Thu Jun 5 16:53:11 2008 UTC