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

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

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.74 by root, Fri Jul 18 01:29:58 2008 UTC vs.
Revision 1.130 by root, Mon Jun 29 21:00:32 2009 UTC