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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.95 by root, Thu Oct 2 06:42:39 2008 UTC vs.
Revision 1.165 by root, Mon Jul 27 22:49:23 2009 UTC

…		…
1	package AnyEvent::Handle;	1	package AnyEvent::Handle;
2		2
3	no warnings;
4	use strict qw(subs vars);
5
6	use AnyEvent ();
7	use AnyEvent::Util qw(WSAEWOULDBLOCK);
8	use Scalar::Util ();	3	use Scalar::Util ();
9	use Carp ();	4	use Carp ();
10	use Fcntl ();
11	use Errno qw(EAGAIN EINTR);	5	use Errno qw(EAGAIN EINTR);
12		6
		7	use AnyEvent (); BEGIN { AnyEvent::common_sense }
		8	use AnyEvent::Util qw(WSAEWOULDBLOCK);
		9
13	=head1 NAME	10	=head1 NAME
14		11
15	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent	12	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent
16		13
17	=cut	14	=cut
18		15
19	our $VERSION = 4.3;	16	our $VERSION = 4.87;
20		17
21	=head1 SYNOPSIS	18	=head1 SYNOPSIS
22		19
23	use AnyEvent;	20	use AnyEvent;
24	use AnyEvent::Handle;	21	use AnyEvent::Handle;
25		22
26	my $cv = AnyEvent->condvar;	23	my $cv = AnyEvent->condvar;
27		24
28	my $handle =	25	my $hdl; $hdl = new AnyEvent::Handle
29	AnyEvent::Handle->new (
30	fh => \*STDIN,	26	fh => \*STDIN,
31	on_eof => sub {	27	on_error => sub {
32	$cv->broadcast;	28	my ($hdl, $fatal, $msg) = @_;
33	},	29	warn "got error $msg\n";
		30	$hdl->destroy;
		31	$cv->send;
34	);	32	);
35		33
36	# send some request line	34	# send some request line
37	$handle->push_write ("getinfo\015\012");	35	$hdl->push_write ("getinfo\015\012");
38		36
39	# read the response line	37	# read the response line
40	$handle->push_read (line => sub {	38	$hdl->push_read (line => sub {
41	my ($handle, $line) = @_;	39	my ($hdl, $line) = @_;
42	warn "read line <$line>\n";	40	warn "got line <$line>\n";
43	$cv->send;	41	$cv->send;
44	});	42	});
45		43
46	$cv->recv;	44	$cv->recv;
47		45
48	=head1 DESCRIPTION	46	=head1 DESCRIPTION
49		47
50	This module is a helper module to make it easier to do event-based I/O on	48	This module is a helper module to make it easier to do event-based I/O on
51	filehandles. For utility functions for doing non-blocking connects and accepts	49	filehandles.
52	on sockets see L<AnyEvent::Util>.
53		50
54	The L<AnyEvent::Intro> tutorial contains some well-documented	51	The L<AnyEvent::Intro> tutorial contains some well-documented
55	AnyEvent::Handle examples.	52	AnyEvent::Handle examples.
56		53
57	In the following, when the documentation refers to of "bytes" then this	54	In the following, when the documentation refers to of "bytes" then this
58	means characters. As sysread and syswrite are used for all I/O, their	55	means characters. As sysread and syswrite are used for all I/O, their
59	treatment of characters applies to this module as well.	56	treatment of characters applies to this module as well.
60		57
		58	At the very minimum, you should specify C<fh> or C<connect>, and the
		59	C<on_error> callback.
		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 [C<fh> or C<connect> MANDATORY]
83		75
84	The filehandle this L<AnyEvent::Handle> object will operate on.	76	The filehandle this L<AnyEvent::Handle> object will operate on.
85
86	NOTE: The filehandle will be set to non-blocking mode (using	77	NOTE: The filehandle will be set to non-blocking mode (using
87	C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in	78	C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in
88	that mode.	79	that mode.
89		80
		81	=item connect => [$host, $service] [C<fh> or C<connect> MANDATORY]
		82
		83	Try to connect to the specified host and service (port), using
		84	C<AnyEvent::Socket::tcp_connect>. The C<$host> additionally becomes the
		85	default C<peername>.
		86
		87	You have to specify either this parameter, or C<fh>, above.
		88
		89	It is possible to push requests on the read and write queues, and modify
		90	properties of the stream, even while AnyEvent::Handle is connecting.
		91
		92	When this parameter is specified, then the C<on_prepare>,
		93	C<on_connect_error> and C<on_connect> callbacks will be called under the
		94	appropriate circumstances:
		95
		96	=over 4
		97
90	=item on_eof => $cb->($handle)	98	=item on_prepare => $cb->($handle)
91		99
92	Set the callback to be called when an end-of-file condition is detected,	100	This (rarely used) callback is called before a new connection is
93	i.e. in the case of a socket, when the other side has closed the	101	attempted, but after the file handle has been created. It could be used to
94	connection cleanly.	102	prepare the file handle with parameters required for the actual connect
		103	(as opposed to settings that can be changed when the connection is already
		104	established).
95		105
96	For sockets, this just means that the other side has stopped sending data,	106	The return value of this callback should be the connect timeout value in
97	you can still try to write data, and, in fact, one can return from the eof	107	seconds (or C<0>, or C<undef>, or the empty list, to indicate the default
98	callback and continue writing data, as only the read part has been shut	108	timeout is to be used).
99	down.
100		109
101	While not mandatory, it is I<highly> recommended to set an eof callback,	110	=item on_connect => $cb->($handle, $host, $port, $retry->())
102	otherwise you might end up with a closed socket while you are still
103	waiting for data.
104		111
105	If an EOF condition has been detected but no C<on_eof> callback has been	112	This callback is called when a connection has been successfully established.
106	set, then a fatal error will be raised with C<$!> set to <0>.
107		113
		114	The actual numeric host and port (the socket peername) are passed as
		115	parameters, together with a retry callback.
		116
		117	When, for some reason, the handle is not acceptable, then calling
		118	C<$retry> will continue with the next conenction target (in case of
		119	multi-homed hosts or SRV records there can be multiple connection
		120	endpoints). When it is called then the read and write queues, eof status,
		121	tls status and similar properties of the handle are being reset.
		122
		123	In most cases, ignoring the C<$retry> parameter is the way to go.
		124
		125	=item on_connect_error => $cb->($handle, $message)
		126
		127	This callback is called when the conenction could not be
		128	established. C<$!> will contain the relevant error code, and C<$message> a
		129	message describing it (usually the same as C<"$!">).
		130
		131	If this callback isn't specified, then C<on_error> will be called with a
		132	fatal error instead.
		133
		134	=back
		135
108	=item on_error => $cb->($handle, $fatal)	136	=item on_error => $cb->($handle, $fatal, $message)
109		137
110	This is the error callback, which is called when, well, some error	138	This is the error callback, which is called when, well, some error
111	occured, such as not being able to resolve the hostname, failure to	139	occured, such as not being able to resolve the hostname, failure to
112	connect or a read error.	140	connect or a read error.
113		141
114	Some errors are fatal (which is indicated by C<$fatal> being true). On	142	Some errors are fatal (which is indicated by C<$fatal> being true). On
115	fatal errors the handle object will be shut down and will not be usable	143	fatal errors the handle object will be destroyed (by a call to C<< ->
116	(but you are free to look at the current C<< ->rbuf >>). Examples of fatal	144	destroy >>) after invoking the error callback (which means you are free to
117	errors are an EOF condition with active (but unsatisifable) read watchers	145	examine the handle object). Examples of fatal errors are an EOF condition
118	(C<EPIPE>) or I/O errors.	146	with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors. In
		147	cases where the other side can close the connection at their will it is
		148	often easiest to not report C<EPIPE> errors in this callback.
		149
		150	AnyEvent::Handle tries to find an appropriate error code for you to check
		151	against, but in some cases (TLS errors), this does not work well. It is
		152	recommended to always output the C<$message> argument in human-readable
		153	error messages (it's usually the same as C<"$!">).
119		154
120	Non-fatal errors can be retried by simply returning, but it is recommended	155	Non-fatal errors can be retried by simply returning, but it is recommended
121	to simply ignore this parameter and instead abondon the handle object	156	to simply ignore this parameter and instead abondon the handle object
122	when this callback is invoked. Examples of non-fatal errors are timeouts	157	when this callback is invoked. Examples of non-fatal errors are timeouts
123	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).	158	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
124		159
125	On callback entrance, the value of C<$!> contains the operating system	160	On callback entrance, the value of C<$!> contains the operating system
126	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).	161	error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
		162	C<EPROTO>).
127		163
128	While not mandatory, it is I<highly> recommended to set this callback, as	164	While not mandatory, it is I<highly> recommended to set this callback, as
129	you will not be notified of errors otherwise. The default simply calls	165	you will not be notified of errors otherwise. The default simply calls
130	C<croak>.	166	C<croak>.
131		167
135	and no read request is in the queue (unlike read queue callbacks, this	171	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	172	callback will only be called when at least one octet of data is in the
137	read buffer).	173	read buffer).
138		174
139	To access (and remove data from) the read buffer, use the C<< ->rbuf >>	175	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
140	method or access the C<$handle->{rbuf}> member directly.	176	method or access the C<< $handle->{rbuf} >> member directly. Note that you
		177	must not enlarge or modify the read buffer, you can only remove data at
		178	the beginning from it.
141		179
142	When an EOF condition is detected then AnyEvent::Handle will first try to	180	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	181	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	182	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>).	183	error will be raised (with C<$!> set to C<EPIPE>).
		184
		185	Note that, unlike requests in the read queue, an C<on_read> callback
		186	doesn't mean you I<require> some data: if there is an EOF and there
		187	are outstanding read requests then an error will be flagged. With an
		188	C<on_read> callback, the C<on_eof> callback will be invoked.
		189
		190	=item on_eof => $cb->($handle)
		191
		192	Set the callback to be called when an end-of-file condition is detected,
		193	i.e. in the case of a socket, when the other side has closed the
		194	connection cleanly, and there are no outstanding read requests in the
		195	queue (if there are read requests, then an EOF counts as an unexpected
		196	connection close and will be flagged as an error).
		197
		198	For sockets, this just means that the other side has stopped sending data,
		199	you can still try to write data, and, in fact, one can return from the EOF
		200	callback and continue writing data, as only the read part has been shut
		201	down.
		202
		203	If an EOF condition has been detected but no C<on_eof> callback has been
		204	set, then a fatal error will be raised with C<$!> set to <0>.
146		205
147	=item on_drain => $cb->($handle)	206	=item on_drain => $cb->($handle)
148		207
149	This sets the callback that is called when the write buffer becomes empty	208	This sets the callback that is called when the write buffer becomes empty
150	(or when the callback is set and the buffer is empty already).	209	(or when the callback is set and the buffer is empty already).
…		…
243		302
244	This will not work for partial TLS data that could not be encoded	303	This will not work for partial TLS data that could not be encoded
245	yet. This data will be lost. Calling the C<stoptls> method in time might	304	yet. This data will be lost. Calling the C<stoptls> method in time might
246	help.	305	help.
247		306
		307	=item peername => $string
		308
		309	A string used to identify the remote site - usually the DNS hostname
		310	(I<not> IDN!) used to create the connection, rarely the IP address.
		311
		312	Apart from being useful in error messages, this string is also used in TLS
		313	peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This
		314	verification will be skipped when C<peername> is not specified or
		315	C<undef>.
		316
248	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	317	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
249		318
250	When this parameter is given, it enables TLS (SSL) mode, that means	319	When this parameter is given, it enables TLS (SSL) mode, that means
251	AnyEvent will start a TLS handshake as soon as the conenction has been	320	AnyEvent will start a TLS handshake as soon as the conenction has been
252	established and will transparently encrypt/decrypt data afterwards.	321	established and will transparently encrypt/decrypt data afterwards.
		322
		323	All TLS protocol errors will be signalled as C<EPROTO>, with an
		324	appropriate error message.
253		325
254	TLS mode requires Net::SSLeay to be installed (it will be loaded	326	TLS mode requires Net::SSLeay to be installed (it will be loaded
255	automatically when you try to create a TLS handle): this module doesn't	327	automatically when you try to create a TLS handle): this module doesn't
256	have a dependency on that module, so if your module requires it, you have	328	have a dependency on that module, so if your module requires it, you have
257	to add the dependency yourself.	329	to add the dependency yourself.
…		…
261	mode.	333	mode.
262		334
263	You can also provide your own TLS connection object, but you have	335	You can also provide your own TLS connection object, but you have
264	to make sure that you call either C<Net::SSLeay::set_connect_state>	336	to make sure that you call either C<Net::SSLeay::set_connect_state>
265	or C<Net::SSLeay::set_accept_state> on it before you pass it to	337	or C<Net::SSLeay::set_accept_state> on it before you pass it to
266	AnyEvent::Handle.	338	AnyEvent::Handle. Also, this module will take ownership of this connection
		339	object.
		340
		341	At some future point, AnyEvent::Handle might switch to another TLS
		342	implementation, then the option to use your own session object will go
		343	away.
		344
		345	B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,
		346	passing in the wrong integer will lead to certain crash. This most often
		347	happens when one uses a stylish C<< tls => 1 >> and is surprised about the
		348	segmentation fault.
267		349
268	See the C<< ->starttls >> method for when need to start TLS negotiation later.	350	See the C<< ->starttls >> method for when need to start TLS negotiation later.
269		351
270	=item tls_ctx => $ssl_ctx	352	=item tls_ctx => $anyevent_tls
271		353
272	Use the given C<Net::SSLeay::CTX> object to create the new TLS connection	354	Use the given C<AnyEvent::TLS> object to create the new TLS connection
273	(unless a connection object was specified directly). If this parameter is	355	(unless a connection object was specified directly). If this parameter is
274	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	356	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
		357
		358	Instead of an object, you can also specify a hash reference with C<< key
		359	=> value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a
		360	new TLS context object.
		361
		362	=item on_starttls => $cb->($handle, $success[, $error_message])
		363
		364	This callback will be invoked when the TLS/SSL handshake has finished. If
		365	C<$success> is true, then the TLS handshake succeeded, otherwise it failed
		366	(C<on_stoptls> will not be called in this case).
		367
		368	The session in C<< $handle->{tls} >> can still be examined in this
		369	callback, even when the handshake was not successful.
		370
		371	TLS handshake failures will not cause C<on_error> to be invoked when this
		372	callback is in effect, instead, the error message will be passed to C<on_starttls>.
		373
		374	Without this callback, handshake failures lead to C<on_error> being
		375	called, as normal.
		376
		377	Note that you cannot call C<starttls> right again in this callback. If you
		378	need to do that, start an zero-second timer instead whose callback can
		379	then call C<< ->starttls >> again.
		380
		381	=item on_stoptls => $cb->($handle)
		382
		383	When a SSLv3/TLS shutdown/close notify/EOF is detected and this callback is
		384	set, then it will be invoked after freeing the TLS session. If it is not,
		385	then a TLS shutdown condition will be treated like a normal EOF condition
		386	on the handle.
		387
		388	The session in C<< $handle->{tls} >> can still be examined in this
		389	callback.
		390
		391	This callback will only be called on TLS shutdowns, not when the
		392	underlying handle signals EOF.
275		393
276	=item json => JSON or JSON::XS object	394	=item json => JSON or JSON::XS object
277		395
278	This is the json coder object used by the C<json> read and write types.	396	This is the json coder object used by the C<json> read and write types.
279		397
…		…
288		406
289	=cut	407	=cut
290		408
291	sub new {	409	sub new {
292	my $class = shift;	410	my $class = shift;
293
294	my $self = bless { @_ }, $class;	411	my $self = bless { @_ }, $class;
295		412
296	$self->{fh} or Carp::croak "mandatory argument fh is missing";	413	if ($self->{fh}) {
		414	$self->_start;
		415	return unless $self->{fh}; # could be gone by now
		416
		417	} elsif ($self->{connect}) {
		418	require AnyEvent::Socket;
		419
		420	$self->{peername} = $self->{connect}[0]
		421	unless exists $self->{peername};
		422
		423	$self->{_skip_drain_rbuf} = 1;
		424
		425	{
		426	Scalar::Util::weaken (my $self = $self);
		427
		428	$self->{_connect} =
		429	AnyEvent::Socket::tcp_connect (
		430	$self->{connect}[0],
		431	$self->{connect}[1],
		432	sub {
		433	my ($fh, $host, $port, $retry) = @_;
		434
		435	if ($fh) {
		436	$self->{fh} = $fh;
		437
		438	delete $self->{_skip_drain_rbuf};
		439	$self->_start;
		440
		441	$self->{on_connect}
		442	and $self->{on_connect}($self, $host, $port, sub {
		443	delete @$self{qw(fh _tw _ww _rw _eof _queue rbuf _wbuf tls _tls_rbuf _tls_wbuf)};
		444	$self->{_skip_drain_rbuf} = 1;
		445	&$retry;
		446	});
		447
		448	} else {
		449	if ($self->{on_connect_error}) {
		450	$self->{on_connect_error}($self, "$!");
		451	$self->destroy;
		452	} else {
		453	$self->_error ($!, 1);
		454	}
		455	}
		456	},
		457	sub {
		458	local $self->{fh} = $_[0];
		459
		460	$self->{on_prepare}
		461	? $self->{on_prepare}->($self)
		462	: ()
		463	}
		464	);
		465	}
		466
		467	} else {
		468	Carp::croak "AnyEvent::Handle: either an existing fh or the connect parameter must be specified";
		469	}
		470
		471	$self
		472	}
		473
		474	sub _start {
		475	my ($self) = @_;
297		476
298	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	477	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
		478
		479	$self->{_activity} = AnyEvent->now;
		480	$self->_timeout;
		481
		482	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
299		483
300	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})	484	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
301	if $self->{tls};	485	if $self->{tls};
302		486
303	$self->{_activity} = AnyEvent->now;
304	$self->_timeout;
305
306	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};	487	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
307	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
308		488
309	$self->start_read	489	$self->start_read
310	if $self->{on_read};	490	if $self->{on_read} \|\| @{ $self->{_queue} };
311		491
312	$self	492	$self->_drain_wbuf;
313	}	493	}
314		494
315	sub _shutdown {	495	#sub _shutdown {
316	my ($self) = @_;	496	# my ($self) = @_;
317		497	#
318	delete $self->{_tw};	498	# delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)};
319	delete $self->{_rw};	499	# $self->{_eof} = 1; # tell starttls et. al to stop trying
320	delete $self->{_ww};	500	#
321	delete $self->{fh};
322
323	&_freetls;	501	# &_freetls;
324		502	#}
325	delete $self->{on_read};
326	delete $self->{_queue};
327	}
328		503
329	sub _error {	504	sub _error {
330	my ($self, $errno, $fatal) = @_;	505	my ($self, $errno, $fatal, $message) = @_;
331
332	$self->_shutdown
333	if $fatal;
334		506
335	$! = $errno;	507	$! = $errno;
		508	$message \|\|= "$!";
336		509
337	if ($self->{on_error}) {	510	if ($self->{on_error}) {
338	$self->{on_error}($self, $fatal);	511	$self->{on_error}($self, $fatal, $message);
339	} else {	512	$self->destroy if $fatal;
		513	} elsif ($self->{fh}) {
		514	$self->destroy;
340	Carp::croak "AnyEvent::Handle uncaught error: $!";	515	Carp::croak "AnyEvent::Handle uncaught error: $message";
341	}	516	}
342	}	517	}
343		518
344	=item $fh = $handle->fh	519	=item $fh = $handle->fh
345		520
…		…
382	}	557	}
383		558
384	=item $handle->autocork ($boolean)	559	=item $handle->autocork ($boolean)
385		560
386	Enables or disables the current autocork behaviour (see C<autocork>	561	Enables or disables the current autocork behaviour (see C<autocork>
387	constructor argument).	562	constructor argument). Changes will only take effect on the next write.
388		563
389	=cut	564	=cut
		565
		566	sub autocork {
		567	$_[0]{autocork} = $_[1];
		568	}
390		569
391	=item $handle->no_delay ($boolean)	570	=item $handle->no_delay ($boolean)
392		571
393	Enables or disables the C<no_delay> setting (see constructor argument of	572	Enables or disables the C<no_delay> setting (see constructor argument of
394	the same name for details).	573	the same name for details).
…		…
398	sub no_delay {	577	sub no_delay {
399	$_[0]{no_delay} = $_[1];	578	$_[0]{no_delay} = $_[1];
400		579
401	eval {	580	eval {
402	local $SIG{__DIE__};	581	local $SIG{__DIE__};
403	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];	582	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1]
		583	if $_[0]{fh};
404	};	584	};
		585	}
		586
		587	=item $handle->on_starttls ($cb)
		588
		589	Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument).
		590
		591	=cut
		592
		593	sub on_starttls {
		594	$_[0]{on_starttls} = $_[1];
		595	}
		596
		597	=item $handle->on_stoptls ($cb)
		598
		599	Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).
		600
		601	=cut
		602
		603	sub on_starttls {
		604	$_[0]{on_stoptls} = $_[1];
405	}	605	}
406		606
407	#############################################################################	607	#############################################################################
408		608
409	=item $handle->timeout ($seconds)	609	=item $handle->timeout ($seconds)
…		…
422	# reset the timeout watcher, as neccessary	622	# reset the timeout watcher, as neccessary
423	# also check for time-outs	623	# also check for time-outs
424	sub _timeout {	624	sub _timeout {
425	my ($self) = @_;	625	my ($self) = @_;
426		626
427	if ($self->{timeout}) {	627	if ($self->{timeout} && $self->{fh}) {
428	my $NOW = AnyEvent->now;	628	my $NOW = AnyEvent->now;
429		629
430	# when would the timeout trigger?	630	# when would the timeout trigger?
431	my $after = $self->{_activity} + $self->{timeout} - $NOW;	631	my $after = $self->{_activity} + $self->{timeout} - $NOW;
432		632
…		…
435	$self->{_activity} = $NOW;	635	$self->{_activity} = $NOW;
436		636
437	if ($self->{on_timeout}) {	637	if ($self->{on_timeout}) {
438	$self->{on_timeout}($self);	638	$self->{on_timeout}($self);
439	} else {	639	} else {
440	$self->_error (&Errno::ETIMEDOUT);	640	$self->_error (Errno::ETIMEDOUT);
441	}	641	}
442		642
443	# callback could have changed timeout value, optimise	643	# callback could have changed timeout value, optimise
444	return unless $self->{timeout};	644	return unless $self->{timeout};
445		645
…		…
508	Scalar::Util::weaken $self;	708	Scalar::Util::weaken $self;
509		709
510	my $cb = sub {	710	my $cb = sub {
511	my $len = syswrite $self->{fh}, $self->{wbuf};	711	my $len = syswrite $self->{fh}, $self->{wbuf};
512		712
513	if ($len >= 0) {	713	if (defined $len) {
514	substr $self->{wbuf}, 0, $len, "";	714	substr $self->{wbuf}, 0, $len, "";
515		715
516	$self->{_activity} = AnyEvent->now;	716	$self->{_activity} = AnyEvent->now;
517		717
518	$self->{on_drain}($self)	718	$self->{on_drain}($self)
…		…
550	->($self, @_);	750	->($self, @_);
551	}	751	}
552		752
553	if ($self->{tls}) {	753	if ($self->{tls}) {
554	$self->{_tls_wbuf} .= $_[0];	754	$self->{_tls_wbuf} .= $_[0];
555	&_dotls ($self);	755	&_dotls ($self) if $self->{fh};
556	} else {	756	} else {
557	$self->{wbuf} .= $_[0];	757	$self->{wbuf} .= $_[0];
558	$self->_drain_wbuf;	758	$self->_drain_wbuf if $self->{fh};
559	}	759	}
560	}	760	}
561		761
562	=item $handle->push_write (type => @args)	762	=item $handle->push_write (type => @args)
563		763
…		…
577	=cut	777	=cut
578		778
579	register_write_type netstring => sub {	779	register_write_type netstring => sub {
580	my ($self, $string) = @_;	780	my ($self, $string) = @_;
581		781
582	sprintf "%d:%s,", (length $string), $string	782	(length $string) . ":$string,"
583	};	783	};
584		784
585	=item packstring => $format, $data	785	=item packstring => $format, $data
586		786
587	An octet string prefixed with an encoded length. The encoding C<$format>	787	An octet string prefixed with an encoded length. The encoding C<$format>
…		…
652		852
653	pack "w/a*", Storable::nfreeze ($ref)	853	pack "w/a*", Storable::nfreeze ($ref)
654	};	854	};
655		855
656	=back	856	=back
		857
		858	=item $handle->push_shutdown
		859
		860	Sometimes you know you want to close the socket after writing your data
		861	before it was actually written. One way to do that is to replace your
		862	C<on_drain> handler by a callback that shuts down the socket (and set
		863	C<low_water_mark> to C<0>). This method is a shorthand for just that, and
		864	replaces the C<on_drain> callback with:
		865
		866	sub { shutdown $_[0]{fh}, 1 } # for push_shutdown
		867
		868	This simply shuts down the write side and signals an EOF condition to the
		869	the peer.
		870
		871	You can rely on the normal read queue and C<on_eof> handling
		872	afterwards. This is the cleanest way to close a connection.
		873
		874	=cut
		875
		876	sub push_shutdown {
		877	my ($self) = @_;
		878
		879	delete $self->{low_water_mark};
		880	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });
		881	}
657		882
658	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	883	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
659		884
660	This function (not method) lets you add your own types to C<push_write>.	885	This function (not method) lets you add your own types to C<push_write>.
661	Whenever the given C<type> is used, C<push_write> will invoke the code	886	Whenever the given C<type> is used, C<push_write> will invoke the code
…		…
755	=cut	980	=cut
756		981
757	sub _drain_rbuf {	982	sub _drain_rbuf {
758	my ($self) = @_;	983	my ($self) = @_;
759		984
		985	# avoid recursion
		986	return if exists $self->{_skip_drain_rbuf};
760	local $self->{_in_drain} = 1;	987	local $self->{_skip_drain_rbuf} = 1;
761		988
762	if (	989	if (
763	defined $self->{rbuf_max}	990	defined $self->{rbuf_max}
764	&& $self->{rbuf_max} < length $self->{rbuf}	991	&& $self->{rbuf_max} < length $self->{rbuf}
765	) {	992	) {
766	$self->_error (&Errno::ENOSPC, 1), return;	993	$self->_error (Errno::ENOSPC, 1), return;
767	}	994	}
768		995
769	while () {	996	while () {
		997	# we need to use a separate tls read buffer, as we must not receive data while
		998	# we are draining the buffer, and this can only happen with TLS.
		999	$self->{rbuf} .= delete $self->{_tls_rbuf}
		1000	if exists $self->{_tls_rbuf};
		1001
770	my $len = length $self->{rbuf};	1002	my $len = length $self->{rbuf};
771		1003
772	if (my $cb = shift @{ $self->{_queue} }) {	1004	if (my $cb = shift @{ $self->{_queue} }) {
773	unless ($cb->($self)) {	1005	unless ($cb->($self)) {
774	if ($self->{_eof}) {	1006	# no progress can be made
775	# no progress can be made (not enough data and no data forthcoming)	1007	# (not enough data and no data forthcoming)
776	$self->_error (&Errno::EPIPE, 1), return;	1008	$self->_error (Errno::EPIPE, 1), return
777	}	1009	if $self->{_eof};
778		1010
779	unshift @{ $self->{_queue} }, $cb;	1011	unshift @{ $self->{_queue} }, $cb;
780	last;	1012	last;
781	}	1013	}
782	} elsif ($self->{on_read}) {	1014	} elsif ($self->{on_read}) {
…		…
789	&& !@{ $self->{_queue} } # and the queue is still empty	1021	&& !@{ $self->{_queue} } # and the queue is still empty
790	&& $self->{on_read} # but we still have on_read	1022	&& $self->{on_read} # but we still have on_read
791	) {	1023	) {
792	# no further data will arrive	1024	# no further data will arrive
793	# so no progress can be made	1025	# so no progress can be made
794	$self->_error (&Errno::EPIPE, 1), return	1026	$self->_error (Errno::EPIPE, 1), return
795	if $self->{_eof};	1027	if $self->{_eof};
796		1028
797	last; # more data might arrive	1029	last; # more data might arrive
798	}	1030	}
799	} else {	1031	} else {
…		…
802	last;	1034	last;
803	}	1035	}
804	}	1036	}
805		1037
806	if ($self->{_eof}) {	1038	if ($self->{_eof}) {
807	if ($self->{on_eof}) {	1039	$self->{on_eof}
808	$self->{on_eof}($self)	1040	? $self->{on_eof}($self)
809	} else {	1041	: $self->_error (0, 1, "Unexpected end-of-file");
810	$self->_error (0, 1);	1042
811	}	1043	return;
812	}	1044	}
813		1045
814	# may need to restart read watcher	1046	# may need to restart read watcher
815	unless ($self->{_rw}) {	1047	unless ($self->{_rw}) {
816	$self->start_read	1048	$self->start_read
…		…
828		1060
829	sub on_read {	1061	sub on_read {
830	my ($self, $cb) = @_;	1062	my ($self, $cb) = @_;
831		1063
832	$self->{on_read} = $cb;	1064	$self->{on_read} = $cb;
833	$self->_drain_rbuf if $cb && !$self->{_in_drain};	1065	$self->_drain_rbuf if $cb;
834	}	1066	}
835		1067
836	=item $handle->rbuf	1068	=item $handle->rbuf
837		1069
838	Returns the read buffer (as a modifiable lvalue).	1070	Returns the read buffer (as a modifiable lvalue).
839		1071
840	You can access the read buffer directly as the C<< ->{rbuf} >> member, if	1072	You can access the read buffer directly as the C<< ->{rbuf} >>
841	you want.	1073	member, if you want. However, the only operation allowed on the
		1074	read buffer (apart from looking at it) is removing data from its
		1075	beginning. Otherwise modifying or appending to it is not allowed and will
		1076	lead to hard-to-track-down bugs.
842		1077
843	NOTE: The read buffer should only be used or modified if the C<on_read>,	1078	NOTE: The read buffer should only be used or modified if the C<on_read>,
844	C<push_read> or C<unshift_read> methods are used. The other read methods	1079	C<push_read> or C<unshift_read> methods are used. The other read methods
845	automatically manage the read buffer.	1080	automatically manage the read buffer.
846		1081
…		…
887	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	1122	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
888	->($self, $cb, @_);	1123	->($self, $cb, @_);
889	}	1124	}
890		1125
891	push @{ $self->{_queue} }, $cb;	1126	push @{ $self->{_queue} }, $cb;
892	$self->_drain_rbuf unless $self->{_in_drain};	1127	$self->_drain_rbuf;
893	}	1128	}
894		1129
895	sub unshift_read {	1130	sub unshift_read {
896	my $self = shift;	1131	my $self = shift;
897	my $cb = pop;	1132	my $cb = pop;
…		…
903	->($self, $cb, @_);	1138	->($self, $cb, @_);
904	}	1139	}
905		1140
906		1141
907	unshift @{ $self->{_queue} }, $cb;	1142	unshift @{ $self->{_queue} }, $cb;
908	$self->_drain_rbuf unless $self->{_in_drain};	1143	$self->_drain_rbuf;
909	}	1144	}
910		1145
911	=item $handle->push_read (type => @args, $cb)	1146	=item $handle->push_read (type => @args, $cb)
912		1147
913	=item $handle->unshift_read (type => @args, $cb)	1148	=item $handle->unshift_read (type => @args, $cb)
…		…
1046	return 1;	1281	return 1;
1047	}	1282	}
1048		1283
1049	# reject	1284	# reject
1050	if ($reject && $$rbuf =~ $reject) {	1285	if ($reject && $$rbuf =~ $reject) {
1051	$self->_error (&Errno::EBADMSG);	1286	$self->_error (Errno::EBADMSG);
1052	}	1287	}
1053		1288
1054	# skip	1289	# skip
1055	if ($skip && $$rbuf =~ $skip) {	1290	if ($skip && $$rbuf =~ $skip) {
1056	$data .= substr $$rbuf, 0, $+[0], "";	1291	$data .= substr $$rbuf, 0, $+[0], "";
…		…
1072	my ($self, $cb) = @_;	1307	my ($self, $cb) = @_;
1073		1308
1074	sub {	1309	sub {
1075	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {	1310	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
1076	if ($_[0]{rbuf} =~ /[^0-9]/) {	1311	if ($_[0]{rbuf} =~ /[^0-9]/) {
1077	$self->_error (&Errno::EBADMSG);	1312	$self->_error (Errno::EBADMSG);
1078	}	1313	}
1079	return;	1314	return;
1080	}	1315	}
1081		1316
1082	my $len = $1;	1317	my $len = $1;
…		…
1085	my $string = $_[1];	1320	my $string = $_[1];
1086	$_[0]->unshift_read (chunk => 1, sub {	1321	$_[0]->unshift_read (chunk => 1, sub {
1087	if ($_[1] eq ",") {	1322	if ($_[1] eq ",") {
1088	$cb->($_[0], $string);	1323	$cb->($_[0], $string);
1089	} else {	1324	} else {
1090	$self->_error (&Errno::EBADMSG);	1325	$self->_error (Errno::EBADMSG);
1091	}	1326	}
1092	});	1327	});
1093	});	1328	});
1094		1329
1095	1	1330	1
…		…
1101	An octet string prefixed with an encoded length. The encoding C<$format>	1336	An octet string prefixed with an encoded length. The encoding C<$format>
1102	uses the same format as a Perl C<pack> format, but must specify a single	1337	uses the same format as a Perl C<pack> format, but must specify a single
1103	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an	1338	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
1104	optional C<!>, C<< < >> or C<< > >> modifier).	1339	optional C<!>, C<< < >> or C<< > >> modifier).
1105		1340
1106	DNS over TCP uses a prefix of C<n>, EPP uses a prefix of C<N>.	1341	For example, DNS over TCP uses a prefix of C<n> (2 octet network order),
		1342	EPP uses a prefix of C<N> (4 octtes).
1107		1343
1108	Example: read a block of data prefixed by its length in BER-encoded	1344	Example: read a block of data prefixed by its length in BER-encoded
1109	format (very efficient).	1345	format (very efficient).
1110		1346
1111	$handle->push_read (packstring => "w", sub {	1347	$handle->push_read (packstring => "w", sub {
…		…
1141	}	1377	}
1142	};	1378	};
1143		1379
1144	=item json => $cb->($handle, $hash_or_arrayref)	1380	=item json => $cb->($handle, $hash_or_arrayref)
1145		1381
1146	Reads a JSON object or array, decodes it and passes it to the callback.	1382	Reads a JSON object or array, decodes it and passes it to the
		1383	callback. When a parse error occurs, an C<EBADMSG> error will be raised.
1147		1384
1148	If a C<json> object was passed to the constructor, then that will be used	1385	If a C<json> object was passed to the constructor, then that will be used
1149	for the final decode, otherwise it will create a JSON coder expecting UTF-8.	1386	for the final decode, otherwise it will create a JSON coder expecting UTF-8.
1150		1387
1151	This read type uses the incremental parser available with JSON version	1388	This read type uses the incremental parser available with JSON version
…		…
1160	=cut	1397	=cut
1161		1398
1162	register_read_type json => sub {	1399	register_read_type json => sub {
1163	my ($self, $cb) = @_;	1400	my ($self, $cb) = @_;
1164		1401
1165	require JSON;	1402	my $json = $self->{json} \|\|=
		1403	eval { require JSON::XS; JSON::XS->new->utf8 }
		1404	\|\| do { require JSON; JSON->new->utf8 };
1166		1405
1167	my $data;	1406	my $data;
1168	my $rbuf = \$self->{rbuf};	1407	my $rbuf = \$self->{rbuf};
1169		1408
1170	my $json = $self->{json} \|\|= JSON->new->utf8;
1171
1172	sub {	1409	sub {
1173	my $ref = $json->incr_parse ($self->{rbuf});	1410	my $ref = eval { $json->incr_parse ($self->{rbuf}) };
1174		1411
1175	if ($ref) {	1412	if ($ref) {
1176	$self->{rbuf} = $json->incr_text;	1413	$self->{rbuf} = $json->incr_text;
1177	$json->incr_text = "";	1414	$json->incr_text = "";
1178	$cb->($self, $ref);	1415	$cb->($self, $ref);
1179		1416
1180	1	1417	1
		1418	} elsif ($@) {
		1419	# error case
		1420	$json->incr_skip;
		1421
		1422	$self->{rbuf} = $json->incr_text;
		1423	$json->incr_text = "";
		1424
		1425	$self->_error (Errno::EBADMSG);
		1426
		1427	()
1181	} else {	1428	} else {
1182	$self->{rbuf} = "";	1429	$self->{rbuf} = "";
		1430
1183	()	1431	()
1184	}	1432	}
1185	}	1433	}
1186	};	1434	};
1187		1435
…		…
1219	# read remaining chunk	1467	# read remaining chunk
1220	$_[0]->unshift_read (chunk => $len, sub {	1468	$_[0]->unshift_read (chunk => $len, sub {
1221	if (my $ref = eval { Storable::thaw ($_[1]) }) {	1469	if (my $ref = eval { Storable::thaw ($_[1]) }) {
1222	$cb->($_[0], $ref);	1470	$cb->($_[0], $ref);
1223	} else {	1471	} else {
1224	$self->_error (&Errno::EBADMSG);	1472	$self->_error (Errno::EBADMSG);
1225	}	1473	}
1226	});	1474	});
1227	}	1475	}
1228		1476
1229	1	1477	1
…		…
1290	if ($len > 0) {	1538	if ($len > 0) {
1291	$self->{_activity} = AnyEvent->now;	1539	$self->{_activity} = AnyEvent->now;
1292		1540
1293	if ($self->{tls}) {	1541	if ($self->{tls}) {
1294	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);	1542	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
		1543
1295	&_dotls ($self);	1544	&_dotls ($self);
1296	} else {	1545	} else {
1297	$self->_drain_rbuf unless $self->{_in_drain};	1546	$self->_drain_rbuf;
1298	}	1547	}
1299		1548
1300	} elsif (defined $len) {	1549	} elsif (defined $len) {
1301	delete $self->{_rw};	1550	delete $self->{_rw};
1302	$self->{_eof} = 1;	1551	$self->{_eof} = 1;
1303	$self->_drain_rbuf unless $self->{_in_drain};	1552	$self->_drain_rbuf;
1304		1553
1305	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1554	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1306	return $self->_error ($!, 1);	1555	return $self->_error ($!, 1);
1307	}	1556	}
1308	});	1557	});
1309	}	1558	}
1310	}	1559	}
1311		1560
		1561	our $ERROR_SYSCALL;
		1562	our $ERROR_WANT_READ;
		1563
		1564	sub _tls_error {
		1565	my ($self, $err) = @_;
		1566
		1567	return $self->_error ($!, 1)
		1568	if $err == Net::SSLeay::ERROR_SYSCALL ();
		1569
		1570	my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());
		1571
		1572	# reduce error string to look less scary
		1573	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;
		1574
		1575	if ($self->{_on_starttls}) {
		1576	(delete $self->{_on_starttls})->($self, undef, $err);
		1577	&_freetls;
		1578	} else {
		1579	&_freetls;
		1580	$self->_error (Errno::EPROTO, 1, $err);
		1581	}
		1582	}
		1583
		1584	# poll the write BIO and send the data if applicable
		1585	# also decode read data if possible
		1586	# this is basiclaly our TLS state machine
		1587	# more efficient implementations are possible with openssl,
		1588	# but not with the buggy and incomplete Net::SSLeay.
1312	sub _dotls {	1589	sub _dotls {
1313	my ($self) = @_;	1590	my ($self) = @_;
1314		1591
1315	my $buf;	1592	my $tmp;
1316		1593
1317	if (length $self->{_tls_wbuf}) {	1594	if (length $self->{_tls_wbuf}) {
1318	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1595	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1319	substr $self->{_tls_wbuf}, 0, $len, "";	1596	substr $self->{_tls_wbuf}, 0, $tmp, "";
1320	}	1597	}
1321	}
1322		1598
		1599	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);
		1600	return $self->_tls_error ($tmp)
		1601	if $tmp != $ERROR_WANT_READ
		1602	&& ($tmp != $ERROR_SYSCALL \|\| $!);
		1603	}
		1604
1323	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {	1605	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
1324	unless (length $buf) {	1606	unless (length $tmp) {
1325	# let's treat SSL-eof as we treat normal EOF	1607	$self->{_on_starttls}
1326	delete $self->{_rw};	1608	and (delete $self->{_on_starttls})->($self, undef, "EOF during handshake"); # ???
1327	$self->{_eof} = 1;
1328	&_freetls;	1609	&_freetls;
		1610
		1611	if ($self->{on_stoptls}) {
		1612	$self->{on_stoptls}($self);
		1613	return;
		1614	} else {
		1615	# let's treat SSL-eof as we treat normal EOF
		1616	delete $self->{_rw};
		1617	$self->{_eof} = 1;
		1618	}
1329	}	1619	}
1330		1620
1331	$self->{rbuf} .= $buf;	1621	$self->{_tls_rbuf} .= $tmp;
1332	$self->_drain_rbuf unless $self->{_in_drain};	1622	$self->_drain_rbuf;
1333	$self->{tls} or return; # tls session might have gone away in callback	1623	$self->{tls} or return; # tls session might have gone away in callback
1334	}	1624	}
1335		1625
1336	my $err = Net::SSLeay::get_error ($self->{tls}, -1);	1626	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1337
1338	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
1339	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {
1340	return $self->_error ($!, 1);	1627	return $self->_tls_error ($tmp)
1341	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {	1628	if $tmp != $ERROR_WANT_READ
1342	return $self->_error (&Errno::EIO, 1);	1629	&& ($tmp != $ERROR_SYSCALL \|\| $!);
1343	}
1344		1630
1345	# all others are fine for our purposes
1346	}
1347
1348	if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1631	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1349	$self->{wbuf} .= $buf;	1632	$self->{wbuf} .= $tmp;
1350	$self->_drain_wbuf;	1633	$self->_drain_wbuf;
1351	}	1634	}
		1635
		1636	$self->{_on_starttls}
		1637	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
		1638	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");
1352	}	1639	}
1353		1640
1354	=item $handle->starttls ($tls[, $tls_ctx])	1641	=item $handle->starttls ($tls[, $tls_ctx])
1355		1642
1356	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	1643	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
1357	object is created, you can also do that at a later time by calling	1644	object is created, you can also do that at a later time by calling
1358	C<starttls>.	1645	C<starttls>.
1359		1646
		1647	Starting TLS is currently an asynchronous operation - when you push some
		1648	write data and then call C<< ->starttls >> then TLS negotiation will start
		1649	immediately, after which the queued write data is then sent.
		1650
1360	The first argument is the same as the C<tls> constructor argument (either	1651	The first argument is the same as the C<tls> constructor argument (either
1361	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1652	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1362		1653
1363	The second argument is the optional C<Net::SSLeay::CTX> object that is	1654	The second argument is the optional C<AnyEvent::TLS> object that is used
1364	used when AnyEvent::Handle has to create its own TLS connection object.	1655	when AnyEvent::Handle has to create its own TLS connection object, or
		1656	a hash reference with C<< key => value >> pairs that will be used to
		1657	construct a new context.
1365		1658
1366	The TLS connection object will end up in C<< $handle->{tls} >> after this	1659	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS
1367	call and can be used or changed to your liking. Note that the handshake	1660	context in C<< $handle->{tls_ctx} >> after this call and can be used or
1368	might have already started when this function returns.	1661	changed to your liking. Note that the handshake might have already started
		1662	when this function returns.
1369		1663
1370	If it an error to start a TLS handshake more than once per	1664	Due to bugs in OpenSSL, it might or might not be possible to do multiple
1371	AnyEvent::Handle object (this is due to bugs in OpenSSL).	1665	handshakes on the same stream. Best do not attempt to use the stream after
		1666	stopping TLS.
1372		1667
1373	=cut	1668	=cut
		1669
		1670	our %TLS_CACHE; #TODO not yet documented, should we?
1374		1671
1375	sub starttls {	1672	sub starttls {
1376	my ($self, $ssl, $ctx) = @_;	1673	my ($self, $tls, $ctx) = @_;
		1674
		1675	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"
		1676	if $self->{tls};
		1677
		1678	$self->{tls} = $tls;
		1679	$self->{tls_ctx} = $ctx if @_ > 2;
		1680
		1681	return unless $self->{fh};
1377		1682
1378	require Net::SSLeay;	1683	require Net::SSLeay;
1379		1684
1380	Carp::croak "it is an error to call starttls more than once on an Anyevent::Handle object"	1685	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
		1686	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
		1687
1381	if $self->{tls};	1688	$tls = $self->{tls};
		1689	$ctx = $self->{tls_ctx};
		1690
		1691	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
		1692
		1693	if ("HASH" eq ref $ctx) {
		1694	require AnyEvent::TLS;
		1695
		1696	if ($ctx->{cache}) {
		1697	my $key = $ctx+0;
		1698	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;
		1699	} else {
		1700	$ctx = new AnyEvent::TLS %$ctx;
		1701	}
		1702	}
1382		1703
1383	if ($ssl eq "accept") {	1704	$self->{tls_ctx} = $ctx \|\| TLS_CTX ();
1384	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1705	$self->{tls} = $tls = $self->{tls_ctx}->_get_session ($tls, $self, $self->{peername});
1385	Net::SSLeay::set_accept_state ($ssl);
1386	} elsif ($ssl eq "connect") {
1387	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());
1388	Net::SSLeay::set_connect_state ($ssl);
1389	}
1390
1391	$self->{tls} = $ssl;
1392		1706
1393	# basically, this is deep magic (because SSL_read should have the same issues)	1707	# basically, this is deep magic (because SSL_read should have the same issues)
1394	# but the openssl maintainers basically said: "trust us, it just works".	1708	# but the openssl maintainers basically said: "trust us, it just works".
1395	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1709	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1396	# and mismaintained ssleay-module doesn't even offer them).	1710	# and mismaintained ssleay-module doesn't even offer them).
…		…
1400	#	1714	#
1401	# note that we do not try to keep the length constant between writes as we are required to do.	1715	# note that we do not try to keep the length constant between writes as we are required to do.
1402	# we assume that most (but not all) of this insanity only applies to non-blocking cases,	1716	# we assume that most (but not all) of this insanity only applies to non-blocking cases,
1403	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to	1717	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
1404	# have identity issues in that area.	1718	# have identity issues in that area.
1405	Net::SSLeay::CTX_set_mode ($self->{tls},	1719	# Net::SSLeay::CTX_set_mode ($ssl,
1406	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1720	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
1407	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));	1721	# \| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
		1722	Net::SSLeay::CTX_set_mode ($tls, 1\|2);
1408		1723
1409	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1724	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1410	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1725	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1411		1726
1412	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1727	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
		1728
		1729	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
		1730	if $self->{on_starttls};
1413		1731
1414	&_dotls; # need to trigger the initial handshake	1732	&_dotls; # need to trigger the initial handshake
1415	$self->start_read; # make sure we actually do read	1733	$self->start_read; # make sure we actually do read
1416	}	1734	}
1417		1735
1418	=item $handle->stoptls	1736	=item $handle->stoptls
1419		1737
1420	Shuts down the SSL connection - this makes a proper EOF handshake by	1738	Shuts down the SSL connection - this makes a proper EOF handshake by
1421	sending a close notify to the other side, but since OpenSSL doesn't	1739	sending a close notify to the other side, but since OpenSSL doesn't
1422	support non-blocking shut downs, it is not possible to re-use the stream	1740	support non-blocking shut downs, it is not guarenteed that you can re-use
1423	afterwards.	1741	the stream afterwards.
1424		1742
1425	=cut	1743	=cut
1426		1744
1427	sub stoptls {	1745	sub stoptls {
1428	my ($self) = @_;	1746	my ($self) = @_;
…		…
1430	if ($self->{tls}) {	1748	if ($self->{tls}) {
1431	Net::SSLeay::shutdown ($self->{tls});	1749	Net::SSLeay::shutdown ($self->{tls});
1432		1750
1433	&_dotls;	1751	&_dotls;
1434		1752
1435	# we don't give a shit. no, we do, but we can't. no...	1753	# # we don't give a shit. no, we do, but we can't. no...#d#
1436	# we, we... have to use openssl :/	1754	# # we, we... have to use openssl :/#d#
1437	&_freetls;	1755	# &_freetls;#d#
1438	}	1756	}
1439	}	1757	}
1440		1758
1441	sub _freetls {	1759	sub _freetls {
1442	my ($self) = @_;	1760	my ($self) = @_;
1443		1761
1444	return unless $self->{tls};	1762	return unless $self->{tls};
1445		1763
1446	Net::SSLeay::free (delete $self->{tls});	1764	$self->{tls_ctx}->_put_session (delete $self->{tls})
		1765	if ref $self->{tls};
1447		1766
1448	delete @$self{qw(_rbio _wbio _tls_wbuf)};	1767	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1449	}	1768	}
1450		1769
1451	sub DESTROY {	1770	sub DESTROY {
1452	my $self = shift;	1771	my ($self) = @_;
1453		1772
1454	&_freetls;	1773	&_freetls;
1455		1774
1456	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	1775	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1457		1776
1458	if ($linger && length $self->{wbuf}) {	1777	if ($linger && length $self->{wbuf} && $self->{fh}) {
1459	my $fh = delete $self->{fh};	1778	my $fh = delete $self->{fh};
1460	my $wbuf = delete $self->{wbuf};	1779	my $wbuf = delete $self->{wbuf};
1461		1780
1462	my @linger;	1781	my @linger;
1463		1782
…		…
1474	@linger = ();	1793	@linger = ();
1475	});	1794	});
1476	}	1795	}
1477	}	1796	}
1478		1797
		1798	=item $handle->destroy
		1799
		1800	Shuts down the handle object as much as possible - this call ensures that
		1801	no further callbacks will be invoked and as many resources as possible
		1802	will be freed. Any method you will call on the handle object after
		1803	destroying it in this way will be silently ignored (and it will return the
		1804	empty list).
		1805
		1806	Normally, you can just "forget" any references to an AnyEvent::Handle
		1807	object and it will simply shut down. This works in fatal error and EOF
		1808	callbacks, as well as code outside. It does I<NOT> work in a read or write
		1809	callback, so when you want to destroy the AnyEvent::Handle object from
		1810	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
		1811	that case.
		1812
		1813	Destroying the handle object in this way has the advantage that callbacks
		1814	will be removed as well, so if those are the only reference holders (as
		1815	is common), then one doesn't need to do anything special to break any
		1816	reference cycles.
		1817
		1818	The handle might still linger in the background and write out remaining
		1819	data, as specified by the C<linger> option, however.
		1820
		1821	=cut
		1822
		1823	sub destroy {
		1824	my ($self) = @_;
		1825
		1826	$self->DESTROY;
		1827	%$self = ();
		1828	bless $self, "AnyEvent::Handle::destroyed";
		1829	}
		1830
		1831	sub AnyEvent::Handle::destroyed::AUTOLOAD {
		1832	#nop
		1833	}
		1834
1479	=item AnyEvent::Handle::TLS_CTX	1835	=item AnyEvent::Handle::TLS_CTX
1480		1836
1481	This function creates and returns the Net::SSLeay::CTX object used by	1837	This function creates and returns the AnyEvent::TLS object used by default
1482	default for TLS mode.	1838	for TLS mode.
1483		1839
1484	The context is created like this:	1840	The context is created by calling L<AnyEvent::TLS> without any arguments.
1485
1486	Net::SSLeay::load_error_strings;
1487	Net::SSLeay::SSLeay_add_ssl_algorithms;
1488	Net::SSLeay::randomize;
1489
1490	my $CTX = Net::SSLeay::CTX_new;
1491
1492	Net::SSLeay::CTX_set_options $CTX, Net::SSLeay::OP_ALL
1493		1841
1494	=cut	1842	=cut
1495		1843
1496	our $TLS_CTX;	1844	our $TLS_CTX;
1497		1845
1498	sub TLS_CTX() {	1846	sub TLS_CTX() {
1499	$TLS_CTX \|\| do {	1847	$TLS_CTX \|\|= do {
1500	require Net::SSLeay;	1848	require AnyEvent::TLS;
1501		1849
1502	Net::SSLeay::load_error_strings ();	1850	new AnyEvent::TLS
1503	Net::SSLeay::SSLeay_add_ssl_algorithms ();
1504	Net::SSLeay::randomize ();
1505
1506	$TLS_CTX = Net::SSLeay::CTX_new ();
1507
1508	Net::SSLeay::CTX_set_options ($TLS_CTX, Net::SSLeay::OP_ALL ());
1509
1510	$TLS_CTX
1511	}	1851	}
1512	}	1852	}
1513		1853
1514	=back	1854	=back
1515		1855
1516		1856
1517	=head1 NONFREQUENTLY ASKED QUESTIONS	1857	=head1 NONFREQUENTLY ASKED QUESTIONS
1518		1858
1519	=over 4	1859	=over 4
1520		1860
		1861	=item I C<undef> the AnyEvent::Handle reference inside my callback and
		1862	still get further invocations!
		1863
		1864	That's because AnyEvent::Handle keeps a reference to itself when handling
		1865	read or write callbacks.
		1866
		1867	It is only safe to "forget" the reference inside EOF or error callbacks,
		1868	from within all other callbacks, you need to explicitly call the C<<
		1869	->destroy >> method.
		1870
		1871	=item I get different callback invocations in TLS mode/Why can't I pause
		1872	reading?
		1873
		1874	Unlike, say, TCP, TLS connections do not consist of two independent
		1875	communication channels, one for each direction. Or put differently. The
		1876	read and write directions are not independent of each other: you cannot
		1877	write data unless you are also prepared to read, and vice versa.
		1878
		1879	This can mean than, in TLS mode, you might get C<on_error> or C<on_eof>
		1880	callback invocations when you are not expecting any read data - the reason
		1881	is that AnyEvent::Handle always reads in TLS mode.
		1882
		1883	During the connection, you have to make sure that you always have a
		1884	non-empty read-queue, or an C<on_read> watcher. At the end of the
		1885	connection (or when you no longer want to use it) you can call the
		1886	C<destroy> method.
		1887
1521	=item How do I read data until the other side closes the connection?	1888	=item How do I read data until the other side closes the connection?
1522		1889
1523	If you just want to read your data into a perl scalar, the easiest way to achieve this is	1890	If you just want to read your data into a perl scalar, the easiest way
1524	by setting an C<on_read> callback that does nothing, clearing the C<on_eof> callback	1891	to achieve this is by setting an C<on_read> callback that does nothing,
1525	and in the C<on_error> callback, the data will be in C<$_[0]{rbuf}>:	1892	clearing the C<on_eof> callback and in the C<on_error> callback, the data
		1893	will be in C<$_[0]{rbuf}>:
1526		1894
1527	$handle->on_read (sub { });	1895	$handle->on_read (sub { });
1528	$handle->on_eof (undef);	1896	$handle->on_eof (undef);
1529	$handle->on_error (sub {	1897	$handle->on_error (sub {
1530	my $data = delete $_[0]{rbuf};	1898	my $data = delete $_[0]{rbuf};
1531	undef $handle;
1532	});	1899	});
1533		1900
1534	The reason to use C<on_error> is that TCP connections, due to latencies	1901	The reason to use C<on_error> is that TCP connections, due to latencies
1535	and packets loss, might get closed quite violently with an error, when in	1902	and packets loss, might get closed quite violently with an error, when in
1536	fact, all data has been received.	1903	fact, all data has been received.
1537		1904
1538	It is usually better to use acknowledgements when transfering data,	1905	It is usually better to use acknowledgements when transferring data,
1539	to make sure the other side hasn't just died and you got the data	1906	to make sure the other side hasn't just died and you got the data
1540	intact. This is also one reason why so many internet protocols have an	1907	intact. This is also one reason why so many internet protocols have an
1541	explicit QUIT command.	1908	explicit QUIT command.
1542		1909
1543
1544	=item I don't want to destroy the handle too early - how do I wait until all data has been sent?	1910	=item I don't want to destroy the handle too early - how do I wait until
		1911	all data has been written?
1545		1912
1546	After writing your last bits of data, set the C<on_drain> callback	1913	After writing your last bits of data, set the C<on_drain> callback
1547	and destroy the handle in there - with the default setting of	1914	and destroy the handle in there - with the default setting of
1548	C<low_water_mark> this will be called precisely when all data has been	1915	C<low_water_mark> this will be called precisely when all data has been
1549	written to the socket:	1916	written to the socket:
…		…
1552	$handle->on_drain (sub {	1919	$handle->on_drain (sub {
1553	warn "all data submitted to the kernel\n";	1920	warn "all data submitted to the kernel\n";
1554	undef $handle;	1921	undef $handle;
1555	});	1922	});
1556		1923
		1924	If you just want to queue some data and then signal EOF to the other side,
		1925	consider using C<< ->push_shutdown >> instead.
		1926
		1927	=item I want to contact a TLS/SSL server, I don't care about security.
		1928
		1929	If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS,
		1930	simply connect to it and then create the AnyEvent::Handle with the C<tls>
		1931	parameter:
		1932
		1933	tcp_connect $host, $port, sub {
		1934	my ($fh) = @_;
		1935
		1936	my $handle = new AnyEvent::Handle
		1937	fh => $fh,
		1938	tls => "connect",
		1939	on_error => sub { ... };
		1940
		1941	$handle->push_write (...);
		1942	};
		1943
		1944	=item I want to contact a TLS/SSL server, I do care about security.
		1945
		1946	Then you should additionally enable certificate verification, including
		1947	peername verification, if the protocol you use supports it (see
		1948	L<AnyEvent::TLS>, C<verify_peername>).
		1949
		1950	E.g. for HTTPS:
		1951
		1952	tcp_connect $host, $port, sub {
		1953	my ($fh) = @_;
		1954
		1955	my $handle = new AnyEvent::Handle
		1956	fh => $fh,
		1957	peername => $host,
		1958	tls => "connect",
		1959	tls_ctx => { verify => 1, verify_peername => "https" },
		1960	...
		1961
		1962	Note that you must specify the hostname you connected to (or whatever
		1963	"peername" the protocol needs) as the C<peername> argument, otherwise no
		1964	peername verification will be done.
		1965
		1966	The above will use the system-dependent default set of trusted CA
		1967	certificates. If you want to check against a specific CA, add the
		1968	C<ca_file> (or C<ca_cert>) arguments to C<tls_ctx>:
		1969
		1970	tls_ctx => {
		1971	verify => 1,
		1972	verify_peername => "https",
		1973	ca_file => "my-ca-cert.pem",
		1974	},
		1975
		1976	=item I want to create a TLS/SSL server, how do I do that?
		1977
		1978	Well, you first need to get a server certificate and key. You have
		1979	three options: a) ask a CA (buy one, use cacert.org etc.) b) create a
		1980	self-signed certificate (cheap. check the search engine of your choice,
		1981	there are many tutorials on the net) or c) make your own CA (tinyca2 is a
		1982	nice program for that purpose).
		1983
		1984	Then create a file with your private key (in PEM format, see
		1985	L<AnyEvent::TLS>), followed by the certificate (also in PEM format). The
		1986	file should then look like this:
		1987
		1988	-----BEGIN RSA PRIVATE KEY-----
		1989	...header data
		1990	... lots of base64'y-stuff
		1991	-----END RSA PRIVATE KEY-----
		1992
		1993	-----BEGIN CERTIFICATE-----
		1994	... lots of base64'y-stuff
		1995	-----END CERTIFICATE-----
		1996
		1997	The important bits are the "PRIVATE KEY" and "CERTIFICATE" parts. Then
		1998	specify this file as C<cert_file>:
		1999
		2000	tcp_server undef, $port, sub {
		2001	my ($fh) = @_;
		2002
		2003	my $handle = new AnyEvent::Handle
		2004	fh => $fh,
		2005	tls => "accept",
		2006	tls_ctx => { cert_file => "my-server-keycert.pem" },
		2007	...
		2008
		2009	When you have intermediate CA certificates that your clients might not
		2010	know about, just append them to the C<cert_file>.
		2011
1557	=back	2012	=back
1558		2013
1559		2014
1560	=head1 SUBCLASSING AnyEvent::Handle	2015	=head1 SUBCLASSING AnyEvent::Handle
1561		2016

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.95 by root, Thu Oct 2 06:42:39 2008 UTC vs. Revision 1.165 by root, Mon Jul 27 22:49:23 2009 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.95 by root, Thu Oct 2 06:42:39 2008 UTC vs.
Revision 1.165 by root, Mon Jul 27 22:49:23 2009 UTC