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

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

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.31 by root, Sun May 25 00:08:49 2008 UTC vs. Revision 1.58 by root, Wed Jun 4 22:51:15 2008 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.31 by root, Sun May 25 00:08:49 2008 UTC vs.
Revision 1.58 by root, Wed Jun 4 22:51:15 2008 UTC