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.134 by root, Fri Jul 3 00:09:04 2009 UTC vs.
Revision 1.184 by root, Thu Sep 3 13:14:38 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.45;
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. Note that setting this flag after
		318	establishing a connection I<may> be a bit too late (data loss could
		319	already have occured on BSD systems), but at least it will protect you
		320	from most attacks.
		321
219	=item read_size => <bytes>	322	=item read_size => <bytes>
220		323
221	The default read block size (the amount of bytes this module will	324	The default read block size (the amount of bytes this module will
222	try to read during each loop iteration, which affects memory	325	try to read during each loop iteration, which affects memory
223	requirements). Default: C<8192>.	326	requirements). Default: C<8192>.
…		…
249		352
250	A string used to identify the remote site - usually the DNS hostname	353	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.	354	(I<not> IDN!) used to create the connection, rarely the IP address.
252		355
253	Apart from being useful in error messages, this string is also used in TLS	356	Apart from being useful in error messages, this string is also used in TLS
254	common name verification (see C<verify_cn> in L<AnyEvent::TLS>).	357	peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This
		358	verification will be skipped when C<peername> is not specified or
		359	C<undef>.
255		360
256	=item tls => "accept" | "connect" | Net::SSLeay::SSL object	361	=item tls => "accept" | "connect" | Net::SSLeay::SSL object
257		362
258	When this parameter is given, it enables TLS (SSL) mode, that means	363	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	364	AnyEvent will start a TLS handshake as soon as the conenction has been
…		…
296		401
297	Instead of an object, you can also specify a hash reference with C<< key	402	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	403	=> value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a
299	new TLS context object.	404	new TLS context object.
300		405
		406	=item on_starttls => $cb->($handle, $success[, $error_message])
		407
		408	This callback will be invoked when the TLS/SSL handshake has finished. If
		409	C<$success> is true, then the TLS handshake succeeded, otherwise it failed
		410	(C<on_stoptls> will not be called in this case).
		411
		412	The session in C<< $handle->{tls} >> can still be examined in this
		413	callback, even when the handshake was not successful.
		414
		415	TLS handshake failures will not cause C<on_error> to be invoked when this
		416	callback is in effect, instead, the error message will be passed to C<on_starttls>.
		417
		418	Without this callback, handshake failures lead to C<on_error> being
		419	called, as normal.
		420
		421	Note that you cannot call C<starttls> right again in this callback. If you
		422	need to do that, start an zero-second timer instead whose callback can
		423	then call C<< ->starttls >> again.
		424
		425	=item on_stoptls => $cb->($handle)
		426
		427	When a SSLv3/TLS shutdown/close notify/EOF is detected and this callback is
		428	set, then it will be invoked after freeing the TLS session. If it is not,
		429	then a TLS shutdown condition will be treated like a normal EOF condition
		430	on the handle.
		431
		432	The session in C<< $handle->{tls} >> can still be examined in this
		433	callback.
		434
		435	This callback will only be called on TLS shutdowns, not when the
		436	underlying handle signals EOF.
		437
301	=item json => JSON or JSON::XS object	438	=item json => JSON or JSON::XS object
302		439
303	This is the json coder object used by the C<json> read and write types.	440	This is the json coder object used by the C<json> read and write types.
304		441
305	If you don't supply it, then AnyEvent::Handle will create and use a	442	If you don't supply it, then AnyEvent::Handle will create and use a
…		…
315		452
316	sub new {	453	sub new {
317	my $class = shift;	454	my $class = shift;
318	my $self = bless { @_ }, $class;	455	my $self = bless { @_ }, $class;
319		456
320	$self->{fh} or Carp::croak "mandatory argument fh is missing";	457	if ($self->{fh}) {
		458	$self->_start;
		459	return unless $self->{fh}; # could be gone by now
		460
		461	} elsif ($self->{connect}) {
		462	require AnyEvent::Socket;
		463
		464	$self->{peername} = $self->{connect}[0]
		465	unless exists $self->{peername};
		466
		467	$self->{_skip_drain_rbuf} = 1;
		468
		469	{
		470	Scalar::Util::weaken (my $self = $self);
		471
		472	$self->{_connect} =
		473	AnyEvent::Socket::tcp_connect (
		474	$self->{connect}[0],
		475	$self->{connect}[1],
		476	sub {
		477	my ($fh, $host, $port, $retry) = @_;
		478
		479	if ($fh) {
		480	$self->{fh} = $fh;
		481
		482	delete $self->{_skip_drain_rbuf};
		483	$self->_start;
		484
		485	$self->{on_connect}
		486	and $self->{on_connect}($self, $host, $port, sub {
		487	delete @$self{qw(fh _tw _rtw _wtw _ww _rw _eof _queue rbuf _wbuf tls _tls_rbuf _tls_wbuf)};
		488	$self->{_skip_drain_rbuf} = 1;
		489	&$retry;
		490	});
		491
		492	} else {
		493	if ($self->{on_connect_error}) {
		494	$self->{on_connect_error}($self, "$!");
		495	$self->destroy;
		496	} else {
		497	$self->_error ($!, 1);
		498	}
		499	}
		500	},
		501	sub {
		502	local $self->{fh} = $_[0];
		503
		504	$self->{on_prepare}
		505	? $self->{on_prepare}->($self)
		506	: ()
		507	}
		508	);
		509	}
		510
		511	} else {
		512	Carp::croak "AnyEvent::Handle: either an existing fh or the connect parameter must be specified";
		513	}
		514
		515	$self
		516	}
		517
		518	sub _start {
		519	my ($self) = @_;
321		520
322	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	521	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
323		522
		523	$self->{_activity} =
		524	$self->{_ractivity} =
324	$self->{_activity} = AnyEvent->now;	525	$self->{_wactivity} = AE::now;
325	$self->_timeout;
326		526
		527	$self->timeout (delete $self->{timeout} ) if $self->{timeout};
		528	$self->rtimeout (delete $self->{rtimeout} ) if $self->{rtimeout};
		529	$self->wtimeout (delete $self->{wtimeout} ) if $self->{wtimeout};
		530
327	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};	531	$self->no_delay (delete $self->{no_delay} ) if exists $self->{no_delay} && $self->{no_delay};
		532	$self->keepalive (delete $self->{keepalive}) if exists $self->{keepalive} && $self->{keepalive};
328		533
		534	$self->oobinline (exists $self->{oobinline} ? delete $self->{oobinline} : 1);
		535
329	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})	536	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
330	if $self->{tls};	537	if $self->{tls};
331		538
332	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};	539	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
333		540
334	$self->start_read	541	$self->start_read
335	if $self->{on_read};	542	if $self->{on_read} || @{ $self->{_queue} };
336		543
337	$self->{fh} && $self	544	$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	}	545	}
348		546
349	sub _error {	547	sub _error {
350	my ($self, $errno, $fatal, $message) = @_;	548	my ($self, $errno, $fatal, $message) = @_;
351		549
352	$self->_shutdown
353	if $fatal;
354
355	$! = $errno;	550	$! = $errno;
356	$message ||= "$!";	551	$message ||= "$!";
357		552
358	if ($self->{on_error}) {	553	if ($self->{on_error}) {
359	$self->{on_error}($self, $fatal, $message);	554	$self->{on_error}($self, $fatal, $message);
		555	$self->destroy if $fatal;
360	} elsif ($self->{fh}) {	556	} elsif ($self->{fh}) {
		557	$self->destroy;
361	Carp::croak "AnyEvent::Handle uncaught error: $message";	558	Carp::croak "AnyEvent::Handle uncaught error: $message";
362	}	559	}
363	}	560	}
364		561
365	=item $fh = $handle->fh	562	=item $fh = $handle->fh
…		…
390	$_[0]{on_eof} = $_[1];	587	$_[0]{on_eof} = $_[1];
391	}	588	}
392		589
393	=item $handle->on_timeout ($cb)	590	=item $handle->on_timeout ($cb)
394		591
395	Replace the current C<on_timeout> callback, or disables the callback (but	592	=item $handle->on_rtimeout ($cb)
396	not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
397	argument and method.
398		593
399	=cut	594	=item $handle->on_wtimeout ($cb)
400		595
401	sub on_timeout {	596	Replace the current C<on_timeout>, C<on_rtimeout> or C<on_wtimeout>
402	$_[0]{on_timeout} = $_[1];	597	callback, or disables the callback (but not the timeout) if C<$cb> =
403	}	598	C<undef>. See the C<timeout> constructor argument and method.
		599
		600	=cut
		601
		602	# see below
404		603
405	=item $handle->autocork ($boolean)	604	=item $handle->autocork ($boolean)
406		605
407	Enables or disables the current autocork behaviour (see C<autocork>	606	Enables or disables the current autocork behaviour (see C<autocork>
408	constructor argument). Changes will only take effect on the next write.	607	constructor argument). Changes will only take effect on the next write.
…		…
423	sub no_delay {	622	sub no_delay {
424	$_[0]{no_delay} = $_[1];	623	$_[0]{no_delay} = $_[1];
425		624
426	eval {	625	eval {
427	local $SIG{__DIE__};	626	local $SIG{__DIE__};
428	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];	627	setsockopt $_[0]{fh}, Socket::IPPROTO_TCP (), Socket::TCP_NODELAY (), int $_[1]
		628	if $_[0]{fh};
429	};	629	};
430	}	630	}
431		631
		632	=item $handle->keepalive ($boolean)
		633
		634	Enables or disables the C<keepalive> setting (see constructor argument of
		635	the same name for details).
		636
		637	=cut
		638
		639	sub keepalive {
		640	$_[0]{keepalive} = $_[1];
		641
		642	eval {
		643	local $SIG{__DIE__};
		644	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
		645	if $_[0]{fh};
		646	};
		647	}
		648
		649	=item $handle->oobinline ($boolean)
		650
		651	Enables or disables the C<oobinline> setting (see constructor argument of
		652	the same name for details).
		653
		654	=cut
		655
		656	sub oobinline {
		657	$_[0]{oobinline} = $_[1];
		658
		659	eval {
		660	local $SIG{__DIE__};
		661	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_OOBINLINE (), int $_[1]
		662	if $_[0]{fh};
		663	};
		664	}
		665
		666	=item $handle->keepalive ($boolean)
		667
		668	Enables or disables the C<keepalive> setting (see constructor argument of
		669	the same name for details).
		670
		671	=cut
		672
		673	sub keepalive {
		674	$_[0]{keepalive} = $_[1];
		675
		676	eval {
		677	local $SIG{__DIE__};
		678	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
		679	if $_[0]{fh};
		680	};
		681	}
		682
		683	=item $handle->on_starttls ($cb)
		684
		685	Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument).
		686
		687	=cut
		688
		689	sub on_starttls {
		690	$_[0]{on_starttls} = $_[1];
		691	}
		692
		693	=item $handle->on_stoptls ($cb)
		694
		695	Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).
		696
		697	=cut
		698
		699	sub on_starttls {
		700	$_[0]{on_stoptls} = $_[1];
		701	}
		702
		703	=item $handle->rbuf_max ($max_octets)
		704
		705	Configures the C<rbuf_max> setting (C<undef> disables it).
		706
		707	=cut
		708
		709	sub rbuf_max {
		710	$_[0]{rbuf_max} = $_[1];
		711	}
		712
432	#############################################################################	713	#############################################################################
433		714
434	=item $handle->timeout ($seconds)	715	=item $handle->timeout ($seconds)
435		716
		717	=item $handle->rtimeout ($seconds)
		718
		719	=item $handle->wtimeout ($seconds)
		720
436	Configures (or disables) the inactivity timeout.	721	Configures (or disables) the inactivity timeout.
437		722
438	=cut	723	=item $handle->timeout_reset
439		724
440	sub timeout {	725	=item $handle->rtimeout_reset
		726
		727	=item $handle->wtimeout_reset
		728
		729	Reset the activity timeout, as if data was received or sent.
		730
		731	These methods are cheap to call.
		732
		733	=cut
		734
		735	for my $dir ("", "r", "w") {
		736	my $timeout = "${dir}timeout";
		737	my $tw = "_${dir}tw";
		738	my $on_timeout = "on_${dir}timeout";
		739	my $activity = "_${dir}activity";
		740	my $cb;
		741
		742	*$on_timeout = sub {
		743	$_[0]{$on_timeout} = $_[1];
		744	};
		745
		746	*$timeout = sub {
441	my ($self, $timeout) = @_;	747	my ($self, $new_value) = @_;
442		748
443	$self->{timeout} = $timeout;	749	$self->{$timeout} = $new_value;
444	$self->_timeout;	750	delete $self->{$tw}; &$cb;
445	}	751	};
446		752
		753	*{"${dir}timeout_reset"} = sub {
		754	$_[0]{$activity} = AE::now;
		755	};
		756
		757	# main workhorse:
447	# reset the timeout watcher, as neccessary	758	# reset the timeout watcher, as neccessary
448	# also check for time-outs	759	# also check for time-outs
449	sub _timeout {	760	$cb = sub {
450	my ($self) = @_;	761	my ($self) = @_;
451		762
452	if ($self->{timeout}) {	763	if ($self->{$timeout} && $self->{fh}) {
453	my $NOW = AnyEvent->now;	764	my $NOW = AE::now;
454		765
455	# when would the timeout trigger?	766	# when would the timeout trigger?
456	my $after = $self->{_activity} + $self->{timeout} - $NOW;	767	my $after = $self->{$activity} + $self->{$timeout} - $NOW;
457		768
458	# now or in the past already?	769	# now or in the past already?
459	if ($after <= 0) {	770	if ($after <= 0) {
460	$self->{_activity} = $NOW;	771	$self->{$activity} = $NOW;
461		772
462	if ($self->{on_timeout}) {	773	if ($self->{$on_timeout}) {
463	$self->{on_timeout}($self);	774	$self->{$on_timeout}($self);
464	} else {	775	} else {
465	$self->_error (&Errno::ETIMEDOUT);	776	$self->_error (Errno::ETIMEDOUT);
		777	}
		778
		779	# callback could have changed timeout value, optimise
		780	return unless $self->{$timeout};
		781
		782	# calculate new after
		783	$after = $self->{$timeout};
466	}	784	}
467		785
468	# callback could have changed timeout value, optimise	786	Scalar::Util::weaken $self;
469	return unless $self->{timeout};	787	return unless $self; # ->error could have destroyed $self
470		788
471	# calculate new after	789	$self->{$tw} ||= AE::timer $after, 0, sub {
472	$after = $self->{timeout};	790	delete $self->{$tw};
		791	$cb->($self);
		792	};
		793	} else {
		794	delete $self->{$tw};
473	}	795	}
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	}	796	}
485	}	797	}
486		798
487	#############################################################################	799	#############################################################################
488		800
…		…
533	Scalar::Util::weaken $self;	845	Scalar::Util::weaken $self;
534		846
535	my $cb = sub {	847	my $cb = sub {
536	my $len = syswrite $self->{fh}, $self->{wbuf};	848	my $len = syswrite $self->{fh}, $self->{wbuf};
537		849
538	if ($len >= 0) {	850	if (defined $len) {
539	substr $self->{wbuf}, 0, $len, "";	851	substr $self->{wbuf}, 0, $len, "";
540		852
541	$self->{_activity} = AnyEvent->now;	853	$self->{_activity} = $self->{_wactivity} = AE::now;
542		854
543	$self->{on_drain}($self)	855	$self->{on_drain}($self)
544	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})	856	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
545	&& $self->{on_drain};	857	&& $self->{on_drain};
546		858
…		…
552		864
553	# try to write data immediately	865	# try to write data immediately
554	$cb->() unless $self->{autocork};	866	$cb->() unless $self->{autocork};
555		867
556	# if still data left in wbuf, we need to poll	868	# if still data left in wbuf, we need to poll
557	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	869	$self->{_ww} = AE::io $self->{fh}, 1, $cb
558	if length $self->{wbuf};	870	if length $self->{wbuf};
559	};	871	};
560	}	872	}
561		873
562	our %WH;	874	our %WH;
…		…
575	->($self, @_);	887	->($self, @_);
576	}	888	}
577		889
578	if ($self->{tls}) {	890	if ($self->{tls}) {
579	$self->{_tls_wbuf} .= $_[0];	891	$self->{_tls_wbuf} .= $_[0];
580		892	&_dotls ($self) if $self->{fh};
581	&_dotls ($self);
582	} else {	893	} else {
583	$self->{wbuf} .= $_[0];	894	$self->{wbuf} .= $_[0];
584	$self->_drain_wbuf;	895	$self->_drain_wbuf if $self->{fh};
585	}	896	}
586	}	897	}
587		898
588	=item $handle->push_write (type => @args)	899	=item $handle->push_write (type => @args)
589		900
…		…
653	Other languages could read single lines terminated by a newline and pass	964	Other languages could read single lines terminated by a newline and pass
654	this line into their JSON decoder of choice.	965	this line into their JSON decoder of choice.
655		966
656	=cut	967	=cut
657		968
		969	sub json_coder() {
		970	eval { require JSON::XS; JSON::XS->new->utf8 }
		971	|| do { require JSON; JSON->new->utf8 }
		972	}
		973
658	register_write_type json => sub {	974	register_write_type json => sub {
659	my ($self, $ref) = @_;	975	my ($self, $ref) = @_;
660		976
661	require JSON;	977	my $json = $self->{json} ||= json_coder;
662		978
663	$self->{json} ? $self->{json}->encode ($ref)	979	$json->encode ($ref)
664	: JSON::encode_json ($ref)
665	};	980	};
666		981
667	=item storable => $reference	982	=item storable => $reference
668		983
669	Freezes the given reference using L<Storable> and writes it to the	984	Freezes the given reference using L<Storable> and writes it to the
…		…
683		998
684	=item $handle->push_shutdown	999	=item $handle->push_shutdown
685		1000
686	Sometimes you know you want to close the socket after writing your data	1001	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	1002	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	1003	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:	1004	C<low_water_mark> to C<0>). This method is a shorthand for just that, and
		1005	replaces the C<on_drain> callback with:
690		1006
691	sub { shutdown $_[0]{fh}, 1 } # for push_shutdown	1007	sub { shutdown $_[0]{fh}, 1 } # for push_shutdown
692		1008
693	This simply shuts down the write side and signals an EOF condition to the	1009	This simply shuts down the write side and signals an EOF condition to the
694	the peer.	1010	the peer.
…		…
697	afterwards. This is the cleanest way to close a connection.	1013	afterwards. This is the cleanest way to close a connection.
698		1014
699	=cut	1015	=cut
700		1016
701	sub push_shutdown {	1017	sub push_shutdown {
		1018	my ($self) = @_;
		1019
		1020	delete $self->{low_water_mark};
702	$_[0]->{on_drain} = sub { shutdown $_[0]{fh}, 1 };	1021	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });
703	}	1022	}
704		1023
705	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	1024	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
706		1025
707	This function (not method) lets you add your own types to C<push_write>.	1026	This function (not method) lets you add your own types to C<push_write>.
…		…
802	=cut	1121	=cut
803		1122
804	sub _drain_rbuf {	1123	sub _drain_rbuf {
805	my ($self) = @_;	1124	my ($self) = @_;
806		1125
		1126	# avoid recursion
		1127	return if $self->{_skip_drain_rbuf};
807	local $self->{_in_drain} = 1;	1128	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		1129
816	while () {	1130	while () {
817	# we need to use a separate tls read buffer, as we must not receive data while	1131	# 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.	1132	# we are draining the buffer, and this can only happen with TLS.
819	$self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf};	1133	$self->{rbuf} .= delete $self->{_tls_rbuf}
		1134	if exists $self->{_tls_rbuf};
820		1135
821	my $len = length $self->{rbuf};	1136	my $len = length $self->{rbuf};
822		1137
823	if (my $cb = shift @{ $self->{_queue} }) {	1138	if (my $cb = shift @{ $self->{_queue} }) {
824	unless ($cb->($self)) {	1139	unless ($cb->($self)) {
825	if ($self->{_eof}) {	1140	# no progress can be made
826	# no progress can be made (not enough data and no data forthcoming)	1141	# (not enough data and no data forthcoming)
827	$self->_error (&Errno::EPIPE, 1), return;	1142	$self->_error (Errno::EPIPE, 1), return
828	}	1143	if $self->{_eof};
829		1144
830	unshift @{ $self->{_queue} }, $cb;	1145	unshift @{ $self->{_queue} }, $cb;
831	last;	1146	last;
832	}	1147	}
833	} elsif ($self->{on_read}) {	1148	} elsif ($self->{on_read}) {
…		…
840	&& !@{ $self->{_queue} } # and the queue is still empty	1155	&& !@{ $self->{_queue} } # and the queue is still empty
841	&& $self->{on_read} # but we still have on_read	1156	&& $self->{on_read} # but we still have on_read
842	) {	1157	) {
843	# no further data will arrive	1158	# no further data will arrive
844	# so no progress can be made	1159	# so no progress can be made
845	$self->_error (&Errno::EPIPE, 1), return	1160	$self->_error (Errno::EPIPE, 1), return
846	if $self->{_eof};	1161	if $self->{_eof};
847		1162
848	last; # more data might arrive	1163	last; # more data might arrive
849	}	1164	}
850	} else {	1165	} else {
…		…
853	last;	1168	last;
854	}	1169	}
855	}	1170	}
856		1171
857	if ($self->{_eof}) {	1172	if ($self->{_eof}) {
858	if ($self->{on_eof}) {	1173	$self->{on_eof}
859	$self->{on_eof}($self)	1174	? $self->{on_eof}($self)
860	} else {	1175	: $self->_error (0, 1, "Unexpected end-of-file");
861	$self->_error (0, 1);	1176
862	}	1177	return;
		1178	}
		1179
		1180	if (
		1181	defined $self->{rbuf_max}
		1182	&& $self->{rbuf_max} < length $self->{rbuf}
		1183	) {
		1184	$self->_error (Errno::ENOSPC, 1), return;
863	}	1185	}
864		1186
865	# may need to restart read watcher	1187	# may need to restart read watcher
866	unless ($self->{_rw}) {	1188	unless ($self->{_rw}) {
867	$self->start_read	1189	$self->start_read
…		…
879		1201
880	sub on_read {	1202	sub on_read {
881	my ($self, $cb) = @_;	1203	my ($self, $cb) = @_;
882		1204
883	$self->{on_read} = $cb;	1205	$self->{on_read} = $cb;
884	$self->_drain_rbuf if $cb && !$self->{_in_drain};	1206	$self->_drain_rbuf if $cb;
885	}	1207	}
886		1208
887	=item $handle->rbuf	1209	=item $handle->rbuf
888		1210
889	Returns the read buffer (as a modifiable lvalue).	1211	Returns the read buffer (as a modifiable lvalue).
…		…
941	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	1263	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
942	->($self, $cb, @_);	1264	->($self, $cb, @_);
943	}	1265	}
944		1266
945	push @{ $self->{_queue} }, $cb;	1267	push @{ $self->{_queue} }, $cb;
946	$self->_drain_rbuf unless $self->{_in_drain};	1268	$self->_drain_rbuf;
947	}	1269	}
948		1270
949	sub unshift_read {	1271	sub unshift_read {
950	my $self = shift;	1272	my $self = shift;
951	my $cb = pop;	1273	my $cb = pop;
…		…
955		1277
956	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")	1278	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")
957	->($self, $cb, @_);	1279	->($self, $cb, @_);
958	}	1280	}
959		1281
960
961	unshift @{ $self->{_queue} }, $cb;	1282	unshift @{ $self->{_queue} }, $cb;
962	$self->_drain_rbuf unless $self->{_in_drain};	1283	$self->_drain_rbuf;
963	}	1284	}
964		1285
965	=item $handle->push_read (type => @args, $cb)	1286	=item $handle->push_read (type => @args, $cb)
966		1287
967	=item $handle->unshift_read (type => @args, $cb)	1288	=item $handle->unshift_read (type => @args, $cb)
…		…
1100	return 1;	1421	return 1;
1101	}	1422	}
1102		1423
1103	# reject	1424	# reject
1104	if ($reject && $$rbuf =~ $reject) {	1425	if ($reject && $$rbuf =~ $reject) {
1105	$self->_error (&Errno::EBADMSG);	1426	$self->_error (Errno::EBADMSG);
1106	}	1427	}
1107		1428
1108	# skip	1429	# skip
1109	if ($skip && $$rbuf =~ $skip) {	1430	if ($skip && $$rbuf =~ $skip) {
1110	$data .= substr $$rbuf, 0, $+[0], "";	1431	$data .= substr $$rbuf, 0, $+[0], "";
…		…
1126	my ($self, $cb) = @_;	1447	my ($self, $cb) = @_;
1127		1448
1128	sub {	1449	sub {
1129	unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {	1450	unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {
1130	if ($_[0]{rbuf} =~ /[^0-9]/) {	1451	if ($_[0]{rbuf} =~ /[^0-9]/) {
1131	$self->_error (&Errno::EBADMSG);	1452	$self->_error (Errno::EBADMSG);
1132	}	1453	}
1133	return;	1454	return;
1134	}	1455	}
1135		1456
1136	my $len = $1;	1457	my $len = $1;
…		…
1139	my $string = $_[1];	1460	my $string = $_[1];
1140	$_[0]->unshift_read (chunk => 1, sub {	1461	$_[0]->unshift_read (chunk => 1, sub {
1141	if ($_[1] eq ",") {	1462	if ($_[1] eq ",") {
1142	$cb->($_[0], $string);	1463	$cb->($_[0], $string);
1143	} else {	1464	} else {
1144	$self->_error (&Errno::EBADMSG);	1465	$self->_error (Errno::EBADMSG);
1145	}	1466	}
1146	});	1467	});
1147	});	1468	});
1148		1469
1149	1	1470	1
…		…
1216	=cut	1537	=cut
1217		1538
1218	register_read_type json => sub {	1539	register_read_type json => sub {
1219	my ($self, $cb) = @_;	1540	my ($self, $cb) = @_;
1220		1541
1221	require JSON;	1542	my $json = $self->{json} ||= json_coder;
1222		1543
1223	my $data;	1544	my $data;
1224	my $rbuf = \$self->{rbuf};	1545	my $rbuf = \$self->{rbuf};
1225
1226	my $json = $self->{json} ||= JSON->new->utf8;
1227		1546
1228	sub {	1547	sub {
1229	my $ref = eval { $json->incr_parse ($self->{rbuf}) };	1548	my $ref = eval { $json->incr_parse ($self->{rbuf}) };
1230		1549
1231	if ($ref) {	1550	if ($ref) {
…		…
1239	$json->incr_skip;	1558	$json->incr_skip;
1240		1559
1241	$self->{rbuf} = $json->incr_text;	1560	$self->{rbuf} = $json->incr_text;
1242	$json->incr_text = "";	1561	$json->incr_text = "";
1243		1562
1244	$self->_error (&Errno::EBADMSG);	1563	$self->_error (Errno::EBADMSG);
1245		1564
1246	()	1565	()
1247	} else {	1566	} else {
1248	$self->{rbuf} = "";	1567	$self->{rbuf} = "";
1249		1568
…		…
1286	# read remaining chunk	1605	# read remaining chunk
1287	$_[0]->unshift_read (chunk => $len, sub {	1606	$_[0]->unshift_read (chunk => $len, sub {
1288	if (my $ref = eval { Storable::thaw ($_[1]) }) {	1607	if (my $ref = eval { Storable::thaw ($_[1]) }) {
1289	$cb->($_[0], $ref);	1608	$cb->($_[0], $ref);
1290	} else {	1609	} else {
1291	$self->_error (&Errno::EBADMSG);	1610	$self->_error (Errno::EBADMSG);
1292	}	1611	}
1293	});	1612	});
1294	}	1613	}
1295		1614
1296	1	1615	1
…		…
1348	my ($self) = @_;	1667	my ($self) = @_;
1349		1668
1350	unless ($self->{_rw} || $self->{_eof}) {	1669	unless ($self->{_rw} || $self->{_eof}) {
1351	Scalar::Util::weaken $self;	1670	Scalar::Util::weaken $self;
1352		1671
1353	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1672	$self->{_rw} = AE::io $self->{fh}, 0, sub {
1354	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});	1673	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1355	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf;	1674	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf;
1356		1675
1357	if ($len > 0) {	1676	if ($len > 0) {
1358	$self->{_activity} = AnyEvent->now;	1677	$self->{_activity} = $self->{_ractivity} = AE::now;
1359		1678
1360	if ($self->{tls}) {	1679	if ($self->{tls}) {
1361	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);	1680	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1362		1681
1363	&_dotls ($self);	1682	&_dotls ($self);
1364	} else {	1683	} else {
1365	$self->_drain_rbuf unless $self->{_in_drain};	1684	$self->_drain_rbuf;
1366	}	1685	}
1367		1686
1368	} elsif (defined $len) {	1687	} elsif (defined $len) {
1369	delete $self->{_rw};	1688	delete $self->{_rw};
1370	$self->{_eof} = 1;	1689	$self->{_eof} = 1;
1371	$self->_drain_rbuf unless $self->{_in_drain};	1690	$self->_drain_rbuf;
1372		1691
1373	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1692	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1374	return $self->_error ($!, 1);	1693	return $self->_error ($!, 1);
1375	}	1694	}
1376	});	1695	};
1377	}	1696	}
1378	}	1697	}
1379		1698
1380	our $ERROR_SYSCALL;	1699	our $ERROR_SYSCALL;
1381	our $ERROR_WANT_READ;	1700	our $ERROR_WANT_READ;
1382	our $ERROR_ZERO_RETURN;
1383		1701
1384	sub _tls_error {	1702	sub _tls_error {
1385	my ($self, $err) = @_;	1703	my ($self, $err) = @_;
1386	warn "$err,$!\n";#d#
1387		1704
1388	return $self->_error ($!, 1)	1705	return $self->_error ($!, 1)
1389	if $err == Net::SSLeay::ERROR_SYSCALL ();	1706	if $err == Net::SSLeay::ERROR_SYSCALL ();
1390		1707
		1708	my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());
		1709
		1710	# reduce error string to look less scary
		1711	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;
		1712
		1713	if ($self->{_on_starttls}) {
		1714	(delete $self->{_on_starttls})->($self, undef, $err);
		1715	&_freetls;
		1716	} else {
		1717	&_freetls;
1391	$self->_error (&Errno::EPROTO, 1,	1718	$self->_error (Errno::EPROTO, 1, $err);
1392	Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ()));	1719	}
1393	}	1720	}
1394		1721
1395	# poll the write BIO and send the data if applicable	1722	# poll the write BIO and send the data if applicable
1396	# also decode read data if possible	1723	# also decode read data if possible
1397	# this is basiclaly our TLS state machine	1724	# this is basiclaly our TLS state machine
…		…
1408	}	1735	}
1409		1736
1410	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);	1737	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);
1411	return $self->_tls_error ($tmp)	1738	return $self->_tls_error ($tmp)
1412	if $tmp != $ERROR_WANT_READ	1739	if $tmp != $ERROR_WANT_READ
1413	&& ($tmp != $ERROR_SYSCALL || $!)	1740	&& ($tmp != $ERROR_SYSCALL || $!);
1414	&& $tmp != $ERROR_ZERO_RETURN;
1415	}	1741	}
1416		1742
1417	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {	1743	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
1418	unless (length $tmp) {	1744	unless (length $tmp) {
1419	# let's treat SSL-eof as we treat normal EOF	1745	$self->{_on_starttls}
1420	delete $self->{_rw};	1746	and (delete $self->{_on_starttls})->($self, undef, "EOF during handshake"); # ???
1421	$self->{_eof} = 1;
1422	&_freetls;	1747	&_freetls;
		1748
		1749	if ($self->{on_stoptls}) {
		1750	$self->{on_stoptls}($self);
		1751	return;
		1752	} else {
		1753	# let's treat SSL-eof as we treat normal EOF
		1754	delete $self->{_rw};
		1755	$self->{_eof} = 1;
		1756	}
1423	}	1757	}
1424		1758
1425	$self->{_tls_rbuf} .= $tmp;	1759	$self->{_tls_rbuf} .= $tmp;
1426	$self->_drain_rbuf unless $self->{_in_drain};	1760	$self->_drain_rbuf;
1427	$self->{tls} or return; # tls session might have gone away in callback	1761	$self->{tls} or return; # tls session might have gone away in callback
1428	}	1762	}
1429		1763
1430	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);	1764	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1431	return $self->_tls_error ($tmp)	1765	return $self->_tls_error ($tmp)
1432	if $tmp != $ERROR_WANT_READ	1766	if $tmp != $ERROR_WANT_READ
1433	&& ($tmp != $ERROR_SYSCALL || $!)	1767	&& ($tmp != $ERROR_SYSCALL || $!);
1434	&& $tmp != $ERROR_ZERO_RETURN;
1435		1768
1436	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1769	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1437	$self->{wbuf} .= $tmp;	1770	$self->{wbuf} .= $tmp;
1438	$self->_drain_wbuf;	1771	$self->_drain_wbuf;
1439	}	1772	}
		1773
		1774	$self->{_on_starttls}
		1775	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
		1776	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");
1440	}	1777	}
1441		1778
1442	=item $handle->starttls ($tls[, $tls_ctx])	1779	=item $handle->starttls ($tls[, $tls_ctx])
1443		1780
1444	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	1781	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
1445	object is created, you can also do that at a later time by calling	1782	object is created, you can also do that at a later time by calling
1446	C<starttls>.	1783	C<starttls>.
		1784
		1785	Starting TLS is currently an asynchronous operation - when you push some
		1786	write data and then call C<< ->starttls >> then TLS negotiation will start
		1787	immediately, after which the queued write data is then sent.
1447		1788
1448	The first argument is the same as the C<tls> constructor argument (either	1789	The first argument is the same as the C<tls> constructor argument (either
1449	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1790	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1450		1791
1451	The second argument is the optional C<AnyEvent::TLS> object that is used	1792	The second argument is the optional C<AnyEvent::TLS> object that is used
…		…
1456	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS	1797	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS
1457	context in C<< $handle->{tls_ctx} >> after this call and can be used or	1798	context in C<< $handle->{tls_ctx} >> after this call and can be used or
1458	changed to your liking. Note that the handshake might have already started	1799	changed to your liking. Note that the handshake might have already started
1459	when this function returns.	1800	when this function returns.
1460		1801
1461	If it an error to start a TLS handshake more than once per	1802	Due to bugs in OpenSSL, it might or might not be possible to do multiple
1462	AnyEvent::Handle object (this is due to bugs in OpenSSL).	1803	handshakes on the same stream. Best do not attempt to use the stream after
		1804	stopping TLS.
1463		1805
1464	=cut	1806	=cut
		1807
		1808	our %TLS_CACHE; #TODO not yet documented, should we?
1465		1809
1466	sub starttls {	1810	sub starttls {
1467	my ($self, $ssl, $ctx) = @_;	1811	my ($self, $tls, $ctx) = @_;
		1812
		1813	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"
		1814	if $self->{tls};
		1815
		1816	$self->{tls} = $tls;
		1817	$self->{tls_ctx} = $ctx if @_ > 2;
		1818
		1819	return unless $self->{fh};
1468		1820
1469	require Net::SSLeay;	1821	require Net::SSLeay;
1470		1822
1471	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"
1472	if $self->{tls};
1473
1474	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();	1823	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1475	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();	1824	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1476	$ERROR_ZERO_RETURN = Net::SSLeay::ERROR_ZERO_RETURN ();
1477		1825
		1826	$tls = delete $self->{tls};
1478	$ctx ||= $self->{tls_ctx};	1827	$ctx = $self->{tls_ctx};
		1828
		1829	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
1479		1830
1480	if ("HASH" eq ref $ctx) {	1831	if ("HASH" eq ref $ctx) {
1481	require AnyEvent::TLS;	1832	require AnyEvent::TLS;
1482		1833
1483	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context	1834	if ($ctx->{cache}) {
		1835	my $key = $ctx+0;
		1836	$ctx = $TLS_CACHE{$key} ||= new AnyEvent::TLS %$ctx;
		1837	} else {
1484	$ctx = new AnyEvent::TLS %$ctx;	1838	$ctx = new AnyEvent::TLS %$ctx;
		1839	}
1485	}	1840	}
1486		1841
1487	$self->{tls_ctx} = $ctx || TLS_CTX ();	1842	$self->{tls_ctx} = $ctx || TLS_CTX ();
1488	$self->{tls} = $ssl = $self->{tls_ctx}->_get_session ($ssl, $self, $self->{peername});	1843	$self->{tls} = $tls = $self->{tls_ctx}->_get_session ($tls, $self, $self->{peername});
1489		1844
1490	# basically, this is deep magic (because SSL_read should have the same issues)	1845	# basically, this is deep magic (because SSL_read should have the same issues)
1491	# but the openssl maintainers basically said: "trust us, it just works".	1846	# but the openssl maintainers basically said: "trust us, it just works".
1492	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1847	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1493	# and mismaintained ssleay-module doesn't even offer them).	1848	# and mismaintained ssleay-module doesn't even offer them).
…		…
1500	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to	1855	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
1501	# have identity issues in that area.	1856	# have identity issues in that area.
1502	# Net::SSLeay::CTX_set_mode ($ssl,	1857	# Net::SSLeay::CTX_set_mode ($ssl,
1503	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)	1858	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)
1504	# | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));	1859	# | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));
1505	Net::SSLeay::CTX_set_mode ($ssl, 1|2);	1860	Net::SSLeay::CTX_set_mode ($tls, 1|2);
1506		1861
1507	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1862	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1508	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1863	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1509		1864
		1865	Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf});
		1866
1510	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1867	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
		1868
		1869	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
		1870	if $self->{on_starttls};
1511		1871
1512	&_dotls; # need to trigger the initial handshake	1872	&_dotls; # need to trigger the initial handshake
1513	$self->start_read; # make sure we actually do read	1873	$self->start_read; # make sure we actually do read
1514	}	1874	}
1515		1875
1516	=item $handle->stoptls	1876	=item $handle->stoptls
1517		1877
1518	Shuts down the SSL connection - this makes a proper EOF handshake by	1878	Shuts down the SSL connection - this makes a proper EOF handshake by
1519	sending a close notify to the other side, but since OpenSSL doesn't	1879	sending a close notify to the other side, but since OpenSSL doesn't
1520	support non-blocking shut downs, it is not possible to re-use the stream	1880	support non-blocking shut downs, it is not guarenteed that you can re-use
1521	afterwards.	1881	the stream afterwards.
1522		1882
1523	=cut	1883	=cut
1524		1884
1525	sub stoptls {	1885	sub stoptls {
1526	my ($self) = @_;	1886	my ($self) = @_;
…		…
1528	if ($self->{tls}) {	1888	if ($self->{tls}) {
1529	Net::SSLeay::shutdown ($self->{tls});	1889	Net::SSLeay::shutdown ($self->{tls});
1530		1890
1531	&_dotls;	1891	&_dotls;
1532		1892
1533	# we don't give a shit. no, we do, but we can't. no...	1893	# # we don't give a shit. no, we do, but we can't. no...#d#
1534	# we, we... have to use openssl :/	1894	# # we, we... have to use openssl :/#d#
1535	&_freetls;	1895	# &_freetls;#d#
1536	}	1896	}
1537	}	1897	}
1538		1898
1539	sub _freetls {	1899	sub _freetls {
1540	my ($self) = @_;	1900	my ($self) = @_;
1541		1901
1542	return unless $self->{tls};	1902	return unless $self->{tls};
1543		1903
1544	$self->{tls_ctx}->_put_session (delete $self->{tls});	1904	$self->{tls_ctx}->_put_session (delete $self->{tls})
		1905	if $self->{tls} > 0;
1545		1906
1546	delete @$self{qw(_rbio _wbio _tls_wbuf)};	1907	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1547	}	1908	}
1548		1909
1549	sub DESTROY {	1910	sub DESTROY {
1550	my ($self) = @_;	1911	my ($self) = @_;
1551		1912
1552	&_freetls;	1913	&_freetls;
1553		1914
1554	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	1915	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1555		1916
1556	if ($linger && length $self->{wbuf}) {	1917	if ($linger && length $self->{wbuf} && $self->{fh}) {
1557	my $fh = delete $self->{fh};	1918	my $fh = delete $self->{fh};
1558	my $wbuf = delete $self->{wbuf};	1919	my $wbuf = delete $self->{wbuf};
1559		1920
1560	my @linger;	1921	my @linger;
1561		1922
1562	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {	1923	push @linger, AE::io $fh, 1, sub {
1563	my $len = syswrite $fh, $wbuf, length $wbuf;	1924	my $len = syswrite $fh, $wbuf, length $wbuf;
1564		1925
1565	if ($len > 0) {	1926	if ($len > 0) {
1566	substr $wbuf, 0, $len, "";	1927	substr $wbuf, 0, $len, "";
1567	} else {	1928	} else {
1568	@linger = (); # end	1929	@linger = (); # end
1569	}	1930	}
1570	});	1931	};
1571	push @linger, AnyEvent->timer (after => $linger, cb => sub {	1932	push @linger, AE::timer $linger, 0, sub {
1572	@linger = ();	1933	@linger = ();
1573	});	1934	};
1574	}	1935	}
1575	}	1936	}
1576		1937
1577	=item $handle->destroy	1938	=item $handle->destroy
1578		1939
1579	Shuts down the handle object as much as possible - this call ensures that	1940	Shuts down the handle object as much as possible - this call ensures that
1580	no further callbacks will be invoked and resources will be freed as much	1941	no further callbacks will be invoked and as many resources as possible
1581	as possible. You must not call any methods on the object afterwards.	1942	will be freed. Any method you will call on the handle object after
		1943	destroying it in this way will be silently ignored (and it will return the
		1944	empty list).
1582		1945
1583	Normally, you can just "forget" any references to an AnyEvent::Handle	1946	Normally, you can just "forget" any references to an AnyEvent::Handle
1584	object and it will simply shut down. This works in fatal error and EOF	1947	object and it will simply shut down. This works in fatal error and EOF
1585	callbacks, as well as code outside. It does I<NOT> work in a read or write	1948	callbacks, as well as code outside. It does I<NOT> work in a read or write
1586	callback, so when you want to destroy the AnyEvent::Handle object from	1949	callback, so when you want to destroy the AnyEvent::Handle object from
1587	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in	1950	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
1588	that case.	1951	that case.
1589		1952
		1953	Destroying the handle object in this way has the advantage that callbacks
		1954	will be removed as well, so if those are the only reference holders (as
		1955	is common), then one doesn't need to do anything special to break any
		1956	reference cycles.
		1957
1590	The handle might still linger in the background and write out remaining	1958	The handle might still linger in the background and write out remaining
1591	data, as specified by the C<linger> option, however.	1959	data, as specified by the C<linger> option, however.
1592		1960
1593	=cut	1961	=cut
1594		1962
1595	sub destroy {	1963	sub destroy {
1596	my ($self) = @_;	1964	my ($self) = @_;
1597		1965
1598	$self->DESTROY;	1966	$self->DESTROY;
1599	%$self = ();	1967	%$self = ();
		1968	bless $self, "AnyEvent::Handle::destroyed";
		1969	}
		1970
		1971	sub AnyEvent::Handle::destroyed::AUTOLOAD {
		1972	#nop
1600	}	1973	}
1601		1974
1602	=item AnyEvent::Handle::TLS_CTX	1975	=item AnyEvent::Handle::TLS_CTX
1603		1976
1604	This function creates and returns the AnyEvent::TLS object used by default	1977	This function creates and returns the AnyEvent::TLS object used by default
…		…
1661		2034
1662	$handle->on_read (sub { });	2035	$handle->on_read (sub { });
1663	$handle->on_eof (undef);	2036	$handle->on_eof (undef);
1664	$handle->on_error (sub {	2037	$handle->on_error (sub {
1665	my $data = delete $_[0]{rbuf};	2038	my $data = delete $_[0]{rbuf};
1666	undef $handle;
1667	});	2039	});
1668		2040
1669	The reason to use C<on_error> is that TCP connections, due to latencies	2041	The reason to use C<on_error> is that TCP connections, due to latencies
1670	and packets loss, might get closed quite violently with an error, when in	2042	and packets loss, might get closed quite violently with an error, when in
1671	fact, all data has been received.	2043	fact, all data has been received.
…		…
1687	$handle->on_drain (sub {	2059	$handle->on_drain (sub {
1688	warn "all data submitted to the kernel\n";	2060	warn "all data submitted to the kernel\n";
1689	undef $handle;	2061	undef $handle;
1690	});	2062	});
1691		2063
		2064	If you just want to queue some data and then signal EOF to the other side,
		2065	consider using C<< ->push_shutdown >> instead.
		2066
		2067	=item I want to contact a TLS/SSL server, I don't care about security.
		2068
		2069	If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS,
		2070	simply connect to it and then create the AnyEvent::Handle with the C<tls>
		2071	parameter:
		2072
		2073	tcp_connect $host, $port, sub {
		2074	my ($fh) = @_;
		2075
		2076	my $handle = new AnyEvent::Handle
		2077	fh => $fh,
		2078	tls => "connect",
		2079	on_error => sub { ... };
		2080
		2081	$handle->push_write (...);
		2082	};
		2083
		2084	=item I want to contact a TLS/SSL server, I do care about security.
		2085
		2086	Then you should additionally enable certificate verification, including
		2087	peername verification, if the protocol you use supports it (see
		2088	L<AnyEvent::TLS>, C<verify_peername>).
		2089
		2090	E.g. for HTTPS:
		2091
		2092	tcp_connect $host, $port, sub {
		2093	my ($fh) = @_;
		2094
		2095	my $handle = new AnyEvent::Handle
		2096	fh => $fh,
		2097	peername => $host,
		2098	tls => "connect",
		2099	tls_ctx => { verify => 1, verify_peername => "https" },
		2100	...
		2101
		2102	Note that you must specify the hostname you connected to (or whatever
		2103	"peername" the protocol needs) as the C<peername> argument, otherwise no
		2104	peername verification will be done.
		2105
		2106	The above will use the system-dependent default set of trusted CA
		2107	certificates. If you want to check against a specific CA, add the
		2108	C<ca_file> (or C<ca_cert>) arguments to C<tls_ctx>:
		2109
		2110	tls_ctx => {
		2111	verify => 1,
		2112	verify_peername => "https",
		2113	ca_file => "my-ca-cert.pem",
		2114	},
		2115
		2116	=item I want to create a TLS/SSL server, how do I do that?
		2117
		2118	Well, you first need to get a server certificate and key. You have
		2119	three options: a) ask a CA (buy one, use cacert.org etc.) b) create a
		2120	self-signed certificate (cheap. check the search engine of your choice,
		2121	there are many tutorials on the net) or c) make your own CA (tinyca2 is a
		2122	nice program for that purpose).
		2123
		2124	Then create a file with your private key (in PEM format, see
		2125	L<AnyEvent::TLS>), followed by the certificate (also in PEM format). The
		2126	file should then look like this:
		2127
		2128	-----BEGIN RSA PRIVATE KEY-----
		2129	...header data
		2130	... lots of base64'y-stuff
		2131	-----END RSA PRIVATE KEY-----
		2132
		2133	-----BEGIN CERTIFICATE-----
		2134	... lots of base64'y-stuff
		2135	-----END CERTIFICATE-----
		2136
		2137	The important bits are the "PRIVATE KEY" and "CERTIFICATE" parts. Then
		2138	specify this file as C<cert_file>:
		2139
		2140	tcp_server undef, $port, sub {
		2141	my ($fh) = @_;
		2142
		2143	my $handle = new AnyEvent::Handle
		2144	fh => $fh,
		2145	tls => "accept",
		2146	tls_ctx => { cert_file => "my-server-keycert.pem" },
		2147	...
		2148
		2149	When you have intermediate CA certificates that your clients might not
		2150	know about, just append them to the C<cert_file>.
		2151
1692	=back	2152	=back
1693		2153
1694		2154
1695	=head1 SUBCLASSING AnyEvent::Handle	2155	=head1 SUBCLASSING AnyEvent::Handle
1696		2156

Diff Legend

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