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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.28 by root, Sat May 24 22:27:11 2008 UTC vs.
Revision 1.50 by root, Fri May 30 21:38:46 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		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 = 4.1;
22		20
23	=head1 SYNOPSIS	21	=head1 SYNOPSIS
24		22
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>, C<ETIMEDOUT> 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.
		124
		125	=item timeout => $fractional_seconds
		126
		127	If non-zero, then this enables an "inactivity" timeout: whenever this many
		128	seconds pass without a successful read or write on the underlying file
		129	handle, the C<on_timeout> callback will be invoked (and if that one is
		130	missing, an C<ETIMEDOUT> error will be raised).
		131
		132	Note that timeout processing is also active when you currently do not have
		133	any outstanding read or write requests: If you plan to keep the connection
		134	idle then you should disable the timout temporarily or ignore the timeout
		135	in the C<on_timeout> callback.
		136
		137	Zero (the default) disables this timeout.
		138
		139	=item on_timeout => $cb->($handle)
		140
		141	Called whenever the inactivity timeout passes. If you return from this
		142	callback, then the timeout will be reset as if some activity had happened,
		143	so this condition is not fatal in any way.
120		144
121	=item rbuf_max => <bytes>	145	=item rbuf_max => <bytes>
122		146
123	If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)	147	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	148	when the read buffer ever (strictly) exceeds this size. This is useful to
…		…
131	isn't finished).	155	isn't finished).
132		156
133	=item read_size => <bytes>	157	=item read_size => <bytes>
134		158
135	The default read block size (the amount of bytes this module will try to read	159	The default read block size (the amount of bytes this module will try to read
136	on each [loop iteration). Default: C<4096>.	160	during each (loop iteration). Default: C<8192>.
137		161
138	=item low_water_mark => <bytes>	162	=item low_water_mark => <bytes>
139		163
140	Sets the amount of bytes (default: C<0>) that make up an "empty" write	164	Sets the amount of bytes (default: C<0>) that make up an "empty" write
141	buffer: If the write reaches this size or gets even samller it is	165	buffer: If the write reaches this size or gets even samller it is
…		…
164		188
165	Use the given Net::SSLeay::CTX object to create the new TLS connection	189	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	190	(unless a connection object was specified directly). If this parameter is
167	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	191	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
168		192
		193	=item json => JSON or JSON::XS object
		194
		195	This is the json coder object used by the C<json> read and write types.
		196
		197	If you don't supply it, then AnyEvent::Handle will create and use a
		198	suitable one, which will write and expect UTF-8 encoded JSON texts.
		199
		200	Note that you are responsible to depend on the JSON module if you want to
		201	use this functionality, as AnyEvent does not have a dependency itself.
		202
		203	=item filter_r => $cb
		204
		205	=item filter_w => $cb
		206
		207	These exist, but are undocumented at this time.
		208
169	=back	209	=back
170		210
171	=cut	211	=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		212
183	sub new {	213	sub new {
184	my $class = shift;	214	my $class = shift;
185		215
186	my $self = bless { @_ }, $class;	216	my $self = bless { @_ }, $class;
…		…
192	if ($self->{tls}) {	222	if ($self->{tls}) {
193	require Net::SSLeay;	223	require Net::SSLeay;
194	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});	224	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});
195	}	225	}
196		226
197	$self->on_eof (delete $self->{on_eof} ) if $self->{on_eof};	227	# $self->on_eof (delete $self->{on_eof} ) if $self->{on_eof}; # nop
198	$self->on_error (delete $self->{on_error}) if $self->{on_error};	228	# $self->on_error (delete $self->{on_error}) if $self->{on_error}; # nop
		229	# $self->on_read (delete $self->{on_read} ) if $self->{on_read}; # nop
199	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	230	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
200	$self->on_read (delete $self->{on_read} ) if $self->{on_read};	231
		232	$self->{_activity} = AnyEvent->now;
		233	$self->_timeout;
201		234
202	$self->start_read;	235	$self->start_read;
203		236
204	$self	237	$self
205	}	238	}
206		239
207	sub _shutdown {	240	sub _shutdown {
208	my ($self) = @_;	241	my ($self) = @_;
209		242
		243	delete $self->{_tw};
210	delete $self->{rw};	244	delete $self->{_rw};
211	delete $self->{ww};	245	delete $self->{_ww};
212	delete $self->{fh};	246	delete $self->{fh};
213	}	247	}
214		248
215	sub error {	249	sub error {
216	my ($self) = @_;	250	my ($self) = @_;
…		…
218	{	252	{
219	local $!;	253	local $!;
220	$self->_shutdown;	254	$self->_shutdown;
221	}	255	}
222		256
223	if ($self->{on_error}) {
224	$self->{on_error}($self);	257	$self->{on_error}($self)
225	} else {	258	if $self->{on_error};
		259
226	die "AnyEvent::Handle uncaught fatal error: $!";	260	Carp::croak "AnyEvent::Handle uncaught fatal error: $!";
227	}
228	}	261	}
229		262
230	=item $fh = $handle->fh	263	=item $fh = $handle->fh
231		264
232	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.
233		266
234	=cut	267	=cut
235		268
236	sub fh { $_[0]->{fh} }	269	sub fh { $_[0]{fh} }
237		270
238	=item $handle->on_error ($cb)	271	=item $handle->on_error ($cb)
239		272
240	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).
241		274
…		…
251		284
252	=cut	285	=cut
253		286
254	sub on_eof {	287	sub on_eof {
255	$_[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 = AnyEvent->now;
		325
		326	# when would the timeout trigger?
		327	my $after = $self->{_activity} + $self->{timeout} - $NOW;
		328
		329	# now or in the past already?
		330	if ($after <= 0) {
		331	$self->{_activity} = $NOW;
		332
		333	if ($self->{on_timeout}) {
		334	$self->{on_timeout}($self);
		335	} else {
		336	$! = Errno::ETIMEDOUT;
		337	$self->error;
		338	}
		339
		340	# callbakx could have changed timeout value, optimise
		341	return unless $self->{timeout};
		342
		343	# calculate new after
		344	$after = $self->{timeout};
		345	}
		346
		347	Scalar::Util::weaken $self;
		348
		349	$self->{_tw} \|\|= AnyEvent->timer (after => $after, cb => sub {
		350	delete $self->{_tw};
		351	$self->_timeout;
		352	});
		353	} else {
		354	delete $self->{_tw};
		355	}
256	}	356	}
257		357
258	#############################################################################	358	#############################################################################
259		359
260	=back	360	=back
…		…
297	=cut	397	=cut
298		398
299	sub _drain_wbuf {	399	sub _drain_wbuf {
300	my ($self) = @_;	400	my ($self) = @_;
301		401
302	unless ($self->{ww}) {	402	if (!$self->{_ww} && length $self->{wbuf}) {
		403
303	Scalar::Util::weaken $self;	404	Scalar::Util::weaken $self;
		405
304	my $cb = sub {	406	my $cb = sub {
305	my $len = syswrite $self->{fh}, $self->{wbuf};	407	my $len = syswrite $self->{fh}, $self->{wbuf};
306		408
307	if ($len > 0) {	409	if ($len >= 0) {
308	substr $self->{wbuf}, 0, $len, "";	410	substr $self->{wbuf}, 0, $len, "";
		411
		412	$self->{_activity} = AnyEvent->now;
309		413
310	$self->{on_drain}($self)	414	$self->{on_drain}($self)
311	if $self->{low_water_mark} >= length $self->{wbuf}	415	if $self->{low_water_mark} >= length $self->{wbuf}
312	&& $self->{on_drain};	416	&& $self->{on_drain};
313		417
314	delete $self->{ww} unless length $self->{wbuf};	418	delete $self->{_ww} unless length $self->{wbuf};
315	} elsif ($! != EAGAIN && $! != EINTR) {	419	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
316	$self->error;	420	$self->error;
317	}	421	}
318	};	422	};
319		423
		424	# try to write data immediately
		425	$cb->();
		426
		427	# if still data left in wbuf, we need to poll
320	$self->{ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb);	428	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)
321		429	if length $self->{wbuf};
322	$cb->($self);
323	};	430	};
		431	}
		432
		433	our %WH;
		434
		435	sub register_write_type($$) {
		436	$WH{$_[0]} = $_[1];
324	}	437	}
325		438
326	sub push_write {	439	sub push_write {
327	my $self = shift;	440	my $self = shift;
328		441
		442	if (@_ > 1) {
		443	my $type = shift;
		444
		445	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")
		446	->($self, @_);
		447	}
		448
329	if ($self->{filter_w}) {	449	if ($self->{filter_w}) {
330	$self->{filter_w}->($self, \$_[0]);	450	$self->{filter_w}($self, \$_[0]);
331	} else {	451	} else {
332	$self->{wbuf} .= $_[0];	452	$self->{wbuf} .= $_[0];
333	$self->_drain_wbuf;	453	$self->_drain_wbuf;
334	}	454	}
335	}	455	}
		456
		457	=item $handle->push_write (type => @args)
		458
		459	=item $handle->unshift_write (type => @args)
		460
		461	Instead of formatting your data yourself, you can also let this module do
		462	the job by specifying a type and type-specific arguments.
		463
		464	Predefined types are (if you have ideas for additional types, feel free to
		465	drop by and tell us):
		466
		467	=over 4
		468
		469	=item netstring => $string
		470
		471	Formats the given value as netstring
		472	(http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them).
		473
		474	=back
		475
		476	=cut
		477
		478	register_write_type netstring => sub {
		479	my ($self, $string) = @_;
		480
		481	sprintf "%d:%s,", (length $string), $string
		482	};
		483
		484	=item json => $array_or_hashref
		485
		486	Encodes the given hash or array reference into a JSON object. Unless you
		487	provide your own JSON object, this means it will be encoded to JSON text
		488	in UTF-8.
		489
		490	JSON objects (and arrays) are self-delimiting, so you can write JSON at
		491	one end of a handle and read them at the other end without using any
		492	additional framing.
		493
		494	The generated JSON text is guaranteed not to contain any newlines: While
		495	this module doesn't need delimiters after or between JSON texts to be
		496	able to read them, many other languages depend on that.
		497
		498	A simple RPC protocol that interoperates easily with others is to send
		499	JSON arrays (or objects, although arrays are usually the better choice as
		500	they mimic how function argument passing works) and a newline after each
		501	JSON text:
		502
		503	$handle->push_write (json => ["method", "arg1", "arg2"]); # whatever
		504	$handle->push_write ("\012");
		505
		506	An AnyEvent::Handle receiver would simply use the C<json> read type and
		507	rely on the fact that the newline will be skipped as leading whitespace:
		508
		509	$handle->push_read (json => sub { my $array = $_[1]; ... });
		510
		511	Other languages could read single lines terminated by a newline and pass
		512	this line into their JSON decoder of choice.
		513
		514	=cut
		515
		516	register_write_type json => sub {
		517	my ($self, $ref) = @_;
		518
		519	require JSON;
		520
		521	$self->{json} ? $self->{json}->encode ($ref)
		522	: JSON::encode_json ($ref)
		523	};
		524
		525	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
		526
		527	This function (not method) lets you add your own types to C<push_write>.
		528	Whenever the given C<type> is used, C<push_write> will invoke the code
		529	reference with the handle object and the remaining arguments.
		530
		531	The code reference is supposed to return a single octet string that will
		532	be appended to the write buffer.
		533
		534	Note that this is a function, and all types registered this way will be
		535	global, so try to use unique names.
		536
		537	=cut
336		538
337	#############################################################################	539	#############################################################################
338		540
339	=back	541	=back
340		542
…		…
419		621
420	if (	622	if (
421	defined $self->{rbuf_max}	623	defined $self->{rbuf_max}
422	&& $self->{rbuf_max} < length $self->{rbuf}	624	&& $self->{rbuf_max} < length $self->{rbuf}
423	) {	625	) {
424	$! = &Errno::ENOSPC; return $self->error;	626	$! = &Errno::ENOSPC;
		627	$self->error;
425	}	628	}
426		629
427	return if $self->{in_drain};	630	return if $self->{in_drain};
428	local $self->{in_drain} = 1;	631	local $self->{in_drain} = 1;
429		632
430	while (my $len = length $self->{rbuf}) {	633	while (my $len = length $self->{rbuf}) {
431	no strict 'refs';	634	no strict 'refs';
432	if (my $cb = shift @{ $self->{queue} }) {	635	if (my $cb = shift @{ $self->{_queue} }) {
433	if (!$cb->($self)) {	636	unless ($cb->($self)) {
434	if ($self->{eof}) {	637	if ($self->{_eof}) {
435	# no progress can be made (not enough data and no data forthcoming)	638	# no progress can be made (not enough data and no data forthcoming)
436	$! = &Errno::EPIPE; return $self->error;	639	$! = &Errno::EPIPE;
		640	$self->error;
437	}	641	}
438		642
439	unshift @{ $self->{queue} }, $cb;	643	unshift @{ $self->{_queue} }, $cb;
440	return;	644	return;
441	}	645	}
442	} elsif ($self->{on_read}) {	646	} elsif ($self->{on_read}) {
443	$self->{on_read}($self);	647	$self->{on_read}($self);
444		648
445	if (	649	if (
446	$self->{eof} # if no further data will arrive	650	$self->{_eof} # if no further data will arrive
447	&& $len == length $self->{rbuf} # and no data has been consumed	651	&& $len == length $self->{rbuf} # and no data has been consumed
448	&& !@{ $self->{queue} } # and the queue is still empty	652	&& !@{ $self->{_queue} } # and the queue is still empty
449	&& $self->{on_read} # and we still want to read data	653	&& $self->{on_read} # and we still want to read data
450	) {	654	) {
451	# then no progress can be made	655	# then no progress can be made
452	$! = &Errno::EPIPE; return $self->error;	656	$! = &Errno::EPIPE;
		657	$self->error;
453	}	658	}
454	} else {	659	} else {
455	# read side becomes idle	660	# read side becomes idle
456	delete $self->{rw};	661	delete $self->{_rw};
457	return;	662	return;
458	}	663	}
459	}	664	}
460		665
461	if ($self->{eof}) {
462	$self->_shutdown;
463	$self->{on_eof}($self)	666	$self->{on_eof}($self)
464	if $self->{on_eof};	667	if $self->{_eof} && $self->{on_eof};
465	}
466	}	668	}
467		669
468	=item $handle->on_read ($cb)	670	=item $handle->on_read ($cb)
469		671
470	This replaces the currently set C<on_read> callback, or clears it (when	672	This replaces the currently set C<on_read> callback, or clears it (when
…		…
515	interested in (which can be none at all) and return a true value. After returning	717	interested in (which can be none at all) and return a true value. After returning
516	true, it will be removed from the queue.	718	true, it will be removed from the queue.
517		719
518	=cut	720	=cut
519		721
		722	our %RH;
		723
		724	sub register_read_type($$) {
		725	$RH{$_[0]} = $_[1];
		726	}
		727
520	sub push_read {	728	sub push_read {
521	my $self = shift;	729	my $self = shift;
522	my $cb = pop;	730	my $cb = pop;
523		731
524	if (@_) {	732	if (@_) {
…		…
526		734
527	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	735	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
528	->($self, $cb, @_);	736	->($self, $cb, @_);
529	}	737	}
530		738
531	push @{ $self->{queue} }, $cb;	739	push @{ $self->{_queue} }, $cb;
532	$self->_drain_rbuf;	740	$self->_drain_rbuf;
533	}	741	}
534		742
535	sub unshift_read {	743	sub unshift_read {
536	my $self = shift;	744	my $self = shift;
…		…
542	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")	750	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")
543	->($self, $cb, @_);	751	->($self, $cb, @_);
544	}	752	}
545		753
546		754
547	unshift @{ $self->{queue} }, $cb;	755	unshift @{ $self->{_queue} }, $cb;
548	$self->_drain_rbuf;	756	$self->_drain_rbuf;
549	}	757	}
550		758
551	=item $handle->push_read (type => @args, $cb)	759	=item $handle->push_read (type => @args, $cb)
552		760
…		…
554		762
555	Instead of providing a callback that parses the data itself you can chose	763	Instead of providing a callback that parses the data itself you can chose
556	between a number of predefined parsing formats, for chunks of data, lines	764	between a number of predefined parsing formats, for chunks of data, lines
557	etc.	765	etc.
558		766
559	The types currently supported are:	767	Predefined types are (if you have ideas for additional types, feel free to
		768	drop by and tell us):
560		769
561	=over 4	770	=over 4
562		771
563	=item chunk => $octets, $cb->($self, $data)	772	=item chunk => $octets, $cb->($handle, $data)
564		773
565	Invoke the callback only once C<$octets> bytes have been read. Pass the	774	Invoke the callback only once C<$octets> bytes have been read. Pass the
566	data read to the callback. The callback will never be called with less	775	data read to the callback. The callback will never be called with less
567	data.	776	data.
568		777
…		…
591		800
592	sub unshift_read_chunk {	801	sub unshift_read_chunk {
593	$_[0]->unshift_read (chunk => $_[1], $_[2]);	802	$_[0]->unshift_read (chunk => $_[1], $_[2]);
594	}	803	}
595		804
596	=item line => [$eol, ]$cb->($self, $line, $eol)	805	=item line => [$eol, ]$cb->($handle, $line, $eol)
597		806
598	The callback will be called only once a full line (including the end of	807	The callback will be called only once a full line (including the end of
599	line marker, C<$eol>) has been read. This line (excluding the end of line	808	line marker, C<$eol>) has been read. This line (excluding the end of line
600	marker) will be passed to the callback as second argument (C<$line>), and	809	marker) will be passed to the callback as second argument (C<$line>), and
601	the end of line marker as the third argument (C<$eol>).	810	the end of line marker as the third argument (C<$eol>).
…		…
638	sub unshift_read_line {	847	sub unshift_read_line {
639	my $self = shift;	848	my $self = shift;
640	$self->unshift_read (line => @_);	849	$self->unshift_read (line => @_);
641	}	850	}
642		851
		852	=item netstring => $cb->($handle, $string)
		853
		854	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
		855
		856	Throws an error with C<$!> set to EBADMSG on format violations.
		857
		858	=cut
		859
		860	register_read_type netstring => sub {
		861	my ($self, $cb) = @_;
		862
		863	sub {
		864	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
		865	if ($_[0]{rbuf} =~ /[^0-9]/) {
		866	$! = &Errno::EBADMSG;
		867	$self->error;
		868	}
		869	return;
		870	}
		871
		872	my $len = $1;
		873
		874	$self->unshift_read (chunk => $len, sub {
		875	my $string = $_[1];
		876	$_[0]->unshift_read (chunk => 1, sub {
		877	if ($_[1] eq ",") {
		878	$cb->($_[0], $string);
		879	} else {
		880	$! = &Errno::EBADMSG;
		881	$self->error;
		882	}
		883	});
		884	});
		885
		886	1
		887	}
		888	};
		889
		890	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
		891
		892	Makes a regex match against the regex object C<$accept> and returns
		893	everything up to and including the match.
		894
		895	Example: read a single line terminated by '\n'.
		896
		897	$handle->push_read (regex => qr<\n>, sub { ... });
		898
		899	If C<$reject> is given and not undef, then it determines when the data is
		900	to be rejected: it is matched against the data when the C<$accept> regex
		901	does not match and generates an C<EBADMSG> error when it matches. This is
		902	useful to quickly reject wrong data (to avoid waiting for a timeout or a
		903	receive buffer overflow).
		904
		905	Example: expect a single decimal number followed by whitespace, reject
		906	anything else (not the use of an anchor).
		907
		908	$handle->push_read (regex => qr<^[0-9]+\s>, qr<[^0-9]>, sub { ... });
		909
		910	If C<$skip> is given and not C<undef>, then it will be matched against
		911	the receive buffer when neither C<$accept> nor C<$reject> match,
		912	and everything preceding and including the match will be accepted
		913	unconditionally. This is useful to skip large amounts of data that you
		914	know cannot be matched, so that the C<$accept> or C<$reject> regex do not
		915	have to start matching from the beginning. This is purely an optimisation
		916	and is usually worth only when you expect more than a few kilobytes.
		917
		918	Example: expect a http header, which ends at C<\015\012\015\012>. Since we
		919	expect the header to be very large (it isn't in practise, but...), we use
		920	a skip regex to skip initial portions. The skip regex is tricky in that
		921	it only accepts something not ending in either \015 or \012, as these are
		922	required for the accept regex.
		923
		924	$handle->push_read (regex =>
		925	qr<\015\012\015\012>,
		926	undef, # no reject
		927	qr<^.*[^\015\012]>,
		928	sub { ... });
		929
		930	=cut
		931
		932	register_read_type regex => sub {
		933	my ($self, $cb, $accept, $reject, $skip) = @_;
		934
		935	my $data;
		936	my $rbuf = \$self->{rbuf};
		937
		938	sub {
		939	# accept
		940	if ($$rbuf =~ $accept) {
		941	$data .= substr $$rbuf, 0, $+[0], "";
		942	$cb->($self, $data);
		943	return 1;
		944	}
		945
		946	# reject
		947	if ($reject && $$rbuf =~ $reject) {
		948	$! = &Errno::EBADMSG;
		949	$self->error;
		950	}
		951
		952	# skip
		953	if ($skip && $$rbuf =~ $skip) {
		954	$data .= substr $$rbuf, 0, $+[0], "";
		955	}
		956
		957	()
		958	}
		959	};
		960
		961	=item json => $cb->($handle, $hash_or_arrayref)
		962
		963	Reads a JSON object or array, decodes it and passes it to the callback.
		964
		965	If a C<json> object was passed to the constructor, then that will be used
		966	for the final decode, otherwise it will create a JSON coder expecting UTF-8.
		967
		968	This read type uses the incremental parser available with JSON version
		969	2.09 (and JSON::XS version 2.2) and above. You have to provide a
		970	dependency on your own: this module will load the JSON module, but
		971	AnyEvent does not depend on it itself.
		972
		973	Since JSON texts are fully self-delimiting, the C<json> read and write
		974	types are an ideal simple RPC protocol: just exchange JSON datagrams. See
		975	the C<json> write type description, above, for an actual example.
		976
		977	=cut
		978
		979	register_read_type json => sub {
		980	my ($self, $cb, $accept, $reject, $skip) = @_;
		981
		982	require JSON;
		983
		984	my $data;
		985	my $rbuf = \$self->{rbuf};
		986
		987	my $json = $self->{json} \|\|= JSON->new->utf8;
		988
		989	sub {
		990	my $ref = $json->incr_parse ($self->{rbuf});
		991
		992	if ($ref) {
		993	$self->{rbuf} = $json->incr_text;
		994	$json->incr_text = "";
		995	$cb->($self, $ref);
		996
		997	1
		998	} else {
		999	$self->{rbuf} = "";
		1000	()
		1001	}
		1002	}
		1003	};
		1004
643	=back	1005	=back
		1006
		1007	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)
		1008
		1009	This function (not method) lets you add your own types to C<push_read>.
		1010
		1011	Whenever the given C<type> is used, C<push_read> will invoke the code
		1012	reference with the handle object, the callback and the remaining
		1013	arguments.
		1014
		1015	The code reference is supposed to return a callback (usually a closure)
		1016	that works as a plain read callback (see C<< ->push_read ($cb) >>).
		1017
		1018	It should invoke the passed callback when it is done reading (remember to
		1019	pass C<$handle> as first argument as all other callbacks do that).
		1020
		1021	Note that this is a function, and all types registered this way will be
		1022	global, so try to use unique names.
		1023
		1024	For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>,
		1025	search for C<register_read_type>)).
644		1026
645	=item $handle->stop_read	1027	=item $handle->stop_read
646		1028
647	=item $handle->start_read	1029	=item $handle->start_read
648		1030
…		…
654	=cut	1036	=cut
655		1037
656	sub stop_read {	1038	sub stop_read {
657	my ($self) = @_;	1039	my ($self) = @_;
658		1040
659	delete $self->{rw};	1041	delete $self->{_rw};
660	}	1042	}
661		1043
662	sub start_read {	1044	sub start_read {
663	my ($self) = @_;	1045	my ($self) = @_;
664		1046
665	unless ($self->{rw} \|\| $self->{eof}) {	1047	unless ($self->{_rw} \|\| $self->{_eof}) {
666	Scalar::Util::weaken $self;	1048	Scalar::Util::weaken $self;
667		1049
668	$self->{rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1050	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
669	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1051	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};
670	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;	1052	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;
671		1053
672	if ($len > 0) {	1054	if ($len > 0) {
		1055	$self->{_activity} = AnyEvent->now;
		1056
673	$self->{filter_r}	1057	$self->{filter_r}
674	? $self->{filter_r}->($self, $rbuf)	1058	? $self->{filter_r}($self, $rbuf)
675	: $self->_drain_rbuf;	1059	: $self->_drain_rbuf;
676		1060
677	} elsif (defined $len) {	1061	} elsif (defined $len) {
678	delete $self->{rw};	1062	delete $self->{_rw};
679	$self->{eof} = 1;	1063	$self->{_eof} = 1;
680	$self->_drain_rbuf;	1064	$self->_drain_rbuf;
681		1065
682	} elsif ($! != EAGAIN && $! != EINTR) {	1066	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
683	return $self->error;	1067	return $self->error;
684	}	1068	}
685	});	1069	});
686	}	1070	}
687	}	1071	}
688		1072
689	sub _dotls {	1073	sub _dotls {
690	my ($self) = @_;	1074	my ($self) = @_;
691		1075
692	if (length $self->{tls_wbuf}) {	1076	if (length $self->{_tls_wbuf}) {
693	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{tls_wbuf})) > 0) {	1077	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
694	substr $self->{tls_wbuf}, 0, $len, "";	1078	substr $self->{_tls_wbuf}, 0, $len, "";
695	}	1079	}
696	}	1080	}
697		1081
698	if (defined (my $buf = Net::SSLeay::BIO_read ($self->{tls_wbio}))) {	1082	if (defined (my $buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {
699	$self->{wbuf} .= $buf;	1083	$self->{wbuf} .= $buf;
700	$self->_drain_wbuf;	1084	$self->_drain_wbuf;
701	}	1085	}
702		1086
703	while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) {	1087	while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) {
…		…
729	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1113	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
730		1114
731	The second argument is the optional C<Net::SSLeay::CTX> object that is	1115	The second argument is the optional C<Net::SSLeay::CTX> object that is
732	used when AnyEvent::Handle has to create its own TLS connection object.	1116	used when AnyEvent::Handle has to create its own TLS connection object.
733		1117
		1118	The TLS connection object will end up in C<< $handle->{tls} >> after this
		1119	call and can be used or changed to your liking. Note that the handshake
		1120	might have already started when this function returns.
		1121
734	=cut	1122	=cut
735		1123
736	# TODO: maybe document...	1124	# TODO: maybe document...
737	sub starttls {	1125	sub starttls {
738	my ($self, $ssl, $ctx) = @_;	1126	my ($self, $ssl, $ctx) = @_;
…		…
753	# but the openssl maintainers basically said: "trust us, it just works".	1141	# but the openssl maintainers basically said: "trust us, it just works".
754	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1142	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
755	# and mismaintained ssleay-module doesn't even offer them).	1143	# and mismaintained ssleay-module doesn't even offer them).
756	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html	1144	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
757	Net::SSLeay::CTX_set_mode ($self->{tls},	1145	Net::SSLeay::CTX_set_mode ($self->{tls},
758	(eval { Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1146	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
759	\| (eval { Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));	1147	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
760		1148
761	$self->{tls_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1149	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
762	$self->{tls_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1150	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
763		1151
764	Net::SSLeay::set_bio ($ssl, $self->{tls_rbio}, $self->{tls_wbio});	1152	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
765		1153
766	$self->{filter_w} = sub {	1154	$self->{filter_w} = sub {
767	$_[0]{tls_wbuf} .= ${$_[1]};	1155	$_[0]{_tls_wbuf} .= ${$_[1]};
768	&_dotls;	1156	&_dotls;
769	};	1157	};
770	$self->{filter_r} = sub {	1158	$self->{filter_r} = sub {
771	Net::SSLeay::BIO_write ($_[0]{tls_rbio}, ${$_[1]});	1159	Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});
772	&_dotls;	1160	&_dotls;
773	};	1161	};
774	}	1162	}
775		1163
776	=item $handle->stoptls	1164	=item $handle->stoptls
…		…
782		1170
783	sub stoptls {	1171	sub stoptls {
784	my ($self) = @_;	1172	my ($self) = @_;
785		1173
786	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};	1174	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};
		1175
787	delete $self->{tls_rbio};	1176	delete $self->{_rbio};
788	delete $self->{tls_wbio};	1177	delete $self->{_wbio};
789	delete $self->{tls_wbuf};	1178	delete $self->{_tls_wbuf};
790	delete $self->{filter_r};	1179	delete $self->{filter_r};
791	delete $self->{filter_w};	1180	delete $self->{filter_w};
792	}	1181	}
793		1182
794	sub DESTROY {	1183	sub DESTROY {
…		…
832	}	1221	}
833	}	1222	}
834		1223
835	=back	1224	=back
836		1225
		1226	=head1 SUBCLASSING AnyEvent::Handle
		1227
		1228	In many cases, you might want to subclass AnyEvent::Handle.
		1229
		1230	To make this easier, a given version of AnyEvent::Handle uses these
		1231	conventions:
		1232
		1233	=over 4
		1234
		1235	=item * all constructor arguments become object members.
		1236
		1237	At least initially, when you pass a C<tls>-argument to the constructor it
		1238	will end up in C<< $handle->{tls} >>. Those members might be changes or
		1239	mutated later on (for example C<tls> will hold the TLS connection object).
		1240
		1241	=item * other object member names are prefixed with an C<_>.
		1242
		1243	All object members not explicitly documented (internal use) are prefixed
		1244	with an underscore character, so the remaining non-C<_>-namespace is free
		1245	for use for subclasses.
		1246
		1247	=item * all members not documented here and not prefixed with an underscore
		1248	are free to use in subclasses.
		1249
		1250	Of course, new versions of AnyEvent::Handle may introduce more "public"
		1251	member variables, but thats just life, at least it is documented.
		1252
		1253	=back
		1254
837	=head1 AUTHOR	1255	=head1 AUTHOR
838		1256
839	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.	1257	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.
840		1258
841	=cut	1259	=cut

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.28 by root, Sat May 24 22:27:11 2008 UTC vs. Revision 1.50 by root, Fri May 30 21:38:46 2008 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.28 by root, Sat May 24 22:27:11 2008 UTC vs.
Revision 1.50 by root, Fri May 30 21:38:46 2008 UTC