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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.92 by root, Wed Oct 1 08:52:06 2008 UTC vs.
Revision 1.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.3;	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");
…		…
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>.
…		…
135	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
136	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
137	read buffer).	129	read buffer).
138		130
139	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 >>
140	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.
141		135
142	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
143	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
144	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
145	error will be raised (with C<$!> set to C<EPIPE>).	139	error will be raised (with C<$!> set to C<EPIPE>).
…		…
240	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
241	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
242	system treats outstanding data at socket close time).	236	system treats outstanding data at socket close time).
243		237
244	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
245	yet. This data will be lost.	239	yet. This data will be lost. Calling the C<stoptls> method in time might
		240	help.
246		241
247	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	242	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
248		243
249	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
250	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
…		…
262	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
263	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>
264	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
265	AnyEvent::Handle.	260	AnyEvent::Handle.
266		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
267	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.
268		268
269	=item tls_ctx => $ssl_ctx	269	=item tls_ctx => $ssl_ctx
270		270
271	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
…		…
281	texts.	281	texts.
282		282
283	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
284	use this functionality, as AnyEvent does not have a dependency itself.	284	use this functionality, as AnyEvent does not have a dependency itself.
285		285
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	286	=back
294		287
295	=cut	288	=cut
296		289
297	sub new {	290	sub new {
…		…
301		294
302	$self->{fh} or Carp::croak "mandatory argument fh is missing";	295	$self->{fh} or Carp::croak "mandatory argument fh is missing";
303		296
304	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	297	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
305		298
306	if ($self->{tls}) {
307	require Net::SSLeay;
308	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});	299	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
309	}	300	if $self->{tls};
310		301
311	$self->{_activity} = AnyEvent->now;	302	$self->{_activity} = AnyEvent->now;
312	$self->_timeout;	303	$self->_timeout;
313		304
314	$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};
…		…
321	}	312	}
322		313
323	sub _shutdown {	314	sub _shutdown {
324	my ($self) = @_;	315	my ($self) = @_;
325		316
326	delete $self->{_tw};	317	delete @$self{qw(_tw _rw _ww fh rbuf wbuf on_read _queue)};
327	delete $self->{_rw};
328	delete $self->{_ww};
329	delete $self->{fh};
330		318
331	&_freetls;	319	&_freetls;
332
333	delete $self->{on_read};
334	delete $self->{_queue};
335	}	320	}
336		321
337	sub _error {	322	sub _error {
338	my ($self, $errno, $fatal) = @_;	323	my ($self, $errno, $fatal) = @_;
339		324
…		…
342		327
343	$! = $errno;	328	$! = $errno;
344		329
345	if ($self->{on_error}) {	330	if ($self->{on_error}) {
346	$self->{on_error}($self, $fatal);	331	$self->{on_error}($self, $fatal);
347	} else {	332	} elsif ($self->{fh}) {
348	Carp::croak "AnyEvent::Handle uncaught error: $!";	333	Carp::croak "AnyEvent::Handle uncaught error: $!";
349	}	334	}
350	}	335	}
351		336
352	=item $fh = $handle->fh	337	=item $fh = $handle->fh
…		…
390	}	375	}
391		376
392	=item $handle->autocork ($boolean)	377	=item $handle->autocork ($boolean)
393		378
394	Enables or disables the current autocork behaviour (see C<autocork>	379	Enables or disables the current autocork behaviour (see C<autocork>
395	constructor argument).	380	constructor argument). Changes will only take effect on the next write.
396		381
397	=cut	382	=cut
		383
		384	sub autocork {
		385	$_[0]{autocork} = $_[1];
		386	}
398		387
399	=item $handle->no_delay ($boolean)	388	=item $handle->no_delay ($boolean)
400		389
401	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
402	the same name for details).	391	the same name for details).
…		…
495	my ($self, $cb) = @_;	484	my ($self, $cb) = @_;
496		485
497	$self->{on_drain} = $cb;	486	$self->{on_drain} = $cb;
498		487
499	$cb->($self)	488	$cb->($self)
500	if $cb && $self->{low_water_mark} >= length $self->{wbuf};	489	if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});
501	}	490	}
502		491
503	=item $handle->push_write ($data)	492	=item $handle->push_write ($data)
504		493
505	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
…		…
522	substr $self->{wbuf}, 0, $len, "";	511	substr $self->{wbuf}, 0, $len, "";
523		512
524	$self->{_activity} = AnyEvent->now;	513	$self->{_activity} = AnyEvent->now;
525		514
526	$self->{on_drain}($self)	515	$self->{on_drain}($self)
527	if $self->{low_water_mark} >= length $self->{wbuf}	516	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
528	&& $self->{on_drain};	517	&& $self->{on_drain};
529		518
530	delete $self->{_ww} unless length $self->{wbuf};	519	delete $self->{_ww} unless length $self->{wbuf};
531	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	520	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
532	$self->_error ($!, 1);	521	$self->_error ($!, 1);
…		…
556		545
557	@_ = ($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")
558	->($self, @_);	547	->($self, @_);
559	}	548	}
560		549
561	if ($self->{filter_w}) {	550	if ($self->{tls}) {
562	$self->{filter_w}($self, \$_[0]);	551	$self->{_tls_wbuf} .= $_[0];
		552
		553	&_dotls ($self);
563	} else {	554	} else {
564	$self->{wbuf} .= $_[0];	555	$self->{wbuf} .= $_[0];
565	$self->_drain_wbuf;	556	$self->_drain_wbuf;
566	}	557	}
567	}	558	}
…		…
584	=cut	575	=cut
585		576
586	register_write_type netstring => sub {	577	register_write_type netstring => sub {
587	my ($self, $string) = @_;	578	my ($self, $string) = @_;
588		579
589	sprintf "%d:%s,", (length $string), $string	580	(length $string) . ":$string,"
590	};	581	};
591		582
592	=item packstring => $format, $data	583	=item packstring => $format, $data
593		584
594	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>
…		…
772	) {	763	) {
773	$self->_error (&Errno::ENOSPC, 1), return;	764	$self->_error (&Errno::ENOSPC, 1), return;
774	}	765	}
775		766
776	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
777	my $len = length $self->{rbuf};	772	my $len = length $self->{rbuf};
778		773
779	if (my $cb = shift @{ $self->{_queue} }) {	774	if (my $cb = shift @{ $self->{_queue} }) {
780	unless ($cb->($self)) {	775	unless ($cb->($self)) {
781	if ($self->{_eof}) {	776	if ($self->{_eof}) {
…		…
803		798
804	last; # more data might arrive	799	last; # more data might arrive
805	}	800	}
806	} else {	801	} else {
807	# read side becomes idle	802	# read side becomes idle
808	delete $self->{_rw};	803	delete $self->{_rw} unless $self->{tls};
809	last;	804	last;
810	}	805	}
811	}	806	}
812		807
813	if ($self->{_eof}) {	808	if ($self->{_eof}) {
…		…
842		837
843	=item $handle->rbuf	838	=item $handle->rbuf
844		839
845	Returns the read buffer (as a modifiable lvalue).	840	Returns the read buffer (as a modifiable lvalue).
846		841
847	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} >>
848	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.
849		847
850	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>,
851	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
852	automatically manage the read buffer.	850	automatically manage the read buffer.
853		851
…		…
1108	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>
1109	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
1110	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an	1108	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
1111	optional C<!>, C<< < >> or C<< > >> modifier).	1109	optional C<!>, C<< < >> or C<< > >> modifier).
1112		1110
1113	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).
1114		1113
1115	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
1116	format (very efficient).	1115	format (very efficient).
1117		1116
1118	$handle->push_read (packstring => "w", sub {	1117	$handle->push_read (packstring => "w", sub {
…		…
1148	}	1147	}
1149	};	1148	};
1150		1149
1151	=item json => $cb->($handle, $hash_or_arrayref)	1150	=item json => $cb->($handle, $hash_or_arrayref)
1152		1151
1153	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.
1154		1154
1155	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
1156	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.
1157		1157
1158	This read type uses the incremental parser available with JSON version	1158	This read type uses the incremental parser available with JSON version
…		…
1175	my $rbuf = \$self->{rbuf};	1175	my $rbuf = \$self->{rbuf};
1176		1176
1177	my $json = $self->{json} \|\|= JSON->new->utf8;	1177	my $json = $self->{json} \|\|= JSON->new->utf8;
1178		1178
1179	sub {	1179	sub {
1180	my $ref = $json->incr_parse ($self->{rbuf});	1180	my $ref = eval { $json->incr_parse ($self->{rbuf}) };
1181		1181
1182	if ($ref) {	1182	if ($ref) {
1183	$self->{rbuf} = $json->incr_text;	1183	$self->{rbuf} = $json->incr_text;
1184	$json->incr_text = "";	1184	$json->incr_text = "";
1185	$cb->($self, $ref);	1185	$cb->($self, $ref);
1186		1186
1187	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	()
1188	} else {	1198	} else {
1189	$self->{rbuf} = "";	1199	$self->{rbuf} = "";
		1200
1190	()	1201	()
1191	}	1202	}
1192	}	1203	}
1193	};	1204	};
1194		1205
…		…
1271	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
1272	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
1273	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
1274	there are any read requests in the queue.	1285	there are any read requests in the queue.
1275		1286
		1287	These methods will have no effect when in TLS mode (as TLS doesn't support
		1288	half-duplex connections).
		1289
1276	=cut	1290	=cut
1277		1291
1278	sub stop_read {	1292	sub stop_read {
1279	my ($self) = @_;	1293	my ($self) = @_;
1280		1294
1281	delete $self->{_rw};	1295	delete $self->{_rw} unless $self->{tls};
1282	}	1296	}
1283		1297
1284	sub start_read {	1298	sub start_read {
1285	my ($self) = @_;	1299	my ($self) = @_;
1286		1300
1287	unless ($self->{_rw} \|\| $self->{_eof}) {	1301	unless ($self->{_rw} \|\| $self->{_eof}) {
1288	Scalar::Util::weaken $self;	1302	Scalar::Util::weaken $self;
1289		1303
1290	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1304	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
1291	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1305	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1292	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;
1293		1307
1294	if ($len > 0) {	1308	if ($len > 0) {
1295	$self->{_activity} = AnyEvent->now;	1309	$self->{_activity} = AnyEvent->now;
1296		1310
1297	$self->{filter_r}	1311	if ($self->{tls}) {
1298	? $self->{filter_r}($self, $rbuf)	1312	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1299	: $self->{_in_drain} \|\| $self->_drain_rbuf;	1313
		1314	&_dotls ($self);
		1315	} else {
		1316	$self->_drain_rbuf unless $self->{_in_drain};
		1317	}
1300		1318
1301	} elsif (defined $len) {	1319	} elsif (defined $len) {
1302	delete $self->{_rw};	1320	delete $self->{_rw};
1303	$self->{_eof} = 1;	1321	$self->{_eof} = 1;
1304	$self->_drain_rbuf unless $self->{_in_drain};	1322	$self->_drain_rbuf unless $self->{_in_drain};
…		…
1308	}	1326	}
1309	});	1327	});
1310	}	1328	}
1311	}	1329	}
1312		1330
		1331	# poll the write BIO and send the data if applicable
1313	sub _dotls {	1332	sub _dotls {
1314	my ($self) = @_;	1333	my ($self) = @_;
1315		1334
1316	my $buf;	1335	my $tmp;
1317		1336
1318	if (length $self->{_tls_wbuf}) {	1337	if (length $self->{_tls_wbuf}) {
1319	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1338	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1320	substr $self->{_tls_wbuf}, 0, $len, "";	1339	substr $self->{_tls_wbuf}, 0, $tmp, "";
1321	}	1340	}
1322	}	1341	}
1323		1342
1324	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {	1343	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
1325	unless (length $buf) {	1344	unless (length $tmp) {
1326	# let's treat SSL-eof as we treat normal EOF	1345	# let's treat SSL-eof as we treat normal EOF
1327	delete $self->{_rw};	1346	delete $self->{_rw};
1328	$self->{_eof} = 1;	1347	$self->{_eof} = 1;
1329	&_freetls;	1348	&_freetls;
1330	}	1349	}
1331		1350
1332	$self->{rbuf} .= $buf;	1351	$self->{_tls_rbuf} .= $tmp;
1333	$self->_drain_rbuf unless $self->{_in_drain};	1352	$self->_drain_rbuf unless $self->{_in_drain};
1334	$self->{tls} or return; # tls session might have gone away in callback	1353	$self->{tls} or return; # tls session might have gone away in callback
1335	}	1354	}
1336		1355
1337	my $err = Net::SSLeay::get_error ($self->{tls}, -1);	1356	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1338		1357
1339	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {	1358	if ($tmp != Net::SSLeay::ERROR_WANT_READ ()) {
1340	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {	1359	if ($tmp == Net::SSLeay::ERROR_SYSCALL ()) {
1341	return $self->_error ($!, 1);	1360	return $self->_error ($!, 1);
1342	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {	1361	} elsif ($tmp == Net::SSLeay::ERROR_SSL ()) {
1343	return $self->_error (&Errno::EIO, 1);	1362	return $self->_error (&Errno::EIO, 1);
1344	}	1363	}
1345		1364
1346	# all others are fine for our purposes	1365	# all other errors are fine for our purposes
1347	}	1366	}
1348		1367
1349	if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1368	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1350	$self->{wbuf} .= $buf;	1369	$self->{wbuf} .= $tmp;
1351	$self->_drain_wbuf;	1370	$self->_drain_wbuf;
1352	}	1371	}
1353	}	1372	}
1354		1373
1355	=item $handle->starttls ($tls[, $tls_ctx])	1374	=item $handle->starttls ($tls[, $tls_ctx])
…		…
1374	=cut	1393	=cut
1375		1394
1376	sub starttls {	1395	sub starttls {
1377	my ($self, $ssl, $ctx) = @_;	1396	my ($self, $ssl, $ctx) = @_;
1378		1397
		1398	require Net::SSLeay;
		1399
1379	Carp::croak "it is an error to call starttls more than once on an Anyevent::Handle object"	1400	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"
1380	if $self->{tls};	1401	if $self->{tls};
1381		1402
1382	if ($ssl eq "accept") {	1403	if ($ssl eq "accept") {
1383	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1404	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());
1384	Net::SSLeay::set_accept_state ($ssl);	1405	Net::SSLeay::set_accept_state ($ssl);
…		…
1395	# and mismaintained ssleay-module doesn't even offer them).	1416	# and mismaintained ssleay-module doesn't even offer them).
1396	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html	1417	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
1397	#	1418	#
1398	# in short: this is a mess.	1419	# in short: this is a mess.
1399	#	1420	#
1400	# 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.
1401	# 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,
1402	# 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.
1403	Net::SSLeay::CTX_set_mode ($self->{tls},	1425	Net::SSLeay::CTX_set_mode ($self->{tls},
1404	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1426	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
1405	\| (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));
1406		1428
1407	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1429	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1408	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1430	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1409		1431
1410	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1432	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
1411		1433
1412	$self->{filter_w} = sub {
1413	$_[0]{_tls_wbuf} .= ${$_[1]};
1414	&_dotls;
1415	};
1416	$self->{filter_r} = sub {
1417	Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});
1418	&_dotls;
1419	};
1420
1421	&_dotls; # need to trigger the initial negotiation exchange	1434	&_dotls; # need to trigger the initial handshake
		1435	$self->start_read; # make sure we actually do read
1422	}	1436	}
1423		1437
1424	=item $handle->stoptls	1438	=item $handle->stoptls
1425		1439
1426	Shuts down the SSL connection - this makes a proper EOF handshake by	1440	Shuts down the SSL connection - this makes a proper EOF handshake by
…		…
1432		1446
1433	sub stoptls {	1447	sub stoptls {
1434	my ($self) = @_;	1448	my ($self) = @_;
1435		1449
1436	if ($self->{tls}) {	1450	if ($self->{tls}) {
1437	Net::SSLeay::shutdown $self->{tls};	1451	Net::SSLeay::shutdown ($self->{tls});
1438		1452
1439	&_dotls;	1453	&_dotls;
1440		1454
1441	# we don't give a shit. no, we do, but we can't. no...	1455	# we don't give a shit. no, we do, but we can't. no...
1442	# we, we... have to use openssl :/	1456	# we, we... have to use openssl :/
…		…
1449		1463
1450	return unless $self->{tls};	1464	return unless $self->{tls};
1451		1465
1452	Net::SSLeay::free (delete $self->{tls});	1466	Net::SSLeay::free (delete $self->{tls});
1453		1467
1454	delete @$self{qw(_rbio filter_w _wbio filter_r)};	1468	delete @$self{qw(_rbio _wbio _tls_wbuf)};
1455	}	1469	}
1456		1470
1457	sub DESTROY {	1471	sub DESTROY {
1458	my $self = shift;	1472	my ($self) = @_;
1459		1473
1460	&_freetls;	1474	&_freetls;
1461		1475
1462	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	1476	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1463		1477
…		…
1480	@linger = ();	1494	@linger = ();
1481	});	1495	});
1482	}	1496	}
1483	}	1497	}
1484		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
1485	=item AnyEvent::Handle::TLS_CTX	1524	=item AnyEvent::Handle::TLS_CTX
1486		1525
1487	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
1488	default for TLS mode.	1527	default for TLS mode.
1489		1528
…		…
1517	}	1556	}
1518	}	1557	}
1519		1558
1520	=back	1559	=back
1521		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
1522	=head1 SUBCLASSING AnyEvent::Handle	1633	=head1 SUBCLASSING AnyEvent::Handle
1523		1634
1524	In many cases, you might want to subclass AnyEvent::Handle.	1635	In many cases, you might want to subclass AnyEvent::Handle.
1525		1636
1526	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.92 by root, Wed Oct 1 08:52:06 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.92 by root, Wed Oct 1 08:52:06 2008 UTC vs.
Revision 1.130 by root, Mon Jun 29 21:00:32 2009 UTC