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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.9 by root, Fri May 2 16:07:46 2008 UTC vs.
Revision 1.36 by root, Mon May 26 18:26:52 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
…		…
212	for reading.	256	for reading.
213		257
214	The write queue is very simple: you can add data to its end, and	258	The write queue is very simple: you can add data to its end, and
215	AnyEvent::Handle will automatically try to get rid of it for you.	259	AnyEvent::Handle will automatically try to get rid of it for you.
216		260
217	When data could be writtena nd the write buffer is shorter then the low	261	When data could be written and the write buffer is shorter then the low
218	water mark, the C<on_drain> callback will be invoked.	262	water mark, the C<on_drain> callback will be invoked.
219		263
220	=over 4	264	=over 4
221		265
222	=item $handle->on_drain ($cb)	266	=item $handle->on_drain ($cb)
…		…
241	want (only limited by the available memory), as C<AnyEvent::Handle>	285	want (only limited by the available memory), as C<AnyEvent::Handle>
242	buffers it independently of the kernel.	286	buffers it independently of the kernel.
243		287
244	=cut	288	=cut
245		289
246	sub push_write {	290	sub _drain_wbuf {
247	my ($self, $data) = @_;	291	my ($self) = @_;
248		292
249	$self->{wbuf} .= $data;	293	if (!$self->{ww} && length $self->{wbuf}) {
250		294
251	unless ($self->{ww}) {
252	Scalar::Util::weaken $self;	295	Scalar::Util::weaken $self;
		296
253	my $cb = sub {	297	my $cb = sub {
254	my $len = syswrite $self->{fh}, $self->{wbuf};	298	my $len = syswrite $self->{fh}, $self->{wbuf};
255		299
256	if ($len > 0) {	300	if ($len >= 0) {
257	substr $self->{wbuf}, 0, $len, "";	301	substr $self->{wbuf}, 0, $len, "";
258
259		302
260	$self->{on_drain}($self)	303	$self->{on_drain}($self)
261	if $self->{low_water_mark} >= length $self->{wbuf}	304	if $self->{low_water_mark} >= length $self->{wbuf}
262	&& $self->{on_drain};	305	&& $self->{on_drain};
263		306
264	delete $self->{ww} unless length $self->{wbuf};	307	delete $self->{ww} unless length $self->{wbuf};
265	} elsif ($! != EAGAIN && $! != EINTR) {	308	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAWOULDBLOCK) {
266	$self->error;	309	$self->error;
267	}	310	}
268	};	311	};
269		312
		313	# try to write data immediately
		314	$cb->();
		315
		316	# if still data left in wbuf, we need to poll
270	$self->{ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb);	317	$self->{ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)
271		318	if length $self->{wbuf};
272	$cb->($self);
273	};	319	};
274	}	320	}
		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
275		386
276	#############################################################################	387	#############################################################################
277		388
278	=back	389	=back
279		390
…		…
349	...	460	...
350	});	461	});
351		462
352	=over 4	463	=over 4
353		464
		465	=cut
		466
354	sub _drain_rbuf {	467	sub _drain_rbuf {
355	my ($self) = @_;	468	my ($self) = @_;
356		469
		470	if (
		471	defined $self->{rbuf_max}
		472	&& $self->{rbuf_max} < length $self->{rbuf}
		473	) {
		474	$! = &Errno::ENOSPC; return $self->error;
		475	}
		476
357	return if exists $self->{in_drain};	477	return if $self->{in_drain};
358	local $self->{in_drain} = 1;	478	local $self->{in_drain} = 1;
359		479
360	while (my $len = length $self->{rbuf}) {	480	while (my $len = length $self->{rbuf}) {
361	no strict 'refs';	481	no strict 'refs';
362	if (@{ $self->{queue} }) {	482	if (my $cb = shift @{ $self->{queue} }) {
363	if ($self->{queue}[0]($self)) {	483	unless ($cb->($self)) {
364	shift @{ $self->{queue} };
365	} elsif ($self->{eof}) {	484	if ($self->{eof}) {
366	# 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)
367	$! = &Errno::EPIPE; return $self->error;	486	$! = &Errno::EPIPE; return $self->error;
368	} else {	487	}
		488
		489	unshift @{ $self->{queue} }, $cb;
369	return;	490	return;
370	}	491	}
371	} elsif ($self->{on_read}) {	492	} elsif ($self->{on_read}) {
372	$self->{on_read}($self);	493	$self->{on_read}($self);
373		494
…		…
387	}	508	}
388	}	509	}
389		510
390	if ($self->{eof}) {	511	if ($self->{eof}) {
391	$self->_shutdown;	512	$self->_shutdown;
392	$self->{on_eof}($self);	513	$self->{on_eof}($self)
		514	if $self->{on_eof};
393	}	515	}
394	}	516	}
395		517
396	=item $handle->on_read ($cb)	518	=item $handle->on_read ($cb)
397		519
…		…
403		525
404	sub on_read {	526	sub on_read {
405	my ($self, $cb) = @_;	527	my ($self, $cb) = @_;
406		528
407	$self->{on_read} = $cb;	529	$self->{on_read} = $cb;
408
409	unless ($self->{rw} \|\| $self->{eof}) {
410	Scalar::Util::weaken $self;
411
412	$self->{rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
413	my $len = sysread $self->{fh}, $self->{rbuf}, $self->{read_size} \|\| 8192, length $self->{rbuf};
414
415	if ($len > 0) {
416	if (exists $self->{rbuf_max}) {
417	if ($self->{rbuf_max} < length $self->{rbuf}) {
418	$! = &Errno::ENOSPC; return $self->error;
419	}
420	}
421
422	} elsif (defined $len) {
423	$self->{eof} = 1;
424	delete $self->{rw};
425
426	} elsif ($! != EAGAIN && $! != EINTR) {
427	return $self->error;
428	}
429
430	$self->_drain_rbuf;
431	});
432	}
433	}	530	}
434		531
435	=item $handle->rbuf	532	=item $handle->rbuf
436		533
437	Returns the read buffer (as a modifiable lvalue).	534	Returns the read buffer (as a modifiable lvalue).
…		…
456	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
457	prepend it (C<unshift_read>).	554	prepend it (C<unshift_read>).
458		555
459	The callback is called each time some additional read data arrives.	556	The callback is called each time some additional read data arrives.
460		557
461	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.
462		559
463	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
464	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
465	available (or an error condition is detected).	562	available (or an error condition is detected).
466		563
…		…
468	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
469	true, it will be removed from the queue.	566	true, it will be removed from the queue.
470		567
471	=cut	568	=cut
472		569
		570	our %RH;
		571
		572	sub register_read_type($$) {
		573	$RH{$_[0]} = $_[1];
		574	}
		575
473	sub push_read {	576	sub push_read {
474	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	}
475		586
476	push @{ $self->{queue} }, $cb;	587	push @{ $self->{queue} }, $cb;
477	$self->_drain_rbuf;	588	$self->_drain_rbuf;
478	}	589	}
479		590
480	sub unshift_read {	591	sub unshift_read {
481	my ($self, $cb) = @_;	592	my $self = shift;
		593	my $cb = pop;
482		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
483	push @{ $self->{queue} }, $cb;	603	unshift @{ $self->{queue} }, $cb;
484	$self->_drain_rbuf;	604	$self->_drain_rbuf;
485	}	605	}
486		606
487	=item $handle->push_read_chunk ($len, $cb->($self, $data))	607	=item $handle->push_read (type => @args, $cb)
488		608
489	=item $handle->unshift_read_chunk ($len, $cb->($self, $data))	609	=item $handle->unshift_read (type => @args, $cb)
490		610
491	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
492	prepend it (C<unshift_read_chunk>).	612	between a number of predefined parsing formats, for chunks of data, lines
		613	etc.
493		614
494	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
495	these C<$len> bytes will be passed to the callback.	616	drop by and tell us):
496		617
497	=cut	618	=over 4
498		619
499	sub _read_chunk($$) {	620	=item chunk => $octets, $cb->($self, $data)
500	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) = @_;
501		636
502	sub {	637	sub {
503	$len <= length $_[0]{rbuf} or return;	638	$len <= length $_[0]{rbuf} or return;
504	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");	639	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");
505	1	640	1
506	}	641	}
507	}	642	};
508		643
		644	# compatibility with older API
509	sub push_read_chunk {	645	sub push_read_chunk {
510	my ($self, $len, $cb) = @_;	646	$_[0]->push_read (chunk => $_[1], $_[2]);
511
512	$self->push_read (_read_chunk $len, $cb);
513	}	647	}
514
515		648
516	sub unshift_read_chunk {	649	sub unshift_read_chunk {
517	my ($self, $len, $cb) = @_;	650	$_[0]->unshift_read (chunk => $_[1], $_[2]);
518
519	$self->unshift_read (_read_chunk $len, $cb);
520	}	651	}
521		652
522	=item $handle->push_read_line ([$eol, ]$cb->($self, $line, $eol))	653	=item line => [$eol, ]$cb->($self, $line, $eol)
523
524	=item $handle->unshift_read_line ([$eol, ]$cb->($self, $line, $eol))
525
526	Append the given callback to the end of the queue (C<push_read_line>) or
527	prepend it (C<unshift_read_line>).
528		654
529	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
530	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
531	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
532	the end of line marker as the third argument (C<$eol>).	658	the end of line marker as the third argument (C<$eol>).
…		…
543	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
544	not marked by the end of line marker.	670	not marked by the end of line marker.
545		671
546	=cut	672	=cut
547		673
548	sub _read_line($$) {	674	register_read_type line => sub {
549	my $cb = pop;	675	my ($self, $cb, $eol) = @_;
550	my $eol = @_ ? shift : qr\|(\015?\012)\|;
551	my $pos;
552		676
		677	$eol = qr\|(\015?\012)\| if @_ < 3;
553	$eol = qr\|(\Q$eol\E)\| unless ref $eol;	678	$eol = quotemeta $eol unless ref $eol;
554	$eol = qr\|^(.*?)($eol)\|;	679	$eol = qr\|^(.*?)($eol)\|s;
555		680
556	sub {	681	sub {
557	$_[0]{rbuf} =~ s/$eol// or return;	682	$_[0]{rbuf} =~ s/$eol// or return;
558		683
559	$cb->($1, $2);	684	$cb->($_[0], $1, $2);
560	1	685	1
561	}	686	}
562	}	687	};
563		688
		689	# compatibility with older API
564	sub push_read_line {	690	sub push_read_line {
565	my $self = shift;	691	my $self = shift;
566
567	$self->push_read (&_read_line);	692	$self->push_read (line => @_);
568	}	693	}
569		694
570	sub unshift_read_line {	695	sub unshift_read_line {
571	my $self = shift;	696	my $self = shift;
572
573	$self->unshift_read (&_read_line);	697	$self->unshift_read (line => @_);
574	}	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	};
		737
		738	=item regex => $accept[, $reject[, $skip], $cb->($data)
		739
		740	Makes a regex match against the regex object C<$accept> and returns
		741	everything up to and including the match.
		742
		743	Example: read a single line terminated by '\n'.
		744
		745	$handle->push_read (regex => qr<\n>, sub { ... });
		746
		747	If C<$reject> is given and not undef, then it determines when the data is
		748	to be rejected: it is matched against the data when the C<$accept> regex
		749	does not match and generates an C<EBADMSG> error when it matches. This is
		750	useful to quickly reject wrong data (to avoid waiting for a timeout or a
		751	receive buffer overflow).
		752
		753	Example: expect a single decimal number followed by whitespace, reject
		754	anything else (not the use of an anchor).
		755
		756	$handle->push_read (regex => qr<^[0-9]+\s>, qr<[^0-9]>, sub { ... });
		757
		758	If C<$skip> is given and not C<undef>, then it will be matched against
		759	the receive buffer when neither C<$accept> nor C<$reject> match,
		760	and everything preceding and including the match will be accepted
		761	unconditionally. This is useful to skip large amounts of data that you
		762	know cannot be matched, so that the C<$accept> or C<$reject> regex do not
		763	have to start matching from the beginning. This is purely an optimisation
		764	and is usually worth only when you expect more than a few kilobytes.
		765
		766	Example: expect a http header, which ends at C<\015\012\015\012>. Since we
		767	expect the header to be very large (it isn't in practise, but...), we use
		768	a skip regex to skip initial portions. The skip regex is tricky in that
		769	it only accepts something not ending in either \015 or \012, as these are
		770	required for the accept regex.
		771
		772	$handle->push_read (regex =>
		773	qr<\015\012\015\012>,
		774	undef, # no reject
		775	qr<^.*[^\015\012]>,
		776	sub { ... });
		777
		778	=cut
		779
		780	register_read_type regex => sub {
		781	my ($self, $cb, $accept, $reject, $skip) = @_;
		782
		783	my $data;
		784	my $rbuf = \$self->{rbuf};
		785
		786	sub {
		787	# accept
		788	if ($$rbuf =~ $accept) {
		789	$data .= substr $$rbuf, 0, $+[0], "";
		790	$cb->($self, $data);
		791	return 1;
		792	}
		793
		794	# reject
		795	if ($reject && $$rbuf =~ $reject) {
		796	$! = &Errno::EBADMSG;
		797	$self->error;
		798	}
		799
		800	# skip
		801	if ($skip && $$rbuf =~ $skip) {
		802	$data .= substr $$rbuf, 0, $+[0], "";
		803	}
		804
		805	()
		806	}
		807	};
575		808
576	=back	809	=back
577		810
		811	=item AnyEvent::Handle::register_read_type type => $coderef->($self, $cb, @args)
		812
		813	This function (not method) lets you add your own types to C<push_read>.
		814
		815	Whenever the given C<type> is used, C<push_read> will invoke the code
		816	reference with the handle object, the callback and the remaining
		817	arguments.
		818
		819	The code reference is supposed to return a callback (usually a closure)
		820	that works as a plain read callback (see C<< ->push_read ($cb) >>).
		821
		822	It should invoke the passed callback when it is done reading (remember to
		823	pass C<$self> as first argument as all other callbacks do that).
		824
		825	Note that this is a function, and all types registered this way will be
		826	global, so try to use unique names.
		827
		828	For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>,
		829	search for C<register_read_type>)).
		830
		831	=item $handle->stop_read
		832
		833	=item $handle->start_read
		834
		835	In rare cases you actually do not want to read anything from the
		836	socket. In this case you can call C<stop_read>. Neither C<on_read> no
		837	any queued callbacks will be executed then. To start reading again, call
		838	C<start_read>.
		839
		840	=cut
		841
		842	sub stop_read {
		843	my ($self) = @_;
		844
		845	delete $self->{rw};
		846	}
		847
		848	sub start_read {
		849	my ($self) = @_;
		850
		851	unless ($self->{rw} \|\| $self->{eof}) {
		852	Scalar::Util::weaken $self;
		853
		854	$self->{rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
		855	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};
		856	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;
		857
		858	if ($len > 0) {
		859	$self->{filter_r}
		860	? $self->{filter_r}->($self, $rbuf)
		861	: $self->_drain_rbuf;
		862
		863	} elsif (defined $len) {
		864	delete $self->{rw};
		865	$self->{eof} = 1;
		866	$self->_drain_rbuf;
		867
		868	} elsif ($! != EAGAIN && $! != EINTR && $! != &AnyEvent::Util::WSAWOULDBLOCK) {
		869	return $self->error;
		870	}
		871	});
		872	}
		873	}
		874
		875	sub _dotls {
		876	my ($self) = @_;
		877
		878	if (length $self->{tls_wbuf}) {
		879	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{tls_wbuf})) > 0) {
		880	substr $self->{tls_wbuf}, 0, $len, "";
		881	}
		882	}
		883
		884	if (defined (my $buf = Net::SSLeay::BIO_read ($self->{tls_wbio}))) {
		885	$self->{wbuf} .= $buf;
		886	$self->_drain_wbuf;
		887	}
		888
		889	while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) {
		890	$self->{rbuf} .= $buf;
		891	$self->_drain_rbuf;
		892	}
		893
		894	my $err = Net::SSLeay::get_error ($self->{tls}, -1);
		895
		896	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
		897	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {
		898	$self->error;
		899	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {
		900	$! = &Errno::EIO;
		901	$self->error;
		902	}
		903
		904	# all others are fine for our purposes
		905	}
		906	}
		907
		908	=item $handle->starttls ($tls[, $tls_ctx])
		909
		910	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
		911	object is created, you can also do that at a later time by calling
		912	C<starttls>.
		913
		914	The first argument is the same as the C<tls> constructor argument (either
		915	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
		916
		917	The second argument is the optional C<Net::SSLeay::CTX> object that is
		918	used when AnyEvent::Handle has to create its own TLS connection object.
		919
		920	=cut
		921
		922	# TODO: maybe document...
		923	sub starttls {
		924	my ($self, $ssl, $ctx) = @_;
		925
		926	$self->stoptls;
		927
		928	if ($ssl eq "accept") {
		929	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());
		930	Net::SSLeay::set_accept_state ($ssl);
		931	} elsif ($ssl eq "connect") {
		932	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());
		933	Net::SSLeay::set_connect_state ($ssl);
		934	}
		935
		936	$self->{tls} = $ssl;
		937
		938	# basically, this is deep magic (because SSL_read should have the same issues)
		939	# but the openssl maintainers basically said: "trust us, it just works".
		940	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
		941	# and mismaintained ssleay-module doesn't even offer them).
		942	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
		943	Net::SSLeay::CTX_set_mode ($self->{tls},
		944	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
		945	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
		946
		947	$self->{tls_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
		948	$self->{tls_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
		949
		950	Net::SSLeay::set_bio ($ssl, $self->{tls_rbio}, $self->{tls_wbio});
		951
		952	$self->{filter_w} = sub {
		953	$_[0]{tls_wbuf} .= ${$_[1]};
		954	&_dotls;
		955	};
		956	$self->{filter_r} = sub {
		957	Net::SSLeay::BIO_write ($_[0]{tls_rbio}, ${$_[1]});
		958	&_dotls;
		959	};
		960	}
		961
		962	=item $handle->stoptls
		963
		964	Destroys the SSL connection, if any. Partial read or write data will be
		965	lost.
		966
		967	=cut
		968
		969	sub stoptls {
		970	my ($self) = @_;
		971
		972	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};
		973	delete $self->{tls_rbio};
		974	delete $self->{tls_wbio};
		975	delete $self->{tls_wbuf};
		976	delete $self->{filter_r};
		977	delete $self->{filter_w};
		978	}
		979
		980	sub DESTROY {
		981	my $self = shift;
		982
		983	$self->stoptls;
		984	}
		985
		986	=item AnyEvent::Handle::TLS_CTX
		987
		988	This function creates and returns the Net::SSLeay::CTX object used by
		989	default for TLS mode.
		990
		991	The context is created like this:
		992
		993	Net::SSLeay::load_error_strings;
		994	Net::SSLeay::SSLeay_add_ssl_algorithms;
		995	Net::SSLeay::randomize;
		996
		997	my $CTX = Net::SSLeay::CTX_new;
		998
		999	Net::SSLeay::CTX_set_options $CTX, Net::SSLeay::OP_ALL
		1000
		1001	=cut
		1002
		1003	our $TLS_CTX;
		1004
		1005	sub TLS_CTX() {
		1006	$TLS_CTX \|\| do {
		1007	require Net::SSLeay;
		1008
		1009	Net::SSLeay::load_error_strings ();
		1010	Net::SSLeay::SSLeay_add_ssl_algorithms ();
		1011	Net::SSLeay::randomize ();
		1012
		1013	$TLS_CTX = Net::SSLeay::CTX_new ();
		1014
		1015	Net::SSLeay::CTX_set_options ($TLS_CTX, Net::SSLeay::OP_ALL ());
		1016
		1017	$TLS_CTX
		1018	}
		1019	}
		1020
		1021	=back
		1022
578	=head1 AUTHOR	1023	=head1 AUTHOR
579		1024
580	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.	1025	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.
581		1026
582	=cut	1027	=cut

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.9 by root, Fri May 2 16:07:46 2008 UTC vs. Revision 1.36 by root, Mon May 26 18:26:52 2008 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.9 by root, Fri May 2 16:07:46 2008 UTC vs.
Revision 1.36 by root, Mon May 26 18:26:52 2008 UTC