[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.132 by elmex, Thu Jul 2 22:25:13 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 $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value...
77		69
78	The constructor supports these arguments (all as key => value pairs).	70	The constructor supports these arguments (all as C<< key => value >> pairs).
79		71
80	=over 4	72	=over 4
81		73
82	=item fh => $filehandle [MANDATORY]	74	=item fh => $filehandle [MANDATORY]
83		75
…		…
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.
		241
		242	=item common_name => $string
		243
		244	The common name used by some verification methods (most notably SSL/TLS)
		245	associated with this connection. Usually this is the remote hostname used
		246	to connect, but can be almost anything.
246		247
247	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	248	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
248		249
249	When this parameter is given, it enables TLS (SSL) mode, that means	250	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	251	AnyEvent will start a TLS handshake as soon as the conenction has been
…		…
260	mode.	261	mode.
261		262
262	You can also provide your own TLS connection object, but you have	263	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>	264	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	265	or C<Net::SSLeay::set_accept_state> on it before you pass it to
265	AnyEvent::Handle.	266	AnyEvent::Handle. Also, this module will take ownership of this connection
		267	object.
		268
		269	At some future point, AnyEvent::Handle might switch to another TLS
		270	implementation, then the option to use your own session object will go
		271	away.
		272
		273	B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,
		274	passing in the wrong integer will lead to certain crash. This most often
		275	happens when one uses a stylish C<< tls => 1 >> and is surprised about the
		276	segmentation fault.
266		277
267	See the C<< ->starttls >> method for when need to start TLS negotiation later.	278	See the C<< ->starttls >> method for when need to start TLS negotiation later.
268		279
269	=item tls_ctx => $ssl_ctx	280	=item tls_ctx => $anyevent_tls
270		281
271	Use the given C<Net::SSLeay::CTX> object to create the new TLS connection	282	Use the given C<AnyEvent::TLS> object to create the new TLS connection
272	(unless a connection object was specified directly). If this parameter is	283	(unless a connection object was specified directly). If this parameter is
273	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	284	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
		285
		286	Instead of an object, you can also specify a hash reference with C<< key
		287	=> value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a
		288	new TLS context object.
274		289
275	=item json => JSON or JSON::XS object	290	=item json => JSON or JSON::XS object
276		291
277	This is the json coder object used by the C<json> read and write types.	292	This is the json coder object used by the C<json> read and write types.
278		293
…		…
281	texts.	296	texts.
282		297
283	Note that you are responsible to depend on the JSON module if you want to	298	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.	299	use this functionality, as AnyEvent does not have a dependency itself.
285		300
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	301	=back
294		302
295	=cut	303	=cut
296		304
297	sub new {	305	sub new {
298	my $class = shift;	306	my $class = shift;
299
300	my $self = bless { @_ }, $class;	307	my $self = bless { @_ }, $class;
301		308
302	$self->{fh} or Carp::croak "mandatory argument fh is missing";	309	$self->{fh} or Carp::croak "mandatory argument fh is missing";
303		310
304	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	311	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
305
306	if ($self->{tls}) {
307	require Net::SSLeay;
308	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});
309	}
310		312
311	$self->{_activity} = AnyEvent->now;	313	$self->{_activity} = AnyEvent->now;
312	$self->_timeout;	314	$self->_timeout;
313		315
		316	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
		317
		318	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
		319	if $self->{tls};
		320
314	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};	321	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};
315	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
316		322
317	$self->start_read	323	$self->start_read
318	if $self->{on_read};	324	if $self->{on_read};
319		325
320	$self	326	$self->{fh} && $self
321	}	327	}
322		328
323	sub _shutdown {	329	sub _shutdown {
324	my ($self) = @_;	330	my ($self) = @_;
325		331
326	delete $self->{_tw};	332	delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)};
327	delete $self->{_rw};	333	$self->{_eof} = 1; # tell starttls et. al to stop trying
328	delete $self->{_ww};
329	delete $self->{fh};
330		334
331	&_freetls;	335	&_freetls;
332
333	delete $self->{on_read};
334	delete $self->{_queue};
335	}	336	}
336		337
337	sub _error {	338	sub _error {
338	my ($self, $errno, $fatal) = @_;	339	my ($self, $errno, $fatal) = @_;
339		340
…		…
342		343
343	$! = $errno;	344	$! = $errno;
344		345
345	if ($self->{on_error}) {	346	if ($self->{on_error}) {
346	$self->{on_error}($self, $fatal);	347	$self->{on_error}($self, $fatal);
347	} else {	348	} elsif ($self->{fh}) {
348	Carp::croak "AnyEvent::Handle uncaught error: $!";	349	Carp::croak "AnyEvent::Handle uncaught error: $!";
349	}	350	}
350	}	351	}
351		352
352	=item $fh = $handle->fh	353	=item $fh = $handle->fh
…		…
390	}	391	}
391		392
392	=item $handle->autocork ($boolean)	393	=item $handle->autocork ($boolean)
393		394
394	Enables or disables the current autocork behaviour (see C<autocork>	395	Enables or disables the current autocork behaviour (see C<autocork>
395	constructor argument).	396	constructor argument). Changes will only take effect on the next write.
396		397
397	=cut	398	=cut
		399
		400	sub autocork {
		401	$_[0]{autocork} = $_[1];
		402	}
398		403
399	=item $handle->no_delay ($boolean)	404	=item $handle->no_delay ($boolean)
400		405
401	Enables or disables the C<no_delay> setting (see constructor argument of	406	Enables or disables the C<no_delay> setting (see constructor argument of
402	the same name for details).	407	the same name for details).
…		…
495	my ($self, $cb) = @_;	500	my ($self, $cb) = @_;
496		501
497	$self->{on_drain} = $cb;	502	$self->{on_drain} = $cb;
498		503
499	$cb->($self)	504	$cb->($self)
500	if $cb && $self->{low_water_mark} >= length $self->{wbuf};	505	if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});
501	}	506	}
502		507
503	=item $handle->push_write ($data)	508	=item $handle->push_write ($data)
504		509
505	Queues the given scalar to be written. You can push as much data as you	510	Queues the given scalar to be written. You can push as much data as you
…		…
522	substr $self->{wbuf}, 0, $len, "";	527	substr $self->{wbuf}, 0, $len, "";
523		528
524	$self->{_activity} = AnyEvent->now;	529	$self->{_activity} = AnyEvent->now;
525		530
526	$self->{on_drain}($self)	531	$self->{on_drain}($self)
527	if $self->{low_water_mark} >= length $self->{wbuf}	532	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
528	&& $self->{on_drain};	533	&& $self->{on_drain};
529		534
530	delete $self->{_ww} unless length $self->{wbuf};	535	delete $self->{_ww} unless length $self->{wbuf};
531	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	536	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
532	$self->_error ($!, 1);	537	$self->_error ($!, 1);
…		…
556		561
557	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	562	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")
558	->($self, @_);	563	->($self, @_);
559	}	564	}
560		565
561	if ($self->{filter_w}) {	566	if ($self->{tls}) {
562	$self->{filter_w}($self, \$_[0]);	567	$self->{_tls_wbuf} .= $_[0];
		568
		569	&_dotls ($self);
563	} else {	570	} else {
564	$self->{wbuf} .= $_[0];	571	$self->{wbuf} .= $_[0];
565	$self->_drain_wbuf;	572	$self->_drain_wbuf;
566	}	573	}
567	}	574	}
…		…
584	=cut	591	=cut
585		592
586	register_write_type netstring => sub {	593	register_write_type netstring => sub {
587	my ($self, $string) = @_;	594	my ($self, $string) = @_;
588		595
589	sprintf "%d:%s,", (length $string), $string	596	(length $string) . ":$string,"
590	};	597	};
591		598
592	=item packstring => $format, $data	599	=item packstring => $format, $data
593		600
594	An octet string prefixed with an encoded length. The encoding C<$format>	601	An octet string prefixed with an encoded length. The encoding C<$format>
…		…
772	) {	779	) {
773	$self->_error (&Errno::ENOSPC, 1), return;	780	$self->_error (&Errno::ENOSPC, 1), return;
774	}	781	}
775		782
776	while () {	783	while () {
		784	# we need to use a separate tls read buffer, as we must not receive data while
		785	# we are draining the buffer, and this can only happen with TLS.
		786	$self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf};
		787
777	my $len = length $self->{rbuf};	788	my $len = length $self->{rbuf};
778		789
779	if (my $cb = shift @{ $self->{_queue} }) {	790	if (my $cb = shift @{ $self->{_queue} }) {
780	unless ($cb->($self)) {	791	unless ($cb->($self)) {
781	if ($self->{_eof}) {	792	if ($self->{_eof}) {
…		…
803		814
804	last; # more data might arrive	815	last; # more data might arrive
805	}	816	}
806	} else {	817	} else {
807	# read side becomes idle	818	# read side becomes idle
808	delete $self->{_rw};	819	delete $self->{_rw} unless $self->{tls};
809	last;	820	last;
810	}	821	}
811	}	822	}
812		823
813	if ($self->{_eof}) {	824	if ($self->{_eof}) {
…		…
842		853
843	=item $handle->rbuf	854	=item $handle->rbuf
844		855
845	Returns the read buffer (as a modifiable lvalue).	856	Returns the read buffer (as a modifiable lvalue).
846		857
847	You can access the read buffer directly as the C<< ->{rbuf} >> member, if	858	You can access the read buffer directly as the C<< ->{rbuf} >>
848	you want.	859	member, if you want. However, the only operation allowed on the
		860	read buffer (apart from looking at it) is removing data from its
		861	beginning. Otherwise modifying or appending to it is not allowed and will
		862	lead to hard-to-track-down bugs.
849		863
850	NOTE: The read buffer should only be used or modified if the C<on_read>,	864	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	865	C<push_read> or C<unshift_read> methods are used. The other read methods
852	automatically manage the read buffer.	866	automatically manage the read buffer.
853		867
…		…
1108	An octet string prefixed with an encoded length. The encoding C<$format>	1122	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	1123	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	1124	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
1111	optional C<!>, C<< < >> or C<< > >> modifier).	1125	optional C<!>, C<< < >> or C<< > >> modifier).
1112		1126
1113	DNS over TCP uses a prefix of C<n>, EPP uses a prefix of C<N>.	1127	For example, DNS over TCP uses a prefix of C<n> (2 octet network order),
		1128	EPP uses a prefix of C<N> (4 octtes).
1114		1129
1115	Example: read a block of data prefixed by its length in BER-encoded	1130	Example: read a block of data prefixed by its length in BER-encoded
1116	format (very efficient).	1131	format (very efficient).
1117		1132
1118	$handle->push_read (packstring => "w", sub {	1133	$handle->push_read (packstring => "w", sub {
…		…
1148	}	1163	}
1149	};	1164	};
1150		1165
1151	=item json => $cb->($handle, $hash_or_arrayref)	1166	=item json => $cb->($handle, $hash_or_arrayref)
1152		1167
1153	Reads a JSON object or array, decodes it and passes it to the callback.	1168	Reads a JSON object or array, decodes it and passes it to the
		1169	callback. When a parse error occurs, an C<EBADMSG> error will be raised.
1154		1170
1155	If a C<json> object was passed to the constructor, then that will be used	1171	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.	1172	for the final decode, otherwise it will create a JSON coder expecting UTF-8.
1157		1173
1158	This read type uses the incremental parser available with JSON version	1174	This read type uses the incremental parser available with JSON version
…		…
1175	my $rbuf = \$self->{rbuf};	1191	my $rbuf = \$self->{rbuf};
1176		1192
1177	my $json = $self->{json} \|\|= JSON->new->utf8;	1193	my $json = $self->{json} \|\|= JSON->new->utf8;
1178		1194
1179	sub {	1195	sub {
1180	my $ref = $json->incr_parse ($self->{rbuf});	1196	my $ref = eval { $json->incr_parse ($self->{rbuf}) };
1181		1197
1182	if ($ref) {	1198	if ($ref) {
1183	$self->{rbuf} = $json->incr_text;	1199	$self->{rbuf} = $json->incr_text;
1184	$json->incr_text = "";	1200	$json->incr_text = "";
1185	$cb->($self, $ref);	1201	$cb->($self, $ref);
1186		1202
1187	1	1203	1
		1204	} elsif ($@) {
		1205	# error case
		1206	$json->incr_skip;
		1207
		1208	$self->{rbuf} = $json->incr_text;
		1209	$json->incr_text = "";
		1210
		1211	$self->_error (&Errno::EBADMSG);
		1212
		1213	()
1188	} else {	1214	} else {
1189	$self->{rbuf} = "";	1215	$self->{rbuf} = "";
		1216
1190	()	1217	()
1191	}	1218	}
1192	}	1219	}
1193	};	1220	};
1194		1221
…		…
1271	Note that AnyEvent::Handle will automatically C<start_read> for you when	1298	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	1299	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	1300	will automatically C<stop_read> for you when neither C<on_read> is set nor
1274	there are any read requests in the queue.	1301	there are any read requests in the queue.
1275		1302
		1303	These methods will have no effect when in TLS mode (as TLS doesn't support
		1304	half-duplex connections).
		1305
1276	=cut	1306	=cut
1277		1307
1278	sub stop_read {	1308	sub stop_read {
1279	my ($self) = @_;	1309	my ($self) = @_;
1280		1310
1281	delete $self->{_rw};	1311	delete $self->{_rw} unless $self->{tls};
1282	}	1312	}
1283		1313
1284	sub start_read {	1314	sub start_read {
1285	my ($self) = @_;	1315	my ($self) = @_;
1286		1316
1287	unless ($self->{_rw} \|\| $self->{_eof}) {	1317	unless ($self->{_rw} \|\| $self->{_eof}) {
1288	Scalar::Util::weaken $self;	1318	Scalar::Util::weaken $self;
1289		1319
1290	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1320	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
1291	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1321	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1292	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;	1322	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;
1293		1323
1294	if ($len > 0) {	1324	if ($len > 0) {
1295	$self->{_activity} = AnyEvent->now;	1325	$self->{_activity} = AnyEvent->now;
1296		1326
1297	$self->{filter_r}	1327	if ($self->{tls}) {
1298	? $self->{filter_r}($self, $rbuf)	1328	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1299	: $self->{_in_drain} \|\| $self->_drain_rbuf;	1329
		1330	&_dotls ($self);
		1331	} else {
		1332	$self->_drain_rbuf unless $self->{_in_drain};
		1333	}
1300		1334
1301	} elsif (defined $len) {	1335	} elsif (defined $len) {
1302	delete $self->{_rw};	1336	delete $self->{_rw};
1303	$self->{_eof} = 1;	1337	$self->{_eof} = 1;
1304	$self->_drain_rbuf unless $self->{_in_drain};	1338	$self->_drain_rbuf unless $self->{_in_drain};
…		…
1308	}	1342	}
1309	});	1343	});
1310	}	1344	}
1311	}	1345	}
1312		1346
		1347	# poll the write BIO and send the data if applicable
1313	sub _dotls {	1348	sub _dotls {
1314	my ($self) = @_;	1349	my ($self) = @_;
1315		1350
1316	my $buf;	1351	my $tmp;
1317		1352
1318	if (length $self->{_tls_wbuf}) {	1353	if (length $self->{_tls_wbuf}) {
1319	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1354	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1320	substr $self->{_tls_wbuf}, 0, $len, "";	1355	substr $self->{_tls_wbuf}, 0, $tmp, "";
1321	}	1356	}
1322	}	1357	}
1323		1358
1324	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {	1359	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
1325	unless (length $buf) {	1360	unless (length $tmp) {
1326	# let's treat SSL-eof as we treat normal EOF	1361	# let's treat SSL-eof as we treat normal EOF
1327	delete $self->{_rw};	1362	delete $self->{_rw};
1328	$self->{_eof} = 1;	1363	$self->{_eof} = 1;
1329	&_freetls;	1364	&_freetls;
1330	}	1365	}
1331		1366
1332	$self->{rbuf} .= $buf;	1367	$self->{_tls_rbuf} .= $tmp;
1333	$self->_drain_rbuf unless $self->{_in_drain};	1368	$self->_drain_rbuf unless $self->{_in_drain};
1334	$self->{tls} or return; # tls session might have gone away in callback	1369	$self->{tls} or return; # tls session might have gone away in callback
1335	}	1370	}
1336		1371
1337	my $err = Net::SSLeay::get_error ($self->{tls}, -1);	1372	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1338		1373
1339	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {	1374	if ($tmp != Net::SSLeay::ERROR_WANT_READ ()) {
1340	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {	1375	if ($tmp == Net::SSLeay::ERROR_SYSCALL ()) {
1341	return $self->_error ($!, 1);	1376	return $self->_error ($!, 1);
1342	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {	1377	} elsif ($tmp == Net::SSLeay::ERROR_SSL ()) {
1343	return $self->_error (&Errno::EIO, 1);	1378	return $self->_error (&Errno::EIO, 1);
1344	}	1379	}
1345		1380
1346	# all others are fine for our purposes	1381	# all other errors are fine for our purposes
1347	}	1382	}
1348		1383
1349	if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1384	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1350	$self->{wbuf} .= $buf;	1385	$self->{wbuf} .= $tmp;
1351	$self->_drain_wbuf;	1386	$self->_drain_wbuf;
1352	}	1387	}
1353	}	1388	}
1354		1389
1355	=item $handle->starttls ($tls[, $tls_ctx])	1390	=item $handle->starttls ($tls[, $tls_ctx])
…		…
1359	C<starttls>.	1394	C<starttls>.
1360		1395
1361	The first argument is the same as the C<tls> constructor argument (either	1396	The first argument is the same as the C<tls> constructor argument (either
1362	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1397	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1363		1398
1364	The second argument is the optional C<Net::SSLeay::CTX> object that is	1399	The second argument is the optional C<AnyEvent::TLS> object that is used
1365	used when AnyEvent::Handle has to create its own TLS connection object.	1400	when AnyEvent::Handle has to create its own TLS connection object, or
		1401	a hash reference with C<< key => value >> pairs that will be used to
		1402	construct a new context.
1366		1403
1367	The TLS connection object will end up in C<< $handle->{tls} >> after this	1404	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS
1368	call and can be used or changed to your liking. Note that the handshake	1405	context in C<< $handle->{tls_ctx} >> after this call and can be used or
1369	might have already started when this function returns.	1406	changed to your liking. Note that the handshake might have already started
		1407	when this function returns.
1370		1408
1371	If it an error to start a TLS handshake more than once per	1409	If it an error to start a TLS handshake more than once per
1372	AnyEvent::Handle object (this is due to bugs in OpenSSL).	1410	AnyEvent::Handle object (this is due to bugs in OpenSSL).
1373		1411
1374	=cut	1412	=cut
1375		1413
1376	sub starttls {	1414	sub starttls {
1377	my ($self, $ssl, $ctx) = @_;	1415	my ($self, $ssl, $ctx) = @_;
1378		1416
		1417	require Net::SSLeay;
		1418
1379	Carp::croak "it is an error to call starttls more than once on an Anyevent::Handle object"	1419	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"
1380	if $self->{tls};	1420	if $self->{tls};
		1421
		1422	$ctx \|\|= $self->{tls_ctx};
		1423
		1424	if ("HASH" eq ref $ctx) {
		1425	require AnyEvent::TLS;
		1426
		1427	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context
		1428	$ctx = new AnyEvent::TLS %$ctx;
		1429	}
1381		1430
1382	if ($ssl eq "accept") {	1431	$self->{tls_ctx} = $ctx \|\| TLS_CTX ();
1383	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1432	$self->{tls} = $ssl = $self->{tls_ctx}->_get_session ($ssl, $self);
1384	Net::SSLeay::set_accept_state ($ssl);
1385	} elsif ($ssl eq "connect") {
1386	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());
1387	Net::SSLeay::set_connect_state ($ssl);
1388	}
1389
1390	$self->{tls} = $ssl;
1391		1433
1392	# basically, this is deep magic (because SSL_read should have the same issues)	1434	# basically, this is deep magic (because SSL_read should have the same issues)
1393	# but the openssl maintainers basically said: "trust us, it just works".	1435	# but the openssl maintainers basically said: "trust us, it just works".
1394	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1436	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1395	# and mismaintained ssleay-module doesn't even offer them).	1437	# and mismaintained ssleay-module doesn't even offer them).
1396	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html	1438	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
1397	#	1439	#
1398	# in short: this is a mess.	1440	# in short: this is a mess.
1399	#	1441	#
1400	# note that we do not try to kepe the length constant between writes as we are required to do.	1442	# 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,	1443	# 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.	1444	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
		1445	# have identity issues in that area.
1403	Net::SSLeay::CTX_set_mode ($self->{tls},	1446	# Net::SSLeay::CTX_set_mode ($ssl,
1404	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1447	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
1405	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));	1448	# \| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
		1449	Net::SSLeay::CTX_set_mode ($ssl, 1\|2);
1406		1450
1407	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1451	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1408	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1452	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1409		1453
1410	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1454	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
1411		1455
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	1456	&_dotls; # need to trigger the initial handshake
		1457	$self->start_read; # make sure we actually do read
1422	}	1458	}
1423		1459
1424	=item $handle->stoptls	1460	=item $handle->stoptls
1425		1461
1426	Shuts down the SSL connection - this makes a proper EOF handshake by	1462	Shuts down the SSL connection - this makes a proper EOF handshake by
…		…
1432		1468
1433	sub stoptls {	1469	sub stoptls {
1434	my ($self) = @_;	1470	my ($self) = @_;
1435		1471
1436	if ($self->{tls}) {	1472	if ($self->{tls}) {
1437	Net::SSLeay::shutdown $self->{tls};	1473	Net::SSLeay::shutdown ($self->{tls});
1438		1474
1439	&_dotls;	1475	&_dotls;
1440		1476
1441	# we don't give a shit. no, we do, but we can't. no...	1477	# we don't give a shit. no, we do, but we can't. no...
1442	# we, we... have to use openssl :/	1478	# we, we... have to use openssl :/
…		…
1447	sub _freetls {	1483	sub _freetls {
1448	my ($self) = @_;	1484	my ($self) = @_;
1449		1485
1450	return unless $self->{tls};	1486	return unless $self->{tls};
1451		1487
1452	Net::SSLeay::free (delete $self->{tls});	1488	$self->{tls_ctx}->_put_session (delete $self->{tls});
1453		1489
1454	delete @$self{qw(_rbio filter_w _wbio filter_r)};	1490	delete @$self{qw(_rbio _wbio _tls_wbuf)};
1455	}	1491	}
1456		1492
1457	sub DESTROY {	1493	sub DESTROY {
1458	my $self = shift;	1494	my ($self) = @_;
1459		1495
1460	&_freetls;	1496	&_freetls;
1461		1497
1462	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	1498	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1463		1499
…		…
1480	@linger = ();	1516	@linger = ();
1481	});	1517	});
1482	}	1518	}
1483	}	1519	}
1484		1520
		1521	=item $handle->destroy
		1522
		1523	Shuts down the handle object as much as possible - this call ensures that
		1524	no further callbacks will be invoked and resources will be freed as much
		1525	as possible. You must not call any methods on the object afterwards.
		1526
		1527	Normally, you can just "forget" any references to an AnyEvent::Handle
		1528	object and it will simply shut down. This works in fatal error and EOF
		1529	callbacks, as well as code outside. It does I<NOT> work in a read or write
		1530	callback, so when you want to destroy the AnyEvent::Handle object from
		1531	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
		1532	that case.
		1533
		1534	The handle might still linger in the background and write out remaining
		1535	data, as specified by the C<linger> option, however.
		1536
		1537	=cut
		1538
		1539	sub destroy {
		1540	my ($self) = @_;
		1541
		1542	$self->DESTROY;
		1543	%$self = ();
		1544	}
		1545
1485	=item AnyEvent::Handle::TLS_CTX	1546	=item AnyEvent::Handle::TLS_CTX
1486		1547
1487	This function creates and returns the Net::SSLeay::CTX object used by	1548	This function creates and returns the AnyEvent::TLS object used by default
1488	default for TLS mode.	1549	for TLS mode.
1489		1550
1490	The context is created like this:	1551	The context is created by calling L<AnyEvent::TLS> without any arguments.
1491
1492	Net::SSLeay::load_error_strings;
1493	Net::SSLeay::SSLeay_add_ssl_algorithms;
1494	Net::SSLeay::randomize;
1495
1496	my $CTX = Net::SSLeay::CTX_new;
1497
1498	Net::SSLeay::CTX_set_options $CTX, Net::SSLeay::OP_ALL
1499		1552
1500	=cut	1553	=cut
1501		1554
1502	our $TLS_CTX;	1555	our $TLS_CTX;
1503		1556
1504	sub TLS_CTX() {	1557	sub TLS_CTX() {
1505	$TLS_CTX \|\| do {	1558	$TLS_CTX \|\|= do {
1506	require Net::SSLeay;	1559	require AnyEvent::TLS;
1507		1560
1508	Net::SSLeay::load_error_strings ();	1561	new AnyEvent::TLS
1509	Net::SSLeay::SSLeay_add_ssl_algorithms ();
1510	Net::SSLeay::randomize ();
1511
1512	$TLS_CTX = Net::SSLeay::CTX_new ();
1513
1514	Net::SSLeay::CTX_set_options ($TLS_CTX, Net::SSLeay::OP_ALL ());
1515
1516	$TLS_CTX
1517	}	1562	}
1518	}	1563	}
1519		1564
1520	=back	1565	=back
		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
1521		1638
1522	=head1 SUBCLASSING AnyEvent::Handle	1639	=head1 SUBCLASSING AnyEvent::Handle
1523		1640
1524	In many cases, you might want to subclass AnyEvent::Handle.	1641	In many cases, you might want to subclass AnyEvent::Handle.
1525		1642

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.132 by elmex, Thu Jul 2 22:25:13 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.132 by elmex, Thu Jul 2 22:25:13 2009 UTC