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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.141 by root, Mon Jul 6 01:03:09 2009 UTC vs.
Revision 1.174 by root, Sat Aug 8 20:52:06 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.452;	16	our $VERSION = 4.91;
20		17
21	=head1 SYNOPSIS	18	=head1 SYNOPSIS
22		19
23	use AnyEvent;	20	use AnyEvent;
24	use AnyEvent::Handle;	21	use AnyEvent::Handle;
25		22
26	my $cv = AnyEvent->condvar;	23	my $cv = AnyEvent->condvar;
27		24
28	my $handle =	25	my $hdl; $hdl = new AnyEvent::Handle
29	AnyEvent::Handle->new (
30	fh => \*STDIN,	26	fh => \*STDIN,
31	on_eof => sub {	27	on_error => sub {
		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
69		69
70	The constructor supports these arguments (all as C<< key => value >> pairs).	70	The constructor supports these arguments (all as C<< key => value >> pairs).
71		71
72	=over 4	72	=over 4
73		73
74	=item fh => $filehandle [MANDATORY]	74	=item fh => $filehandle [C<fh> or C<connect> MANDATORY]
75		75
76	The filehandle this L<AnyEvent::Handle> object will operate on.	76	The filehandle this L<AnyEvent::Handle> object will operate on.
77
78	NOTE: The filehandle will be set to non-blocking mode (using	77	NOTE: The filehandle will be set to non-blocking mode (using
79	C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in	78	C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in
80	that mode.	79	that mode.
81		80
		81	=item connect => [$host, $service] [C<fh> or C<connect> MANDATORY]
		82
		83	Try to connect to the specified host and service (port), using
		84	C<AnyEvent::Socket::tcp_connect>. The C<$host> additionally becomes the
		85	default C<peername>.
		86
		87	You have to specify either this parameter, or C<fh>, above.
		88
		89	It is possible to push requests on the read and write queues, and modify
		90	properties of the stream, even while AnyEvent::Handle is connecting.
		91
		92	When this parameter is specified, then the C<on_prepare>,
		93	C<on_connect_error> and C<on_connect> callbacks will be called under the
		94	appropriate circumstances:
		95
		96	=over 4
		97
		98	=item on_prepare => $cb->($handle)
		99
		100	This (rarely used) callback is called before a new connection is
		101	attempted, but after the file handle has been created. It could be used to
		102	prepare the file handle with parameters required for the actual connect
		103	(as opposed to settings that can be changed when the connection is already
		104	established).
		105
		106	The return value of this callback should be the connect timeout value in
		107	seconds (or C<0>, or C<undef>, or the empty list, to indicate the default
		108	timeout is to be used).
		109
		110	=item on_connect => $cb->($handle, $host, $port, $retry->())
		111
		112	This callback is called when a connection has been successfully established.
		113
		114	The actual numeric host and port (the socket peername) are passed as
		115	parameters, together with a retry callback.
		116
		117	When, for some reason, the handle is not acceptable, then calling
		118	C<$retry> will continue with the next conenction target (in case of
		119	multi-homed hosts or SRV records there can be multiple connection
		120	endpoints). When it is called then the read and write queues, eof status,
		121	tls status and similar properties of the handle are being reset.
		122
		123	In most cases, ignoring the C<$retry> parameter is the way to go.
		124
		125	=item on_connect_error => $cb->($handle, $message)
		126
		127	This callback is called when the conenction could not be
		128	established. C<$!> will contain the relevant error code, and C<$message> a
		129	message describing it (usually the same as C<"$!">).
		130
		131	If this callback isn't specified, then C<on_error> will be called with a
		132	fatal error instead.
		133
		134	=back
		135
		136	=item on_error => $cb->($handle, $fatal, $message)
		137
		138	This is the error callback, which is called when, well, some error
		139	occured, such as not being able to resolve the hostname, failure to
		140	connect or a read error.
		141
		142	Some errors are fatal (which is indicated by C<$fatal> being true). On
		143	fatal errors the handle object will be destroyed (by a call to C<< ->
		144	destroy >>) after invoking the error callback (which means you are free to
		145	examine the handle object). Examples of fatal errors are an EOF condition
		146	with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors. In
		147	cases where the other side can close the connection at their will it is
		148	often easiest to not report C<EPIPE> errors in this callback.
		149
		150	AnyEvent::Handle tries to find an appropriate error code for you to check
		151	against, but in some cases (TLS errors), this does not work well. It is
		152	recommended to always output the C<$message> argument in human-readable
		153	error messages (it's usually the same as C<"$!">).
		154
		155	Non-fatal errors can be retried by simply returning, but it is recommended
		156	to simply ignore this parameter and instead abondon the handle object
		157	when this callback is invoked. Examples of non-fatal errors are timeouts
		158	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
		159
		160	On callback entrance, the value of C<$!> contains the operating system
		161	error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
		162	C<EPROTO>).
		163
		164	While not mandatory, it is I<highly> recommended to set this callback, as
		165	you will not be notified of errors otherwise. The default simply calls
		166	C<croak>.
		167
		168	=item on_read => $cb->($handle)
		169
		170	This sets the default read callback, which is called when data arrives
		171	and no read request is in the queue (unlike read queue callbacks, this
		172	callback will only be called when at least one octet of data is in the
		173	read buffer).
		174
		175	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
		176	method or access the C<< $handle->{rbuf} >> member directly. Note that you
		177	must not enlarge or modify the read buffer, you can only remove data at
		178	the beginning from it.
		179
		180	When an EOF condition is detected then AnyEvent::Handle will first try to
		181	feed all the remaining data to the queued callbacks and C<on_read> before
		182	calling the C<on_eof> callback. If no progress can be made, then a fatal
		183	error will be raised (with C<$!> set to C<EPIPE>).
		184
		185	Note that, unlike requests in the read queue, an C<on_read> callback
		186	doesn't mean you I<require> some data: if there is an EOF and there
		187	are outstanding read requests then an error will be flagged. With an
		188	C<on_read> callback, the C<on_eof> callback will be invoked.
		189
82	=item on_eof => $cb->($handle)	190	=item on_eof => $cb->($handle)
83		191
84	Set the callback to be called when an end-of-file condition is detected,	192	Set the callback to be called when an end-of-file condition is detected,
85	i.e. in the case of a socket, when the other side has closed the	193	i.e. in the case of a socket, when the other side has closed the
86	connection cleanly.	194	connection cleanly, and there are no outstanding read requests in the
		195	queue (if there are read requests, then an EOF counts as an unexpected
		196	connection close and will be flagged as an error).
87		197
88	For sockets, this just means that the other side has stopped sending data,	198	For sockets, this just means that the other side has stopped sending data,
89	you can still try to write data, and, in fact, one can return from the EOF	199	you can still try to write data, and, in fact, one can return from the EOF
90	callback and continue writing data, as only the read part has been shut	200	callback and continue writing data, as only the read part has been shut
91	down.	201	down.
92		202
93	While not mandatory, it is I<highly> recommended to set an EOF callback,
94	otherwise you might end up with a closed socket while you are still
95	waiting for data.
96
97	If an EOF condition has been detected but no C<on_eof> callback has been	203	If an EOF condition has been detected but no C<on_eof> callback has been
98	set, then a fatal error will be raised with C<$!> set to <0>.	204	set, then a fatal error will be raised with C<$!> set to <0>.
99
100	=item on_error => $cb->($handle, $fatal, $message)
101
102	This is the error callback, which is called when, well, some error
103	occured, such as not being able to resolve the hostname, failure to
104	connect or a read error.
105
106	Some errors are fatal (which is indicated by C<$fatal> being true). On
107	fatal errors the handle object will be shut down and will not be usable
108	(but you are free to look at the current C<< ->rbuf >>). Examples of fatal
109	errors are an EOF condition with active (but unsatisifable) read watchers
110	(C<EPIPE>) or I/O errors.
111
112	AnyEvent::Handle tries to find an appropriate error code for you to check
113	against, but in some cases (TLS errors), this does not work well. It is
114	recommended to always output the C<$message> argument in human-readable
115	error messages (it's usually the same as C<"$!">).
116
117	Non-fatal errors can be retried by simply returning, but it is recommended
118	to simply ignore this parameter and instead abondon the handle object
119	when this callback is invoked. Examples of non-fatal errors are timeouts
120	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
121
122	On callback entrance, the value of C<$!> contains the operating system
123	error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
124	C<EPROTO>).
125
126	While not mandatory, it is I<highly> recommended to set this callback, as
127	you will not be notified of errors otherwise. The default simply calls
128	C<croak>.
129
130	=item on_read => $cb->($handle)
131
132	This sets the default read callback, which is called when data arrives
133	and no read request is in the queue (unlike read queue callbacks, this
134	callback will only be called when at least one octet of data is in the
135	read buffer).
136
137	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
138	method or access the C<< $handle->{rbuf} >> member directly. Note that you
139	must not enlarge or modify the read buffer, you can only remove data at
140	the beginning from it.
141
142	When an EOF condition is detected then AnyEvent::Handle will first try to
143	feed all the remaining data to the queued callbacks and C<on_read> before
144	calling the C<on_eof> callback. If no progress can be made, then a fatal
145	error will be raised (with C<$!> set to C<EPIPE>).
146		205
147	=item on_drain => $cb->($handle)	206	=item on_drain => $cb->($handle)
148		207
149	This sets the callback that is called when the write buffer becomes empty	208	This sets the callback that is called when the write buffer becomes empty
150	(or when the callback is set and the buffer is empty already).	209	(or when the callback is set and the buffer is empty already).
…		…
249		308
250	A string used to identify the remote site - usually the DNS hostname	309	A string used to identify the remote site - usually the DNS hostname
251	(I<not> IDN!) used to create the connection, rarely the IP address.	310	(I<not> IDN!) used to create the connection, rarely the IP address.
252		311
253	Apart from being useful in error messages, this string is also used in TLS	312	Apart from being useful in error messages, this string is also used in TLS
254	peername verification (see C<verify_peername> in L<AnyEvent::TLS>).	313	peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This
		314	verification will be skipped when C<peername> is not specified or
		315	C<undef>.
255		316
256	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	317	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
257		318
258	When this parameter is given, it enables TLS (SSL) mode, that means	319	When this parameter is given, it enables TLS (SSL) mode, that means
259	AnyEvent will start a TLS handshake as soon as the conenction has been	320	AnyEvent will start a TLS handshake as soon as the conenction has been
…		…
296		357
297	Instead of an object, you can also specify a hash reference with C<< key	358	Instead of an object, you can also specify a hash reference with C<< key
298	=> value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a	359	=> value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a
299	new TLS context object.	360	new TLS context object.
300		361
		362	=item on_starttls => $cb->($handle, $success[, $error_message])
		363
		364	This callback will be invoked when the TLS/SSL handshake has finished. If
		365	C<$success> is true, then the TLS handshake succeeded, otherwise it failed
		366	(C<on_stoptls> will not be called in this case).
		367
		368	The session in C<< $handle->{tls} >> can still be examined in this
		369	callback, even when the handshake was not successful.
		370
		371	TLS handshake failures will not cause C<on_error> to be invoked when this
		372	callback is in effect, instead, the error message will be passed to C<on_starttls>.
		373
		374	Without this callback, handshake failures lead to C<on_error> being
		375	called, as normal.
		376
		377	Note that you cannot call C<starttls> right again in this callback. If you
		378	need to do that, start an zero-second timer instead whose callback can
		379	then call C<< ->starttls >> again.
		380
		381	=item on_stoptls => $cb->($handle)
		382
		383	When a SSLv3/TLS shutdown/close notify/EOF is detected and this callback is
		384	set, then it will be invoked after freeing the TLS session. If it is not,
		385	then a TLS shutdown condition will be treated like a normal EOF condition
		386	on the handle.
		387
		388	The session in C<< $handle->{tls} >> can still be examined in this
		389	callback.
		390
		391	This callback will only be called on TLS shutdowns, not when the
		392	underlying handle signals EOF.
		393
301	=item json => JSON or JSON::XS object	394	=item json => JSON or JSON::XS object
302		395
303	This is the json coder object used by the C<json> read and write types.	396	This is the json coder object used by the C<json> read and write types.
304		397
305	If you don't supply it, then AnyEvent::Handle will create and use a	398	If you don't supply it, then AnyEvent::Handle will create and use a
…		…
315		408
316	sub new {	409	sub new {
317	my $class = shift;	410	my $class = shift;
318	my $self = bless { @_ }, $class;	411	my $self = bless { @_ }, $class;
319		412
320	$self->{fh} or Carp::croak "mandatory argument fh is missing";	413	if ($self->{fh}) {
		414	$self->_start;
		415	return unless $self->{fh}; # could be gone by now
		416
		417	} elsif ($self->{connect}) {
		418	require AnyEvent::Socket;
		419
		420	$self->{peername} = $self->{connect}[0]
		421	unless exists $self->{peername};
		422
		423	$self->{_skip_drain_rbuf} = 1;
		424
		425	{
		426	Scalar::Util::weaken (my $self = $self);
		427
		428	$self->{_connect} =
		429	AnyEvent::Socket::tcp_connect (
		430	$self->{connect}[0],
		431	$self->{connect}[1],
		432	sub {
		433	my ($fh, $host, $port, $retry) = @_;
		434
		435	if ($fh) {
		436	$self->{fh} = $fh;
		437
		438	delete $self->{_skip_drain_rbuf};
		439	$self->_start;
		440
		441	$self->{on_connect}
		442	and $self->{on_connect}($self, $host, $port, sub {
		443	delete @$self{qw(fh _tw _ww _rw _eof _queue rbuf _wbuf tls _tls_rbuf _tls_wbuf)};
		444	$self->{_skip_drain_rbuf} = 1;
		445	&$retry;
		446	});
		447
		448	} else {
		449	if ($self->{on_connect_error}) {
		450	$self->{on_connect_error}($self, "$!");
		451	$self->destroy;
		452	} else {
		453	$self->_error ($!, 1);
		454	}
		455	}
		456	},
		457	sub {
		458	local $self->{fh} = $_[0];
		459
		460	$self->{on_prepare}
		461	? $self->{on_prepare}->($self)
		462	: ()
		463	}
		464	);
		465	}
		466
		467	} else {
		468	Carp::croak "AnyEvent::Handle: either an existing fh or the connect parameter must be specified";
		469	}
		470
		471	$self
		472	}
		473
		474	sub _start {
		475	my ($self) = @_;
321		476
322	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	477	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
323		478
324	$self->{_activity} = AnyEvent->now;	479	$self->{_activity} = AnyEvent->now;
325	$self->_timeout;	480	$self->_timeout;
…		…
327	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};	482	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
328		483
329	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})	484	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
330	if $self->{tls};	485	if $self->{tls};
331		486
332	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};	487	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
333		488
334	$self->start_read	489	$self->start_read
335	if $self->{on_read};	490	if $self->{on_read} \|\| @{ $self->{_queue} };
336		491
337	$self->{fh} && $self	492	$self->_drain_wbuf;
338	}	493	}
339		494
340	sub _shutdown {	495	#sub _shutdown {
341	my ($self) = @_;	496	# my ($self) = @_;
342		497	#
343	delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)};	498	# delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)};
344	$self->{_eof} = 1; # tell starttls et. al to stop trying	499	# $self->{_eof} = 1; # tell starttls et. al to stop trying
345		500	#
346	&_freetls;	501	# &_freetls;
347	}	502	#}
348		503
349	sub _error {	504	sub _error {
350	my ($self, $errno, $fatal, $message) = @_;	505	my ($self, $errno, $fatal, $message) = @_;
351		506
352	$self->_shutdown
353	if $fatal;
354
355	$! = $errno;	507	$! = $errno;
356	$message \|\|= "$!";	508	$message \|\|= "$!";
357		509
358	if ($self->{on_error}) {	510	if ($self->{on_error}) {
359	$self->{on_error}($self, $fatal, $message);	511	$self->{on_error}($self, $fatal, $message);
		512	$self->destroy if $fatal;
360	} elsif ($self->{fh}) {	513	} elsif ($self->{fh}) {
		514	$self->destroy;
361	Carp::croak "AnyEvent::Handle uncaught error: $message";	515	Carp::croak "AnyEvent::Handle uncaught error: $message";
362	}	516	}
363	}	517	}
364		518
365	=item $fh = $handle->fh	519	=item $fh = $handle->fh
…		…
423	sub no_delay {	577	sub no_delay {
424	$_[0]{no_delay} = $_[1];	578	$_[0]{no_delay} = $_[1];
425		579
426	eval {	580	eval {
427	local $SIG{__DIE__};	581	local $SIG{__DIE__};
428	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];	582	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1]
		583	if $_[0]{fh};
429	};	584	};
		585	}
		586
		587	=item $handle->on_starttls ($cb)
		588
		589	Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument).
		590
		591	=cut
		592
		593	sub on_starttls {
		594	$_[0]{on_starttls} = $_[1];
		595	}
		596
		597	=item $handle->on_stoptls ($cb)
		598
		599	Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).
		600
		601	=cut
		602
		603	sub on_starttls {
		604	$_[0]{on_stoptls} = $_[1];
		605	}
		606
		607	=item $handle->rbuf_max ($max_octets)
		608
		609	Configures the C<rbuf_max> setting (C<undef> disables it).
		610
		611	=cut
		612
		613	sub rbuf_max {
		614	$_[0]{rbuf_max} = $_[1];
430	}	615	}
431		616
432	#############################################################################	617	#############################################################################
433		618
434	=item $handle->timeout ($seconds)	619	=item $handle->timeout ($seconds)
…		…
439		624
440	sub timeout {	625	sub timeout {
441	my ($self, $timeout) = @_;	626	my ($self, $timeout) = @_;
442		627
443	$self->{timeout} = $timeout;	628	$self->{timeout} = $timeout;
		629	delete $self->{_tw};
444	$self->_timeout;	630	$self->_timeout;
445	}	631	}
446		632
447	# reset the timeout watcher, as neccessary	633	# reset the timeout watcher, as neccessary
448	# also check for time-outs	634	# also check for time-outs
449	sub _timeout {	635	sub _timeout {
450	my ($self) = @_;	636	my ($self) = @_;
451		637
452	if ($self->{timeout}) {	638	if ($self->{timeout} && $self->{fh}) {
453	my $NOW = AnyEvent->now;	639	my $NOW = AnyEvent->now;
454		640
455	# when would the timeout trigger?	641	# when would the timeout trigger?
456	my $after = $self->{_activity} + $self->{timeout} - $NOW;	642	my $after = $self->{_activity} + $self->{timeout} - $NOW;
457		643
…		…
460	$self->{_activity} = $NOW;	646	$self->{_activity} = $NOW;
461		647
462	if ($self->{on_timeout}) {	648	if ($self->{on_timeout}) {
463	$self->{on_timeout}($self);	649	$self->{on_timeout}($self);
464	} else {	650	} else {
465	$self->_error (&Errno::ETIMEDOUT);	651	$self->_error (Errno::ETIMEDOUT);
466	}	652	}
467		653
468	# callback could have changed timeout value, optimise	654	# callback could have changed timeout value, optimise
469	return unless $self->{timeout};	655	return unless $self->{timeout};
470		656
…		…
533	Scalar::Util::weaken $self;	719	Scalar::Util::weaken $self;
534		720
535	my $cb = sub {	721	my $cb = sub {
536	my $len = syswrite $self->{fh}, $self->{wbuf};	722	my $len = syswrite $self->{fh}, $self->{wbuf};
537		723
538	if ($len >= 0) {	724	if (defined $len) {
539	substr $self->{wbuf}, 0, $len, "";	725	substr $self->{wbuf}, 0, $len, "";
540		726
541	$self->{_activity} = AnyEvent->now;	727	$self->{_activity} = AnyEvent->now;
542		728
543	$self->{on_drain}($self)	729	$self->{on_drain}($self)
…		…
575	->($self, @_);	761	->($self, @_);
576	}	762	}
577		763
578	if ($self->{tls}) {	764	if ($self->{tls}) {
579	$self->{_tls_wbuf} .= $_[0];	765	$self->{_tls_wbuf} .= $_[0];
580		766	&_dotls ($self) if $self->{fh};
581	&_dotls ($self);
582	} else {	767	} else {
583	$self->{wbuf} .= $_[0];	768	$self->{wbuf} .= $_[0];
584	$self->_drain_wbuf;	769	$self->_drain_wbuf if $self->{fh};
585	}	770	}
586	}	771	}
587		772
588	=item $handle->push_write (type => @args)	773	=item $handle->push_write (type => @args)
589		774
…		…
683		868
684	=item $handle->push_shutdown	869	=item $handle->push_shutdown
685		870
686	Sometimes you know you want to close the socket after writing your data	871	Sometimes you know you want to close the socket after writing your data
687	before it was actually written. One way to do that is to replace your	872	before it was actually written. One way to do that is to replace your
688	C<on_drain> handler by a callback that shuts down the socket. This method	873	C<on_drain> handler by a callback that shuts down the socket (and set
689	is a shorthand for just that, and replaces the C<on_drain> callback with:	874	C<low_water_mark> to C<0>). This method is a shorthand for just that, and
		875	replaces the C<on_drain> callback with:
690		876
691	sub { shutdown $_[0]{fh}, 1 } # for push_shutdown	877	sub { shutdown $_[0]{fh}, 1 } # for push_shutdown
692		878
693	This simply shuts down the write side and signals an EOF condition to the	879	This simply shuts down the write side and signals an EOF condition to the
694	the peer.	880	the peer.
…		…
697	afterwards. This is the cleanest way to close a connection.	883	afterwards. This is the cleanest way to close a connection.
698		884
699	=cut	885	=cut
700		886
701	sub push_shutdown {	887	sub push_shutdown {
		888	my ($self) = @_;
		889
		890	delete $self->{low_water_mark};
702	$_[0]->{on_drain} = sub { shutdown $_[0]{fh}, 1 };	891	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });
703	}	892	}
704		893
705	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	894	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
706		895
707	This function (not method) lets you add your own types to C<push_write>.	896	This function (not method) lets you add your own types to C<push_write>.
…		…
802	=cut	991	=cut
803		992
804	sub _drain_rbuf {	993	sub _drain_rbuf {
805	my ($self) = @_;	994	my ($self) = @_;
806		995
		996	# avoid recursion
		997	return if $self->{_skip_drain_rbuf};
807	local $self->{_in_drain} = 1;	998	local $self->{_skip_drain_rbuf} = 1;
808
809	if (
810	defined $self->{rbuf_max}
811	&& $self->{rbuf_max} < length $self->{rbuf}
812	) {
813	$self->_error (&Errno::ENOSPC, 1), return;
814	}
815		999
816	while () {	1000	while () {
817	# we need to use a separate tls read buffer, as we must not receive data while	1001	# we need to use a separate tls read buffer, as we must not receive data while
818	# we are draining the buffer, and this can only happen with TLS.	1002	# we are draining the buffer, and this can only happen with TLS.
819	$self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf};	1003	$self->{rbuf} .= delete $self->{_tls_rbuf}
		1004	if exists $self->{_tls_rbuf};
820		1005
821	my $len = length $self->{rbuf};	1006	my $len = length $self->{rbuf};
822		1007
823	if (my $cb = shift @{ $self->{_queue} }) {	1008	if (my $cb = shift @{ $self->{_queue} }) {
824	unless ($cb->($self)) {	1009	unless ($cb->($self)) {
825	if ($self->{_eof}) {	1010	# no progress can be made
826	# no progress can be made (not enough data and no data forthcoming)	1011	# (not enough data and no data forthcoming)
827	$self->_error (&Errno::EPIPE, 1), return;	1012	$self->_error (Errno::EPIPE, 1), return
828	}	1013	if $self->{_eof};
829		1014
830	unshift @{ $self->{_queue} }, $cb;	1015	unshift @{ $self->{_queue} }, $cb;
831	last;	1016	last;
832	}	1017	}
833	} elsif ($self->{on_read}) {	1018	} elsif ($self->{on_read}) {
…		…
840	&& !@{ $self->{_queue} } # and the queue is still empty	1025	&& !@{ $self->{_queue} } # and the queue is still empty
841	&& $self->{on_read} # but we still have on_read	1026	&& $self->{on_read} # but we still have on_read
842	) {	1027	) {
843	# no further data will arrive	1028	# no further data will arrive
844	# so no progress can be made	1029	# so no progress can be made
845	$self->_error (&Errno::EPIPE, 1), return	1030	$self->_error (Errno::EPIPE, 1), return
846	if $self->{_eof};	1031	if $self->{_eof};
847		1032
848	last; # more data might arrive	1033	last; # more data might arrive
849	}	1034	}
850	} else {	1035	} else {
…		…
853	last;	1038	last;
854	}	1039	}
855	}	1040	}
856		1041
857	if ($self->{_eof}) {	1042	if ($self->{_eof}) {
858	if ($self->{on_eof}) {	1043	$self->{on_eof}
859	$self->{on_eof}($self)	1044	? $self->{on_eof}($self)
860	} else {
861	$self->_error (0, 1, "Unexpected end-of-file");	1045	: $self->_error (0, 1, "Unexpected end-of-file");
862	}	1046
		1047	return;
		1048	}
		1049
		1050	if (
		1051	defined $self->{rbuf_max}
		1052	&& $self->{rbuf_max} < length $self->{rbuf}
		1053	) {
		1054	$self->_error (Errno::ENOSPC, 1), return;
863	}	1055	}
864		1056
865	# may need to restart read watcher	1057	# may need to restart read watcher
866	unless ($self->{_rw}) {	1058	unless ($self->{_rw}) {
867	$self->start_read	1059	$self->start_read
…		…
879		1071
880	sub on_read {	1072	sub on_read {
881	my ($self, $cb) = @_;	1073	my ($self, $cb) = @_;
882		1074
883	$self->{on_read} = $cb;	1075	$self->{on_read} = $cb;
884	$self->_drain_rbuf if $cb && !$self->{_in_drain};	1076	$self->_drain_rbuf if $cb;
885	}	1077	}
886		1078
887	=item $handle->rbuf	1079	=item $handle->rbuf
888		1080
889	Returns the read buffer (as a modifiable lvalue).	1081	Returns the read buffer (as a modifiable lvalue).
…		…
941	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	1133	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
942	->($self, $cb, @_);	1134	->($self, $cb, @_);
943	}	1135	}
944		1136
945	push @{ $self->{_queue} }, $cb;	1137	push @{ $self->{_queue} }, $cb;
946	$self->_drain_rbuf unless $self->{_in_drain};	1138	$self->_drain_rbuf;
947	}	1139	}
948		1140
949	sub unshift_read {	1141	sub unshift_read {
950	my $self = shift;	1142	my $self = shift;
951	my $cb = pop;	1143	my $cb = pop;
…		…
957	->($self, $cb, @_);	1149	->($self, $cb, @_);
958	}	1150	}
959		1151
960		1152
961	unshift @{ $self->{_queue} }, $cb;	1153	unshift @{ $self->{_queue} }, $cb;
962	$self->_drain_rbuf unless $self->{_in_drain};	1154	$self->_drain_rbuf;
963	}	1155	}
964		1156
965	=item $handle->push_read (type => @args, $cb)	1157	=item $handle->push_read (type => @args, $cb)
966		1158
967	=item $handle->unshift_read (type => @args, $cb)	1159	=item $handle->unshift_read (type => @args, $cb)
…		…
1100	return 1;	1292	return 1;
1101	}	1293	}
1102		1294
1103	# reject	1295	# reject
1104	if ($reject && $$rbuf =~ $reject) {	1296	if ($reject && $$rbuf =~ $reject) {
1105	$self->_error (&Errno::EBADMSG);	1297	$self->_error (Errno::EBADMSG);
1106	}	1298	}
1107		1299
1108	# skip	1300	# skip
1109	if ($skip && $$rbuf =~ $skip) {	1301	if ($skip && $$rbuf =~ $skip) {
1110	$data .= substr $$rbuf, 0, $+[0], "";	1302	$data .= substr $$rbuf, 0, $+[0], "";
…		…
1126	my ($self, $cb) = @_;	1318	my ($self, $cb) = @_;
1127		1319
1128	sub {	1320	sub {
1129	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {	1321	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
1130	if ($_[0]{rbuf} =~ /[^0-9]/) {	1322	if ($_[0]{rbuf} =~ /[^0-9]/) {
1131	$self->_error (&Errno::EBADMSG);	1323	$self->_error (Errno::EBADMSG);
1132	}	1324	}
1133	return;	1325	return;
1134	}	1326	}
1135		1327
1136	my $len = $1;	1328	my $len = $1;
…		…
1139	my $string = $_[1];	1331	my $string = $_[1];
1140	$_[0]->unshift_read (chunk => 1, sub {	1332	$_[0]->unshift_read (chunk => 1, sub {
1141	if ($_[1] eq ",") {	1333	if ($_[1] eq ",") {
1142	$cb->($_[0], $string);	1334	$cb->($_[0], $string);
1143	} else {	1335	} else {
1144	$self->_error (&Errno::EBADMSG);	1336	$self->_error (Errno::EBADMSG);
1145	}	1337	}
1146	});	1338	});
1147	});	1339	});
1148		1340
1149	1	1341	1
…		…
1239	$json->incr_skip;	1431	$json->incr_skip;
1240		1432
1241	$self->{rbuf} = $json->incr_text;	1433	$self->{rbuf} = $json->incr_text;
1242	$json->incr_text = "";	1434	$json->incr_text = "";
1243		1435
1244	$self->_error (&Errno::EBADMSG);	1436	$self->_error (Errno::EBADMSG);
1245		1437
1246	()	1438	()
1247	} else {	1439	} else {
1248	$self->{rbuf} = "";	1440	$self->{rbuf} = "";
1249		1441
…		…
1286	# read remaining chunk	1478	# read remaining chunk
1287	$_[0]->unshift_read (chunk => $len, sub {	1479	$_[0]->unshift_read (chunk => $len, sub {
1288	if (my $ref = eval { Storable::thaw ($_[1]) }) {	1480	if (my $ref = eval { Storable::thaw ($_[1]) }) {
1289	$cb->($_[0], $ref);	1481	$cb->($_[0], $ref);
1290	} else {	1482	} else {
1291	$self->_error (&Errno::EBADMSG);	1483	$self->_error (Errno::EBADMSG);
1292	}	1484	}
1293	});	1485	});
1294	}	1486	}
1295		1487
1296	1	1488	1
…		…
1360	if ($self->{tls}) {	1552	if ($self->{tls}) {
1361	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);	1553	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1362		1554
1363	&_dotls ($self);	1555	&_dotls ($self);
1364	} else {	1556	} else {
1365	$self->_drain_rbuf unless $self->{_in_drain};	1557	$self->_drain_rbuf;
1366	}	1558	}
1367		1559
1368	} elsif (defined $len) {	1560	} elsif (defined $len) {
1369	delete $self->{_rw};	1561	delete $self->{_rw};
1370	$self->{_eof} = 1;	1562	$self->{_eof} = 1;
1371	$self->_drain_rbuf unless $self->{_in_drain};	1563	$self->_drain_rbuf;
1372		1564
1373	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1565	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1374	return $self->_error ($!, 1);	1566	return $self->_error ($!, 1);
1375	}	1567	}
1376	});	1568	});
1377	}	1569	}
1378	}	1570	}
1379		1571
1380	our $ERROR_SYSCALL;	1572	our $ERROR_SYSCALL;
1381	our $ERROR_WANT_READ;	1573	our $ERROR_WANT_READ;
1382	our $ERROR_ZERO_RETURN;
1383		1574
1384	sub _tls_error {	1575	sub _tls_error {
1385	my ($self, $err) = @_;	1576	my ($self, $err) = @_;
1386		1577
1387	return $self->_error ($!, 1)	1578	return $self->_error ($!, 1)
…		…
1390	my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());	1581	my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());
1391		1582
1392	# reduce error string to look less scary	1583	# reduce error string to look less scary
1393	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;	1584	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;
1394		1585
		1586	if ($self->{_on_starttls}) {
		1587	(delete $self->{_on_starttls})->($self, undef, $err);
		1588	&_freetls;
		1589	} else {
		1590	&_freetls;
1395	$self->_error (&Errno::EPROTO, 1, $err);	1591	$self->_error (Errno::EPROTO, 1, $err);
		1592	}
1396	}	1593	}
1397		1594
1398	# poll the write BIO and send the data if applicable	1595	# poll the write BIO and send the data if applicable
1399	# also decode read data if possible	1596	# also decode read data if possible
1400	# this is basiclaly our TLS state machine	1597	# this is basiclaly our TLS state machine
…		…
1411	}	1608	}
1412		1609
1413	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);	1610	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);
1414	return $self->_tls_error ($tmp)	1611	return $self->_tls_error ($tmp)
1415	if $tmp != $ERROR_WANT_READ	1612	if $tmp != $ERROR_WANT_READ
1416	&& ($tmp != $ERROR_SYSCALL \|\| $!)	1613	&& ($tmp != $ERROR_SYSCALL \|\| $!);
1417	&& $tmp != $ERROR_ZERO_RETURN;
1418	}	1614	}
1419		1615
1420	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {	1616	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
1421	unless (length $tmp) {	1617	unless (length $tmp) {
1422	# let's treat SSL-eof as we treat normal EOF	1618	$self->{_on_starttls}
1423	delete $self->{_rw};	1619	and (delete $self->{_on_starttls})->($self, undef, "EOF during handshake"); # ???
1424	$self->{_eof} = 1;
1425	&_freetls;	1620	&_freetls;
		1621
		1622	if ($self->{on_stoptls}) {
		1623	$self->{on_stoptls}($self);
		1624	return;
		1625	} else {
		1626	# let's treat SSL-eof as we treat normal EOF
		1627	delete $self->{_rw};
		1628	$self->{_eof} = 1;
		1629	}
1426	}	1630	}
1427		1631
1428	$self->{_tls_rbuf} .= $tmp;	1632	$self->{_tls_rbuf} .= $tmp;
1429	$self->_drain_rbuf unless $self->{_in_drain};	1633	$self->_drain_rbuf;
1430	$self->{tls} or return; # tls session might have gone away in callback	1634	$self->{tls} or return; # tls session might have gone away in callback
1431	}	1635	}
1432		1636
1433	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);	1637	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1434	return $self->_tls_error ($tmp)	1638	return $self->_tls_error ($tmp)
1435	if $tmp != $ERROR_WANT_READ	1639	if $tmp != $ERROR_WANT_READ
1436	&& ($tmp != $ERROR_SYSCALL \|\| $!)	1640	&& ($tmp != $ERROR_SYSCALL \|\| $!);
1437	&& $tmp != $ERROR_ZERO_RETURN;
1438		1641
1439	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1642	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1440	$self->{wbuf} .= $tmp;	1643	$self->{wbuf} .= $tmp;
1441	$self->_drain_wbuf;	1644	$self->_drain_wbuf;
1442	}	1645	}
		1646
		1647	$self->{_on_starttls}
		1648	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
		1649	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");
1443	}	1650	}
1444		1651
1445	=item $handle->starttls ($tls[, $tls_ctx])	1652	=item $handle->starttls ($tls[, $tls_ctx])
1446		1653
1447	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	1654	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
1448	object is created, you can also do that at a later time by calling	1655	object is created, you can also do that at a later time by calling
1449	C<starttls>.	1656	C<starttls>.
		1657
		1658	Starting TLS is currently an asynchronous operation - when you push some
		1659	write data and then call C<< ->starttls >> then TLS negotiation will start
		1660	immediately, after which the queued write data is then sent.
1450		1661
1451	The first argument is the same as the C<tls> constructor argument (either	1662	The first argument is the same as the C<tls> constructor argument (either
1452	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1663	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1453		1664
1454	The second argument is the optional C<AnyEvent::TLS> object that is used	1665	The second argument is the optional C<AnyEvent::TLS> object that is used
…		…
1459	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS	1670	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS
1460	context in C<< $handle->{tls_ctx} >> after this call and can be used or	1671	context in C<< $handle->{tls_ctx} >> after this call and can be used or
1461	changed to your liking. Note that the handshake might have already started	1672	changed to your liking. Note that the handshake might have already started
1462	when this function returns.	1673	when this function returns.
1463		1674
1464	If it an error to start a TLS handshake more than once per	1675	Due to bugs in OpenSSL, it might or might not be possible to do multiple
1465	AnyEvent::Handle object (this is due to bugs in OpenSSL).	1676	handshakes on the same stream. Best do not attempt to use the stream after
		1677	stopping TLS.
1466		1678
1467	=cut	1679	=cut
1468		1680
1469	our %TLS_CACHE; #TODO not yet documented, should we?	1681	our %TLS_CACHE; #TODO not yet documented, should we?
1470		1682
1471	sub starttls {	1683	sub starttls {
1472	my ($self, $ssl, $ctx) = @_;	1684	my ($self, $tls, $ctx) = @_;
		1685
		1686	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"
		1687	if $self->{tls};
		1688
		1689	$self->{tls} = $tls;
		1690	$self->{tls_ctx} = $ctx if @_ > 2;
		1691
		1692	return unless $self->{fh};
1473		1693
1474	require Net::SSLeay;	1694	require Net::SSLeay;
1475		1695
1476	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"
1477	if $self->{tls};
1478
1479	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();	1696	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1480	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();	1697	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1481	$ERROR_ZERO_RETURN = Net::SSLeay::ERROR_ZERO_RETURN ();
1482		1698
		1699	$tls = $self->{tls};
1483	$ctx \|\|= $self->{tls_ctx};	1700	$ctx = $self->{tls_ctx};
		1701
		1702	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
1484		1703
1485	if ("HASH" eq ref $ctx) {	1704	if ("HASH" eq ref $ctx) {
1486	require AnyEvent::TLS;	1705	require AnyEvent::TLS;
1487
1488	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context
1489		1706
1490	if ($ctx->{cache}) {	1707	if ($ctx->{cache}) {
1491	my $key = $ctx+0;	1708	my $key = $ctx+0;
1492	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;	1709	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;
1493	} else {	1710	} else {
1494	$ctx = new AnyEvent::TLS %$ctx;	1711	$ctx = new AnyEvent::TLS %$ctx;
1495	}	1712	}
1496	}	1713	}
1497		1714
1498	$self->{tls_ctx} = $ctx \|\| TLS_CTX ();	1715	$self->{tls_ctx} = $ctx \|\| TLS_CTX ();
1499	$self->{tls} = $ssl = $self->{tls_ctx}->_get_session ($ssl, $self, $self->{peername});	1716	$self->{tls} = $tls = $self->{tls_ctx}->_get_session ($tls, $self, $self->{peername});
1500		1717
1501	# basically, this is deep magic (because SSL_read should have the same issues)	1718	# basically, this is deep magic (because SSL_read should have the same issues)
1502	# but the openssl maintainers basically said: "trust us, it just works".	1719	# but the openssl maintainers basically said: "trust us, it just works".
1503	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1720	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1504	# and mismaintained ssleay-module doesn't even offer them).	1721	# and mismaintained ssleay-module doesn't even offer them).
…		…
1511	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to	1728	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
1512	# have identity issues in that area.	1729	# have identity issues in that area.
1513	# Net::SSLeay::CTX_set_mode ($ssl,	1730	# Net::SSLeay::CTX_set_mode ($ssl,
1514	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1731	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
1515	# \| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));	1732	# \| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
1516	Net::SSLeay::CTX_set_mode ($ssl, 1\|2);	1733	Net::SSLeay::CTX_set_mode ($tls, 1\|2);
1517		1734
1518	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1735	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1519	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1736	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1520		1737
		1738	Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf});
		1739
1521	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1740	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
		1741
		1742	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
		1743	if $self->{on_starttls};
1522		1744
1523	&_dotls; # need to trigger the initial handshake	1745	&_dotls; # need to trigger the initial handshake
1524	$self->start_read; # make sure we actually do read	1746	$self->start_read; # make sure we actually do read
1525	}	1747	}
1526		1748
1527	=item $handle->stoptls	1749	=item $handle->stoptls
1528		1750
1529	Shuts down the SSL connection - this makes a proper EOF handshake by	1751	Shuts down the SSL connection - this makes a proper EOF handshake by
1530	sending a close notify to the other side, but since OpenSSL doesn't	1752	sending a close notify to the other side, but since OpenSSL doesn't
1531	support non-blocking shut downs, it is not possible to re-use the stream	1753	support non-blocking shut downs, it is not guarenteed that you can re-use
1532	afterwards.	1754	the stream afterwards.
1533		1755
1534	=cut	1756	=cut
1535		1757
1536	sub stoptls {	1758	sub stoptls {
1537	my ($self) = @_;	1759	my ($self) = @_;
…		…
1539	if ($self->{tls}) {	1761	if ($self->{tls}) {
1540	Net::SSLeay::shutdown ($self->{tls});	1762	Net::SSLeay::shutdown ($self->{tls});
1541		1763
1542	&_dotls;	1764	&_dotls;
1543		1765
1544	# we don't give a shit. no, we do, but we can't. no...	1766	# # we don't give a shit. no, we do, but we can't. no...#d#
1545	# we, we... have to use openssl :/	1767	# # we, we... have to use openssl :/#d#
1546	&_freetls;	1768	# &_freetls;#d#
1547	}	1769	}
1548	}	1770	}
1549		1771
1550	sub _freetls {	1772	sub _freetls {
1551	my ($self) = @_;	1773	my ($self) = @_;
1552		1774
1553	return unless $self->{tls};	1775	return unless $self->{tls};
1554		1776
1555	$self->{tls_ctx}->_put_session (delete $self->{tls});	1777	$self->{tls_ctx}->_put_session (delete $self->{tls})
		1778	if $self->{tls} > 0;
1556		1779
1557	delete @$self{qw(_rbio _wbio _tls_wbuf)};	1780	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1558	}	1781	}
1559		1782
1560	sub DESTROY {	1783	sub DESTROY {
1561	my ($self) = @_;	1784	my ($self) = @_;
1562		1785
1563	&_freetls;	1786	&_freetls;
1564		1787
1565	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	1788	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1566		1789
1567	if ($linger && length $self->{wbuf}) {	1790	if ($linger && length $self->{wbuf} && $self->{fh}) {
1568	my $fh = delete $self->{fh};	1791	my $fh = delete $self->{fh};
1569	my $wbuf = delete $self->{wbuf};	1792	my $wbuf = delete $self->{wbuf};
1570		1793
1571	my @linger;	1794	my @linger;
1572		1795
…		…
1587		1810
1588	=item $handle->destroy	1811	=item $handle->destroy
1589		1812
1590	Shuts down the handle object as much as possible - this call ensures that	1813	Shuts down the handle object as much as possible - this call ensures that
1591	no further callbacks will be invoked and as many resources as possible	1814	no further callbacks will be invoked and as many resources as possible
1592	will be freed. You must not call any methods on the object afterwards.	1815	will be freed. Any method you will call on the handle object after
		1816	destroying it in this way will be silently ignored (and it will return the
		1817	empty list).
1593		1818
1594	Normally, you can just "forget" any references to an AnyEvent::Handle	1819	Normally, you can just "forget" any references to an AnyEvent::Handle
1595	object and it will simply shut down. This works in fatal error and EOF	1820	object and it will simply shut down. This works in fatal error and EOF
1596	callbacks, as well as code outside. It does I<NOT> work in a read or write	1821	callbacks, as well as code outside. It does I<NOT> work in a read or write
1597	callback, so when you want to destroy the AnyEvent::Handle object from	1822	callback, so when you want to destroy the AnyEvent::Handle object from
1598	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in	1823	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
1599	that case.	1824	that case.
1600		1825
		1826	Destroying the handle object in this way has the advantage that callbacks
		1827	will be removed as well, so if those are the only reference holders (as
		1828	is common), then one doesn't need to do anything special to break any
		1829	reference cycles.
		1830
1601	The handle might still linger in the background and write out remaining	1831	The handle might still linger in the background and write out remaining
1602	data, as specified by the C<linger> option, however.	1832	data, as specified by the C<linger> option, however.
1603		1833
1604	=cut	1834	=cut
1605		1835
1606	sub destroy {	1836	sub destroy {
1607	my ($self) = @_;	1837	my ($self) = @_;
1608		1838
1609	$self->DESTROY;	1839	$self->DESTROY;
1610	%$self = ();	1840	%$self = ();
		1841	bless $self, "AnyEvent::Handle::destroyed";
		1842	}
		1843
		1844	sub AnyEvent::Handle::destroyed::AUTOLOAD {
		1845	#nop
1611	}	1846	}
1612		1847
1613	=item AnyEvent::Handle::TLS_CTX	1848	=item AnyEvent::Handle::TLS_CTX
1614		1849
1615	This function creates and returns the AnyEvent::TLS object used by default	1850	This function creates and returns the AnyEvent::TLS object used by default
…		…
1672		1907
1673	$handle->on_read (sub { });	1908	$handle->on_read (sub { });
1674	$handle->on_eof (undef);	1909	$handle->on_eof (undef);
1675	$handle->on_error (sub {	1910	$handle->on_error (sub {
1676	my $data = delete $_[0]{rbuf};	1911	my $data = delete $_[0]{rbuf};
1677	undef $handle;
1678	});	1912	});
1679		1913
1680	The reason to use C<on_error> is that TCP connections, due to latencies	1914	The reason to use C<on_error> is that TCP connections, due to latencies
1681	and packets loss, might get closed quite violently with an error, when in	1915	and packets loss, might get closed quite violently with an error, when in
1682	fact, all data has been received.	1916	fact, all data has been received.
…		…
1698	$handle->on_drain (sub {	1932	$handle->on_drain (sub {
1699	warn "all data submitted to the kernel\n";	1933	warn "all data submitted to the kernel\n";
1700	undef $handle;	1934	undef $handle;
1701	});	1935	});
1702		1936
		1937	If you just want to queue some data and then signal EOF to the other side,
		1938	consider using C<< ->push_shutdown >> instead.
		1939
		1940	=item I want to contact a TLS/SSL server, I don't care about security.
		1941
		1942	If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS,
		1943	simply connect to it and then create the AnyEvent::Handle with the C<tls>
		1944	parameter:
		1945
		1946	tcp_connect $host, $port, sub {
		1947	my ($fh) = @_;
		1948
		1949	my $handle = new AnyEvent::Handle
		1950	fh => $fh,
		1951	tls => "connect",
		1952	on_error => sub { ... };
		1953
		1954	$handle->push_write (...);
		1955	};
		1956
		1957	=item I want to contact a TLS/SSL server, I do care about security.
		1958
		1959	Then you should additionally enable certificate verification, including
		1960	peername verification, if the protocol you use supports it (see
		1961	L<AnyEvent::TLS>, C<verify_peername>).
		1962
		1963	E.g. for HTTPS:
		1964
		1965	tcp_connect $host, $port, sub {
		1966	my ($fh) = @_;
		1967
		1968	my $handle = new AnyEvent::Handle
		1969	fh => $fh,
		1970	peername => $host,
		1971	tls => "connect",
		1972	tls_ctx => { verify => 1, verify_peername => "https" },
		1973	...
		1974
		1975	Note that you must specify the hostname you connected to (or whatever
		1976	"peername" the protocol needs) as the C<peername> argument, otherwise no
		1977	peername verification will be done.
		1978
		1979	The above will use the system-dependent default set of trusted CA
		1980	certificates. If you want to check against a specific CA, add the
		1981	C<ca_file> (or C<ca_cert>) arguments to C<tls_ctx>:
		1982
		1983	tls_ctx => {
		1984	verify => 1,
		1985	verify_peername => "https",
		1986	ca_file => "my-ca-cert.pem",
		1987	},
		1988
		1989	=item I want to create a TLS/SSL server, how do I do that?
		1990
		1991	Well, you first need to get a server certificate and key. You have
		1992	three options: a) ask a CA (buy one, use cacert.org etc.) b) create a
		1993	self-signed certificate (cheap. check the search engine of your choice,
		1994	there are many tutorials on the net) or c) make your own CA (tinyca2 is a
		1995	nice program for that purpose).
		1996
		1997	Then create a file with your private key (in PEM format, see
		1998	L<AnyEvent::TLS>), followed by the certificate (also in PEM format). The
		1999	file should then look like this:
		2000
		2001	-----BEGIN RSA PRIVATE KEY-----
		2002	...header data
		2003	... lots of base64'y-stuff
		2004	-----END RSA PRIVATE KEY-----
		2005
		2006	-----BEGIN CERTIFICATE-----
		2007	... lots of base64'y-stuff
		2008	-----END CERTIFICATE-----
		2009
		2010	The important bits are the "PRIVATE KEY" and "CERTIFICATE" parts. Then
		2011	specify this file as C<cert_file>:
		2012
		2013	tcp_server undef, $port, sub {
		2014	my ($fh) = @_;
		2015
		2016	my $handle = new AnyEvent::Handle
		2017	fh => $fh,
		2018	tls => "accept",
		2019	tls_ctx => { cert_file => "my-server-keycert.pem" },
		2020	...
		2021
		2022	When you have intermediate CA certificates that your clients might not
		2023	know about, just append them to the C<cert_file>.
		2024
1703	=back	2025	=back
1704		2026
1705		2027
1706	=head1 SUBCLASSING AnyEvent::Handle	2028	=head1 SUBCLASSING AnyEvent::Handle
1707		2029

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.141 by root, Mon Jul 6 01:03:09 2009 UTC vs. Revision 1.174 by root, Sat Aug 8 20:52:06 2009 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.141 by root, Mon Jul 6 01:03:09 2009 UTC vs.
Revision 1.174 by root, Sat Aug 8 20:52:06 2009 UTC