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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.20 by elmex, Sat May 24 08:16:50 2008 UTC vs.
Revision 1.40 by root, Tue May 27 05:36:27 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
17	This module is experimental.
18		16
19	=cut	17	=cut
20		18
21	our $VERSION = '0.04';	19	our $VERSION = '0.04';
22		20
…		…
25	use AnyEvent;	23	use AnyEvent;
26	use AnyEvent::Handle;	24	use AnyEvent::Handle;
27		25
28	my $cv = AnyEvent->condvar;	26	my $cv = AnyEvent->condvar;
29		27
30	my $ae_fh = AnyEvent::Handle->new (fh => \*STDIN);	28	my $handle =
31
32	#TODO
33
34	# or use the constructor to pass the callback:
35
36	my $ae_fh2 =
37	AnyEvent::Handle->new (	29	AnyEvent::Handle->new (
38	fh => \*STDIN,	30	fh => \*STDIN,
39	on_eof => sub {	31	on_eof => sub {
40	$cv->broadcast;	32	$cv->broadcast;
41	},	33	},
42	#TODO
43	);	34	);
44		35
45	$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;
46		47
47	=head1 DESCRIPTION	48	=head1 DESCRIPTION
48		49
49	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
50	filehandles. For utility functions for doing non-blocking connects and accepts	51	filehandles. For utility functions for doing non-blocking connects and accepts
…		…
72	The filehandle this L<AnyEvent::Handle> object will operate on.	73	The filehandle this L<AnyEvent::Handle> object will operate on.
73		74
74	NOTE: The filehandle will be set to non-blocking (using	75	NOTE: The filehandle will be set to non-blocking (using
75	AnyEvent::Util::fh_nonblocking).	76	AnyEvent::Util::fh_nonblocking).
76		77
77	=item on_eof => $cb->($self)	78	=item on_eof => $cb->($handle)
78		79
79	Set the callback to be called on EOF.	80	Set the callback to be called on EOF.
80		81
81	While not mandatory, it is highly recommended to set an eof callback,	82	While not mandatory, it is highly recommended to set an eof callback,
82	otherwise you might end up with a closed socket while you are still	83	otherwise you might end up with a closed socket while you are still
83	waiting for data.	84	waiting for data.
84		85
85	=item on_error => $cb->($self)	86	=item on_error => $cb->($handle)
86		87
87	This is the fatal error callback, that is called when, well, a fatal error	88	This is the fatal error callback, that is called when, well, a fatal error
88	occurs, such as not being able to resolve the hostname, failure to connect	89	occurs, such as not being able to resolve the hostname, failure to connect
89	or a read error.	90	or a read error.
90		91
91	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
92	called.	93	called.
93		94
94	On callback entrance, the value of C<$!> contains the operating system	95	On callback entrance, the value of C<$!> contains the operating system
95	error (or C<ENOSPC> or C<EPIPE>).	96	error (or C<ENOSPC>, C<EPIPE> or C<EBADMSG>).
		97
		98	The callback should throw an exception. If it returns, then
		99	AnyEvent::Handle will C<croak> for you.
96		100
97	While not mandatory, it is I<highly> recommended to set this callback, as	101	While not mandatory, it is I<highly> recommended to set this callback, as
98	you will not be notified of errors otherwise. The default simply calls	102	you will not be notified of errors otherwise. The default simply calls
99	die.	103	die.
100		104
101	=item on_read => $cb->($self)	105	=item on_read => $cb->($handle)
102		106
103	This sets the default read callback, which is called when data arrives	107	This sets the default read callback, which is called when data arrives
104	and no read request is in the queue.	108	and no read request is in the queue.
105		109
106	To access (and remove data from) the read buffer, use the C<< ->rbuf >>	110	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
107	method or access the C<$self->{rbuf}> member directly.	111	method or access the C<$handle->{rbuf}> member directly.
108		112
109	When an EOF condition is detected then AnyEvent::Handle will first try to	113	When an EOF condition is detected then AnyEvent::Handle will first try to
110	feed all the remaining data to the queued callbacks and C<on_read> before	114	feed all the remaining data to the queued callbacks and C<on_read> before
111	calling the C<on_eof> callback. If no progress can be made, then a fatal	115	calling the C<on_eof> callback. If no progress can be made, then a fatal
112	error will be raised (with C<$!> set to C<EPIPE>).	116	error will be raised (with C<$!> set to C<EPIPE>).
113		117
114	=item on_drain => $cb->()	118	=item on_drain => $cb->($handle)
115		119
116	This sets the callback that is called when the write buffer becomes empty	120	This sets the callback that is called when the write buffer becomes empty
117	(or when the callback is set and the buffer is empty already).	121	(or when the callback is set and the buffer is empty already).
118		122
119	To append to the write buffer, use the C<< ->push_write >> method.	123	To append to the write buffer, use the C<< ->push_write >> method.
…		…
145		149
146	When this parameter is given, it enables TLS (SSL) mode, that means it	150	When this parameter is given, it enables TLS (SSL) mode, that means it
147	will start making tls handshake and will transparently encrypt/decrypt	151	will start making tls handshake and will transparently encrypt/decrypt
148	data.	152	data.
149		153
		154	TLS mode requires Net::SSLeay to be installed (it will be loaded
		155	automatically when you try to create a TLS handle).
		156
150	For the TLS server side, use C<accept>, and for the TLS client side of a	157	For the TLS server side, use C<accept>, and for the TLS client side of a
151	connection, use C<connect> mode.	158	connection, use C<connect> mode.
152		159
153	You can also provide your own TLS connection object, but you have	160	You can also provide your own TLS connection object, but you have
154	to make sure that you call either C<Net::SSLeay::set_connect_state>	161	to make sure that you call either C<Net::SSLeay::set_connect_state>
155	or C<Net::SSLeay::set_accept_state> on it before you pass it to	162	or C<Net::SSLeay::set_accept_state> on it before you pass it to
156	AnyEvent::Handle.	163	AnyEvent::Handle.
157		164
		165	See the C<starttls> method if you need to start TLs negotiation later.
		166
158	=item tls_ctx => $ssl_ctx	167	=item tls_ctx => $ssl_ctx
159		168
160	Use the given Net::SSLeay::CTX object to create the new TLS connection	169	Use the given Net::SSLeay::CTX object to create the new TLS connection
161	(unless a connection object was specified directly). If this parameter is	170	(unless a connection object was specified directly). If this parameter is
162	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	171	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
		172
		173	=item json => JSON or JSON::XS object
		174
		175	This is the json coder object used by the C<json> read and write types.
		176
		177	If you don't supply it, then AnyEvent::Handle will use C<encode_json> and
		178	C<decode_json>.
		179
		180	Note that you are responsible to depend on the JSON module if you want to
		181	use this functionality, as AnyEvent does not have a dependency itself.
		182
		183	=item filter_r => $cb
		184
		185	=item filter_w => $cb
		186
		187	These exist, but are undocumented at this time.
163		188
164	=back	189	=back
165		190
166	=cut	191	=cut
167		192
…		…
190	}	215	}
191		216
192	sub _shutdown {	217	sub _shutdown {
193	my ($self) = @_;	218	my ($self) = @_;
194		219
195	delete $self->{rw};	220	delete $self->{_rw};
196	delete $self->{ww};	221	delete $self->{_ww};
197	delete $self->{fh};	222	delete $self->{fh};
198	}	223	}
199		224
200	sub error {	225	sub error {
201	my ($self) = @_;	226	my ($self) = @_;
…		…
203	{	228	{
204	local $!;	229	local $!;
205	$self->_shutdown;	230	$self->_shutdown;
206	}	231	}
207		232
208	if ($self->{on_error}) {
209	$self->{on_error}($self);	233	$self->{on_error}($self)
210	} else {	234	if $self->{on_error};
		235
211	die "AnyEvent::Handle uncaught fatal error: $!";	236	Carp::croak "AnyEvent::Handle uncaught fatal error: $!";
212	}
213	}	237	}
214		238
215	=item $fh = $handle->fh	239	=item $fh = $handle->fh
216		240
217	This method returns the filehandle of the L<AnyEvent::Handle> object.	241	This method returns the file handle of the L<AnyEvent::Handle> object.
218		242
219	=cut	243	=cut
220		244
221	sub fh { $_[0]->{fh} }	245	sub fh { $_[0]{fh} }
222		246
223	=item $handle->on_error ($cb)	247	=item $handle->on_error ($cb)
224		248
225	Replace the current C<on_error> callback (see the C<on_error> constructor argument).	249	Replace the current C<on_error> callback (see the C<on_error> constructor argument).
226		250
…		…
282	=cut	306	=cut
283		307
284	sub _drain_wbuf {	308	sub _drain_wbuf {
285	my ($self) = @_;	309	my ($self) = @_;
286		310
287	unless ($self->{ww}) {	311	if (!$self->{_ww} && length $self->{wbuf}) {
		312
288	Scalar::Util::weaken $self;	313	Scalar::Util::weaken $self;
		314
289	my $cb = sub {	315	my $cb = sub {
290	my $len = syswrite $self->{fh}, $self->{wbuf};	316	my $len = syswrite $self->{fh}, $self->{wbuf};
291		317
292	if ($len > 0) {	318	if ($len >= 0) {
293	substr $self->{wbuf}, 0, $len, "";	319	substr $self->{wbuf}, 0, $len, "";
294		320
295	$self->{on_drain}($self)	321	$self->{on_drain}($self)
296	if $self->{low_water_mark} >= length $self->{wbuf}	322	if $self->{low_water_mark} >= length $self->{wbuf}
297	&& $self->{on_drain};	323	&& $self->{on_drain};
298		324
299	delete $self->{ww} unless length $self->{wbuf};	325	delete $self->{_ww} unless length $self->{wbuf};
300	} elsif ($! != EAGAIN && $! != EINTR) {	326	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAWOULDBLOCK) {
301	$self->error;	327	$self->error;
302	}	328	}
303	};	329	};
304		330
		331	# try to write data immediately
		332	$cb->();
		333
		334	# if still data left in wbuf, we need to poll
305	$self->{ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb);	335	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)
306		336	if length $self->{wbuf};
307	$cb->($self);
308	};	337	};
		338	}
		339
		340	our %WH;
		341
		342	sub register_write_type($$) {
		343	$WH{$_[0]} = $_[1];
309	}	344	}
310		345
311	sub push_write {	346	sub push_write {
312	my $self = shift;	347	my $self = shift;
		348
		349	if (@_ > 1) {
		350	my $type = shift;
		351
		352	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")
		353	->($self, @_);
		354	}
313		355
314	if ($self->{filter_w}) {	356	if ($self->{filter_w}) {
315	$self->{filter_w}->($self, \$_[0]);	357	$self->{filter_w}->($self, \$_[0]);
316	} else {	358	} else {
317	$self->{wbuf} .= $_[0];	359	$self->{wbuf} .= $_[0];
318	$self->_drain_wbuf;	360	$self->_drain_wbuf;
319	}	361	}
320	}	362	}
		363
		364	=item $handle->push_write (type => @args)
		365
		366	=item $handle->unshift_write (type => @args)
		367
		368	Instead of formatting your data yourself, you can also let this module do
		369	the job by specifying a type and type-specific arguments.
		370
		371	Predefined types are (if you have ideas for additional types, feel free to
		372	drop by and tell us):
		373
		374	=over 4
		375
		376	=item netstring => $string
		377
		378	Formats the given value as netstring
		379	(http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them).
		380
		381	=back
		382
		383	=cut
		384
		385	register_write_type netstring => sub {
		386	my ($self, $string) = @_;
		387
		388	sprintf "%d:%s,", (length $string), $string
		389	};
		390
		391	=item json => $array_or_hashref
		392
		393	Encodes the given hash or array reference into a JSON object. Unless you
		394	provide your own JSON object, this means it will be encoded to JSON text
		395	in UTF-8.
		396
		397	JSON objects (and arrays) are self-delimiting, so you can write JSON at
		398	one end of a handle and read them at the other end without using any
		399	additional framing.
		400
		401	=cut
		402
		403	register_write_type json => sub {
		404	my ($self, $ref) = @_;
		405
		406	require JSON;
		407
		408	$self->{json} ? $self->{json}->encode ($ref)
		409	: JSON::encode_json ($ref)
		410	};
		411
		412	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
		413
		414	This function (not method) lets you add your own types to C<push_write>.
		415	Whenever the given C<type> is used, C<push_write> will invoke the code
		416	reference with the handle object and the remaining arguments.
		417
		418	The code reference is supposed to return a single octet string that will
		419	be appended to the write buffer.
		420
		421	Note that this is a function, and all types registered this way will be
		422	global, so try to use unique names.
		423
		424	=cut
321		425
322	#############################################################################	426	#############################################################################
323		427
324	=back	428	=back
325		429
…		…
404		508
405	if (	509	if (
406	defined $self->{rbuf_max}	510	defined $self->{rbuf_max}
407	&& $self->{rbuf_max} < length $self->{rbuf}	511	&& $self->{rbuf_max} < length $self->{rbuf}
408	) {	512	) {
409	$! = &Errno::ENOSPC; return $self->error;	513	$! = &Errno::ENOSPC;
		514	$self->error;
410	}	515	}
411		516
412	return if $self->{in_drain};	517	return if $self->{in_drain};
413	local $self->{in_drain} = 1;	518	local $self->{in_drain} = 1;
414		519
415	while (my $len = length $self->{rbuf}) {	520	while (my $len = length $self->{rbuf}) {
416	no strict 'refs';	521	no strict 'refs';
417	if (my $cb = shift @{ $self->{queue} }) {	522	if (my $cb = shift @{ $self->{_queue} }) {
418	if (!$cb->($self)) {	523	unless ($cb->($self)) {
419	if ($self->{eof}) {	524	if ($self->{_eof}) {
420	# no progress can be made (not enough data and no data forthcoming)	525	# no progress can be made (not enough data and no data forthcoming)
421	$! = &Errno::EPIPE; return $self->error;	526	$! = &Errno::EPIPE;
		527	$self->error;
422	}	528	}
423		529
424	unshift @{ $self->{queue} }, $cb;	530	unshift @{ $self->{_queue} }, $cb;
425	return;	531	return;
426	}	532	}
427	} elsif ($self->{on_read}) {	533	} elsif ($self->{on_read}) {
428	$self->{on_read}($self);	534	$self->{on_read}($self);
429		535
430	if (	536	if (
431	$self->{eof} # if no further data will arrive	537	$self->{_eof} # if no further data will arrive
432	&& $len == length $self->{rbuf} # and no data has been consumed	538	&& $len == length $self->{rbuf} # and no data has been consumed
433	&& !@{ $self->{queue} } # and the queue is still empty	539	&& !@{ $self->{_queue} } # and the queue is still empty
434	&& $self->{on_read} # and we still want to read data	540	&& $self->{on_read} # and we still want to read data
435	) {	541	) {
436	# then no progress can be made	542	# then no progress can be made
437	$! = &Errno::EPIPE; return $self->error;	543	$! = &Errno::EPIPE;
		544	$self->error;
438	}	545	}
439	} else {	546	} else {
440	# read side becomes idle	547	# read side becomes idle
441	delete $self->{rw};	548	delete $self->{_rw};
442	return;	549	return;
443	}	550	}
444	}	551	}
445		552
446	if ($self->{eof}) {	553	if ($self->{_eof}) {
447	$self->_shutdown;	554	$self->_shutdown;
448	$self->{on_eof}($self)	555	$self->{on_eof}($self)
449	if $self->{on_eof};	556	if $self->{on_eof};
450	}	557	}
451	}	558	}
…		…
500	interested in (which can be none at all) and return a true value. After returning	607	interested in (which can be none at all) and return a true value. After returning
501	true, it will be removed from the queue.	608	true, it will be removed from the queue.
502		609
503	=cut	610	=cut
504		611
		612	our %RH;
		613
		614	sub register_read_type($$) {
		615	$RH{$_[0]} = $_[1];
		616	}
		617
505	sub push_read {	618	sub push_read {
506	my ($self, $cb) = @_;	619	my $self = shift;
		620	my $cb = pop;
507		621
		622	if (@_) {
		623	my $type = shift;
		624
		625	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
		626	->($self, $cb, @_);
		627	}
		628
508	push @{ $self->{queue} }, $cb;	629	push @{ $self->{_queue} }, $cb;
509	$self->_drain_rbuf;	630	$self->_drain_rbuf;
510	}	631	}
511		632
512	sub unshift_read {	633	sub unshift_read {
513	my ($self, $cb) = @_;	634	my $self = shift;
		635	my $cb = pop;
514		636
		637	if (@_) {
		638	my $type = shift;
		639
		640	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")
		641	->($self, $cb, @_);
		642	}
		643
		644
515	push @{ $self->{queue} }, $cb;	645	unshift @{ $self->{_queue} }, $cb;
516	$self->_drain_rbuf;	646	$self->_drain_rbuf;
517	}	647	}
518		648
519	=item $handle->push_read_chunk ($len, $cb->($self, $data))	649	=item $handle->push_read (type => @args, $cb)
520		650
521	=item $handle->unshift_read_chunk ($len, $cb->($self, $data))	651	=item $handle->unshift_read (type => @args, $cb)
522		652
523	Append the given callback to the end of the queue (C<push_read_chunk>) or	653	Instead of providing a callback that parses the data itself you can chose
524	prepend it (C<unshift_read_chunk>).	654	between a number of predefined parsing formats, for chunks of data, lines
		655	etc.
525		656
526	The callback will be called only once C<$len> bytes have been read, and	657	Predefined types are (if you have ideas for additional types, feel free to
527	these C<$len> bytes will be passed to the callback.	658	drop by and tell us):
528		659
529	=cut	660	=over 4
530		661
531	sub _read_chunk($$) {	662	=item chunk => $octets, $cb->($handle, $data)
		663
		664	Invoke the callback only once C<$octets> bytes have been read. Pass the
		665	data read to the callback. The callback will never be called with less
		666	data.
		667
		668	Example: read 2 bytes.
		669
		670	$handle->push_read (chunk => 2, sub {
		671	warn "yay ", unpack "H*", $_[1];
		672	});
		673
		674	=cut
		675
		676	register_read_type chunk => sub {
532	my ($self, $len, $cb) = @_;	677	my ($self, $cb, $len) = @_;
533		678
534	sub {	679	sub {
535	$len <= length $_[0]{rbuf} or return;	680	$len <= length $_[0]{rbuf} or return;
536	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");	681	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");
537	1	682	1
538	}	683	}
539	}	684	};
540		685
		686	# compatibility with older API
541	sub push_read_chunk {	687	sub push_read_chunk {
542	$_[0]->push_read (&_read_chunk);	688	$_[0]->push_read (chunk => $_[1], $_[2]);
543	}	689	}
544
545		690
546	sub unshift_read_chunk {	691	sub unshift_read_chunk {
547	$_[0]->unshift_read (&_read_chunk);	692	$_[0]->unshift_read (chunk => $_[1], $_[2]);
548	}	693	}
549		694
550	=item $handle->push_read_line ([$eol, ]$cb->($self, $line, $eol))	695	=item line => [$eol, ]$cb->($handle, $line, $eol)
551
552	=item $handle->unshift_read_line ([$eol, ]$cb->($self, $line, $eol))
553
554	Append the given callback to the end of the queue (C<push_read_line>) or
555	prepend it (C<unshift_read_line>).
556		696
557	The callback will be called only once a full line (including the end of	697	The callback will be called only once a full line (including the end of
558	line marker, C<$eol>) has been read. This line (excluding the end of line	698	line marker, C<$eol>) has been read. This line (excluding the end of line
559	marker) will be passed to the callback as second argument (C<$line>), and	699	marker) will be passed to the callback as second argument (C<$line>), and
560	the end of line marker as the third argument (C<$eol>).	700	the end of line marker as the third argument (C<$eol>).
…		…
571	Partial lines at the end of the stream will never be returned, as they are	711	Partial lines at the end of the stream will never be returned, as they are
572	not marked by the end of line marker.	712	not marked by the end of line marker.
573		713
574	=cut	714	=cut
575		715
576	sub _read_line($$) {	716	register_read_type line => sub {
577	my $self = shift;	717	my ($self, $cb, $eol) = @_;
578	my $cb = pop;
579	my $eol = @_ ? shift : qr\|(\015?\012)\|;
580	my $pos;
581		718
		719	$eol = qr\|(\015?\012)\| if @_ < 3;
582	$eol = quotemeta $eol unless ref $eol;	720	$eol = quotemeta $eol unless ref $eol;
583	$eol = qr\|^(.*?)($eol)\|s;	721	$eol = qr\|^(.*?)($eol)\|s;
584		722
585	sub {	723	sub {
586	$_[0]{rbuf} =~ s/$eol// or return;	724	$_[0]{rbuf} =~ s/$eol// or return;
587		725
588	$cb->($_[0], $1, $2);	726	$cb->($_[0], $1, $2);
589	1	727	1
590	}	728	}
591	}	729	};
592		730
		731	# compatibility with older API
593	sub push_read_line {	732	sub push_read_line {
594	$_[0]->push_read (&_read_line);	733	my $self = shift;
		734	$self->push_read (line => @_);
595	}	735	}
596		736
597	sub unshift_read_line {	737	sub unshift_read_line {
598	$_[0]->unshift_read (&_read_line);	738	my $self = shift;
		739	$self->unshift_read (line => @_);
599	}	740	}
		741
		742	=item netstring => $cb->($handle, $string)
		743
		744	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
		745
		746	Throws an error with C<$!> set to EBADMSG on format violations.
		747
		748	=cut
		749
		750	register_read_type netstring => sub {
		751	my ($self, $cb) = @_;
		752
		753	sub {
		754	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
		755	if ($_[0]{rbuf} =~ /[^0-9]/) {
		756	$! = &Errno::EBADMSG;
		757	$self->error;
		758	}
		759	return;
		760	}
		761
		762	my $len = $1;
		763
		764	$self->unshift_read (chunk => $len, sub {
		765	my $string = $_[1];
		766	$_[0]->unshift_read (chunk => 1, sub {
		767	if ($_[1] eq ",") {
		768	$cb->($_[0], $string);
		769	} else {
		770	$! = &Errno::EBADMSG;
		771	$self->error;
		772	}
		773	});
		774	});
		775
		776	1
		777	}
		778	};
		779
		780	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
		781
		782	Makes a regex match against the regex object C<$accept> and returns
		783	everything up to and including the match.
		784
		785	Example: read a single line terminated by '\n'.
		786
		787	$handle->push_read (regex => qr<\n>, sub { ... });
		788
		789	If C<$reject> is given and not undef, then it determines when the data is
		790	to be rejected: it is matched against the data when the C<$accept> regex
		791	does not match and generates an C<EBADMSG> error when it matches. This is
		792	useful to quickly reject wrong data (to avoid waiting for a timeout or a
		793	receive buffer overflow).
		794
		795	Example: expect a single decimal number followed by whitespace, reject
		796	anything else (not the use of an anchor).
		797
		798	$handle->push_read (regex => qr<^[0-9]+\s>, qr<[^0-9]>, sub { ... });
		799
		800	If C<$skip> is given and not C<undef>, then it will be matched against
		801	the receive buffer when neither C<$accept> nor C<$reject> match,
		802	and everything preceding and including the match will be accepted
		803	unconditionally. This is useful to skip large amounts of data that you
		804	know cannot be matched, so that the C<$accept> or C<$reject> regex do not
		805	have to start matching from the beginning. This is purely an optimisation
		806	and is usually worth only when you expect more than a few kilobytes.
		807
		808	Example: expect a http header, which ends at C<\015\012\015\012>. Since we
		809	expect the header to be very large (it isn't in practise, but...), we use
		810	a skip regex to skip initial portions. The skip regex is tricky in that
		811	it only accepts something not ending in either \015 or \012, as these are
		812	required for the accept regex.
		813
		814	$handle->push_read (regex =>
		815	qr<\015\012\015\012>,
		816	undef, # no reject
		817	qr<^.*[^\015\012]>,
		818	sub { ... });
		819
		820	=cut
		821
		822	register_read_type regex => sub {
		823	my ($self, $cb, $accept, $reject, $skip) = @_;
		824
		825	my $data;
		826	my $rbuf = \$self->{rbuf};
		827
		828	sub {
		829	# accept
		830	if ($$rbuf =~ $accept) {
		831	$data .= substr $$rbuf, 0, $+[0], "";
		832	$cb->($self, $data);
		833	return 1;
		834	}
		835
		836	# reject
		837	if ($reject && $$rbuf =~ $reject) {
		838	$! = &Errno::EBADMSG;
		839	$self->error;
		840	}
		841
		842	# skip
		843	if ($skip && $$rbuf =~ $skip) {
		844	$data .= substr $$rbuf, 0, $+[0], "";
		845	}
		846
		847	()
		848	}
		849	};
		850
		851	=item json => $cb->($handle, $hash_or_arrayref)
		852
		853	Reads a JSON object or array, decodes it and passes it to the callback.
		854
		855	If a C<json> object was passed to the constructor, then that will be used
		856	for the final decode, otherwise it will create a JSON coder expecting UTF-8.
		857
		858	This read type uses the incremental parser available with JSON version
		859	2.09 (and JSON::XS version 2.2) and above. You have to provide a
		860	dependency on your own: this module will load the JSON module, but
		861	AnyEvent does not depend on it itself.
		862
		863	Since JSON texts are fully self-delimiting, the C<json> read and write
		864	types are an ideal simple RPC protocol: just exchange JSON datagrams.
		865
		866	=cut
		867
		868	register_read_type json => sub {
		869	my ($self, $cb, $accept, $reject, $skip) = @_;
		870
		871	require JSON;
		872
		873	my $data;
		874	my $rbuf = \$self->{rbuf};
		875
		876	my $json = $self->{json} \|\|= JSON::XS->new->utf8;
		877
		878	sub {
		879	my $ref = $json->incr_parse ($self->{rbuf});
		880
		881	if ($ref) {
		882	$self->{rbuf} = $json->incr_text;
		883	$json->incr_text = "";
		884	$cb->($self, $ref);
		885
		886	1
		887	} else {
		888	$self->{rbuf} = "";
		889	()
		890	}
		891	}
		892	};
		893
		894	=back
		895
		896	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)
		897
		898	This function (not method) lets you add your own types to C<push_read>.
		899
		900	Whenever the given C<type> is used, C<push_read> will invoke the code
		901	reference with the handle object, the callback and the remaining
		902	arguments.
		903
		904	The code reference is supposed to return a callback (usually a closure)
		905	that works as a plain read callback (see C<< ->push_read ($cb) >>).
		906
		907	It should invoke the passed callback when it is done reading (remember to
		908	pass C<$handle> as first argument as all other callbacks do that).
		909
		910	Note that this is a function, and all types registered this way will be
		911	global, so try to use unique names.
		912
		913	For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>,
		914	search for C<register_read_type>)).
600		915
601	=item $handle->stop_read	916	=item $handle->stop_read
602		917
603	=item $handle->start_read	918	=item $handle->start_read
604		919
605	In rare cases you actually do not want to read anything from the	920	In rare cases you actually do not want to read anything from the
606	socket. In this case you can call C<stop_read>. Neither C<on_read> no	921	socket. In this case you can call C<stop_read>. Neither C<on_read> no
607	any queued callbacks will be executed then. To start readign again, call	922	any queued callbacks will be executed then. To start reading again, call
608	C<start_read>.	923	C<start_read>.
609		924
610	=cut	925	=cut
611		926
612	sub stop_read {	927	sub stop_read {
613	my ($self) = @_;	928	my ($self) = @_;
614		929
615	delete $self->{rw};	930	delete $self->{_rw};
616	}	931	}
617		932
618	sub start_read {	933	sub start_read {
619	my ($self) = @_;	934	my ($self) = @_;
620		935
621	unless ($self->{rw} \|\| $self->{eof}) {	936	unless ($self->{_rw} \|\| $self->{_eof}) {
622	Scalar::Util::weaken $self;	937	Scalar::Util::weaken $self;
623		938
624	$self->{rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	939	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
625	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	940	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};
626	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;	941	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;
627		942
628	if ($len > 0) {	943	if ($len > 0) {
629	$self->{filter_r}	944	$self->{filter_r}
630	? $self->{filter_r}->($self, $rbuf)	945	? $self->{filter_r}->($self, $rbuf)
631	: $self->_drain_rbuf;	946	: $self->_drain_rbuf;
632		947
633	} elsif (defined $len) {	948	} elsif (defined $len) {
634	delete $self->{rw};	949	delete $self->{_rw};
635	$self->{eof} = 1;	950	$self->{_eof} = 1;
636	$self->_drain_rbuf;	951	$self->_drain_rbuf;
637		952
638	} elsif ($! != EAGAIN && $! != EINTR) {	953	} elsif ($! != EAGAIN && $! != EINTR && $! != &AnyEvent::Util::WSAWOULDBLOCK) {
639	return $self->error;	954	return $self->error;
640	}	955	}
641	});	956	});
642	}	957	}
643	}	958	}
644		959
645	sub _dotls {	960	sub _dotls {
646	my ($self) = @_;	961	my ($self) = @_;
647		962
648	if (length $self->{tls_wbuf}) {	963	if (length $self->{_tls_wbuf}) {
649	my $len = Net::SSLeay::write ($self->{tls}, $self->{tls_wbuf});	964	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
650	substr $self->{tls_wbuf}, 0, $len, "" if $len > 0;	965	substr $self->{_tls_wbuf}, 0, $len, "";
		966	}
651	}	967	}
652		968
653	if (defined (my $buf = Net::SSLeay::BIO_read ($self->{tls_wbio}))) {	969	if (defined (my $buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {
654	$self->{wbuf} .= $buf;	970	$self->{wbuf} .= $buf;
655	$self->_drain_wbuf;	971	$self->_drain_wbuf;
656	}	972	}
657		973
658	if (defined (my $buf = Net::SSLeay::read ($self->{tls}))) {	974	while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) {
659	$self->{rbuf} .= $buf;	975	$self->{rbuf} .= $buf;
660	$self->_drain_rbuf;	976	$self->_drain_rbuf;
661	} elsif (	977	}
		978
662	(my $err = Net::SSLeay::get_error ($self->{tls}, -1))	979	my $err = Net::SSLeay::get_error ($self->{tls}, -1);
		980
663	!= Net::SSLeay::ERROR_WANT_READ ()	981	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
664	) {
665	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {	982	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {
666	$self->error;	983	$self->error;
667	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {	984	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {
668	$! = &Errno::EIO;	985	$! = &Errno::EIO;
669	$self->error;	986	$self->error;
…		…
671		988
672	# all others are fine for our purposes	989	# all others are fine for our purposes
673	}	990	}
674	}	991	}
675		992
		993	=item $handle->starttls ($tls[, $tls_ctx])
		994
		995	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
		996	object is created, you can also do that at a later time by calling
		997	C<starttls>.
		998
		999	The first argument is the same as the C<tls> constructor argument (either
		1000	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
		1001
		1002	The second argument is the optional C<Net::SSLeay::CTX> object that is
		1003	used when AnyEvent::Handle has to create its own TLS connection object.
		1004
		1005	The TLS connection object will end up in C<< $handle->{tls} >> after this
		1006	call and can be used or changed to your liking. Note that the handshake
		1007	might have already started when this function returns.
		1008
		1009	=cut
		1010
676	# TODO: maybe document...	1011	# TODO: maybe document...
677	sub starttls {	1012	sub starttls {
678	my ($self, $ssl, $ctx) = @_;	1013	my ($self, $ssl, $ctx) = @_;
		1014
		1015	$self->stoptls;
679		1016
680	if ($ssl eq "accept") {	1017	if ($ssl eq "accept") {
681	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1018	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());
682	Net::SSLeay::set_accept_state ($ssl);	1019	Net::SSLeay::set_accept_state ($ssl);
683	} elsif ($ssl eq "connect") {	1020	} elsif ($ssl eq "connect") {
…		…
685	Net::SSLeay::set_connect_state ($ssl);	1022	Net::SSLeay::set_connect_state ($ssl);
686	}	1023	}
687		1024
688	$self->{tls} = $ssl;	1025	$self->{tls} = $ssl;
689		1026
		1027	# basically, this is deep magic (because SSL_read should have the same issues)
		1028	# but the openssl maintainers basically said: "trust us, it just works".
		1029	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
		1030	# and mismaintained ssleay-module doesn't even offer them).
		1031	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
		1032	Net::SSLeay::CTX_set_mode ($self->{tls},
		1033	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
		1034	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
		1035
690	$self->{tls_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1036	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
691	$self->{tls_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1037	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
692		1038
693	Net::SSLeay::set_bio ($ssl, $self->{tls_rbio}, $self->{tls_wbio});	1039	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
694		1040
695	$self->{filter_w} = sub {	1041	$self->{filter_w} = sub {
696	$_[0]{tls_wbuf} .= ${$_[1]};	1042	$_[0]{_tls_wbuf} .= ${$_[1]};
697	&_dotls;	1043	&_dotls;
698	};	1044	};
699	$self->{filter_r} = sub {	1045	$self->{filter_r} = sub {
700	Net::SSLeay::BIO_write ($_[0]{tls_rbio}, ${$_[1]});	1046	Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});
701	&_dotls;	1047	&_dotls;
702	};	1048	};
703	}	1049	}
704		1050
		1051	=item $handle->stoptls
		1052
		1053	Destroys the SSL connection, if any. Partial read or write data will be
		1054	lost.
		1055
		1056	=cut
		1057
		1058	sub stoptls {
		1059	my ($self) = @_;
		1060
		1061	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};
		1062
		1063	delete $self->{_rbio};
		1064	delete $self->{_wbio};
		1065	delete $self->{_tls_wbuf};
		1066	delete $self->{filter_r};
		1067	delete $self->{filter_w};
		1068	}
		1069
705	sub DESTROY {	1070	sub DESTROY {
706	my $self = shift;	1071	my $self = shift;
707		1072
708	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};	1073	$self->stoptls;
709	}	1074	}
710		1075
711	=item AnyEvent::Handle::TLS_CTX	1076	=item AnyEvent::Handle::TLS_CTX
712		1077
713	This function creates and returns the Net::SSLeay::CTX object used by	1078	This function creates and returns the Net::SSLeay::CTX object used by
…		…
743	}	1108	}
744	}	1109	}
745		1110
746	=back	1111	=back
747		1112
		1113	=head1 SUBCLASSING AnyEvent::Handle
		1114
		1115	In many cases, you might want to subclass AnyEvent::Handle.
		1116
		1117	To make this easier, a given version of AnyEvent::Handle uses these
		1118	conventions:
		1119
		1120	=over 4
		1121
		1122	=item * all constructor arguments become object members.
		1123
		1124	At least initially, when you pass a C<tls>-argument to the constructor it
		1125	will end up in C<< $handle->{tls} >>. Those members might be changes or
		1126	mutated later on (for example C<tls> will hold the TLS connection object).
		1127
		1128	=item * other object member names are prefixed with an C<_>.
		1129
		1130	All object members not explicitly documented (internal use) are prefixed
		1131	with an underscore character, so the remaining non-C<_>-namespace is free
		1132	for use for subclasses.
		1133
		1134	=item * all members not documented here and not prefixed with an underscore
		1135	are free to use in subclasses.
		1136
		1137	Of course, new versions of AnyEvent::Handle may introduce more "public"
		1138	member variables, but thats just life, at least it is documented.
		1139
		1140	=back
		1141
748	=head1 AUTHOR	1142	=head1 AUTHOR
749		1143
750	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.	1144	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.
751		1145
752	=cut	1146	=cut

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.20 by elmex, Sat May 24 08:16:50 2008 UTC vs. Revision 1.40 by root, Tue May 27 05:36:27 2008 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.20 by elmex, Sat May 24 08:16:50 2008 UTC vs.
Revision 1.40 by root, Tue May 27 05:36:27 2008 UTC