[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.180 by root, Thu Aug 20 22:58:35 2009 UTC

…		…
1	package AnyEvent::Handle;
2
3	no warnings;
4	use strict qw(subs vars);
5
6	use AnyEvent ();
7	use AnyEvent::Util qw(WSAEWOULDBLOCK);
8	use Scalar::Util ();
9	use Carp ();
10	use Fcntl ();
11	use Errno qw(EAGAIN EINTR);
12
13	=head1 NAME	1	=head1 NAME
14		2
15	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent	3	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent
16
17	=cut
18
19	our $VERSION = 4.452;
20		4
21	=head1 SYNOPSIS	5	=head1 SYNOPSIS
22		6
23	use AnyEvent;	7	use AnyEvent;
24	use AnyEvent::Handle;	8	use AnyEvent::Handle;
25		9
26	my $cv = AnyEvent->condvar;	10	my $cv = AnyEvent->condvar;
27		11
28	my $handle =	12	my $hdl; $hdl = new AnyEvent::Handle
29	AnyEvent::Handle->new (
30	fh => \*STDIN,	13	fh => \*STDIN,
31	on_eof => sub {	14	on_error => sub {
		15	my ($hdl, $fatal, $msg) = @_;
		16	warn "got error $msg\n";
		17	$hdl->destroy;
32	$cv->send;	18	$cv->send;
33	},
34	);	19	);
35		20
36	# send some request line	21	# send some request line
37	$handle->push_write ("getinfo\015\012");	22	$hdl->push_write ("getinfo\015\012");
38		23
39	# read the response line	24	# read the response line
40	$handle->push_read (line => sub {	25	$hdl->push_read (line => sub {
41	my ($handle, $line) = @_;	26	my ($hdl, $line) = @_;
42	warn "read line <$line>\n";	27	warn "got line <$line>\n";
43	$cv->send;	28	$cv->send;
44	});	29	});
45		30
46	$cv->recv;	31	$cv->recv;
47		32
48	=head1 DESCRIPTION	33	=head1 DESCRIPTION
49		34
50	This module is a helper module to make it easier to do event-based I/O on	35	This module is a helper module to make it easier to do event-based I/O on
51	filehandles. For utility functions for doing non-blocking connects and accepts	36	filehandles.
52	on sockets see L<AnyEvent::Util>.
53		37
54	The L<AnyEvent::Intro> tutorial contains some well-documented	38	The L<AnyEvent::Intro> tutorial contains some well-documented
55	AnyEvent::Handle examples.	39	AnyEvent::Handle examples.
56		40
57	In the following, when the documentation refers to of "bytes" then this	41	In the following, when the documentation refers to of "bytes" then this
58	means characters. As sysread and syswrite are used for all I/O, their	42	means characters. As sysread and syswrite are used for all I/O, their
59	treatment of characters applies to this module as well.	43	treatment of characters applies to this module as well.
60		44
		45	At the very minimum, you should specify C<fh> or C<connect>, and the
		46	C<on_error> callback.
		47
61	All callbacks will be invoked with the handle object as their first	48	All callbacks will be invoked with the handle object as their first
62	argument.	49	argument.
63		50
		51	=cut
		52
		53	package AnyEvent::Handle;
		54
		55	use Scalar::Util ();
		56	use List::Util ();
		57	use Carp ();
		58	use Errno qw(EAGAIN EINTR);
		59
		60	use AnyEvent (); BEGIN { AnyEvent::common_sense }
		61	use AnyEvent::Util qw(WSAEWOULDBLOCK);
		62
		63	our $VERSION = $AnyEvent::VERSION;
		64
64	=head1 METHODS	65	=head1 METHODS
65		66
66	=over 4	67	=over 4
67		68
68	=item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value...	69	=item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value...
69		70
70	The constructor supports these arguments (all as C<< key => value >> pairs).	71	The constructor supports these arguments (all as C<< key => value >> pairs).
71		72
72	=over 4	73	=over 4
73		74
74	=item fh => $filehandle [MANDATORY]	75	=item fh => $filehandle [C<fh> or C<connect> MANDATORY]
75		76
76	The filehandle this L<AnyEvent::Handle> object will operate on.	77	The filehandle this L<AnyEvent::Handle> object will operate on.
77
78	NOTE: The filehandle will be set to non-blocking mode (using	78	NOTE: The filehandle will be set to non-blocking mode (using
79	C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in	79	C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in
80	that mode.	80	that mode.
81		81
		82	=item connect => [$host, $service] [C<fh> or C<connect> MANDATORY]
		83
		84	Try to connect to the specified host and service (port), using
		85	C<AnyEvent::Socket::tcp_connect>. The C<$host> additionally becomes the
		86	default C<peername>.
		87
		88	You have to specify either this parameter, or C<fh>, above.
		89
		90	It is possible to push requests on the read and write queues, and modify
		91	properties of the stream, even while AnyEvent::Handle is connecting.
		92
		93	When this parameter is specified, then the C<on_prepare>,
		94	C<on_connect_error> and C<on_connect> callbacks will be called under the
		95	appropriate circumstances:
		96
		97	=over 4
		98
		99	=item on_prepare => $cb->($handle)
		100
		101	This (rarely used) callback is called before a new connection is
		102	attempted, but after the file handle has been created. It could be used to
		103	prepare the file handle with parameters required for the actual connect
		104	(as opposed to settings that can be changed when the connection is already
		105	established).
		106
		107	The return value of this callback should be the connect timeout value in
		108	seconds (or C<0>, or C<undef>, or the empty list, to indicate the default
		109	timeout is to be used).
		110
		111	=item on_connect => $cb->($handle, $host, $port, $retry->())
		112
		113	This callback is called when a connection has been successfully established.
		114
		115	The actual numeric host and port (the socket peername) are passed as
		116	parameters, together with a retry callback.
		117
		118	When, for some reason, the handle is not acceptable, then calling
		119	C<$retry> will continue with the next conenction target (in case of
		120	multi-homed hosts or SRV records there can be multiple connection
		121	endpoints). When it is called then the read and write queues, eof status,
		122	tls status and similar properties of the handle are being reset.
		123
		124	In most cases, ignoring the C<$retry> parameter is the way to go.
		125
		126	=item on_connect_error => $cb->($handle, $message)
		127
		128	This callback is called when the conenction could not be
		129	established. C<$!> will contain the relevant error code, and C<$message> a
		130	message describing it (usually the same as C<"$!">).
		131
		132	If this callback isn't specified, then C<on_error> will be called with a
		133	fatal error instead.
		134
		135	=back
		136
		137	=item on_error => $cb->($handle, $fatal, $message)
		138
		139	This is the error callback, which is called when, well, some error
		140	occured, such as not being able to resolve the hostname, failure to
		141	connect or a read error.
		142
		143	Some errors are fatal (which is indicated by C<$fatal> being true). On
		144	fatal errors the handle object will be destroyed (by a call to C<< ->
		145	destroy >>) after invoking the error callback (which means you are free to
		146	examine the handle object). Examples of fatal errors are an EOF condition
		147	with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors. In
		148	cases where the other side can close the connection at their will it is
		149	often easiest to not report C<EPIPE> errors in this callback.
		150
		151	AnyEvent::Handle tries to find an appropriate error code for you to check
		152	against, but in some cases (TLS errors), this does not work well. It is
		153	recommended to always output the C<$message> argument in human-readable
		154	error messages (it's usually the same as C<"$!">).
		155
		156	Non-fatal errors can be retried by simply returning, but it is recommended
		157	to simply ignore this parameter and instead abondon the handle object
		158	when this callback is invoked. Examples of non-fatal errors are timeouts
		159	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
		160
		161	On callback entrance, the value of C<$!> contains the operating system
		162	error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
		163	C<EPROTO>).
		164
		165	While not mandatory, it is I<highly> recommended to set this callback, as
		166	you will not be notified of errors otherwise. The default simply calls
		167	C<croak>.
		168
		169	=item on_read => $cb->($handle)
		170
		171	This sets the default read callback, which is called when data arrives
		172	and no read request is in the queue (unlike read queue callbacks, this
		173	callback will only be called when at least one octet of data is in the
		174	read buffer).
		175
		176	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
		177	method or access the C<< $handle->{rbuf} >> member directly. Note that you
		178	must not enlarge or modify the read buffer, you can only remove data at
		179	the beginning from it.
		180
		181	When an EOF condition is detected then AnyEvent::Handle will first try to
		182	feed all the remaining data to the queued callbacks and C<on_read> before
		183	calling the C<on_eof> callback. If no progress can be made, then a fatal
		184	error will be raised (with C<$!> set to C<EPIPE>).
		185
		186	Note that, unlike requests in the read queue, an C<on_read> callback
		187	doesn't mean you I<require> some data: if there is an EOF and there
		188	are outstanding read requests then an error will be flagged. With an
		189	C<on_read> callback, the C<on_eof> callback will be invoked.
		190
82	=item on_eof => $cb->($handle)	191	=item on_eof => $cb->($handle)
83		192
84	Set the callback to be called when an end-of-file condition is detected,	193	Set the callback to be called when an end-of-file condition is detected,
85	i.e. in the case of a socket, when the other side has closed the	194	i.e. in the case of a socket, when the other side has closed the
86	connection cleanly.	195	connection cleanly, and there are no outstanding read requests in the
		196	queue (if there are read requests, then an EOF counts as an unexpected
		197	connection close and will be flagged as an error).
87		198
88	For sockets, this just means that the other side has stopped sending data,	199	For sockets, this just means that the other side has stopped sending data,
89	you can still try to write data, and, in fact, one can return from the EOF	200	you can still try to write data, and, in fact, one can return from the EOF
90	callback and continue writing data, as only the read part has been shut	201	callback and continue writing data, as only the read part has been shut
91	down.	202	down.
92		203
93	While not mandatory, it is I<highly> recommended to set an EOF callback,
94	otherwise you might end up with a closed socket while you are still
95	waiting for data.
96
97	If an EOF condition has been detected but no C<on_eof> callback has been	204	If an EOF condition has been detected but no C<on_eof> callback has been
98	set, then a fatal error will be raised with C<$!> set to <0>.	205	set, then a fatal error will be raised with C<$!> set to <0>.
99
100	=item on_error => $cb->($handle, $fatal, $message)
101
102	This is the error callback, which is called when, well, some error
103	occured, such as not being able to resolve the hostname, failure to
104	connect or a read error.
105
106	Some errors are fatal (which is indicated by C<$fatal> being true). On
107	fatal errors the handle object will be shut down and will not be usable
108	(but you are free to look at the current C<< ->rbuf >>). Examples of fatal
109	errors are an EOF condition with active (but unsatisifable) read watchers
110	(C<EPIPE>) or I/O errors.
111
112	AnyEvent::Handle tries to find an appropriate error code for you to check
113	against, but in some cases (TLS errors), this does not work well. It is
114	recommended to always output the C<$message> argument in human-readable
115	error messages (it's usually the same as C<"$!">).
116
117	Non-fatal errors can be retried by simply returning, but it is recommended
118	to simply ignore this parameter and instead abondon the handle object
119	when this callback is invoked. Examples of non-fatal errors are timeouts
120	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
121
122	On callback entrance, the value of C<$!> contains the operating system
123	error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
124	C<EPROTO>).
125
126	While not mandatory, it is I<highly> recommended to set this callback, as
127	you will not be notified of errors otherwise. The default simply calls
128	C<croak>.
129
130	=item on_read => $cb->($handle)
131
132	This sets the default read callback, which is called when data arrives
133	and no read request is in the queue (unlike read queue callbacks, this
134	callback will only be called when at least one octet of data is in the
135	read buffer).
136
137	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
138	method or access the C<< $handle->{rbuf} >> member directly. Note that you
139	must not enlarge or modify the read buffer, you can only remove data at
140	the beginning from it.
141
142	When an EOF condition is detected then AnyEvent::Handle will first try to
143	feed all the remaining data to the queued callbacks and C<on_read> before
144	calling the C<on_eof> callback. If no progress can be made, then a fatal
145	error will be raised (with C<$!> set to C<EPIPE>).
146		206
147	=item on_drain => $cb->($handle)	207	=item on_drain => $cb->($handle)
148		208
149	This sets the callback that is called when the write buffer becomes empty	209	This sets the callback that is called when the write buffer becomes empty
150	(or when the callback is set and the buffer is empty already).	210	(or when the callback is set and the buffer is empty already).
157	memory and push it into the queue, but instead only read more data from	217	memory and push it into the queue, but instead only read more data from
158	the file when the write queue becomes empty.	218	the file when the write queue becomes empty.
159		219
160	=item timeout => $fractional_seconds	220	=item timeout => $fractional_seconds
161		221
		222	=item rtimeout => $fractional_seconds
		223
		224	=item wtimeout => $fractional_seconds
		225
162	If non-zero, then this enables an "inactivity" timeout: whenever this many	226	If non-zero, then these enables an "inactivity" timeout: whenever this
163	seconds pass without a successful read or write on the underlying file	227	many seconds pass without a successful read or write on the underlying
164	handle, the C<on_timeout> callback will be invoked (and if that one is	228	file handle (or a call to C<timeout_reset>), the C<on_timeout> callback
165	missing, a non-fatal C<ETIMEDOUT> error will be raised).	229	will be invoked (and if that one is missing, a non-fatal C<ETIMEDOUT>
		230	error will be raised).
		231
		232	There are three variants of the timeouts that work fully independent
		233	of each other, for both read and write, just read, and just write:
		234	C<timeout>, C<rtimeout> and C<wtimeout>, with corresponding callbacks
		235	C<on_timeout>, C<on_rtimeout> and C<on_wtimeout>, and reset functions
		236	C<timeout_reset>, C<rtimeout_reset>, and C<wtimeout_reset>.
166		237
167	Note that timeout processing is also active when you currently do not have	238	Note that timeout processing is also active when you currently do not have
168	any outstanding read or write requests: If you plan to keep the connection	239	any outstanding read or write requests: If you plan to keep the connection
169	idle then you should disable the timout temporarily or ignore the timeout	240	idle then you should disable the timout temporarily or ignore the timeout
170	in the C<on_timeout> callback, in which case AnyEvent::Handle will simply	241	in the C<on_timeout> callback, in which case AnyEvent::Handle will simply
…		…
249		320
250	A string used to identify the remote site - usually the DNS hostname	321	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.	322	(I<not> IDN!) used to create the connection, rarely the IP address.
252		323
253	Apart from being useful in error messages, this string is also used in TLS	324	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>).	325	peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This
		326	verification will be skipped when C<peername> is not specified or
		327	C<undef>.
255		328
256	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	329	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
257		330
258	When this parameter is given, it enables TLS (SSL) mode, that means	331	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	332	AnyEvent will start a TLS handshake as soon as the conenction has been
…		…
296		369
297	Instead of an object, you can also specify a hash reference with C<< key	370	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	371	=> value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a
299	new TLS context object.	372	new TLS context object.
300		373
301	=item on_starttls => $cb->($handle, $success)	374	=item on_starttls => $cb->($handle, $success[, $error_message])
302		375
303	This callback will be invoked when the TLS/SSL handshake has finished. If	376	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	377	C<$success> is true, then the TLS handshake succeeded, otherwise it failed
305	(C<on_stoptls> will not be called in this case).	378	(C<on_stoptls> will not be called in this case).
306		379
307	The session in C<< $handle->{tls} >> can still be examined in this	380	The session in C<< $handle->{tls} >> can still be examined in this
308	callback, even when the handshake was not successful.	381	callback, even when the handshake was not successful.
		382
		383	TLS handshake failures will not cause C<on_error> to be invoked when this
		384	callback is in effect, instead, the error message will be passed to C<on_starttls>.
		385
		386	Without this callback, handshake failures lead to C<on_error> being
		387	called, as normal.
		388
		389	Note that you cannot call C<starttls> right again in this callback. If you
		390	need to do that, start an zero-second timer instead whose callback can
		391	then call C<< ->starttls >> again.
309		392
310	=item on_stoptls => $cb->($handle)	393	=item on_stoptls => $cb->($handle)
311		394
312	When a SSLv3/TLS shutdown/close notify/EOF is detected and this callback is	395	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,	396	set, then it will be invoked after freeing the TLS session. If it is not,
…		…
337		420
338	sub new {	421	sub new {
339	my $class = shift;	422	my $class = shift;
340	my $self = bless { @_ }, $class;	423	my $self = bless { @_ }, $class;
341		424
342	$self->{fh} or Carp::croak "mandatory argument fh is missing";	425	if ($self->{fh}) {
		426	$self->_start;
		427	return unless $self->{fh}; # could be gone by now
		428
		429	} elsif ($self->{connect}) {
		430	require AnyEvent::Socket;
		431
		432	$self->{peername} = $self->{connect}[0]
		433	unless exists $self->{peername};
		434
		435	$self->{_skip_drain_rbuf} = 1;
		436
		437	{
		438	Scalar::Util::weaken (my $self = $self);
		439
		440	$self->{_connect} =
		441	AnyEvent::Socket::tcp_connect (
		442	$self->{connect}[0],
		443	$self->{connect}[1],
		444	sub {
		445	my ($fh, $host, $port, $retry) = @_;
		446
		447	if ($fh) {
		448	$self->{fh} = $fh;
		449
		450	delete $self->{_skip_drain_rbuf};
		451	$self->_start;
		452
		453	$self->{on_connect}
		454	and $self->{on_connect}($self, $host, $port, sub {
		455	delete @$self{qw(fh _tw _rtw _wtw _ww _rw _eof _queue rbuf _wbuf tls _tls_rbuf _tls_wbuf)};
		456	$self->{_skip_drain_rbuf} = 1;
		457	&$retry;
		458	});
		459
		460	} else {
		461	if ($self->{on_connect_error}) {
		462	$self->{on_connect_error}($self, "$!");
		463	$self->destroy;
		464	} else {
		465	$self->_error ($!, 1);
		466	}
		467	}
		468	},
		469	sub {
		470	local $self->{fh} = $_[0];
		471
		472	$self->{on_prepare}
		473	? $self->{on_prepare}->($self)
		474	: ()
		475	}
		476	);
		477	}
		478
		479	} else {
		480	Carp::croak "AnyEvent::Handle: either an existing fh or the connect parameter must be specified";
		481	}
		482
		483	$self
		484	}
		485
		486	sub _start {
		487	my ($self) = @_;
343		488
344	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	489	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
345		490
		491	$self->{_activity} =
		492	$self->{_ractivity} =
346	$self->{_activity} = AnyEvent->now;	493	$self->{_wactivity} = AE::now;
347	$self->_timeout;	494
		495	$self->timeout (delete $self->{timeout} ) if $self->{timeout};
		496	$self->rtimeout (delete $self->{rtimeout}) if $self->{rtimeout};
		497	$self->wtimeout (delete $self->{wtimeout}) if $self->{wtimeout};
348		498
349	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};	499	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
350		500
351	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})	501	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
352	if $self->{tls};	502	if $self->{tls};
353		503
354	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};	504	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
355		505
356	$self->start_read	506	$self->start_read
357	if $self->{on_read};	507	if $self->{on_read} \|\| @{ $self->{_queue} };
358		508
359	$self->{fh} && $self	509	$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	}	510	}
370		511
371	sub _error {	512	sub _error {
372	my ($self, $errno, $fatal, $message) = @_;	513	my ($self, $errno, $fatal, $message) = @_;
373		514
374	$self->_shutdown
375	if $fatal;
376
377	$! = $errno;	515	$! = $errno;
378	$message \|\|= "$!";	516	$message \|\|= "$!";
379		517
380	if ($self->{on_error}) {	518	if ($self->{on_error}) {
381	$self->{on_error}($self, $fatal, $message);	519	$self->{on_error}($self, $fatal, $message);
		520	$self->destroy if $fatal;
382	} elsif ($self->{fh}) {	521	} elsif ($self->{fh}) {
		522	$self->destroy;
383	Carp::croak "AnyEvent::Handle uncaught error: $message";	523	Carp::croak "AnyEvent::Handle uncaught error: $message";
384	}	524	}
385	}	525	}
386		526
387	=item $fh = $handle->fh	527	=item $fh = $handle->fh
…		…
412	$_[0]{on_eof} = $_[1];	552	$_[0]{on_eof} = $_[1];
413	}	553	}
414		554
415	=item $handle->on_timeout ($cb)	555	=item $handle->on_timeout ($cb)
416		556
417	Replace the current C<on_timeout> callback, or disables the callback (but	557	=item $handle->on_rtimeout ($cb)
418	not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
419	argument and method.
420		558
421	=cut	559	=item $handle->on_wtimeout ($cb)
422		560
423	sub on_timeout {	561	Replace the current C<on_timeout>, C<on_rtimeout> or C<on_wtimeout>
424	$_[0]{on_timeout} = $_[1];	562	callback, or disables the callback (but not the timeout) if C<$cb> =
425	}	563	C<undef>. See the C<timeout> constructor argument and method.
		564
		565	=cut
		566
		567	# see below
426		568
427	=item $handle->autocork ($boolean)	569	=item $handle->autocork ($boolean)
428		570
429	Enables or disables the current autocork behaviour (see C<autocork>	571	Enables or disables the current autocork behaviour (see C<autocork>
430	constructor argument). Changes will only take effect on the next write.	572	constructor argument). Changes will only take effect on the next write.
…		…
445	sub no_delay {	587	sub no_delay {
446	$_[0]{no_delay} = $_[1];	588	$_[0]{no_delay} = $_[1];
447		589
448	eval {	590	eval {
449	local $SIG{__DIE__};	591	local $SIG{__DIE__};
450	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];	592	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1]
		593	if $_[0]{fh};
451	};	594	};
452	}	595	}
453		596
454	=item $handle->on_starttls ($cb)	597	=item $handle->on_starttls ($cb)
455		598
…		…
469		612
470	sub on_starttls {	613	sub on_starttls {
471	$_[0]{on_stoptls} = $_[1];	614	$_[0]{on_stoptls} = $_[1];
472	}	615	}
473		616
		617	=item $handle->rbuf_max ($max_octets)
		618
		619	Configures the C<rbuf_max> setting (C<undef> disables it).
		620
		621	=cut
		622
		623	sub rbuf_max {
		624	$_[0]{rbuf_max} = $_[1];
		625	}
		626
474	#############################################################################	627	#############################################################################
475		628
476	=item $handle->timeout ($seconds)	629	=item $handle->timeout ($seconds)
477		630
		631	=item $handle->rtimeout ($seconds)
		632
		633	=item $handle->wtimeout ($seconds)
		634
478	Configures (or disables) the inactivity timeout.	635	Configures (or disables) the inactivity timeout.
479		636
480	=cut	637	=item $handle->timeout_reset
481		638
482	sub timeout {	639	=item $handle->rtimeout_reset
		640
		641	=item $handle->wtimeout_reset
		642
		643	Reset the activity timeout, as if data was received or sent.
		644
		645	These methods are cheap to call.
		646
		647	=cut
		648
		649	for my $dir ("", "r", "w") {
		650	my $timeout = "${dir}timeout";
		651	my $tw = "_${dir}tw";
		652	my $on_timeout = "on_${dir}timeout";
		653	my $activity = "_${dir}activity";
		654	my $cb;
		655
		656	*$on_timeout = sub {
		657	$_[0]{$on_timeout} = $_[1];
		658	};
		659
		660	*$timeout = sub {
483	my ($self, $timeout) = @_;	661	my ($self, $new_value) = @_;
484		662
485	$self->{timeout} = $timeout;	663	$self->{$timeout} = $new_value;
486	$self->_timeout;	664	delete $self->{$tw}; &$cb;
487	}	665	};
488		666
		667	*{"${dir}timeout_reset"} = sub {
		668	$_[0]{$activity} = AE::now;
		669	};
		670
		671	# main workhorse:
489	# reset the timeout watcher, as neccessary	672	# reset the timeout watcher, as neccessary
490	# also check for time-outs	673	# also check for time-outs
491	sub _timeout {	674	$cb = sub {
492	my ($self) = @_;	675	my ($self) = @_;
493		676
494	if ($self->{timeout}) {	677	if ($self->{$timeout} && $self->{fh}) {
495	my $NOW = AnyEvent->now;	678	my $NOW = AE::now;
496		679
497	# when would the timeout trigger?	680	# when would the timeout trigger?
498	my $after = $self->{_activity} + $self->{timeout} - $NOW;	681	my $after = $self->{$activity} + $self->{$timeout} - $NOW;
499		682
500	# now or in the past already?	683	# now or in the past already?
501	if ($after <= 0) {	684	if ($after <= 0) {
502	$self->{_activity} = $NOW;	685	$self->{$activity} = $NOW;
503		686
504	if ($self->{on_timeout}) {	687	if ($self->{$on_timeout}) {
505	$self->{on_timeout}($self);	688	$self->{$on_timeout}($self);
506	} else {	689	} else {
507	$self->_error (&Errno::ETIMEDOUT);	690	$self->_error (Errno::ETIMEDOUT);
		691	}
		692
		693	# callback could have changed timeout value, optimise
		694	return unless $self->{$timeout};
		695
		696	# calculate new after
		697	$after = $self->{$timeout};
508	}	698	}
509		699
510	# callback could have changed timeout value, optimise	700	Scalar::Util::weaken $self;
511	return unless $self->{timeout};	701	return unless $self; # ->error could have destroyed $self
512		702
513	# calculate new after	703	$self->{$tw} \|\|= AE::timer $after, 0, sub {
514	$after = $self->{timeout};	704	delete $self->{$tw};
		705	$cb->($self);
		706	};
		707	} else {
		708	delete $self->{$tw};
515	}	709	}
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	}	710	}
527	}	711	}
528		712
529	#############################################################################	713	#############################################################################
530		714
…		…
575	Scalar::Util::weaken $self;	759	Scalar::Util::weaken $self;
576		760
577	my $cb = sub {	761	my $cb = sub {
578	my $len = syswrite $self->{fh}, $self->{wbuf};	762	my $len = syswrite $self->{fh}, $self->{wbuf};
579		763
580	if ($len >= 0) {	764	if (defined $len) {
581	substr $self->{wbuf}, 0, $len, "";	765	substr $self->{wbuf}, 0, $len, "";
582		766
583	$self->{_activity} = AnyEvent->now;	767	$self->{_activity} = $self->{_wactivity} = AE::now;
584		768
585	$self->{on_drain}($self)	769	$self->{on_drain}($self)
586	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})	770	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
587	&& $self->{on_drain};	771	&& $self->{on_drain};
588		772
…		…
594		778
595	# try to write data immediately	779	# try to write data immediately
596	$cb->() unless $self->{autocork};	780	$cb->() unless $self->{autocork};
597		781
598	# if still data left in wbuf, we need to poll	782	# if still data left in wbuf, we need to poll
599	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	783	$self->{_ww} = AE::io $self->{fh}, 1, $cb
600	if length $self->{wbuf};	784	if length $self->{wbuf};
601	};	785	};
602	}	786	}
603		787
604	our %WH;	788	our %WH;
…		…
617	->($self, @_);	801	->($self, @_);
618	}	802	}
619		803
620	if ($self->{tls}) {	804	if ($self->{tls}) {
621	$self->{_tls_wbuf} .= $_[0];	805	$self->{_tls_wbuf} .= $_[0];
622		806	&_dotls ($self) if $self->{fh};
623	&_dotls ($self);
624	} else {	807	} else {
625	$self->{wbuf} .= $_[0];	808	$self->{wbuf} .= $_[0];
626	$self->_drain_wbuf;	809	$self->_drain_wbuf if $self->{fh};
627	}	810	}
628	}	811	}
629		812
630	=item $handle->push_write (type => @args)	813	=item $handle->push_write (type => @args)
631		814
…		…
695	Other languages could read single lines terminated by a newline and pass	878	Other languages could read single lines terminated by a newline and pass
696	this line into their JSON decoder of choice.	879	this line into their JSON decoder of choice.
697		880
698	=cut	881	=cut
699		882
		883	sub json_coder() {
		884	eval { require JSON::XS; JSON::XS->new->utf8 }
		885	\|\| do { require JSON; JSON->new->utf8 }
		886	}
		887
700	register_write_type json => sub {	888	register_write_type json => sub {
701	my ($self, $ref) = @_;	889	my ($self, $ref) = @_;
702		890
703	require JSON;	891	my $json = $self->{json} \|\|= json_coder;
704		892
705	$self->{json} ? $self->{json}->encode ($ref)	893	$json->encode ($ref)
706	: JSON::encode_json ($ref)
707	};	894	};
708		895
709	=item storable => $reference	896	=item storable => $reference
710		897
711	Freezes the given reference using L<Storable> and writes it to the	898	Freezes the given reference using L<Storable> and writes it to the
…		…
848	=cut	1035	=cut
849		1036
850	sub _drain_rbuf {	1037	sub _drain_rbuf {
851	my ($self) = @_;	1038	my ($self) = @_;
852		1039
		1040	# avoid recursion
		1041	return if $self->{_skip_drain_rbuf};
853	local $self->{_in_drain} = 1;	1042	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		1043
862	while () {	1044	while () {
863	# we need to use a separate tls read buffer, as we must not receive data while	1045	# 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.	1046	# we are draining the buffer, and this can only happen with TLS.
865	$self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf};	1047	$self->{rbuf} .= delete $self->{_tls_rbuf}
		1048	if exists $self->{_tls_rbuf};
866		1049
867	my $len = length $self->{rbuf};	1050	my $len = length $self->{rbuf};
868		1051
869	if (my $cb = shift @{ $self->{_queue} }) {	1052	if (my $cb = shift @{ $self->{_queue} }) {
870	unless ($cb->($self)) {	1053	unless ($cb->($self)) {
871	if ($self->{_eof}) {	1054	# no progress can be made
872	# no progress can be made (not enough data and no data forthcoming)	1055	# (not enough data and no data forthcoming)
873	$self->_error (&Errno::EPIPE, 1), return;	1056	$self->_error (Errno::EPIPE, 1), return
874	}	1057	if $self->{_eof};
875		1058
876	unshift @{ $self->{_queue} }, $cb;	1059	unshift @{ $self->{_queue} }, $cb;
877	last;	1060	last;
878	}	1061	}
879	} elsif ($self->{on_read}) {	1062	} elsif ($self->{on_read}) {
…		…
886	&& !@{ $self->{_queue} } # and the queue is still empty	1069	&& !@{ $self->{_queue} } # and the queue is still empty
887	&& $self->{on_read} # but we still have on_read	1070	&& $self->{on_read} # but we still have on_read
888	) {	1071	) {
889	# no further data will arrive	1072	# no further data will arrive
890	# so no progress can be made	1073	# so no progress can be made
891	$self->_error (&Errno::EPIPE, 1), return	1074	$self->_error (Errno::EPIPE, 1), return
892	if $self->{_eof};	1075	if $self->{_eof};
893		1076
894	last; # more data might arrive	1077	last; # more data might arrive
895	}	1078	}
896	} else {	1079	} else {
…		…
899	last;	1082	last;
900	}	1083	}
901	}	1084	}
902		1085
903	if ($self->{_eof}) {	1086	if ($self->{_eof}) {
904	if ($self->{on_eof}) {	1087	$self->{on_eof}
905	$self->{on_eof}($self)	1088	? $self->{on_eof}($self)
906	} else {
907	$self->_error (0, 1, "Unexpected end-of-file");	1089	: $self->_error (0, 1, "Unexpected end-of-file");
908	}	1090
		1091	return;
		1092	}
		1093
		1094	if (
		1095	defined $self->{rbuf_max}
		1096	&& $self->{rbuf_max} < length $self->{rbuf}
		1097	) {
		1098	$self->_error (Errno::ENOSPC, 1), return;
909	}	1099	}
910		1100
911	# may need to restart read watcher	1101	# may need to restart read watcher
912	unless ($self->{_rw}) {	1102	unless ($self->{_rw}) {
913	$self->start_read	1103	$self->start_read
…		…
925		1115
926	sub on_read {	1116	sub on_read {
927	my ($self, $cb) = @_;	1117	my ($self, $cb) = @_;
928		1118
929	$self->{on_read} = $cb;	1119	$self->{on_read} = $cb;
930	$self->_drain_rbuf if $cb && !$self->{_in_drain};	1120	$self->_drain_rbuf if $cb;
931	}	1121	}
932		1122
933	=item $handle->rbuf	1123	=item $handle->rbuf
934		1124
935	Returns the read buffer (as a modifiable lvalue).	1125	Returns the read buffer (as a modifiable lvalue).
…		…
987	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	1177	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
988	->($self, $cb, @_);	1178	->($self, $cb, @_);
989	}	1179	}
990		1180
991	push @{ $self->{_queue} }, $cb;	1181	push @{ $self->{_queue} }, $cb;
992	$self->_drain_rbuf unless $self->{_in_drain};	1182	$self->_drain_rbuf;
993	}	1183	}
994		1184
995	sub unshift_read {	1185	sub unshift_read {
996	my $self = shift;	1186	my $self = shift;
997	my $cb = pop;	1187	my $cb = pop;
…		…
1003	->($self, $cb, @_);	1193	->($self, $cb, @_);
1004	}	1194	}
1005		1195
1006		1196
1007	unshift @{ $self->{_queue} }, $cb;	1197	unshift @{ $self->{_queue} }, $cb;
1008	$self->_drain_rbuf unless $self->{_in_drain};	1198	$self->_drain_rbuf;
1009	}	1199	}
1010		1200
1011	=item $handle->push_read (type => @args, $cb)	1201	=item $handle->push_read (type => @args, $cb)
1012		1202
1013	=item $handle->unshift_read (type => @args, $cb)	1203	=item $handle->unshift_read (type => @args, $cb)
…		…
1146	return 1;	1336	return 1;
1147	}	1337	}
1148		1338
1149	# reject	1339	# reject
1150	if ($reject && $$rbuf =~ $reject) {	1340	if ($reject && $$rbuf =~ $reject) {
1151	$self->_error (&Errno::EBADMSG);	1341	$self->_error (Errno::EBADMSG);
1152	}	1342	}
1153		1343
1154	# skip	1344	# skip
1155	if ($skip && $$rbuf =~ $skip) {	1345	if ($skip && $$rbuf =~ $skip) {
1156	$data .= substr $$rbuf, 0, $+[0], "";	1346	$data .= substr $$rbuf, 0, $+[0], "";
…		…
1172	my ($self, $cb) = @_;	1362	my ($self, $cb) = @_;
1173		1363
1174	sub {	1364	sub {
1175	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {	1365	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
1176	if ($_[0]{rbuf} =~ /[^0-9]/) {	1366	if ($_[0]{rbuf} =~ /[^0-9]/) {
1177	$self->_error (&Errno::EBADMSG);	1367	$self->_error (Errno::EBADMSG);
1178	}	1368	}
1179	return;	1369	return;
1180	}	1370	}
1181		1371
1182	my $len = $1;	1372	my $len = $1;
…		…
1185	my $string = $_[1];	1375	my $string = $_[1];
1186	$_[0]->unshift_read (chunk => 1, sub {	1376	$_[0]->unshift_read (chunk => 1, sub {
1187	if ($_[1] eq ",") {	1377	if ($_[1] eq ",") {
1188	$cb->($_[0], $string);	1378	$cb->($_[0], $string);
1189	} else {	1379	} else {
1190	$self->_error (&Errno::EBADMSG);	1380	$self->_error (Errno::EBADMSG);
1191	}	1381	}
1192	});	1382	});
1193	});	1383	});
1194		1384
1195	1	1385	1
…		…
1262	=cut	1452	=cut
1263		1453
1264	register_read_type json => sub {	1454	register_read_type json => sub {
1265	my ($self, $cb) = @_;	1455	my ($self, $cb) = @_;
1266		1456
1267	my $json = $self->{json} \|\|=	1457	my $json = $self->{json} \|\|= json_coder;
1268	eval { require JSON::XS; JSON::XS->new->utf8 }
1269	\|\| do { require JSON; JSON->new->utf8 };
1270		1458
1271	my $data;	1459	my $data;
1272	my $rbuf = \$self->{rbuf};	1460	my $rbuf = \$self->{rbuf};
1273		1461
1274	sub {	1462	sub {
…		…
1285	$json->incr_skip;	1473	$json->incr_skip;
1286		1474
1287	$self->{rbuf} = $json->incr_text;	1475	$self->{rbuf} = $json->incr_text;
1288	$json->incr_text = "";	1476	$json->incr_text = "";
1289		1477
1290	$self->_error (&Errno::EBADMSG);	1478	$self->_error (Errno::EBADMSG);
1291		1479
1292	()	1480	()
1293	} else {	1481	} else {
1294	$self->{rbuf} = "";	1482	$self->{rbuf} = "";
1295		1483
…		…
1332	# read remaining chunk	1520	# read remaining chunk
1333	$_[0]->unshift_read (chunk => $len, sub {	1521	$_[0]->unshift_read (chunk => $len, sub {
1334	if (my $ref = eval { Storable::thaw ($_[1]) }) {	1522	if (my $ref = eval { Storable::thaw ($_[1]) }) {
1335	$cb->($_[0], $ref);	1523	$cb->($_[0], $ref);
1336	} else {	1524	} else {
1337	$self->_error (&Errno::EBADMSG);	1525	$self->_error (Errno::EBADMSG);
1338	}	1526	}
1339	});	1527	});
1340	}	1528	}
1341		1529
1342	1	1530	1
…		…
1394	my ($self) = @_;	1582	my ($self) = @_;
1395		1583
1396	unless ($self->{_rw} \|\| $self->{_eof}) {	1584	unless ($self->{_rw} \|\| $self->{_eof}) {
1397	Scalar::Util::weaken $self;	1585	Scalar::Util::weaken $self;
1398		1586
1399	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1587	$self->{_rw} = AE::io $self->{fh}, 0, sub {
1400	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});	1588	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1401	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;	1589	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;
1402		1590
1403	if ($len > 0) {	1591	if ($len > 0) {
1404	$self->{_activity} = AnyEvent->now;	1592	$self->{_activity} = $self->{_ractivity} = AE::now;
1405		1593
1406	if ($self->{tls}) {	1594	if ($self->{tls}) {
1407	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);	1595	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1408		1596
1409	&_dotls ($self);	1597	&_dotls ($self);
1410	} else {	1598	} else {
1411	$self->_drain_rbuf unless $self->{_in_drain};	1599	$self->_drain_rbuf;
1412	}	1600	}
1413		1601
1414	} elsif (defined $len) {	1602	} elsif (defined $len) {
1415	delete $self->{_rw};	1603	delete $self->{_rw};
1416	$self->{_eof} = 1;	1604	$self->{_eof} = 1;
1417	$self->_drain_rbuf unless $self->{_in_drain};	1605	$self->_drain_rbuf;
1418		1606
1419	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1607	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1420	return $self->_error ($!, 1);	1608	return $self->_error ($!, 1);
1421	}	1609	}
1422	});	1610	};
1423	}	1611	}
1424	}	1612	}
1425		1613
1426	our $ERROR_SYSCALL;	1614	our $ERROR_SYSCALL;
1427	our $ERROR_WANT_READ;	1615	our $ERROR_WANT_READ;
…		…
1435	my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());	1623	my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());
1436		1624
1437	# reduce error string to look less scary	1625	# reduce error string to look less scary
1438	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;	1626	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;
1439		1627
		1628	if ($self->{_on_starttls}) {
		1629	(delete $self->{_on_starttls})->($self, undef, $err);
		1630	&_freetls;
		1631	} else {
		1632	&_freetls;
1440	$self->_error (&Errno::EPROTO, 1, $err);	1633	$self->_error (Errno::EPROTO, 1, $err);
		1634	}
1441	}	1635	}
1442		1636
1443	# poll the write BIO and send the data if applicable	1637	# poll the write BIO and send the data if applicable
1444	# also decode read data if possible	1638	# also decode read data if possible
1445	# this is basiclaly our TLS state machine	1639	# this is basiclaly our TLS state machine
…		…
1461	&& ($tmp != $ERROR_SYSCALL \|\| $!);	1655	&& ($tmp != $ERROR_SYSCALL \|\| $!);
1462	}	1656	}
1463		1657
1464	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {	1658	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
1465	unless (length $tmp) {	1659	unless (length $tmp) {
		1660	$self->{_on_starttls}
		1661	and (delete $self->{_on_starttls})->($self, undef, "EOF during handshake"); # ???
1466	&_freetls;	1662	&_freetls;
		1663
1467	if ($self->{on_stoptls}) {	1664	if ($self->{on_stoptls}) {
1468	$self->{on_stoptls}($self);	1665	$self->{on_stoptls}($self);
1469	return;	1666	return;
1470	} else {	1667	} else {
1471	# let's treat SSL-eof as we treat normal EOF	1668	# let's treat SSL-eof as we treat normal EOF
…		…
1473	$self->{_eof} = 1;	1670	$self->{_eof} = 1;
1474	}	1671	}
1475	}	1672	}
1476		1673
1477	$self->{_tls_rbuf} .= $tmp;	1674	$self->{_tls_rbuf} .= $tmp;
1478	$self->_drain_rbuf unless $self->{_in_drain};	1675	$self->_drain_rbuf;
1479	$self->{tls} or return; # tls session might have gone away in callback	1676	$self->{tls} or return; # tls session might have gone away in callback
1480	}	1677	}
1481		1678
1482	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);	1679	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1483	return $self->_tls_error ($tmp)	1680	return $self->_tls_error ($tmp)
…		…
1489	$self->_drain_wbuf;	1686	$self->_drain_wbuf;
1490	}	1687	}
1491		1688
1492	$self->{_on_starttls}	1689	$self->{_on_starttls}
1493	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()	1690	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
1494	and (delete $self->{_on_starttls})->($self, 1);	1691	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");
1495	}	1692	}
1496		1693
1497	=item $handle->starttls ($tls[, $tls_ctx])	1694	=item $handle->starttls ($tls[, $tls_ctx])
1498		1695
1499	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	1696	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	1697	object is created, you can also do that at a later time by calling
1501	C<starttls>.	1698	C<starttls>.
		1699
		1700	Starting TLS is currently an asynchronous operation - when you push some
		1701	write data and then call C<< ->starttls >> then TLS negotiation will start
		1702	immediately, after which the queued write data is then sent.
1502		1703
1503	The first argument is the same as the C<tls> constructor argument (either	1704	The first argument is the same as the C<tls> constructor argument (either
1504	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1705	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1505		1706
1506	The second argument is the optional C<AnyEvent::TLS> object that is used	1707	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	1712	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	1713	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	1714	changed to your liking. Note that the handshake might have already started
1514	when this function returns.	1715	when this function returns.
1515		1716
1516	If it an error to start a TLS handshake more than once per	1717	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).	1718	handshakes on the same stream. Best do not attempt to use the stream after
		1719	stopping TLS.
1518		1720
1519	=cut	1721	=cut
1520		1722
1521	our %TLS_CACHE; #TODO not yet documented, should we?	1723	our %TLS_CACHE; #TODO not yet documented, should we?
1522		1724
1523	sub starttls {	1725	sub starttls {
1524	my ($self, $ssl, $ctx) = @_;	1726	my ($self, $tls, $ctx) = @_;
		1727
		1728	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"
		1729	if $self->{tls};
		1730
		1731	$self->{tls} = $tls;
		1732	$self->{tls_ctx} = $ctx if @_ > 2;
		1733
		1734	return unless $self->{fh};
1525		1735
1526	require Net::SSLeay;	1736	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		1737
1531	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();	1738	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1532	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();	1739	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1533		1740
		1741	$tls = delete $self->{tls};
1534	$ctx \|\|= $self->{tls_ctx};	1742	$ctx = $self->{tls_ctx};
		1743
		1744	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
1535		1745
1536	if ("HASH" eq ref $ctx) {	1746	if ("HASH" eq ref $ctx) {
1537	require AnyEvent::TLS;	1747	require AnyEvent::TLS;
1538
1539	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context
1540		1748
1541	if ($ctx->{cache}) {	1749	if ($ctx->{cache}) {
1542	my $key = $ctx+0;	1750	my $key = $ctx+0;
1543	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;	1751	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;
1544	} else {	1752	} else {
1545	$ctx = new AnyEvent::TLS %$ctx;	1753	$ctx = new AnyEvent::TLS %$ctx;
1546	}	1754	}
1547	}	1755	}
1548		1756
1549	$self->{tls_ctx} = $ctx \|\| TLS_CTX ();	1757	$self->{tls_ctx} = $ctx \|\| TLS_CTX ();
1550	$self->{tls} = $ssl = $self->{tls_ctx}->_get_session ($ssl, $self, $self->{peername});	1758	$self->{tls} = $tls = $self->{tls_ctx}->_get_session ($tls, $self, $self->{peername});
1551		1759
1552	# basically, this is deep magic (because SSL_read should have the same issues)	1760	# 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".	1761	# but the openssl maintainers basically said: "trust us, it just works".
1554	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1762	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1555	# and mismaintained ssleay-module doesn't even offer them).	1763	# 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	1770	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
1563	# have identity issues in that area.	1771	# have identity issues in that area.
1564	# Net::SSLeay::CTX_set_mode ($ssl,	1772	# Net::SSLeay::CTX_set_mode ($ssl,
1565	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1773	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
1566	# \| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));	1774	# \| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
1567	Net::SSLeay::CTX_set_mode ($ssl, 1\|2);	1775	Net::SSLeay::CTX_set_mode ($tls, 1\|2);
1568		1776
1569	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1777	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1570	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1778	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1571		1779
		1780	Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf});
		1781
1572	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1782	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
1573		1783
1574	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }	1784	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1575	if exists $self->{on_starttls};	1785	if $self->{on_starttls};
1576		1786
1577	&_dotls; # need to trigger the initial handshake	1787	&_dotls; # need to trigger the initial handshake
1578	$self->start_read; # make sure we actually do read	1788	$self->start_read; # make sure we actually do read
1579	}	1789	}
1580		1790
1581	=item $handle->stoptls	1791	=item $handle->stoptls
1582		1792
1583	Shuts down the SSL connection - this makes a proper EOF handshake by	1793	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	1794	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	1795	support non-blocking shut downs, it is not guarenteed that you can re-use
1586	afterwards.	1796	the stream afterwards.
1587		1797
1588	=cut	1798	=cut
1589		1799
1590	sub stoptls {	1800	sub stoptls {
1591	my ($self) = @_;	1801	my ($self) = @_;
…		…
1604	sub _freetls {	1814	sub _freetls {
1605	my ($self) = @_;	1815	my ($self) = @_;
1606		1816
1607	return unless $self->{tls};	1817	return unless $self->{tls};
1608		1818
1609	$self->{_on_starttls}
1610	and (delete $self->{_on_starttls})->($self, undef);
1611
1612	$self->{tls_ctx}->_put_session (delete $self->{tls});	1819	$self->{tls_ctx}->_put_session (delete $self->{tls})
		1820	if $self->{tls} > 0;
1613		1821
1614	delete @$self{qw(_rbio _wbio _tls_wbuf)};	1822	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1615	}	1823	}
1616		1824
1617	sub DESTROY {	1825	sub DESTROY {
1618	my ($self) = @_;	1826	my ($self) = @_;
1619		1827
1620	&_freetls;	1828	&_freetls;
1621		1829
1622	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	1830	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1623		1831
1624	if ($linger && length $self->{wbuf}) {	1832	if ($linger && length $self->{wbuf} && $self->{fh}) {
1625	my $fh = delete $self->{fh};	1833	my $fh = delete $self->{fh};
1626	my $wbuf = delete $self->{wbuf};	1834	my $wbuf = delete $self->{wbuf};
1627		1835
1628	my @linger;	1836	my @linger;
1629		1837
1630	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {	1838	push @linger, AE::io $fh, 1, sub {
1631	my $len = syswrite $fh, $wbuf, length $wbuf;	1839	my $len = syswrite $fh, $wbuf, length $wbuf;
1632		1840
1633	if ($len > 0) {	1841	if ($len > 0) {
1634	substr $wbuf, 0, $len, "";	1842	substr $wbuf, 0, $len, "";
1635	} else {	1843	} else {
1636	@linger = (); # end	1844	@linger = (); # end
1637	}	1845	}
1638	});	1846	};
1639	push @linger, AnyEvent->timer (after => $linger, cb => sub {	1847	push @linger, AE::timer $linger, 0, sub {
1640	@linger = ();	1848	@linger = ();
1641	});	1849	};
1642	}	1850	}
1643	}	1851	}
1644		1852
1645	=item $handle->destroy	1853	=item $handle->destroy
1646		1854
1647	Shuts down the handle object as much as possible - this call ensures that	1855	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	1856	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.	1857	will be freed. Any method you will call on the handle object after
		1858	destroying it in this way will be silently ignored (and it will return the
		1859	empty list).
1650		1860
1651	Normally, you can just "forget" any references to an AnyEvent::Handle	1861	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	1862	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	1863	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	1864	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	1865	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
1656	that case.	1866	that case.
1657		1867
		1868	Destroying the handle object in this way has the advantage that callbacks
		1869	will be removed as well, so if those are the only reference holders (as
		1870	is common), then one doesn't need to do anything special to break any
		1871	reference cycles.
		1872
1658	The handle might still linger in the background and write out remaining	1873	The handle might still linger in the background and write out remaining
1659	data, as specified by the C<linger> option, however.	1874	data, as specified by the C<linger> option, however.
1660		1875
1661	=cut	1876	=cut
1662		1877
1663	sub destroy {	1878	sub destroy {
1664	my ($self) = @_;	1879	my ($self) = @_;
1665		1880
1666	$self->DESTROY;	1881	$self->DESTROY;
1667	%$self = ();	1882	%$self = ();
		1883	bless $self, "AnyEvent::Handle::destroyed";
		1884	}
		1885
		1886	sub AnyEvent::Handle::destroyed::AUTOLOAD {
		1887	#nop
1668	}	1888	}
1669		1889
1670	=item AnyEvent::Handle::TLS_CTX	1890	=item AnyEvent::Handle::TLS_CTX
1671		1891
1672	This function creates and returns the AnyEvent::TLS object used by default	1892	This function creates and returns the AnyEvent::TLS object used by default
…		…
1729		1949
1730	$handle->on_read (sub { });	1950	$handle->on_read (sub { });
1731	$handle->on_eof (undef);	1951	$handle->on_eof (undef);
1732	$handle->on_error (sub {	1952	$handle->on_error (sub {
1733	my $data = delete $_[0]{rbuf};	1953	my $data = delete $_[0]{rbuf};
1734	undef $handle;
1735	});	1954	});
1736		1955
1737	The reason to use C<on_error> is that TCP connections, due to latencies	1956	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	1957	and packets loss, might get closed quite violently with an error, when in
1739	fact, all data has been received.	1958	fact, all data has been received.
…		…
1755	$handle->on_drain (sub {	1974	$handle->on_drain (sub {
1756	warn "all data submitted to the kernel\n";	1975	warn "all data submitted to the kernel\n";
1757	undef $handle;	1976	undef $handle;
1758	});	1977	});
1759		1978
		1979	If you just want to queue some data and then signal EOF to the other side,
		1980	consider using C<< ->push_shutdown >> instead.
		1981
		1982	=item I want to contact a TLS/SSL server, I don't care about security.
		1983
		1984	If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS,
		1985	simply connect to it and then create the AnyEvent::Handle with the C<tls>
		1986	parameter:
		1987
		1988	tcp_connect $host, $port, sub {
		1989	my ($fh) = @_;
		1990
		1991	my $handle = new AnyEvent::Handle
		1992	fh => $fh,
		1993	tls => "connect",
		1994	on_error => sub { ... };
		1995
		1996	$handle->push_write (...);
		1997	};
		1998
		1999	=item I want to contact a TLS/SSL server, I do care about security.
		2000
		2001	Then you should additionally enable certificate verification, including
		2002	peername verification, if the protocol you use supports it (see
		2003	L<AnyEvent::TLS>, C<verify_peername>).
		2004
		2005	E.g. for HTTPS:
		2006
		2007	tcp_connect $host, $port, sub {
		2008	my ($fh) = @_;
		2009
		2010	my $handle = new AnyEvent::Handle
		2011	fh => $fh,
		2012	peername => $host,
		2013	tls => "connect",
		2014	tls_ctx => { verify => 1, verify_peername => "https" },
		2015	...
		2016
		2017	Note that you must specify the hostname you connected to (or whatever
		2018	"peername" the protocol needs) as the C<peername> argument, otherwise no
		2019	peername verification will be done.
		2020
		2021	The above will use the system-dependent default set of trusted CA
		2022	certificates. If you want to check against a specific CA, add the
		2023	C<ca_file> (or C<ca_cert>) arguments to C<tls_ctx>:
		2024
		2025	tls_ctx => {
		2026	verify => 1,
		2027	verify_peername => "https",
		2028	ca_file => "my-ca-cert.pem",
		2029	},
		2030
		2031	=item I want to create a TLS/SSL server, how do I do that?
		2032
		2033	Well, you first need to get a server certificate and key. You have
		2034	three options: a) ask a CA (buy one, use cacert.org etc.) b) create a
		2035	self-signed certificate (cheap. check the search engine of your choice,
		2036	there are many tutorials on the net) or c) make your own CA (tinyca2 is a
		2037	nice program for that purpose).
		2038
		2039	Then create a file with your private key (in PEM format, see
		2040	L<AnyEvent::TLS>), followed by the certificate (also in PEM format). The
		2041	file should then look like this:
		2042
		2043	-----BEGIN RSA PRIVATE KEY-----
		2044	...header data
		2045	... lots of base64'y-stuff
		2046	-----END RSA PRIVATE KEY-----
		2047
		2048	-----BEGIN CERTIFICATE-----
		2049	... lots of base64'y-stuff
		2050	-----END CERTIFICATE-----
		2051
		2052	The important bits are the "PRIVATE KEY" and "CERTIFICATE" parts. Then
		2053	specify this file as C<cert_file>:
		2054
		2055	tcp_server undef, $port, sub {
		2056	my ($fh) = @_;
		2057
		2058	my $handle = new AnyEvent::Handle
		2059	fh => $fh,
		2060	tls => "accept",
		2061	tls_ctx => { cert_file => "my-server-keycert.pem" },
		2062	...
		2063
		2064	When you have intermediate CA certificates that your clients might not
		2065	know about, just append them to the C<cert_file>.
		2066
1760	=back	2067	=back
1761		2068
1762		2069
1763	=head1 SUBCLASSING AnyEvent::Handle	2070	=head1 SUBCLASSING AnyEvent::Handle
1764		2071

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.180 by root, Thu Aug 20 22:58:35 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.180 by root, Thu Aug 20 22:58:35 2009 UTC