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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.88 by root, Thu Aug 21 23:48:35 2008 UTC vs.
Revision 1.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.233;	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");
…		…
63		63
64	=head1 METHODS	64	=head1 METHODS
65		65
66	=over 4	66	=over 4
67		67
68	=item B<new (%args)>	68	=item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value...
69		69
70	The constructor supports these arguments (all as key => value pairs).	70	The constructor supports these arguments (all as C<< key => value >> pairs).
71		71
72	=over 4	72	=over 4
73		73
74	=item fh => $filehandle [MANDATORY]	74	=item fh => $filehandle [MANDATORY]
75		75
…		…
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.
		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.
238		247
239	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	248	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
240		249
241	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
242	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
…		…
252	mode.	261	mode.
253		262
254	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
255	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>
256	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
257	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.
258		277
259	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.
260		279
261	=item tls_ctx => $ssl_ctx	280	=item tls_ctx => $anyevent_tls
262		281
263	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
264	(unless a connection object was specified directly). If this parameter is	283	(unless a connection object was specified directly). If this parameter is
265	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.
266		289
267	=item json => JSON or JSON::XS object	290	=item json => JSON or JSON::XS object
268		291
269	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.
270		293
…		…
273	texts.	296	texts.
274		297
275	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
276	use this functionality, as AnyEvent does not have a dependency itself.	299	use this functionality, as AnyEvent does not have a dependency itself.
277		300
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	301	=back
286		302
287	=cut	303	=cut
288		304
289	sub new {	305	sub new {
290	my $class = shift;	306	my $class = shift;
291
292	my $self = bless { @_ }, $class;	307	my $self = bless { @_ }, $class;
293		308
294	$self->{fh} or Carp::croak "mandatory argument fh is missing";	309	$self->{fh} or Carp::croak "mandatory argument fh is missing";
295		310
296	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	311	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
297
298	if ($self->{tls}) {
299	require Net::SSLeay;
300	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});
301	}
302		312
303	$self->{_activity} = AnyEvent->now;	313	$self->{_activity} = AnyEvent->now;
304	$self->_timeout;	314	$self->_timeout;
305		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
306	$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};
307	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
308		322
309	$self->start_read	323	$self->start_read
310	if $self->{on_read};	324	if $self->{on_read};
311		325
312	$self	326	$self->{fh} && $self
313	}	327	}
314		328
315	sub _shutdown {	329	sub _shutdown {
316	my ($self) = @_;	330	my ($self) = @_;
317		331
318	delete $self->{_tw};	332	delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)};
319	delete $self->{_rw};	333	$self->{_eof} = 1; # tell starttls et. al to stop trying
320	delete $self->{_ww};
321	delete $self->{fh};
322		334
323	$self->stoptls;	335	&_freetls;
324
325	delete $self->{on_read};
326	delete $self->{_queue};
327	}	336	}
328		337
329	sub _error {	338	sub _error {
330	my ($self, $errno, $fatal) = @_;	339	my ($self, $errno, $fatal) = @_;
331		340
…		…
334		343
335	$! = $errno;	344	$! = $errno;
336		345
337	if ($self->{on_error}) {	346	if ($self->{on_error}) {
338	$self->{on_error}($self, $fatal);	347	$self->{on_error}($self, $fatal);
339	} else {	348	} elsif ($self->{fh}) {
340	Carp::croak "AnyEvent::Handle uncaught error: $!";	349	Carp::croak "AnyEvent::Handle uncaught error: $!";
341	}	350	}
342	}	351	}
343		352
344	=item $fh = $handle->fh	353	=item $fh = $handle->fh
…		…
382	}	391	}
383		392
384	=item $handle->autocork ($boolean)	393	=item $handle->autocork ($boolean)
385		394
386	Enables or disables the current autocork behaviour (see C<autocork>	395	Enables or disables the current autocork behaviour (see C<autocork>
387	constructor argument).	396	constructor argument). Changes will only take effect on the next write.
388		397
389	=cut	398	=cut
		399
		400	sub autocork {
		401	$_[0]{autocork} = $_[1];
		402	}
390		403
391	=item $handle->no_delay ($boolean)	404	=item $handle->no_delay ($boolean)
392		405
393	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
394	the same name for details).	407	the same name for details).
…		…
487	my ($self, $cb) = @_;	500	my ($self, $cb) = @_;
488		501
489	$self->{on_drain} = $cb;	502	$self->{on_drain} = $cb;
490		503
491	$cb->($self)	504	$cb->($self)
492	if $cb && $self->{low_water_mark} >= length $self->{wbuf};	505	if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});
493	}	506	}
494		507
495	=item $handle->push_write ($data)	508	=item $handle->push_write ($data)
496		509
497	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
…		…
514	substr $self->{wbuf}, 0, $len, "";	527	substr $self->{wbuf}, 0, $len, "";
515		528
516	$self->{_activity} = AnyEvent->now;	529	$self->{_activity} = AnyEvent->now;
517		530
518	$self->{on_drain}($self)	531	$self->{on_drain}($self)
519	if $self->{low_water_mark} >= length $self->{wbuf}	532	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
520	&& $self->{on_drain};	533	&& $self->{on_drain};
521		534
522	delete $self->{_ww} unless length $self->{wbuf};	535	delete $self->{_ww} unless length $self->{wbuf};
523	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	536	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
524	$self->_error ($!, 1);	537	$self->_error ($!, 1);
…		…
548		561
549	@_ = ($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")
550	->($self, @_);	563	->($self, @_);
551	}	564	}
552		565
553	if ($self->{filter_w}) {	566	if ($self->{tls}) {
554	$self->{filter_w}($self, \$_[0]);	567	$self->{_tls_wbuf} .= $_[0];
		568
		569	&_dotls ($self);
555	} else {	570	} else {
556	$self->{wbuf} .= $_[0];	571	$self->{wbuf} .= $_[0];
557	$self->_drain_wbuf;	572	$self->_drain_wbuf;
558	}	573	}
559	}	574	}
…		…
576	=cut	591	=cut
577		592
578	register_write_type netstring => sub {	593	register_write_type netstring => sub {
579	my ($self, $string) = @_;	594	my ($self, $string) = @_;
580		595
581	sprintf "%d:%s,", (length $string), $string	596	(length $string) . ":$string,"
582	};	597	};
583		598
584	=item packstring => $format, $data	599	=item packstring => $format, $data
585		600
586	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>
…		…
764	) {	779	) {
765	$self->_error (&Errno::ENOSPC, 1), return;	780	$self->_error (&Errno::ENOSPC, 1), return;
766	}	781	}
767		782
768	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
769	my $len = length $self->{rbuf};	788	my $len = length $self->{rbuf};
770		789
771	if (my $cb = shift @{ $self->{_queue} }) {	790	if (my $cb = shift @{ $self->{_queue} }) {
772	unless ($cb->($self)) {	791	unless ($cb->($self)) {
773	if ($self->{_eof}) {	792	if ($self->{_eof}) {
…		…
795		814
796	last; # more data might arrive	815	last; # more data might arrive
797	}	816	}
798	} else {	817	} else {
799	# read side becomes idle	818	# read side becomes idle
800	delete $self->{_rw};	819	delete $self->{_rw} unless $self->{tls};
801	last;	820	last;
802	}	821	}
803	}	822	}
804		823
805	if ($self->{_eof}) {	824	if ($self->{_eof}) {
…		…
834		853
835	=item $handle->rbuf	854	=item $handle->rbuf
836		855
837	Returns the read buffer (as a modifiable lvalue).	856	Returns the read buffer (as a modifiable lvalue).
838		857
839	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} >>
840	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.
841		863
842	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>,
843	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
844	automatically manage the read buffer.	866	automatically manage the read buffer.
845		867
…		…
1100	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>
1101	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
1102	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an	1124	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
1103	optional C<!>, C<< < >> or C<< > >> modifier).	1125	optional C<!>, C<< < >> or C<< > >> modifier).
1104		1126
1105	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).
1106		1129
1107	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
1108	format (very efficient).	1131	format (very efficient).
1109		1132
1110	$handle->push_read (packstring => "w", sub {	1133	$handle->push_read (packstring => "w", sub {
…		…
1140	}	1163	}
1141	};	1164	};
1142		1165
1143	=item json => $cb->($handle, $hash_or_arrayref)	1166	=item json => $cb->($handle, $hash_or_arrayref)
1144		1167
1145	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.
1146		1170
1147	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
1148	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.
1149		1173
1150	This read type uses the incremental parser available with JSON version	1174	This read type uses the incremental parser available with JSON version
…		…
1167	my $rbuf = \$self->{rbuf};	1191	my $rbuf = \$self->{rbuf};
1168		1192
1169	my $json = $self->{json} \|\|= JSON->new->utf8;	1193	my $json = $self->{json} \|\|= JSON->new->utf8;
1170		1194
1171	sub {	1195	sub {
1172	my $ref = $json->incr_parse ($self->{rbuf});	1196	my $ref = eval { $json->incr_parse ($self->{rbuf}) };
1173		1197
1174	if ($ref) {	1198	if ($ref) {
1175	$self->{rbuf} = $json->incr_text;	1199	$self->{rbuf} = $json->incr_text;
1176	$json->incr_text = "";	1200	$json->incr_text = "";
1177	$cb->($self, $ref);	1201	$cb->($self, $ref);
1178		1202
1179	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	()
1180	} else {	1214	} else {
1181	$self->{rbuf} = "";	1215	$self->{rbuf} = "";
		1216
1182	()	1217	()
1183	}	1218	}
1184	}	1219	}
1185	};	1220	};
1186		1221
…		…
1263	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
1264	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
1265	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
1266	there are any read requests in the queue.	1301	there are any read requests in the queue.
1267		1302
		1303	These methods will have no effect when in TLS mode (as TLS doesn't support
		1304	half-duplex connections).
		1305
1268	=cut	1306	=cut
1269		1307
1270	sub stop_read {	1308	sub stop_read {
1271	my ($self) = @_;	1309	my ($self) = @_;
1272		1310
1273	delete $self->{_rw};	1311	delete $self->{_rw} unless $self->{tls};
1274	}	1312	}
1275		1313
1276	sub start_read {	1314	sub start_read {
1277	my ($self) = @_;	1315	my ($self) = @_;
1278		1316
1279	unless ($self->{_rw} \|\| $self->{_eof}) {	1317	unless ($self->{_rw} \|\| $self->{_eof}) {
1280	Scalar::Util::weaken $self;	1318	Scalar::Util::weaken $self;
1281		1319
1282	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1320	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
1283	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1321	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1284	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;
1285		1323
1286	if ($len > 0) {	1324	if ($len > 0) {
1287	$self->{_activity} = AnyEvent->now;	1325	$self->{_activity} = AnyEvent->now;
1288		1326
1289	$self->{filter_r}	1327	if ($self->{tls}) {
1290	? $self->{filter_r}($self, $rbuf)	1328	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1291	: $self->{_in_drain} \|\| $self->_drain_rbuf;	1329
		1330	&_dotls ($self);
		1331	} else {
		1332	$self->_drain_rbuf unless $self->{_in_drain};
		1333	}
1292		1334
1293	} elsif (defined $len) {	1335	} elsif (defined $len) {
1294	delete $self->{_rw};	1336	delete $self->{_rw};
1295	$self->{_eof} = 1;	1337	$self->{_eof} = 1;
1296	$self->_drain_rbuf unless $self->{_in_drain};	1338	$self->_drain_rbuf unless $self->{_in_drain};
…		…
1300	}	1342	}
1301	});	1343	});
1302	}	1344	}
1303	}	1345	}
1304		1346
		1347	# poll the write BIO and send the data if applicable
1305	sub _dotls {	1348	sub _dotls {
1306	my ($self) = @_;	1349	my ($self) = @_;
1307		1350
1308	my $buf;	1351	my $tmp;
1309		1352
1310	if (length $self->{_tls_wbuf}) {	1353	if (length $self->{_tls_wbuf}) {
1311	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1354	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1312	substr $self->{_tls_wbuf}, 0, $len, "";	1355	substr $self->{_tls_wbuf}, 0, $tmp, "";
1313	}	1356	}
1314	}	1357	}
1315		1358
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}))) {	1359	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
1322	if (length $buf) {	1360	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	1361	# let's treat SSL-eof as we treat normal EOF
		1362	delete $self->{_rw};
1327	$self->{_eof} = 1;	1363	$self->{_eof} = 1;
1328	$self->_shutdown;	1364	&_freetls;
1329	return;
1330	}	1365	}
1331	}
1332		1366
		1367	$self->{_tls_rbuf} .= $tmp;
		1368	$self->_drain_rbuf unless $self->{_in_drain};
		1369	$self->{tls} or return; # tls session might have gone away in callback
		1370	}
		1371
1333	my $err = Net::SSLeay::get_error ($self->{tls}, -1);	1372	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1334		1373
1335	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {	1374	if ($tmp != Net::SSLeay::ERROR_WANT_READ ()) {
1336	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {	1375	if ($tmp == Net::SSLeay::ERROR_SYSCALL ()) {
1337	return $self->_error ($!, 1);	1376	return $self->_error ($!, 1);
1338	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {	1377	} elsif ($tmp == Net::SSLeay::ERROR_SSL ()) {
1339	return $self->_error (&Errno::EIO, 1);	1378	return $self->_error (&Errno::EIO, 1);
1340	}	1379	}
1341		1380
1342	# all others are fine for our purposes	1381	# all other errors are fine for our purposes
		1382	}
		1383
		1384	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
		1385	$self->{wbuf} .= $tmp;
		1386	$self->_drain_wbuf;
1343	}	1387	}
1344	}	1388	}
1345		1389
1346	=item $handle->starttls ($tls[, $tls_ctx])	1390	=item $handle->starttls ($tls[, $tls_ctx])
1347		1391
…		…
1350	C<starttls>.	1394	C<starttls>.
1351		1395
1352	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
1353	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1397	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1354		1398
1355	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
1356	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.
1357		1403
1358	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
1359	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
1360	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.
		1408
		1409	If it an error to start a TLS handshake more than once per
		1410	AnyEvent::Handle object (this is due to bugs in OpenSSL).
1361		1411
1362	=cut	1412	=cut
1363		1413
1364	sub starttls {	1414	sub starttls {
1365	my ($self, $ssl, $ctx) = @_;	1415	my ($self, $ssl, $ctx) = @_;
1366		1416
1367	$self->stoptls;	1417	require Net::SSLeay;
1368		1418
1369	if ($ssl eq "accept") {	1419	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"
1370	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1420	if $self->{tls};
1371	Net::SSLeay::set_accept_state ($ssl);	1421
1372	} elsif ($ssl eq "connect") {	1422	$ctx \|\|= $self->{tls_ctx};
1373	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1423
1374	Net::SSLeay::set_connect_state ($ssl);	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	}
1375	}	1430
1376		1431	$self->{tls_ctx} = $ctx \|\| TLS_CTX ();
1377	$self->{tls} = $ssl;	1432	$self->{tls} = $ssl = $self->{tls_ctx}->_get_session ($ssl, $self);
1378		1433
1379	# 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)
1380	# but the openssl maintainers basically said: "trust us, it just works".	1435	# but the openssl maintainers basically said: "trust us, it just works".
1381	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1436	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1382	# and mismaintained ssleay-module doesn't even offer them).	1437	# and mismaintained ssleay-module doesn't even offer them).
1383	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html	1438	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
1384	#	1439	#
1385	# in short: this is a mess.	1440	# in short: this is a mess.
1386	#	1441	#
1387	# 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.
1388	# 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,
1389	# 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.
1390	Net::SSLeay::CTX_set_mode ($self->{tls},	1446	# Net::SSLeay::CTX_set_mode ($ssl,
1391	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1447	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
1392	\| (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);
1393		1450
1394	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1451	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1395	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1452	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1396		1453
1397	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1454	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
1398		1455
1399	$self->{filter_w} = sub {	1456	&_dotls; # need to trigger the initial handshake
1400	$_[0]{_tls_wbuf} .= ${$_[1]};	1457	$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	}	1458	}
1408		1459
1409	=item $handle->stoptls	1460	=item $handle->stoptls
1410		1461
1411	Destroys the SSL connection, if any. Partial read or write data will be	1462	Shuts down the SSL connection - this makes a proper EOF handshake by
1412	lost.	1463	sending a close notify to the other side, but since OpenSSL doesn't
		1464	support non-blocking shut downs, it is not possible to re-use the stream
		1465	afterwards.
1413		1466
1414	=cut	1467	=cut
1415		1468
1416	sub stoptls {	1469	sub stoptls {
1417	my ($self) = @_;	1470	my ($self) = @_;
1418		1471
1419	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};	1472	if ($self->{tls}) {
		1473	Net::SSLeay::shutdown ($self->{tls});
1420		1474
1421	delete $self->{_rbio};	1475	&_dotls;
1422	delete $self->{_wbio};	1476
1423	delete $self->{_tls_wbuf};	1477	# we don't give a shit. no, we do, but we can't. no...
1424	delete $self->{filter_r};	1478	# we, we... have to use openssl :/
1425	delete $self->{filter_w};	1479	&_freetls;
		1480	}
		1481	}
		1482
		1483	sub _freetls {
		1484	my ($self) = @_;
		1485
		1486	return unless $self->{tls};
		1487
		1488	$self->{tls_ctx}->_put_session (delete $self->{tls});
		1489
		1490	delete @$self{qw(_rbio _wbio _tls_wbuf)};
1426	}	1491	}
1427		1492
1428	sub DESTROY {	1493	sub DESTROY {
1429	my $self = shift;	1494	my ($self) = @_;
1430		1495
1431	$self->stoptls;	1496	&_freetls;
1432		1497
1433	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	1498	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1434		1499
1435	if ($linger && length $self->{wbuf}) {	1500	if ($linger && length $self->{wbuf}) {
1436	my $fh = delete $self->{fh};	1501	my $fh = delete $self->{fh};
…		…
1451	@linger = ();	1516	@linger = ();
1452	});	1517	});
1453	}	1518	}
1454	}	1519	}
1455		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
1456	=item AnyEvent::Handle::TLS_CTX	1546	=item AnyEvent::Handle::TLS_CTX
1457		1547
1458	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
1459	default for TLS mode.	1549	for TLS mode.
1460		1550
1461	The context is created like this:	1551	The context is created by calling L<AnyEvent::TLS> without any arguments.
1462
1463	Net::SSLeay::load_error_strings;
1464	Net::SSLeay::SSLeay_add_ssl_algorithms;
1465	Net::SSLeay::randomize;
1466
1467	my $CTX = Net::SSLeay::CTX_new;
1468
1469	Net::SSLeay::CTX_set_options $CTX, Net::SSLeay::OP_ALL
1470		1552
1471	=cut	1553	=cut
1472		1554
1473	our $TLS_CTX;	1555	our $TLS_CTX;
1474		1556
1475	sub TLS_CTX() {	1557	sub TLS_CTX() {
1476	$TLS_CTX \|\| do {	1558	$TLS_CTX \|\|= do {
1477	require Net::SSLeay;	1559	require AnyEvent::TLS;
1478		1560
1479	Net::SSLeay::load_error_strings ();	1561	new AnyEvent::TLS
1480	Net::SSLeay::SSLeay_add_ssl_algorithms ();
1481	Net::SSLeay::randomize ();
1482
1483	$TLS_CTX = Net::SSLeay::CTX_new ();
1484
1485	Net::SSLeay::CTX_set_options ($TLS_CTX, Net::SSLeay::OP_ALL ());
1486
1487	$TLS_CTX
1488	}	1562	}
1489	}	1563	}
1490		1564
1491	=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
1492		1638
1493	=head1 SUBCLASSING AnyEvent::Handle	1639	=head1 SUBCLASSING AnyEvent::Handle
1494		1640
1495	In many cases, you might want to subclass AnyEvent::Handle.	1641	In many cases, you might want to subclass AnyEvent::Handle.
1496		1642

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.88 by root, Thu Aug 21 23:48:35 2008 UTC vs. Revision 1.132 by elmex, Thu Jul 2 22:25:13 2009 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.88 by root, Thu Aug 21 23:48:35 2008 UTC vs.
Revision 1.132 by elmex, Thu Jul 2 22:25:13 2009 UTC