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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.37 by root, Mon May 26 20:02:22 2008 UTC vs.
Revision 1.57 by root, Wed Jun 4 11:45:21 2008 UTC

…		…
2		2
3	no warnings;	3	no warnings;
4	use strict;	4	use strict;
5		5
6	use AnyEvent ();	6	use AnyEvent ();
7	use AnyEvent::Util qw(WSAWOULDBLOCK);	7	use AnyEvent::Util qw(WSAEWOULDBLOCK);
8	use Scalar::Util ();	8	use Scalar::Util ();
9	use Carp ();	9	use Carp ();
10	use Fcntl ();	10	use Fcntl ();
11	use Errno qw/EAGAIN EINTR/;	11	use Errno qw(EAGAIN EINTR);
12		12
13	=head1 NAME	13	=head1 NAME
14		14
15	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent	15	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent
16		16
17	=cut	17	=cut
18		18
19	our $VERSION = '0.04';	19	our $VERSION = 4.13;
20		20
21	=head1 SYNOPSIS	21	=head1 SYNOPSIS
22		22
23	use AnyEvent;	23	use AnyEvent;
24	use AnyEvent::Handle;	24	use AnyEvent::Handle;
…		…
73	The filehandle this L<AnyEvent::Handle> object will operate on.	73	The filehandle this L<AnyEvent::Handle> object will operate on.
74		74
75	NOTE: The filehandle will be set to non-blocking (using	75	NOTE: The filehandle will be set to non-blocking (using
76	AnyEvent::Util::fh_nonblocking).	76	AnyEvent::Util::fh_nonblocking).
77		77
78	=item on_eof => $cb->($self)	78	=item on_eof => $cb->($handle)
79		79
80	Set the callback to be called on EOF.	80	Set the callback to be called when an end-of-file condition is detcted,
		81	i.e. in the case of a socket, when the other side has closed the
		82	connection cleanly.
81		83
82	While not mandatory, it is highly recommended to set an eof callback,	84	While not mandatory, it is highly recommended to set an eof callback,
83	otherwise you might end up with a closed socket while you are still	85	otherwise you might end up with a closed socket while you are still
84	waiting for data.	86	waiting for data.
85		87
86	=item on_error => $cb->($self)	88	=item on_error => $cb->($handle, $fatal)
87		89
88	This is the fatal error callback, that is called when, well, a fatal error	90	This is the error callback, which is called when, well, some error
89	occurs, such as not being able to resolve the hostname, failure to connect	91	occured, such as not being able to resolve the hostname, failure to
90	or a read error.	92	connect or a read error.
91		93
92	The object will not be in a usable state when this callback has been	94	Some errors are fatal (which is indicated by C<$fatal> being true). On
93	called.	95	fatal errors the handle object will be shut down and will not be
		96	usable. Non-fatal errors can be retried by simply returning, but it is
		97	recommended to simply ignore this parameter and instead abondon the handle
		98	object when this callback is invoked.
94		99
95	On callback entrance, the value of C<$!> contains the operating system	100	On callback entrance, the value of C<$!> contains the operating system
96	error (or C<ENOSPC>, C<EPIPE> or C<EBADMSG>).	101	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).
97
98	The callbakc should throw an exception. If it returns, then
99	AnyEvent::Handle will C<croak> for you.
100		102
101	While not mandatory, it is I<highly> recommended to set this callback, as	103	While not mandatory, it is I<highly> recommended to set this callback, as
102	you will not be notified of errors otherwise. The default simply calls	104	you will not be notified of errors otherwise. The default simply calls
103	die.	105	C<croak>.
104		106
105	=item on_read => $cb->($self)	107	=item on_read => $cb->($handle)
106		108
107	This sets the default read callback, which is called when data arrives	109	This sets the default read callback, which is called when data arrives
108	and no read request is in the queue.	110	and no read request is in the queue.
109		111
110	To access (and remove data from) the read buffer, use the C<< ->rbuf >>	112	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
111	method or access the C<$self->{rbuf}> member directly.	113	method or access the C<$handle->{rbuf}> member directly.
112		114
113	When an EOF condition is detected then AnyEvent::Handle will first try to	115	When an EOF condition is detected then AnyEvent::Handle will first try to
114	feed all the remaining data to the queued callbacks and C<on_read> before	116	feed all the remaining data to the queued callbacks and C<on_read> before
115	calling the C<on_eof> callback. If no progress can be made, then a fatal	117	calling the C<on_eof> callback. If no progress can be made, then a fatal
116	error will be raised (with C<$!> set to C<EPIPE>).	118	error will be raised (with C<$!> set to C<EPIPE>).
117		119
118	=item on_drain => $cb->()	120	=item on_drain => $cb->($handle)
119		121
120	This sets the callback that is called when the write buffer becomes empty	122	This sets the callback that is called when the write buffer becomes empty
121	(or when the callback is set and the buffer is empty already).	123	(or when the callback is set and the buffer is empty already).
122		124
123	To append to the write buffer, use the C<< ->push_write >> method.	125	To append to the write buffer, use the C<< ->push_write >> method.
		126
		127	=item timeout => $fractional_seconds
		128
		129	If non-zero, then this enables an "inactivity" timeout: whenever this many
		130	seconds pass without a successful read or write on the underlying file
		131	handle, the C<on_timeout> callback will be invoked (and if that one is
		132	missing, an C<ETIMEDOUT> error will be raised).
		133
		134	Note that timeout processing is also active when you currently do not have
		135	any outstanding read or write requests: If you plan to keep the connection
		136	idle then you should disable the timout temporarily or ignore the timeout
		137	in the C<on_timeout> callback.
		138
		139	Zero (the default) disables this timeout.
		140
		141	=item on_timeout => $cb->($handle)
		142
		143	Called whenever the inactivity timeout passes. If you return from this
		144	callback, then the timeout will be reset as if some activity had happened,
		145	so this condition is not fatal in any way.
124		146
125	=item rbuf_max => <bytes>	147	=item rbuf_max => <bytes>
126		148
127	If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)	149	If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)
128	when the read buffer ever (strictly) exceeds this size. This is useful to	150	when the read buffer ever (strictly) exceeds this size. This is useful to
…		…
135	isn't finished).	157	isn't finished).
136		158
137	=item read_size => <bytes>	159	=item read_size => <bytes>
138		160
139	The default read block size (the amount of bytes this module will try to read	161	The default read block size (the amount of bytes this module will try to read
140	on each [loop iteration). Default: C<4096>.	162	during each (loop iteration). Default: C<8192>.
141		163
142	=item low_water_mark => <bytes>	164	=item low_water_mark => <bytes>
143		165
144	Sets the amount of bytes (default: C<0>) that make up an "empty" write	166	Sets the amount of bytes (default: C<0>) that make up an "empty" write
145	buffer: If the write reaches this size or gets even samller it is	167	buffer: If the write reaches this size or gets even samller it is
…		…
168		190
169	Use the given Net::SSLeay::CTX object to create the new TLS connection	191	Use the given Net::SSLeay::CTX object to create the new TLS connection
170	(unless a connection object was specified directly). If this parameter is	192	(unless a connection object was specified directly). If this parameter is
171	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	193	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
172		194
		195	=item json => JSON or JSON::XS object
		196
		197	This is the json coder object used by the C<json> read and write types.
		198
		199	If you don't supply it, then AnyEvent::Handle will create and use a
		200	suitable one, which will write and expect UTF-8 encoded JSON texts.
		201
		202	Note that you are responsible to depend on the JSON module if you want to
		203	use this functionality, as AnyEvent does not have a dependency itself.
		204
		205	=item filter_r => $cb
		206
		207	=item filter_w => $cb
		208
		209	These exist, but are undocumented at this time.
		210
173	=back	211	=back
174		212
175	=cut	213	=cut
176		214
177	sub new {	215	sub new {
…		…
186	if ($self->{tls}) {	224	if ($self->{tls}) {
187	require Net::SSLeay;	225	require Net::SSLeay;
188	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});	226	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});
189	}	227	}
190		228
191	$self->on_eof (delete $self->{on_eof} ) if $self->{on_eof};	229	# $self->on_eof (delete $self->{on_eof} ) if $self->{on_eof}; # nop
192	$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
193	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	232	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
194	$self->on_read (delete $self->{on_read} ) if $self->{on_read};	233
		234	$self->{_activity} = AnyEvent->now;
		235	$self->_timeout;
195		236
196	$self->start_read;	237	$self->start_read;
197		238
198	$self	239	$self
199	}	240	}
200		241
201	sub _shutdown {	242	sub _shutdown {
202	my ($self) = @_;	243	my ($self) = @_;
203		244
		245	delete $self->{_tw};
204	delete $self->{rw};	246	delete $self->{_rw};
205	delete $self->{ww};	247	delete $self->{_ww};
206	delete $self->{fh};	248	delete $self->{fh};
207	}
208		249
		250	$self->stoptls;
		251	}
		252
209	sub error {	253	sub _error {
210	my ($self) = @_;	254	my ($self, $errno, $fatal) = @_;
211		255
212	{
213	local $!;
214	$self->_shutdown;	256	$self->_shutdown
215	}	257	if $fatal;
216		258
217	$self->{on_error}($self)	259	$! = $errno;
		260
218	if $self->{on_error};	261	if ($self->{on_error}) {
219		262	$self->{on_error}($self, $fatal);
		263	} else {
220	Carp::croak "AnyEvent::Handle uncaught fatal error: $!";	264	Carp::croak "AnyEvent::Handle uncaught error: $!";
		265	}
221	}	266	}
222		267
223	=item $fh = $handle->fh	268	=item $fh = $handle->fh
224		269
225	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.
226		271
227	=cut	272	=cut
228		273
229	sub fh { $_[0]->{fh} }	274	sub fh { $_[0]{fh} }
230		275
231	=item $handle->on_error ($cb)	276	=item $handle->on_error ($cb)
232		277
233	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).
234		279
…		…
244		289
245	=cut	290	=cut
246		291
247	sub on_eof {	292	sub on_eof {
248	$_[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	}
249	}	361	}
250		362
251	#############################################################################	363	#############################################################################
252		364
253	=back	365	=back
…		…
290	=cut	402	=cut
291		403
292	sub _drain_wbuf {	404	sub _drain_wbuf {
293	my ($self) = @_;	405	my ($self) = @_;
294		406
295	if (!$self->{ww} && length $self->{wbuf}) {	407	if (!$self->{_ww} && length $self->{wbuf}) {
296		408
297	Scalar::Util::weaken $self;	409	Scalar::Util::weaken $self;
298		410
299	my $cb = sub {	411	my $cb = sub {
300	my $len = syswrite $self->{fh}, $self->{wbuf};	412	my $len = syswrite $self->{fh}, $self->{wbuf};
301		413
302	if ($len >= 0) {	414	if ($len >= 0) {
303	substr $self->{wbuf}, 0, $len, "";	415	substr $self->{wbuf}, 0, $len, "";
		416
		417	$self->{_activity} = AnyEvent->now;
304		418
305	$self->{on_drain}($self)	419	$self->{on_drain}($self)
306	if $self->{low_water_mark} >= length $self->{wbuf}	420	if $self->{low_water_mark} >= length $self->{wbuf}
307	&& $self->{on_drain};	421	&& $self->{on_drain};
308		422
309	delete $self->{ww} unless length $self->{wbuf};	423	delete $self->{_ww} unless length $self->{wbuf};
310	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAWOULDBLOCK) {	424	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
311	$self->error;	425	$self->_error ($!, 1);
312	}	426	}
313	};	427	};
314		428
315	# try to write data immediately	429	# try to write data immediately
316	$cb->();	430	$cb->();
317		431
318	# if still data left in wbuf, we need to poll	432	# if still data left in wbuf, we need to poll
319	$self->{ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	433	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)
320	if length $self->{wbuf};	434	if length $self->{wbuf};
321	};	435	};
322	}	436	}
323		437
324	our %WH;	438	our %WH;
…		…
336	@_ = ($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")
337	->($self, @_);	451	->($self, @_);
338	}	452	}
339		453
340	if ($self->{filter_w}) {	454	if ($self->{filter_w}) {
341	$self->{filter_w}->($self, \$_[0]);	455	$self->{filter_w}($self, \$_[0]);
342	} else {	456	} else {
343	$self->{wbuf} .= $_[0];	457	$self->{wbuf} .= $_[0];
344	$self->_drain_wbuf;	458	$self->_drain_wbuf;
345	}	459	}
346	}	460	}
347		461
348	=item $handle->push_write (type => @args)	462	=item $handle->push_write (type => @args)
349		463
350	=item $handle->unshift_write (type => @args)
351
352	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
353	the job by specifying a type and type-specific arguments.	465	the job by specifying a type and type-specific arguments.
354		466
355	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
356	drop by and tell us):	468	drop by and tell us):
…		…
360	=item netstring => $string	472	=item netstring => $string
361		473
362	Formats the given value as netstring	474	Formats the given value as netstring
363	(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).
364		476
365	=back
366
367	=cut	477	=cut
368		478
369	register_write_type netstring => sub {	479	register_write_type netstring => sub {
370	my ($self, $string) = @_;	480	my ($self, $string) = @_;
371		481
372	sprintf "%d:%s,", (length $string), $string	482	sprintf "%d:%s,", (length $string), $string
373	};	483	};
374		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
375	=item AnyEvent::Handle::register_write_type type => $coderef->($self, @args)	528	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
376		529
377	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>.
378	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
379	reference with the handle object and the remaining arguments.	532	reference with the handle object and the remaining arguments.
380		533
…		…
416	the specified number of bytes which give an XML datagram.	569	the specified number of bytes which give an XML datagram.
417		570
418	# in the default state, expect some header bytes	571	# in the default state, expect some header bytes
419	$handle->on_read (sub {	572	$handle->on_read (sub {
420	# 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)
421	shift->unshift_read_chunk (4, sub {	574	shift->unshift_read (chunk => 4, sub {
422	# header arrived, decode	575	# header arrived, decode
423	my $len = unpack "N", $_[1];	576	my $len = unpack "N", $_[1];
424		577
425	# now read the payload	578	# now read the payload
426	shift->unshift_read_chunk ($len, sub {	579	shift->unshift_read (chunk => $len, sub {
427	my $xml = $_[1];	580	my $xml = $_[1];
428	# handle xml	581	# handle xml
429	});	582	});
430	});	583	});
431	});	584	});
…		…
438		591
439	# request one	592	# request one
440	$handle->push_write ("request 1\015\012");	593	$handle->push_write ("request 1\015\012");
441		594
442	# 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
443	$handle->push_read_line (sub {	596	$handle->push_read (line => sub {
444	# if we got an "OK", we have to _prepend_ another line,	597	# if we got an "OK", we have to _prepend_ another line,
445	# so it will be read before the second request reads its 64 bytes	598	# so it will be read before the second request reads its 64 bytes
446	# which are already in the queue when this callback is called	599	# which are already in the queue when this callback is called
447	# we don't do this in case we got an error	600	# we don't do this in case we got an error
448	if ($_[1] eq "OK") {	601	if ($_[1] eq "OK") {
449	$_[0]->unshift_read_line (sub {	602	$_[0]->unshift_read (line => sub {
450	my $response = $_[1];	603	my $response = $_[1];
451	...	604	...
452	});	605	});
453	}	606	}
454	});	607	});
455		608
456	# request two	609	# request two
457	$handle->push_write ("request 2\015\012");	610	$handle->push_write ("request 2\015\012");
458		611
459	# simply read 64 bytes, always	612	# simply read 64 bytes, always
460	$handle->push_read_chunk (64, sub {	613	$handle->push_read (chunk => 64, sub {
461	my $response = $_[1];	614	my $response = $_[1];
462	...	615	...
463	});	616	});
464		617
465	=over 4	618	=over 4
…		…
471		624
472	if (	625	if (
473	defined $self->{rbuf_max}	626	defined $self->{rbuf_max}
474	&& $self->{rbuf_max} < length $self->{rbuf}	627	&& $self->{rbuf_max} < length $self->{rbuf}
475	) {	628	) {
476	$! = &Errno::ENOSPC;	629	return $self->_error (&Errno::ENOSPC, 1);
477	$self->error;
478	}	630	}
479		631
480	return if $self->{in_drain};	632	return if $self->{in_drain};
481	local $self->{in_drain} = 1;	633	local $self->{in_drain} = 1;
482		634
483	while (my $len = length $self->{rbuf}) {	635	while (my $len = length $self->{rbuf}) {
484	no strict 'refs';	636	no strict 'refs';
485	if (my $cb = shift @{ $self->{queue} }) {	637	if (my $cb = shift @{ $self->{_queue} }) {
486	unless ($cb->($self)) {	638	unless ($cb->($self)) {
487	if ($self->{eof}) {	639	if ($self->{_eof}) {
488	# 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)
489	$! = &Errno::EPIPE;	641	return $self->_error (&Errno::EPIPE, 1);
490	$self->error;
491	}	642	}
492		643
493	unshift @{ $self->{queue} }, $cb;	644	unshift @{ $self->{_queue} }, $cb;
494	return;	645	last;
495	}	646	}
496	} elsif ($self->{on_read}) {	647	} elsif ($self->{on_read}) {
497	$self->{on_read}($self);	648	$self->{on_read}($self);
498		649
499	if (	650	if (
500	$self->{eof} # if no further data will arrive
501	&& $len == length $self->{rbuf} # and no data has been consumed	651	$len == length $self->{rbuf} # if no data has been consumed
502	&& !@{ $self->{queue} } # and the queue is still empty	652	&& !@{ $self->{_queue} } # and the queue is still empty
503	&& $self->{on_read} # and we still want to read data	653	&& $self->{on_read} # but we still have on_read
504	) {	654	) {
		655	# no further data will arrive
505	# then no progress can be made	656	# so no progress can be made
506	$! = &Errno::EPIPE;	657	return $self->_error (&Errno::EPIPE, 1)
507	$self->error;	658	if $self->{_eof};
		659
		660	last; # more data might arrive
508	}	661	}
509	} else {	662	} else {
510	# read side becomes idle	663	# read side becomes idle
511	delete $self->{rw};	664	delete $self->{_rw};
512	return;	665	last;
513	}	666	}
514	}	667	}
515		668
516	if ($self->{eof}) {
517	$self->_shutdown;
518	$self->{on_eof}($self)	669	$self->{on_eof}($self)
519	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} };
520	}	676	}
521	}	677	}
522		678
523	=item $handle->on_read ($cb)	679	=item $handle->on_read ($cb)
524		680
…		…
587		743
588	$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")
589	->($self, $cb, @_);	745	->($self, $cb, @_);
590	}	746	}
591		747
592	push @{ $self->{queue} }, $cb;	748	push @{ $self->{_queue} }, $cb;
593	$self->_drain_rbuf;	749	$self->_drain_rbuf;
594	}	750	}
595		751
596	sub unshift_read {	752	sub unshift_read {
597	my $self = shift;	753	my $self = shift;
…		…
603	$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")
604	->($self, $cb, @_);	760	->($self, $cb, @_);
605	}	761	}
606		762
607		763
608	unshift @{ $self->{queue} }, $cb;	764	unshift @{ $self->{_queue} }, $cb;
609	$self->_drain_rbuf;	765	$self->_drain_rbuf;
610	}	766	}
611		767
612	=item $handle->push_read (type => @args, $cb)	768	=item $handle->push_read (type => @args, $cb)
613		769
…		…
620	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
621	drop by and tell us):	777	drop by and tell us):
622		778
623	=over 4	779	=over 4
624		780
625	=item chunk => $octets, $cb->($self, $data)	781	=item chunk => $octets, $cb->($handle, $data)
626		782
627	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
628	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
629	data.	785	data.
630		786
…		…
653		809
654	sub unshift_read_chunk {	810	sub unshift_read_chunk {
655	$_[0]->unshift_read (chunk => $_[1], $_[2]);	811	$_[0]->unshift_read (chunk => $_[1], $_[2]);
656	}	812	}
657		813
658	=item line => [$eol, ]$cb->($self, $line, $eol)	814	=item line => [$eol, ]$cb->($handle, $line, $eol)
659		815
660	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
661	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
662	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
663	the end of line marker as the third argument (C<$eol>).	819	the end of line marker as the third argument (C<$eol>).
…		…
700	sub unshift_read_line {	856	sub unshift_read_line {
701	my $self = shift;	857	my $self = shift;
702	$self->unshift_read (line => @_);	858	$self->unshift_read (line => @_);
703	}	859	}
704		860
705	=item netstring => $cb->($string)	861	=item netstring => $cb->($handle, $string)
706		862
707	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).
708		864
709	Throws an error with C<$!> set to EBADMSG on format violations.	865	Throws an error with C<$!> set to EBADMSG on format violations.
710		866
…		…
714	my ($self, $cb) = @_;	870	my ($self, $cb) = @_;
715		871
716	sub {	872	sub {
717	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {	873	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
718	if ($_[0]{rbuf} =~ /[^0-9]/) {	874	if ($_[0]{rbuf} =~ /[^0-9]/) {
719	$! = &Errno::EBADMSG;	875	$self->_error (&Errno::EBADMSG);
720	$self->error;
721	}	876	}
722	return;	877	return;
723	}	878	}
724		879
725	my $len = $1;	880	my $len = $1;
…		…
728	my $string = $_[1];	883	my $string = $_[1];
729	$_[0]->unshift_read (chunk => 1, sub {	884	$_[0]->unshift_read (chunk => 1, sub {
730	if ($_[1] eq ",") {	885	if ($_[1] eq ",") {
731	$cb->($_[0], $string);	886	$cb->($_[0], $string);
732	} else {	887	} else {
733	$! = &Errno::EBADMSG;	888	$self->_error (&Errno::EBADMSG);
734	$self->error;
735	}	889	}
736	});	890	});
737	});	891	});
738		892
739	1	893	1
740	}	894	}
741	};	895	};
742		896
743	=item regex => $accept[, $reject[, $skip], $cb->($data)	897	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
744		898
745	Makes a regex match against the regex object C<$accept> and returns	899	Makes a regex match against the regex object C<$accept> and returns
746	everything up to and including the match.	900	everything up to and including the match.
747		901
748	Example: read a single line terminated by '\n'.	902	Example: read a single line terminated by '\n'.
…		…
796	return 1;	950	return 1;
797	}	951	}
798		952
799	# reject	953	# reject
800	if ($reject && $$rbuf =~ $reject) {	954	if ($reject && $$rbuf =~ $reject) {
801	$! = &Errno::EBADMSG;	955	$self->_error (&Errno::EBADMSG);
802	$self->error;
803	}	956	}
804		957
805	# skip	958	# skip
806	if ($skip && $$rbuf =~ $skip) {	959	if ($skip && $$rbuf =~ $skip) {
807	$data .= substr $$rbuf, 0, $+[0], "";	960	$data .= substr $$rbuf, 0, $+[0], "";
…		…
809		962
810	()	963	()
811	}	964	}
812	};	965	};
813		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
814	=back	1011	=back
815		1012
816	=item AnyEvent::Handle::register_read_type type => $coderef->($self, $cb, @args)	1013	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)
817		1014
818	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>.
819		1016
820	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
821	reference with the handle object, the callback and the remaining	1018	reference with the handle object, the callback and the remaining
…		…
823		1020
824	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)
825	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) >>).
826		1023
827	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
828	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).
829		1026
830	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
831	global, so try to use unique names.	1028	global, so try to use unique names.
832		1029
833	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>,
…		…
840	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
841	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
842	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
843	C<start_read>.	1040	C<start_read>.
844		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
845	=cut	1047	=cut
846		1048
847	sub stop_read {	1049	sub stop_read {
848	my ($self) = @_;	1050	my ($self) = @_;
849		1051
850	delete $self->{rw};	1052	delete $self->{_rw};
851	}	1053	}
852		1054
853	sub start_read {	1055	sub start_read {
854	my ($self) = @_;	1056	my ($self) = @_;
855		1057
856	unless ($self->{rw} \|\| $self->{eof}) {	1058	unless ($self->{_rw} \|\| $self->{_eof}) {
857	Scalar::Util::weaken $self;	1059	Scalar::Util::weaken $self;
858		1060
859	$self->{rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1061	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
860	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1062	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};
861	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;
862		1064
863	if ($len > 0) {	1065	if ($len > 0) {
		1066	$self->{_activity} = AnyEvent->now;
		1067
864	$self->{filter_r}	1068	$self->{filter_r}
865	? $self->{filter_r}->($self, $rbuf)	1069	? $self->{filter_r}($self, $rbuf)
866	: $self->_drain_rbuf;	1070	: $self->_drain_rbuf;
867		1071
868	} elsif (defined $len) {	1072	} elsif (defined $len) {
869	delete $self->{rw};	1073	delete $self->{_rw};
870	$self->{eof} = 1;	1074	$self->{_eof} = 1;
871	$self->_drain_rbuf;	1075	$self->_drain_rbuf;
872		1076
873	} elsif ($! != EAGAIN && $! != EINTR && $! != &AnyEvent::Util::WSAWOULDBLOCK) {	1077	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
874	return $self->error;	1078	return $self->_error ($!, 1);
875	}	1079	}
876	});	1080	});
877	}	1081	}
878	}	1082	}
879		1083
880	sub _dotls {	1084	sub _dotls {
881	my ($self) = @_;	1085	my ($self) = @_;
882		1086
		1087	my $buf;
		1088
883	if (length $self->{tls_wbuf}) {	1089	if (length $self->{_tls_wbuf}) {
884	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) {
885	substr $self->{tls_wbuf}, 0, $len, "";	1091	substr $self->{_tls_wbuf}, 0, $len, "";
886	}	1092	}
887	}	1093	}
888		1094
889	if (defined (my $buf = Net::SSLeay::BIO_read ($self->{tls_wbio}))) {	1095	if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {
890	$self->{wbuf} .= $buf;	1096	$self->{wbuf} .= $buf;
891	$self->_drain_wbuf;	1097	$self->_drain_wbuf;
892	}	1098	}
893		1099
894	while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) {	1100	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {
		1101	if (length $buf) {
895	$self->{rbuf} .= $buf;	1102	$self->{rbuf} .= $buf;
896	$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	}
897	}	1110	}
898		1111
899	my $err = Net::SSLeay::get_error ($self->{tls}, -1);	1112	my $err = Net::SSLeay::get_error ($self->{tls}, -1);
900		1113
901	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {	1114	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
902	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {	1115	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {
903	$self->error;	1116	return $self->_error ($!, 1);
904	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {	1117	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {
905	$! = &Errno::EIO;	1118	return $self->_error (&Errno::EIO, 1);
906	$self->error;
907	}	1119	}
908		1120
909	# all others are fine for our purposes	1121	# all others are fine for our purposes
910	}	1122	}
911	}	1123	}
…		…
920	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1132	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
921		1133
922	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
923	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.
924		1136
925	=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.
926		1140
927	# TODO: maybe document...	1141	=cut
		1142
928	sub starttls {	1143	sub starttls {
929	my ($self, $ssl, $ctx) = @_;	1144	my ($self, $ssl, $ctx) = @_;
930		1145
931	$self->stoptls;	1146	$self->stoptls;
932		1147
…		…
947	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html	1162	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
948	Net::SSLeay::CTX_set_mode ($self->{tls},	1163	Net::SSLeay::CTX_set_mode ($self->{tls},
949	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1164	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
950	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));	1165	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
951		1166
952	$self->{tls_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1167	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
953	$self->{tls_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1168	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
954		1169
955	Net::SSLeay::set_bio ($ssl, $self->{tls_rbio}, $self->{tls_wbio});	1170	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
956		1171
957	$self->{filter_w} = sub {	1172	$self->{filter_w} = sub {
958	$_[0]{tls_wbuf} .= ${$_[1]};	1173	$_[0]{_tls_wbuf} .= ${$_[1]};
959	&_dotls;	1174	&_dotls;
960	};	1175	};
961	$self->{filter_r} = sub {	1176	$self->{filter_r} = sub {
962	Net::SSLeay::BIO_write ($_[0]{tls_rbio}, ${$_[1]});	1177	Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});
963	&_dotls;	1178	&_dotls;
964	};	1179	};
965	}	1180	}
966		1181
967	=item $handle->stoptls	1182	=item $handle->stoptls
…		…
973		1188
974	sub stoptls {	1189	sub stoptls {
975	my ($self) = @_;	1190	my ($self) = @_;
976		1191
977	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};	1192	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};
		1193
978	delete $self->{tls_rbio};	1194	delete $self->{_rbio};
979	delete $self->{tls_wbio};	1195	delete $self->{_wbio};
980	delete $self->{tls_wbuf};	1196	delete $self->{_tls_wbuf};
981	delete $self->{filter_r};	1197	delete $self->{filter_r};
982	delete $self->{filter_w};	1198	delete $self->{filter_w};
983	}	1199	}
984		1200
985	sub DESTROY {	1201	sub DESTROY {
…		…
1023	}	1239	}
1024	}	1240	}
1025		1241
1026	=back	1242	=back
1027		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
1028	=head1 AUTHOR	1273	=head1 AUTHOR
1029		1274
1030	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>.
1031		1276
1032	=cut	1277	=cut

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.37 by root, Mon May 26 20:02:22 2008 UTC vs. Revision 1.57 by root, Wed Jun 4 11:45:21 2008 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.37 by root, Mon May 26 20:02:22 2008 UTC vs.
Revision 1.57 by root, Wed Jun 4 11:45:21 2008 UTC