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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.25 by root, Sat May 24 15:19:43 2008 UTC vs.
Revision 1.39 by root, Tue May 27 04:59:51 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(WSAWOULDBLOCK);
8	use Scalar::Util ();	8	use Scalar::Util ();
9	use Carp ();	9	use Carp ();
10	use Fcntl ();	10	use Fcntl ();
11	use Errno qw/EAGAIN EINTR/;	11	use Errno qw/EAGAIN EINTR/;
12		12
13	=head1 NAME	13	=head1 NAME
14		14
15	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent	15	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent
16		16
17	This module is experimental.
18
19	=cut	17	=cut
20		18
21	our $VERSION = '0.04';	19	our $VERSION = '0.04';
22		20
23	=head1 SYNOPSIS	21	=head1 SYNOPSIS
…		…
25	use AnyEvent;	23	use AnyEvent;
26	use AnyEvent::Handle;	24	use AnyEvent::Handle;
27		25
28	my $cv = AnyEvent->condvar;	26	my $cv = AnyEvent->condvar;
29		27
30	my $ae_fh = AnyEvent::Handle->new (fh => \*STDIN);	28	my $handle =
31
32	#TODO
33
34	# or use the constructor to pass the callback:
35
36	my $ae_fh2 =
37	AnyEvent::Handle->new (	29	AnyEvent::Handle->new (
38	fh => \*STDIN,	30	fh => \*STDIN,
39	on_eof => sub {	31	on_eof => sub {
40	$cv->broadcast;	32	$cv->broadcast;
41	},	33	},
42	#TODO
43	);	34	);
44		35
45	$cv->wait;	36	# send some request line
		37	$handle->push_write ("getinfo\015\012");
		38
		39	# read the response line
		40	$handle->push_read (line => sub {
		41	my ($handle, $line) = @_;
		42	warn "read line <$line>\n";
		43	$cv->send;
		44	});
		45
		46	$cv->recv;
46		47
47	=head1 DESCRIPTION	48	=head1 DESCRIPTION
48		49
49	This module is a helper module to make it easier to do event-based I/O on	50	This module is a helper module to make it easier to do event-based I/O on
50	filehandles. For utility functions for doing non-blocking connects and accepts	51	filehandles. For utility functions for doing non-blocking connects and accepts
…		…
90		91
91	The object will not be in a usable state when this callback has been	92	The object will not be in a usable state when this callback has been
92	called.	93	called.
93		94
94	On callback entrance, the value of C<$!> contains the operating system	95	On callback entrance, the value of C<$!> contains the operating system
95	error (or C<ENOSPC> or C<EPIPE>).	96	error (or C<ENOSPC>, C<EPIPE> or C<EBADMSG>).
		97
		98	The callback should throw an exception. If it returns, then
		99	AnyEvent::Handle will C<croak> for you.
96		100
97	While not mandatory, it is I<highly> recommended to set this callback, as	101	While not mandatory, it is I<highly> recommended to set this callback, as
98	you will not be notified of errors otherwise. The default simply calls	102	you will not be notified of errors otherwise. The default simply calls
99	die.	103	die.
100		104
…		…
145		149
146	When this parameter is given, it enables TLS (SSL) mode, that means it	150	When this parameter is given, it enables TLS (SSL) mode, that means it
147	will start making tls handshake and will transparently encrypt/decrypt	151	will start making tls handshake and will transparently encrypt/decrypt
148	data.	152	data.
149		153
		154	TLS mode requires Net::SSLeay to be installed (it will be loaded
		155	automatically when you try to create a TLS handle).
		156
150	For the TLS server side, use C<accept>, and for the TLS client side of a	157	For the TLS server side, use C<accept>, and for the TLS client side of a
151	connection, use C<connect> mode.	158	connection, use C<connect> mode.
152		159
153	You can also provide your own TLS connection object, but you have	160	You can also provide your own TLS connection object, but you have
154	to make sure that you call either C<Net::SSLeay::set_connect_state>	161	to make sure that you call either C<Net::SSLeay::set_connect_state>
155	or C<Net::SSLeay::set_accept_state> on it before you pass it to	162	or C<Net::SSLeay::set_accept_state> on it before you pass it to
156	AnyEvent::Handle.	163	AnyEvent::Handle.
157		164
		165	See the C<starttls> method if you need to start TLs negotiation later.
		166
158	=item tls_ctx => $ssl_ctx	167	=item tls_ctx => $ssl_ctx
159		168
160	Use the given Net::SSLeay::CTX object to create the new TLS connection	169	Use the given Net::SSLeay::CTX object to create the new TLS connection
161	(unless a connection object was specified directly). If this parameter is	170	(unless a connection object was specified directly). If this parameter is
162	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	171	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
		172
		173	=item filter_r => $cb
		174
		175	=item filter_w => $cb
		176
		177	These exist, but are undocumented at this time.
163		178
164	=back	179	=back
165		180
166	=cut	181	=cut
167		182
…		…
190	}	205	}
191		206
192	sub _shutdown {	207	sub _shutdown {
193	my ($self) = @_;	208	my ($self) = @_;
194		209
195	delete $self->{rw};	210	delete $self->{_rw};
196	delete $self->{ww};	211	delete $self->{_ww};
197	delete $self->{fh};	212	delete $self->{fh};
198	}	213	}
199		214
200	sub error {	215	sub error {
201	my ($self) = @_;	216	my ($self) = @_;
…		…
203	{	218	{
204	local $!;	219	local $!;
205	$self->_shutdown;	220	$self->_shutdown;
206	}	221	}
207		222
208	if ($self->{on_error}) {
209	$self->{on_error}($self);	223	$self->{on_error}($self)
210	} else {	224	if $self->{on_error};
		225
211	die "AnyEvent::Handle uncaught fatal error: $!";	226	Carp::croak "AnyEvent::Handle uncaught fatal error: $!";
212	}
213	}	227	}
214		228
215	=item $fh = $handle->fh	229	=item $fh = $handle->fh
216		230
217	This method returns the file handle of the L<AnyEvent::Handle> object.	231	This method returns the file handle of the L<AnyEvent::Handle> object.
218		232
219	=cut	233	=cut
220		234
221	sub fh { $_[0]->{fh} }	235	sub fh { $_[0]{fh} }
222		236
223	=item $handle->on_error ($cb)	237	=item $handle->on_error ($cb)
224		238
225	Replace the current C<on_error> callback (see the C<on_error> constructor argument).	239	Replace the current C<on_error> callback (see the C<on_error> constructor argument).
226		240
…		…
282	=cut	296	=cut
283		297
284	sub _drain_wbuf {	298	sub _drain_wbuf {
285	my ($self) = @_;	299	my ($self) = @_;
286		300
287	unless ($self->{ww}) {	301	if (!$self->{_ww} && length $self->{wbuf}) {
		302
288	Scalar::Util::weaken $self;	303	Scalar::Util::weaken $self;
		304
289	my $cb = sub {	305	my $cb = sub {
290	my $len = syswrite $self->{fh}, $self->{wbuf};	306	my $len = syswrite $self->{fh}, $self->{wbuf};
291		307
292	if ($len > 0) {	308	if ($len >= 0) {
293	substr $self->{wbuf}, 0, $len, "";	309	substr $self->{wbuf}, 0, $len, "";
294		310
295	$self->{on_drain}($self)	311	$self->{on_drain}($self)
296	if $self->{low_water_mark} >= length $self->{wbuf}	312	if $self->{low_water_mark} >= length $self->{wbuf}
297	&& $self->{on_drain};	313	&& $self->{on_drain};
298		314
299	delete $self->{ww} unless length $self->{wbuf};	315	delete $self->{_ww} unless length $self->{wbuf};
300	} elsif ($! != EAGAIN && $! != EINTR) {	316	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAWOULDBLOCK) {
301	$self->error;	317	$self->error;
302	}	318	}
303	};	319	};
304		320
		321	# try to write data immediately
		322	$cb->();
		323
		324	# if still data left in wbuf, we need to poll
305	$self->{ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb);	325	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)
306		326	if length $self->{wbuf};
307	$cb->($self);
308	};	327	};
		328	}
		329
		330	our %WH;
		331
		332	sub register_write_type($$) {
		333	$WH{$_[0]} = $_[1];
309	}	334	}
310		335
311	sub push_write {	336	sub push_write {
312	my $self = shift;	337	my $self = shift;
		338
		339	if (@_ > 1) {
		340	my $type = shift;
		341
		342	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")
		343	->($self, @_);
		344	}
313		345
314	if ($self->{filter_w}) {	346	if ($self->{filter_w}) {
315	$self->{filter_w}->($self, \$_[0]);	347	$self->{filter_w}->($self, \$_[0]);
316	} else {	348	} else {
317	$self->{wbuf} .= $_[0];	349	$self->{wbuf} .= $_[0];
318	$self->_drain_wbuf;	350	$self->_drain_wbuf;
319	}	351	}
320	}	352	}
		353
		354	=item $handle->push_write (type => @args)
		355
		356	=item $handle->unshift_write (type => @args)
		357
		358	Instead of formatting your data yourself, you can also let this module do
		359	the job by specifying a type and type-specific arguments.
		360
		361	Predefined types are (if you have ideas for additional types, feel free to
		362	drop by and tell us):
		363
		364	=over 4
		365
		366	=item netstring => $string
		367
		368	Formats the given value as netstring
		369	(http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them).
		370
		371	=back
		372
		373	=cut
		374
		375	register_write_type netstring => sub {
		376	my ($self, $string) = @_;
		377
		378	sprintf "%d:%s,", (length $string), $string
		379	};
		380
		381	=item json => $array_or_hashref
		382
		383	=item AnyEvent::Handle::register_write_type type => $coderef->($self, @args)
		384
		385	This function (not method) lets you add your own types to C<push_write>.
		386	Whenever the given C<type> is used, C<push_write> will invoke the code
		387	reference with the handle object and the remaining arguments.
		388
		389	The code reference is supposed to return a single octet string that will
		390	be appended to the write buffer.
		391
		392	Note that this is a function, and all types registered this way will be
		393	global, so try to use unique names.
		394
		395	=cut
321		396
322	#############################################################################	397	#############################################################################
323		398
324	=back	399	=back
325		400
…		…
404		479
405	if (	480	if (
406	defined $self->{rbuf_max}	481	defined $self->{rbuf_max}
407	&& $self->{rbuf_max} < length $self->{rbuf}	482	&& $self->{rbuf_max} < length $self->{rbuf}
408	) {	483	) {
409	$! = &Errno::ENOSPC; return $self->error;	484	$! = &Errno::ENOSPC;
		485	$self->error;
410	}	486	}
411		487
412	return if $self->{in_drain};	488	return if $self->{in_drain};
413	local $self->{in_drain} = 1;	489	local $self->{in_drain} = 1;
414		490
415	while (my $len = length $self->{rbuf}) {	491	while (my $len = length $self->{rbuf}) {
416	no strict 'refs';	492	no strict 'refs';
417	if (my $cb = shift @{ $self->{queue} }) {	493	if (my $cb = shift @{ $self->{_queue} }) {
418	if (!$cb->($self)) {	494	unless ($cb->($self)) {
419	if ($self->{eof}) {	495	if ($self->{_eof}) {
420	# no progress can be made (not enough data and no data forthcoming)	496	# no progress can be made (not enough data and no data forthcoming)
421	$! = &Errno::EPIPE; return $self->error;	497	$! = &Errno::EPIPE;
		498	$self->error;
422	}	499	}
423		500
424	unshift @{ $self->{queue} }, $cb;	501	unshift @{ $self->{_queue} }, $cb;
425	return;	502	return;
426	}	503	}
427	} elsif ($self->{on_read}) {	504	} elsif ($self->{on_read}) {
428	$self->{on_read}($self);	505	$self->{on_read}($self);
429		506
430	if (	507	if (
431	$self->{eof} # if no further data will arrive	508	$self->{_eof} # if no further data will arrive
432	&& $len == length $self->{rbuf} # and no data has been consumed	509	&& $len == length $self->{rbuf} # and no data has been consumed
433	&& !@{ $self->{queue} } # and the queue is still empty	510	&& !@{ $self->{_queue} } # and the queue is still empty
434	&& $self->{on_read} # and we still want to read data	511	&& $self->{on_read} # and we still want to read data
435	) {	512	) {
436	# then no progress can be made	513	# then no progress can be made
437	$! = &Errno::EPIPE; return $self->error;	514	$! = &Errno::EPIPE;
		515	$self->error;
438	}	516	}
439	} else {	517	} else {
440	# read side becomes idle	518	# read side becomes idle
441	delete $self->{rw};	519	delete $self->{_rw};
442	return;	520	return;
443	}	521	}
444	}	522	}
445		523
446	if ($self->{eof}) {	524	if ($self->{_eof}) {
447	$self->_shutdown;	525	$self->_shutdown;
448	$self->{on_eof}($self)	526	$self->{on_eof}($self)
449	if $self->{on_eof};	527	if $self->{on_eof};
450	}	528	}
451	}	529	}
…		…
500	interested in (which can be none at all) and return a true value. After returning	578	interested in (which can be none at all) and return a true value. After returning
501	true, it will be removed from the queue.	579	true, it will be removed from the queue.
502		580
503	=cut	581	=cut
504		582
		583	our %RH;
		584
		585	sub register_read_type($$) {
		586	$RH{$_[0]} = $_[1];
		587	}
		588
505	sub push_read {	589	sub push_read {
506	my ($self, $cb) = @_;	590	my $self = shift;
		591	my $cb = pop;
507		592
		593	if (@_) {
		594	my $type = shift;
		595
		596	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
		597	->($self, $cb, @_);
		598	}
		599
508	push @{ $self->{queue} }, $cb;	600	push @{ $self->{_queue} }, $cb;
509	$self->_drain_rbuf;	601	$self->_drain_rbuf;
510	}	602	}
511		603
512	sub unshift_read {	604	sub unshift_read {
513	my ($self, $cb) = @_;	605	my $self = shift;
		606	my $cb = pop;
514		607
		608	if (@_) {
		609	my $type = shift;
		610
		611	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")
		612	->($self, $cb, @_);
		613	}
		614
		615
515	push @{ $self->{queue} }, $cb;	616	unshift @{ $self->{_queue} }, $cb;
516	$self->_drain_rbuf;	617	$self->_drain_rbuf;
517	}	618	}
518		619
519	=item $handle->push_read_chunk ($len, $cb->($self, $data))	620	=item $handle->push_read (type => @args, $cb)
520		621
521	=item $handle->unshift_read_chunk ($len, $cb->($self, $data))	622	=item $handle->unshift_read (type => @args, $cb)
522		623
523	Append the given callback to the end of the queue (C<push_read_chunk>) or	624	Instead of providing a callback that parses the data itself you can chose
524	prepend it (C<unshift_read_chunk>).	625	between a number of predefined parsing formats, for chunks of data, lines
		626	etc.
525		627
526	The callback will be called only once C<$len> bytes have been read, and	628	Predefined types are (if you have ideas for additional types, feel free to
527	these C<$len> bytes will be passed to the callback.	629	drop by and tell us):
528		630
529	=cut	631	=over 4
530		632
531	sub _read_chunk($$) {	633	=item chunk => $octets, $cb->($self, $data)
		634
		635	Invoke the callback only once C<$octets> bytes have been read. Pass the
		636	data read to the callback. The callback will never be called with less
		637	data.
		638
		639	Example: read 2 bytes.
		640
		641	$handle->push_read (chunk => 2, sub {
		642	warn "yay ", unpack "H*", $_[1];
		643	});
		644
		645	=cut
		646
		647	register_read_type chunk => sub {
532	my ($self, $len, $cb) = @_;	648	my ($self, $cb, $len) = @_;
533		649
534	sub {	650	sub {
535	$len <= length $_[0]{rbuf} or return;	651	$len <= length $_[0]{rbuf} or return;
536	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");	652	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");
537	1	653	1
538	}	654	}
539	}	655	};
540		656
		657	# compatibility with older API
541	sub push_read_chunk {	658	sub push_read_chunk {
542	$_[0]->push_read (&_read_chunk);	659	$_[0]->push_read (chunk => $_[1], $_[2]);
543	}	660	}
544
545		661
546	sub unshift_read_chunk {	662	sub unshift_read_chunk {
547	$_[0]->unshift_read (&_read_chunk);	663	$_[0]->unshift_read (chunk => $_[1], $_[2]);
548	}	664	}
549		665
550	=item $handle->push_read_line ([$eol, ]$cb->($self, $line, $eol))	666	=item line => [$eol, ]$cb->($self, $line, $eol)
551
552	=item $handle->unshift_read_line ([$eol, ]$cb->($self, $line, $eol))
553
554	Append the given callback to the end of the queue (C<push_read_line>) or
555	prepend it (C<unshift_read_line>).
556		667
557	The callback will be called only once a full line (including the end of	668	The callback will be called only once a full line (including the end of
558	line marker, C<$eol>) has been read. This line (excluding the end of line	669	line marker, C<$eol>) has been read. This line (excluding the end of line
559	marker) will be passed to the callback as second argument (C<$line>), and	670	marker) will be passed to the callback as second argument (C<$line>), and
560	the end of line marker as the third argument (C<$eol>).	671	the end of line marker as the third argument (C<$eol>).
…		…
571	Partial lines at the end of the stream will never be returned, as they are	682	Partial lines at the end of the stream will never be returned, as they are
572	not marked by the end of line marker.	683	not marked by the end of line marker.
573		684
574	=cut	685	=cut
575		686
576	sub _read_line($$) {	687	register_read_type line => sub {
577	my $self = shift;	688	my ($self, $cb, $eol) = @_;
578	my $cb = pop;
579	my $eol = @_ ? shift : qr\|(\015?\012)\|;
580	my $pos;
581		689
		690	$eol = qr\|(\015?\012)\| if @_ < 3;
582	$eol = quotemeta $eol unless ref $eol;	691	$eol = quotemeta $eol unless ref $eol;
583	$eol = qr\|^(.*?)($eol)\|s;	692	$eol = qr\|^(.*?)($eol)\|s;
584		693
585	sub {	694	sub {
586	$_[0]{rbuf} =~ s/$eol// or return;	695	$_[0]{rbuf} =~ s/$eol// or return;
587		696
588	$cb->($_[0], $1, $2);	697	$cb->($_[0], $1, $2);
589	1	698	1
590	}	699	}
591	}	700	};
592		701
		702	# compatibility with older API
593	sub push_read_line {	703	sub push_read_line {
594	$_[0]->push_read (&_read_line);	704	my $self = shift;
		705	$self->push_read (line => @_);
595	}	706	}
596		707
597	sub unshift_read_line {	708	sub unshift_read_line {
598	$_[0]->unshift_read (&_read_line);	709	my $self = shift;
		710	$self->unshift_read (line => @_);
599	}	711	}
		712
		713	=item netstring => $cb->($string)
		714
		715	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
		716
		717	Throws an error with C<$!> set to EBADMSG on format violations.
		718
		719	=cut
		720
		721	register_read_type netstring => sub {
		722	my ($self, $cb) = @_;
		723
		724	sub {
		725	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
		726	if ($_[0]{rbuf} =~ /[^0-9]/) {
		727	$! = &Errno::EBADMSG;
		728	$self->error;
		729	}
		730	return;
		731	}
		732
		733	my $len = $1;
		734
		735	$self->unshift_read (chunk => $len, sub {
		736	my $string = $_[1];
		737	$_[0]->unshift_read (chunk => 1, sub {
		738	if ($_[1] eq ",") {
		739	$cb->($_[0], $string);
		740	} else {
		741	$! = &Errno::EBADMSG;
		742	$self->error;
		743	}
		744	});
		745	});
		746
		747	1
		748	}
		749	};
		750
		751	=item regex => $accept[, $reject[, $skip], $cb->($data)
		752
		753	Makes a regex match against the regex object C<$accept> and returns
		754	everything up to and including the match.
		755
		756	Example: read a single line terminated by '\n'.
		757
		758	$handle->push_read (regex => qr<\n>, sub { ... });
		759
		760	If C<$reject> is given and not undef, then it determines when the data is
		761	to be rejected: it is matched against the data when the C<$accept> regex
		762	does not match and generates an C<EBADMSG> error when it matches. This is
		763	useful to quickly reject wrong data (to avoid waiting for a timeout or a
		764	receive buffer overflow).
		765
		766	Example: expect a single decimal number followed by whitespace, reject
		767	anything else (not the use of an anchor).
		768
		769	$handle->push_read (regex => qr<^[0-9]+\s>, qr<[^0-9]>, sub { ... });
		770
		771	If C<$skip> is given and not C<undef>, then it will be matched against
		772	the receive buffer when neither C<$accept> nor C<$reject> match,
		773	and everything preceding and including the match will be accepted
		774	unconditionally. This is useful to skip large amounts of data that you
		775	know cannot be matched, so that the C<$accept> or C<$reject> regex do not
		776	have to start matching from the beginning. This is purely an optimisation
		777	and is usually worth only when you expect more than a few kilobytes.
		778
		779	Example: expect a http header, which ends at C<\015\012\015\012>. Since we
		780	expect the header to be very large (it isn't in practise, but...), we use
		781	a skip regex to skip initial portions. The skip regex is tricky in that
		782	it only accepts something not ending in either \015 or \012, as these are
		783	required for the accept regex.
		784
		785	$handle->push_read (regex =>
		786	qr<\015\012\015\012>,
		787	undef, # no reject
		788	qr<^.*[^\015\012]>,
		789	sub { ... });
		790
		791	=cut
		792
		793	register_read_type regex => sub {
		794	my ($self, $cb, $accept, $reject, $skip) = @_;
		795
		796	my $data;
		797	my $rbuf = \$self->{rbuf};
		798
		799	sub {
		800	# accept
		801	if ($$rbuf =~ $accept) {
		802	$data .= substr $$rbuf, 0, $+[0], "";
		803	$cb->($self, $data);
		804	return 1;
		805	}
		806
		807	# reject
		808	if ($reject && $$rbuf =~ $reject) {
		809	$! = &Errno::EBADMSG;
		810	$self->error;
		811	}
		812
		813	# skip
		814	if ($skip && $$rbuf =~ $skip) {
		815	$data .= substr $$rbuf, 0, $+[0], "";
		816	}
		817
		818	()
		819	}
		820	};
		821
		822	=back
		823
		824	=item AnyEvent::Handle::register_read_type type => $coderef->($self, $cb, @args)
		825
		826	This function (not method) lets you add your own types to C<push_read>.
		827
		828	Whenever the given C<type> is used, C<push_read> will invoke the code
		829	reference with the handle object, the callback and the remaining
		830	arguments.
		831
		832	The code reference is supposed to return a callback (usually a closure)
		833	that works as a plain read callback (see C<< ->push_read ($cb) >>).
		834
		835	It should invoke the passed callback when it is done reading (remember to
		836	pass C<$self> as first argument as all other callbacks do that).
		837
		838	Note that this is a function, and all types registered this way will be
		839	global, so try to use unique names.
		840
		841	For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>,
		842	search for C<register_read_type>)).
600		843
601	=item $handle->stop_read	844	=item $handle->stop_read
602		845
603	=item $handle->start_read	846	=item $handle->start_read
604		847
…		…
610	=cut	853	=cut
611		854
612	sub stop_read {	855	sub stop_read {
613	my ($self) = @_;	856	my ($self) = @_;
614		857
615	delete $self->{rw};	858	delete $self->{_rw};
616	}	859	}
617		860
618	sub start_read {	861	sub start_read {
619	my ($self) = @_;	862	my ($self) = @_;
620		863
621	unless ($self->{rw} \|\| $self->{eof}) {	864	unless ($self->{_rw} \|\| $self->{_eof}) {
622	Scalar::Util::weaken $self;	865	Scalar::Util::weaken $self;
623		866
624	$self->{rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	867	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
625	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	868	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};
626	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;	869	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;
627		870
628	if ($len > 0) {	871	if ($len > 0) {
629	$self->{filter_r}	872	$self->{filter_r}
630	? $self->{filter_r}->($self, $rbuf)	873	? $self->{filter_r}->($self, $rbuf)
631	: $self->_drain_rbuf;	874	: $self->_drain_rbuf;
632		875
633	} elsif (defined $len) {	876	} elsif (defined $len) {
634	delete $self->{rw};	877	delete $self->{_rw};
635	$self->{eof} = 1;	878	$self->{_eof} = 1;
636	$self->_drain_rbuf;	879	$self->_drain_rbuf;
637		880
638	} elsif ($! != EAGAIN && $! != EINTR) {	881	} elsif ($! != EAGAIN && $! != EINTR && $! != &AnyEvent::Util::WSAWOULDBLOCK) {
639	return $self->error;	882	return $self->error;
640	}	883	}
641	});	884	});
642	}	885	}
643	}	886	}
644		887
645	sub _dotls {	888	sub _dotls {
646	my ($self) = @_;	889	my ($self) = @_;
647		890
648	if (length $self->{tls_wbuf}) {	891	if (length $self->{_tls_wbuf}) {
649	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{tls_wbuf})) > 0) {	892	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
650	substr $self->{tls_wbuf}, 0, $len, "";	893	substr $self->{_tls_wbuf}, 0, $len, "";
651	}	894	}
652	}	895	}
653		896
654	if (defined (my $buf = Net::SSLeay::BIO_read ($self->{tls_wbio}))) {	897	if (defined (my $buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {
655	$self->{wbuf} .= $buf;	898	$self->{wbuf} .= $buf;
656	$self->_drain_wbuf;	899	$self->_drain_wbuf;
657	}	900	}
658		901
659	while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) {	902	while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) {
…		…
685	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	928	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
686		929
687	The second argument is the optional C<Net::SSLeay::CTX> object that is	930	The second argument is the optional C<Net::SSLeay::CTX> object that is
688	used when AnyEvent::Handle has to create its own TLS connection object.	931	used when AnyEvent::Handle has to create its own TLS connection object.
689		932
		933	The TLS connection object will end up in C<< $handle->{tls} >> after this
		934	call and can be used or changed to your liking. Note that the handshake
		935	might have already started when this function returns.
		936
690	=cut	937	=cut
691		938
692	# TODO: maybe document...	939	# TODO: maybe document...
693	sub starttls {	940	sub starttls {
694	my ($self, $ssl, $ctx) = @_;	941	my ($self, $ssl, $ctx) = @_;
…		…
707		954
708	# basically, this is deep magic (because SSL_read should have the same issues)	955	# basically, this is deep magic (because SSL_read should have the same issues)
709	# but the openssl maintainers basically said: "trust us, it just works".	956	# but the openssl maintainers basically said: "trust us, it just works".
710	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	957	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
711	# and mismaintained ssleay-module doesn't even offer them).	958	# and mismaintained ssleay-module doesn't even offer them).
		959	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
712	Net::SSLeay::CTX_set_mode ($self->{tls},	960	Net::SSLeay::CTX_set_mode ($self->{tls},
713	(eval { Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	961	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
714	\| (eval { Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));	962	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
715		963
716	$self->{tls_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	964	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
717	$self->{tls_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	965	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
718		966
719	Net::SSLeay::set_bio ($ssl, $self->{tls_rbio}, $self->{tls_wbio});	967	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
720		968
721	$self->{filter_w} = sub {	969	$self->{filter_w} = sub {
722	$_[0]{tls_wbuf} .= ${$_[1]};	970	$_[0]{_tls_wbuf} .= ${$_[1]};
723	&_dotls;	971	&_dotls;
724	};	972	};
725	$self->{filter_r} = sub {	973	$self->{filter_r} = sub {
726	Net::SSLeay::BIO_write ($_[0]{tls_rbio}, ${$_[1]});	974	Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});
727	&_dotls;	975	&_dotls;
728	};	976	};
729	}	977	}
730		978
731	=item $handle->stoptls	979	=item $handle->stoptls
…		…
737		985
738	sub stoptls {	986	sub stoptls {
739	my ($self) = @_;	987	my ($self) = @_;
740		988
741	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};	989	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};
		990
742	delete $self->{tls_rbio};	991	delete $self->{_rbio};
743	delete $self->{tls_wbio};	992	delete $self->{_wbio};
744	delete $self->{tls_wbuf};	993	delete $self->{_tls_wbuf};
745	delete $self->{filter_r};	994	delete $self->{filter_r};
746	delete $self->{filter_w};	995	delete $self->{filter_w};
747	}	996	}
748		997
749	sub DESTROY {	998	sub DESTROY {
…		…
787	}	1036	}
788	}	1037	}
789		1038
790	=back	1039	=back
791		1040
		1041	=head1 SUBCLASSING AnyEvent::Handle
		1042
		1043	In many cases, you might want to subclass AnyEvent::Handle.
		1044
		1045	To make this easier, a given version of AnyEvent::Handle uses these
		1046	conventions:
		1047
		1048	=over 4
		1049
		1050	=item * all constructor arguments become object members.
		1051
		1052	At least initially, when you pass a C<tls>-argument to the constructor it
		1053	will end up in C<< $handle->{tls} >>. Those members might be changes or
		1054	mutated later on (for example C<tls> will hold the TLS connection object).
		1055
		1056	=item * other object member names are prefixed with an C<_>.
		1057
		1058	All object members not explicitly documented (internal use) are prefixed
		1059	with an underscore character, so the remaining non-C<_>-namespace is free
		1060	for use for subclasses.
		1061
		1062	=item * all members not documented here and not prefixed with an underscore
		1063	are free to use in subclasses.
		1064
		1065	Of course, new versions of AnyEvent::Handle may introduce more "public"
		1066	member variables, but thats just life, at least it is documented.
		1067
		1068	=back
		1069
792	=head1 AUTHOR	1070	=head1 AUTHOR
793		1071
794	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.	1072	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.
795		1073
796	=cut	1074	=cut

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.25 by root, Sat May 24 15:19:43 2008 UTC vs. Revision 1.39 by root, Tue May 27 04:59:51 2008 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.25 by root, Sat May 24 15:19:43 2008 UTC vs.
Revision 1.39 by root, Tue May 27 04:59:51 2008 UTC