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.141 by root, Mon Jul 6 01:03:09 2009 UTC vs.
Revision 1.183 by root, Thu Sep 3 12:45:35 2009 UTC

1	package AnyEvent::Handle;
2
3	no warnings;
4	use strict qw(subs vars);
5
6	use AnyEvent ();
7	use AnyEvent::Util qw(WSAEWOULDBLOCK);
8	use Scalar::Util ();
9	use Carp ();
10	use Fcntl ();
11	use Errno qw(EAGAIN EINTR);
12
13	=head1 NAME	1	=head1 NAME
14		2
15	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent	3	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent
16
17	=cut
18
19	our $VERSION = 4.452;
20		4
21	=head1 SYNOPSIS	5	=head1 SYNOPSIS
22		6
23	use AnyEvent;	7	use AnyEvent;
24	use AnyEvent::Handle;	8	use AnyEvent::Handle;
25		9
26	my $cv = AnyEvent->condvar;	10	my $cv = AnyEvent->condvar;
27		11
28	my $handle =	12	my $hdl; $hdl = new AnyEvent::Handle
29	AnyEvent::Handle->new (
30	fh => \*STDIN,	13	fh => \*STDIN,
31	on_eof => sub {	14	on_error => sub {
		15	my ($hdl, $fatal, $msg) = @_;
		16	warn "got error $msg\n";
		17	$hdl->destroy;
32	$cv->send;	18	$cv->send;
33	},
34	);	19	);
35		20
36	# send some request line	21	# send some request line
37	$handle->push_write ("getinfo\015\012");	22	$hdl->push_write ("getinfo\015\012");
38		23
39	# read the response line	24	# read the response line
40	$handle->push_read (line => sub {	25	$hdl->push_read (line => sub {
41	my ($handle, $line) = @_;	26	my ($hdl, $line) = @_;
42	warn "read line <$line>\n";	27	warn "got line <$line>\n";
43	$cv->send;	28	$cv->send;
44	});	29	});
45		30
46	$cv->recv;	31	$cv->recv;
47		32
48	=head1 DESCRIPTION	33	=head1 DESCRIPTION
49		34
50	This module is a helper module to make it easier to do event-based I/O on	35	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	36	filehandles.
52	on sockets see L<AnyEvent::Util>.
53		37
54	The L<AnyEvent::Intro> tutorial contains some well-documented	38	The L<AnyEvent::Intro> tutorial contains some well-documented
55	AnyEvent::Handle examples.	39	AnyEvent::Handle examples.
56		40
57	In the following, when the documentation refers to of "bytes" then this	41	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	42	means characters. As sysread and syswrite are used for all I/O, their
59	treatment of characters applies to this module as well.	43	treatment of characters applies to this module as well.
60		44
		45	At the very minimum, you should specify C<fh> or C<connect>, and the
		46	C<on_error> callback.
		47
61	All callbacks will be invoked with the handle object as their first	48	All callbacks will be invoked with the handle object as their first
62	argument.	49	argument.
63		50
		51	=cut
		52
		53	package AnyEvent::Handle;
		54
		55	use Scalar::Util ();
		56	use List::Util ();
		57	use Carp ();
		58	use Errno qw(EAGAIN EINTR);
		59
		60	use AnyEvent (); BEGIN { AnyEvent::common_sense }
		61	use AnyEvent::Util qw(WSAEWOULDBLOCK);
		62
		63	our $VERSION = $AnyEvent::VERSION;
		64
64	=head1 METHODS	65	=head1 METHODS
65		66
66	=over 4	67	=over 4
67		68
68	=item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value...	69	=item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value...
69		70
70	The constructor supports these arguments (all as C<< key => value >> pairs).	71	The constructor supports these arguments (all as C<< key => value >> pairs).
71		72
72	=over 4	73	=over 4
73		74
74	=item fh => $filehandle [MANDATORY]	75	=item fh => $filehandle [C<fh> or C<connect> MANDATORY]
75		76
76	The filehandle this L<AnyEvent::Handle> object will operate on.	77	The filehandle this L<AnyEvent::Handle> object will operate on.
77
78	NOTE: The filehandle will be set to non-blocking mode (using	78	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	79	C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in
80	that mode.	80	that mode.
81		81
		82	=item connect => [$host, $service] [C<fh> or C<connect> MANDATORY]
		83
		84	Try to connect to the specified host and service (port), using
		85	C<AnyEvent::Socket::tcp_connect>. The C<$host> additionally becomes the
		86	default C<peername>.
		87
		88	You have to specify either this parameter, or C<fh>, above.
		89
		90	It is possible to push requests on the read and write queues, and modify
		91	properties of the stream, even while AnyEvent::Handle is connecting.
		92
		93	When this parameter is specified, then the C<on_prepare>,
		94	C<on_connect_error> and C<on_connect> callbacks will be called under the
		95	appropriate circumstances:
		96
		97	=over 4
		98
		99	=item on_prepare => $cb->($handle)
		100
		101	This (rarely used) callback is called before a new connection is
		102	attempted, but after the file handle has been created. It could be used to
		103	prepare the file handle with parameters required for the actual connect
		104	(as opposed to settings that can be changed when the connection is already
		105	established).
		106
		107	The return value of this callback should be the connect timeout value in
		108	seconds (or C<0>, or C<undef>, or the empty list, to indicate the default
		109	timeout is to be used).
		110
		111	=item on_connect => $cb->($handle, $host, $port, $retry->())
		112
		113	This callback is called when a connection has been successfully established.
		114
		115	The actual numeric host and port (the socket peername) are passed as
		116	parameters, together with a retry callback.
		117
		118	When, for some reason, the handle is not acceptable, then calling
		119	C<$retry> will continue with the next conenction target (in case of
		120	multi-homed hosts or SRV records there can be multiple connection
		121	endpoints). When it is called then the read and write queues, eof status,
		122	tls status and similar properties of the handle are being reset.
		123
		124	In most cases, ignoring the C<$retry> parameter is the way to go.
		125
		126	=item on_connect_error => $cb->($handle, $message)
		127
		128	This callback is called when the conenction could not be
		129	established. C<$!> will contain the relevant error code, and C<$message> a
		130	message describing it (usually the same as C<"$!">).
		131
		132	If this callback isn't specified, then C<on_error> will be called with a
		133	fatal error instead.
		134
		135	=back
		136
		137	=item on_error => $cb->($handle, $fatal, $message)
		138
		139	This is the error callback, which is called when, well, some error
		140	occured, such as not being able to resolve the hostname, failure to
		141	connect or a read error.
		142
		143	Some errors are fatal (which is indicated by C<$fatal> being true). On
		144	fatal errors the handle object will be destroyed (by a call to C<< ->
		145	destroy >>) after invoking the error callback (which means you are free to
		146	examine the handle object). Examples of fatal errors are an EOF condition
		147	with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors. In
		148	cases where the other side can close the connection at their will it is
		149	often easiest to not report C<EPIPE> errors in this callback.
		150
		151	AnyEvent::Handle tries to find an appropriate error code for you to check
		152	against, but in some cases (TLS errors), this does not work well. It is
		153	recommended to always output the C<$message> argument in human-readable
		154	error messages (it's usually the same as C<"$!">).
		155
		156	Non-fatal errors can be retried by simply returning, but it is recommended
		157	to simply ignore this parameter and instead abondon the handle object
		158	when this callback is invoked. Examples of non-fatal errors are timeouts
		159	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
		160
		161	On callback entrance, the value of C<$!> contains the operating system
		162	error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
		163	C<EPROTO>).
		164
		165	While not mandatory, it is I<highly> recommended to set this callback, as
		166	you will not be notified of errors otherwise. The default simply calls
		167	C<croak>.
		168
		169	=item on_read => $cb->($handle)
		170
		171	This sets the default read callback, which is called when data arrives
		172	and no read request is in the queue (unlike read queue callbacks, this
		173	callback will only be called when at least one octet of data is in the
		174	read buffer).
		175
		176	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
		177	method or access the C<< $handle->{rbuf} >> member directly. Note that you
		178	must not enlarge or modify the read buffer, you can only remove data at
		179	the beginning from it.
		180
		181	When an EOF condition is detected then AnyEvent::Handle will first try to
		182	feed all the remaining data to the queued callbacks and C<on_read> before
		183	calling the C<on_eof> callback. If no progress can be made, then a fatal
		184	error will be raised (with C<$!> set to C<EPIPE>).
		185
		186	Note that, unlike requests in the read queue, an C<on_read> callback
		187	doesn't mean you I<require> some data: if there is an EOF and there
		188	are outstanding read requests then an error will be flagged. With an
		189	C<on_read> callback, the C<on_eof> callback will be invoked.
		190
82	=item on_eof => $cb->($handle)	191	=item on_eof => $cb->($handle)
83		192
84	Set the callback to be called when an end-of-file condition is detected,	193	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	194	i.e. in the case of a socket, when the other side has closed the
86	connection cleanly.	195	connection cleanly, and there are no outstanding read requests in the
		196	queue (if there are read requests, then an EOF counts as an unexpected
		197	connection close and will be flagged as an error).
87		198
88	For sockets, this just means that the other side has stopped sending data,	199	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	200	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	201	callback and continue writing data, as only the read part has been shut
91	down.	202	down.
92		203
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	204	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>.	205	set, then a fatal error will be raised with C<$!> set to <0>.
99
100	=item on_error => $cb->($handle, $fatal, $message)
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	AnyEvent::Handle tries to find an appropriate error code for you to check
113	against, but in some cases (TLS errors), this does not work well. It is
114	recommended to always output the C<$message> argument in human-readable
115	error messages (it's usually the same as C<"$!">).
116
117	Non-fatal errors can be retried by simply returning, but it is recommended
118	to simply ignore this parameter and instead abondon the handle object
119	when this callback is invoked. Examples of non-fatal errors are timeouts
120	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
121
122	On callback entrance, the value of C<$!> contains the operating system
123	error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
124	C<EPROTO>).
125
126	While not mandatory, it is I<highly> recommended to set this callback, as
127	you will not be notified of errors otherwise. The default simply calls
128	C<croak>.
129
130	=item on_read => $cb->($handle)
131
132	This sets the default read callback, which is called when data arrives
133	and no read request is in the queue (unlike read queue callbacks, this
134	callback will only be called when at least one octet of data is in the
135	read buffer).
136
137	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
138	method or access the C<< $handle->{rbuf} >> member directly. Note that you
139	must not enlarge or modify the read buffer, you can only remove data at
140	the beginning from it.
141
142	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
144	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>).
146		206
147	=item on_drain => $cb->($handle)	207	=item on_drain => $cb->($handle)
148		208
149	This sets the callback that is called when the write buffer becomes empty	209	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).	210	(or when the callback is set and the buffer is empty already).
…		…
157	memory and push it into the queue, but instead only read more data from	217	memory and push it into the queue, but instead only read more data from
158	the file when the write queue becomes empty.	218	the file when the write queue becomes empty.
159		219
160	=item timeout => $fractional_seconds	220	=item timeout => $fractional_seconds
161		221
		222	=item rtimeout => $fractional_seconds
		223
		224	=item wtimeout => $fractional_seconds
		225
162	If non-zero, then this enables an "inactivity" timeout: whenever this many	226	If non-zero, then these enables an "inactivity" timeout: whenever this
163	seconds pass without a successful read or write on the underlying file	227	many seconds pass without a successful read or write on the underlying
164	handle, the C<on_timeout> callback will be invoked (and if that one is	228	file handle (or a call to C<timeout_reset>), the C<on_timeout> callback
165	missing, a non-fatal C<ETIMEDOUT> error will be raised).	229	will be invoked (and if that one is missing, a non-fatal C<ETIMEDOUT>
		230	error will be raised).
		231
		232	There are three variants of the timeouts that work fully independent
		233	of each other, for both read and write, just read, and just write:
		234	C<timeout>, C<rtimeout> and C<wtimeout>, with corresponding callbacks
		235	C<on_timeout>, C<on_rtimeout> and C<on_wtimeout>, and reset functions
		236	C<timeout_reset>, C<rtimeout_reset>, and C<wtimeout_reset>.
166		237
167	Note that timeout processing is also active when you currently do not have	238	Note that timeout processing is also active when you currently do not have
168	any outstanding read or write requests: If you plan to keep the connection	239	any outstanding read or write requests: If you plan to keep the connection
169	idle then you should disable the timout temporarily or ignore the timeout	240	idle then you should disable the timout temporarily or ignore the timeout
170	in the C<on_timeout> callback, in which case AnyEvent::Handle will simply	241	in the C<on_timeout> callback, in which case AnyEvent::Handle will simply
…		…
214	accomplishd by setting this option to a true value.	285	accomplishd by setting this option to a true value.
215		286
216	The default is your opertaing system's default behaviour (most likely	287	The default is your opertaing system's default behaviour (most likely
217	enabled), this option explicitly enables or disables it, if possible.	288	enabled), this option explicitly enables or disables it, if possible.
218		289
		290	=item keepalive => <boolean>
		291
		292	Enables (default disable) the SO_KEEPALIVE option on the stream socket:
		293	normally, TCP connections have no time-out once established, so TCP
		294	conenctions, once established, can stay alive forever even when the other
		295	side has long gone. TCP keepalives are a cheap way to take down long-lived
		296	TCP connections whent he other side becomes unreachable. While the default
		297	is OS-dependent, TCP keepalives usually kick in after around two hours,
		298	and, if the other side doesn't reply, take down the TCP connection some 10
		299	to 15 minutes later.
		300
		301	It is harmless to specify this option for file handles that do not support
		302	keepalives, and enabling it on connections that are potentially long-lived
		303	is usually a good idea.
		304
		305	=item oobinline => <boolean>
		306
		307	BSD majorly fucked up the implementation of TCP urgent data. The result
		308	is that almost no OS implements TCP according to the specs, and every OS
		309	implements it slightly differently.
		310
		311	If you want to handle TCP urgent data, then setting this flag (the default
		312	is enabled) gives you the most portable way of getting urgent data, by
		313	putting it into the stream.
		314
		315	Since BSD emulation of OOB data on top of TCP's urgent data can have
		316	security implications, AnyEvent::Handle sets this flag automatically
		317	unless explicitly specified.
		318
219	=item read_size => <bytes>	319	=item read_size => <bytes>
220		320
221	The default read block size (the amount of bytes this module will	321	The default read block size (the amount of bytes this module will
222	try to read during each loop iteration, which affects memory	322	try to read during each loop iteration, which affects memory
223	requirements). Default: C<8192>.	323	requirements). Default: C<8192>.
…		…
249		349
250	A string used to identify the remote site - usually the DNS hostname	350	A string used to identify the remote site - usually the DNS hostname
251	(I<not> IDN!) used to create the connection, rarely the IP address.	351	(I<not> IDN!) used to create the connection, rarely the IP address.
252		352
253	Apart from being useful in error messages, this string is also used in TLS	353	Apart from being useful in error messages, this string is also used in TLS
254	peername verification (see C<verify_peername> in L<AnyEvent::TLS>).	354	peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This
		355	verification will be skipped when C<peername> is not specified or
		356	C<undef>.
255		357
256	=item tls => "accept" | "connect" | Net::SSLeay::SSL object	358	=item tls => "accept" | "connect" | Net::SSLeay::SSL object
257		359
258	When this parameter is given, it enables TLS (SSL) mode, that means	360	When this parameter is given, it enables TLS (SSL) mode, that means
259	AnyEvent will start a TLS handshake as soon as the conenction has been	361	AnyEvent will start a TLS handshake as soon as the conenction has been
…		…
296		398
297	Instead of an object, you can also specify a hash reference with C<< key	399	Instead of an object, you can also specify a hash reference with C<< key
298	=> value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a	400	=> value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a
299	new TLS context object.	401	new TLS context object.
300		402
		403	=item on_starttls => $cb->($handle, $success[, $error_message])
		404
		405	This callback will be invoked when the TLS/SSL handshake has finished. If
		406	C<$success> is true, then the TLS handshake succeeded, otherwise it failed
		407	(C<on_stoptls> will not be called in this case).
		408
		409	The session in C<< $handle->{tls} >> can still be examined in this
		410	callback, even when the handshake was not successful.
		411
		412	TLS handshake failures will not cause C<on_error> to be invoked when this
		413	callback is in effect, instead, the error message will be passed to C<on_starttls>.
		414
		415	Without this callback, handshake failures lead to C<on_error> being
		416	called, as normal.
		417
		418	Note that you cannot call C<starttls> right again in this callback. If you
		419	need to do that, start an zero-second timer instead whose callback can
		420	then call C<< ->starttls >> again.
		421
		422	=item on_stoptls => $cb->($handle)
		423
		424	When a SSLv3/TLS shutdown/close notify/EOF is detected and this callback is
		425	set, then it will be invoked after freeing the TLS session. If it is not,
		426	then a TLS shutdown condition will be treated like a normal EOF condition
		427	on the handle.
		428
		429	The session in C<< $handle->{tls} >> can still be examined in this
		430	callback.
		431
		432	This callback will only be called on TLS shutdowns, not when the
		433	underlying handle signals EOF.
		434
301	=item json => JSON or JSON::XS object	435	=item json => JSON or JSON::XS object
302		436
303	This is the json coder object used by the C<json> read and write types.	437	This is the json coder object used by the C<json> read and write types.
304		438
305	If you don't supply it, then AnyEvent::Handle will create and use a	439	If you don't supply it, then AnyEvent::Handle will create and use a
…		…
315		449
316	sub new {	450	sub new {
317	my $class = shift;	451	my $class = shift;
318	my $self = bless { @_ }, $class;	452	my $self = bless { @_ }, $class;
319		453
320	$self->{fh} or Carp::croak "mandatory argument fh is missing";	454	if ($self->{fh}) {
		455	$self->_start;
		456	return unless $self->{fh}; # could be gone by now
		457
		458	} elsif ($self->{connect}) {
		459	require AnyEvent::Socket;
		460
		461	$self->{peername} = $self->{connect}[0]
		462	unless exists $self->{peername};
		463
		464	$self->{_skip_drain_rbuf} = 1;
		465
		466	{
		467	Scalar::Util::weaken (my $self = $self);
		468
		469	$self->{_connect} =
		470	AnyEvent::Socket::tcp_connect (
		471	$self->{connect}[0],
		472	$self->{connect}[1],
		473	sub {
		474	my ($fh, $host, $port, $retry) = @_;
		475
		476	if ($fh) {
		477	$self->{fh} = $fh;
		478
		479	delete $self->{_skip_drain_rbuf};
		480	$self->_start;
		481
		482	$self->{on_connect}
		483	and $self->{on_connect}($self, $host, $port, sub {
		484	delete @$self{qw(fh _tw _rtw _wtw _ww _rw _eof _queue rbuf _wbuf tls _tls_rbuf _tls_wbuf)};
		485	$self->{_skip_drain_rbuf} = 1;
		486	&$retry;
		487	});
		488
		489	} else {
		490	if ($self->{on_connect_error}) {
		491	$self->{on_connect_error}($self, "$!");
		492	$self->destroy;
		493	} else {
		494	$self->_error ($!, 1);
		495	}
		496	}
		497	},
		498	sub {
		499	local $self->{fh} = $_[0];
		500
		501	$self->{on_prepare}
		502	? $self->{on_prepare}->($self)
		503	: ()
		504	}
		505	);
		506	}
		507
		508	} else {
		509	Carp::croak "AnyEvent::Handle: either an existing fh or the connect parameter must be specified";
		510	}
		511
		512	$self
		513	}
		514
		515	sub _start {
		516	my ($self) = @_;
321		517
322	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	518	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
323		519
		520	$self->{_activity} =
		521	$self->{_ractivity} =
324	$self->{_activity} = AnyEvent->now;	522	$self->{_wactivity} = AE::now;
325	$self->_timeout;
326		523
		524	$self->timeout (delete $self->{timeout} ) if $self->{timeout};
		525	$self->rtimeout (delete $self->{rtimeout} ) if $self->{rtimeout};
		526	$self->wtimeout (delete $self->{wtimeout} ) if $self->{wtimeout};
		527
327	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};	528	$self->no_delay (delete $self->{no_delay} ) if exists $self->{no_delay} && $self->{no_delay};
		529	$self->keepalive (delete $self->{keepalive}) if exists $self->{keepalive} && $self->{keepalive};
328		530
		531	$self->oobinline (exists $self->{oobinline} ? delete $self->{oobinline} : 1);
		532
329	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})	533	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
330	if $self->{tls};	534	if $self->{tls};
331		535
332	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};	536	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
333		537
334	$self->start_read	538	$self->start_read
335	if $self->{on_read};	539	if $self->{on_read} || @{ $self->{_queue} };
336		540
337	$self->{fh} && $self	541	$self->_drain_wbuf;
338	}
339
340	sub _shutdown {
341	my ($self) = @_;
342
343	delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)};
344	$self->{_eof} = 1; # tell starttls et. al to stop trying
345
346	&_freetls;
347	}	542	}
348		543
349	sub _error {	544	sub _error {
350	my ($self, $errno, $fatal, $message) = @_;	545	my ($self, $errno, $fatal, $message) = @_;
351		546
352	$self->_shutdown
353	if $fatal;
354
355	$! = $errno;	547	$! = $errno;
356	$message ||= "$!";	548	$message ||= "$!";
357		549
358	if ($self->{on_error}) {	550	if ($self->{on_error}) {
359	$self->{on_error}($self, $fatal, $message);	551	$self->{on_error}($self, $fatal, $message);
		552	$self->destroy if $fatal;
360	} elsif ($self->{fh}) {	553	} elsif ($self->{fh}) {
		554	$self->destroy;
361	Carp::croak "AnyEvent::Handle uncaught error: $message";	555	Carp::croak "AnyEvent::Handle uncaught error: $message";
362	}	556	}
363	}	557	}
364		558
365	=item $fh = $handle->fh	559	=item $fh = $handle->fh
…		…
390	$_[0]{on_eof} = $_[1];	584	$_[0]{on_eof} = $_[1];
391	}	585	}
392		586
393	=item $handle->on_timeout ($cb)	587	=item $handle->on_timeout ($cb)
394		588
395	Replace the current C<on_timeout> callback, or disables the callback (but	589	=item $handle->on_rtimeout ($cb)
396	not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
397	argument and method.
398		590
399	=cut	591	=item $handle->on_wtimeout ($cb)
400		592
401	sub on_timeout {	593	Replace the current C<on_timeout>, C<on_rtimeout> or C<on_wtimeout>
402	$_[0]{on_timeout} = $_[1];	594	callback, or disables the callback (but not the timeout) if C<$cb> =
403	}	595	C<undef>. See the C<timeout> constructor argument and method.
		596
		597	=cut
		598
		599	# see below
404		600
405	=item $handle->autocork ($boolean)	601	=item $handle->autocork ($boolean)
406		602
407	Enables or disables the current autocork behaviour (see C<autocork>	603	Enables or disables the current autocork behaviour (see C<autocork>
408	constructor argument). Changes will only take effect on the next write.	604	constructor argument). Changes will only take effect on the next write.
…		…
423	sub no_delay {	619	sub no_delay {
424	$_[0]{no_delay} = $_[1];	620	$_[0]{no_delay} = $_[1];
425		621
426	eval {	622	eval {
427	local $SIG{__DIE__};	623	local $SIG{__DIE__};
428	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];	624	setsockopt $_[0]{fh}, Socket::IPPROTO_TCP (), Socket::TCP_NODELAY (), int $_[1]
		625	if $_[0]{fh};
429	};	626	};
430	}	627	}
431		628
		629	=item $handle->keepalive ($boolean)
		630
		631	Enables or disables the C<keepalive> setting (see constructor argument of
		632	the same name for details).
		633
		634	=cut
		635
		636	sub keepalive {
		637	$_[0]{keepalive} = $_[1];
		638
		639	eval {
		640	local $SIG{__DIE__};
		641	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
		642	if $_[0]{fh};
		643	};
		644	}
		645
		646	=item $handle->oobinline ($boolean)
		647
		648	Enables or disables the C<oobinline> setting (see constructor argument of
		649	the same name for details).
		650
		651	=cut
		652
		653	sub oobinline {
		654	$_[0]{oobinline} = $_[1];
		655
		656	eval {
		657	local $SIG{__DIE__};
		658	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_OOBINLINE (), int $_[1]
		659	if $_[0]{fh};
		660	};
		661	}
		662
		663	=item $handle->keepalive ($boolean)
		664
		665	Enables or disables the C<keepalive> setting (see constructor argument of
		666	the same name for details).
		667
		668	=cut
		669
		670	sub keepalive {
		671	$_[0]{keepalive} = $_[1];
		672
		673	eval {
		674	local $SIG{__DIE__};
		675	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
		676	if $_[0]{fh};
		677	};
		678	}
		679
		680	=item $handle->on_starttls ($cb)
		681
		682	Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument).
		683
		684	=cut
		685
		686	sub on_starttls {
		687	$_[0]{on_starttls} = $_[1];
		688	}
		689
		690	=item $handle->on_stoptls ($cb)
		691
		692	Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).
		693
		694	=cut
		695
		696	sub on_starttls {
		697	$_[0]{on_stoptls} = $_[1];
		698	}
		699
		700	=item $handle->rbuf_max ($max_octets)
		701
		702	Configures the C<rbuf_max> setting (C<undef> disables it).
		703
		704	=cut
		705
		706	sub rbuf_max {
		707	$_[0]{rbuf_max} = $_[1];
		708	}
		709
432	#############################################################################	710	#############################################################################
433		711
434	=item $handle->timeout ($seconds)	712	=item $handle->timeout ($seconds)
435		713
		714	=item $handle->rtimeout ($seconds)
		715
		716	=item $handle->wtimeout ($seconds)
		717
436	Configures (or disables) the inactivity timeout.	718	Configures (or disables) the inactivity timeout.
437		719
438	=cut	720	=item $handle->timeout_reset
439		721
440	sub timeout {	722	=item $handle->rtimeout_reset
		723
		724	=item $handle->wtimeout_reset
		725
		726	Reset the activity timeout, as if data was received or sent.
		727
		728	These methods are cheap to call.
		729
		730	=cut
		731
		732	for my $dir ("", "r", "w") {
		733	my $timeout = "${dir}timeout";
		734	my $tw = "_${dir}tw";
		735	my $on_timeout = "on_${dir}timeout";
		736	my $activity = "_${dir}activity";
		737	my $cb;
		738
		739	*$on_timeout = sub {
		740	$_[0]{$on_timeout} = $_[1];
		741	};
		742
		743	*$timeout = sub {
441	my ($self, $timeout) = @_;	744	my ($self, $new_value) = @_;
442		745
443	$self->{timeout} = $timeout;	746	$self->{$timeout} = $new_value;
444	$self->_timeout;	747	delete $self->{$tw}; &$cb;
445	}	748	};
446		749
		750	*{"${dir}timeout_reset"} = sub {
		751	$_[0]{$activity} = AE::now;
		752	};
		753
		754	# main workhorse:
447	# reset the timeout watcher, as neccessary	755	# reset the timeout watcher, as neccessary
448	# also check for time-outs	756	# also check for time-outs
449	sub _timeout {	757	$cb = sub {
450	my ($self) = @_;	758	my ($self) = @_;
451		759
452	if ($self->{timeout}) {	760	if ($self->{$timeout} && $self->{fh}) {
453	my $NOW = AnyEvent->now;	761	my $NOW = AE::now;
454		762
455	# when would the timeout trigger?	763	# when would the timeout trigger?
456	my $after = $self->{_activity} + $self->{timeout} - $NOW;	764	my $after = $self->{$activity} + $self->{$timeout} - $NOW;
457		765
458	# now or in the past already?	766	# now or in the past already?
459	if ($after <= 0) {	767	if ($after <= 0) {
460	$self->{_activity} = $NOW;	768	$self->{$activity} = $NOW;
461		769
462	if ($self->{on_timeout}) {	770	if ($self->{$on_timeout}) {
463	$self->{on_timeout}($self);	771	$self->{$on_timeout}($self);
464	} else {	772	} else {
465	$self->_error (&Errno::ETIMEDOUT);	773	$self->_error (Errno::ETIMEDOUT);
		774	}
		775
		776	# callback could have changed timeout value, optimise
		777	return unless $self->{$timeout};
		778
		779	# calculate new after
		780	$after = $self->{$timeout};
466	}	781	}
467		782
468	# callback could have changed timeout value, optimise	783	Scalar::Util::weaken $self;
469	return unless $self->{timeout};	784	return unless $self; # ->error could have destroyed $self
470		785
471	# calculate new after	786	$self->{$tw} ||= AE::timer $after, 0, sub {
472	$after = $self->{timeout};	787	delete $self->{$tw};
		788	$cb->($self);
		789	};
		790	} else {
		791	delete $self->{$tw};
473	}	792	}
474
475	Scalar::Util::weaken $self;
476	return unless $self; # ->error could have destroyed $self
477
478	$self->{_tw} ||= AnyEvent->timer (after => $after, cb => sub {
479	delete $self->{_tw};
480	$self->_timeout;
481	});
482	} else {
483	delete $self->{_tw};
484	}	793	}
485	}	794	}
486		795
487	#############################################################################	796	#############################################################################
488		797
…		…
533	Scalar::Util::weaken $self;	842	Scalar::Util::weaken $self;
534		843
535	my $cb = sub {	844	my $cb = sub {
536	my $len = syswrite $self->{fh}, $self->{wbuf};	845	my $len = syswrite $self->{fh}, $self->{wbuf};
537		846
538	if ($len >= 0) {	847	if (defined $len) {
539	substr $self->{wbuf}, 0, $len, "";	848	substr $self->{wbuf}, 0, $len, "";
540		849
541	$self->{_activity} = AnyEvent->now;	850	$self->{_activity} = $self->{_wactivity} = AE::now;
542		851
543	$self->{on_drain}($self)	852	$self->{on_drain}($self)
544	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})	853	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
545	&& $self->{on_drain};	854	&& $self->{on_drain};
546		855
…		…
552		861
553	# try to write data immediately	862	# try to write data immediately
554	$cb->() unless $self->{autocork};	863	$cb->() unless $self->{autocork};
555		864
556	# if still data left in wbuf, we need to poll	865	# if still data left in wbuf, we need to poll
557	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	866	$self->{_ww} = AE::io $self->{fh}, 1, $cb
558	if length $self->{wbuf};	867	if length $self->{wbuf};
559	};	868	};
560	}	869	}
561		870
562	our %WH;	871	our %WH;
…		…
575	->($self, @_);	884	->($self, @_);
576	}	885	}
577		886
578	if ($self->{tls}) {	887	if ($self->{tls}) {
579	$self->{_tls_wbuf} .= $_[0];	888	$self->{_tls_wbuf} .= $_[0];
580		889	&_dotls ($self) if $self->{fh};
581	&_dotls ($self);
582	} else {	890	} else {
583	$self->{wbuf} .= $_[0];	891	$self->{wbuf} .= $_[0];
584	$self->_drain_wbuf;	892	$self->_drain_wbuf if $self->{fh};
585	}	893	}
586	}	894	}
587		895
588	=item $handle->push_write (type => @args)	896	=item $handle->push_write (type => @args)
589		897
…		…
653	Other languages could read single lines terminated by a newline and pass	961	Other languages could read single lines terminated by a newline and pass
654	this line into their JSON decoder of choice.	962	this line into their JSON decoder of choice.
655		963
656	=cut	964	=cut
657		965
		966	sub json_coder() {
		967	eval { require JSON::XS; JSON::XS->new->utf8 }
		968	|| do { require JSON; JSON->new->utf8 }
		969	}
		970
658	register_write_type json => sub {	971	register_write_type json => sub {
659	my ($self, $ref) = @_;	972	my ($self, $ref) = @_;
660		973
661	require JSON;	974	my $json = $self->{json} ||= json_coder;
662		975
663	$self->{json} ? $self->{json}->encode ($ref)	976	$json->encode ($ref)
664	: JSON::encode_json ($ref)
665	};	977	};
666		978
667	=item storable => $reference	979	=item storable => $reference
668		980
669	Freezes the given reference using L<Storable> and writes it to the	981	Freezes the given reference using L<Storable> and writes it to the
…		…
683		995
684	=item $handle->push_shutdown	996	=item $handle->push_shutdown
685		997
686	Sometimes you know you want to close the socket after writing your data	998	Sometimes you know you want to close the socket after writing your data
687	before it was actually written. One way to do that is to replace your	999	before it was actually written. One way to do that is to replace your
688	C<on_drain> handler by a callback that shuts down the socket. This method	1000	C<on_drain> handler by a callback that shuts down the socket (and set
689	is a shorthand for just that, and replaces the C<on_drain> callback with:	1001	C<low_water_mark> to C<0>). This method is a shorthand for just that, and
		1002	replaces the C<on_drain> callback with:
690		1003
691	sub { shutdown $_[0]{fh}, 1 } # for push_shutdown	1004	sub { shutdown $_[0]{fh}, 1 } # for push_shutdown
692		1005
693	This simply shuts down the write side and signals an EOF condition to the	1006	This simply shuts down the write side and signals an EOF condition to the
694	the peer.	1007	the peer.
…		…
697	afterwards. This is the cleanest way to close a connection.	1010	afterwards. This is the cleanest way to close a connection.
698		1011
699	=cut	1012	=cut
700		1013
701	sub push_shutdown {	1014	sub push_shutdown {
		1015	my ($self) = @_;
		1016
		1017	delete $self->{low_water_mark};
702	$_[0]->{on_drain} = sub { shutdown $_[0]{fh}, 1 };	1018	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });
703	}	1019	}
704		1020
705	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	1021	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
706		1022
707	This function (not method) lets you add your own types to C<push_write>.	1023	This function (not method) lets you add your own types to C<push_write>.
…		…
802	=cut	1118	=cut
803		1119
804	sub _drain_rbuf {	1120	sub _drain_rbuf {
805	my ($self) = @_;	1121	my ($self) = @_;
806		1122
		1123	# avoid recursion
		1124	return if $self->{_skip_drain_rbuf};
807	local $self->{_in_drain} = 1;	1125	local $self->{_skip_drain_rbuf} = 1;
808
809	if (
810	defined $self->{rbuf_max}
811	&& $self->{rbuf_max} < length $self->{rbuf}
812	) {
813	$self->_error (&Errno::ENOSPC, 1), return;
814	}
815		1126
816	while () {	1127	while () {
817	# we need to use a separate tls read buffer, as we must not receive data while	1128	# we need to use a separate tls read buffer, as we must not receive data while
818	# we are draining the buffer, and this can only happen with TLS.	1129	# we are draining the buffer, and this can only happen with TLS.
819	$self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf};	1130	$self->{rbuf} .= delete $self->{_tls_rbuf}
		1131	if exists $self->{_tls_rbuf};
820		1132
821	my $len = length $self->{rbuf};	1133	my $len = length $self->{rbuf};
822		1134
823	if (my $cb = shift @{ $self->{_queue} }) {	1135	if (my $cb = shift @{ $self->{_queue} }) {
824	unless ($cb->($self)) {	1136	unless ($cb->($self)) {
825	if ($self->{_eof}) {	1137	# no progress can be made
826	# no progress can be made (not enough data and no data forthcoming)	1138	# (not enough data and no data forthcoming)
827	$self->_error (&Errno::EPIPE, 1), return;	1139	$self->_error (Errno::EPIPE, 1), return
828	}	1140	if $self->{_eof};
829		1141
830	unshift @{ $self->{_queue} }, $cb;	1142	unshift @{ $self->{_queue} }, $cb;
831	last;	1143	last;
832	}	1144	}
833	} elsif ($self->{on_read}) {	1145	} elsif ($self->{on_read}) {
…		…
840	&& !@{ $self->{_queue} } # and the queue is still empty	1152	&& !@{ $self->{_queue} } # and the queue is still empty
841	&& $self->{on_read} # but we still have on_read	1153	&& $self->{on_read} # but we still have on_read
842	) {	1154	) {
843	# no further data will arrive	1155	# no further data will arrive
844	# so no progress can be made	1156	# so no progress can be made
845	$self->_error (&Errno::EPIPE, 1), return	1157	$self->_error (Errno::EPIPE, 1), return
846	if $self->{_eof};	1158	if $self->{_eof};
847		1159
848	last; # more data might arrive	1160	last; # more data might arrive
849	}	1161	}
850	} else {	1162	} else {
…		…
853	last;	1165	last;
854	}	1166	}
855	}	1167	}
856		1168
857	if ($self->{_eof}) {	1169	if ($self->{_eof}) {
858	if ($self->{on_eof}) {	1170	$self->{on_eof}
859	$self->{on_eof}($self)	1171	? $self->{on_eof}($self)
860	} else {
861	$self->_error (0, 1, "Unexpected end-of-file");	1172	: $self->_error (0, 1, "Unexpected end-of-file");
862	}	1173
		1174	return;
		1175	}
		1176
		1177	if (
		1178	defined $self->{rbuf_max}
		1179	&& $self->{rbuf_max} < length $self->{rbuf}
		1180	) {
		1181	$self->_error (Errno::ENOSPC, 1), return;
863	}	1182	}
864		1183
865	# may need to restart read watcher	1184	# may need to restart read watcher
866	unless ($self->{_rw}) {	1185	unless ($self->{_rw}) {
867	$self->start_read	1186	$self->start_read
…		…
879		1198
880	sub on_read {	1199	sub on_read {
881	my ($self, $cb) = @_;	1200	my ($self, $cb) = @_;
882		1201
883	$self->{on_read} = $cb;	1202	$self->{on_read} = $cb;
884	$self->_drain_rbuf if $cb && !$self->{_in_drain};	1203	$self->_drain_rbuf if $cb;
885	}	1204	}
886		1205
887	=item $handle->rbuf	1206	=item $handle->rbuf
888		1207
889	Returns the read buffer (as a modifiable lvalue).	1208	Returns the read buffer (as a modifiable lvalue).
…		…
941	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	1260	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
942	->($self, $cb, @_);	1261	->($self, $cb, @_);
943	}	1262	}
944		1263
945	push @{ $self->{_queue} }, $cb;	1264	push @{ $self->{_queue} }, $cb;
946	$self->_drain_rbuf unless $self->{_in_drain};	1265	$self->_drain_rbuf;
947	}	1266	}
948		1267
949	sub unshift_read {	1268	sub unshift_read {
950	my $self = shift;	1269	my $self = shift;
951	my $cb = pop;	1270	my $cb = pop;
…		…
955		1274
956	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")	1275	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")
957	->($self, $cb, @_);	1276	->($self, $cb, @_);
958	}	1277	}
959		1278
960
961	unshift @{ $self->{_queue} }, $cb;	1279	unshift @{ $self->{_queue} }, $cb;
962	$self->_drain_rbuf unless $self->{_in_drain};	1280	$self->_drain_rbuf;
963	}	1281	}
964		1282
965	=item $handle->push_read (type => @args, $cb)	1283	=item $handle->push_read (type => @args, $cb)
966		1284
967	=item $handle->unshift_read (type => @args, $cb)	1285	=item $handle->unshift_read (type => @args, $cb)
…		…
1100	return 1;	1418	return 1;
1101	}	1419	}
1102		1420
1103	# reject	1421	# reject
1104	if ($reject && $$rbuf =~ $reject) {	1422	if ($reject && $$rbuf =~ $reject) {
1105	$self->_error (&Errno::EBADMSG);	1423	$self->_error (Errno::EBADMSG);
1106	}	1424	}
1107		1425
1108	# skip	1426	# skip
1109	if ($skip && $$rbuf =~ $skip) {	1427	if ($skip && $$rbuf =~ $skip) {
1110	$data .= substr $$rbuf, 0, $+[0], "";	1428	$data .= substr $$rbuf, 0, $+[0], "";
…		…
1126	my ($self, $cb) = @_;	1444	my ($self, $cb) = @_;
1127		1445
1128	sub {	1446	sub {
1129	unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {	1447	unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {
1130	if ($_[0]{rbuf} =~ /[^0-9]/) {	1448	if ($_[0]{rbuf} =~ /[^0-9]/) {
1131	$self->_error (&Errno::EBADMSG);	1449	$self->_error (Errno::EBADMSG);
1132	}	1450	}
1133	return;	1451	return;
1134	}	1452	}
1135		1453
1136	my $len = $1;	1454	my $len = $1;
…		…
1139	my $string = $_[1];	1457	my $string = $_[1];
1140	$_[0]->unshift_read (chunk => 1, sub {	1458	$_[0]->unshift_read (chunk => 1, sub {
1141	if ($_[1] eq ",") {	1459	if ($_[1] eq ",") {
1142	$cb->($_[0], $string);	1460	$cb->($_[0], $string);
1143	} else {	1461	} else {
1144	$self->_error (&Errno::EBADMSG);	1462	$self->_error (Errno::EBADMSG);
1145	}	1463	}
1146	});	1464	});
1147	});	1465	});
1148		1466
1149	1	1467	1
…		…
1216	=cut	1534	=cut
1217		1535
1218	register_read_type json => sub {	1536	register_read_type json => sub {
1219	my ($self, $cb) = @_;	1537	my ($self, $cb) = @_;
1220		1538
1221	my $json = $self->{json} ||=	1539	my $json = $self->{json} ||= json_coder;
1222	eval { require JSON::XS; JSON::XS->new->utf8 }
1223	|| do { require JSON; JSON->new->utf8 };
1224		1540
1225	my $data;	1541	my $data;
1226	my $rbuf = \$self->{rbuf};	1542	my $rbuf = \$self->{rbuf};
1227		1543
1228	sub {	1544	sub {
…		…
1239	$json->incr_skip;	1555	$json->incr_skip;
1240		1556
1241	$self->{rbuf} = $json->incr_text;	1557	$self->{rbuf} = $json->incr_text;
1242	$json->incr_text = "";	1558	$json->incr_text = "";
1243		1559
1244	$self->_error (&Errno::EBADMSG);	1560	$self->_error (Errno::EBADMSG);
1245		1561
1246	()	1562	()
1247	} else {	1563	} else {
1248	$self->{rbuf} = "";	1564	$self->{rbuf} = "";
1249		1565
…		…
1286	# read remaining chunk	1602	# read remaining chunk
1287	$_[0]->unshift_read (chunk => $len, sub {	1603	$_[0]->unshift_read (chunk => $len, sub {
1288	if (my $ref = eval { Storable::thaw ($_[1]) }) {	1604	if (my $ref = eval { Storable::thaw ($_[1]) }) {
1289	$cb->($_[0], $ref);	1605	$cb->($_[0], $ref);
1290	} else {	1606	} else {
1291	$self->_error (&Errno::EBADMSG);	1607	$self->_error (Errno::EBADMSG);
1292	}	1608	}
1293	});	1609	});
1294	}	1610	}
1295		1611
1296	1	1612	1
…		…
1348	my ($self) = @_;	1664	my ($self) = @_;
1349		1665
1350	unless ($self->{_rw} || $self->{_eof}) {	1666	unless ($self->{_rw} || $self->{_eof}) {
1351	Scalar::Util::weaken $self;	1667	Scalar::Util::weaken $self;
1352		1668
1353	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1669	$self->{_rw} = AE::io $self->{fh}, 0, sub {
1354	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});	1670	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1355	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf;	1671	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf;
1356		1672
1357	if ($len > 0) {	1673	if ($len > 0) {
1358	$self->{_activity} = AnyEvent->now;	1674	$self->{_activity} = $self->{_ractivity} = AE::now;
1359		1675
1360	if ($self->{tls}) {	1676	if ($self->{tls}) {
1361	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);	1677	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1362		1678
1363	&_dotls ($self);	1679	&_dotls ($self);
1364	} else {	1680	} else {
1365	$self->_drain_rbuf unless $self->{_in_drain};	1681	$self->_drain_rbuf;
1366	}	1682	}
1367		1683
1368	} elsif (defined $len) {	1684	} elsif (defined $len) {
1369	delete $self->{_rw};	1685	delete $self->{_rw};
1370	$self->{_eof} = 1;	1686	$self->{_eof} = 1;
1371	$self->_drain_rbuf unless $self->{_in_drain};	1687	$self->_drain_rbuf;
1372		1688
1373	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1689	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1374	return $self->_error ($!, 1);	1690	return $self->_error ($!, 1);
1375	}	1691	}
1376	});	1692	};
1377	}	1693	}
1378	}	1694	}
1379		1695
1380	our $ERROR_SYSCALL;	1696	our $ERROR_SYSCALL;
1381	our $ERROR_WANT_READ;	1697	our $ERROR_WANT_READ;
1382	our $ERROR_ZERO_RETURN;
1383		1698
1384	sub _tls_error {	1699	sub _tls_error {
1385	my ($self, $err) = @_;	1700	my ($self, $err) = @_;
1386		1701
1387	return $self->_error ($!, 1)	1702	return $self->_error ($!, 1)
…		…
1390	my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());	1705	my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());
1391		1706
1392	# reduce error string to look less scary	1707	# reduce error string to look less scary
1393	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;	1708	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;
1394		1709
		1710	if ($self->{_on_starttls}) {
		1711	(delete $self->{_on_starttls})->($self, undef, $err);
		1712	&_freetls;
		1713	} else {
		1714	&_freetls;
1395	$self->_error (&Errno::EPROTO, 1, $err);	1715	$self->_error (Errno::EPROTO, 1, $err);
		1716	}
1396	}	1717	}
1397		1718
1398	# poll the write BIO and send the data if applicable	1719	# poll the write BIO and send the data if applicable
1399	# also decode read data if possible	1720	# also decode read data if possible
1400	# this is basiclaly our TLS state machine	1721	# this is basiclaly our TLS state machine
…		…
1411	}	1732	}
1412		1733
1413	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);	1734	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);
1414	return $self->_tls_error ($tmp)	1735	return $self->_tls_error ($tmp)
1415	if $tmp != $ERROR_WANT_READ	1736	if $tmp != $ERROR_WANT_READ
1416	&& ($tmp != $ERROR_SYSCALL || $!)	1737	&& ($tmp != $ERROR_SYSCALL || $!);
1417	&& $tmp != $ERROR_ZERO_RETURN;
1418	}	1738	}
1419		1739
1420	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {	1740	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
1421	unless (length $tmp) {	1741	unless (length $tmp) {
1422	# let's treat SSL-eof as we treat normal EOF	1742	$self->{_on_starttls}
1423	delete $self->{_rw};	1743	and (delete $self->{_on_starttls})->($self, undef, "EOF during handshake"); # ???
1424	$self->{_eof} = 1;
1425	&_freetls;	1744	&_freetls;
		1745
		1746	if ($self->{on_stoptls}) {
		1747	$self->{on_stoptls}($self);
		1748	return;
		1749	} else {
		1750	# let's treat SSL-eof as we treat normal EOF
		1751	delete $self->{_rw};
		1752	$self->{_eof} = 1;
		1753	}
1426	}	1754	}
1427		1755
1428	$self->{_tls_rbuf} .= $tmp;	1756	$self->{_tls_rbuf} .= $tmp;
1429	$self->_drain_rbuf unless $self->{_in_drain};	1757	$self->_drain_rbuf;
1430	$self->{tls} or return; # tls session might have gone away in callback	1758	$self->{tls} or return; # tls session might have gone away in callback
1431	}	1759	}
1432		1760
1433	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);	1761	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1434	return $self->_tls_error ($tmp)	1762	return $self->_tls_error ($tmp)
1435	if $tmp != $ERROR_WANT_READ	1763	if $tmp != $ERROR_WANT_READ
1436	&& ($tmp != $ERROR_SYSCALL || $!)	1764	&& ($tmp != $ERROR_SYSCALL || $!);
1437	&& $tmp != $ERROR_ZERO_RETURN;
1438		1765
1439	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1766	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1440	$self->{wbuf} .= $tmp;	1767	$self->{wbuf} .= $tmp;
1441	$self->_drain_wbuf;	1768	$self->_drain_wbuf;
1442	}	1769	}
		1770
		1771	$self->{_on_starttls}
		1772	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
		1773	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");
1443	}	1774	}
1444		1775
1445	=item $handle->starttls ($tls[, $tls_ctx])	1776	=item $handle->starttls ($tls[, $tls_ctx])
1446		1777
1447	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	1778	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
1448	object is created, you can also do that at a later time by calling	1779	object is created, you can also do that at a later time by calling
1449	C<starttls>.	1780	C<starttls>.
		1781
		1782	Starting TLS is currently an asynchronous operation - when you push some
		1783	write data and then call C<< ->starttls >> then TLS negotiation will start
		1784	immediately, after which the queued write data is then sent.
1450		1785
1451	The first argument is the same as the C<tls> constructor argument (either	1786	The first argument is the same as the C<tls> constructor argument (either
1452	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1787	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1453		1788
1454	The second argument is the optional C<AnyEvent::TLS> object that is used	1789	The second argument is the optional C<AnyEvent::TLS> object that is used
…		…
1459	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS	1794	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS
1460	context in C<< $handle->{tls_ctx} >> after this call and can be used or	1795	context in C<< $handle->{tls_ctx} >> after this call and can be used or
1461	changed to your liking. Note that the handshake might have already started	1796	changed to your liking. Note that the handshake might have already started
1462	when this function returns.	1797	when this function returns.
1463		1798
1464	If it an error to start a TLS handshake more than once per	1799	Due to bugs in OpenSSL, it might or might not be possible to do multiple
1465	AnyEvent::Handle object (this is due to bugs in OpenSSL).	1800	handshakes on the same stream. Best do not attempt to use the stream after
		1801	stopping TLS.
1466		1802
1467	=cut	1803	=cut
1468		1804
1469	our %TLS_CACHE; #TODO not yet documented, should we?	1805	our %TLS_CACHE; #TODO not yet documented, should we?
1470		1806
1471	sub starttls {	1807	sub starttls {
1472	my ($self, $ssl, $ctx) = @_;	1808	my ($self, $tls, $ctx) = @_;
		1809
		1810	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"
		1811	if $self->{tls};
		1812
		1813	$self->{tls} = $tls;
		1814	$self->{tls_ctx} = $ctx if @_ > 2;
		1815
		1816	return unless $self->{fh};
1473		1817
1474	require Net::SSLeay;	1818	require Net::SSLeay;
1475		1819
1476	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"
1477	if $self->{tls};
1478
1479	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();	1820	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1480	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();	1821	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1481	$ERROR_ZERO_RETURN = Net::SSLeay::ERROR_ZERO_RETURN ();
1482		1822
		1823	$tls = delete $self->{tls};
1483	$ctx ||= $self->{tls_ctx};	1824	$ctx = $self->{tls_ctx};
		1825
		1826	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
1484		1827
1485	if ("HASH" eq ref $ctx) {	1828	if ("HASH" eq ref $ctx) {
1486	require AnyEvent::TLS;	1829	require AnyEvent::TLS;
1487
1488	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context
1489		1830
1490	if ($ctx->{cache}) {	1831	if ($ctx->{cache}) {
1491	my $key = $ctx+0;	1832	my $key = $ctx+0;
1492	$ctx = $TLS_CACHE{$key} ||= new AnyEvent::TLS %$ctx;	1833	$ctx = $TLS_CACHE{$key} ||= new AnyEvent::TLS %$ctx;
1493	} else {	1834	} else {
1494	$ctx = new AnyEvent::TLS %$ctx;	1835	$ctx = new AnyEvent::TLS %$ctx;
1495	}	1836	}
1496	}	1837	}
1497		1838
1498	$self->{tls_ctx} = $ctx || TLS_CTX ();	1839	$self->{tls_ctx} = $ctx || TLS_CTX ();
1499	$self->{tls} = $ssl = $self->{tls_ctx}->_get_session ($ssl, $self, $self->{peername});	1840	$self->{tls} = $tls = $self->{tls_ctx}->_get_session ($tls, $self, $self->{peername});
1500		1841
1501	# basically, this is deep magic (because SSL_read should have the same issues)	1842	# basically, this is deep magic (because SSL_read should have the same issues)
1502	# but the openssl maintainers basically said: "trust us, it just works".	1843	# but the openssl maintainers basically said: "trust us, it just works".
1503	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1844	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1504	# and mismaintained ssleay-module doesn't even offer them).	1845	# and mismaintained ssleay-module doesn't even offer them).
…		…
1511	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to	1852	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
1512	# have identity issues in that area.	1853	# have identity issues in that area.
1513	# Net::SSLeay::CTX_set_mode ($ssl,	1854	# Net::SSLeay::CTX_set_mode ($ssl,
1514	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)	1855	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)
1515	# | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));	1856	# | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));
1516	Net::SSLeay::CTX_set_mode ($ssl, 1|2);	1857	Net::SSLeay::CTX_set_mode ($tls, 1|2);
1517		1858
1518	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1859	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1519	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1860	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1520		1861
		1862	Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf});
		1863
1521	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1864	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
		1865
		1866	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
		1867	if $self->{on_starttls};
1522		1868
1523	&_dotls; # need to trigger the initial handshake	1869	&_dotls; # need to trigger the initial handshake
1524	$self->start_read; # make sure we actually do read	1870	$self->start_read; # make sure we actually do read
1525	}	1871	}
1526		1872
1527	=item $handle->stoptls	1873	=item $handle->stoptls
1528		1874
1529	Shuts down the SSL connection - this makes a proper EOF handshake by	1875	Shuts down the SSL connection - this makes a proper EOF handshake by
1530	sending a close notify to the other side, but since OpenSSL doesn't	1876	sending a close notify to the other side, but since OpenSSL doesn't
1531	support non-blocking shut downs, it is not possible to re-use the stream	1877	support non-blocking shut downs, it is not guarenteed that you can re-use
1532	afterwards.	1878	the stream afterwards.
1533		1879
1534	=cut	1880	=cut
1535		1881
1536	sub stoptls {	1882	sub stoptls {
1537	my ($self) = @_;	1883	my ($self) = @_;
…		…
1539	if ($self->{tls}) {	1885	if ($self->{tls}) {
1540	Net::SSLeay::shutdown ($self->{tls});	1886	Net::SSLeay::shutdown ($self->{tls});
1541		1887
1542	&_dotls;	1888	&_dotls;
1543		1889
1544	# we don't give a shit. no, we do, but we can't. no...	1890	# # we don't give a shit. no, we do, but we can't. no...#d#
1545	# we, we... have to use openssl :/	1891	# # we, we... have to use openssl :/#d#
1546	&_freetls;	1892	# &_freetls;#d#
1547	}	1893	}
1548	}	1894	}
1549		1895
1550	sub _freetls {	1896	sub _freetls {
1551	my ($self) = @_;	1897	my ($self) = @_;
1552		1898
1553	return unless $self->{tls};	1899	return unless $self->{tls};
1554		1900
1555	$self->{tls_ctx}->_put_session (delete $self->{tls});	1901	$self->{tls_ctx}->_put_session (delete $self->{tls})
		1902	if $self->{tls} > 0;
1556		1903
1557	delete @$self{qw(_rbio _wbio _tls_wbuf)};	1904	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1558	}	1905	}
1559		1906
1560	sub DESTROY {	1907	sub DESTROY {
1561	my ($self) = @_;	1908	my ($self) = @_;
1562		1909
1563	&_freetls;	1910	&_freetls;
1564		1911
1565	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	1912	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1566		1913
1567	if ($linger && length $self->{wbuf}) {	1914	if ($linger && length $self->{wbuf} && $self->{fh}) {
1568	my $fh = delete $self->{fh};	1915	my $fh = delete $self->{fh};
1569	my $wbuf = delete $self->{wbuf};	1916	my $wbuf = delete $self->{wbuf};
1570		1917
1571	my @linger;	1918	my @linger;
1572		1919
1573	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {	1920	push @linger, AE::io $fh, 1, sub {
1574	my $len = syswrite $fh, $wbuf, length $wbuf;	1921	my $len = syswrite $fh, $wbuf, length $wbuf;
1575		1922
1576	if ($len > 0) {	1923	if ($len > 0) {
1577	substr $wbuf, 0, $len, "";	1924	substr $wbuf, 0, $len, "";
1578	} else {	1925	} else {
1579	@linger = (); # end	1926	@linger = (); # end
1580	}	1927	}
1581	});	1928	};
1582	push @linger, AnyEvent->timer (after => $linger, cb => sub {	1929	push @linger, AE::timer $linger, 0, sub {
1583	@linger = ();	1930	@linger = ();
1584	});	1931	};
1585	}	1932	}
1586	}	1933	}
1587		1934
1588	=item $handle->destroy	1935	=item $handle->destroy
1589		1936
1590	Shuts down the handle object as much as possible - this call ensures that	1937	Shuts down the handle object as much as possible - this call ensures that
1591	no further callbacks will be invoked and as many resources as possible	1938	no further callbacks will be invoked and as many resources as possible
1592	will be freed. You must not call any methods on the object afterwards.	1939	will be freed. Any method you will call on the handle object after
		1940	destroying it in this way will be silently ignored (and it will return the
		1941	empty list).
1593		1942
1594	Normally, you can just "forget" any references to an AnyEvent::Handle	1943	Normally, you can just "forget" any references to an AnyEvent::Handle
1595	object and it will simply shut down. This works in fatal error and EOF	1944	object and it will simply shut down. This works in fatal error and EOF
1596	callbacks, as well as code outside. It does I<NOT> work in a read or write	1945	callbacks, as well as code outside. It does I<NOT> work in a read or write
1597	callback, so when you want to destroy the AnyEvent::Handle object from	1946	callback, so when you want to destroy the AnyEvent::Handle object from
1598	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in	1947	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
1599	that case.	1948	that case.
1600		1949
		1950	Destroying the handle object in this way has the advantage that callbacks
		1951	will be removed as well, so if those are the only reference holders (as
		1952	is common), then one doesn't need to do anything special to break any
		1953	reference cycles.
		1954
1601	The handle might still linger in the background and write out remaining	1955	The handle might still linger in the background and write out remaining
1602	data, as specified by the C<linger> option, however.	1956	data, as specified by the C<linger> option, however.
1603		1957
1604	=cut	1958	=cut
1605		1959
1606	sub destroy {	1960	sub destroy {
1607	my ($self) = @_;	1961	my ($self) = @_;
1608		1962
1609	$self->DESTROY;	1963	$self->DESTROY;
1610	%$self = ();	1964	%$self = ();
		1965	bless $self, "AnyEvent::Handle::destroyed";
		1966	}
		1967
		1968	sub AnyEvent::Handle::destroyed::AUTOLOAD {
		1969	#nop
1611	}	1970	}
1612		1971
1613	=item AnyEvent::Handle::TLS_CTX	1972	=item AnyEvent::Handle::TLS_CTX
1614		1973
1615	This function creates and returns the AnyEvent::TLS object used by default	1974	This function creates and returns the AnyEvent::TLS object used by default
…		…
1672		2031
1673	$handle->on_read (sub { });	2032	$handle->on_read (sub { });
1674	$handle->on_eof (undef);	2033	$handle->on_eof (undef);
1675	$handle->on_error (sub {	2034	$handle->on_error (sub {
1676	my $data = delete $_[0]{rbuf};	2035	my $data = delete $_[0]{rbuf};
1677	undef $handle;
1678	});	2036	});
1679		2037
1680	The reason to use C<on_error> is that TCP connections, due to latencies	2038	The reason to use C<on_error> is that TCP connections, due to latencies
1681	and packets loss, might get closed quite violently with an error, when in	2039	and packets loss, might get closed quite violently with an error, when in
1682	fact, all data has been received.	2040	fact, all data has been received.
…		…
1698	$handle->on_drain (sub {	2056	$handle->on_drain (sub {
1699	warn "all data submitted to the kernel\n";	2057	warn "all data submitted to the kernel\n";
1700	undef $handle;	2058	undef $handle;
1701	});	2059	});
1702		2060
		2061	If you just want to queue some data and then signal EOF to the other side,
		2062	consider using C<< ->push_shutdown >> instead.
		2063
		2064	=item I want to contact a TLS/SSL server, I don't care about security.
		2065
		2066	If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS,
		2067	simply connect to it and then create the AnyEvent::Handle with the C<tls>
		2068	parameter:
		2069
		2070	tcp_connect $host, $port, sub {
		2071	my ($fh) = @_;
		2072
		2073	my $handle = new AnyEvent::Handle
		2074	fh => $fh,
		2075	tls => "connect",
		2076	on_error => sub { ... };
		2077
		2078	$handle->push_write (...);
		2079	};
		2080
		2081	=item I want to contact a TLS/SSL server, I do care about security.
		2082
		2083	Then you should additionally enable certificate verification, including
		2084	peername verification, if the protocol you use supports it (see
		2085	L<AnyEvent::TLS>, C<verify_peername>).
		2086
		2087	E.g. for HTTPS:
		2088
		2089	tcp_connect $host, $port, sub {
		2090	my ($fh) = @_;
		2091
		2092	my $handle = new AnyEvent::Handle
		2093	fh => $fh,
		2094	peername => $host,
		2095	tls => "connect",
		2096	tls_ctx => { verify => 1, verify_peername => "https" },
		2097	...
		2098
		2099	Note that you must specify the hostname you connected to (or whatever
		2100	"peername" the protocol needs) as the C<peername> argument, otherwise no
		2101	peername verification will be done.
		2102
		2103	The above will use the system-dependent default set of trusted CA
		2104	certificates. If you want to check against a specific CA, add the
		2105	C<ca_file> (or C<ca_cert>) arguments to C<tls_ctx>:
		2106
		2107	tls_ctx => {
		2108	verify => 1,
		2109	verify_peername => "https",
		2110	ca_file => "my-ca-cert.pem",
		2111	},
		2112
		2113	=item I want to create a TLS/SSL server, how do I do that?
		2114
		2115	Well, you first need to get a server certificate and key. You have
		2116	three options: a) ask a CA (buy one, use cacert.org etc.) b) create a
		2117	self-signed certificate (cheap. check the search engine of your choice,
		2118	there are many tutorials on the net) or c) make your own CA (tinyca2 is a
		2119	nice program for that purpose).
		2120
		2121	Then create a file with your private key (in PEM format, see
		2122	L<AnyEvent::TLS>), followed by the certificate (also in PEM format). The
		2123	file should then look like this:
		2124
		2125	-----BEGIN RSA PRIVATE KEY-----
		2126	...header data
		2127	... lots of base64'y-stuff
		2128	-----END RSA PRIVATE KEY-----
		2129
		2130	-----BEGIN CERTIFICATE-----
		2131	... lots of base64'y-stuff
		2132	-----END CERTIFICATE-----
		2133
		2134	The important bits are the "PRIVATE KEY" and "CERTIFICATE" parts. Then
		2135	specify this file as C<cert_file>:
		2136
		2137	tcp_server undef, $port, sub {
		2138	my ($fh) = @_;
		2139
		2140	my $handle = new AnyEvent::Handle
		2141	fh => $fh,
		2142	tls => "accept",
		2143	tls_ctx => { cert_file => "my-server-keycert.pem" },
		2144	...
		2145
		2146	When you have intermediate CA certificates that your clients might not
		2147	know about, just append them to the C<cert_file>.
		2148
1703	=back	2149	=back
1704		2150
1705		2151
1706	=head1 SUBCLASSING AnyEvent::Handle	2152	=head1 SUBCLASSING AnyEvent::Handle
1707		2153

Diff Legend

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