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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.39 by root, Tue May 27 04:59:51 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 qw(WSAWOULDBLOCK);	7	use AnyEvent::Util qw(WSAEWOULDBLOCK);
8	use Scalar::Util ();	8	use Scalar::Util ();
9	use Carp ();	9	use Carp ();
10	use Fcntl ();	10	use Fcntl ();
11	use Errno qw/EAGAIN EINTR/;	11	use Errno qw(EAGAIN EINTR);
12		12
13	=head1 NAME	13	=head1 NAME
14		14
15	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent	15	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent
16		16
17	=cut	17	=cut
18		18
19	our $VERSION = '0.04';	19	our $VERSION = 4.22;
20		20
21	=head1 SYNOPSIS	21	=head1 SYNOPSIS
22		22
23	use AnyEvent;	23	use AnyEvent;
24	use AnyEvent::Handle;	24	use AnyEvent::Handle;
…		…
73	The filehandle this L<AnyEvent::Handle> object will operate on.	73	The filehandle this L<AnyEvent::Handle> object will operate on.
74		74
75	NOTE: The filehandle will be set to non-blocking (using	75	NOTE: The filehandle will be set to non-blocking (using
76	AnyEvent::Util::fh_nonblocking).	76	AnyEvent::Util::fh_nonblocking).
77		77
78	=item on_eof => $cb->($self)	78	=item on_eof => $cb->($handle)
79		79
80	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.
81		83
82	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,
83	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
84	waiting for data.	86	waiting for data.
85		87
86	=item on_error => $cb->($self)	88	=item on_error => $cb->($handle, $fatal)
87		89
88	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
89	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
90	or a read error.	92	connect or a read error.
91		93
92	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
93	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.
94		99
95	On callback entrance, the value of C<$!> contains the operating system	100	On callback entrance, the value of C<$!> contains the operating system
96	error (or C<ENOSPC>, C<EPIPE> or C<EBADMSG>).	101	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).
97
98	The callback should throw an exception. If it returns, then
99	AnyEvent::Handle will C<croak> for you.
100		102
101	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
102	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
103	die.	105	C<croak>.
104		106
105	=item on_read => $cb->($self)	107	=item on_read => $cb->($handle)
106		108
107	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
108	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).
109		113
110	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 >>
111	method or access the C<$self->{rbuf}> member directly.	115	method or access the C<$handle->{rbuf}> member directly.
112		116
113	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
114	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
115	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
116	error will be raised (with C<$!> set to C<EPIPE>).	120	error will be raised (with C<$!> set to C<EPIPE>).
117		121
118	=item on_drain => $cb->()	122	=item on_drain => $cb->($handle)
119		123
120	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
121	(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).
122		126
123	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.
124		154
125	=item rbuf_max => <bytes>	155	=item rbuf_max => <bytes>
126		156
127	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>)
128	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
…		…
132	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
133	(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
134	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
135	isn't finished).	165	isn't finished).
136		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
137	=item read_size => <bytes>	191	=item read_size => <bytes>
138		192
139	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
140	on each [loop iteration). Default: C<4096>.	194	during each (loop iteration). Default: C<8192>.
141		195
142	=item low_water_mark => <bytes>	196	=item low_water_mark => <bytes>
143		197
144	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
145	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
146	considered empty.	200	considered empty.
		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.
147		212
148	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	213	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
149		214
150	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
151	will start making tls handshake and will transparently encrypt/decrypt	216	will start making tls handshake and will transparently encrypt/decrypt
…		…
160	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
161	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>
162	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
163	AnyEvent::Handle.	228	AnyEvent::Handle.
164		229
165	See the C<starttls> method if you need to start TLs negotiation later.	230	See the C<starttls> method if you need to start TLS negotiation later.
166		231
167	=item tls_ctx => $ssl_ctx	232	=item tls_ctx => $ssl_ctx
168		233
169	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
170	(unless a connection object was specified directly). If this parameter is	235	(unless a connection object was specified directly). If this parameter is
171	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	236	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
172		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
173	=item filter_r => $cb	248	=item filter_r => $cb
174		249
175	=item filter_w => $cb	250	=item filter_w => $cb
176		251
177	These exist, but are undocumented at this time.	252	These exist, but are undocumented at this time.
…		…
192	if ($self->{tls}) {	267	if ($self->{tls}) {
193	require Net::SSLeay;	268	require Net::SSLeay;
194	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});	269	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});
195	}	270	}
196		271
197	$self->on_eof (delete $self->{on_eof} ) if $self->{on_eof};	272	$self->{_activity} = AnyEvent->now;
198	$self->on_error (delete $self->{on_error}) if $self->{on_error};	273	$self->_timeout;
		274
199	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	275	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};
200	$self->on_read (delete $self->{on_read} ) if $self->{on_read};	276	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
201		277
202	$self->start_read;	278	$self->start_read
		279	if $self->{on_read};
203		280
204	$self	281	$self
205	}	282	}
206		283
207	sub _shutdown {	284	sub _shutdown {
208	my ($self) = @_;	285	my ($self) = @_;
209		286
		287	delete $self->{_tw};
210	delete $self->{_rw};	288	delete $self->{_rw};
211	delete $self->{_ww};	289	delete $self->{_ww};
212	delete $self->{fh};	290	delete $self->{fh};
213	}
214		291
		292	$self->stoptls;
		293	}
		294
215	sub error {	295	sub _error {
216	my ($self) = @_;	296	my ($self, $errno, $fatal) = @_;
217		297
218	{
219	local $!;
220	$self->_shutdown;	298	$self->_shutdown
221	}	299	if $fatal;
222		300
223	$self->{on_error}($self)	301	$! = $errno;
		302
224	if $self->{on_error};	303	if ($self->{on_error}) {
225		304	$self->{on_error}($self, $fatal);
		305	} else {
226	Carp::croak "AnyEvent::Handle uncaught fatal error: $!";	306	Carp::croak "AnyEvent::Handle uncaught error: $!";
		307	}
227	}	308	}
228		309
229	=item $fh = $handle->fh	310	=item $fh = $handle->fh
230		311
231	This method returns the file handle of the L<AnyEvent::Handle> object.	312	This method returns the file handle of the L<AnyEvent::Handle> object.
…		…
250		331
251	=cut	332	=cut
252		333
253	sub on_eof {	334	sub on_eof {
254	$_[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	}
255	}	426	}
256		427
257	#############################################################################	428	#############################################################################
258		429
259	=back	430	=back
…		…
306	my $len = syswrite $self->{fh}, $self->{wbuf};	477	my $len = syswrite $self->{fh}, $self->{wbuf};
307		478
308	if ($len >= 0) {	479	if ($len >= 0) {
309	substr $self->{wbuf}, 0, $len, "";	480	substr $self->{wbuf}, 0, $len, "";
310		481
		482	$self->{_activity} = AnyEvent->now;
		483
311	$self->{on_drain}($self)	484	$self->{on_drain}($self)
312	if $self->{low_water_mark} >= length $self->{wbuf}	485	if $self->{low_water_mark} >= length $self->{wbuf}
313	&& $self->{on_drain};	486	&& $self->{on_drain};
314		487
315	delete $self->{_ww} unless length $self->{wbuf};	488	delete $self->{_ww} unless length $self->{wbuf};
316	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAWOULDBLOCK) {	489	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
317	$self->error;	490	$self->_error ($!, 1);
318	}	491	}
319	};	492	};
320		493
321	# try to write data immediately	494	# try to write data immediately
322	$cb->();	495	$cb->() unless $self->{autocork};
323		496
324	# if still data left in wbuf, we need to poll	497	# if still data left in wbuf, we need to poll
325	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	498	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)
326	if length $self->{wbuf};	499	if length $self->{wbuf};
327	};	500	};
…		…
342	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	515	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")
343	->($self, @_);	516	->($self, @_);
344	}	517	}
345		518
346	if ($self->{filter_w}) {	519	if ($self->{filter_w}) {
347	$self->{filter_w}->($self, \$_[0]);	520	$self->{filter_w}($self, \$_[0]);
348	} else {	521	} else {
349	$self->{wbuf} .= $_[0];	522	$self->{wbuf} .= $_[0];
350	$self->_drain_wbuf;	523	$self->_drain_wbuf;
351	}	524	}
352	}	525	}
353		526
354	=item $handle->push_write (type => @args)	527	=item $handle->push_write (type => @args)
355		528
356	=item $handle->unshift_write (type => @args)
357
358	Instead of formatting your data yourself, you can also let this module do	529	Instead of formatting your data yourself, you can also let this module do
359	the job by specifying a type and type-specific arguments.	530	the job by specifying a type and type-specific arguments.
360		531
361	Predefined types are (if you have ideas for additional types, feel free to	532	Predefined types are (if you have ideas for additional types, feel free to
362	drop by and tell us):	533	drop by and tell us):
…		…
366	=item netstring => $string	537	=item netstring => $string
367		538
368	Formats the given value as netstring	539	Formats the given value as netstring
369	(http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them).	540	(http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them).
370		541
371	=back
372
373	=cut	542	=cut
374		543
375	register_write_type netstring => sub {	544	register_write_type netstring => sub {
376	my ($self, $string) = @_;	545	my ($self, $string) = @_;
377		546
378	sprintf "%d:%s,", (length $string), $string	547	sprintf "%d:%s,", (length $string), $string
379	};	548	};
380		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
381	=item json => $array_or_hashref	565	=item json => $array_or_hashref
382		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
383	=item AnyEvent::Handle::register_write_type type => $coderef->($self, @args)	623	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
384		624
385	This function (not method) lets you add your own types to C<push_write>.	625	This function (not method) lets you add your own types to C<push_write>.
386	Whenever the given C<type> is used, C<push_write> will invoke the code	626	Whenever the given C<type> is used, C<push_write> will invoke the code
387	reference with the handle object and the remaining arguments.	627	reference with the handle object and the remaining arguments.
388		628
…		…
407	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
408	a queue.	648	a queue.
409		649
410	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
411	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
412	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
413	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).
414		655
415	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
416	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
417	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
418	below).	659	done its job (see C<push_read>, below).
419		660
420	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
421	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.
422		663
423	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
424	the specified number of bytes which give an XML datagram.	665	the specified number of bytes which give an XML datagram.
425		666
426	# in the default state, expect some header bytes	667	# in the default state, expect some header bytes
427	$handle->on_read (sub {	668	$handle->on_read (sub {
428	# 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)
429	shift->unshift_read_chunk (4, sub {	670	shift->unshift_read (chunk => 4, sub {
430	# header arrived, decode	671	# header arrived, decode
431	my $len = unpack "N", $_[1];	672	my $len = unpack "N", $_[1];
432		673
433	# now read the payload	674	# now read the payload
434	shift->unshift_read_chunk ($len, sub {	675	shift->unshift_read (chunk => $len, sub {
435	my $xml = $_[1];	676	my $xml = $_[1];
436	# handle xml	677	# handle xml
437	});	678	});
438	});	679	});
439	});	680	});
440		681
441	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"
442	"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
443	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
444	pipeline sending both requests and manipulate the queue as necessary in	685	just pipeline sending both requests and manipulate the queue as necessary
445	the callbacks:	686	in the callbacks.
446		687
447	# 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"
448	$handle->push_write ("request 1\015\012");	693	$handle->push_write ("request 1\015\012");
449		694
450	# 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
451	$handle->push_read_line (sub {	696	$handle->push_read (line => sub {
452	# if we got an "OK", we have to _prepend_ another line,	697	# if we got an "OK", we have to _prepend_ another line,
453	# 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
454	# which are already in the queue when this callback is called	699	# which are already in the queue when this callback is called
455	# we don't do this in case we got an error	700	# we don't do this in case we got an error
456	if ($_[1] eq "OK") {	701	if ($_[1] eq "OK") {
457	$_[0]->unshift_read_line (sub {	702	$_[0]->unshift_read (line => sub {
458	my $response = $_[1];	703	my $response = $_[1];
459	...	704	...
460	});	705	});
461	}	706	}
462	});	707	});
463		708
464	# request two	709	# request two, simply returns 64 octets
465	$handle->push_write ("request 2\015\012");	710	$handle->push_write ("request 2\015\012");
466		711
467	# simply read 64 bytes, always	712	# simply read 64 bytes, always
468	$handle->push_read_chunk (64, sub {	713	$handle->push_read (chunk => 64, sub {
469	my $response = $_[1];	714	my $response = $_[1];
470	...	715	...
471	});	716	});
472		717
473	=over 4	718	=over 4
474		719
475	=cut	720	=cut
476		721
477	sub _drain_rbuf {	722	sub _drain_rbuf {
478	my ($self) = @_;	723	my ($self) = @_;
		724
		725	local $self->{_in_drain} = 1;
479		726
480	if (	727	if (
481	defined $self->{rbuf_max}	728	defined $self->{rbuf_max}
482	&& $self->{rbuf_max} < length $self->{rbuf}	729	&& $self->{rbuf_max} < length $self->{rbuf}
483	) {	730	) {
484	$! = &Errno::ENOSPC;	731	return $self->_error (&Errno::ENOSPC, 1);
485	$self->error;
486	}	732	}
487		733
488	return if $self->{in_drain};	734	while () {
489	local $self->{in_drain} = 1;
490
491	while (my $len = length $self->{rbuf}) {
492	no strict 'refs';	735	no strict 'refs';
		736
		737	my $len = length $self->{rbuf};
		738
493	if (my $cb = shift @{ $self->{_queue} }) {	739	if (my $cb = shift @{ $self->{_queue} }) {
494	unless ($cb->($self)) {	740	unless ($cb->($self)) {
495	if ($self->{_eof}) {	741	if ($self->{_eof}) {
496	# 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)
497	$! = &Errno::EPIPE;	743	$self->_error (&Errno::EPIPE, 1), last;
498	$self->error;
499	}	744	}
500		745
501	unshift @{ $self->{_queue} }, $cb;	746	unshift @{ $self->{_queue} }, $cb;
502	return;	747	last;
503	}	748	}
504	} elsif ($self->{on_read}) {	749	} elsif ($self->{on_read}) {
		750	last unless $len;
		751
505	$self->{on_read}($self);	752	$self->{on_read}($self);
506		753
507	if (	754	if (
508	$self->{_eof} # if no further data will arrive
509	&& $len == length $self->{rbuf} # and no data has been consumed	755	$len == length $self->{rbuf} # if no data has been consumed
510	&& !@{ $self->{_queue} } # and the queue is still empty	756	&& !@{ $self->{_queue} } # and the queue is still empty
511	&& $self->{on_read} # and we still want to read data	757	&& $self->{on_read} # but we still have on_read
512	) {	758	) {
		759	# no further data will arrive
513	# then no progress can be made	760	# so no progress can be made
514	$! = &Errno::EPIPE;	761	$self->_error (&Errno::EPIPE, 1), last
515	$self->error;	762	if $self->{_eof};
		763
		764	last; # more data might arrive
516	}	765	}
517	} else {	766	} else {
518	# read side becomes idle	767	# read side becomes idle
519	delete $self->{_rw};	768	delete $self->{_rw};
520	return;	769	last;
521	}	770	}
522	}	771	}
523		772
524	if ($self->{_eof}) {
525	$self->_shutdown;
526	$self->{on_eof}($self)	773	$self->{on_eof}($self)
527	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} };
528	}	780	}
529	}	781	}
530		782
531	=item $handle->on_read ($cb)	783	=item $handle->on_read ($cb)
532		784
…		…
538		790
539	sub on_read {	791	sub on_read {
540	my ($self, $cb) = @_;	792	my ($self, $cb) = @_;
541		793
542	$self->{on_read} = $cb;	794	$self->{on_read} = $cb;
		795	$self->_drain_rbuf if $cb && !$self->{_in_drain};
543	}	796	}
544		797
545	=item $handle->rbuf	798	=item $handle->rbuf
546		799
547	Returns the read buffer (as a modifiable lvalue).	800	Returns the read buffer (as a modifiable lvalue).
…		…
596	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	849	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
597	->($self, $cb, @_);	850	->($self, $cb, @_);
598	}	851	}
599		852
600	push @{ $self->{_queue} }, $cb;	853	push @{ $self->{_queue} }, $cb;
601	$self->_drain_rbuf;	854	$self->_drain_rbuf unless $self->{_in_drain};
602	}	855	}
603		856
604	sub unshift_read {	857	sub unshift_read {
605	my $self = shift;	858	my $self = shift;
606	my $cb = pop;	859	my $cb = pop;
…		…
612	->($self, $cb, @_);	865	->($self, $cb, @_);
613	}	866	}
614		867
615		868
616	unshift @{ $self->{_queue} }, $cb;	869	unshift @{ $self->{_queue} }, $cb;
617	$self->_drain_rbuf;	870	$self->_drain_rbuf unless $self->{_in_drain};
618	}	871	}
619		872
620	=item $handle->push_read (type => @args, $cb)	873	=item $handle->push_read (type => @args, $cb)
621		874
622	=item $handle->unshift_read (type => @args, $cb)	875	=item $handle->unshift_read (type => @args, $cb)
…		…
628	Predefined types are (if you have ideas for additional types, feel free to	881	Predefined types are (if you have ideas for additional types, feel free to
629	drop by and tell us):	882	drop by and tell us):
630		883
631	=over 4	884	=over 4
632		885
633	=item chunk => $octets, $cb->($self, $data)	886	=item chunk => $octets, $cb->($handle, $data)
634		887
635	Invoke the callback only once C<$octets> bytes have been read. Pass the	888	Invoke the callback only once C<$octets> bytes have been read. Pass the
636	data read to the callback. The callback will never be called with less	889	data read to the callback. The callback will never be called with less
637	data.	890	data.
638		891
…		…
652	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");	905	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");
653	1	906	1
654	}	907	}
655	};	908	};
656		909
657	# compatibility with older API
658	sub push_read_chunk {
659	$_[0]->push_read (chunk => $_[1], $_[2]);
660	}
661
662	sub unshift_read_chunk {
663	$_[0]->unshift_read (chunk => $_[1], $_[2]);
664	}
665
666	=item line => [$eol, ]$cb->($self, $line, $eol)	910	=item line => [$eol, ]$cb->($handle, $line, $eol)
667		911
668	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
669	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
670	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
671	the end of line marker as the third argument (C<$eol>).	915	the end of line marker as the third argument (C<$eol>).
…		…
685	=cut	929	=cut
686		930
687	register_read_type line => sub {	931	register_read_type line => sub {
688	my ($self, $cb, $eol) = @_;	932	my ($self, $cb, $eol) = @_;
689		933
690	$eol = qr\|(\015?\012)\| if @_ < 3;	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 {
691	$eol = quotemeta $eol unless ref $eol;	943	$eol = quotemeta $eol unless ref $eol;
692	$eol = qr\|^(.*?)($eol)\|s;	944	$eol = qr\|^(.*?)($eol)\|s;
693		945
694	sub {	946	sub {
695	$_[0]{rbuf} =~ s/$eol// or return;	947	$_[0]{rbuf} =~ s/$eol// or return;
696		948
697	$cb->($_[0], $1, $2);	949	$cb->($_[0], $1, $2);
		950	1
698	1	951	}
699	}	952	}
700	};	953	};
701		954
702	# compatibility with older API
703	sub push_read_line {
704	my $self = shift;
705	$self->push_read (line => @_);
706	}
707
708	sub unshift_read_line {
709	my $self = shift;
710	$self->unshift_read (line => @_);
711	}
712
713	=item netstring => $cb->($string)
714
715	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
716
717	Throws an error with C<$!> set to EBADMSG on format violations.
718
719	=cut
720
721	register_read_type netstring => sub {
722	my ($self, $cb) = @_;
723
724	sub {
725	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
726	if ($_[0]{rbuf} =~ /[^0-9]/) {
727	$! = &Errno::EBADMSG;
728	$self->error;
729	}
730	return;
731	}
732
733	my $len = $1;
734
735	$self->unshift_read (chunk => $len, sub {
736	my $string = $_[1];
737	$_[0]->unshift_read (chunk => 1, sub {
738	if ($_[1] eq ",") {
739	$cb->($_[0], $string);
740	} else {
741	$! = &Errno::EBADMSG;
742	$self->error;
743	}
744	});
745	});
746
747	1
748	}
749	};
750
751	=item regex => $accept[, $reject[, $skip], $cb->($data)	955	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
752		956
753	Makes a regex match against the regex object C<$accept> and returns	957	Makes a regex match against the regex object C<$accept> and returns
754	everything up to and including the match.	958	everything up to and including the match.
755		959
756	Example: read a single line terminated by '\n'.	960	Example: read a single line terminated by '\n'.
…		…
804	return 1;	1008	return 1;
805	}	1009	}
806		1010
807	# reject	1011	# reject
808	if ($reject && $$rbuf =~ $reject) {	1012	if ($reject && $$rbuf =~ $reject) {
809	$! = &Errno::EBADMSG;	1013	$self->_error (&Errno::EBADMSG);
810	$self->error;
811	}	1014	}
812		1015
813	# skip	1016	# skip
814	if ($skip && $$rbuf =~ $skip) {	1017	if ($skip && $$rbuf =~ $skip) {
815	$data .= substr $$rbuf, 0, $+[0], "";	1018	$data .= substr $$rbuf, 0, $+[0], "";
…		…
817		1020
818	()	1021	()
819	}	1022	}
820	};	1023	};
821		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
		1057	1
		1058	}
		1059	};
		1060
		1061	=item packstring => $format, $cb->($handle, $string)
		1062
		1063	An octet string prefixed with an encoded length. The encoding C<$format>
		1064	uses the same format as a Perl C<pack> format, but must specify a single
		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
822	=back	1195	=back
823		1196
824	=item AnyEvent::Handle::register_read_type type => $coderef->($self, $cb, @args)	1197	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)
825		1198
826	This function (not method) lets you add your own types to C<push_read>.	1199	This function (not method) lets you add your own types to C<push_read>.
827		1200
828	Whenever the given C<type> is used, C<push_read> will invoke the code	1201	Whenever the given C<type> is used, C<push_read> will invoke the code
829	reference with the handle object, the callback and the remaining	1202	reference with the handle object, the callback and the remaining
…		…
831		1204
832	The code reference is supposed to return a callback (usually a closure)	1205	The code reference is supposed to return a callback (usually a closure)
833	that works as a plain read callback (see C<< ->push_read ($cb) >>).	1206	that works as a plain read callback (see C<< ->push_read ($cb) >>).
834		1207
835	It should invoke the passed callback when it is done reading (remember to	1208	It should invoke the passed callback when it is done reading (remember to
836	pass C<$self> as first argument as all other callbacks do that).	1209	pass C<$handle> as first argument as all other callbacks do that).
837		1210
838	Note that this is a function, and all types registered this way will be	1211	Note that this is a function, and all types registered this way will be
839	global, so try to use unique names.	1212	global, so try to use unique names.
840		1213
841	For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>,	1214	For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>,
…		…
844	=item $handle->stop_read	1217	=item $handle->stop_read
845		1218
846	=item $handle->start_read	1219	=item $handle->start_read
847		1220
848	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
849	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
850	any queued callbacks will be executed then. To start reading again, call	1223	any queued callbacks will be executed then. To start reading again, call
851	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.
852		1230
853	=cut	1231	=cut
854		1232
855	sub stop_read {	1233	sub stop_read {
856	my ($self) = @_;	1234	my ($self) = @_;
…		…
867	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1245	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
868	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1246	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};
869	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;
870		1248
871	if ($len > 0) {	1249	if ($len > 0) {
		1250	$self->{_activity} = AnyEvent->now;
		1251
872	$self->{filter_r}	1252	$self->{filter_r}
873	? $self->{filter_r}->($self, $rbuf)	1253	? $self->{filter_r}($self, $rbuf)
874	: $self->_drain_rbuf;	1254	: $self->{_in_drain} \|\| $self->_drain_rbuf;
875		1255
876	} elsif (defined $len) {	1256	} elsif (defined $len) {
877	delete $self->{_rw};	1257	delete $self->{_rw};
878	$self->{_eof} = 1;	1258	$self->{_eof} = 1;
879	$self->_drain_rbuf;	1259	$self->_drain_rbuf unless $self->{_in_drain};
880		1260
881	} elsif ($! != EAGAIN && $! != EINTR && $! != &AnyEvent::Util::WSAWOULDBLOCK) {	1261	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
882	return $self->error;	1262	return $self->_error ($!, 1);
883	}	1263	}
884	});	1264	});
885	}	1265	}
886	}	1266	}
887		1267
888	sub _dotls {	1268	sub _dotls {
889	my ($self) = @_;	1269	my ($self) = @_;
		1270
		1271	my $buf;
890		1272
891	if (length $self->{_tls_wbuf}) {	1273	if (length $self->{_tls_wbuf}) {
892	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1274	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
893	substr $self->{_tls_wbuf}, 0, $len, "";	1275	substr $self->{_tls_wbuf}, 0, $len, "";
894	}	1276	}
895	}	1277	}
896		1278
897	if (defined (my $buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1279	if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {
898	$self->{wbuf} .= $buf;	1280	$self->{wbuf} .= $buf;
899	$self->_drain_wbuf;	1281	$self->_drain_wbuf;
900	}	1282	}
901		1283
902	while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) {	1284	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {
		1285	if (length $buf) {
903	$self->{rbuf} .= $buf;	1286	$self->{rbuf} .= $buf;
904	$self->_drain_rbuf;	1287	$self->_drain_rbuf unless $self->{_in_drain};
		1288	} else {
		1289	# let's treat SSL-eof as we treat normal EOF
		1290	$self->{_eof} = 1;
		1291	$self->_shutdown;
		1292	return;
		1293	}
905	}	1294	}
906		1295
907	my $err = Net::SSLeay::get_error ($self->{tls}, -1);	1296	my $err = Net::SSLeay::get_error ($self->{tls}, -1);
908		1297
909	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {	1298	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
910	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {	1299	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {
911	$self->error;	1300	return $self->_error ($!, 1);
912	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {	1301	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {
913	$! = &Errno::EIO;	1302	return $self->_error (&Errno::EIO, 1);
914	$self->error;
915	}	1303	}
916		1304
917	# all others are fine for our purposes	1305	# all others are fine for our purposes
918	}	1306	}
919	}	1307	}
…		…
934	call and can be used or changed to your liking. Note that the handshake	1322	call and can be used or changed to your liking. Note that the handshake
935	might have already started when this function returns.	1323	might have already started when this function returns.
936		1324
937	=cut	1325	=cut
938		1326
939	# TODO: maybe document...
940	sub starttls {	1327	sub starttls {
941	my ($self, $ssl, $ctx) = @_;	1328	my ($self, $ssl, $ctx) = @_;
942		1329
943	$self->stoptls;	1330	$self->stoptls;
944		1331
…		…
997		1384
998	sub DESTROY {	1385	sub DESTROY {
999	my $self = shift;	1386	my $self = shift;
1000		1387
1001	$self->stoptls;	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	}
1002	}	1411	}
1003		1412
1004	=item AnyEvent::Handle::TLS_CTX	1413	=item AnyEvent::Handle::TLS_CTX
1005		1414
1006	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
…		…
1048	=over 4	1457	=over 4
1049		1458
1050	=item * all constructor arguments become object members.	1459	=item * all constructor arguments become object members.
1051		1460
1052	At least initially, when you pass a C<tls>-argument to the constructor it	1461	At least initially, when you pass a C<tls>-argument to the constructor it
1053	will end up in C<< $handle->{tls} >>. Those members might be changes or	1462	will end up in C<< $handle->{tls} >>. Those members might be changed or
1054	mutated later on (for example C<tls> will hold the TLS connection object).	1463	mutated later on (for example C<tls> will hold the TLS connection object).
1055		1464
1056	=item * other object member names are prefixed with an C<_>.	1465	=item * other object member names are prefixed with an C<_>.
1057		1466
1058	All object members not explicitly documented (internal use) are prefixed	1467	All object members not explicitly documented (internal use) are prefixed

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.39 by root, Tue May 27 04:59:51 2008 UTC vs. Revision 1.78 by root, Sun Jul 27 07:34:07 2008 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.39 by root, Tue May 27 04:59:51 2008 UTC vs.
Revision 1.78 by root, Sun Jul 27 07:34:07 2008 UTC