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

Diff Legend

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