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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.90 by root, Mon Sep 29 02:08:57 2008 UTC vs.
Revision 1.115 by root, Tue Feb 10 13:58:49 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.234;	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};
…		…
326	delete $self->{_tw};	315	delete $self->{_tw};
327	delete $self->{_rw};	316	delete $self->{_rw};
328	delete $self->{_ww};	317	delete $self->{_ww};
329	delete $self->{fh};	318	delete $self->{fh};
330		319
331	$self->stoptls;	320	&_freetls;
332		321
333	delete $self->{on_read};	322	delete $self->{on_read};
334	delete $self->{_queue};	323	delete $self->{_queue};
335	}	324	}
336		325
…		…
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>
…		…
772	) {	767	) {
773	$self->_error (&Errno::ENOSPC, 1), return;	768	$self->_error (&Errno::ENOSPC, 1), return;
774	}	769	}
775		770
776	while () {	771	while () {
		772	$self->{rbuf} .= delete $self->{tls_rbuf} if exists $self->{tls_rbuf};#d#
		773
777	my $len = length $self->{rbuf};	774	my $len = length $self->{rbuf};
778		775
779	if (my $cb = shift @{ $self->{_queue} }) {	776	if (my $cb = shift @{ $self->{_queue} }) {
780	unless ($cb->($self)) {	777	unless ($cb->($self)) {
781	if ($self->{_eof}) {	778	if ($self->{_eof}) {
…		…
803		800
804	last; # more data might arrive	801	last; # more data might arrive
805	}	802	}
806	} else {	803	} else {
807	# read side becomes idle	804	# read side becomes idle
808	delete $self->{_rw};	805	delete $self->{_rw} unless $self->{tls};
809	last;	806	last;
810	}	807	}
811	}	808	}
812		809
813	if ($self->{_eof}) {	810	if ($self->{_eof}) {
…		…
1108	An octet string prefixed with an encoded length. The encoding C<$format>	1105	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	1106	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	1107	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
1111	optional C<!>, C<< < >> or C<< > >> modifier).	1108	optional C<!>, C<< < >> or C<< > >> modifier).
1112		1109
1113	DNS over TCP uses a prefix of C<n>, EPP uses a prefix of C<N>.	1110	For example, DNS over TCP uses a prefix of C<n> (2 octet network order),
		1111	EPP uses a prefix of C<N> (4 octtes).
1114		1112
1115	Example: read a block of data prefixed by its length in BER-encoded	1113	Example: read a block of data prefixed by its length in BER-encoded
1116	format (very efficient).	1114	format (very efficient).
1117		1115
1118	$handle->push_read (packstring => "w", sub {	1116	$handle->push_read (packstring => "w", sub {
…		…
1148	}	1146	}
1149	};	1147	};
1150		1148
1151	=item json => $cb->($handle, $hash_or_arrayref)	1149	=item json => $cb->($handle, $hash_or_arrayref)
1152		1150
1153	Reads a JSON object or array, decodes it and passes it to the callback.	1151	Reads a JSON object or array, decodes it and passes it to the
		1152	callback. When a parse error occurs, an C<EBADMSG> error will be raised.
1154		1153
1155	If a C<json> object was passed to the constructor, then that will be used	1154	If a C<json> object was passed to the constructor, then that will be used
1156	for the final decode, otherwise it will create a JSON coder expecting UTF-8.	1155	for the final decode, otherwise it will create a JSON coder expecting UTF-8.
1157		1156
1158	This read type uses the incremental parser available with JSON version	1157	This read type uses the incremental parser available with JSON version
…		…
1175	my $rbuf = \$self->{rbuf};	1174	my $rbuf = \$self->{rbuf};
1176		1175
1177	my $json = $self->{json} \|\|= JSON->new->utf8;	1176	my $json = $self->{json} \|\|= JSON->new->utf8;
1178		1177
1179	sub {	1178	sub {
1180	my $ref = $json->incr_parse ($self->{rbuf});	1179	my $ref = eval { $json->incr_parse ($self->{rbuf}) };
1181		1180
1182	if ($ref) {	1181	if ($ref) {
1183	$self->{rbuf} = $json->incr_text;	1182	$self->{rbuf} = $json->incr_text;
1184	$json->incr_text = "";	1183	$json->incr_text = "";
1185	$cb->($self, $ref);	1184	$cb->($self, $ref);
1186		1185
1187	1	1186	1
		1187	} elsif ($@) {
		1188	# error case
		1189	$json->incr_skip;
		1190
		1191	$self->{rbuf} = $json->incr_text;
		1192	$json->incr_text = "";
		1193
		1194	$self->_error (&Errno::EBADMSG);
		1195
		1196	()
1188	} else {	1197	} else {
1189	$self->{rbuf} = "";	1198	$self->{rbuf} = "";
		1199
1190	()	1200	()
1191	}	1201	}
1192	}	1202	}
1193	};	1203	};
1194		1204
…		…
1271	Note that AnyEvent::Handle will automatically C<start_read> for you when	1281	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	1282	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	1283	will automatically C<stop_read> for you when neither C<on_read> is set nor
1274	there are any read requests in the queue.	1284	there are any read requests in the queue.
1275		1285
		1286	These methods will have no effect when in TLS mode (as TLS doesn't support
		1287	half-duplex connections).
		1288
1276	=cut	1289	=cut
1277		1290
1278	sub stop_read {	1291	sub stop_read {
1279	my ($self) = @_;	1292	my ($self) = @_;
1280		1293
1281	delete $self->{_rw};	1294	delete $self->{_rw} unless $self->{tls};
1282	}	1295	}
1283		1296
1284	sub start_read {	1297	sub start_read {
1285	my ($self) = @_;	1298	my ($self) = @_;
1286		1299
1287	unless ($self->{_rw} \|\| $self->{_eof}) {	1300	unless ($self->{_rw} \|\| $self->{_eof}) {
1288	Scalar::Util::weaken $self;	1301	Scalar::Util::weaken $self;
1289		1302
1290	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1303	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
1291	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1304	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1292	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;	1305	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;
1293		1306
1294	if ($len > 0) {	1307	if ($len > 0) {
1295	$self->{_activity} = AnyEvent->now;	1308	$self->{_activity} = AnyEvent->now;
1296		1309
1297	$self->{filter_r}	1310	if ($self->{tls}) {
1298	? $self->{filter_r}($self, $rbuf)	1311	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1299	: $self->{_in_drain} \|\| $self->_drain_rbuf;	1312
		1313	&_dotls ($self);
		1314	} else {
		1315	$self->_drain_rbuf unless $self->{_in_drain};
		1316	}
1300		1317
1301	} elsif (defined $len) {	1318	} elsif (defined $len) {
1302	delete $self->{_rw};	1319	delete $self->{_rw};
1303	$self->{_eof} = 1;	1320	$self->{_eof} = 1;
1304	$self->_drain_rbuf unless $self->{_in_drain};	1321	$self->_drain_rbuf unless $self->{_in_drain};
…		…
1308	}	1325	}
1309	});	1326	});
1310	}	1327	}
1311	}	1328	}
1312		1329
		1330	# poll the write BIO and send the data if applicable
1313	sub _dotls {	1331	sub _dotls {
1314	my ($self) = @_;	1332	my ($self) = @_;
1315		1333
1316	my $buf;	1334	my $tmp;
1317		1335
1318	if (length $self->{_tls_wbuf}) {	1336	if (length $self->{_tls_wbuf}) {
1319	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1337	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1320	substr $self->{_tls_wbuf}, 0, $len, "";	1338	substr $self->{_tls_wbuf}, 0, $tmp, "";
1321	}	1339	}
1322	}	1340	}
1323		1341
1324	if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1325	$self->{wbuf} .= $buf;
1326	$self->_drain_wbuf;
1327	}
1328
1329	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {	1342	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
1330	if (length $buf) {	1343	unless (length $tmp) {
1331	$self->{rbuf} .= $buf;
1332	$self->_drain_rbuf unless $self->{_in_drain};
1333	} else {
1334	# let's treat SSL-eof as we treat normal EOF	1344	# let's treat SSL-eof as we treat normal EOF
		1345	delete $self->{_rw};
1335	$self->{_eof} = 1;	1346	$self->{_eof} = 1;
1336	$self->_shutdown;	1347	&_freetls;
1337	return;
1338	}	1348	}
1339	}
1340		1349
		1350	$self->{tls_rbuf} .= $tmp;#d#
		1351	$self->_drain_rbuf unless $self->{_in_drain};
		1352	$self->{tls} or return; # tls session might have gone away in callback
		1353	}
		1354
1341	my $err = Net::SSLeay::get_error ($self->{tls}, -1);	1355	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1342		1356
1343	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {	1357	if ($tmp != Net::SSLeay::ERROR_WANT_READ ()) {
1344	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {	1358	if ($tmp == Net::SSLeay::ERROR_SYSCALL ()) {
1345	return $self->_error ($!, 1);	1359	return $self->_error ($!, 1);
1346	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {	1360	} elsif ($tmp == Net::SSLeay::ERROR_SSL ()) {
1347	return $self->_error (&Errno::EIO, 1);	1361	return $self->_error (&Errno::EIO, 1);
1348	}	1362	}
1349		1363
1350	# all others are fine for our purposes	1364	# all other errors are fine for our purposes
		1365	}
		1366
		1367	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
		1368	$self->{wbuf} .= $tmp;
		1369	$self->_drain_wbuf;
1351	}	1370	}
1352	}	1371	}
1353		1372
1354	=item $handle->starttls ($tls[, $tls_ctx])	1373	=item $handle->starttls ($tls[, $tls_ctx])
1355		1374
…		…
1365		1384
1366	The TLS connection object will end up in C<< $handle->{tls} >> after this	1385	The TLS connection object will end up in C<< $handle->{tls} >> after this
1367	call and can be used or changed to your liking. Note that the handshake	1386	call and can be used or changed to your liking. Note that the handshake
1368	might have already started when this function returns.	1387	might have already started when this function returns.
1369		1388
		1389	If it an error to start a TLS handshake more than once per
		1390	AnyEvent::Handle object (this is due to bugs in OpenSSL).
		1391
1370	=cut	1392	=cut
1371		1393
1372	sub starttls {	1394	sub starttls {
1373	my ($self, $ssl, $ctx) = @_;	1395	my ($self, $ssl, $ctx) = @_;
1374		1396
1375	$self->stoptls;	1397	require Net::SSLeay;
1376		1398
		1399	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"
		1400	if $self->{tls};
		1401
1377	if ($ssl eq "accept") {	1402	if ($ssl eq "accept") {
1378	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1403	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());
1379	Net::SSLeay::set_accept_state ($ssl);	1404	Net::SSLeay::set_accept_state ($ssl);
1380	} elsif ($ssl eq "connect") {	1405	} elsif ($ssl eq "connect") {
1381	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1406	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());
…		…
1390	# and mismaintained ssleay-module doesn't even offer them).	1415	# and mismaintained ssleay-module doesn't even offer them).
1391	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html	1416	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
1392	#	1417	#
1393	# in short: this is a mess.	1418	# in short: this is a mess.
1394	#	1419	#
1395	# note that we do not try to kepe the length constant between writes as we are required to do.	1420	# note that we do not try to keep the length constant between writes as we are required to do.
1396	# we assume that most (but not all) of this insanity only applies to non-blocking cases,	1421	# we assume that most (but not all) of this insanity only applies to non-blocking cases,
1397	# and we drive openssl fully in blocking mode here.	1422	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
		1423	# have identity issues in that area.
1398	Net::SSLeay::CTX_set_mode ($self->{tls},	1424	Net::SSLeay::CTX_set_mode ($self->{tls},
1399	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1425	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
1400	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));	1426	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
1401		1427
1402	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1428	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1403	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1429	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1404		1430
1405	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1431	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
1406		1432
1407	$self->{filter_w} = sub {	1433	&_dotls; # need to trigger the initial handshake
1408	$_[0]{_tls_wbuf} .= ${$_[1]};	1434	$self->start_read; # make sure we actually do read
1409	&_dotls;
1410	};
1411	$self->{filter_r} = sub {
1412	Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});
1413	&_dotls;
1414	};
1415	}	1435	}
1416		1436
1417	=item $handle->stoptls	1437	=item $handle->stoptls
1418		1438
1419	Destroys the SSL connection, if any. Partial read or write data will be	1439	Shuts down the SSL connection - this makes a proper EOF handshake by
1420	lost.	1440	sending a close notify to the other side, but since OpenSSL doesn't
		1441	support non-blocking shut downs, it is not possible to re-use the stream
		1442	afterwards.
1421		1443
1422	=cut	1444	=cut
1423		1445
1424	sub stoptls {	1446	sub stoptls {
1425	my ($self) = @_;	1447	my ($self) = @_;
1426		1448
		1449	if ($self->{tls}) {
		1450	Net::SSLeay::shutdown ($self->{tls});
		1451
		1452	&_dotls;
		1453
		1454	# we don't give a shit. no, we do, but we can't. no...
		1455	# we, we... have to use openssl :/
		1456	&_freetls;
		1457	}
		1458	}
		1459
		1460	sub _freetls {
		1461	my ($self) = @_;
		1462
		1463	return unless $self->{tls};
		1464
1427	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};	1465	Net::SSLeay::free (delete $self->{tls});
1428		1466
1429	delete $self->{_rbio};	1467	delete @$self{qw(_rbio _wbio _tls_wbuf)};
1430	delete $self->{_wbio};
1431	delete $self->{_tls_wbuf};
1432	delete $self->{filter_r};
1433	delete $self->{filter_w};
1434	}	1468	}
1435		1469
1436	sub DESTROY {	1470	sub DESTROY {
1437	my $self = shift;	1471	my $self = shift;
1438		1472
1439	$self->stoptls;	1473	&_freetls;
1440		1474
1441	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	1475	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1442		1476
1443	if ($linger && length $self->{wbuf}) {	1477	if ($linger && length $self->{wbuf}) {
1444	my $fh = delete $self->{fh};	1478	my $fh = delete $self->{fh};
…		…
1459	@linger = ();	1493	@linger = ();
1460	});	1494	});
1461	}	1495	}
1462	}	1496	}
1463		1497
		1498	=item $handle->destroy
		1499
		1500	Shuts down the handle object as much as possible - this call ensures that
		1501	no further callbacks will be invoked and resources will be freed as much
		1502	as possible. You must not call any methods on the object afterwards.
		1503
		1504	Normally, you can just "forget" any references to an AnyEvent::Handle
		1505	object and it will simply shut down. This works in fatal error and EOF
		1506	callbacks, as well as code outside. It does I<NOT> work in a read or write
		1507	callback, so when you want to destroy the AnyEvent::Handle object from
		1508	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
		1509	that case.
		1510
		1511	The handle might still linger in the background and write out remaining
		1512	data, as specified by the C<linger> option, however.
		1513
		1514	=cut
		1515
		1516	sub destroy {
		1517	my ($self) = @_;
		1518
		1519	$self->DESTROY;
		1520	%$self = ();
		1521	}
		1522
1464	=item AnyEvent::Handle::TLS_CTX	1523	=item AnyEvent::Handle::TLS_CTX
1465		1524
1466	This function creates and returns the Net::SSLeay::CTX object used by	1525	This function creates and returns the Net::SSLeay::CTX object used by
1467	default for TLS mode.	1526	default for TLS mode.
1468		1527
…		…
1496	}	1555	}
1497	}	1556	}
1498		1557
1499	=back	1558	=back
1500		1559
		1560
		1561	=head1 NONFREQUENTLY ASKED QUESTIONS
		1562
		1563	=over 4
		1564
		1565	=item I C<undef> the AnyEvent::Handle reference inside my callback and
		1566	still get further invocations!
		1567
		1568	That's because AnyEvent::Handle keeps a reference to itself when handling
		1569	read or write callbacks.
		1570
		1571	It is only safe to "forget" the reference inside EOF or error callbacks,
		1572	from within all other callbacks, you need to explicitly call the C<<
		1573	->destroy >> method.
		1574
		1575	=item I get different callback invocations in TLS mode/Why can't I pause
		1576	reading?
		1577
		1578	Unlike, say, TCP, TLS connections do not consist of two independent
		1579	communication channels, one for each direction. Or put differently. The
		1580	read and write directions are not independent of each other: you cannot
		1581	write data unless you are also prepared to read, and vice versa.
		1582
		1583	This can mean than, in TLS mode, you might get C<on_error> or C<on_eof>
		1584	callback invocations when you are not expecting any read data - the reason
		1585	is that AnyEvent::Handle always reads in TLS mode.
		1586
		1587	During the connection, you have to make sure that you always have a
		1588	non-empty read-queue, or an C<on_read> watcher. At the end of the
		1589	connection (or when you no longer want to use it) you can call the
		1590	C<destroy> method.
		1591
		1592	=item How do I read data until the other side closes the connection?
		1593
		1594	If you just want to read your data into a perl scalar, the easiest way
		1595	to achieve this is by setting an C<on_read> callback that does nothing,
		1596	clearing the C<on_eof> callback and in the C<on_error> callback, the data
		1597	will be in C<$_[0]{rbuf}>:
		1598
		1599	$handle->on_read (sub { });
		1600	$handle->on_eof (undef);
		1601	$handle->on_error (sub {
		1602	my $data = delete $_[0]{rbuf};
		1603	undef $handle;
		1604	});
		1605
		1606	The reason to use C<on_error> is that TCP connections, due to latencies
		1607	and packets loss, might get closed quite violently with an error, when in
		1608	fact, all data has been received.
		1609
		1610	It is usually better to use acknowledgements when transferring data,
		1611	to make sure the other side hasn't just died and you got the data
		1612	intact. This is also one reason why so many internet protocols have an
		1613	explicit QUIT command.
		1614
		1615	=item I don't want to destroy the handle too early - how do I wait until
		1616	all data has been written?
		1617
		1618	After writing your last bits of data, set the C<on_drain> callback
		1619	and destroy the handle in there - with the default setting of
		1620	C<low_water_mark> this will be called precisely when all data has been
		1621	written to the socket:
		1622
		1623	$handle->push_write (...);
		1624	$handle->on_drain (sub {
		1625	warn "all data submitted to the kernel\n";
		1626	undef $handle;
		1627	});
		1628
		1629	=back
		1630
		1631
1501	=head1 SUBCLASSING AnyEvent::Handle	1632	=head1 SUBCLASSING AnyEvent::Handle
1502		1633
1503	In many cases, you might want to subclass AnyEvent::Handle.	1634	In many cases, you might want to subclass AnyEvent::Handle.
1504		1635
1505	To make this easier, a given version of AnyEvent::Handle uses these	1636	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.90 by root, Mon Sep 29 02:08:57 2008 UTC vs. Revision 1.115 by root, Tue Feb 10 13:58:49 2009 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.90 by root, Mon Sep 29 02:08:57 2008 UTC vs.
Revision 1.115 by root, Tue Feb 10 13:58:49 2009 UTC