[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.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	This module is experimental.
18
19	=cut	17	=cut
20		18
21	our $VERSION = '0.04';	19	our $VERSION = 4.12;
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->on_eof (delete $self->{on_eof} ) if $self->{on_eof}; # nop
188	$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
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
		234	$self->{_activity} = AnyEvent->now;
		235	$self->_timeout;
191		236
192	$self->start_read;	237	$self->start_read;
193		238
194	$self	239	$self
195	}	240	}
196		241
197	sub _shutdown {	242	sub _shutdown {
198	my ($self) = @_;	243	my ($self) = @_;
199		244
		245	delete $self->{_tw};
200	delete $self->{rw};	246	delete $self->{_rw};
201	delete $self->{ww};	247	delete $self->{_ww};
202	delete $self->{fh};	248	delete $self->{fh};
203	}
204		249
		250	$self->stoptls;
		251	}
		252
205	sub error {	253	sub _error {
206	my ($self) = @_;	254	my ($self, $errno, $fatal) = @_;
207		255
208	{
209	local $!;
210	$self->_shutdown;	256	$self->_shutdown
211	}	257	if $fatal;
		258
		259	$! = $errno;
212		260
213	if ($self->{on_error}) {	261	if ($self->{on_error}) {
214	$self->{on_error}($self);	262	$self->{on_error}($self, $fatal);
215	} else {	263	} else {
216	Carp::croak "AnyEvent::Handle uncaught fatal error: $!";	264	Carp::croak "AnyEvent::Handle uncaught error: $!";
217	}	265	}
218	}	266	}
219		267
220	=item $fh = $handle->fh	268	=item $fh = $handle->fh
221		269
222	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.
223		271
224	=cut	272	=cut
225		273
226	sub fh { $_[0]->{fh} }	274	sub fh { $_[0]{fh} }
227		275
228	=item $handle->on_error ($cb)	276	=item $handle->on_error ($cb)
229		277
230	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).
231		279
…		…
241		289
242	=cut	290	=cut
243		291
244	sub on_eof {	292	sub on_eof {
245	$_[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	}
246	}	361	}
247		362
248	#############################################################################	363	#############################################################################
249		364
250	=back	365	=back
…		…
287	=cut	402	=cut
288		403
289	sub _drain_wbuf {	404	sub _drain_wbuf {
290	my ($self) = @_;	405	my ($self) = @_;
291		406
292	if (!$self->{ww} && length $self->{wbuf}) {	407	if (!$self->{_ww} && length $self->{wbuf}) {
		408
293	Scalar::Util::weaken $self;	409	Scalar::Util::weaken $self;
		410
294	my $cb = sub {	411	my $cb = sub {
295	my $len = syswrite $self->{fh}, $self->{wbuf};	412	my $len = syswrite $self->{fh}, $self->{wbuf};
296		413
297	if ($len >= 0) {	414	if ($len >= 0) {
298	substr $self->{wbuf}, 0, $len, "";	415	substr $self->{wbuf}, 0, $len, "";
		416
		417	$self->{_activity} = AnyEvent->now;
299		418
300	$self->{on_drain}($self)	419	$self->{on_drain}($self)
301	if $self->{low_water_mark} >= length $self->{wbuf}	420	if $self->{low_water_mark} >= length $self->{wbuf}
302	&& $self->{on_drain};	421	&& $self->{on_drain};
303		422
304	delete $self->{ww} unless length $self->{wbuf};	423	delete $self->{_ww} unless length $self->{wbuf};
305	} elsif ($! != EAGAIN && $! != EINTR) {	424	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
306	$self->error;	425	$self->_error ($!, 1);
307	}	426	}
308	};	427	};
309		428
		429	# try to write data immediately
		430	$cb->();
		431
		432	# if still data left in wbuf, we need to poll
310	$self->{ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb);	433	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)
311		434	if length $self->{wbuf};
312	$cb->($self);
313	};	435	};
314	}	436	}
315		437
316	our %WH;	438	our %WH;
317		439
…		…
328	@_ = ($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")
329	->($self, @_);	451	->($self, @_);
330	}	452	}
331		453
332	if ($self->{filter_w}) {	454	if ($self->{filter_w}) {
333	$self->{filter_w}->($self, \$_[0]);	455	$self->{filter_w}($self, \$_[0]);
334	} else {	456	} else {
335	$self->{wbuf} .= $_[0];	457	$self->{wbuf} .= $_[0];
336	$self->_drain_wbuf;	458	$self->_drain_wbuf;
337	}	459	}
338	}	460	}
339		461
340	=item $handle->push_write (type => @args)	462	=item $handle->push_write (type => @args)
341		463
342	=item $handle->unshift_write (type => @args)
343
344	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
345	the job by specifying a type and type-specific arguments.	465	the job by specifying a type and type-specific arguments.
346		466
347	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
348	drop by and tell us):	468	drop by and tell us):
…		…
352	=item netstring => $string	472	=item netstring => $string
353		473
354	Formats the given value as netstring	474	Formats the given value as netstring
355	(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).
356		476
357	=back
358
359	=cut	477	=cut
360		478
361	register_write_type netstring => sub {	479	register_write_type netstring => sub {
362	my ($self, $string) = @_;	480	my ($self, $string) = @_;
363		481
364	sprintf "%d:%s,", (length $string), $string	482	sprintf "%d:%s,", (length $string), $string
365	};	483	};
366		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
367	=item AnyEvent::Handle::register_write_type type => $coderef->($self, @args)	528	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
368		529
369	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>.
370	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
371	reference with the handle object and the remaining arguments.	532	reference with the handle object and the remaining arguments.
372		533
…		…
408	the specified number of bytes which give an XML datagram.	569	the specified number of bytes which give an XML datagram.
409		570
410	# in the default state, expect some header bytes	571	# in the default state, expect some header bytes
411	$handle->on_read (sub {	572	$handle->on_read (sub {
412	# 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)
413	shift->unshift_read_chunk (4, sub {	574	shift->unshift_read (chunk => 4, sub {
414	# header arrived, decode	575	# header arrived, decode
415	my $len = unpack "N", $_[1];	576	my $len = unpack "N", $_[1];
416		577
417	# now read the payload	578	# now read the payload
418	shift->unshift_read_chunk ($len, sub {	579	shift->unshift_read (chunk => $len, sub {
419	my $xml = $_[1];	580	my $xml = $_[1];
420	# handle xml	581	# handle xml
421	});	582	});
422	});	583	});
423	});	584	});
…		…
430		591
431	# request one	592	# request one
432	$handle->push_write ("request 1\015\012");	593	$handle->push_write ("request 1\015\012");
433		594
434	# 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
435	$handle->push_read_line (sub {	596	$handle->push_read (line => sub {
436	# if we got an "OK", we have to _prepend_ another line,	597	# 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	598	# 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	599	# which are already in the queue when this callback is called
439	# we don't do this in case we got an error	600	# we don't do this in case we got an error
440	if ($_[1] eq "OK") {	601	if ($_[1] eq "OK") {
441	$_[0]->unshift_read_line (sub {	602	$_[0]->unshift_read (line => sub {
442	my $response = $_[1];	603	my $response = $_[1];
443	...	604	...
444	});	605	});
445	}	606	}
446	});	607	});
447		608
448	# request two	609	# request two
449	$handle->push_write ("request 2\015\012");	610	$handle->push_write ("request 2\015\012");
450		611
451	# simply read 64 bytes, always	612	# simply read 64 bytes, always
452	$handle->push_read_chunk (64, sub {	613	$handle->push_read (chunk => 64, sub {
453	my $response = $_[1];	614	my $response = $_[1];
454	...	615	...
455	});	616	});
456		617
457	=over 4	618	=over 4
…		…
463		624
464	if (	625	if (
465	defined $self->{rbuf_max}	626	defined $self->{rbuf_max}
466	&& $self->{rbuf_max} < length $self->{rbuf}	627	&& $self->{rbuf_max} < length $self->{rbuf}
467	) {	628	) {
468	$! = &Errno::ENOSPC; return $self->error;	629	return $self->_error (&Errno::ENOSPC, 1);
469	}	630	}
470		631
471	return if $self->{in_drain};	632	return if $self->{in_drain};
472	local $self->{in_drain} = 1;	633	local $self->{in_drain} = 1;
473		634
474	while (my $len = length $self->{rbuf}) {	635	while (my $len = length $self->{rbuf}) {
475	no strict 'refs';	636	no strict 'refs';
476	if (my $cb = shift @{ $self->{queue} }) {	637	if (my $cb = shift @{ $self->{_queue} }) {
477	unless ($cb->($self)) {	638	unless ($cb->($self)) {
478	if ($self->{eof}) {	639	if ($self->{_eof}) {
479	# 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)
480	$! = &Errno::EPIPE; return $self->error;	641	return $self->_error (&Errno::EPIPE, 1);
481	}	642	}
482		643
483	unshift @{ $self->{queue} }, $cb;	644	unshift @{ $self->{_queue} }, $cb;
484	return;	645	last;
485	}	646	}
486	} elsif ($self->{on_read}) {	647	} elsif ($self->{on_read}) {
487	$self->{on_read}($self);	648	$self->{on_read}($self);
488		649
489	if (	650	if (
490	$self->{eof} # if no further data will arrive
491	&& $len == length $self->{rbuf} # and no data has been consumed	651	$len == length $self->{rbuf} # if no data has been consumed
492	&& !@{ $self->{queue} } # and the queue is still empty	652	&& !@{ $self->{_queue} } # and the queue is still empty
493	&& $self->{on_read} # and we still want to read data	653	&& $self->{on_read} # but we still have on_read
494	) {	654	) {
		655	# no further data will arrive
495	# then no progress can be made	656	# so no progress can be made
496	$! = &Errno::EPIPE; return $self->error;	657	return $self->_error (&Errno::EPIPE, 1)
		658	if $self->{_eof};
		659
		660	last; # more data might arrive
497	}	661	}
498	} else {	662	} else {
499	# read side becomes idle	663	# read side becomes idle
500	delete $self->{rw};	664	delete $self->{_rw};
501	return;	665	last;
502	}	666	}
503	}	667	}
504		668
505	if ($self->{eof}) {
506	$self->_shutdown;
507	$self->{on_eof}($self)	669	$self->{on_eof}($self)
508	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} };
509	}	676	}
510	}	677	}
511		678
512	=item $handle->on_read ($cb)	679	=item $handle->on_read ($cb)
513		680
…		…
576		743
577	$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")
578	->($self, $cb, @_);	745	->($self, $cb, @_);
579	}	746	}
580		747
581	push @{ $self->{queue} }, $cb;	748	push @{ $self->{_queue} }, $cb;
582	$self->_drain_rbuf;	749	$self->_drain_rbuf;
583	}	750	}
584		751
585	sub unshift_read {	752	sub unshift_read {
586	my $self = shift;	753	my $self = shift;
…		…
592	$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")
593	->($self, $cb, @_);	760	->($self, $cb, @_);
594	}	761	}
595		762
596		763
597	unshift @{ $self->{queue} }, $cb;	764	unshift @{ $self->{_queue} }, $cb;
598	$self->_drain_rbuf;	765	$self->_drain_rbuf;
599	}	766	}
600		767
601	=item $handle->push_read (type => @args, $cb)	768	=item $handle->push_read (type => @args, $cb)
602		769
…		…
609	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
610	drop by and tell us):	777	drop by and tell us):
611		778
612	=over 4	779	=over 4
613		780
614	=item chunk => $octets, $cb->($self, $data)	781	=item chunk => $octets, $cb->($handle, $data)
615		782
616	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
617	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
618	data.	785	data.
619		786
…		…
642		809
643	sub unshift_read_chunk {	810	sub unshift_read_chunk {
644	$_[0]->unshift_read (chunk => $_[1], $_[2]);	811	$_[0]->unshift_read (chunk => $_[1], $_[2]);
645	}	812	}
646		813
647	=item line => [$eol, ]$cb->($self, $line, $eol)	814	=item line => [$eol, ]$cb->($handle, $line, $eol)
648		815
649	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
650	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
651	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
652	the end of line marker as the third argument (C<$eol>).	819	the end of line marker as the third argument (C<$eol>).
…		…
689	sub unshift_read_line {	856	sub unshift_read_line {
690	my $self = shift;	857	my $self = shift;
691	$self->unshift_read (line => @_);	858	$self->unshift_read (line => @_);
692	}	859	}
693		860
694	=item netstring => $cb->($string)	861	=item netstring => $cb->($handle, $string)
695		862
696	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).
697		864
698	Throws an error with C<$!> set to EBADMSG on format violations.	865	Throws an error with C<$!> set to EBADMSG on format violations.
699		866
…		…
703	my ($self, $cb) = @_;	870	my ($self, $cb) = @_;
704		871
705	sub {	872	sub {
706	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {	873	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
707	if ($_[0]{rbuf} =~ /[^0-9]/) {	874	if ($_[0]{rbuf} =~ /[^0-9]/) {
708	$! = &Errno::EBADMSG;	875	$self->_error (&Errno::EBADMSG);
709	$self->error;
710	}	876	}
711	return;	877	return;
712	}	878	}
713		879
714	my $len = $1;	880	my $len = $1;
…		…
717	my $string = $_[1];	883	my $string = $_[1];
718	$_[0]->unshift_read (chunk => 1, sub {	884	$_[0]->unshift_read (chunk => 1, sub {
719	if ($_[1] eq ",") {	885	if ($_[1] eq ",") {
720	$cb->($_[0], $string);	886	$cb->($_[0], $string);
721	} else {	887	} else {
722	$! = &Errno::EBADMSG;	888	$self->_error (&Errno::EBADMSG);
723	$self->error;
724	}	889	}
725	});	890	});
726	});	891	});
727		892
728	1	893	1
729	}	894	}
730	};	895	};
731		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
732	=back	1011	=back
733		1012
734	=item AnyEvent::Handle::register_read_type type => $coderef->($self, $cb, @args)	1013	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)
735		1014
736	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>.
737		1016
738	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
739	reference with the handle object, the callback and the remaining	1018	reference with the handle object, the callback and the remaining
…		…
741		1020
742	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)
743	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) >>).
744		1023
745	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
746	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).
747		1026
748	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
749	global, so try to use unique names.	1028	global, so try to use unique names.
750		1029
751	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>,
…		…
758	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
759	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
760	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
761	C<start_read>.	1040	C<start_read>.
762		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
763	=cut	1047	=cut
764		1048
765	sub stop_read {	1049	sub stop_read {
766	my ($self) = @_;	1050	my ($self) = @_;
767		1051
768	delete $self->{rw};	1052	delete $self->{_rw};
769	}	1053	}
770		1054
771	sub start_read {	1055	sub start_read {
772	my ($self) = @_;	1056	my ($self) = @_;
773		1057
774	unless ($self->{rw} \|\| $self->{eof}) {	1058	unless ($self->{_rw} \|\| $self->{_eof}) {
775	Scalar::Util::weaken $self;	1059	Scalar::Util::weaken $self;
776		1060
777	$self->{rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1061	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
778	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1062	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};
779	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;
780		1064
781	if ($len > 0) {	1065	if ($len > 0) {
		1066	$self->{_activity} = AnyEvent->now;
		1067
782	$self->{filter_r}	1068	$self->{filter_r}
783	? $self->{filter_r}->($self, $rbuf)	1069	? $self->{filter_r}($self, $rbuf)
784	: $self->_drain_rbuf;	1070	: $self->_drain_rbuf;
785		1071
786	} elsif (defined $len) {	1072	} elsif (defined $len) {
787	delete $self->{rw};	1073	delete $self->{_rw};
788	$self->{eof} = 1;	1074	$self->{_eof} = 1;
789	$self->_drain_rbuf;	1075	$self->_drain_rbuf;
790		1076
791	} elsif ($! != EAGAIN && $! != EINTR) {	1077	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
792	return $self->error;	1078	return $self->_error ($!, 1);
793	}	1079	}
794	});	1080	});
795	}	1081	}
796	}	1082	}
797		1083
798	sub _dotls {	1084	sub _dotls {
799	my ($self) = @_;	1085	my ($self) = @_;
800		1086
		1087	my $buf;
		1088
801	if (length $self->{tls_wbuf}) {	1089	if (length $self->{_tls_wbuf}) {
802	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) {
803	substr $self->{tls_wbuf}, 0, $len, "";	1091	substr $self->{_tls_wbuf}, 0, $len, "";
804	}	1092	}
805	}	1093	}
806		1094
807	if (defined (my $buf = Net::SSLeay::BIO_read ($self->{tls_wbio}))) {	1095	if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {
808	$self->{wbuf} .= $buf;	1096	$self->{wbuf} .= $buf;
809	$self->_drain_wbuf;	1097	$self->_drain_wbuf;
810	}	1098	}
811		1099
812	while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) {	1100	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {
		1101	if (length $buf) {
813	$self->{rbuf} .= $buf;	1102	$self->{rbuf} .= $buf;
814	$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	}
815	}	1110	}
816		1111
817	my $err = Net::SSLeay::get_error ($self->{tls}, -1);	1112	my $err = Net::SSLeay::get_error ($self->{tls}, -1);
818		1113
819	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {	1114	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
820	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {	1115	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {
821	$self->error;	1116	return $self->_error ($!, 1);
822	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {	1117	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {
823	$! = &Errno::EIO;	1118	return $self->_error (&Errno::EIO, 1);
824	$self->error;
825	}	1119	}
826		1120
827	# all others are fine for our purposes	1121	# all others are fine for our purposes
828	}	1122	}
829	}	1123	}
…		…
838	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1132	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
839		1133
840	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
841	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.
842		1136
843	=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.
844		1140
845	# TODO: maybe document...	1141	=cut
		1142
846	sub starttls {	1143	sub starttls {
847	my ($self, $ssl, $ctx) = @_;	1144	my ($self, $ssl, $ctx) = @_;
848		1145
849	$self->stoptls;	1146	$self->stoptls;
850		1147
…		…
862	# but the openssl maintainers basically said: "trust us, it just works".	1159	# but the openssl maintainers basically said: "trust us, it just works".
863	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1160	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
864	# and mismaintained ssleay-module doesn't even offer them).	1161	# and mismaintained ssleay-module doesn't even offer them).
865	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html	1162	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
866	Net::SSLeay::CTX_set_mode ($self->{tls},	1163	Net::SSLeay::CTX_set_mode ($self->{tls},
867	(eval { Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1164	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
868	\| (eval { Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));	1165	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
869		1166
870	$self->{tls_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1167	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
871	$self->{tls_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1168	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
872		1169
873	Net::SSLeay::set_bio ($ssl, $self->{tls_rbio}, $self->{tls_wbio});	1170	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
874		1171
875	$self->{filter_w} = sub {	1172	$self->{filter_w} = sub {
876	$_[0]{tls_wbuf} .= ${$_[1]};	1173	$_[0]{_tls_wbuf} .= ${$_[1]};
877	&_dotls;	1174	&_dotls;
878	};	1175	};
879	$self->{filter_r} = sub {	1176	$self->{filter_r} = sub {
880	Net::SSLeay::BIO_write ($_[0]{tls_rbio}, ${$_[1]});	1177	Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});
881	&_dotls;	1178	&_dotls;
882	};	1179	};
883	}	1180	}
884		1181
885	=item $handle->stoptls	1182	=item $handle->stoptls
…		…
891		1188
892	sub stoptls {	1189	sub stoptls {
893	my ($self) = @_;	1190	my ($self) = @_;
894		1191
895	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};	1192	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};
		1193
896	delete $self->{tls_rbio};	1194	delete $self->{_rbio};
897	delete $self->{tls_wbio};	1195	delete $self->{_wbio};
898	delete $self->{tls_wbuf};	1196	delete $self->{_tls_wbuf};
899	delete $self->{filter_r};	1197	delete $self->{filter_r};
900	delete $self->{filter_w};	1198	delete $self->{filter_w};
901	}	1199	}
902		1200
903	sub DESTROY {	1201	sub DESTROY {
…		…
941	}	1239	}
942	}	1240	}
943		1241
944	=back	1242	=back
945		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
946	=head1 AUTHOR	1273	=head1 AUTHOR
947		1274
948	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>.
949		1276
950	=cut	1277	=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.56 by root, Wed Jun 4 09:55:16 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.56 by root, Wed Jun 4 09:55:16 2008 UTC