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

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

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.112 by root, Wed Jan 21 06:01:35 2009 UTC vs. Revision 1.159 by root, Fri Jul 24 12:35:58 2009 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.112 by root, Wed Jan 21 06:01:35 2009 UTC vs.
Revision 1.159 by root, Fri Jul 24 12:35:58 2009 UTC