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

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

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.4 by elmex, Sun Apr 27 20:20:20 2008 UTC vs.
Revision 1.30 by root, Sat May 24 23:56:26 2008 UTC