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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.120 by root, Fri Mar 27 08:33:41 2009 UTC vs.
Revision 1.160 by root, Fri Jul 24 22:47:04 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.341;	16	our $VERSION = 4.86;
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 {
		28	my ($hdl, $fatal, $msg) = @_;
		29	warn "got error $msg\n";
		30	$hdl->destroy;
32	$cv->send;	31	$cv->send;
33	},
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	=item on_connect => $cb->($handle, $host, $port, $retry->())
		107
		108	This callback is called when a connection has been successfully established.
		109
		110	The actual numeric host and port (the socket peername) are passed as
		111	parameters, together with a retry callback.
		112
		113	When, for some reason, the handle is not acceptable, then calling
		114	C<$retry> will continue with the next conenction target (in case of
		115	multi-homed hosts or SRV records there can be multiple connection
		116	endpoints). When it is called then the read and write queues, eof status,
		117	tls status and similar properties of the handle are being reset.
		118
		119	In most cases, ignoring the C<$retry> parameter is the way to go.
		120
		121	=item on_connect_error => $cb->($handle, $message)
		122
		123	This callback is called when the conenction could not be
		124	established. C<$!> will contain the relevant error code, and C<$message> a
		125	message describing it (usually the same as C<"$!">).
		126
		127	If this callback isn't specified, then C<on_error> will be called with a
		128	fatal error instead.
		129
		130	=back
		131
		132	=item on_error => $cb->($handle, $fatal, $message)
		133
		134	This is the error callback, which is called when, well, some error
		135	occured, such as not being able to resolve the hostname, failure to
		136	connect or a read error.
		137
		138	Some errors are fatal (which is indicated by C<$fatal> being true). On
		139	fatal errors the handle object will be destroyed (by a call to C<< ->
		140	destroy >>) after invoking the error callback (which means you are free to
		141	examine the handle object). Examples of fatal errors are an EOF condition
		142	with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors. In
		143	cases where the other side can close the connection at their will it is
		144	often easiest to not report C<EPIPE> errors in this callback.
		145
		146	AnyEvent::Handle tries to find an appropriate error code for you to check
		147	against, but in some cases (TLS errors), this does not work well. It is
		148	recommended to always output the C<$message> argument in human-readable
		149	error messages (it's usually the same as C<"$!">).
		150
		151	Non-fatal errors can be retried by simply returning, but it is recommended
		152	to simply ignore this parameter and instead abondon the handle object
		153	when this callback is invoked. Examples of non-fatal errors are timeouts
		154	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
		155
		156	On callback entrance, the value of C<$!> contains the operating system
		157	error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
		158	C<EPROTO>).
		159
		160	While not mandatory, it is I<highly> recommended to set this callback, as
		161	you will not be notified of errors otherwise. The default simply calls
		162	C<croak>.
		163
		164	=item on_read => $cb->($handle)
		165
		166	This sets the default read callback, which is called when data arrives
		167	and no read request is in the queue (unlike read queue callbacks, this
		168	callback will only be called when at least one octet of data is in the
		169	read buffer).
		170
		171	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
		172	method or access the C<< $handle->{rbuf} >> member directly. Note that you
		173	must not enlarge or modify the read buffer, you can only remove data at
		174	the beginning from it.
		175
		176	When an EOF condition is detected then AnyEvent::Handle will first try to
		177	feed all the remaining data to the queued callbacks and C<on_read> before
		178	calling the C<on_eof> callback. If no progress can be made, then a fatal
		179	error will be raised (with C<$!> set to C<EPIPE>).
		180
		181	Note that, unlike requests in the read queue, an C<on_read> callback
		182	doesn't mean you I<require> some data: if there is an EOF and there
		183	are outstanding read requests then an error will be flagged. With an
		184	C<on_read> callback, the C<on_eof> callback will be invoked.
		185
82	=item on_eof => $cb->($handle)	186	=item on_eof => $cb->($handle)
83		187
84	Set the callback to be called when an end-of-file condition is detected,	188	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	189	i.e. in the case of a socket, when the other side has closed the
86	connection cleanly.	190	connection cleanly, and there are no outstanding read requests in the
		191	queue (if there are read requests, then an EOF counts as an unexpected
		192	connection close and will be flagged as an error).
87		193
88	For sockets, this just means that the other side has stopped sending data,	194	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	195	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	196	callback and continue writing data, as only the read part has been shut
91	down.	197	down.
92		198
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	199	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>.	200	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		201
141	=item on_drain => $cb->($handle)	202	=item on_drain => $cb->($handle)
142		203
143	This sets the callback that is called when the write buffer becomes empty	204	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).	205	(or when the callback is set and the buffer is empty already).
237		298
238	This will not work for partial TLS data that could not be encoded	299	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	300	yet. This data will be lost. Calling the C<stoptls> method in time might
240	help.	301	help.
241		302
		303	=item peername => $string
		304
		305	A string used to identify the remote site - usually the DNS hostname
		306	(I<not> IDN!) used to create the connection, rarely the IP address.
		307
		308	Apart from being useful in error messages, this string is also used in TLS
		309	peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This
		310	verification will be skipped when C<peername> is not specified or
		311	C<undef>.
		312
242	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	313	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
243		314
244	When this parameter is given, it enables TLS (SSL) mode, that means	315	When this parameter is given, it enables TLS (SSL) mode, that means
245	AnyEvent will start a TLS handshake as soon as the conenction has been	316	AnyEvent will start a TLS handshake as soon as the conenction has been
246	established and will transparently encrypt/decrypt data afterwards.	317	established and will transparently encrypt/decrypt data afterwards.
		318
		319	All TLS protocol errors will be signalled as C<EPROTO>, with an
		320	appropriate error message.
247		321
248	TLS mode requires Net::SSLeay to be installed (it will be loaded	322	TLS mode requires Net::SSLeay to be installed (it will be loaded
249	automatically when you try to create a TLS handle): this module doesn't	323	automatically when you try to create a TLS handle): this module doesn't
250	have a dependency on that module, so if your module requires it, you have	324	have a dependency on that module, so if your module requires it, you have
251	to add the dependency yourself.	325	to add the dependency yourself.
…		…
255	mode.	329	mode.
256		330
257	You can also provide your own TLS connection object, but you have	331	You can also provide your own TLS connection object, but you have
258	to make sure that you call either C<Net::SSLeay::set_connect_state>	332	to make sure that you call either C<Net::SSLeay::set_connect_state>
259	or C<Net::SSLeay::set_accept_state> on it before you pass it to	333	or C<Net::SSLeay::set_accept_state> on it before you pass it to
260	AnyEvent::Handle.	334	AnyEvent::Handle. Also, this module will take ownership of this connection
		335	object.
		336
		337	At some future point, AnyEvent::Handle might switch to another TLS
		338	implementation, then the option to use your own session object will go
		339	away.
261		340
262	B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,	341	B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,
263	passing in the wrong integer will lead to certain crash. This most often	342	passing in the wrong integer will lead to certain crash. This most often
264	happens when one uses a stylish C<< tls => 1 >> and is surprised about the	343	happens when one uses a stylish C<< tls => 1 >> and is surprised about the
265	segmentation fault.	344	segmentation fault.
266		345
267	See the C<< ->starttls >> method for when need to start TLS negotiation later.	346	See the C<< ->starttls >> method for when need to start TLS negotiation later.
268		347
269	=item tls_ctx => $ssl_ctx	348	=item tls_ctx => $anyevent_tls
270		349
271	Use the given C<Net::SSLeay::CTX> object to create the new TLS connection	350	Use the given C<AnyEvent::TLS> object to create the new TLS connection
272	(unless a connection object was specified directly). If this parameter is	351	(unless a connection object was specified directly). If this parameter is
273	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	352	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
		353
		354	Instead of an object, you can also specify a hash reference with C<< key
		355	=> value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a
		356	new TLS context object.
		357
		358	=item on_starttls => $cb->($handle, $success[, $error_message])
		359
		360	This callback will be invoked when the TLS/SSL handshake has finished. If
		361	C<$success> is true, then the TLS handshake succeeded, otherwise it failed
		362	(C<on_stoptls> will not be called in this case).
		363
		364	The session in C<< $handle->{tls} >> can still be examined in this
		365	callback, even when the handshake was not successful.
		366
		367	TLS handshake failures will not cause C<on_error> to be invoked when this
		368	callback is in effect, instead, the error message will be passed to C<on_starttls>.
		369
		370	Without this callback, handshake failures lead to C<on_error> being
		371	called, as normal.
		372
		373	Note that you cannot call C<starttls> right again in this callback. If you
		374	need to do that, start an zero-second timer instead whose callback can
		375	then call C<< ->starttls >> again.
		376
		377	=item on_stoptls => $cb->($handle)
		378
		379	When a SSLv3/TLS shutdown/close notify/EOF is detected and this callback is
		380	set, then it will be invoked after freeing the TLS session. If it is not,
		381	then a TLS shutdown condition will be treated like a normal EOF condition
		382	on the handle.
		383
		384	The session in C<< $handle->{tls} >> can still be examined in this
		385	callback.
		386
		387	This callback will only be called on TLS shutdowns, not when the
		388	underlying handle signals EOF.
274		389
275	=item json => JSON or JSON::XS object	390	=item json => JSON or JSON::XS object
276		391
277	This is the json coder object used by the C<json> read and write types.	392	This is the json coder object used by the C<json> read and write types.
278		393
…		…
287		402
288	=cut	403	=cut
289		404
290	sub new {	405	sub new {
291	my $class = shift;	406	my $class = shift;
292
293	my $self = bless { @_ }, $class;	407	my $self = bless { @_ }, $class;
294		408
295	$self->{fh} or Carp::croak "mandatory argument fh is missing";	409	if ($self->{fh}) {
		410	$self->_start;
		411	return unless $self->{fh}; # could be gone by now
		412
		413	} elsif ($self->{connect}) {
		414	require AnyEvent::Socket;
		415
		416	$self->{peername} = $self->{connect}[0]
		417	unless exists $self->{peername};
		418
		419	$self->{_skip_drain_rbuf} = 1;
		420
		421	{
		422	Scalar::Util::weaken (my $self = $self);
		423
		424	$self->{_connect} =
		425	AnyEvent::Socket::tcp_connect (
		426	$self->{connect}[0],
		427	$self->{connect}[1],
		428	sub {
		429	my ($fh, $host, $port, $retry) = @_;
		430
		431	if ($fh) {
		432	$self->{fh} = $fh;
		433
		434	delete $self->{_skip_drain_rbuf};
		435	$self->_start;
		436
		437	$self->{on_connect}
		438	and $self->{on_connect}($self, $host, $port, sub {
		439	delete @$self{qw(fh _tw _ww _rw _eof _queue rbuf _wbuf tls _tls_rbuf _tls_wbuf)};
		440	$self->{_skip_drain_rbuf} = 1;
		441	&$retry;
		442	});
		443
		444	} else {
		445	if ($self->{on_connect_error}) {
		446	$self->{on_connect_error}($self, "$!");
		447	$self->destroy;
		448	} else {
		449	$self->fatal ($!, 1);
		450	}
		451	}
		452	},
		453	sub {
		454	local $self->{fh} = $_[0];
		455
		456	$self->{on_prepare}->($self)
		457	if $self->{on_prepare};
		458	}
		459	);
		460	}
		461
		462	} else {
		463	Carp::croak "AnyEvent::Handle: either an existing fh or the connect parameter must be specified";
		464	}
		465
		466	$self
		467	}
		468
		469	sub _start {
		470	my ($self) = @_;
296		471
297	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	472	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
		473
		474	$self->{_activity} = AnyEvent->now;
		475	$self->_timeout;
		476
		477	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
298		478
299	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})	479	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
300	if $self->{tls};	480	if $self->{tls};
301		481
302	$self->{_activity} = AnyEvent->now;
303	$self->_timeout;
304
305	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};	482	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
306	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
307		483
308	$self->start_read	484	$self->start_read
309	if $self->{on_read};	485	if $self->{on_read} \|\| @{ $self->{_queue} };
310		486
311	$self	487	$self->_drain_wbuf;
312	}	488	}
313		489
314	sub _shutdown {	490	#sub _shutdown {
315	my ($self) = @_;	491	# my ($self) = @_;
316		492	#
317	delete $self->{_tw};	493	# delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)};
318	delete $self->{_rw};	494	# $self->{_eof} = 1; # tell starttls et. al to stop trying
319	delete $self->{_ww};	495	#
320	delete $self->{fh};
321
322	&_freetls;	496	# &_freetls;
323		497	#}
324	delete $self->{on_read};
325	delete $self->{_queue};
326	}
327		498
328	sub _error {	499	sub _error {
329	my ($self, $errno, $fatal) = @_;	500	my ($self, $errno, $fatal, $message) = @_;
330
331	$self->_shutdown
332	if $fatal;
333		501
334	$! = $errno;	502	$! = $errno;
		503	$message \|\|= "$!";
335		504
336	if ($self->{on_error}) {	505	if ($self->{on_error}) {
337	$self->{on_error}($self, $fatal);	506	$self->{on_error}($self, $fatal, $message);
		507	$self->destroy if $fatal;
338	} elsif ($self->{fh}) {	508	} elsif ($self->{fh}) {
		509	$self->destroy;
339	Carp::croak "AnyEvent::Handle uncaught error: $!";	510	Carp::croak "AnyEvent::Handle uncaught error: $message";
340	}	511	}
341	}	512	}
342		513
343	=item $fh = $handle->fh	514	=item $fh = $handle->fh
344		515
…		…
401	sub no_delay {	572	sub no_delay {
402	$_[0]{no_delay} = $_[1];	573	$_[0]{no_delay} = $_[1];
403		574
404	eval {	575	eval {
405	local $SIG{__DIE__};	576	local $SIG{__DIE__};
406	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];	577	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1]
		578	if $_[0]{fh};
407	};	579	};
		580	}
		581
		582	=item $handle->on_starttls ($cb)
		583
		584	Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument).
		585
		586	=cut
		587
		588	sub on_starttls {
		589	$_[0]{on_starttls} = $_[1];
		590	}
		591
		592	=item $handle->on_stoptls ($cb)
		593
		594	Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).
		595
		596	=cut
		597
		598	sub on_starttls {
		599	$_[0]{on_stoptls} = $_[1];
408	}	600	}
409		601
410	#############################################################################	602	#############################################################################
411		603
412	=item $handle->timeout ($seconds)	604	=item $handle->timeout ($seconds)
…		…
425	# reset the timeout watcher, as neccessary	617	# reset the timeout watcher, as neccessary
426	# also check for time-outs	618	# also check for time-outs
427	sub _timeout {	619	sub _timeout {
428	my ($self) = @_;	620	my ($self) = @_;
429		621
430	if ($self->{timeout}) {	622	if ($self->{timeout} && $self->{fh}) {
431	my $NOW = AnyEvent->now;	623	my $NOW = AnyEvent->now;
432		624
433	# when would the timeout trigger?	625	# when would the timeout trigger?
434	my $after = $self->{_activity} + $self->{timeout} - $NOW;	626	my $after = $self->{_activity} + $self->{timeout} - $NOW;
435		627
…		…
438	$self->{_activity} = $NOW;	630	$self->{_activity} = $NOW;
439		631
440	if ($self->{on_timeout}) {	632	if ($self->{on_timeout}) {
441	$self->{on_timeout}($self);	633	$self->{on_timeout}($self);
442	} else {	634	} else {
443	$self->_error (&Errno::ETIMEDOUT);	635	$self->_error (Errno::ETIMEDOUT);
444	}	636	}
445		637
446	# callback could have changed timeout value, optimise	638	# callback could have changed timeout value, optimise
447	return unless $self->{timeout};	639	return unless $self->{timeout};
448		640
…		…
511	Scalar::Util::weaken $self;	703	Scalar::Util::weaken $self;
512		704
513	my $cb = sub {	705	my $cb = sub {
514	my $len = syswrite $self->{fh}, $self->{wbuf};	706	my $len = syswrite $self->{fh}, $self->{wbuf};
515		707
516	if ($len >= 0) {	708	if (defined $len) {
517	substr $self->{wbuf}, 0, $len, "";	709	substr $self->{wbuf}, 0, $len, "";
518		710
519	$self->{_activity} = AnyEvent->now;	711	$self->{_activity} = AnyEvent->now;
520		712
521	$self->{on_drain}($self)	713	$self->{on_drain}($self)
…		…
553	->($self, @_);	745	->($self, @_);
554	}	746	}
555		747
556	if ($self->{tls}) {	748	if ($self->{tls}) {
557	$self->{_tls_wbuf} .= $_[0];	749	$self->{_tls_wbuf} .= $_[0];
558		750	&_dotls ($self) if $self->{fh};
559	&_dotls ($self);
560	} else {	751	} else {
561	$self->{wbuf} .= $_[0];	752	$self->{wbuf} .= $_[0];
562	$self->_drain_wbuf;	753	$self->_drain_wbuf if $self->{fh};
563	}	754	}
564	}	755	}
565		756
566	=item $handle->push_write (type => @args)	757	=item $handle->push_write (type => @args)
567		758
…		…
656		847
657	pack "w/a*", Storable::nfreeze ($ref)	848	pack "w/a*", Storable::nfreeze ($ref)
658	};	849	};
659		850
660	=back	851	=back
		852
		853	=item $handle->push_shutdown
		854
		855	Sometimes you know you want to close the socket after writing your data
		856	before it was actually written. One way to do that is to replace your
		857	C<on_drain> handler by a callback that shuts down the socket (and set
		858	C<low_water_mark> to C<0>). This method is a shorthand for just that, and
		859	replaces the C<on_drain> callback with:
		860
		861	sub { shutdown $_[0]{fh}, 1 } # for push_shutdown
		862
		863	This simply shuts down the write side and signals an EOF condition to the
		864	the peer.
		865
		866	You can rely on the normal read queue and C<on_eof> handling
		867	afterwards. This is the cleanest way to close a connection.
		868
		869	=cut
		870
		871	sub push_shutdown {
		872	my ($self) = @_;
		873
		874	delete $self->{low_water_mark};
		875	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });
		876	}
661		877
662	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	878	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
663		879
664	This function (not method) lets you add your own types to C<push_write>.	880	This function (not method) lets you add your own types to C<push_write>.
665	Whenever the given C<type> is used, C<push_write> will invoke the code	881	Whenever the given C<type> is used, C<push_write> will invoke the code
…		…
759	=cut	975	=cut
760		976
761	sub _drain_rbuf {	977	sub _drain_rbuf {
762	my ($self) = @_;	978	my ($self) = @_;
763		979
		980	# avoid recursion
		981	return if exists $self->{_skip_drain_rbuf};
764	local $self->{_in_drain} = 1;	982	local $self->{_skip_drain_rbuf} = 1;
765		983
766	if (	984	if (
767	defined $self->{rbuf_max}	985	defined $self->{rbuf_max}
768	&& $self->{rbuf_max} < length $self->{rbuf}	986	&& $self->{rbuf_max} < length $self->{rbuf}
769	) {	987	) {
770	$self->_error (&Errno::ENOSPC, 1), return;	988	$self->_error (Errno::ENOSPC, 1), return;
771	}	989	}
772		990
773	while () {	991	while () {
774	# we need to use a separate tls read buffer, as we must not receive data while	992	# we need to use a separate tls read buffer, as we must not receive data while
775	# we are draining the buffer, and this can only happen with TLS.	993	# we are draining the buffer, and this can only happen with TLS.
…		…
779		997
780	if (my $cb = shift @{ $self->{_queue} }) {	998	if (my $cb = shift @{ $self->{_queue} }) {
781	unless ($cb->($self)) {	999	unless ($cb->($self)) {
782	if ($self->{_eof}) {	1000	if ($self->{_eof}) {
783	# no progress can be made (not enough data and no data forthcoming)	1001	# no progress can be made (not enough data and no data forthcoming)
784	$self->_error (&Errno::EPIPE, 1), return;	1002	$self->_error (Errno::EPIPE, 1), return;
785	}	1003	}
786		1004
787	unshift @{ $self->{_queue} }, $cb;	1005	unshift @{ $self->{_queue} }, $cb;
788	last;	1006	last;
789	}	1007	}
…		…
797	&& !@{ $self->{_queue} } # and the queue is still empty	1015	&& !@{ $self->{_queue} } # and the queue is still empty
798	&& $self->{on_read} # but we still have on_read	1016	&& $self->{on_read} # but we still have on_read
799	) {	1017	) {
800	# no further data will arrive	1018	# no further data will arrive
801	# so no progress can be made	1019	# so no progress can be made
802	$self->_error (&Errno::EPIPE, 1), return	1020	$self->_error (Errno::EPIPE, 1), return
803	if $self->{_eof};	1021	if $self->{_eof};
804		1022
805	last; # more data might arrive	1023	last; # more data might arrive
806	}	1024	}
807	} else {	1025	} else {
…		…
813		1031
814	if ($self->{_eof}) {	1032	if ($self->{_eof}) {
815	if ($self->{on_eof}) {	1033	if ($self->{on_eof}) {
816	$self->{on_eof}($self)	1034	$self->{on_eof}($self)
817	} else {	1035	} else {
818	$self->_error (0, 1);	1036	$self->_error (0, 1, "Unexpected end-of-file");
819	}	1037	}
820	}	1038	}
821		1039
822	# may need to restart read watcher	1040	# may need to restart read watcher
823	unless ($self->{_rw}) {	1041	unless ($self->{_rw}) {
…		…
836		1054
837	sub on_read {	1055	sub on_read {
838	my ($self, $cb) = @_;	1056	my ($self, $cb) = @_;
839		1057
840	$self->{on_read} = $cb;	1058	$self->{on_read} = $cb;
841	$self->_drain_rbuf if $cb && !$self->{_in_drain};	1059	$self->_drain_rbuf if $cb;
842	}	1060	}
843		1061
844	=item $handle->rbuf	1062	=item $handle->rbuf
845		1063
846	Returns the read buffer (as a modifiable lvalue).	1064	Returns the read buffer (as a modifiable lvalue).
…		…
898	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	1116	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
899	->($self, $cb, @_);	1117	->($self, $cb, @_);
900	}	1118	}
901		1119
902	push @{ $self->{_queue} }, $cb;	1120	push @{ $self->{_queue} }, $cb;
903	$self->_drain_rbuf unless $self->{_in_drain};	1121	$self->_drain_rbuf;
904	}	1122	}
905		1123
906	sub unshift_read {	1124	sub unshift_read {
907	my $self = shift;	1125	my $self = shift;
908	my $cb = pop;	1126	my $cb = pop;
…		…
914	->($self, $cb, @_);	1132	->($self, $cb, @_);
915	}	1133	}
916		1134
917		1135
918	unshift @{ $self->{_queue} }, $cb;	1136	unshift @{ $self->{_queue} }, $cb;
919	$self->_drain_rbuf unless $self->{_in_drain};	1137	$self->_drain_rbuf;
920	}	1138	}
921		1139
922	=item $handle->push_read (type => @args, $cb)	1140	=item $handle->push_read (type => @args, $cb)
923		1141
924	=item $handle->unshift_read (type => @args, $cb)	1142	=item $handle->unshift_read (type => @args, $cb)
…		…
1057	return 1;	1275	return 1;
1058	}	1276	}
1059		1277
1060	# reject	1278	# reject
1061	if ($reject && $$rbuf =~ $reject) {	1279	if ($reject && $$rbuf =~ $reject) {
1062	$self->_error (&Errno::EBADMSG);	1280	$self->_error (Errno::EBADMSG);
1063	}	1281	}
1064		1282
1065	# skip	1283	# skip
1066	if ($skip && $$rbuf =~ $skip) {	1284	if ($skip && $$rbuf =~ $skip) {
1067	$data .= substr $$rbuf, 0, $+[0], "";	1285	$data .= substr $$rbuf, 0, $+[0], "";
…		…
1083	my ($self, $cb) = @_;	1301	my ($self, $cb) = @_;
1084		1302
1085	sub {	1303	sub {
1086	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {	1304	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
1087	if ($_[0]{rbuf} =~ /[^0-9]/) {	1305	if ($_[0]{rbuf} =~ /[^0-9]/) {
1088	$self->_error (&Errno::EBADMSG);	1306	$self->_error (Errno::EBADMSG);
1089	}	1307	}
1090	return;	1308	return;
1091	}	1309	}
1092		1310
1093	my $len = $1;	1311	my $len = $1;
…		…
1096	my $string = $_[1];	1314	my $string = $_[1];
1097	$_[0]->unshift_read (chunk => 1, sub {	1315	$_[0]->unshift_read (chunk => 1, sub {
1098	if ($_[1] eq ",") {	1316	if ($_[1] eq ",") {
1099	$cb->($_[0], $string);	1317	$cb->($_[0], $string);
1100	} else {	1318	} else {
1101	$self->_error (&Errno::EBADMSG);	1319	$self->_error (Errno::EBADMSG);
1102	}	1320	}
1103	});	1321	});
1104	});	1322	});
1105		1323
1106	1	1324	1
…		…
1173	=cut	1391	=cut
1174		1392
1175	register_read_type json => sub {	1393	register_read_type json => sub {
1176	my ($self, $cb) = @_;	1394	my ($self, $cb) = @_;
1177		1395
1178	require JSON;	1396	my $json = $self->{json} \|\|=
		1397	eval { require JSON::XS; JSON::XS->new->utf8 }
		1398	\|\| do { require JSON; JSON->new->utf8 };
1179		1399
1180	my $data;	1400	my $data;
1181	my $rbuf = \$self->{rbuf};	1401	my $rbuf = \$self->{rbuf};
1182
1183	my $json = $self->{json} \|\|= JSON->new->utf8;
1184		1402
1185	sub {	1403	sub {
1186	my $ref = eval { $json->incr_parse ($self->{rbuf}) };	1404	my $ref = eval { $json->incr_parse ($self->{rbuf}) };
1187		1405
1188	if ($ref) {	1406	if ($ref) {
…		…
1196	$json->incr_skip;	1414	$json->incr_skip;
1197		1415
1198	$self->{rbuf} = $json->incr_text;	1416	$self->{rbuf} = $json->incr_text;
1199	$json->incr_text = "";	1417	$json->incr_text = "";
1200		1418
1201	$self->_error (&Errno::EBADMSG);	1419	$self->_error (Errno::EBADMSG);
1202		1420
1203	()	1421	()
1204	} else {	1422	} else {
1205	$self->{rbuf} = "";	1423	$self->{rbuf} = "";
1206		1424
…		…
1243	# read remaining chunk	1461	# read remaining chunk
1244	$_[0]->unshift_read (chunk => $len, sub {	1462	$_[0]->unshift_read (chunk => $len, sub {
1245	if (my $ref = eval { Storable::thaw ($_[1]) }) {	1463	if (my $ref = eval { Storable::thaw ($_[1]) }) {
1246	$cb->($_[0], $ref);	1464	$cb->($_[0], $ref);
1247	} else {	1465	} else {
1248	$self->_error (&Errno::EBADMSG);	1466	$self->_error (Errno::EBADMSG);
1249	}	1467	}
1250	});	1468	});
1251	}	1469	}
1252		1470
1253	1	1471	1
…		…
1317	if ($self->{tls}) {	1535	if ($self->{tls}) {
1318	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);	1536	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1319		1537
1320	&_dotls ($self);	1538	&_dotls ($self);
1321	} else {	1539	} else {
1322	$self->_drain_rbuf unless $self->{_in_drain};	1540	$self->_drain_rbuf;
1323	}	1541	}
1324		1542
1325	} elsif (defined $len) {	1543	} elsif (defined $len) {
1326	delete $self->{_rw};	1544	delete $self->{_rw};
1327	$self->{_eof} = 1;	1545	$self->{_eof} = 1;
1328	$self->_drain_rbuf unless $self->{_in_drain};	1546	$self->_drain_rbuf;
1329		1547
1330	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1548	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1331	return $self->_error ($!, 1);	1549	return $self->_error ($!, 1);
1332	}	1550	}
1333	});	1551	});
1334	}	1552	}
1335	}	1553	}
1336		1554
		1555	our $ERROR_SYSCALL;
		1556	our $ERROR_WANT_READ;
		1557
		1558	sub _tls_error {
		1559	my ($self, $err) = @_;
		1560
		1561	return $self->_error ($!, 1)
		1562	if $err == Net::SSLeay::ERROR_SYSCALL ();
		1563
		1564	my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());
		1565
		1566	# reduce error string to look less scary
		1567	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;
		1568
		1569	if ($self->{_on_starttls}) {
		1570	(delete $self->{_on_starttls})->($self, undef, $err);
		1571	&_freetls;
		1572	} else {
		1573	&_freetls;
		1574	$self->_error (Errno::EPROTO, 1, $err);
		1575	}
		1576	}
		1577
1337	# poll the write BIO and send the data if applicable	1578	# poll the write BIO and send the data if applicable
		1579	# also decode read data if possible
		1580	# this is basiclaly our TLS state machine
		1581	# more efficient implementations are possible with openssl,
		1582	# but not with the buggy and incomplete Net::SSLeay.
1338	sub _dotls {	1583	sub _dotls {
1339	my ($self) = @_;	1584	my ($self) = @_;
1340		1585
1341	my $tmp;	1586	my $tmp;
1342		1587
1343	if (length $self->{_tls_wbuf}) {	1588	if (length $self->{_tls_wbuf}) {
1344	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1589	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1345	substr $self->{_tls_wbuf}, 0, $tmp, "";	1590	substr $self->{_tls_wbuf}, 0, $tmp, "";
1346	}	1591	}
		1592
		1593	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);
		1594	return $self->_tls_error ($tmp)
		1595	if $tmp != $ERROR_WANT_READ
		1596	&& ($tmp != $ERROR_SYSCALL \|\| $!);
1347	}	1597	}
1348		1598
1349	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {	1599	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
1350	unless (length $tmp) {	1600	unless (length $tmp) {
1351	# let's treat SSL-eof as we treat normal EOF	1601	$self->{_on_starttls}
1352	delete $self->{_rw};	1602	and (delete $self->{_on_starttls})->($self, undef, "EOF during handshake"); # ???
1353	$self->{_eof} = 1;
1354	&_freetls;	1603	&_freetls;
		1604
		1605	if ($self->{on_stoptls}) {
		1606	$self->{on_stoptls}($self);
		1607	return;
		1608	} else {
		1609	# let's treat SSL-eof as we treat normal EOF
		1610	delete $self->{_rw};
		1611	$self->{_eof} = 1;
		1612	}
1355	}	1613	}
1356		1614
1357	$self->{_tls_rbuf} .= $tmp;	1615	$self->{_tls_rbuf} .= $tmp;
1358	$self->_drain_rbuf unless $self->{_in_drain};	1616	$self->_drain_rbuf;
1359	$self->{tls} or return; # tls session might have gone away in callback	1617	$self->{tls} or return; # tls session might have gone away in callback
1360	}	1618	}
1361		1619
1362	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);	1620	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1363
1364	if ($tmp != Net::SSLeay::ERROR_WANT_READ ()) {
1365	if ($tmp == Net::SSLeay::ERROR_SYSCALL ()) {
1366	return $self->_error ($!, 1);	1621	return $self->_tls_error ($tmp)
1367	} elsif ($tmp == Net::SSLeay::ERROR_SSL ()) {	1622	if $tmp != $ERROR_WANT_READ
1368	return $self->_error (&Errno::EIO, 1);	1623	&& ($tmp != $ERROR_SYSCALL \|\| $!);
1369	}
1370
1371	# all other errors are fine for our purposes
1372	}
1373		1624
1374	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1625	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1375	$self->{wbuf} .= $tmp;	1626	$self->{wbuf} .= $tmp;
1376	$self->_drain_wbuf;	1627	$self->_drain_wbuf;
1377	}	1628	}
		1629
		1630	$self->{_on_starttls}
		1631	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
		1632	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");
1378	}	1633	}
1379		1634
1380	=item $handle->starttls ($tls[, $tls_ctx])	1635	=item $handle->starttls ($tls[, $tls_ctx])
1381		1636
1382	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	1637	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
1383	object is created, you can also do that at a later time by calling	1638	object is created, you can also do that at a later time by calling
1384	C<starttls>.	1639	C<starttls>.
1385		1640
		1641	Starting TLS is currently an asynchronous operation - when you push some
		1642	write data and then call C<< ->starttls >> then TLS negotiation will start
		1643	immediately, after which the queued write data is then sent.
		1644
1386	The first argument is the same as the C<tls> constructor argument (either	1645	The first argument is the same as the C<tls> constructor argument (either
1387	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1646	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1388		1647
1389	The second argument is the optional C<Net::SSLeay::CTX> object that is	1648	The second argument is the optional C<AnyEvent::TLS> object that is used
1390	used when AnyEvent::Handle has to create its own TLS connection object.	1649	when AnyEvent::Handle has to create its own TLS connection object, or
		1650	a hash reference with C<< key => value >> pairs that will be used to
		1651	construct a new context.
1391		1652
1392	The TLS connection object will end up in C<< $handle->{tls} >> after this	1653	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS
1393	call and can be used or changed to your liking. Note that the handshake	1654	context in C<< $handle->{tls_ctx} >> after this call and can be used or
1394	might have already started when this function returns.	1655	changed to your liking. Note that the handshake might have already started
		1656	when this function returns.
1395		1657
1396	If it an error to start a TLS handshake more than once per	1658	Due to bugs in OpenSSL, it might or might not be possible to do multiple
1397	AnyEvent::Handle object (this is due to bugs in OpenSSL).	1659	handshakes on the same stream. Best do not attempt to use the stream after
		1660	stopping TLS.
1398		1661
1399	=cut	1662	=cut
		1663
		1664	our %TLS_CACHE; #TODO not yet documented, should we?
1400		1665
1401	sub starttls {	1666	sub starttls {
1402	my ($self, $ssl, $ctx) = @_;	1667	my ($self, $tls, $ctx) = @_;
		1668
		1669	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"
		1670	if $self->{tls};
		1671
		1672	$self->{tls} = $tls;
		1673	$self->{tls_ctx} = $ctx if @_ > 2;
		1674
		1675	return unless $self->{fh};
1403		1676
1404	require Net::SSLeay;	1677	require Net::SSLeay;
1405		1678
1406	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"	1679	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
		1680	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
		1681
1407	if $self->{tls};	1682	$tls = $self->{tls};
		1683	$ctx = $self->{tls_ctx};
		1684
		1685	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
		1686
		1687	if ("HASH" eq ref $ctx) {
		1688	require AnyEvent::TLS;
		1689
		1690	if ($ctx->{cache}) {
		1691	my $key = $ctx+0;
		1692	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;
		1693	} else {
		1694	$ctx = new AnyEvent::TLS %$ctx;
		1695	}
		1696	}
1408		1697
1409	if ($ssl eq "accept") {	1698	$self->{tls_ctx} = $ctx \|\| TLS_CTX ();
1410	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1699	$self->{tls} = $tls = $self->{tls_ctx}->_get_session ($tls, $self, $self->{peername});
1411	Net::SSLeay::set_accept_state ($ssl);
1412	} elsif ($ssl eq "connect") {
1413	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());
1414	Net::SSLeay::set_connect_state ($ssl);
1415	}
1416
1417	$self->{tls} = $ssl;
1418		1700
1419	# basically, this is deep magic (because SSL_read should have the same issues)	1701	# basically, this is deep magic (because SSL_read should have the same issues)
1420	# but the openssl maintainers basically said: "trust us, it just works".	1702	# but the openssl maintainers basically said: "trust us, it just works".
1421	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1703	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1422	# and mismaintained ssleay-module doesn't even offer them).	1704	# and mismaintained ssleay-module doesn't even offer them).
…		…
1426	#	1708	#
1427	# note that we do not try to keep the length constant between writes as we are required to do.	1709	# note that we do not try to keep the length constant between writes as we are required to do.
1428	# we assume that most (but not all) of this insanity only applies to non-blocking cases,	1710	# we assume that most (but not all) of this insanity only applies to non-blocking cases,
1429	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to	1711	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
1430	# have identity issues in that area.	1712	# have identity issues in that area.
1431	Net::SSLeay::CTX_set_mode ($self->{tls},	1713	# Net::SSLeay::CTX_set_mode ($ssl,
1432	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1714	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
1433	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));	1715	# \| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
		1716	Net::SSLeay::CTX_set_mode ($tls, 1\|2);
1434		1717
1435	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1718	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1436	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1719	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1437		1720
1438	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1721	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
		1722
		1723	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
		1724	if $self->{on_starttls};
1439		1725
1440	&_dotls; # need to trigger the initial handshake	1726	&_dotls; # need to trigger the initial handshake
1441	$self->start_read; # make sure we actually do read	1727	$self->start_read; # make sure we actually do read
1442	}	1728	}
1443		1729
1444	=item $handle->stoptls	1730	=item $handle->stoptls
1445		1731
1446	Shuts down the SSL connection - this makes a proper EOF handshake by	1732	Shuts down the SSL connection - this makes a proper EOF handshake by
1447	sending a close notify to the other side, but since OpenSSL doesn't	1733	sending a close notify to the other side, but since OpenSSL doesn't
1448	support non-blocking shut downs, it is not possible to re-use the stream	1734	support non-blocking shut downs, it is not guarenteed that you can re-use
1449	afterwards.	1735	the stream afterwards.
1450		1736
1451	=cut	1737	=cut
1452		1738
1453	sub stoptls {	1739	sub stoptls {
1454	my ($self) = @_;	1740	my ($self) = @_;
…		…
1456	if ($self->{tls}) {	1742	if ($self->{tls}) {
1457	Net::SSLeay::shutdown ($self->{tls});	1743	Net::SSLeay::shutdown ($self->{tls});
1458		1744
1459	&_dotls;	1745	&_dotls;
1460		1746
1461	# we don't give a shit. no, we do, but we can't. no...	1747	# # we don't give a shit. no, we do, but we can't. no...#d#
1462	# we, we... have to use openssl :/	1748	# # we, we... have to use openssl :/#d#
1463	&_freetls;	1749	# &_freetls;#d#
1464	}	1750	}
1465	}	1751	}
1466		1752
1467	sub _freetls {	1753	sub _freetls {
1468	my ($self) = @_;	1754	my ($self) = @_;
1469		1755
1470	return unless $self->{tls};	1756	return unless $self->{tls};
1471		1757
1472	Net::SSLeay::free (delete $self->{tls});	1758	$self->{tls_ctx}->_put_session (delete $self->{tls})
		1759	if ref $self->{tls};
1473		1760
1474	delete @$self{qw(_rbio _wbio _tls_wbuf)};	1761	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1475	}	1762	}
1476		1763
1477	sub DESTROY {	1764	sub DESTROY {
1478	my ($self) = @_;	1765	my ($self) = @_;
1479		1766
1480	&_freetls;	1767	&_freetls;
1481		1768
1482	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	1769	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1483		1770
1484	if ($linger && length $self->{wbuf}) {	1771	if ($linger && length $self->{wbuf} && $self->{fh}) {
1485	my $fh = delete $self->{fh};	1772	my $fh = delete $self->{fh};
1486	my $wbuf = delete $self->{wbuf};	1773	my $wbuf = delete $self->{wbuf};
1487		1774
1488	my @linger;	1775	my @linger;
1489		1776
…		…
1503	}	1790	}
1504		1791
1505	=item $handle->destroy	1792	=item $handle->destroy
1506		1793
1507	Shuts down the handle object as much as possible - this call ensures that	1794	Shuts down the handle object as much as possible - this call ensures that
1508	no further callbacks will be invoked and resources will be freed as much	1795	no further callbacks will be invoked and as many resources as possible
1509	as possible. You must not call any methods on the object afterwards.	1796	will be freed. You must not call any methods on the object afterwards.
1510		1797
1511	Normally, you can just "forget" any references to an AnyEvent::Handle	1798	Normally, you can just "forget" any references to an AnyEvent::Handle
1512	object and it will simply shut down. This works in fatal error and EOF	1799	object and it will simply shut down. This works in fatal error and EOF
1513	callbacks, as well as code outside. It does I<NOT> work in a read or write	1800	callbacks, as well as code outside. It does I<NOT> work in a read or write
1514	callback, so when you want to destroy the AnyEvent::Handle object from	1801	callback, so when you want to destroy the AnyEvent::Handle object from
1515	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in	1802	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
1516	that case.	1803	that case.
1517		1804
		1805	Destroying the handle object in this way has the advantage that callbacks
		1806	will be removed as well, so if those are the only reference holders (as
		1807	is common), then one doesn't need to do anything special to break any
		1808	reference cycles.
		1809
1518	The handle might still linger in the background and write out remaining	1810	The handle might still linger in the background and write out remaining
1519	data, as specified by the C<linger> option, however.	1811	data, as specified by the C<linger> option, however.
1520		1812
1521	=cut	1813	=cut
1522		1814
…		…
1527	%$self = ();	1819	%$self = ();
1528	}	1820	}
1529		1821
1530	=item AnyEvent::Handle::TLS_CTX	1822	=item AnyEvent::Handle::TLS_CTX
1531		1823
1532	This function creates and returns the Net::SSLeay::CTX object used by	1824	This function creates and returns the AnyEvent::TLS object used by default
1533	default for TLS mode.	1825	for TLS mode.
1534		1826
1535	The context is created like this:	1827	The context is created by calling L<AnyEvent::TLS> without any arguments.
1536
1537	Net::SSLeay::load_error_strings;
1538	Net::SSLeay::SSLeay_add_ssl_algorithms;
1539	Net::SSLeay::randomize;
1540
1541	my $CTX = Net::SSLeay::CTX_new;
1542
1543	Net::SSLeay::CTX_set_options $CTX, Net::SSLeay::OP_ALL
1544		1828
1545	=cut	1829	=cut
1546		1830
1547	our $TLS_CTX;	1831	our $TLS_CTX;
1548		1832
1549	sub TLS_CTX() {	1833	sub TLS_CTX() {
1550	$TLS_CTX \|\| do {	1834	$TLS_CTX \|\|= do {
1551	require Net::SSLeay;	1835	require AnyEvent::TLS;
1552		1836
1553	Net::SSLeay::load_error_strings ();	1837	new AnyEvent::TLS
1554	Net::SSLeay::SSLeay_add_ssl_algorithms ();
1555	Net::SSLeay::randomize ();
1556
1557	$TLS_CTX = Net::SSLeay::CTX_new ();
1558
1559	Net::SSLeay::CTX_set_options ($TLS_CTX, Net::SSLeay::OP_ALL ());
1560
1561	$TLS_CTX
1562	}	1838	}
1563	}	1839	}
1564		1840
1565	=back	1841	=back
1566		1842
…		…
1605		1881
1606	$handle->on_read (sub { });	1882	$handle->on_read (sub { });
1607	$handle->on_eof (undef);	1883	$handle->on_eof (undef);
1608	$handle->on_error (sub {	1884	$handle->on_error (sub {
1609	my $data = delete $_[0]{rbuf};	1885	my $data = delete $_[0]{rbuf};
1610	undef $handle;
1611	});	1886	});
1612		1887
1613	The reason to use C<on_error> is that TCP connections, due to latencies	1888	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	1889	and packets loss, might get closed quite violently with an error, when in
1615	fact, all data has been received.	1890	fact, all data has been received.
…		…
1631	$handle->on_drain (sub {	1906	$handle->on_drain (sub {
1632	warn "all data submitted to the kernel\n";	1907	warn "all data submitted to the kernel\n";
1633	undef $handle;	1908	undef $handle;
1634	});	1909	});
1635		1910
		1911	If you just want to queue some data and then signal EOF to the other side,
		1912	consider using C<< ->push_shutdown >> instead.
		1913
		1914	=item I want to contact a TLS/SSL server, I don't care about security.
		1915
		1916	If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS,
		1917	simply connect to it and then create the AnyEvent::Handle with the C<tls>
		1918	parameter:
		1919
		1920	tcp_connect $host, $port, sub {
		1921	my ($fh) = @_;
		1922
		1923	my $handle = new AnyEvent::Handle
		1924	fh => $fh,
		1925	tls => "connect",
		1926	on_error => sub { ... };
		1927
		1928	$handle->push_write (...);
		1929	};
		1930
		1931	=item I want to contact a TLS/SSL server, I do care about security.
		1932
		1933	Then you should additionally enable certificate verification, including
		1934	peername verification, if the protocol you use supports it (see
		1935	L<AnyEvent::TLS>, C<verify_peername>).
		1936
		1937	E.g. for HTTPS:
		1938
		1939	tcp_connect $host, $port, sub {
		1940	my ($fh) = @_;
		1941
		1942	my $handle = new AnyEvent::Handle
		1943	fh => $fh,
		1944	peername => $host,
		1945	tls => "connect",
		1946	tls_ctx => { verify => 1, verify_peername => "https" },
		1947	...
		1948
		1949	Note that you must specify the hostname you connected to (or whatever
		1950	"peername" the protocol needs) as the C<peername> argument, otherwise no
		1951	peername verification will be done.
		1952
		1953	The above will use the system-dependent default set of trusted CA
		1954	certificates. If you want to check against a specific CA, add the
		1955	C<ca_file> (or C<ca_cert>) arguments to C<tls_ctx>:
		1956
		1957	tls_ctx => {
		1958	verify => 1,
		1959	verify_peername => "https",
		1960	ca_file => "my-ca-cert.pem",
		1961	},
		1962
		1963	=item I want to create a TLS/SSL server, how do I do that?
		1964
		1965	Well, you first need to get a server certificate and key. You have
		1966	three options: a) ask a CA (buy one, use cacert.org etc.) b) create a
		1967	self-signed certificate (cheap. check the search engine of your choice,
		1968	there are many tutorials on the net) or c) make your own CA (tinyca2 is a
		1969	nice program for that purpose).
		1970
		1971	Then create a file with your private key (in PEM format, see
		1972	L<AnyEvent::TLS>), followed by the certificate (also in PEM format). The
		1973	file should then look like this:
		1974
		1975	-----BEGIN RSA PRIVATE KEY-----
		1976	...header data
		1977	... lots of base64'y-stuff
		1978	-----END RSA PRIVATE KEY-----
		1979
		1980	-----BEGIN CERTIFICATE-----
		1981	... lots of base64'y-stuff
		1982	-----END CERTIFICATE-----
		1983
		1984	The important bits are the "PRIVATE KEY" and "CERTIFICATE" parts. Then
		1985	specify this file as C<cert_file>:
		1986
		1987	tcp_server undef, $port, sub {
		1988	my ($fh) = @_;
		1989
		1990	my $handle = new AnyEvent::Handle
		1991	fh => $fh,
		1992	tls => "accept",
		1993	tls_ctx => { cert_file => "my-server-keycert.pem" },
		1994	...
		1995
		1996	When you have intermediate CA certificates that your clients might not
		1997	know about, just append them to the C<cert_file>.
		1998
1636	=back	1999	=back
1637		2000
1638		2001
1639	=head1 SUBCLASSING AnyEvent::Handle	2002	=head1 SUBCLASSING AnyEvent::Handle
1640		2003

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.120 by root, Fri Mar 27 08:33:41 2009 UTC vs. Revision 1.160 by root, Fri Jul 24 22:47:04 2009 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.120 by root, Fri Mar 27 08:33:41 2009 UTC vs.
Revision 1.160 by root, Fri Jul 24 22:47:04 2009 UTC