[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.54 by root, Tue Jun 3 09:02: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.12;
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 when an end-of-file condition is detcted,
		81	i.e. in the case of a socket, when the other side has closed the
		82	connection cleanly.
80		83
81	While not mandatory, it is highly recommended to set an eof callback,	84	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	85	otherwise you might end up with a closed socket while you are still
83	waiting for data.	86	waiting for data.
84		87
85	=item on_error => $cb->($self)	88	=item on_error => $cb->($handle, $fatal)
86		89
87	This is the fatal error callback, that is called when, well, a fatal error	90	This is the error callback, which is called when, well, some error
88	occurs, such as not being able to resolve the hostname, failure to connect	91	occured, such as not being able to resolve the hostname, failure to
89	or a read error.	92	connect or a read error.
90		93
91	The object will not be in a usable state when this callback has been	94	Some errors are fatal (which is indicated by C<$fatal> being true). On
92	called.	95	fatal errors the handle object will be shut down and will not be
		96	usable. Non-fatal errors can be retried by simply returning, but it is
		97	recommended to simply ignore this parameter and instead abondon the handle
		98	object when this callback is invoked.
93		99
94	On callback entrance, the value of C<$!> contains the operating system	100	On callback entrance, the value of C<$!> contains the operating system
95	error (or C<ENOSPC> or C<EPIPE>).	101	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).
96		102
97	While not mandatory, it is I<highly> recommended to set this callback, as	103	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	104	you will not be notified of errors otherwise. The default simply calls
99	die.	105	C<croak>.
100		106
101	=item on_read => $cb->($self)	107	=item on_read => $cb->($handle)
102		108
103	This sets the default read callback, which is called when data arrives	109	This sets the default read callback, which is called when data arrives
104	and no read request is in the queue.	110	and no read request is in the queue.
105		111
106	To access (and remove data from) the read buffer, use the C<< ->rbuf >>	112	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
107	method or access the C<$self->{rbuf}> member directly.	113	method or access the C<$handle->{rbuf}> member directly.
108		114
109	When an EOF condition is detected then AnyEvent::Handle will first try to	115	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	116	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	117	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>).	118	error will be raised (with C<$!> set to C<EPIPE>).
113		119
114	=item on_drain => $cb->()	120	=item on_drain => $cb->($handle)
115		121
116	This sets the callback that is called when the write buffer becomes empty	122	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).	123	(or when the callback is set and the buffer is empty already).
118		124
119	To append to the write buffer, use the C<< ->push_write >> method.	125	To append to the write buffer, use the C<< ->push_write >> method.
		126
		127	=item timeout => $fractional_seconds
		128
		129	If non-zero, then this enables an "inactivity" timeout: whenever this many
		130	seconds pass without a successful read or write on the underlying file
		131	handle, the C<on_timeout> callback will be invoked (and if that one is
		132	missing, an C<ETIMEDOUT> error will be raised).
		133
		134	Note that timeout processing is also active when you currently do not have
		135	any outstanding read or write requests: If you plan to keep the connection
		136	idle then you should disable the timout temporarily or ignore the timeout
		137	in the C<on_timeout> callback.
		138
		139	Zero (the default) disables this timeout.
		140
		141	=item on_timeout => $cb->($handle)
		142
		143	Called whenever the inactivity timeout passes. If you return from this
		144	callback, then the timeout will be reset as if some activity had happened,
		145	so this condition is not fatal in any way.
120		146
121	=item rbuf_max => <bytes>	147	=item rbuf_max => <bytes>
122		148
123	If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)	149	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	150	when the read buffer ever (strictly) exceeds this size. This is useful to
…		…
131	isn't finished).	157	isn't finished).
132		158
133	=item read_size => <bytes>	159	=item read_size => <bytes>
134		160
135	The default read block size (the amount of bytes this module will try to read	161	The default read block size (the amount of bytes this module will try to read
136	on each [loop iteration). Default: C<4096>.	162	during each (loop iteration). Default: C<8192>.
137		163
138	=item low_water_mark => <bytes>	164	=item low_water_mark => <bytes>
139		165
140	Sets the amount of bytes (default: C<0>) that make up an "empty" write	166	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	167	buffer: If the write reaches this size or gets even samller it is
…		…
164		190
165	Use the given Net::SSLeay::CTX object to create the new TLS connection	191	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	192	(unless a connection object was specified directly). If this parameter is
167	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	193	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
168		194
		195	=item json => JSON or JSON::XS object
		196
		197	This is the json coder object used by the C<json> read and write types.
		198
		199	If you don't supply it, then AnyEvent::Handle will create and use a
		200	suitable one, which will write and expect UTF-8 encoded JSON texts.
		201
		202	Note that you are responsible to depend on the JSON module if you want to
		203	use this functionality, as AnyEvent does not have a dependency itself.
		204
		205	=item filter_r => $cb
		206
		207	=item filter_w => $cb
		208
		209	These exist, but are undocumented at this time.
		210
169	=back	211	=back
170		212
171	=cut	213	=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		214
183	sub new {	215	sub new {
184	my $class = shift;	216	my $class = shift;
185		217
186	my $self = bless { @_ }, $class;	218	my $self = bless { @_ }, $class;
…		…
192	if ($self->{tls}) {	224	if ($self->{tls}) {
193	require Net::SSLeay;	225	require Net::SSLeay;
194	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});	226	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});
195	}	227	}
196		228
197	$self->on_eof (delete $self->{on_eof} ) if $self->{on_eof};	229	# $self->on_eof (delete $self->{on_eof} ) if $self->{on_eof}; # nop
198	$self->on_error (delete $self->{on_error}) if $self->{on_error};	230	# $self->on_error (delete $self->{on_error}) if $self->{on_error}; # nop
		231	# $self->on_read (delete $self->{on_read} ) if $self->{on_read}; # nop
199	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	232	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
200	$self->on_read (delete $self->{on_read} ) if $self->{on_read};	233
		234	$self->{_activity} = AnyEvent->now;
		235	$self->_timeout;
201		236
202	$self->start_read;	237	$self->start_read;
203		238
204	$self	239	$self
205	}	240	}
206		241
207	sub _shutdown {	242	sub _shutdown {
208	my ($self) = @_;	243	my ($self) = @_;
209		244
		245	delete $self->{_tw};
210	delete $self->{rw};	246	delete $self->{_rw};
211	delete $self->{ww};	247	delete $self->{_ww};
212	delete $self->{fh};	248	delete $self->{fh};
213	}
214		249
		250	$self->stoptls;
		251	}
		252
215	sub error {	253	sub _error {
216	my ($self) = @_;	254	my ($self, $errno, $fatal) = @_;
217		255
218	{
219	local $!;
220	$self->_shutdown;	256	$self->_shutdown
221	}	257	if $fatal;
		258
		259	$! = $errno;
222		260
223	if ($self->{on_error}) {	261	if ($self->{on_error}) {
224	$self->{on_error}($self);	262	$self->{on_error}($self, $fatal);
225	} else {	263	} else {
226	die "AnyEvent::Handle uncaught fatal error: $!";	264	Carp::croak "AnyEvent::Handle uncaught error: $!";
227	}	265	}
228	}	266	}
229		267
230	=item $fh = $handle->fh	268	=item $fh = $handle->fh
231		269
232	This method returns the file handle of the L<AnyEvent::Handle> object.	270	This method returns the file handle of the L<AnyEvent::Handle> object.
233		271
234	=cut	272	=cut
235		273
236	sub fh { $_[0]->{fh} }	274	sub fh { $_[0]{fh} }
237		275
238	=item $handle->on_error ($cb)	276	=item $handle->on_error ($cb)
239		277
240	Replace the current C<on_error> callback (see the C<on_error> constructor argument).	278	Replace the current C<on_error> callback (see the C<on_error> constructor argument).
241		279
…		…
251		289
252	=cut	290	=cut
253		291
254	sub on_eof {	292	sub on_eof {
255	$_[0]{on_eof} = $_[1];	293	$_[0]{on_eof} = $_[1];
		294	}
		295
		296	=item $handle->on_timeout ($cb)
		297
		298	Replace the current C<on_timeout> callback, or disables the callback
		299	(but not the timeout) if C<$cb> = C<undef>. See C<timeout> constructor
		300	argument.
		301
		302	=cut
		303
		304	sub on_timeout {
		305	$_[0]{on_timeout} = $_[1];
		306	}
		307
		308	#############################################################################
		309
		310	=item $handle->timeout ($seconds)
		311
		312	Configures (or disables) the inactivity timeout.
		313
		314	=cut
		315
		316	sub timeout {
		317	my ($self, $timeout) = @_;
		318
		319	$self->{timeout} = $timeout;
		320	$self->_timeout;
		321	}
		322
		323	# reset the timeout watcher, as neccessary
		324	# also check for time-outs
		325	sub _timeout {
		326	my ($self) = @_;
		327
		328	if ($self->{timeout}) {
		329	my $NOW = AnyEvent->now;
		330
		331	# when would the timeout trigger?
		332	my $after = $self->{_activity} + $self->{timeout} - $NOW;
		333
		334	# now or in the past already?
		335	if ($after <= 0) {
		336	$self->{_activity} = $NOW;
		337
		338	if ($self->{on_timeout}) {
		339	$self->{on_timeout}($self);
		340	} else {
		341	$self->_error (&Errno::ETIMEDOUT);
		342	}
		343
		344	# callbakx could have changed timeout value, optimise
		345	return unless $self->{timeout};
		346
		347	# calculate new after
		348	$after = $self->{timeout};
		349	}
		350
		351	Scalar::Util::weaken $self;
		352
		353	$self->{_tw} \|\|= AnyEvent->timer (after => $after, cb => sub {
		354	delete $self->{_tw};
		355	$self->_timeout;
		356	});
		357	} else {
		358	delete $self->{_tw};
		359	}
256	}	360	}
257		361
258	#############################################################################	362	#############################################################################
259		363
260	=back	364	=back
…		…
297	=cut	401	=cut
298		402
299	sub _drain_wbuf {	403	sub _drain_wbuf {
300	my ($self) = @_;	404	my ($self) = @_;
301		405
302	unless ($self->{ww}) {	406	if (!$self->{_ww} && length $self->{wbuf}) {
		407
303	Scalar::Util::weaken $self;	408	Scalar::Util::weaken $self;
		409
304	my $cb = sub {	410	my $cb = sub {
305	my $len = syswrite $self->{fh}, $self->{wbuf};	411	my $len = syswrite $self->{fh}, $self->{wbuf};
306		412
307	if ($len > 0) {	413	if ($len >= 0) {
308	substr $self->{wbuf}, 0, $len, "";	414	substr $self->{wbuf}, 0, $len, "";
		415
		416	$self->{_activity} = AnyEvent->now;
309		417
310	$self->{on_drain}($self)	418	$self->{on_drain}($self)
311	if $self->{low_water_mark} >= length $self->{wbuf}	419	if $self->{low_water_mark} >= length $self->{wbuf}
312	&& $self->{on_drain};	420	&& $self->{on_drain};
313		421
314	delete $self->{ww} unless length $self->{wbuf};	422	delete $self->{_ww} unless length $self->{wbuf};
315	} elsif ($! != EAGAIN && $! != EINTR) {	423	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
316	$self->error;	424	$self->_error ($!, 1);
317	}	425	}
318	};	426	};
319		427
		428	# try to write data immediately
		429	$cb->();
		430
		431	# if still data left in wbuf, we need to poll
320	$self->{ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb);	432	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)
321		433	if length $self->{wbuf};
322	$cb->($self);
323	};	434	};
		435	}
		436
		437	our %WH;
		438
		439	sub register_write_type($$) {
		440	$WH{$_[0]} = $_[1];
324	}	441	}
325		442
326	sub push_write {	443	sub push_write {
327	my $self = shift;	444	my $self = shift;
328		445
		446	if (@_ > 1) {
		447	my $type = shift;
		448
		449	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")
		450	->($self, @_);
		451	}
		452
329	if ($self->{filter_w}) {	453	if ($self->{filter_w}) {
330	$self->{filter_w}->($self, \$_[0]);	454	$self->{filter_w}($self, \$_[0]);
331	} else {	455	} else {
332	$self->{wbuf} .= $_[0];	456	$self->{wbuf} .= $_[0];
333	$self->_drain_wbuf;	457	$self->_drain_wbuf;
334	}	458	}
335	}	459	}
		460
		461	=item $handle->push_write (type => @args)
		462
		463	Instead of formatting your data yourself, you can also let this module do
		464	the job by specifying a type and type-specific arguments.
		465
		466	Predefined types are (if you have ideas for additional types, feel free to
		467	drop by and tell us):
		468
		469	=over 4
		470
		471	=item netstring => $string
		472
		473	Formats the given value as netstring
		474	(http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them).
		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	=back
		526
		527	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
		528
		529	This function (not method) lets you add your own types to C<push_write>.
		530	Whenever the given C<type> is used, C<push_write> will invoke the code
		531	reference with the handle object and the remaining arguments.
		532
		533	The code reference is supposed to return a single octet string that will
		534	be appended to the write buffer.
		535
		536	Note that this is a function, and all types registered this way will be
		537	global, so try to use unique names.
		538
		539	=cut
336		540
337	#############################################################################	541	#############################################################################
338		542
339	=back	543	=back
340		544
…		…
364	the specified number of bytes which give an XML datagram.	568	the specified number of bytes which give an XML datagram.
365		569
366	# in the default state, expect some header bytes	570	# in the default state, expect some header bytes
367	$handle->on_read (sub {	571	$handle->on_read (sub {
368	# some data is here, now queue the length-header-read (4 octets)	572	# some data is here, now queue the length-header-read (4 octets)
369	shift->unshift_read_chunk (4, sub {	573	shift->unshift_read (chunk => 4, sub {
370	# header arrived, decode	574	# header arrived, decode
371	my $len = unpack "N", $_[1];	575	my $len = unpack "N", $_[1];
372		576
373	# now read the payload	577	# now read the payload
374	shift->unshift_read_chunk ($len, sub {	578	shift->unshift_read (chunk => $len, sub {
375	my $xml = $_[1];	579	my $xml = $_[1];
376	# handle xml	580	# handle xml
377	});	581	});
378	});	582	});
379	});	583	});
…		…
386		590
387	# request one	591	# request one
388	$handle->push_write ("request 1\015\012");	592	$handle->push_write ("request 1\015\012");
389		593
390	# we expect "ERROR" or "OK" as response, so push a line read	594	# we expect "ERROR" or "OK" as response, so push a line read
391	$handle->push_read_line (sub {	595	$handle->push_read (line => sub {
392	# if we got an "OK", we have to _prepend_ another line,	596	# if we got an "OK", we have to _prepend_ another line,
393	# so it will be read before the second request reads its 64 bytes	597	# so it will be read before the second request reads its 64 bytes
394	# which are already in the queue when this callback is called	598	# which are already in the queue when this callback is called
395	# we don't do this in case we got an error	599	# we don't do this in case we got an error
396	if ($_[1] eq "OK") {	600	if ($_[1] eq "OK") {
397	$_[0]->unshift_read_line (sub {	601	$_[0]->unshift_read (line => sub {
398	my $response = $_[1];	602	my $response = $_[1];
399	...	603	...
400	});	604	});
401	}	605	}
402	});	606	});
403		607
404	# request two	608	# request two
405	$handle->push_write ("request 2\015\012");	609	$handle->push_write ("request 2\015\012");
406		610
407	# simply read 64 bytes, always	611	# simply read 64 bytes, always
408	$handle->push_read_chunk (64, sub {	612	$handle->push_read (chunk => 64, sub {
409	my $response = $_[1];	613	my $response = $_[1];
410	...	614	...
411	});	615	});
412		616
413	=over 4	617	=over 4
…		…
419		623
420	if (	624	if (
421	defined $self->{rbuf_max}	625	defined $self->{rbuf_max}
422	&& $self->{rbuf_max} < length $self->{rbuf}	626	&& $self->{rbuf_max} < length $self->{rbuf}
423	) {	627	) {
424	$! = &Errno::ENOSPC; return $self->error;	628	return $self->_error (&Errno::ENOSPC, 1);
425	}	629	}
426		630
427	return if $self->{in_drain};	631	return if $self->{in_drain};
428	local $self->{in_drain} = 1;	632	local $self->{in_drain} = 1;
429		633
430	while (my $len = length $self->{rbuf}) {	634	while (my $len = length $self->{rbuf}) {
431	no strict 'refs';	635	no strict 'refs';
432	if (my $cb = shift @{ $self->{queue} }) {	636	if (my $cb = shift @{ $self->{_queue} }) {
433	if (!$cb->($self)) {	637	unless ($cb->($self)) {
434	if ($self->{eof}) {	638	if ($self->{_eof}) {
435	# no progress can be made (not enough data and no data forthcoming)	639	# no progress can be made (not enough data and no data forthcoming)
436	$! = &Errno::EPIPE; return $self->error;	640	return $self->_error (&Errno::EPIPE, 1);
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	return $self->_error (&Errno::EPIPE, 1);
453	}	657	}
454	} else {	658	} else {
455	# read side becomes idle	659	# read side becomes idle
456	delete $self->{rw};	660	delete $self->{_rw};
457	return;	661	return;
458	}	662	}
459	}	663	}
460		664
461	if ($self->{eof}) {
462	$self->_shutdown;
463	$self->{on_eof}($self)	665	$self->{on_eof}($self)
464	if $self->{on_eof};	666	if $self->{_eof} && $self->{on_eof};
465	}
466	}	667	}
467		668
468	=item $handle->on_read ($cb)	669	=item $handle->on_read ($cb)
469		670
470	This replaces the currently set C<on_read> callback, or clears it (when	671	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	716	interested in (which can be none at all) and return a true value. After returning
516	true, it will be removed from the queue.	717	true, it will be removed from the queue.
517		718
518	=cut	719	=cut
519		720
		721	our %RH;
		722
		723	sub register_read_type($$) {
		724	$RH{$_[0]} = $_[1];
		725	}
		726
520	sub push_read {	727	sub push_read {
521	my $self = shift;	728	my $self = shift;
522	my $cb = pop;	729	my $cb = pop;
523		730
524	if (@_) {	731	if (@_) {
…		…
526		733
527	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	734	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
528	->($self, $cb, @_);	735	->($self, $cb, @_);
529	}	736	}
530		737
531	push @{ $self->{queue} }, $cb;	738	push @{ $self->{_queue} }, $cb;
532	$self->_drain_rbuf;	739	$self->_drain_rbuf;
533	}	740	}
534		741
535	sub unshift_read {	742	sub unshift_read {
536	my $self = shift;	743	my $self = shift;
…		…
542	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")	749	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")
543	->($self, $cb, @_);	750	->($self, $cb, @_);
544	}	751	}
545		752
546		753
547	unshift @{ $self->{queue} }, $cb;	754	unshift @{ $self->{_queue} }, $cb;
548	$self->_drain_rbuf;	755	$self->_drain_rbuf;
549	}	756	}
550		757
551	=item $handle->push_read (type => @args, $cb)	758	=item $handle->push_read (type => @args, $cb)
552		759
…		…
554		761
555	Instead of providing a callback that parses the data itself you can chose	762	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	763	between a number of predefined parsing formats, for chunks of data, lines
557	etc.	764	etc.
558		765
559	The types currently supported are:	766	Predefined types are (if you have ideas for additional types, feel free to
		767	drop by and tell us):
560		768
561	=over 4	769	=over 4
562		770
563	=item chunk => $octets, $cb->($self, $data)	771	=item chunk => $octets, $cb->($handle, $data)
564		772
565	Invoke the callback only once C<$octets> bytes have been read. Pass the	773	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	774	data read to the callback. The callback will never be called with less
567	data.	775	data.
568		776
…		…
591		799
592	sub unshift_read_chunk {	800	sub unshift_read_chunk {
593	$_[0]->unshift_read (chunk => $_[1], $_[2]);	801	$_[0]->unshift_read (chunk => $_[1], $_[2]);
594	}	802	}
595		803
596	=item line => [$eol, ]$cb->($self, $line, $eol)	804	=item line => [$eol, ]$cb->($handle, $line, $eol)
597		805
598	The callback will be called only once a full line (including the end of	806	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	807	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	808	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>).	809	the end of line marker as the third argument (C<$eol>).
…		…
638	sub unshift_read_line {	846	sub unshift_read_line {
639	my $self = shift;	847	my $self = shift;
640	$self->unshift_read (line => @_);	848	$self->unshift_read (line => @_);
641	}	849	}
642		850
		851	=item netstring => $cb->($handle, $string)
		852
		853	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
		854
		855	Throws an error with C<$!> set to EBADMSG on format violations.
		856
		857	=cut
		858
		859	register_read_type netstring => sub {
		860	my ($self, $cb) = @_;
		861
		862	sub {
		863	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
		864	if ($_[0]{rbuf} =~ /[^0-9]/) {
		865	$self->_error (&Errno::EBADMSG);
		866	}
		867	return;
		868	}
		869
		870	my $len = $1;
		871
		872	$self->unshift_read (chunk => $len, sub {
		873	my $string = $_[1];
		874	$_[0]->unshift_read (chunk => 1, sub {
		875	if ($_[1] eq ",") {
		876	$cb->($_[0], $string);
		877	} else {
		878	$self->_error (&Errno::EBADMSG);
		879	}
		880	});
		881	});
		882
		883	1
		884	}
		885	};
		886
		887	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
		888
		889	Makes a regex match against the regex object C<$accept> and returns
		890	everything up to and including the match.
		891
		892	Example: read a single line terminated by '\n'.
		893
		894	$handle->push_read (regex => qr<\n>, sub { ... });
		895
		896	If C<$reject> is given and not undef, then it determines when the data is
		897	to be rejected: it is matched against the data when the C<$accept> regex
		898	does not match and generates an C<EBADMSG> error when it matches. This is
		899	useful to quickly reject wrong data (to avoid waiting for a timeout or a
		900	receive buffer overflow).
		901
		902	Example: expect a single decimal number followed by whitespace, reject
		903	anything else (not the use of an anchor).
		904
		905	$handle->push_read (regex => qr<^[0-9]+\s>, qr<[^0-9]>, sub { ... });
		906
		907	If C<$skip> is given and not C<undef>, then it will be matched against
		908	the receive buffer when neither C<$accept> nor C<$reject> match,
		909	and everything preceding and including the match will be accepted
		910	unconditionally. This is useful to skip large amounts of data that you
		911	know cannot be matched, so that the C<$accept> or C<$reject> regex do not
		912	have to start matching from the beginning. This is purely an optimisation
		913	and is usually worth only when you expect more than a few kilobytes.
		914
		915	Example: expect a http header, which ends at C<\015\012\015\012>. Since we
		916	expect the header to be very large (it isn't in practise, but...), we use
		917	a skip regex to skip initial portions. The skip regex is tricky in that
		918	it only accepts something not ending in either \015 or \012, as these are
		919	required for the accept regex.
		920
		921	$handle->push_read (regex =>
		922	qr<\015\012\015\012>,
		923	undef, # no reject
		924	qr<^.*[^\015\012]>,
		925	sub { ... });
		926
		927	=cut
		928
		929	register_read_type regex => sub {
		930	my ($self, $cb, $accept, $reject, $skip) = @_;
		931
		932	my $data;
		933	my $rbuf = \$self->{rbuf};
		934
		935	sub {
		936	# accept
		937	if ($$rbuf =~ $accept) {
		938	$data .= substr $$rbuf, 0, $+[0], "";
		939	$cb->($self, $data);
		940	return 1;
		941	}
		942
		943	# reject
		944	if ($reject && $$rbuf =~ $reject) {
		945	$self->_error (&Errno::EBADMSG);
		946	}
		947
		948	# skip
		949	if ($skip && $$rbuf =~ $skip) {
		950	$data .= substr $$rbuf, 0, $+[0], "";
		951	}
		952
		953	()
		954	}
		955	};
		956
		957	=item json => $cb->($handle, $hash_or_arrayref)
		958
		959	Reads a JSON object or array, decodes it and passes it to the callback.
		960
		961	If a C<json> object was passed to the constructor, then that will be used
		962	for the final decode, otherwise it will create a JSON coder expecting UTF-8.
		963
		964	This read type uses the incremental parser available with JSON version
		965	2.09 (and JSON::XS version 2.2) and above. You have to provide a
		966	dependency on your own: this module will load the JSON module, but
		967	AnyEvent does not depend on it itself.
		968
		969	Since JSON texts are fully self-delimiting, the C<json> read and write
		970	types are an ideal simple RPC protocol: just exchange JSON datagrams. See
		971	the C<json> write type description, above, for an actual example.
		972
		973	=cut
		974
		975	register_read_type json => sub {
		976	my ($self, $cb, $accept, $reject, $skip) = @_;
		977
		978	require JSON;
		979
		980	my $data;
		981	my $rbuf = \$self->{rbuf};
		982
		983	my $json = $self->{json} \|\|= JSON->new->utf8;
		984
		985	sub {
		986	my $ref = $json->incr_parse ($self->{rbuf});
		987
		988	if ($ref) {
		989	$self->{rbuf} = $json->incr_text;
		990	$json->incr_text = "";
		991	$cb->($self, $ref);
		992
		993	1
		994	} else {
		995	$self->{rbuf} = "";
		996	()
		997	}
		998	}
		999	};
		1000
643	=back	1001	=back
		1002
		1003	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)
		1004
		1005	This function (not method) lets you add your own types to C<push_read>.
		1006
		1007	Whenever the given C<type> is used, C<push_read> will invoke the code
		1008	reference with the handle object, the callback and the remaining
		1009	arguments.
		1010
		1011	The code reference is supposed to return a callback (usually a closure)
		1012	that works as a plain read callback (see C<< ->push_read ($cb) >>).
		1013
		1014	It should invoke the passed callback when it is done reading (remember to
		1015	pass C<$handle> as first argument as all other callbacks do that).
		1016
		1017	Note that this is a function, and all types registered this way will be
		1018	global, so try to use unique names.
		1019
		1020	For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>,
		1021	search for C<register_read_type>)).
644		1022
645	=item $handle->stop_read	1023	=item $handle->stop_read
646		1024
647	=item $handle->start_read	1025	=item $handle->start_read
648		1026
…		…
654	=cut	1032	=cut
655		1033
656	sub stop_read {	1034	sub stop_read {
657	my ($self) = @_;	1035	my ($self) = @_;
658		1036
659	delete $self->{rw};	1037	delete $self->{_rw};
660	}	1038	}
661		1039
662	sub start_read {	1040	sub start_read {
663	my ($self) = @_;	1041	my ($self) = @_;
664		1042
665	unless ($self->{rw} \|\| $self->{eof}) {	1043	unless ($self->{_rw} \|\| $self->{_eof}) {
666	Scalar::Util::weaken $self;	1044	Scalar::Util::weaken $self;
667		1045
668	$self->{rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1046	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
669	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1047	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};
670	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;	1048	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;
671		1049
672	if ($len > 0) {	1050	if ($len > 0) {
		1051	$self->{_activity} = AnyEvent->now;
		1052
673	$self->{filter_r}	1053	$self->{filter_r}
674	? $self->{filter_r}->($self, $rbuf)	1054	? $self->{filter_r}($self, $rbuf)
675	: $self->_drain_rbuf;	1055	: $self->_drain_rbuf;
676		1056
677	} elsif (defined $len) {	1057	} elsif (defined $len) {
678	delete $self->{rw};	1058	delete $self->{_rw};
679	$self->{eof} = 1;	1059	$self->{_eof} = 1;
680	$self->_drain_rbuf;	1060	$self->_drain_rbuf;
681		1061
682	} elsif ($! != EAGAIN && $! != EINTR) {	1062	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
683	return $self->error;	1063	return $self->_error ($!, 1);
684	}	1064	}
685	});	1065	});
686	}	1066	}
687	}	1067	}
688		1068
689	sub _dotls {	1069	sub _dotls {
690	my ($self) = @_;	1070	my ($self) = @_;
691		1071
692	if (length $self->{tls_wbuf}) {	1072	if (length $self->{_tls_wbuf}) {
693	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{tls_wbuf})) > 0) {	1073	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
694	substr $self->{tls_wbuf}, 0, $len, "";	1074	substr $self->{_tls_wbuf}, 0, $len, "";
695	}	1075	}
696	}	1076	}
697		1077
698	if (defined (my $buf = Net::SSLeay::BIO_read ($self->{tls_wbio}))) {	1078	if (defined (my $buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {
699	$self->{wbuf} .= $buf;	1079	$self->{wbuf} .= $buf;
700	$self->_drain_wbuf;	1080	$self->_drain_wbuf;
701	}	1081	}
702		1082
703	while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) {	1083	while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) {
…		…
707		1087
708	my $err = Net::SSLeay::get_error ($self->{tls}, -1);	1088	my $err = Net::SSLeay::get_error ($self->{tls}, -1);
709		1089
710	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {	1090	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
711	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {	1091	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {
712	$self->error;	1092	return $self->_error ($!, 1);
713	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {	1093	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {
714	$! = &Errno::EIO;	1094	return $self->_error (&Errno::EIO, 1);
715	$self->error;
716	}	1095	}
717		1096
718	# all others are fine for our purposes	1097	# all others are fine for our purposes
719	}	1098	}
720	}	1099	}
…		…
729	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1108	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
730		1109
731	The second argument is the optional C<Net::SSLeay::CTX> object that is	1110	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.	1111	used when AnyEvent::Handle has to create its own TLS connection object.
733		1112
734	=cut	1113	The TLS connection object will end up in C<< $handle->{tls} >> after this
		1114	call and can be used or changed to your liking. Note that the handshake
		1115	might have already started when this function returns.
735		1116
736	# TODO: maybe document...	1117	=cut
		1118
737	sub starttls {	1119	sub starttls {
738	my ($self, $ssl, $ctx) = @_;	1120	my ($self, $ssl, $ctx) = @_;
739		1121
740	$self->stoptls;	1122	$self->stoptls;
741		1123
…		…
753	# but the openssl maintainers basically said: "trust us, it just works".	1135	# but the openssl maintainers basically said: "trust us, it just works".
754	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1136	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
755	# and mismaintained ssleay-module doesn't even offer them).	1137	# and mismaintained ssleay-module doesn't even offer them).
756	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html	1138	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
757	Net::SSLeay::CTX_set_mode ($self->{tls},	1139	Net::SSLeay::CTX_set_mode ($self->{tls},
758	(eval { Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1140	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
759	\| (eval { Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));	1141	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
760		1142
761	$self->{tls_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1143	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
762	$self->{tls_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1144	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
763		1145
764	Net::SSLeay::set_bio ($ssl, $self->{tls_rbio}, $self->{tls_wbio});	1146	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
765		1147
766	$self->{filter_w} = sub {	1148	$self->{filter_w} = sub {
767	$_[0]{tls_wbuf} .= ${$_[1]};	1149	$_[0]{_tls_wbuf} .= ${$_[1]};
768	&_dotls;	1150	&_dotls;
769	};	1151	};
770	$self->{filter_r} = sub {	1152	$self->{filter_r} = sub {
771	Net::SSLeay::BIO_write ($_[0]{tls_rbio}, ${$_[1]});	1153	Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});
772	&_dotls;	1154	&_dotls;
773	};	1155	};
774	}	1156	}
775		1157
776	=item $handle->stoptls	1158	=item $handle->stoptls
…		…
782		1164
783	sub stoptls {	1165	sub stoptls {
784	my ($self) = @_;	1166	my ($self) = @_;
785		1167
786	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};	1168	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};
		1169
787	delete $self->{tls_rbio};	1170	delete $self->{_rbio};
788	delete $self->{tls_wbio};	1171	delete $self->{_wbio};
789	delete $self->{tls_wbuf};	1172	delete $self->{_tls_wbuf};
790	delete $self->{filter_r};	1173	delete $self->{filter_r};
791	delete $self->{filter_w};	1174	delete $self->{filter_w};
792	}	1175	}
793		1176
794	sub DESTROY {	1177	sub DESTROY {
…		…
832	}	1215	}
833	}	1216	}
834		1217
835	=back	1218	=back
836		1219
		1220	=head1 SUBCLASSING AnyEvent::Handle
		1221
		1222	In many cases, you might want to subclass AnyEvent::Handle.
		1223
		1224	To make this easier, a given version of AnyEvent::Handle uses these
		1225	conventions:
		1226
		1227	=over 4
		1228
		1229	=item * all constructor arguments become object members.
		1230
		1231	At least initially, when you pass a C<tls>-argument to the constructor it
		1232	will end up in C<< $handle->{tls} >>. Those members might be changes or
		1233	mutated later on (for example C<tls> will hold the TLS connection object).
		1234
		1235	=item * other object member names are prefixed with an C<_>.
		1236
		1237	All object members not explicitly documented (internal use) are prefixed
		1238	with an underscore character, so the remaining non-C<_>-namespace is free
		1239	for use for subclasses.
		1240
		1241	=item * all members not documented here and not prefixed with an underscore
		1242	are free to use in subclasses.
		1243
		1244	Of course, new versions of AnyEvent::Handle may introduce more "public"
		1245	member variables, but thats just life, at least it is documented.
		1246
		1247	=back
		1248
837	=head1 AUTHOR	1249	=head1 AUTHOR
838		1250
839	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.	1251	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.
840		1252
841	=cut	1253	=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.54 by root, Tue Jun 3 09:02: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.54 by root, Tue Jun 3 09:02:46 2008 UTC