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

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

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.19 by root, Sat May 24 05:57:11 2008 UTC vs. Revision 1.66 by root, Fri Jun 6 15:32:54 2008 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.19 by root, Sat May 24 05:57:11 2008 UTC vs.
Revision 1.66 by root, Fri Jun 6 15:32:54 2008 UTC