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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.142 by root, Mon Jul 6 20:24:47 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.452;
20		4
21	=head1 SYNOPSIS	5	=head1 SYNOPSIS
22		6
23	use AnyEvent;	7	use AnyEvent;
24	use AnyEvent::Handle;	8	use AnyEvent::Handle;
25		9
26	my $cv = AnyEvent->condvar;	10	my $cv = AnyEvent->condvar;
27		11
28	my $handle =	12	my $hdl; $hdl = new AnyEvent::Handle
29	AnyEvent::Handle->new (
30	fh => \*STDIN,	13	fh => \*STDIN,
31	on_eof => sub {	14	on_error => sub {
		15	my ($hdl, $fatal, $msg) = @_;
		16	warn "got error $msg\n";
		17	$hdl->destroy;
32	$cv->send;	18	$cv->send;
33	},
34	);	19	);
35		20
36	# send some request line	21	# send some request line
37	$handle->push_write ("getinfo\015\012");	22	$hdl->push_write ("getinfo\015\012");
38		23
39	# read the response line	24	# read the response line
40	$handle->push_read (line => sub {	25	$hdl->push_read (line => sub {
41	my ($handle, $line) = @_;	26	my ($hdl, $line) = @_;
42	warn "read line <$line>\n";	27	warn "got line <$line>\n";
43	$cv->send;	28	$cv->send;
44	});	29	});
45		30
46	$cv->recv;	31	$cv->recv;
47		32
48	=head1 DESCRIPTION	33	=head1 DESCRIPTION
49		34
50	This module is a helper module to make it easier to do event-based I/O on	35	This module is a helper module to make it easier to do event-based I/O on
51	filehandles. For utility functions for doing non-blocking connects and accepts	36	filehandles.
52	on sockets see L<AnyEvent::Util>.
53		37
54	The L<AnyEvent::Intro> tutorial contains some well-documented	38	The L<AnyEvent::Intro> tutorial contains some well-documented
55	AnyEvent::Handle examples.	39	AnyEvent::Handle examples.
56		40
57	In the following, when the documentation refers to of "bytes" then this	41	In the following, when the documentation refers to of "bytes" then this
58	means characters. As sysread and syswrite are used for all I/O, their	42	means characters. As sysread and syswrite are used for all I/O, their
59	treatment of characters applies to this module as well.	43	treatment of characters applies to this module as well.
60		44
		45	At the very minimum, you should specify C<fh> or C<connect>, and the
		46	C<on_error> callback.
		47
61	All callbacks will be invoked with the handle object as their first	48	All callbacks will be invoked with the handle object as their first
62	argument.	49	argument.
63		50
		51	=cut
		52
		53	package AnyEvent::Handle;
		54
		55	use Scalar::Util ();
		56	use List::Util ();
		57	use Carp ();
		58	use Errno qw(EAGAIN EINTR);
		59
		60	use AnyEvent (); BEGIN { AnyEvent::common_sense }
		61	use AnyEvent::Util qw(WSAEWOULDBLOCK);
		62
		63	our $VERSION = $AnyEvent::VERSION;
		64
64	=head1 METHODS	65	=head1 METHODS
65		66
66	=over 4	67	=over 4
67		68
68	=item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value...	69	=item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value...
69		70
70	The constructor supports these arguments (all as C<< key => value >> pairs).	71	The constructor supports these arguments (all as C<< key => value >> pairs).
71		72
72	=over 4	73	=over 4
73		74
74	=item fh => $filehandle [MANDATORY]	75	=item fh => $filehandle [C<fh> or C<connect> MANDATORY]
75		76
76	The filehandle this L<AnyEvent::Handle> object will operate on.	77	The filehandle this L<AnyEvent::Handle> object will operate on.
77
78	NOTE: The filehandle will be set to non-blocking mode (using	78	NOTE: The filehandle will be set to non-blocking mode (using
79	C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in	79	C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in
80	that mode.	80	that mode.
81		81
		82	=item connect => [$host, $service] [C<fh> or C<connect> MANDATORY]
		83
		84	Try to connect to the specified host and service (port), using
		85	C<AnyEvent::Socket::tcp_connect>. The C<$host> additionally becomes the
		86	default C<peername>.
		87
		88	You have to specify either this parameter, or C<fh>, above.
		89
		90	It is possible to push requests on the read and write queues, and modify
		91	properties of the stream, even while AnyEvent::Handle is connecting.
		92
		93	When this parameter is specified, then the C<on_prepare>,
		94	C<on_connect_error> and C<on_connect> callbacks will be called under the
		95	appropriate circumstances:
		96
		97	=over 4
		98
		99	=item on_prepare => $cb->($handle)
		100
		101	This (rarely used) callback is called before a new connection is
		102	attempted, but after the file handle has been created. It could be used to
		103	prepare the file handle with parameters required for the actual connect
		104	(as opposed to settings that can be changed when the connection is already
		105	established).
		106
		107	The return value of this callback should be the connect timeout value in
		108	seconds (or C<0>, or C<undef>, or the empty list, to indicate the default
		109	timeout is to be used).
		110
		111	=item on_connect => $cb->($handle, $host, $port, $retry->())
		112
		113	This callback is called when a connection has been successfully established.
		114
		115	The actual numeric host and port (the socket peername) are passed as
		116	parameters, together with a retry callback.
		117
		118	When, for some reason, the handle is not acceptable, then calling
		119	C<$retry> will continue with the next conenction target (in case of
		120	multi-homed hosts or SRV records there can be multiple connection
		121	endpoints). When it is called then the read and write queues, eof status,
		122	tls status and similar properties of the handle are being reset.
		123
		124	In most cases, ignoring the C<$retry> parameter is the way to go.
		125
		126	=item on_connect_error => $cb->($handle, $message)
		127
		128	This callback is called when the conenction could not be
		129	established. C<$!> will contain the relevant error code, and C<$message> a
		130	message describing it (usually the same as C<"$!">).
		131
		132	If this callback isn't specified, then C<on_error> will be called with a
		133	fatal error instead.
		134
		135	=back
		136
		137	=item on_error => $cb->($handle, $fatal, $message)
		138
		139	This is the error callback, which is called when, well, some error
		140	occured, such as not being able to resolve the hostname, failure to
		141	connect or a read error.
		142
		143	Some errors are fatal (which is indicated by C<$fatal> being true). On
		144	fatal errors the handle object will be destroyed (by a call to C<< ->
		145	destroy >>) after invoking the error callback (which means you are free to
		146	examine the handle object). Examples of fatal errors are an EOF condition
		147	with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors. In
		148	cases where the other side can close the connection at their will it is
		149	often easiest to not report C<EPIPE> errors in this callback.
		150
		151	AnyEvent::Handle tries to find an appropriate error code for you to check
		152	against, but in some cases (TLS errors), this does not work well. It is
		153	recommended to always output the C<$message> argument in human-readable
		154	error messages (it's usually the same as C<"$!">).
		155
		156	Non-fatal errors can be retried by simply returning, but it is recommended
		157	to simply ignore this parameter and instead abondon the handle object
		158	when this callback is invoked. Examples of non-fatal errors are timeouts
		159	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
		160
		161	On callback entrance, the value of C<$!> contains the operating system
		162	error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
		163	C<EPROTO>).
		164
		165	While not mandatory, it is I<highly> recommended to set this callback, as
		166	you will not be notified of errors otherwise. The default simply calls
		167	C<croak>.
		168
		169	=item on_read => $cb->($handle)
		170
		171	This sets the default read callback, which is called when data arrives
		172	and no read request is in the queue (unlike read queue callbacks, this
		173	callback will only be called when at least one octet of data is in the
		174	read buffer).
		175
		176	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
		177	method or access the C<< $handle->{rbuf} >> member directly. Note that you
		178	must not enlarge or modify the read buffer, you can only remove data at
		179	the beginning from it.
		180
		181	When an EOF condition is detected then AnyEvent::Handle will first try to
		182	feed all the remaining data to the queued callbacks and C<on_read> before
		183	calling the C<on_eof> callback. If no progress can be made, then a fatal
		184	error will be raised (with C<$!> set to C<EPIPE>).
		185
		186	Note that, unlike requests in the read queue, an C<on_read> callback
		187	doesn't mean you I<require> some data: if there is an EOF and there
		188	are outstanding read requests then an error will be flagged. With an
		189	C<on_read> callback, the C<on_eof> callback will be invoked.
		190
82	=item on_eof => $cb->($handle)	191	=item on_eof => $cb->($handle)
83		192
84	Set the callback to be called when an end-of-file condition is detected,	193	Set the callback to be called when an end-of-file condition is detected,
85	i.e. in the case of a socket, when the other side has closed the	194	i.e. in the case of a socket, when the other side has closed the
86	connection cleanly.	195	connection cleanly, and there are no outstanding read requests in the
		196	queue (if there are read requests, then an EOF counts as an unexpected
		197	connection close and will be flagged as an error).
87		198
88	For sockets, this just means that the other side has stopped sending data,	199	For sockets, this just means that the other side has stopped sending data,
89	you can still try to write data, and, in fact, one can return from the EOF	200	you can still try to write data, and, in fact, one can return from the EOF
90	callback and continue writing data, as only the read part has been shut	201	callback and continue writing data, as only the read part has been shut
91	down.	202	down.
92		203
93	While not mandatory, it is I<highly> recommended to set an EOF callback,
94	otherwise you might end up with a closed socket while you are still
95	waiting for data.
96
97	If an EOF condition has been detected but no C<on_eof> callback has been	204	If an EOF condition has been detected but no C<on_eof> callback has been
98	set, then a fatal error will be raised with C<$!> set to <0>.	205	set, then a fatal error will be raised with C<$!> set to <0>.
99
100	=item on_error => $cb->($handle, $fatal, $message)
101
102	This is the error callback, which is called when, well, some error
103	occured, such as not being able to resolve the hostname, failure to
104	connect or a read error.
105
106	Some errors are fatal (which is indicated by C<$fatal> being true). On
107	fatal errors the handle object will be shut down and will not be usable
108	(but you are free to look at the current C<< ->rbuf >>). Examples of fatal
109	errors are an EOF condition with active (but unsatisifable) read watchers
110	(C<EPIPE>) or I/O errors.
111
112	AnyEvent::Handle tries to find an appropriate error code for you to check
113	against, but in some cases (TLS errors), this does not work well. It is
114	recommended to always output the C<$message> argument in human-readable
115	error messages (it's usually the same as C<"$!">).
116
117	Non-fatal errors can be retried by simply returning, but it is recommended
118	to simply ignore this parameter and instead abondon the handle object
119	when this callback is invoked. Examples of non-fatal errors are timeouts
120	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
121
122	On callback entrance, the value of C<$!> contains the operating system
123	error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
124	C<EPROTO>).
125
126	While not mandatory, it is I<highly> recommended to set this callback, as
127	you will not be notified of errors otherwise. The default simply calls
128	C<croak>.
129
130	=item on_read => $cb->($handle)
131
132	This sets the default read callback, which is called when data arrives
133	and no read request is in the queue (unlike read queue callbacks, this
134	callback will only be called when at least one octet of data is in the
135	read buffer).
136
137	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
138	method or access the C<< $handle->{rbuf} >> member directly. Note that you
139	must not enlarge or modify the read buffer, you can only remove data at
140	the beginning from it.
141
142	When an EOF condition is detected then AnyEvent::Handle will first try to
143	feed all the remaining data to the queued callbacks and C<on_read> before
144	calling the C<on_eof> callback. If no progress can be made, then a fatal
145	error will be raised (with C<$!> set to C<EPIPE>).
146		206
147	=item on_drain => $cb->($handle)	207	=item on_drain => $cb->($handle)
148		208
149	This sets the callback that is called when the write buffer becomes empty	209	This sets the callback that is called when the write buffer becomes empty
150	(or when the callback is set and the buffer is empty already).	210	(or when the callback is set and the buffer is empty already).
157	memory and push it into the queue, but instead only read more data from	217	memory and push it into the queue, but instead only read more data from
158	the file when the write queue becomes empty.	218	the file when the write queue becomes empty.
159		219
160	=item timeout => $fractional_seconds	220	=item timeout => $fractional_seconds
161		221
		222	=item rtimeout => $fractional_seconds
		223
		224	=item wtimeout => $fractional_seconds
		225
162	If non-zero, then this enables an "inactivity" timeout: whenever this many	226	If non-zero, then these enables an "inactivity" timeout: whenever this
163	seconds pass without a successful read or write on the underlying file	227	many seconds pass without a successful read or write on the underlying
164	handle, the C<on_timeout> callback will be invoked (and if that one is	228	file handle (or a call to C<timeout_reset>), the C<on_timeout> callback
165	missing, a non-fatal C<ETIMEDOUT> error will be raised).	229	will be invoked (and if that one is missing, a non-fatal C<ETIMEDOUT>
		230	error will be raised).
		231
		232	There are three variants of the timeouts that work fully independent
		233	of each other, for both read and write, just read, and just write:
		234	C<timeout>, C<rtimeout> and C<wtimeout>, with corresponding callbacks
		235	C<on_timeout>, C<on_rtimeout> and C<on_wtimeout>, and reset functions
		236	C<timeout_reset>, C<rtimeout_reset>, and C<wtimeout_reset>.
166		237
167	Note that timeout processing is also active when you currently do not have	238	Note that timeout processing is also active when you currently do not have
168	any outstanding read or write requests: If you plan to keep the connection	239	any outstanding read or write requests: If you plan to keep the connection
169	idle then you should disable the timout temporarily or ignore the timeout	240	idle then you should disable the timout temporarily or ignore the timeout
170	in the C<on_timeout> callback, in which case AnyEvent::Handle will simply	241	in the C<on_timeout> callback, in which case AnyEvent::Handle will simply
…		…
214	accomplishd by setting this option to a true value.	285	accomplishd by setting this option to a true value.
215		286
216	The default is your opertaing system's default behaviour (most likely	287	The default is your opertaing system's default behaviour (most likely
217	enabled), this option explicitly enables or disables it, if possible.	288	enabled), this option explicitly enables or disables it, if possible.
218		289
		290	=item keepalive => <boolean>
		291
		292	Enables (default disable) the SO_KEEPALIVE option on the stream socket:
		293	normally, TCP connections have no time-out once established, so TCP
		294	conenctions, once established, can stay alive forever even when the other
		295	side has long gone. TCP keepalives are a cheap way to take down long-lived
		296	TCP connections whent he other side becomes unreachable. While the default
		297	is OS-dependent, TCP keepalives usually kick in after around two hours,
		298	and, if the other side doesn't reply, take down the TCP connection some 10
		299	to 15 minutes later.
		300
		301	It is harmless to specify this option for file handles that do not support
		302	keepalives, and enabling it on connections that are potentially long-lived
		303	is usually a good idea.
		304
		305	=item oobinline => <boolean>
		306
		307	BSD majorly fucked up the implementation of TCP urgent data. The result
		308	is that almost no OS implements TCP according to the specs, and every OS
		309	implements it slightly differently.
		310
		311	If you want to handle TCP urgent data, then setting this flag (the default
		312	is enabled) gives you the most portable way of getting urgent data, by
		313	putting it into the stream.
		314
		315	Since BSD emulation of OOB data on top of TCP's urgent data can have
		316	security implications, AnyEvent::Handle sets this flag automatically
		317	unless explicitly specified. 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	peername verification (see C<verify_peername> 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
301	=item on_starttls => $cb->($handle, $success)	406	=item on_starttls => $cb->($handle, $success[, $error_message])
302		407
303	This callback will be invoked when the TLS/SSL handshake has finished. If	408	This callback will be invoked when the TLS/SSL handshake has finished. If
304	C<$success> is true, then the TLS handshake succeeded, otherwise it failed	409	C<$success> is true, then the TLS handshake succeeded, otherwise it failed
305	(C<on_stoptls> will not be called in this case).	410	(C<on_stoptls> will not be called in this case).
306		411
307	The session in C<< $handle->{tls} >> can still be examined in this	412	The session in C<< $handle->{tls} >> can still be examined in this
308	callback, even when the handshake was not successful.	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.
309		424
310	=item on_stoptls => $cb->($handle)	425	=item on_stoptls => $cb->($handle)
311		426
312	When a SSLv3/TLS shutdown/close notify/EOF is detected and this callback is	427	When a SSLv3/TLS shutdown/close notify/EOF is detected and this callback is
313	set, then it will be invoked after freeing the TLS session. If it is not,	428	set, then it will be invoked after freeing the TLS session. If it is not,
…		…
337		452
338	sub new {	453	sub new {
339	my $class = shift;	454	my $class = shift;
340	my $self = bless { @_ }, $class;	455	my $self = bless { @_ }, $class;
341		456
342	$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) = @_;
343		520
344	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	521	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
345		522
		523	$self->{_activity} =
		524	$self->{_ractivity} =
346	$self->{_activity} = AnyEvent->now;	525	$self->{_wactivity} = AE::now;
347	$self->_timeout;
348		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
349	$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};
350		533
		534	$self->oobinline (exists $self->{oobinline} ? delete $self->{oobinline} : 1);
		535
351	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})	536	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
352	if $self->{tls};	537	if $self->{tls};
353		538
354	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};	539	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
355		540
356	$self->start_read	541	$self->start_read
357	if $self->{on_read};	542	if $self->{on_read} \|\| @{ $self->{_queue} };
358		543
359	$self->{fh} && $self	544	$self->_drain_wbuf;
360	}
361
362	sub _shutdown {
363	my ($self) = @_;
364
365	delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)};
366	$self->{_eof} = 1; # tell starttls et. al to stop trying
367
368	&_freetls;
369	}	545	}
370		546
371	sub _error {	547	sub _error {
372	my ($self, $errno, $fatal, $message) = @_;	548	my ($self, $errno, $fatal, $message) = @_;
373		549
374	$self->_shutdown
375	if $fatal;
376
377	$! = $errno;	550	$! = $errno;
378	$message \|\|= "$!";	551	$message \|\|= "$!";
379		552
380	if ($self->{on_error}) {	553	if ($self->{on_error}) {
381	$self->{on_error}($self, $fatal, $message);	554	$self->{on_error}($self, $fatal, $message);
		555	$self->destroy if $fatal;
382	} elsif ($self->{fh}) {	556	} elsif ($self->{fh}) {
		557	$self->destroy;
383	Carp::croak "AnyEvent::Handle uncaught error: $message";	558	Carp::croak "AnyEvent::Handle uncaught error: $message";
384	}	559	}
385	}	560	}
386		561
387	=item $fh = $handle->fh	562	=item $fh = $handle->fh
…		…
412	$_[0]{on_eof} = $_[1];	587	$_[0]{on_eof} = $_[1];
413	}	588	}
414		589
415	=item $handle->on_timeout ($cb)	590	=item $handle->on_timeout ($cb)
416		591
417	Replace the current C<on_timeout> callback, or disables the callback (but	592	=item $handle->on_rtimeout ($cb)
418	not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
419	argument and method.
420		593
421	=cut	594	=item $handle->on_wtimeout ($cb)
422		595
423	sub on_timeout {	596	Replace the current C<on_timeout>, C<on_rtimeout> or C<on_wtimeout>
424	$_[0]{on_timeout} = $_[1];	597	callback, or disables the callback (but not the timeout) if C<$cb> =
425	}	598	C<undef>. See the C<timeout> constructor argument and method.
		599
		600	=cut
		601
		602	# see below
426		603
427	=item $handle->autocork ($boolean)	604	=item $handle->autocork ($boolean)
428		605
429	Enables or disables the current autocork behaviour (see C<autocork>	606	Enables or disables the current autocork behaviour (see C<autocork>
430	constructor argument). Changes will only take effect on the next write.	607	constructor argument). Changes will only take effect on the next write.
…		…
445	sub no_delay {	622	sub no_delay {
446	$_[0]{no_delay} = $_[1];	623	$_[0]{no_delay} = $_[1];
447		624
448	eval {	625	eval {
449	local $SIG{__DIE__};	626	local $SIG{__DIE__};
450	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};
		629	};
		630	}
		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};
451	};	680	};
452	}	681	}
453		682
454	=item $handle->on_starttls ($cb)	683	=item $handle->on_starttls ($cb)
455		684
…		…
469		698
470	sub on_starttls {	699	sub on_starttls {
471	$_[0]{on_stoptls} = $_[1];	700	$_[0]{on_stoptls} = $_[1];
472	}	701	}
473		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
474	#############################################################################	713	#############################################################################
475		714
476	=item $handle->timeout ($seconds)	715	=item $handle->timeout ($seconds)
477		716
		717	=item $handle->rtimeout ($seconds)
		718
		719	=item $handle->wtimeout ($seconds)
		720
478	Configures (or disables) the inactivity timeout.	721	Configures (or disables) the inactivity timeout.
479		722
480	=cut	723	=item $handle->timeout_reset
481		724
482	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 {
483	my ($self, $timeout) = @_;	747	my ($self, $new_value) = @_;
484		748
485	$self->{timeout} = $timeout;	749	$self->{$timeout} = $new_value;
486	$self->_timeout;	750	delete $self->{$tw}; &$cb;
487	}	751	};
488		752
		753	*{"${dir}timeout_reset"} = sub {
		754	$_[0]{$activity} = AE::now;
		755	};
		756
		757	# main workhorse:
489	# reset the timeout watcher, as neccessary	758	# reset the timeout watcher, as neccessary
490	# also check for time-outs	759	# also check for time-outs
491	sub _timeout {	760	$cb = sub {
492	my ($self) = @_;	761	my ($self) = @_;
493		762
494	if ($self->{timeout}) {	763	if ($self->{$timeout} && $self->{fh}) {
495	my $NOW = AnyEvent->now;	764	my $NOW = AE::now;
496		765
497	# when would the timeout trigger?	766	# when would the timeout trigger?
498	my $after = $self->{_activity} + $self->{timeout} - $NOW;	767	my $after = $self->{$activity} + $self->{$timeout} - $NOW;
499		768
500	# now or in the past already?	769	# now or in the past already?
501	if ($after <= 0) {	770	if ($after <= 0) {
502	$self->{_activity} = $NOW;	771	$self->{$activity} = $NOW;
503		772
504	if ($self->{on_timeout}) {	773	if ($self->{$on_timeout}) {
505	$self->{on_timeout}($self);	774	$self->{$on_timeout}($self);
506	} else {	775	} else {
507	$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};
508	}	784	}
509		785
510	# callback could have changed timeout value, optimise	786	Scalar::Util::weaken $self;
511	return unless $self->{timeout};	787	return unless $self; # ->error could have destroyed $self
512		788
513	# calculate new after	789	$self->{$tw} \|\|= AE::timer $after, 0, sub {
514	$after = $self->{timeout};	790	delete $self->{$tw};
		791	$cb->($self);
		792	};
		793	} else {
		794	delete $self->{$tw};
515	}	795	}
516
517	Scalar::Util::weaken $self;
518	return unless $self; # ->error could have destroyed $self
519
520	$self->{_tw} \|\|= AnyEvent->timer (after => $after, cb => sub {
521	delete $self->{_tw};
522	$self->_timeout;
523	});
524	} else {
525	delete $self->{_tw};
526	}	796	}
527	}	797	}
528		798
529	#############################################################################	799	#############################################################################
530		800
…		…
575	Scalar::Util::weaken $self;	845	Scalar::Util::weaken $self;
576		846
577	my $cb = sub {	847	my $cb = sub {
578	my $len = syswrite $self->{fh}, $self->{wbuf};	848	my $len = syswrite $self->{fh}, $self->{wbuf};
579		849
580	if ($len >= 0) {	850	if (defined $len) {
581	substr $self->{wbuf}, 0, $len, "";	851	substr $self->{wbuf}, 0, $len, "";
582		852
583	$self->{_activity} = AnyEvent->now;	853	$self->{_activity} = $self->{_wactivity} = AE::now;
584		854
585	$self->{on_drain}($self)	855	$self->{on_drain}($self)
586	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})
587	&& $self->{on_drain};	857	&& $self->{on_drain};
588		858
…		…
594		864
595	# try to write data immediately	865	# try to write data immediately
596	$cb->() unless $self->{autocork};	866	$cb->() unless $self->{autocork};
597		867
598	# if still data left in wbuf, we need to poll	868	# if still data left in wbuf, we need to poll
599	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	869	$self->{_ww} = AE::io $self->{fh}, 1, $cb
600	if length $self->{wbuf};	870	if length $self->{wbuf};
601	};	871	};
602	}	872	}
603		873
604	our %WH;	874	our %WH;
…		…
617	->($self, @_);	887	->($self, @_);
618	}	888	}
619		889
620	if ($self->{tls}) {	890	if ($self->{tls}) {
621	$self->{_tls_wbuf} .= $_[0];	891	$self->{_tls_wbuf} .= $_[0];
622		892	&_dotls ($self) if $self->{fh};
623	&_dotls ($self);
624	} else {	893	} else {
625	$self->{wbuf} .= $_[0];	894	$self->{wbuf} .= $_[0];
626	$self->_drain_wbuf;	895	$self->_drain_wbuf if $self->{fh};
627	}	896	}
628	}	897	}
629		898
630	=item $handle->push_write (type => @args)	899	=item $handle->push_write (type => @args)
631		900
…		…
695	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
696	this line into their JSON decoder of choice.	965	this line into their JSON decoder of choice.
697		966
698	=cut	967	=cut
699		968
		969	sub json_coder() {
		970	eval { require JSON::XS; JSON::XS->new->utf8 }
		971	\|\| do { require JSON; JSON->new->utf8 }
		972	}
		973
700	register_write_type json => sub {	974	register_write_type json => sub {
701	my ($self, $ref) = @_;	975	my ($self, $ref) = @_;
702		976
703	require JSON;	977	my $json = $self->{json} \|\|= json_coder;
704		978
705	$self->{json} ? $self->{json}->encode ($ref)	979	$json->encode ($ref)
706	: JSON::encode_json ($ref)
707	};	980	};
708		981
709	=item storable => $reference	982	=item storable => $reference
710		983
711	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
…		…
848	=cut	1121	=cut
849		1122
850	sub _drain_rbuf {	1123	sub _drain_rbuf {
851	my ($self) = @_;	1124	my ($self) = @_;
852		1125
		1126	# avoid recursion
		1127	return if $self->{_skip_drain_rbuf};
853	local $self->{_in_drain} = 1;	1128	local $self->{_skip_drain_rbuf} = 1;
854
855	if (
856	defined $self->{rbuf_max}
857	&& $self->{rbuf_max} < length $self->{rbuf}
858	) {
859	$self->_error (&Errno::ENOSPC, 1), return;
860	}
861		1129
862	while () {	1130	while () {
863	# 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
864	# 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.
865	$self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf};	1133	$self->{rbuf} .= delete $self->{_tls_rbuf}
		1134	if exists $self->{_tls_rbuf};
866		1135
867	my $len = length $self->{rbuf};	1136	my $len = length $self->{rbuf};
868		1137
869	if (my $cb = shift @{ $self->{_queue} }) {	1138	if (my $cb = shift @{ $self->{_queue} }) {
870	unless ($cb->($self)) {	1139	unless ($cb->($self)) {
871	if ($self->{_eof}) {	1140	# no progress can be made
872	# no progress can be made (not enough data and no data forthcoming)	1141	# (not enough data and no data forthcoming)
873	$self->_error (&Errno::EPIPE, 1), return;	1142	$self->_error (Errno::EPIPE, 1), return
874	}	1143	if $self->{_eof};
875		1144
876	unshift @{ $self->{_queue} }, $cb;	1145	unshift @{ $self->{_queue} }, $cb;
877	last;	1146	last;
878	}	1147	}
879	} elsif ($self->{on_read}) {	1148	} elsif ($self->{on_read}) {
…		…
886	&& !@{ $self->{_queue} } # and the queue is still empty	1155	&& !@{ $self->{_queue} } # and the queue is still empty
887	&& $self->{on_read} # but we still have on_read	1156	&& $self->{on_read} # but we still have on_read
888	) {	1157	) {
889	# no further data will arrive	1158	# no further data will arrive
890	# so no progress can be made	1159	# so no progress can be made
891	$self->_error (&Errno::EPIPE, 1), return	1160	$self->_error (Errno::EPIPE, 1), return
892	if $self->{_eof};	1161	if $self->{_eof};
893		1162
894	last; # more data might arrive	1163	last; # more data might arrive
895	}	1164	}
896	} else {	1165	} else {
…		…
899	last;	1168	last;
900	}	1169	}
901	}	1170	}
902		1171
903	if ($self->{_eof}) {	1172	if ($self->{_eof}) {
904	if ($self->{on_eof}) {	1173	$self->{on_eof}
905	$self->{on_eof}($self)	1174	? $self->{on_eof}($self)
906	} else {
907	$self->_error (0, 1, "Unexpected end-of-file");	1175	: $self->_error (0, 1, "Unexpected end-of-file");
908	}	1176
		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;
909	}	1185	}
910		1186
911	# may need to restart read watcher	1187	# may need to restart read watcher
912	unless ($self->{_rw}) {	1188	unless ($self->{_rw}) {
913	$self->start_read	1189	$self->start_read
…		…
925		1201
926	sub on_read {	1202	sub on_read {
927	my ($self, $cb) = @_;	1203	my ($self, $cb) = @_;
928		1204
929	$self->{on_read} = $cb;	1205	$self->{on_read} = $cb;
930	$self->_drain_rbuf if $cb && !$self->{_in_drain};	1206	$self->_drain_rbuf if $cb;
931	}	1207	}
932		1208
933	=item $handle->rbuf	1209	=item $handle->rbuf
934		1210
935	Returns the read buffer (as a modifiable lvalue).	1211	Returns the read buffer (as a modifiable lvalue).
…		…
987	$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")
988	->($self, $cb, @_);	1264	->($self, $cb, @_);
989	}	1265	}
990		1266
991	push @{ $self->{_queue} }, $cb;	1267	push @{ $self->{_queue} }, $cb;
992	$self->_drain_rbuf unless $self->{_in_drain};	1268	$self->_drain_rbuf;
993	}	1269	}
994		1270
995	sub unshift_read {	1271	sub unshift_read {
996	my $self = shift;	1272	my $self = shift;
997	my $cb = pop;	1273	my $cb = pop;
…		…
1001		1277
1002	$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")
1003	->($self, $cb, @_);	1279	->($self, $cb, @_);
1004	}	1280	}
1005		1281
1006
1007	unshift @{ $self->{_queue} }, $cb;	1282	unshift @{ $self->{_queue} }, $cb;
1008	$self->_drain_rbuf unless $self->{_in_drain};	1283	$self->_drain_rbuf;
1009	}	1284	}
1010		1285
1011	=item $handle->push_read (type => @args, $cb)	1286	=item $handle->push_read (type => @args, $cb)
1012		1287
1013	=item $handle->unshift_read (type => @args, $cb)	1288	=item $handle->unshift_read (type => @args, $cb)
…		…
1146	return 1;	1421	return 1;
1147	}	1422	}
1148		1423
1149	# reject	1424	# reject
1150	if ($reject && $$rbuf =~ $reject) {	1425	if ($reject && $$rbuf =~ $reject) {
1151	$self->_error (&Errno::EBADMSG);	1426	$self->_error (Errno::EBADMSG);
1152	}	1427	}
1153		1428
1154	# skip	1429	# skip
1155	if ($skip && $$rbuf =~ $skip) {	1430	if ($skip && $$rbuf =~ $skip) {
1156	$data .= substr $$rbuf, 0, $+[0], "";	1431	$data .= substr $$rbuf, 0, $+[0], "";
…		…
1172	my ($self, $cb) = @_;	1447	my ($self, $cb) = @_;
1173		1448
1174	sub {	1449	sub {
1175	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {	1450	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
1176	if ($_[0]{rbuf} =~ /[^0-9]/) {	1451	if ($_[0]{rbuf} =~ /[^0-9]/) {
1177	$self->_error (&Errno::EBADMSG);	1452	$self->_error (Errno::EBADMSG);
1178	}	1453	}
1179	return;	1454	return;
1180	}	1455	}
1181		1456
1182	my $len = $1;	1457	my $len = $1;
…		…
1185	my $string = $_[1];	1460	my $string = $_[1];
1186	$_[0]->unshift_read (chunk => 1, sub {	1461	$_[0]->unshift_read (chunk => 1, sub {
1187	if ($_[1] eq ",") {	1462	if ($_[1] eq ",") {
1188	$cb->($_[0], $string);	1463	$cb->($_[0], $string);
1189	} else {	1464	} else {
1190	$self->_error (&Errno::EBADMSG);	1465	$self->_error (Errno::EBADMSG);
1191	}	1466	}
1192	});	1467	});
1193	});	1468	});
1194		1469
1195	1	1470	1
…		…
1262	=cut	1537	=cut
1263		1538
1264	register_read_type json => sub {	1539	register_read_type json => sub {
1265	my ($self, $cb) = @_;	1540	my ($self, $cb) = @_;
1266		1541
1267	my $json = $self->{json} \|\|=	1542	my $json = $self->{json} \|\|= json_coder;
1268	eval { require JSON::XS; JSON::XS->new->utf8 }
1269	\|\| do { require JSON; JSON->new->utf8 };
1270		1543
1271	my $data;	1544	my $data;
1272	my $rbuf = \$self->{rbuf};	1545	my $rbuf = \$self->{rbuf};
1273		1546
1274	sub {	1547	sub {
…		…
1285	$json->incr_skip;	1558	$json->incr_skip;
1286		1559
1287	$self->{rbuf} = $json->incr_text;	1560	$self->{rbuf} = $json->incr_text;
1288	$json->incr_text = "";	1561	$json->incr_text = "";
1289		1562
1290	$self->_error (&Errno::EBADMSG);	1563	$self->_error (Errno::EBADMSG);
1291		1564
1292	()	1565	()
1293	} else {	1566	} else {
1294	$self->{rbuf} = "";	1567	$self->{rbuf} = "";
1295		1568
…		…
1332	# read remaining chunk	1605	# read remaining chunk
1333	$_[0]->unshift_read (chunk => $len, sub {	1606	$_[0]->unshift_read (chunk => $len, sub {
1334	if (my $ref = eval { Storable::thaw ($_[1]) }) {	1607	if (my $ref = eval { Storable::thaw ($_[1]) }) {
1335	$cb->($_[0], $ref);	1608	$cb->($_[0], $ref);
1336	} else {	1609	} else {
1337	$self->_error (&Errno::EBADMSG);	1610	$self->_error (Errno::EBADMSG);
1338	}	1611	}
1339	});	1612	});
1340	}	1613	}
1341		1614
1342	1	1615	1
…		…
1394	my ($self) = @_;	1667	my ($self) = @_;
1395		1668
1396	unless ($self->{_rw} \|\| $self->{_eof}) {	1669	unless ($self->{_rw} \|\| $self->{_eof}) {
1397	Scalar::Util::weaken $self;	1670	Scalar::Util::weaken $self;
1398		1671
1399	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1672	$self->{_rw} = AE::io $self->{fh}, 0, sub {
1400	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});	1673	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1401	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;
1402		1675
1403	if ($len > 0) {	1676	if ($len > 0) {
1404	$self->{_activity} = AnyEvent->now;	1677	$self->{_activity} = $self->{_ractivity} = AE::now;
1405		1678
1406	if ($self->{tls}) {	1679	if ($self->{tls}) {
1407	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);	1680	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1408		1681
1409	&_dotls ($self);	1682	&_dotls ($self);
1410	} else {	1683	} else {
1411	$self->_drain_rbuf unless $self->{_in_drain};	1684	$self->_drain_rbuf;
1412	}	1685	}
1413		1686
1414	} elsif (defined $len) {	1687	} elsif (defined $len) {
1415	delete $self->{_rw};	1688	delete $self->{_rw};
1416	$self->{_eof} = 1;	1689	$self->{_eof} = 1;
1417	$self->_drain_rbuf unless $self->{_in_drain};	1690	$self->_drain_rbuf;
1418		1691
1419	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1692	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1420	return $self->_error ($!, 1);	1693	return $self->_error ($!, 1);
1421	}	1694	}
1422	});	1695	};
1423	}	1696	}
1424	}	1697	}
1425		1698
1426	our $ERROR_SYSCALL;	1699	our $ERROR_SYSCALL;
1427	our $ERROR_WANT_READ;	1700	our $ERROR_WANT_READ;
…		…
1435	my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());	1708	my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());
1436		1709
1437	# reduce error string to look less scary	1710	# reduce error string to look less scary
1438	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;	1711	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;
1439		1712
		1713	if ($self->{_on_starttls}) {
		1714	(delete $self->{_on_starttls})->($self, undef, $err);
		1715	&_freetls;
		1716	} else {
		1717	&_freetls;
1440	$self->_error (&Errno::EPROTO, 1, $err);	1718	$self->_error (Errno::EPROTO, 1, $err);
		1719	}
1441	}	1720	}
1442		1721
1443	# poll the write BIO and send the data if applicable	1722	# poll the write BIO and send the data if applicable
1444	# also decode read data if possible	1723	# also decode read data if possible
1445	# this is basiclaly our TLS state machine	1724	# this is basiclaly our TLS state machine
…		…
1461	&& ($tmp != $ERROR_SYSCALL \|\| $!);	1740	&& ($tmp != $ERROR_SYSCALL \|\| $!);
1462	}	1741	}
1463		1742
1464	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {	1743	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
1465	unless (length $tmp) {	1744	unless (length $tmp) {
		1745	$self->{_on_starttls}
		1746	and (delete $self->{_on_starttls})->($self, undef, "EOF during handshake"); # ???
1466	&_freetls;	1747	&_freetls;
		1748
1467	if ($self->{on_stoptls}) {	1749	if ($self->{on_stoptls}) {
1468	$self->{on_stoptls}($self);	1750	$self->{on_stoptls}($self);
1469	return;	1751	return;
1470	} else {	1752	} else {
1471	# let's treat SSL-eof as we treat normal EOF	1753	# let's treat SSL-eof as we treat normal EOF
…		…
1473	$self->{_eof} = 1;	1755	$self->{_eof} = 1;
1474	}	1756	}
1475	}	1757	}
1476		1758
1477	$self->{_tls_rbuf} .= $tmp;	1759	$self->{_tls_rbuf} .= $tmp;
1478	$self->_drain_rbuf unless $self->{_in_drain};	1760	$self->_drain_rbuf;
1479	$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
1480	}	1762	}
1481		1763
1482	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);	1764	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1483	return $self->_tls_error ($tmp)	1765	return $self->_tls_error ($tmp)
…		…
1489	$self->_drain_wbuf;	1771	$self->_drain_wbuf;
1490	}	1772	}
1491		1773
1492	$self->{_on_starttls}	1774	$self->{_on_starttls}
1493	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()	1775	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
1494	and (delete $self->{_on_starttls})->($self, 1);	1776	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");
1495	}	1777	}
1496		1778
1497	=item $handle->starttls ($tls[, $tls_ctx])	1779	=item $handle->starttls ($tls[, $tls_ctx])
1498		1780
1499	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	1781	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
1500	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
1501	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.
1502		1788
1503	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
1504	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1790	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1505		1791
1506	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
…		…
1511	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
1512	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
1513	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
1514	when this function returns.	1800	when this function returns.
1515		1801
1516	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
1517	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.
1518		1805
1519	=cut	1806	=cut
1520		1807
1521	our %TLS_CACHE; #TODO not yet documented, should we?	1808	our %TLS_CACHE; #TODO not yet documented, should we?
1522		1809
1523	sub starttls {	1810	sub starttls {
1524	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};
1525		1820
1526	require Net::SSLeay;	1821	require Net::SSLeay;
1527
1528	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"
1529	if $self->{tls};
1530		1822
1531	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();	1823	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1532	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();	1824	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1533		1825
		1826	$tls = delete $self->{tls};
1534	$ctx \|\|= $self->{tls_ctx};	1827	$ctx = $self->{tls_ctx};
		1828
		1829	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
1535		1830
1536	if ("HASH" eq ref $ctx) {	1831	if ("HASH" eq ref $ctx) {
1537	require AnyEvent::TLS;	1832	require AnyEvent::TLS;
1538
1539	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context
1540		1833
1541	if ($ctx->{cache}) {	1834	if ($ctx->{cache}) {
1542	my $key = $ctx+0;	1835	my $key = $ctx+0;
1543	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;	1836	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;
1544	} else {	1837	} else {
1545	$ctx = new AnyEvent::TLS %$ctx;	1838	$ctx = new AnyEvent::TLS %$ctx;
1546	}	1839	}
1547	}	1840	}
1548		1841
1549	$self->{tls_ctx} = $ctx \|\| TLS_CTX ();	1842	$self->{tls_ctx} = $ctx \|\| TLS_CTX ();
1550	$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});
1551		1844
1552	# 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)
1553	# but the openssl maintainers basically said: "trust us, it just works".	1846	# but the openssl maintainers basically said: "trust us, it just works".
1554	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1847	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1555	# and mismaintained ssleay-module doesn't even offer them).	1848	# and mismaintained ssleay-module doesn't even offer them).
…		…
1562	# 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
1563	# have identity issues in that area.	1856	# have identity issues in that area.
1564	# Net::SSLeay::CTX_set_mode ($ssl,	1857	# Net::SSLeay::CTX_set_mode ($ssl,
1565	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1858	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
1566	# \| (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));
1567	Net::SSLeay::CTX_set_mode ($ssl, 1\|2);	1860	Net::SSLeay::CTX_set_mode ($tls, 1\|2);
1568		1861
1569	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1862	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1570	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1863	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1571		1864
		1865	Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf});
		1866
1572	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1867	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
1573		1868
1574	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }	1869	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1575	if exists $self->{on_starttls};	1870	if $self->{on_starttls};
1576		1871
1577	&_dotls; # need to trigger the initial handshake	1872	&_dotls; # need to trigger the initial handshake
1578	$self->start_read; # make sure we actually do read	1873	$self->start_read; # make sure we actually do read
1579	}	1874	}
1580		1875
1581	=item $handle->stoptls	1876	=item $handle->stoptls
1582		1877
1583	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
1584	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
1585	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
1586	afterwards.	1881	the stream afterwards.
1587		1882
1588	=cut	1883	=cut
1589		1884
1590	sub stoptls {	1885	sub stoptls {
1591	my ($self) = @_;	1886	my ($self) = @_;
…		…
1604	sub _freetls {	1899	sub _freetls {
1605	my ($self) = @_;	1900	my ($self) = @_;
1606		1901
1607	return unless $self->{tls};	1902	return unless $self->{tls};
1608		1903
1609	$self->{_on_starttls}
1610	and (delete $self->{_on_starttls})->($self, undef);
1611
1612	$self->{tls_ctx}->_put_session (delete $self->{tls});	1904	$self->{tls_ctx}->_put_session (delete $self->{tls})
		1905	if $self->{tls} > 0;
1613		1906
1614	delete @$self{qw(_rbio _wbio _tls_wbuf)};	1907	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1615	}	1908	}
1616		1909
1617	sub DESTROY {	1910	sub DESTROY {
1618	my ($self) = @_;	1911	my ($self) = @_;
1619		1912
1620	&_freetls;	1913	&_freetls;
1621		1914
1622	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	1915	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1623		1916
1624	if ($linger && length $self->{wbuf}) {	1917	if ($linger && length $self->{wbuf} && $self->{fh}) {
1625	my $fh = delete $self->{fh};	1918	my $fh = delete $self->{fh};
1626	my $wbuf = delete $self->{wbuf};	1919	my $wbuf = delete $self->{wbuf};
1627		1920
1628	my @linger;	1921	my @linger;
1629		1922
1630	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {	1923	push @linger, AE::io $fh, 1, sub {
1631	my $len = syswrite $fh, $wbuf, length $wbuf;	1924	my $len = syswrite $fh, $wbuf, length $wbuf;
1632		1925
1633	if ($len > 0) {	1926	if ($len > 0) {
1634	substr $wbuf, 0, $len, "";	1927	substr $wbuf, 0, $len, "";
1635	} else {	1928	} else {
1636	@linger = (); # end	1929	@linger = (); # end
1637	}	1930	}
1638	});	1931	};
1639	push @linger, AnyEvent->timer (after => $linger, cb => sub {	1932	push @linger, AE::timer $linger, 0, sub {
1640	@linger = ();	1933	@linger = ();
1641	});	1934	};
1642	}	1935	}
1643	}	1936	}
1644		1937
1645	=item $handle->destroy	1938	=item $handle->destroy
1646		1939
1647	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
1648	no further callbacks will be invoked and as many resources as possible	1941	no further callbacks will be invoked and as many resources as possible
1649	will be freed. 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).
1650		1945
1651	Normally, you can just "forget" any references to an AnyEvent::Handle	1946	Normally, you can just "forget" any references to an AnyEvent::Handle
1652	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
1653	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
1654	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
1655	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
1656	that case.	1951	that case.
1657		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
1658	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
1659	data, as specified by the C<linger> option, however.	1959	data, as specified by the C<linger> option, however.
1660		1960
1661	=cut	1961	=cut
1662		1962
1663	sub destroy {	1963	sub destroy {
1664	my ($self) = @_;	1964	my ($self) = @_;
1665		1965
1666	$self->DESTROY;	1966	$self->DESTROY;
1667	%$self = ();	1967	%$self = ();
		1968	bless $self, "AnyEvent::Handle::destroyed";
		1969	}
		1970
		1971	sub AnyEvent::Handle::destroyed::AUTOLOAD {
		1972	#nop
1668	}	1973	}
1669		1974
1670	=item AnyEvent::Handle::TLS_CTX	1975	=item AnyEvent::Handle::TLS_CTX
1671		1976
1672	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
…		…
1729		2034
1730	$handle->on_read (sub { });	2035	$handle->on_read (sub { });
1731	$handle->on_eof (undef);	2036	$handle->on_eof (undef);
1732	$handle->on_error (sub {	2037	$handle->on_error (sub {
1733	my $data = delete $_[0]{rbuf};	2038	my $data = delete $_[0]{rbuf};
1734	undef $handle;
1735	});	2039	});
1736		2040
1737	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
1738	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
1739	fact, all data has been received.	2043	fact, all data has been received.
…		…
1755	$handle->on_drain (sub {	2059	$handle->on_drain (sub {
1756	warn "all data submitted to the kernel\n";	2060	warn "all data submitted to the kernel\n";
1757	undef $handle;	2061	undef $handle;
1758	});	2062	});
1759		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
1760	=back	2152	=back
1761		2153
1762		2154
1763	=head1 SUBCLASSING AnyEvent::Handle	2155	=head1 SUBCLASSING AnyEvent::Handle
1764		2156

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.142 by root, Mon Jul 6 20:24:47 2009 UTC vs. Revision 1.184 by root, Thu Sep 3 13:14:38 2009 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.142 by root, Mon Jul 6 20:24:47 2009 UTC vs.
Revision 1.184 by root, Thu Sep 3 13:14:38 2009 UTC