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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.29 by root, Sat May 24 23:10:18 2008 UTC vs.
Revision 1.41 by root, Tue May 27 05:47:36 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 file handles via AnyEvent	15	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent
16		16
17	This module is experimental.
18
19	=cut	17	=cut
20		18
21	our $VERSION = '0.04';	19	our $VERSION = '0.04';
22		20
23	=head1 SYNOPSIS	21	=head1 SYNOPSIS
…		…
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
…		…
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>, C<EPIPE> or C<EBADMSG>).	96	error (or C<ENOSPC>, C<EPIPE> or C<EBADMSG>).
96		97
		98	The callback should throw an exception. If it returns, then
		99	AnyEvent::Handle will C<croak> for you.
		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.
…		…
164		168
165	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
166	(unless a connection object was specified directly). If this parameter is	170	(unless a connection object was specified directly). If this parameter is
167	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	171	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
168		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 create and use a
		178	suitable one, which will write and expect UTF-8 encoded JSON texts.
		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.
		188
169	=back	189	=back
170		190
171	=cut	191	=cut
172
173	our (%RH, %WH);
174
175	sub register_read_type($$) {
176	$RH{$_[0]} = $_[1];
177	}
178
179	sub register_write_type($$) {
180	$WH{$_[0]} = $_[1];
181	}
182		192
183	sub new {	193	sub new {
184	my $class = shift;	194	my $class = shift;
185		195
186	my $self = bless { @_ }, $class;	196	my $self = bless { @_ }, $class;
…		…
205	}	215	}
206		216
207	sub _shutdown {	217	sub _shutdown {
208	my ($self) = @_;	218	my ($self) = @_;
209		219
210	delete $self->{rw};	220	delete $self->{_rw};
211	delete $self->{ww};	221	delete $self->{_ww};
212	delete $self->{fh};	222	delete $self->{fh};
213	}	223	}
214		224
215	sub error {	225	sub error {
216	my ($self) = @_;	226	my ($self) = @_;
…		…
218	{	228	{
219	local $!;	229	local $!;
220	$self->_shutdown;	230	$self->_shutdown;
221	}	231	}
222		232
223	if ($self->{on_error}) {
224	$self->{on_error}($self);	233	$self->{on_error}($self)
225	} else {	234	if $self->{on_error};
		235
226	Carp::croak "AnyEvent::Handle uncaught fatal error: $!";	236	Carp::croak "AnyEvent::Handle uncaught fatal error: $!";
227	}
228	}	237	}
229		238
230	=item $fh = $handle->fh	239	=item $fh = $handle->fh
231		240
232	This method returns the file handle of the L<AnyEvent::Handle> object.	241	This method returns the file handle of the L<AnyEvent::Handle> object.
233		242
234	=cut	243	=cut
235		244
236	sub fh { $_[0]->{fh} }	245	sub fh { $_[0]{fh} }
237		246
238	=item $handle->on_error ($cb)	247	=item $handle->on_error ($cb)
239		248
240	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).
241		250
…		…
297	=cut	306	=cut
298		307
299	sub _drain_wbuf {	308	sub _drain_wbuf {
300	my ($self) = @_;	309	my ($self) = @_;
301		310
302	if (!$self->{ww} && length $self->{wbuf}) {	311	if (!$self->{_ww} && length $self->{wbuf}) {
		312
303	Scalar::Util::weaken $self;	313	Scalar::Util::weaken $self;
		314
304	my $cb = sub {	315	my $cb = sub {
305	my $len = syswrite $self->{fh}, $self->{wbuf};	316	my $len = syswrite $self->{fh}, $self->{wbuf};
306		317
307	if ($len >= 0) {	318	if ($len >= 0) {
308	substr $self->{wbuf}, 0, $len, "";	319	substr $self->{wbuf}, 0, $len, "";
309		320
310	$self->{on_drain}($self)	321	$self->{on_drain}($self)
311	if $self->{low_water_mark} >= length $self->{wbuf}	322	if $self->{low_water_mark} >= length $self->{wbuf}
312	&& $self->{on_drain};	323	&& $self->{on_drain};
313		324
314	delete $self->{ww} unless length $self->{wbuf};	325	delete $self->{_ww} unless length $self->{wbuf};
315	} elsif ($! != EAGAIN && $! != EINTR) {	326	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAWOULDBLOCK) {
316	$self->error;	327	$self->error;
317	}	328	}
318	};	329	};
319		330
		331	# try to write data immediately
		332	$cb->();
		333
		334	# if still data left in wbuf, we need to poll
320	$self->{ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb);	335	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)
321		336	if length $self->{wbuf};
322	$cb->($self);
323	};	337	};
		338	}
		339
		340	our %WH;
		341
		342	sub register_write_type($$) {
		343	$WH{$_[0]} = $_[1];
324	}	344	}
325		345
326	sub push_write {	346	sub push_write {
327	my $self = shift;	347	my $self = shift;
328		348
…		…
346	=item $handle->unshift_write (type => @args)	366	=item $handle->unshift_write (type => @args)
347		367
348	Instead of formatting your data yourself, you can also let this module do	368	Instead of formatting your data yourself, you can also let this module do
349	the job by specifying a type and type-specific arguments.	369	the job by specifying a type and type-specific arguments.
350		370
351	Predefined types are:	371	Predefined types are (if you have ideas for additional types, feel free to
		372	drop by and tell us):
352		373
353	=over 4	374	=over 4
354		375
355	=item netstring => $string	376	=item netstring => $string
356		377
357	Formats the given value as netstring	378	Formats the given value as netstring
358	(http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them).	379	(http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them).
359		380
		381	=back
		382
360	=cut	383	=cut
361		384
362	register_write_type netstring => sub {	385	register_write_type netstring => sub {
363	my ($self, $string) = @_;	386	my ($self, $string) = @_;
364		387
365	sprintf "%d:%s,", (length $string), $string	388	sprintf "%d:%s,", (length $string), $string
366	};	389	};
367		390
368	=back	391	=item json => $array_or_hashref
369		392
370	=cut	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.
371		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.
372		400
		401	The generated JSON text is guaranteed not to contain any newlines: While
		402	this module doesn't need delimiters after or between JSON texts to be
		403	able to read them, many other languages depend on that.
		404
		405	A simple RPC protocol that interoperates easily with others is to send
		406	JSON arrays (or objects, although arrays are usually the better choice as
		407	they mimic how function argument passing works) and a newline after each
		408	JSON text:
		409
		410	$handle->push_write (json => ["method", "arg1", "arg2"]); # whatever
		411	$handle->push_write ("\012");
		412
		413	An AnyEvent::Handle receiver would simply use the C<json> read type and
		414	rely on the fact that the newline will be skipped as leading whitespace:
		415
		416	$handle->push_read (json => sub { my $array = $_[1]; ... });
		417
		418	Other languages could read single lines terminated by a newline and pass
		419	this line into their JSON decoder of choice.
		420
		421	=cut
		422
		423	register_write_type json => sub {
		424	my ($self, $ref) = @_;
		425
		426	require JSON;
		427
		428	$self->{json} ? $self->{json}->encode ($ref)
		429	: JSON::encode_json ($ref)
		430	};
		431
		432	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
		433
		434	This function (not method) lets you add your own types to C<push_write>.
		435	Whenever the given C<type> is used, C<push_write> will invoke the code
		436	reference with the handle object and the remaining arguments.
		437
		438	The code reference is supposed to return a single octet string that will
		439	be appended to the write buffer.
		440
		441	Note that this is a function, and all types registered this way will be
		442	global, so try to use unique names.
		443
		444	=cut
373		445
374	#############################################################################	446	#############################################################################
375		447
376	=back	448	=back
377		449
…		…
456		528
457	if (	529	if (
458	defined $self->{rbuf_max}	530	defined $self->{rbuf_max}
459	&& $self->{rbuf_max} < length $self->{rbuf}	531	&& $self->{rbuf_max} < length $self->{rbuf}
460	) {	532	) {
461	$! = &Errno::ENOSPC; return $self->error;	533	$! = &Errno::ENOSPC;
		534	$self->error;
462	}	535	}
463		536
464	return if $self->{in_drain};	537	return if $self->{in_drain};
465	local $self->{in_drain} = 1;	538	local $self->{in_drain} = 1;
466		539
467	while (my $len = length $self->{rbuf}) {	540	while (my $len = length $self->{rbuf}) {
468	no strict 'refs';	541	no strict 'refs';
469	if (my $cb = shift @{ $self->{queue} }) {	542	if (my $cb = shift @{ $self->{_queue} }) {
470	unless ($cb->($self)) {	543	unless ($cb->($self)) {
471	if ($self->{eof}) {	544	if ($self->{_eof}) {
472	# no progress can be made (not enough data and no data forthcoming)	545	# no progress can be made (not enough data and no data forthcoming)
473	$! = &Errno::EPIPE; return $self->error;	546	$! = &Errno::EPIPE;
		547	$self->error;
474	}	548	}
475		549
476	unshift @{ $self->{queue} }, $cb;	550	unshift @{ $self->{_queue} }, $cb;
477	return;	551	return;
478	}	552	}
479	} elsif ($self->{on_read}) {	553	} elsif ($self->{on_read}) {
480	$self->{on_read}($self);	554	$self->{on_read}($self);
481		555
482	if (	556	if (
483	$self->{eof} # if no further data will arrive	557	$self->{_eof} # if no further data will arrive
484	&& $len == length $self->{rbuf} # and no data has been consumed	558	&& $len == length $self->{rbuf} # and no data has been consumed
485	&& !@{ $self->{queue} } # and the queue is still empty	559	&& !@{ $self->{_queue} } # and the queue is still empty
486	&& $self->{on_read} # and we still want to read data	560	&& $self->{on_read} # and we still want to read data
487	) {	561	) {
488	# then no progress can be made	562	# then no progress can be made
489	$! = &Errno::EPIPE; return $self->error;	563	$! = &Errno::EPIPE;
		564	$self->error;
490	}	565	}
491	} else {	566	} else {
492	# read side becomes idle	567	# read side becomes idle
493	delete $self->{rw};	568	delete $self->{_rw};
494	return;	569	return;
495	}	570	}
496	}	571	}
497		572
498	if ($self->{eof}) {	573	if ($self->{_eof}) {
499	$self->_shutdown;	574	$self->_shutdown;
500	$self->{on_eof}($self)	575	$self->{on_eof}($self)
501	if $self->{on_eof};	576	if $self->{on_eof};
502	}	577	}
503	}	578	}
…		…
552	interested in (which can be none at all) and return a true value. After returning	627	interested in (which can be none at all) and return a true value. After returning
553	true, it will be removed from the queue.	628	true, it will be removed from the queue.
554		629
555	=cut	630	=cut
556		631
		632	our %RH;
		633
		634	sub register_read_type($$) {
		635	$RH{$_[0]} = $_[1];
		636	}
		637
557	sub push_read {	638	sub push_read {
558	my $self = shift;	639	my $self = shift;
559	my $cb = pop;	640	my $cb = pop;
560		641
561	if (@_) {	642	if (@_) {
…		…
563		644
564	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	645	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
565	->($self, $cb, @_);	646	->($self, $cb, @_);
566	}	647	}
567		648
568	push @{ $self->{queue} }, $cb;	649	push @{ $self->{_queue} }, $cb;
569	$self->_drain_rbuf;	650	$self->_drain_rbuf;
570	}	651	}
571		652
572	sub unshift_read {	653	sub unshift_read {
573	my $self = shift;	654	my $self = shift;
…		…
579	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")	660	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")
580	->($self, $cb, @_);	661	->($self, $cb, @_);
581	}	662	}
582		663
583		664
584	unshift @{ $self->{queue} }, $cb;	665	unshift @{ $self->{_queue} }, $cb;
585	$self->_drain_rbuf;	666	$self->_drain_rbuf;
586	}	667	}
587		668
588	=item $handle->push_read (type => @args, $cb)	669	=item $handle->push_read (type => @args, $cb)
589		670
…		…
591		672
592	Instead of providing a callback that parses the data itself you can chose	673	Instead of providing a callback that parses the data itself you can chose
593	between a number of predefined parsing formats, for chunks of data, lines	674	between a number of predefined parsing formats, for chunks of data, lines
594	etc.	675	etc.
595		676
596	The types currently supported are:	677	Predefined types are (if you have ideas for additional types, feel free to
		678	drop by and tell us):
597		679
598	=over 4	680	=over 4
599		681
600	=item chunk => $octets, $cb->($self, $data)	682	=item chunk => $octets, $cb->($handle, $data)
601		683
602	Invoke the callback only once C<$octets> bytes have been read. Pass the	684	Invoke the callback only once C<$octets> bytes have been read. Pass the
603	data read to the callback. The callback will never be called with less	685	data read to the callback. The callback will never be called with less
604	data.	686	data.
605		687
…		…
628		710
629	sub unshift_read_chunk {	711	sub unshift_read_chunk {
630	$_[0]->unshift_read (chunk => $_[1], $_[2]);	712	$_[0]->unshift_read (chunk => $_[1], $_[2]);
631	}	713	}
632		714
633	=item line => [$eol, ]$cb->($self, $line, $eol)	715	=item line => [$eol, ]$cb->($handle, $line, $eol)
634		716
635	The callback will be called only once a full line (including the end of	717	The callback will be called only once a full line (including the end of
636	line marker, C<$eol>) has been read. This line (excluding the end of line	718	line marker, C<$eol>) has been read. This line (excluding the end of line
637	marker) will be passed to the callback as second argument (C<$line>), and	719	marker) will be passed to the callback as second argument (C<$line>), and
638	the end of line marker as the third argument (C<$eol>).	720	the end of line marker as the third argument (C<$eol>).
…		…
675	sub unshift_read_line {	757	sub unshift_read_line {
676	my $self = shift;	758	my $self = shift;
677	$self->unshift_read (line => @_);	759	$self->unshift_read (line => @_);
678	}	760	}
679		761
680	=item netstring => $cb->($string)	762	=item netstring => $cb->($handle, $string)
681		763
682	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).	764	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
683		765
684	Throws an error with C<$!> set to EBADMSG on format violations.	766	Throws an error with C<$!> set to EBADMSG on format violations.
685		767
…		…
713		795
714	1	796	1
715	}	797	}
716	};	798	};
717		799
		800	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
		801
		802	Makes a regex match against the regex object C<$accept> and returns
		803	everything up to and including the match.
		804
		805	Example: read a single line terminated by '\n'.
		806
		807	$handle->push_read (regex => qr<\n>, sub { ... });
		808
		809	If C<$reject> is given and not undef, then it determines when the data is
		810	to be rejected: it is matched against the data when the C<$accept> regex
		811	does not match and generates an C<EBADMSG> error when it matches. This is
		812	useful to quickly reject wrong data (to avoid waiting for a timeout or a
		813	receive buffer overflow).
		814
		815	Example: expect a single decimal number followed by whitespace, reject
		816	anything else (not the use of an anchor).
		817
		818	$handle->push_read (regex => qr<^[0-9]+\s>, qr<[^0-9]>, sub { ... });
		819
		820	If C<$skip> is given and not C<undef>, then it will be matched against
		821	the receive buffer when neither C<$accept> nor C<$reject> match,
		822	and everything preceding and including the match will be accepted
		823	unconditionally. This is useful to skip large amounts of data that you
		824	know cannot be matched, so that the C<$accept> or C<$reject> regex do not
		825	have to start matching from the beginning. This is purely an optimisation
		826	and is usually worth only when you expect more than a few kilobytes.
		827
		828	Example: expect a http header, which ends at C<\015\012\015\012>. Since we
		829	expect the header to be very large (it isn't in practise, but...), we use
		830	a skip regex to skip initial portions. The skip regex is tricky in that
		831	it only accepts something not ending in either \015 or \012, as these are
		832	required for the accept regex.
		833
		834	$handle->push_read (regex =>
		835	qr<\015\012\015\012>,
		836	undef, # no reject
		837	qr<^.*[^\015\012]>,
		838	sub { ... });
		839
		840	=cut
		841
		842	register_read_type regex => sub {
		843	my ($self, $cb, $accept, $reject, $skip) = @_;
		844
		845	my $data;
		846	my $rbuf = \$self->{rbuf};
		847
		848	sub {
		849	# accept
		850	if ($$rbuf =~ $accept) {
		851	$data .= substr $$rbuf, 0, $+[0], "";
		852	$cb->($self, $data);
		853	return 1;
		854	}
		855
		856	# reject
		857	if ($reject && $$rbuf =~ $reject) {
		858	$! = &Errno::EBADMSG;
		859	$self->error;
		860	}
		861
		862	# skip
		863	if ($skip && $$rbuf =~ $skip) {
		864	$data .= substr $$rbuf, 0, $+[0], "";
		865	}
		866
		867	()
		868	}
		869	};
		870
		871	=item json => $cb->($handle, $hash_or_arrayref)
		872
		873	Reads a JSON object or array, decodes it and passes it to the callback.
		874
		875	If a C<json> object was passed to the constructor, then that will be used
		876	for the final decode, otherwise it will create a JSON coder expecting UTF-8.
		877
		878	This read type uses the incremental parser available with JSON version
		879	2.09 (and JSON::XS version 2.2) and above. You have to provide a
		880	dependency on your own: this module will load the JSON module, but
		881	AnyEvent does not depend on it itself.
		882
		883	Since JSON texts are fully self-delimiting, the C<json> read and write
		884	types are an ideal simple RPC protocol: just exchange JSON datagrams. See
		885	the C<json> write type description, above, for an actual example.
		886
		887	=cut
		888
		889	register_read_type json => sub {
		890	my ($self, $cb, $accept, $reject, $skip) = @_;
		891
		892	require JSON;
		893
		894	my $data;
		895	my $rbuf = \$self->{rbuf};
		896
		897	my $json = $self->{json} \|\|= JSON->new->utf8;
		898
		899	sub {
		900	my $ref = $json->incr_parse ($self->{rbuf});
		901
		902	if ($ref) {
		903	$self->{rbuf} = $json->incr_text;
		904	$json->incr_text = "";
		905	$cb->($self, $ref);
		906
		907	1
		908	} else {
		909	$self->{rbuf} = "";
		910	()
		911	}
		912	}
		913	};
		914
718	=back	915	=back
		916
		917	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)
		918
		919	This function (not method) lets you add your own types to C<push_read>.
		920
		921	Whenever the given C<type> is used, C<push_read> will invoke the code
		922	reference with the handle object, the callback and the remaining
		923	arguments.
		924
		925	The code reference is supposed to return a callback (usually a closure)
		926	that works as a plain read callback (see C<< ->push_read ($cb) >>).
		927
		928	It should invoke the passed callback when it is done reading (remember to
		929	pass C<$handle> as first argument as all other callbacks do that).
		930
		931	Note that this is a function, and all types registered this way will be
		932	global, so try to use unique names.
		933
		934	For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>,
		935	search for C<register_read_type>)).
719		936
720	=item $handle->stop_read	937	=item $handle->stop_read
721		938
722	=item $handle->start_read	939	=item $handle->start_read
723		940
…		…
729	=cut	946	=cut
730		947
731	sub stop_read {	948	sub stop_read {
732	my ($self) = @_;	949	my ($self) = @_;
733		950
734	delete $self->{rw};	951	delete $self->{_rw};
735	}	952	}
736		953
737	sub start_read {	954	sub start_read {
738	my ($self) = @_;	955	my ($self) = @_;
739		956
740	unless ($self->{rw} \|\| $self->{eof}) {	957	unless ($self->{_rw} \|\| $self->{_eof}) {
741	Scalar::Util::weaken $self;	958	Scalar::Util::weaken $self;
742		959
743	$self->{rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	960	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
744	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	961	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};
745	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;	962	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;
746		963
747	if ($len > 0) {	964	if ($len > 0) {
748	$self->{filter_r}	965	$self->{filter_r}
749	? $self->{filter_r}->($self, $rbuf)	966	? $self->{filter_r}->($self, $rbuf)
750	: $self->_drain_rbuf;	967	: $self->_drain_rbuf;
751		968
752	} elsif (defined $len) {	969	} elsif (defined $len) {
753	delete $self->{rw};	970	delete $self->{_rw};
754	$self->{eof} = 1;	971	$self->{_eof} = 1;
755	$self->_drain_rbuf;	972	$self->_drain_rbuf;
756		973
757	} elsif ($! != EAGAIN && $! != EINTR) {	974	} elsif ($! != EAGAIN && $! != EINTR && $! != &AnyEvent::Util::WSAWOULDBLOCK) {
758	return $self->error;	975	return $self->error;
759	}	976	}
760	});	977	});
761	}	978	}
762	}	979	}
763		980
764	sub _dotls {	981	sub _dotls {
765	my ($self) = @_;	982	my ($self) = @_;
766		983
767	if (length $self->{tls_wbuf}) {	984	if (length $self->{_tls_wbuf}) {
768	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{tls_wbuf})) > 0) {	985	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
769	substr $self->{tls_wbuf}, 0, $len, "";	986	substr $self->{_tls_wbuf}, 0, $len, "";
770	}	987	}
771	}	988	}
772		989
773	if (defined (my $buf = Net::SSLeay::BIO_read ($self->{tls_wbio}))) {	990	if (defined (my $buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {
774	$self->{wbuf} .= $buf;	991	$self->{wbuf} .= $buf;
775	$self->_drain_wbuf;	992	$self->_drain_wbuf;
776	}	993	}
777		994
778	while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) {	995	while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) {
…		…
804	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1021	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
805		1022
806	The second argument is the optional C<Net::SSLeay::CTX> object that is	1023	The second argument is the optional C<Net::SSLeay::CTX> object that is
807	used when AnyEvent::Handle has to create its own TLS connection object.	1024	used when AnyEvent::Handle has to create its own TLS connection object.
808		1025
		1026	The TLS connection object will end up in C<< $handle->{tls} >> after this
		1027	call and can be used or changed to your liking. Note that the handshake
		1028	might have already started when this function returns.
		1029
809	=cut	1030	=cut
810		1031
811	# TODO: maybe document...	1032	# TODO: maybe document...
812	sub starttls {	1033	sub starttls {
813	my ($self, $ssl, $ctx) = @_;	1034	my ($self, $ssl, $ctx) = @_;
…		…
828	# but the openssl maintainers basically said: "trust us, it just works".	1049	# but the openssl maintainers basically said: "trust us, it just works".
829	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1050	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
830	# and mismaintained ssleay-module doesn't even offer them).	1051	# and mismaintained ssleay-module doesn't even offer them).
831	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html	1052	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
832	Net::SSLeay::CTX_set_mode ($self->{tls},	1053	Net::SSLeay::CTX_set_mode ($self->{tls},
833	(eval { Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1054	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
834	\| (eval { Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));	1055	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
835		1056
836	$self->{tls_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1057	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
837	$self->{tls_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1058	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
838		1059
839	Net::SSLeay::set_bio ($ssl, $self->{tls_rbio}, $self->{tls_wbio});	1060	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
840		1061
841	$self->{filter_w} = sub {	1062	$self->{filter_w} = sub {
842	$_[0]{tls_wbuf} .= ${$_[1]};	1063	$_[0]{_tls_wbuf} .= ${$_[1]};
843	&_dotls;	1064	&_dotls;
844	};	1065	};
845	$self->{filter_r} = sub {	1066	$self->{filter_r} = sub {
846	Net::SSLeay::BIO_write ($_[0]{tls_rbio}, ${$_[1]});	1067	Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});
847	&_dotls;	1068	&_dotls;
848	};	1069	};
849	}	1070	}
850		1071
851	=item $handle->stoptls	1072	=item $handle->stoptls
…		…
857		1078
858	sub stoptls {	1079	sub stoptls {
859	my ($self) = @_;	1080	my ($self) = @_;
860		1081
861	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};	1082	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};
		1083
862	delete $self->{tls_rbio};	1084	delete $self->{_rbio};
863	delete $self->{tls_wbio};	1085	delete $self->{_wbio};
864	delete $self->{tls_wbuf};	1086	delete $self->{_tls_wbuf};
865	delete $self->{filter_r};	1087	delete $self->{filter_r};
866	delete $self->{filter_w};	1088	delete $self->{filter_w};
867	}	1089	}
868		1090
869	sub DESTROY {	1091	sub DESTROY {
…		…
907	}	1129	}
908	}	1130	}
909		1131
910	=back	1132	=back
911		1133
		1134	=head1 SUBCLASSING AnyEvent::Handle
		1135
		1136	In many cases, you might want to subclass AnyEvent::Handle.
		1137
		1138	To make this easier, a given version of AnyEvent::Handle uses these
		1139	conventions:
		1140
		1141	=over 4
		1142
		1143	=item * all constructor arguments become object members.
		1144
		1145	At least initially, when you pass a C<tls>-argument to the constructor it
		1146	will end up in C<< $handle->{tls} >>. Those members might be changes or
		1147	mutated later on (for example C<tls> will hold the TLS connection object).
		1148
		1149	=item * other object member names are prefixed with an C<_>.
		1150
		1151	All object members not explicitly documented (internal use) are prefixed
		1152	with an underscore character, so the remaining non-C<_>-namespace is free
		1153	for use for subclasses.
		1154
		1155	=item * all members not documented here and not prefixed with an underscore
		1156	are free to use in subclasses.
		1157
		1158	Of course, new versions of AnyEvent::Handle may introduce more "public"
		1159	member variables, but thats just life, at least it is documented.
		1160
		1161	=back
		1162
912	=head1 AUTHOR	1163	=head1 AUTHOR
913		1164
914	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.	1165	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.
915		1166
916	=cut	1167	=cut

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.29 by root, Sat May 24 23:10:18 2008 UTC vs. Revision 1.41 by root, Tue May 27 05:47:36 2008 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.29 by root, Sat May 24 23:10:18 2008 UTC vs.
Revision 1.41 by root, Tue May 27 05:47:36 2008 UTC