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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.5 by elmex, Mon Apr 28 08:01:05 2008 UTC vs.
Revision 1.29 by root, Sat May 24 23:10:18 2008 UTC

1	package AnyEvent::Handle;	1	package AnyEvent::Handle;
2		2
3	use warnings;	3	no warnings;
4	use strict;	4	use strict;
5		5
6	use AnyEvent;	6	use AnyEvent ();
7	use IO::Handle;	7	use AnyEvent::Util ();
		8	use Scalar::Util ();
		9	use Carp ();
		10	use Fcntl ();
8	use Errno qw/EAGAIN EINTR/;	11	use Errno qw/EAGAIN EINTR/;
9		12
10	=head1 NAME	13	=head1 NAME
11		14
12	AnyEvent::Handle - non-blocking I/O on filehandles via AnyEvent	15	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent
13		16
14	=head1 VERSION	17	This module is experimental.
15		18
16	Version 0.01
17
18	=cut	19	=cut
19		20
20	our $VERSION = '0.01';	21	our $VERSION = '0.04';
21		22
22	=head1 SYNOPSIS	23	=head1 SYNOPSIS
23		24
24	use AnyEvent;	25	use AnyEvent;
25	use AnyEvent::Handle;	26	use AnyEvent::Handle;
26		27
27	my $cv = AnyEvent->condvar;	28	my $cv = AnyEvent->condvar;
28		29
29	my $ae_fh = AnyEvent::Handle->new (fh => \*STDIN);	30	my $ae_fh = AnyEvent::Handle->new (fh => \*STDIN);
30		31
31	$ae_fh->on_eof (sub { $cv->broadcast });	32	#TODO
32
33	$ae_fh->readlines (sub {
34	my ($ae_fh, @lines) = @_;
35	for (@lines) {
36	chomp;
37	print "Line: $_";
38	}
39	});
40		33
41	# or use the constructor to pass the callback:	34	# or use the constructor to pass the callback:
42		35
43	my $ae_fh2 =	36	my $ae_fh2 =
44	AnyEvent::Handle->new (	37	AnyEvent::Handle->new (
45	fh => \*STDIN,	38	fh => \*STDIN,
46	on_eof => sub {	39	on_eof => sub {
47	$cv->broadcast;	40	$cv->broadcast;
48	},	41	},
49	on_readline => sub {	42	#TODO
50	my ($ae_fh, @lines) = @_;	43	);
51	for (@lines) {	44
52	chomp;	45	$cv->wait;
53	print "Line: $_";	46
		47	=head1 DESCRIPTION
		48
		49	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	on sockets see L<AnyEvent::Util>.
		52
		53	In the following, when the documentation refers to of "bytes" then this
		54	means characters. As sysread and syswrite are used for all I/O, their
		55	treatment of characters applies to this module as well.
		56
		57	All callbacks will be invoked with the handle object as their first
		58	argument.
		59
		60	=head1 METHODS
		61
		62	=over 4
		63
		64	=item B<new (%args)>
		65
		66	The constructor supports these arguments (all as key => value pairs).
		67
		68	=over 4
		69
		70	=item fh => $filehandle [MANDATORY]
		71
		72	The filehandle this L<AnyEvent::Handle> object will operate on.
		73
		74	NOTE: The filehandle will be set to non-blocking (using
		75	AnyEvent::Util::fh_nonblocking).
		76
		77	=item on_eof => $cb->($self)
		78
		79	Set the callback to be called on EOF.
		80
		81	While not mandatory, it is highly recommended to set an eof callback,
		82	otherwise you might end up with a closed socket while you are still
		83	waiting for data.
		84
		85	=item on_error => $cb->($self)
		86
		87	This is the fatal error callback, that is called when, well, a fatal error
		88	occurs, such as not being able to resolve the hostname, failure to connect
		89	or a read error.
		90
		91	The object will not be in a usable state when this callback has been
		92	called.
		93
		94	On callback entrance, the value of C<$!> contains the operating system
		95	error (or C<ENOSPC>, C<EPIPE> or C<EBADMSG>).
		96
		97	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	die.
		100
		101	=item on_read => $cb->($self)
		102
		103	This sets the default read callback, which is called when data arrives
		104	and no read request is in the queue.
		105
		106	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
		107	method or access the C<$self->{rbuf}> member directly.
		108
		109	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	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
		114	=item on_drain => $cb->()
		115
		116	This sets the callback that is called when the write buffer becomes empty
		117	(or when the callback is set and the buffer is empty already).
		118
		119	To append to the write buffer, use the C<< ->push_write >> method.
		120
		121	=item rbuf_max => <bytes>
		122
		123	If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)
		124	when the read buffer ever (strictly) exceeds this size. This is useful to
		125	avoid denial-of-service attacks.
		126
		127	For example, a server accepting connections from untrusted sources should
		128	be configured to accept only so-and-so much data that it cannot act on
		129	(for example, when expecting a line, an attacker could send an unlimited
		130	amount of data without a callback ever being called as long as the line
		131	isn't finished).
		132
		133	=item read_size => <bytes>
		134
		135	The default read block size (the amount of bytes this module will try to read
		136	on each [loop iteration). Default: C<4096>.
		137
		138	=item low_water_mark => <bytes>
		139
		140	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	considered empty.
		143
		144	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
		145
		146	When this parameter is given, it enables TLS (SSL) mode, that means it
		147	will start making tls handshake and will transparently encrypt/decrypt
		148	data.
		149
		150	TLS mode requires Net::SSLeay to be installed (it will be loaded
		151	automatically when you try to create a TLS handle).
		152
		153	For the TLS server side, use C<accept>, and for the TLS client side of a
		154	connection, use C<connect> mode.
		155
		156	You can also provide your own TLS connection object, but you have
		157	to make sure that you call either C<Net::SSLeay::set_connect_state>
		158	or C<Net::SSLeay::set_accept_state> on it before you pass it to
		159	AnyEvent::Handle.
		160
		161	See the C<starttls> method if you need to start TLs negotiation later.
		162
		163	=item tls_ctx => $ssl_ctx
		164
		165	Use the given Net::SSLeay::CTX object to create the new TLS connection
		166	(unless a connection object was specified directly). If this parameter is
		167	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
		168
		169	=back
		170
		171	=cut
		172
		173	our (%RH, %WH);
		174
		175	sub register_read_type($$) {
		176	$RH{$_[0]} = $_[1];
		177	}
		178
		179	sub register_write_type($$) {
		180	$WH{$_[0]} = $_[1];
		181	}
		182
		183	sub new {
		184	my $class = shift;
		185
		186	my $self = bless { @_ }, $class;
		187
		188	$self->{fh} or Carp::croak "mandatory argument fh is missing";
		189
		190	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
		191
		192	if ($self->{tls}) {
		193	require Net::SSLeay;
		194	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});
		195	}
		196
		197	$self->on_eof (delete $self->{on_eof} ) if $self->{on_eof};
		198	$self->on_error (delete $self->{on_error}) if $self->{on_error};
		199	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
		200	$self->on_read (delete $self->{on_read} ) if $self->{on_read};
		201
		202	$self->start_read;
		203
		204	$self
		205	}
		206
		207	sub _shutdown {
		208	my ($self) = @_;
		209
		210	delete $self->{rw};
		211	delete $self->{ww};
		212	delete $self->{fh};
		213	}
		214
		215	sub error {
		216	my ($self) = @_;
		217
		218	{
		219	local $!;
		220	$self->_shutdown;
		221	}
		222
		223	if ($self->{on_error}) {
		224	$self->{on_error}($self);
		225	} else {
		226	Carp::croak "AnyEvent::Handle uncaught fatal error: $!";
		227	}
		228	}
		229
		230	=item $fh = $handle->fh
		231
		232	This method returns the file handle of the L<AnyEvent::Handle> object.
		233
		234	=cut
		235
		236	sub fh { $_[0]->{fh} }
		237
		238	=item $handle->on_error ($cb)
		239
		240	Replace the current C<on_error> callback (see the C<on_error> constructor argument).
		241
		242	=cut
		243
		244	sub on_error {
		245	$_[0]{on_error} = $_[1];
		246	}
		247
		248	=item $handle->on_eof ($cb)
		249
		250	Replace the current C<on_eof> callback (see the C<on_eof> constructor argument).
		251
		252	=cut
		253
		254	sub on_eof {
		255	$_[0]{on_eof} = $_[1];
		256	}
		257
		258	#############################################################################
		259
		260	=back
		261
		262	=head2 WRITE QUEUE
		263
		264	AnyEvent::Handle manages two queues per handle, one for writing and one
		265	for reading.
		266
		267	The write queue is very simple: you can add data to its end, and
		268	AnyEvent::Handle will automatically try to get rid of it for you.
		269
		270	When data could be written and the write buffer is shorter then the low
		271	water mark, the C<on_drain> callback will be invoked.
		272
		273	=over 4
		274
		275	=item $handle->on_drain ($cb)
		276
		277	Sets the C<on_drain> callback or clears it (see the description of
		278	C<on_drain> in the constructor).
		279
		280	=cut
		281
		282	sub on_drain {
		283	my ($self, $cb) = @_;
		284
		285	$self->{on_drain} = $cb;
		286
		287	$cb->($self)
		288	if $cb && $self->{low_water_mark} >= length $self->{wbuf};
		289	}
		290
		291	=item $handle->push_write ($data)
		292
		293	Queues the given scalar to be written. You can push as much data as you
		294	want (only limited by the available memory), as C<AnyEvent::Handle>
		295	buffers it independently of the kernel.
		296
		297	=cut
		298
		299	sub _drain_wbuf {
		300	my ($self) = @_;
		301
		302	if (!$self->{ww} && length $self->{wbuf}) {
		303	Scalar::Util::weaken $self;
		304	my $cb = sub {
		305	my $len = syswrite $self->{fh}, $self->{wbuf};
		306
		307	if ($len >= 0) {
		308	substr $self->{wbuf}, 0, $len, "";
		309
		310	$self->{on_drain}($self)
		311	if $self->{low_water_mark} >= length $self->{wbuf}
		312	&& $self->{on_drain};
		313
		314	delete $self->{ww} unless length $self->{wbuf};
		315	} elsif ($! != EAGAIN && $! != EINTR) {
		316	$self->error;
		317	}
		318	};
		319
		320	$self->{ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb);
		321
		322	$cb->($self);
		323	};
		324	}
		325
		326	sub push_write {
		327	my $self = shift;
		328
		329	if (@_ > 1) {
		330	my $type = shift;
		331
		332	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")
		333	->($self, @_);
		334	}
		335
		336	if ($self->{filter_w}) {
		337	$self->{filter_w}->($self, \$_[0]);
		338	} else {
		339	$self->{wbuf} .= $_[0];
		340	$self->_drain_wbuf;
		341	}
		342	}
		343
		344	=item $handle->push_write (type => @args)
		345
		346	=item $handle->unshift_write (type => @args)
		347
		348	Instead of formatting your data yourself, you can also let this module do
		349	the job by specifying a type and type-specific arguments.
		350
		351	Predefined types are:
		352
		353	=over 4
		354
		355	=item netstring => $string
		356
		357	Formats the given value as netstring
		358	(http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them).
		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	=back
		369
		370	=cut
		371
		372
		373
		374	#############################################################################
		375
		376	=back
		377
		378	=head2 READ QUEUE
		379
		380	AnyEvent::Handle manages two queues per handle, one for writing and one
		381	for reading.
		382
		383	The read queue is more complex than the write queue. It can be used in two
		384	ways, the "simple" way, using only C<on_read> and the "complex" way, using
		385	a queue.
		386
		387	In the simple case, you just install an C<on_read> callback and whenever
		388	new data arrives, it will be called. You can then remove some data (if
		389	enough is there) from the read buffer (C<< $handle->rbuf >>) if you want
		390	or not.
		391
		392	In the more complex case, you want to queue multiple callbacks. In this
		393	case, AnyEvent::Handle will call the first queued callback each time new
		394	data arrives and removes it when it has done its job (see C<push_read>,
		395	below).
		396
		397	This way you can, for example, push three line-reads, followed by reading
		398	a chunk of data, and AnyEvent::Handle will execute them in order.
		399
		400	Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by
		401	the specified number of bytes which give an XML datagram.
		402
		403	# in the default state, expect some header bytes
		404	$handle->on_read (sub {
		405	# some data is here, now queue the length-header-read (4 octets)
		406	shift->unshift_read_chunk (4, sub {
		407	# header arrived, decode
		408	my $len = unpack "N", $_[1];
		409
		410	# now read the payload
		411	shift->unshift_read_chunk ($len, sub {
		412	my $xml = $_[1];
		413	# handle xml
		414	});
		415	});
		416	});
		417
		418	Example 2: Implement a client for a protocol that replies either with
		419	"OK" and another line or "ERROR" for one request, and 64 bytes for the
		420	second request. Due tot he availability of a full queue, we can just
		421	pipeline sending both requests and manipulate the queue as necessary in
		422	the callbacks:
		423
		424	# request one
		425	$handle->push_write ("request 1\015\012");
		426
		427	# we expect "ERROR" or "OK" as response, so push a line read
		428	$handle->push_read_line (sub {
		429	# if we got an "OK", we have to _prepend_ another line,
		430	# so it will be read before the second request reads its 64 bytes
		431	# which are already in the queue when this callback is called
		432	# we don't do this in case we got an error
		433	if ($_[1] eq "OK") {
		434	$_[0]->unshift_read_line (sub {
		435	my $response = $_[1];
		436	...
		437	});
		438	}
		439	});
		440
		441	# request two
		442	$handle->push_write ("request 2\015\012");
		443
		444	# simply read 64 bytes, always
		445	$handle->push_read_chunk (64, sub {
		446	my $response = $_[1];
		447	...
		448	});
		449
		450	=over 4
		451
		452	=cut
		453
		454	sub _drain_rbuf {
		455	my ($self) = @_;
		456
		457	if (
		458	defined $self->{rbuf_max}
		459	&& $self->{rbuf_max} < length $self->{rbuf}
		460	) {
		461	$! = &Errno::ENOSPC; return $self->error;
		462	}
		463
		464	return if $self->{in_drain};
		465	local $self->{in_drain} = 1;
		466
		467	while (my $len = length $self->{rbuf}) {
		468	no strict 'refs';
		469	if (my $cb = shift @{ $self->{queue} }) {
		470	unless ($cb->($self)) {
		471	if ($self->{eof}) {
		472	# no progress can be made (not enough data and no data forthcoming)
		473	$! = &Errno::EPIPE; return $self->error;
54	}	474	}
		475
		476	unshift @{ $self->{queue} }, $cb;
		477	return;
55	}	478	}
56	);
57
58	$cv->wait;
59
60	=head1 DESCRIPTION
61
62	This module is a helper module to make it easier to do non-blocking I/O
63	on filehandles (and sockets, see L<AnyEvent::Socket>).
64
65	The event loop is provided by L<AnyEvent>.
66
67	=head1 METHODS
68
69	=over 4
70
71	=item B<new (%args)>
72
73	The constructor has these arguments:
74
75	=over 4
76
77	=item fh => $filehandle
78
79	The filehandle this L<AnyEvent::Handle> object will operate on.
80
81	NOTE: The filehandle will be set to non-blocking.
82
83	=item read_block_size => $size
84
85	The default read block size use for reads via the C<on_read>
86	method.
87
88	=item on_read => $cb
89
90	=item on_eof => $cb
91
92	=item on_error => $cb
93
94	These are shortcuts, that will call the corresponding method and set the callback to C<$cb>.
95
96	=item on_readline => $cb
97
98	The C<readlines> method is called with the default seperator and C<$cb> as callback
99	for you.
100
101	=back
102
103	=cut
104
105	sub new {
106	my $this = shift;
107	my $class = ref($this) \|\| $this;
108	my $self = {
109	read_block_size => 4096,
110	rbuf => '',
111	@_
112	};
113	bless $self, $class;
114
115	$self->{fh}->blocking (0) if $self->{fh};
116
117	if ($self->{on_read}) {
118	$self->on_read ($self->{on_read});
119
120	} elsif ($self->{on_readline}) {	479	} elsif ($self->{on_read}) {
121	$self->readlines ($self->{on_readline});	480	$self->{on_read}($self);
122		481
		482	if (
		483	$self->{eof} # if no further data will arrive
		484	&& $len == length $self->{rbuf} # and no data has been consumed
		485	&& !@{ $self->{queue} } # and the queue is still empty
		486	&& $self->{on_read} # and we still want to read data
		487	) {
		488	# then no progress can be made
		489	$! = &Errno::EPIPE; return $self->error;
		490	}
		491	} else {
		492	# read side becomes idle
		493	delete $self->{rw};
		494	return;
		495	}
		496	}
		497
123	} elsif ($self->{on_eof}) {	498	if ($self->{eof}) {
124	$self->on_eof ($self->{on_eof});	499	$self->_shutdown;
125		500	$self->{on_eof}($self)
126	} elsif ($self->{on_error}) {	501	if $self->{on_eof};
127	$self->on_eof ($self->{on_error});
128	}	502	}
129
130	return $self
131	}	503	}
132		504
133	=item B<fh>	505	=item $handle->on_read ($cb)
134		506
135	This method returns the filehandle of the L<AnyEvent::Handle> object.	507	This replaces the currently set C<on_read> callback, or clears it (when
136		508	the new callback is C<undef>). See the description of C<on_read> in the
137	=cut	509	constructor.
138
139	sub fh { $_[0]->{fh} }
140
141	=item B<on_read ($callback)>
142
143	This method installs a C<$callback> that will be called
144	when new data arrived. You can access the read buffer via the C<rbuf>
145	method (see below).
146
147	The first argument of the C<$callback> will be the L<AnyEvent::Handle> object.
148		510
149	=cut	511	=cut
150		512
151	sub on_read {	513	sub on_read {
152	my ($self, $cb) = @_;	514	my ($self, $cb) = @_;
		515
153	$self->{on_read} = $cb;	516	$self->{on_read} = $cb;
		517	}
154		518
155	unless (defined $self->{on_read}) {	519	=item $handle->rbuf
156	delete $self->{on_read_w};	520
157	return;	521	Returns the read buffer (as a modifiable lvalue).
		522
		523	You can access the read buffer directly as the C<< ->{rbuf} >> member, if
		524	you want.
		525
		526	NOTE: The read buffer should only be used or modified if the C<on_read>,
		527	C<push_read> or C<unshift_read> methods are used. The other read methods
		528	automatically manage the read buffer.
		529
		530	=cut
		531
		532	sub rbuf : lvalue {
		533	$_[0]{rbuf}
		534	}
		535
		536	=item $handle->push_read ($cb)
		537
		538	=item $handle->unshift_read ($cb)
		539
		540	Append the given callback to the end of the queue (C<push_read>) or
		541	prepend it (C<unshift_read>).
		542
		543	The callback is called each time some additional read data arrives.
		544
		545	It must check whether enough data is in the read buffer already.
		546
		547	If not enough data is available, it must return the empty list or a false
		548	value, in which case it will be called repeatedly until enough data is
		549	available (or an error condition is detected).
		550
		551	If enough data was available, then the callback must remove all data it is
		552	interested in (which can be none at all) and return a true value. After returning
		553	true, it will be removed from the queue.
		554
		555	=cut
		556
		557	sub push_read {
		558	my $self = shift;
		559	my $cb = pop;
		560
		561	if (@_) {
		562	my $type = shift;
		563
		564	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
		565	->($self, $cb, @_);
		566	}
		567
		568	push @{ $self->{queue} }, $cb;
		569	$self->_drain_rbuf;
		570	}
		571
		572	sub unshift_read {
		573	my $self = shift;
		574	my $cb = pop;
		575
		576	if (@_) {
		577	my $type = shift;
		578
		579	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")
		580	->($self, $cb, @_);
		581	}
		582
		583
		584	unshift @{ $self->{queue} }, $cb;
		585	$self->_drain_rbuf;
		586	}
		587
		588	=item $handle->push_read (type => @args, $cb)
		589
		590	=item $handle->unshift_read (type => @args, $cb)
		591
		592	Instead of providing a callback that parses the data itself you can chose
		593	between a number of predefined parsing formats, for chunks of data, lines
		594	etc.
		595
		596	The types currently supported are:
		597
		598	=over 4
		599
		600	=item chunk => $octets, $cb->($self, $data)
		601
		602	Invoke the callback only once C<$octets> bytes have been read. Pass the
		603	data read to the callback. The callback will never be called with less
		604	data.
		605
		606	Example: read 2 bytes.
		607
		608	$handle->push_read (chunk => 2, sub {
		609	warn "yay ", unpack "H*", $_[1];
158	}	610	});
159		611
160	$self->{on_read_w} =	612	=cut
161	AnyEvent->io (poll => 'r', fh => $self->{fh}, cb => sub {	613
162	#d# warn "READ:[$self->{read_size}] $self->{read_block_size} : ".length ($self->{rbuf})."\n";	614	register_read_type chunk => sub {
163	my $rbuf_len = length $self->{rbuf};	615	my ($self, $cb, $len) = @_;
164	my $l;	616
165	if (defined $self->{read_size}) {	617	sub {
166	$l = sysread $self->{fh}, $self->{rbuf},	618	$len <= length $_[0]{rbuf} or return;
167	($self->{read_size} - $rbuf_len), $rbuf_len;	619	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");
168	} else {	620	1
169	$l = sysread $self->{fh}, $self->{rbuf}, $self->{read_block_size}, $rbuf_len;	621	}
		622	};
		623
		624	# compatibility with older API
		625	sub push_read_chunk {
		626	$_[0]->push_read (chunk => $_[1], $_[2]);
		627	}
		628
		629	sub unshift_read_chunk {
		630	$_[0]->unshift_read (chunk => $_[1], $_[2]);
		631	}
		632
		633	=item line => [$eol, ]$cb->($self, $line, $eol)
		634
		635	The callback will be called only once a full line (including the end of
		636	line marker, C<$eol>) has been read. This line (excluding the end of line
		637	marker) will be passed to the callback as second argument (C<$line>), and
		638	the end of line marker as the third argument (C<$eol>).
		639
		640	The end of line marker, C<$eol>, can be either a string, in which case it
		641	will be interpreted as a fixed record end marker, or it can be a regex
		642	object (e.g. created by C<qr>), in which case it is interpreted as a
		643	regular expression.
		644
		645	The end of line marker argument C<$eol> is optional, if it is missing (NOT
		646	undef), then C<qr\|\015?\012\|> is used (which is good for most internet
		647	protocols).
		648
		649	Partial lines at the end of the stream will never be returned, as they are
		650	not marked by the end of line marker.
		651
		652	=cut
		653
		654	register_read_type line => sub {
		655	my ($self, $cb, $eol) = @_;
		656
		657	$eol = qr\|(\015?\012)\| if @_ < 3;
		658	$eol = quotemeta $eol unless ref $eol;
		659	$eol = qr\|^(.*?)($eol)\|s;
		660
		661	sub {
		662	$_[0]{rbuf} =~ s/$eol// or return;
		663
		664	$cb->($_[0], $1, $2);
		665	1
		666	}
		667	};
		668
		669	# compatibility with older API
		670	sub push_read_line {
		671	my $self = shift;
		672	$self->push_read (line => @_);
		673	}
		674
		675	sub unshift_read_line {
		676	my $self = shift;
		677	$self->unshift_read (line => @_);
		678	}
		679
		680	=item netstring => $cb->($string)
		681
		682	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
		683
		684	Throws an error with C<$!> set to EBADMSG on format violations.
		685
		686	=cut
		687
		688	register_read_type netstring => sub {
		689	my ($self, $cb) = @_;
		690
		691	sub {
		692	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
		693	if ($_[0]{rbuf} =~ /[^0-9]/) {
		694	$! = &Errno::EBADMSG;
		695	$self->error;
170	}	696	}
171	#d# warn "READL $l [$self->{rbuf}]\n";	697	return;
		698	}
172		699
173	if (not defined $l) {	700	my $len = $1;
174	return if $! == EAGAIN \|\| $! == EINTR;
175	$self->{on_error}->($self) if $self->{on_error};
176	delete $self->{on_read_w};
177		701
178	} elsif ($l == 0) {	702	$self->unshift_read (chunk => $len, sub {
179	$self->{on_eof}->($self) if $self->{on_eof};	703	my $string = $_[1];
180	delete $self->{on_read_w};	704	$_[0]->unshift_read (chunk => 1, sub {
181		705	if ($_[1] eq ",") {
		706	$cb->($_[0], $string);
182	} else {	707	} else {
183	$self->{on_read}->($self);	708	$! = &Errno::EBADMSG;
		709	$self->error;
		710	}
		711	});
		712	});
		713
		714	1
		715	}
		716	};
		717
		718	=back
		719
		720	=item $handle->stop_read
		721
		722	=item $handle->start_read
		723
		724	In rare cases you actually do not want to read anything from the
		725	socket. In this case you can call C<stop_read>. Neither C<on_read> no
		726	any queued callbacks will be executed then. To start reading again, call
		727	C<start_read>.
		728
		729	=cut
		730
		731	sub stop_read {
		732	my ($self) = @_;
		733
		734	delete $self->{rw};
		735	}
		736
		737	sub start_read {
		738	my ($self) = @_;
		739
		740	unless ($self->{rw} \|\| $self->{eof}) {
		741	Scalar::Util::weaken $self;
		742
		743	$self->{rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
		744	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};
		745	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;
		746
		747	if ($len > 0) {
		748	$self->{filter_r}
		749	? $self->{filter_r}->($self, $rbuf)
		750	: $self->_drain_rbuf;
		751
		752	} elsif (defined $len) {
		753	delete $self->{rw};
		754	$self->{eof} = 1;
		755	$self->_drain_rbuf;
		756
		757	} elsif ($! != EAGAIN && $! != EINTR) {
		758	return $self->error;
184	}	759	}
185	});	760	});
		761	}
186	}	762	}
187		763
188	=item B<on_error ($callback)>	764	sub _dotls {
189
190	Whenever a read or write operation resulted in an error the C<$callback>
191	will be called.
192
193	The first argument of C<$callback> will be the L<AnyEvent::Handle> object itself.
194	The error is given as errno in C<$!>.
195
196	=cut
197
198	sub on_error {
199	$_[0]->{on_error} = $_[1];
200	}
201
202	=item B<on_eof ($callback)>
203
204	Installs the C<$callback> that will be called when the end of file is
205	encountered in a read operation this C<$callback> will be called. The first
206	argument will be the L<AnyEvent::Handle> object itself.
207
208	=cut
209
210	sub on_eof {
211	$_[0]->{on_eof} = $_[1];
212	}
213
214	=item B<rbuf>
215
216	Returns a reference to the read buffer.
217
218	NOTE: The read buffer should only be used or modified if the C<on_read>
219	method is used directly. The C<read> and C<readlines> methods will provide
220	the read data to their callbacks.
221
222	=cut
223
224	sub rbuf : lvalue {
225	$_[0]->{rbuf}
226	}
227
228	=item B<read ($len, $callback)>
229
230	Will read exactly C<$len> bytes from the filehandle and call the C<$callback>
231	if done so. The first argument to the C<$callback> will be the L<AnyEvent::Handle>
232	object itself and the second argument the read data.
233
234	NOTE: This method will override any callbacks installed via the C<on_read> method.
235
236	=cut
237
238	sub read {
239	my ($self, $len, $cb) = @_;	765	my ($self) = @_;
240		766
241	$self->{read_cb} = $cb;	767	if (length $self->{tls_wbuf}) {
242	my $old_blk_size = $self->{read_block_size};	768	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{tls_wbuf})) > 0) {
243	$self->{read_block_size} = $len;	769	substr $self->{tls_wbuf}, 0, $len, "";
244
245	$self->on_read (sub {
246	#d# warn "OFOFO $len \|\| ".length($_[0]->{rbuf})."\|\|\n";
247
248	if ($len == length $_[0]->{rbuf}) {
249	$_[0]->{read_block_size} = $old_blk_size;
250	$_[0]->on_read (undef);
251	$_[0]->{read_cb}->($_[0], (substr $self->{rbuf}, 0, $len, ''));
252	}	770	}
253	});	771	}
254	}
255		772
256	=item B<readlines ($callback)>	773	if (defined (my $buf = Net::SSLeay::BIO_read ($self->{tls_wbio}))) {
257		774	$self->{wbuf} .= $buf;
258	=item B<readlines ($sep, $callback)>	775	$self->_drain_wbuf;
259
260	This method will read lines from the filehandle, seperated by C<$sep> or C<"\n">
261	if C<$sep> is not provided. C<$sep> will be used as "line" seperator.
262
263	The C<$callback> will be called when at least one
264	line could be read. The first argument to the C<$callback> will be the L<AnyEvent::Handle>
265	object itself and the rest of the arguments will be the read lines.
266
267	NOTE: This method will override any callbacks installed via the C<on_read> method.
268
269	=cut
270
271	sub readlines {
272	my ($self, $sep, $cb) = @_;
273
274	if (ref $sep) {
275	$cb = $sep;
276	$sep = "\n";
277
278	} elsif (not defined $sep) {
279	$sep = "\n";
280	}	776	}
281		777
282	my $sep_len = length $sep;	778	while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) {
		779	$self->{rbuf} .= $buf;
		780	$self->_drain_rbuf;
		781	}
283		782
284	$self->{on_readline} = $cb;	783	my $err = Net::SSLeay::get_error ($self->{tls}, -1);
285		784
286	$self->on_read (sub {	785	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
287	my @lines;	786	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {
288	my $rb = \$_[0]->{rbuf};	787	$self->error;
289	my $pos;	788	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {
290	while (($pos = index ($$rb, $sep)) >= 0) {	789	$! = &Errno::EIO;
291	push @lines, substr $$rb, 0, $pos + $sep_len, '';	790	$self->error;
292	}	791	}
293	$self->{on_readline}->($_[0], @lines);	792
		793	# all others are fine for our purposes
		794	}
		795	}
		796
		797	=item $handle->starttls ($tls[, $tls_ctx])
		798
		799	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
		800	object is created, you can also do that at a later time by calling
		801	C<starttls>.
		802
		803	The first argument is the same as the C<tls> constructor argument (either
		804	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
		805
		806	The second argument is the optional C<Net::SSLeay::CTX> object that is
		807	used when AnyEvent::Handle has to create its own TLS connection object.
		808
		809	=cut
		810
		811	# TODO: maybe document...
		812	sub starttls {
		813	my ($self, $ssl, $ctx) = @_;
		814
		815	$self->stoptls;
		816
		817	if ($ssl eq "accept") {
		818	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());
		819	Net::SSLeay::set_accept_state ($ssl);
		820	} elsif ($ssl eq "connect") {
		821	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());
		822	Net::SSLeay::set_connect_state ($ssl);
		823	}
		824
		825	$self->{tls} = $ssl;
		826
		827	# basically, this is deep magic (because SSL_read should have the same issues)
		828	# but the openssl maintainers basically said: "trust us, it just works".
		829	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
		830	# and mismaintained ssleay-module doesn't even offer them).
		831	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
		832	Net::SSLeay::CTX_set_mode ($self->{tls},
		833	(eval { Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
		834	\| (eval { Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
		835
		836	$self->{tls_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
		837	$self->{tls_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
		838
		839	Net::SSLeay::set_bio ($ssl, $self->{tls_rbio}, $self->{tls_wbio});
		840
		841	$self->{filter_w} = sub {
		842	$_[0]{tls_wbuf} .= ${$_[1]};
		843	&_dotls;
294	});	844	};
		845	$self->{filter_r} = sub {
		846	Net::SSLeay::BIO_write ($_[0]{tls_rbio}, ${$_[1]});
		847	&_dotls;
		848	};
295	}	849	}
296		850
297	=item B<write ($data)>	851	=item $handle->stoptls
298		852
299	=item B<write ($callback)>	853	Destroys the SSL connection, if any. Partial read or write data will be
		854	lost.
300		855
301	=item B<write ($data, $callback)>
302
303	This method will write C<$data> to the filehandle and call the C<$callback>
304	afterwards. If only C<$callback> is provided it will be called when the
305	write buffer becomes empty the next time (or immediately if it already is empty).
306
307	=cut	856	=cut
308		857
309	sub write {	858	sub stoptls {
310	my ($self, $data, $cb) = @_;
311	if (ref $data) { $cb = $data; undef $data }
312	push @{$self->{write_bufs}}, [$data, $cb];
313	$self->_check_writer;
314	}
315
316	sub _check_writer {
317	my ($self) = @_;	859	my ($self) = @_;
318		860
319	if ($self->{write_w}) {	861	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};
320	unless ($self->{write_cb}) {	862	delete $self->{tls_rbio};
321	while (@{$self->{write_bufs}} && not defined $self->{write_bufs}->[0]->[1]) {	863	delete $self->{tls_wbio};
322	my $wba = shift @{$self->{write_bufs}};	864	delete $self->{tls_wbuf};
323	$self->{wbuf} .= $wba->[0];	865	delete $self->{filter_r};
324	}
325	}
326	return;
327	}
328
329	my $wba = shift @{$self->{write_bufs}}
330	or return;
331
332	unless (defined $wba->[0]) {
333	$wba->[1]->($self) if $wba->[1];
334	$self->_check_writer;
335	return;
336	}
337
338	$self->{wbuf} = $wba->[0];
339	$self->{write_cb} = $wba->[1];
340
341	$self->{write_w} =
342	AnyEvent->io (poll => 'w', fh => $self->{fh}, cb => sub {
343	my $l = syswrite $self->{fh}, $self->{wbuf}, length $self->{wbuf};
344
345	if (not defined $l) {
346	return if $! == EAGAIN \|\| $! == EINTR;
347	delete $self->{write_w};	866	delete $self->{filter_w};
348	$self->{on_error}->($self) if $self->{on_error};	867	}
349		868
350	} else {	869	sub DESTROY {
351	substr $self->{wbuf}, 0, $l, '';	870	my $self = shift;
352		871
353	if (length ($self->{wbuf}) == 0) {	872	$self->stoptls;
354	$self->{write_cb}->($self) if $self->{write_cb};	873	}
355		874
356	delete $self->{write_w};	875	=item AnyEvent::Handle::TLS_CTX
357	delete $self->{wbuf};
358	delete $self->{write_cb};
359		876
360	$self->_check_writer;	877	This function creates and returns the Net::SSLeay::CTX object used by
361	}	878	default for TLS mode.
362	}	879
363	});	880	The context is created like this:
		881
		882	Net::SSLeay::load_error_strings;
		883	Net::SSLeay::SSLeay_add_ssl_algorithms;
		884	Net::SSLeay::randomize;
		885
		886	my $CTX = Net::SSLeay::CTX_new;
		887
		888	Net::SSLeay::CTX_set_options $CTX, Net::SSLeay::OP_ALL
		889
		890	=cut
		891
		892	our $TLS_CTX;
		893
		894	sub TLS_CTX() {
		895	$TLS_CTX \|\| do {
		896	require Net::SSLeay;
		897
		898	Net::SSLeay::load_error_strings ();
		899	Net::SSLeay::SSLeay_add_ssl_algorithms ();
		900	Net::SSLeay::randomize ();
		901
		902	$TLS_CTX = Net::SSLeay::CTX_new ();
		903
		904	Net::SSLeay::CTX_set_options ($TLS_CTX, Net::SSLeay::OP_ALL ());
		905
		906	$TLS_CTX
		907	}
364	}	908	}
365		909
366	=back	910	=back
367		911
368	=head1 AUTHOR	912	=head1 AUTHOR
369		913
370	Robin Redeker, C<< <elmex at ta-sa.org> >>	914	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.
371		915
372	=cut	916	=cut
373		917
374	1; # End of AnyEvent::Handle	918	1; # End of AnyEvent::Handle

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.5 by elmex, Mon Apr 28 08:01:05 2008 UTC vs. Revision 1.29 by root, Sat May 24 23:10:18 2008 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.5 by elmex, Mon Apr 28 08:01:05 2008 UTC vs.
Revision 1.29 by root, Sat May 24 23:10:18 2008 UTC