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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.29 by root, Sat May 24 23:10:18 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
173	our (%RH, %WH);
174
175	sub register_read_type($$) {
176	$RH{$_[0]} = $_[1];
177	}
178
179	sub register_write_type($$) {
180	$WH{$_[0]} = $_[1];
181	}
182		214
183	sub new {	215	sub new {
184	my $class = shift;	216	my $class = shift;
185		217
186	my $self = bless { @_ }, $class;	218	my $self = bless { @_ }, $class;
…		…
192	if ($self->{tls}) {	224	if ($self->{tls}) {
193	require Net::SSLeay;	225	require Net::SSLeay;
194	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});	226	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});
195	}	227	}
196		228
197	$self->on_eof (delete $self->{on_eof} ) if $self->{on_eof};	229	# $self->on_eof (delete $self->{on_eof} ) if $self->{on_eof}; # nop
198	$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
199	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	232	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
200	$self->on_read (delete $self->{on_read} ) if $self->{on_read};	233
		234	$self->{_activity} = AnyEvent->now;
		235	$self->_timeout;
201		236
202	$self->start_read;	237	$self->start_read;
203		238
204	$self	239	$self
205	}	240	}
206		241
207	sub _shutdown {	242	sub _shutdown {
208	my ($self) = @_;	243	my ($self) = @_;
209		244
		245	delete $self->{_tw};
210	delete $self->{rw};	246	delete $self->{_rw};
211	delete $self->{ww};	247	delete $self->{_ww};
212	delete $self->{fh};	248	delete $self->{fh};
213	}
214		249
		250	$self->stoptls;
		251	}
		252
215	sub error {	253	sub _error {
216	my ($self) = @_;	254	my ($self, $errno, $fatal) = @_;
217		255
218	{
219	local $!;
220	$self->_shutdown;	256	$self->_shutdown
221	}	257	if $fatal;
		258
		259	$! = $errno;
222		260
223	if ($self->{on_error}) {	261	if ($self->{on_error}) {
224	$self->{on_error}($self);	262	$self->{on_error}($self, $fatal);
225	} else {	263	} else {
226	Carp::croak "AnyEvent::Handle uncaught fatal error: $!";	264	Carp::croak "AnyEvent::Handle uncaught error: $!";
227	}	265	}
228	}	266	}
229		267
230	=item $fh = $handle->fh	268	=item $fh = $handle->fh
231		269
232	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.
233		271
234	=cut	272	=cut
235		273
236	sub fh { $_[0]->{fh} }	274	sub fh { $_[0]{fh} }
237		275
238	=item $handle->on_error ($cb)	276	=item $handle->on_error ($cb)
239		277
240	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).
241		279
…		…
251		289
252	=cut	290	=cut
253		291
254	sub on_eof {	292	sub on_eof {
255	$_[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	}
256	}	361	}
257		362
258	#############################################################################	363	#############################################################################
259		364
260	=back	365	=back
…		…
297	=cut	402	=cut
298		403
299	sub _drain_wbuf {	404	sub _drain_wbuf {
300	my ($self) = @_;	405	my ($self) = @_;
301		406
302	if (!$self->{ww} && length $self->{wbuf}) {	407	if (!$self->{_ww} && length $self->{wbuf}) {
		408
303	Scalar::Util::weaken $self;	409	Scalar::Util::weaken $self;
		410
304	my $cb = sub {	411	my $cb = sub {
305	my $len = syswrite $self->{fh}, $self->{wbuf};	412	my $len = syswrite $self->{fh}, $self->{wbuf};
306		413
307	if ($len >= 0) {	414	if ($len >= 0) {
308	substr $self->{wbuf}, 0, $len, "";	415	substr $self->{wbuf}, 0, $len, "";
		416
		417	$self->{_activity} = AnyEvent->now;
309		418
310	$self->{on_drain}($self)	419	$self->{on_drain}($self)
311	if $self->{low_water_mark} >= length $self->{wbuf}	420	if $self->{low_water_mark} >= length $self->{wbuf}
312	&& $self->{on_drain};	421	&& $self->{on_drain};
313		422
314	delete $self->{ww} unless length $self->{wbuf};	423	delete $self->{_ww} unless length $self->{wbuf};
315	} elsif ($! != EAGAIN && $! != EINTR) {	424	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
316	$self->error;	425	$self->_error ($!, 1);
317	}	426	}
318	};	427	};
319		428
		429	# try to write data immediately
		430	$cb->();
		431
		432	# if still data left in wbuf, we need to poll
320	$self->{ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb);	433	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)
321		434	if length $self->{wbuf};
322	$cb->($self);
323	};	435	};
		436	}
		437
		438	our %WH;
		439
		440	sub register_write_type($$) {
		441	$WH{$_[0]} = $_[1];
324	}	442	}
325		443
326	sub push_write {	444	sub push_write {
327	my $self = shift;	445	my $self = shift;
328		446
…		…
332	@_ = ($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")
333	->($self, @_);	451	->($self, @_);
334	}	452	}
335		453
336	if ($self->{filter_w}) {	454	if ($self->{filter_w}) {
337	$self->{filter_w}->($self, \$_[0]);	455	$self->{filter_w}($self, \$_[0]);
338	} else {	456	} else {
339	$self->{wbuf} .= $_[0];	457	$self->{wbuf} .= $_[0];
340	$self->_drain_wbuf;	458	$self->_drain_wbuf;
341	}	459	}
342	}	460	}
343		461
344	=item $handle->push_write (type => @args)	462	=item $handle->push_write (type => @args)
345		463
346	=item $handle->unshift_write (type => @args)
347
348	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
349	the job by specifying a type and type-specific arguments.	465	the job by specifying a type and type-specific arguments.
350		466
351	Predefined types are:	467	Predefined types are (if you have ideas for additional types, feel free to
		468	drop by and tell us):
352		469
353	=over 4	470	=over 4
354		471
355	=item netstring => $string	472	=item netstring => $string
356		473
…		…
363	my ($self, $string) = @_;	480	my ($self, $string) = @_;
364		481
365	sprintf "%d:%s,", (length $string), $string	482	sprintf "%d:%s,", (length $string), $string
366	};	483	};
367		484
		485	=item json => $array_or_hashref
		486
		487	Encodes the given hash or array reference into a JSON object. Unless you
		488	provide your own JSON object, this means it will be encoded to JSON text
		489	in UTF-8.
		490
		491	JSON objects (and arrays) are self-delimiting, so you can write JSON at
		492	one end of a handle and read them at the other end without using any
		493	additional framing.
		494
		495	The generated JSON text is guaranteed not to contain any newlines: While
		496	this module doesn't need delimiters after or between JSON texts to be
		497	able to read them, many other languages depend on that.
		498
		499	A simple RPC protocol that interoperates easily with others is to send
		500	JSON arrays (or objects, although arrays are usually the better choice as
		501	they mimic how function argument passing works) and a newline after each
		502	JSON text:
		503
		504	$handle->push_write (json => ["method", "arg1", "arg2"]); # whatever
		505	$handle->push_write ("\012");
		506
		507	An AnyEvent::Handle receiver would simply use the C<json> read type and
		508	rely on the fact that the newline will be skipped as leading whitespace:
		509
		510	$handle->push_read (json => sub { my $array = $_[1]; ... });
		511
		512	Other languages could read single lines terminated by a newline and pass
		513	this line into their JSON decoder of choice.
		514
		515	=cut
		516
		517	register_write_type json => sub {
		518	my ($self, $ref) = @_;
		519
		520	require JSON;
		521
		522	$self->{json} ? $self->{json}->encode ($ref)
		523	: JSON::encode_json ($ref)
		524	};
		525
368	=back	526	=back
369		527
370	=cut	528	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
371		529
		530	This function (not method) lets you add your own types to C<push_write>.
		531	Whenever the given C<type> is used, C<push_write> will invoke the code
		532	reference with the handle object and the remaining arguments.
372		533
		534	The code reference is supposed to return a single octet string that will
		535	be appended to the write buffer.
		536
		537	Note that this is a function, and all types registered this way will be
		538	global, so try to use unique names.
		539
		540	=cut
373		541
374	#############################################################################	542	#############################################################################
375		543
376	=back	544	=back
377		545
…		…
401	the specified number of bytes which give an XML datagram.	569	the specified number of bytes which give an XML datagram.
402		570
403	# in the default state, expect some header bytes	571	# in the default state, expect some header bytes
404	$handle->on_read (sub {	572	$handle->on_read (sub {
405	# 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)
406	shift->unshift_read_chunk (4, sub {	574	shift->unshift_read (chunk => 4, sub {
407	# header arrived, decode	575	# header arrived, decode
408	my $len = unpack "N", $_[1];	576	my $len = unpack "N", $_[1];
409		577
410	# now read the payload	578	# now read the payload
411	shift->unshift_read_chunk ($len, sub {	579	shift->unshift_read (chunk => $len, sub {
412	my $xml = $_[1];	580	my $xml = $_[1];
413	# handle xml	581	# handle xml
414	});	582	});
415	});	583	});
416	});	584	});
…		…
423		591
424	# request one	592	# request one
425	$handle->push_write ("request 1\015\012");	593	$handle->push_write ("request 1\015\012");
426		594
427	# 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
428	$handle->push_read_line (sub {	596	$handle->push_read (line => sub {
429	# if we got an "OK", we have to _prepend_ another line,	597	# if we got an "OK", we have to _prepend_ another line,
430	# 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
431	# which are already in the queue when this callback is called	599	# which are already in the queue when this callback is called
432	# we don't do this in case we got an error	600	# we don't do this in case we got an error
433	if ($_[1] eq "OK") {	601	if ($_[1] eq "OK") {
434	$_[0]->unshift_read_line (sub {	602	$_[0]->unshift_read (line => sub {
435	my $response = $_[1];	603	my $response = $_[1];
436	...	604	...
437	});	605	});
438	}	606	}
439	});	607	});
440		608
441	# request two	609	# request two
442	$handle->push_write ("request 2\015\012");	610	$handle->push_write ("request 2\015\012");
443		611
444	# simply read 64 bytes, always	612	# simply read 64 bytes, always
445	$handle->push_read_chunk (64, sub {	613	$handle->push_read (chunk => 64, sub {
446	my $response = $_[1];	614	my $response = $_[1];
447	...	615	...
448	});	616	});
449		617
450	=over 4	618	=over 4
…		…
456		624
457	if (	625	if (
458	defined $self->{rbuf_max}	626	defined $self->{rbuf_max}
459	&& $self->{rbuf_max} < length $self->{rbuf}	627	&& $self->{rbuf_max} < length $self->{rbuf}
460	) {	628	) {
461	$! = &Errno::ENOSPC; return $self->error;	629	return $self->_error (&Errno::ENOSPC, 1);
462	}	630	}
463		631
464	return if $self->{in_drain};	632	return if $self->{in_drain};
465	local $self->{in_drain} = 1;	633	local $self->{in_drain} = 1;
466		634
467	while (my $len = length $self->{rbuf}) {	635	while (my $len = length $self->{rbuf}) {
468	no strict 'refs';	636	no strict 'refs';
469	if (my $cb = shift @{ $self->{queue} }) {	637	if (my $cb = shift @{ $self->{_queue} }) {
470	unless ($cb->($self)) {	638	unless ($cb->($self)) {
471	if ($self->{eof}) {	639	if ($self->{_eof}) {
472	# 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)
473	$! = &Errno::EPIPE; return $self->error;	641	return $self->_error (&Errno::EPIPE, 1);
474	}	642	}
475		643
476	unshift @{ $self->{queue} }, $cb;	644	unshift @{ $self->{_queue} }, $cb;
477	return;	645	last;
478	}	646	}
479	} elsif ($self->{on_read}) {	647	} elsif ($self->{on_read}) {
480	$self->{on_read}($self);	648	$self->{on_read}($self);
481		649
482	if (	650	if (
483	$self->{eof} # if no further data will arrive
484	&& $len == length $self->{rbuf} # and no data has been consumed	651	$len == length $self->{rbuf} # if no data has been consumed
485	&& !@{ $self->{queue} } # and the queue is still empty	652	&& !@{ $self->{_queue} } # and the queue is still empty
486	&& $self->{on_read} # and we still want to read data	653	&& $self->{on_read} # but we still have on_read
487	) {	654	) {
		655	# no further data will arrive
488	# then no progress can be made	656	# so no progress can be made
489	$! = &Errno::EPIPE; return $self->error;	657	return $self->_error (&Errno::EPIPE, 1)
		658	if $self->{_eof};
		659
		660	last; # more data might arrive
490	}	661	}
491	} else {	662	} else {
492	# read side becomes idle	663	# read side becomes idle
493	delete $self->{rw};	664	delete $self->{_rw};
494	return;	665	last;
495	}	666	}
496	}	667	}
497		668
498	if ($self->{eof}) {
499	$self->_shutdown;
500	$self->{on_eof}($self)	669	$self->{on_eof}($self)
501	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} };
502	}	676	}
503	}	677	}
504		678
505	=item $handle->on_read ($cb)	679	=item $handle->on_read ($cb)
506		680
…		…
552	interested in (which can be none at all) and return a true value. After returning	726	interested in (which can be none at all) and return a true value. After returning
553	true, it will be removed from the queue.	727	true, it will be removed from the queue.
554		728
555	=cut	729	=cut
556		730
		731	our %RH;
		732
		733	sub register_read_type($$) {
		734	$RH{$_[0]} = $_[1];
		735	}
		736
557	sub push_read {	737	sub push_read {
558	my $self = shift;	738	my $self = shift;
559	my $cb = pop;	739	my $cb = pop;
560		740
561	if (@_) {	741	if (@_) {
…		…
563		743
564	$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")
565	->($self, $cb, @_);	745	->($self, $cb, @_);
566	}	746	}
567		747
568	push @{ $self->{queue} }, $cb;	748	push @{ $self->{_queue} }, $cb;
569	$self->_drain_rbuf;	749	$self->_drain_rbuf;
570	}	750	}
571		751
572	sub unshift_read {	752	sub unshift_read {
573	my $self = shift;	753	my $self = shift;
…		…
579	$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")
580	->($self, $cb, @_);	760	->($self, $cb, @_);
581	}	761	}
582		762
583		763
584	unshift @{ $self->{queue} }, $cb;	764	unshift @{ $self->{_queue} }, $cb;
585	$self->_drain_rbuf;	765	$self->_drain_rbuf;
586	}	766	}
587		767
588	=item $handle->push_read (type => @args, $cb)	768	=item $handle->push_read (type => @args, $cb)
589		769
…		…
591		771
592	Instead of providing a callback that parses the data itself you can chose	772	Instead of providing a callback that parses the data itself you can chose
593	between a number of predefined parsing formats, for chunks of data, lines	773	between a number of predefined parsing formats, for chunks of data, lines
594	etc.	774	etc.
595		775
596	The types currently supported are:	776	Predefined types are (if you have ideas for additional types, feel free to
		777	drop by and tell us):
597		778
598	=over 4	779	=over 4
599		780
600	=item chunk => $octets, $cb->($self, $data)	781	=item chunk => $octets, $cb->($handle, $data)
601		782
602	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
603	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
604	data.	785	data.
605		786
…		…
628		809
629	sub unshift_read_chunk {	810	sub unshift_read_chunk {
630	$_[0]->unshift_read (chunk => $_[1], $_[2]);	811	$_[0]->unshift_read (chunk => $_[1], $_[2]);
631	}	812	}
632		813
633	=item line => [$eol, ]$cb->($self, $line, $eol)	814	=item line => [$eol, ]$cb->($handle, $line, $eol)
634		815
635	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
636	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
637	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
638	the end of line marker as the third argument (C<$eol>).	819	the end of line marker as the third argument (C<$eol>).
…		…
675	sub unshift_read_line {	856	sub unshift_read_line {
676	my $self = shift;	857	my $self = shift;
677	$self->unshift_read (line => @_);	858	$self->unshift_read (line => @_);
678	}	859	}
679		860
680	=item netstring => $cb->($string)	861	=item netstring => $cb->($handle, $string)
681		862
682	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).
683		864
684	Throws an error with C<$!> set to EBADMSG on format violations.	865	Throws an error with C<$!> set to EBADMSG on format violations.
685		866
…		…
689	my ($self, $cb) = @_;	870	my ($self, $cb) = @_;
690		871
691	sub {	872	sub {
692	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {	873	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
693	if ($_[0]{rbuf} =~ /[^0-9]/) {	874	if ($_[0]{rbuf} =~ /[^0-9]/) {
694	$! = &Errno::EBADMSG;	875	$self->_error (&Errno::EBADMSG);
695	$self->error;
696	}	876	}
697	return;	877	return;
698	}	878	}
699		879
700	my $len = $1;	880	my $len = $1;
…		…
703	my $string = $_[1];	883	my $string = $_[1];
704	$_[0]->unshift_read (chunk => 1, sub {	884	$_[0]->unshift_read (chunk => 1, sub {
705	if ($_[1] eq ",") {	885	if ($_[1] eq ",") {
706	$cb->($_[0], $string);	886	$cb->($_[0], $string);
707	} else {	887	} else {
708	$! = &Errno::EBADMSG;	888	$self->_error (&Errno::EBADMSG);
709	$self->error;
710	}	889	}
711	});	890	});
712	});	891	});
713		892
714	1	893	1
715	}	894	}
716	};	895	};
717		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
718	=back	1011	=back
		1012
		1013	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)
		1014
		1015	This function (not method) lets you add your own types to C<push_read>.
		1016
		1017	Whenever the given C<type> is used, C<push_read> will invoke the code
		1018	reference with the handle object, the callback and the remaining
		1019	arguments.
		1020
		1021	The code reference is supposed to return a callback (usually a closure)
		1022	that works as a plain read callback (see C<< ->push_read ($cb) >>).
		1023
		1024	It should invoke the passed callback when it is done reading (remember to
		1025	pass C<$handle> as first argument as all other callbacks do that).
		1026
		1027	Note that this is a function, and all types registered this way will be
		1028	global, so try to use unique names.
		1029
		1030	For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>,
		1031	search for C<register_read_type>)).
719		1032
720	=item $handle->stop_read	1033	=item $handle->stop_read
721		1034
722	=item $handle->start_read	1035	=item $handle->start_read
723		1036
724	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
725	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
726	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
727	C<start_read>.	1040	C<start_read>.
728		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
729	=cut	1047	=cut
730		1048
731	sub stop_read {	1049	sub stop_read {
732	my ($self) = @_;	1050	my ($self) = @_;
733		1051
734	delete $self->{rw};	1052	delete $self->{_rw};
735	}	1053	}
736		1054
737	sub start_read {	1055	sub start_read {
738	my ($self) = @_;	1056	my ($self) = @_;
739		1057
740	unless ($self->{rw} \|\| $self->{eof}) {	1058	unless ($self->{_rw} \|\| $self->{_eof}) {
741	Scalar::Util::weaken $self;	1059	Scalar::Util::weaken $self;
742		1060
743	$self->{rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1061	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
744	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1062	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};
745	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;
746		1064
747	if ($len > 0) {	1065	if ($len > 0) {
		1066	$self->{_activity} = AnyEvent->now;
		1067
748	$self->{filter_r}	1068	$self->{filter_r}
749	? $self->{filter_r}->($self, $rbuf)	1069	? $self->{filter_r}($self, $rbuf)
750	: $self->_drain_rbuf;	1070	: $self->_drain_rbuf;
751		1071
752	} elsif (defined $len) {	1072	} elsif (defined $len) {
753	delete $self->{rw};	1073	delete $self->{_rw};
754	$self->{eof} = 1;	1074	$self->{_eof} = 1;
755	$self->_drain_rbuf;	1075	$self->_drain_rbuf;
756		1076
757	} elsif ($! != EAGAIN && $! != EINTR) {	1077	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
758	return $self->error;	1078	return $self->_error ($!, 1);
759	}	1079	}
760	});	1080	});
761	}	1081	}
762	}	1082	}
763		1083
764	sub _dotls {	1084	sub _dotls {
765	my ($self) = @_;	1085	my ($self) = @_;
766		1086
		1087	my $buf;
		1088
767	if (length $self->{tls_wbuf}) {	1089	if (length $self->{_tls_wbuf}) {
768	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) {
769	substr $self->{tls_wbuf}, 0, $len, "";	1091	substr $self->{_tls_wbuf}, 0, $len, "";
770	}	1092	}
771	}	1093	}
772		1094
773	if (defined (my $buf = Net::SSLeay::BIO_read ($self->{tls_wbio}))) {	1095	if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {
774	$self->{wbuf} .= $buf;	1096	$self->{wbuf} .= $buf;
775	$self->_drain_wbuf;	1097	$self->_drain_wbuf;
776	}	1098	}
777		1099
778	while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) {	1100	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {
		1101	if (length $buf) {
779	$self->{rbuf} .= $buf;	1102	$self->{rbuf} .= $buf;
780	$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	}
781	}	1110	}
782		1111
783	my $err = Net::SSLeay::get_error ($self->{tls}, -1);	1112	my $err = Net::SSLeay::get_error ($self->{tls}, -1);
784		1113
785	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {	1114	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
786	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {	1115	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {
787	$self->error;	1116	return $self->_error ($!, 1);
788	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {	1117	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {
789	$! = &Errno::EIO;	1118	return $self->_error (&Errno::EIO, 1);
790	$self->error;
791	}	1119	}
792		1120
793	# all others are fine for our purposes	1121	# all others are fine for our purposes
794	}	1122	}
795	}	1123	}
…		…
804	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1132	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
805		1133
806	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
807	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.
808		1136
809	=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.
810		1140
811	# TODO: maybe document...	1141	=cut
		1142
812	sub starttls {	1143	sub starttls {
813	my ($self, $ssl, $ctx) = @_;	1144	my ($self, $ssl, $ctx) = @_;
814		1145
815	$self->stoptls;	1146	$self->stoptls;
816		1147
…		…
828	# but the openssl maintainers basically said: "trust us, it just works".	1159	# but the openssl maintainers basically said: "trust us, it just works".
829	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1160	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
830	# and mismaintained ssleay-module doesn't even offer them).	1161	# and mismaintained ssleay-module doesn't even offer them).
831	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html	1162	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
832	Net::SSLeay::CTX_set_mode ($self->{tls},	1163	Net::SSLeay::CTX_set_mode ($self->{tls},
833	(eval { Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1164	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
834	\| (eval { Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));	1165	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
835		1166
836	$self->{tls_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1167	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
837	$self->{tls_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1168	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
838		1169
839	Net::SSLeay::set_bio ($ssl, $self->{tls_rbio}, $self->{tls_wbio});	1170	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
840		1171
841	$self->{filter_w} = sub {	1172	$self->{filter_w} = sub {
842	$_[0]{tls_wbuf} .= ${$_[1]};	1173	$_[0]{_tls_wbuf} .= ${$_[1]};
843	&_dotls;	1174	&_dotls;
844	};	1175	};
845	$self->{filter_r} = sub {	1176	$self->{filter_r} = sub {
846	Net::SSLeay::BIO_write ($_[0]{tls_rbio}, ${$_[1]});	1177	Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});
847	&_dotls;	1178	&_dotls;
848	};	1179	};
849	}	1180	}
850		1181
851	=item $handle->stoptls	1182	=item $handle->stoptls
…		…
857		1188
858	sub stoptls {	1189	sub stoptls {
859	my ($self) = @_;	1190	my ($self) = @_;
860		1191
861	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};	1192	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};
		1193
862	delete $self->{tls_rbio};	1194	delete $self->{_rbio};
863	delete $self->{tls_wbio};	1195	delete $self->{_wbio};
864	delete $self->{tls_wbuf};	1196	delete $self->{_tls_wbuf};
865	delete $self->{filter_r};	1197	delete $self->{filter_r};
866	delete $self->{filter_w};	1198	delete $self->{filter_w};
867	}	1199	}
868		1200
869	sub DESTROY {	1201	sub DESTROY {
…		…
907	}	1239	}
908	}	1240	}
909		1241
910	=back	1242	=back
911		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
912	=head1 AUTHOR	1273	=head1 AUTHOR
913		1274
914	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>.
915		1276
916	=cut	1277	=cut

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.29 by root, Sat May 24 23:10:18 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.29 by root, Sat May 24 23:10:18 2008 UTC vs.
Revision 1.56 by root, Wed Jun 4 09:55:16 2008 UTC