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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.89 by root, Sat Sep 6 10:54:32 2008 UTC vs.
Revision 1.130 by root, Mon Jun 29 21:00:32 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.45;
20		20
21	=head1 SYNOPSIS	21	=head1 SYNOPSIS
22		22
23	use AnyEvent;	23	use AnyEvent;
24	use AnyEvent::Handle;	24	use AnyEvent::Handle;
…		…
27		27
28	my $handle =	28	my $handle =
29	AnyEvent::Handle->new (	29	AnyEvent::Handle->new (
30	fh => \*STDIN,	30	fh => \*STDIN,
31	on_eof => sub {	31	on_eof => sub {
32	$cv->broadcast;	32	$cv->send;
33	},	33	},
34	);	34	);
35		35
36	# send some request line	36	# send some request line
37	$handle->push_write ("getinfo\015\012");	37	$handle->push_write ("getinfo\015\012");
…		…
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};
…		…
313	}	312	}
314		313
315	sub _shutdown {	314	sub _shutdown {
316	my ($self) = @_;	315	my ($self) = @_;
317		316
318	delete $self->{_tw};	317	delete @$self{qw(_tw _rw _ww fh rbuf wbuf on_read _queue)};
319	delete $self->{_rw};
320	delete $self->{_ww};
321	delete $self->{fh};
322		318
323	$self->stoptls;	319	&_freetls;
324
325	delete $self->{on_read};
326	delete $self->{_queue};
327	}	320	}
328		321
329	sub _error {	322	sub _error {
330	my ($self, $errno, $fatal) = @_;	323	my ($self, $errno, $fatal) = @_;
331		324
…		…
334		327
335	$! = $errno;	328	$! = $errno;
336		329
337	if ($self->{on_error}) {	330	if ($self->{on_error}) {
338	$self->{on_error}($self, $fatal);	331	$self->{on_error}($self, $fatal);
339	} else {	332	} elsif ($self->{fh}) {
340	Carp::croak "AnyEvent::Handle uncaught error: $!";	333	Carp::croak "AnyEvent::Handle uncaught error: $!";
341	}	334	}
342	}	335	}
343		336
344	=item $fh = $handle->fh	337	=item $fh = $handle->fh
…		…
382	}	375	}
383		376
384	=item $handle->autocork ($boolean)	377	=item $handle->autocork ($boolean)
385		378
386	Enables or disables the current autocork behaviour (see C<autocork>	379	Enables or disables the current autocork behaviour (see C<autocork>
387	constructor argument).	380	constructor argument). Changes will only take effect on the next write.
388		381
389	=cut	382	=cut
		383
		384	sub autocork {
		385	$_[0]{autocork} = $_[1];
		386	}
390		387
391	=item $handle->no_delay ($boolean)	388	=item $handle->no_delay ($boolean)
392		389
393	Enables or disables the C<no_delay> setting (see constructor argument of	390	Enables or disables the C<no_delay> setting (see constructor argument of
394	the same name for details).	391	the same name for details).
…		…
487	my ($self, $cb) = @_;	484	my ($self, $cb) = @_;
488		485
489	$self->{on_drain} = $cb;	486	$self->{on_drain} = $cb;
490		487
491	$cb->($self)	488	$cb->($self)
492	if $cb && $self->{low_water_mark} >= length $self->{wbuf};	489	if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});
493	}	490	}
494		491
495	=item $handle->push_write ($data)	492	=item $handle->push_write ($data)
496		493
497	Queues the given scalar to be written. You can push as much data as you	494	Queues the given scalar to be written. You can push as much data as you
…		…
514	substr $self->{wbuf}, 0, $len, "";	511	substr $self->{wbuf}, 0, $len, "";
515		512
516	$self->{_activity} = AnyEvent->now;	513	$self->{_activity} = AnyEvent->now;
517		514
518	$self->{on_drain}($self)	515	$self->{on_drain}($self)
519	if $self->{low_water_mark} >= length $self->{wbuf}	516	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
520	&& $self->{on_drain};	517	&& $self->{on_drain};
521		518
522	delete $self->{_ww} unless length $self->{wbuf};	519	delete $self->{_ww} unless length $self->{wbuf};
523	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	520	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
524	$self->_error ($!, 1);	521	$self->_error ($!, 1);
…		…
548		545
549	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	546	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")
550	->($self, @_);	547	->($self, @_);
551	}	548	}
552		549
553	if ($self->{filter_w}) {	550	if ($self->{tls}) {
554	$self->{filter_w}($self, \$_[0]);	551	$self->{_tls_wbuf} .= $_[0];
		552
		553	&_dotls ($self);
555	} else {	554	} else {
556	$self->{wbuf} .= $_[0];	555	$self->{wbuf} .= $_[0];
557	$self->_drain_wbuf;	556	$self->_drain_wbuf;
558	}	557	}
559	}	558	}
…		…
576	=cut	575	=cut
577		576
578	register_write_type netstring => sub {	577	register_write_type netstring => sub {
579	my ($self, $string) = @_;	578	my ($self, $string) = @_;
580		579
581	sprintf "%d:%s,", (length $string), $string	580	(length $string) . ":$string,"
582	};	581	};
583		582
584	=item packstring => $format, $data	583	=item packstring => $format, $data
585		584
586	An octet string prefixed with an encoded length. The encoding C<$format>	585	An octet string prefixed with an encoded length. The encoding C<$format>
…		…
764	) {	763	) {
765	$self->_error (&Errno::ENOSPC, 1), return;	764	$self->_error (&Errno::ENOSPC, 1), return;
766	}	765	}
767		766
768	while () {	767	while () {
		768	# we need to use a separate tls read buffer, as we must not receive data while
		769	# we are draining the buffer, and this can only happen with TLS.
		770	$self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf};
		771
769	my $len = length $self->{rbuf};	772	my $len = length $self->{rbuf};
770		773
771	if (my $cb = shift @{ $self->{_queue} }) {	774	if (my $cb = shift @{ $self->{_queue} }) {
772	unless ($cb->($self)) {	775	unless ($cb->($self)) {
773	if ($self->{_eof}) {	776	if ($self->{_eof}) {
…		…
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}) {
…		…
834		837
835	=item $handle->rbuf	838	=item $handle->rbuf
836		839
837	Returns the read buffer (as a modifiable lvalue).	840	Returns the read buffer (as a modifiable lvalue).
838		841
839	You can access the read buffer directly as the C<< ->{rbuf} >> member, if	842	You can access the read buffer directly as the C<< ->{rbuf} >>
840	you want.	843	member, if you want. However, the only operation allowed on the
		844	read buffer (apart from looking at it) is removing data from its
		845	beginning. Otherwise modifying or appending to it is not allowed and will
		846	lead to hard-to-track-down bugs.
841		847
842	NOTE: The read buffer should only be used or modified if the C<on_read>,	848	NOTE: The read buffer should only be used or modified if the C<on_read>,
843	C<push_read> or C<unshift_read> methods are used. The other read methods	849	C<push_read> or C<unshift_read> methods are used. The other read methods
844	automatically manage the read buffer.	850	automatically manage the read buffer.
845		851
…		…
1100	An octet string prefixed with an encoded length. The encoding C<$format>	1106	An octet string prefixed with an encoded length. The encoding C<$format>
1101	uses the same format as a Perl C<pack> format, but must specify a single	1107	uses the same format as a Perl C<pack> format, but must specify a single
1102	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an	1108	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
1103	optional C<!>, C<< < >> or C<< > >> modifier).	1109	optional C<!>, C<< < >> or C<< > >> modifier).
1104		1110
1105	DNS over TCP uses a prefix of C<n>, EPP uses a prefix of C<N>.	1111	For example, DNS over TCP uses a prefix of C<n> (2 octet network order),
		1112	EPP uses a prefix of C<N> (4 octtes).
1106		1113
1107	Example: read a block of data prefixed by its length in BER-encoded	1114	Example: read a block of data prefixed by its length in BER-encoded
1108	format (very efficient).	1115	format (very efficient).
1109		1116
1110	$handle->push_read (packstring => "w", sub {	1117	$handle->push_read (packstring => "w", sub {
…		…
1140	}	1147	}
1141	};	1148	};
1142		1149
1143	=item json => $cb->($handle, $hash_or_arrayref)	1150	=item json => $cb->($handle, $hash_or_arrayref)
1144		1151
1145	Reads a JSON object or array, decodes it and passes it to the callback.	1152	Reads a JSON object or array, decodes it and passes it to the
		1153	callback. When a parse error occurs, an C<EBADMSG> error will be raised.
1146		1154
1147	If a C<json> object was passed to the constructor, then that will be used	1155	If a C<json> object was passed to the constructor, then that will be used
1148	for the final decode, otherwise it will create a JSON coder expecting UTF-8.	1156	for the final decode, otherwise it will create a JSON coder expecting UTF-8.
1149		1157
1150	This read type uses the incremental parser available with JSON version	1158	This read type uses the incremental parser available with JSON version
…		…
1167	my $rbuf = \$self->{rbuf};	1175	my $rbuf = \$self->{rbuf};
1168		1176
1169	my $json = $self->{json} \|\|= JSON->new->utf8;	1177	my $json = $self->{json} \|\|= JSON->new->utf8;
1170		1178
1171	sub {	1179	sub {
1172	my $ref = $json->incr_parse ($self->{rbuf});	1180	my $ref = eval { $json->incr_parse ($self->{rbuf}) };
1173		1181
1174	if ($ref) {	1182	if ($ref) {
1175	$self->{rbuf} = $json->incr_text;	1183	$self->{rbuf} = $json->incr_text;
1176	$json->incr_text = "";	1184	$json->incr_text = "";
1177	$cb->($self, $ref);	1185	$cb->($self, $ref);
1178		1186
1179	1	1187	1
		1188	} elsif ($@) {
		1189	# error case
		1190	$json->incr_skip;
		1191
		1192	$self->{rbuf} = $json->incr_text;
		1193	$json->incr_text = "";
		1194
		1195	$self->_error (&Errno::EBADMSG);
		1196
		1197	()
1180	} else {	1198	} else {
1181	$self->{rbuf} = "";	1199	$self->{rbuf} = "";
		1200
1182	()	1201	()
1183	}	1202	}
1184	}	1203	}
1185	};	1204	};
1186		1205
…		…
1263	Note that AnyEvent::Handle will automatically C<start_read> for you when	1282	Note that AnyEvent::Handle will automatically C<start_read> for you when
1264	you change the C<on_read> callback or push/unshift a read callback, and it	1283	you change the C<on_read> callback or push/unshift a read callback, and it
1265	will automatically C<stop_read> for you when neither C<on_read> is set nor	1284	will automatically C<stop_read> for you when neither C<on_read> is set nor
1266	there are any read requests in the queue.	1285	there are any read requests in the queue.
1267		1286
		1287	These methods will have no effect when in TLS mode (as TLS doesn't support
		1288	half-duplex connections).
		1289
1268	=cut	1290	=cut
1269		1291
1270	sub stop_read {	1292	sub stop_read {
1271	my ($self) = @_;	1293	my ($self) = @_;
1272		1294
1273	delete $self->{_rw};	1295	delete $self->{_rw} unless $self->{tls};
1274	}	1296	}
1275		1297
1276	sub start_read {	1298	sub start_read {
1277	my ($self) = @_;	1299	my ($self) = @_;
1278		1300
1279	unless ($self->{_rw} \|\| $self->{_eof}) {	1301	unless ($self->{_rw} \|\| $self->{_eof}) {
1280	Scalar::Util::weaken $self;	1302	Scalar::Util::weaken $self;
1281		1303
1282	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1304	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
1283	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1305	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1284	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;	1306	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;
1285		1307
1286	if ($len > 0) {	1308	if ($len > 0) {
1287	$self->{_activity} = AnyEvent->now;	1309	$self->{_activity} = AnyEvent->now;
1288		1310
1289	$self->{filter_r}	1311	if ($self->{tls}) {
1290	? $self->{filter_r}($self, $rbuf)	1312	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1291	: $self->{_in_drain} \|\| $self->_drain_rbuf;	1313
		1314	&_dotls ($self);
		1315	} else {
		1316	$self->_drain_rbuf unless $self->{_in_drain};
		1317	}
1292		1318
1293	} elsif (defined $len) {	1319	} elsif (defined $len) {
1294	delete $self->{_rw};	1320	delete $self->{_rw};
1295	$self->{_eof} = 1;	1321	$self->{_eof} = 1;
1296	$self->_drain_rbuf unless $self->{_in_drain};	1322	$self->_drain_rbuf unless $self->{_in_drain};
…		…
1300	}	1326	}
1301	});	1327	});
1302	}	1328	}
1303	}	1329	}
1304		1330
		1331	# poll the write BIO and send the data if applicable
1305	sub _dotls {	1332	sub _dotls {
1306	my ($self) = @_;	1333	my ($self) = @_;
1307		1334
1308	my $buf;	1335	my $tmp;
1309		1336
1310	if (length $self->{_tls_wbuf}) {	1337	if (length $self->{_tls_wbuf}) {
1311	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1338	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1312	substr $self->{_tls_wbuf}, 0, $len, "";	1339	substr $self->{_tls_wbuf}, 0, $tmp, "";
1313	}	1340	}
1314	}	1341	}
1315		1342
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}))) {	1343	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
1322	if (length $buf) {	1344	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	1345	# let's treat SSL-eof as we treat normal EOF
		1346	delete $self->{_rw};
1327	$self->{_eof} = 1;	1347	$self->{_eof} = 1;
1328	$self->_shutdown;	1348	&_freetls;
1329	return;
1330	}	1349	}
1331	}
1332		1350
		1351	$self->{_tls_rbuf} .= $tmp;
		1352	$self->_drain_rbuf unless $self->{_in_drain};
		1353	$self->{tls} or return; # tls session might have gone away in callback
		1354	}
		1355
1333	my $err = Net::SSLeay::get_error ($self->{tls}, -1);	1356	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1334		1357
1335	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {	1358	if ($tmp != Net::SSLeay::ERROR_WANT_READ ()) {
1336	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {	1359	if ($tmp == Net::SSLeay::ERROR_SYSCALL ()) {
1337	return $self->_error ($!, 1);	1360	return $self->_error ($!, 1);
1338	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {	1361	} elsif ($tmp == Net::SSLeay::ERROR_SSL ()) {
1339	return $self->_error (&Errno::EIO, 1);	1362	return $self->_error (&Errno::EIO, 1);
1340	}	1363	}
1341		1364
1342	# all others are fine for our purposes	1365	# all other errors are fine for our purposes
		1366	}
		1367
		1368	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
		1369	$self->{wbuf} .= $tmp;
		1370	$self->_drain_wbuf;
1343	}	1371	}
1344	}	1372	}
1345		1373
1346	=item $handle->starttls ($tls[, $tls_ctx])	1374	=item $handle->starttls ($tls[, $tls_ctx])
1347		1375
…		…
1357		1385
1358	The TLS connection object will end up in C<< $handle->{tls} >> after this	1386	The TLS connection object will end up in C<< $handle->{tls} >> after this
1359	call and can be used or changed to your liking. Note that the handshake	1387	call and can be used or changed to your liking. Note that the handshake
1360	might have already started when this function returns.	1388	might have already started when this function returns.
1361		1389
		1390	If it an error to start a TLS handshake more than once per
		1391	AnyEvent::Handle object (this is due to bugs in OpenSSL).
		1392
1362	=cut	1393	=cut
1363		1394
1364	sub starttls {	1395	sub starttls {
1365	my ($self, $ssl, $ctx) = @_;	1396	my ($self, $ssl, $ctx) = @_;
1366		1397
1367	$self->stoptls;	1398	require Net::SSLeay;
1368		1399
		1400	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"
		1401	if $self->{tls};
		1402
1369	if ($ssl eq "accept") {	1403	if ($ssl eq "accept") {
1370	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1404	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());
1371	Net::SSLeay::set_accept_state ($ssl);	1405	Net::SSLeay::set_accept_state ($ssl);
1372	} elsif ($ssl eq "connect") {	1406	} elsif ($ssl eq "connect") {
1373	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1407	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());
…		…
1382	# and mismaintained ssleay-module doesn't even offer them).	1416	# and mismaintained ssleay-module doesn't even offer them).
1383	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html	1417	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
1384	#	1418	#
1385	# in short: this is a mess.	1419	# in short: this is a mess.
1386	#	1420	#
1387	# note that we do not try to kepe the length constant between writes as we are required to do.	1421	# 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,	1422	# 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.	1423	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
		1424	# have identity issues in that area.
1390	Net::SSLeay::CTX_set_mode ($self->{tls},	1425	Net::SSLeay::CTX_set_mode ($self->{tls},
1391	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1426	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
1392	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));	1427	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
1393		1428
1394	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1429	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1395	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1430	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1396		1431
1397	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1432	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
1398		1433
1399	$self->{filter_w} = sub {	1434	&_dotls; # need to trigger the initial handshake
1400	$_[0]{_tls_wbuf} .= ${$_[1]};	1435	$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	}	1436	}
1408		1437
1409	=item $handle->stoptls	1438	=item $handle->stoptls
1410		1439
1411	Destroys the SSL connection, if any. Partial read or write data will be	1440	Shuts down the SSL connection - this makes a proper EOF handshake by
1412	lost.	1441	sending a close notify to the other side, but since OpenSSL doesn't
		1442	support non-blocking shut downs, it is not possible to re-use the stream
		1443	afterwards.
1413		1444
1414	=cut	1445	=cut
1415		1446
1416	sub stoptls {	1447	sub stoptls {
1417	my ($self) = @_;	1448	my ($self) = @_;
1418		1449
		1450	if ($self->{tls}) {
		1451	Net::SSLeay::shutdown ($self->{tls});
		1452
		1453	&_dotls;
		1454
		1455	# we don't give a shit. no, we do, but we can't. no...
		1456	# we, we... have to use openssl :/
		1457	&_freetls;
		1458	}
		1459	}
		1460
		1461	sub _freetls {
		1462	my ($self) = @_;
		1463
		1464	return unless $self->{tls};
		1465
1419	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};	1466	Net::SSLeay::free (delete $self->{tls});
1420		1467
1421	delete $self->{_rbio};	1468	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	}	1469	}
1427		1470
1428	sub DESTROY {	1471	sub DESTROY {
1429	my $self = shift;	1472	my ($self) = @_;
1430		1473
1431	$self->stoptls;	1474	&_freetls;
1432		1475
1433	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	1476	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1434		1477
1435	if ($linger && length $self->{wbuf}) {	1478	if ($linger && length $self->{wbuf}) {
1436	my $fh = delete $self->{fh};	1479	my $fh = delete $self->{fh};
…		…
1451	@linger = ();	1494	@linger = ();
1452	});	1495	});
1453	}	1496	}
1454	}	1497	}
1455		1498
		1499	=item $handle->destroy
		1500
		1501	Shuts down the handle object as much as possible - this call ensures that
		1502	no further callbacks will be invoked and resources will be freed as much
		1503	as possible. You must not call any methods on the object afterwards.
		1504
		1505	Normally, you can just "forget" any references to an AnyEvent::Handle
		1506	object and it will simply shut down. This works in fatal error and EOF
		1507	callbacks, as well as code outside. It does I<NOT> work in a read or write
		1508	callback, so when you want to destroy the AnyEvent::Handle object from
		1509	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
		1510	that case.
		1511
		1512	The handle might still linger in the background and write out remaining
		1513	data, as specified by the C<linger> option, however.
		1514
		1515	=cut
		1516
		1517	sub destroy {
		1518	my ($self) = @_;
		1519
		1520	$self->DESTROY;
		1521	%$self = ();
		1522	}
		1523
1456	=item AnyEvent::Handle::TLS_CTX	1524	=item AnyEvent::Handle::TLS_CTX
1457		1525
1458	This function creates and returns the Net::SSLeay::CTX object used by	1526	This function creates and returns the Net::SSLeay::CTX object used by
1459	default for TLS mode.	1527	default for TLS mode.
1460		1528
…		…
1488	}	1556	}
1489	}	1557	}
1490		1558
1491	=back	1559	=back
1492		1560
		1561
		1562	=head1 NONFREQUENTLY ASKED QUESTIONS
		1563
		1564	=over 4
		1565
		1566	=item I C<undef> the AnyEvent::Handle reference inside my callback and
		1567	still get further invocations!
		1568
		1569	That's because AnyEvent::Handle keeps a reference to itself when handling
		1570	read or write callbacks.
		1571
		1572	It is only safe to "forget" the reference inside EOF or error callbacks,
		1573	from within all other callbacks, you need to explicitly call the C<<
		1574	->destroy >> method.
		1575
		1576	=item I get different callback invocations in TLS mode/Why can't I pause
		1577	reading?
		1578
		1579	Unlike, say, TCP, TLS connections do not consist of two independent
		1580	communication channels, one for each direction. Or put differently. The
		1581	read and write directions are not independent of each other: you cannot
		1582	write data unless you are also prepared to read, and vice versa.
		1583
		1584	This can mean than, in TLS mode, you might get C<on_error> or C<on_eof>
		1585	callback invocations when you are not expecting any read data - the reason
		1586	is that AnyEvent::Handle always reads in TLS mode.
		1587
		1588	During the connection, you have to make sure that you always have a
		1589	non-empty read-queue, or an C<on_read> watcher. At the end of the
		1590	connection (or when you no longer want to use it) you can call the
		1591	C<destroy> method.
		1592
		1593	=item How do I read data until the other side closes the connection?
		1594
		1595	If you just want to read your data into a perl scalar, the easiest way
		1596	to achieve this is by setting an C<on_read> callback that does nothing,
		1597	clearing the C<on_eof> callback and in the C<on_error> callback, the data
		1598	will be in C<$_[0]{rbuf}>:
		1599
		1600	$handle->on_read (sub { });
		1601	$handle->on_eof (undef);
		1602	$handle->on_error (sub {
		1603	my $data = delete $_[0]{rbuf};
		1604	undef $handle;
		1605	});
		1606
		1607	The reason to use C<on_error> is that TCP connections, due to latencies
		1608	and packets loss, might get closed quite violently with an error, when in
		1609	fact, all data has been received.
		1610
		1611	It is usually better to use acknowledgements when transferring data,
		1612	to make sure the other side hasn't just died and you got the data
		1613	intact. This is also one reason why so many internet protocols have an
		1614	explicit QUIT command.
		1615
		1616	=item I don't want to destroy the handle too early - how do I wait until
		1617	all data has been written?
		1618
		1619	After writing your last bits of data, set the C<on_drain> callback
		1620	and destroy the handle in there - with the default setting of
		1621	C<low_water_mark> this will be called precisely when all data has been
		1622	written to the socket:
		1623
		1624	$handle->push_write (...);
		1625	$handle->on_drain (sub {
		1626	warn "all data submitted to the kernel\n";
		1627	undef $handle;
		1628	});
		1629
		1630	=back
		1631
		1632
1493	=head1 SUBCLASSING AnyEvent::Handle	1633	=head1 SUBCLASSING AnyEvent::Handle
1494		1634
1495	In many cases, you might want to subclass AnyEvent::Handle.	1635	In many cases, you might want to subclass AnyEvent::Handle.
1496		1636
1497	To make this easier, a given version of AnyEvent::Handle uses these	1637	To make this easier, a given version of AnyEvent::Handle uses these

Diff Legend

-–
+Removed lines
-+
+Added lines
-<
+Changed lines
->
+Changed lines

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.89 by root, Sat Sep 6 10:54:32 2008 UTC vs. Revision 1.130 by root, Mon Jun 29 21:00:32 2009 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.89 by root, Sat Sep 6 10:54:32 2008 UTC vs.
Revision 1.130 by root, Mon Jun 29 21:00:32 2009 UTC