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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.102 by root, Wed Oct 29 14:32:02 2008 UTC vs.
Revision 1.175 by root, Sat Aug 8 22:20:43 2009 UTC

…		…
1	package AnyEvent::Handle;	1	package AnyEvent::Handle;
2		2
3	no warnings;
4	use strict qw(subs vars);
5
6	use AnyEvent ();
7	use AnyEvent::Util qw(WSAEWOULDBLOCK);
8	use Scalar::Util ();	3	use Scalar::Util ();
9	use Carp ();	4	use Carp ();
10	use Fcntl ();
11	use Errno qw(EAGAIN EINTR);	5	use Errno qw(EAGAIN EINTR);
12		6
		7	use AnyEvent (); BEGIN { AnyEvent::common_sense }
		8	use AnyEvent::Util qw(WSAEWOULDBLOCK);
		9
13	=head1 NAME	10	=head1 NAME
14		11
15	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent	12	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent
16		13
17	=cut	14	=cut
18		15
19	our $VERSION = 4.3;	16	our $VERSION = 4.91;
20		17
21	=head1 SYNOPSIS	18	=head1 SYNOPSIS
22		19
23	use AnyEvent;	20	use AnyEvent;
24	use AnyEvent::Handle;	21	use AnyEvent::Handle;
25		22
26	my $cv = AnyEvent->condvar;	23	my $cv = AnyEvent->condvar;
27		24
28	my $handle =	25	my $hdl; $hdl = new AnyEvent::Handle
29	AnyEvent::Handle->new (
30	fh => \*STDIN,	26	fh => \*STDIN,
31	on_eof => sub {	27	on_error => sub {
32	$cv->broadcast;	28	my ($hdl, $fatal, $msg) = @_;
33	},	29	warn "got error $msg\n";
		30	$hdl->destroy;
		31	$cv->send;
34	);	32	);
35		33
36	# send some request line	34	# send some request line
37	$handle->push_write ("getinfo\015\012");	35	$hdl->push_write ("getinfo\015\012");
38		36
39	# read the response line	37	# read the response line
40	$handle->push_read (line => sub {	38	$hdl->push_read (line => sub {
41	my ($handle, $line) = @_;	39	my ($hdl, $line) = @_;
42	warn "read line <$line>\n";	40	warn "got line <$line>\n";
43	$cv->send;	41	$cv->send;
44	});	42	});
45		43
46	$cv->recv;	44	$cv->recv;
47		45
48	=head1 DESCRIPTION	46	=head1 DESCRIPTION
49		47
50	This module is a helper module to make it easier to do event-based I/O on	48	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	49	filehandles.
52	on sockets see L<AnyEvent::Util>.
53		50
54	The L<AnyEvent::Intro> tutorial contains some well-documented	51	The L<AnyEvent::Intro> tutorial contains some well-documented
55	AnyEvent::Handle examples.	52	AnyEvent::Handle examples.
56		53
57	In the following, when the documentation refers to of "bytes" then this	54	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	55	means characters. As sysread and syswrite are used for all I/O, their
59	treatment of characters applies to this module as well.	56	treatment of characters applies to this module as well.
60		57
		58	At the very minimum, you should specify C<fh> or C<connect>, and the
		59	C<on_error> callback.
		60
61	All callbacks will be invoked with the handle object as their first	61	All callbacks will be invoked with the handle object as their first
62	argument.	62	argument.
63		63
64	=head1 METHODS	64	=head1 METHODS
65		65
66	=over 4	66	=over 4
67		67
68	=item B<new (%args)>	68	=item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value...
69		69
70	The constructor supports these arguments (all as key => value pairs).	70	The constructor supports these arguments (all as C<< key => value >> pairs).
71		71
72	=over 4	72	=over 4
73		73
74	=item fh => $filehandle [MANDATORY]	74	=item fh => $filehandle [C<fh> or C<connect> MANDATORY]
75		75
76	The filehandle this L<AnyEvent::Handle> object will operate on.	76	The filehandle this L<AnyEvent::Handle> object will operate on.
77
78	NOTE: The filehandle will be set to non-blocking mode (using	77	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	78	C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in
80	that mode.	79	that mode.
81		80
		81	=item connect => [$host, $service] [C<fh> or C<connect> MANDATORY]
		82
		83	Try to connect to the specified host and service (port), using
		84	C<AnyEvent::Socket::tcp_connect>. The C<$host> additionally becomes the
		85	default C<peername>.
		86
		87	You have to specify either this parameter, or C<fh>, above.
		88
		89	It is possible to push requests on the read and write queues, and modify
		90	properties of the stream, even while AnyEvent::Handle is connecting.
		91
		92	When this parameter is specified, then the C<on_prepare>,
		93	C<on_connect_error> and C<on_connect> callbacks will be called under the
		94	appropriate circumstances:
		95
		96	=over 4
		97
		98	=item on_prepare => $cb->($handle)
		99
		100	This (rarely used) callback is called before a new connection is
		101	attempted, but after the file handle has been created. It could be used to
		102	prepare the file handle with parameters required for the actual connect
		103	(as opposed to settings that can be changed when the connection is already
		104	established).
		105
		106	The return value of this callback should be the connect timeout value in
		107	seconds (or C<0>, or C<undef>, or the empty list, to indicate the default
		108	timeout is to be used).
		109
		110	=item on_connect => $cb->($handle, $host, $port, $retry->())
		111
		112	This callback is called when a connection has been successfully established.
		113
		114	The actual numeric host and port (the socket peername) are passed as
		115	parameters, together with a retry callback.
		116
		117	When, for some reason, the handle is not acceptable, then calling
		118	C<$retry> will continue with the next conenction target (in case of
		119	multi-homed hosts or SRV records there can be multiple connection
		120	endpoints). When it is called then the read and write queues, eof status,
		121	tls status and similar properties of the handle are being reset.
		122
		123	In most cases, ignoring the C<$retry> parameter is the way to go.
		124
		125	=item on_connect_error => $cb->($handle, $message)
		126
		127	This callback is called when the conenction could not be
		128	established. C<$!> will contain the relevant error code, and C<$message> a
		129	message describing it (usually the same as C<"$!">).
		130
		131	If this callback isn't specified, then C<on_error> will be called with a
		132	fatal error instead.
		133
		134	=back
		135
		136	=item on_error => $cb->($handle, $fatal, $message)
		137
		138	This is the error callback, which is called when, well, some error
		139	occured, such as not being able to resolve the hostname, failure to
		140	connect or a read error.
		141
		142	Some errors are fatal (which is indicated by C<$fatal> being true). On
		143	fatal errors the handle object will be destroyed (by a call to C<< ->
		144	destroy >>) after invoking the error callback (which means you are free to
		145	examine the handle object). Examples of fatal errors are an EOF condition
		146	with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors. In
		147	cases where the other side can close the connection at their will it is
		148	often easiest to not report C<EPIPE> errors in this callback.
		149
		150	AnyEvent::Handle tries to find an appropriate error code for you to check
		151	against, but in some cases (TLS errors), this does not work well. It is
		152	recommended to always output the C<$message> argument in human-readable
		153	error messages (it's usually the same as C<"$!">).
		154
		155	Non-fatal errors can be retried by simply returning, but it is recommended
		156	to simply ignore this parameter and instead abondon the handle object
		157	when this callback is invoked. Examples of non-fatal errors are timeouts
		158	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
		159
		160	On callback entrance, the value of C<$!> contains the operating system
		161	error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
		162	C<EPROTO>).
		163
		164	While not mandatory, it is I<highly> recommended to set this callback, as
		165	you will not be notified of errors otherwise. The default simply calls
		166	C<croak>.
		167
		168	=item on_read => $cb->($handle)
		169
		170	This sets the default read callback, which is called when data arrives
		171	and no read request is in the queue (unlike read queue callbacks, this
		172	callback will only be called when at least one octet of data is in the
		173	read buffer).
		174
		175	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
		176	method or access the C<< $handle->{rbuf} >> member directly. Note that you
		177	must not enlarge or modify the read buffer, you can only remove data at
		178	the beginning from it.
		179
		180	When an EOF condition is detected then AnyEvent::Handle will first try to
		181	feed all the remaining data to the queued callbacks and C<on_read> before
		182	calling the C<on_eof> callback. If no progress can be made, then a fatal
		183	error will be raised (with C<$!> set to C<EPIPE>).
		184
		185	Note that, unlike requests in the read queue, an C<on_read> callback
		186	doesn't mean you I<require> some data: if there is an EOF and there
		187	are outstanding read requests then an error will be flagged. With an
		188	C<on_read> callback, the C<on_eof> callback will be invoked.
		189
82	=item on_eof => $cb->($handle)	190	=item on_eof => $cb->($handle)
83		191
84	Set the callback to be called when an end-of-file condition is detected,	192	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	193	i.e. in the case of a socket, when the other side has closed the
86	connection cleanly.	194	connection cleanly, and there are no outstanding read requests in the
		195	queue (if there are read requests, then an EOF counts as an unexpected
		196	connection close and will be flagged as an error).
87		197
88	For sockets, this just means that the other side has stopped sending data,	198	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	199	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	200	callback and continue writing data, as only the read part has been shut
91	down.	201	down.
92		202
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	203	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>.	204	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.
133
134	When an EOF condition is detected then AnyEvent::Handle will first try to
135	feed all the remaining data to the queued callbacks and C<on_read> before
136	calling the C<on_eof> callback. If no progress can be made, then a fatal
137	error will be raised (with C<$!> set to C<EPIPE>).
138		205
139	=item on_drain => $cb->($handle)	206	=item on_drain => $cb->($handle)
140		207
141	This sets the callback that is called when the write buffer becomes empty	208	This sets the callback that is called when the write buffer becomes empty
142	(or when the callback is set and the buffer is empty already).	209	(or when the callback is set and the buffer is empty already).
235		302
236	This will not work for partial TLS data that could not be encoded	303	This will not work for partial TLS data that could not be encoded
237	yet. This data will be lost. Calling the C<stoptls> method in time might	304	yet. This data will be lost. Calling the C<stoptls> method in time might
238	help.	305	help.
239		306
		307	=item peername => $string
		308
		309	A string used to identify the remote site - usually the DNS hostname
		310	(I<not> IDN!) used to create the connection, rarely the IP address.
		311
		312	Apart from being useful in error messages, this string is also used in TLS
		313	peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This
		314	verification will be skipped when C<peername> is not specified or
		315	C<undef>.
		316
240	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	317	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
241		318
242	When this parameter is given, it enables TLS (SSL) mode, that means	319	When this parameter is given, it enables TLS (SSL) mode, that means
243	AnyEvent will start a TLS handshake as soon as the conenction has been	320	AnyEvent will start a TLS handshake as soon as the conenction has been
244	established and will transparently encrypt/decrypt data afterwards.	321	established and will transparently encrypt/decrypt data afterwards.
		322
		323	All TLS protocol errors will be signalled as C<EPROTO>, with an
		324	appropriate error message.
245		325
246	TLS mode requires Net::SSLeay to be installed (it will be loaded	326	TLS mode requires Net::SSLeay to be installed (it will be loaded
247	automatically when you try to create a TLS handle): this module doesn't	327	automatically when you try to create a TLS handle): this module doesn't
248	have a dependency on that module, so if your module requires it, you have	328	have a dependency on that module, so if your module requires it, you have
249	to add the dependency yourself.	329	to add the dependency yourself.
…		…
253	mode.	333	mode.
254		334
255	You can also provide your own TLS connection object, but you have	335	You can also provide your own TLS connection object, but you have
256	to make sure that you call either C<Net::SSLeay::set_connect_state>	336	to make sure that you call either C<Net::SSLeay::set_connect_state>
257	or C<Net::SSLeay::set_accept_state> on it before you pass it to	337	or C<Net::SSLeay::set_accept_state> on it before you pass it to
258	AnyEvent::Handle.	338	AnyEvent::Handle. Also, this module will take ownership of this connection
		339	object.
		340
		341	At some future point, AnyEvent::Handle might switch to another TLS
		342	implementation, then the option to use your own session object will go
		343	away.
		344
		345	B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,
		346	passing in the wrong integer will lead to certain crash. This most often
		347	happens when one uses a stylish C<< tls => 1 >> and is surprised about the
		348	segmentation fault.
259		349
260	See the C<< ->starttls >> method for when need to start TLS negotiation later.	350	See the C<< ->starttls >> method for when need to start TLS negotiation later.
261		351
262	=item tls_ctx => $ssl_ctx	352	=item tls_ctx => $anyevent_tls
263		353
264	Use the given C<Net::SSLeay::CTX> object to create the new TLS connection	354	Use the given C<AnyEvent::TLS> object to create the new TLS connection
265	(unless a connection object was specified directly). If this parameter is	355	(unless a connection object was specified directly). If this parameter is
266	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	356	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
		357
		358	Instead of an object, you can also specify a hash reference with C<< key
		359	=> value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a
		360	new TLS context object.
		361
		362	=item on_starttls => $cb->($handle, $success[, $error_message])
		363
		364	This callback will be invoked when the TLS/SSL handshake has finished. If
		365	C<$success> is true, then the TLS handshake succeeded, otherwise it failed
		366	(C<on_stoptls> will not be called in this case).
		367
		368	The session in C<< $handle->{tls} >> can still be examined in this
		369	callback, even when the handshake was not successful.
		370
		371	TLS handshake failures will not cause C<on_error> to be invoked when this
		372	callback is in effect, instead, the error message will be passed to C<on_starttls>.
		373
		374	Without this callback, handshake failures lead to C<on_error> being
		375	called, as normal.
		376
		377	Note that you cannot call C<starttls> right again in this callback. If you
		378	need to do that, start an zero-second timer instead whose callback can
		379	then call C<< ->starttls >> again.
		380
		381	=item on_stoptls => $cb->($handle)
		382
		383	When a SSLv3/TLS shutdown/close notify/EOF is detected and this callback is
		384	set, then it will be invoked after freeing the TLS session. If it is not,
		385	then a TLS shutdown condition will be treated like a normal EOF condition
		386	on the handle.
		387
		388	The session in C<< $handle->{tls} >> can still be examined in this
		389	callback.
		390
		391	This callback will only be called on TLS shutdowns, not when the
		392	underlying handle signals EOF.
267		393
268	=item json => JSON or JSON::XS object	394	=item json => JSON or JSON::XS object
269		395
270	This is the json coder object used by the C<json> read and write types.	396	This is the json coder object used by the C<json> read and write types.
271		397
…		…
280		406
281	=cut	407	=cut
282		408
283	sub new {	409	sub new {
284	my $class = shift;	410	my $class = shift;
285
286	my $self = bless { @_ }, $class;	411	my $self = bless { @_ }, $class;
287		412
288	$self->{fh} or Carp::croak "mandatory argument fh is missing";	413	if ($self->{fh}) {
		414	$self->_start;
		415	return unless $self->{fh}; # could be gone by now
		416
		417	} elsif ($self->{connect}) {
		418	require AnyEvent::Socket;
		419
		420	$self->{peername} = $self->{connect}[0]
		421	unless exists $self->{peername};
		422
		423	$self->{_skip_drain_rbuf} = 1;
		424
		425	{
		426	Scalar::Util::weaken (my $self = $self);
		427
		428	$self->{_connect} =
		429	AnyEvent::Socket::tcp_connect (
		430	$self->{connect}[0],
		431	$self->{connect}[1],
		432	sub {
		433	my ($fh, $host, $port, $retry) = @_;
		434
		435	if ($fh) {
		436	$self->{fh} = $fh;
		437
		438	delete $self->{_skip_drain_rbuf};
		439	$self->_start;
		440
		441	$self->{on_connect}
		442	and $self->{on_connect}($self, $host, $port, sub {
		443	delete @$self{qw(fh _tw _ww _rw _eof _queue rbuf _wbuf tls _tls_rbuf _tls_wbuf)};
		444	$self->{_skip_drain_rbuf} = 1;
		445	&$retry;
		446	});
		447
		448	} else {
		449	if ($self->{on_connect_error}) {
		450	$self->{on_connect_error}($self, "$!");
		451	$self->destroy;
		452	} else {
		453	$self->_error ($!, 1);
		454	}
		455	}
		456	},
		457	sub {
		458	local $self->{fh} = $_[0];
		459
		460	$self->{on_prepare}
		461	? $self->{on_prepare}->($self)
		462	: ()
		463	}
		464	);
		465	}
		466
		467	} else {
		468	Carp::croak "AnyEvent::Handle: either an existing fh or the connect parameter must be specified";
		469	}
		470
		471	$self
		472	}
		473
		474	sub _start {
		475	my ($self) = @_;
289		476
290	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	477	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
		478
		479	$self->{_activity} = AE::now;
		480	$self->_timeout;
		481
		482	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
291		483
292	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})	484	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
293	if $self->{tls};	485	if $self->{tls};
294		486
295	$self->{_activity} = AnyEvent->now;
296	$self->_timeout;
297
298	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};	487	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
299	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
300		488
301	$self->start_read	489	$self->start_read
302	if $self->{on_read};	490	if $self->{on_read} \|\| @{ $self->{_queue} };
303		491
304	$self	492	$self->_drain_wbuf;
305	}	493	}
306		494
307	sub _shutdown {	495	#sub _shutdown {
308	my ($self) = @_;	496	# my ($self) = @_;
309		497	#
310	delete $self->{_tw};	498	# delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)};
311	delete $self->{_rw};	499	# $self->{_eof} = 1; # tell starttls et. al to stop trying
312	delete $self->{_ww};	500	#
313	delete $self->{fh};
314
315	&_freetls;	501	# &_freetls;
316		502	#}
317	delete $self->{on_read};
318	delete $self->{_queue};
319	}
320		503
321	sub _error {	504	sub _error {
322	my ($self, $errno, $fatal) = @_;	505	my ($self, $errno, $fatal, $message) = @_;
323
324	$self->_shutdown
325	if $fatal;
326		506
327	$! = $errno;	507	$! = $errno;
		508	$message \|\|= "$!";
328		509
329	if ($self->{on_error}) {	510	if ($self->{on_error}) {
330	$self->{on_error}($self, $fatal);	511	$self->{on_error}($self, $fatal, $message);
		512	$self->destroy if $fatal;
331	} elsif ($self->{fh}) {	513	} elsif ($self->{fh}) {
		514	$self->destroy;
332	Carp::croak "AnyEvent::Handle uncaught error: $!";	515	Carp::croak "AnyEvent::Handle uncaught error: $message";
333	}	516	}
334	}	517	}
335		518
336	=item $fh = $handle->fh	519	=item $fh = $handle->fh
337		520
…		…
374	}	557	}
375		558
376	=item $handle->autocork ($boolean)	559	=item $handle->autocork ($boolean)
377		560
378	Enables or disables the current autocork behaviour (see C<autocork>	561	Enables or disables the current autocork behaviour (see C<autocork>
379	constructor argument).	562	constructor argument). Changes will only take effect on the next write.
380		563
381	=cut	564	=cut
		565
		566	sub autocork {
		567	$_[0]{autocork} = $_[1];
		568	}
382		569
383	=item $handle->no_delay ($boolean)	570	=item $handle->no_delay ($boolean)
384		571
385	Enables or disables the C<no_delay> setting (see constructor argument of	572	Enables or disables the C<no_delay> setting (see constructor argument of
386	the same name for details).	573	the same name for details).
…		…
390	sub no_delay {	577	sub no_delay {
391	$_[0]{no_delay} = $_[1];	578	$_[0]{no_delay} = $_[1];
392		579
393	eval {	580	eval {
394	local $SIG{__DIE__};	581	local $SIG{__DIE__};
395	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];	582	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1]
		583	if $_[0]{fh};
396	};	584	};
		585	}
		586
		587	=item $handle->on_starttls ($cb)
		588
		589	Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument).
		590
		591	=cut
		592
		593	sub on_starttls {
		594	$_[0]{on_starttls} = $_[1];
		595	}
		596
		597	=item $handle->on_stoptls ($cb)
		598
		599	Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).
		600
		601	=cut
		602
		603	sub on_starttls {
		604	$_[0]{on_stoptls} = $_[1];
		605	}
		606
		607	=item $handle->rbuf_max ($max_octets)
		608
		609	Configures the C<rbuf_max> setting (C<undef> disables it).
		610
		611	=cut
		612
		613	sub rbuf_max {
		614	$_[0]{rbuf_max} = $_[1];
397	}	615	}
398		616
399	#############################################################################	617	#############################################################################
400		618
401	=item $handle->timeout ($seconds)	619	=item $handle->timeout ($seconds)
…		…
406		624
407	sub timeout {	625	sub timeout {
408	my ($self, $timeout) = @_;	626	my ($self, $timeout) = @_;
409		627
410	$self->{timeout} = $timeout;	628	$self->{timeout} = $timeout;
		629	delete $self->{_tw};
411	$self->_timeout;	630	$self->_timeout;
412	}	631	}
413		632
414	# reset the timeout watcher, as neccessary	633	# reset the timeout watcher, as neccessary
415	# also check for time-outs	634	# also check for time-outs
416	sub _timeout {	635	sub _timeout {
417	my ($self) = @_;	636	my ($self) = @_;
418		637
419	if ($self->{timeout}) {	638	if ($self->{timeout} && $self->{fh}) {
420	my $NOW = AnyEvent->now;	639	my $NOW = AE::now;
421		640
422	# when would the timeout trigger?	641	# when would the timeout trigger?
423	my $after = $self->{_activity} + $self->{timeout} - $NOW;	642	my $after = $self->{_activity} + $self->{timeout} - $NOW;
424		643
425	# now or in the past already?	644	# now or in the past already?
…		…
427	$self->{_activity} = $NOW;	646	$self->{_activity} = $NOW;
428		647
429	if ($self->{on_timeout}) {	648	if ($self->{on_timeout}) {
430	$self->{on_timeout}($self);	649	$self->{on_timeout}($self);
431	} else {	650	} else {
432	$self->_error (&Errno::ETIMEDOUT);	651	$self->_error (Errno::ETIMEDOUT);
433	}	652	}
434		653
435	# callback could have changed timeout value, optimise	654	# callback could have changed timeout value, optimise
436	return unless $self->{timeout};	655	return unless $self->{timeout};
437		656
…		…
440	}	659	}
441		660
442	Scalar::Util::weaken $self;	661	Scalar::Util::weaken $self;
443	return unless $self; # ->error could have destroyed $self	662	return unless $self; # ->error could have destroyed $self
444		663
445	$self->{_tw} \|\|= AnyEvent->timer (after => $after, cb => sub {	664	$self->{_tw} \|\|= AE::timer $after, 0, sub {
446	delete $self->{_tw};	665	delete $self->{_tw};
447	$self->_timeout;	666	$self->_timeout;
448	});	667	};
449	} else {	668	} else {
450	delete $self->{_tw};	669	delete $self->{_tw};
451	}	670	}
452	}	671	}
453		672
…		…
500	Scalar::Util::weaken $self;	719	Scalar::Util::weaken $self;
501		720
502	my $cb = sub {	721	my $cb = sub {
503	my $len = syswrite $self->{fh}, $self->{wbuf};	722	my $len = syswrite $self->{fh}, $self->{wbuf};
504		723
505	if ($len >= 0) {	724	if (defined $len) {
506	substr $self->{wbuf}, 0, $len, "";	725	substr $self->{wbuf}, 0, $len, "";
507		726
508	$self->{_activity} = AnyEvent->now;	727	$self->{_activity} = AE::now;
509		728
510	$self->{on_drain}($self)	729	$self->{on_drain}($self)
511	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})	730	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
512	&& $self->{on_drain};	731	&& $self->{on_drain};
513		732
…		…
519		738
520	# try to write data immediately	739	# try to write data immediately
521	$cb->() unless $self->{autocork};	740	$cb->() unless $self->{autocork};
522		741
523	# if still data left in wbuf, we need to poll	742	# if still data left in wbuf, we need to poll
524	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	743	$self->{_ww} = AE::io $self->{fh}, 1, $cb
525	if length $self->{wbuf};	744	if length $self->{wbuf};
526	};	745	};
527	}	746	}
528		747
529	our %WH;	748	our %WH;
…		…
542	->($self, @_);	761	->($self, @_);
543	}	762	}
544		763
545	if ($self->{tls}) {	764	if ($self->{tls}) {
546	$self->{_tls_wbuf} .= $_[0];	765	$self->{_tls_wbuf} .= $_[0];
547		766	&_dotls ($self) if $self->{fh};
548	&_dotls ($self);
549	} else {	767	} else {
550	$self->{wbuf} .= $_[0];	768	$self->{wbuf} .= $_[0];
551	$self->_drain_wbuf;	769	$self->_drain_wbuf if $self->{fh};
552	}	770	}
553	}	771	}
554		772
555	=item $handle->push_write (type => @args)	773	=item $handle->push_write (type => @args)
556		774
…		…
645		863
646	pack "w/a*", Storable::nfreeze ($ref)	864	pack "w/a*", Storable::nfreeze ($ref)
647	};	865	};
648		866
649	=back	867	=back
		868
		869	=item $handle->push_shutdown
		870
		871	Sometimes you know you want to close the socket after writing your data
		872	before it was actually written. One way to do that is to replace your
		873	C<on_drain> handler by a callback that shuts down the socket (and set
		874	C<low_water_mark> to C<0>). This method is a shorthand for just that, and
		875	replaces the C<on_drain> callback with:
		876
		877	sub { shutdown $_[0]{fh}, 1 } # for push_shutdown
		878
		879	This simply shuts down the write side and signals an EOF condition to the
		880	the peer.
		881
		882	You can rely on the normal read queue and C<on_eof> handling
		883	afterwards. This is the cleanest way to close a connection.
		884
		885	=cut
		886
		887	sub push_shutdown {
		888	my ($self) = @_;
		889
		890	delete $self->{low_water_mark};
		891	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });
		892	}
650		893
651	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	894	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
652		895
653	This function (not method) lets you add your own types to C<push_write>.	896	This function (not method) lets you add your own types to C<push_write>.
654	Whenever the given C<type> is used, C<push_write> will invoke the code	897	Whenever the given C<type> is used, C<push_write> will invoke the code
…		…
748	=cut	991	=cut
749		992
750	sub _drain_rbuf {	993	sub _drain_rbuf {
751	my ($self) = @_;	994	my ($self) = @_;
752		995
		996	# avoid recursion
		997	return if $self->{_skip_drain_rbuf};
753	local $self->{_in_drain} = 1;	998	local $self->{_skip_drain_rbuf} = 1;
754
755	if (
756	defined $self->{rbuf_max}
757	&& $self->{rbuf_max} < length $self->{rbuf}
758	) {
759	$self->_error (&Errno::ENOSPC, 1), return;
760	}
761		999
762	while () {	1000	while () {
		1001	# we need to use a separate tls read buffer, as we must not receive data while
		1002	# we are draining the buffer, and this can only happen with TLS.
		1003	$self->{rbuf} .= delete $self->{_tls_rbuf}
		1004	if exists $self->{_tls_rbuf};
		1005
763	my $len = length $self->{rbuf};	1006	my $len = length $self->{rbuf};
764		1007
765	if (my $cb = shift @{ $self->{_queue} }) {	1008	if (my $cb = shift @{ $self->{_queue} }) {
766	unless ($cb->($self)) {	1009	unless ($cb->($self)) {
767	if ($self->{_eof}) {	1010	# no progress can be made
768	# no progress can be made (not enough data and no data forthcoming)	1011	# (not enough data and no data forthcoming)
769	$self->_error (&Errno::EPIPE, 1), return;	1012	$self->_error (Errno::EPIPE, 1), return
770	}	1013	if $self->{_eof};
771		1014
772	unshift @{ $self->{_queue} }, $cb;	1015	unshift @{ $self->{_queue} }, $cb;
773	last;	1016	last;
774	}	1017	}
775	} elsif ($self->{on_read}) {	1018	} elsif ($self->{on_read}) {
…		…
782	&& !@{ $self->{_queue} } # and the queue is still empty	1025	&& !@{ $self->{_queue} } # and the queue is still empty
783	&& $self->{on_read} # but we still have on_read	1026	&& $self->{on_read} # but we still have on_read
784	) {	1027	) {
785	# no further data will arrive	1028	# no further data will arrive
786	# so no progress can be made	1029	# so no progress can be made
787	$self->_error (&Errno::EPIPE, 1), return	1030	$self->_error (Errno::EPIPE, 1), return
788	if $self->{_eof};	1031	if $self->{_eof};
789		1032
790	last; # more data might arrive	1033	last; # more data might arrive
791	}	1034	}
792	} else {	1035	} else {
…		…
795	last;	1038	last;
796	}	1039	}
797	}	1040	}
798		1041
799	if ($self->{_eof}) {	1042	if ($self->{_eof}) {
800	if ($self->{on_eof}) {	1043	$self->{on_eof}
801	$self->{on_eof}($self)	1044	? $self->{on_eof}($self)
802	} else {	1045	: $self->_error (0, 1, "Unexpected end-of-file");
803	$self->_error (0, 1);	1046
804	}	1047	return;
		1048	}
		1049
		1050	if (
		1051	defined $self->{rbuf_max}
		1052	&& $self->{rbuf_max} < length $self->{rbuf}
		1053	) {
		1054	$self->_error (Errno::ENOSPC, 1), return;
805	}	1055	}
806		1056
807	# may need to restart read watcher	1057	# may need to restart read watcher
808	unless ($self->{_rw}) {	1058	unless ($self->{_rw}) {
809	$self->start_read	1059	$self->start_read
…		…
821		1071
822	sub on_read {	1072	sub on_read {
823	my ($self, $cb) = @_;	1073	my ($self, $cb) = @_;
824		1074
825	$self->{on_read} = $cb;	1075	$self->{on_read} = $cb;
826	$self->_drain_rbuf if $cb && !$self->{_in_drain};	1076	$self->_drain_rbuf if $cb;
827	}	1077	}
828		1078
829	=item $handle->rbuf	1079	=item $handle->rbuf
830		1080
831	Returns the read buffer (as a modifiable lvalue).	1081	Returns the read buffer (as a modifiable lvalue).
832		1082
833	You can access the read buffer directly as the C<< ->{rbuf} >> member, if	1083	You can access the read buffer directly as the C<< ->{rbuf} >>
834	you want.	1084	member, if you want. However, the only operation allowed on the
		1085	read buffer (apart from looking at it) is removing data from its
		1086	beginning. Otherwise modifying or appending to it is not allowed and will
		1087	lead to hard-to-track-down bugs.
835		1088
836	NOTE: The read buffer should only be used or modified if the C<on_read>,	1089	NOTE: The read buffer should only be used or modified if the C<on_read>,
837	C<push_read> or C<unshift_read> methods are used. The other read methods	1090	C<push_read> or C<unshift_read> methods are used. The other read methods
838	automatically manage the read buffer.	1091	automatically manage the read buffer.
839		1092
…		…
880	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	1133	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
881	->($self, $cb, @_);	1134	->($self, $cb, @_);
882	}	1135	}
883		1136
884	push @{ $self->{_queue} }, $cb;	1137	push @{ $self->{_queue} }, $cb;
885	$self->_drain_rbuf unless $self->{_in_drain};	1138	$self->_drain_rbuf;
886	}	1139	}
887		1140
888	sub unshift_read {	1141	sub unshift_read {
889	my $self = shift;	1142	my $self = shift;
890	my $cb = pop;	1143	my $cb = pop;
…		…
896	->($self, $cb, @_);	1149	->($self, $cb, @_);
897	}	1150	}
898		1151
899		1152
900	unshift @{ $self->{_queue} }, $cb;	1153	unshift @{ $self->{_queue} }, $cb;
901	$self->_drain_rbuf unless $self->{_in_drain};	1154	$self->_drain_rbuf;
902	}	1155	}
903		1156
904	=item $handle->push_read (type => @args, $cb)	1157	=item $handle->push_read (type => @args, $cb)
905		1158
906	=item $handle->unshift_read (type => @args, $cb)	1159	=item $handle->unshift_read (type => @args, $cb)
…		…
1039	return 1;	1292	return 1;
1040	}	1293	}
1041		1294
1042	# reject	1295	# reject
1043	if ($reject && $$rbuf =~ $reject) {	1296	if ($reject && $$rbuf =~ $reject) {
1044	$self->_error (&Errno::EBADMSG);	1297	$self->_error (Errno::EBADMSG);
1045	}	1298	}
1046		1299
1047	# skip	1300	# skip
1048	if ($skip && $$rbuf =~ $skip) {	1301	if ($skip && $$rbuf =~ $skip) {
1049	$data .= substr $$rbuf, 0, $+[0], "";	1302	$data .= substr $$rbuf, 0, $+[0], "";
…		…
1065	my ($self, $cb) = @_;	1318	my ($self, $cb) = @_;
1066		1319
1067	sub {	1320	sub {
1068	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {	1321	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
1069	if ($_[0]{rbuf} =~ /[^0-9]/) {	1322	if ($_[0]{rbuf} =~ /[^0-9]/) {
1070	$self->_error (&Errno::EBADMSG);	1323	$self->_error (Errno::EBADMSG);
1071	}	1324	}
1072	return;	1325	return;
1073	}	1326	}
1074		1327
1075	my $len = $1;	1328	my $len = $1;
…		…
1078	my $string = $_[1];	1331	my $string = $_[1];
1079	$_[0]->unshift_read (chunk => 1, sub {	1332	$_[0]->unshift_read (chunk => 1, sub {
1080	if ($_[1] eq ",") {	1333	if ($_[1] eq ",") {
1081	$cb->($_[0], $string);	1334	$cb->($_[0], $string);
1082	} else {	1335	} else {
1083	$self->_error (&Errno::EBADMSG);	1336	$self->_error (Errno::EBADMSG);
1084	}	1337	}
1085	});	1338	});
1086	});	1339	});
1087		1340
1088	1	1341	1
…		…
1135	}	1388	}
1136	};	1389	};
1137		1390
1138	=item json => $cb->($handle, $hash_or_arrayref)	1391	=item json => $cb->($handle, $hash_or_arrayref)
1139		1392
1140	Reads a JSON object or array, decodes it and passes it to the callback.	1393	Reads a JSON object or array, decodes it and passes it to the
		1394	callback. When a parse error occurs, an C<EBADMSG> error will be raised.
1141		1395
1142	If a C<json> object was passed to the constructor, then that will be used	1396	If a C<json> object was passed to the constructor, then that will be used
1143	for the final decode, otherwise it will create a JSON coder expecting UTF-8.	1397	for the final decode, otherwise it will create a JSON coder expecting UTF-8.
1144		1398
1145	This read type uses the incremental parser available with JSON version	1399	This read type uses the incremental parser available with JSON version
…		…
1154	=cut	1408	=cut
1155		1409
1156	register_read_type json => sub {	1410	register_read_type json => sub {
1157	my ($self, $cb) = @_;	1411	my ($self, $cb) = @_;
1158		1412
1159	require JSON;	1413	my $json = $self->{json} \|\|=
		1414	eval { require JSON::XS; JSON::XS->new->utf8 }
		1415	\|\| do { require JSON; JSON->new->utf8 };
1160		1416
1161	my $data;	1417	my $data;
1162	my $rbuf = \$self->{rbuf};	1418	my $rbuf = \$self->{rbuf};
1163		1419
1164	my $json = $self->{json} \|\|= JSON->new->utf8;
1165
1166	sub {	1420	sub {
1167	my $ref = $json->incr_parse ($self->{rbuf});	1421	my $ref = eval { $json->incr_parse ($self->{rbuf}) };
1168		1422
1169	if ($ref) {	1423	if ($ref) {
1170	$self->{rbuf} = $json->incr_text;	1424	$self->{rbuf} = $json->incr_text;
1171	$json->incr_text = "";	1425	$json->incr_text = "";
1172	$cb->($self, $ref);	1426	$cb->($self, $ref);
1173		1427
1174	1	1428	1
		1429	} elsif ($@) {
		1430	# error case
		1431	$json->incr_skip;
		1432
		1433	$self->{rbuf} = $json->incr_text;
		1434	$json->incr_text = "";
		1435
		1436	$self->_error (Errno::EBADMSG);
		1437
		1438	()
1175	} else {	1439	} else {
1176	$self->{rbuf} = "";	1440	$self->{rbuf} = "";
		1441
1177	()	1442	()
1178	}	1443	}
1179	}	1444	}
1180	};	1445	};
1181		1446
…		…
1213	# read remaining chunk	1478	# read remaining chunk
1214	$_[0]->unshift_read (chunk => $len, sub {	1479	$_[0]->unshift_read (chunk => $len, sub {
1215	if (my $ref = eval { Storable::thaw ($_[1]) }) {	1480	if (my $ref = eval { Storable::thaw ($_[1]) }) {
1216	$cb->($_[0], $ref);	1481	$cb->($_[0], $ref);
1217	} else {	1482	} else {
1218	$self->_error (&Errno::EBADMSG);	1483	$self->_error (Errno::EBADMSG);
1219	}	1484	}
1220	});	1485	});
1221	}	1486	}
1222		1487
1223	1	1488	1
…		…
1275	my ($self) = @_;	1540	my ($self) = @_;
1276		1541
1277	unless ($self->{_rw} \|\| $self->{_eof}) {	1542	unless ($self->{_rw} \|\| $self->{_eof}) {
1278	Scalar::Util::weaken $self;	1543	Scalar::Util::weaken $self;
1279		1544
1280	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1545	$self->{_rw} = AE::io $self->{fh}, 0, sub {
1281	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});	1546	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1282	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;	1547	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;
1283		1548
1284	if ($len > 0) {	1549	if ($len > 0) {
1285	$self->{_activity} = AnyEvent->now;	1550	$self->{_activity} = AE::now;
1286		1551
1287	if ($self->{tls}) {	1552	if ($self->{tls}) {
1288	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);	1553	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1289		1554
1290	&_dotls ($self);	1555	&_dotls ($self);
1291	} else {	1556	} else {
1292	$self->_drain_rbuf unless $self->{_in_drain};	1557	$self->_drain_rbuf;
1293	}	1558	}
1294		1559
1295	} elsif (defined $len) {	1560	} elsif (defined $len) {
1296	delete $self->{_rw};	1561	delete $self->{_rw};
1297	$self->{_eof} = 1;	1562	$self->{_eof} = 1;
1298	$self->_drain_rbuf unless $self->{_in_drain};	1563	$self->_drain_rbuf;
1299		1564
1300	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1565	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1301	return $self->_error ($!, 1);	1566	return $self->_error ($!, 1);
1302	}	1567	}
1303	});	1568	};
		1569	}
		1570	}
		1571
		1572	our $ERROR_SYSCALL;
		1573	our $ERROR_WANT_READ;
		1574
		1575	sub _tls_error {
		1576	my ($self, $err) = @_;
		1577
		1578	return $self->_error ($!, 1)
		1579	if $err == Net::SSLeay::ERROR_SYSCALL ();
		1580
		1581	my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());
		1582
		1583	# reduce error string to look less scary
		1584	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;
		1585
		1586	if ($self->{_on_starttls}) {
		1587	(delete $self->{_on_starttls})->($self, undef, $err);
		1588	&_freetls;
		1589	} else {
		1590	&_freetls;
		1591	$self->_error (Errno::EPROTO, 1, $err);
1304	}	1592	}
1305	}	1593	}
1306		1594
1307	# poll the write BIO and send the data if applicable	1595	# poll the write BIO and send the data if applicable
		1596	# also decode read data if possible
		1597	# this is basiclaly our TLS state machine
		1598	# more efficient implementations are possible with openssl,
		1599	# but not with the buggy and incomplete Net::SSLeay.
1308	sub _dotls {	1600	sub _dotls {
1309	my ($self) = @_;	1601	my ($self) = @_;
1310		1602
1311	my $tmp;	1603	my $tmp;
1312		1604
1313	if (length $self->{_tls_wbuf}) {	1605	if (length $self->{_tls_wbuf}) {
1314	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1606	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1315	substr $self->{_tls_wbuf}, 0, $tmp, "";	1607	substr $self->{_tls_wbuf}, 0, $tmp, "";
1316	}	1608	}
		1609
		1610	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);
		1611	return $self->_tls_error ($tmp)
		1612	if $tmp != $ERROR_WANT_READ
		1613	&& ($tmp != $ERROR_SYSCALL \|\| $!);
1317	}	1614	}
1318		1615
1319	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {	1616	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
1320	unless (length $tmp) {	1617	unless (length $tmp) {
1321	# let's treat SSL-eof as we treat normal EOF	1618	$self->{_on_starttls}
1322	delete $self->{_rw};	1619	and (delete $self->{_on_starttls})->($self, undef, "EOF during handshake"); # ???
1323	$self->{_eof} = 1;
1324	&_freetls;	1620	&_freetls;
		1621
		1622	if ($self->{on_stoptls}) {
		1623	$self->{on_stoptls}($self);
		1624	return;
		1625	} else {
		1626	# let's treat SSL-eof as we treat normal EOF
		1627	delete $self->{_rw};
		1628	$self->{_eof} = 1;
		1629	}
1325	}	1630	}
1326		1631
1327	$self->{rbuf} .= $tmp;	1632	$self->{_tls_rbuf} .= $tmp;
1328	$self->_drain_rbuf unless $self->{_in_drain};	1633	$self->_drain_rbuf;
1329	$self->{tls} or return; # tls session might have gone away in callback	1634	$self->{tls} or return; # tls session might have gone away in callback
1330	}	1635	}
1331		1636
1332	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);	1637	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1333
1334	if ($tmp != Net::SSLeay::ERROR_WANT_READ ()) {
1335	if ($tmp == Net::SSLeay::ERROR_SYSCALL ()) {
1336	return $self->_error ($!, 1);	1638	return $self->_tls_error ($tmp)
1337	} elsif ($tmp == Net::SSLeay::ERROR_SSL ()) {	1639	if $tmp != $ERROR_WANT_READ
1338	return $self->_error (&Errno::EIO, 1);	1640	&& ($tmp != $ERROR_SYSCALL \|\| $!);
1339	}
1340
1341	# all other errors are fine for our purposes
1342	}
1343		1641
1344	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1642	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1345	$self->{wbuf} .= $tmp;	1643	$self->{wbuf} .= $tmp;
1346	$self->_drain_wbuf;	1644	$self->_drain_wbuf;
1347	}	1645	}
		1646
		1647	$self->{_on_starttls}
		1648	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
		1649	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");
1348	}	1650	}
1349		1651
1350	=item $handle->starttls ($tls[, $tls_ctx])	1652	=item $handle->starttls ($tls[, $tls_ctx])
1351		1653
1352	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	1654	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
1353	object is created, you can also do that at a later time by calling	1655	object is created, you can also do that at a later time by calling
1354	C<starttls>.	1656	C<starttls>.
1355		1657
		1658	Starting TLS is currently an asynchronous operation - when you push some
		1659	write data and then call C<< ->starttls >> then TLS negotiation will start
		1660	immediately, after which the queued write data is then sent.
		1661
1356	The first argument is the same as the C<tls> constructor argument (either	1662	The first argument is the same as the C<tls> constructor argument (either
1357	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1663	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1358		1664
1359	The second argument is the optional C<Net::SSLeay::CTX> object that is	1665	The second argument is the optional C<AnyEvent::TLS> object that is used
1360	used when AnyEvent::Handle has to create its own TLS connection object.	1666	when AnyEvent::Handle has to create its own TLS connection object, or
		1667	a hash reference with C<< key => value >> pairs that will be used to
		1668	construct a new context.
1361		1669
1362	The TLS connection object will end up in C<< $handle->{tls} >> after this	1670	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS
1363	call and can be used or changed to your liking. Note that the handshake	1671	context in C<< $handle->{tls_ctx} >> after this call and can be used or
1364	might have already started when this function returns.	1672	changed to your liking. Note that the handshake might have already started
		1673	when this function returns.
1365		1674
1366	If it an error to start a TLS handshake more than once per	1675	Due to bugs in OpenSSL, it might or might not be possible to do multiple
1367	AnyEvent::Handle object (this is due to bugs in OpenSSL).	1676	handshakes on the same stream. Best do not attempt to use the stream after
		1677	stopping TLS.
1368		1678
1369	=cut	1679	=cut
		1680
		1681	our %TLS_CACHE; #TODO not yet documented, should we?
1370		1682
1371	sub starttls {	1683	sub starttls {
1372	my ($self, $ssl, $ctx) = @_;	1684	my ($self, $tls, $ctx) = @_;
		1685
		1686	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"
		1687	if $self->{tls};
		1688
		1689	$self->{tls} = $tls;
		1690	$self->{tls_ctx} = $ctx if @_ > 2;
		1691
		1692	return unless $self->{fh};
1373		1693
1374	require Net::SSLeay;	1694	require Net::SSLeay;
1375		1695
1376	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"	1696	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
		1697	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
		1698
1377	if $self->{tls};	1699	$tls = $self->{tls};
		1700	$ctx = $self->{tls_ctx};
		1701
		1702	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
		1703
		1704	if ("HASH" eq ref $ctx) {
		1705	require AnyEvent::TLS;
		1706
		1707	if ($ctx->{cache}) {
		1708	my $key = $ctx+0;
		1709	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;
		1710	} else {
		1711	$ctx = new AnyEvent::TLS %$ctx;
		1712	}
		1713	}
1378		1714
1379	if ($ssl eq "accept") {	1715	$self->{tls_ctx} = $ctx \|\| TLS_CTX ();
1380	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1716	$self->{tls} = $tls = $self->{tls_ctx}->_get_session ($tls, $self, $self->{peername});
1381	Net::SSLeay::set_accept_state ($ssl);
1382	} elsif ($ssl eq "connect") {
1383	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());
1384	Net::SSLeay::set_connect_state ($ssl);
1385	}
1386
1387	$self->{tls} = $ssl;
1388		1717
1389	# basically, this is deep magic (because SSL_read should have the same issues)	1718	# basically, this is deep magic (because SSL_read should have the same issues)
1390	# but the openssl maintainers basically said: "trust us, it just works".	1719	# but the openssl maintainers basically said: "trust us, it just works".
1391	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1720	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1392	# and mismaintained ssleay-module doesn't even offer them).	1721	# and mismaintained ssleay-module doesn't even offer them).
…		…
1396	#	1725	#
1397	# note that we do not try to keep the length constant between writes as we are required to do.	1726	# note that we do not try to keep the length constant between writes as we are required to do.
1398	# we assume that most (but not all) of this insanity only applies to non-blocking cases,	1727	# we assume that most (but not all) of this insanity only applies to non-blocking cases,
1399	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to	1728	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
1400	# have identity issues in that area.	1729	# have identity issues in that area.
1401	Net::SSLeay::CTX_set_mode ($self->{tls},	1730	# Net::SSLeay::CTX_set_mode ($ssl,
1402	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1731	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
1403	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));	1732	# \| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
		1733	Net::SSLeay::CTX_set_mode ($tls, 1\|2);
1404		1734
1405	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1735	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1406	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1736	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1407		1737
		1738	Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf});
		1739
1408	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1740	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
		1741
		1742	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
		1743	if $self->{on_starttls};
1409		1744
1410	&_dotls; # need to trigger the initial handshake	1745	&_dotls; # need to trigger the initial handshake
1411	$self->start_read; # make sure we actually do read	1746	$self->start_read; # make sure we actually do read
1412	}	1747	}
1413		1748
1414	=item $handle->stoptls	1749	=item $handle->stoptls
1415		1750
1416	Shuts down the SSL connection - this makes a proper EOF handshake by	1751	Shuts down the SSL connection - this makes a proper EOF handshake by
1417	sending a close notify to the other side, but since OpenSSL doesn't	1752	sending a close notify to the other side, but since OpenSSL doesn't
1418	support non-blocking shut downs, it is not possible to re-use the stream	1753	support non-blocking shut downs, it is not guarenteed that you can re-use
1419	afterwards.	1754	the stream afterwards.
1420		1755
1421	=cut	1756	=cut
1422		1757
1423	sub stoptls {	1758	sub stoptls {
1424	my ($self) = @_;	1759	my ($self) = @_;
…		…
1426	if ($self->{tls}) {	1761	if ($self->{tls}) {
1427	Net::SSLeay::shutdown ($self->{tls});	1762	Net::SSLeay::shutdown ($self->{tls});
1428		1763
1429	&_dotls;	1764	&_dotls;
1430		1765
1431	# we don't give a shit. no, we do, but we can't. no...	1766	# # we don't give a shit. no, we do, but we can't. no...#d#
1432	# we, we... have to use openssl :/	1767	# # we, we... have to use openssl :/#d#
1433	&_freetls;	1768	# &_freetls;#d#
1434	}	1769	}
1435	}	1770	}
1436		1771
1437	sub _freetls {	1772	sub _freetls {
1438	my ($self) = @_;	1773	my ($self) = @_;
1439		1774
1440	return unless $self->{tls};	1775	return unless $self->{tls};
1441		1776
1442	Net::SSLeay::free (delete $self->{tls});	1777	$self->{tls_ctx}->_put_session (delete $self->{tls})
		1778	if $self->{tls} > 0;
1443		1779
1444	delete @$self{qw(_rbio _wbio _tls_wbuf)};	1780	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1445	}	1781	}
1446		1782
1447	sub DESTROY {	1783	sub DESTROY {
1448	my $self = shift;	1784	my ($self) = @_;
1449		1785
1450	&_freetls;	1786	&_freetls;
1451		1787
1452	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	1788	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1453		1789
1454	if ($linger && length $self->{wbuf}) {	1790	if ($linger && length $self->{wbuf} && $self->{fh}) {
1455	my $fh = delete $self->{fh};	1791	my $fh = delete $self->{fh};
1456	my $wbuf = delete $self->{wbuf};	1792	my $wbuf = delete $self->{wbuf};
1457		1793
1458	my @linger;	1794	my @linger;
1459		1795
1460	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {	1796	push @linger, AE::io $fh, 1, sub {
1461	my $len = syswrite $fh, $wbuf, length $wbuf;	1797	my $len = syswrite $fh, $wbuf, length $wbuf;
1462		1798
1463	if ($len > 0) {	1799	if ($len > 0) {
1464	substr $wbuf, 0, $len, "";	1800	substr $wbuf, 0, $len, "";
1465	} else {	1801	} else {
1466	@linger = (); # end	1802	@linger = (); # end
1467	}	1803	}
1468	});	1804	};
1469	push @linger, AnyEvent->timer (after => $linger, cb => sub {	1805	push @linger, AE::timer $linger, 0, sub {
1470	@linger = ();	1806	@linger = ();
1471	});	1807	};
1472	}	1808	}
1473	}	1809	}
1474		1810
1475	=item $handle->destroy	1811	=item $handle->destroy
1476		1812
1477	Shuts down the handle object as much as possible - this call ensures that	1813	Shuts down the handle object as much as possible - this call ensures that
1478	no further callbacks will be invoked and resources will be freed as much	1814	no further callbacks will be invoked and as many resources as possible
1479	as possible. You must not call any methods on the object afterwards.	1815	will be freed. Any method you will call on the handle object after
		1816	destroying it in this way will be silently ignored (and it will return the
		1817	empty list).
1480		1818
1481	Normally, you can just "forget" any references to an AnyEvent::Handle	1819	Normally, you can just "forget" any references to an AnyEvent::Handle
1482	object and it will simply shut down. This works in fatal error and EOF	1820	object and it will simply shut down. This works in fatal error and EOF
1483	callbacks, as well as code outside. It does I<NOT> work in a read or write	1821	callbacks, as well as code outside. It does I<NOT> work in a read or write
1484	callback, so when you want to destroy the AnyEvent::Handle object from	1822	callback, so when you want to destroy the AnyEvent::Handle object from
1485	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in	1823	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
1486	that case.	1824	that case.
1487		1825
		1826	Destroying the handle object in this way has the advantage that callbacks
		1827	will be removed as well, so if those are the only reference holders (as
		1828	is common), then one doesn't need to do anything special to break any
		1829	reference cycles.
		1830
1488	The handle might still linger in the background and write out remaining	1831	The handle might still linger in the background and write out remaining
1489	data, as specified by the C<linger> option, however.	1832	data, as specified by the C<linger> option, however.
1490		1833
1491	=cut	1834	=cut
1492		1835
1493	sub destroy {	1836	sub destroy {
1494	my ($self) = @_;	1837	my ($self) = @_;
1495		1838
1496	$self->DESTROY;	1839	$self->DESTROY;
1497	%$self = ();	1840	%$self = ();
		1841	bless $self, "AnyEvent::Handle::destroyed";
		1842	}
		1843
		1844	sub AnyEvent::Handle::destroyed::AUTOLOAD {
		1845	#nop
1498	}	1846	}
1499		1847
1500	=item AnyEvent::Handle::TLS_CTX	1848	=item AnyEvent::Handle::TLS_CTX
1501		1849
1502	This function creates and returns the Net::SSLeay::CTX object used by	1850	This function creates and returns the AnyEvent::TLS object used by default
1503	default for TLS mode.	1851	for TLS mode.
1504		1852
1505	The context is created like this:	1853	The context is created by calling L<AnyEvent::TLS> without any arguments.
1506
1507	Net::SSLeay::load_error_strings;
1508	Net::SSLeay::SSLeay_add_ssl_algorithms;
1509	Net::SSLeay::randomize;
1510
1511	my $CTX = Net::SSLeay::CTX_new;
1512
1513	Net::SSLeay::CTX_set_options $CTX, Net::SSLeay::OP_ALL
1514		1854
1515	=cut	1855	=cut
1516		1856
1517	our $TLS_CTX;	1857	our $TLS_CTX;
1518		1858
1519	sub TLS_CTX() {	1859	sub TLS_CTX() {
1520	$TLS_CTX \|\| do {	1860	$TLS_CTX \|\|= do {
1521	require Net::SSLeay;	1861	require AnyEvent::TLS;
1522		1862
1523	Net::SSLeay::load_error_strings ();	1863	new AnyEvent::TLS
1524	Net::SSLeay::SSLeay_add_ssl_algorithms ();
1525	Net::SSLeay::randomize ();
1526
1527	$TLS_CTX = Net::SSLeay::CTX_new ();
1528
1529	Net::SSLeay::CTX_set_options ($TLS_CTX, Net::SSLeay::OP_ALL ());
1530
1531	$TLS_CTX
1532	}	1864	}
1533	}	1865	}
1534		1866
1535	=back	1867	=back
1536		1868
…		…
1575		1907
1576	$handle->on_read (sub { });	1908	$handle->on_read (sub { });
1577	$handle->on_eof (undef);	1909	$handle->on_eof (undef);
1578	$handle->on_error (sub {	1910	$handle->on_error (sub {
1579	my $data = delete $_[0]{rbuf};	1911	my $data = delete $_[0]{rbuf};
1580	undef $handle;
1581	});	1912	});
1582		1913
1583	The reason to use C<on_error> is that TCP connections, due to latencies	1914	The reason to use C<on_error> is that TCP connections, due to latencies
1584	and packets loss, might get closed quite violently with an error, when in	1915	and packets loss, might get closed quite violently with an error, when in
1585	fact, all data has been received.	1916	fact, all data has been received.
…		…
1601	$handle->on_drain (sub {	1932	$handle->on_drain (sub {
1602	warn "all data submitted to the kernel\n";	1933	warn "all data submitted to the kernel\n";
1603	undef $handle;	1934	undef $handle;
1604	});	1935	});
1605		1936
		1937	If you just want to queue some data and then signal EOF to the other side,
		1938	consider using C<< ->push_shutdown >> instead.
		1939
		1940	=item I want to contact a TLS/SSL server, I don't care about security.
		1941
		1942	If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS,
		1943	simply connect to it and then create the AnyEvent::Handle with the C<tls>
		1944	parameter:
		1945
		1946	tcp_connect $host, $port, sub {
		1947	my ($fh) = @_;
		1948
		1949	my $handle = new AnyEvent::Handle
		1950	fh => $fh,
		1951	tls => "connect",
		1952	on_error => sub { ... };
		1953
		1954	$handle->push_write (...);
		1955	};
		1956
		1957	=item I want to contact a TLS/SSL server, I do care about security.
		1958
		1959	Then you should additionally enable certificate verification, including
		1960	peername verification, if the protocol you use supports it (see
		1961	L<AnyEvent::TLS>, C<verify_peername>).
		1962
		1963	E.g. for HTTPS:
		1964
		1965	tcp_connect $host, $port, sub {
		1966	my ($fh) = @_;
		1967
		1968	my $handle = new AnyEvent::Handle
		1969	fh => $fh,
		1970	peername => $host,
		1971	tls => "connect",
		1972	tls_ctx => { verify => 1, verify_peername => "https" },
		1973	...
		1974
		1975	Note that you must specify the hostname you connected to (or whatever
		1976	"peername" the protocol needs) as the C<peername> argument, otherwise no
		1977	peername verification will be done.
		1978
		1979	The above will use the system-dependent default set of trusted CA
		1980	certificates. If you want to check against a specific CA, add the
		1981	C<ca_file> (or C<ca_cert>) arguments to C<tls_ctx>:
		1982
		1983	tls_ctx => {
		1984	verify => 1,
		1985	verify_peername => "https",
		1986	ca_file => "my-ca-cert.pem",
		1987	},
		1988
		1989	=item I want to create a TLS/SSL server, how do I do that?
		1990
		1991	Well, you first need to get a server certificate and key. You have
		1992	three options: a) ask a CA (buy one, use cacert.org etc.) b) create a
		1993	self-signed certificate (cheap. check the search engine of your choice,
		1994	there are many tutorials on the net) or c) make your own CA (tinyca2 is a
		1995	nice program for that purpose).
		1996
		1997	Then create a file with your private key (in PEM format, see
		1998	L<AnyEvent::TLS>), followed by the certificate (also in PEM format). The
		1999	file should then look like this:
		2000
		2001	-----BEGIN RSA PRIVATE KEY-----
		2002	...header data
		2003	... lots of base64'y-stuff
		2004	-----END RSA PRIVATE KEY-----
		2005
		2006	-----BEGIN CERTIFICATE-----
		2007	... lots of base64'y-stuff
		2008	-----END CERTIFICATE-----
		2009
		2010	The important bits are the "PRIVATE KEY" and "CERTIFICATE" parts. Then
		2011	specify this file as C<cert_file>:
		2012
		2013	tcp_server undef, $port, sub {
		2014	my ($fh) = @_;
		2015
		2016	my $handle = new AnyEvent::Handle
		2017	fh => $fh,
		2018	tls => "accept",
		2019	tls_ctx => { cert_file => "my-server-keycert.pem" },
		2020	...
		2021
		2022	When you have intermediate CA certificates that your clients might not
		2023	know about, just append them to the C<cert_file>.
		2024
1606	=back	2025	=back
1607		2026
1608		2027
1609	=head1 SUBCLASSING AnyEvent::Handle	2028	=head1 SUBCLASSING AnyEvent::Handle
1610		2029

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.102 by root, Wed Oct 29 14:32:02 2008 UTC vs. Revision 1.175 by root, Sat Aug 8 22:20:43 2009 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.102 by root, Wed Oct 29 14:32:02 2008 UTC vs.
Revision 1.175 by root, Sat Aug 8 22:20:43 2009 UTC