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

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

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.21 by root, Sat May 24 15:03:42 2008 UTC vs. Revision 1.45 by root, Thu May 29 00:20:39 2008 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.21 by root, Sat May 24 15:03:42 2008 UTC vs.
Revision 1.45 by root, Thu May 29 00:20:39 2008 UTC