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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.102 by root, Wed Oct 29 14:32:02 2008 UTC vs.
Revision 1.167 by root, Tue Jul 28 11:02:19 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.881;
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	=head1 METHODS	64	=head1 METHODS
65		65
66	=over 4	66	=over 4
67		67
68	=item B<new (%args)>	68	=item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value...
69		69
70	The constructor supports these arguments (all as key => value pairs).	70	The constructor supports these arguments (all as C<< key => value >> pairs).
71		71
72	=over 4	72	=over 4
73		73
74	=item fh => $filehandle [MANDATORY]	74	=item fh => $filehandle [C<fh> or C<connect> MANDATORY]
75		75
76	The filehandle this L<AnyEvent::Handle> object will operate on.	76	The filehandle this L<AnyEvent::Handle> object will operate on.
77
78	NOTE: The filehandle will be set to non-blocking mode (using	77	NOTE: The filehandle will be set to non-blocking mode (using
79	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
80	that mode.	79	that mode.
81		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
		98	=item on_prepare => $cb->($handle)
		99
		100	This (rarely used) callback is called before a new connection is
		101	attempted, but after the file handle has been created. It could be used to
		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).
		105
		106	The return value of this callback should be the connect timeout value in
		107	seconds (or C<0>, or C<undef>, or the empty list, to indicate the default
		108	timeout is to be used).
		109
		110	=item on_connect => $cb->($handle, $host, $port, $retry->())
		111
		112	This callback is called when a connection has been successfully established.
		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
		136	=item on_error => $cb->($handle, $fatal, $message)
		137
		138	This is the error callback, which is called when, well, some error
		139	occured, such as not being able to resolve the hostname, failure to
		140	connect or a read error.
		141
		142	Some errors are fatal (which is indicated by C<$fatal> being true). On
		143	fatal errors the handle object will be destroyed (by a call to C<< ->
		144	destroy >>) after invoking the error callback (which means you are free to
		145	examine the handle object). Examples of fatal errors are an EOF condition
		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<"$!">).
		154
		155	Non-fatal errors can be retried by simply returning, but it is recommended
		156	to simply ignore this parameter and instead abondon the handle object
		157	when this callback is invoked. Examples of non-fatal errors are timeouts
		158	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
		159
		160	On callback entrance, the value of C<$!> contains the operating system
		161	error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
		162	C<EPROTO>).
		163
		164	While not mandatory, it is I<highly> recommended to set this callback, as
		165	you will not be notified of errors otherwise. The default simply calls
		166	C<croak>.
		167
		168	=item on_read => $cb->($handle)
		169
		170	This sets the default read callback, which is called when data arrives
		171	and no read request is in the queue (unlike read queue callbacks, this
		172	callback will only be called when at least one octet of data is in the
		173	read buffer).
		174
		175	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
		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.
		179
		180	When an EOF condition is detected then AnyEvent::Handle will first try to
		181	feed all the remaining data to the queued callbacks and C<on_read> before
		182	calling the C<on_eof> callback. If no progress can be made, then a fatal
		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
82	=item on_eof => $cb->($handle)	190	=item on_eof => $cb->($handle)
83		191
84	Set the callback to be called when an end-of-file condition is detected,	192	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	193	i.e. in the case of a socket, when the other side has closed the
86	connection cleanly.	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).
87		197
88	For sockets, this just means that the other side has stopped sending data,	198	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	199	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	200	callback and continue writing data, as only the read part has been shut
91	down.	201	down.
92		202
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	203	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>.	204	set, then a fatal error will be raised with C<$!> set to <0>.
99
100	=item on_error => $cb->($handle, $fatal)
101
102	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
104	connect or a read error.
105
106	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
108	(but you are free to look at the current C<< ->rbuf >>). Examples of fatal
109	errors are an EOF condition with active (but unsatisifable) read watchers
110	(C<EPIPE>) or I/O errors.
111
112	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
114	when this callback is invoked. Examples of non-fatal errors are timeouts
115	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
116
117	On callback entrance, the value of C<$!> contains the operating system
118	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).
119
120	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
122	C<croak>.
123
124	=item on_read => $cb->($handle)
125
126	This sets the default read callback, which is called when data arrives
127	and no read request is in the queue (unlike read queue callbacks, this
128	callback will only be called when at least one octet of data is in the
129	read buffer).
130
131	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
132	method or access the C<$handle->{rbuf}> member directly.
133
134	When an EOF condition is detected then AnyEvent::Handle will first try to
135	feed all the remaining data to the queued callbacks and C<on_read> before
136	calling the C<on_eof> callback. If no progress can be made, then a fatal
137	error will be raised (with C<$!> set to C<EPIPE>).
138		205
139	=item on_drain => $cb->($handle)	206	=item on_drain => $cb->($handle)
140		207
141	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
142	(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).
235		302
236	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
237	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
238	help.	305	help.
239		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
240	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	317	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
241		318
242	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
243	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
244	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.
245		325
246	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
247	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
248	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
249	to add the dependency yourself.	329	to add the dependency yourself.
…		…
253	mode.	333	mode.
254		334
255	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
256	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>
257	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
258	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.
259		349
260	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.
261		351
262	=item tls_ctx => $ssl_ctx	352	=item tls_ctx => $anyevent_tls
263		353
264	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
265	(unless a connection object was specified directly). If this parameter is	355	(unless a connection object was specified directly). If this parameter is
266	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.
267		393
268	=item json => JSON or JSON::XS object	394	=item json => JSON or JSON::XS object
269		395
270	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.
271		397
…		…
280		406
281	=cut	407	=cut
282		408
283	sub new {	409	sub new {
284	my $class = shift;	410	my $class = shift;
285
286	my $self = bless { @_ }, $class;	411	my $self = bless { @_ }, $class;
287		412
288	$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) = @_;
289		476
290	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};
291		483
292	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})	484	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
293	if $self->{tls};	485	if $self->{tls};
294		486
295	$self->{_activity} = AnyEvent->now;
296	$self->_timeout;
297
298	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};	487	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
299	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
300		488
301	$self->start_read	489	$self->start_read
302	if $self->{on_read};	490	if $self->{on_read} \|\| @{ $self->{_queue} };
303		491
304	$self	492	$self->_drain_wbuf;
305	}	493	}
306		494
307	sub _shutdown {	495	#sub _shutdown {
308	my ($self) = @_;	496	# my ($self) = @_;
309		497	#
310	delete $self->{_tw};	498	# delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)};
311	delete $self->{_rw};	499	# $self->{_eof} = 1; # tell starttls et. al to stop trying
312	delete $self->{_ww};	500	#
313	delete $self->{fh};
314
315	&_freetls;	501	# &_freetls;
316		502	#}
317	delete $self->{on_read};
318	delete $self->{_queue};
319	}
320		503
321	sub _error {	504	sub _error {
322	my ($self, $errno, $fatal) = @_;	505	my ($self, $errno, $fatal, $message) = @_;
323
324	$self->_shutdown
325	if $fatal;
326		506
327	$! = $errno;	507	$! = $errno;
		508	$message \|\|= "$!";
328		509
329	if ($self->{on_error}) {	510	if ($self->{on_error}) {
330	$self->{on_error}($self, $fatal);	511	$self->{on_error}($self, $fatal, $message);
		512	$self->destroy if $fatal;
331	} elsif ($self->{fh}) {	513	} elsif ($self->{fh}) {
		514	$self->destroy;
332	Carp::croak "AnyEvent::Handle uncaught error: $!";	515	Carp::croak "AnyEvent::Handle uncaught error: $message";
333	}	516	}
334	}	517	}
335		518
336	=item $fh = $handle->fh	519	=item $fh = $handle->fh
337		520
…		…
374	}	557	}
375		558
376	=item $handle->autocork ($boolean)	559	=item $handle->autocork ($boolean)
377		560
378	Enables or disables the current autocork behaviour (see C<autocork>	561	Enables or disables the current autocork behaviour (see C<autocork>
379	constructor argument).	562	constructor argument). Changes will only take effect on the next write.
380		563
381	=cut	564	=cut
		565
		566	sub autocork {
		567	$_[0]{autocork} = $_[1];
		568	}
382		569
383	=item $handle->no_delay ($boolean)	570	=item $handle->no_delay ($boolean)
384		571
385	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
386	the same name for details).	573	the same name for details).
…		…
390	sub no_delay {	577	sub no_delay {
391	$_[0]{no_delay} = $_[1];	578	$_[0]{no_delay} = $_[1];
392		579
393	eval {	580	eval {
394	local $SIG{__DIE__};	581	local $SIG{__DIE__};
395	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};
396	};	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];
397	}	605	}
398		606
399	#############################################################################	607	#############################################################################
400		608
401	=item $handle->timeout ($seconds)	609	=item $handle->timeout ($seconds)
…		…
414	# reset the timeout watcher, as neccessary	622	# reset the timeout watcher, as neccessary
415	# also check for time-outs	623	# also check for time-outs
416	sub _timeout {	624	sub _timeout {
417	my ($self) = @_;	625	my ($self) = @_;
418		626
419	if ($self->{timeout}) {	627	if ($self->{timeout} && $self->{fh}) {
420	my $NOW = AnyEvent->now;	628	my $NOW = AnyEvent->now;
421		629
422	# when would the timeout trigger?	630	# when would the timeout trigger?
423	my $after = $self->{_activity} + $self->{timeout} - $NOW;	631	my $after = $self->{_activity} + $self->{timeout} - $NOW;
424		632
…		…
427	$self->{_activity} = $NOW;	635	$self->{_activity} = $NOW;
428		636
429	if ($self->{on_timeout}) {	637	if ($self->{on_timeout}) {
430	$self->{on_timeout}($self);	638	$self->{on_timeout}($self);
431	} else {	639	} else {
432	$self->_error (&Errno::ETIMEDOUT);	640	$self->_error (Errno::ETIMEDOUT);
433	}	641	}
434		642
435	# callback could have changed timeout value, optimise	643	# callback could have changed timeout value, optimise
436	return unless $self->{timeout};	644	return unless $self->{timeout};
437		645
…		…
500	Scalar::Util::weaken $self;	708	Scalar::Util::weaken $self;
501		709
502	my $cb = sub {	710	my $cb = sub {
503	my $len = syswrite $self->{fh}, $self->{wbuf};	711	my $len = syswrite $self->{fh}, $self->{wbuf};
504		712
505	if ($len >= 0) {	713	if (defined $len) {
506	substr $self->{wbuf}, 0, $len, "";	714	substr $self->{wbuf}, 0, $len, "";
507		715
508	$self->{_activity} = AnyEvent->now;	716	$self->{_activity} = AnyEvent->now;
509		717
510	$self->{on_drain}($self)	718	$self->{on_drain}($self)
…		…
542	->($self, @_);	750	->($self, @_);
543	}	751	}
544		752
545	if ($self->{tls}) {	753	if ($self->{tls}) {
546	$self->{_tls_wbuf} .= $_[0];	754	$self->{_tls_wbuf} .= $_[0];
547		755	&_dotls ($self) if $self->{fh};
548	&_dotls ($self);
549	} else {	756	} else {
550	$self->{wbuf} .= $_[0];	757	$self->{wbuf} .= $_[0];
551	$self->_drain_wbuf;	758	$self->_drain_wbuf if $self->{fh};
552	}	759	}
553	}	760	}
554		761
555	=item $handle->push_write (type => @args)	762	=item $handle->push_write (type => @args)
556		763
…		…
645		852
646	pack "w/a*", Storable::nfreeze ($ref)	853	pack "w/a*", Storable::nfreeze ($ref)
647	};	854	};
648		855
649	=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	}
650		882
651	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	883	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
652		884
653	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>.
654	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
…		…
748	=cut	980	=cut
749		981
750	sub _drain_rbuf {	982	sub _drain_rbuf {
751	my ($self) = @_;	983	my ($self) = @_;
752		984
		985	# avoid recursion
		986	return if $self->{_skip_drain_rbuf};
753	local $self->{_in_drain} = 1;	987	local $self->{_skip_drain_rbuf} = 1;
754		988
755	if (	989	if (
756	defined $self->{rbuf_max}	990	defined $self->{rbuf_max}
757	&& $self->{rbuf_max} < length $self->{rbuf}	991	&& $self->{rbuf_max} < length $self->{rbuf}
758	) {	992	) {
759	$self->_error (&Errno::ENOSPC, 1), return;	993	$self->_error (Errno::ENOSPC, 1), return;
760	}	994	}
761		995
762	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
763	my $len = length $self->{rbuf};	1002	my $len = length $self->{rbuf};
764		1003
765	if (my $cb = shift @{ $self->{_queue} }) {	1004	if (my $cb = shift @{ $self->{_queue} }) {
766	unless ($cb->($self)) {	1005	unless ($cb->($self)) {
767	if ($self->{_eof}) {	1006	# no progress can be made
768	# no progress can be made (not enough data and no data forthcoming)	1007	# (not enough data and no data forthcoming)
769	$self->_error (&Errno::EPIPE, 1), return;	1008	$self->_error (Errno::EPIPE, 1), return
770	}	1009	if $self->{_eof};
771		1010
772	unshift @{ $self->{_queue} }, $cb;	1011	unshift @{ $self->{_queue} }, $cb;
773	last;	1012	last;
774	}	1013	}
775	} elsif ($self->{on_read}) {	1014	} elsif ($self->{on_read}) {
…		…
782	&& !@{ $self->{_queue} } # and the queue is still empty	1021	&& !@{ $self->{_queue} } # and the queue is still empty
783	&& $self->{on_read} # but we still have on_read	1022	&& $self->{on_read} # but we still have on_read
784	) {	1023	) {
785	# no further data will arrive	1024	# no further data will arrive
786	# so no progress can be made	1025	# so no progress can be made
787	$self->_error (&Errno::EPIPE, 1), return	1026	$self->_error (Errno::EPIPE, 1), return
788	if $self->{_eof};	1027	if $self->{_eof};
789		1028
790	last; # more data might arrive	1029	last; # more data might arrive
791	}	1030	}
792	} else {	1031	} else {
…		…
795	last;	1034	last;
796	}	1035	}
797	}	1036	}
798		1037
799	if ($self->{_eof}) {	1038	if ($self->{_eof}) {
800	if ($self->{on_eof}) {	1039	$self->{on_eof}
801	$self->{on_eof}($self)	1040	? $self->{on_eof}($self)
802	} else {	1041	: $self->_error (0, 1, "Unexpected end-of-file");
803	$self->_error (0, 1);	1042
804	}	1043	return;
805	}	1044	}
806		1045
807	# may need to restart read watcher	1046	# may need to restart read watcher
808	unless ($self->{_rw}) {	1047	unless ($self->{_rw}) {
809	$self->start_read	1048	$self->start_read
…		…
821		1060
822	sub on_read {	1061	sub on_read {
823	my ($self, $cb) = @_;	1062	my ($self, $cb) = @_;
824		1063
825	$self->{on_read} = $cb;	1064	$self->{on_read} = $cb;
826	$self->_drain_rbuf if $cb && !$self->{_in_drain};	1065	$self->_drain_rbuf if $cb;
827	}	1066	}
828		1067
829	=item $handle->rbuf	1068	=item $handle->rbuf
830		1069
831	Returns the read buffer (as a modifiable lvalue).	1070	Returns the read buffer (as a modifiable lvalue).
832		1071
833	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} >>
834	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.
835		1077
836	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>,
837	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
838	automatically manage the read buffer.	1080	automatically manage the read buffer.
839		1081
…		…
880	$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")
881	->($self, $cb, @_);	1123	->($self, $cb, @_);
882	}	1124	}
883		1125
884	push @{ $self->{_queue} }, $cb;	1126	push @{ $self->{_queue} }, $cb;
885	$self->_drain_rbuf unless $self->{_in_drain};	1127	$self->_drain_rbuf;
886	}	1128	}
887		1129
888	sub unshift_read {	1130	sub unshift_read {
889	my $self = shift;	1131	my $self = shift;
890	my $cb = pop;	1132	my $cb = pop;
…		…
896	->($self, $cb, @_);	1138	->($self, $cb, @_);
897	}	1139	}
898		1140
899		1141
900	unshift @{ $self->{_queue} }, $cb;	1142	unshift @{ $self->{_queue} }, $cb;
901	$self->_drain_rbuf unless $self->{_in_drain};	1143	$self->_drain_rbuf;
902	}	1144	}
903		1145
904	=item $handle->push_read (type => @args, $cb)	1146	=item $handle->push_read (type => @args, $cb)
905		1147
906	=item $handle->unshift_read (type => @args, $cb)	1148	=item $handle->unshift_read (type => @args, $cb)
…		…
1039	return 1;	1281	return 1;
1040	}	1282	}
1041		1283
1042	# reject	1284	# reject
1043	if ($reject && $$rbuf =~ $reject) {	1285	if ($reject && $$rbuf =~ $reject) {
1044	$self->_error (&Errno::EBADMSG);	1286	$self->_error (Errno::EBADMSG);
1045	}	1287	}
1046		1288
1047	# skip	1289	# skip
1048	if ($skip && $$rbuf =~ $skip) {	1290	if ($skip && $$rbuf =~ $skip) {
1049	$data .= substr $$rbuf, 0, $+[0], "";	1291	$data .= substr $$rbuf, 0, $+[0], "";
…		…
1065	my ($self, $cb) = @_;	1307	my ($self, $cb) = @_;
1066		1308
1067	sub {	1309	sub {
1068	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {	1310	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
1069	if ($_[0]{rbuf} =~ /[^0-9]/) {	1311	if ($_[0]{rbuf} =~ /[^0-9]/) {
1070	$self->_error (&Errno::EBADMSG);	1312	$self->_error (Errno::EBADMSG);
1071	}	1313	}
1072	return;	1314	return;
1073	}	1315	}
1074		1316
1075	my $len = $1;	1317	my $len = $1;
…		…
1078	my $string = $_[1];	1320	my $string = $_[1];
1079	$_[0]->unshift_read (chunk => 1, sub {	1321	$_[0]->unshift_read (chunk => 1, sub {
1080	if ($_[1] eq ",") {	1322	if ($_[1] eq ",") {
1081	$cb->($_[0], $string);	1323	$cb->($_[0], $string);
1082	} else {	1324	} else {
1083	$self->_error (&Errno::EBADMSG);	1325	$self->_error (Errno::EBADMSG);
1084	}	1326	}
1085	});	1327	});
1086	});	1328	});
1087		1329
1088	1	1330	1
…		…
1135	}	1377	}
1136	};	1378	};
1137		1379
1138	=item json => $cb->($handle, $hash_or_arrayref)	1380	=item json => $cb->($handle, $hash_or_arrayref)
1139		1381
1140	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.
1141		1384
1142	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
1143	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.
1144		1387
1145	This read type uses the incremental parser available with JSON version	1388	This read type uses the incremental parser available with JSON version
…		…
1154	=cut	1397	=cut
1155		1398
1156	register_read_type json => sub {	1399	register_read_type json => sub {
1157	my ($self, $cb) = @_;	1400	my ($self, $cb) = @_;
1158		1401
1159	require JSON;	1402	my $json = $self->{json} \|\|=
		1403	eval { require JSON::XS; JSON::XS->new->utf8 }
		1404	\|\| do { require JSON; JSON->new->utf8 };
1160		1405
1161	my $data;	1406	my $data;
1162	my $rbuf = \$self->{rbuf};	1407	my $rbuf = \$self->{rbuf};
1163		1408
1164	my $json = $self->{json} \|\|= JSON->new->utf8;
1165
1166	sub {	1409	sub {
1167	my $ref = $json->incr_parse ($self->{rbuf});	1410	my $ref = eval { $json->incr_parse ($self->{rbuf}) };
1168		1411
1169	if ($ref) {	1412	if ($ref) {
1170	$self->{rbuf} = $json->incr_text;	1413	$self->{rbuf} = $json->incr_text;
1171	$json->incr_text = "";	1414	$json->incr_text = "";
1172	$cb->($self, $ref);	1415	$cb->($self, $ref);
1173		1416
1174	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	()
1175	} else {	1428	} else {
1176	$self->{rbuf} = "";	1429	$self->{rbuf} = "";
		1430
1177	()	1431	()
1178	}	1432	}
1179	}	1433	}
1180	};	1434	};
1181		1435
…		…
1213	# read remaining chunk	1467	# read remaining chunk
1214	$_[0]->unshift_read (chunk => $len, sub {	1468	$_[0]->unshift_read (chunk => $len, sub {
1215	if (my $ref = eval { Storable::thaw ($_[1]) }) {	1469	if (my $ref = eval { Storable::thaw ($_[1]) }) {
1216	$cb->($_[0], $ref);	1470	$cb->($_[0], $ref);
1217	} else {	1471	} else {
1218	$self->_error (&Errno::EBADMSG);	1472	$self->_error (Errno::EBADMSG);
1219	}	1473	}
1220	});	1474	});
1221	}	1475	}
1222		1476
1223	1	1477	1
…		…
1287	if ($self->{tls}) {	1541	if ($self->{tls}) {
1288	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);	1542	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1289		1543
1290	&_dotls ($self);	1544	&_dotls ($self);
1291	} else {	1545	} else {
1292	$self->_drain_rbuf unless $self->{_in_drain};	1546	$self->_drain_rbuf;
1293	}	1547	}
1294		1548
1295	} elsif (defined $len) {	1549	} elsif (defined $len) {
1296	delete $self->{_rw};	1550	delete $self->{_rw};
1297	$self->{_eof} = 1;	1551	$self->{_eof} = 1;
1298	$self->_drain_rbuf unless $self->{_in_drain};	1552	$self->_drain_rbuf;
1299		1553
1300	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1554	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1301	return $self->_error ($!, 1);	1555	return $self->_error ($!, 1);
1302	}	1556	}
1303	});	1557	});
1304	}	1558	}
1305	}	1559	}
1306		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
1307	# poll the write BIO and send the data if applicable	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.
1308	sub _dotls {	1589	sub _dotls {
1309	my ($self) = @_;	1590	my ($self) = @_;
1310		1591
1311	my $tmp;	1592	my $tmp;
1312		1593
1313	if (length $self->{_tls_wbuf}) {	1594	if (length $self->{_tls_wbuf}) {
1314	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1595	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1315	substr $self->{_tls_wbuf}, 0, $tmp, "";	1596	substr $self->{_tls_wbuf}, 0, $tmp, "";
1316	}	1597	}
		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 \|\| $!);
1317	}	1603	}
1318		1604
1319	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {	1605	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
1320	unless (length $tmp) {	1606	unless (length $tmp) {
1321	# let's treat SSL-eof as we treat normal EOF	1607	$self->{_on_starttls}
1322	delete $self->{_rw};	1608	and (delete $self->{_on_starttls})->($self, undef, "EOF during handshake"); # ???
1323	$self->{_eof} = 1;
1324	&_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	}
1325	}	1619	}
1326		1620
1327	$self->{rbuf} .= $tmp;	1621	$self->{_tls_rbuf} .= $tmp;
1328	$self->_drain_rbuf unless $self->{_in_drain};	1622	$self->_drain_rbuf;
1329	$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
1330	}	1624	}
1331		1625
1332	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);	1626	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1333
1334	if ($tmp != Net::SSLeay::ERROR_WANT_READ ()) {
1335	if ($tmp == Net::SSLeay::ERROR_SYSCALL ()) {
1336	return $self->_error ($!, 1);	1627	return $self->_tls_error ($tmp)
1337	} elsif ($tmp == Net::SSLeay::ERROR_SSL ()) {	1628	if $tmp != $ERROR_WANT_READ
1338	return $self->_error (&Errno::EIO, 1);	1629	&& ($tmp != $ERROR_SYSCALL \|\| $!);
1339	}
1340
1341	# all other errors are fine for our purposes
1342	}
1343		1630
1344	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1631	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1345	$self->{wbuf} .= $tmp;	1632	$self->{wbuf} .= $tmp;
1346	$self->_drain_wbuf;	1633	$self->_drain_wbuf;
1347	}	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");
1348	}	1639	}
1349		1640
1350	=item $handle->starttls ($tls[, $tls_ctx])	1641	=item $handle->starttls ($tls[, $tls_ctx])
1351		1642
1352	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	1643	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
1353	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
1354	C<starttls>.	1645	C<starttls>.
1355		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
1356	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
1357	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1652	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1358		1653
1359	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
1360	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.
1361		1658
1362	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
1363	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
1364	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.
1365		1663
1366	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
1367	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.
1368		1667
1369	=cut	1668	=cut
		1669
		1670	our %TLS_CACHE; #TODO not yet documented, should we?
1370		1671
1371	sub starttls {	1672	sub starttls {
1372	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};
1373		1682
1374	require Net::SSLeay;	1683	require Net::SSLeay;
1375		1684
1376	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
1377	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	}
1378		1703
1379	if ($ssl eq "accept") {	1704	$self->{tls_ctx} = $ctx \|\| TLS_CTX ();
1380	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1705	$self->{tls} = $tls = $self->{tls_ctx}->_get_session ($tls, $self, $self->{peername});
1381	Net::SSLeay::set_accept_state ($ssl);
1382	} elsif ($ssl eq "connect") {
1383	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());
1384	Net::SSLeay::set_connect_state ($ssl);
1385	}
1386
1387	$self->{tls} = $ssl;
1388		1706
1389	# 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)
1390	# but the openssl maintainers basically said: "trust us, it just works".	1708	# but the openssl maintainers basically said: "trust us, it just works".
1391	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1709	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1392	# and mismaintained ssleay-module doesn't even offer them).	1710	# and mismaintained ssleay-module doesn't even offer them).
…		…
1396	#	1714	#
1397	# 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.
1398	# 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,
1399	# 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
1400	# have identity issues in that area.	1718	# have identity issues in that area.
1401	Net::SSLeay::CTX_set_mode ($self->{tls},	1719	# Net::SSLeay::CTX_set_mode ($ssl,
1402	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1720	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
1403	\| (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);
1404		1723
1405	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1724	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1406	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1725	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1407		1726
1408	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};
1409		1731
1410	&_dotls; # need to trigger the initial handshake	1732	&_dotls; # need to trigger the initial handshake
1411	$self->start_read; # make sure we actually do read	1733	$self->start_read; # make sure we actually do read
1412	}	1734	}
1413		1735
1414	=item $handle->stoptls	1736	=item $handle->stoptls
1415		1737
1416	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
1417	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
1418	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
1419	afterwards.	1741	the stream afterwards.
1420		1742
1421	=cut	1743	=cut
1422		1744
1423	sub stoptls {	1745	sub stoptls {
1424	my ($self) = @_;	1746	my ($self) = @_;
…		…
1426	if ($self->{tls}) {	1748	if ($self->{tls}) {
1427	Net::SSLeay::shutdown ($self->{tls});	1749	Net::SSLeay::shutdown ($self->{tls});
1428		1750
1429	&_dotls;	1751	&_dotls;
1430		1752
1431	# 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#
1432	# we, we... have to use openssl :/	1754	# # we, we... have to use openssl :/#d#
1433	&_freetls;	1755	# &_freetls;#d#
1434	}	1756	}
1435	}	1757	}
1436		1758
1437	sub _freetls {	1759	sub _freetls {
1438	my ($self) = @_;	1760	my ($self) = @_;
1439		1761
1440	return unless $self->{tls};	1762	return unless $self->{tls};
1441		1763
1442	Net::SSLeay::free (delete $self->{tls});	1764	$self->{tls_ctx}->_put_session (delete $self->{tls})
		1765	if ref $self->{tls};
1443		1766
1444	delete @$self{qw(_rbio _wbio _tls_wbuf)};	1767	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1445	}	1768	}
1446		1769
1447	sub DESTROY {	1770	sub DESTROY {
1448	my $self = shift;	1771	my ($self) = @_;
1449		1772
1450	&_freetls;	1773	&_freetls;
1451		1774
1452	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	1775	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1453		1776
1454	if ($linger && length $self->{wbuf}) {	1777	if ($linger && length $self->{wbuf} && $self->{fh}) {
1455	my $fh = delete $self->{fh};	1778	my $fh = delete $self->{fh};
1456	my $wbuf = delete $self->{wbuf};	1779	my $wbuf = delete $self->{wbuf};
1457		1780
1458	my @linger;	1781	my @linger;
1459		1782
…		…
1473	}	1796	}
1474		1797
1475	=item $handle->destroy	1798	=item $handle->destroy
1476		1799
1477	Shuts down the handle object as much as possible - this call ensures that	1800	Shuts down the handle object as much as possible - this call ensures that
1478	no further callbacks will be invoked and resources will be freed as much	1801	no further callbacks will be invoked and as many resources as possible
1479	as possible. You must not call any methods on the object afterwards.	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).
1480		1805
1481	Normally, you can just "forget" any references to an AnyEvent::Handle	1806	Normally, you can just "forget" any references to an AnyEvent::Handle
1482	object and it will simply shut down. This works in fatal error and EOF	1807	object and it will simply shut down. This works in fatal error and EOF
1483	callbacks, as well as code outside. It does I<NOT> work in a read or write	1808	callbacks, as well as code outside. It does I<NOT> work in a read or write
1484	callback, so when you want to destroy the AnyEvent::Handle object from	1809	callback, so when you want to destroy the AnyEvent::Handle object from
1485	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in	1810	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
1486	that case.	1811	that case.
1487		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
1488	The handle might still linger in the background and write out remaining	1818	The handle might still linger in the background and write out remaining
1489	data, as specified by the C<linger> option, however.	1819	data, as specified by the C<linger> option, however.
1490		1820
1491	=cut	1821	=cut
1492		1822
1493	sub destroy {	1823	sub destroy {
1494	my ($self) = @_;	1824	my ($self) = @_;
1495		1825
1496	$self->DESTROY;	1826	$self->DESTROY;
1497	%$self = ();	1827	%$self = ();
		1828	bless $self, "AnyEvent::Handle::destroyed";
		1829	}
		1830
		1831	sub AnyEvent::Handle::destroyed::AUTOLOAD {
		1832	#nop
1498	}	1833	}
1499		1834
1500	=item AnyEvent::Handle::TLS_CTX	1835	=item AnyEvent::Handle::TLS_CTX
1501		1836
1502	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
1503	default for TLS mode.	1838	for TLS mode.
1504		1839
1505	The context is created like this:	1840	The context is created by calling L<AnyEvent::TLS> without any arguments.
1506
1507	Net::SSLeay::load_error_strings;
1508	Net::SSLeay::SSLeay_add_ssl_algorithms;
1509	Net::SSLeay::randomize;
1510
1511	my $CTX = Net::SSLeay::CTX_new;
1512
1513	Net::SSLeay::CTX_set_options $CTX, Net::SSLeay::OP_ALL
1514		1841
1515	=cut	1842	=cut
1516		1843
1517	our $TLS_CTX;	1844	our $TLS_CTX;
1518		1845
1519	sub TLS_CTX() {	1846	sub TLS_CTX() {
1520	$TLS_CTX \|\| do {	1847	$TLS_CTX \|\|= do {
1521	require Net::SSLeay;	1848	require AnyEvent::TLS;
1522		1849
1523	Net::SSLeay::load_error_strings ();	1850	new AnyEvent::TLS
1524	Net::SSLeay::SSLeay_add_ssl_algorithms ();
1525	Net::SSLeay::randomize ();
1526
1527	$TLS_CTX = Net::SSLeay::CTX_new ();
1528
1529	Net::SSLeay::CTX_set_options ($TLS_CTX, Net::SSLeay::OP_ALL ());
1530
1531	$TLS_CTX
1532	}	1851	}
1533	}	1852	}
1534		1853
1535	=back	1854	=back
1536		1855
…		…
1575		1894
1576	$handle->on_read (sub { });	1895	$handle->on_read (sub { });
1577	$handle->on_eof (undef);	1896	$handle->on_eof (undef);
1578	$handle->on_error (sub {	1897	$handle->on_error (sub {
1579	my $data = delete $_[0]{rbuf};	1898	my $data = delete $_[0]{rbuf};
1580	undef $handle;
1581	});	1899	});
1582		1900
1583	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
1584	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
1585	fact, all data has been received.	1903	fact, all data has been received.
…		…
1601	$handle->on_drain (sub {	1919	$handle->on_drain (sub {
1602	warn "all data submitted to the kernel\n";	1920	warn "all data submitted to the kernel\n";
1603	undef $handle;	1921	undef $handle;
1604	});	1922	});
1605		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
1606	=back	2012	=back
1607		2013
1608		2014
1609	=head1 SUBCLASSING AnyEvent::Handle	2015	=head1 SUBCLASSING AnyEvent::Handle
1610		2016

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.102 by root, Wed Oct 29 14:32:02 2008 UTC vs. Revision 1.167 by root, Tue Jul 28 11:02:19 2009 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.102 by root, Wed Oct 29 14:32:02 2008 UTC vs.
Revision 1.167 by root, Tue Jul 28 11:02:19 2009 UTC