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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.21 by root, Sat May 24 15:03:42 2008 UTC vs.
Revision 1.38 by root, Mon May 26 21:28:33 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 filehandles via AnyEvent	15	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent
16
17	This module is experimental.
18		16
19	=cut	17	=cut
20		18
21	our $VERSION = '0.04';	19	our $VERSION = '0.04';
22		20
…		…
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 filehandle 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 AnyEvent::Handle::register_write_type type => $coderef->($self, @args)
		382
		383	This function (not method) lets you add your own types to C<push_write>.
		384	Whenever the given C<type> is used, C<push_write> will invoke the code
		385	reference with the handle object and the remaining arguments.
		386
		387	The code reference is supposed to return a single octet string that will
		388	be appended to the write buffer.
		389
		390	Note that this is a function, and all types registered this way will be
		391	global, so try to use unique names.
		392
		393	=cut
321		394
322	#############################################################################	395	#############################################################################
323		396
324	=back	397	=back
325		398
…		…
404		477
405	if (	478	if (
406	defined $self->{rbuf_max}	479	defined $self->{rbuf_max}
407	&& $self->{rbuf_max} < length $self->{rbuf}	480	&& $self->{rbuf_max} < length $self->{rbuf}
408	) {	481	) {
409	$! = &Errno::ENOSPC; return $self->error;	482	$! = &Errno::ENOSPC;
		483	$self->error;
410	}	484	}
411		485
412	return if $self->{in_drain};	486	return if $self->{in_drain};
413	local $self->{in_drain} = 1;	487	local $self->{in_drain} = 1;
414		488
415	while (my $len = length $self->{rbuf}) {	489	while (my $len = length $self->{rbuf}) {
416	no strict 'refs';	490	no strict 'refs';
417	if (my $cb = shift @{ $self->{queue} }) {	491	if (my $cb = shift @{ $self->{_queue} }) {
418	if (!$cb->($self)) {	492	unless ($cb->($self)) {
419	if ($self->{eof}) {	493	if ($self->{_eof}) {
420	# no progress can be made (not enough data and no data forthcoming)	494	# no progress can be made (not enough data and no data forthcoming)
421	$! = &Errno::EPIPE; return $self->error;	495	$! = &Errno::EPIPE;
		496	$self->error;
422	}	497	}
423		498
424	unshift @{ $self->{queue} }, $cb;	499	unshift @{ $self->{_queue} }, $cb;
425	return;	500	return;
426	}	501	}
427	} elsif ($self->{on_read}) {	502	} elsif ($self->{on_read}) {
428	$self->{on_read}($self);	503	$self->{on_read}($self);
429		504
430	if (	505	if (
431	$self->{eof} # if no further data will arrive	506	$self->{_eof} # if no further data will arrive
432	&& $len == length $self->{rbuf} # and no data has been consumed	507	&& $len == length $self->{rbuf} # and no data has been consumed
433	&& !@{ $self->{queue} } # and the queue is still empty	508	&& !@{ $self->{_queue} } # and the queue is still empty
434	&& $self->{on_read} # and we still want to read data	509	&& $self->{on_read} # and we still want to read data
435	) {	510	) {
436	# then no progress can be made	511	# then no progress can be made
437	$! = &Errno::EPIPE; return $self->error;	512	$! = &Errno::EPIPE;
		513	$self->error;
438	}	514	}
439	} else {	515	} else {
440	# read side becomes idle	516	# read side becomes idle
441	delete $self->{rw};	517	delete $self->{_rw};
442	return;	518	return;
443	}	519	}
444	}	520	}
445		521
446	if ($self->{eof}) {	522	if ($self->{_eof}) {
447	$self->_shutdown;	523	$self->_shutdown;
448	$self->{on_eof}($self)	524	$self->{on_eof}($self)
449	if $self->{on_eof};	525	if $self->{on_eof};
450	}	526	}
451	}	527	}
…		…
500	interested in (which can be none at all) and return a true value. After returning	576	interested in (which can be none at all) and return a true value. After returning
501	true, it will be removed from the queue.	577	true, it will be removed from the queue.
502		578
503	=cut	579	=cut
504		580
		581	our %RH;
		582
		583	sub register_read_type($$) {
		584	$RH{$_[0]} = $_[1];
		585	}
		586
505	sub push_read {	587	sub push_read {
506	my ($self, $cb) = @_;	588	my $self = shift;
		589	my $cb = pop;
507		590
		591	if (@_) {
		592	my $type = shift;
		593
		594	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
		595	->($self, $cb, @_);
		596	}
		597
508	push @{ $self->{queue} }, $cb;	598	push @{ $self->{_queue} }, $cb;
509	$self->_drain_rbuf;	599	$self->_drain_rbuf;
510	}	600	}
511		601
512	sub unshift_read {	602	sub unshift_read {
513	my ($self, $cb) = @_;	603	my $self = shift;
		604	my $cb = pop;
514		605
		606	if (@_) {
		607	my $type = shift;
		608
		609	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")
		610	->($self, $cb, @_);
		611	}
		612
		613
515	push @{ $self->{queue} }, $cb;	614	unshift @{ $self->{_queue} }, $cb;
516	$self->_drain_rbuf;	615	$self->_drain_rbuf;
517	}	616	}
518		617
519	=item $handle->push_read_chunk ($len, $cb->($self, $data))	618	=item $handle->push_read (type => @args, $cb)
520		619
521	=item $handle->unshift_read_chunk ($len, $cb->($self, $data))	620	=item $handle->unshift_read (type => @args, $cb)
522		621
523	Append the given callback to the end of the queue (C<push_read_chunk>) or	622	Instead of providing a callback that parses the data itself you can chose
524	prepend it (C<unshift_read_chunk>).	623	between a number of predefined parsing formats, for chunks of data, lines
		624	etc.
525		625
526	The callback will be called only once C<$len> bytes have been read, and	626	Predefined types are (if you have ideas for additional types, feel free to
527	these C<$len> bytes will be passed to the callback.	627	drop by and tell us):
528		628
529	=cut	629	=over 4
530		630
531	sub _read_chunk($$) {	631	=item chunk => $octets, $cb->($self, $data)
		632
		633	Invoke the callback only once C<$octets> bytes have been read. Pass the
		634	data read to the callback. The callback will never be called with less
		635	data.
		636
		637	Example: read 2 bytes.
		638
		639	$handle->push_read (chunk => 2, sub {
		640	warn "yay ", unpack "H*", $_[1];
		641	});
		642
		643	=cut
		644
		645	register_read_type chunk => sub {
532	my ($self, $len, $cb) = @_;	646	my ($self, $cb, $len) = @_;
533		647
534	sub {	648	sub {
535	$len <= length $_[0]{rbuf} or return;	649	$len <= length $_[0]{rbuf} or return;
536	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");	650	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");
537	1	651	1
538	}	652	}
539	}	653	};
540		654
		655	# compatibility with older API
541	sub push_read_chunk {	656	sub push_read_chunk {
542	$_[0]->push_read (&_read_chunk);	657	$_[0]->push_read (chunk => $_[1], $_[2]);
543	}	658	}
544
545		659
546	sub unshift_read_chunk {	660	sub unshift_read_chunk {
547	$_[0]->unshift_read (&_read_chunk);	661	$_[0]->unshift_read (chunk => $_[1], $_[2]);
548	}	662	}
549		663
550	=item $handle->push_read_line ([$eol, ]$cb->($self, $line, $eol))	664	=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		665
557	The callback will be called only once a full line (including the end of	666	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	667	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	668	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>).	669	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	680	Partial lines at the end of the stream will never be returned, as they are
572	not marked by the end of line marker.	681	not marked by the end of line marker.
573		682
574	=cut	683	=cut
575		684
576	sub _read_line($$) {	685	register_read_type line => sub {
577	my $self = shift;	686	my ($self, $cb, $eol) = @_;
578	my $cb = pop;
579	my $eol = @_ ? shift : qr\|(\015?\012)\|;
580	my $pos;
581		687
		688	$eol = qr\|(\015?\012)\| if @_ < 3;
582	$eol = quotemeta $eol unless ref $eol;	689	$eol = quotemeta $eol unless ref $eol;
583	$eol = qr\|^(.*?)($eol)\|s;	690	$eol = qr\|^(.*?)($eol)\|s;
584		691
585	sub {	692	sub {
586	$_[0]{rbuf} =~ s/$eol// or return;	693	$_[0]{rbuf} =~ s/$eol// or return;
587		694
588	$cb->($_[0], $1, $2);	695	$cb->($_[0], $1, $2);
589	1	696	1
590	}	697	}
591	}	698	};
592		699
		700	# compatibility with older API
593	sub push_read_line {	701	sub push_read_line {
594	$_[0]->push_read (&_read_line);	702	my $self = shift;
		703	$self->push_read (line => @_);
595	}	704	}
596		705
597	sub unshift_read_line {	706	sub unshift_read_line {
598	$_[0]->unshift_read (&_read_line);	707	my $self = shift;
		708	$self->unshift_read (line => @_);
599	}	709	}
		710
		711	=item netstring => $cb->($string)
		712
		713	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
		714
		715	Throws an error with C<$!> set to EBADMSG on format violations.
		716
		717	=cut
		718
		719	register_read_type netstring => sub {
		720	my ($self, $cb) = @_;
		721
		722	sub {
		723	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
		724	if ($_[0]{rbuf} =~ /[^0-9]/) {
		725	$! = &Errno::EBADMSG;
		726	$self->error;
		727	}
		728	return;
		729	}
		730
		731	my $len = $1;
		732
		733	$self->unshift_read (chunk => $len, sub {
		734	my $string = $_[1];
		735	$_[0]->unshift_read (chunk => 1, sub {
		736	if ($_[1] eq ",") {
		737	$cb->($_[0], $string);
		738	} else {
		739	$! = &Errno::EBADMSG;
		740	$self->error;
		741	}
		742	});
		743	});
		744
		745	1
		746	}
		747	};
		748
		749	=item regex => $accept[, $reject[, $skip], $cb->($data)
		750
		751	Makes a regex match against the regex object C<$accept> and returns
		752	everything up to and including the match.
		753
		754	Example: read a single line terminated by '\n'.
		755
		756	$handle->push_read (regex => qr<\n>, sub { ... });
		757
		758	If C<$reject> is given and not undef, then it determines when the data is
		759	to be rejected: it is matched against the data when the C<$accept> regex
		760	does not match and generates an C<EBADMSG> error when it matches. This is
		761	useful to quickly reject wrong data (to avoid waiting for a timeout or a
		762	receive buffer overflow).
		763
		764	Example: expect a single decimal number followed by whitespace, reject
		765	anything else (not the use of an anchor).
		766
		767	$handle->push_read (regex => qr<^[0-9]+\s>, qr<[^0-9]>, sub { ... });
		768
		769	If C<$skip> is given and not C<undef>, then it will be matched against
		770	the receive buffer when neither C<$accept> nor C<$reject> match,
		771	and everything preceding and including the match will be accepted
		772	unconditionally. This is useful to skip large amounts of data that you
		773	know cannot be matched, so that the C<$accept> or C<$reject> regex do not
		774	have to start matching from the beginning. This is purely an optimisation
		775	and is usually worth only when you expect more than a few kilobytes.
		776
		777	Example: expect a http header, which ends at C<\015\012\015\012>. Since we
		778	expect the header to be very large (it isn't in practise, but...), we use
		779	a skip regex to skip initial portions. The skip regex is tricky in that
		780	it only accepts something not ending in either \015 or \012, as these are
		781	required for the accept regex.
		782
		783	$handle->push_read (regex =>
		784	qr<\015\012\015\012>,
		785	undef, # no reject
		786	qr<^.*[^\015\012]>,
		787	sub { ... });
		788
		789	=cut
		790
		791	register_read_type regex => sub {
		792	my ($self, $cb, $accept, $reject, $skip) = @_;
		793
		794	my $data;
		795	my $rbuf = \$self->{rbuf};
		796
		797	sub {
		798	# accept
		799	if ($$rbuf =~ $accept) {
		800	$data .= substr $$rbuf, 0, $+[0], "";
		801	$cb->($self, $data);
		802	return 1;
		803	}
		804
		805	# reject
		806	if ($reject && $$rbuf =~ $reject) {
		807	$! = &Errno::EBADMSG;
		808	$self->error;
		809	}
		810
		811	# skip
		812	if ($skip && $$rbuf =~ $skip) {
		813	$data .= substr $$rbuf, 0, $+[0], "";
		814	}
		815
		816	()
		817	}
		818	};
		819
		820	=back
		821
		822	=item AnyEvent::Handle::register_read_type type => $coderef->($self, $cb, @args)
		823
		824	This function (not method) lets you add your own types to C<push_read>.
		825
		826	Whenever the given C<type> is used, C<push_read> will invoke the code
		827	reference with the handle object, the callback and the remaining
		828	arguments.
		829
		830	The code reference is supposed to return a callback (usually a closure)
		831	that works as a plain read callback (see C<< ->push_read ($cb) >>).
		832
		833	It should invoke the passed callback when it is done reading (remember to
		834	pass C<$self> as first argument as all other callbacks do that).
		835
		836	Note that this is a function, and all types registered this way will be
		837	global, so try to use unique names.
		838
		839	For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>,
		840	search for C<register_read_type>)).
600		841
601	=item $handle->stop_read	842	=item $handle->stop_read
602		843
603	=item $handle->start_read	844	=item $handle->start_read
604		845
605	In rare cases you actually do not want to read anything from the	846	In rare cases you actually do not want to read anything from the
606	socket. In this case you can call C<stop_read>. Neither C<on_read> no	847	socket. In this case you can call C<stop_read>. Neither C<on_read> no
607	any queued callbacks will be executed then. To start readign again, call	848	any queued callbacks will be executed then. To start reading again, call
608	C<start_read>.	849	C<start_read>.
609		850
610	=cut	851	=cut
611		852
612	sub stop_read {	853	sub stop_read {
613	my ($self) = @_;	854	my ($self) = @_;
614		855
615	delete $self->{rw};	856	delete $self->{_rw};
616	}	857	}
617		858
618	sub start_read {	859	sub start_read {
619	my ($self) = @_;	860	my ($self) = @_;
620		861
621	unless ($self->{rw} \|\| $self->{eof}) {	862	unless ($self->{_rw} \|\| $self->{_eof}) {
622	Scalar::Util::weaken $self;	863	Scalar::Util::weaken $self;
623		864
624	$self->{rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	865	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
625	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	866	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};
626	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;	867	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;
627		868
628	if ($len > 0) {	869	if ($len > 0) {
629	$self->{filter_r}	870	$self->{filter_r}
630	? $self->{filter_r}->($self, $rbuf)	871	? $self->{filter_r}->($self, $rbuf)
631	: $self->_drain_rbuf;	872	: $self->_drain_rbuf;
632		873
633	} elsif (defined $len) {	874	} elsif (defined $len) {
634	delete $self->{rw};	875	delete $self->{_rw};
635	$self->{eof} = 1;	876	$self->{_eof} = 1;
636	$self->_drain_rbuf;	877	$self->_drain_rbuf;
637		878
638	} elsif ($! != EAGAIN && $! != EINTR) {	879	} elsif ($! != EAGAIN && $! != EINTR && $! != &AnyEvent::Util::WSAWOULDBLOCK) {
639	return $self->error;	880	return $self->error;
640	}	881	}
641	});	882	});
642	}	883	}
643	}	884	}
644		885
645	sub _dotls {	886	sub _dotls {
646	my ($self) = @_;	887	my ($self) = @_;
647		888
648	if (length $self->{tls_wbuf}) {	889	if (length $self->{_tls_wbuf}) {
649	my $len = Net::SSLeay::write ($self->{tls}, $self->{tls_wbuf});	890	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
650	substr $self->{tls_wbuf}, 0, $len, "" if $len > 0;	891	substr $self->{_tls_wbuf}, 0, $len, "";
		892	}
651	}	893	}
652		894
653	if (defined (my $buf = Net::SSLeay::BIO_read ($self->{tls_wbio}))) {	895	if (defined (my $buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {
654	$self->{wbuf} .= $buf;	896	$self->{wbuf} .= $buf;
655	$self->_drain_wbuf;	897	$self->_drain_wbuf;
656	}	898	}
657		899
658	if (defined (my $buf = Net::SSLeay::read ($self->{tls}))) {	900	while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) {
659	$self->{rbuf} .= $buf;	901	$self->{rbuf} .= $buf;
660	$self->_drain_rbuf;	902	$self->_drain_rbuf;
661	} elsif (	903	}
		904
662	(my $err = Net::SSLeay::get_error ($self->{tls}, -1))	905	my $err = Net::SSLeay::get_error ($self->{tls}, -1);
		906
663	!= Net::SSLeay::ERROR_WANT_READ ()	907	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
664	) {
665	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {	908	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {
666	$self->error;	909	$self->error;
667	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {	910	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {
668	$! = &Errno::EIO;	911	$! = &Errno::EIO;
669	$self->error;	912	$self->error;
…		…
671		914
672	# all others are fine for our purposes	915	# all others are fine for our purposes
673	}	916	}
674	}	917	}
675		918
		919	=item $handle->starttls ($tls[, $tls_ctx])
		920
		921	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
		922	object is created, you can also do that at a later time by calling
		923	C<starttls>.
		924
		925	The first argument is the same as the C<tls> constructor argument (either
		926	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
		927
		928	The second argument is the optional C<Net::SSLeay::CTX> object that is
		929	used when AnyEvent::Handle has to create its own TLS connection object.
		930
		931	The TLS connection object will end up in C<< $handle->{tls} >> after this
		932	call and can be used or changed to your liking. Note that the handshake
		933	might have already started when this function returns.
		934
		935	=cut
		936
676	# TODO: maybe document...	937	# TODO: maybe document...
677	sub starttls {	938	sub starttls {
678	my ($self, $ssl, $ctx) = @_;	939	my ($self, $ssl, $ctx) = @_;
		940
		941	$self->stoptls;
679		942
680	if ($ssl eq "accept") {	943	if ($ssl eq "accept") {
681	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	944	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());
682	Net::SSLeay::set_accept_state ($ssl);	945	Net::SSLeay::set_accept_state ($ssl);
683	} elsif ($ssl eq "connect") {	946	} elsif ($ssl eq "connect") {
…		…
689		952
690	# basically, this is deep magic (because SSL_read should have the same issues)	953	# basically, this is deep magic (because SSL_read should have the same issues)
691	# but the openssl maintainers basically said: "trust us, it just works".	954	# but the openssl maintainers basically said: "trust us, it just works".
692	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	955	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
693	# and mismaintained ssleay-module doesn't even offer them).	956	# and mismaintained ssleay-module doesn't even offer them).
		957	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
694	Net::SSLeay::CTX_set_mode ($self->{tls},	958	Net::SSLeay::CTX_set_mode ($self->{tls},
695	(eval { Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	959	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
696	\| (eval { Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));	960	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
697		961
698	$self->{tls_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	962	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
699	$self->{tls_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	963	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
700		964
701	Net::SSLeay::set_bio ($ssl, $self->{tls_rbio}, $self->{tls_wbio});	965	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
702		966
703	$self->{filter_w} = sub {	967	$self->{filter_w} = sub {
704	$_[0]{tls_wbuf} .= ${$_[1]};	968	$_[0]{_tls_wbuf} .= ${$_[1]};
705	&_dotls;	969	&_dotls;
706	};	970	};
707	$self->{filter_r} = sub {	971	$self->{filter_r} = sub {
708	Net::SSLeay::BIO_write ($_[0]{tls_rbio}, ${$_[1]});	972	Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});
709	&_dotls;	973	&_dotls;
710	};	974	};
711	}	975	}
712		976
		977	=item $handle->stoptls
		978
		979	Destroys the SSL connection, if any. Partial read or write data will be
		980	lost.
		981
		982	=cut
		983
		984	sub stoptls {
		985	my ($self) = @_;
		986
		987	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};
		988
		989	delete $self->{_rbio};
		990	delete $self->{_wbio};
		991	delete $self->{_tls_wbuf};
		992	delete $self->{filter_r};
		993	delete $self->{filter_w};
		994	}
		995
713	sub DESTROY {	996	sub DESTROY {
714	my $self = shift;	997	my $self = shift;
715		998
716	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};	999	$self->stoptls;
717	}	1000	}
718		1001
719	=item AnyEvent::Handle::TLS_CTX	1002	=item AnyEvent::Handle::TLS_CTX
720		1003
721	This function creates and returns the Net::SSLeay::CTX object used by	1004	This function creates and returns the Net::SSLeay::CTX object used by
…		…
751	}	1034	}
752	}	1035	}
753		1036
754	=back	1037	=back
755		1038
		1039	=head1 SUBCLASSING AnyEvent::Handle
		1040
		1041	In many cases, you might want to subclass AnyEvent::Handle.
		1042
		1043	To make this easier, a given version of AnyEvent::Handle uses these
		1044	conventions:
		1045
		1046	=over 4
		1047
		1048	=item * all constructor arguments become object members.
		1049
		1050	At least initially, when you pass a C<tls>-argument to the constructor it
		1051	will end up in C<< $handle->{tls} >>. Those members might be changes or
		1052	mutated later on (for example C<tls> will hold the TLS connection object).
		1053
		1054	=item * other object member names are prefixed with an C<_>.
		1055
		1056	All object members not explicitly documented (internal use) are prefixed
		1057	with an underscore character, so the remaining non-C<_>-namespace is free
		1058	for use for subclasses.
		1059
		1060	=item * all members not documented here and not prefixed with an underscore
		1061	are free to use in subclasses.
		1062
		1063	Of course, new versions of AnyEvent::Handle may introduce more "public"
		1064	member variables, but thats just life, at least it is documented.
		1065
		1066	=back
		1067
756	=head1 AUTHOR	1068	=head1 AUTHOR
757		1069
758	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.	1070	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.
759		1071
760	=cut	1072	=cut

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.21 by root, Sat May 24 15:03:42 2008 UTC vs. Revision 1.38 by root, Mon May 26 21:28:33 2008 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.21 by root, Sat May 24 15:03:42 2008 UTC vs.
Revision 1.38 by root, Mon May 26 21:28:33 2008 UTC