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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.131 by root, Tue Jun 30 22:42:33 2009 UTC vs.
Revision 1.178 by root, Tue Aug 11 01:15:17 2009 UTC

…		…
1	package AnyEvent::Handle;
2
3	no warnings;
4	use strict qw(subs vars);
5
6	use AnyEvent ();
7	use AnyEvent::Util qw(WSAEWOULDBLOCK);
8	use Scalar::Util ();
9	use Carp ();
10	use Fcntl ();
11	use Errno qw(EAGAIN EINTR);
12
13	=head1 NAME	1	=head1 NAME
14		2
15	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent	3	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent
16
17	=cut
18
19	our $VERSION = 4.45;
20		4
21	=head1 SYNOPSIS	5	=head1 SYNOPSIS
22		6
23	use AnyEvent;	7	use AnyEvent;
24	use AnyEvent::Handle;	8	use AnyEvent::Handle;
25		9
26	my $cv = AnyEvent->condvar;	10	my $cv = AnyEvent->condvar;
27		11
28	my $handle =	12	my $hdl; $hdl = new AnyEvent::Handle
29	AnyEvent::Handle->new (
30	fh => \*STDIN,	13	fh => \*STDIN,
31	on_eof => sub {	14	on_error => sub {
		15	my ($hdl, $fatal, $msg) = @_;
		16	warn "got error $msg\n";
		17	$hdl->destroy;
32	$cv->send;	18	$cv->send;
33	},
34	);	19	);
35		20
36	# send some request line	21	# send some request line
37	$handle->push_write ("getinfo\015\012");	22	$hdl->push_write ("getinfo\015\012");
38		23
39	# read the response line	24	# read the response line
40	$handle->push_read (line => sub {	25	$hdl->push_read (line => sub {
41	my ($handle, $line) = @_;	26	my ($hdl, $line) = @_;
42	warn "read line <$line>\n";	27	warn "got line <$line>\n";
43	$cv->send;	28	$cv->send;
44	});	29	});
45		30
46	$cv->recv;	31	$cv->recv;
47		32
48	=head1 DESCRIPTION	33	=head1 DESCRIPTION
49		34
50	This module is a helper module to make it easier to do event-based I/O on	35	This module is a helper module to make it easier to do event-based I/O on
51	filehandles. For utility functions for doing non-blocking connects and accepts	36	filehandles.
52	on sockets see L<AnyEvent::Util>.
53		37
54	The L<AnyEvent::Intro> tutorial contains some well-documented	38	The L<AnyEvent::Intro> tutorial contains some well-documented
55	AnyEvent::Handle examples.	39	AnyEvent::Handle examples.
56		40
57	In the following, when the documentation refers to of "bytes" then this	41	In the following, when the documentation refers to of "bytes" then this
58	means characters. As sysread and syswrite are used for all I/O, their	42	means characters. As sysread and syswrite are used for all I/O, their
59	treatment of characters applies to this module as well.	43	treatment of characters applies to this module as well.
60		44
		45	At the very minimum, you should specify C<fh> or C<connect>, and the
		46	C<on_error> callback.
		47
61	All callbacks will be invoked with the handle object as their first	48	All callbacks will be invoked with the handle object as their first
62	argument.	49	argument.
63		50
		51	=cut
		52
		53	package AnyEvent::Handle;
		54
		55	use Scalar::Util ();
		56	use List::Util ();
		57	use Carp ();
		58	use Errno qw(EAGAIN EINTR);
		59
		60	use AnyEvent (); BEGIN { AnyEvent::common_sense }
		61	use AnyEvent::Util qw(WSAEWOULDBLOCK);
		62
		63	our $VERSION = $AnyEvent::VERSION;
		64
64	=head1 METHODS	65	=head1 METHODS
65		66
66	=over 4	67	=over 4
67		68
68	=item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value...	69	=item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value...
69		70
70	The constructor supports these arguments (all as C<< key => value >> pairs).	71	The constructor supports these arguments (all as C<< key => value >> pairs).
71		72
72	=over 4	73	=over 4
73		74
74	=item fh => $filehandle [MANDATORY]	75	=item fh => $filehandle [C<fh> or C<connect> MANDATORY]
75		76
76	The filehandle this L<AnyEvent::Handle> object will operate on.	77	The filehandle this L<AnyEvent::Handle> object will operate on.
77
78	NOTE: The filehandle will be set to non-blocking mode (using	78	NOTE: The filehandle will be set to non-blocking mode (using
79	C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in	79	C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in
80	that mode.	80	that mode.
81		81
		82	=item connect => [$host, $service] [C<fh> or C<connect> MANDATORY]
		83
		84	Try to connect to the specified host and service (port), using
		85	C<AnyEvent::Socket::tcp_connect>. The C<$host> additionally becomes the
		86	default C<peername>.
		87
		88	You have to specify either this parameter, or C<fh>, above.
		89
		90	It is possible to push requests on the read and write queues, and modify
		91	properties of the stream, even while AnyEvent::Handle is connecting.
		92
		93	When this parameter is specified, then the C<on_prepare>,
		94	C<on_connect_error> and C<on_connect> callbacks will be called under the
		95	appropriate circumstances:
		96
		97	=over 4
		98
		99	=item on_prepare => $cb->($handle)
		100
		101	This (rarely used) callback is called before a new connection is
		102	attempted, but after the file handle has been created. It could be used to
		103	prepare the file handle with parameters required for the actual connect
		104	(as opposed to settings that can be changed when the connection is already
		105	established).
		106
		107	The return value of this callback should be the connect timeout value in
		108	seconds (or C<0>, or C<undef>, or the empty list, to indicate the default
		109	timeout is to be used).
		110
		111	=item on_connect => $cb->($handle, $host, $port, $retry->())
		112
		113	This callback is called when a connection has been successfully established.
		114
		115	The actual numeric host and port (the socket peername) are passed as
		116	parameters, together with a retry callback.
		117
		118	When, for some reason, the handle is not acceptable, then calling
		119	C<$retry> will continue with the next conenction target (in case of
		120	multi-homed hosts or SRV records there can be multiple connection
		121	endpoints). When it is called then the read and write queues, eof status,
		122	tls status and similar properties of the handle are being reset.
		123
		124	In most cases, ignoring the C<$retry> parameter is the way to go.
		125
		126	=item on_connect_error => $cb->($handle, $message)
		127
		128	This callback is called when the conenction could not be
		129	established. C<$!> will contain the relevant error code, and C<$message> a
		130	message describing it (usually the same as C<"$!">).
		131
		132	If this callback isn't specified, then C<on_error> will be called with a
		133	fatal error instead.
		134
		135	=back
		136
		137	=item on_error => $cb->($handle, $fatal, $message)
		138
		139	This is the error callback, which is called when, well, some error
		140	occured, such as not being able to resolve the hostname, failure to
		141	connect or a read error.
		142
		143	Some errors are fatal (which is indicated by C<$fatal> being true). On
		144	fatal errors the handle object will be destroyed (by a call to C<< ->
		145	destroy >>) after invoking the error callback (which means you are free to
		146	examine the handle object). Examples of fatal errors are an EOF condition
		147	with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors. In
		148	cases where the other side can close the connection at their will it is
		149	often easiest to not report C<EPIPE> errors in this callback.
		150
		151	AnyEvent::Handle tries to find an appropriate error code for you to check
		152	against, but in some cases (TLS errors), this does not work well. It is
		153	recommended to always output the C<$message> argument in human-readable
		154	error messages (it's usually the same as C<"$!">).
		155
		156	Non-fatal errors can be retried by simply returning, but it is recommended
		157	to simply ignore this parameter and instead abondon the handle object
		158	when this callback is invoked. Examples of non-fatal errors are timeouts
		159	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
		160
		161	On callback entrance, the value of C<$!> contains the operating system
		162	error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
		163	C<EPROTO>).
		164
		165	While not mandatory, it is I<highly> recommended to set this callback, as
		166	you will not be notified of errors otherwise. The default simply calls
		167	C<croak>.
		168
		169	=item on_read => $cb->($handle)
		170
		171	This sets the default read callback, which is called when data arrives
		172	and no read request is in the queue (unlike read queue callbacks, this
		173	callback will only be called when at least one octet of data is in the
		174	read buffer).
		175
		176	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
		177	method or access the C<< $handle->{rbuf} >> member directly. Note that you
		178	must not enlarge or modify the read buffer, you can only remove data at
		179	the beginning from it.
		180
		181	When an EOF condition is detected then AnyEvent::Handle will first try to
		182	feed all the remaining data to the queued callbacks and C<on_read> before
		183	calling the C<on_eof> callback. If no progress can be made, then a fatal
		184	error will be raised (with C<$!> set to C<EPIPE>).
		185
		186	Note that, unlike requests in the read queue, an C<on_read> callback
		187	doesn't mean you I<require> some data: if there is an EOF and there
		188	are outstanding read requests then an error will be flagged. With an
		189	C<on_read> callback, the C<on_eof> callback will be invoked.
		190
82	=item on_eof => $cb->($handle)	191	=item on_eof => $cb->($handle)
83		192
84	Set the callback to be called when an end-of-file condition is detected,	193	Set the callback to be called when an end-of-file condition is detected,
85	i.e. in the case of a socket, when the other side has closed the	194	i.e. in the case of a socket, when the other side has closed the
86	connection cleanly.	195	connection cleanly, and there are no outstanding read requests in the
		196	queue (if there are read requests, then an EOF counts as an unexpected
		197	connection close and will be flagged as an error).
87		198
88	For sockets, this just means that the other side has stopped sending data,	199	For sockets, this just means that the other side has stopped sending data,
89	you can still try to write data, and, in fact, one can return from the EOF	200	you can still try to write data, and, in fact, one can return from the EOF
90	callback and continue writing data, as only the read part has been shut	201	callback and continue writing data, as only the read part has been shut
91	down.	202	down.
92		203
93	While not mandatory, it is I<highly> recommended to set an EOF callback,
94	otherwise you might end up with a closed socket while you are still
95	waiting for data.
96
97	If an EOF condition has been detected but no C<on_eof> callback has been	204	If an EOF condition has been detected but no C<on_eof> callback has been
98	set, then a fatal error will be raised with C<$!> set to <0>.	205	set, then a fatal error will be raised with C<$!> set to <0>.
99
100	=item on_error => $cb->($handle, $fatal)
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	Non-fatal errors can be retried by simply returning, but it is recommended
113	to simply ignore this parameter and instead abondon the handle object
114	when this callback is invoked. Examples of non-fatal errors are timeouts
115	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
116
117	On callback entrance, the value of C<$!> contains the operating system
118	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).
119
120	While not mandatory, it is I<highly> recommended to set this callback, as
121	you will not be notified of errors otherwise. The default simply calls
122	C<croak>.
123
124	=item on_read => $cb->($handle)
125
126	This sets the default read callback, which is called when data arrives
127	and no read request is in the queue (unlike read queue callbacks, this
128	callback will only be called when at least one octet of data is in the
129	read buffer).
130
131	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
132	method or access the C<$handle->{rbuf}> member directly. Note that you
133	must not enlarge or modify the read buffer, you can only remove data at
134	the beginning from it.
135
136	When an EOF condition is detected then AnyEvent::Handle will first try to
137	feed all the remaining data to the queued callbacks and C<on_read> before
138	calling the C<on_eof> callback. If no progress can be made, then a fatal
139	error will be raised (with C<$!> set to C<EPIPE>).
140		206
141	=item on_drain => $cb->($handle)	207	=item on_drain => $cb->($handle)
142		208
143	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
144	(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).
151	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
152	the file when the write queue becomes empty.	218	the file when the write queue becomes empty.
153		219
154	=item timeout => $fractional_seconds	220	=item timeout => $fractional_seconds
155		221
		222	=item rtimeout => $fractional_seconds
		223
		224	=item wtimeout => $fractional_seconds
		225
156	If non-zero, then this enables an "inactivity" timeout: whenever this many	226	If non-zero, then these enables an "inactivity" timeout: whenever this
157	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
158	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
159	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>.
160		237
161	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
162	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
163	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
164	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
…		…
237		314
238	This will not work for partial TLS data that could not be encoded	315	This will not work for partial TLS data that could not be encoded
239	yet. This data will be lost. Calling the C<stoptls> method in time might	316	yet. This data will be lost. Calling the C<stoptls> method in time might
240	help.	317	help.
241		318
242	=item common_name => $string	319	=item peername => $string
243		320
244	The common name used by some verification methods (most notably SSL/TLS)	321	A string used to identify the remote site - usually the DNS hostname
245	associated with this connection. Usually this is the remote hostname used	322	(I<not> IDN!) used to create the connection, rarely the IP address.
246	to connect, but can be almost anything.	323
		324	Apart from being useful in error messages, this string is also used in 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>.
247		328
248	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	329	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
249		330
250	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
251	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
252	established and will transparently encrypt/decrypt data afterwards.	333	established and will transparently encrypt/decrypt data afterwards.
		334
		335	All TLS protocol errors will be signalled as C<EPROTO>, with an
		336	appropriate error message.
253		337
254	TLS mode requires Net::SSLeay to be installed (it will be loaded	338	TLS mode requires Net::SSLeay to be installed (it will be loaded
255	automatically when you try to create a TLS handle): this module doesn't	339	automatically when you try to create a TLS handle): this module doesn't
256	have a dependency on that module, so if your module requires it, you have	340	have a dependency on that module, so if your module requires it, you have
257	to add the dependency yourself.	341	to add the dependency yourself.
…		…
285		369
286	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
287	=> 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
288	new TLS context object.	372	new TLS context object.
289		373
		374	=item on_starttls => $cb->($handle, $success[, $error_message])
		375
		376	This callback will be invoked when the TLS/SSL handshake has finished. If
		377	C<$success> is true, then the TLS handshake succeeded, otherwise it failed
		378	(C<on_stoptls> will not be called in this case).
		379
		380	The session in C<< $handle->{tls} >> can still be examined in this
		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.
		392
		393	=item on_stoptls => $cb->($handle)
		394
		395	When a SSLv3/TLS shutdown/close notify/EOF is detected and this callback is
		396	set, then it will be invoked after freeing the TLS session. If it is not,
		397	then a TLS shutdown condition will be treated like a normal EOF condition
		398	on the handle.
		399
		400	The session in C<< $handle->{tls} >> can still be examined in this
		401	callback.
		402
		403	This callback will only be called on TLS shutdowns, not when the
		404	underlying handle signals EOF.
		405
290	=item json => JSON or JSON::XS object	406	=item json => JSON or JSON::XS object
291		407
292	This is the json coder object used by the C<json> read and write types.	408	This is the json coder object used by the C<json> read and write types.
293		409
294	If you don't supply it, then AnyEvent::Handle will create and use a	410	If you don't supply it, then AnyEvent::Handle will create and use a
…		…
304		420
305	sub new {	421	sub new {
306	my $class = shift;	422	my $class = shift;
307	my $self = bless { @_ }, $class;	423	my $self = bless { @_ }, $class;
308		424
309	$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) = @_;
310		488
311	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	489	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
312		490
		491	$self->{_activity} =
		492	$self->{_ractivity} =
313	$self->{_activity} = AnyEvent->now;	493	$self->{_wactivity} = AE::now;
314	$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};
315		498
316	$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};
317		500
318	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})	501	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
319	if $self->{tls};	502	if $self->{tls};
320		503
321	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};	504	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
322		505
323	$self->start_read	506	$self->start_read
324	if $self->{on_read};	507	if $self->{on_read} \|\| @{ $self->{_queue} };
325		508
326	$self->{fh} && $self	509	$self->_drain_wbuf;
327	}
328
329	sub _shutdown {
330	my ($self) = @_;
331
332	delete @$self{qw(_tw _rw _ww fh rbuf wbuf on_read _queue)};
333	$self->{_eof} = 1; # tell starttls et. al to stop trying
334
335	&_freetls;
336	}	510	}
337		511
338	sub _error {	512	sub _error {
339	my ($self, $errno, $fatal) = @_;	513	my ($self, $errno, $fatal, $message) = @_;
340
341	$self->_shutdown
342	if $fatal;
343		514
344	$! = $errno;	515	$! = $errno;
		516	$message \|\|= "$!";
345		517
346	if ($self->{on_error}) {	518	if ($self->{on_error}) {
347	$self->{on_error}($self, $fatal);	519	$self->{on_error}($self, $fatal, $message);
		520	$self->destroy if $fatal;
348	} elsif ($self->{fh}) {	521	} elsif ($self->{fh}) {
		522	$self->destroy;
349	Carp::croak "AnyEvent::Handle uncaught error: $!";	523	Carp::croak "AnyEvent::Handle uncaught error: $message";
350	}	524	}
351	}	525	}
352		526
353	=item $fh = $handle->fh	527	=item $fh = $handle->fh
354		528
…		…
378	$_[0]{on_eof} = $_[1];	552	$_[0]{on_eof} = $_[1];
379	}	553	}
380		554
381	=item $handle->on_timeout ($cb)	555	=item $handle->on_timeout ($cb)
382		556
383	Replace the current C<on_timeout> callback, or disables the callback (but	557	=item $handle->on_rtimeout ($cb)
384	not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
385	argument and method.
386		558
387	=cut	559	=item $handle->on_wtimeout ($cb)
388		560
389	sub on_timeout {	561	Replace the current C<on_timeout>, C<on_rtimeout> or C<on_wtimeout>
390	$_[0]{on_timeout} = $_[1];	562	callback, or disables the callback (but not the timeout) if C<$cb> =
391	}	563	C<undef>. See the C<timeout> constructor argument and method.
		564
		565	=cut
		566
		567	# see below
392		568
393	=item $handle->autocork ($boolean)	569	=item $handle->autocork ($boolean)
394		570
395	Enables or disables the current autocork behaviour (see C<autocork>	571	Enables or disables the current autocork behaviour (see C<autocork>
396	constructor argument). Changes will only take effect on the next write.	572	constructor argument). Changes will only take effect on the next write.
…		…
411	sub no_delay {	587	sub no_delay {
412	$_[0]{no_delay} = $_[1];	588	$_[0]{no_delay} = $_[1];
413		589
414	eval {	590	eval {
415	local $SIG{__DIE__};	591	local $SIG{__DIE__};
416	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};
417	};	594	};
418	}	595	}
419		596
		597	=item $handle->on_starttls ($cb)
		598
		599	Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument).
		600
		601	=cut
		602
		603	sub on_starttls {
		604	$_[0]{on_starttls} = $_[1];
		605	}
		606
		607	=item $handle->on_stoptls ($cb)
		608
		609	Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).
		610
		611	=cut
		612
		613	sub on_starttls {
		614	$_[0]{on_stoptls} = $_[1];
		615	}
		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
420	#############################################################################	627	#############################################################################
421		628
422	=item $handle->timeout ($seconds)	629	=item $handle->timeout ($seconds)
423		630
		631	=item $handle->rtimeout ($seconds)
		632
		633	=item $handle->wtimeout ($seconds)
		634
424	Configures (or disables) the inactivity timeout.	635	Configures (or disables) the inactivity timeout.
425		636
426	=cut	637	=item $handle->timeout_reset
427		638
428	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 {
429	my ($self, $timeout) = @_;	661	my ($self, $new_value) = @_;
430		662
431	$self->{timeout} = $timeout;	663	$self->{$timeout} = $new_value;
432	$self->_timeout;	664	delete $self->{$tw}; &$cb;
433	}	665	};
434		666
		667	*{"${dir}timeout_reset"} = sub {
		668	$_[0]{$activity} = AE::now;
		669	};
		670
		671	# main workhorse:
435	# reset the timeout watcher, as neccessary	672	# reset the timeout watcher, as neccessary
436	# also check for time-outs	673	# also check for time-outs
437	sub _timeout {	674	$cb = sub {
438	my ($self) = @_;	675	my ($self) = @_;
439		676
440	if ($self->{timeout}) {	677	if ($self->{$timeout} && $self->{fh}) {
441	my $NOW = AnyEvent->now;	678	my $NOW = AE::now;
442		679
443	# when would the timeout trigger?	680	# when would the timeout trigger?
444	my $after = $self->{_activity} + $self->{timeout} - $NOW;	681	my $after = $self->{$activity} + $self->{$timeout} - $NOW;
445		682
446	# now or in the past already?	683	# now or in the past already?
447	if ($after <= 0) {	684	if ($after <= 0) {
448	$self->{_activity} = $NOW;	685	$self->{$activity} = $NOW;
449		686
450	if ($self->{on_timeout}) {	687	if ($self->{$on_timeout}) {
451	$self->{on_timeout}($self);	688	$self->{$on_timeout}($self);
452	} else {	689	} else {
453	$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};
454	}	698	}
455		699
456	# callback could have changed timeout value, optimise	700	Scalar::Util::weaken $self;
457	return unless $self->{timeout};	701	return unless $self; # ->error could have destroyed $self
458		702
459	# calculate new after	703	$self->{$tw} \|\|= AE::timer $after, 0, sub {
460	$after = $self->{timeout};	704	delete $self->{$tw};
		705	$cb->($self);
		706	};
		707	} else {
		708	delete $self->{$tw};
461	}	709	}
462
463	Scalar::Util::weaken $self;
464	return unless $self; # ->error could have destroyed $self
465
466	$self->{_tw} \|\|= AnyEvent->timer (after => $after, cb => sub {
467	delete $self->{_tw};
468	$self->_timeout;
469	});
470	} else {
471	delete $self->{_tw};
472	}	710	}
473	}	711	}
474		712
475	#############################################################################	713	#############################################################################
476		714
…		…
521	Scalar::Util::weaken $self;	759	Scalar::Util::weaken $self;
522		760
523	my $cb = sub {	761	my $cb = sub {
524	my $len = syswrite $self->{fh}, $self->{wbuf};	762	my $len = syswrite $self->{fh}, $self->{wbuf};
525		763
526	if ($len >= 0) {	764	if (defined $len) {
527	substr $self->{wbuf}, 0, $len, "";	765	substr $self->{wbuf}, 0, $len, "";
528		766
529	$self->{_activity} = AnyEvent->now;	767	$self->{_activity} = $self->{_wactivity} = AE::now;
530		768
531	$self->{on_drain}($self)	769	$self->{on_drain}($self)
532	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})
533	&& $self->{on_drain};	771	&& $self->{on_drain};
534		772
…		…
540		778
541	# try to write data immediately	779	# try to write data immediately
542	$cb->() unless $self->{autocork};	780	$cb->() unless $self->{autocork};
543		781
544	# if still data left in wbuf, we need to poll	782	# if still data left in wbuf, we need to poll
545	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	783	$self->{_ww} = AE::io $self->{fh}, 1, $cb
546	if length $self->{wbuf};	784	if length $self->{wbuf};
547	};	785	};
548	}	786	}
549		787
550	our %WH;	788	our %WH;
…		…
563	->($self, @_);	801	->($self, @_);
564	}	802	}
565		803
566	if ($self->{tls}) {	804	if ($self->{tls}) {
567	$self->{_tls_wbuf} .= $_[0];	805	$self->{_tls_wbuf} .= $_[0];
568		806	&_dotls ($self) if $self->{fh};
569	&_dotls ($self);
570	} else {	807	} else {
571	$self->{wbuf} .= $_[0];	808	$self->{wbuf} .= $_[0];
572	$self->_drain_wbuf;	809	$self->_drain_wbuf if $self->{fh};
573	}	810	}
574	}	811	}
575		812
576	=item $handle->push_write (type => @args)	813	=item $handle->push_write (type => @args)
577		814
…		…
666		903
667	pack "w/a*", Storable::nfreeze ($ref)	904	pack "w/a*", Storable::nfreeze ($ref)
668	};	905	};
669		906
670	=back	907	=back
		908
		909	=item $handle->push_shutdown
		910
		911	Sometimes you know you want to close the socket after writing your data
		912	before it was actually written. One way to do that is to replace your
		913	C<on_drain> handler by a callback that shuts down the socket (and set
		914	C<low_water_mark> to C<0>). This method is a shorthand for just that, and
		915	replaces the C<on_drain> callback with:
		916
		917	sub { shutdown $_[0]{fh}, 1 } # for push_shutdown
		918
		919	This simply shuts down the write side and signals an EOF condition to the
		920	the peer.
		921
		922	You can rely on the normal read queue and C<on_eof> handling
		923	afterwards. This is the cleanest way to close a connection.
		924
		925	=cut
		926
		927	sub push_shutdown {
		928	my ($self) = @_;
		929
		930	delete $self->{low_water_mark};
		931	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });
		932	}
671		933
672	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	934	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
673		935
674	This function (not method) lets you add your own types to C<push_write>.	936	This function (not method) lets you add your own types to C<push_write>.
675	Whenever the given C<type> is used, C<push_write> will invoke the code	937	Whenever the given C<type> is used, C<push_write> will invoke the code
…		…
769	=cut	1031	=cut
770		1032
771	sub _drain_rbuf {	1033	sub _drain_rbuf {
772	my ($self) = @_;	1034	my ($self) = @_;
773		1035
		1036	# avoid recursion
		1037	return if $self->{_skip_drain_rbuf};
774	local $self->{_in_drain} = 1;	1038	local $self->{_skip_drain_rbuf} = 1;
775
776	if (
777	defined $self->{rbuf_max}
778	&& $self->{rbuf_max} < length $self->{rbuf}
779	) {
780	$self->_error (&Errno::ENOSPC, 1), return;
781	}
782		1039
783	while () {	1040	while () {
784	# we need to use a separate tls read buffer, as we must not receive data while	1041	# we need to use a separate tls read buffer, as we must not receive data while
785	# we are draining the buffer, and this can only happen with TLS.	1042	# we are draining the buffer, and this can only happen with TLS.
786	$self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf};	1043	$self->{rbuf} .= delete $self->{_tls_rbuf}
		1044	if exists $self->{_tls_rbuf};
787		1045
788	my $len = length $self->{rbuf};	1046	my $len = length $self->{rbuf};
789		1047
790	if (my $cb = shift @{ $self->{_queue} }) {	1048	if (my $cb = shift @{ $self->{_queue} }) {
791	unless ($cb->($self)) {	1049	unless ($cb->($self)) {
792	if ($self->{_eof}) {	1050	# no progress can be made
793	# no progress can be made (not enough data and no data forthcoming)	1051	# (not enough data and no data forthcoming)
794	$self->_error (&Errno::EPIPE, 1), return;	1052	$self->_error (Errno::EPIPE, 1), return
795	}	1053	if $self->{_eof};
796		1054
797	unshift @{ $self->{_queue} }, $cb;	1055	unshift @{ $self->{_queue} }, $cb;
798	last;	1056	last;
799	}	1057	}
800	} elsif ($self->{on_read}) {	1058	} elsif ($self->{on_read}) {
…		…
807	&& !@{ $self->{_queue} } # and the queue is still empty	1065	&& !@{ $self->{_queue} } # and the queue is still empty
808	&& $self->{on_read} # but we still have on_read	1066	&& $self->{on_read} # but we still have on_read
809	) {	1067	) {
810	# no further data will arrive	1068	# no further data will arrive
811	# so no progress can be made	1069	# so no progress can be made
812	$self->_error (&Errno::EPIPE, 1), return	1070	$self->_error (Errno::EPIPE, 1), return
813	if $self->{_eof};	1071	if $self->{_eof};
814		1072
815	last; # more data might arrive	1073	last; # more data might arrive
816	}	1074	}
817	} else {	1075	} else {
…		…
820	last;	1078	last;
821	}	1079	}
822	}	1080	}
823		1081
824	if ($self->{_eof}) {	1082	if ($self->{_eof}) {
825	if ($self->{on_eof}) {	1083	$self->{on_eof}
826	$self->{on_eof}($self)	1084	? $self->{on_eof}($self)
827	} else {	1085	: $self->_error (0, 1, "Unexpected end-of-file");
828	$self->_error (0, 1);	1086
829	}	1087	return;
		1088	}
		1089
		1090	if (
		1091	defined $self->{rbuf_max}
		1092	&& $self->{rbuf_max} < length $self->{rbuf}
		1093	) {
		1094	$self->_error (Errno::ENOSPC, 1), return;
830	}	1095	}
831		1096
832	# may need to restart read watcher	1097	# may need to restart read watcher
833	unless ($self->{_rw}) {	1098	unless ($self->{_rw}) {
834	$self->start_read	1099	$self->start_read
…		…
846		1111
847	sub on_read {	1112	sub on_read {
848	my ($self, $cb) = @_;	1113	my ($self, $cb) = @_;
849		1114
850	$self->{on_read} = $cb;	1115	$self->{on_read} = $cb;
851	$self->_drain_rbuf if $cb && !$self->{_in_drain};	1116	$self->_drain_rbuf if $cb;
852	}	1117	}
853		1118
854	=item $handle->rbuf	1119	=item $handle->rbuf
855		1120
856	Returns the read buffer (as a modifiable lvalue).	1121	Returns the read buffer (as a modifiable lvalue).
…		…
908	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	1173	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
909	->($self, $cb, @_);	1174	->($self, $cb, @_);
910	}	1175	}
911		1176
912	push @{ $self->{_queue} }, $cb;	1177	push @{ $self->{_queue} }, $cb;
913	$self->_drain_rbuf unless $self->{_in_drain};	1178	$self->_drain_rbuf;
914	}	1179	}
915		1180
916	sub unshift_read {	1181	sub unshift_read {
917	my $self = shift;	1182	my $self = shift;
918	my $cb = pop;	1183	my $cb = pop;
…		…
924	->($self, $cb, @_);	1189	->($self, $cb, @_);
925	}	1190	}
926		1191
927		1192
928	unshift @{ $self->{_queue} }, $cb;	1193	unshift @{ $self->{_queue} }, $cb;
929	$self->_drain_rbuf unless $self->{_in_drain};	1194	$self->_drain_rbuf;
930	}	1195	}
931		1196
932	=item $handle->push_read (type => @args, $cb)	1197	=item $handle->push_read (type => @args, $cb)
933		1198
934	=item $handle->unshift_read (type => @args, $cb)	1199	=item $handle->unshift_read (type => @args, $cb)
…		…
1067	return 1;	1332	return 1;
1068	}	1333	}
1069		1334
1070	# reject	1335	# reject
1071	if ($reject && $$rbuf =~ $reject) {	1336	if ($reject && $$rbuf =~ $reject) {
1072	$self->_error (&Errno::EBADMSG);	1337	$self->_error (Errno::EBADMSG);
1073	}	1338	}
1074		1339
1075	# skip	1340	# skip
1076	if ($skip && $$rbuf =~ $skip) {	1341	if ($skip && $$rbuf =~ $skip) {
1077	$data .= substr $$rbuf, 0, $+[0], "";	1342	$data .= substr $$rbuf, 0, $+[0], "";
…		…
1093	my ($self, $cb) = @_;	1358	my ($self, $cb) = @_;
1094		1359
1095	sub {	1360	sub {
1096	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {	1361	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
1097	if ($_[0]{rbuf} =~ /[^0-9]/) {	1362	if ($_[0]{rbuf} =~ /[^0-9]/) {
1098	$self->_error (&Errno::EBADMSG);	1363	$self->_error (Errno::EBADMSG);
1099	}	1364	}
1100	return;	1365	return;
1101	}	1366	}
1102		1367
1103	my $len = $1;	1368	my $len = $1;
…		…
1106	my $string = $_[1];	1371	my $string = $_[1];
1107	$_[0]->unshift_read (chunk => 1, sub {	1372	$_[0]->unshift_read (chunk => 1, sub {
1108	if ($_[1] eq ",") {	1373	if ($_[1] eq ",") {
1109	$cb->($_[0], $string);	1374	$cb->($_[0], $string);
1110	} else {	1375	} else {
1111	$self->_error (&Errno::EBADMSG);	1376	$self->_error (Errno::EBADMSG);
1112	}	1377	}
1113	});	1378	});
1114	});	1379	});
1115		1380
1116	1	1381	1
…		…
1183	=cut	1448	=cut
1184		1449
1185	register_read_type json => sub {	1450	register_read_type json => sub {
1186	my ($self, $cb) = @_;	1451	my ($self, $cb) = @_;
1187		1452
1188	require JSON;	1453	my $json = $self->{json} \|\|=
		1454	eval { require JSON::XS; JSON::XS->new->utf8 }
		1455	\|\| do { require JSON; JSON->new->utf8 };
1189		1456
1190	my $data;	1457	my $data;
1191	my $rbuf = \$self->{rbuf};	1458	my $rbuf = \$self->{rbuf};
1192
1193	my $json = $self->{json} \|\|= JSON->new->utf8;
1194		1459
1195	sub {	1460	sub {
1196	my $ref = eval { $json->incr_parse ($self->{rbuf}) };	1461	my $ref = eval { $json->incr_parse ($self->{rbuf}) };
1197		1462
1198	if ($ref) {	1463	if ($ref) {
…		…
1206	$json->incr_skip;	1471	$json->incr_skip;
1207		1472
1208	$self->{rbuf} = $json->incr_text;	1473	$self->{rbuf} = $json->incr_text;
1209	$json->incr_text = "";	1474	$json->incr_text = "";
1210		1475
1211	$self->_error (&Errno::EBADMSG);	1476	$self->_error (Errno::EBADMSG);
1212		1477
1213	()	1478	()
1214	} else {	1479	} else {
1215	$self->{rbuf} = "";	1480	$self->{rbuf} = "";
1216		1481
…		…
1253	# read remaining chunk	1518	# read remaining chunk
1254	$_[0]->unshift_read (chunk => $len, sub {	1519	$_[0]->unshift_read (chunk => $len, sub {
1255	if (my $ref = eval { Storable::thaw ($_[1]) }) {	1520	if (my $ref = eval { Storable::thaw ($_[1]) }) {
1256	$cb->($_[0], $ref);	1521	$cb->($_[0], $ref);
1257	} else {	1522	} else {
1258	$self->_error (&Errno::EBADMSG);	1523	$self->_error (Errno::EBADMSG);
1259	}	1524	}
1260	});	1525	});
1261	}	1526	}
1262		1527
1263	1	1528	1
…		…
1315	my ($self) = @_;	1580	my ($self) = @_;
1316		1581
1317	unless ($self->{_rw} \|\| $self->{_eof}) {	1582	unless ($self->{_rw} \|\| $self->{_eof}) {
1318	Scalar::Util::weaken $self;	1583	Scalar::Util::weaken $self;
1319		1584
1320	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1585	$self->{_rw} = AE::io $self->{fh}, 0, sub {
1321	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});	1586	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1322	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;	1587	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;
1323		1588
1324	if ($len > 0) {	1589	if ($len > 0) {
1325	$self->{_activity} = AnyEvent->now;	1590	$self->{_activity} = $self->{_ractivity} = AE::now;
1326		1591
1327	if ($self->{tls}) {	1592	if ($self->{tls}) {
1328	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);	1593	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1329		1594
1330	&_dotls ($self);	1595	&_dotls ($self);
1331	} else {	1596	} else {
1332	$self->_drain_rbuf unless $self->{_in_drain};	1597	$self->_drain_rbuf;
1333	}	1598	}
1334		1599
1335	} elsif (defined $len) {	1600	} elsif (defined $len) {
1336	delete $self->{_rw};	1601	delete $self->{_rw};
1337	$self->{_eof} = 1;	1602	$self->{_eof} = 1;
1338	$self->_drain_rbuf unless $self->{_in_drain};	1603	$self->_drain_rbuf;
1339		1604
1340	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1605	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1341	return $self->_error ($!, 1);	1606	return $self->_error ($!, 1);
1342	}	1607	}
1343	});	1608	};
		1609	}
		1610	}
		1611
		1612	our $ERROR_SYSCALL;
		1613	our $ERROR_WANT_READ;
		1614
		1615	sub _tls_error {
		1616	my ($self, $err) = @_;
		1617
		1618	return $self->_error ($!, 1)
		1619	if $err == Net::SSLeay::ERROR_SYSCALL ();
		1620
		1621	my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());
		1622
		1623	# reduce error string to look less scary
		1624	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;
		1625
		1626	if ($self->{_on_starttls}) {
		1627	(delete $self->{_on_starttls})->($self, undef, $err);
		1628	&_freetls;
		1629	} else {
		1630	&_freetls;
		1631	$self->_error (Errno::EPROTO, 1, $err);
1344	}	1632	}
1345	}	1633	}
1346		1634
1347	# poll the write BIO and send the data if applicable	1635	# poll the write BIO and send the data if applicable
		1636	# also decode read data if possible
		1637	# this is basiclaly our TLS state machine
		1638	# more efficient implementations are possible with openssl,
		1639	# but not with the buggy and incomplete Net::SSLeay.
1348	sub _dotls {	1640	sub _dotls {
1349	my ($self) = @_;	1641	my ($self) = @_;
1350		1642
1351	my $tmp;	1643	my $tmp;
1352		1644
1353	if (length $self->{_tls_wbuf}) {	1645	if (length $self->{_tls_wbuf}) {
1354	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1646	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1355	substr $self->{_tls_wbuf}, 0, $tmp, "";	1647	substr $self->{_tls_wbuf}, 0, $tmp, "";
1356	}	1648	}
		1649
		1650	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);
		1651	return $self->_tls_error ($tmp)
		1652	if $tmp != $ERROR_WANT_READ
		1653	&& ($tmp != $ERROR_SYSCALL \|\| $!);
1357	}	1654	}
1358		1655
1359	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {	1656	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
1360	unless (length $tmp) {	1657	unless (length $tmp) {
1361	# let's treat SSL-eof as we treat normal EOF	1658	$self->{_on_starttls}
1362	delete $self->{_rw};	1659	and (delete $self->{_on_starttls})->($self, undef, "EOF during handshake"); # ???
1363	$self->{_eof} = 1;
1364	&_freetls;	1660	&_freetls;
		1661
		1662	if ($self->{on_stoptls}) {
		1663	$self->{on_stoptls}($self);
		1664	return;
		1665	} else {
		1666	# let's treat SSL-eof as we treat normal EOF
		1667	delete $self->{_rw};
		1668	$self->{_eof} = 1;
		1669	}
1365	}	1670	}
1366		1671
1367	$self->{_tls_rbuf} .= $tmp;	1672	$self->{_tls_rbuf} .= $tmp;
1368	$self->_drain_rbuf unless $self->{_in_drain};	1673	$self->_drain_rbuf;
1369	$self->{tls} or return; # tls session might have gone away in callback	1674	$self->{tls} or return; # tls session might have gone away in callback
1370	}	1675	}
1371		1676
1372	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);	1677	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1373
1374	if ($tmp != Net::SSLeay::ERROR_WANT_READ ()) {
1375	if ($tmp == Net::SSLeay::ERROR_SYSCALL ()) {
1376	return $self->_error ($!, 1);	1678	return $self->_tls_error ($tmp)
1377	} elsif ($tmp == Net::SSLeay::ERROR_SSL ()) {	1679	if $tmp != $ERROR_WANT_READ
1378	return $self->_error (&Errno::EIO, 1);	1680	&& ($tmp != $ERROR_SYSCALL \|\| $!);
1379	}
1380
1381	# all other errors are fine for our purposes
1382	}
1383		1681
1384	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1682	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1385	$self->{wbuf} .= $tmp;	1683	$self->{wbuf} .= $tmp;
1386	$self->_drain_wbuf;	1684	$self->_drain_wbuf;
1387	}	1685	}
		1686
		1687	$self->{_on_starttls}
		1688	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
		1689	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");
1388	}	1690	}
1389		1691
1390	=item $handle->starttls ($tls[, $tls_ctx])	1692	=item $handle->starttls ($tls[, $tls_ctx])
1391		1693
1392	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	1694	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
1393	object is created, you can also do that at a later time by calling	1695	object is created, you can also do that at a later time by calling
1394	C<starttls>.	1696	C<starttls>.
		1697
		1698	Starting TLS is currently an asynchronous operation - when you push some
		1699	write data and then call C<< ->starttls >> then TLS negotiation will start
		1700	immediately, after which the queued write data is then sent.
1395		1701
1396	The first argument is the same as the C<tls> constructor argument (either	1702	The first argument is the same as the C<tls> constructor argument (either
1397	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1703	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1398		1704
1399	The second argument is the optional C<AnyEvent::TLS> object that is used	1705	The second argument is the optional C<AnyEvent::TLS> object that is used
…		…
1404	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS	1710	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS
1405	context in C<< $handle->{tls_ctx} >> after this call and can be used or	1711	context in C<< $handle->{tls_ctx} >> after this call and can be used or
1406	changed to your liking. Note that the handshake might have already started	1712	changed to your liking. Note that the handshake might have already started
1407	when this function returns.	1713	when this function returns.
1408		1714
1409	If it an error to start a TLS handshake more than once per	1715	Due to bugs in OpenSSL, it might or might not be possible to do multiple
1410	AnyEvent::Handle object (this is due to bugs in OpenSSL).	1716	handshakes on the same stream. Best do not attempt to use the stream after
		1717	stopping TLS.
1411		1718
1412	=cut	1719	=cut
		1720
		1721	our %TLS_CACHE; #TODO not yet documented, should we?
1413		1722
1414	sub starttls {	1723	sub starttls {
1415	my ($self, $ssl, $ctx) = @_;	1724	my ($self, $tls, $ctx) = @_;
		1725
		1726	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"
		1727	if $self->{tls};
		1728
		1729	$self->{tls} = $tls;
		1730	$self->{tls_ctx} = $ctx if @_ > 2;
		1731
		1732	return unless $self->{fh};
1416		1733
1417	require Net::SSLeay;	1734	require Net::SSLeay;
1418		1735
1419	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"	1736	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
		1737	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
		1738
1420	if $self->{tls};	1739	$tls = $self->{tls};
1421
1422	$ctx \|\|= $self->{tls_ctx};	1740	$ctx = $self->{tls_ctx};
		1741
		1742	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
1423		1743
1424	if ("HASH" eq ref $ctx) {	1744	if ("HASH" eq ref $ctx) {
1425	require AnyEvent::TLS;	1745	require AnyEvent::TLS;
1426		1746
1427	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context	1747	if ($ctx->{cache}) {
		1748	my $key = $ctx+0;
		1749	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;
		1750	} else {
1428	$ctx = new AnyEvent::TLS %$ctx;	1751	$ctx = new AnyEvent::TLS %$ctx;
		1752	}
1429	}	1753	}
1430		1754
1431	$self->{tls_ctx} = $ctx \|\| TLS_CTX ();	1755	$self->{tls_ctx} = $ctx \|\| TLS_CTX ();
1432	$self->{tls} = $ssl = $self->{tls_ctx}->_get_session ($ssl, $self);	1756	$self->{tls} = $tls = $self->{tls_ctx}->_get_session ($tls, $self, $self->{peername});
1433		1757
1434	# basically, this is deep magic (because SSL_read should have the same issues)	1758	# basically, this is deep magic (because SSL_read should have the same issues)
1435	# but the openssl maintainers basically said: "trust us, it just works".	1759	# but the openssl maintainers basically said: "trust us, it just works".
1436	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1760	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1437	# and mismaintained ssleay-module doesn't even offer them).	1761	# and mismaintained ssleay-module doesn't even offer them).
…		…
1444	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to	1768	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
1445	# have identity issues in that area.	1769	# have identity issues in that area.
1446	# Net::SSLeay::CTX_set_mode ($ssl,	1770	# Net::SSLeay::CTX_set_mode ($ssl,
1447	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1771	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
1448	# \| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));	1772	# \| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
1449	Net::SSLeay::CTX_set_mode ($ssl, 1\|2);	1773	Net::SSLeay::CTX_set_mode ($tls, 1\|2);
1450		1774
1451	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1775	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1452	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1776	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1453		1777
		1778	Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf});
		1779
1454	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1780	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
		1781
		1782	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
		1783	if $self->{on_starttls};
1455		1784
1456	&_dotls; # need to trigger the initial handshake	1785	&_dotls; # need to trigger the initial handshake
1457	$self->start_read; # make sure we actually do read	1786	$self->start_read; # make sure we actually do read
1458	}	1787	}
1459		1788
1460	=item $handle->stoptls	1789	=item $handle->stoptls
1461		1790
1462	Shuts down the SSL connection - this makes a proper EOF handshake by	1791	Shuts down the SSL connection - this makes a proper EOF handshake by
1463	sending a close notify to the other side, but since OpenSSL doesn't	1792	sending a close notify to the other side, but since OpenSSL doesn't
1464	support non-blocking shut downs, it is not possible to re-use the stream	1793	support non-blocking shut downs, it is not guarenteed that you can re-use
1465	afterwards.	1794	the stream afterwards.
1466		1795
1467	=cut	1796	=cut
1468		1797
1469	sub stoptls {	1798	sub stoptls {
1470	my ($self) = @_;	1799	my ($self) = @_;
…		…
1472	if ($self->{tls}) {	1801	if ($self->{tls}) {
1473	Net::SSLeay::shutdown ($self->{tls});	1802	Net::SSLeay::shutdown ($self->{tls});
1474		1803
1475	&_dotls;	1804	&_dotls;
1476		1805
1477	# we don't give a shit. no, we do, but we can't. no...	1806	# # we don't give a shit. no, we do, but we can't. no...#d#
1478	# we, we... have to use openssl :/	1807	# # we, we... have to use openssl :/#d#
1479	&_freetls;	1808	# &_freetls;#d#
1480	}	1809	}
1481	}	1810	}
1482		1811
1483	sub _freetls {	1812	sub _freetls {
1484	my ($self) = @_;	1813	my ($self) = @_;
1485		1814
1486	return unless $self->{tls};	1815	return unless $self->{tls};
1487		1816
1488	$self->{tls_ctx}->_put_session (delete $self->{tls});	1817	$self->{tls_ctx}->_put_session (delete $self->{tls})
		1818	if $self->{tls} > 0;
1489		1819
1490	delete @$self{qw(_rbio _wbio _tls_wbuf)};	1820	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1491	}	1821	}
1492		1822
1493	sub DESTROY {	1823	sub DESTROY {
1494	my ($self) = @_;	1824	my ($self) = @_;
1495		1825
1496	&_freetls;	1826	&_freetls;
1497		1827
1498	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	1828	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1499		1829
1500	if ($linger && length $self->{wbuf}) {	1830	if ($linger && length $self->{wbuf} && $self->{fh}) {
1501	my $fh = delete $self->{fh};	1831	my $fh = delete $self->{fh};
1502	my $wbuf = delete $self->{wbuf};	1832	my $wbuf = delete $self->{wbuf};
1503		1833
1504	my @linger;	1834	my @linger;
1505		1835
1506	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {	1836	push @linger, AE::io $fh, 1, sub {
1507	my $len = syswrite $fh, $wbuf, length $wbuf;	1837	my $len = syswrite $fh, $wbuf, length $wbuf;
1508		1838
1509	if ($len > 0) {	1839	if ($len > 0) {
1510	substr $wbuf, 0, $len, "";	1840	substr $wbuf, 0, $len, "";
1511	} else {	1841	} else {
1512	@linger = (); # end	1842	@linger = (); # end
1513	}	1843	}
1514	});	1844	};
1515	push @linger, AnyEvent->timer (after => $linger, cb => sub {	1845	push @linger, AE::timer $linger, 0, sub {
1516	@linger = ();	1846	@linger = ();
1517	});	1847	};
1518	}	1848	}
1519	}	1849	}
1520		1850
1521	=item $handle->destroy	1851	=item $handle->destroy
1522		1852
1523	Shuts down the handle object as much as possible - this call ensures that	1853	Shuts down the handle object as much as possible - this call ensures that
1524	no further callbacks will be invoked and resources will be freed as much	1854	no further callbacks will be invoked and as many resources as possible
1525	as possible. You must not call any methods on the object afterwards.	1855	will be freed. Any method you will call on the handle object after
		1856	destroying it in this way will be silently ignored (and it will return the
		1857	empty list).
1526		1858
1527	Normally, you can just "forget" any references to an AnyEvent::Handle	1859	Normally, you can just "forget" any references to an AnyEvent::Handle
1528	object and it will simply shut down. This works in fatal error and EOF	1860	object and it will simply shut down. This works in fatal error and EOF
1529	callbacks, as well as code outside. It does I<NOT> work in a read or write	1861	callbacks, as well as code outside. It does I<NOT> work in a read or write
1530	callback, so when you want to destroy the AnyEvent::Handle object from	1862	callback, so when you want to destroy the AnyEvent::Handle object from
1531	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in	1863	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
1532	that case.	1864	that case.
1533		1865
		1866	Destroying the handle object in this way has the advantage that callbacks
		1867	will be removed as well, so if those are the only reference holders (as
		1868	is common), then one doesn't need to do anything special to break any
		1869	reference cycles.
		1870
1534	The handle might still linger in the background and write out remaining	1871	The handle might still linger in the background and write out remaining
1535	data, as specified by the C<linger> option, however.	1872	data, as specified by the C<linger> option, however.
1536		1873
1537	=cut	1874	=cut
1538		1875
1539	sub destroy {	1876	sub destroy {
1540	my ($self) = @_;	1877	my ($self) = @_;
1541		1878
1542	$self->DESTROY;	1879	$self->DESTROY;
1543	%$self = ();	1880	%$self = ();
		1881	bless $self, "AnyEvent::Handle::destroyed";
		1882	}
		1883
		1884	sub AnyEvent::Handle::destroyed::AUTOLOAD {
		1885	#nop
1544	}	1886	}
1545		1887
1546	=item AnyEvent::Handle::TLS_CTX	1888	=item AnyEvent::Handle::TLS_CTX
1547		1889
1548	This function creates and returns the AnyEvent::TLS object used by default	1890	This function creates and returns the AnyEvent::TLS object used by default
…		…
1605		1947
1606	$handle->on_read (sub { });	1948	$handle->on_read (sub { });
1607	$handle->on_eof (undef);	1949	$handle->on_eof (undef);
1608	$handle->on_error (sub {	1950	$handle->on_error (sub {
1609	my $data = delete $_[0]{rbuf};	1951	my $data = delete $_[0]{rbuf};
1610	undef $handle;
1611	});	1952	});
1612		1953
1613	The reason to use C<on_error> is that TCP connections, due to latencies	1954	The reason to use C<on_error> is that TCP connections, due to latencies
1614	and packets loss, might get closed quite violently with an error, when in	1955	and packets loss, might get closed quite violently with an error, when in
1615	fact, all data has been received.	1956	fact, all data has been received.
…		…
1631	$handle->on_drain (sub {	1972	$handle->on_drain (sub {
1632	warn "all data submitted to the kernel\n";	1973	warn "all data submitted to the kernel\n";
1633	undef $handle;	1974	undef $handle;
1634	});	1975	});
1635		1976
		1977	If you just want to queue some data and then signal EOF to the other side,
		1978	consider using C<< ->push_shutdown >> instead.
		1979
		1980	=item I want to contact a TLS/SSL server, I don't care about security.
		1981
		1982	If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS,
		1983	simply connect to it and then create the AnyEvent::Handle with the C<tls>
		1984	parameter:
		1985
		1986	tcp_connect $host, $port, sub {
		1987	my ($fh) = @_;
		1988
		1989	my $handle = new AnyEvent::Handle
		1990	fh => $fh,
		1991	tls => "connect",
		1992	on_error => sub { ... };
		1993
		1994	$handle->push_write (...);
		1995	};
		1996
		1997	=item I want to contact a TLS/SSL server, I do care about security.
		1998
		1999	Then you should additionally enable certificate verification, including
		2000	peername verification, if the protocol you use supports it (see
		2001	L<AnyEvent::TLS>, C<verify_peername>).
		2002
		2003	E.g. for HTTPS:
		2004
		2005	tcp_connect $host, $port, sub {
		2006	my ($fh) = @_;
		2007
		2008	my $handle = new AnyEvent::Handle
		2009	fh => $fh,
		2010	peername => $host,
		2011	tls => "connect",
		2012	tls_ctx => { verify => 1, verify_peername => "https" },
		2013	...
		2014
		2015	Note that you must specify the hostname you connected to (or whatever
		2016	"peername" the protocol needs) as the C<peername> argument, otherwise no
		2017	peername verification will be done.
		2018
		2019	The above will use the system-dependent default set of trusted CA
		2020	certificates. If you want to check against a specific CA, add the
		2021	C<ca_file> (or C<ca_cert>) arguments to C<tls_ctx>:
		2022
		2023	tls_ctx => {
		2024	verify => 1,
		2025	verify_peername => "https",
		2026	ca_file => "my-ca-cert.pem",
		2027	},
		2028
		2029	=item I want to create a TLS/SSL server, how do I do that?
		2030
		2031	Well, you first need to get a server certificate and key. You have
		2032	three options: a) ask a CA (buy one, use cacert.org etc.) b) create a
		2033	self-signed certificate (cheap. check the search engine of your choice,
		2034	there are many tutorials on the net) or c) make your own CA (tinyca2 is a
		2035	nice program for that purpose).
		2036
		2037	Then create a file with your private key (in PEM format, see
		2038	L<AnyEvent::TLS>), followed by the certificate (also in PEM format). The
		2039	file should then look like this:
		2040
		2041	-----BEGIN RSA PRIVATE KEY-----
		2042	...header data
		2043	... lots of base64'y-stuff
		2044	-----END RSA PRIVATE KEY-----
		2045
		2046	-----BEGIN CERTIFICATE-----
		2047	... lots of base64'y-stuff
		2048	-----END CERTIFICATE-----
		2049
		2050	The important bits are the "PRIVATE KEY" and "CERTIFICATE" parts. Then
		2051	specify this file as C<cert_file>:
		2052
		2053	tcp_server undef, $port, sub {
		2054	my ($fh) = @_;
		2055
		2056	my $handle = new AnyEvent::Handle
		2057	fh => $fh,
		2058	tls => "accept",
		2059	tls_ctx => { cert_file => "my-server-keycert.pem" },
		2060	...
		2061
		2062	When you have intermediate CA certificates that your clients might not
		2063	know about, just append them to the C<cert_file>.
		2064
1636	=back	2065	=back
1637		2066
1638		2067
1639	=head1 SUBCLASSING AnyEvent::Handle	2068	=head1 SUBCLASSING AnyEvent::Handle
1640		2069

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.131 by root, Tue Jun 30 22:42:33 2009 UTC vs. Revision 1.178 by root, Tue Aug 11 01:15:17 2009 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.131 by root, Tue Jun 30 22:42:33 2009 UTC vs.
Revision 1.178 by root, Tue Aug 11 01:15:17 2009 UTC