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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.92 by root, Wed Oct 1 08:52:06 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.3;	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");
…		…
59	treatment of characters applies to this module as well.	59	treatment of characters applies to this module as well.
60		60
61	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
62	argument.	62	argument.
63		63
64	=head2 SIGPIPE is not handled by this module
65
66	SIGPIPE is not handled by this module, so one of the practical
67	requirements of using it is to ignore SIGPIPE (C<$SIG{PIPE} =
68	'IGNORE'>). At least, this is highly recommend in a networked program: If
69	you use AnyEvent::Handle in a filter program (like sort), exiting on
70	SIGPIPE is probably the right thing to do.
71
72	=head1 METHODS	64	=head1 METHODS
73		65
74	=over 4	66	=over 4
75		67
76	=item B<new (%args)>	68	=item B<new (%args)>
…		…
92	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,
93	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
94	connection cleanly.	86	connection cleanly.
95		87
96	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,
97	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
98	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
99	down.	91	down.
100		92
101	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,
102	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
103	waiting for data.	95	waiting for data.
104		96
105	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
106	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>.
…		…
240	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
241	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
242	system treats outstanding data at socket close time).	234	system treats outstanding data at socket close time).
243		235
244	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
245	yet. This data will be lost.	237	yet. This data will be lost. Calling the C<stoptls> method in time might
		238	help.
246		239
247	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	240	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
248		241
249	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
250	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
…		…
262	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
263	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>
264	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
265	AnyEvent::Handle.	258	AnyEvent::Handle.
266		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
267	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.
268		266
269	=item tls_ctx => $ssl_ctx	267	=item tls_ctx => $ssl_ctx
270		268
271	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
…		…
281	texts.	279	texts.
282		280
283	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
284	use this functionality, as AnyEvent does not have a dependency itself.	282	use this functionality, as AnyEvent does not have a dependency itself.
285		283
286	=item filter_r => $cb
287
288	=item filter_w => $cb
289
290	These exist, but are undocumented at this time. (They are used internally
291	by the TLS code).
292
293	=back	284	=back
294		285
295	=cut	286	=cut
296		287
297	sub new {	288	sub new {
…		…
301		292
302	$self->{fh} or Carp::croak "mandatory argument fh is missing";	293	$self->{fh} or Carp::croak "mandatory argument fh is missing";
303		294
304	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	295	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
305		296
306	if ($self->{tls}) {
307	require Net::SSLeay;
308	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});	297	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
309	}	298	if $self->{tls};
310		299
311	$self->{_activity} = AnyEvent->now;	300	$self->{_activity} = AnyEvent->now;
312	$self->_timeout;	301	$self->_timeout;
313		302
314	$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};
…		…
342		331
343	$! = $errno;	332	$! = $errno;
344		333
345	if ($self->{on_error}) {	334	if ($self->{on_error}) {
346	$self->{on_error}($self, $fatal);	335	$self->{on_error}($self, $fatal);
347	} else {	336	} elsif ($self->{fh}) {
348	Carp::croak "AnyEvent::Handle uncaught error: $!";	337	Carp::croak "AnyEvent::Handle uncaught error: $!";
349	}	338	}
350	}	339	}
351		340
352	=item $fh = $handle->fh	341	=item $fh = $handle->fh
…		…
390	}	379	}
391		380
392	=item $handle->autocork ($boolean)	381	=item $handle->autocork ($boolean)
393		382
394	Enables or disables the current autocork behaviour (see C<autocork>	383	Enables or disables the current autocork behaviour (see C<autocork>
395	constructor argument).	384	constructor argument). Changes will only take effect on the next write.
396		385
397	=cut	386	=cut
		387
		388	sub autocork {
		389	$_[0]{autocork} = $_[1];
		390	}
398		391
399	=item $handle->no_delay ($boolean)	392	=item $handle->no_delay ($boolean)
400		393
401	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
402	the same name for details).	395	the same name for details).
…		…
495	my ($self, $cb) = @_;	488	my ($self, $cb) = @_;
496		489
497	$self->{on_drain} = $cb;	490	$self->{on_drain} = $cb;
498		491
499	$cb->($self)	492	$cb->($self)
500	if $cb && $self->{low_water_mark} >= length $self->{wbuf};	493	if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});
501	}	494	}
502		495
503	=item $handle->push_write ($data)	496	=item $handle->push_write ($data)
504		497
505	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
…		…
522	substr $self->{wbuf}, 0, $len, "";	515	substr $self->{wbuf}, 0, $len, "";
523		516
524	$self->{_activity} = AnyEvent->now;	517	$self->{_activity} = AnyEvent->now;
525		518
526	$self->{on_drain}($self)	519	$self->{on_drain}($self)
527	if $self->{low_water_mark} >= length $self->{wbuf}	520	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
528	&& $self->{on_drain};	521	&& $self->{on_drain};
529		522
530	delete $self->{_ww} unless length $self->{wbuf};	523	delete $self->{_ww} unless length $self->{wbuf};
531	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	524	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
532	$self->_error ($!, 1);	525	$self->_error ($!, 1);
…		…
556		549
557	@_ = ($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")
558	->($self, @_);	551	->($self, @_);
559	}	552	}
560		553
561	if ($self->{filter_w}) {	554	if ($self->{tls}) {
562	$self->{filter_w}($self, \$_[0]);	555	$self->{_tls_wbuf} .= $_[0];
		556
		557	&_dotls ($self);
563	} else {	558	} else {
564	$self->{wbuf} .= $_[0];	559	$self->{wbuf} .= $_[0];
565	$self->_drain_wbuf;	560	$self->_drain_wbuf;
566	}	561	}
567	}	562	}
…		…
584	=cut	579	=cut
585		580
586	register_write_type netstring => sub {	581	register_write_type netstring => sub {
587	my ($self, $string) = @_;	582	my ($self, $string) = @_;
588		583
589	sprintf "%d:%s,", (length $string), $string	584	(length $string) . ":$string,"
590	};	585	};
591		586
592	=item packstring => $format, $data	587	=item packstring => $format, $data
593		588
594	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>
…		…
803		798
804	last; # more data might arrive	799	last; # more data might arrive
805	}	800	}
806	} else {	801	} else {
807	# read side becomes idle	802	# read side becomes idle
808	delete $self->{_rw};	803	delete $self->{_rw} unless $self->{tls};
809	last;	804	last;
810	}	805	}
811	}	806	}
812		807
813	if ($self->{_eof}) {	808	if ($self->{_eof}) {
…		…
1108	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>
1109	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
1110	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an	1105	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
1111	optional C<!>, C<< < >> or C<< > >> modifier).	1106	optional C<!>, C<< < >> or C<< > >> modifier).
1112		1107
1113	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).
1114		1110
1115	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
1116	format (very efficient).	1112	format (very efficient).
1117		1113
1118	$handle->push_read (packstring => "w", sub {	1114	$handle->push_read (packstring => "w", sub {
…		…
1271	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
1272	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
1273	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
1274	there are any read requests in the queue.	1270	there are any read requests in the queue.
1275		1271
		1272	These methods will have no effect when in TLS mode (as TLS doesn't support
		1273	half-duplex connections).
		1274
1276	=cut	1275	=cut
1277		1276
1278	sub stop_read {	1277	sub stop_read {
1279	my ($self) = @_;	1278	my ($self) = @_;
1280		1279
1281	delete $self->{_rw};	1280	delete $self->{_rw} unless $self->{tls};
1282	}	1281	}
1283		1282
1284	sub start_read {	1283	sub start_read {
1285	my ($self) = @_;	1284	my ($self) = @_;
1286		1285
1287	unless ($self->{_rw} \|\| $self->{_eof}) {	1286	unless ($self->{_rw} \|\| $self->{_eof}) {
1288	Scalar::Util::weaken $self;	1287	Scalar::Util::weaken $self;
1289		1288
1290	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1289	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
1291	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1290	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1292	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;
1293		1292
1294	if ($len > 0) {	1293	if ($len > 0) {
1295	$self->{_activity} = AnyEvent->now;	1294	$self->{_activity} = AnyEvent->now;
1296		1295
1297	$self->{filter_r}	1296	if ($self->{tls}) {
1298	? $self->{filter_r}($self, $rbuf)	1297	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1299	: $self->{_in_drain} \|\| $self->_drain_rbuf;	1298
		1299	&_dotls ($self);
		1300	} else {
		1301	$self->_drain_rbuf unless $self->{_in_drain};
		1302	}
1300		1303
1301	} elsif (defined $len) {	1304	} elsif (defined $len) {
1302	delete $self->{_rw};	1305	delete $self->{_rw};
1303	$self->{_eof} = 1;	1306	$self->{_eof} = 1;
1304	$self->_drain_rbuf unless $self->{_in_drain};	1307	$self->_drain_rbuf unless $self->{_in_drain};
…		…
1308	}	1311	}
1309	});	1312	});
1310	}	1313	}
1311	}	1314	}
1312		1315
		1316	# poll the write BIO and send the data if applicable
1313	sub _dotls {	1317	sub _dotls {
1314	my ($self) = @_;	1318	my ($self) = @_;
1315		1319
1316	my $buf;	1320	my $tmp;
1317		1321
1318	if (length $self->{_tls_wbuf}) {	1322	if (length $self->{_tls_wbuf}) {
1319	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1323	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1320	substr $self->{_tls_wbuf}, 0, $len, "";	1324	substr $self->{_tls_wbuf}, 0, $tmp, "";
1321	}	1325	}
1322	}	1326	}
1323		1327
1324	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {	1328	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
1325	unless (length $buf) {	1329	unless (length $tmp) {
1326	# let's treat SSL-eof as we treat normal EOF	1330	# let's treat SSL-eof as we treat normal EOF
1327	delete $self->{_rw};	1331	delete $self->{_rw};
1328	$self->{_eof} = 1;	1332	$self->{_eof} = 1;
1329	&_freetls;	1333	&_freetls;
1330	}	1334	}
1331		1335
1332	$self->{rbuf} .= $buf;	1336	$self->{rbuf} .= $tmp;
1333	$self->_drain_rbuf unless $self->{_in_drain};	1337	$self->_drain_rbuf unless $self->{_in_drain};
1334	$self->{tls} or return; # tls session might have gone away in callback	1338	$self->{tls} or return; # tls session might have gone away in callback
1335	}	1339	}
1336		1340
1337	my $err = Net::SSLeay::get_error ($self->{tls}, -1);	1341	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1338		1342
1339	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {	1343	if ($tmp != Net::SSLeay::ERROR_WANT_READ ()) {
1340	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {	1344	if ($tmp == Net::SSLeay::ERROR_SYSCALL ()) {
1341	return $self->_error ($!, 1);	1345	return $self->_error ($!, 1);
1342	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {	1346	} elsif ($tmp == Net::SSLeay::ERROR_SSL ()) {
1343	return $self->_error (&Errno::EIO, 1);	1347	return $self->_error (&Errno::EIO, 1);
1344	}	1348	}
1345		1349
1346	# all others are fine for our purposes	1350	# all other errors are fine for our purposes
1347	}	1351	}
1348		1352
1349	if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1353	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1350	$self->{wbuf} .= $buf;	1354	$self->{wbuf} .= $tmp;
1351	$self->_drain_wbuf;	1355	$self->_drain_wbuf;
1352	}	1356	}
1353	}	1357	}
1354		1358
1355	=item $handle->starttls ($tls[, $tls_ctx])	1359	=item $handle->starttls ($tls[, $tls_ctx])
…		…
1374	=cut	1378	=cut
1375		1379
1376	sub starttls {	1380	sub starttls {
1377	my ($self, $ssl, $ctx) = @_;	1381	my ($self, $ssl, $ctx) = @_;
1378		1382
		1383	require Net::SSLeay;
		1384
1379	Carp::croak "it is an error to call starttls more than once on an Anyevent::Handle object"	1385	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"
1380	if $self->{tls};	1386	if $self->{tls};
1381		1387
1382	if ($ssl eq "accept") {	1388	if ($ssl eq "accept") {
1383	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1389	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());
1384	Net::SSLeay::set_accept_state ($ssl);	1390	Net::SSLeay::set_accept_state ($ssl);
…		…
1395	# and mismaintained ssleay-module doesn't even offer them).	1401	# and mismaintained ssleay-module doesn't even offer them).
1396	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html	1402	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
1397	#	1403	#
1398	# in short: this is a mess.	1404	# in short: this is a mess.
1399	#	1405	#
1400	# 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.
1401	# 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,
1402	# 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.
1403	Net::SSLeay::CTX_set_mode ($self->{tls},	1410	Net::SSLeay::CTX_set_mode ($self->{tls},
1404	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1411	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
1405	\| (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));
1406		1413
1407	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1414	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1408	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1415	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1409		1416
1410	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1417	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
1411		1418
1412	$self->{filter_w} = sub {
1413	$_[0]{_tls_wbuf} .= ${$_[1]};
1414	&_dotls;
1415	};
1416	$self->{filter_r} = sub {
1417	Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});
1418	&_dotls;
1419	};
1420
1421	&_dotls; # need to trigger the initial negotiation exchange	1419	&_dotls; # need to trigger the initial handshake
		1420	$self->start_read; # make sure we actually do read
1422	}	1421	}
1423		1422
1424	=item $handle->stoptls	1423	=item $handle->stoptls
1425		1424
1426	Shuts down the SSL connection - this makes a proper EOF handshake by	1425	Shuts down the SSL connection - this makes a proper EOF handshake by
…		…
1432		1431
1433	sub stoptls {	1432	sub stoptls {
1434	my ($self) = @_;	1433	my ($self) = @_;
1435		1434
1436	if ($self->{tls}) {	1435	if ($self->{tls}) {
1437	Net::SSLeay::shutdown $self->{tls};	1436	Net::SSLeay::shutdown ($self->{tls});
1438		1437
1439	&_dotls;	1438	&_dotls;
1440		1439
1441	# we don't give a shit. no, we do, but we can't. no...	1440	# we don't give a shit. no, we do, but we can't. no...
1442	# we, we... have to use openssl :/	1441	# we, we... have to use openssl :/
…		…
1449		1448
1450	return unless $self->{tls};	1449	return unless $self->{tls};
1451		1450
1452	Net::SSLeay::free (delete $self->{tls});	1451	Net::SSLeay::free (delete $self->{tls});
1453		1452
1454	delete @$self{qw(_rbio filter_w _wbio filter_r)};	1453	delete @$self{qw(_rbio _wbio _tls_wbuf)};
1455	}	1454	}
1456		1455
1457	sub DESTROY {	1456	sub DESTROY {
1458	my $self = shift;	1457	my $self = shift;
1459		1458
…		…
1480	@linger = ();	1479	@linger = ();
1481	});	1480	});
1482	}	1481	}
1483	}	1482	}
1484		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
1485	=item AnyEvent::Handle::TLS_CTX	1509	=item AnyEvent::Handle::TLS_CTX
1486		1510
1487	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
1488	default for TLS mode.	1512	default for TLS mode.
1489		1513
…		…
1517	}	1541	}
1518	}	1542	}
1519		1543
1520	=back	1544	=back
1521		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
1522	=head1 SUBCLASSING AnyEvent::Handle	1618	=head1 SUBCLASSING AnyEvent::Handle
1523		1619
1524	In many cases, you might want to subclass AnyEvent::Handle.	1620	In many cases, you might want to subclass AnyEvent::Handle.
1525		1621
1526	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.92 by root, Wed Oct 1 08:52:06 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.92 by root, Wed Oct 1 08:52:06 2008 UTC vs.
Revision 1.109 by root, Wed Jan 14 02:03:43 2009 UTC