ViewVC Help

View File | Revision Log | Show Annotations | Download File

/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.78 by root, Sun Jul 27 07:34:07 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		16
17	This module is experimental.
18
19	=cut	17	=cut
20		18
21	our $VERSION = '0.04';	19	our $VERSION = 4.22;
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 detected,
		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 (unlike read queue callbacks, this
		111	callback will only be called when at least one octet of data is in the
		112	read buffer).
105		113
106	To access (and remove data from) the read buffer, use the C<< ->rbuf >>	114	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
107	method or access the C<$self->{rbuf}> member directly.	115	method or access the C<$handle->{rbuf}> member directly.
108		116
109	When an EOF condition is detected then AnyEvent::Handle will first try to	117	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	118	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	119	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>).	120	error will be raised (with C<$!> set to C<EPIPE>).
113		121
114	=item on_drain => $cb->()	122	=item on_drain => $cb->($handle)
115		123
116	This sets the callback that is called when the write buffer becomes empty	124	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).	125	(or when the callback is set and the buffer is empty already).
118		126
119	To append to the write buffer, use the C<< ->push_write >> method.	127	To append to the write buffer, use the C<< ->push_write >> method.
		128
		129	This callback is useful when you don't want to put all of your write data
		130	into the queue at once, for example, when you want to write the contents
		131	of some file to the socket you might not want to read the whole file into
		132	memory and push it into the queue, but instead only read more data from
		133	the file when the write queue becomes empty.
		134
		135	=item timeout => $fractional_seconds
		136
		137	If non-zero, then this enables an "inactivity" timeout: whenever this many
		138	seconds pass without a successful read or write on the underlying file
		139	handle, the C<on_timeout> callback will be invoked (and if that one is
		140	missing, an C<ETIMEDOUT> error will be raised).
		141
		142	Note that timeout processing is also active when you currently do not have
		143	any outstanding read or write requests: If you plan to keep the connection
		144	idle then you should disable the timout temporarily or ignore the timeout
		145	in the C<on_timeout> callback.
		146
		147	Zero (the default) disables this timeout.
		148
		149	=item on_timeout => $cb->($handle)
		150
		151	Called whenever the inactivity timeout passes. If you return from this
		152	callback, then the timeout will be reset as if some activity had happened,
		153	so this condition is not fatal in any way.
120		154
121	=item rbuf_max => <bytes>	155	=item rbuf_max => <bytes>
122		156
123	If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)	157	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	158	when the read buffer ever (strictly) exceeds this size. This is useful to
…		…
128	be configured to accept only so-and-so much data that it cannot act on	162	be configured to accept only so-and-so much data that it cannot act on
129	(for example, when expecting a line, an attacker could send an unlimited	163	(for example, when expecting a line, an attacker could send an unlimited
130	amount of data without a callback ever being called as long as the line	164	amount of data without a callback ever being called as long as the line
131	isn't finished).	165	isn't finished).
132		166
		167	=item autocork => <boolean>
		168
		169	When disabled (the default), then C<push_write> will try to immediately
		170	write the data to the handle if possible. This avoids having to register
		171	a write watcher and wait for the next event loop iteration, but can be
		172	inefficient if you write multiple small chunks (this disadvantage is
		173	usually avoided by your kernel's nagle algorithm, see C<low_delay>).
		174
		175	When enabled, then writes will always be queued till the next event loop
		176	iteration. This is efficient when you do many small writes per iteration,
		177	but less efficient when you do a single write only.
		178
		179	=item no_delay => <boolean>
		180
		181	When doing small writes on sockets, your operating system kernel might
		182	wait a bit for more data before actually sending it out. This is called
		183	the Nagle algorithm, and usually it is beneficial.
		184
		185	In some situations you want as low a delay as possible, which cna be
		186	accomplishd by setting this option to true.
		187
		188	The default is your opertaing system's default behaviour, this option
		189	explicitly enables or disables it, if possible.
		190
133	=item read_size => <bytes>	191	=item read_size => <bytes>
134		192
135	The default read block size (the amount of bytes this module will try to read	193	The default read block size (the amount of bytes this module will try to read
136	on each [loop iteration). Default: C<4096>.	194	during each (loop iteration). Default: C<8192>.
137		195
138	=item low_water_mark => <bytes>	196	=item low_water_mark => <bytes>
139		197
140	Sets the amount of bytes (default: C<0>) that make up an "empty" write	198	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	199	buffer: If the write reaches this size or gets even samller it is
142	considered empty.	200	considered empty.
143		201
		202	=item linger => <seconds>
		203
		204	If non-zero (default: C<3600>), then the destructor of the
		205	AnyEvent::Handle object will check wether there is still outstanding write
		206	data and will install a watcher that will write out this data. No errors
		207	will be reported (this mostly matches how the operating system treats
		208	outstanding data at socket close time).
		209
		210	This will not work for partial TLS data that could not yet been
		211	encoded. This data will be lost.
		212
144	=item tls => "accept" | "connect" | Net::SSLeay::SSL object	213	=item tls => "accept" | "connect" | Net::SSLeay::SSL object
145		214
146	When this parameter is given, it enables TLS (SSL) mode, that means it	215	When this parameter is given, it enables TLS (SSL) mode, that means it
147	will start making tls handshake and will transparently encrypt/decrypt	216	will start making tls handshake and will transparently encrypt/decrypt
148	data.	217	data.
		218
		219	TLS mode requires Net::SSLeay to be installed (it will be loaded
		220	automatically when you try to create a TLS handle).
149		221
150	For the TLS server side, use C<accept>, and for the TLS client side of a	222	For the TLS server side, use C<accept>, and for the TLS client side of a
151	connection, use C<connect> mode.	223	connection, use C<connect> mode.
152		224
153	You can also provide your own TLS connection object, but you have	225	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>	226	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	227	or C<Net::SSLeay::set_accept_state> on it before you pass it to
156	AnyEvent::Handle.	228	AnyEvent::Handle.
157		229
		230	See the C<starttls> method if you need to start TLS negotiation later.
		231
158	=item tls_ctx => $ssl_ctx	232	=item tls_ctx => $ssl_ctx
159		233
160	Use the given Net::SSLeay::CTX object to create the new TLS connection	234	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	235	(unless a connection object was specified directly). If this parameter is
162	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	236	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
163		237
		238	=item json => JSON or JSON::XS object
		239
		240	This is the json coder object used by the C<json> read and write types.
		241
		242	If you don't supply it, then AnyEvent::Handle will create and use a
		243	suitable one, which will write and expect UTF-8 encoded JSON texts.
		244
		245	Note that you are responsible to depend on the JSON module if you want to
		246	use this functionality, as AnyEvent does not have a dependency itself.
		247
		248	=item filter_r => $cb
		249
		250	=item filter_w => $cb
		251
		252	These exist, but are undocumented at this time.
		253
164	=back	254	=back
165		255
166	=cut	256	=cut
167		257
168	sub new {	258	sub new {
…		…
177	if ($self->{tls}) {	267	if ($self->{tls}) {
178	require Net::SSLeay;	268	require Net::SSLeay;
179	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});	269	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});
180	}	270	}
181		271
182	$self->on_eof (delete $self->{on_eof} ) if $self->{on_eof};	272	$self->{_activity} = AnyEvent->now;
183	$self->on_error (delete $self->{on_error}) if $self->{on_error};	273	$self->_timeout;
		274
184	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	275	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};
185	$self->on_read (delete $self->{on_read} ) if $self->{on_read};	276	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
186		277
187	$self->start_read;	278	$self->start_read
		279	if $self->{on_read};
188		280
189	$self	281	$self
190	}	282	}
191		283
192	sub _shutdown {	284	sub _shutdown {
193	my ($self) = @_;	285	my ($self) = @_;
194		286
		287	delete $self->{_tw};
195	delete $self->{rw};	288	delete $self->{_rw};
196	delete $self->{ww};	289	delete $self->{_ww};
197	delete $self->{fh};	290	delete $self->{fh};
198	}
199		291
		292	$self->stoptls;
		293	}
		294
200	sub error {	295	sub _error {
201	my ($self) = @_;	296	my ($self, $errno, $fatal) = @_;
202		297
203	{
204	local $!;
205	$self->_shutdown;	298	$self->_shutdown
206	}	299	if $fatal;
		300
		301	$! = $errno;
207		302
208	if ($self->{on_error}) {	303	if ($self->{on_error}) {
209	$self->{on_error}($self);	304	$self->{on_error}($self, $fatal);
210	} else {	305	} else {
211	die "AnyEvent::Handle uncaught fatal error: $!";	306	Carp::croak "AnyEvent::Handle uncaught error: $!";
212	}	307	}
213	}	308	}
214		309
215	=item $fh = $handle->fh	310	=item $fh = $handle->fh
216		311
217	This method returns the filehandle of the L<AnyEvent::Handle> object.	312	This method returns the file handle of the L<AnyEvent::Handle> object.
218		313
219	=cut	314	=cut
220		315
221	sub fh { $_[0]->{fh} }	316	sub fh { $_[0]{fh} }
222		317
223	=item $handle->on_error ($cb)	318	=item $handle->on_error ($cb)
224		319
225	Replace the current C<on_error> callback (see the C<on_error> constructor argument).	320	Replace the current C<on_error> callback (see the C<on_error> constructor argument).
226		321
…		…
236		331
237	=cut	332	=cut
238		333
239	sub on_eof {	334	sub on_eof {
240	$_[0]{on_eof} = $_[1];	335	$_[0]{on_eof} = $_[1];
		336	}
		337
		338	=item $handle->on_timeout ($cb)
		339
		340	Replace the current C<on_timeout> callback, or disables the callback
		341	(but not the timeout) if C<$cb> = C<undef>. See C<timeout> constructor
		342	argument.
		343
		344	=cut
		345
		346	sub on_timeout {
		347	$_[0]{on_timeout} = $_[1];
		348	}
		349
		350	=item $handle->autocork ($boolean)
		351
		352	Enables or disables the current autocork behaviour (see C<autocork>
		353	constructor argument).
		354
		355	=cut
		356
		357	=item $handle->no_delay ($boolean)
		358
		359	Enables or disables the C<no_delay> setting (see constructor argument of
		360	the same name for details).
		361
		362	=cut
		363
		364	sub no_delay {
		365	$_[0]{no_delay} = $_[1];
		366
		367	eval {
		368	local $SIG{__DIE__};
		369	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];
		370	};
		371	}
		372
		373	#############################################################################
		374
		375	=item $handle->timeout ($seconds)
		376
		377	Configures (or disables) the inactivity timeout.
		378
		379	=cut
		380
		381	sub timeout {
		382	my ($self, $timeout) = @_;
		383
		384	$self->{timeout} = $timeout;
		385	$self->_timeout;
		386	}
		387
		388	# reset the timeout watcher, as neccessary
		389	# also check for time-outs
		390	sub _timeout {
		391	my ($self) = @_;
		392
		393	if ($self->{timeout}) {
		394	my $NOW = AnyEvent->now;
		395
		396	# when would the timeout trigger?
		397	my $after = $self->{_activity} + $self->{timeout} - $NOW;
		398
		399	# now or in the past already?
		400	if ($after <= 0) {
		401	$self->{_activity} = $NOW;
		402
		403	if ($self->{on_timeout}) {
		404	$self->{on_timeout}($self);
		405	} else {
		406	$self->_error (&Errno::ETIMEDOUT);
		407	}
		408
		409	# callback could have changed timeout value, optimise
		410	return unless $self->{timeout};
		411
		412	# calculate new after
		413	$after = $self->{timeout};
		414	}
		415
		416	Scalar::Util::weaken $self;
		417	return unless $self; # ->error could have destroyed $self
		418
		419	$self->{_tw} ||= AnyEvent->timer (after => $after, cb => sub {
		420	delete $self->{_tw};
		421	$self->_timeout;
		422	});
		423	} else {
		424	delete $self->{_tw};
		425	}
241	}	426	}
242		427
243	#############################################################################	428	#############################################################################
244		429
245	=back	430	=back
…		…
282	=cut	467	=cut
283		468
284	sub _drain_wbuf {	469	sub _drain_wbuf {
285	my ($self) = @_;	470	my ($self) = @_;
286		471
287	unless ($self->{ww}) {	472	if (!$self->{_ww} && length $self->{wbuf}) {
		473
288	Scalar::Util::weaken $self;	474	Scalar::Util::weaken $self;
		475
289	my $cb = sub {	476	my $cb = sub {
290	my $len = syswrite $self->{fh}, $self->{wbuf};	477	my $len = syswrite $self->{fh}, $self->{wbuf};
291		478
292	if ($len > 0) {	479	if ($len >= 0) {
293	substr $self->{wbuf}, 0, $len, "";	480	substr $self->{wbuf}, 0, $len, "";
		481
		482	$self->{_activity} = AnyEvent->now;
294		483
295	$self->{on_drain}($self)	484	$self->{on_drain}($self)
296	if $self->{low_water_mark} >= length $self->{wbuf}	485	if $self->{low_water_mark} >= length $self->{wbuf}
297	&& $self->{on_drain};	486	&& $self->{on_drain};
298		487
299	delete $self->{ww} unless length $self->{wbuf};	488	delete $self->{_ww} unless length $self->{wbuf};
300	} elsif ($! != EAGAIN && $! != EINTR) {	489	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
301	$self->error;	490	$self->_error ($!, 1);
302	}	491	}
303	};	492	};
304		493
		494	# try to write data immediately
		495	$cb->() unless $self->{autocork};
		496
		497	# if still data left in wbuf, we need to poll
305	$self->{ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb);	498	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)
306		499	if length $self->{wbuf};
307	$cb->($self);
308	};	500	};
		501	}
		502
		503	our %WH;
		504
		505	sub register_write_type($$) {
		506	$WH{$_[0]} = $_[1];
309	}	507	}
310		508
311	sub push_write {	509	sub push_write {
312	my $self = shift;	510	my $self = shift;
313		511
		512	if (@_ > 1) {
		513	my $type = shift;
		514
		515	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")
		516	->($self, @_);
		517	}
		518
314	if ($self->{filter_w}) {	519	if ($self->{filter_w}) {
315	$self->{filter_w}->($self, \$_[0]);	520	$self->{filter_w}($self, \$_[0]);
316	} else {	521	} else {
317	$self->{wbuf} .= $_[0];	522	$self->{wbuf} .= $_[0];
318	$self->_drain_wbuf;	523	$self->_drain_wbuf;
319	}	524	}
320	}	525	}
321		526
		527	=item $handle->push_write (type => @args)
		528
		529	Instead of formatting your data yourself, you can also let this module do
		530	the job by specifying a type and type-specific arguments.
		531
		532	Predefined types are (if you have ideas for additional types, feel free to
		533	drop by and tell us):
		534
		535	=over 4
		536
		537	=item netstring => $string
		538
		539	Formats the given value as netstring
		540	(http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them).
		541
		542	=cut
		543
		544	register_write_type netstring => sub {
		545	my ($self, $string) = @_;
		546
		547	sprintf "%d:%s,", (length $string), $string
		548	};
		549
		550	=item packstring => $format, $data
		551
		552	An octet string prefixed with an encoded length. The encoding C<$format>
		553	uses the same format as a Perl C<pack> format, but must specify a single
		554	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
		555	optional C<!>, C<< < >> or C<< > >> modifier).
		556
		557	=cut
		558
		559	register_write_type packstring => sub {
		560	my ($self, $format, $string) = @_;
		561
		562	pack "$format/a*", $string
		563	};
		564
		565	=item json => $array_or_hashref
		566
		567	Encodes the given hash or array reference into a JSON object. Unless you
		568	provide your own JSON object, this means it will be encoded to JSON text
		569	in UTF-8.
		570
		571	JSON objects (and arrays) are self-delimiting, so you can write JSON at
		572	one end of a handle and read them at the other end without using any
		573	additional framing.
		574
		575	The generated JSON text is guaranteed not to contain any newlines: While
		576	this module doesn't need delimiters after or between JSON texts to be
		577	able to read them, many other languages depend on that.
		578
		579	A simple RPC protocol that interoperates easily with others is to send
		580	JSON arrays (or objects, although arrays are usually the better choice as
		581	they mimic how function argument passing works) and a newline after each
		582	JSON text:
		583
		584	$handle->push_write (json => ["method", "arg1", "arg2"]); # whatever
		585	$handle->push_write ("\012");
		586
		587	An AnyEvent::Handle receiver would simply use the C<json> read type and
		588	rely on the fact that the newline will be skipped as leading whitespace:
		589
		590	$handle->push_read (json => sub { my $array = $_[1]; ... });
		591
		592	Other languages could read single lines terminated by a newline and pass
		593	this line into their JSON decoder of choice.
		594
		595	=cut
		596
		597	register_write_type json => sub {
		598	my ($self, $ref) = @_;
		599
		600	require JSON;
		601
		602	$self->{json} ? $self->{json}->encode ($ref)
		603	: JSON::encode_json ($ref)
		604	};
		605
		606	=item storable => $reference
		607
		608	Freezes the given reference using L<Storable> and writes it to the
		609	handle. Uses the C<nfreeze> format.
		610
		611	=cut
		612
		613	register_write_type storable => sub {
		614	my ($self, $ref) = @_;
		615
		616	require Storable;
		617
		618	pack "w/a*", Storable::nfreeze ($ref)
		619	};
		620
		621	=back
		622
		623	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
		624
		625	This function (not method) lets you add your own types to C<push_write>.
		626	Whenever the given C<type> is used, C<push_write> will invoke the code
		627	reference with the handle object and the remaining arguments.
		628
		629	The code reference is supposed to return a single octet string that will
		630	be appended to the write buffer.
		631
		632	Note that this is a function, and all types registered this way will be
		633	global, so try to use unique names.
		634
		635	=cut
		636
322	#############################################################################	637	#############################################################################
323		638
324	=back	639	=back
325		640
326	=head2 READ QUEUE	641	=head2 READ QUEUE
…		…
332	ways, the "simple" way, using only C<on_read> and the "complex" way, using	647	ways, the "simple" way, using only C<on_read> and the "complex" way, using
333	a queue.	648	a queue.
334		649
335	In the simple case, you just install an C<on_read> callback and whenever	650	In the simple case, you just install an C<on_read> callback and whenever
336	new data arrives, it will be called. You can then remove some data (if	651	new data arrives, it will be called. You can then remove some data (if
337	enough is there) from the read buffer (C<< $handle->rbuf >>) if you want	652	enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna
338	or not.	653	leave the data there if you want to accumulate more (e.g. when only a
		654	partial message has been received so far).
339		655
340	In the more complex case, you want to queue multiple callbacks. In this	656	In the more complex case, you want to queue multiple callbacks. In this
341	case, AnyEvent::Handle will call the first queued callback each time new	657	case, AnyEvent::Handle will call the first queued callback each time new
342	data arrives and removes it when it has done its job (see C<push_read>,	658	data arrives (also the first time it is queued) and removes it when it has
343	below).	659	done its job (see C<push_read>, below).
344		660
345	This way you can, for example, push three line-reads, followed by reading	661	This way you can, for example, push three line-reads, followed by reading
346	a chunk of data, and AnyEvent::Handle will execute them in order.	662	a chunk of data, and AnyEvent::Handle will execute them in order.
347		663
348	Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by	664	Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by
349	the specified number of bytes which give an XML datagram.	665	the specified number of bytes which give an XML datagram.
350		666
351	# in the default state, expect some header bytes	667	# in the default state, expect some header bytes
352	$handle->on_read (sub {	668	$handle->on_read (sub {
353	# some data is here, now queue the length-header-read (4 octets)	669	# some data is here, now queue the length-header-read (4 octets)
354	shift->unshift_read_chunk (4, sub {	670	shift->unshift_read (chunk => 4, sub {
355	# header arrived, decode	671	# header arrived, decode
356	my $len = unpack "N", $_[1];	672	my $len = unpack "N", $_[1];
357		673
358	# now read the payload	674	# now read the payload
359	shift->unshift_read_chunk ($len, sub {	675	shift->unshift_read (chunk => $len, sub {
360	my $xml = $_[1];	676	my $xml = $_[1];
361	# handle xml	677	# handle xml
362	});	678	});
363	});	679	});
364	});	680	});
365		681
366	Example 2: Implement a client for a protocol that replies either with	682	Example 2: Implement a client for a protocol that replies either with "OK"
367	"OK" and another line or "ERROR" for one request, and 64 bytes for the	683	and another line or "ERROR" for the first request that is sent, and 64
368	second request. Due tot he availability of a full queue, we can just	684	bytes for the second request. Due to the availability of a queue, we can
369	pipeline sending both requests and manipulate the queue as necessary in	685	just pipeline sending both requests and manipulate the queue as necessary
370	the callbacks:	686	in the callbacks.
371		687
372	# request one	688	When the first callback is called and sees an "OK" response, it will
		689	C<unshift> another line-read. This line-read will be queued I<before> the
		690	64-byte chunk callback.
		691
		692	# request one, returns either "OK + extra line" or "ERROR"
373	$handle->push_write ("request 1\015\012");	693	$handle->push_write ("request 1\015\012");
374		694
375	# we expect "ERROR" or "OK" as response, so push a line read	695	# we expect "ERROR" or "OK" as response, so push a line read
376	$handle->push_read_line (sub {	696	$handle->push_read (line => sub {
377	# if we got an "OK", we have to _prepend_ another line,	697	# if we got an "OK", we have to _prepend_ another line,
378	# so it will be read before the second request reads its 64 bytes	698	# so it will be read before the second request reads its 64 bytes
379	# which are already in the queue when this callback is called	699	# which are already in the queue when this callback is called
380	# we don't do this in case we got an error	700	# we don't do this in case we got an error
381	if ($_[1] eq "OK") {	701	if ($_[1] eq "OK") {
382	$_[0]->unshift_read_line (sub {	702	$_[0]->unshift_read (line => sub {
383	my $response = $_[1];	703	my $response = $_[1];
384	...	704	...
385	});	705	});
386	}	706	}
387	});	707	});
388		708
389	# request two	709	# request two, simply returns 64 octets
390	$handle->push_write ("request 2\015\012");	710	$handle->push_write ("request 2\015\012");
391		711
392	# simply read 64 bytes, always	712	# simply read 64 bytes, always
393	$handle->push_read_chunk (64, sub {	713	$handle->push_read (chunk => 64, sub {
394	my $response = $_[1];	714	my $response = $_[1];
395	...	715	...
396	});	716	});
397		717
398	=over 4	718	=over 4
399		719
400	=cut	720	=cut
401		721
402	sub _drain_rbuf {	722	sub _drain_rbuf {
403	my ($self) = @_;	723	my ($self) = @_;
		724
		725	local $self->{_in_drain} = 1;
404		726
405	if (	727	if (
406	defined $self->{rbuf_max}	728	defined $self->{rbuf_max}
407	&& $self->{rbuf_max} < length $self->{rbuf}	729	&& $self->{rbuf_max} < length $self->{rbuf}
408	) {	730	) {
409	$! = &Errno::ENOSPC; return $self->error;	731	return $self->_error (&Errno::ENOSPC, 1);
410	}	732	}
411		733
412	return if $self->{in_drain};	734	while () {
413	local $self->{in_drain} = 1;
414
415	while (my $len = length $self->{rbuf}) {
416	no strict 'refs';	735	no strict 'refs';
		736
		737	my $len = length $self->{rbuf};
		738
417	if (my $cb = shift @{ $self->{queue} }) {	739	if (my $cb = shift @{ $self->{_queue} }) {
418	if (!$cb->($self)) {	740	unless ($cb->($self)) {
419	if ($self->{eof}) {	741	if ($self->{_eof}) {
420	# no progress can be made (not enough data and no data forthcoming)	742	# no progress can be made (not enough data and no data forthcoming)
421	$! = &Errno::EPIPE; return $self->error;	743	$self->_error (&Errno::EPIPE, 1), last;
422	}	744	}
423		745
424	unshift @{ $self->{queue} }, $cb;	746	unshift @{ $self->{_queue} }, $cb;
425	return;	747	last;
426	}	748	}
427	} elsif ($self->{on_read}) {	749	} elsif ($self->{on_read}) {
		750	last unless $len;
		751
428	$self->{on_read}($self);	752	$self->{on_read}($self);
429		753
430	if (	754	if (
431	$self->{eof} # if no further data will arrive
432	&& $len == length $self->{rbuf} # and no data has been consumed	755	$len == length $self->{rbuf} # if no data has been consumed
433	&& !@{ $self->{queue} } # and the queue is still empty	756	&& !@{ $self->{_queue} } # and the queue is still empty
434	&& $self->{on_read} # and we still want to read data	757	&& $self->{on_read} # but we still have on_read
435	) {	758	) {
		759	# no further data will arrive
436	# then no progress can be made	760	# so no progress can be made
437	$! = &Errno::EPIPE; return $self->error;	761	$self->_error (&Errno::EPIPE, 1), last
		762	if $self->{_eof};
		763
		764	last; # more data might arrive
438	}	765	}
439	} else {	766	} else {
440	# read side becomes idle	767	# read side becomes idle
441	delete $self->{rw};	768	delete $self->{_rw};
442	return;	769	last;
443	}	770	}
444	}	771	}
445		772
446	if ($self->{eof}) {
447	$self->_shutdown;
448	$self->{on_eof}($self)	773	$self->{on_eof}($self)
449	if $self->{on_eof};	774	if $self->{_eof} && $self->{on_eof};
		775
		776	# may need to restart read watcher
		777	unless ($self->{_rw}) {
		778	$self->start_read
		779	if $self->{on_read} || @{ $self->{_queue} };
450	}	780	}
451	}	781	}
452		782
453	=item $handle->on_read ($cb)	783	=item $handle->on_read ($cb)
454		784
…		…
460		790
461	sub on_read {	791	sub on_read {
462	my ($self, $cb) = @_;	792	my ($self, $cb) = @_;
463		793
464	$self->{on_read} = $cb;	794	$self->{on_read} = $cb;
		795	$self->_drain_rbuf if $cb && !$self->{_in_drain};
465	}	796	}
466		797
467	=item $handle->rbuf	798	=item $handle->rbuf
468		799
469	Returns the read buffer (as a modifiable lvalue).	800	Returns the read buffer (as a modifiable lvalue).
…		…
500	interested in (which can be none at all) and return a true value. After returning	831	interested in (which can be none at all) and return a true value. After returning
501	true, it will be removed from the queue.	832	true, it will be removed from the queue.
502		833
503	=cut	834	=cut
504		835
		836	our %RH;
		837
		838	sub register_read_type($$) {
		839	$RH{$_[0]} = $_[1];
		840	}
		841
505	sub push_read {	842	sub push_read {
506	my ($self, $cb) = @_;	843	my $self = shift;
		844	my $cb = pop;
507		845
		846	if (@_) {
		847	my $type = shift;
		848
		849	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
		850	->($self, $cb, @_);
		851	}
		852
508	push @{ $self->{queue} }, $cb;	853	push @{ $self->{_queue} }, $cb;
509	$self->_drain_rbuf;	854	$self->_drain_rbuf unless $self->{_in_drain};
510	}	855	}
511		856
512	sub unshift_read {	857	sub unshift_read {
513	my ($self, $cb) = @_;	858	my $self = shift;
		859	my $cb = pop;
514		860
		861	if (@_) {
		862	my $type = shift;
		863
		864	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")
		865	->($self, $cb, @_);
		866	}
		867
		868
515	push @{ $self->{queue} }, $cb;	869	unshift @{ $self->{_queue} }, $cb;
516	$self->_drain_rbuf;	870	$self->_drain_rbuf unless $self->{_in_drain};
517	}	871	}
518		872
519	=item $handle->push_read_chunk ($len, $cb->($self, $data))	873	=item $handle->push_read (type => @args, $cb)
520		874
521	=item $handle->unshift_read_chunk ($len, $cb->($self, $data))	875	=item $handle->unshift_read (type => @args, $cb)
522		876
523	Append the given callback to the end of the queue (C<push_read_chunk>) or	877	Instead of providing a callback that parses the data itself you can chose
524	prepend it (C<unshift_read_chunk>).	878	between a number of predefined parsing formats, for chunks of data, lines
		879	etc.
525		880
526	The callback will be called only once C<$len> bytes have been read, and	881	Predefined types are (if you have ideas for additional types, feel free to
527	these C<$len> bytes will be passed to the callback.	882	drop by and tell us):
528		883
529	=cut	884	=over 4
530		885
531	sub _read_chunk($$) {	886	=item chunk => $octets, $cb->($handle, $data)
		887
		888	Invoke the callback only once C<$octets> bytes have been read. Pass the
		889	data read to the callback. The callback will never be called with less
		890	data.
		891
		892	Example: read 2 bytes.
		893
		894	$handle->push_read (chunk => 2, sub {
		895	warn "yay ", unpack "H*", $_[1];
		896	});
		897
		898	=cut
		899
		900	register_read_type chunk => sub {
532	my ($self, $len, $cb) = @_;	901	my ($self, $cb, $len) = @_;
533		902
534	sub {	903	sub {
535	$len <= length $_[0]{rbuf} or return;	904	$len <= length $_[0]{rbuf} or return;
536	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");	905	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");
537	1	906	1
538	}	907	}
539	}	908	};
540		909
541	sub push_read_chunk {	910	=item line => [$eol, ]$cb->($handle, $line, $eol)
542	$_[0]->push_read (&_read_chunk);
543	}
544
545
546	sub unshift_read_chunk {
547	$_[0]->unshift_read (&_read_chunk);
548	}
549
550	=item $handle->push_read_line ([$eol, ]$cb->($self, $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		911
557	The callback will be called only once a full line (including the end of	912	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	913	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	914	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>).	915	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	926	Partial lines at the end of the stream will never be returned, as they are
572	not marked by the end of line marker.	927	not marked by the end of line marker.
573		928
574	=cut	929	=cut
575		930
576	sub _read_line($$) {	931	register_read_type line => sub {
577	my $self = shift;	932	my ($self, $cb, $eol) = @_;
578	my $cb = pop;
579	my $eol = @_ ? shift : qr|(\015?\012)|;
580	my $pos;
581		933
		934	if (@_ < 3) {
		935	# this is more than twice as fast as the generic code below
		936	sub {
		937	$_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return;
		938
		939	$cb->($_[0], $1, $2);
		940	1
		941	}
		942	} else {
582	$eol = quotemeta $eol unless ref $eol;	943	$eol = quotemeta $eol unless ref $eol;
583	$eol = qr|^(.*?)($eol)|s;	944	$eol = qr|^(.*?)($eol)|s;
		945
		946	sub {
		947	$_[0]{rbuf} =~ s/$eol// or return;
		948
		949	$cb->($_[0], $1, $2);
		950	1
		951	}
		952	}
		953	};
		954
		955	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
		956
		957	Makes a regex match against the regex object C<$accept> and returns
		958	everything up to and including the match.
		959
		960	Example: read a single line terminated by '\n'.
		961
		962	$handle->push_read (regex => qr<\n>, sub { ... });
		963
		964	If C<$reject> is given and not undef, then it determines when the data is
		965	to be rejected: it is matched against the data when the C<$accept> regex
		966	does not match and generates an C<EBADMSG> error when it matches. This is
		967	useful to quickly reject wrong data (to avoid waiting for a timeout or a
		968	receive buffer overflow).
		969
		970	Example: expect a single decimal number followed by whitespace, reject
		971	anything else (not the use of an anchor).
		972
		973	$handle->push_read (regex => qr<^[0-9]+\s>, qr<[^0-9]>, sub { ... });
		974
		975	If C<$skip> is given and not C<undef>, then it will be matched against
		976	the receive buffer when neither C<$accept> nor C<$reject> match,
		977	and everything preceding and including the match will be accepted
		978	unconditionally. This is useful to skip large amounts of data that you
		979	know cannot be matched, so that the C<$accept> or C<$reject> regex do not
		980	have to start matching from the beginning. This is purely an optimisation
		981	and is usually worth only when you expect more than a few kilobytes.
		982
		983	Example: expect a http header, which ends at C<\015\012\015\012>. Since we
		984	expect the header to be very large (it isn't in practise, but...), we use
		985	a skip regex to skip initial portions. The skip regex is tricky in that
		986	it only accepts something not ending in either \015 or \012, as these are
		987	required for the accept regex.
		988
		989	$handle->push_read (regex =>
		990	qr<\015\012\015\012>,
		991	undef, # no reject
		992	qr<^.*[^\015\012]>,
		993	sub { ... });
		994
		995	=cut
		996
		997	register_read_type regex => sub {
		998	my ($self, $cb, $accept, $reject, $skip) = @_;
		999
		1000	my $data;
		1001	my $rbuf = \$self->{rbuf};
584		1002
585	sub {	1003	sub {
586	$_[0]{rbuf} =~ s/$eol// or return;	1004	# accept
		1005	if ($$rbuf =~ $accept) {
		1006	$data .= substr $$rbuf, 0, $+[0], "";
		1007	$cb->($self, $data);
		1008	return 1;
		1009	}
		1010
		1011	# reject
		1012	if ($reject && $$rbuf =~ $reject) {
		1013	$self->_error (&Errno::EBADMSG);
		1014	}
587		1015
588	$cb->($_[0], $1, $2);	1016	# skip
		1017	if ($skip && $$rbuf =~ $skip) {
		1018	$data .= substr $$rbuf, 0, $+[0], "";
		1019	}
		1020
		1021	()
		1022	}
		1023	};
		1024
		1025	=item netstring => $cb->($handle, $string)
		1026
		1027	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
		1028
		1029	Throws an error with C<$!> set to EBADMSG on format violations.
		1030
		1031	=cut
		1032
		1033	register_read_type netstring => sub {
		1034	my ($self, $cb) = @_;
		1035
		1036	sub {
		1037	unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {
		1038	if ($_[0]{rbuf} =~ /[^0-9]/) {
		1039	$self->_error (&Errno::EBADMSG);
		1040	}
		1041	return;
		1042	}
		1043
		1044	my $len = $1;
		1045
		1046	$self->unshift_read (chunk => $len, sub {
		1047	my $string = $_[1];
		1048	$_[0]->unshift_read (chunk => 1, sub {
		1049	if ($_[1] eq ",") {
		1050	$cb->($_[0], $string);
		1051	} else {
		1052	$self->_error (&Errno::EBADMSG);
		1053	}
		1054	});
		1055	});
		1056
589	1	1057	1
590	}	1058	}
591	}	1059	};
592		1060
593	sub push_read_line {	1061	=item packstring => $format, $cb->($handle, $string)
594	$_[0]->push_read (&_read_line);
595	}
596		1062
597	sub unshift_read_line {	1063	An octet string prefixed with an encoded length. The encoding C<$format>
598	$_[0]->unshift_read (&_read_line);	1064	uses the same format as a Perl C<pack> format, but must specify a single
599	}	1065	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
		1066	optional C<!>, C<< < >> or C<< > >> modifier).
		1067
		1068	DNS over TCP uses a prefix of C<n>, EPP uses a prefix of C<N>.
		1069
		1070	Example: read a block of data prefixed by its length in BER-encoded
		1071	format (very efficient).
		1072
		1073	$handle->push_read (packstring => "w", sub {
		1074	my ($handle, $data) = @_;
		1075	});
		1076
		1077	=cut
		1078
		1079	register_read_type packstring => sub {
		1080	my ($self, $cb, $format) = @_;
		1081
		1082	sub {
		1083	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
		1084	defined (my $len = eval { unpack $format, $_[0]{rbuf} })
		1085	or return;
		1086
		1087	$format = length pack $format, $len;
		1088
		1089	# bypass unshift if we already have the remaining chunk
		1090	if ($format + $len <= length $_[0]{rbuf}) {
		1091	my $data = substr $_[0]{rbuf}, $format, $len;
		1092	substr $_[0]{rbuf}, 0, $format + $len, "";
		1093	$cb->($_[0], $data);
		1094	} else {
		1095	# remove prefix
		1096	substr $_[0]{rbuf}, 0, $format, "";
		1097
		1098	# read remaining chunk
		1099	$_[0]->unshift_read (chunk => $len, $cb);
		1100	}
		1101
		1102	1
		1103	}
		1104	};
		1105
		1106	=item json => $cb->($handle, $hash_or_arrayref)
		1107
		1108	Reads a JSON object or array, decodes it and passes it to the callback.
		1109
		1110	If a C<json> object was passed to the constructor, then that will be used
		1111	for the final decode, otherwise it will create a JSON coder expecting UTF-8.
		1112
		1113	This read type uses the incremental parser available with JSON version
		1114	2.09 (and JSON::XS version 2.2) and above. You have to provide a
		1115	dependency on your own: this module will load the JSON module, but
		1116	AnyEvent does not depend on it itself.
		1117
		1118	Since JSON texts are fully self-delimiting, the C<json> read and write
		1119	types are an ideal simple RPC protocol: just exchange JSON datagrams. See
		1120	the C<json> write type description, above, for an actual example.
		1121
		1122	=cut
		1123
		1124	register_read_type json => sub {
		1125	my ($self, $cb) = @_;
		1126
		1127	require JSON;
		1128
		1129	my $data;
		1130	my $rbuf = \$self->{rbuf};
		1131
		1132	my $json = $self->{json} ||= JSON->new->utf8;
		1133
		1134	sub {
		1135	my $ref = $json->incr_parse ($self->{rbuf});
		1136
		1137	if ($ref) {
		1138	$self->{rbuf} = $json->incr_text;
		1139	$json->incr_text = "";
		1140	$cb->($self, $ref);
		1141
		1142	1
		1143	} else {
		1144	$self->{rbuf} = "";
		1145	()
		1146	}
		1147	}
		1148	};
		1149
		1150	=item storable => $cb->($handle, $ref)
		1151
		1152	Deserialises a L<Storable> frozen representation as written by the
		1153	C<storable> write type (BER-encoded length prefix followed by nfreeze'd
		1154	data).
		1155
		1156	Raises C<EBADMSG> error if the data could not be decoded.
		1157
		1158	=cut
		1159
		1160	register_read_type storable => sub {
		1161	my ($self, $cb) = @_;
		1162
		1163	require Storable;
		1164
		1165	sub {
		1166	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
		1167	defined (my $len = eval { unpack "w", $_[0]{rbuf} })
		1168	or return;
		1169
		1170	my $format = length pack "w", $len;
		1171
		1172	# bypass unshift if we already have the remaining chunk
		1173	if ($format + $len <= length $_[0]{rbuf}) {
		1174	my $data = substr $_[0]{rbuf}, $format, $len;
		1175	substr $_[0]{rbuf}, 0, $format + $len, "";
		1176	$cb->($_[0], Storable::thaw ($data));
		1177	} else {
		1178	# remove prefix
		1179	substr $_[0]{rbuf}, 0, $format, "";
		1180
		1181	# read remaining chunk
		1182	$_[0]->unshift_read (chunk => $len, sub {
		1183	if (my $ref = eval { Storable::thaw ($_[1]) }) {
		1184	$cb->($_[0], $ref);
		1185	} else {
		1186	$self->_error (&Errno::EBADMSG);
		1187	}
		1188	});
		1189	}
		1190
		1191	1
		1192	}
		1193	};
		1194
		1195	=back
		1196
		1197	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)
		1198
		1199	This function (not method) lets you add your own types to C<push_read>.
		1200
		1201	Whenever the given C<type> is used, C<push_read> will invoke the code
		1202	reference with the handle object, the callback and the remaining
		1203	arguments.
		1204
		1205	The code reference is supposed to return a callback (usually a closure)
		1206	that works as a plain read callback (see C<< ->push_read ($cb) >>).
		1207
		1208	It should invoke the passed callback when it is done reading (remember to
		1209	pass C<$handle> as first argument as all other callbacks do that).
		1210
		1211	Note that this is a function, and all types registered this way will be
		1212	global, so try to use unique names.
		1213
		1214	For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>,
		1215	search for C<register_read_type>)).
600		1216
601	=item $handle->stop_read	1217	=item $handle->stop_read
602		1218
603	=item $handle->start_read	1219	=item $handle->start_read
604		1220
605	In rare cases you actually do not want to read anything from the	1221	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	1222	socket. In this case you can call C<stop_read>. Neither C<on_read> nor
607	any queued callbacks will be executed then. To start readign again, call	1223	any queued callbacks will be executed then. To start reading again, call
608	C<start_read>.	1224	C<start_read>.
		1225
		1226	Note that AnyEvent::Handle will automatically C<start_read> for you when
		1227	you change the C<on_read> callback or push/unshift a read callback, and it
		1228	will automatically C<stop_read> for you when neither C<on_read> is set nor
		1229	there are any read requests in the queue.
609		1230
610	=cut	1231	=cut
611		1232
612	sub stop_read {	1233	sub stop_read {
613	my ($self) = @_;	1234	my ($self) = @_;
614		1235
615	delete $self->{rw};	1236	delete $self->{_rw};
616	}	1237	}
617		1238
618	sub start_read {	1239	sub start_read {
619	my ($self) = @_;	1240	my ($self) = @_;
620		1241
621	unless ($self->{rw} || $self->{eof}) {	1242	unless ($self->{_rw} || $self->{_eof}) {
622	Scalar::Util::weaken $self;	1243	Scalar::Util::weaken $self;
623		1244
624	$self->{rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1245	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
625	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1246	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};
626	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf;	1247	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf;
627		1248
628	if ($len > 0) {	1249	if ($len > 0) {
		1250	$self->{_activity} = AnyEvent->now;
		1251
629	$self->{filter_r}	1252	$self->{filter_r}
630	? $self->{filter_r}->($self, $rbuf)	1253	? $self->{filter_r}($self, $rbuf)
631	: $self->_drain_rbuf;	1254	: $self->{_in_drain} || $self->_drain_rbuf;
632		1255
633	} elsif (defined $len) {	1256	} elsif (defined $len) {
634	delete $self->{rw};	1257	delete $self->{_rw};
635	$self->{eof} = 1;	1258	$self->{_eof} = 1;
636	$self->_drain_rbuf;	1259	$self->_drain_rbuf unless $self->{_in_drain};
637		1260
638	} elsif ($! != EAGAIN && $! != EINTR) {	1261	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
639	return $self->error;	1262	return $self->_error ($!, 1);
640	}	1263	}
641	});	1264	});
642	}	1265	}
643	}	1266	}
644		1267
645	sub _dotls {	1268	sub _dotls {
646	my ($self) = @_;	1269	my ($self) = @_;
647		1270
		1271	my $buf;
		1272
648	if (length $self->{tls_wbuf}) {	1273	if (length $self->{_tls_wbuf}) {
649	my $len = Net::SSLeay::write ($self->{tls}, $self->{tls_wbuf});	1274	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
650	substr $self->{tls_wbuf}, 0, $len, "" if $len > 0;	1275	substr $self->{_tls_wbuf}, 0, $len, "";
		1276	}
651	}	1277	}
652		1278
653	if (defined (my $buf = Net::SSLeay::BIO_read ($self->{tls_wbio}))) {	1279	if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {
654	$self->{wbuf} .= $buf;	1280	$self->{wbuf} .= $buf;
655	$self->_drain_wbuf;	1281	$self->_drain_wbuf;
656	}	1282	}
657		1283
658	if (defined (my $buf = Net::SSLeay::read ($self->{tls}))) {	1284	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {
		1285	if (length $buf) {
659	$self->{rbuf} .= $buf;	1286	$self->{rbuf} .= $buf;
660	$self->_drain_rbuf;	1287	$self->_drain_rbuf unless $self->{_in_drain};
661	} elsif (	1288	} else {
		1289	# let's treat SSL-eof as we treat normal EOF
		1290	$self->{_eof} = 1;
		1291	$self->_shutdown;
		1292	return;
		1293	}
		1294	}
		1295
662	(my $err = Net::SSLeay::get_error ($self->{tls}, -1))	1296	my $err = Net::SSLeay::get_error ($self->{tls}, -1);
		1297
663	!= Net::SSLeay::ERROR_WANT_READ ()	1298	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
664	) {
665	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {	1299	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {
666	$self->error;	1300	return $self->_error ($!, 1);
667	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {	1301	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {
668	$! = &Errno::EIO;	1302	return $self->_error (&Errno::EIO, 1);
669	$self->error;
670	}	1303	}
671		1304
672	# all others are fine for our purposes	1305	# all others are fine for our purposes
673	}	1306	}
674	}	1307	}
675		1308
676	# TODO: maybe document...	1309	=item $handle->starttls ($tls[, $tls_ctx])
		1310
		1311	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
		1312	object is created, you can also do that at a later time by calling
		1313	C<starttls>.
		1314
		1315	The first argument is the same as the C<tls> constructor argument (either
		1316	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
		1317
		1318	The second argument is the optional C<Net::SSLeay::CTX> object that is
		1319	used when AnyEvent::Handle has to create its own TLS connection object.
		1320
		1321	The TLS connection object will end up in C<< $handle->{tls} >> after this
		1322	call and can be used or changed to your liking. Note that the handshake
		1323	might have already started when this function returns.
		1324
		1325	=cut
		1326
677	sub starttls {	1327	sub starttls {
678	my ($self, $ssl, $ctx) = @_;	1328	my ($self, $ssl, $ctx) = @_;
		1329
		1330	$self->stoptls;
679		1331
680	if ($ssl eq "accept") {	1332	if ($ssl eq "accept") {
681	$ssl = Net::SSLeay::new ($ctx || TLS_CTX ());	1333	$ssl = Net::SSLeay::new ($ctx || TLS_CTX ());
682	Net::SSLeay::set_accept_state ($ssl);	1334	Net::SSLeay::set_accept_state ($ssl);
683	} elsif ($ssl eq "connect") {	1335	} elsif ($ssl eq "connect") {
…		…
689		1341
690	# basically, this is deep magic (because SSL_read should have the same issues)	1342	# 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".	1343	# but the openssl maintainers basically said: "trust us, it just works".
692	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1344	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
693	# and mismaintained ssleay-module doesn't even offer them).	1345	# and mismaintained ssleay-module doesn't even offer them).
		1346	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
694	Net::SSLeay::CTX_set_mode ($self->{tls},	1347	Net::SSLeay::CTX_set_mode ($self->{tls},
695	(eval { Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)	1348	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)
696	| (eval { Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));	1349	| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));
697		1350
698	$self->{tls_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1351	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
699	$self->{tls_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1352	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
700		1353
701	Net::SSLeay::set_bio ($ssl, $self->{tls_rbio}, $self->{tls_wbio});	1354	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
702		1355
703	$self->{filter_w} = sub {	1356	$self->{filter_w} = sub {
704	$_[0]{tls_wbuf} .= ${$_[1]};	1357	$_[0]{_tls_wbuf} .= ${$_[1]};
705	&_dotls;	1358	&_dotls;
706	};	1359	};
707	$self->{filter_r} = sub {	1360	$self->{filter_r} = sub {
708	Net::SSLeay::BIO_write ($_[0]{tls_rbio}, ${$_[1]});	1361	Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});
709	&_dotls;	1362	&_dotls;
710	};	1363	};
711	}	1364	}
712		1365
		1366	=item $handle->stoptls
		1367
		1368	Destroys the SSL connection, if any. Partial read or write data will be
		1369	lost.
		1370
		1371	=cut
		1372
		1373	sub stoptls {
		1374	my ($self) = @_;
		1375
		1376	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};
		1377
		1378	delete $self->{_rbio};
		1379	delete $self->{_wbio};
		1380	delete $self->{_tls_wbuf};
		1381	delete $self->{filter_r};
		1382	delete $self->{filter_w};
		1383	}
		1384
713	sub DESTROY {	1385	sub DESTROY {
714	my $self = shift;	1386	my $self = shift;
715		1387
716	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};	1388	$self->stoptls;
		1389
		1390	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
		1391
		1392	if ($linger && length $self->{wbuf}) {
		1393	my $fh = delete $self->{fh};
		1394	my $wbuf = delete $self->{wbuf};
		1395
		1396	my @linger;
		1397
		1398	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {
		1399	my $len = syswrite $fh, $wbuf, length $wbuf;
		1400
		1401	if ($len > 0) {
		1402	substr $wbuf, 0, $len, "";
		1403	} else {
		1404	@linger = (); # end
		1405	}
		1406	});
		1407	push @linger, AnyEvent->timer (after => $linger, cb => sub {
		1408	@linger = ();
		1409	});
		1410	}
717	}	1411	}
718		1412
719	=item AnyEvent::Handle::TLS_CTX	1413	=item AnyEvent::Handle::TLS_CTX
720		1414
721	This function creates and returns the Net::SSLeay::CTX object used by	1415	This function creates and returns the Net::SSLeay::CTX object used by
…		…
751	}	1445	}
752	}	1446	}
753		1447
754	=back	1448	=back
755		1449
		1450	=head1 SUBCLASSING AnyEvent::Handle
		1451
		1452	In many cases, you might want to subclass AnyEvent::Handle.
		1453
		1454	To make this easier, a given version of AnyEvent::Handle uses these
		1455	conventions:
		1456
		1457	=over 4
		1458
		1459	=item * all constructor arguments become object members.
		1460
		1461	At least initially, when you pass a C<tls>-argument to the constructor it
		1462	will end up in C<< $handle->{tls} >>. Those members might be changed or
		1463	mutated later on (for example C<tls> will hold the TLS connection object).
		1464
		1465	=item * other object member names are prefixed with an C<_>.
		1466
		1467	All object members not explicitly documented (internal use) are prefixed
		1468	with an underscore character, so the remaining non-C<_>-namespace is free
		1469	for use for subclasses.
		1470
		1471	=item * all members not documented here and not prefixed with an underscore
		1472	are free to use in subclasses.
		1473
		1474	Of course, new versions of AnyEvent::Handle may introduce more "public"
		1475	member variables, but thats just life, at least it is documented.
		1476
		1477	=back
		1478
756	=head1 AUTHOR	1479	=head1 AUTHOR
757		1480
758	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.	1481	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.
759		1482
760	=cut	1483	=cut

Diff Legend

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