ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/AnyEvent/lib/AnyEvent/Handle.pm

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.91 by root, Wed Oct 1 07:40:39 2008 UTC vs.
Revision 1.171 by root, Tue Aug 4 12:38:55 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.9;
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).
…		…
240	write data and will install a watcher that will write this data to the	299	write data and will install a watcher that will write this data to the
241	socket. No errors will be reported (this mostly matches how the operating	300	socket. No errors will be reported (this mostly matches how the operating
242	system treats outstanding data at socket close time).	301	system treats outstanding data at socket close time).
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.	304	yet. This data will be lost. Calling the C<stoptls> method in time might
		305	help.
		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>.
246		316
247	=item tls => "accept" | "connect" | Net::SSLeay::SSL object	317	=item tls => "accept" | "connect" | Net::SSLeay::SSL object
248		318
249	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
250	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
251	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.
252		325
253	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
254	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
255	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
256	to add the dependency yourself.	329	to add the dependency yourself.
…		…
260	mode.	333	mode.
261		334
262	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
263	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>
264	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
265	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.
266		349
267	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.
268		351
269	=item tls_ctx => $ssl_ctx	352	=item tls_ctx => $anyevent_tls
270		353
271	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
272	(unless a connection object was specified directly). If this parameter is	355	(unless a connection object was specified directly). If this parameter is
273	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.
274		393
275	=item json => JSON or JSON::XS object	394	=item json => JSON or JSON::XS object
276		395
277	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.
278		397
…		…
281	texts.	400	texts.
282		401
283	Note that you are responsible to depend on the JSON module if you want to	402	Note that you are responsible to depend on the JSON module if you want to
284	use this functionality, as AnyEvent does not have a dependency itself.	403	use this functionality, as AnyEvent does not have a dependency itself.
285		404
286	=item filter_r => $cb
287
288	=item filter_w => $cb
289
290	These exist, but are undocumented at this time. (They are used internally
291	by the TLS code).
292
293	=back	405	=back
294		406
295	=cut	407	=cut
296		408
297	sub new {	409	sub new {
298	my $class = shift;	410	my $class = shift;
299
300	my $self = bless { @_ }, $class;	411	my $self = bless { @_ }, $class;
301		412
302	$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) = @_;
303		476
304	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	477	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
305
306	if ($self->{tls}) {
307	require Net::SSLeay;
308	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});
309	}
310		478
311	$self->{_activity} = AnyEvent->now;	479	$self->{_activity} = AnyEvent->now;
312	$self->_timeout;	480	$self->_timeout;
313		481
314	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};
315	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};	482	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
316		483
		484	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
		485	if $self->{tls};
		486
		487	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
		488
317	$self->start_read	489	$self->start_read
318	if $self->{on_read};	490	if $self->{on_read} || @{ $self->{_queue} };
319		491
320	$self	492	$self->_drain_wbuf;
321	}	493	}
322		494
323	sub _shutdown {	495	#sub _shutdown {
324	my ($self) = @_;	496	# my ($self) = @_;
325		497	#
326	delete $self->{_tw};	498	# delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)};
327	delete $self->{_rw};	499	# $self->{_eof} = 1; # tell starttls et. al to stop trying
328	delete $self->{_ww};	500	#
329	delete $self->{fh};	501	# &_freetls;
330		502	#}
331	$self->stoptls;
332
333	delete $self->{on_read};
334	delete $self->{_queue};
335	}
336		503
337	sub _error {	504	sub _error {
338	my ($self, $errno, $fatal) = @_;	505	my ($self, $errno, $fatal, $message) = @_;
339
340	$self->_shutdown
341	if $fatal;
342		506
343	$! = $errno;	507	$! = $errno;
		508	$message ||= "$!";
344		509
345	if ($self->{on_error}) {	510	if ($self->{on_error}) {
346	$self->{on_error}($self, $fatal);	511	$self->{on_error}($self, $fatal, $message);
347	} else {	512	$self->destroy if $fatal;
		513	} elsif ($self->{fh}) {
		514	$self->destroy;
348	Carp::croak "AnyEvent::Handle uncaught error: $!";	515	Carp::croak "AnyEvent::Handle uncaught error: $message";
349	}	516	}
350	}	517	}
351		518
352	=item $fh = $handle->fh	519	=item $fh = $handle->fh
353		520
…		…
390	}	557	}
391		558
392	=item $handle->autocork ($boolean)	559	=item $handle->autocork ($boolean)
393		560
394	Enables or disables the current autocork behaviour (see C<autocork>	561	Enables or disables the current autocork behaviour (see C<autocork>
395	constructor argument).	562	constructor argument). Changes will only take effect on the next write.
396		563
397	=cut	564	=cut
		565
		566	sub autocork {
		567	$_[0]{autocork} = $_[1];
		568	}
398		569
399	=item $handle->no_delay ($boolean)	570	=item $handle->no_delay ($boolean)
400		571
401	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
402	the same name for details).	573	the same name for details).
…		…
406	sub no_delay {	577	sub no_delay {
407	$_[0]{no_delay} = $_[1];	578	$_[0]{no_delay} = $_[1];
408		579
409	eval {	580	eval {
410	local $SIG{__DIE__};	581	local $SIG{__DIE__};
411	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};
412	};	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];
		605	}
		606
		607	=item $handle->rbuf_max ($max_octets)
		608
		609	Configures the C<rbuf_max> setting (C<undef> disables it).
		610
		611	=cut
		612
		613	sub rbuf_max {
		614	$_[0]{rbuf_max} = $_[1];
413	}	615	}
414		616
415	#############################################################################	617	#############################################################################
416		618
417	=item $handle->timeout ($seconds)	619	=item $handle->timeout ($seconds)
…		…
430	# reset the timeout watcher, as neccessary	632	# reset the timeout watcher, as neccessary
431	# also check for time-outs	633	# also check for time-outs
432	sub _timeout {	634	sub _timeout {
433	my ($self) = @_;	635	my ($self) = @_;
434		636
435	if ($self->{timeout}) {	637	if ($self->{timeout} && $self->{fh}) {
436	my $NOW = AnyEvent->now;	638	my $NOW = AnyEvent->now;
437		639
438	# when would the timeout trigger?	640	# when would the timeout trigger?
439	my $after = $self->{_activity} + $self->{timeout} - $NOW;	641	my $after = $self->{_activity} + $self->{timeout} - $NOW;
440		642
…		…
443	$self->{_activity} = $NOW;	645	$self->{_activity} = $NOW;
444		646
445	if ($self->{on_timeout}) {	647	if ($self->{on_timeout}) {
446	$self->{on_timeout}($self);	648	$self->{on_timeout}($self);
447	} else {	649	} else {
448	$self->_error (&Errno::ETIMEDOUT);	650	$self->_error (Errno::ETIMEDOUT);
449	}	651	}
450		652
451	# callback could have changed timeout value, optimise	653	# callback could have changed timeout value, optimise
452	return unless $self->{timeout};	654	return unless $self->{timeout};
453		655
…		…
495	my ($self, $cb) = @_;	697	my ($self, $cb) = @_;
496		698
497	$self->{on_drain} = $cb;	699	$self->{on_drain} = $cb;
498		700
499	$cb->($self)	701	$cb->($self)
500	if $cb && $self->{low_water_mark} >= length $self->{wbuf};	702	if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});
501	}	703	}
502		704
503	=item $handle->push_write ($data)	705	=item $handle->push_write ($data)
504		706
505	Queues the given scalar to be written. You can push as much data as you	707	Queues the given scalar to be written. You can push as much data as you
…		…
516	Scalar::Util::weaken $self;	718	Scalar::Util::weaken $self;
517		719
518	my $cb = sub {	720	my $cb = sub {
519	my $len = syswrite $self->{fh}, $self->{wbuf};	721	my $len = syswrite $self->{fh}, $self->{wbuf};
520		722
521	if ($len >= 0) {	723	if (defined $len) {
522	substr $self->{wbuf}, 0, $len, "";	724	substr $self->{wbuf}, 0, $len, "";
523		725
524	$self->{_activity} = AnyEvent->now;	726	$self->{_activity} = AnyEvent->now;
525		727
526	$self->{on_drain}($self)	728	$self->{on_drain}($self)
527	if $self->{low_water_mark} >= length $self->{wbuf}	729	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
528	&& $self->{on_drain};	730	&& $self->{on_drain};
529		731
530	delete $self->{_ww} unless length $self->{wbuf};	732	delete $self->{_ww} unless length $self->{wbuf};
531	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	733	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
532	$self->_error ($!, 1);	734	$self->_error ($!, 1);
…		…
556		758
557	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	759	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")
558	->($self, @_);	760	->($self, @_);
559	}	761	}
560		762
561	if ($self->{filter_w}) {	763	if ($self->{tls}) {
562	$self->{filter_w}($self, \$_[0]);	764	$self->{_tls_wbuf} .= $_[0];
		765	&_dotls ($self) if $self->{fh};
563	} else {	766	} else {
564	$self->{wbuf} .= $_[0];	767	$self->{wbuf} .= $_[0];
565	$self->_drain_wbuf;	768	$self->_drain_wbuf if $self->{fh};
566	}	769	}
567	}	770	}
568		771
569	=item $handle->push_write (type => @args)	772	=item $handle->push_write (type => @args)
570		773
…		…
584	=cut	787	=cut
585		788
586	register_write_type netstring => sub {	789	register_write_type netstring => sub {
587	my ($self, $string) = @_;	790	my ($self, $string) = @_;
588		791
589	sprintf "%d:%s,", (length $string), $string	792	(length $string) . ":$string,"
590	};	793	};
591		794
592	=item packstring => $format, $data	795	=item packstring => $format, $data
593		796
594	An octet string prefixed with an encoded length. The encoding C<$format>	797	An octet string prefixed with an encoded length. The encoding C<$format>
…		…
659		862
660	pack "w/a*", Storable::nfreeze ($ref)	863	pack "w/a*", Storable::nfreeze ($ref)
661	};	864	};
662		865
663	=back	866	=back
		867
		868	=item $handle->push_shutdown
		869
		870	Sometimes you know you want to close the socket after writing your data
		871	before it was actually written. One way to do that is to replace your
		872	C<on_drain> handler by a callback that shuts down the socket (and set
		873	C<low_water_mark> to C<0>). This method is a shorthand for just that, and
		874	replaces the C<on_drain> callback with:
		875
		876	sub { shutdown $_[0]{fh}, 1 } # for push_shutdown
		877
		878	This simply shuts down the write side and signals an EOF condition to the
		879	the peer.
		880
		881	You can rely on the normal read queue and C<on_eof> handling
		882	afterwards. This is the cleanest way to close a connection.
		883
		884	=cut
		885
		886	sub push_shutdown {
		887	my ($self) = @_;
		888
		889	delete $self->{low_water_mark};
		890	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });
		891	}
664		892
665	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	893	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
666		894
667	This function (not method) lets you add your own types to C<push_write>.	895	This function (not method) lets you add your own types to C<push_write>.
668	Whenever the given C<type> is used, C<push_write> will invoke the code	896	Whenever the given C<type> is used, C<push_write> will invoke the code
…		…
762	=cut	990	=cut
763		991
764	sub _drain_rbuf {	992	sub _drain_rbuf {
765	my ($self) = @_;	993	my ($self) = @_;
766		994
		995	# avoid recursion
		996	return if $self->{_skip_drain_rbuf};
767	local $self->{_in_drain} = 1;	997	local $self->{_skip_drain_rbuf} = 1;
768
769	if (
770	defined $self->{rbuf_max}
771	&& $self->{rbuf_max} < length $self->{rbuf}
772	) {
773	$self->_error (&Errno::ENOSPC, 1), return;
774	}
775		998
776	while () {	999	while () {
		1000	# we need to use a separate tls read buffer, as we must not receive data while
		1001	# we are draining the buffer, and this can only happen with TLS.
		1002	$self->{rbuf} .= delete $self->{_tls_rbuf}
		1003	if exists $self->{_tls_rbuf};
		1004
777	my $len = length $self->{rbuf};	1005	my $len = length $self->{rbuf};
778		1006
779	if (my $cb = shift @{ $self->{_queue} }) {	1007	if (my $cb = shift @{ $self->{_queue} }) {
780	unless ($cb->($self)) {	1008	unless ($cb->($self)) {
781	if ($self->{_eof}) {	1009	# no progress can be made
782	# no progress can be made (not enough data and no data forthcoming)	1010	# (not enough data and no data forthcoming)
783	$self->_error (&Errno::EPIPE, 1), return;	1011	$self->_error (Errno::EPIPE, 1), return
784	}	1012	if $self->{_eof};
785		1013
786	unshift @{ $self->{_queue} }, $cb;	1014	unshift @{ $self->{_queue} }, $cb;
787	last;	1015	last;
788	}	1016	}
789	} elsif ($self->{on_read}) {	1017	} elsif ($self->{on_read}) {
…		…
796	&& !@{ $self->{_queue} } # and the queue is still empty	1024	&& !@{ $self->{_queue} } # and the queue is still empty
797	&& $self->{on_read} # but we still have on_read	1025	&& $self->{on_read} # but we still have on_read
798	) {	1026	) {
799	# no further data will arrive	1027	# no further data will arrive
800	# so no progress can be made	1028	# so no progress can be made
801	$self->_error (&Errno::EPIPE, 1), return	1029	$self->_error (Errno::EPIPE, 1), return
802	if $self->{_eof};	1030	if $self->{_eof};
803		1031
804	last; # more data might arrive	1032	last; # more data might arrive
805	}	1033	}
806	} else {	1034	} else {
807	# read side becomes idle	1035	# read side becomes idle
808	delete $self->{_rw};	1036	delete $self->{_rw} unless $self->{tls};
809	last;	1037	last;
810	}	1038	}
811	}	1039	}
812		1040
813	if ($self->{_eof}) {	1041	if ($self->{_eof}) {
814	if ($self->{on_eof}) {	1042	$self->{on_eof}
815	$self->{on_eof}($self)	1043	? $self->{on_eof}($self)
816	} else {	1044	: $self->_error (0, 1, "Unexpected end-of-file");
817	$self->_error (0, 1);	1045
818	}	1046	return;
		1047	}
		1048
		1049	if (
		1050	defined $self->{rbuf_max}
		1051	&& $self->{rbuf_max} < length $self->{rbuf}
		1052	) {
		1053	$self->_error (Errno::ENOSPC, 1), return;
819	}	1054	}
820		1055
821	# may need to restart read watcher	1056	# may need to restart read watcher
822	unless ($self->{_rw}) {	1057	unless ($self->{_rw}) {
823	$self->start_read	1058	$self->start_read
…		…
835		1070
836	sub on_read {	1071	sub on_read {
837	my ($self, $cb) = @_;	1072	my ($self, $cb) = @_;
838		1073
839	$self->{on_read} = $cb;	1074	$self->{on_read} = $cb;
840	$self->_drain_rbuf if $cb && !$self->{_in_drain};	1075	$self->_drain_rbuf if $cb;
841	}	1076	}
842		1077
843	=item $handle->rbuf	1078	=item $handle->rbuf
844		1079
845	Returns the read buffer (as a modifiable lvalue).	1080	Returns the read buffer (as a modifiable lvalue).
846		1081
847	You can access the read buffer directly as the C<< ->{rbuf} >> member, if	1082	You can access the read buffer directly as the C<< ->{rbuf} >>
848	you want.	1083	member, if you want. However, the only operation allowed on the
		1084	read buffer (apart from looking at it) is removing data from its
		1085	beginning. Otherwise modifying or appending to it is not allowed and will
		1086	lead to hard-to-track-down bugs.
849		1087
850	NOTE: The read buffer should only be used or modified if the C<on_read>,	1088	NOTE: The read buffer should only be used or modified if the C<on_read>,
851	C<push_read> or C<unshift_read> methods are used. The other read methods	1089	C<push_read> or C<unshift_read> methods are used. The other read methods
852	automatically manage the read buffer.	1090	automatically manage the read buffer.
853		1091
…		…
894	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	1132	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
895	->($self, $cb, @_);	1133	->($self, $cb, @_);
896	}	1134	}
897		1135
898	push @{ $self->{_queue} }, $cb;	1136	push @{ $self->{_queue} }, $cb;
899	$self->_drain_rbuf unless $self->{_in_drain};	1137	$self->_drain_rbuf;
900	}	1138	}
901		1139
902	sub unshift_read {	1140	sub unshift_read {
903	my $self = shift;	1141	my $self = shift;
904	my $cb = pop;	1142	my $cb = pop;
…		…
910	->($self, $cb, @_);	1148	->($self, $cb, @_);
911	}	1149	}
912		1150
913		1151
914	unshift @{ $self->{_queue} }, $cb;	1152	unshift @{ $self->{_queue} }, $cb;
915	$self->_drain_rbuf unless $self->{_in_drain};	1153	$self->_drain_rbuf;
916	}	1154	}
917		1155
918	=item $handle->push_read (type => @args, $cb)	1156	=item $handle->push_read (type => @args, $cb)
919		1157
920	=item $handle->unshift_read (type => @args, $cb)	1158	=item $handle->unshift_read (type => @args, $cb)
…		…
1053	return 1;	1291	return 1;
1054	}	1292	}
1055		1293
1056	# reject	1294	# reject
1057	if ($reject && $$rbuf =~ $reject) {	1295	if ($reject && $$rbuf =~ $reject) {
1058	$self->_error (&Errno::EBADMSG);	1296	$self->_error (Errno::EBADMSG);
1059	}	1297	}
1060		1298
1061	# skip	1299	# skip
1062	if ($skip && $$rbuf =~ $skip) {	1300	if ($skip && $$rbuf =~ $skip) {
1063	$data .= substr $$rbuf, 0, $+[0], "";	1301	$data .= substr $$rbuf, 0, $+[0], "";
…		…
1079	my ($self, $cb) = @_;	1317	my ($self, $cb) = @_;
1080		1318
1081	sub {	1319	sub {
1082	unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {	1320	unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {
1083	if ($_[0]{rbuf} =~ /[^0-9]/) {	1321	if ($_[0]{rbuf} =~ /[^0-9]/) {
1084	$self->_error (&Errno::EBADMSG);	1322	$self->_error (Errno::EBADMSG);
1085	}	1323	}
1086	return;	1324	return;
1087	}	1325	}
1088		1326
1089	my $len = $1;	1327	my $len = $1;
…		…
1092	my $string = $_[1];	1330	my $string = $_[1];
1093	$_[0]->unshift_read (chunk => 1, sub {	1331	$_[0]->unshift_read (chunk => 1, sub {
1094	if ($_[1] eq ",") {	1332	if ($_[1] eq ",") {
1095	$cb->($_[0], $string);	1333	$cb->($_[0], $string);
1096	} else {	1334	} else {
1097	$self->_error (&Errno::EBADMSG);	1335	$self->_error (Errno::EBADMSG);
1098	}	1336	}
1099	});	1337	});
1100	});	1338	});
1101		1339
1102	1	1340	1
…		…
1108	An octet string prefixed with an encoded length. The encoding C<$format>	1346	An octet string prefixed with an encoded length. The encoding C<$format>
1109	uses the same format as a Perl C<pack> format, but must specify a single	1347	uses the same format as a Perl C<pack> format, but must specify a single
1110	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an	1348	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
1111	optional C<!>, C<< < >> or C<< > >> modifier).	1349	optional C<!>, C<< < >> or C<< > >> modifier).
1112		1350
1113	DNS over TCP uses a prefix of C<n>, EPP uses a prefix of C<N>.	1351	For example, DNS over TCP uses a prefix of C<n> (2 octet network order),
		1352	EPP uses a prefix of C<N> (4 octtes).
1114		1353
1115	Example: read a block of data prefixed by its length in BER-encoded	1354	Example: read a block of data prefixed by its length in BER-encoded
1116	format (very efficient).	1355	format (very efficient).
1117		1356
1118	$handle->push_read (packstring => "w", sub {	1357	$handle->push_read (packstring => "w", sub {
…		…
1148	}	1387	}
1149	};	1388	};
1150		1389
1151	=item json => $cb->($handle, $hash_or_arrayref)	1390	=item json => $cb->($handle, $hash_or_arrayref)
1152		1391
1153	Reads a JSON object or array, decodes it and passes it to the callback.	1392	Reads a JSON object or array, decodes it and passes it to the
		1393	callback. When a parse error occurs, an C<EBADMSG> error will be raised.
1154		1394
1155	If a C<json> object was passed to the constructor, then that will be used	1395	If a C<json> object was passed to the constructor, then that will be used
1156	for the final decode, otherwise it will create a JSON coder expecting UTF-8.	1396	for the final decode, otherwise it will create a JSON coder expecting UTF-8.
1157		1397
1158	This read type uses the incremental parser available with JSON version	1398	This read type uses the incremental parser available with JSON version
…		…
1167	=cut	1407	=cut
1168		1408
1169	register_read_type json => sub {	1409	register_read_type json => sub {
1170	my ($self, $cb) = @_;	1410	my ($self, $cb) = @_;
1171		1411
1172	require JSON;	1412	my $json = $self->{json} ||=
		1413	eval { require JSON::XS; JSON::XS->new->utf8 }
		1414	|| do { require JSON; JSON->new->utf8 };
1173		1415
1174	my $data;	1416	my $data;
1175	my $rbuf = \$self->{rbuf};	1417	my $rbuf = \$self->{rbuf};
1176		1418
1177	my $json = $self->{json} ||= JSON->new->utf8;
1178
1179	sub {	1419	sub {
1180	my $ref = $json->incr_parse ($self->{rbuf});	1420	my $ref = eval { $json->incr_parse ($self->{rbuf}) };
1181		1421
1182	if ($ref) {	1422	if ($ref) {
1183	$self->{rbuf} = $json->incr_text;	1423	$self->{rbuf} = $json->incr_text;
1184	$json->incr_text = "";	1424	$json->incr_text = "";
1185	$cb->($self, $ref);	1425	$cb->($self, $ref);
1186		1426
1187	1	1427	1
		1428	} elsif ($@) {
		1429	# error case
		1430	$json->incr_skip;
		1431
		1432	$self->{rbuf} = $json->incr_text;
		1433	$json->incr_text = "";
		1434
		1435	$self->_error (Errno::EBADMSG);
		1436
		1437	()
1188	} else {	1438	} else {
1189	$self->{rbuf} = "";	1439	$self->{rbuf} = "";
		1440
1190	()	1441	()
1191	}	1442	}
1192	}	1443	}
1193	};	1444	};
1194		1445
…		…
1226	# read remaining chunk	1477	# read remaining chunk
1227	$_[0]->unshift_read (chunk => $len, sub {	1478	$_[0]->unshift_read (chunk => $len, sub {
1228	if (my $ref = eval { Storable::thaw ($_[1]) }) {	1479	if (my $ref = eval { Storable::thaw ($_[1]) }) {
1229	$cb->($_[0], $ref);	1480	$cb->($_[0], $ref);
1230	} else {	1481	} else {
1231	$self->_error (&Errno::EBADMSG);	1482	$self->_error (Errno::EBADMSG);
1232	}	1483	}
1233	});	1484	});
1234	}	1485	}
1235		1486
1236	1	1487	1
…		…
1271	Note that AnyEvent::Handle will automatically C<start_read> for you when	1522	Note that AnyEvent::Handle will automatically C<start_read> for you when
1272	you change the C<on_read> callback or push/unshift a read callback, and it	1523	you change the C<on_read> callback or push/unshift a read callback, and it
1273	will automatically C<stop_read> for you when neither C<on_read> is set nor	1524	will automatically C<stop_read> for you when neither C<on_read> is set nor
1274	there are any read requests in the queue.	1525	there are any read requests in the queue.
1275		1526
		1527	These methods will have no effect when in TLS mode (as TLS doesn't support
		1528	half-duplex connections).
		1529
1276	=cut	1530	=cut
1277		1531
1278	sub stop_read {	1532	sub stop_read {
1279	my ($self) = @_;	1533	my ($self) = @_;
1280		1534
1281	delete $self->{_rw};	1535	delete $self->{_rw} unless $self->{tls};
1282	}	1536	}
1283		1537
1284	sub start_read {	1538	sub start_read {
1285	my ($self) = @_;	1539	my ($self) = @_;
1286		1540
1287	unless ($self->{_rw} || $self->{_eof}) {	1541	unless ($self->{_rw} || $self->{_eof}) {
1288	Scalar::Util::weaken $self;	1542	Scalar::Util::weaken $self;
1289		1543
1290	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1544	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
1291	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1545	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1292	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf;	1546	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf;
1293		1547
1294	if ($len > 0) {	1548	if ($len > 0) {
1295	$self->{_activity} = AnyEvent->now;	1549	$self->{_activity} = AnyEvent->now;
1296		1550
1297	$self->{filter_r}	1551	if ($self->{tls}) {
1298	? $self->{filter_r}($self, $rbuf)	1552	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1299	: $self->{_in_drain} || $self->_drain_rbuf;	1553
		1554	&_dotls ($self);
		1555	} else {
		1556	$self->_drain_rbuf;
		1557	}
1300		1558
1301	} elsif (defined $len) {	1559	} elsif (defined $len) {
1302	delete $self->{_rw};	1560	delete $self->{_rw};
1303	$self->{_eof} = 1;	1561	$self->{_eof} = 1;
1304	$self->_drain_rbuf unless $self->{_in_drain};	1562	$self->_drain_rbuf;
1305		1563
1306	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1564	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1307	return $self->_error ($!, 1);	1565	return $self->_error ($!, 1);
1308	}	1566	}
1309	});	1567	});
1310	}	1568	}
1311	}	1569	}
1312		1570
		1571	our $ERROR_SYSCALL;
		1572	our $ERROR_WANT_READ;
		1573
		1574	sub _tls_error {
		1575	my ($self, $err) = @_;
		1576
		1577	return $self->_error ($!, 1)
		1578	if $err == Net::SSLeay::ERROR_SYSCALL ();
		1579
		1580	my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());
		1581
		1582	# reduce error string to look less scary
		1583	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;
		1584
		1585	if ($self->{_on_starttls}) {
		1586	(delete $self->{_on_starttls})->($self, undef, $err);
		1587	&_freetls;
		1588	} else {
		1589	&_freetls;
		1590	$self->_error (Errno::EPROTO, 1, $err);
		1591	}
		1592	}
		1593
		1594	# poll the write BIO and send the data if applicable
		1595	# also decode read data if possible
		1596	# this is basiclaly our TLS state machine
		1597	# more efficient implementations are possible with openssl,
		1598	# but not with the buggy and incomplete Net::SSLeay.
1313	sub _dotls {	1599	sub _dotls {
1314	my ($self) = @_;	1600	my ($self) = @_;
1315		1601
1316	my $buf;	1602	my $tmp;
1317		1603
1318	if (length $self->{_tls_wbuf}) {	1604	if (length $self->{_tls_wbuf}) {
1319	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1605	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1320	substr $self->{_tls_wbuf}, 0, $len, "";	1606	substr $self->{_tls_wbuf}, 0, $tmp, "";
1321	}	1607	}
1322	}
1323		1608
		1609	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);
		1610	return $self->_tls_error ($tmp)
		1611	if $tmp != $ERROR_WANT_READ
		1612	&& ($tmp != $ERROR_SYSCALL || $!);
		1613	}
		1614
1324	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {	1615	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
1325	unless (length $buf) {	1616	unless (length $tmp) {
		1617	$self->{_on_starttls}
		1618	and (delete $self->{_on_starttls})->($self, undef, "EOF during handshake"); # ???
		1619	&_freetls;
		1620
		1621	if ($self->{on_stoptls}) {
		1622	$self->{on_stoptls}($self);
		1623	return;
		1624	} else {
1326	# let's treat SSL-eof as we treat normal EOF	1625	# let's treat SSL-eof as we treat normal EOF
1327	delete $self->{_rw};	1626	delete $self->{_rw};
1328	$self->{_eof} = 1;	1627	$self->{_eof} = 1;
		1628	}
1329	}	1629	}
1330		1630
1331	$self->{rbuf} .= $buf;	1631	$self->{_tls_rbuf} .= $tmp;
1332	$self->_drain_rbuf unless $self->{_in_drain};	1632	$self->_drain_rbuf;
1333
1334	$self->{tls} or return; # tls could have gone away	1633	$self->{tls} or return; # tls session might have gone away in callback
1335	}	1634	}
1336		1635
1337	my $err = Net::SSLeay::get_error ($self->{tls}, -1);	1636	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1338
1339	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
1340	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {
1341	return $self->_error ($!, 1);	1637	return $self->_tls_error ($tmp)
1342	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {	1638	if $tmp != $ERROR_WANT_READ
1343	return $self->_error (&Errno::EIO, 1);	1639	&& ($tmp != $ERROR_SYSCALL || $!);
1344	}
1345		1640
1346	# all others are fine for our purposes
1347	}
1348
1349	if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1641	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1350	$self->{wbuf} .= $buf;	1642	$self->{wbuf} .= $tmp;
1351	$self->_drain_wbuf;	1643	$self->_drain_wbuf;
1352	}	1644	}
		1645
		1646	$self->{_on_starttls}
		1647	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
		1648	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");
1353	}	1649	}
1354		1650
1355	=item $handle->starttls ($tls[, $tls_ctx])	1651	=item $handle->starttls ($tls[, $tls_ctx])
1356		1652
1357	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	1653	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
1358	object is created, you can also do that at a later time by calling	1654	object is created, you can also do that at a later time by calling
1359	C<starttls>.	1655	C<starttls>.
1360		1656
		1657	Starting TLS is currently an asynchronous operation - when you push some
		1658	write data and then call C<< ->starttls >> then TLS negotiation will start
		1659	immediately, after which the queued write data is then sent.
		1660
1361	The first argument is the same as the C<tls> constructor argument (either	1661	The first argument is the same as the C<tls> constructor argument (either
1362	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1662	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1363		1663
1364	The second argument is the optional C<Net::SSLeay::CTX> object that is	1664	The second argument is the optional C<AnyEvent::TLS> object that is used
1365	used when AnyEvent::Handle has to create its own TLS connection object.	1665	when AnyEvent::Handle has to create its own TLS connection object, or
		1666	a hash reference with C<< key => value >> pairs that will be used to
		1667	construct a new context.
1366		1668
1367	The TLS connection object will end up in C<< $handle->{tls} >> after this	1669	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS
1368	call and can be used or changed to your liking. Note that the handshake	1670	context in C<< $handle->{tls_ctx} >> after this call and can be used or
1369	might have already started when this function returns.	1671	changed to your liking. Note that the handshake might have already started
		1672	when this function returns.
1370		1673
		1674	Due to bugs in OpenSSL, it might or might not be possible to do multiple
		1675	handshakes on the same stream. Best do not attempt to use the stream after
		1676	stopping TLS.
		1677
1371	=cut	1678	=cut
		1679
		1680	our %TLS_CACHE; #TODO not yet documented, should we?
1372		1681
1373	sub starttls {	1682	sub starttls {
1374	my ($self, $ssl, $ctx) = @_;	1683	my ($self, $tls, $ctx) = @_;
1375		1684
1376	$self->stoptls;	1685	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"
		1686	if $self->{tls};
1377		1687
1378	if ($ssl eq "accept") {	1688	$self->{tls} = $tls;
1379	$ssl = Net::SSLeay::new ($ctx || TLS_CTX ());	1689	$self->{tls_ctx} = $ctx if @_ > 2;
1380	Net::SSLeay::set_accept_state ($ssl);	1690
1381	} elsif ($ssl eq "connect") {	1691	return unless $self->{fh};
1382	$ssl = Net::SSLeay::new ($ctx || TLS_CTX ());	1692
1383	Net::SSLeay::set_connect_state ($ssl);	1693	require Net::SSLeay;
		1694
		1695	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
		1696	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
		1697
		1698	$tls = $self->{tls};
		1699	$ctx = $self->{tls_ctx};
		1700
		1701	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
		1702
		1703	if ("HASH" eq ref $ctx) {
		1704	require AnyEvent::TLS;
		1705
		1706	if ($ctx->{cache}) {
		1707	my $key = $ctx+0;
		1708	$ctx = $TLS_CACHE{$key} ||= new AnyEvent::TLS %$ctx;
		1709	} else {
		1710	$ctx = new AnyEvent::TLS %$ctx;
		1711	}
		1712	}
1384	}	1713
1385		1714	$self->{tls_ctx} = $ctx || TLS_CTX ();
1386	$self->{tls} = $ssl;	1715	$self->{tls} = $tls = $self->{tls_ctx}->_get_session ($tls, $self, $self->{peername});
1387		1716
1388	# basically, this is deep magic (because SSL_read should have the same issues)	1717	# basically, this is deep magic (because SSL_read should have the same issues)
1389	# but the openssl maintainers basically said: "trust us, it just works".	1718	# but the openssl maintainers basically said: "trust us, it just works".
1390	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1719	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1391	# and mismaintained ssleay-module doesn't even offer them).	1720	# and mismaintained ssleay-module doesn't even offer them).
1392	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html	1721	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
1393	#	1722	#
1394	# in short: this is a mess.	1723	# in short: this is a mess.
1395	#	1724	#
1396	# note that we do not try to kepe the length constant between writes as we are required to do.	1725	# note that we do not try to keep the length constant between writes as we are required to do.
1397	# we assume that most (but not all) of this insanity only applies to non-blocking cases,	1726	# we assume that most (but not all) of this insanity only applies to non-blocking cases,
1398	# and we drive openssl fully in blocking mode here.	1727	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
		1728	# have identity issues in that area.
1399	Net::SSLeay::CTX_set_mode ($self->{tls},	1729	# Net::SSLeay::CTX_set_mode ($ssl,
1400	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)	1730	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)
1401	| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));	1731	# | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));
		1732	Net::SSLeay::CTX_set_mode ($tls, 1|2);
1402		1733
1403	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1734	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1404	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1735	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1405		1736
1406	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1737	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
1407		1738
1408	$self->{filter_w} = sub {	1739	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1409	$_[0]{_tls_wbuf} .= ${$_[1]};	1740	if $self->{on_starttls};
1410	&_dotls;
1411	};
1412	$self->{filter_r} = sub {
1413	Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});
1414	&_dotls;
1415	};
1416		1741
1417	&_dotls; # need to trigger the initial negotiation exchange	1742	&_dotls; # need to trigger the initial handshake
		1743	$self->start_read; # make sure we actually do read
1418	}	1744	}
1419		1745
1420	=item $handle->stoptls	1746	=item $handle->stoptls
1421		1747
1422	Destroys the SSL connection, if any. Partial read or write data will be	1748	Shuts down the SSL connection - this makes a proper EOF handshake by
1423	lost.	1749	sending a close notify to the other side, but since OpenSSL doesn't
		1750	support non-blocking shut downs, it is not guarenteed that you can re-use
		1751	the stream afterwards.
1424		1752
1425	=cut	1753	=cut
1426		1754
1427	sub stoptls {	1755	sub stoptls {
1428	my ($self) = @_;	1756	my ($self) = @_;
1429		1757
1430	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};	1758	if ($self->{tls}) {
		1759	Net::SSLeay::shutdown ($self->{tls});
1431		1760
1432	delete $self->{_rbio};	1761	&_dotls;
1433	delete $self->{_wbio};	1762
1434	delete $self->{_tls_wbuf};	1763	# # we don't give a shit. no, we do, but we can't. no...#d#
1435	delete $self->{filter_r};	1764	# # we, we... have to use openssl :/#d#
1436	delete $self->{filter_w};	1765	# &_freetls;#d#
		1766	}
		1767	}
		1768
		1769	sub _freetls {
		1770	my ($self) = @_;
		1771
		1772	return unless $self->{tls};
		1773
		1774	$self->{tls_ctx}->_put_session (delete $self->{tls})
		1775	if $self->{tls} > 0;
		1776
		1777	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1437	}	1778	}
1438		1779
1439	sub DESTROY {	1780	sub DESTROY {
1440	my $self = shift;	1781	my ($self) = @_;
1441		1782
1442	$self->stoptls;	1783	&_freetls;
1443		1784
1444	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	1785	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1445		1786
1446	if ($linger && length $self->{wbuf}) {	1787	if ($linger && length $self->{wbuf} && $self->{fh}) {
1447	my $fh = delete $self->{fh};	1788	my $fh = delete $self->{fh};
1448	my $wbuf = delete $self->{wbuf};	1789	my $wbuf = delete $self->{wbuf};
1449		1790
1450	my @linger;	1791	my @linger;
1451		1792
…		…
1462	@linger = ();	1803	@linger = ();
1463	});	1804	});
1464	}	1805	}
1465	}	1806	}
1466		1807
		1808	=item $handle->destroy
		1809
		1810	Shuts down the handle object as much as possible - this call ensures that
		1811	no further callbacks will be invoked and as many resources as possible
		1812	will be freed. Any method you will call on the handle object after
		1813	destroying it in this way will be silently ignored (and it will return the
		1814	empty list).
		1815
		1816	Normally, you can just "forget" any references to an AnyEvent::Handle
		1817	object and it will simply shut down. This works in fatal error and EOF
		1818	callbacks, as well as code outside. It does I<NOT> work in a read or write
		1819	callback, so when you want to destroy the AnyEvent::Handle object from
		1820	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
		1821	that case.
		1822
		1823	Destroying the handle object in this way has the advantage that callbacks
		1824	will be removed as well, so if those are the only reference holders (as
		1825	is common), then one doesn't need to do anything special to break any
		1826	reference cycles.
		1827
		1828	The handle might still linger in the background and write out remaining
		1829	data, as specified by the C<linger> option, however.
		1830
		1831	=cut
		1832
		1833	sub destroy {
		1834	my ($self) = @_;
		1835
		1836	$self->DESTROY;
		1837	%$self = ();
		1838	bless $self, "AnyEvent::Handle::destroyed";
		1839	}
		1840
		1841	sub AnyEvent::Handle::destroyed::AUTOLOAD {
		1842	#nop
		1843	}
		1844
1467	=item AnyEvent::Handle::TLS_CTX	1845	=item AnyEvent::Handle::TLS_CTX
1468		1846
1469	This function creates and returns the Net::SSLeay::CTX object used by	1847	This function creates and returns the AnyEvent::TLS object used by default
1470	default for TLS mode.	1848	for TLS mode.
1471		1849
1472	The context is created like this:	1850	The context is created by calling L<AnyEvent::TLS> without any arguments.
1473
1474	Net::SSLeay::load_error_strings;
1475	Net::SSLeay::SSLeay_add_ssl_algorithms;
1476	Net::SSLeay::randomize;
1477
1478	my $CTX = Net::SSLeay::CTX_new;
1479
1480	Net::SSLeay::CTX_set_options $CTX, Net::SSLeay::OP_ALL
1481		1851
1482	=cut	1852	=cut
1483		1853
1484	our $TLS_CTX;	1854	our $TLS_CTX;
1485		1855
1486	sub TLS_CTX() {	1856	sub TLS_CTX() {
1487	$TLS_CTX || do {	1857	$TLS_CTX ||= do {
1488	require Net::SSLeay;	1858	require AnyEvent::TLS;
1489		1859
1490	Net::SSLeay::load_error_strings ();	1860	new AnyEvent::TLS
1491	Net::SSLeay::SSLeay_add_ssl_algorithms ();
1492	Net::SSLeay::randomize ();
1493
1494	$TLS_CTX = Net::SSLeay::CTX_new ();
1495
1496	Net::SSLeay::CTX_set_options ($TLS_CTX, Net::SSLeay::OP_ALL ());
1497
1498	$TLS_CTX
1499	}	1861	}
1500	}	1862	}
1501		1863
1502	=back	1864	=back
		1865
		1866
		1867	=head1 NONFREQUENTLY ASKED QUESTIONS
		1868
		1869	=over 4
		1870
		1871	=item I C<undef> the AnyEvent::Handle reference inside my callback and
		1872	still get further invocations!
		1873
		1874	That's because AnyEvent::Handle keeps a reference to itself when handling
		1875	read or write callbacks.
		1876
		1877	It is only safe to "forget" the reference inside EOF or error callbacks,
		1878	from within all other callbacks, you need to explicitly call the C<<
		1879	->destroy >> method.
		1880
		1881	=item I get different callback invocations in TLS mode/Why can't I pause
		1882	reading?
		1883
		1884	Unlike, say, TCP, TLS connections do not consist of two independent
		1885	communication channels, one for each direction. Or put differently. The
		1886	read and write directions are not independent of each other: you cannot
		1887	write data unless you are also prepared to read, and vice versa.
		1888
		1889	This can mean than, in TLS mode, you might get C<on_error> or C<on_eof>
		1890	callback invocations when you are not expecting any read data - the reason
		1891	is that AnyEvent::Handle always reads in TLS mode.
		1892
		1893	During the connection, you have to make sure that you always have a
		1894	non-empty read-queue, or an C<on_read> watcher. At the end of the
		1895	connection (or when you no longer want to use it) you can call the
		1896	C<destroy> method.
		1897
		1898	=item How do I read data until the other side closes the connection?
		1899
		1900	If you just want to read your data into a perl scalar, the easiest way
		1901	to achieve this is by setting an C<on_read> callback that does nothing,
		1902	clearing the C<on_eof> callback and in the C<on_error> callback, the data
		1903	will be in C<$_[0]{rbuf}>:
		1904
		1905	$handle->on_read (sub { });
		1906	$handle->on_eof (undef);
		1907	$handle->on_error (sub {
		1908	my $data = delete $_[0]{rbuf};
		1909	});
		1910
		1911	The reason to use C<on_error> is that TCP connections, due to latencies
		1912	and packets loss, might get closed quite violently with an error, when in
		1913	fact, all data has been received.
		1914
		1915	It is usually better to use acknowledgements when transferring data,
		1916	to make sure the other side hasn't just died and you got the data
		1917	intact. This is also one reason why so many internet protocols have an
		1918	explicit QUIT command.
		1919
		1920	=item I don't want to destroy the handle too early - how do I wait until
		1921	all data has been written?
		1922
		1923	After writing your last bits of data, set the C<on_drain> callback
		1924	and destroy the handle in there - with the default setting of
		1925	C<low_water_mark> this will be called precisely when all data has been
		1926	written to the socket:
		1927
		1928	$handle->push_write (...);
		1929	$handle->on_drain (sub {
		1930	warn "all data submitted to the kernel\n";
		1931	undef $handle;
		1932	});
		1933
		1934	If you just want to queue some data and then signal EOF to the other side,
		1935	consider using C<< ->push_shutdown >> instead.
		1936
		1937	=item I want to contact a TLS/SSL server, I don't care about security.
		1938
		1939	If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS,
		1940	simply connect to it and then create the AnyEvent::Handle with the C<tls>
		1941	parameter:
		1942
		1943	tcp_connect $host, $port, sub {
		1944	my ($fh) = @_;
		1945
		1946	my $handle = new AnyEvent::Handle
		1947	fh => $fh,
		1948	tls => "connect",
		1949	on_error => sub { ... };
		1950
		1951	$handle->push_write (...);
		1952	};
		1953
		1954	=item I want to contact a TLS/SSL server, I do care about security.
		1955
		1956	Then you should additionally enable certificate verification, including
		1957	peername verification, if the protocol you use supports it (see
		1958	L<AnyEvent::TLS>, C<verify_peername>).
		1959
		1960	E.g. for HTTPS:
		1961
		1962	tcp_connect $host, $port, sub {
		1963	my ($fh) = @_;
		1964
		1965	my $handle = new AnyEvent::Handle
		1966	fh => $fh,
		1967	peername => $host,
		1968	tls => "connect",
		1969	tls_ctx => { verify => 1, verify_peername => "https" },
		1970	...
		1971
		1972	Note that you must specify the hostname you connected to (or whatever
		1973	"peername" the protocol needs) as the C<peername> argument, otherwise no
		1974	peername verification will be done.
		1975
		1976	The above will use the system-dependent default set of trusted CA
		1977	certificates. If you want to check against a specific CA, add the
		1978	C<ca_file> (or C<ca_cert>) arguments to C<tls_ctx>:
		1979
		1980	tls_ctx => {
		1981	verify => 1,
		1982	verify_peername => "https",
		1983	ca_file => "my-ca-cert.pem",
		1984	},
		1985
		1986	=item I want to create a TLS/SSL server, how do I do that?
		1987
		1988	Well, you first need to get a server certificate and key. You have
		1989	three options: a) ask a CA (buy one, use cacert.org etc.) b) create a
		1990	self-signed certificate (cheap. check the search engine of your choice,
		1991	there are many tutorials on the net) or c) make your own CA (tinyca2 is a
		1992	nice program for that purpose).
		1993
		1994	Then create a file with your private key (in PEM format, see
		1995	L<AnyEvent::TLS>), followed by the certificate (also in PEM format). The
		1996	file should then look like this:
		1997
		1998	-----BEGIN RSA PRIVATE KEY-----
		1999	...header data
		2000	... lots of base64'y-stuff
		2001	-----END RSA PRIVATE KEY-----
		2002
		2003	-----BEGIN CERTIFICATE-----
		2004	... lots of base64'y-stuff
		2005	-----END CERTIFICATE-----
		2006
		2007	The important bits are the "PRIVATE KEY" and "CERTIFICATE" parts. Then
		2008	specify this file as C<cert_file>:
		2009
		2010	tcp_server undef, $port, sub {
		2011	my ($fh) = @_;
		2012
		2013	my $handle = new AnyEvent::Handle
		2014	fh => $fh,
		2015	tls => "accept",
		2016	tls_ctx => { cert_file => "my-server-keycert.pem" },
		2017	...
		2018
		2019	When you have intermediate CA certificates that your clients might not
		2020	know about, just append them to the C<cert_file>.
		2021
		2022	=back
		2023
1503		2024
1504	=head1 SUBCLASSING AnyEvent::Handle	2025	=head1 SUBCLASSING AnyEvent::Handle
1505		2026
1506	In many cases, you might want to subclass AnyEvent::Handle.	2027	In many cases, you might want to subclass AnyEvent::Handle.
1507		2028

Diff Legend

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