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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.75 by root, Fri Jul 18 02:14:44 2008 UTC vs.
Revision 1.112 by root, Wed Jan 21 06:01:35 2009 UTC

…		…
1	package AnyEvent::Handle;	1	package AnyEvent::Handle;
2		2
3	no warnings;	3	no warnings;
4	use strict;	4	use strict qw(subs vars);
5		5
6	use AnyEvent ();	6	use AnyEvent ();
7	use AnyEvent::Util qw(WSAEWOULDBLOCK);	7	use AnyEvent::Util qw(WSAEWOULDBLOCK);
8	use Scalar::Util ();	8	use Scalar::Util ();
9	use Carp ();	9	use Carp ();
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 = 4.22;	19	our $VERSION = 4.331;
20		20
21	=head1 SYNOPSIS	21	=head1 SYNOPSIS
22		22
23	use AnyEvent;	23	use AnyEvent;
24	use AnyEvent::Handle;	24	use AnyEvent::Handle;
…		…
27		27
28	my $handle =	28	my $handle =
29	AnyEvent::Handle->new (	29	AnyEvent::Handle->new (
30	fh => \*STDIN,	30	fh => \*STDIN,
31	on_eof => sub {	31	on_eof => sub {
32	$cv->broadcast;	32	$cv->send;
33	},	33	},
34	);	34	);
35		35
36	# send some request line	36	# send some request line
37	$handle->push_write ("getinfo\015\012");	37	$handle->push_write ("getinfo\015\012");
…		…
49		49
50	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
51	filehandles. For utility functions for doing non-blocking connects and accepts	51	filehandles. For utility functions for doing non-blocking connects and accepts
52	on sockets see L<AnyEvent::Util>.	52	on sockets see L<AnyEvent::Util>.
53		53
		54	The L<AnyEvent::Intro> tutorial contains some well-documented
		55	AnyEvent::Handle examples.
		56
54	In the following, when the documentation refers to of "bytes" then this	57	In the following, when the documentation refers to of "bytes" then this
55	means characters. As sysread and syswrite are used for all I/O, their	58	means characters. As sysread and syswrite are used for all I/O, their
56	treatment of characters applies to this module as well.	59	treatment of characters applies to this module as well.
57		60
58	All callbacks will be invoked with the handle object as their first	61	All callbacks will be invoked with the handle object as their first
…		…
70		73
71	=item fh => $filehandle [MANDATORY]	74	=item fh => $filehandle [MANDATORY]
72		75
73	The filehandle this L<AnyEvent::Handle> object will operate on.	76	The filehandle this L<AnyEvent::Handle> object will operate on.
74		77
75	NOTE: The filehandle will be set to non-blocking (using	78	NOTE: The filehandle will be set to non-blocking mode (using
76	AnyEvent::Util::fh_nonblocking).	79	C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in
		80	that mode.
77		81
78	=item on_eof => $cb->($handle)	82	=item on_eof => $cb->($handle)
79		83
80	Set the callback to be called when an end-of-file condition is detected,	84	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	85	i.e. in the case of a socket, when the other side has closed the
82	connection cleanly.	86	connection cleanly.
83		87
		88	For sockets, this just means that the other side has stopped sending data,
		89	you can still try to write data, and, in fact, one can return from the EOF
		90	callback and continue writing data, as only the read part has been shut
		91	down.
		92
84	While not mandatory, it is highly recommended to set an eof callback,	93	While not mandatory, it is I<highly> recommended to set an EOF callback,
85	otherwise you might end up with a closed socket while you are still	94	otherwise you might end up with a closed socket while you are still
86	waiting for data.	95	waiting for data.
		96
		97	If an EOF condition has been detected but no C<on_eof> callback has been
		98	set, then a fatal error will be raised with C<$!> set to <0>.
87		99
88	=item on_error => $cb->($handle, $fatal)	100	=item on_error => $cb->($handle, $fatal)
89		101
90	This is the error callback, which is called when, well, some error	102	This is the error callback, which is called when, well, some error
91	occured, such as not being able to resolve the hostname, failure to	103	occured, such as not being able to resolve the hostname, failure to
92	connect or a read error.	104	connect or a read error.
93		105
94	Some errors are fatal (which is indicated by C<$fatal> being true). On	106	Some errors are fatal (which is indicated by C<$fatal> being true). On
95	fatal errors the handle object will be shut down and will not be	107	fatal errors the handle object will be shut down and will not be usable
		108	(but you are free to look at the current C<< ->rbuf >>). Examples of fatal
		109	errors are an EOF condition with active (but unsatisifable) read watchers
		110	(C<EPIPE>) or I/O errors.
		111
96	usable. Non-fatal errors can be retried by simply returning, but it is	112	Non-fatal errors can be retried by simply returning, but it is recommended
97	recommended to simply ignore this parameter and instead abondon the handle	113	to simply ignore this parameter and instead abondon the handle object
98	object when this callback is invoked.	114	when this callback is invoked. Examples of non-fatal errors are timeouts
		115	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
99		116
100	On callback entrance, the value of C<$!> contains the operating system	117	On callback entrance, the value of C<$!> contains the operating system
101	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).	118	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).
102		119
103	While not mandatory, it is I<highly> recommended to set this callback, as	120	While not mandatory, it is I<highly> recommended to set this callback, as
…		…
135	=item timeout => $fractional_seconds	152	=item timeout => $fractional_seconds
136		153
137	If non-zero, then this enables an "inactivity" timeout: whenever this many	154	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	155	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	156	handle, the C<on_timeout> callback will be invoked (and if that one is
140	missing, an C<ETIMEDOUT> error will be raised).	157	missing, a non-fatal C<ETIMEDOUT> error will be raised).
141		158
142	Note that timeout processing is also active when you currently do not have	159	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	160	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	161	idle then you should disable the timout temporarily or ignore the timeout
145	in the C<on_timeout> callback.	162	in the C<on_timeout> callback, in which case AnyEvent::Handle will simply
		163	restart the timeout.
146		164
147	Zero (the default) disables this timeout.	165	Zero (the default) disables this timeout.
148		166
149	=item on_timeout => $cb->($handle)	167	=item on_timeout => $cb->($handle)
150		168
…		…
154		172
155	=item rbuf_max => <bytes>	173	=item rbuf_max => <bytes>
156		174
157	If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)	175	If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)
158	when the read buffer ever (strictly) exceeds this size. This is useful to	176	when the read buffer ever (strictly) exceeds this size. This is useful to
159	avoid denial-of-service attacks.	177	avoid some forms of denial-of-service attacks.
160		178
161	For example, a server accepting connections from untrusted sources should	179	For example, a server accepting connections from untrusted sources should
162	be configured to accept only so-and-so much data that it cannot act on	180	be configured to accept only so-and-so much data that it cannot act on
163	(for example, when expecting a line, an attacker could send an unlimited	181	(for example, when expecting a line, an attacker could send an unlimited
164	amount of data without a callback ever being called as long as the line	182	amount of data without a callback ever being called as long as the line
165	isn't finished).	183	isn't finished).
166		184
167	=item autocork => <boolean>	185	=item autocork => <boolean>
168		186
169	When disabled (the default), then C<push_write> will try to immediately	187	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	188	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	189	a write watcher and wait for the next event loop iteration, but can
172	inefficient if you write multiple small chunks (this disadvantage is	190	be inefficient if you write multiple small chunks (on the wire, this
173	usually avoided by your kernel's nagle algorithm, see C<low_delay>).	191	disadvantage is usually avoided by your kernel's nagle algorithm, see
		192	C<no_delay>, but this option can save costly syscalls).
174		193
175	When enabled, then writes will always be queued till the next event loop	194	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,	195	iteration. This is efficient when you do many small writes per iteration,
177	but less efficient when you do a single write only.	196	but less efficient when you do a single write only per iteration (or when
		197	the write buffer often is full). It also increases write latency.
178		198
179	=item no_delay => <boolean>	199	=item no_delay => <boolean>
180		200
181	When doing small writes on sockets, your operating system kernel might	201	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	202	wait a bit for more data before actually sending it out. This is called
183	the Nagle algorithm, and usually it is beneficial.	203	the Nagle algorithm, and usually it is beneficial.
184		204
185	In some situations you want as low a delay as possible, which cna be	205	In some situations you want as low a delay as possible, which can be
186	accomplishd by setting this option to true.	206	accomplishd by setting this option to a true value.
187		207
188	The default is your opertaing system's default behaviour, this option	208	The default is your opertaing system's default behaviour (most likely
189	explicitly enables or disables it, if possible.	209	enabled), this option explicitly enables or disables it, if possible.
190		210
191	=item read_size => <bytes>	211	=item read_size => <bytes>
192		212
193	The default read block size (the amount of bytes this module will try to read	213	The default read block size (the amount of bytes this module will
194	during each (loop iteration). Default: C<8192>.	214	try to read during each loop iteration, which affects memory
		215	requirements). Default: C<8192>.
195		216
196	=item low_water_mark => <bytes>	217	=item low_water_mark => <bytes>
197		218
198	Sets the amount of bytes (default: C<0>) that make up an "empty" write	219	Sets the amount of bytes (default: C<0>) that make up an "empty" write
199	buffer: If the write reaches this size or gets even samller it is	220	buffer: If the write reaches this size or gets even samller it is
200	considered empty.	221	considered empty.
201		222
		223	Sometimes it can be beneficial (for performance reasons) to add data to
		224	the write buffer before it is fully drained, but this is a rare case, as
		225	the operating system kernel usually buffers data as well, so the default
		226	is good in almost all cases.
		227
202	=item linger => <seconds>	228	=item linger => <seconds>
203		229
204	If non-zero (default: C<3600>), then the destructor of the	230	If non-zero (default: C<3600>), then the destructor of the
205	AnyEvent::Handle object will check wether there is still outstanding write	231	AnyEvent::Handle object will check whether there is still outstanding
206	data and will install a watcher that will write out this data. No errors	232	write data and will install a watcher that will write this data to the
207	will be reported (this mostly matches how the operating system treats	233	socket. No errors will be reported (this mostly matches how the operating
208	outstanding data at socket close time).	234	system treats outstanding data at socket close time).
209		235
210	This will not work for partial TLS data that could not yet been	236	This will not work for partial TLS data that could not be encoded
211	encoded. This data will be lost.	237	yet. This data will be lost. Calling the C<stoptls> method in time might
		238	help.
212		239
213	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	240	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
214		241
215	When this parameter is given, it enables TLS (SSL) mode, that means it	242	When this parameter is given, it enables TLS (SSL) mode, that means
216	will start making tls handshake and will transparently encrypt/decrypt	243	AnyEvent will start a TLS handshake as soon as the conenction has been
217	data.	244	established and will transparently encrypt/decrypt data afterwards.
218		245
219	TLS mode requires Net::SSLeay to be installed (it will be loaded	246	TLS mode requires Net::SSLeay to be installed (it will be loaded
220	automatically when you try to create a TLS handle).	247	automatically when you try to create a TLS handle): this module doesn't
		248	have a dependency on that module, so if your module requires it, you have
		249	to add the dependency yourself.
221		250
222	For the TLS server side, use C<accept>, and for the TLS client side of a	251	Unlike TCP, TLS has a server and client side: for the TLS server side, use
223	connection, use C<connect> mode.	252	C<accept>, and for the TLS client side of a connection, use C<connect>
		253	mode.
224		254
225	You can also provide your own TLS connection object, but you have	255	You can also provide your own TLS connection object, but you have
226	to make sure that you call either C<Net::SSLeay::set_connect_state>	256	to make sure that you call either C<Net::SSLeay::set_connect_state>
227	or C<Net::SSLeay::set_accept_state> on it before you pass it to	257	or C<Net::SSLeay::set_accept_state> on it before you pass it to
228	AnyEvent::Handle.	258	AnyEvent::Handle.
229		259
		260	B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,
		261	passing in the wrong integer will lead to certain crash. This most often
		262	happens when one uses a stylish C<< tls => 1 >> and is surprised about the
		263	segmentation fault.
		264
230	See the C<starttls> method if you need to start TLS negotiation later.	265	See the C<< ->starttls >> method for when need to start TLS negotiation later.
231		266
232	=item tls_ctx => $ssl_ctx	267	=item tls_ctx => $ssl_ctx
233		268
234	Use the given Net::SSLeay::CTX object to create the new TLS connection	269	Use the given C<Net::SSLeay::CTX> object to create the new TLS connection
235	(unless a connection object was specified directly). If this parameter is	270	(unless a connection object was specified directly). If this parameter is
236	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	271	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
237		272
238	=item json => JSON or JSON::XS object	273	=item json => JSON or JSON::XS object
239		274
240	This is the json coder object used by the C<json> read and write types.	275	This is the json coder object used by the C<json> read and write types.
241		276
242	If you don't supply it, then AnyEvent::Handle will create and use a	277	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.	278	suitable one (on demand), which will write and expect UTF-8 encoded JSON
		279	texts.
244		280
245	Note that you are responsible to depend on the JSON module if you want to	281	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.	282	use this functionality, as AnyEvent does not have a dependency itself.
247		283
248	=item filter_r => $cb
249
250	=item filter_w => $cb
251
252	These exist, but are undocumented at this time.
253
254	=back	284	=back
255		285
256	=cut	286	=cut
257		287
258	sub new {	288	sub new {
…		…
262		292
263	$self->{fh} or Carp::croak "mandatory argument fh is missing";	293	$self->{fh} or Carp::croak "mandatory argument fh is missing";
264		294
265	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	295	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
266		296
267	if ($self->{tls}) {
268	require Net::SSLeay;
269	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});	297	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
270	}	298	if $self->{tls};
271		299
272	$self->{_activity} = AnyEvent->now;	300	$self->{_activity} = AnyEvent->now;
273	$self->_timeout;	301	$self->_timeout;
274		302
275	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};	303	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};
…		…
287	delete $self->{_tw};	315	delete $self->{_tw};
288	delete $self->{_rw};	316	delete $self->{_rw};
289	delete $self->{_ww};	317	delete $self->{_ww};
290	delete $self->{fh};	318	delete $self->{fh};
291		319
292	$self->stoptls;	320	&_freetls;
		321
		322	delete $self->{on_read};
		323	delete $self->{_queue};
293	}	324	}
294		325
295	sub _error {	326	sub _error {
296	my ($self, $errno, $fatal) = @_;	327	my ($self, $errno, $fatal) = @_;
297		328
…		…
300		331
301	$! = $errno;	332	$! = $errno;
302		333
303	if ($self->{on_error}) {	334	if ($self->{on_error}) {
304	$self->{on_error}($self, $fatal);	335	$self->{on_error}($self, $fatal);
305	} else {	336	} elsif ($self->{fh}) {
306	Carp::croak "AnyEvent::Handle uncaught error: $!";	337	Carp::croak "AnyEvent::Handle uncaught error: $!";
307	}	338	}
308	}	339	}
309		340
310	=item $fh = $handle->fh	341	=item $fh = $handle->fh
311		342
312	This method returns the file handle of the L<AnyEvent::Handle> object.	343	This method returns the file handle used to create the L<AnyEvent::Handle> object.
313		344
314	=cut	345	=cut
315		346
316	sub fh { $_[0]{fh} }	347	sub fh { $_[0]{fh} }
317		348
…		…
335	$_[0]{on_eof} = $_[1];	366	$_[0]{on_eof} = $_[1];
336	}	367	}
337		368
338	=item $handle->on_timeout ($cb)	369	=item $handle->on_timeout ($cb)
339		370
340	Replace the current C<on_timeout> callback, or disables the callback	371	Replace the current C<on_timeout> callback, or disables the callback (but
341	(but not the timeout) if C<$cb> = C<undef>. See C<timeout> constructor	372	not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
342	argument.	373	argument and method.
343		374
344	=cut	375	=cut
345		376
346	sub on_timeout {	377	sub on_timeout {
347	$_[0]{on_timeout} = $_[1];	378	$_[0]{on_timeout} = $_[1];
348	}	379	}
349		380
350	=item $handle->autocork ($boolean)	381	=item $handle->autocork ($boolean)
351		382
352	Enables or disables the current autocork behaviour (see C<autocork>	383	Enables or disables the current autocork behaviour (see C<autocork>
353	constructor argument).	384	constructor argument). Changes will only take effect on the next write.
354		385
355	=cut	386	=cut
		387
		388	sub autocork {
		389	$_[0]{autocork} = $_[1];
		390	}
356		391
357	=item $handle->no_delay ($boolean)	392	=item $handle->no_delay ($boolean)
358		393
359	Enables or disables the C<no_delay> setting (see constructor argument of	394	Enables or disables the C<no_delay> setting (see constructor argument of
360	the same name for details).	395	the same name for details).
…		…
453	my ($self, $cb) = @_;	488	my ($self, $cb) = @_;
454		489
455	$self->{on_drain} = $cb;	490	$self->{on_drain} = $cb;
456		491
457	$cb->($self)	492	$cb->($self)
458	if $cb && $self->{low_water_mark} >= length $self->{wbuf};	493	if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});
459	}	494	}
460		495
461	=item $handle->push_write ($data)	496	=item $handle->push_write ($data)
462		497
463	Queues the given scalar to be written. You can push as much data as you	498	Queues the given scalar to be written. You can push as much data as you
…		…
480	substr $self->{wbuf}, 0, $len, "";	515	substr $self->{wbuf}, 0, $len, "";
481		516
482	$self->{_activity} = AnyEvent->now;	517	$self->{_activity} = AnyEvent->now;
483		518
484	$self->{on_drain}($self)	519	$self->{on_drain}($self)
485	if $self->{low_water_mark} >= length $self->{wbuf}	520	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
486	&& $self->{on_drain};	521	&& $self->{on_drain};
487		522
488	delete $self->{_ww} unless length $self->{wbuf};	523	delete $self->{_ww} unless length $self->{wbuf};
489	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	524	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
490	$self->_error ($!, 1);	525	$self->_error ($!, 1);
…		…
514		549
515	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	550	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")
516	->($self, @_);	551	->($self, @_);
517	}	552	}
518		553
519	if ($self->{filter_w}) {	554	if ($self->{tls}) {
520	$self->{filter_w}($self, \$_[0]);	555	$self->{_tls_wbuf} .= $_[0];
		556
		557	&_dotls ($self);
521	} else {	558	} else {
522	$self->{wbuf} .= $_[0];	559	$self->{wbuf} .= $_[0];
523	$self->_drain_wbuf;	560	$self->_drain_wbuf;
524	}	561	}
525	}	562	}
…		…
542	=cut	579	=cut
543		580
544	register_write_type netstring => sub {	581	register_write_type netstring => sub {
545	my ($self, $string) = @_;	582	my ($self, $string) = @_;
546		583
547	sprintf "%d:%s,", (length $string), $string	584	(length $string) . ":$string,"
548	};	585	};
549		586
550	=item packstring => $format, $data	587	=item packstring => $format, $data
551		588
552	An octet string prefixed with an encoded length. The encoding C<$format>	589	An octet string prefixed with an encoded length. The encoding C<$format>
…		…
726		763
727	if (	764	if (
728	defined $self->{rbuf_max}	765	defined $self->{rbuf_max}
729	&& $self->{rbuf_max} < length $self->{rbuf}	766	&& $self->{rbuf_max} < length $self->{rbuf}
730	) {	767	) {
731	return $self->_error (&Errno::ENOSPC, 1);	768	$self->_error (&Errno::ENOSPC, 1), return;
732	}	769	}
733		770
734	while () {	771	while () {
735	no strict 'refs';
736
737	my $len = length $self->{rbuf};	772	my $len = length $self->{rbuf};
738		773
739	if (my $cb = shift @{ $self->{_queue} }) {	774	if (my $cb = shift @{ $self->{_queue} }) {
740	unless ($cb->($self)) {	775	unless ($cb->($self)) {
741	if ($self->{_eof}) {	776	if ($self->{_eof}) {
742	# no progress can be made (not enough data and no data forthcoming)	777	# no progress can be made (not enough data and no data forthcoming)
743	$self->_error (&Errno::EPIPE, 1), last;	778	$self->_error (&Errno::EPIPE, 1), return;
744	}	779	}
745		780
746	unshift @{ $self->{_queue} }, $cb;	781	unshift @{ $self->{_queue} }, $cb;
747	last;	782	last;
748	}	783	}
…		…
756	&& !@{ $self->{_queue} } # and the queue is still empty	791	&& !@{ $self->{_queue} } # and the queue is still empty
757	&& $self->{on_read} # but we still have on_read	792	&& $self->{on_read} # but we still have on_read
758	) {	793	) {
759	# no further data will arrive	794	# no further data will arrive
760	# so no progress can be made	795	# so no progress can be made
761	$self->_error (&Errno::EPIPE, 1), last	796	$self->_error (&Errno::EPIPE, 1), return
762	if $self->{_eof};	797	if $self->{_eof};
763		798
764	last; # more data might arrive	799	last; # more data might arrive
765	}	800	}
766	} else {	801	} else {
767	# read side becomes idle	802	# read side becomes idle
768	delete $self->{_rw};	803	delete $self->{_rw} unless $self->{tls};
769	last;	804	last;
770	}	805	}
771	}	806	}
772		807
		808	if ($self->{_eof}) {
		809	if ($self->{on_eof}) {
773	$self->{on_eof}($self)	810	$self->{on_eof}($self)
774	if $self->{_eof} && $self->{on_eof};	811	} else {
		812	$self->_error (0, 1);
		813	}
		814	}
775		815
776	# may need to restart read watcher	816	# may need to restart read watcher
777	unless ($self->{_rw}) {	817	unless ($self->{_rw}) {
778	$self->start_read	818	$self->start_read
779	if $self->{on_read} \|\| @{ $self->{_queue} };	819	if $self->{on_read} \|\| @{ $self->{_queue} };
…		…
905	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");	945	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");
906	1	946	1
907	}	947	}
908	};	948	};
909		949
910	# compatibility with older API
911	sub push_read_chunk {
912	$_[0]->push_read (chunk => $_[1], $_[2]);
913	}
914
915	sub unshift_read_chunk {
916	$_[0]->unshift_read (chunk => $_[1], $_[2]);
917	}
918
919	=item line => [$eol, ]$cb->($handle, $line, $eol)	950	=item line => [$eol, ]$cb->($handle, $line, $eol)
920		951
921	The callback will be called only once a full line (including the end of	952	The callback will be called only once a full line (including the end of
922	line marker, C<$eol>) has been read. This line (excluding the end of line	953	line marker, C<$eol>) has been read. This line (excluding the end of line
923	marker) will be passed to the callback as second argument (C<$line>), and	954	marker) will be passed to the callback as second argument (C<$line>), and
…		…
938	=cut	969	=cut
939		970
940	register_read_type line => sub {	971	register_read_type line => sub {
941	my ($self, $cb, $eol) = @_;	972	my ($self, $cb, $eol) = @_;
942		973
943	$eol = qr\|(\015?\012)\| if @_ < 3;	974	if (@_ < 3) {
		975	# this is more than twice as fast as the generic code below
		976	sub {
		977	$_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return;
		978
		979	$cb->($_[0], $1, $2);
		980	1
		981	}
		982	} else {
944	$eol = quotemeta $eol unless ref $eol;	983	$eol = quotemeta $eol unless ref $eol;
945	$eol = qr\|^(.*?)($eol)\|s;	984	$eol = qr\|^(.*?)($eol)\|s;
946		985
947	sub {	986	sub {
948	$_[0]{rbuf} =~ s/$eol// or return;	987	$_[0]{rbuf} =~ s/$eol// or return;
949		988
950	$cb->($_[0], $1, $2);	989	$cb->($_[0], $1, $2);
		990	1
951	1	991	}
952	}	992	}
953	};	993	};
954
955	# compatibility with older API
956	sub push_read_line {
957	my $self = shift;
958	$self->push_read (line => @_);
959	}
960
961	sub unshift_read_line {
962	my $self = shift;
963	$self->unshift_read (line => @_);
964	}
965		994
966	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)	995	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
967		996
968	Makes a regex match against the regex object C<$accept> and returns	997	Makes a regex match against the regex object C<$accept> and returns
969	everything up to and including the match.	998	everything up to and including the match.
…		…
1074	An octet string prefixed with an encoded length. The encoding C<$format>	1103	An octet string prefixed with an encoded length. The encoding C<$format>
1075	uses the same format as a Perl C<pack> format, but must specify a single	1104	uses the same format as a Perl C<pack> format, but must specify a single
1076	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an	1105	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
1077	optional C<!>, C<< < >> or C<< > >> modifier).	1106	optional C<!>, C<< < >> or C<< > >> modifier).
1078		1107
1079	DNS over TCP uses a prefix of C<n>, EPP uses a prefix of C<N>.	1108	For example, DNS over TCP uses a prefix of C<n> (2 octet network order),
		1109	EPP uses a prefix of C<N> (4 octtes).
1080		1110
1081	Example: read a block of data prefixed by its length in BER-encoded	1111	Example: read a block of data prefixed by its length in BER-encoded
1082	format (very efficient).	1112	format (very efficient).
1083		1113
1084	$handle->push_read (packstring => "w", sub {	1114	$handle->push_read (packstring => "w", sub {
…		…
1090	register_read_type packstring => sub {	1120	register_read_type packstring => sub {
1091	my ($self, $cb, $format) = @_;	1121	my ($self, $cb, $format) = @_;
1092		1122
1093	sub {	1123	sub {
1094	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method	1124	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
1095	defined (my $len = eval { unpack $format, $_[0]->{rbuf} })	1125	defined (my $len = eval { unpack $format, $_[0]{rbuf} })
1096	or return;	1126	or return;
1097		1127
		1128	$format = length pack $format, $len;
		1129
		1130	# bypass unshift if we already have the remaining chunk
		1131	if ($format + $len <= length $_[0]{rbuf}) {
		1132	my $data = substr $_[0]{rbuf}, $format, $len;
		1133	substr $_[0]{rbuf}, 0, $format + $len, "";
		1134	$cb->($_[0], $data);
		1135	} else {
1098	# remove prefix	1136	# remove prefix
1099	substr $_[0]->{rbuf}, 0, (length pack $format, $len), "";	1137	substr $_[0]{rbuf}, 0, $format, "";
1100		1138
1101	# read rest	1139	# read remaining chunk
1102	$_[0]->unshift_read (chunk => $len, $cb);	1140	$_[0]->unshift_read (chunk => $len, $cb);
		1141	}
1103		1142
1104	1	1143	1
1105	}	1144	}
1106	};	1145	};
1107		1146
1108	=item json => $cb->($handle, $hash_or_arrayref)	1147	=item json => $cb->($handle, $hash_or_arrayref)
1109		1148
1110	Reads a JSON object or array, decodes it and passes it to the callback.	1149	Reads a JSON object or array, decodes it and passes it to the
		1150	callback. When a parse error occurs, an C<EBADMSG> error will be raised.
1111		1151
1112	If a C<json> object was passed to the constructor, then that will be used	1152	If a C<json> object was passed to the constructor, then that will be used
1113	for the final decode, otherwise it will create a JSON coder expecting UTF-8.	1153	for the final decode, otherwise it will create a JSON coder expecting UTF-8.
1114		1154
1115	This read type uses the incremental parser available with JSON version	1155	This read type uses the incremental parser available with JSON version
…		…
1132	my $rbuf = \$self->{rbuf};	1172	my $rbuf = \$self->{rbuf};
1133		1173
1134	my $json = $self->{json} \|\|= JSON->new->utf8;	1174	my $json = $self->{json} \|\|= JSON->new->utf8;
1135		1175
1136	sub {	1176	sub {
		1177	eval {
1137	my $ref = $json->incr_parse ($self->{rbuf});	1178	my $ref = $json->incr_parse ($self->{rbuf});
1138		1179
1139	if ($ref) {	1180	if ($ref) {
		1181	$self->{rbuf} = $json->incr_text;
		1182	$json->incr_text = "";
		1183	$cb->($self, $ref);
		1184
		1185	1
		1186	} else {
		1187	$self->{rbuf} = "";
		1188	()
		1189	}
		1190
		1191	1
		1192	} or do {
		1193	# error case
		1194	$json->incr_skip;
		1195
1140	$self->{rbuf} = $json->incr_text;	1196	$self->{rbuf} = $json->incr_text;
1141	$json->incr_text = "";	1197	$json->incr_text = "";
1142	$cb->($self, $ref);
1143		1198
1144	1	1199	$self->_error (&Errno::EBADMSG);
1145	} else {
1146	$self->{rbuf} = "";
1147	()
1148	}	1200	};
1149	}	1201	}
1150	};	1202	};
1151		1203
1152	=item storable => $cb->($handle, $ref)	1204	=item storable => $cb->($handle, $ref)
1153		1205
…		…
1164		1216
1165	require Storable;	1217	require Storable;
1166		1218
1167	sub {	1219	sub {
1168	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method	1220	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
1169	defined (my $len = eval { unpack "w", $_[0]->{rbuf} })	1221	defined (my $len = eval { unpack "w", $_[0]{rbuf} })
1170	or return;	1222	or return;
1171		1223
		1224	my $format = length pack "w", $len;
		1225
		1226	# bypass unshift if we already have the remaining chunk
		1227	if ($format + $len <= length $_[0]{rbuf}) {
		1228	my $data = substr $_[0]{rbuf}, $format, $len;
		1229	substr $_[0]{rbuf}, 0, $format + $len, "";
		1230	$cb->($_[0], Storable::thaw ($data));
		1231	} else {
1172	# remove prefix	1232	# remove prefix
1173	substr $_[0]->{rbuf}, 0, (length pack "w", $len), "";	1233	substr $_[0]{rbuf}, 0, $format, "";
1174		1234
1175	# read rest	1235	# read remaining chunk
1176	$_[0]->unshift_read (chunk => $len, sub {	1236	$_[0]->unshift_read (chunk => $len, sub {
1177	if (my $ref = eval { Storable::thaw ($_[1]) }) {	1237	if (my $ref = eval { Storable::thaw ($_[1]) }) {
1178	$cb->($_[0], $ref);	1238	$cb->($_[0], $ref);
1179	} else {	1239	} else {
1180	$self->_error (&Errno::EBADMSG);	1240	$self->_error (&Errno::EBADMSG);
		1241	}
1181	}	1242	});
1182	});	1243	}
		1244
		1245	1
1183	}	1246	}
1184	};	1247	};
1185		1248
1186	=back	1249	=back
1187		1250
…		…
1217	Note that AnyEvent::Handle will automatically C<start_read> for you when	1280	Note that AnyEvent::Handle will automatically C<start_read> for you when
1218	you change the C<on_read> callback or push/unshift a read callback, and it	1281	you change the C<on_read> callback or push/unshift a read callback, and it
1219	will automatically C<stop_read> for you when neither C<on_read> is set nor	1282	will automatically C<stop_read> for you when neither C<on_read> is set nor
1220	there are any read requests in the queue.	1283	there are any read requests in the queue.
1221		1284
		1285	These methods will have no effect when in TLS mode (as TLS doesn't support
		1286	half-duplex connections).
		1287
1222	=cut	1288	=cut
1223		1289
1224	sub stop_read {	1290	sub stop_read {
1225	my ($self) = @_;	1291	my ($self) = @_;
1226		1292
1227	delete $self->{_rw};	1293	delete $self->{_rw} unless $self->{tls};
1228	}	1294	}
1229		1295
1230	sub start_read {	1296	sub start_read {
1231	my ($self) = @_;	1297	my ($self) = @_;
1232		1298
1233	unless ($self->{_rw} \|\| $self->{_eof}) {	1299	unless ($self->{_rw} \|\| $self->{_eof}) {
1234	Scalar::Util::weaken $self;	1300	Scalar::Util::weaken $self;
1235		1301
1236	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1302	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
1237	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1303	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1238	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;	1304	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;
1239		1305
1240	if ($len > 0) {	1306	if ($len > 0) {
1241	$self->{_activity} = AnyEvent->now;	1307	$self->{_activity} = AnyEvent->now;
1242		1308
1243	$self->{filter_r}	1309	if ($self->{tls}) {
1244	? $self->{filter_r}($self, $rbuf)	1310	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1245	: $self->{_in_drain} \|\| $self->_drain_rbuf;	1311
		1312	&_dotls ($self);
		1313	} else {
		1314	$self->_drain_rbuf unless $self->{_in_drain};
		1315	}
1246		1316
1247	} elsif (defined $len) {	1317	} elsif (defined $len) {
1248	delete $self->{_rw};	1318	delete $self->{_rw};
1249	$self->{_eof} = 1;	1319	$self->{_eof} = 1;
1250	$self->_drain_rbuf unless $self->{_in_drain};	1320	$self->_drain_rbuf unless $self->{_in_drain};
…		…
1254	}	1324	}
1255	});	1325	});
1256	}	1326	}
1257	}	1327	}
1258		1328
		1329	# poll the write BIO and send the data if applicable
1259	sub _dotls {	1330	sub _dotls {
1260	my ($self) = @_;	1331	my ($self) = @_;
1261		1332
1262	my $buf;	1333	my $tmp;
1263		1334
1264	if (length $self->{_tls_wbuf}) {	1335	if (length $self->{_tls_wbuf}) {
1265	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1336	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1266	substr $self->{_tls_wbuf}, 0, $len, "";	1337	substr $self->{_tls_wbuf}, 0, $tmp, "";
1267	}	1338	}
1268	}	1339	}
1269		1340
1270	if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1271	$self->{wbuf} .= $buf;
1272	$self->_drain_wbuf;
1273	}
1274
1275	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {	1341	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
1276	if (length $buf) {	1342	unless (length $tmp) {
1277	$self->{rbuf} .= $buf;
1278	$self->_drain_rbuf unless $self->{_in_drain};
1279	} else {
1280	# let's treat SSL-eof as we treat normal EOF	1343	# let's treat SSL-eof as we treat normal EOF
		1344	delete $self->{_rw};
1281	$self->{_eof} = 1;	1345	$self->{_eof} = 1;
1282	$self->_shutdown;	1346	&_freetls;
1283	return;
1284	}	1347	}
1285	}
1286		1348
		1349	$self->{rbuf} .= $tmp;
		1350	$self->_drain_rbuf unless $self->{_in_drain};
		1351	$self->{tls} or return; # tls session might have gone away in callback
		1352	}
		1353
1287	my $err = Net::SSLeay::get_error ($self->{tls}, -1);	1354	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1288		1355
1289	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {	1356	if ($tmp != Net::SSLeay::ERROR_WANT_READ ()) {
1290	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {	1357	if ($tmp == Net::SSLeay::ERROR_SYSCALL ()) {
1291	return $self->_error ($!, 1);	1358	return $self->_error ($!, 1);
1292	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {	1359	} elsif ($tmp == Net::SSLeay::ERROR_SSL ()) {
1293	return $self->_error (&Errno::EIO, 1);	1360	return $self->_error (&Errno::EIO, 1);
1294	}	1361	}
1295		1362
1296	# all others are fine for our purposes	1363	# all other errors are fine for our purposes
		1364	}
		1365
		1366	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
		1367	$self->{wbuf} .= $tmp;
		1368	$self->_drain_wbuf;
1297	}	1369	}
1298	}	1370	}
1299		1371
1300	=item $handle->starttls ($tls[, $tls_ctx])	1372	=item $handle->starttls ($tls[, $tls_ctx])
1301		1373
…		…
1311		1383
1312	The TLS connection object will end up in C<< $handle->{tls} >> after this	1384	The TLS connection object will end up in C<< $handle->{tls} >> after this
1313	call and can be used or changed to your liking. Note that the handshake	1385	call and can be used or changed to your liking. Note that the handshake
1314	might have already started when this function returns.	1386	might have already started when this function returns.
1315		1387
		1388	If it an error to start a TLS handshake more than once per
		1389	AnyEvent::Handle object (this is due to bugs in OpenSSL).
		1390
1316	=cut	1391	=cut
1317		1392
1318	sub starttls {	1393	sub starttls {
1319	my ($self, $ssl, $ctx) = @_;	1394	my ($self, $ssl, $ctx) = @_;
1320		1395
1321	$self->stoptls;	1396	require Net::SSLeay;
1322		1397
		1398	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"
		1399	if $self->{tls};
		1400
1323	if ($ssl eq "accept") {	1401	if ($ssl eq "accept") {
1324	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1402	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());
1325	Net::SSLeay::set_accept_state ($ssl);	1403	Net::SSLeay::set_accept_state ($ssl);
1326	} elsif ($ssl eq "connect") {	1404	} elsif ($ssl eq "connect") {
1327	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1405	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());
…		…
1333	# basically, this is deep magic (because SSL_read should have the same issues)	1411	# basically, this is deep magic (because SSL_read should have the same issues)
1334	# but the openssl maintainers basically said: "trust us, it just works".	1412	# but the openssl maintainers basically said: "trust us, it just works".
1335	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1413	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1336	# and mismaintained ssleay-module doesn't even offer them).	1414	# and mismaintained ssleay-module doesn't even offer them).
1337	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html	1415	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
		1416	#
		1417	# in short: this is a mess.
		1418	#
		1419	# note that we do not try to keep the length constant between writes as we are required to do.
		1420	# we assume that most (but not all) of this insanity only applies to non-blocking cases,
		1421	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
		1422	# have identity issues in that area.
1338	Net::SSLeay::CTX_set_mode ($self->{tls},	1423	Net::SSLeay::CTX_set_mode ($self->{tls},
1339	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1424	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
1340	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));	1425	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
1341		1426
1342	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1427	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1343	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1428	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1344		1429
1345	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1430	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
1346		1431
1347	$self->{filter_w} = sub {	1432	&_dotls; # need to trigger the initial handshake
1348	$_[0]{_tls_wbuf} .= ${$_[1]};	1433	$self->start_read; # make sure we actually do read
1349	&_dotls;
1350	};
1351	$self->{filter_r} = sub {
1352	Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});
1353	&_dotls;
1354	};
1355	}	1434	}
1356		1435
1357	=item $handle->stoptls	1436	=item $handle->stoptls
1358		1437
1359	Destroys the SSL connection, if any. Partial read or write data will be	1438	Shuts down the SSL connection - this makes a proper EOF handshake by
1360	lost.	1439	sending a close notify to the other side, but since OpenSSL doesn't
		1440	support non-blocking shut downs, it is not possible to re-use the stream
		1441	afterwards.
1361		1442
1362	=cut	1443	=cut
1363		1444
1364	sub stoptls {	1445	sub stoptls {
1365	my ($self) = @_;	1446	my ($self) = @_;
1366		1447
		1448	if ($self->{tls}) {
		1449	Net::SSLeay::shutdown ($self->{tls});
		1450
		1451	&_dotls;
		1452
		1453	# we don't give a shit. no, we do, but we can't. no...
		1454	# we, we... have to use openssl :/
		1455	&_freetls;
		1456	}
		1457	}
		1458
		1459	sub _freetls {
		1460	my ($self) = @_;
		1461
		1462	return unless $self->{tls};
		1463
1367	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};	1464	Net::SSLeay::free (delete $self->{tls});
1368		1465
1369	delete $self->{_rbio};	1466	delete @$self{qw(_rbio _wbio _tls_wbuf)};
1370	delete $self->{_wbio};
1371	delete $self->{_tls_wbuf};
1372	delete $self->{filter_r};
1373	delete $self->{filter_w};
1374	}	1467	}
1375		1468
1376	sub DESTROY {	1469	sub DESTROY {
1377	my $self = shift;	1470	my $self = shift;
1378		1471
1379	$self->stoptls;	1472	&_freetls;
1380		1473
1381	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	1474	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1382		1475
1383	if ($linger && length $self->{wbuf}) {	1476	if ($linger && length $self->{wbuf}) {
1384	my $fh = delete $self->{fh};	1477	my $fh = delete $self->{fh};
…		…
1399	@linger = ();	1492	@linger = ();
1400	});	1493	});
1401	}	1494	}
1402	}	1495	}
1403		1496
		1497	=item $handle->destroy
		1498
		1499	Shuts down the handle object as much as possible - this call ensures that
		1500	no further callbacks will be invoked and resources will be freed as much
		1501	as possible. You must not call any methods on the object afterwards.
		1502
		1503	Normally, you can just "forget" any references to an AnyEvent::Handle
		1504	object and it will simply shut down. This works in fatal error and EOF
		1505	callbacks, as well as code outside. It does I<NOT> work in a read or write
		1506	callback, so when you want to destroy the AnyEvent::Handle object from
		1507	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
		1508	that case.
		1509
		1510	The handle might still linger in the background and write out remaining
		1511	data, as specified by the C<linger> option, however.
		1512
		1513	=cut
		1514
		1515	sub destroy {
		1516	my ($self) = @_;
		1517
		1518	$self->DESTROY;
		1519	%$self = ();
		1520	}
		1521
1404	=item AnyEvent::Handle::TLS_CTX	1522	=item AnyEvent::Handle::TLS_CTX
1405		1523
1406	This function creates and returns the Net::SSLeay::CTX object used by	1524	This function creates and returns the Net::SSLeay::CTX object used by
1407	default for TLS mode.	1525	default for TLS mode.
1408		1526
…		…
1436	}	1554	}
1437	}	1555	}
1438		1556
1439	=back	1557	=back
1440		1558
		1559
		1560	=head1 NONFREQUENTLY ASKED QUESTIONS
		1561
		1562	=over 4
		1563
		1564	=item I C<undef> the AnyEvent::Handle reference inside my callback and
		1565	still get further invocations!
		1566
		1567	That's because AnyEvent::Handle keeps a reference to itself when handling
		1568	read or write callbacks.
		1569
		1570	It is only safe to "forget" the reference inside EOF or error callbacks,
		1571	from within all other callbacks, you need to explicitly call the C<<
		1572	->destroy >> method.
		1573
		1574	=item I get different callback invocations in TLS mode/Why can't I pause
		1575	reading?
		1576
		1577	Unlike, say, TCP, TLS connections do not consist of two independent
		1578	communication channels, one for each direction. Or put differently. The
		1579	read and write directions are not independent of each other: you cannot
		1580	write data unless you are also prepared to read, and vice versa.
		1581
		1582	This can mean than, in TLS mode, you might get C<on_error> or C<on_eof>
		1583	callback invocations when you are not expecting any read data - the reason
		1584	is that AnyEvent::Handle always reads in TLS mode.
		1585
		1586	During the connection, you have to make sure that you always have a
		1587	non-empty read-queue, or an C<on_read> watcher. At the end of the
		1588	connection (or when you no longer want to use it) you can call the
		1589	C<destroy> method.
		1590
		1591	=item How do I read data until the other side closes the connection?
		1592
		1593	If you just want to read your data into a perl scalar, the easiest way
		1594	to achieve this is by setting an C<on_read> callback that does nothing,
		1595	clearing the C<on_eof> callback and in the C<on_error> callback, the data
		1596	will be in C<$_[0]{rbuf}>:
		1597
		1598	$handle->on_read (sub { });
		1599	$handle->on_eof (undef);
		1600	$handle->on_error (sub {
		1601	my $data = delete $_[0]{rbuf};
		1602	undef $handle;
		1603	});
		1604
		1605	The reason to use C<on_error> is that TCP connections, due to latencies
		1606	and packets loss, might get closed quite violently with an error, when in
		1607	fact, all data has been received.
		1608
		1609	It is usually better to use acknowledgements when transferring data,
		1610	to make sure the other side hasn't just died and you got the data
		1611	intact. This is also one reason why so many internet protocols have an
		1612	explicit QUIT command.
		1613
		1614	=item I don't want to destroy the handle too early - how do I wait until
		1615	all data has been written?
		1616
		1617	After writing your last bits of data, set the C<on_drain> callback
		1618	and destroy the handle in there - with the default setting of
		1619	C<low_water_mark> this will be called precisely when all data has been
		1620	written to the socket:
		1621
		1622	$handle->push_write (...);
		1623	$handle->on_drain (sub {
		1624	warn "all data submitted to the kernel\n";
		1625	undef $handle;
		1626	});
		1627
		1628	=back
		1629
		1630
1441	=head1 SUBCLASSING AnyEvent::Handle	1631	=head1 SUBCLASSING AnyEvent::Handle
1442		1632
1443	In many cases, you might want to subclass AnyEvent::Handle.	1633	In many cases, you might want to subclass AnyEvent::Handle.
1444		1634
1445	To make this easier, a given version of AnyEvent::Handle uses these	1635	To make this easier, a given version of AnyEvent::Handle uses these

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.75 by root, Fri Jul 18 02:14:44 2008 UTC vs. Revision 1.112 by root, Wed Jan 21 06:01:35 2009 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.75 by root, Fri Jul 18 02:14:44 2008 UTC vs.
Revision 1.112 by root, Wed Jan 21 06:01:35 2009 UTC