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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.27 by root, Sat May 24 15:26:04 2008 UTC vs.
Revision 1.43 by root, Wed May 28 23:57:38 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(WSAEWOULDBLOCK);
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	use Time::HiRes qw(time);
12		13
13	=head1 NAME	14	=head1 NAME
14		15
15	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent	16	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent
16
17	This module is experimental.
18		17
19	=cut	18	=cut
20		19
21	our $VERSION = '0.04';	20	our $VERSION = '0.04';
22		21
…		…
25	use AnyEvent;	24	use AnyEvent;
26	use AnyEvent::Handle;	25	use AnyEvent::Handle;
27		26
28	my $cv = AnyEvent->condvar;	27	my $cv = AnyEvent->condvar;
29		28
30	my $ae_fh = AnyEvent::Handle->new (fh => \*STDIN);	29	my $handle =
31
32	#TODO
33
34	# or use the constructor to pass the callback:
35
36	my $ae_fh2 =
37	AnyEvent::Handle->new (	30	AnyEvent::Handle->new (
38	fh => \*STDIN,	31	fh => \*STDIN,
39	on_eof => sub {	32	on_eof => sub {
40	$cv->broadcast;	33	$cv->broadcast;
41	},	34	},
42	#TODO
43	);	35	);
44		36
45	$cv->wait;	37	# send some request line
		38	$handle->push_write ("getinfo\015\012");
		39
		40	# read the response line
		41	$handle->push_read (line => sub {
		42	my ($handle, $line) = @_;
		43	warn "read line <$line>\n";
		44	$cv->send;
		45	});
		46
		47	$cv->recv;
46		48
47	=head1 DESCRIPTION	49	=head1 DESCRIPTION
48		50
49	This module is a helper module to make it easier to do event-based I/O on	51	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	52	filehandles. For utility functions for doing non-blocking connects and accepts
…		…
72	The filehandle this L<AnyEvent::Handle> object will operate on.	74	The filehandle this L<AnyEvent::Handle> object will operate on.
73		75
74	NOTE: The filehandle will be set to non-blocking (using	76	NOTE: The filehandle will be set to non-blocking (using
75	AnyEvent::Util::fh_nonblocking).	77	AnyEvent::Util::fh_nonblocking).
76		78
77	=item on_eof => $cb->($self)	79	=item on_eof => $cb->($handle)
78		80
79	Set the callback to be called on EOF.	81	Set the callback to be called on EOF.
80		82
81	While not mandatory, it is highly recommended to set an eof callback,	83	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	84	otherwise you might end up with a closed socket while you are still
83	waiting for data.	85	waiting for data.
84		86
85	=item on_error => $cb->($self)	87	=item on_error => $cb->($handle)
86		88
87	This is the fatal error callback, that is called when, well, a fatal error	89	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	90	occurs, such as not being able to resolve the hostname, failure to connect
89	or a read error.	91	or a read error.
90		92
91	The object will not be in a usable state when this callback has been	93	The object will not be in a usable state when this callback has been
92	called.	94	called.
93		95
94	On callback entrance, the value of C<$!> contains the operating system	96	On callback entrance, the value of C<$!> contains the operating system
95	error (or C<ENOSPC> or C<EPIPE>).	97	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).
		98
		99	The callback should throw an exception. If it returns, then
		100	AnyEvent::Handle will C<croak> for you.
96		101
97	While not mandatory, it is I<highly> recommended to set this callback, as	102	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	103	you will not be notified of errors otherwise. The default simply calls
99	die.	104	die.
100		105
101	=item on_read => $cb->($self)	106	=item on_read => $cb->($handle)
102		107
103	This sets the default read callback, which is called when data arrives	108	This sets the default read callback, which is called when data arrives
104	and no read request is in the queue.	109	and no read request is in the queue.
105		110
106	To access (and remove data from) the read buffer, use the C<< ->rbuf >>	111	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
107	method or access the C<$self->{rbuf}> member directly.	112	method or access the C<$handle->{rbuf}> member directly.
108		113
109	When an EOF condition is detected then AnyEvent::Handle will first try to	114	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	115	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	116	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>).	117	error will be raised (with C<$!> set to C<EPIPE>).
113		118
114	=item on_drain => $cb->()	119	=item on_drain => $cb->($handle)
115		120
116	This sets the callback that is called when the write buffer becomes empty	121	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).	122	(or when the callback is set and the buffer is empty already).
118		123
119	To append to the write buffer, use the C<< ->push_write >> method.	124	To append to the write buffer, use the C<< ->push_write >> method.
		125
		126	=item timeout => $fractional_seconds
		127
		128	If non-zero, then this enables an "inactivity" timeout: whenever this many
		129	seconds pass without a successful read or write on the underlying file
		130	handle, the C<on_timeout> callback will be invoked (and if that one is
		131	missing, an C<ETIMEDOUT> errror will be raised).
		132
		133	Note that timeout processing is also active when you currently do not have
		134	any outstanding read or write requests: If you plan to keep the connection
		135	idle then you should disable the timout temporarily or ignore the timeout
		136	in the C<on_timeout> callback.
		137
		138	Zero (the default) disables this timeout.
		139
		140	=item on_timeout => $cb->($handle)
		141
		142	Called whenever the inactivity timeout passes. If you return from this
		143	callback, then the timeout will be reset as if some activity had happened,
		144	so this condition is not fatal in any way.
120		145
121	=item rbuf_max => <bytes>	146	=item rbuf_max => <bytes>
122		147
123	If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)	148	If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)
124	when the read buffer ever (strictly) exceeds this size. This is useful to	149	when the read buffer ever (strictly) exceeds this size. This is useful to
…		…
164		189
165	Use the given Net::SSLeay::CTX object to create the new TLS connection	190	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	191	(unless a connection object was specified directly). If this parameter is
167	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	192	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
168		193
		194	=item json => JSON or JSON::XS object
		195
		196	This is the json coder object used by the C<json> read and write types.
		197
		198	If you don't supply it, then AnyEvent::Handle will create and use a
		199	suitable one, which will write and expect UTF-8 encoded JSON texts.
		200
		201	Note that you are responsible to depend on the JSON module if you want to
		202	use this functionality, as AnyEvent does not have a dependency itself.
		203
		204	=item filter_r => $cb
		205
		206	=item filter_w => $cb
		207
		208	These exist, but are undocumented at this time.
		209
169	=back	210	=back
170		211
171	=cut	212	=cut
172		213
173	sub new {	214	sub new {
…		…
182	if ($self->{tls}) {	223	if ($self->{tls}) {
183	require Net::SSLeay;	224	require Net::SSLeay;
184	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});	225	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});
185	}	226	}
186		227
187	$self->on_eof (delete $self->{on_eof} ) if $self->{on_eof};	228	# $self->on_eof (delete $self->{on_eof} ) if $self->{on_eof}; # nop
188	$self->on_error (delete $self->{on_error}) if $self->{on_error};	229	# $self->on_error (delete $self->{on_error}) if $self->{on_error}; # nop
		230	# $self->on_read (delete $self->{on_read} ) if $self->{on_read}; # nop
189	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	231	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
190	$self->on_read (delete $self->{on_read} ) if $self->{on_read};	232
		233	$self->{_activity} = time;
		234	$self->_timeout;
191		235
192	$self->start_read;	236	$self->start_read;
193		237
194	$self	238	$self
195	}	239	}
196		240
197	sub _shutdown {	241	sub _shutdown {
198	my ($self) = @_;	242	my ($self) = @_;
199		243
200	delete $self->{rw};	244	delete $self->{_rw};
201	delete $self->{ww};	245	delete $self->{_ww};
202	delete $self->{fh};	246	delete $self->{fh};
203	}	247	}
204		248
205	sub error {	249	sub error {
206	my ($self) = @_;	250	my ($self) = @_;
…		…
208	{	252	{
209	local $!;	253	local $!;
210	$self->_shutdown;	254	$self->_shutdown;
211	}	255	}
212		256
213	if ($self->{on_error}) {
214	$self->{on_error}($self);	257	$self->{on_error}($self)
215	} else {	258	if $self->{on_error};
		259
216	die "AnyEvent::Handle uncaught fatal error: $!";	260	Carp::croak "AnyEvent::Handle uncaught fatal error: $!";
217	}
218	}	261	}
219		262
220	=item $fh = $handle->fh	263	=item $fh = $handle->fh
221		264
222	This method returns the file handle of the L<AnyEvent::Handle> object.	265	This method returns the file handle of the L<AnyEvent::Handle> object.
223		266
224	=cut	267	=cut
225		268
226	sub fh { $_[0]->{fh} }	269	sub fh { $_[0]{fh} }
227		270
228	=item $handle->on_error ($cb)	271	=item $handle->on_error ($cb)
229		272
230	Replace the current C<on_error> callback (see the C<on_error> constructor argument).	273	Replace the current C<on_error> callback (see the C<on_error> constructor argument).
231		274
…		…
241		284
242	=cut	285	=cut
243		286
244	sub on_eof {	287	sub on_eof {
245	$_[0]{on_eof} = $_[1];	288	$_[0]{on_eof} = $_[1];
		289	}
		290
		291	=item $handle->on_timeout ($cb)
		292
		293	Replace the current C<on_timeout> callback, or disables the callback
		294	(but not the timeout) if C<$cb> = C<undef>. See C<timeout> constructor
		295	argument.
		296
		297	=cut
		298
		299	sub on_timeout {
		300	$_[0]{on_timeout} = $_[1];
		301	}
		302
		303	#############################################################################
		304
		305	=item $handle->timeout ($seconds)
		306
		307	Configures (or disables) the inactivity timeout.
		308
		309	=cut
		310
		311	sub timeout {
		312	my ($self, $timeout) = @_;
		313
		314	$self->{timeout} = $timeout;
		315	$self->_timeout;
		316	}
		317
		318	# reset the timeout watcher, as neccessary
		319	# also check for time-outs
		320	sub _timeout {
		321	my ($self) = @_;
		322
		323	if ($self->{timeout}) {
		324	my $NOW = time;
		325
		326	# when would the timeout trigger?
		327	my $after = $self->{_activity} + $self->{timeout} - $NOW;
		328
		329	warn "next to in $after\n";#d#
		330
		331	# now or in the past already?
		332	if ($after <= 0) {
		333	$self->{_activity} = $NOW;
		334
		335	if ($self->{on_timeout}) {
		336	$self->{on_timeout}->($self);
		337	} else {
		338	$! = Errno::ETIMEDOUT;
		339	$self->error;
		340	}
		341
		342	# callbakx could have changed timeout value, optimise
		343	return unless $self->{timeout};
		344
		345	# calculate new after
		346	$after = $self->{timeout};
		347	}
		348
		349	Scalar::Util::weaken $self;
		350
		351	warn "after $after\n";#d#
		352	$self->{_tw} \|\|= AnyEvent->timer (after => $after, cb => sub {
		353	delete $self->{_tw};
		354	$self->_timeout;
		355	});
		356	} else {
		357	delete $self->{_tw};
		358	}
246	}	359	}
247		360
248	#############################################################################	361	#############################################################################
249		362
250	=back	363	=back
…		…
287	=cut	400	=cut
288		401
289	sub _drain_wbuf {	402	sub _drain_wbuf {
290	my ($self) = @_;	403	my ($self) = @_;
291		404
292	unless ($self->{ww}) {	405	if (!$self->{_ww} && length $self->{wbuf}) {
		406
293	Scalar::Util::weaken $self;	407	Scalar::Util::weaken $self;
		408
294	my $cb = sub {	409	my $cb = sub {
295	my $len = syswrite $self->{fh}, $self->{wbuf};	410	my $len = syswrite $self->{fh}, $self->{wbuf};
296		411
297	if ($len > 0) {	412	if ($len >= 0) {
298	substr $self->{wbuf}, 0, $len, "";	413	substr $self->{wbuf}, 0, $len, "";
		414
		415	$self->{_activity} = time;
299		416
300	$self->{on_drain}($self)	417	$self->{on_drain}($self)
301	if $self->{low_water_mark} >= length $self->{wbuf}	418	if $self->{low_water_mark} >= length $self->{wbuf}
302	&& $self->{on_drain};	419	&& $self->{on_drain};
303		420
304	delete $self->{ww} unless length $self->{wbuf};	421	delete $self->{_ww} unless length $self->{wbuf};
305	} elsif ($! != EAGAIN && $! != EINTR) {	422	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
306	$self->error;	423	$self->error;
307	}	424	}
308	};	425	};
309		426
		427	# try to write data immediately
		428	$cb->();
		429
		430	# if still data left in wbuf, we need to poll
310	$self->{ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb);	431	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)
311		432	if length $self->{wbuf};
312	$cb->($self);
313	};	433	};
		434	}
		435
		436	our %WH;
		437
		438	sub register_write_type($$) {
		439	$WH{$_[0]} = $_[1];
314	}	440	}
315		441
316	sub push_write {	442	sub push_write {
317	my $self = shift;	443	my $self = shift;
		444
		445	if (@_ > 1) {
		446	my $type = shift;
		447
		448	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")
		449	->($self, @_);
		450	}
318		451
319	if ($self->{filter_w}) {	452	if ($self->{filter_w}) {
320	$self->{filter_w}->($self, \$_[0]);	453	$self->{filter_w}->($self, \$_[0]);
321	} else {	454	} else {
322	$self->{wbuf} .= $_[0];	455	$self->{wbuf} .= $_[0];
323	$self->_drain_wbuf;	456	$self->_drain_wbuf;
324	}	457	}
325	}	458	}
		459
		460	=item $handle->push_write (type => @args)
		461
		462	=item $handle->unshift_write (type => @args)
		463
		464	Instead of formatting your data yourself, you can also let this module do
		465	the job by specifying a type and type-specific arguments.
		466
		467	Predefined types are (if you have ideas for additional types, feel free to
		468	drop by and tell us):
		469
		470	=over 4
		471
		472	=item netstring => $string
		473
		474	Formats the given value as netstring
		475	(http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them).
		476
		477	=back
		478
		479	=cut
		480
		481	register_write_type netstring => sub {
		482	my ($self, $string) = @_;
		483
		484	sprintf "%d:%s,", (length $string), $string
		485	};
		486
		487	=item json => $array_or_hashref
		488
		489	Encodes the given hash or array reference into a JSON object. Unless you
		490	provide your own JSON object, this means it will be encoded to JSON text
		491	in UTF-8.
		492
		493	JSON objects (and arrays) are self-delimiting, so you can write JSON at
		494	one end of a handle and read them at the other end without using any
		495	additional framing.
		496
		497	The generated JSON text is guaranteed not to contain any newlines: While
		498	this module doesn't need delimiters after or between JSON texts to be
		499	able to read them, many other languages depend on that.
		500
		501	A simple RPC protocol that interoperates easily with others is to send
		502	JSON arrays (or objects, although arrays are usually the better choice as
		503	they mimic how function argument passing works) and a newline after each
		504	JSON text:
		505
		506	$handle->push_write (json => ["method", "arg1", "arg2"]); # whatever
		507	$handle->push_write ("\012");
		508
		509	An AnyEvent::Handle receiver would simply use the C<json> read type and
		510	rely on the fact that the newline will be skipped as leading whitespace:
		511
		512	$handle->push_read (json => sub { my $array = $_[1]; ... });
		513
		514	Other languages could read single lines terminated by a newline and pass
		515	this line into their JSON decoder of choice.
		516
		517	=cut
		518
		519	register_write_type json => sub {
		520	my ($self, $ref) = @_;
		521
		522	require JSON;
		523
		524	$self->{json} ? $self->{json}->encode ($ref)
		525	: JSON::encode_json ($ref)
		526	};
		527
		528	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
		529
		530	This function (not method) lets you add your own types to C<push_write>.
		531	Whenever the given C<type> is used, C<push_write> will invoke the code
		532	reference with the handle object and the remaining arguments.
		533
		534	The code reference is supposed to return a single octet string that will
		535	be appended to the write buffer.
		536
		537	Note that this is a function, and all types registered this way will be
		538	global, so try to use unique names.
		539
		540	=cut
326		541
327	#############################################################################	542	#############################################################################
328		543
329	=back	544	=back
330		545
…		…
409		624
410	if (	625	if (
411	defined $self->{rbuf_max}	626	defined $self->{rbuf_max}
412	&& $self->{rbuf_max} < length $self->{rbuf}	627	&& $self->{rbuf_max} < length $self->{rbuf}
413	) {	628	) {
414	$! = &Errno::ENOSPC; return $self->error;	629	$! = &Errno::ENOSPC;
		630	$self->error;
415	}	631	}
416		632
417	return if $self->{in_drain};	633	return if $self->{in_drain};
418	local $self->{in_drain} = 1;	634	local $self->{in_drain} = 1;
419		635
420	while (my $len = length $self->{rbuf}) {	636	while (my $len = length $self->{rbuf}) {
421	no strict 'refs';	637	no strict 'refs';
422	if (my $cb = shift @{ $self->{queue} }) {	638	if (my $cb = shift @{ $self->{_queue} }) {
423	if (!$cb->($self)) {	639	unless ($cb->($self)) {
424	if ($self->{eof}) {	640	if ($self->{_eof}) {
425	# no progress can be made (not enough data and no data forthcoming)	641	# no progress can be made (not enough data and no data forthcoming)
426	$! = &Errno::EPIPE; return $self->error;	642	$! = &Errno::EPIPE;
		643	$self->error;
427	}	644	}
428		645
429	unshift @{ $self->{queue} }, $cb;	646	unshift @{ $self->{_queue} }, $cb;
430	return;	647	return;
431	}	648	}
432	} elsif ($self->{on_read}) {	649	} elsif ($self->{on_read}) {
433	$self->{on_read}($self);	650	$self->{on_read}($self);
434		651
435	if (	652	if (
436	$self->{eof} # if no further data will arrive	653	$self->{_eof} # if no further data will arrive
437	&& $len == length $self->{rbuf} # and no data has been consumed	654	&& $len == length $self->{rbuf} # and no data has been consumed
438	&& !@{ $self->{queue} } # and the queue is still empty	655	&& !@{ $self->{_queue} } # and the queue is still empty
439	&& $self->{on_read} # and we still want to read data	656	&& $self->{on_read} # and we still want to read data
440	) {	657	) {
441	# then no progress can be made	658	# then no progress can be made
442	$! = &Errno::EPIPE; return $self->error;	659	$! = &Errno::EPIPE;
		660	$self->error;
443	}	661	}
444	} else {	662	} else {
445	# read side becomes idle	663	# read side becomes idle
446	delete $self->{rw};	664	delete $self->{_rw};
447	return;	665	return;
448	}	666	}
449	}	667	}
450		668
451	if ($self->{eof}) {	669	if ($self->{_eof}) {
452	$self->_shutdown;	670	$self->_shutdown;
453	$self->{on_eof}($self)	671	$self->{on_eof}($self)
454	if $self->{on_eof};	672	if $self->{on_eof};
455	}	673	}
456	}	674	}
…		…
505	interested in (which can be none at all) and return a true value. After returning	723	interested in (which can be none at all) and return a true value. After returning
506	true, it will be removed from the queue.	724	true, it will be removed from the queue.
507		725
508	=cut	726	=cut
509		727
		728	our %RH;
		729
		730	sub register_read_type($$) {
		731	$RH{$_[0]} = $_[1];
		732	}
		733
510	sub push_read {	734	sub push_read {
511	my ($self, $cb) = @_;	735	my $self = shift;
		736	my $cb = pop;
512		737
		738	if (@_) {
		739	my $type = shift;
		740
		741	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
		742	->($self, $cb, @_);
		743	}
		744
513	push @{ $self->{queue} }, $cb;	745	push @{ $self->{_queue} }, $cb;
514	$self->_drain_rbuf;	746	$self->_drain_rbuf;
515	}	747	}
516		748
517	sub unshift_read {	749	sub unshift_read {
518	my ($self, $cb) = @_;	750	my $self = shift;
		751	my $cb = pop;
519		752
		753	if (@_) {
		754	my $type = shift;
		755
		756	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")
		757	->($self, $cb, @_);
		758	}
		759
		760
520	push @{ $self->{queue} }, $cb;	761	unshift @{ $self->{_queue} }, $cb;
521	$self->_drain_rbuf;	762	$self->_drain_rbuf;
522	}	763	}
523		764
524	=item $handle->push_read_chunk ($len, $cb->($self, $data))	765	=item $handle->push_read (type => @args, $cb)
525		766
526	=item $handle->unshift_read_chunk ($len, $cb->($self, $data))	767	=item $handle->unshift_read (type => @args, $cb)
527		768
528	Append the given callback to the end of the queue (C<push_read_chunk>) or	769	Instead of providing a callback that parses the data itself you can chose
529	prepend it (C<unshift_read_chunk>).	770	between a number of predefined parsing formats, for chunks of data, lines
		771	etc.
530		772
531	The callback will be called only once C<$len> bytes have been read, and	773	Predefined types are (if you have ideas for additional types, feel free to
532	these C<$len> bytes will be passed to the callback.	774	drop by and tell us):
533		775
534	=cut	776	=over 4
535		777
536	sub _read_chunk($$) {	778	=item chunk => $octets, $cb->($handle, $data)
		779
		780	Invoke the callback only once C<$octets> bytes have been read. Pass the
		781	data read to the callback. The callback will never be called with less
		782	data.
		783
		784	Example: read 2 bytes.
		785
		786	$handle->push_read (chunk => 2, sub {
		787	warn "yay ", unpack "H*", $_[1];
		788	});
		789
		790	=cut
		791
		792	register_read_type chunk => sub {
537	my ($self, $len, $cb) = @_;	793	my ($self, $cb, $len) = @_;
538		794
539	sub {	795	sub {
540	$len <= length $_[0]{rbuf} or return;	796	$len <= length $_[0]{rbuf} or return;
541	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");	797	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");
542	1	798	1
543	}	799	}
544	}	800	};
545		801
		802	# compatibility with older API
546	sub push_read_chunk {	803	sub push_read_chunk {
547	$_[0]->push_read (&_read_chunk);	804	$_[0]->push_read (chunk => $_[1], $_[2]);
548	}	805	}
549
550		806
551	sub unshift_read_chunk {	807	sub unshift_read_chunk {
552	$_[0]->unshift_read (&_read_chunk);	808	$_[0]->unshift_read (chunk => $_[1], $_[2]);
553	}	809	}
554		810
555	=item $handle->push_read_line ([$eol, ]$cb->($self, $line, $eol))	811	=item line => [$eol, ]$cb->($handle, $line, $eol)
556
557	=item $handle->unshift_read_line ([$eol, ]$cb->($self, $line, $eol))
558
559	Append the given callback to the end of the queue (C<push_read_line>) or
560	prepend it (C<unshift_read_line>).
561		812
562	The callback will be called only once a full line (including the end of	813	The callback will be called only once a full line (including the end of
563	line marker, C<$eol>) has been read. This line (excluding the end of line	814	line marker, C<$eol>) has been read. This line (excluding the end of line
564	marker) will be passed to the callback as second argument (C<$line>), and	815	marker) will be passed to the callback as second argument (C<$line>), and
565	the end of line marker as the third argument (C<$eol>).	816	the end of line marker as the third argument (C<$eol>).
…		…
576	Partial lines at the end of the stream will never be returned, as they are	827	Partial lines at the end of the stream will never be returned, as they are
577	not marked by the end of line marker.	828	not marked by the end of line marker.
578		829
579	=cut	830	=cut
580		831
581	sub _read_line($$) {	832	register_read_type line => sub {
582	my $self = shift;	833	my ($self, $cb, $eol) = @_;
583	my $cb = pop;
584	my $eol = @_ ? shift : qr\|(\015?\012)\|;
585	my $pos;
586		834
		835	$eol = qr\|(\015?\012)\| if @_ < 3;
587	$eol = quotemeta $eol unless ref $eol;	836	$eol = quotemeta $eol unless ref $eol;
588	$eol = qr\|^(.*?)($eol)\|s;	837	$eol = qr\|^(.*?)($eol)\|s;
589		838
590	sub {	839	sub {
591	$_[0]{rbuf} =~ s/$eol// or return;	840	$_[0]{rbuf} =~ s/$eol// or return;
592		841
593	$cb->($_[0], $1, $2);	842	$cb->($_[0], $1, $2);
594	1	843	1
595	}	844	}
596	}	845	};
597		846
		847	# compatibility with older API
598	sub push_read_line {	848	sub push_read_line {
599	$_[0]->push_read (&_read_line);	849	my $self = shift;
		850	$self->push_read (line => @_);
600	}	851	}
601		852
602	sub unshift_read_line {	853	sub unshift_read_line {
603	$_[0]->unshift_read (&_read_line);	854	my $self = shift;
		855	$self->unshift_read (line => @_);
604	}	856	}
		857
		858	=item netstring => $cb->($handle, $string)
		859
		860	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
		861
		862	Throws an error with C<$!> set to EBADMSG on format violations.
		863
		864	=cut
		865
		866	register_read_type netstring => sub {
		867	my ($self, $cb) = @_;
		868
		869	sub {
		870	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
		871	if ($_[0]{rbuf} =~ /[^0-9]/) {
		872	$! = &Errno::EBADMSG;
		873	$self->error;
		874	}
		875	return;
		876	}
		877
		878	my $len = $1;
		879
		880	$self->unshift_read (chunk => $len, sub {
		881	my $string = $_[1];
		882	$_[0]->unshift_read (chunk => 1, sub {
		883	if ($_[1] eq ",") {
		884	$cb->($_[0], $string);
		885	} else {
		886	$! = &Errno::EBADMSG;
		887	$self->error;
		888	}
		889	});
		890	});
		891
		892	1
		893	}
		894	};
		895
		896	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
		897
		898	Makes a regex match against the regex object C<$accept> and returns
		899	everything up to and including the match.
		900
		901	Example: read a single line terminated by '\n'.
		902
		903	$handle->push_read (regex => qr<\n>, sub { ... });
		904
		905	If C<$reject> is given and not undef, then it determines when the data is
		906	to be rejected: it is matched against the data when the C<$accept> regex
		907	does not match and generates an C<EBADMSG> error when it matches. This is
		908	useful to quickly reject wrong data (to avoid waiting for a timeout or a
		909	receive buffer overflow).
		910
		911	Example: expect a single decimal number followed by whitespace, reject
		912	anything else (not the use of an anchor).
		913
		914	$handle->push_read (regex => qr<^[0-9]+\s>, qr<[^0-9]>, sub { ... });
		915
		916	If C<$skip> is given and not C<undef>, then it will be matched against
		917	the receive buffer when neither C<$accept> nor C<$reject> match,
		918	and everything preceding and including the match will be accepted
		919	unconditionally. This is useful to skip large amounts of data that you
		920	know cannot be matched, so that the C<$accept> or C<$reject> regex do not
		921	have to start matching from the beginning. This is purely an optimisation
		922	and is usually worth only when you expect more than a few kilobytes.
		923
		924	Example: expect a http header, which ends at C<\015\012\015\012>. Since we
		925	expect the header to be very large (it isn't in practise, but...), we use
		926	a skip regex to skip initial portions. The skip regex is tricky in that
		927	it only accepts something not ending in either \015 or \012, as these are
		928	required for the accept regex.
		929
		930	$handle->push_read (regex =>
		931	qr<\015\012\015\012>,
		932	undef, # no reject
		933	qr<^.*[^\015\012]>,
		934	sub { ... });
		935
		936	=cut
		937
		938	register_read_type regex => sub {
		939	my ($self, $cb, $accept, $reject, $skip) = @_;
		940
		941	my $data;
		942	my $rbuf = \$self->{rbuf};
		943
		944	sub {
		945	# accept
		946	if ($$rbuf =~ $accept) {
		947	$data .= substr $$rbuf, 0, $+[0], "";
		948	$cb->($self, $data);
		949	return 1;
		950	}
		951
		952	# reject
		953	if ($reject && $$rbuf =~ $reject) {
		954	$! = &Errno::EBADMSG;
		955	$self->error;
		956	}
		957
		958	# skip
		959	if ($skip && $$rbuf =~ $skip) {
		960	$data .= substr $$rbuf, 0, $+[0], "";
		961	}
		962
		963	()
		964	}
		965	};
		966
		967	=item json => $cb->($handle, $hash_or_arrayref)
		968
		969	Reads a JSON object or array, decodes it and passes it to the callback.
		970
		971	If a C<json> object was passed to the constructor, then that will be used
		972	for the final decode, otherwise it will create a JSON coder expecting UTF-8.
		973
		974	This read type uses the incremental parser available with JSON version
		975	2.09 (and JSON::XS version 2.2) and above. You have to provide a
		976	dependency on your own: this module will load the JSON module, but
		977	AnyEvent does not depend on it itself.
		978
		979	Since JSON texts are fully self-delimiting, the C<json> read and write
		980	types are an ideal simple RPC protocol: just exchange JSON datagrams. See
		981	the C<json> write type description, above, for an actual example.
		982
		983	=cut
		984
		985	register_read_type json => sub {
		986	my ($self, $cb, $accept, $reject, $skip) = @_;
		987
		988	require JSON;
		989
		990	my $data;
		991	my $rbuf = \$self->{rbuf};
		992
		993	my $json = $self->{json} \|\|= JSON->new->utf8;
		994
		995	sub {
		996	my $ref = $json->incr_parse ($self->{rbuf});
		997
		998	if ($ref) {
		999	$self->{rbuf} = $json->incr_text;
		1000	$json->incr_text = "";
		1001	$cb->($self, $ref);
		1002
		1003	1
		1004	} else {
		1005	$self->{rbuf} = "";
		1006	()
		1007	}
		1008	}
		1009	};
		1010
		1011	=back
		1012
		1013	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)
		1014
		1015	This function (not method) lets you add your own types to C<push_read>.
		1016
		1017	Whenever the given C<type> is used, C<push_read> will invoke the code
		1018	reference with the handle object, the callback and the remaining
		1019	arguments.
		1020
		1021	The code reference is supposed to return a callback (usually a closure)
		1022	that works as a plain read callback (see C<< ->push_read ($cb) >>).
		1023
		1024	It should invoke the passed callback when it is done reading (remember to
		1025	pass C<$handle> as first argument as all other callbacks do that).
		1026
		1027	Note that this is a function, and all types registered this way will be
		1028	global, so try to use unique names.
		1029
		1030	For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>,
		1031	search for C<register_read_type>)).
605		1032
606	=item $handle->stop_read	1033	=item $handle->stop_read
607		1034
608	=item $handle->start_read	1035	=item $handle->start_read
609		1036
…		…
615	=cut	1042	=cut
616		1043
617	sub stop_read {	1044	sub stop_read {
618	my ($self) = @_;	1045	my ($self) = @_;
619		1046
620	delete $self->{rw};	1047	delete $self->{_rw};
621	}	1048	}
622		1049
623	sub start_read {	1050	sub start_read {
624	my ($self) = @_;	1051	my ($self) = @_;
625		1052
626	unless ($self->{rw} \|\| $self->{eof}) {	1053	unless ($self->{_rw} \|\| $self->{_eof}) {
627	Scalar::Util::weaken $self;	1054	Scalar::Util::weaken $self;
628		1055
629	$self->{rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1056	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
630	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1057	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};
631	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;	1058	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;
632		1059
633	if ($len > 0) {	1060	if ($len > 0) {
		1061	$self->{_activity} = time;
		1062
634	$self->{filter_r}	1063	$self->{filter_r}
635	? $self->{filter_r}->($self, $rbuf)	1064	? $self->{filter_r}->($self, $rbuf)
636	: $self->_drain_rbuf;	1065	: $self->_drain_rbuf;
637		1066
638	} elsif (defined $len) {	1067	} elsif (defined $len) {
639	delete $self->{rw};	1068	delete $self->{_rw};
		1069	delete $self->{_ww};
		1070	delete $self->{_tw};
640	$self->{eof} = 1;	1071	$self->{_eof} = 1;
641	$self->_drain_rbuf;	1072	$self->_drain_rbuf;
642		1073
643	} elsif ($! != EAGAIN && $! != EINTR) {	1074	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
644	return $self->error;	1075	return $self->error;
645	}	1076	}
646	});	1077	});
647	}	1078	}
648	}	1079	}
649		1080
650	sub _dotls {	1081	sub _dotls {
651	my ($self) = @_;	1082	my ($self) = @_;
652		1083
653	if (length $self->{tls_wbuf}) {	1084	if (length $self->{_tls_wbuf}) {
654	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{tls_wbuf})) > 0) {	1085	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
655	substr $self->{tls_wbuf}, 0, $len, "";	1086	substr $self->{_tls_wbuf}, 0, $len, "";
656	}	1087	}
657	}	1088	}
658		1089
659	if (defined (my $buf = Net::SSLeay::BIO_read ($self->{tls_wbio}))) {	1090	if (defined (my $buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {
660	$self->{wbuf} .= $buf;	1091	$self->{wbuf} .= $buf;
661	$self->_drain_wbuf;	1092	$self->_drain_wbuf;
662	}	1093	}
663		1094
664	while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) {	1095	while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) {
…		…
690	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1121	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
691		1122
692	The second argument is the optional C<Net::SSLeay::CTX> object that is	1123	The second argument is the optional C<Net::SSLeay::CTX> object that is
693	used when AnyEvent::Handle has to create its own TLS connection object.	1124	used when AnyEvent::Handle has to create its own TLS connection object.
694		1125
		1126	The TLS connection object will end up in C<< $handle->{tls} >> after this
		1127	call and can be used or changed to your liking. Note that the handshake
		1128	might have already started when this function returns.
		1129
695	=cut	1130	=cut
696		1131
697	# TODO: maybe document...	1132	# TODO: maybe document...
698	sub starttls {	1133	sub starttls {
699	my ($self, $ssl, $ctx) = @_;	1134	my ($self, $ssl, $ctx) = @_;
…		…
714	# but the openssl maintainers basically said: "trust us, it just works".	1149	# but the openssl maintainers basically said: "trust us, it just works".
715	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1150	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
716	# and mismaintained ssleay-module doesn't even offer them).	1151	# and mismaintained ssleay-module doesn't even offer them).
717	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html	1152	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
718	Net::SSLeay::CTX_set_mode ($self->{tls},	1153	Net::SSLeay::CTX_set_mode ($self->{tls},
719	(eval { Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1154	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
720	\| (eval { Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));	1155	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
721		1156
722	$self->{tls_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1157	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
723	$self->{tls_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1158	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
724		1159
725	Net::SSLeay::set_bio ($ssl, $self->{tls_rbio}, $self->{tls_wbio});	1160	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
726		1161
727	$self->{filter_w} = sub {	1162	$self->{filter_w} = sub {
728	$_[0]{tls_wbuf} .= ${$_[1]};	1163	$_[0]{_tls_wbuf} .= ${$_[1]};
729	&_dotls;	1164	&_dotls;
730	};	1165	};
731	$self->{filter_r} = sub {	1166	$self->{filter_r} = sub {
732	Net::SSLeay::BIO_write ($_[0]{tls_rbio}, ${$_[1]});	1167	Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});
733	&_dotls;	1168	&_dotls;
734	};	1169	};
735	}	1170	}
736		1171
737	=item $handle->stoptls	1172	=item $handle->stoptls
…		…
743		1178
744	sub stoptls {	1179	sub stoptls {
745	my ($self) = @_;	1180	my ($self) = @_;
746		1181
747	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};	1182	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};
		1183
748	delete $self->{tls_rbio};	1184	delete $self->{_rbio};
749	delete $self->{tls_wbio};	1185	delete $self->{_wbio};
750	delete $self->{tls_wbuf};	1186	delete $self->{_tls_wbuf};
751	delete $self->{filter_r};	1187	delete $self->{filter_r};
752	delete $self->{filter_w};	1188	delete $self->{filter_w};
753	}	1189	}
754		1190
755	sub DESTROY {	1191	sub DESTROY {
…		…
793	}	1229	}
794	}	1230	}
795		1231
796	=back	1232	=back
797		1233
		1234	=head1 SUBCLASSING AnyEvent::Handle
		1235
		1236	In many cases, you might want to subclass AnyEvent::Handle.
		1237
		1238	To make this easier, a given version of AnyEvent::Handle uses these
		1239	conventions:
		1240
		1241	=over 4
		1242
		1243	=item * all constructor arguments become object members.
		1244
		1245	At least initially, when you pass a C<tls>-argument to the constructor it
		1246	will end up in C<< $handle->{tls} >>. Those members might be changes or
		1247	mutated later on (for example C<tls> will hold the TLS connection object).
		1248
		1249	=item * other object member names are prefixed with an C<_>.
		1250
		1251	All object members not explicitly documented (internal use) are prefixed
		1252	with an underscore character, so the remaining non-C<_>-namespace is free
		1253	for use for subclasses.
		1254
		1255	=item * all members not documented here and not prefixed with an underscore
		1256	are free to use in subclasses.
		1257
		1258	Of course, new versions of AnyEvent::Handle may introduce more "public"
		1259	member variables, but thats just life, at least it is documented.
		1260
		1261	=back
		1262
798	=head1 AUTHOR	1263	=head1 AUTHOR
799		1264
800	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.	1265	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.
801		1266
802	=cut	1267	=cut

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.27 by root, Sat May 24 15:26:04 2008 UTC vs. Revision 1.43 by root, Wed May 28 23:57:38 2008 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.27 by root, Sat May 24 15:26:04 2008 UTC vs.
Revision 1.43 by root, Wed May 28 23:57:38 2008 UTC