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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.88 by root, Thu Aug 21 23:48:35 2008 UTC vs.
Revision 1.109 by root, Wed Jan 14 02:03:43 2009 UTC

…		…
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.233;	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");
…		…
84	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,
85	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
86	connection cleanly.	86	connection cleanly.
87		87
88	For sockets, this just means that the other side has stopped sending data,	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	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	90	callback and continue writing data, as only the read part has been shut
91	down.	91	down.
92		92
93	While not mandatory, it is I<highly> recommended to set an eof callback,	93	While not mandatory, it is I<highly> recommended to set an EOF callback,
94	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
95	waiting for data.	95	waiting for data.
96		96
97	If an EOF condition has been detected but no C<on_eof> callback has been	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>.	98	set, then a fatal error will be raised with C<$!> set to <0>.
…		…
232	write data and will install a watcher that will write this data to the	232	write data and will install a watcher that will write this data to the
233	socket. No errors will be reported (this mostly matches how the operating	233	socket. No errors will be reported (this mostly matches how the operating
234	system treats outstanding data at socket close time).	234	system treats outstanding data at socket close time).
235		235
236	This will not work for partial TLS data that could not be encoded	236	This will not work for partial TLS data that could not be encoded
237	yet. This data will be lost.	237	yet. This data will be lost. Calling the C<stoptls> method in time might
		238	help.
238		239
239	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	240	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
240		241
241	When this parameter is given, it enables TLS (SSL) mode, that means	242	When this parameter is given, it enables TLS (SSL) mode, that means
242	AnyEvent will start a TLS handshake as soon as the conenction has been	243	AnyEvent will start a TLS handshake as soon as the conenction has been
…		…
254	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
255	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>
256	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
257	AnyEvent::Handle.	258	AnyEvent::Handle.
258		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
259	See the C<< ->starttls >> method for when need to start TLS negotiation later.	265	See the C<< ->starttls >> method for when need to start TLS negotiation later.
260		266
261	=item tls_ctx => $ssl_ctx	267	=item tls_ctx => $ssl_ctx
262		268
263	Use the given C<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
…		…
273	texts.	279	texts.
274		280
275	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
276	use this functionality, as AnyEvent does not have a dependency itself.	282	use this functionality, as AnyEvent does not have a dependency itself.
277		283
278	=item filter_r => $cb
279
280	=item filter_w => $cb
281
282	These exist, but are undocumented at this time. (They are used internally
283	by the TLS code).
284
285	=back	284	=back
286		285
287	=cut	286	=cut
288		287
289	sub new {	288	sub new {
…		…
293		292
294	$self->{fh} or Carp::croak "mandatory argument fh is missing";	293	$self->{fh} or Carp::croak "mandatory argument fh is missing";
295		294
296	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	295	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
297		296
298	if ($self->{tls}) {
299	require Net::SSLeay;
300	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});	297	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
301	}	298	if $self->{tls};
302		299
303	$self->{_activity} = AnyEvent->now;	300	$self->{_activity} = AnyEvent->now;
304	$self->_timeout;	301	$self->_timeout;
305		302
306	$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};
…		…
318	delete $self->{_tw};	315	delete $self->{_tw};
319	delete $self->{_rw};	316	delete $self->{_rw};
320	delete $self->{_ww};	317	delete $self->{_ww};
321	delete $self->{fh};	318	delete $self->{fh};
322		319
323	$self->stoptls;	320	&_freetls;
324		321
325	delete $self->{on_read};	322	delete $self->{on_read};
326	delete $self->{_queue};	323	delete $self->{_queue};
327	}	324	}
328		325
…		…
334		331
335	$! = $errno;	332	$! = $errno;
336		333
337	if ($self->{on_error}) {	334	if ($self->{on_error}) {
338	$self->{on_error}($self, $fatal);	335	$self->{on_error}($self, $fatal);
339	} else {	336	} elsif ($self->{fh}) {
340	Carp::croak "AnyEvent::Handle uncaught error: $!";	337	Carp::croak "AnyEvent::Handle uncaught error: $!";
341	}	338	}
342	}	339	}
343		340
344	=item $fh = $handle->fh	341	=item $fh = $handle->fh
…		…
382	}	379	}
383		380
384	=item $handle->autocork ($boolean)	381	=item $handle->autocork ($boolean)
385		382
386	Enables or disables the current autocork behaviour (see C<autocork>	383	Enables or disables the current autocork behaviour (see C<autocork>
387	constructor argument).	384	constructor argument). Changes will only take effect on the next write.
388		385
389	=cut	386	=cut
		387
		388	sub autocork {
		389	$_[0]{autocork} = $_[1];
		390	}
390		391
391	=item $handle->no_delay ($boolean)	392	=item $handle->no_delay ($boolean)
392		393
393	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
394	the same name for details).	395	the same name for details).
…		…
487	my ($self, $cb) = @_;	488	my ($self, $cb) = @_;
488		489
489	$self->{on_drain} = $cb;	490	$self->{on_drain} = $cb;
490		491
491	$cb->($self)	492	$cb->($self)
492	if $cb && $self->{low_water_mark} >= length $self->{wbuf};	493	if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});
493	}	494	}
494		495
495	=item $handle->push_write ($data)	496	=item $handle->push_write ($data)
496		497
497	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
…		…
514	substr $self->{wbuf}, 0, $len, "";	515	substr $self->{wbuf}, 0, $len, "";
515		516
516	$self->{_activity} = AnyEvent->now;	517	$self->{_activity} = AnyEvent->now;
517		518
518	$self->{on_drain}($self)	519	$self->{on_drain}($self)
519	if $self->{low_water_mark} >= length $self->{wbuf}	520	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
520	&& $self->{on_drain};	521	&& $self->{on_drain};
521		522
522	delete $self->{_ww} unless length $self->{wbuf};	523	delete $self->{_ww} unless length $self->{wbuf};
523	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	524	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
524	$self->_error ($!, 1);	525	$self->_error ($!, 1);
…		…
548		549
549	@_ = ($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")
550	->($self, @_);	551	->($self, @_);
551	}	552	}
552		553
553	if ($self->{filter_w}) {	554	if ($self->{tls}) {
554	$self->{filter_w}($self, \$_[0]);	555	$self->{_tls_wbuf} .= $_[0];
		556
		557	&_dotls ($self);
555	} else {	558	} else {
556	$self->{wbuf} .= $_[0];	559	$self->{wbuf} .= $_[0];
557	$self->_drain_wbuf;	560	$self->_drain_wbuf;
558	}	561	}
559	}	562	}
…		…
576	=cut	579	=cut
577		580
578	register_write_type netstring => sub {	581	register_write_type netstring => sub {
579	my ($self, $string) = @_;	582	my ($self, $string) = @_;
580		583
581	sprintf "%d:%s,", (length $string), $string	584	(length $string) . ":$string,"
582	};	585	};
583		586
584	=item packstring => $format, $data	587	=item packstring => $format, $data
585		588
586	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>
…		…
795		798
796	last; # more data might arrive	799	last; # more data might arrive
797	}	800	}
798	} else {	801	} else {
799	# read side becomes idle	802	# read side becomes idle
800	delete $self->{_rw};	803	delete $self->{_rw} unless $self->{tls};
801	last;	804	last;
802	}	805	}
803	}	806	}
804		807
805	if ($self->{_eof}) {	808	if ($self->{_eof}) {
…		…
1100	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>
1101	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
1102	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an	1105	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
1103	optional C<!>, C<< < >> or C<< > >> modifier).	1106	optional C<!>, C<< < >> or C<< > >> modifier).
1104		1107
1105	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).
1106		1110
1107	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
1108	format (very efficient).	1112	format (very efficient).
1109		1113
1110	$handle->push_read (packstring => "w", sub {	1114	$handle->push_read (packstring => "w", sub {
…		…
1263	Note that AnyEvent::Handle will automatically C<start_read> for you when	1267	Note that AnyEvent::Handle will automatically C<start_read> for you when
1264	you change the C<on_read> callback or push/unshift a read callback, and it	1268	you change the C<on_read> callback or push/unshift a read callback, and it
1265	will automatically C<stop_read> for you when neither C<on_read> is set nor	1269	will automatically C<stop_read> for you when neither C<on_read> is set nor
1266	there are any read requests in the queue.	1270	there are any read requests in the queue.
1267		1271
		1272	These methods will have no effect when in TLS mode (as TLS doesn't support
		1273	half-duplex connections).
		1274
1268	=cut	1275	=cut
1269		1276
1270	sub stop_read {	1277	sub stop_read {
1271	my ($self) = @_;	1278	my ($self) = @_;
1272		1279
1273	delete $self->{_rw};	1280	delete $self->{_rw} unless $self->{tls};
1274	}	1281	}
1275		1282
1276	sub start_read {	1283	sub start_read {
1277	my ($self) = @_;	1284	my ($self) = @_;
1278		1285
1279	unless ($self->{_rw} \|\| $self->{_eof}) {	1286	unless ($self->{_rw} \|\| $self->{_eof}) {
1280	Scalar::Util::weaken $self;	1287	Scalar::Util::weaken $self;
1281		1288
1282	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1289	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
1283	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1290	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1284	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;	1291	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;
1285		1292
1286	if ($len > 0) {	1293	if ($len > 0) {
1287	$self->{_activity} = AnyEvent->now;	1294	$self->{_activity} = AnyEvent->now;
1288		1295
1289	$self->{filter_r}	1296	if ($self->{tls}) {
1290	? $self->{filter_r}($self, $rbuf)	1297	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1291	: $self->{_in_drain} \|\| $self->_drain_rbuf;	1298
		1299	&_dotls ($self);
		1300	} else {
		1301	$self->_drain_rbuf unless $self->{_in_drain};
		1302	}
1292		1303
1293	} elsif (defined $len) {	1304	} elsif (defined $len) {
1294	delete $self->{_rw};	1305	delete $self->{_rw};
1295	$self->{_eof} = 1;	1306	$self->{_eof} = 1;
1296	$self->_drain_rbuf unless $self->{_in_drain};	1307	$self->_drain_rbuf unless $self->{_in_drain};
…		…
1300	}	1311	}
1301	});	1312	});
1302	}	1313	}
1303	}	1314	}
1304		1315
		1316	# poll the write BIO and send the data if applicable
1305	sub _dotls {	1317	sub _dotls {
1306	my ($self) = @_;	1318	my ($self) = @_;
1307		1319
1308	my $buf;	1320	my $tmp;
1309		1321
1310	if (length $self->{_tls_wbuf}) {	1322	if (length $self->{_tls_wbuf}) {
1311	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1323	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1312	substr $self->{_tls_wbuf}, 0, $len, "";	1324	substr $self->{_tls_wbuf}, 0, $tmp, "";
1313	}	1325	}
1314	}	1326	}
1315		1327
1316	if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1317	$self->{wbuf} .= $buf;
1318	$self->_drain_wbuf;
1319	}
1320
1321	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {	1328	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
1322	if (length $buf) {	1329	unless (length $tmp) {
1323	$self->{rbuf} .= $buf;
1324	$self->_drain_rbuf unless $self->{_in_drain};
1325	} else {
1326	# let's treat SSL-eof as we treat normal EOF	1330	# let's treat SSL-eof as we treat normal EOF
		1331	delete $self->{_rw};
1327	$self->{_eof} = 1;	1332	$self->{_eof} = 1;
1328	$self->_shutdown;	1333	&_freetls;
1329	return;
1330	}	1334	}
1331	}
1332		1335
		1336	$self->{rbuf} .= $tmp;
		1337	$self->_drain_rbuf unless $self->{_in_drain};
		1338	$self->{tls} or return; # tls session might have gone away in callback
		1339	}
		1340
1333	my $err = Net::SSLeay::get_error ($self->{tls}, -1);	1341	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1334		1342
1335	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {	1343	if ($tmp != Net::SSLeay::ERROR_WANT_READ ()) {
1336	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {	1344	if ($tmp == Net::SSLeay::ERROR_SYSCALL ()) {
1337	return $self->_error ($!, 1);	1345	return $self->_error ($!, 1);
1338	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {	1346	} elsif ($tmp == Net::SSLeay::ERROR_SSL ()) {
1339	return $self->_error (&Errno::EIO, 1);	1347	return $self->_error (&Errno::EIO, 1);
1340	}	1348	}
1341		1349
1342	# all others are fine for our purposes	1350	# all other errors are fine for our purposes
		1351	}
		1352
		1353	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
		1354	$self->{wbuf} .= $tmp;
		1355	$self->_drain_wbuf;
1343	}	1356	}
1344	}	1357	}
1345		1358
1346	=item $handle->starttls ($tls[, $tls_ctx])	1359	=item $handle->starttls ($tls[, $tls_ctx])
1347		1360
…		…
1357		1370
1358	The TLS connection object will end up in C<< $handle->{tls} >> after this	1371	The TLS connection object will end up in C<< $handle->{tls} >> after this
1359	call and can be used or changed to your liking. Note that the handshake	1372	call and can be used or changed to your liking. Note that the handshake
1360	might have already started when this function returns.	1373	might have already started when this function returns.
1361		1374
		1375	If it an error to start a TLS handshake more than once per
		1376	AnyEvent::Handle object (this is due to bugs in OpenSSL).
		1377
1362	=cut	1378	=cut
1363		1379
1364	sub starttls {	1380	sub starttls {
1365	my ($self, $ssl, $ctx) = @_;	1381	my ($self, $ssl, $ctx) = @_;
1366		1382
1367	$self->stoptls;	1383	require Net::SSLeay;
1368		1384
		1385	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"
		1386	if $self->{tls};
		1387
1369	if ($ssl eq "accept") {	1388	if ($ssl eq "accept") {
1370	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1389	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());
1371	Net::SSLeay::set_accept_state ($ssl);	1390	Net::SSLeay::set_accept_state ($ssl);
1372	} elsif ($ssl eq "connect") {	1391	} elsif ($ssl eq "connect") {
1373	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1392	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());
…		…
1382	# and mismaintained ssleay-module doesn't even offer them).	1401	# and mismaintained ssleay-module doesn't even offer them).
1383	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html	1402	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
1384	#	1403	#
1385	# in short: this is a mess.	1404	# in short: this is a mess.
1386	#	1405	#
1387	# note that we do not try to kepe the length constant between writes as we are required to do.	1406	# note that we do not try to keep the length constant between writes as we are required to do.
1388	# we assume that most (but not all) of this insanity only applies to non-blocking cases,	1407	# we assume that most (but not all) of this insanity only applies to non-blocking cases,
1389	# and we drive openssl fully in blocking mode here.	1408	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
		1409	# have identity issues in that area.
1390	Net::SSLeay::CTX_set_mode ($self->{tls},	1410	Net::SSLeay::CTX_set_mode ($self->{tls},
1391	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1411	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
1392	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));	1412	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
1393		1413
1394	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1414	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1395	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1415	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1396		1416
1397	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1417	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
1398		1418
1399	$self->{filter_w} = sub {	1419	&_dotls; # need to trigger the initial handshake
1400	$_[0]{_tls_wbuf} .= ${$_[1]};	1420	$self->start_read; # make sure we actually do read
1401	&_dotls;
1402	};
1403	$self->{filter_r} = sub {
1404	Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});
1405	&_dotls;
1406	};
1407	}	1421	}
1408		1422
1409	=item $handle->stoptls	1423	=item $handle->stoptls
1410		1424
1411	Destroys the SSL connection, if any. Partial read or write data will be	1425	Shuts down the SSL connection - this makes a proper EOF handshake by
1412	lost.	1426	sending a close notify to the other side, but since OpenSSL doesn't
		1427	support non-blocking shut downs, it is not possible to re-use the stream
		1428	afterwards.
1413		1429
1414	=cut	1430	=cut
1415		1431
1416	sub stoptls {	1432	sub stoptls {
1417	my ($self) = @_;	1433	my ($self) = @_;
1418		1434
		1435	if ($self->{tls}) {
		1436	Net::SSLeay::shutdown ($self->{tls});
		1437
		1438	&_dotls;
		1439
		1440	# we don't give a shit. no, we do, but we can't. no...
		1441	# we, we... have to use openssl :/
		1442	&_freetls;
		1443	}
		1444	}
		1445
		1446	sub _freetls {
		1447	my ($self) = @_;
		1448
		1449	return unless $self->{tls};
		1450
1419	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};	1451	Net::SSLeay::free (delete $self->{tls});
1420		1452
1421	delete $self->{_rbio};	1453	delete @$self{qw(_rbio _wbio _tls_wbuf)};
1422	delete $self->{_wbio};
1423	delete $self->{_tls_wbuf};
1424	delete $self->{filter_r};
1425	delete $self->{filter_w};
1426	}	1454	}
1427		1455
1428	sub DESTROY {	1456	sub DESTROY {
1429	my $self = shift;	1457	my $self = shift;
1430		1458
1431	$self->stoptls;	1459	&_freetls;
1432		1460
1433	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	1461	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1434		1462
1435	if ($linger && length $self->{wbuf}) {	1463	if ($linger && length $self->{wbuf}) {
1436	my $fh = delete $self->{fh};	1464	my $fh = delete $self->{fh};
…		…
1451	@linger = ();	1479	@linger = ();
1452	});	1480	});
1453	}	1481	}
1454	}	1482	}
1455		1483
		1484	=item $handle->destroy
		1485
		1486	Shuts down the handle object as much as possible - this call ensures that
		1487	no further callbacks will be invoked and resources will be freed as much
		1488	as possible. You must not call any methods on the object afterwards.
		1489
		1490	Normally, you can just "forget" any references to an AnyEvent::Handle
		1491	object and it will simply shut down. This works in fatal error and EOF
		1492	callbacks, as well as code outside. It does I<NOT> work in a read or write
		1493	callback, so when you want to destroy the AnyEvent::Handle object from
		1494	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
		1495	that case.
		1496
		1497	The handle might still linger in the background and write out remaining
		1498	data, as specified by the C<linger> option, however.
		1499
		1500	=cut
		1501
		1502	sub destroy {
		1503	my ($self) = @_;
		1504
		1505	$self->DESTROY;
		1506	%$self = ();
		1507	}
		1508
1456	=item AnyEvent::Handle::TLS_CTX	1509	=item AnyEvent::Handle::TLS_CTX
1457		1510
1458	This function creates and returns the Net::SSLeay::CTX object used by	1511	This function creates and returns the Net::SSLeay::CTX object used by
1459	default for TLS mode.	1512	default for TLS mode.
1460		1513
…		…
1488	}	1541	}
1489	}	1542	}
1490		1543
1491	=back	1544	=back
1492		1545
		1546
		1547	=head1 NONFREQUENTLY ASKED QUESTIONS
		1548
		1549	=over 4
		1550
		1551	=item I C<undef> the AnyEvent::Handle reference inside my callback and
		1552	still get further invocations!
		1553
		1554	That's because AnyEvent::Handle keeps a reference to itself when handling
		1555	read or write callbacks.
		1556
		1557	It is only safe to "forget" the reference inside EOF or error callbacks,
		1558	from within all other callbacks, you need to explicitly call the C<<
		1559	->destroy >> method.
		1560
		1561	=item I get different callback invocations in TLS mode/Why can't I pause
		1562	reading?
		1563
		1564	Unlike, say, TCP, TLS connections do not consist of two independent
		1565	communication channels, one for each direction. Or put differently. The
		1566	read and write directions are not independent of each other: you cannot
		1567	write data unless you are also prepared to read, and vice versa.
		1568
		1569	This can mean than, in TLS mode, you might get C<on_error> or C<on_eof>
		1570	callback invocations when you are not expecting any read data - the reason
		1571	is that AnyEvent::Handle always reads in TLS mode.
		1572
		1573	During the connection, you have to make sure that you always have a
		1574	non-empty read-queue, or an C<on_read> watcher. At the end of the
		1575	connection (or when you no longer want to use it) you can call the
		1576	C<destroy> method.
		1577
		1578	=item How do I read data until the other side closes the connection?
		1579
		1580	If you just want to read your data into a perl scalar, the easiest way
		1581	to achieve this is by setting an C<on_read> callback that does nothing,
		1582	clearing the C<on_eof> callback and in the C<on_error> callback, the data
		1583	will be in C<$_[0]{rbuf}>:
		1584
		1585	$handle->on_read (sub { });
		1586	$handle->on_eof (undef);
		1587	$handle->on_error (sub {
		1588	my $data = delete $_[0]{rbuf};
		1589	undef $handle;
		1590	});
		1591
		1592	The reason to use C<on_error> is that TCP connections, due to latencies
		1593	and packets loss, might get closed quite violently with an error, when in
		1594	fact, all data has been received.
		1595
		1596	It is usually better to use acknowledgements when transferring data,
		1597	to make sure the other side hasn't just died and you got the data
		1598	intact. This is also one reason why so many internet protocols have an
		1599	explicit QUIT command.
		1600
		1601	=item I don't want to destroy the handle too early - how do I wait until
		1602	all data has been written?
		1603
		1604	After writing your last bits of data, set the C<on_drain> callback
		1605	and destroy the handle in there - with the default setting of
		1606	C<low_water_mark> this will be called precisely when all data has been
		1607	written to the socket:
		1608
		1609	$handle->push_write (...);
		1610	$handle->on_drain (sub {
		1611	warn "all data submitted to the kernel\n";
		1612	undef $handle;
		1613	});
		1614
		1615	=back
		1616
		1617
1493	=head1 SUBCLASSING AnyEvent::Handle	1618	=head1 SUBCLASSING AnyEvent::Handle
1494		1619
1495	In many cases, you might want to subclass AnyEvent::Handle.	1620	In many cases, you might want to subclass AnyEvent::Handle.
1496		1621
1497	To make this easier, a given version of AnyEvent::Handle uses these	1622	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.88 by root, Thu Aug 21 23:48:35 2008 UTC vs. Revision 1.109 by root, Wed Jan 14 02:03:43 2009 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.88 by root, Thu Aug 21 23:48:35 2008 UTC vs.
Revision 1.109 by root, Wed Jan 14 02:03:43 2009 UTC