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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.42 by root, Tue May 27 06:23:15 2008 UTC vs.
Revision 1.69 by root, Sun Jun 15 21:44:56 2008 UTC

…		…
6	use AnyEvent ();	6	use AnyEvent ();
7	use AnyEvent::Util qw(WSAEWOULDBLOCK);	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.151;
20		20
21	=head1 SYNOPSIS	21	=head1 SYNOPSIS
22		22
23	use AnyEvent;	23	use AnyEvent;
24	use AnyEvent::Handle;	24	use AnyEvent::Handle;
…		…
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->($handle)	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->($handle)	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 callback 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->($handle)	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 (unlike read queue callbacks, this
		111	callback will only be called when at least one octet of data is in the
		112	read buffer).
109		113
110	To access (and remove data from) the read buffer, use the C<< ->rbuf >>	114	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
111	method or access the C<$handle->{rbuf}> member directly.	115	method or access the C<$handle->{rbuf}> member directly.
112		116
113	When an EOF condition is detected then AnyEvent::Handle will first try to	117	When an EOF condition is detected then AnyEvent::Handle will first try to
…		…
119		123
120	This sets the callback that is called when the write buffer becomes empty	124	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).	125	(or when the callback is set and the buffer is empty already).
122		126
123	To append to the write buffer, use the C<< ->push_write >> method.	127	To append to the write buffer, use the C<< ->push_write >> method.
		128
		129	This callback is useful when you don't want to put all of your write data
		130	into the queue at once, for example, when you want to write the contents
		131	of some file to the socket you might not want to read the whole file into
		132	memory and push it into the queue, but instead only read more data from
		133	the file when the write queue becomes empty.
		134
		135	=item timeout => $fractional_seconds
		136
		137	If non-zero, then this enables an "inactivity" timeout: whenever this many
		138	seconds pass without a successful read or write on the underlying file
		139	handle, the C<on_timeout> callback will be invoked (and if that one is
		140	missing, an C<ETIMEDOUT> error will be raised).
		141
		142	Note that timeout processing is also active when you currently do not have
		143	any outstanding read or write requests: If you plan to keep the connection
		144	idle then you should disable the timout temporarily or ignore the timeout
		145	in the C<on_timeout> callback.
		146
		147	Zero (the default) disables this timeout.
		148
		149	=item on_timeout => $cb->($handle)
		150
		151	Called whenever the inactivity timeout passes. If you return from this
		152	callback, then the timeout will be reset as if some activity had happened,
		153	so this condition is not fatal in any way.
124		154
125	=item rbuf_max => <bytes>	155	=item rbuf_max => <bytes>
126		156
127	If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)	157	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	158	when the read buffer ever (strictly) exceeds this size. This is useful to
…		…
135	isn't finished).	165	isn't finished).
136		166
137	=item read_size => <bytes>	167	=item read_size => <bytes>
138		168
139	The default read block size (the amount of bytes this module will try to read	169	The default read block size (the amount of bytes this module will try to read
140	on each [loop iteration). Default: C<4096>.	170	during each (loop iteration). Default: C<8192>.
141		171
142	=item low_water_mark => <bytes>	172	=item low_water_mark => <bytes>
143		173
144	Sets the amount of bytes (default: C<0>) that make up an "empty" write	174	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	175	buffer: If the write reaches this size or gets even samller it is
146	considered empty.	176	considered empty.
		177
		178	=item linger => <seconds>
		179
		180	If non-zero (default: C<3600>), then the destructor of the
		181	AnyEvent::Handle object will check wether there is still outstanding write
		182	data and will install a watcher that will write out this data. No errors
		183	will be reported (this mostly matches how the operating system treats
		184	outstanding data at socket close time).
		185
		186	This will not work for partial TLS data that could not yet been
		187	encoded. This data will be lost.
147		188
148	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	189	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
149		190
150	When this parameter is given, it enables TLS (SSL) mode, that means it	191	When this parameter is given, it enables TLS (SSL) mode, that means it
151	will start making tls handshake and will transparently encrypt/decrypt	192	will start making tls handshake and will transparently encrypt/decrypt
…		…
202	if ($self->{tls}) {	243	if ($self->{tls}) {
203	require Net::SSLeay;	244	require Net::SSLeay;
204	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});	245	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});
205	}	246	}
206		247
207	$self->on_eof (delete $self->{on_eof} ) if $self->{on_eof};	248	$self->{_activity} = AnyEvent->now;
208	$self->on_error (delete $self->{on_error}) if $self->{on_error};	249	$self->_timeout;
		250
209	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	251	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
210	$self->on_read (delete $self->{on_read} ) if $self->{on_read};
211		252
212	$self->start_read;	253	$self->start_read
		254	if $self->{on_read};
213		255
214	$self	256	$self
215	}	257	}
216		258
217	sub _shutdown {	259	sub _shutdown {
218	my ($self) = @_;	260	my ($self) = @_;
219		261
		262	delete $self->{_tw};
220	delete $self->{_rw};	263	delete $self->{_rw};
221	delete $self->{_ww};	264	delete $self->{_ww};
222	delete $self->{fh};	265	delete $self->{fh};
223	}
224		266
		267	$self->stoptls;
		268	}
		269
225	sub error {	270	sub _error {
226	my ($self) = @_;	271	my ($self, $errno, $fatal) = @_;
227		272
228	{
229	local $!;
230	$self->_shutdown;	273	$self->_shutdown
231	}	274	if $fatal;
232		275
233	$self->{on_error}($self)	276	$! = $errno;
		277
234	if $self->{on_error};	278	if ($self->{on_error}) {
235		279	$self->{on_error}($self, $fatal);
		280	} else {
236	Carp::croak "AnyEvent::Handle uncaught fatal error: $!";	281	Carp::croak "AnyEvent::Handle uncaught error: $!";
		282	}
237	}	283	}
238		284
239	=item $fh = $handle->fh	285	=item $fh = $handle->fh
240		286
241	This method returns the file handle of the L<AnyEvent::Handle> object.	287	This method returns the file handle of the L<AnyEvent::Handle> object.
…		…
260		306
261	=cut	307	=cut
262		308
263	sub on_eof {	309	sub on_eof {
264	$_[0]{on_eof} = $_[1];	310	$_[0]{on_eof} = $_[1];
		311	}
		312
		313	=item $handle->on_timeout ($cb)
		314
		315	Replace the current C<on_timeout> callback, or disables the callback
		316	(but not the timeout) if C<$cb> = C<undef>. See C<timeout> constructor
		317	argument.
		318
		319	=cut
		320
		321	sub on_timeout {
		322	$_[0]{on_timeout} = $_[1];
		323	}
		324
		325	#############################################################################
		326
		327	=item $handle->timeout ($seconds)
		328
		329	Configures (or disables) the inactivity timeout.
		330
		331	=cut
		332
		333	sub timeout {
		334	my ($self, $timeout) = @_;
		335
		336	$self->{timeout} = $timeout;
		337	$self->_timeout;
		338	}
		339
		340	# reset the timeout watcher, as neccessary
		341	# also check for time-outs
		342	sub _timeout {
		343	my ($self) = @_;
		344
		345	if ($self->{timeout}) {
		346	my $NOW = AnyEvent->now;
		347
		348	# when would the timeout trigger?
		349	my $after = $self->{_activity} + $self->{timeout} - $NOW;
		350
		351	# now or in the past already?
		352	if ($after <= 0) {
		353	$self->{_activity} = $NOW;
		354
		355	if ($self->{on_timeout}) {
		356	$self->{on_timeout}($self);
		357	} else {
		358	$self->_error (&Errno::ETIMEDOUT);
		359	}
		360
		361	# callback could have changed timeout value, optimise
		362	return unless $self->{timeout};
		363
		364	# calculate new after
		365	$after = $self->{timeout};
		366	}
		367
		368	Scalar::Util::weaken $self;
		369	return unless $self; # ->error could have destroyed $self
		370
		371	$self->{_tw} \|\|= AnyEvent->timer (after => $after, cb => sub {
		372	delete $self->{_tw};
		373	$self->_timeout;
		374	});
		375	} else {
		376	delete $self->{_tw};
		377	}
265	}	378	}
266		379
267	#############################################################################	380	#############################################################################
268		381
269	=back	382	=back
…		…
316	my $len = syswrite $self->{fh}, $self->{wbuf};	429	my $len = syswrite $self->{fh}, $self->{wbuf};
317		430
318	if ($len >= 0) {	431	if ($len >= 0) {
319	substr $self->{wbuf}, 0, $len, "";	432	substr $self->{wbuf}, 0, $len, "";
320		433
		434	$self->{_activity} = AnyEvent->now;
		435
321	$self->{on_drain}($self)	436	$self->{on_drain}($self)
322	if $self->{low_water_mark} >= length $self->{wbuf}	437	if $self->{low_water_mark} >= length $self->{wbuf}
323	&& $self->{on_drain};	438	&& $self->{on_drain};
324		439
325	delete $self->{_ww} unless length $self->{wbuf};	440	delete $self->{_ww} unless length $self->{wbuf};
326	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	441	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
327	$self->error;	442	$self->_error ($!, 1);
328	}	443	}
329	};	444	};
330		445
331	# try to write data immediately	446	# try to write data immediately
332	$cb->();	447	$cb->();
…		…
352	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	467	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")
353	->($self, @_);	468	->($self, @_);
354	}	469	}
355		470
356	if ($self->{filter_w}) {	471	if ($self->{filter_w}) {
357	$self->{filter_w}->($self, \$_[0]);	472	$self->{filter_w}($self, \$_[0]);
358	} else {	473	} else {
359	$self->{wbuf} .= $_[0];	474	$self->{wbuf} .= $_[0];
360	$self->_drain_wbuf;	475	$self->_drain_wbuf;
361	}	476	}
362	}	477	}
363		478
364	=item $handle->push_write (type => @args)	479	=item $handle->push_write (type => @args)
365		480
366	=item $handle->unshift_write (type => @args)
367
368	Instead of formatting your data yourself, you can also let this module do	481	Instead of formatting your data yourself, you can also let this module do
369	the job by specifying a type and type-specific arguments.	482	the job by specifying a type and type-specific arguments.
370		483
371	Predefined types are (if you have ideas for additional types, feel free to	484	Predefined types are (if you have ideas for additional types, feel free to
372	drop by and tell us):	485	drop by and tell us):
…		…
376	=item netstring => $string	489	=item netstring => $string
377		490
378	Formats the given value as netstring	491	Formats the given value as netstring
379	(http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them).	492	(http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them).
380		493
381	=back
382
383	=cut	494	=cut
384		495
385	register_write_type netstring => sub {	496	register_write_type netstring => sub {
386	my ($self, $string) = @_;	497	my ($self, $string) = @_;
387		498
388	sprintf "%d:%s,", (length $string), $string	499	sprintf "%d:%s,", (length $string), $string
		500	};
		501
		502	=item packstring => $format, $data
		503
		504	An octet string prefixed with an encoded length. The encoding C<$format>
		505	uses the same format as a Perl C<pack> format, but must specify a single
		506	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
		507	optional C<!>, C<< < >> or C<< > >> modifier).
		508
		509	=cut
		510
		511	register_write_type packstring => sub {
		512	my ($self, $format, $string) = @_;
		513
		514	pack "$format/a*", $string
389	};	515	};
390		516
391	=item json => $array_or_hashref	517	=item json => $array_or_hashref
392		518
393	Encodes the given hash or array reference into a JSON object. Unless you	519	Encodes the given hash or array reference into a JSON object. Unless you
…		…
427		553
428	$self->{json} ? $self->{json}->encode ($ref)	554	$self->{json} ? $self->{json}->encode ($ref)
429	: JSON::encode_json ($ref)	555	: JSON::encode_json ($ref)
430	};	556	};
431		557
		558	=item storable => $reference
		559
		560	Freezes the given reference using L<Storable> and writes it to the
		561	handle. Uses the C<nfreeze> format.
		562
		563	=cut
		564
		565	register_write_type storable => sub {
		566	my ($self, $ref) = @_;
		567
		568	require Storable;
		569
		570	pack "w/a*", Storable::nfreeze ($ref)
		571	};
		572
		573	=back
		574
432	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	575	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
433		576
434	This function (not method) lets you add your own types to C<push_write>.	577	This function (not method) lets you add your own types to C<push_write>.
435	Whenever the given C<type> is used, C<push_write> will invoke the code	578	Whenever the given C<type> is used, C<push_write> will invoke the code
436	reference with the handle object and the remaining arguments.	579	reference with the handle object and the remaining arguments.
…		…
456	ways, the "simple" way, using only C<on_read> and the "complex" way, using	599	ways, the "simple" way, using only C<on_read> and the "complex" way, using
457	a queue.	600	a queue.
458		601
459	In the simple case, you just install an C<on_read> callback and whenever	602	In the simple case, you just install an C<on_read> callback and whenever
460	new data arrives, it will be called. You can then remove some data (if	603	new data arrives, it will be called. You can then remove some data (if
461	enough is there) from the read buffer (C<< $handle->rbuf >>) if you want	604	enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna
462	or not.	605	leave the data there if you want to accumulate more (e.g. when only a
		606	partial message has been received so far).
463		607
464	In the more complex case, you want to queue multiple callbacks. In this	608	In the more complex case, you want to queue multiple callbacks. In this
465	case, AnyEvent::Handle will call the first queued callback each time new	609	case, AnyEvent::Handle will call the first queued callback each time new
466	data arrives and removes it when it has done its job (see C<push_read>,	610	data arrives (also the first time it is queued) and removes it when it has
467	below).	611	done its job (see C<push_read>, below).
468		612
469	This way you can, for example, push three line-reads, followed by reading	613	This way you can, for example, push three line-reads, followed by reading
470	a chunk of data, and AnyEvent::Handle will execute them in order.	614	a chunk of data, and AnyEvent::Handle will execute them in order.
471		615
472	Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by	616	Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by
473	the specified number of bytes which give an XML datagram.	617	the specified number of bytes which give an XML datagram.
474		618
475	# in the default state, expect some header bytes	619	# in the default state, expect some header bytes
476	$handle->on_read (sub {	620	$handle->on_read (sub {
477	# some data is here, now queue the length-header-read (4 octets)	621	# some data is here, now queue the length-header-read (4 octets)
478	shift->unshift_read_chunk (4, sub {	622	shift->unshift_read (chunk => 4, sub {
479	# header arrived, decode	623	# header arrived, decode
480	my $len = unpack "N", $_[1];	624	my $len = unpack "N", $_[1];
481		625
482	# now read the payload	626	# now read the payload
483	shift->unshift_read_chunk ($len, sub {	627	shift->unshift_read (chunk => $len, sub {
484	my $xml = $_[1];	628	my $xml = $_[1];
485	# handle xml	629	# handle xml
486	});	630	});
487	});	631	});
488	});	632	});
489		633
490	Example 2: Implement a client for a protocol that replies either with	634	Example 2: Implement a client for a protocol that replies either with "OK"
491	"OK" and another line or "ERROR" for one request, and 64 bytes for the	635	and another line or "ERROR" for the first request that is sent, and 64
492	second request. Due tot he availability of a full queue, we can just	636	bytes for the second request. Due to the availability of a queue, we can
493	pipeline sending both requests and manipulate the queue as necessary in	637	just pipeline sending both requests and manipulate the queue as necessary
494	the callbacks:	638	in the callbacks.
495		639
496	# request one	640	When the first callback is called and sees an "OK" response, it will
		641	C<unshift> another line-read. This line-read will be queued I<before> the
		642	64-byte chunk callback.
		643
		644	# request one, returns either "OK + extra line" or "ERROR"
497	$handle->push_write ("request 1\015\012");	645	$handle->push_write ("request 1\015\012");
498		646
499	# we expect "ERROR" or "OK" as response, so push a line read	647	# we expect "ERROR" or "OK" as response, so push a line read
500	$handle->push_read_line (sub {	648	$handle->push_read (line => sub {
501	# if we got an "OK", we have to _prepend_ another line,	649	# if we got an "OK", we have to _prepend_ another line,
502	# so it will be read before the second request reads its 64 bytes	650	# so it will be read before the second request reads its 64 bytes
503	# which are already in the queue when this callback is called	651	# which are already in the queue when this callback is called
504	# we don't do this in case we got an error	652	# we don't do this in case we got an error
505	if ($_[1] eq "OK") {	653	if ($_[1] eq "OK") {
506	$_[0]->unshift_read_line (sub {	654	$_[0]->unshift_read (line => sub {
507	my $response = $_[1];	655	my $response = $_[1];
508	...	656	...
509	});	657	});
510	}	658	}
511	});	659	});
512		660
513	# request two	661	# request two, simply returns 64 octets
514	$handle->push_write ("request 2\015\012");	662	$handle->push_write ("request 2\015\012");
515		663
516	# simply read 64 bytes, always	664	# simply read 64 bytes, always
517	$handle->push_read_chunk (64, sub {	665	$handle->push_read (chunk => 64, sub {
518	my $response = $_[1];	666	my $response = $_[1];
519	...	667	...
520	});	668	});
521		669
522	=over 4	670	=over 4
523		671
524	=cut	672	=cut
525		673
526	sub _drain_rbuf {	674	sub _drain_rbuf {
527	my ($self) = @_;	675	my ($self) = @_;
		676
		677	local $self->{_in_drain} = 1;
528		678
529	if (	679	if (
530	defined $self->{rbuf_max}	680	defined $self->{rbuf_max}
531	&& $self->{rbuf_max} < length $self->{rbuf}	681	&& $self->{rbuf_max} < length $self->{rbuf}
532	) {	682	) {
533	$! = &Errno::ENOSPC;	683	return $self->_error (&Errno::ENOSPC, 1);
534	$self->error;
535	}	684	}
536		685
537	return if $self->{in_drain};	686	while () {
538	local $self->{in_drain} = 1;
539
540	while (my $len = length $self->{rbuf}) {
541	no strict 'refs';	687	no strict 'refs';
		688
		689	my $len = length $self->{rbuf};
		690
542	if (my $cb = shift @{ $self->{_queue} }) {	691	if (my $cb = shift @{ $self->{_queue} }) {
543	unless ($cb->($self)) {	692	unless ($cb->($self)) {
544	if ($self->{_eof}) {	693	if ($self->{_eof}) {
545	# no progress can be made (not enough data and no data forthcoming)	694	# no progress can be made (not enough data and no data forthcoming)
546	$! = &Errno::EPIPE;	695	$self->_error (&Errno::EPIPE, 1), last;
547	$self->error;
548	}	696	}
549		697
550	unshift @{ $self->{_queue} }, $cb;	698	unshift @{ $self->{_queue} }, $cb;
551	return;	699	last;
552	}	700	}
553	} elsif ($self->{on_read}) {	701	} elsif ($self->{on_read}) {
		702	last unless $len;
		703
554	$self->{on_read}($self);	704	$self->{on_read}($self);
555		705
556	if (	706	if (
557	$self->{_eof} # if no further data will arrive
558	&& $len == length $self->{rbuf} # and no data has been consumed	707	$len == length $self->{rbuf} # if no data has been consumed
559	&& !@{ $self->{_queue} } # and the queue is still empty	708	&& !@{ $self->{_queue} } # and the queue is still empty
560	&& $self->{on_read} # and we still want to read data	709	&& $self->{on_read} # but we still have on_read
561	) {	710	) {
		711	# no further data will arrive
562	# then no progress can be made	712	# so no progress can be made
563	$! = &Errno::EPIPE;	713	$self->_error (&Errno::EPIPE, 1), last
564	$self->error;	714	if $self->{_eof};
		715
		716	last; # more data might arrive
565	}	717	}
566	} else {	718	} else {
567	# read side becomes idle	719	# read side becomes idle
568	delete $self->{_rw};	720	delete $self->{_rw};
569	return;	721	last;
570	}	722	}
571	}	723	}
572		724
573	if ($self->{_eof}) {
574	$self->_shutdown;
575	$self->{on_eof}($self)	725	$self->{on_eof}($self)
576	if $self->{on_eof};	726	if $self->{_eof} && $self->{on_eof};
		727
		728	# may need to restart read watcher
		729	unless ($self->{_rw}) {
		730	$self->start_read
		731	if $self->{on_read} \|\| @{ $self->{_queue} };
577	}	732	}
578	}	733	}
579		734
580	=item $handle->on_read ($cb)	735	=item $handle->on_read ($cb)
581		736
…		…
587		742
588	sub on_read {	743	sub on_read {
589	my ($self, $cb) = @_;	744	my ($self, $cb) = @_;
590		745
591	$self->{on_read} = $cb;	746	$self->{on_read} = $cb;
		747	$self->_drain_rbuf if $cb && !$self->{_in_drain};
592	}	748	}
593		749
594	=item $handle->rbuf	750	=item $handle->rbuf
595		751
596	Returns the read buffer (as a modifiable lvalue).	752	Returns the read buffer (as a modifiable lvalue).
…		…
645	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	801	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
646	->($self, $cb, @_);	802	->($self, $cb, @_);
647	}	803	}
648		804
649	push @{ $self->{_queue} }, $cb;	805	push @{ $self->{_queue} }, $cb;
650	$self->_drain_rbuf;	806	$self->_drain_rbuf unless $self->{_in_drain};
651	}	807	}
652		808
653	sub unshift_read {	809	sub unshift_read {
654	my $self = shift;	810	my $self = shift;
655	my $cb = pop;	811	my $cb = pop;
…		…
661	->($self, $cb, @_);	817	->($self, $cb, @_);
662	}	818	}
663		819
664		820
665	unshift @{ $self->{_queue} }, $cb;	821	unshift @{ $self->{_queue} }, $cb;
666	$self->_drain_rbuf;	822	$self->_drain_rbuf unless $self->{_in_drain};
667	}	823	}
668		824
669	=item $handle->push_read (type => @args, $cb)	825	=item $handle->push_read (type => @args, $cb)
670		826
671	=item $handle->unshift_read (type => @args, $cb)	827	=item $handle->unshift_read (type => @args, $cb)
…		…
756		912
757	sub unshift_read_line {	913	sub unshift_read_line {
758	my $self = shift;	914	my $self = shift;
759	$self->unshift_read (line => @_);	915	$self->unshift_read (line => @_);
760	}	916	}
761
762	=item netstring => $cb->($handle, $string)
763
764	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
765
766	Throws an error with C<$!> set to EBADMSG on format violations.
767
768	=cut
769
770	register_read_type netstring => sub {
771	my ($self, $cb) = @_;
772
773	sub {
774	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
775	if ($_[0]{rbuf} =~ /[^0-9]/) {
776	$! = &Errno::EBADMSG;
777	$self->error;
778	}
779	return;
780	}
781
782	my $len = $1;
783
784	$self->unshift_read (chunk => $len, sub {
785	my $string = $_[1];
786	$_[0]->unshift_read (chunk => 1, sub {
787	if ($_[1] eq ",") {
788	$cb->($_[0], $string);
789	} else {
790	$! = &Errno::EBADMSG;
791	$self->error;
792	}
793	});
794	});
795
796	1
797	}
798	};
799		917
800	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)	918	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
801		919
802	Makes a regex match against the regex object C<$accept> and returns	920	Makes a regex match against the regex object C<$accept> and returns
803	everything up to and including the match.	921	everything up to and including the match.
…		…
853	return 1;	971	return 1;
854	}	972	}
855		973
856	# reject	974	# reject
857	if ($reject && $$rbuf =~ $reject) {	975	if ($reject && $$rbuf =~ $reject) {
858	$! = &Errno::EBADMSG;	976	$self->_error (&Errno::EBADMSG);
859	$self->error;
860	}	977	}
861		978
862	# skip	979	# skip
863	if ($skip && $$rbuf =~ $skip) {	980	if ($skip && $$rbuf =~ $skip) {
864	$data .= substr $$rbuf, 0, $+[0], "";	981	$data .= substr $$rbuf, 0, $+[0], "";
…		…
866		983
867	()	984	()
868	}	985	}
869	};	986	};
870		987
		988	=item netstring => $cb->($handle, $string)
		989
		990	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
		991
		992	Throws an error with C<$!> set to EBADMSG on format violations.
		993
		994	=cut
		995
		996	register_read_type netstring => sub {
		997	my ($self, $cb) = @_;
		998
		999	sub {
		1000	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
		1001	if ($_[0]{rbuf} =~ /[^0-9]/) {
		1002	$self->_error (&Errno::EBADMSG);
		1003	}
		1004	return;
		1005	}
		1006
		1007	my $len = $1;
		1008
		1009	$self->unshift_read (chunk => $len, sub {
		1010	my $string = $_[1];
		1011	$_[0]->unshift_read (chunk => 1, sub {
		1012	if ($_[1] eq ",") {
		1013	$cb->($_[0], $string);
		1014	} else {
		1015	$self->_error (&Errno::EBADMSG);
		1016	}
		1017	});
		1018	});
		1019
		1020	1
		1021	}
		1022	};
		1023
		1024	=item packstring => $format, $cb->($handle, $string)
		1025
		1026	An octet string prefixed with an encoded length. The encoding C<$format>
		1027	uses the same format as a Perl C<pack> format, but must specify a single
		1028	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
		1029	optional C<!>, C<< < >> or C<< > >> modifier).
		1030
		1031	DNS over TCP uses a prefix of C<n>, EPP uses a prefix of C<N>.
		1032
		1033	Example: read a block of data prefixed by its length in BER-encoded
		1034	format (very efficient).
		1035
		1036	$handle->push_read (packstring => "w", sub {
		1037	my ($handle, $data) = @_;
		1038	});
		1039
		1040	=cut
		1041
		1042	register_read_type packstring => sub {
		1043	my ($self, $cb, $format) = @_;
		1044
		1045	sub {
		1046	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
		1047	defined (my $len = eval { unpack $format, $_[0]->{rbuf} })
		1048	or return;
		1049
		1050	# remove prefix
		1051	substr $_[0]->{rbuf}, 0, (length pack $format, $len), "";
		1052
		1053	# read rest
		1054	$_[0]->unshift_read (chunk => $len, $cb);
		1055
		1056	1
		1057	}
		1058	};
		1059
871	=item json => $cb->($handle, $hash_or_arrayref)	1060	=item json => $cb->($handle, $hash_or_arrayref)
872		1061
873	Reads a JSON object or array, decodes it and passes it to the callback.	1062	Reads a JSON object or array, decodes it and passes it to the callback.
874		1063
875	If a C<json> object was passed to the constructor, then that will be used	1064	If a C<json> object was passed to the constructor, then that will be used
…		…
885	the C<json> write type description, above, for an actual example.	1074	the C<json> write type description, above, for an actual example.
886		1075
887	=cut	1076	=cut
888		1077
889	register_read_type json => sub {	1078	register_read_type json => sub {
890	my ($self, $cb, $accept, $reject, $skip) = @_;	1079	my ($self, $cb) = @_;
891		1080
892	require JSON;	1081	require JSON;
893		1082
894	my $data;	1083	my $data;
895	my $rbuf = \$self->{rbuf};	1084	my $rbuf = \$self->{rbuf};
…		…
910	()	1099	()
911	}	1100	}
912	}	1101	}
913	};	1102	};
914		1103
		1104	=item storable => $cb->($handle, $ref)
		1105
		1106	Deserialises a L<Storable> frozen representation as written by the
		1107	C<storable> write type (BER-encoded length prefix followed by nfreeze'd
		1108	data).
		1109
		1110	Raises C<EBADMSG> error if the data could not be decoded.
		1111
		1112	=cut
		1113
		1114	register_read_type storable => sub {
		1115	my ($self, $cb) = @_;
		1116
		1117	require Storable;
		1118
		1119	sub {
		1120	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
		1121	defined (my $len = eval { unpack "w", $_[0]->{rbuf} })
		1122	or return;
		1123
		1124	# remove prefix
		1125	substr $_[0]->{rbuf}, 0, (length pack "w", $len), "";
		1126
		1127	# read rest
		1128	$_[0]->unshift_read (chunk => $len, sub {
		1129	if (my $ref = eval { Storable::thaw ($_[1]) }) {
		1130	$cb->($_[0], $ref);
		1131	} else {
		1132	$self->_error (&Errno::EBADMSG);
		1133	}
		1134	});
		1135	}
		1136	};
		1137
915	=back	1138	=back
916		1139
917	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)	1140	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)
918		1141
919	This function (not method) lets you add your own types to C<push_read>.	1142	This function (not method) lets you add your own types to C<push_read>.
…		…
937	=item $handle->stop_read	1160	=item $handle->stop_read
938		1161
939	=item $handle->start_read	1162	=item $handle->start_read
940		1163
941	In rare cases you actually do not want to read anything from the	1164	In rare cases you actually do not want to read anything from the
942	socket. In this case you can call C<stop_read>. Neither C<on_read> no	1165	socket. In this case you can call C<stop_read>. Neither C<on_read> nor
943	any queued callbacks will be executed then. To start reading again, call	1166	any queued callbacks will be executed then. To start reading again, call
944	C<start_read>.	1167	C<start_read>.
		1168
		1169	Note that AnyEvent::Handle will automatically C<start_read> for you when
		1170	you change the C<on_read> callback or push/unshift a read callback, and it
		1171	will automatically C<stop_read> for you when neither C<on_read> is set nor
		1172	there are any read requests in the queue.
945		1173
946	=cut	1174	=cut
947		1175
948	sub stop_read {	1176	sub stop_read {
949	my ($self) = @_;	1177	my ($self) = @_;
…		…
960	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1188	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
961	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1189	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};
962	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;	1190	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;
963		1191
964	if ($len > 0) {	1192	if ($len > 0) {
		1193	$self->{_activity} = AnyEvent->now;
		1194
965	$self->{filter_r}	1195	$self->{filter_r}
966	? $self->{filter_r}->($self, $rbuf)	1196	? $self->{filter_r}($self, $rbuf)
967	: $self->_drain_rbuf;	1197	: $self->{_in_drain} \|\| $self->_drain_rbuf;
968		1198
969	} elsif (defined $len) {	1199	} elsif (defined $len) {
970	delete $self->{_rw};	1200	delete $self->{_rw};
971	$self->{_eof} = 1;	1201	$self->{_eof} = 1;
972	$self->_drain_rbuf;	1202	$self->_drain_rbuf unless $self->{_in_drain};
973		1203
974	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1204	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
975	return $self->error;	1205	return $self->_error ($!, 1);
976	}	1206	}
977	});	1207	});
978	}	1208	}
979	}	1209	}
980		1210
981	sub _dotls {	1211	sub _dotls {
982	my ($self) = @_;	1212	my ($self) = @_;
		1213
		1214	my $buf;
983		1215
984	if (length $self->{_tls_wbuf}) {	1216	if (length $self->{_tls_wbuf}) {
985	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1217	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
986	substr $self->{_tls_wbuf}, 0, $len, "";	1218	substr $self->{_tls_wbuf}, 0, $len, "";
987	}	1219	}
988	}	1220	}
989		1221
990	if (defined (my $buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1222	if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {
991	$self->{wbuf} .= $buf;	1223	$self->{wbuf} .= $buf;
992	$self->_drain_wbuf;	1224	$self->_drain_wbuf;
993	}	1225	}
994		1226
995	while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) {	1227	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {
		1228	if (length $buf) {
996	$self->{rbuf} .= $buf;	1229	$self->{rbuf} .= $buf;
997	$self->_drain_rbuf;	1230	$self->_drain_rbuf unless $self->{_in_drain};
		1231	} else {
		1232	# let's treat SSL-eof as we treat normal EOF
		1233	$self->{_eof} = 1;
		1234	$self->_shutdown;
		1235	return;
		1236	}
998	}	1237	}
999		1238
1000	my $err = Net::SSLeay::get_error ($self->{tls}, -1);	1239	my $err = Net::SSLeay::get_error ($self->{tls}, -1);
1001		1240
1002	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {	1241	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
1003	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {	1242	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {
1004	$self->error;	1243	return $self->_error ($!, 1);
1005	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {	1244	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {
1006	$! = &Errno::EIO;	1245	return $self->_error (&Errno::EIO, 1);
1007	$self->error;
1008	}	1246	}
1009		1247
1010	# all others are fine for our purposes	1248	# all others are fine for our purposes
1011	}	1249	}
1012	}	1250	}
…		…
1027	call and can be used or changed to your liking. Note that the handshake	1265	call and can be used or changed to your liking. Note that the handshake
1028	might have already started when this function returns.	1266	might have already started when this function returns.
1029		1267
1030	=cut	1268	=cut
1031		1269
1032	# TODO: maybe document...
1033	sub starttls {	1270	sub starttls {
1034	my ($self, $ssl, $ctx) = @_;	1271	my ($self, $ssl, $ctx) = @_;
1035		1272
1036	$self->stoptls;	1273	$self->stoptls;
1037		1274
…		…
1090		1327
1091	sub DESTROY {	1328	sub DESTROY {
1092	my $self = shift;	1329	my $self = shift;
1093		1330
1094	$self->stoptls;	1331	$self->stoptls;
		1332
		1333	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
		1334
		1335	if ($linger && length $self->{wbuf}) {
		1336	my $fh = delete $self->{fh};
		1337	my $wbuf = delete $self->{wbuf};
		1338
		1339	my @linger;
		1340
		1341	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {
		1342	my $len = syswrite $fh, $wbuf, length $wbuf;
		1343
		1344	if ($len > 0) {
		1345	substr $wbuf, 0, $len, "";
		1346	} else {
		1347	@linger = (); # end
		1348	}
		1349	});
		1350	push @linger, AnyEvent->timer (after => $linger, cb => sub {
		1351	@linger = ();
		1352	});
		1353	}
1095	}	1354	}
1096		1355
1097	=item AnyEvent::Handle::TLS_CTX	1356	=item AnyEvent::Handle::TLS_CTX
1098		1357
1099	This function creates and returns the Net::SSLeay::CTX object used by	1358	This function creates and returns the Net::SSLeay::CTX object used by

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.42 by root, Tue May 27 06:23:15 2008 UTC vs. Revision 1.69 by root, Sun Jun 15 21:44:56 2008 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.42 by root, Tue May 27 06:23:15 2008 UTC vs.
Revision 1.69 by root, Sun Jun 15 21:44:56 2008 UTC