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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.8 by root, Fri May 2 15:36:10 2008 UTC vs.
Revision 1.35 by root, Mon May 26 05:46:35 2008 UTC

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

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.8 by root, Fri May 2 15:36:10 2008 UTC vs. Revision 1.35 by root, Mon May 26 05:46:35 2008 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.8 by root, Fri May 2 15:36:10 2008 UTC vs.
Revision 1.35 by root, Mon May 26 05:46:35 2008 UTC