[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.118 by root, Thu Feb 12 17:33:38 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.34;
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>.
…		…
127	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
128	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
129	read buffer).	129	read buffer).
130		130
131	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 >>
132	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.
133		135
134	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
135	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
136	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
137	error will be raised (with C<$!> set to C<EPIPE>).	139	error will be raised (with C<$!> set to C<EPIPE>).
…		…
232	write data and will install a watcher that will write this data to the	234	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	235	socket. No errors will be reported (this mostly matches how the operating
234	system treats outstanding data at socket close time).	236	system treats outstanding data at socket close time).
235		237
236	This will not work for partial TLS data that could not be encoded	238	This will not work for partial TLS data that could not be encoded
237	yet. This data will be lost.	239	yet. This data will be lost. Calling the C<stoptls> method in time might
		240	help.
238		241
239	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	242	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
240		243
241	When this parameter is given, it enables TLS (SSL) mode, that means	244	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	245	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	257	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>	258	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	259	or C<Net::SSLeay::set_accept_state> on it before you pass it to
257	AnyEvent::Handle.	260	AnyEvent::Handle.
258		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
259	See the C<< ->starttls >> method for when need to start TLS negotiation later.	267	See the C<< ->starttls >> method for when need to start TLS negotiation later.
260		268
261	=item tls_ctx => $ssl_ctx	269	=item tls_ctx => $ssl_ctx
262		270
263	Use the given C<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
…		…
273	texts.	281	texts.
274		282
275	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
276	use this functionality, as AnyEvent does not have a dependency itself.	284	use this functionality, as AnyEvent does not have a dependency itself.
277		285
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	286	=back
286		287
287	=cut	288	=cut
288		289
289	sub new {	290	sub new {
…		…
293		294
294	$self->{fh} or Carp::croak "mandatory argument fh is missing";	295	$self->{fh} or Carp::croak "mandatory argument fh is missing";
295		296
296	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	297	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
297		298
298	if ($self->{tls}) {
299	require Net::SSLeay;
300	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});	299	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
301	}	300	if $self->{tls};
302		301
303	$self->{_activity} = AnyEvent->now;	302	$self->{_activity} = AnyEvent->now;
304	$self->_timeout;	303	$self->_timeout;
305		304
306	$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};
…		…
318	delete $self->{_tw};	317	delete $self->{_tw};
319	delete $self->{_rw};	318	delete $self->{_rw};
320	delete $self->{_ww};	319	delete $self->{_ww};
321	delete $self->{fh};	320	delete $self->{fh};
322		321
323	$self->stoptls;	322	&_freetls;
324		323
325	delete $self->{on_read};	324	delete $self->{on_read};
326	delete $self->{_queue};	325	delete $self->{_queue};
327	}	326	}
328		327
…		…
334		333
335	$! = $errno;	334	$! = $errno;
336		335
337	if ($self->{on_error}) {	336	if ($self->{on_error}) {
338	$self->{on_error}($self, $fatal);	337	$self->{on_error}($self, $fatal);
339	} else {	338	} elsif ($self->{fh}) {
340	Carp::croak "AnyEvent::Handle uncaught error: $!";	339	Carp::croak "AnyEvent::Handle uncaught error: $!";
341	}	340	}
342	}	341	}
343		342
344	=item $fh = $handle->fh	343	=item $fh = $handle->fh
…		…
382	}	381	}
383		382
384	=item $handle->autocork ($boolean)	383	=item $handle->autocork ($boolean)
385		384
386	Enables or disables the current autocork behaviour (see C<autocork>	385	Enables or disables the current autocork behaviour (see C<autocork>
387	constructor argument).	386	constructor argument). Changes will only take effect on the next write.
388		387
389	=cut	388	=cut
		389
		390	sub autocork {
		391	$_[0]{autocork} = $_[1];
		392	}
390		393
391	=item $handle->no_delay ($boolean)	394	=item $handle->no_delay ($boolean)
392		395
393	Enables or disables the C<no_delay> setting (see constructor argument of	396	Enables or disables the C<no_delay> setting (see constructor argument of
394	the same name for details).	397	the same name for details).
…		…
487	my ($self, $cb) = @_;	490	my ($self, $cb) = @_;
488		491
489	$self->{on_drain} = $cb;	492	$self->{on_drain} = $cb;
490		493
491	$cb->($self)	494	$cb->($self)
492	if $cb && $self->{low_water_mark} >= length $self->{wbuf};	495	if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});
493	}	496	}
494		497
495	=item $handle->push_write ($data)	498	=item $handle->push_write ($data)
496		499
497	Queues the given scalar to be written. You can push as much data as you	500	Queues the given scalar to be written. You can push as much data as you
…		…
514	substr $self->{wbuf}, 0, $len, "";	517	substr $self->{wbuf}, 0, $len, "";
515		518
516	$self->{_activity} = AnyEvent->now;	519	$self->{_activity} = AnyEvent->now;
517		520
518	$self->{on_drain}($self)	521	$self->{on_drain}($self)
519	if $self->{low_water_mark} >= length $self->{wbuf}	522	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
520	&& $self->{on_drain};	523	&& $self->{on_drain};
521		524
522	delete $self->{_ww} unless length $self->{wbuf};	525	delete $self->{_ww} unless length $self->{wbuf};
523	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	526	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
524	$self->_error ($!, 1);	527	$self->_error ($!, 1);
…		…
548		551
549	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	552	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")
550	->($self, @_);	553	->($self, @_);
551	}	554	}
552		555
553	if ($self->{filter_w}) {	556	if ($self->{tls}) {
554	$self->{filter_w}($self, \$_[0]);	557	$self->{_tls_wbuf} .= $_[0];
		558
		559	&_dotls ($self);
555	} else {	560	} else {
556	$self->{wbuf} .= $_[0];	561	$self->{wbuf} .= $_[0];
557	$self->_drain_wbuf;	562	$self->_drain_wbuf;
558	}	563	}
559	}	564	}
…		…
576	=cut	581	=cut
577		582
578	register_write_type netstring => sub {	583	register_write_type netstring => sub {
579	my ($self, $string) = @_;	584	my ($self, $string) = @_;
580		585
581	sprintf "%d:%s,", (length $string), $string	586	(length $string) . ":$string,"
582	};	587	};
583		588
584	=item packstring => $format, $data	589	=item packstring => $format, $data
585		590
586	An octet string prefixed with an encoded length. The encoding C<$format>	591	An octet string prefixed with an encoded length. The encoding C<$format>
…		…
764	) {	769	) {
765	$self->_error (&Errno::ENOSPC, 1), return;	770	$self->_error (&Errno::ENOSPC, 1), return;
766	}	771	}
767		772
768	while () {	773	while () {
		774	# we need to use a separate tls read buffer, as we must not receive data while
		775	# we are draining the buffer, and this can only happen with TLS.
		776	$self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf};
		777
769	my $len = length $self->{rbuf};	778	my $len = length $self->{rbuf};
770		779
771	if (my $cb = shift @{ $self->{_queue} }) {	780	if (my $cb = shift @{ $self->{_queue} }) {
772	unless ($cb->($self)) {	781	unless ($cb->($self)) {
773	if ($self->{_eof}) {	782	if ($self->{_eof}) {
…		…
795		804
796	last; # more data might arrive	805	last; # more data might arrive
797	}	806	}
798	} else {	807	} else {
799	# read side becomes idle	808	# read side becomes idle
800	delete $self->{_rw};	809	delete $self->{_rw} unless $self->{tls};
801	last;	810	last;
802	}	811	}
803	}	812	}
804		813
805	if ($self->{_eof}) {	814	if ($self->{_eof}) {
…		…
834		843
835	=item $handle->rbuf	844	=item $handle->rbuf
836		845
837	Returns the read buffer (as a modifiable lvalue).	846	Returns the read buffer (as a modifiable lvalue).
838		847
839	You can access the read buffer directly as the C<< ->{rbuf} >> member, if	848	You can access the read buffer directly as the C<< ->{rbuf} >>
840	you want.	849	member, if you want. However, the only operation allowed on the
		850	read buffer (apart from looking at it) is removing data from its
		851	beginning. Otherwise modifying or appending to it is not allowed and will
		852	lead to hard-to-track-down bugs.
841		853
842	NOTE: The read buffer should only be used or modified if the C<on_read>,	854	NOTE: The read buffer should only be used or modified if the C<on_read>,
843	C<push_read> or C<unshift_read> methods are used. The other read methods	855	C<push_read> or C<unshift_read> methods are used. The other read methods
844	automatically manage the read buffer.	856	automatically manage the read buffer.
845		857
…		…
1100	An octet string prefixed with an encoded length. The encoding C<$format>	1112	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	1113	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	1114	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
1103	optional C<!>, C<< < >> or C<< > >> modifier).	1115	optional C<!>, C<< < >> or C<< > >> modifier).
1104		1116
1105	DNS over TCP uses a prefix of C<n>, EPP uses a prefix of C<N>.	1117	For example, DNS over TCP uses a prefix of C<n> (2 octet network order),
		1118	EPP uses a prefix of C<N> (4 octtes).
1106		1119
1107	Example: read a block of data prefixed by its length in BER-encoded	1120	Example: read a block of data prefixed by its length in BER-encoded
1108	format (very efficient).	1121	format (very efficient).
1109		1122
1110	$handle->push_read (packstring => "w", sub {	1123	$handle->push_read (packstring => "w", sub {
…		…
1140	}	1153	}
1141	};	1154	};
1142		1155
1143	=item json => $cb->($handle, $hash_or_arrayref)	1156	=item json => $cb->($handle, $hash_or_arrayref)
1144		1157
1145	Reads a JSON object or array, decodes it and passes it to the callback.	1158	Reads a JSON object or array, decodes it and passes it to the
		1159	callback. When a parse error occurs, an C<EBADMSG> error will be raised.
1146		1160
1147	If a C<json> object was passed to the constructor, then that will be used	1161	If a C<json> object was passed to the constructor, then that will be used
1148	for the final decode, otherwise it will create a JSON coder expecting UTF-8.	1162	for the final decode, otherwise it will create a JSON coder expecting UTF-8.
1149		1163
1150	This read type uses the incremental parser available with JSON version	1164	This read type uses the incremental parser available with JSON version
…		…
1167	my $rbuf = \$self->{rbuf};	1181	my $rbuf = \$self->{rbuf};
1168		1182
1169	my $json = $self->{json} \|\|= JSON->new->utf8;	1183	my $json = $self->{json} \|\|= JSON->new->utf8;
1170		1184
1171	sub {	1185	sub {
1172	my $ref = $json->incr_parse ($self->{rbuf});	1186	my $ref = eval { $json->incr_parse ($self->{rbuf}) };
1173		1187
1174	if ($ref) {	1188	if ($ref) {
1175	$self->{rbuf} = $json->incr_text;	1189	$self->{rbuf} = $json->incr_text;
1176	$json->incr_text = "";	1190	$json->incr_text = "";
1177	$cb->($self, $ref);	1191	$cb->($self, $ref);
1178		1192
1179	1	1193	1
		1194	} elsif ($@) {
		1195	# error case
		1196	$json->incr_skip;
		1197
		1198	$self->{rbuf} = $json->incr_text;
		1199	$json->incr_text = "";
		1200
		1201	$self->_error (&Errno::EBADMSG);
		1202
		1203	()
1180	} else {	1204	} else {
1181	$self->{rbuf} = "";	1205	$self->{rbuf} = "";
		1206
1182	()	1207	()
1183	}	1208	}
1184	}	1209	}
1185	};	1210	};
1186		1211
…		…
1263	Note that AnyEvent::Handle will automatically C<start_read> for you when	1288	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	1289	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	1290	will automatically C<stop_read> for you when neither C<on_read> is set nor
1266	there are any read requests in the queue.	1291	there are any read requests in the queue.
1267		1292
		1293	These methods will have no effect when in TLS mode (as TLS doesn't support
		1294	half-duplex connections).
		1295
1268	=cut	1296	=cut
1269		1297
1270	sub stop_read {	1298	sub stop_read {
1271	my ($self) = @_;	1299	my ($self) = @_;
1272		1300
1273	delete $self->{_rw};	1301	delete $self->{_rw} unless $self->{tls};
1274	}	1302	}
1275		1303
1276	sub start_read {	1304	sub start_read {
1277	my ($self) = @_;	1305	my ($self) = @_;
1278		1306
1279	unless ($self->{_rw} \|\| $self->{_eof}) {	1307	unless ($self->{_rw} \|\| $self->{_eof}) {
1280	Scalar::Util::weaken $self;	1308	Scalar::Util::weaken $self;
1281		1309
1282	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1310	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
1283	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1311	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1284	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;	1312	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;
1285		1313
1286	if ($len > 0) {	1314	if ($len > 0) {
1287	$self->{_activity} = AnyEvent->now;	1315	$self->{_activity} = AnyEvent->now;
1288		1316
1289	$self->{filter_r}	1317	if ($self->{tls}) {
1290	? $self->{filter_r}($self, $rbuf)	1318	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1291	: $self->{_in_drain} \|\| $self->_drain_rbuf;	1319
		1320	&_dotls ($self);
		1321	} else {
		1322	$self->_drain_rbuf unless $self->{_in_drain};
		1323	}
1292		1324
1293	} elsif (defined $len) {	1325	} elsif (defined $len) {
1294	delete $self->{_rw};	1326	delete $self->{_rw};
1295	$self->{_eof} = 1;	1327	$self->{_eof} = 1;
1296	$self->_drain_rbuf unless $self->{_in_drain};	1328	$self->_drain_rbuf unless $self->{_in_drain};
…		…
1300	}	1332	}
1301	});	1333	});
1302	}	1334	}
1303	}	1335	}
1304		1336
		1337	# poll the write BIO and send the data if applicable
1305	sub _dotls {	1338	sub _dotls {
1306	my ($self) = @_;	1339	my ($self) = @_;
1307		1340
1308	my $buf;	1341	my $tmp;
1309		1342
1310	if (length $self->{_tls_wbuf}) {	1343	if (length $self->{_tls_wbuf}) {
1311	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1344	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1312	substr $self->{_tls_wbuf}, 0, $len, "";	1345	substr $self->{_tls_wbuf}, 0, $tmp, "";
1313	}	1346	}
1314	}	1347	}
1315		1348
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}))) {	1349	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
1322	if (length $buf) {	1350	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	1351	# let's treat SSL-eof as we treat normal EOF
		1352	delete $self->{_rw};
1327	$self->{_eof} = 1;	1353	$self->{_eof} = 1;
1328	$self->_shutdown;	1354	&_freetls;
1329	return;
1330	}	1355	}
1331	}
1332		1356
		1357	$self->{_tls_rbuf} .= $tmp;
		1358	$self->_drain_rbuf unless $self->{_in_drain};
		1359	$self->{tls} or return; # tls session might have gone away in callback
		1360	}
		1361
1333	my $err = Net::SSLeay::get_error ($self->{tls}, -1);	1362	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1334		1363
1335	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {	1364	if ($tmp != Net::SSLeay::ERROR_WANT_READ ()) {
1336	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {	1365	if ($tmp == Net::SSLeay::ERROR_SYSCALL ()) {
1337	return $self->_error ($!, 1);	1366	return $self->_error ($!, 1);
1338	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {	1367	} elsif ($tmp == Net::SSLeay::ERROR_SSL ()) {
1339	return $self->_error (&Errno::EIO, 1);	1368	return $self->_error (&Errno::EIO, 1);
1340	}	1369	}
1341		1370
1342	# all others are fine for our purposes	1371	# all other errors are fine for our purposes
		1372	}
		1373
		1374	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
		1375	$self->{wbuf} .= $tmp;
		1376	$self->_drain_wbuf;
1343	}	1377	}
1344	}	1378	}
1345		1379
1346	=item $handle->starttls ($tls[, $tls_ctx])	1380	=item $handle->starttls ($tls[, $tls_ctx])
1347		1381
…		…
1357		1391
1358	The TLS connection object will end up in C<< $handle->{tls} >> after this	1392	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	1393	call and can be used or changed to your liking. Note that the handshake
1360	might have already started when this function returns.	1394	might have already started when this function returns.
1361		1395
		1396	If it an error to start a TLS handshake more than once per
		1397	AnyEvent::Handle object (this is due to bugs in OpenSSL).
		1398
1362	=cut	1399	=cut
1363		1400
1364	sub starttls {	1401	sub starttls {
1365	my ($self, $ssl, $ctx) = @_;	1402	my ($self, $ssl, $ctx) = @_;
1366		1403
1367	$self->stoptls;	1404	require Net::SSLeay;
1368		1405
		1406	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"
		1407	if $self->{tls};
		1408
1369	if ($ssl eq "accept") {	1409	if ($ssl eq "accept") {
1370	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1410	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());
1371	Net::SSLeay::set_accept_state ($ssl);	1411	Net::SSLeay::set_accept_state ($ssl);
1372	} elsif ($ssl eq "connect") {	1412	} elsif ($ssl eq "connect") {
1373	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1413	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());
…		…
1382	# and mismaintained ssleay-module doesn't even offer them).	1422	# and mismaintained ssleay-module doesn't even offer them).
1383	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html	1423	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
1384	#	1424	#
1385	# in short: this is a mess.	1425	# in short: this is a mess.
1386	#	1426	#
1387	# note that we do not try to kepe the length constant between writes as we are required to do.	1427	# 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,	1428	# 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.	1429	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
		1430	# have identity issues in that area.
1390	Net::SSLeay::CTX_set_mode ($self->{tls},	1431	Net::SSLeay::CTX_set_mode ($self->{tls},
1391	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1432	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
1392	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));	1433	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
1393		1434
1394	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1435	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1395	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1436	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1396		1437
1397	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1438	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
1398		1439
1399	$self->{filter_w} = sub {	1440	&_dotls; # need to trigger the initial handshake
1400	$_[0]{_tls_wbuf} .= ${$_[1]};	1441	$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	}	1442	}
1408		1443
1409	=item $handle->stoptls	1444	=item $handle->stoptls
1410		1445
1411	Destroys the SSL connection, if any. Partial read or write data will be	1446	Shuts down the SSL connection - this makes a proper EOF handshake by
1412	lost.	1447	sending a close notify to the other side, but since OpenSSL doesn't
		1448	support non-blocking shut downs, it is not possible to re-use the stream
		1449	afterwards.
1413		1450
1414	=cut	1451	=cut
1415		1452
1416	sub stoptls {	1453	sub stoptls {
1417	my ($self) = @_;	1454	my ($self) = @_;
1418		1455
		1456	if ($self->{tls}) {
		1457	Net::SSLeay::shutdown ($self->{tls});
		1458
		1459	&_dotls;
		1460
		1461	# we don't give a shit. no, we do, but we can't. no...
		1462	# we, we... have to use openssl :/
		1463	&_freetls;
		1464	}
		1465	}
		1466
		1467	sub _freetls {
		1468	my ($self) = @_;
		1469
		1470	return unless $self->{tls};
		1471
1419	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};	1472	Net::SSLeay::free (delete $self->{tls});
1420		1473
1421	delete $self->{_rbio};	1474	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	}	1475	}
1427		1476
1428	sub DESTROY {	1477	sub DESTROY {
1429	my $self = shift;	1478	my $self = shift;
1430		1479
1431	$self->stoptls;	1480	&_freetls;
1432		1481
1433	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	1482	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1434		1483
1435	if ($linger && length $self->{wbuf}) {	1484	if ($linger && length $self->{wbuf}) {
1436	my $fh = delete $self->{fh};	1485	my $fh = delete $self->{fh};
…		…
1451	@linger = ();	1500	@linger = ();
1452	});	1501	});
1453	}	1502	}
1454	}	1503	}
1455		1504
		1505	=item $handle->destroy
		1506
		1507	Shuts down the handle object as much as possible - this call ensures that
		1508	no further callbacks will be invoked and resources will be freed as much
		1509	as possible. You must not call any methods on the object afterwards.
		1510
		1511	Normally, you can just "forget" any references to an AnyEvent::Handle
		1512	object and it will simply shut down. This works in fatal error and EOF
		1513	callbacks, as well as code outside. It does I<NOT> work in a read or write
		1514	callback, so when you want to destroy the AnyEvent::Handle object from
		1515	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
		1516	that case.
		1517
		1518	The handle might still linger in the background and write out remaining
		1519	data, as specified by the C<linger> option, however.
		1520
		1521	=cut
		1522
		1523	sub destroy {
		1524	my ($self) = @_;
		1525
		1526	$self->DESTROY;
		1527	%$self = ();
		1528	}
		1529
1456	=item AnyEvent::Handle::TLS_CTX	1530	=item AnyEvent::Handle::TLS_CTX
1457		1531
1458	This function creates and returns the Net::SSLeay::CTX object used by	1532	This function creates and returns the Net::SSLeay::CTX object used by
1459	default for TLS mode.	1533	default for TLS mode.
1460		1534
…		…
1488	}	1562	}
1489	}	1563	}
1490		1564
1491	=back	1565	=back
1492		1566
		1567
		1568	=head1 NONFREQUENTLY ASKED QUESTIONS
		1569
		1570	=over 4
		1571
		1572	=item I C<undef> the AnyEvent::Handle reference inside my callback and
		1573	still get further invocations!
		1574
		1575	That's because AnyEvent::Handle keeps a reference to itself when handling
		1576	read or write callbacks.
		1577
		1578	It is only safe to "forget" the reference inside EOF or error callbacks,
		1579	from within all other callbacks, you need to explicitly call the C<<
		1580	->destroy >> method.
		1581
		1582	=item I get different callback invocations in TLS mode/Why can't I pause
		1583	reading?
		1584
		1585	Unlike, say, TCP, TLS connections do not consist of two independent
		1586	communication channels, one for each direction. Or put differently. The
		1587	read and write directions are not independent of each other: you cannot
		1588	write data unless you are also prepared to read, and vice versa.
		1589
		1590	This can mean than, in TLS mode, you might get C<on_error> or C<on_eof>
		1591	callback invocations when you are not expecting any read data - the reason
		1592	is that AnyEvent::Handle always reads in TLS mode.
		1593
		1594	During the connection, you have to make sure that you always have a
		1595	non-empty read-queue, or an C<on_read> watcher. At the end of the
		1596	connection (or when you no longer want to use it) you can call the
		1597	C<destroy> method.
		1598
		1599	=item How do I read data until the other side closes the connection?
		1600
		1601	If you just want to read your data into a perl scalar, the easiest way
		1602	to achieve this is by setting an C<on_read> callback that does nothing,
		1603	clearing the C<on_eof> callback and in the C<on_error> callback, the data
		1604	will be in C<$_[0]{rbuf}>:
		1605
		1606	$handle->on_read (sub { });
		1607	$handle->on_eof (undef);
		1608	$handle->on_error (sub {
		1609	my $data = delete $_[0]{rbuf};
		1610	undef $handle;
		1611	});
		1612
		1613	The reason to use C<on_error> is that TCP connections, due to latencies
		1614	and packets loss, might get closed quite violently with an error, when in
		1615	fact, all data has been received.
		1616
		1617	It is usually better to use acknowledgements when transferring data,
		1618	to make sure the other side hasn't just died and you got the data
		1619	intact. This is also one reason why so many internet protocols have an
		1620	explicit QUIT command.
		1621
		1622	=item I don't want to destroy the handle too early - how do I wait until
		1623	all data has been written?
		1624
		1625	After writing your last bits of data, set the C<on_drain> callback
		1626	and destroy the handle in there - with the default setting of
		1627	C<low_water_mark> this will be called precisely when all data has been
		1628	written to the socket:
		1629
		1630	$handle->push_write (...);
		1631	$handle->on_drain (sub {
		1632	warn "all data submitted to the kernel\n";
		1633	undef $handle;
		1634	});
		1635
		1636	=back
		1637
		1638
1493	=head1 SUBCLASSING AnyEvent::Handle	1639	=head1 SUBCLASSING AnyEvent::Handle
1494		1640
1495	In many cases, you might want to subclass AnyEvent::Handle.	1641	In many cases, you might want to subclass AnyEvent::Handle.
1496		1642
1497	To make this easier, a given version of AnyEvent::Handle uses these	1643	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.118 by root, Thu Feb 12 17:33:38 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.118 by root, Thu Feb 12 17:33:38 2009 UTC