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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.18 by root, Sat May 24 05:01:16 2008 UTC vs.
Revision 1.36 by root, Mon May 26 18:26:52 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
…		…
83	waiting for data.	84	waiting for data.
84		85
85	=item on_error => $cb->($self)	86	=item on_error => $cb->($self)
86		87
87	This is the fatal error callback, that is called when, well, a fatal error	88	This is the fatal error callback, that is called when, well, a fatal error
88	ocurs, such as not being able to resolve the hostname, failure to connect	89	occurs, such as not being able to resolve the hostname, failure to connect
89	or a read error.	90	or a read error.
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>).
96		97
97	While not mandatory, it is I<highly> recommended to set this callback, as	98	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	99	you will not be notified of errors otherwise. The default simply calls
99	die.	100	die.
100		101
…		…
102		103
103	This sets the default read callback, which is called when data arrives	104	This sets the default read callback, which is called when data arrives
104	and no read request is in the queue.	105	and no read request is in the queue.
105		106
106	To access (and remove data from) the read buffer, use the C<< ->rbuf >>	107	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
107	method or acces sthe C<$self->{rbuf}> member directly.	108	method or access the C<$self->{rbuf}> member directly.
108		109
109	When an EOF condition is detected then AnyEvent::Handle will first try to	110	When an EOF condition is detected then AnyEvent::Handle will first try to
110	feed all the remaining data to the queued callbacks and C<on_read> before	111	feed all the remaining data to the queued callbacks and C<on_read> before
111	calling the C<on_eof> callback. If no progress can be made, then a fatal	112	calling the C<on_eof> callback. If no progress can be made, then a fatal
112	error will be raised (with C<$!> set to C<EPIPE>).	113	error will be raised (with C<$!> set to C<EPIPE>).
…		…
139		140
140	Sets the amount of bytes (default: C<0>) that make up an "empty" write	141	Sets the amount of bytes (default: C<0>) that make up an "empty" write
141	buffer: If the write reaches this size or gets even samller it is	142	buffer: If the write reaches this size or gets even samller it is
142	considered empty.	143	considered empty.
143		144
		145	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
		146
		147	When this parameter is given, it enables TLS (SSL) mode, that means it
		148	will start making tls handshake and will transparently encrypt/decrypt
		149	data.
		150
		151	TLS mode requires Net::SSLeay to be installed (it will be loaded
		152	automatically when you try to create a TLS handle).
		153
		154	For the TLS server side, use C<accept>, and for the TLS client side of a
		155	connection, use C<connect> mode.
		156
		157	You can also provide your own TLS connection object, but you have
		158	to make sure that you call either C<Net::SSLeay::set_connect_state>
		159	or C<Net::SSLeay::set_accept_state> on it before you pass it to
		160	AnyEvent::Handle.
		161
		162	See the C<starttls> method if you need to start TLs negotiation later.
		163
		164	=item tls_ctx => $ssl_ctx
		165
		166	Use the given Net::SSLeay::CTX object to create the new TLS connection
		167	(unless a connection object was specified directly). If this parameter is
		168	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
		169
144	=back	170	=back
145		171
146	=cut	172	=cut
147		173
148	sub new {	174	sub new {
…		…
151	my $self = bless { @_ }, $class;	177	my $self = bless { @_ }, $class;
152		178
153	$self->{fh} or Carp::croak "mandatory argument fh is missing";	179	$self->{fh} or Carp::croak "mandatory argument fh is missing";
154		180
155	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	181	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
		182
		183	if ($self->{tls}) {
		184	require Net::SSLeay;
		185	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});
		186	}
156		187
157	$self->on_eof (delete $self->{on_eof} ) if $self->{on_eof};	188	$self->on_eof (delete $self->{on_eof} ) if $self->{on_eof};
158	$self->on_error (delete $self->{on_error}) if $self->{on_error};	189	$self->on_error (delete $self->{on_error}) if $self->{on_error};
159	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	190	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
160	$self->on_read (delete $self->{on_read} ) if $self->{on_read};	191	$self->on_read (delete $self->{on_read} ) if $self->{on_read};
…		…
181	}	212	}
182		213
183	if ($self->{on_error}) {	214	if ($self->{on_error}) {
184	$self->{on_error}($self);	215	$self->{on_error}($self);
185	} else {	216	} else {
186	die "AnyEvent::Handle uncaught fatal error: $!";	217	Carp::croak "AnyEvent::Handle uncaught fatal error: $!";
187	}	218	}
188	}	219	}
189		220
190	=item $fh = $handle->fh	221	=item $fh = $handle->fh
191		222
192	This method returns the filehandle of the L<AnyEvent::Handle> object.	223	This method returns the file handle of the L<AnyEvent::Handle> object.
193		224
194	=cut	225	=cut
195		226
196	sub fh { $_[0]->{fh} }	227	sub fh { $_[0]->{fh} }
197		228
…		…
225	for reading.	256	for reading.
226		257
227	The write queue is very simple: you can add data to its end, and	258	The write queue is very simple: you can add data to its end, and
228	AnyEvent::Handle will automatically try to get rid of it for you.	259	AnyEvent::Handle will automatically try to get rid of it for you.
229		260
230	When data could be writtena nd the write buffer is shorter then the low	261	When data could be written and the write buffer is shorter then the low
231	water mark, the C<on_drain> callback will be invoked.	262	water mark, the C<on_drain> callback will be invoked.
232		263
233	=over 4	264	=over 4
234		265
235	=item $handle->on_drain ($cb)	266	=item $handle->on_drain ($cb)
…		…
257	=cut	288	=cut
258		289
259	sub _drain_wbuf {	290	sub _drain_wbuf {
260	my ($self) = @_;	291	my ($self) = @_;
261		292
262	unless ($self->{ww}) {	293	if (!$self->{ww} && length $self->{wbuf}) {
		294
263	Scalar::Util::weaken $self;	295	Scalar::Util::weaken $self;
		296
264	my $cb = sub {	297	my $cb = sub {
265	my $len = syswrite $self->{fh}, $self->{wbuf};	298	my $len = syswrite $self->{fh}, $self->{wbuf};
266		299
267	if ($len > 0) {	300	if ($len >= 0) {
268	substr $self->{wbuf}, 0, $len, "";	301	substr $self->{wbuf}, 0, $len, "";
269		302
270	$self->{on_drain}($self)	303	$self->{on_drain}($self)
271	if $self->{low_water_mark} >= length $self->{wbuf}	304	if $self->{low_water_mark} >= length $self->{wbuf}
272	&& $self->{on_drain};	305	&& $self->{on_drain};
273		306
274	delete $self->{ww} unless length $self->{wbuf};	307	delete $self->{ww} unless length $self->{wbuf};
275	} elsif ($! != EAGAIN && $! != EINTR) {	308	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAWOULDBLOCK) {
276	$self->error;	309	$self->error;
277	}	310	}
278	};	311	};
279		312
		313	# try to write data immediately
		314	$cb->();
		315
		316	# if still data left in wbuf, we need to poll
280	$self->{ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb);	317	$self->{ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)
281		318	if length $self->{wbuf};
282	$cb->($self);
283	};	319	};
		320	}
		321
		322	our %WH;
		323
		324	sub register_write_type($$) {
		325	$WH{$_[0]} = $_[1];
284	}	326	}
285		327
286	sub push_write {	328	sub push_write {
287	my $self = shift;	329	my $self = shift;
		330
		331	if (@_ > 1) {
		332	my $type = shift;
		333
		334	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")
		335	->($self, @_);
		336	}
288		337
289	if ($self->{filter_w}) {	338	if ($self->{filter_w}) {
290	$self->{filter_w}->($self, \$_[0]);	339	$self->{filter_w}->($self, \$_[0]);
291	} else {	340	} else {
292	$self->{wbuf} .= $_[0];	341	$self->{wbuf} .= $_[0];
293	$self->_drain_wbuf;	342	$self->_drain_wbuf;
294	}	343	}
295	}	344	}
		345
		346	=item $handle->push_write (type => @args)
		347
		348	=item $handle->unshift_write (type => @args)
		349
		350	Instead of formatting your data yourself, you can also let this module do
		351	the job by specifying a type and type-specific arguments.
		352
		353	Predefined types are (if you have ideas for additional types, feel free to
		354	drop by and tell us):
		355
		356	=over 4
		357
		358	=item netstring => $string
		359
		360	Formats the given value as netstring
		361	(http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them).
		362
		363	=back
		364
		365	=cut
		366
		367	register_write_type netstring => sub {
		368	my ($self, $string) = @_;
		369
		370	sprintf "%d:%s,", (length $string), $string
		371	};
		372
		373	=item AnyEvent::Handle::register_write_type type => $coderef->($self, @args)
		374
		375	This function (not method) lets you add your own types to C<push_write>.
		376	Whenever the given C<type> is used, C<push_write> will invoke the code
		377	reference with the handle object and the remaining arguments.
		378
		379	The code reference is supposed to return a single octet string that will
		380	be appended to the write buffer.
		381
		382	Note that this is a function, and all types registered this way will be
		383	global, so try to use unique names.
		384
		385	=cut
296		386
297	#############################################################################	387	#############################################################################
298		388
299	=back	389	=back
300		390
…		…
388	local $self->{in_drain} = 1;	478	local $self->{in_drain} = 1;
389		479
390	while (my $len = length $self->{rbuf}) {	480	while (my $len = length $self->{rbuf}) {
391	no strict 'refs';	481	no strict 'refs';
392	if (my $cb = shift @{ $self->{queue} }) {	482	if (my $cb = shift @{ $self->{queue} }) {
393	if (!$cb->($self)) {	483	unless ($cb->($self)) {
394	if ($self->{eof}) {	484	if ($self->{eof}) {
395	# no progress can be made (not enough data and no data forthcoming)	485	# no progress can be made (not enough data and no data forthcoming)
396	$! = &Errno::EPIPE; return $self->error;	486	$! = &Errno::EPIPE; return $self->error;
397	}	487	}
398		488
…		…
463	Append the given callback to the end of the queue (C<push_read>) or	553	Append the given callback to the end of the queue (C<push_read>) or
464	prepend it (C<unshift_read>).	554	prepend it (C<unshift_read>).
465		555
466	The callback is called each time some additional read data arrives.	556	The callback is called each time some additional read data arrives.
467		557
468	It must check wether enough data is in the read buffer already.	558	It must check whether enough data is in the read buffer already.
469		559
470	If not enough data is available, it must return the empty list or a false	560	If not enough data is available, it must return the empty list or a false
471	value, in which case it will be called repeatedly until enough data is	561	value, in which case it will be called repeatedly until enough data is
472	available (or an error condition is detected).	562	available (or an error condition is detected).
473		563
…		…
475	interested in (which can be none at all) and return a true value. After returning	565	interested in (which can be none at all) and return a true value. After returning
476	true, it will be removed from the queue.	566	true, it will be removed from the queue.
477		567
478	=cut	568	=cut
479		569
		570	our %RH;
		571
		572	sub register_read_type($$) {
		573	$RH{$_[0]} = $_[1];
		574	}
		575
480	sub push_read {	576	sub push_read {
481	my ($self, $cb) = @_;	577	my $self = shift;
		578	my $cb = pop;
		579
		580	if (@_) {
		581	my $type = shift;
		582
		583	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
		584	->($self, $cb, @_);
		585	}
482		586
483	push @{ $self->{queue} }, $cb;	587	push @{ $self->{queue} }, $cb;
484	$self->_drain_rbuf;	588	$self->_drain_rbuf;
485	}	589	}
486		590
487	sub unshift_read {	591	sub unshift_read {
488	my ($self, $cb) = @_;	592	my $self = shift;
		593	my $cb = pop;
489		594
		595	if (@_) {
		596	my $type = shift;
		597
		598	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")
		599	->($self, $cb, @_);
		600	}
		601
		602
490	push @{ $self->{queue} }, $cb;	603	unshift @{ $self->{queue} }, $cb;
491	$self->_drain_rbuf;	604	$self->_drain_rbuf;
492	}	605	}
493		606
494	=item $handle->push_read_chunk ($len, $cb->($self, $data))	607	=item $handle->push_read (type => @args, $cb)
495		608
496	=item $handle->unshift_read_chunk ($len, $cb->($self, $data))	609	=item $handle->unshift_read (type => @args, $cb)
497		610
498	Append the given callback to the end of the queue (C<push_read_chunk>) or	611	Instead of providing a callback that parses the data itself you can chose
499	prepend it (C<unshift_read_chunk>).	612	between a number of predefined parsing formats, for chunks of data, lines
		613	etc.
500		614
501	The callback will be called only once C<$len> bytes have been read, and	615	Predefined types are (if you have ideas for additional types, feel free to
502	these C<$len> bytes will be passed to the callback.	616	drop by and tell us):
503		617
504	=cut	618	=over 4
505		619
506	sub _read_chunk($$) {	620	=item chunk => $octets, $cb->($self, $data)
		621
		622	Invoke the callback only once C<$octets> bytes have been read. Pass the
		623	data read to the callback. The callback will never be called with less
		624	data.
		625
		626	Example: read 2 bytes.
		627
		628	$handle->push_read (chunk => 2, sub {
		629	warn "yay ", unpack "H*", $_[1];
		630	});
		631
		632	=cut
		633
		634	register_read_type chunk => sub {
507	my ($self, $len, $cb) = @_;	635	my ($self, $cb, $len) = @_;
508		636
509	sub {	637	sub {
510	$len <= length $_[0]{rbuf} or return;	638	$len <= length $_[0]{rbuf} or return;
511	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");	639	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");
512	1	640	1
513	}	641	}
514	}	642	};
515		643
		644	# compatibility with older API
516	sub push_read_chunk {	645	sub push_read_chunk {
517	$_[0]->push_read (&_read_chunk);	646	$_[0]->push_read (chunk => $_[1], $_[2]);
518	}	647	}
519
520		648
521	sub unshift_read_chunk {	649	sub unshift_read_chunk {
522	$_[0]->unshift_read (&_read_chunk);	650	$_[0]->unshift_read (chunk => $_[1], $_[2]);
523	}	651	}
524		652
525	=item $handle->push_read_line ([$eol, ]$cb->($self, $line, $eol))	653	=item line => [$eol, ]$cb->($self, $line, $eol)
526
527	=item $handle->unshift_read_line ([$eol, ]$cb->($self, $line, $eol))
528
529	Append the given callback to the end of the queue (C<push_read_line>) or
530	prepend it (C<unshift_read_line>).
531		654
532	The callback will be called only once a full line (including the end of	655	The callback will be called only once a full line (including the end of
533	line marker, C<$eol>) has been read. This line (excluding the end of line	656	line marker, C<$eol>) has been read. This line (excluding the end of line
534	marker) will be passed to the callback as second argument (C<$line>), and	657	marker) will be passed to the callback as second argument (C<$line>), and
535	the end of line marker as the third argument (C<$eol>).	658	the end of line marker as the third argument (C<$eol>).
…		…
546	Partial lines at the end of the stream will never be returned, as they are	669	Partial lines at the end of the stream will never be returned, as they are
547	not marked by the end of line marker.	670	not marked by the end of line marker.
548		671
549	=cut	672	=cut
550		673
551	sub _read_line($$) {	674	register_read_type line => sub {
552	my $self = shift;	675	my ($self, $cb, $eol) = @_;
553	my $cb = pop;
554	my $eol = @_ ? shift : qr\|(\015?\012)\|;
555	my $pos;
556		676
		677	$eol = qr\|(\015?\012)\| if @_ < 3;
557	$eol = quotemeta $eol unless ref $eol;	678	$eol = quotemeta $eol unless ref $eol;
558	$eol = qr\|^(.*?)($eol)\|s;	679	$eol = qr\|^(.*?)($eol)\|s;
559		680
560	sub {	681	sub {
561	$_[0]{rbuf} =~ s/$eol// or return;	682	$_[0]{rbuf} =~ s/$eol// or return;
562		683
563	$cb->($_[0], $1, $2);	684	$cb->($_[0], $1, $2);
564	1	685	1
565	}	686	}
566	}	687	};
567		688
		689	# compatibility with older API
568	sub push_read_line {	690	sub push_read_line {
569	$_[0]->push_read (&_read_line);	691	my $self = shift;
		692	$self->push_read (line => @_);
570	}	693	}
571		694
572	sub unshift_read_line {	695	sub unshift_read_line {
573	$_[0]->unshift_read (&_read_line);	696	my $self = shift;
		697	$self->unshift_read (line => @_);
574	}	698	}
		699
		700	=item netstring => $cb->($string)
		701
		702	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
		703
		704	Throws an error with C<$!> set to EBADMSG on format violations.
		705
		706	=cut
		707
		708	register_read_type netstring => sub {
		709	my ($self, $cb) = @_;
		710
		711	sub {
		712	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
		713	if ($_[0]{rbuf} =~ /[^0-9]/) {
		714	$! = &Errno::EBADMSG;
		715	$self->error;
		716	}
		717	return;
		718	}
		719
		720	my $len = $1;
		721
		722	$self->unshift_read (chunk => $len, sub {
		723	my $string = $_[1];
		724	$_[0]->unshift_read (chunk => 1, sub {
		725	if ($_[1] eq ",") {
		726	$cb->($_[0], $string);
		727	} else {
		728	$! = &Errno::EBADMSG;
		729	$self->error;
		730	}
		731	});
		732	});
		733
		734	1
		735	}
		736	};
		737
		738	=item regex => $accept[, $reject[, $skip], $cb->($data)
		739
		740	Makes a regex match against the regex object C<$accept> and returns
		741	everything up to and including the match.
		742
		743	Example: read a single line terminated by '\n'.
		744
		745	$handle->push_read (regex => qr<\n>, sub { ... });
		746
		747	If C<$reject> is given and not undef, then it determines when the data is
		748	to be rejected: it is matched against the data when the C<$accept> regex
		749	does not match and generates an C<EBADMSG> error when it matches. This is
		750	useful to quickly reject wrong data (to avoid waiting for a timeout or a
		751	receive buffer overflow).
		752
		753	Example: expect a single decimal number followed by whitespace, reject
		754	anything else (not the use of an anchor).
		755
		756	$handle->push_read (regex => qr<^[0-9]+\s>, qr<[^0-9]>, sub { ... });
		757
		758	If C<$skip> is given and not C<undef>, then it will be matched against
		759	the receive buffer when neither C<$accept> nor C<$reject> match,
		760	and everything preceding and including the match will be accepted
		761	unconditionally. This is useful to skip large amounts of data that you
		762	know cannot be matched, so that the C<$accept> or C<$reject> regex do not
		763	have to start matching from the beginning. This is purely an optimisation
		764	and is usually worth only when you expect more than a few kilobytes.
		765
		766	Example: expect a http header, which ends at C<\015\012\015\012>. Since we
		767	expect the header to be very large (it isn't in practise, but...), we use
		768	a skip regex to skip initial portions. The skip regex is tricky in that
		769	it only accepts something not ending in either \015 or \012, as these are
		770	required for the accept regex.
		771
		772	$handle->push_read (regex =>
		773	qr<\015\012\015\012>,
		774	undef, # no reject
		775	qr<^.*[^\015\012]>,
		776	sub { ... });
		777
		778	=cut
		779
		780	register_read_type regex => sub {
		781	my ($self, $cb, $accept, $reject, $skip) = @_;
		782
		783	my $data;
		784	my $rbuf = \$self->{rbuf};
		785
		786	sub {
		787	# accept
		788	if ($$rbuf =~ $accept) {
		789	$data .= substr $$rbuf, 0, $+[0], "";
		790	$cb->($self, $data);
		791	return 1;
		792	}
		793
		794	# reject
		795	if ($reject && $$rbuf =~ $reject) {
		796	$! = &Errno::EBADMSG;
		797	$self->error;
		798	}
		799
		800	# skip
		801	if ($skip && $$rbuf =~ $skip) {
		802	$data .= substr $$rbuf, 0, $+[0], "";
		803	}
		804
		805	()
		806	}
		807	};
		808
		809	=back
		810
		811	=item AnyEvent::Handle::register_read_type type => $coderef->($self, $cb, @args)
		812
		813	This function (not method) lets you add your own types to C<push_read>.
		814
		815	Whenever the given C<type> is used, C<push_read> will invoke the code
		816	reference with the handle object, the callback and the remaining
		817	arguments.
		818
		819	The code reference is supposed to return a callback (usually a closure)
		820	that works as a plain read callback (see C<< ->push_read ($cb) >>).
		821
		822	It should invoke the passed callback when it is done reading (remember to
		823	pass C<$self> as first argument as all other callbacks do that).
		824
		825	Note that this is a function, and all types registered this way will be
		826	global, so try to use unique names.
		827
		828	For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>,
		829	search for C<register_read_type>)).
575		830
576	=item $handle->stop_read	831	=item $handle->stop_read
577		832
578	=item $handle->start_read	833	=item $handle->start_read
579		834
580	In rare cases you actually do not want to read anything from the	835	In rare cases you actually do not want to read anything from the
581	socket. In this case you can call C<stop_read>. Neither C<on_read> no	836	socket. In this case you can call C<stop_read>. Neither C<on_read> no
582	any queued callbacks will be executed then. To start readign again, call	837	any queued callbacks will be executed then. To start reading again, call
583	C<start_read>.	838	C<start_read>.
584		839
585	=cut	840	=cut
586		841
587	sub stop_read {	842	sub stop_read {
…		…
608	} elsif (defined $len) {	863	} elsif (defined $len) {
609	delete $self->{rw};	864	delete $self->{rw};
610	$self->{eof} = 1;	865	$self->{eof} = 1;
611	$self->_drain_rbuf;	866	$self->_drain_rbuf;
612		867
613	} elsif ($! != EAGAIN && $! != EINTR) {	868	} elsif ($! != EAGAIN && $! != EINTR && $! != &AnyEvent::Util::WSAWOULDBLOCK) {
614	return $self->error;	869	return $self->error;
615	}	870	}
616	});	871	});
617	}	872	}
618	}	873	}
619		874
		875	sub _dotls {
		876	my ($self) = @_;
		877
		878	if (length $self->{tls_wbuf}) {
		879	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{tls_wbuf})) > 0) {
		880	substr $self->{tls_wbuf}, 0, $len, "";
		881	}
		882	}
		883
		884	if (defined (my $buf = Net::SSLeay::BIO_read ($self->{tls_wbio}))) {
		885	$self->{wbuf} .= $buf;
		886	$self->_drain_wbuf;
		887	}
		888
		889	while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) {
		890	$self->{rbuf} .= $buf;
		891	$self->_drain_rbuf;
		892	}
		893
		894	my $err = Net::SSLeay::get_error ($self->{tls}, -1);
		895
		896	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
		897	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {
		898	$self->error;
		899	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {
		900	$! = &Errno::EIO;
		901	$self->error;
		902	}
		903
		904	# all others are fine for our purposes
		905	}
		906	}
		907
		908	=item $handle->starttls ($tls[, $tls_ctx])
		909
		910	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
		911	object is created, you can also do that at a later time by calling
		912	C<starttls>.
		913
		914	The first argument is the same as the C<tls> constructor argument (either
		915	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
		916
		917	The second argument is the optional C<Net::SSLeay::CTX> object that is
		918	used when AnyEvent::Handle has to create its own TLS connection object.
		919
		920	=cut
		921
		922	# TODO: maybe document...
		923	sub starttls {
		924	my ($self, $ssl, $ctx) = @_;
		925
		926	$self->stoptls;
		927
		928	if ($ssl eq "accept") {
		929	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());
		930	Net::SSLeay::set_accept_state ($ssl);
		931	} elsif ($ssl eq "connect") {
		932	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());
		933	Net::SSLeay::set_connect_state ($ssl);
		934	}
		935
		936	$self->{tls} = $ssl;
		937
		938	# basically, this is deep magic (because SSL_read should have the same issues)
		939	# but the openssl maintainers basically said: "trust us, it just works".
		940	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
		941	# and mismaintained ssleay-module doesn't even offer them).
		942	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
		943	Net::SSLeay::CTX_set_mode ($self->{tls},
		944	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
		945	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
		946
		947	$self->{tls_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
		948	$self->{tls_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
		949
		950	Net::SSLeay::set_bio ($ssl, $self->{tls_rbio}, $self->{tls_wbio});
		951
		952	$self->{filter_w} = sub {
		953	$_[0]{tls_wbuf} .= ${$_[1]};
		954	&_dotls;
		955	};
		956	$self->{filter_r} = sub {
		957	Net::SSLeay::BIO_write ($_[0]{tls_rbio}, ${$_[1]});
		958	&_dotls;
		959	};
		960	}
		961
		962	=item $handle->stoptls
		963
		964	Destroys the SSL connection, if any. Partial read or write data will be
		965	lost.
		966
		967	=cut
		968
		969	sub stoptls {
		970	my ($self) = @_;
		971
		972	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};
		973	delete $self->{tls_rbio};
		974	delete $self->{tls_wbio};
		975	delete $self->{tls_wbuf};
		976	delete $self->{filter_r};
		977	delete $self->{filter_w};
		978	}
		979
		980	sub DESTROY {
		981	my $self = shift;
		982
		983	$self->stoptls;
		984	}
		985
		986	=item AnyEvent::Handle::TLS_CTX
		987
		988	This function creates and returns the Net::SSLeay::CTX object used by
		989	default for TLS mode.
		990
		991	The context is created like this:
		992
		993	Net::SSLeay::load_error_strings;
		994	Net::SSLeay::SSLeay_add_ssl_algorithms;
		995	Net::SSLeay::randomize;
		996
		997	my $CTX = Net::SSLeay::CTX_new;
		998
		999	Net::SSLeay::CTX_set_options $CTX, Net::SSLeay::OP_ALL
		1000
		1001	=cut
		1002
		1003	our $TLS_CTX;
		1004
		1005	sub TLS_CTX() {
		1006	$TLS_CTX \|\| do {
		1007	require Net::SSLeay;
		1008
		1009	Net::SSLeay::load_error_strings ();
		1010	Net::SSLeay::SSLeay_add_ssl_algorithms ();
		1011	Net::SSLeay::randomize ();
		1012
		1013	$TLS_CTX = Net::SSLeay::CTX_new ();
		1014
		1015	Net::SSLeay::CTX_set_options ($TLS_CTX, Net::SSLeay::OP_ALL ());
		1016
		1017	$TLS_CTX
		1018	}
		1019	}
		1020
620	=back	1021	=back
621		1022
622	=head1 AUTHOR	1023	=head1 AUTHOR
623		1024
624	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.	1025	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.18 by root, Sat May 24 05:01:16 2008 UTC vs. Revision 1.36 by root, Mon May 26 18:26:52 2008 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.18 by root, Sat May 24 05:01:16 2008 UTC vs.
Revision 1.36 by root, Mon May 26 18:26:52 2008 UTC