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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.120 by root, Fri Mar 27 08:33:41 2009 UTC vs.
Revision 1.150 by root, Thu Jul 16 04:16:25 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.341;	19	our $VERSION = 4.82;
20		20
21	=head1 SYNOPSIS	21	=head1 SYNOPSIS
22		22
23	use AnyEvent;	23	use AnyEvent;
24	use AnyEvent::Handle;	24	use AnyEvent::Handle;
25		25
26	my $cv = AnyEvent->condvar;	26	my $cv = AnyEvent->condvar;
27		27
28	my $handle =	28	my $hdl; $hdl = new AnyEvent::Handle
29	AnyEvent::Handle->new (
30	fh => \*STDIN,	29	fh => \*STDIN,
31	on_eof => sub {	30	on_error => sub {
		31	warn "got error $_[2]\n";
32	$cv->send;	32	$cv->send;
33	},
34	);	33	);
35		34
36	# send some request line	35	# send some request line
37	$handle->push_write ("getinfo\015\012");	36	$hdl->push_write ("getinfo\015\012");
38		37
39	# read the response line	38	# read the response line
40	$handle->push_read (line => sub {	39	$hdl->push_read (line => sub {
41	my ($handle, $line) = @_;	40	my ($hdl, $line) = @_;
42	warn "read line <$line>\n";	41	warn "got line <$line>\n";
43	$cv->send;	42	$cv->send;
44	});	43	});
45		44
46	$cv->recv;	45	$cv->recv;
47		46
…		…
63		62
64	=head1 METHODS	63	=head1 METHODS
65		64
66	=over 4	65	=over 4
67		66
68	=item B<new (%args)>	67	=item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value...
69		68
70	The constructor supports these arguments (all as key => value pairs).	69	The constructor supports these arguments (all as C<< key => value >> pairs).
71		70
72	=over 4	71	=over 4
73		72
74	=item fh => $filehandle [MANDATORY]	73	=item fh => $filehandle [MANDATORY]
75		74
…		…
81		80
82	=item on_eof => $cb->($handle)	81	=item on_eof => $cb->($handle)
83		82
84	Set the callback to be called when an end-of-file condition is detected,	83	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	84	i.e. in the case of a socket, when the other side has closed the
86	connection cleanly.	85	connection cleanly, and there are no outstanding read requests in the
		86	queue (if there are read requests, then an EOF counts as an unexpected
		87	connection close and will be flagged as an error).
87		88
88	For sockets, this just means that the other side has stopped sending data,	89	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	90	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	91	callback and continue writing data, as only the read part has been shut
91	down.	92	down.
92		93
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
95	waiting for data.
96
97	If an EOF condition has been detected but no C<on_eof> callback has been	94	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>.	95	set, then a fatal error will be raised with C<$!> set to <0>.
99		96
100	=item on_error => $cb->($handle, $fatal)	97	=item on_error => $cb->($handle, $fatal, $message)
101		98
102	This is the error callback, which is called when, well, some error	99	This is the error callback, which is called when, well, some error
103	occured, such as not being able to resolve the hostname, failure to	100	occured, such as not being able to resolve the hostname, failure to
104	connect or a read error.	101	connect or a read error.
105		102
106	Some errors are fatal (which is indicated by C<$fatal> being true). On	103	Some errors are fatal (which is indicated by C<$fatal> being true). On
107	fatal errors the handle object will be shut down and will not be usable	104	fatal errors the handle object will be destroyed (by a call to C<< ->
108	(but you are free to look at the current C<< ->rbuf >>). Examples of fatal	105	destroy >>) after invoking the error callback (which means you are free to
109	errors are an EOF condition with active (but unsatisifable) read watchers	106	examine the handle object). Examples of fatal errors are an EOF condition
110	(C<EPIPE>) or I/O errors.	107	with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors.
		108
		109	AnyEvent::Handle tries to find an appropriate error code for you to check
		110	against, but in some cases (TLS errors), this does not work well. It is
		111	recommended to always output the C<$message> argument in human-readable
		112	error messages (it's usually the same as C<"$!">).
111		113
112	Non-fatal errors can be retried by simply returning, but it is recommended	114	Non-fatal errors can be retried by simply returning, but it is recommended
113	to simply ignore this parameter and instead abondon the handle object	115	to simply ignore this parameter and instead abondon the handle object
114	when this callback is invoked. Examples of non-fatal errors are timeouts	116	when this callback is invoked. Examples of non-fatal errors are timeouts
115	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).	117	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
116		118
117	On callback entrance, the value of C<$!> contains the operating system	119	On callback entrance, the value of C<$!> contains the operating system
118	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).	120	error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
		121	C<EPROTO>).
119		122
120	While not mandatory, it is I<highly> recommended to set this callback, as	123	While not mandatory, it is I<highly> recommended to set this callback, as
121	you will not be notified of errors otherwise. The default simply calls	124	you will not be notified of errors otherwise. The default simply calls
122	C<croak>.	125	C<croak>.
123		126
…		…
127	and no read request is in the queue (unlike read queue callbacks, this	130	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	131	callback will only be called when at least one octet of data is in the
129	read buffer).	132	read buffer).
130		133
131	To access (and remove data from) the read buffer, use the C<< ->rbuf >>	134	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
132	method or access the C<$handle->{rbuf}> member directly. Note that you	135	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	136	must not enlarge or modify the read buffer, you can only remove data at
134	the beginning from it.	137	the beginning from it.
135		138
136	When an EOF condition is detected then AnyEvent::Handle will first try to	139	When an EOF condition is detected then AnyEvent::Handle will first try to
137	feed all the remaining data to the queued callbacks and C<on_read> before	140	feed all the remaining data to the queued callbacks and C<on_read> before
138	calling the C<on_eof> callback. If no progress can be made, then a fatal	141	calling the C<on_eof> callback. If no progress can be made, then a fatal
139	error will be raised (with C<$!> set to C<EPIPE>).	142	error will be raised (with C<$!> set to C<EPIPE>).
		143
		144	Note that, unlike requests in the read queue, an C<on_read> callback
		145	doesn't mean you I<require> some data: if there is an EOF and there
		146	are outstanding read requests then an error will be flagged. With an
		147	C<on_read> callback, the C<on_eof> callback will be invoked.
140		148
141	=item on_drain => $cb->($handle)	149	=item on_drain => $cb->($handle)
142		150
143	This sets the callback that is called when the write buffer becomes empty	151	This sets the callback that is called when the write buffer becomes empty
144	(or when the callback is set and the buffer is empty already).	152	(or when the callback is set and the buffer is empty already).
…		…
237		245
238	This will not work for partial TLS data that could not be encoded	246	This will not work for partial TLS data that could not be encoded
239	yet. This data will be lost. Calling the C<stoptls> method in time might	247	yet. This data will be lost. Calling the C<stoptls> method in time might
240	help.	248	help.
241		249
		250	=item peername => $string
		251
		252	A string used to identify the remote site - usually the DNS hostname
		253	(I<not> IDN!) used to create the connection, rarely the IP address.
		254
		255	Apart from being useful in error messages, this string is also used in TLS
		256	peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This
		257	verification will be skipped when C<peername> is not specified or
		258	C<undef>.
		259
242	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	260	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
243		261
244	When this parameter is given, it enables TLS (SSL) mode, that means	262	When this parameter is given, it enables TLS (SSL) mode, that means
245	AnyEvent will start a TLS handshake as soon as the conenction has been	263	AnyEvent will start a TLS handshake as soon as the conenction has been
246	established and will transparently encrypt/decrypt data afterwards.	264	established and will transparently encrypt/decrypt data afterwards.
		265
		266	All TLS protocol errors will be signalled as C<EPROTO>, with an
		267	appropriate error message.
247		268
248	TLS mode requires Net::SSLeay to be installed (it will be loaded	269	TLS mode requires Net::SSLeay to be installed (it will be loaded
249	automatically when you try to create a TLS handle): this module doesn't	270	automatically when you try to create a TLS handle): this module doesn't
250	have a dependency on that module, so if your module requires it, you have	271	have a dependency on that module, so if your module requires it, you have
251	to add the dependency yourself.	272	to add the dependency yourself.
…		…
255	mode.	276	mode.
256		277
257	You can also provide your own TLS connection object, but you have	278	You can also provide your own TLS connection object, but you have
258	to make sure that you call either C<Net::SSLeay::set_connect_state>	279	to make sure that you call either C<Net::SSLeay::set_connect_state>
259	or C<Net::SSLeay::set_accept_state> on it before you pass it to	280	or C<Net::SSLeay::set_accept_state> on it before you pass it to
260	AnyEvent::Handle.	281	AnyEvent::Handle. Also, this module will take ownership of this connection
		282	object.
		283
		284	At some future point, AnyEvent::Handle might switch to another TLS
		285	implementation, then the option to use your own session object will go
		286	away.
261		287
262	B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,	288	B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,
263	passing in the wrong integer will lead to certain crash. This most often	289	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	290	happens when one uses a stylish C<< tls => 1 >> and is surprised about the
265	segmentation fault.	291	segmentation fault.
266		292
267	See the C<< ->starttls >> method for when need to start TLS negotiation later.	293	See the C<< ->starttls >> method for when need to start TLS negotiation later.
268		294
269	=item tls_ctx => $ssl_ctx	295	=item tls_ctx => $anyevent_tls
270		296
271	Use the given C<Net::SSLeay::CTX> object to create the new TLS connection	297	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	298	(unless a connection object was specified directly). If this parameter is
273	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	299	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
		300
		301	Instead of an object, you can also specify a hash reference with C<< key
		302	=> value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a
		303	new TLS context object.
		304
		305	=item on_starttls => $cb->($handle, $success[, $error_message])
		306
		307	This callback will be invoked when the TLS/SSL handshake has finished. If
		308	C<$success> is true, then the TLS handshake succeeded, otherwise it failed
		309	(C<on_stoptls> will not be called in this case).
		310
		311	The session in C<< $handle->{tls} >> can still be examined in this
		312	callback, even when the handshake was not successful.
		313
		314	TLS handshake failures will not cause C<on_error> to be invoked when this
		315	callback is in effect, instead, the error message will be passed to C<on_starttls>.
		316
		317	Without this callback, handshake failures lead to C<on_error> being
		318	called, as normal.
		319
		320	Note that you cannot call C<starttls> right again in this callback. If you
		321	need to do that, start an zero-second timer instead whose callback can
		322	then call C<< ->starttls >> again.
		323
		324	=item on_stoptls => $cb->($handle)
		325
		326	When a SSLv3/TLS shutdown/close notify/EOF is detected and this callback is
		327	set, then it will be invoked after freeing the TLS session. If it is not,
		328	then a TLS shutdown condition will be treated like a normal EOF condition
		329	on the handle.
		330
		331	The session in C<< $handle->{tls} >> can still be examined in this
		332	callback.
		333
		334	This callback will only be called on TLS shutdowns, not when the
		335	underlying handle signals EOF.
274		336
275	=item json => JSON or JSON::XS object	337	=item json => JSON or JSON::XS object
276		338
277	This is the json coder object used by the C<json> read and write types.	339	This is the json coder object used by the C<json> read and write types.
278		340
…		…
287		349
288	=cut	350	=cut
289		351
290	sub new {	352	sub new {
291	my $class = shift;	353	my $class = shift;
292
293	my $self = bless { @_ }, $class;	354	my $self = bless { @_ }, $class;
294		355
295	$self->{fh} or Carp::croak "mandatory argument fh is missing";	356	$self->{fh} or Carp::croak "mandatory argument fh is missing";
296		357
297	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	358	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
		359
		360	$self->{_activity} = AnyEvent->now;
		361	$self->_timeout;
		362
		363	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
298		364
299	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})	365	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
300	if $self->{tls};	366	if $self->{tls};
301		367
302	$self->{_activity} = AnyEvent->now;
303	$self->_timeout;
304
305	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};	368	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
306	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
307		369
308	$self->start_read	370	$self->start_read
309	if $self->{on_read};	371	if $self->{on_read};
310		372
311	$self	373	$self->{fh} && $self
312	}	374	}
313		375
314	sub _shutdown {	376	#sub _shutdown {
315	my ($self) = @_;	377	# my ($self) = @_;
316		378	#
317	delete $self->{_tw};	379	# delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)};
318	delete $self->{_rw};	380	# $self->{_eof} = 1; # tell starttls et. al to stop trying
319	delete $self->{_ww};	381	#
320	delete $self->{fh};
321
322	&_freetls;	382	# &_freetls;
323		383	#}
324	delete $self->{on_read};
325	delete $self->{_queue};
326	}
327		384
328	sub _error {	385	sub _error {
329	my ($self, $errno, $fatal) = @_;	386	my ($self, $errno, $fatal, $message) = @_;
330
331	$self->_shutdown
332	if $fatal;
333		387
334	$! = $errno;	388	$! = $errno;
		389	$message \|\|= "$!";
335		390
336	if ($self->{on_error}) {	391	if ($self->{on_error}) {
337	$self->{on_error}($self, $fatal);	392	$self->{on_error}($self, $fatal, $message);
		393	$self->destroy;
338	} elsif ($self->{fh}) {	394	} elsif ($self->{fh}) {
		395	$self->destroy;
339	Carp::croak "AnyEvent::Handle uncaught error: $!";	396	Carp::croak "AnyEvent::Handle uncaught error: $message";
340	}	397	}
341	}	398	}
342		399
343	=item $fh = $handle->fh	400	=item $fh = $handle->fh
344		401
…		…
405	local $SIG{__DIE__};	462	local $SIG{__DIE__};
406	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];	463	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];
407	};	464	};
408	}	465	}
409		466
		467	=item $handle->on_starttls ($cb)
		468
		469	Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument).
		470
		471	=cut
		472
		473	sub on_starttls {
		474	$_[0]{on_starttls} = $_[1];
		475	}
		476
		477	=item $handle->on_stoptls ($cb)
		478
		479	Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).
		480
		481	=cut
		482
		483	sub on_starttls {
		484	$_[0]{on_stoptls} = $_[1];
		485	}
		486
410	#############################################################################	487	#############################################################################
411		488
412	=item $handle->timeout ($seconds)	489	=item $handle->timeout ($seconds)
413		490
414	Configures (or disables) the inactivity timeout.	491	Configures (or disables) the inactivity timeout.
…		…
438	$self->{_activity} = $NOW;	515	$self->{_activity} = $NOW;
439		516
440	if ($self->{on_timeout}) {	517	if ($self->{on_timeout}) {
441	$self->{on_timeout}($self);	518	$self->{on_timeout}($self);
442	} else {	519	} else {
443	$self->_error (&Errno::ETIMEDOUT);	520	$self->_error (Errno::ETIMEDOUT);
444	}	521	}
445		522
446	# callback could have changed timeout value, optimise	523	# callback could have changed timeout value, optimise
447	return unless $self->{timeout};	524	return unless $self->{timeout};
448		525
…		…
511	Scalar::Util::weaken $self;	588	Scalar::Util::weaken $self;
512		589
513	my $cb = sub {	590	my $cb = sub {
514	my $len = syswrite $self->{fh}, $self->{wbuf};	591	my $len = syswrite $self->{fh}, $self->{wbuf};
515		592
516	if ($len >= 0) {	593	if (defined $len) {
517	substr $self->{wbuf}, 0, $len, "";	594	substr $self->{wbuf}, 0, $len, "";
518		595
519	$self->{_activity} = AnyEvent->now;	596	$self->{_activity} = AnyEvent->now;
520		597
521	$self->{on_drain}($self)	598	$self->{on_drain}($self)
…		…
656		733
657	pack "w/a*", Storable::nfreeze ($ref)	734	pack "w/a*", Storable::nfreeze ($ref)
658	};	735	};
659		736
660	=back	737	=back
		738
		739	=item $handle->push_shutdown
		740
		741	Sometimes you know you want to close the socket after writing your data
		742	before it was actually written. One way to do that is to replace your
		743	C<on_drain> handler by a callback that shuts down the socket (and set
		744	C<low_water_mark> to C<0>). This method is a shorthand for just that, and
		745	replaces the C<on_drain> callback with:
		746
		747	sub { shutdown $_[0]{fh}, 1 } # for push_shutdown
		748
		749	This simply shuts down the write side and signals an EOF condition to the
		750	the peer.
		751
		752	You can rely on the normal read queue and C<on_eof> handling
		753	afterwards. This is the cleanest way to close a connection.
		754
		755	=cut
		756
		757	sub push_shutdown {
		758	my ($self) = @_;
		759
		760	delete $self->{low_water_mark};
		761	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });
		762	}
661		763
662	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	764	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
663		765
664	This function (not method) lets you add your own types to C<push_write>.	766	This function (not method) lets you add your own types to C<push_write>.
665	Whenever the given C<type> is used, C<push_write> will invoke the code	767	Whenever the given C<type> is used, C<push_write> will invoke the code
…		…
765		867
766	if (	868	if (
767	defined $self->{rbuf_max}	869	defined $self->{rbuf_max}
768	&& $self->{rbuf_max} < length $self->{rbuf}	870	&& $self->{rbuf_max} < length $self->{rbuf}
769	) {	871	) {
770	$self->_error (&Errno::ENOSPC, 1), return;	872	$self->_error (Errno::ENOSPC, 1), return;
771	}	873	}
772		874
773	while () {	875	while () {
774	# we need to use a separate tls read buffer, as we must not receive data while	876	# we need to use a separate tls read buffer, as we must not receive data while
775	# we are draining the buffer, and this can only happen with TLS.	877	# we are draining the buffer, and this can only happen with TLS.
…		…
779		881
780	if (my $cb = shift @{ $self->{_queue} }) {	882	if (my $cb = shift @{ $self->{_queue} }) {
781	unless ($cb->($self)) {	883	unless ($cb->($self)) {
782	if ($self->{_eof}) {	884	if ($self->{_eof}) {
783	# no progress can be made (not enough data and no data forthcoming)	885	# no progress can be made (not enough data and no data forthcoming)
784	$self->_error (&Errno::EPIPE, 1), return;	886	$self->_error (Errno::EPIPE, 1), return;
785	}	887	}
786		888
787	unshift @{ $self->{_queue} }, $cb;	889	unshift @{ $self->{_queue} }, $cb;
788	last;	890	last;
789	}	891	}
…		…
797	&& !@{ $self->{_queue} } # and the queue is still empty	899	&& !@{ $self->{_queue} } # and the queue is still empty
798	&& $self->{on_read} # but we still have on_read	900	&& $self->{on_read} # but we still have on_read
799	) {	901	) {
800	# no further data will arrive	902	# no further data will arrive
801	# so no progress can be made	903	# so no progress can be made
802	$self->_error (&Errno::EPIPE, 1), return	904	$self->_error (Errno::EPIPE, 1), return
803	if $self->{_eof};	905	if $self->{_eof};
804		906
805	last; # more data might arrive	907	last; # more data might arrive
806	}	908	}
807	} else {	909	} else {
…		…
813		915
814	if ($self->{_eof}) {	916	if ($self->{_eof}) {
815	if ($self->{on_eof}) {	917	if ($self->{on_eof}) {
816	$self->{on_eof}($self)	918	$self->{on_eof}($self)
817	} else {	919	} else {
818	$self->_error (0, 1);	920	$self->_error (0, 1, "Unexpected end-of-file");
819	}	921	}
820	}	922	}
821		923
822	# may need to restart read watcher	924	# may need to restart read watcher
823	unless ($self->{_rw}) {	925	unless ($self->{_rw}) {
…		…
1057	return 1;	1159	return 1;
1058	}	1160	}
1059		1161
1060	# reject	1162	# reject
1061	if ($reject && $$rbuf =~ $reject) {	1163	if ($reject && $$rbuf =~ $reject) {
1062	$self->_error (&Errno::EBADMSG);	1164	$self->_error (Errno::EBADMSG);
1063	}	1165	}
1064		1166
1065	# skip	1167	# skip
1066	if ($skip && $$rbuf =~ $skip) {	1168	if ($skip && $$rbuf =~ $skip) {
1067	$data .= substr $$rbuf, 0, $+[0], "";	1169	$data .= substr $$rbuf, 0, $+[0], "";
…		…
1083	my ($self, $cb) = @_;	1185	my ($self, $cb) = @_;
1084		1186
1085	sub {	1187	sub {
1086	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {	1188	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
1087	if ($_[0]{rbuf} =~ /[^0-9]/) {	1189	if ($_[0]{rbuf} =~ /[^0-9]/) {
1088	$self->_error (&Errno::EBADMSG);	1190	$self->_error (Errno::EBADMSG);
1089	}	1191	}
1090	return;	1192	return;
1091	}	1193	}
1092		1194
1093	my $len = $1;	1195	my $len = $1;
…		…
1096	my $string = $_[1];	1198	my $string = $_[1];
1097	$_[0]->unshift_read (chunk => 1, sub {	1199	$_[0]->unshift_read (chunk => 1, sub {
1098	if ($_[1] eq ",") {	1200	if ($_[1] eq ",") {
1099	$cb->($_[0], $string);	1201	$cb->($_[0], $string);
1100	} else {	1202	} else {
1101	$self->_error (&Errno::EBADMSG);	1203	$self->_error (Errno::EBADMSG);
1102	}	1204	}
1103	});	1205	});
1104	});	1206	});
1105		1207
1106	1	1208	1
…		…
1173	=cut	1275	=cut
1174		1276
1175	register_read_type json => sub {	1277	register_read_type json => sub {
1176	my ($self, $cb) = @_;	1278	my ($self, $cb) = @_;
1177		1279
1178	require JSON;	1280	my $json = $self->{json} \|\|=
		1281	eval { require JSON::XS; JSON::XS->new->utf8 }
		1282	\|\| do { require JSON; JSON->new->utf8 };
1179		1283
1180	my $data;	1284	my $data;
1181	my $rbuf = \$self->{rbuf};	1285	my $rbuf = \$self->{rbuf};
1182
1183	my $json = $self->{json} \|\|= JSON->new->utf8;
1184		1286
1185	sub {	1287	sub {
1186	my $ref = eval { $json->incr_parse ($self->{rbuf}) };	1288	my $ref = eval { $json->incr_parse ($self->{rbuf}) };
1187		1289
1188	if ($ref) {	1290	if ($ref) {
…		…
1196	$json->incr_skip;	1298	$json->incr_skip;
1197		1299
1198	$self->{rbuf} = $json->incr_text;	1300	$self->{rbuf} = $json->incr_text;
1199	$json->incr_text = "";	1301	$json->incr_text = "";
1200		1302
1201	$self->_error (&Errno::EBADMSG);	1303	$self->_error (Errno::EBADMSG);
1202		1304
1203	()	1305	()
1204	} else {	1306	} else {
1205	$self->{rbuf} = "";	1307	$self->{rbuf} = "";
1206		1308
…		…
1243	# read remaining chunk	1345	# read remaining chunk
1244	$_[0]->unshift_read (chunk => $len, sub {	1346	$_[0]->unshift_read (chunk => $len, sub {
1245	if (my $ref = eval { Storable::thaw ($_[1]) }) {	1347	if (my $ref = eval { Storable::thaw ($_[1]) }) {
1246	$cb->($_[0], $ref);	1348	$cb->($_[0], $ref);
1247	} else {	1349	} else {
1248	$self->_error (&Errno::EBADMSG);	1350	$self->_error (Errno::EBADMSG);
1249	}	1351	}
1250	});	1352	});
1251	}	1353	}
1252		1354
1253	1	1355	1
…		…
1332	}	1434	}
1333	});	1435	});
1334	}	1436	}
1335	}	1437	}
1336		1438
		1439	our $ERROR_SYSCALL;
		1440	our $ERROR_WANT_READ;
		1441
		1442	sub _tls_error {
		1443	my ($self, $err) = @_;
		1444
		1445	return $self->_error ($!, 1)
		1446	if $err == Net::SSLeay::ERROR_SYSCALL ();
		1447
		1448	my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());
		1449
		1450	# reduce error string to look less scary
		1451	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;
		1452
		1453	if ($self->{_on_starttls}) {
		1454	(delete $self->{_on_starttls})->($self, undef, $err);
		1455	&_freetls;
		1456	} else {
		1457	&_freetls;
		1458	$self->_error (Errno::EPROTO, 1, $err);
		1459	}
		1460	}
		1461
1337	# poll the write BIO and send the data if applicable	1462	# poll the write BIO and send the data if applicable
		1463	# also decode read data if possible
		1464	# this is basiclaly our TLS state machine
		1465	# more efficient implementations are possible with openssl,
		1466	# but not with the buggy and incomplete Net::SSLeay.
1338	sub _dotls {	1467	sub _dotls {
1339	my ($self) = @_;	1468	my ($self) = @_;
1340		1469
1341	my $tmp;	1470	my $tmp;
1342		1471
1343	if (length $self->{_tls_wbuf}) {	1472	if (length $self->{_tls_wbuf}) {
1344	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1473	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1345	substr $self->{_tls_wbuf}, 0, $tmp, "";	1474	substr $self->{_tls_wbuf}, 0, $tmp, "";
1346	}	1475	}
		1476
		1477	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);
		1478	return $self->_tls_error ($tmp)
		1479	if $tmp != $ERROR_WANT_READ
		1480	&& ($tmp != $ERROR_SYSCALL \|\| $!);
1347	}	1481	}
1348		1482
1349	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {	1483	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
1350	unless (length $tmp) {	1484	unless (length $tmp) {
1351	# let's treat SSL-eof as we treat normal EOF	1485	$self->{_on_starttls}
1352	delete $self->{_rw};	1486	and (delete $self->{_on_starttls})->($self, undef, "EOF during handshake"); # ???
1353	$self->{_eof} = 1;
1354	&_freetls;	1487	&_freetls;
		1488
		1489	if ($self->{on_stoptls}) {
		1490	$self->{on_stoptls}($self);
		1491	return;
		1492	} else {
		1493	# let's treat SSL-eof as we treat normal EOF
		1494	delete $self->{_rw};
		1495	$self->{_eof} = 1;
		1496	}
1355	}	1497	}
1356		1498
1357	$self->{_tls_rbuf} .= $tmp;	1499	$self->{_tls_rbuf} .= $tmp;
1358	$self->_drain_rbuf unless $self->{_in_drain};	1500	$self->_drain_rbuf unless $self->{_in_drain};
1359	$self->{tls} or return; # tls session might have gone away in callback	1501	$self->{tls} or return; # tls session might have gone away in callback
1360	}	1502	}
1361		1503
1362	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);	1504	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1363
1364	if ($tmp != Net::SSLeay::ERROR_WANT_READ ()) {
1365	if ($tmp == Net::SSLeay::ERROR_SYSCALL ()) {
1366	return $self->_error ($!, 1);	1505	return $self->_tls_error ($tmp)
1367	} elsif ($tmp == Net::SSLeay::ERROR_SSL ()) {	1506	if $tmp != $ERROR_WANT_READ
1368	return $self->_error (&Errno::EIO, 1);	1507	&& ($tmp != $ERROR_SYSCALL \|\| $!);
1369	}
1370
1371	# all other errors are fine for our purposes
1372	}
1373		1508
1374	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1509	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1375	$self->{wbuf} .= $tmp;	1510	$self->{wbuf} .= $tmp;
1376	$self->_drain_wbuf;	1511	$self->_drain_wbuf;
1377	}	1512	}
		1513
		1514	$self->{_on_starttls}
		1515	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
		1516	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");
1378	}	1517	}
1379		1518
1380	=item $handle->starttls ($tls[, $tls_ctx])	1519	=item $handle->starttls ($tls[, $tls_ctx])
1381		1520
1382	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	1521	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
…		…
1384	C<starttls>.	1523	C<starttls>.
1385		1524
1386	The first argument is the same as the C<tls> constructor argument (either	1525	The first argument is the same as the C<tls> constructor argument (either
1387	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1526	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1388		1527
1389	The second argument is the optional C<Net::SSLeay::CTX> object that is	1528	The second argument is the optional C<AnyEvent::TLS> object that is used
1390	used when AnyEvent::Handle has to create its own TLS connection object.	1529	when AnyEvent::Handle has to create its own TLS connection object, or
		1530	a hash reference with C<< key => value >> pairs that will be used to
		1531	construct a new context.
1391		1532
1392	The TLS connection object will end up in C<< $handle->{tls} >> after this	1533	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS
1393	call and can be used or changed to your liking. Note that the handshake	1534	context in C<< $handle->{tls_ctx} >> after this call and can be used or
1394	might have already started when this function returns.	1535	changed to your liking. Note that the handshake might have already started
		1536	when this function returns.
1395		1537
1396	If it an error to start a TLS handshake more than once per	1538	If it an error to start a TLS handshake more than once per
1397	AnyEvent::Handle object (this is due to bugs in OpenSSL).	1539	AnyEvent::Handle object (this is due to bugs in OpenSSL).
1398		1540
1399	=cut	1541	=cut
1400		1542
		1543	our %TLS_CACHE; #TODO not yet documented, should we?
		1544
1401	sub starttls {	1545	sub starttls {
1402	my ($self, $ssl, $ctx) = @_;	1546	my ($self, $ssl, $ctx) = @_;
1403		1547
1404	require Net::SSLeay;	1548	require Net::SSLeay;
1405		1549
1406	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"	1550	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"
1407	if $self->{tls};	1551	if $self->{tls};
		1552
		1553	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
		1554	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
		1555
		1556	$ctx \|\|= $self->{tls_ctx};
		1557
		1558	if ("HASH" eq ref $ctx) {
		1559	require AnyEvent::TLS;
		1560
		1561	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context
		1562
		1563	if ($ctx->{cache}) {
		1564	my $key = $ctx+0;
		1565	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;
		1566	} else {
		1567	$ctx = new AnyEvent::TLS %$ctx;
		1568	}
		1569	}
1408		1570
1409	if ($ssl eq "accept") {	1571	$self->{tls_ctx} = $ctx \|\| TLS_CTX ();
1410	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1572	$self->{tls} = $ssl = $self->{tls_ctx}->_get_session ($ssl, $self, $self->{peername});
1411	Net::SSLeay::set_accept_state ($ssl);
1412	} elsif ($ssl eq "connect") {
1413	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());
1414	Net::SSLeay::set_connect_state ($ssl);
1415	}
1416
1417	$self->{tls} = $ssl;
1418		1573
1419	# basically, this is deep magic (because SSL_read should have the same issues)	1574	# basically, this is deep magic (because SSL_read should have the same issues)
1420	# but the openssl maintainers basically said: "trust us, it just works".	1575	# but the openssl maintainers basically said: "trust us, it just works".
1421	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1576	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1422	# and mismaintained ssleay-module doesn't even offer them).	1577	# and mismaintained ssleay-module doesn't even offer them).
…		…
1426	#	1581	#
1427	# note that we do not try to keep the length constant between writes as we are required to do.	1582	# note that we do not try to keep the length constant between writes as we are required to do.
1428	# we assume that most (but not all) of this insanity only applies to non-blocking cases,	1583	# we assume that most (but not all) of this insanity only applies to non-blocking cases,
1429	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to	1584	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
1430	# have identity issues in that area.	1585	# have identity issues in that area.
1431	Net::SSLeay::CTX_set_mode ($self->{tls},	1586	# Net::SSLeay::CTX_set_mode ($ssl,
1432	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1587	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
1433	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));	1588	# \| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
		1589	Net::SSLeay::CTX_set_mode ($ssl, 1\|2);
1434		1590
1435	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1591	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1436	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1592	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1437		1593
1438	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1594	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
		1595
		1596	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
		1597	if $self->{on_starttls};
1439		1598
1440	&_dotls; # need to trigger the initial handshake	1599	&_dotls; # need to trigger the initial handshake
1441	$self->start_read; # make sure we actually do read	1600	$self->start_read; # make sure we actually do read
1442	}	1601	}
1443		1602
…		…
1456	if ($self->{tls}) {	1615	if ($self->{tls}) {
1457	Net::SSLeay::shutdown ($self->{tls});	1616	Net::SSLeay::shutdown ($self->{tls});
1458		1617
1459	&_dotls;	1618	&_dotls;
1460		1619
1461	# we don't give a shit. no, we do, but we can't. no...	1620	# # we don't give a shit. no, we do, but we can't. no...#d#
1462	# we, we... have to use openssl :/	1621	# # we, we... have to use openssl :/#d#
1463	&_freetls;	1622	# &_freetls;#d#
1464	}	1623	}
1465	}	1624	}
1466		1625
1467	sub _freetls {	1626	sub _freetls {
1468	my ($self) = @_;	1627	my ($self) = @_;
1469		1628
1470	return unless $self->{tls};	1629	return unless $self->{tls};
1471		1630
1472	Net::SSLeay::free (delete $self->{tls});	1631	$self->{tls_ctx}->_put_session (delete $self->{tls});
1473		1632
1474	delete @$self{qw(_rbio _wbio _tls_wbuf)};	1633	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1475	}	1634	}
1476		1635
1477	sub DESTROY {	1636	sub DESTROY {
1478	my ($self) = @_;	1637	my ($self) = @_;
1479		1638
…		…
1503	}	1662	}
1504		1663
1505	=item $handle->destroy	1664	=item $handle->destroy
1506		1665
1507	Shuts down the handle object as much as possible - this call ensures that	1666	Shuts down the handle object as much as possible - this call ensures that
1508	no further callbacks will be invoked and resources will be freed as much	1667	no further callbacks will be invoked and as many resources as possible
1509	as possible. You must not call any methods on the object afterwards.	1668	will be freed. You must not call any methods on the object afterwards.
1510		1669
1511	Normally, you can just "forget" any references to an AnyEvent::Handle	1670	Normally, you can just "forget" any references to an AnyEvent::Handle
1512	object and it will simply shut down. This works in fatal error and EOF	1671	object and it will simply shut down. This works in fatal error and EOF
1513	callbacks, as well as code outside. It does I<NOT> work in a read or write	1672	callbacks, as well as code outside. It does I<NOT> work in a read or write
1514	callback, so when you want to destroy the AnyEvent::Handle object from	1673	callback, so when you want to destroy the AnyEvent::Handle object from
1515	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in	1674	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
1516	that case.	1675	that case.
1517		1676
		1677	Destroying the handle object in this way has the advantage that callbacks
		1678	will be removed as well, so if those are the only reference holders (as
		1679	is common), then one doesn't need to do anything special to break any
		1680	reference cycles.
		1681
1518	The handle might still linger in the background and write out remaining	1682	The handle might still linger in the background and write out remaining
1519	data, as specified by the C<linger> option, however.	1683	data, as specified by the C<linger> option, however.
1520		1684
1521	=cut	1685	=cut
1522		1686
…		…
1527	%$self = ();	1691	%$self = ();
1528	}	1692	}
1529		1693
1530	=item AnyEvent::Handle::TLS_CTX	1694	=item AnyEvent::Handle::TLS_CTX
1531		1695
1532	This function creates and returns the Net::SSLeay::CTX object used by	1696	This function creates and returns the AnyEvent::TLS object used by default
1533	default for TLS mode.	1697	for TLS mode.
1534		1698
1535	The context is created like this:	1699	The context is created by calling L<AnyEvent::TLS> without any arguments.
1536
1537	Net::SSLeay::load_error_strings;
1538	Net::SSLeay::SSLeay_add_ssl_algorithms;
1539	Net::SSLeay::randomize;
1540
1541	my $CTX = Net::SSLeay::CTX_new;
1542
1543	Net::SSLeay::CTX_set_options $CTX, Net::SSLeay::OP_ALL
1544		1700
1545	=cut	1701	=cut
1546		1702
1547	our $TLS_CTX;	1703	our $TLS_CTX;
1548		1704
1549	sub TLS_CTX() {	1705	sub TLS_CTX() {
1550	$TLS_CTX \|\| do {	1706	$TLS_CTX \|\|= do {
1551	require Net::SSLeay;	1707	require AnyEvent::TLS;
1552		1708
1553	Net::SSLeay::load_error_strings ();	1709	new AnyEvent::TLS
1554	Net::SSLeay::SSLeay_add_ssl_algorithms ();
1555	Net::SSLeay::randomize ();
1556
1557	$TLS_CTX = Net::SSLeay::CTX_new ();
1558
1559	Net::SSLeay::CTX_set_options ($TLS_CTX, Net::SSLeay::OP_ALL ());
1560
1561	$TLS_CTX
1562	}	1710	}
1563	}	1711	}
1564		1712
1565	=back	1713	=back
1566		1714
…		…
1605		1753
1606	$handle->on_read (sub { });	1754	$handle->on_read (sub { });
1607	$handle->on_eof (undef);	1755	$handle->on_eof (undef);
1608	$handle->on_error (sub {	1756	$handle->on_error (sub {
1609	my $data = delete $_[0]{rbuf};	1757	my $data = delete $_[0]{rbuf};
1610	undef $handle;
1611	});	1758	});
1612		1759
1613	The reason to use C<on_error> is that TCP connections, due to latencies	1760	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	1761	and packets loss, might get closed quite violently with an error, when in
1615	fact, all data has been received.	1762	fact, all data has been received.
…		…
1631	$handle->on_drain (sub {	1778	$handle->on_drain (sub {
1632	warn "all data submitted to the kernel\n";	1779	warn "all data submitted to the kernel\n";
1633	undef $handle;	1780	undef $handle;
1634	});	1781	});
1635		1782
		1783	If you just want to queue some data and then signal EOF to the other side,
		1784	consider using C<< ->push_shutdown >> instead.
		1785
		1786	=item I want to contact a TLS/SSL server, I don't care about security.
		1787
		1788	If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS,
		1789	simply connect to it and then create the AnyEvent::Handle with the C<tls>
		1790	parameter:
		1791
		1792	tcp_connect $host, $port, sub {
		1793	my ($fh) = @_;
		1794
		1795	my $handle = new AnyEvent::Handle
		1796	fh => $fh,
		1797	tls => "connect",
		1798	on_error => sub { ... };
		1799
		1800	$handle->push_write (...);
		1801	};
		1802
		1803	=item I want to contact a TLS/SSL server, I do care about security.
		1804
		1805	Then you should additionally enable certificate verification, including
		1806	peername verification, if the protocol you use supports it (see
		1807	L<AnyEvent::TLS>, C<verify_peername>).
		1808
		1809	E.g. for HTTPS:
		1810
		1811	tcp_connect $host, $port, sub {
		1812	my ($fh) = @_;
		1813
		1814	my $handle = new AnyEvent::Handle
		1815	fh => $fh,
		1816	peername => $host,
		1817	tls => "connect",
		1818	tls_ctx => { verify => 1, verify_peername => "https" },
		1819	...
		1820
		1821	Note that you must specify the hostname you connected to (or whatever
		1822	"peername" the protocol needs) as the C<peername> argument, otherwise no
		1823	peername verification will be done.
		1824
		1825	The above will use the system-dependent default set of trusted CA
		1826	certificates. If you want to check against a specific CA, add the
		1827	C<ca_file> (or C<ca_cert>) arguments to C<tls_ctx>:
		1828
		1829	tls_ctx => {
		1830	verify => 1,
		1831	verify_peername => "https",
		1832	ca_file => "my-ca-cert.pem",
		1833	},
		1834
		1835	=item I want to create a TLS/SSL server, how do I do that?
		1836
		1837	Well, you first need to get a server certificate and key. You have
		1838	three options: a) ask a CA (buy one, use cacert.org etc.) b) create a
		1839	self-signed certificate (cheap. check the search engine of your choice,
		1840	there are many tutorials on the net) or c) make your own CA (tinyca2 is a
		1841	nice program for that purpose).
		1842
		1843	Then create a file with your private key (in PEM format, see
		1844	L<AnyEvent::TLS>), followed by the certificate (also in PEM format). The
		1845	file should then look like this:
		1846
		1847	-----BEGIN RSA PRIVATE KEY-----
		1848	...header data
		1849	... lots of base64'y-stuff
		1850	-----END RSA PRIVATE KEY-----
		1851
		1852	-----BEGIN CERTIFICATE-----
		1853	... lots of base64'y-stuff
		1854	-----END CERTIFICATE-----
		1855
		1856	The important bits are the "PRIVATE KEY" and "CERTIFICATE" parts. Then
		1857	specify this file as C<cert_file>:
		1858
		1859	tcp_server undef, $port, sub {
		1860	my ($fh) = @_;
		1861
		1862	my $handle = new AnyEvent::Handle
		1863	fh => $fh,
		1864	tls => "accept",
		1865	tls_ctx => { cert_file => "my-server-keycert.pem" },
		1866	...
		1867
		1868	When you have intermediate CA certificates that your clients might not
		1869	know about, just append them to the C<cert_file>.
		1870
1636	=back	1871	=back
1637		1872
1638		1873
1639	=head1 SUBCLASSING AnyEvent::Handle	1874	=head1 SUBCLASSING AnyEvent::Handle
1640		1875

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.120 by root, Fri Mar 27 08:33:41 2009 UTC vs. Revision 1.150 by root, Thu Jul 16 04:16:25 2009 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.120 by root, Fri Mar 27 08:33:41 2009 UTC vs.
Revision 1.150 by root, Thu Jul 16 04:16:25 2009 UTC