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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.1 by elmex, Sun Apr 27 16:56:17 2008 UTC vs.
Revision 1.12 by elmex, Thu May 15 09:03:43 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 filehandles via AnyEvent
13		16
14	=head1 VERSION
15
16	Version 0.01
17
18	=cut	17	=cut
19		18
20	our $VERSION = '0.01';	19	our $VERSION = '0.02';
21		20
22	=head1 SYNOPSIS	21	=head1 SYNOPSIS
23		22
24	use AnyEvent;	23	use AnyEvent;
25	use AnyEvent::Handle;	24	use AnyEvent::Handle;
26		25
27	my $cv = AnyEvent->condvar;	26	my $cv = AnyEvent->condvar;
28		27
29	my $ae_fh = AnyEvent::Handle->new (fh => \*STDIN);	28	my $ae_fh = AnyEvent::Handle->new (fh => \*STDIN);
30		29
		30	#TODO
		31
		32	# or use the constructor to pass the callback:
		33
		34	my $ae_fh2 =
		35	AnyEvent::Handle->new (
		36	fh => \*STDIN,
		37	on_eof => sub {
		38	$cv->broadcast;
		39	},
		40	#TODO
		41	);
		42
		43	$cv->wait;
		44
		45	=head1 DESCRIPTION
		46
		47	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
		49	non-blocking resolves and connects).
		50
		51	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
		53	treatment of characters applies to this module as well.
		54
		55	All callbacks will be invoked with the handle object as their first
		56	argument.
		57
		58	=head1 METHODS
		59
		60	=over 4
		61
		62	=item B<new (%args)>
		63
		64	The constructor supports these arguments (all as key => value pairs).
		65
		66	=over 4
		67
		68	=item fh => $filehandle [MANDATORY]
		69
		70	The filehandle this L<AnyEvent::Handle> object will operate on.
		71
		72	NOTE: The filehandle will be set to non-blocking (using
		73	AnyEvent::Util::fh_nonblocking).
		74
		75	=item on_eof => $cb->($self) [MANDATORY]
		76
		77	Set the callback to be called on EOF.
		78
		79	=item on_error => $cb->($self)
		80
		81	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
		83	or a read error.
		84
		85	The object will not be in a usable state when this callback has been
		86	called.
		87
		88	On callback entrance, the value of C<$!> contains the operating system
		89	error (or C<ENOSPC> or C<EPIPE>).
		90
		91	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
		93	die.
		94
		95	=item on_read => $cb->($self)
		96
		97	This sets the default read callback, which is called when data arrives
		98	and no read request is in the queue.
		99
		100	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
		101	method or acces sthe C<$self->{rbuf}> member directly.
		102
		103	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
		105	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>).
		107
		108	=item on_drain => $cb->()
		109
		110	This sets the callback that is called when the write buffer becomes empty
		111	(or when the callback is set and the buffer is empty already).
		112
		113	To append to the write buffer, use the C<< ->push_write >> method.
		114
		115	=item rbuf_max => <bytes>
		116
		117	If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)
		118	when the read buffer ever (strictly) exceeds this size. This is useful to
		119	avoid denial-of-service attacks.
		120
		121	For example, a server accepting connections from untrusted sources should
		122	be configured to accept only so-and-so much data that it cannot act on
		123	(for example, when expecting a line, an attacker could send an unlimited
		124	amount of data without a callback ever being called as long as the line
		125	isn't finished).
		126
		127	=item read_size => <bytes>
		128
		129	The default read block size (the amount of bytes this module will try to read
		130	on each [loop iteration). Default: C<4096>.
		131
		132	=item low_water_mark => <bytes>
		133
		134	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
		136	considered empty.
		137
		138	=back
		139
		140	=cut
		141
		142	sub new {
		143	my $class = shift;
		144
		145	my $self = bless { @_ }, $class;
		146
		147	$self->{fh} or Carp::croak "mandatory argument fh is missing";
		148
		149	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
		150
		151	$self->on_eof ((delete $self->{on_eof} ) or Carp::croak "mandatory argument on_eof is missing");
		152
		153	$self->on_error (delete $self->{on_error}) if $self->{on_error};
		154	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
		155	$self->on_read (delete $self->{on_read} ) if $self->{on_read};
		156
		157	$self->start_read;
		158
		159	$self
		160	}
		161
		162	sub _shutdown {
		163	my ($self) = @_;
		164
		165	delete $self->{rw};
		166	delete $self->{ww};
		167	delete $self->{fh};
		168	}
		169
		170	sub error {
		171	my ($self) = @_;
		172
		173	{
		174	local $!;
		175	$self->_shutdown;
		176	}
		177
		178	if ($self->{on_error}) {
		179	$self->{on_error}($self);
		180	} else {
		181	die "AnyEvent::Handle uncaught fatal error: $!";
		182	}
		183	}
		184
		185	=item $fh = $handle->fh
		186
		187	This method returns the filehandle of the L<AnyEvent::Handle> object.
		188
		189	=cut
		190
		191	sub fh { $_[0]->{fh} }
		192
		193	=item $handle->on_error ($cb)
		194
		195	Replace the current C<on_error> callback (see the C<on_error> constructor argument).
		196
		197	=cut
		198
		199	sub on_error {
		200	$_[0]{on_error} = $_[1];
		201	}
		202
		203	=item $handle->on_eof ($cb)
		204
		205	Replace the current C<on_eof> callback (see the C<on_eof> constructor argument).
		206
		207	=cut
		208
		209	sub on_eof {
		210	$_[0]{on_eof} = $_[1];
		211	}
		212
		213	#############################################################################
		214
		215	=back
		216
		217	=head2 WRITE QUEUE
		218
		219	AnyEvent::Handle manages two queues per handle, one for writing and one
		220	for reading.
		221
		222	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.
		224
		225	When data could be writtena nd the write buffer is shorter then the low
		226	water mark, the C<on_drain> callback will be invoked.
		227
		228	=over 4
		229
		230	=item $handle->on_drain ($cb)
		231
		232	Sets the C<on_drain> callback or clears it (see the description of
		233	C<on_drain> in the constructor).
		234
		235	=cut
		236
		237	sub on_drain {
		238	my ($self, $cb) = @_;
		239
		240	$self->{on_drain} = $cb;
		241
		242	$cb->($self)
		243	if $cb && $self->{low_water_mark} >= length $self->{wbuf};
		244	}
		245
		246	=item $handle->push_write ($data)
		247
		248	Queues the given scalar to be written. You can push as much data as you
		249	want (only limited by the available memory), as C<AnyEvent::Handle>
		250	buffers it independently of the kernel.
		251
		252	=cut
		253
		254	sub push_write {
		255	my ($self, $data) = @_;
		256
		257	$self->{wbuf} .= $data;
		258
		259	unless ($self->{ww}) {
		260	Scalar::Util::weaken $self;
		261	my $cb = sub {
		262	my $len = syswrite $self->{fh}, $self->{wbuf};
		263
		264	if ($len > 0) {
		265	substr $self->{wbuf}, 0, $len, "";
		266
		267
		268	$self->{on_drain}($self)
		269	if $self->{low_water_mark} >= length $self->{wbuf}
		270	&& $self->{on_drain};
		271
		272	delete $self->{ww} unless length $self->{wbuf};
		273	} elsif ($! != EAGAIN && $! != EINTR) {
		274	$self->error;
		275	}
		276	};
		277
		278	$self->{ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb);
		279
		280	$cb->($self);
		281	};
		282	}
		283
		284	#############################################################################
		285
		286	=back
		287
		288	=head2 READ QUEUE
		289
		290	AnyEvent::Handle manages two queues per handle, one for writing and one
		291	for reading.
		292
		293	The read queue is more complex than the write queue. It can be used in two
		294	ways, the "simple" way, using only C<on_read> and the "complex" way, using
		295	a queue.
		296
		297	In the simple case, you just install an C<on_read> callback and whenever
		298	new data arrives, it will be called. You can then remove some data (if
		299	enough is there) from the read buffer (C<< $handle->rbuf >>) if you want
		300	or not.
		301
		302	In the more complex case, you want to queue multiple callbacks. In this
		303	case, AnyEvent::Handle will call the first queued callback each time new
		304	data arrives and removes it when it has done its job (see C<push_read>,
		305	below).
		306
		307	This way you can, for example, push three line-reads, followed by reading
		308	a chunk of data, and AnyEvent::Handle will execute them in order.
		309
		310	Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by
		311	the specified number of bytes which give an XML datagram.
		312
		313	# in the default state, expect some header bytes
		314	$handle->on_read (sub {
		315	# some data is here, now queue the length-header-read (4 octets)
		316	shift->unshift_read_chunk (4, sub {
		317	# header arrived, decode
		318	my $len = unpack "N", $_[1];
		319
		320	# now read the payload
		321	shift->unshift_read_chunk ($len, sub {
		322	my $xml = $_[1];
		323	# handle xml
		324	});
		325	});
		326	});
		327
		328	Example 2: Implement a client for a protocol that replies either with
		329	"OK" and another line or "ERROR" for one request, and 64 bytes for the
		330	second request. Due tot he availability of a full queue, we can just
		331	pipeline sending both requests and manipulate the queue as necessary in
		332	the callbacks:
		333
		334	# request one
		335	$handle->push_write ("request 1\015\012");
		336
		337	# we expect "ERROR" or "OK" as response, so push a line read
31	$ae_fh->readlines (sub {	338	$handle->push_read_line (sub {
32	my ($ae_fh, @lines) = @_;	339	# if we got an "OK", we have to _prepend_ another line,
33	for (@lines) {	340	# so it will be read before the second request reads its 64 bytes
34	chomp;	341	# which are already in the queue when this callback is called
35	print "Line: $_";	342	# we don't do this in case we got an error
		343	if ($_[1] eq "OK") {
		344	$_[0]->unshift_read_line (sub {
		345	my $response = $_[1];
		346	...
		347	});
36	}	348	}
37	$cv->broadcast;
38	});	349	});
39		350
40	$cv->wait;	351	# request two
		352	$handle->push_write ("request 2\015\012");
41		353
42	=head1 DESCRIPTION	354	# simply read 64 bytes, always
43		355	$handle->push_read_chunk (64, sub {
44	This module is a helper module to make it easier to do non-blocking I/O	356	my $response = $_[1];
45	on filehandles (and sockets, see L<AnyEvent::Socket>).	357	...
46		358	});
47	The event loop is provided by L<AnyEvent>.
48
49	=head1 METHODS
50		359
51	=over 4	360	=over 4
52		361
53	=item B<new (%args)>
54
55	The constructor has these arguments:
56
57	=over 4
58
59	=item fh => $filehandle
60
61	The filehandle this L<AnyEvent::Handle> object will operate on.
62
63	NOTE: The filehandle will be set to non-blocking.
64
65	=item read_block_size => $size
66
67	The default read block size use for reads via the C<on_read>
68	method.
69
70	=back
71
72	=cut	362	=cut
73		363
74	sub new {	364	sub _drain_rbuf {
75	my $this = shift;
76	my $class = ref($this) \|\| $this;
77	my $self = {	365	my ($self) = @_;
78	read_block_size => 4096,
79	rbuf => '',
80	@_
81	};
82	bless $self, $class;
83		366
84	$self->{fh}->blocking (0) if $self->{fh};	367	return if $self->{in_drain};
		368	local $self->{in_drain} = 1;
85		369
86	if ($self->{on_read}) {	370	while (my $len = length $self->{rbuf}) {
87	$self->on_read ($self->{on_read});	371	no strict 'refs';
		372	if (my $cb = shift @{ $self->{queue} }) {
		373	if (!$cb->($self)) {
		374	if ($self->{eof}) {
		375	# no progress can be made (not enough data and no data forthcoming)
		376	$! = &Errno::EPIPE; return $self->error;
		377	}
88		378
		379	unshift @{ $self->{queue} }, $cb;
		380	return;
		381	}
89	} elsif ($self->{on_readline}) {	382	} elsif ($self->{on_read}) {
90	$self->readlines ($self->{on_readline});	383	$self->{on_read}($self);
		384
		385	if (
		386	$self->{eof} # if no further data will arrive
		387	&& $len == length $self->{rbuf} # and no data has been consumed
		388	&& !@{ $self->{queue} } # and the queue is still empty
		389	&& $self->{on_read} # and we still want to read data
		390	) {
		391	# then no progress can be made
		392	$! = &Errno::EPIPE; return $self->error;
		393	}
		394	} else {
		395	# read side becomes idle
		396	delete $self->{rw};
		397	return;
		398	}
91	}	399	}
92		400
93	return $self	401	if ($self->{eof}) {
		402	$self->_shutdown;
		403	$self->{on_eof}($self);
		404	}
94	}	405	}
95		406
96	=item B<fh>	407	=item $handle->on_read ($cb)
97		408
98	This method returns the filehandle of the L<AnyEvent::Handle> object.	409	This replaces the currently set C<on_read> callback, or clears it (when
99		410	the new callback is C<undef>). See the description of C<on_read> in the
100	=cut	411	constructor.
101
102	sub fh { $_[0]->{fh} }
103
104	=item B<on_read ($callback)>
105
106	This method installs a C<$callback> that will be called
107	when new data arrived. You can access the read buffer via the C<rbuf>
108	method (see below).
109
110	The first argument of the C<$callback> will be the L<AnyEvent::Handle> object.
111		412
112	=cut	413	=cut
113		414
114	sub on_read {	415	sub on_read {
115	my ($self, $cb) = @_;	416	my ($self, $cb) = @_;
		417
116	$self->{on_read} = $cb;	418	$self->{on_read} = $cb;
		419	}
117		420
118	unless (defined $self->{on_read}) {	421	=item $handle->rbuf
119	delete $self->{on_read_w};	422
120	return;	423	Returns the read buffer (as a modifiable lvalue).
		424
		425	You can access the read buffer directly as the C<< ->{rbuf} >> member, if
		426	you want.
		427
		428	NOTE: The read buffer should only be used or modified if the C<on_read>,
		429	C<push_read> or C<unshift_read> methods are used. The other read methods
		430	automatically manage the read buffer.
		431
		432	=cut
		433
		434	sub rbuf : lvalue {
		435	$_[0]{rbuf}
		436	}
		437
		438	=item $handle->push_read ($cb)
		439
		440	=item $handle->unshift_read ($cb)
		441
		442	Append the given callback to the end of the queue (C<push_read>) or
		443	prepend it (C<unshift_read>).
		444
		445	The callback is called each time some additional read data arrives.
		446
		447	It must check wether enough data is in the read buffer already.
		448
		449	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
		451	available (or an error condition is detected).
		452
		453	If enough data was available, then the callback must remove all data it is
		454	interested in (which can be none at all) and return a true value. After returning
		455	true, it will be removed from the queue.
		456
		457	=cut
		458
		459	sub push_read {
		460	my ($self, $cb) = @_;
		461
		462	push @{ $self->{queue} }, $cb;
		463	$self->_drain_rbuf;
		464	}
		465
		466	sub unshift_read {
		467	my ($self, $cb) = @_;
		468
		469	push @{ $self->{queue} }, $cb;
		470	$self->_drain_rbuf;
		471	}
		472
		473	=item $handle->push_read_chunk ($len, $cb->($self, $data))
		474
		475	=item $handle->unshift_read_chunk ($len, $cb->($self, $data))
		476
		477	Append the given callback to the end of the queue (C<push_read_chunk>) or
		478	prepend it (C<unshift_read_chunk>).
		479
		480	The callback will be called only once C<$len> bytes have been read, and
		481	these C<$len> bytes will be passed to the callback.
		482
		483	=cut
		484
		485	sub _read_chunk($$) {
		486	my ($self, $len, $cb) = @_;
		487
		488	sub {
		489	$len <= length $_[0]{rbuf} or return;
		490	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");
		491	1
121	}	492	}
122		493	}
123	$self->{on_read_w} =	494
124	AnyEvent->io (poll => 'r', fh => $self->{fh}, cb => sub {	495	sub push_read_chunk {
125	#d# warn "READ:[$self->{read_size}] $self->{read_block_size} : ".length ($self->{rbuf})."\n";	496	$_[0]->push_read (&_read_chunk);
126	my $rbuf_len = length $self->{rbuf};	497	}
127	my $l;	498
		499
		500	sub unshift_read_chunk {
		501	$_[0]->unshift_read (&_read_chunk);
		502	}
		503
		504	=item $handle->push_read_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
		511	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
		513	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>).
		515
		516	The end of line marker, C<$eol>, can be either a string, in which case it
		517	will be interpreted as a fixed record end marker, or it can be a regex
		518	object (e.g. created by C<qr>), in which case it is interpreted as a
		519	regular expression.
		520
		521	The end of line marker argument C<$eol> is optional, if it is missing (NOT
		522	undef), then C<qr\|\015?\012\|> is used (which is good for most internet
		523	protocols).
		524
		525	Partial lines at the end of the stream will never be returned, as they are
		526	not marked by the end of line marker.
		527
		528	=cut
		529
		530	sub _read_line($$) {
		531	my $self = shift;
		532	my $cb = pop;
		533	my $eol = @_ ? shift : qr\|(\015?\012)\|;
		534	my $pos;
		535
		536	$eol = qr\|(\Q$eol\E)\| unless ref $eol;
		537	$eol = qr\|^(.*?)($eol)\|;
		538
		539	sub {
		540	$_[0]{rbuf} =~ s/$eol// or return;
		541
		542	$cb->($_[0], $1, $2);
		543	1
		544	}
		545	}
		546
		547	sub push_read_line {
		548	$_[0]->push_read (&_read_line);
		549	}
		550
		551	sub unshift_read_line {
		552	$_[0]->unshift_read (&_read_line);
		553	}
		554
		555	=item $handle->stop_read
		556
		557	=item $handle->start_read
		558
		559	In rare cases you actually do not want to read anything form the
		560	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
		562	C<start_read>.
		563
		564	=cut
		565
		566	sub stop_read {
		567	my ($self) = @_;
		568
		569	delete $self->{rw};
		570	}
		571
		572	sub start_read {
		573	my ($self) = @_;
		574
		575	unless ($self->{rw} \|\| $self->{eof}) {
		576	Scalar::Util::weaken $self;
		577
		578	$self->{rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
		579	my $len = sysread $self->{fh}, $self->{rbuf}, $self->{read_size} \|\| 8192, length $self->{rbuf};
		580
		581	if ($len > 0) {
128	if (defined $self->{read_size}) {	582	if (defined $self->{rbuf_max}) {
129	$l = sysread $self->{fh}, $self->{rbuf},	583	if ($self->{rbuf_max} < length $self->{rbuf}) {
130	($self->{read_size} - $rbuf_len), $rbuf_len;	584	$! = &Errno::ENOSPC; return $self->error;
131	} else {	585	}
132	$l = sysread $self->{fh}, $self->{rbuf}, $self->{read_block_size}, $rbuf_len;	586	}
		587
		588	} elsif (defined $len) {
		589	$self->{eof} = 1;
		590	delete $self->{rw};
		591
		592	} elsif ($! != EAGAIN && $! != EINTR) {
		593	return $self->error;
133	}	594	}
134	#d# warn "READL $l [$self->{rbuf}]\n";
135		595
136	if (not defined $l) {	596	$self->_drain_rbuf;
137	return if $! == EAGAIN \|\| $! == EINTR;
138	$self->{on_error}->($self, $!) if $self->{on_error};
139	delete $self->{on_read_w};
140
141	} elsif ($l == 0) {
142	$self->{on_eof}->($self) if $self->{on_eof};
143	delete $self->{on_read_w};
144
145	} else {
146	$self->{on_read}->($self);
147	}
148	});	597	});
149	}
150
151	=item B<on_error ($callback)>
152
153	Whenever a read or write operation resulted in an error the C<$callback>
154	will be called.
155
156	The first argument of C<$callback> will be the L<AnyEvent::Handle> object itself
157	and the second argument will be the value of C<$!>.
158
159	=cut
160
161	sub on_error {
162	$_[0]->{on_error} = $_[1];
163	}
164
165	=item B<on_eof ($callback)>
166
167	Installs the C<$callback> that will be called when the end of file is
168	encountered in a read operation this C<$callback> will be called. The first
169	argument will be the L<AnyEvent::Handle> object itself.
170
171	=cut
172
173	sub on_eof {
174	$_[0]->{on_eof} = $_[1];
175	}
176
177	=item B<rbuf>
178
179	Returns a reference to the read buffer.
180
181	NOTE: The read buffer should only be used or modified if the C<on_read>
182	method is used directly. The C<read> and C<readlines> methods will provide
183	the read data to their callbacks.
184
185	=cut
186
187	sub rbuf : lvalue { $_[0]->{rbuf} }
188
189	=item B<read ($len, $callback)>
190
191	Will read exactly C<$len> bytes from the filehandle and call the C<$callback>
192	if done so. The first argument to the C<$callback> will be the L<AnyEvent::Handle>
193	object itself and the second argument the read data.
194
195	NOTE: This method will override any callbacks installed via the C<on_read> method.
196
197	=cut
198
199	sub read {
200	my ($self, $len, $cb) = @_;
201
202	$self->{read_cb} = $cb;
203	my $old_blk_size = $self->{read_block_size};
204	$self->{read_block_size} = $len;
205
206	$self->on_read (sub {
207	#d# warn "OFOFO $len \|\| ".length($_[0]->{rbuf})."\|\|\n";
208
209	if ($len == length $_[0]->{rbuf}) {
210	$_[0]->{read_block_size} = $old_blk_size;
211	$_[0]->on_read (undef);
212	$_[0]->{read_cb}->($_[0], (substr $self->{rbuf}, 0, $len, ''));
213	}
214	});
215	}
216
217	=item B<readlines ($callback)>
218
219	=item B<readlines ($sep, $callback)>
220
221	This method will read lines from the filehandle, seperated by C<$sep> or C<"\n">
222	if C<$sep> is not provided. C<$sep> will be used as part of a regex, so it can be
223	a regex itself and won't be quoted!
224
225	The C<$callback> will be called when at least one
226	line could be read. The first argument to the C<$callback> will be the L<AnyEvent::Handle>
227	object itself and the rest of the arguments will be the read lines.
228
229	NOTE: This method will override any callbacks installed via the C<on_read> method.
230
231	=cut
232
233	sub readlines {
234	my ($self, $NL, $cb) = @_;
235
236	if (ref $NL) {
237	$cb = $NL;
238	$NL = "\n";
239	}	598	}
240
241	$self->{on_readline} = $cb;
242
243	$self->on_read (sub {
244	my @lines;
245	push @lines, $1 while $_[0]->{rbuf} =~ s/(.*)$NL//;
246	$self->{on_readline}->($_[0], @lines);
247	});
248	}
249
250	=item B<write ($data)>
251
252	=item B<write ($callback)>
253
254	=item B<write ($data, $callback)>
255
256	This method will write C<$data> to the filehandle and call the C<$callback>
257	afterwards. If only C<$callback> is provided it will be called when the
258	write buffer becomes empty the next time (or immediately if it already is empty).
259
260	=cut
261
262	sub write {
263	my ($self, $data, $cb) = @_;
264	if (ref $data) { $cb = $data; undef $data }
265	push @{$self->{write_bufs}}, [$data, $cb];
266	$self->_check_writer;
267	}
268
269	sub _check_writer {
270	my ($self) = @_;
271
272	if ($self->{write_w}) {
273	unless ($self->{write_cb}) {
274	while (@{$self->{write_bufs}} && not defined $self->{write_bufs}->[0]->[1]) {
275	my $wba = shift @{$self->{write_bufs}};
276	$self->{wbuf} .= $wba->[0];
277	}
278	}
279	return;
280	}
281
282	my $wba = shift @{$self->{write_bufs}}
283	or return;
284
285	unless (defined $wba->[0]) {
286	$wba->[1]->($self) if $wba->[1];
287	$self->_check_writer;
288	return;
289	}
290
291	$self->{wbuf} = $wba->[0];
292	$self->{write_cb} = $wba->[1];
293
294	$self->{write_w} =
295	AnyEvent->io (poll => 'w', fh => $self->{fh}, cb => sub {
296	my $l = syswrite $self->{fh}, $self->{wbuf}, length $self->{wbuf};
297
298	if (not defined $l) {
299	return if $! == EAGAIN \|\| $! == EINTR;
300	delete $self->{write_w};
301
302	$self->{on_error}->($self, $!) if $self->{on_error};
303
304	} else {
305	substr $self->{wbuf}, 0, $l, '';
306
307	if (length ($self->{wbuf}) == 0) {
308	$self->{write_cb}->($self) if $self->{write_cb};
309
310	delete $self->{write_w};
311	delete $self->{wbuf};
312	delete $self->{write_cb};
313
314	$self->_check_writer;
315	}
316	}
317	});
318	}	599	}
319		600
320	=back	601	=back
321		602
322	=head1 AUTHOR	603	=head1 AUTHOR
323		604
324	Robin Redeker, C<< <elmex at ta-sa.org> >>	605	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.
325
326	=head1 BUGS
327
328	Please report any bugs or feature requests to
329	C<bug-io-anyevent at rt.cpan.org>, or through the web interface at
330	L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=IO-AnyEvent>.
331	I will be notified, and then you'll automatically be notified of progress on
332	your bug as I make changes.
333
334	=head1 SUPPORT
335
336	You can find documentation for this module with the perldoc command.
337
338	perldoc AnyEvent::Handle
339
340	You can also look for information at:
341
342	=over 4
343
344	=item * AnnoCPAN: Annotated CPAN documentation
345
346	L<http://annocpan.org/dist/IO-AnyEvent>
347
348	=item * CPAN Ratings
349
350	L<http://cpanratings.perl.org/d/IO-AnyEvent>
351
352	=item * RT: CPAN's request tracker
353
354	L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=IO-AnyEvent>
355
356	=item * Search CPAN
357
358	L<http://search.cpan.org/dist/IO-AnyEvent>
359
360	=back
361
362	=head1 ACKNOWLEDGEMENTS
363
364	=head1 COPYRIGHT & LICENSE
365
366	Copyright 2008 Robin Redeker, all rights reserved.
367
368	This program is free software; you can redistribute it and/or modify it
369	under the same terms as Perl itself.
370		606
371	=cut	607	=cut
372		608
373	1; # End of AnyEvent::Handle	609	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.1 by elmex, Sun Apr 27 16:56:17 2008 UTC vs. Revision 1.12 by elmex, Thu May 15 09:03:43 2008 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.1 by elmex, Sun Apr 27 16:56:17 2008 UTC vs.
Revision 1.12 by elmex, Thu May 15 09:03:43 2008 UTC