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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.12 by elmex, Thu May 15 09:03:43 2008 UTC vs.
Revision 1.32 by root, Sun May 25 01:10:54 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(WSAEAGAIN);
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		16
17	=cut	17	=cut
18		18
19	our $VERSION = '0.02';	19	our $VERSION = '0.04';
20		20
21	=head1 SYNOPSIS	21	=head1 SYNOPSIS
22		22
23	use AnyEvent;	23	use AnyEvent;
24	use AnyEvent::Handle;	24	use AnyEvent::Handle;
25		25
26	my $cv = AnyEvent->condvar;	26	my $cv = AnyEvent->condvar;
27		27
28	my $ae_fh = AnyEvent::Handle->new (fh => \*STDIN);	28	my $handle =
29
30	#TODO
31
32	# or use the constructor to pass the callback:
33
34	my $ae_fh2 =
35	AnyEvent::Handle->new (	29	AnyEvent::Handle->new (
36	fh => \*STDIN,	30	fh => \*STDIN,
37	on_eof => sub {	31	on_eof => sub {
38	$cv->broadcast;	32	$cv->broadcast;
39	},	33	},
40	#TODO
41	);	34	);
42		35
43	$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;
44		47
45	=head1 DESCRIPTION	48	=head1 DESCRIPTION
46		49
47	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
48	filehandles (and sockets, see L<AnyEvent::Socket> for an easy way to make	51	filehandles. For utility functions for doing non-blocking connects and accepts
49	non-blocking resolves and connects).	52	on sockets see L<AnyEvent::Util>.
50		53
51	In the following, when the documentation refers to of "bytes" then this	54	In the following, when the documentation refers to of "bytes" then this
52	means characters. As sysread and syswrite are used for all I/O, their	55	means characters. As sysread and syswrite are used for all I/O, their
53	treatment of characters applies to this module as well.	56	treatment of characters applies to this module as well.
54		57
…		…
70	The filehandle this L<AnyEvent::Handle> object will operate on.	73	The filehandle this L<AnyEvent::Handle> object will operate on.
71		74
72	NOTE: The filehandle will be set to non-blocking (using	75	NOTE: The filehandle will be set to non-blocking (using
73	AnyEvent::Util::fh_nonblocking).	76	AnyEvent::Util::fh_nonblocking).
74		77
75	=item on_eof => $cb->($self) [MANDATORY]	78	=item on_eof => $cb->($self)
76		79
77	Set the callback to be called on EOF.	80	Set the callback to be called on EOF.
78		81
		82	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
		84	waiting for data.
		85
79	=item on_error => $cb->($self)	86	=item on_error => $cb->($self)
80		87
81	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
82	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
83	or a read error.	90	or a read error.
84		91
85	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
86	called.	93	called.
87		94
88	On callback entrance, the value of C<$!> contains the operating system	95	On callback entrance, the value of C<$!> contains the operating system
89	error (or C<ENOSPC> or C<EPIPE>).	96	error (or C<ENOSPC>, C<EPIPE> or C<EBADMSG>).
90		97
91	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
92	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
93	die.	100	die.
94		101
…		…
96		103
97	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
98	and no read request is in the queue.	105	and no read request is in the queue.
99		106
100	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 >>
101	method or acces sthe C<$self->{rbuf}> member directly.	108	method or access the C<$self->{rbuf}> member directly.
102		109
103	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
104	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
105	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
106	error will be raised (with C<$!> set to C<EPIPE>).	113	error will be raised (with C<$!> set to C<EPIPE>).
…		…
133		140
134	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
135	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
136	considered empty.	143	considered empty.
137		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
138	=back	170	=back
139		171
140	=cut	172	=cut
141		173
142	sub new {	174	sub new {
…		…
146		178
147	$self->{fh} or Carp::croak "mandatory argument fh is missing";	179	$self->{fh} or Carp::croak "mandatory argument fh is missing";
148		180
149	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	181	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
150		182
151	$self->on_eof ((delete $self->{on_eof} ) or Carp::croak "mandatory argument on_eof is missing");	183	if ($self->{tls}) {
		184	require Net::SSLeay;
		185	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});
		186	}
152		187
		188	$self->on_eof (delete $self->{on_eof} ) if $self->{on_eof};
153	$self->on_error (delete $self->{on_error}) if $self->{on_error};	189	$self->on_error (delete $self->{on_error}) if $self->{on_error};
154	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	190	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
155	$self->on_read (delete $self->{on_read} ) if $self->{on_read};	191	$self->on_read (delete $self->{on_read} ) if $self->{on_read};
156		192
157	$self->start_read;	193	$self->start_read;
…		…
176	}	212	}
177		213
178	if ($self->{on_error}) {	214	if ($self->{on_error}) {
179	$self->{on_error}($self);	215	$self->{on_error}($self);
180	} else {	216	} else {
181	die "AnyEvent::Handle uncaught fatal error: $!";	217	Carp::croak "AnyEvent::Handle uncaught fatal error: $!";
182	}	218	}
183	}	219	}
184		220
185	=item $fh = $handle->fh	221	=item $fh = $handle->fh
186		222
187	This method returns the filehandle of the L<AnyEvent::Handle> object.	223	This method returns the file handle of the L<AnyEvent::Handle> object.
188		224
189	=cut	225	=cut
190		226
191	sub fh { $_[0]->{fh} }	227	sub fh { $_[0]->{fh} }
192		228
…		…
220	for reading.	256	for reading.
221		257
222	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
223	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.
224		260
225	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
226	water mark, the C<on_drain> callback will be invoked.	262	water mark, the C<on_drain> callback will be invoked.
227		263
228	=over 4	264	=over 4
229		265
230	=item $handle->on_drain ($cb)	266	=item $handle->on_drain ($cb)
…		…
249	want (only limited by the available memory), as C<AnyEvent::Handle>	285	want (only limited by the available memory), as C<AnyEvent::Handle>
250	buffers it independently of the kernel.	286	buffers it independently of the kernel.
251		287
252	=cut	288	=cut
253		289
254	sub push_write {	290	sub _drain_wbuf {
255	my ($self, $data) = @_;	291	my ($self) = @_;
256		292
257	$self->{wbuf} .= $data;	293	if (!$self->{ww} && length $self->{wbuf}) {
258
259	unless ($self->{ww}) {
260	Scalar::Util::weaken $self;	294	Scalar::Util::weaken $self;
261	my $cb = sub {	295	my $cb = sub {
262	my $len = syswrite $self->{fh}, $self->{wbuf};	296	my $len = syswrite $self->{fh}, $self->{wbuf};
263		297
264	if ($len > 0) {	298	if ($len >= 0) {
265	substr $self->{wbuf}, 0, $len, "";	299	substr $self->{wbuf}, 0, $len, "";
266
267		300
268	$self->{on_drain}($self)	301	$self->{on_drain}($self)
269	if $self->{low_water_mark} >= length $self->{wbuf}	302	if $self->{low_water_mark} >= length $self->{wbuf}
270	&& $self->{on_drain};	303	&& $self->{on_drain};
271		304
272	delete $self->{ww} unless length $self->{wbuf};	305	delete $self->{ww} unless length $self->{wbuf};
273	} elsif ($! != EAGAIN && $! != EINTR) {	306	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEAGAIN) {
274	$self->error;	307	$self->error;
275	}	308	}
276	};	309	};
277		310
278	$self->{ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb);	311	$self->{ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb);
279		312
280	$cb->($self);	313	$cb->($self);
281	};	314	};
282	}	315	}
		316
		317	our %WH;
		318
		319	sub register_write_type($$) {
		320	$WH{$_[0]} = $_[1];
		321	}
		322
		323	sub push_write {
		324	my $self = shift;
		325
		326	if (@_ > 1) {
		327	my $type = shift;
		328
		329	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")
		330	->($self, @_);
		331	}
		332
		333	if ($self->{filter_w}) {
		334	$self->{filter_w}->($self, \$_[0]);
		335	} else {
		336	$self->{wbuf} .= $_[0];
		337	$self->_drain_wbuf;
		338	}
		339	}
		340
		341	=item $handle->push_write (type => @args)
		342
		343	=item $handle->unshift_write (type => @args)
		344
		345	Instead of formatting your data yourself, you can also let this module do
		346	the job by specifying a type and type-specific arguments.
		347
		348	Predefined types are (if you have ideas for additional types, feel free to
		349	drop by and tell us):
		350
		351	=over 4
		352
		353	=item netstring => $string
		354
		355	Formats the given value as netstring
		356	(http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them).
		357
		358	=back
		359
		360	=cut
		361
		362	register_write_type netstring => sub {
		363	my ($self, $string) = @_;
		364
		365	sprintf "%d:%s,", (length $string), $string
		366	};
		367
		368	=item AnyEvent::Handle::register_write_type type => $coderef->($self, @args)
		369
		370	This function (not method) lets you add your own types to C<push_write>.
		371	Whenever the given C<type> is used, C<push_write> will invoke the code
		372	reference with the handle object and the remaining arguments.
		373
		374	The code reference is supposed to return a single octet string that will
		375	be appended to the write buffer.
		376
		377	Note that this is a function, and all types registered this way will be
		378	global, so try to use unique names.
		379
		380	=cut
283		381
284	#############################################################################	382	#############################################################################
285		383
286	=back	384	=back
287		385
…		…
362	=cut	460	=cut
363		461
364	sub _drain_rbuf {	462	sub _drain_rbuf {
365	my ($self) = @_;	463	my ($self) = @_;
366		464
		465	if (
		466	defined $self->{rbuf_max}
		467	&& $self->{rbuf_max} < length $self->{rbuf}
		468	) {
		469	$! = &Errno::ENOSPC; return $self->error;
		470	}
		471
367	return if $self->{in_drain};	472	return if $self->{in_drain};
368	local $self->{in_drain} = 1;	473	local $self->{in_drain} = 1;
369		474
370	while (my $len = length $self->{rbuf}) {	475	while (my $len = length $self->{rbuf}) {
371	no strict 'refs';	476	no strict 'refs';
372	if (my $cb = shift @{ $self->{queue} }) {	477	if (my $cb = shift @{ $self->{queue} }) {
373	if (!$cb->($self)) {	478	unless ($cb->($self)) {
374	if ($self->{eof}) {	479	if ($self->{eof}) {
375	# no progress can be made (not enough data and no data forthcoming)	480	# no progress can be made (not enough data and no data forthcoming)
376	$! = &Errno::EPIPE; return $self->error;	481	$! = &Errno::EPIPE; return $self->error;
377	}	482	}
378		483
…		…
398	}	503	}
399	}	504	}
400		505
401	if ($self->{eof}) {	506	if ($self->{eof}) {
402	$self->_shutdown;	507	$self->_shutdown;
403	$self->{on_eof}($self);	508	$self->{on_eof}($self)
		509	if $self->{on_eof};
404	}	510	}
405	}	511	}
406		512
407	=item $handle->on_read ($cb)	513	=item $handle->on_read ($cb)
408		514
…		…
442	Append the given callback to the end of the queue (C<push_read>) or	548	Append the given callback to the end of the queue (C<push_read>) or
443	prepend it (C<unshift_read>).	549	prepend it (C<unshift_read>).
444		550
445	The callback is called each time some additional read data arrives.	551	The callback is called each time some additional read data arrives.
446		552
447	It must check wether enough data is in the read buffer already.	553	It must check whether enough data is in the read buffer already.
448		554
449	If not enough data is available, it must return the empty list or a false	555	If not enough data is available, it must return the empty list or a false
450	value, in which case it will be called repeatedly until enough data is	556	value, in which case it will be called repeatedly until enough data is
451	available (or an error condition is detected).	557	available (or an error condition is detected).
452		558
…		…
454	interested in (which can be none at all) and return a true value. After returning	560	interested in (which can be none at all) and return a true value. After returning
455	true, it will be removed from the queue.	561	true, it will be removed from the queue.
456		562
457	=cut	563	=cut
458		564
		565	our %RH;
		566
		567	sub register_read_type($$) {
		568	$RH{$_[0]} = $_[1];
		569	}
		570
459	sub push_read {	571	sub push_read {
460	my ($self, $cb) = @_;	572	my $self = shift;
		573	my $cb = pop;
		574
		575	if (@_) {
		576	my $type = shift;
		577
		578	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
		579	->($self, $cb, @_);
		580	}
461		581
462	push @{ $self->{queue} }, $cb;	582	push @{ $self->{queue} }, $cb;
463	$self->_drain_rbuf;	583	$self->_drain_rbuf;
464	}	584	}
465		585
466	sub unshift_read {	586	sub unshift_read {
467	my ($self, $cb) = @_;	587	my $self = shift;
		588	my $cb = pop;
468		589
		590	if (@_) {
		591	my $type = shift;
		592
		593	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")
		594	->($self, $cb, @_);
		595	}
		596
		597
469	push @{ $self->{queue} }, $cb;	598	unshift @{ $self->{queue} }, $cb;
470	$self->_drain_rbuf;	599	$self->_drain_rbuf;
471	}	600	}
472		601
473	=item $handle->push_read_chunk ($len, $cb->($self, $data))	602	=item $handle->push_read (type => @args, $cb)
474		603
475	=item $handle->unshift_read_chunk ($len, $cb->($self, $data))	604	=item $handle->unshift_read (type => @args, $cb)
476		605
477	Append the given callback to the end of the queue (C<push_read_chunk>) or	606	Instead of providing a callback that parses the data itself you can chose
478	prepend it (C<unshift_read_chunk>).	607	between a number of predefined parsing formats, for chunks of data, lines
		608	etc.
479		609
480	The callback will be called only once C<$len> bytes have been read, and	610	Predefined types are (if you have ideas for additional types, feel free to
481	these C<$len> bytes will be passed to the callback.	611	drop by and tell us):
482		612
483	=cut	613	=over 4
484		614
485	sub _read_chunk($$) {	615	=item chunk => $octets, $cb->($self, $data)
		616
		617	Invoke the callback only once C<$octets> bytes have been read. Pass the
		618	data read to the callback. The callback will never be called with less
		619	data.
		620
		621	Example: read 2 bytes.
		622
		623	$handle->push_read (chunk => 2, sub {
		624	warn "yay ", unpack "H*", $_[1];
		625	});
		626
		627	=cut
		628
		629	register_read_type chunk => sub {
486	my ($self, $len, $cb) = @_;	630	my ($self, $cb, $len) = @_;
487		631
488	sub {	632	sub {
489	$len <= length $_[0]{rbuf} or return;	633	$len <= length $_[0]{rbuf} or return;
490	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");	634	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");
491	1	635	1
492	}	636	}
493	}	637	};
494		638
		639	# compatibility with older API
495	sub push_read_chunk {	640	sub push_read_chunk {
496	$_[0]->push_read (&_read_chunk);	641	$_[0]->push_read (chunk => $_[1], $_[2]);
497	}	642	}
498
499		643
500	sub unshift_read_chunk {	644	sub unshift_read_chunk {
501	$_[0]->unshift_read (&_read_chunk);	645	$_[0]->unshift_read (chunk => $_[1], $_[2]);
502	}	646	}
503		647
504	=item $handle->push_read_line ([$eol, ]$cb->($self, $line, $eol))	648	=item line => [$eol, ]$cb->($self, $line, $eol)
505
506	=item $handle->unshift_read_line ([$eol, ]$cb->($self, $line, $eol))
507
508	Append the given callback to the end of the queue (C<push_read_line>) or
509	prepend it (C<unshift_read_line>).
510		649
511	The callback will be called only once a full line (including the end of	650	The callback will be called only once a full line (including the end of
512	line marker, C<$eol>) has been read. This line (excluding the end of line	651	line marker, C<$eol>) has been read. This line (excluding the end of line
513	marker) will be passed to the callback as second argument (C<$line>), and	652	marker) will be passed to the callback as second argument (C<$line>), and
514	the end of line marker as the third argument (C<$eol>).	653	the end of line marker as the third argument (C<$eol>).
…		…
525	Partial lines at the end of the stream will never be returned, as they are	664	Partial lines at the end of the stream will never be returned, as they are
526	not marked by the end of line marker.	665	not marked by the end of line marker.
527		666
528	=cut	667	=cut
529		668
530	sub _read_line($$) {	669	register_read_type line => sub {
531	my $self = shift;	670	my ($self, $cb, $eol) = @_;
532	my $cb = pop;
533	my $eol = @_ ? shift : qr\|(\015?\012)\|;
534	my $pos;
535		671
		672	$eol = qr\|(\015?\012)\| if @_ < 3;
536	$eol = qr\|(\Q$eol\E)\| unless ref $eol;	673	$eol = quotemeta $eol unless ref $eol;
537	$eol = qr\|^(.*?)($eol)\|;	674	$eol = qr\|^(.*?)($eol)\|s;
538		675
539	sub {	676	sub {
540	$_[0]{rbuf} =~ s/$eol// or return;	677	$_[0]{rbuf} =~ s/$eol// or return;
541		678
542	$cb->($_[0], $1, $2);	679	$cb->($_[0], $1, $2);
543	1	680	1
544	}	681	}
545	}	682	};
546		683
		684	# compatibility with older API
547	sub push_read_line {	685	sub push_read_line {
548	$_[0]->push_read (&_read_line);	686	my $self = shift;
		687	$self->push_read (line => @_);
549	}	688	}
550		689
551	sub unshift_read_line {	690	sub unshift_read_line {
552	$_[0]->unshift_read (&_read_line);	691	my $self = shift;
		692	$self->unshift_read (line => @_);
553	}	693	}
		694
		695	=item netstring => $cb->($string)
		696
		697	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
		698
		699	Throws an error with C<$!> set to EBADMSG on format violations.
		700
		701	=cut
		702
		703	register_read_type netstring => sub {
		704	my ($self, $cb) = @_;
		705
		706	sub {
		707	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
		708	if ($_[0]{rbuf} =~ /[^0-9]/) {
		709	$! = &Errno::EBADMSG;
		710	$self->error;
		711	}
		712	return;
		713	}
		714
		715	my $len = $1;
		716
		717	$self->unshift_read (chunk => $len, sub {
		718	my $string = $_[1];
		719	$_[0]->unshift_read (chunk => 1, sub {
		720	if ($_[1] eq ",") {
		721	$cb->($_[0], $string);
		722	} else {
		723	$! = &Errno::EBADMSG;
		724	$self->error;
		725	}
		726	});
		727	});
		728
		729	1
		730	}
		731	};
		732
		733	=back
		734
		735	=item AnyEvent::Handle::register_read_type type => $coderef->($self, $cb, @args)
		736
		737	This function (not method) lets you add your own types to C<push_read>.
		738
		739	Whenever the given C<type> is used, C<push_read> will invoke the code
		740	reference with the handle object, the callback and the remaining
		741	arguments.
		742
		743	The code reference is supposed to return a callback (usually a closure)
		744	that works as a plain read callback (see C<< ->push_read ($cb) >>).
		745
		746	It should invoke the passed callback when it is done reading (remember to
		747	pass C<$self> as first argument as all other callbacks do that).
		748
		749	Note that this is a function, and all types registered this way will be
		750	global, so try to use unique names.
		751
		752	For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>,
		753	search for C<register_read_type>)).
554		754
555	=item $handle->stop_read	755	=item $handle->stop_read
556		756
557	=item $handle->start_read	757	=item $handle->start_read
558		758
559	In rare cases you actually do not want to read anything form the	759	In rare cases you actually do not want to read anything from the
560	socket. In this case you can call C<stop_read>. Neither C<on_read> no	760	socket. In this case you can call C<stop_read>. Neither C<on_read> no
561	any queued callbacks will be executed then. To start readign again, call	761	any queued callbacks will be executed then. To start reading again, call
562	C<start_read>.	762	C<start_read>.
563		763
564	=cut	764	=cut
565		765
566	sub stop_read {	766	sub stop_read {
…		…
574		774
575	unless ($self->{rw} \|\| $self->{eof}) {	775	unless ($self->{rw} \|\| $self->{eof}) {
576	Scalar::Util::weaken $self;	776	Scalar::Util::weaken $self;
577		777
578	$self->{rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	778	$self->{rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
		779	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};
579	my $len = sysread $self->{fh}, $self->{rbuf}, $self->{read_size} \|\| 8192, length $self->{rbuf};	780	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;
580		781
581	if ($len > 0) {	782	if ($len > 0) {
582	if (defined $self->{rbuf_max}) {	783	$self->{filter_r}
583	if ($self->{rbuf_max} < length $self->{rbuf}) {	784	? $self->{filter_r}->($self, $rbuf)
584	$! = &Errno::ENOSPC; return $self->error;	785	: $self->_drain_rbuf;
585	}
586	}
587		786
588	} elsif (defined $len) {	787	} elsif (defined $len) {
		788	delete $self->{rw};
589	$self->{eof} = 1;	789	$self->{eof} = 1;
590	delete $self->{rw};	790	$self->_drain_rbuf;
591		791
592	} elsif ($! != EAGAIN && $! != EINTR) {	792	} elsif ($! != EAGAIN && $! != EINTR && $! != &AnyEvent::Util::WSAEAGAIN) {
593	return $self->error;	793	return $self->error;
594	}	794	}
595
596	$self->_drain_rbuf;
597	});	795	});
598	}	796	}
599	}	797	}
600		798
		799	sub _dotls {
		800	my ($self) = @_;
		801
		802	if (length $self->{tls_wbuf}) {
		803	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{tls_wbuf})) > 0) {
		804	substr $self->{tls_wbuf}, 0, $len, "";
		805	}
		806	}
		807
		808	if (defined (my $buf = Net::SSLeay::BIO_read ($self->{tls_wbio}))) {
		809	$self->{wbuf} .= $buf;
		810	$self->_drain_wbuf;
		811	}
		812
		813	while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) {
		814	$self->{rbuf} .= $buf;
		815	$self->_drain_rbuf;
		816	}
		817
		818	my $err = Net::SSLeay::get_error ($self->{tls}, -1);
		819
		820	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
		821	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {
		822	$self->error;
		823	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {
		824	$! = &Errno::EIO;
		825	$self->error;
		826	}
		827
		828	# all others are fine for our purposes
		829	}
		830	}
		831
		832	=item $handle->starttls ($tls[, $tls_ctx])
		833
		834	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
		835	object is created, you can also do that at a later time by calling
		836	C<starttls>.
		837
		838	The first argument is the same as the C<tls> constructor argument (either
		839	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
		840
		841	The second argument is the optional C<Net::SSLeay::CTX> object that is
		842	used when AnyEvent::Handle has to create its own TLS connection object.
		843
		844	=cut
		845
		846	# TODO: maybe document...
		847	sub starttls {
		848	my ($self, $ssl, $ctx) = @_;
		849
		850	$self->stoptls;
		851
		852	if ($ssl eq "accept") {
		853	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());
		854	Net::SSLeay::set_accept_state ($ssl);
		855	} elsif ($ssl eq "connect") {
		856	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());
		857	Net::SSLeay::set_connect_state ($ssl);
		858	}
		859
		860	$self->{tls} = $ssl;
		861
		862	# basically, this is deep magic (because SSL_read should have the same issues)
		863	# but the openssl maintainers basically said: "trust us, it just works".
		864	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
		865	# and mismaintained ssleay-module doesn't even offer them).
		866	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
		867	Net::SSLeay::CTX_set_mode ($self->{tls},
		868	(eval { Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
		869	\| (eval { Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
		870
		871	$self->{tls_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
		872	$self->{tls_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
		873
		874	Net::SSLeay::set_bio ($ssl, $self->{tls_rbio}, $self->{tls_wbio});
		875
		876	$self->{filter_w} = sub {
		877	$_[0]{tls_wbuf} .= ${$_[1]};
		878	&_dotls;
		879	};
		880	$self->{filter_r} = sub {
		881	Net::SSLeay::BIO_write ($_[0]{tls_rbio}, ${$_[1]});
		882	&_dotls;
		883	};
		884	}
		885
		886	=item $handle->stoptls
		887
		888	Destroys the SSL connection, if any. Partial read or write data will be
		889	lost.
		890
		891	=cut
		892
		893	sub stoptls {
		894	my ($self) = @_;
		895
		896	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};
		897	delete $self->{tls_rbio};
		898	delete $self->{tls_wbio};
		899	delete $self->{tls_wbuf};
		900	delete $self->{filter_r};
		901	delete $self->{filter_w};
		902	}
		903
		904	sub DESTROY {
		905	my $self = shift;
		906
		907	$self->stoptls;
		908	}
		909
		910	=item AnyEvent::Handle::TLS_CTX
		911
		912	This function creates and returns the Net::SSLeay::CTX object used by
		913	default for TLS mode.
		914
		915	The context is created like this:
		916
		917	Net::SSLeay::load_error_strings;
		918	Net::SSLeay::SSLeay_add_ssl_algorithms;
		919	Net::SSLeay::randomize;
		920
		921	my $CTX = Net::SSLeay::CTX_new;
		922
		923	Net::SSLeay::CTX_set_options $CTX, Net::SSLeay::OP_ALL
		924
		925	=cut
		926
		927	our $TLS_CTX;
		928
		929	sub TLS_CTX() {
		930	$TLS_CTX \|\| do {
		931	require Net::SSLeay;
		932
		933	Net::SSLeay::load_error_strings ();
		934	Net::SSLeay::SSLeay_add_ssl_algorithms ();
		935	Net::SSLeay::randomize ();
		936
		937	$TLS_CTX = Net::SSLeay::CTX_new ();
		938
		939	Net::SSLeay::CTX_set_options ($TLS_CTX, Net::SSLeay::OP_ALL ());
		940
		941	$TLS_CTX
		942	}
		943	}
		944
601	=back	945	=back
602		946
603	=head1 AUTHOR	947	=head1 AUTHOR
604		948
605	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.	949	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.12 by elmex, Thu May 15 09:03:43 2008 UTC vs. Revision 1.32 by root, Sun May 25 01:10:54 2008 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.12 by elmex, Thu May 15 09:03:43 2008 UTC vs.
Revision 1.32 by root, Sun May 25 01:10:54 2008 UTC