[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.47 by root, Thu May 29 00:25:28 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
17	This module is experimental.
18		16
19	=cut	17	=cut
20		18
21	our $VERSION = '0.04';	19	our $VERSION = '0.04';
22		20
…		…
25	use AnyEvent;	23	use AnyEvent;
26	use AnyEvent::Handle;	24	use AnyEvent::Handle;
27		25
28	my $cv = AnyEvent->condvar;	26	my $cv = AnyEvent->condvar;
29		27
30	my $ae_fh = AnyEvent::Handle->new (fh => \*STDIN);	28	my $handle =
31
32	#TODO
33
34	# or use the constructor to pass the callback:
35
36	my $ae_fh2 =
37	AnyEvent::Handle->new (	29	AnyEvent::Handle->new (
38	fh => \*STDIN,	30	fh => \*STDIN,
39	on_eof => sub {	31	on_eof => sub {
40	$cv->broadcast;	32	$cv->broadcast;
41	},	33	},
42	#TODO
43	);	34	);
44		35
45	$cv->wait;	36	# send some request line
		37	$handle->push_write ("getinfo\015\012");
		38
		39	# read the response line
		40	$handle->push_read (line => sub {
		41	my ($handle, $line) = @_;
		42	warn "read line <$line>\n";
		43	$cv->send;
		44	});
		45
		46	$cv->recv;
46		47
47	=head1 DESCRIPTION	48	=head1 DESCRIPTION
48		49
49	This module is a helper module to make it easier to do event-based I/O on	50	This module is a helper module to make it easier to do event-based I/O on
50	filehandles. For utility functions for doing non-blocking connects and accepts	51	filehandles. For utility functions for doing non-blocking connects and accepts
…		…
72	The filehandle this L<AnyEvent::Handle> object will operate on.	73	The filehandle this L<AnyEvent::Handle> object will operate on.
73		74
74	NOTE: The filehandle will be set to non-blocking (using	75	NOTE: The filehandle will be set to non-blocking (using
75	AnyEvent::Util::fh_nonblocking).	76	AnyEvent::Util::fh_nonblocking).
76		77
77	=item on_eof => $cb->($self)	78	=item on_eof => $cb->($handle)
78		79
79	Set the callback to be called on EOF.	80	Set the callback to be called on EOF.
80		81
81	While not mandatory, it is highly recommended to set an eof callback,	82	While not mandatory, it is highly recommended to set an eof callback,
82	otherwise you might end up with a closed socket while you are still	83	otherwise you might end up with a closed socket while you are still
83	waiting for data.	84	waiting for data.
84		85
85	=item on_error => $cb->($self)	86	=item on_error => $cb->($handle)
86		87
87	This is the fatal error callback, that is called when, well, a fatal error	88	This is the fatal error callback, that is called when, well, a fatal error
88	occurs, such as not being able to resolve the hostname, failure to connect	89	occurs, such as not being able to resolve the hostname, failure to connect
89	or a read error.	90	or a read error.
90		91
91	The object will not be in a usable state when this callback has been	92	The object will not be in a usable state when this callback has been
92	called.	93	called.
93		94
94	On callback entrance, the value of C<$!> contains the operating system	95	On callback entrance, the value of C<$!> contains the operating system
95	error (or C<ENOSPC> or C<EPIPE>).	96	error (or C<ENOSPC>, C<EPIPE>, 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		212
173	sub new {	213	sub new {
…		…
182	if ($self->{tls}) {	222	if ($self->{tls}) {
183	require Net::SSLeay;	223	require Net::SSLeay;
184	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});	224	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});
185	}	225	}
186		226
187	$self->on_eof (delete $self->{on_eof} ) if $self->{on_eof};	227	# $self->on_eof (delete $self->{on_eof} ) if $self->{on_eof}; # nop
188	$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
189	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	230	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
190	$self->on_read (delete $self->{on_read} ) if $self->{on_read};	231
		232	$self->{_activity} = AnyEvent->now;
		233	$self->_timeout;
191		234
192	$self->start_read;	235	$self->start_read;
193		236
194	$self	237	$self
195	}	238	}
196		239
197	sub _shutdown {	240	sub _shutdown {
198	my ($self) = @_;	241	my ($self) = @_;
199		242
		243	delete $self->{_tw};
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 = 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	}
246	}	356	}
247		357
248	#############################################################################	358	#############################################################################
249		359
250	=back	360	=back
…		…
287	=cut	397	=cut
288		398
289	sub _drain_wbuf {	399	sub _drain_wbuf {
290	my ($self) = @_;	400	my ($self) = @_;
291		401
292	unless ($self->{ww}) {	402	if (!$self->{_ww} && length $self->{wbuf}) {
		403
293	Scalar::Util::weaken $self;	404	Scalar::Util::weaken $self;
		405
294	my $cb = sub {	406	my $cb = sub {
295	my $len = syswrite $self->{fh}, $self->{wbuf};	407	my $len = syswrite $self->{fh}, $self->{wbuf};
296		408
297	if ($len > 0) {	409	if ($len >= 0) {
298	substr $self->{wbuf}, 0, $len, "";	410	substr $self->{wbuf}, 0, $len, "";
		411
		412	$self->{_activity} = AnyEvent->now;
299		413
300	$self->{on_drain}($self)	414	$self->{on_drain}($self)
301	if $self->{low_water_mark} >= length $self->{wbuf}	415	if $self->{low_water_mark} >= length $self->{wbuf}
302	&& $self->{on_drain};	416	&& $self->{on_drain};
303		417
304	delete $self->{ww} unless length $self->{wbuf};	418	delete $self->{_ww} unless length $self->{wbuf};
305	} elsif ($! != EAGAIN && $! != EINTR) {	419	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
306	$self->error;	420	$self->error;
307	}	421	}
308	};	422	};
309		423
		424	# try to write data immediately
		425	$cb->();
		426
		427	# if still data left in wbuf, we need to poll
310	$self->{ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb);	428	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)
311		429	if length $self->{wbuf};
312	$cb->($self);
313	};	430	};
		431	}
		432
		433	our %WH;
		434
		435	sub register_write_type($$) {
		436	$WH{$_[0]} = $_[1];
314	}	437	}
315		438
316	sub push_write {	439	sub push_write {
317	my $self = shift;	440	my $self = shift;
		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	}
318		448
319	if ($self->{filter_w}) {	449	if ($self->{filter_w}) {
320	$self->{filter_w}->($self, \$_[0]);	450	$self->{filter_w}->($self, \$_[0]);
321	} else {	451	} else {
322	$self->{wbuf} .= $_[0];	452	$self->{wbuf} .= $_[0];
323	$self->_drain_wbuf;	453	$self->_drain_wbuf;
324	}	454	}
325	}	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
326		538
327	#############################################################################	539	#############################################################################
328		540
329	=back	541	=back
330		542
…		…
409		621
410	if (	622	if (
411	defined $self->{rbuf_max}	623	defined $self->{rbuf_max}
412	&& $self->{rbuf_max} < length $self->{rbuf}	624	&& $self->{rbuf_max} < length $self->{rbuf}
413	) {	625	) {
414	$! = &Errno::ENOSPC; return $self->error;	626	$! = &Errno::ENOSPC;
		627	$self->error;
415	}	628	}
416		629
417	return if $self->{in_drain};	630	return if $self->{in_drain};
418	local $self->{in_drain} = 1;	631	local $self->{in_drain} = 1;
419		632
420	while (my $len = length $self->{rbuf}) {	633	while (my $len = length $self->{rbuf}) {
421	no strict 'refs';	634	no strict 'refs';
422	if (my $cb = shift @{ $self->{queue} }) {	635	if (my $cb = shift @{ $self->{_queue} }) {
423	if (!$cb->($self)) {	636	unless ($cb->($self)) {
424	if ($self->{eof}) {	637	if ($self->{_eof}) {
425	# 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)
426	$! = &Errno::EPIPE; return $self->error;	639	$! = &Errno::EPIPE;
		640	$self->error;
427	}	641	}
428		642
429	unshift @{ $self->{queue} }, $cb;	643	unshift @{ $self->{_queue} }, $cb;
430	return;	644	return;
431	}	645	}
432	} elsif ($self->{on_read}) {	646	} elsif ($self->{on_read}) {
433	$self->{on_read}($self);	647	$self->{on_read}($self);
434		648
435	if (	649	if (
436	$self->{eof} # if no further data will arrive	650	$self->{_eof} # if no further data will arrive
437	&& $len == length $self->{rbuf} # and no data has been consumed	651	&& $len == length $self->{rbuf} # and no data has been consumed
438	&& !@{ $self->{queue} } # and the queue is still empty	652	&& !@{ $self->{_queue} } # and the queue is still empty
439	&& $self->{on_read} # and we still want to read data	653	&& $self->{on_read} # and we still want to read data
440	) {	654	) {
441	# then no progress can be made	655	# then no progress can be made
442	$! = &Errno::EPIPE; return $self->error;	656	$! = &Errno::EPIPE;
		657	$self->error;
443	}	658	}
444	} else {	659	} else {
445	# read side becomes idle	660	# read side becomes idle
446	delete $self->{rw};	661	delete $self->{_rw};
447	return;	662	return;
448	}	663	}
449	}	664	}
450		665
451	if ($self->{eof}) {	666	if ($self->{_eof}) {
452	$self->_shutdown;	667	$self->_shutdown;
453	$self->{on_eof}($self)	668	$self->{on_eof}($self)
454	if $self->{on_eof};	669	if $self->{on_eof};
455	}	670	}
456	}	671	}
…		…
505	interested in (which can be none at all) and return a true value. After returning	720	interested in (which can be none at all) and return a true value. After returning
506	true, it will be removed from the queue.	721	true, it will be removed from the queue.
507		722
508	=cut	723	=cut
509		724
		725	our %RH;
		726
		727	sub register_read_type($$) {
		728	$RH{$_[0]} = $_[1];
		729	}
		730
510	sub push_read {	731	sub push_read {
511	my ($self, $cb) = @_;	732	my $self = shift;
		733	my $cb = pop;
512		734
		735	if (@_) {
		736	my $type = shift;
		737
		738	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
		739	->($self, $cb, @_);
		740	}
		741
513	push @{ $self->{queue} }, $cb;	742	push @{ $self->{_queue} }, $cb;
514	$self->_drain_rbuf;	743	$self->_drain_rbuf;
515	}	744	}
516		745
517	sub unshift_read {	746	sub unshift_read {
518	my ($self, $cb) = @_;	747	my $self = shift;
		748	my $cb = pop;
519		749
		750	if (@_) {
		751	my $type = shift;
		752
		753	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")
		754	->($self, $cb, @_);
		755	}
		756
		757
520	push @{ $self->{queue} }, $cb;	758	unshift @{ $self->{_queue} }, $cb;
521	$self->_drain_rbuf;	759	$self->_drain_rbuf;
522	}	760	}
523		761
524	=item $handle->push_read_chunk ($len, $cb->($self, $data))	762	=item $handle->push_read (type => @args, $cb)
525		763
526	=item $handle->unshift_read_chunk ($len, $cb->($self, $data))	764	=item $handle->unshift_read (type => @args, $cb)
527		765
528	Append the given callback to the end of the queue (C<push_read_chunk>) or	766	Instead of providing a callback that parses the data itself you can chose
529	prepend it (C<unshift_read_chunk>).	767	between a number of predefined parsing formats, for chunks of data, lines
		768	etc.
530		769
531	The callback will be called only once C<$len> bytes have been read, and	770	Predefined types are (if you have ideas for additional types, feel free to
532	these C<$len> bytes will be passed to the callback.	771	drop by and tell us):
533		772
534	=cut	773	=over 4
535		774
536	sub _read_chunk($$) {	775	=item chunk => $octets, $cb->($handle, $data)
		776
		777	Invoke the callback only once C<$octets> bytes have been read. Pass the
		778	data read to the callback. The callback will never be called with less
		779	data.
		780
		781	Example: read 2 bytes.
		782
		783	$handle->push_read (chunk => 2, sub {
		784	warn "yay ", unpack "H*", $_[1];
		785	});
		786
		787	=cut
		788
		789	register_read_type chunk => sub {
537	my ($self, $len, $cb) = @_;	790	my ($self, $cb, $len) = @_;
538		791
539	sub {	792	sub {
540	$len <= length $_[0]{rbuf} or return;	793	$len <= length $_[0]{rbuf} or return;
541	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");	794	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");
542	1	795	1
543	}	796	}
544	}	797	};
545		798
		799	# compatibility with older API
546	sub push_read_chunk {	800	sub push_read_chunk {
547	$_[0]->push_read (&_read_chunk);	801	$_[0]->push_read (chunk => $_[1], $_[2]);
548	}	802	}
549
550		803
551	sub unshift_read_chunk {	804	sub unshift_read_chunk {
552	$_[0]->unshift_read (&_read_chunk);	805	$_[0]->unshift_read (chunk => $_[1], $_[2]);
553	}	806	}
554		807
555	=item $handle->push_read_line ([$eol, ]$cb->($self, $line, $eol))	808	=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		809
562	The callback will be called only once a full line (including the end of	810	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	811	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	812	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>).	813	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	824	Partial lines at the end of the stream will never be returned, as they are
577	not marked by the end of line marker.	825	not marked by the end of line marker.
578		826
579	=cut	827	=cut
580		828
581	sub _read_line($$) {	829	register_read_type line => sub {
582	my $self = shift;	830	my ($self, $cb, $eol) = @_;
583	my $cb = pop;
584	my $eol = @_ ? shift : qr\|(\015?\012)\|;
585	my $pos;
586		831
		832	$eol = qr\|(\015?\012)\| if @_ < 3;
587	$eol = quotemeta $eol unless ref $eol;	833	$eol = quotemeta $eol unless ref $eol;
588	$eol = qr\|^(.*?)($eol)\|s;	834	$eol = qr\|^(.*?)($eol)\|s;
589		835
590	sub {	836	sub {
591	$_[0]{rbuf} =~ s/$eol// or return;	837	$_[0]{rbuf} =~ s/$eol// or return;
592		838
593	$cb->($_[0], $1, $2);	839	$cb->($_[0], $1, $2);
594	1	840	1
595	}	841	}
596	}	842	};
597		843
		844	# compatibility with older API
598	sub push_read_line {	845	sub push_read_line {
599	$_[0]->push_read (&_read_line);	846	my $self = shift;
		847	$self->push_read (line => @_);
600	}	848	}
601		849
602	sub unshift_read_line {	850	sub unshift_read_line {
603	$_[0]->unshift_read (&_read_line);	851	my $self = shift;
		852	$self->unshift_read (line => @_);
604	}	853	}
		854
		855	=item netstring => $cb->($handle, $string)
		856
		857	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
		858
		859	Throws an error with C<$!> set to EBADMSG on format violations.
		860
		861	=cut
		862
		863	register_read_type netstring => sub {
		864	my ($self, $cb) = @_;
		865
		866	sub {
		867	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
		868	if ($_[0]{rbuf} =~ /[^0-9]/) {
		869	$! = &Errno::EBADMSG;
		870	$self->error;
		871	}
		872	return;
		873	}
		874
		875	my $len = $1;
		876
		877	$self->unshift_read (chunk => $len, sub {
		878	my $string = $_[1];
		879	$_[0]->unshift_read (chunk => 1, sub {
		880	if ($_[1] eq ",") {
		881	$cb->($_[0], $string);
		882	} else {
		883	$! = &Errno::EBADMSG;
		884	$self->error;
		885	}
		886	});
		887	});
		888
		889	1
		890	}
		891	};
		892
		893	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
		894
		895	Makes a regex match against the regex object C<$accept> and returns
		896	everything up to and including the match.
		897
		898	Example: read a single line terminated by '\n'.
		899
		900	$handle->push_read (regex => qr<\n>, sub { ... });
		901
		902	If C<$reject> is given and not undef, then it determines when the data is
		903	to be rejected: it is matched against the data when the C<$accept> regex
		904	does not match and generates an C<EBADMSG> error when it matches. This is
		905	useful to quickly reject wrong data (to avoid waiting for a timeout or a
		906	receive buffer overflow).
		907
		908	Example: expect a single decimal number followed by whitespace, reject
		909	anything else (not the use of an anchor).
		910
		911	$handle->push_read (regex => qr<^[0-9]+\s>, qr<[^0-9]>, sub { ... });
		912
		913	If C<$skip> is given and not C<undef>, then it will be matched against
		914	the receive buffer when neither C<$accept> nor C<$reject> match,
		915	and everything preceding and including the match will be accepted
		916	unconditionally. This is useful to skip large amounts of data that you
		917	know cannot be matched, so that the C<$accept> or C<$reject> regex do not
		918	have to start matching from the beginning. This is purely an optimisation
		919	and is usually worth only when you expect more than a few kilobytes.
		920
		921	Example: expect a http header, which ends at C<\015\012\015\012>. Since we
		922	expect the header to be very large (it isn't in practise, but...), we use
		923	a skip regex to skip initial portions. The skip regex is tricky in that
		924	it only accepts something not ending in either \015 or \012, as these are
		925	required for the accept regex.
		926
		927	$handle->push_read (regex =>
		928	qr<\015\012\015\012>,
		929	undef, # no reject
		930	qr<^.*[^\015\012]>,
		931	sub { ... });
		932
		933	=cut
		934
		935	register_read_type regex => sub {
		936	my ($self, $cb, $accept, $reject, $skip) = @_;
		937
		938	my $data;
		939	my $rbuf = \$self->{rbuf};
		940
		941	sub {
		942	# accept
		943	if ($$rbuf =~ $accept) {
		944	$data .= substr $$rbuf, 0, $+[0], "";
		945	$cb->($self, $data);
		946	return 1;
		947	}
		948
		949	# reject
		950	if ($reject && $$rbuf =~ $reject) {
		951	$! = &Errno::EBADMSG;
		952	$self->error;
		953	}
		954
		955	# skip
		956	if ($skip && $$rbuf =~ $skip) {
		957	$data .= substr $$rbuf, 0, $+[0], "";
		958	}
		959
		960	()
		961	}
		962	};
		963
		964	=item json => $cb->($handle, $hash_or_arrayref)
		965
		966	Reads a JSON object or array, decodes it and passes it to the callback.
		967
		968	If a C<json> object was passed to the constructor, then that will be used
		969	for the final decode, otherwise it will create a JSON coder expecting UTF-8.
		970
		971	This read type uses the incremental parser available with JSON version
		972	2.09 (and JSON::XS version 2.2) and above. You have to provide a
		973	dependency on your own: this module will load the JSON module, but
		974	AnyEvent does not depend on it itself.
		975
		976	Since JSON texts are fully self-delimiting, the C<json> read and write
		977	types are an ideal simple RPC protocol: just exchange JSON datagrams. See
		978	the C<json> write type description, above, for an actual example.
		979
		980	=cut
		981
		982	register_read_type json => sub {
		983	my ($self, $cb, $accept, $reject, $skip) = @_;
		984
		985	require JSON;
		986
		987	my $data;
		988	my $rbuf = \$self->{rbuf};
		989
		990	my $json = $self->{json} \|\|= JSON->new->utf8;
		991
		992	sub {
		993	my $ref = $json->incr_parse ($self->{rbuf});
		994
		995	if ($ref) {
		996	$self->{rbuf} = $json->incr_text;
		997	$json->incr_text = "";
		998	$cb->($self, $ref);
		999
		1000	1
		1001	} else {
		1002	$self->{rbuf} = "";
		1003	()
		1004	}
		1005	}
		1006	};
		1007
		1008	=back
		1009
		1010	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)
		1011
		1012	This function (not method) lets you add your own types to C<push_read>.
		1013
		1014	Whenever the given C<type> is used, C<push_read> will invoke the code
		1015	reference with the handle object, the callback and the remaining
		1016	arguments.
		1017
		1018	The code reference is supposed to return a callback (usually a closure)
		1019	that works as a plain read callback (see C<< ->push_read ($cb) >>).
		1020
		1021	It should invoke the passed callback when it is done reading (remember to
		1022	pass C<$handle> as first argument as all other callbacks do that).
		1023
		1024	Note that this is a function, and all types registered this way will be
		1025	global, so try to use unique names.
		1026
		1027	For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>,
		1028	search for C<register_read_type>)).
605		1029
606	=item $handle->stop_read	1030	=item $handle->stop_read
607		1031
608	=item $handle->start_read	1032	=item $handle->start_read
609		1033
…		…
615	=cut	1039	=cut
616		1040
617	sub stop_read {	1041	sub stop_read {
618	my ($self) = @_;	1042	my ($self) = @_;
619		1043
620	delete $self->{rw};	1044	delete $self->{_rw};
621	}	1045	}
622		1046
623	sub start_read {	1047	sub start_read {
624	my ($self) = @_;	1048	my ($self) = @_;
625		1049
626	unless ($self->{rw} \|\| $self->{eof}) {	1050	unless ($self->{_rw} \|\| $self->{_eof}) {
627	Scalar::Util::weaken $self;	1051	Scalar::Util::weaken $self;
628		1052
629	$self->{rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1053	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
630	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1054	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};
631	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;	1055	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;
632		1056
633	if ($len > 0) {	1057	if ($len > 0) {
		1058	$self->{_activity} = AnyEvent->now;
		1059
634	$self->{filter_r}	1060	$self->{filter_r}
635	? $self->{filter_r}->($self, $rbuf)	1061	? $self->{filter_r}->($self, $rbuf)
636	: $self->_drain_rbuf;	1062	: $self->_drain_rbuf;
637		1063
638	} elsif (defined $len) {	1064	} elsif (defined $len) {
639	delete $self->{rw};	1065	delete $self->{_rw};
640	$self->{eof} = 1;	1066	$self->{_eof} = 1;
641	$self->_drain_rbuf;	1067	$self->_drain_rbuf;
642		1068
643	} elsif ($! != EAGAIN && $! != EINTR) {	1069	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
644	return $self->error;	1070	return $self->error;
645	}	1071	}
646	});	1072	});
647	}	1073	}
648	}	1074	}
649		1075
650	sub _dotls {	1076	sub _dotls {
651	my ($self) = @_;	1077	my ($self) = @_;
652		1078
653	if (length $self->{tls_wbuf}) {	1079	if (length $self->{_tls_wbuf}) {
654	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{tls_wbuf})) > 0) {	1080	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
655	substr $self->{tls_wbuf}, 0, $len, "";	1081	substr $self->{_tls_wbuf}, 0, $len, "";
656	}	1082	}
657	}	1083	}
658		1084
659	if (defined (my $buf = Net::SSLeay::BIO_read ($self->{tls_wbio}))) {	1085	if (defined (my $buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {
660	$self->{wbuf} .= $buf;	1086	$self->{wbuf} .= $buf;
661	$self->_drain_wbuf;	1087	$self->_drain_wbuf;
662	}	1088	}
663		1089
664	while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) {	1090	while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) {
…		…
690	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1116	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
691		1117
692	The second argument is the optional C<Net::SSLeay::CTX> object that is	1118	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.	1119	used when AnyEvent::Handle has to create its own TLS connection object.
694		1120
		1121	The TLS connection object will end up in C<< $handle->{tls} >> after this
		1122	call and can be used or changed to your liking. Note that the handshake
		1123	might have already started when this function returns.
		1124
695	=cut	1125	=cut
696		1126
697	# TODO: maybe document...	1127	# TODO: maybe document...
698	sub starttls {	1128	sub starttls {
699	my ($self, $ssl, $ctx) = @_;	1129	my ($self, $ssl, $ctx) = @_;
…		…
714	# but the openssl maintainers basically said: "trust us, it just works".	1144	# but the openssl maintainers basically said: "trust us, it just works".
715	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1145	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
716	# and mismaintained ssleay-module doesn't even offer them).	1146	# and mismaintained ssleay-module doesn't even offer them).
717	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html	1147	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
718	Net::SSLeay::CTX_set_mode ($self->{tls},	1148	Net::SSLeay::CTX_set_mode ($self->{tls},
719	(eval { Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1149	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
720	\| (eval { Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));	1150	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
721		1151
722	$self->{tls_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1152	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
723	$self->{tls_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1153	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
724		1154
725	Net::SSLeay::set_bio ($ssl, $self->{tls_rbio}, $self->{tls_wbio});	1155	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
726		1156
727	$self->{filter_w} = sub {	1157	$self->{filter_w} = sub {
728	$_[0]{tls_wbuf} .= ${$_[1]};	1158	$_[0]{_tls_wbuf} .= ${$_[1]};
729	&_dotls;	1159	&_dotls;
730	};	1160	};
731	$self->{filter_r} = sub {	1161	$self->{filter_r} = sub {
732	Net::SSLeay::BIO_write ($_[0]{tls_rbio}, ${$_[1]});	1162	Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});
733	&_dotls;	1163	&_dotls;
734	};	1164	};
735	}	1165	}
736		1166
737	=item $handle->stoptls	1167	=item $handle->stoptls
…		…
743		1173
744	sub stoptls {	1174	sub stoptls {
745	my ($self) = @_;	1175	my ($self) = @_;
746		1176
747	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};	1177	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};
		1178
748	delete $self->{tls_rbio};	1179	delete $self->{_rbio};
749	delete $self->{tls_wbio};	1180	delete $self->{_wbio};
750	delete $self->{tls_wbuf};	1181	delete $self->{_tls_wbuf};
751	delete $self->{filter_r};	1182	delete $self->{filter_r};
752	delete $self->{filter_w};	1183	delete $self->{filter_w};
753	}	1184	}
754		1185
755	sub DESTROY {	1186	sub DESTROY {
…		…
793	}	1224	}
794	}	1225	}
795		1226
796	=back	1227	=back
797		1228
		1229	=head1 SUBCLASSING AnyEvent::Handle
		1230
		1231	In many cases, you might want to subclass AnyEvent::Handle.
		1232
		1233	To make this easier, a given version of AnyEvent::Handle uses these
		1234	conventions:
		1235
		1236	=over 4
		1237
		1238	=item * all constructor arguments become object members.
		1239
		1240	At least initially, when you pass a C<tls>-argument to the constructor it
		1241	will end up in C<< $handle->{tls} >>. Those members might be changes or
		1242	mutated later on (for example C<tls> will hold the TLS connection object).
		1243
		1244	=item * other object member names are prefixed with an C<_>.
		1245
		1246	All object members not explicitly documented (internal use) are prefixed
		1247	with an underscore character, so the remaining non-C<_>-namespace is free
		1248	for use for subclasses.
		1249
		1250	=item * all members not documented here and not prefixed with an underscore
		1251	are free to use in subclasses.
		1252
		1253	Of course, new versions of AnyEvent::Handle may introduce more "public"
		1254	member variables, but thats just life, at least it is documented.
		1255
		1256	=back
		1257
798	=head1 AUTHOR	1258	=head1 AUTHOR
799		1259
800	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.	1260	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.
801		1261
802	=cut	1262	=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.47 by root, Thu May 29 00:25:28 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.47 by root, Thu May 29 00:25:28 2008 UTC