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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.134 by root, Fri Jul 3 00:09:04 2009 UTC vs.
Revision 1.163 by root, Mon Jul 27 22:08:52 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.45;	16	our $VERSION = 4.87;
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	common name verification (see C<verify_cn> 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];
430	}	605	}
431		606
432	#############################################################################	607	#############################################################################
433		608
434	=item $handle->timeout ($seconds)	609	=item $handle->timeout ($seconds)
…		…
447	# reset the timeout watcher, as neccessary	622	# reset the timeout watcher, as neccessary
448	# also check for time-outs	623	# also check for time-outs
449	sub _timeout {	624	sub _timeout {
450	my ($self) = @_;	625	my ($self) = @_;
451		626
452	if ($self->{timeout}) {	627	if ($self->{timeout} && $self->{fh}) {
453	my $NOW = AnyEvent->now;	628	my $NOW = AnyEvent->now;
454		629
455	# when would the timeout trigger?	630	# when would the timeout trigger?
456	my $after = $self->{_activity} + $self->{timeout} - $NOW;	631	my $after = $self->{_activity} + $self->{timeout} - $NOW;
457		632
…		…
460	$self->{_activity} = $NOW;	635	$self->{_activity} = $NOW;
461		636
462	if ($self->{on_timeout}) {	637	if ($self->{on_timeout}) {
463	$self->{on_timeout}($self);	638	$self->{on_timeout}($self);
464	} else {	639	} else {
465	$self->_error (&Errno::ETIMEDOUT);	640	$self->_error (Errno::ETIMEDOUT);
466	}	641	}
467		642
468	# callback could have changed timeout value, optimise	643	# callback could have changed timeout value, optimise
469	return unless $self->{timeout};	644	return unless $self->{timeout};
470		645
…		…
533	Scalar::Util::weaken $self;	708	Scalar::Util::weaken $self;
534		709
535	my $cb = sub {	710	my $cb = sub {
536	my $len = syswrite $self->{fh}, $self->{wbuf};	711	my $len = syswrite $self->{fh}, $self->{wbuf};
537		712
538	if ($len >= 0) {	713	if (defined $len) {
539	substr $self->{wbuf}, 0, $len, "";	714	substr $self->{wbuf}, 0, $len, "";
540		715
541	$self->{_activity} = AnyEvent->now;	716	$self->{_activity} = AnyEvent->now;
542		717
543	$self->{on_drain}($self)	718	$self->{on_drain}($self)
…		…
575	->($self, @_);	750	->($self, @_);
576	}	751	}
577		752
578	if ($self->{tls}) {	753	if ($self->{tls}) {
579	$self->{_tls_wbuf} .= $_[0];	754	$self->{_tls_wbuf} .= $_[0];
580		755	&_dotls ($self) if $self->{fh};
581	&_dotls ($self);
582	} else {	756	} else {
583	$self->{wbuf} .= $_[0];	757	$self->{wbuf} .= $_[0];
584	$self->_drain_wbuf;	758	$self->_drain_wbuf if $self->{fh};
585	}	759	}
586	}	760	}
587		761
588	=item $handle->push_write (type => @args)	762	=item $handle->push_write (type => @args)
589		763
…		…
683		857
684	=item $handle->push_shutdown	858	=item $handle->push_shutdown
685		859
686	Sometimes you know you want to close the socket after writing your data	860	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	861	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	862	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:	863	C<low_water_mark> to C<0>). This method is a shorthand for just that, and
		864	replaces the C<on_drain> callback with:
690		865
691	sub { shutdown $_[0]{fh}, 1 } # for push_shutdown	866	sub { shutdown $_[0]{fh}, 1 } # for push_shutdown
692		867
693	This simply shuts down the write side and signals an EOF condition to the	868	This simply shuts down the write side and signals an EOF condition to the
694	the peer.	869	the peer.
…		…
697	afterwards. This is the cleanest way to close a connection.	872	afterwards. This is the cleanest way to close a connection.
698		873
699	=cut	874	=cut
700		875
701	sub push_shutdown {	876	sub push_shutdown {
		877	my ($self) = @_;
		878
		879	delete $self->{low_water_mark};
702	$_[0]->{on_drain} = sub { shutdown $_[0]{fh}, 1 };	880	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });
703	}	881	}
704		882
705	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	883	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
706		884
707	This function (not method) lets you add your own types to C<push_write>.	885	This function (not method) lets you add your own types to C<push_write>.
…		…
802	=cut	980	=cut
803		981
804	sub _drain_rbuf {	982	sub _drain_rbuf {
805	my ($self) = @_;	983	my ($self) = @_;
806		984
		985	# avoid recursion
		986	return if exists $self->{_skip_drain_rbuf};
807	local $self->{_in_drain} = 1;	987	local $self->{_skip_drain_rbuf} = 1;
808		988
809	if (	989	if (
810	defined $self->{rbuf_max}	990	defined $self->{rbuf_max}
811	&& $self->{rbuf_max} < length $self->{rbuf}	991	&& $self->{rbuf_max} < length $self->{rbuf}
812	) {	992	) {
813	$self->_error (&Errno::ENOSPC, 1), return;	993	$self->_error (Errno::ENOSPC, 1), return;
814	}	994	}
815		995
816	while () {	996	while () {
817	# we need to use a separate tls read buffer, as we must not receive data while	997	# 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.	998	# we are draining the buffer, and this can only happen with TLS.
819	$self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf};	999	$self->{rbuf} .= delete $self->{_tls_rbuf}
		1000	if exists $self->{_tls_rbuf};
820		1001
821	my $len = length $self->{rbuf};	1002	my $len = length $self->{rbuf};
822		1003
823	if (my $cb = shift @{ $self->{_queue} }) {	1004	if (my $cb = shift @{ $self->{_queue} }) {
824	unless ($cb->($self)) {	1005	unless ($cb->($self)) {
825	if ($self->{_eof}) {	1006	# no progress can be made
826	# no progress can be made (not enough data and no data forthcoming)	1007	# (not enough data and no data forthcoming)
827	$self->_error (&Errno::EPIPE, 1), return;	1008	$self->_error (Errno::EPIPE, 1), return
828	}	1009	if $self->{_eof};
829		1010
830	unshift @{ $self->{_queue} }, $cb;	1011	unshift @{ $self->{_queue} }, $cb;
831	last;	1012	last;
832	}	1013	}
833	} elsif ($self->{on_read}) {	1014	} elsif ($self->{on_read}) {
…		…
840	&& !@{ $self->{_queue} } # and the queue is still empty	1021	&& !@{ $self->{_queue} } # and the queue is still empty
841	&& $self->{on_read} # but we still have on_read	1022	&& $self->{on_read} # but we still have on_read
842	) {	1023	) {
843	# no further data will arrive	1024	# no further data will arrive
844	# so no progress can be made	1025	# so no progress can be made
845	$self->_error (&Errno::EPIPE, 1), return	1026	$self->_error (Errno::EPIPE, 1), return
846	if $self->{_eof};	1027	if $self->{_eof};
847		1028
848	last; # more data might arrive	1029	last; # more data might arrive
849	}	1030	}
850	} else {	1031	} else {
…		…
853	last;	1034	last;
854	}	1035	}
855	}	1036	}
856		1037
857	if ($self->{_eof}) {	1038	if ($self->{_eof}) {
858	if ($self->{on_eof}) {	1039	$self->{on_eof}
859	$self->{on_eof}($self)	1040	? $self->{on_eof}($self)
860	} else {	1041	: $self->_error (0, 1, "Unexpected end-of-file");
861	$self->_error (0, 1);	1042
862	}	1043	return;
863	}	1044	}
864		1045
865	# may need to restart read watcher	1046	# may need to restart read watcher
866	unless ($self->{_rw}) {	1047	unless ($self->{_rw}) {
867	$self->start_read	1048	$self->start_read
…		…
879		1060
880	sub on_read {	1061	sub on_read {
881	my ($self, $cb) = @_;	1062	my ($self, $cb) = @_;
882		1063
883	$self->{on_read} = $cb;	1064	$self->{on_read} = $cb;
884	$self->_drain_rbuf if $cb && !$self->{_in_drain};	1065	$self->_drain_rbuf if $cb;
885	}	1066	}
886		1067
887	=item $handle->rbuf	1068	=item $handle->rbuf
888		1069
889	Returns the read buffer (as a modifiable lvalue).	1070	Returns the read buffer (as a modifiable lvalue).
…		…
941	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	1122	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
942	->($self, $cb, @_);	1123	->($self, $cb, @_);
943	}	1124	}
944		1125
945	push @{ $self->{_queue} }, $cb;	1126	push @{ $self->{_queue} }, $cb;
946	$self->_drain_rbuf unless $self->{_in_drain};	1127	$self->_drain_rbuf;
947	}	1128	}
948		1129
949	sub unshift_read {	1130	sub unshift_read {
950	my $self = shift;	1131	my $self = shift;
951	my $cb = pop;	1132	my $cb = pop;
…		…
957	->($self, $cb, @_);	1138	->($self, $cb, @_);
958	}	1139	}
959		1140
960		1141
961	unshift @{ $self->{_queue} }, $cb;	1142	unshift @{ $self->{_queue} }, $cb;
962	$self->_drain_rbuf unless $self->{_in_drain};	1143	$self->_drain_rbuf;
963	}	1144	}
964		1145
965	=item $handle->push_read (type => @args, $cb)	1146	=item $handle->push_read (type => @args, $cb)
966		1147
967	=item $handle->unshift_read (type => @args, $cb)	1148	=item $handle->unshift_read (type => @args, $cb)
…		…
1100	return 1;	1281	return 1;
1101	}	1282	}
1102		1283
1103	# reject	1284	# reject
1104	if ($reject && $$rbuf =~ $reject) {	1285	if ($reject && $$rbuf =~ $reject) {
1105	$self->_error (&Errno::EBADMSG);	1286	$self->_error (Errno::EBADMSG);
1106	}	1287	}
1107		1288
1108	# skip	1289	# skip
1109	if ($skip && $$rbuf =~ $skip) {	1290	if ($skip && $$rbuf =~ $skip) {
1110	$data .= substr $$rbuf, 0, $+[0], "";	1291	$data .= substr $$rbuf, 0, $+[0], "";
…		…
1126	my ($self, $cb) = @_;	1307	my ($self, $cb) = @_;
1127		1308
1128	sub {	1309	sub {
1129	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {	1310	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
1130	if ($_[0]{rbuf} =~ /[^0-9]/) {	1311	if ($_[0]{rbuf} =~ /[^0-9]/) {
1131	$self->_error (&Errno::EBADMSG);	1312	$self->_error (Errno::EBADMSG);
1132	}	1313	}
1133	return;	1314	return;
1134	}	1315	}
1135		1316
1136	my $len = $1;	1317	my $len = $1;
…		…
1139	my $string = $_[1];	1320	my $string = $_[1];
1140	$_[0]->unshift_read (chunk => 1, sub {	1321	$_[0]->unshift_read (chunk => 1, sub {
1141	if ($_[1] eq ",") {	1322	if ($_[1] eq ",") {
1142	$cb->($_[0], $string);	1323	$cb->($_[0], $string);
1143	} else {	1324	} else {
1144	$self->_error (&Errno::EBADMSG);	1325	$self->_error (Errno::EBADMSG);
1145	}	1326	}
1146	});	1327	});
1147	});	1328	});
1148		1329
1149	1	1330	1
…		…
1216	=cut	1397	=cut
1217		1398
1218	register_read_type json => sub {	1399	register_read_type json => sub {
1219	my ($self, $cb) = @_;	1400	my ($self, $cb) = @_;
1220		1401
1221	require JSON;	1402	my $json = $self->{json} \|\|=
		1403	eval { require JSON::XS; JSON::XS->new->utf8 }
		1404	\|\| do { require JSON; JSON->new->utf8 };
1222		1405
1223	my $data;	1406	my $data;
1224	my $rbuf = \$self->{rbuf};	1407	my $rbuf = \$self->{rbuf};
1225
1226	my $json = $self->{json} \|\|= JSON->new->utf8;
1227		1408
1228	sub {	1409	sub {
1229	my $ref = eval { $json->incr_parse ($self->{rbuf}) };	1410	my $ref = eval { $json->incr_parse ($self->{rbuf}) };
1230		1411
1231	if ($ref) {	1412	if ($ref) {
…		…
1239	$json->incr_skip;	1420	$json->incr_skip;
1240		1421
1241	$self->{rbuf} = $json->incr_text;	1422	$self->{rbuf} = $json->incr_text;
1242	$json->incr_text = "";	1423	$json->incr_text = "";
1243		1424
1244	$self->_error (&Errno::EBADMSG);	1425	$self->_error (Errno::EBADMSG);
1245		1426
1246	()	1427	()
1247	} else {	1428	} else {
1248	$self->{rbuf} = "";	1429	$self->{rbuf} = "";
1249		1430
…		…
1286	# read remaining chunk	1467	# read remaining chunk
1287	$_[0]->unshift_read (chunk => $len, sub {	1468	$_[0]->unshift_read (chunk => $len, sub {
1288	if (my $ref = eval { Storable::thaw ($_[1]) }) {	1469	if (my $ref = eval { Storable::thaw ($_[1]) }) {
1289	$cb->($_[0], $ref);	1470	$cb->($_[0], $ref);
1290	} else {	1471	} else {
1291	$self->_error (&Errno::EBADMSG);	1472	$self->_error (Errno::EBADMSG);
1292	}	1473	}
1293	});	1474	});
1294	}	1475	}
1295		1476
1296	1	1477	1
…		…
1360	if ($self->{tls}) {	1541	if ($self->{tls}) {
1361	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);	1542	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1362		1543
1363	&_dotls ($self);	1544	&_dotls ($self);
1364	} else {	1545	} else {
1365	$self->_drain_rbuf unless $self->{_in_drain};	1546	$self->_drain_rbuf;
1366	}	1547	}
1367		1548
1368	} elsif (defined $len) {	1549	} elsif (defined $len) {
1369	delete $self->{_rw};	1550	delete $self->{_rw};
1370	$self->{_eof} = 1;	1551	$self->{_eof} = 1;
1371	$self->_drain_rbuf unless $self->{_in_drain};	1552	$self->_drain_rbuf;
1372		1553
1373	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1554	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1374	return $self->_error ($!, 1);	1555	return $self->_error ($!, 1);
1375	}	1556	}
1376	});	1557	});
1377	}	1558	}
1378	}	1559	}
1379		1560
1380	our $ERROR_SYSCALL;	1561	our $ERROR_SYSCALL;
1381	our $ERROR_WANT_READ;	1562	our $ERROR_WANT_READ;
1382	our $ERROR_ZERO_RETURN;
1383		1563
1384	sub _tls_error {	1564	sub _tls_error {
1385	my ($self, $err) = @_;	1565	my ($self, $err) = @_;
1386	warn "$err,$!\n";#d#
1387		1566
1388	return $self->_error ($!, 1)	1567	return $self->_error ($!, 1)
1389	if $err == Net::SSLeay::ERROR_SYSCALL ();	1568	if $err == Net::SSLeay::ERROR_SYSCALL ();
1390		1569
		1570	my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());
		1571
		1572	# reduce error string to look less scary
		1573	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;
		1574
		1575	if ($self->{_on_starttls}) {
		1576	(delete $self->{_on_starttls})->($self, undef, $err);
		1577	&_freetls;
		1578	} else {
		1579	&_freetls;
1391	$self->_error (&Errno::EPROTO, 1,	1580	$self->_error (Errno::EPROTO, 1, $err);
1392	Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ()));	1581	}
1393	}	1582	}
1394		1583
1395	# poll the write BIO and send the data if applicable	1584	# poll the write BIO and send the data if applicable
1396	# also decode read data if possible	1585	# also decode read data if possible
1397	# this is basiclaly our TLS state machine	1586	# this is basiclaly our TLS state machine
…		…
1408	}	1597	}
1409		1598
1410	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);	1599	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);
1411	return $self->_tls_error ($tmp)	1600	return $self->_tls_error ($tmp)
1412	if $tmp != $ERROR_WANT_READ	1601	if $tmp != $ERROR_WANT_READ
1413	&& ($tmp != $ERROR_SYSCALL \|\| $!)	1602	&& ($tmp != $ERROR_SYSCALL \|\| $!);
1414	&& $tmp != $ERROR_ZERO_RETURN;
1415	}	1603	}
1416		1604
1417	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {	1605	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
1418	unless (length $tmp) {	1606	unless (length $tmp) {
1419	# let's treat SSL-eof as we treat normal EOF	1607	$self->{_on_starttls}
1420	delete $self->{_rw};	1608	and (delete $self->{_on_starttls})->($self, undef, "EOF during handshake"); # ???
1421	$self->{_eof} = 1;
1422	&_freetls;	1609	&_freetls;
		1610
		1611	if ($self->{on_stoptls}) {
		1612	$self->{on_stoptls}($self);
		1613	return;
		1614	} else {
		1615	# let's treat SSL-eof as we treat normal EOF
		1616	delete $self->{_rw};
		1617	$self->{_eof} = 1;
		1618	}
1423	}	1619	}
1424		1620
1425	$self->{_tls_rbuf} .= $tmp;	1621	$self->{_tls_rbuf} .= $tmp;
1426	$self->_drain_rbuf unless $self->{_in_drain};	1622	$self->_drain_rbuf;
1427	$self->{tls} or return; # tls session might have gone away in callback	1623	$self->{tls} or return; # tls session might have gone away in callback
1428	}	1624	}
1429		1625
1430	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);	1626	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1431	return $self->_tls_error ($tmp)	1627	return $self->_tls_error ($tmp)
1432	if $tmp != $ERROR_WANT_READ	1628	if $tmp != $ERROR_WANT_READ
1433	&& ($tmp != $ERROR_SYSCALL \|\| $!)	1629	&& ($tmp != $ERROR_SYSCALL \|\| $!);
1434	&& $tmp != $ERROR_ZERO_RETURN;
1435		1630
1436	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1631	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1437	$self->{wbuf} .= $tmp;	1632	$self->{wbuf} .= $tmp;
1438	$self->_drain_wbuf;	1633	$self->_drain_wbuf;
1439	}	1634	}
		1635
		1636	$self->{_on_starttls}
		1637	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
		1638	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");
1440	}	1639	}
1441		1640
1442	=item $handle->starttls ($tls[, $tls_ctx])	1641	=item $handle->starttls ($tls[, $tls_ctx])
1443		1642
1444	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	1643	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
1445	object is created, you can also do that at a later time by calling	1644	object is created, you can also do that at a later time by calling
1446	C<starttls>.	1645	C<starttls>.
		1646
		1647	Starting TLS is currently an asynchronous operation - when you push some
		1648	write data and then call C<< ->starttls >> then TLS negotiation will start
		1649	immediately, after which the queued write data is then sent.
1447		1650
1448	The first argument is the same as the C<tls> constructor argument (either	1651	The first argument is the same as the C<tls> constructor argument (either
1449	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1652	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1450		1653
1451	The second argument is the optional C<AnyEvent::TLS> object that is used	1654	The second argument is the optional C<AnyEvent::TLS> object that is used
…		…
1456	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS	1659	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS
1457	context in C<< $handle->{tls_ctx} >> after this call and can be used or	1660	context in C<< $handle->{tls_ctx} >> after this call and can be used or
1458	changed to your liking. Note that the handshake might have already started	1661	changed to your liking. Note that the handshake might have already started
1459	when this function returns.	1662	when this function returns.
1460		1663
1461	If it an error to start a TLS handshake more than once per	1664	Due to bugs in OpenSSL, it might or might not be possible to do multiple
1462	AnyEvent::Handle object (this is due to bugs in OpenSSL).	1665	handshakes on the same stream. Best do not attempt to use the stream after
		1666	stopping TLS.
1463		1667
1464	=cut	1668	=cut
		1669
		1670	our %TLS_CACHE; #TODO not yet documented, should we?
1465		1671
1466	sub starttls {	1672	sub starttls {
1467	my ($self, $ssl, $ctx) = @_;	1673	my ($self, $tls, $ctx) = @_;
		1674
		1675	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"
		1676	if $self->{tls};
		1677
		1678	$self->{tls} = $tls;
		1679	$self->{tls_ctx} = $ctx if @_ > 2;
		1680
		1681	return unless $self->{fh};
1468		1682
1469	require Net::SSLeay;	1683	require Net::SSLeay;
1470		1684
1471	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"
1472	if $self->{tls};
1473
1474	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();	1685	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1475	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();	1686	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1476	$ERROR_ZERO_RETURN = Net::SSLeay::ERROR_ZERO_RETURN ();
1477		1687
		1688	$tls = $self->{tls};
1478	$ctx \|\|= $self->{tls_ctx};	1689	$ctx = $self->{tls_ctx};
		1690
		1691	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
1479		1692
1480	if ("HASH" eq ref $ctx) {	1693	if ("HASH" eq ref $ctx) {
1481	require AnyEvent::TLS;	1694	require AnyEvent::TLS;
1482		1695
1483	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context	1696	if ($ctx->{cache}) {
		1697	my $key = $ctx+0;
		1698	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;
		1699	} else {
1484	$ctx = new AnyEvent::TLS %$ctx;	1700	$ctx = new AnyEvent::TLS %$ctx;
		1701	}
1485	}	1702	}
1486		1703
1487	$self->{tls_ctx} = $ctx \|\| TLS_CTX ();	1704	$self->{tls_ctx} = $ctx \|\| TLS_CTX ();
1488	$self->{tls} = $ssl = $self->{tls_ctx}->_get_session ($ssl, $self, $self->{peername});	1705	$self->{tls} = $tls = $self->{tls_ctx}->_get_session ($tls, $self, $self->{peername});
1489		1706
1490	# basically, this is deep magic (because SSL_read should have the same issues)	1707	# basically, this is deep magic (because SSL_read should have the same issues)
1491	# but the openssl maintainers basically said: "trust us, it just works".	1708	# but the openssl maintainers basically said: "trust us, it just works".
1492	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1709	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1493	# and mismaintained ssleay-module doesn't even offer them).	1710	# and mismaintained ssleay-module doesn't even offer them).
…		…
1500	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to	1717	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
1501	# have identity issues in that area.	1718	# have identity issues in that area.
1502	# Net::SSLeay::CTX_set_mode ($ssl,	1719	# Net::SSLeay::CTX_set_mode ($ssl,
1503	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1720	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
1504	# \| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));	1721	# \| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
1505	Net::SSLeay::CTX_set_mode ($ssl, 1\|2);	1722	Net::SSLeay::CTX_set_mode ($tls, 1\|2);
1506		1723
1507	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1724	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1508	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1725	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1509		1726
1510	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1727	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
		1728
		1729	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
		1730	if $self->{on_starttls};
1511		1731
1512	&_dotls; # need to trigger the initial handshake	1732	&_dotls; # need to trigger the initial handshake
1513	$self->start_read; # make sure we actually do read	1733	$self->start_read; # make sure we actually do read
1514	}	1734	}
1515		1735
1516	=item $handle->stoptls	1736	=item $handle->stoptls
1517		1737
1518	Shuts down the SSL connection - this makes a proper EOF handshake by	1738	Shuts down the SSL connection - this makes a proper EOF handshake by
1519	sending a close notify to the other side, but since OpenSSL doesn't	1739	sending a close notify to the other side, but since OpenSSL doesn't
1520	support non-blocking shut downs, it is not possible to re-use the stream	1740	support non-blocking shut downs, it is not guarenteed that you can re-use
1521	afterwards.	1741	the stream afterwards.
1522		1742
1523	=cut	1743	=cut
1524		1744
1525	sub stoptls {	1745	sub stoptls {
1526	my ($self) = @_;	1746	my ($self) = @_;
…		…
1528	if ($self->{tls}) {	1748	if ($self->{tls}) {
1529	Net::SSLeay::shutdown ($self->{tls});	1749	Net::SSLeay::shutdown ($self->{tls});
1530		1750
1531	&_dotls;	1751	&_dotls;
1532		1752
1533	# we don't give a shit. no, we do, but we can't. no...	1753	# # we don't give a shit. no, we do, but we can't. no...#d#
1534	# we, we... have to use openssl :/	1754	# # we, we... have to use openssl :/#d#
1535	&_freetls;	1755	# &_freetls;#d#
1536	}	1756	}
1537	}	1757	}
1538		1758
1539	sub _freetls {	1759	sub _freetls {
1540	my ($self) = @_;	1760	my ($self) = @_;
1541		1761
1542	return unless $self->{tls};	1762	return unless $self->{tls};
1543		1763
1544	$self->{tls_ctx}->_put_session (delete $self->{tls});	1764	$self->{tls_ctx}->_put_session (delete $self->{tls})
		1765	if ref $self->{tls};
1545		1766
1546	delete @$self{qw(_rbio _wbio _tls_wbuf)};	1767	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1547	}	1768	}
1548		1769
1549	sub DESTROY {	1770	sub DESTROY {
1550	my ($self) = @_;	1771	my ($self) = @_;
1551		1772
1552	&_freetls;	1773	&_freetls;
1553		1774
1554	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	1775	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1555		1776
1556	if ($linger && length $self->{wbuf}) {	1777	if ($linger && length $self->{wbuf} && $self->{fh}) {
1557	my $fh = delete $self->{fh};	1778	my $fh = delete $self->{fh};
1558	my $wbuf = delete $self->{wbuf};	1779	my $wbuf = delete $self->{wbuf};
1559		1780
1560	my @linger;	1781	my @linger;
1561		1782
…		…
1575	}	1796	}
1576		1797
1577	=item $handle->destroy	1798	=item $handle->destroy
1578		1799
1579	Shuts down the handle object as much as possible - this call ensures that	1800	Shuts down the handle object as much as possible - this call ensures that
1580	no further callbacks will be invoked and resources will be freed as much	1801	no further callbacks will be invoked and as many resources as possible
1581	as possible. You must not call any methods on the object afterwards.	1802	will be freed. You must not call any methods on the object afterwards.
1582		1803
1583	Normally, you can just "forget" any references to an AnyEvent::Handle	1804	Normally, you can just "forget" any references to an AnyEvent::Handle
1584	object and it will simply shut down. This works in fatal error and EOF	1805	object and it will simply shut down. This works in fatal error and EOF
1585	callbacks, as well as code outside. It does I<NOT> work in a read or write	1806	callbacks, as well as code outside. It does I<NOT> work in a read or write
1586	callback, so when you want to destroy the AnyEvent::Handle object from	1807	callback, so when you want to destroy the AnyEvent::Handle object from
1587	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in	1808	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
1588	that case.	1809	that case.
1589		1810
		1811	Destroying the handle object in this way has the advantage that callbacks
		1812	will be removed as well, so if those are the only reference holders (as
		1813	is common), then one doesn't need to do anything special to break any
		1814	reference cycles.
		1815
1590	The handle might still linger in the background and write out remaining	1816	The handle might still linger in the background and write out remaining
1591	data, as specified by the C<linger> option, however.	1817	data, as specified by the C<linger> option, however.
1592		1818
1593	=cut	1819	=cut
1594		1820
…		…
1661		1887
1662	$handle->on_read (sub { });	1888	$handle->on_read (sub { });
1663	$handle->on_eof (undef);	1889	$handle->on_eof (undef);
1664	$handle->on_error (sub {	1890	$handle->on_error (sub {
1665	my $data = delete $_[0]{rbuf};	1891	my $data = delete $_[0]{rbuf};
1666	undef $handle;
1667	});	1892	});
1668		1893
1669	The reason to use C<on_error> is that TCP connections, due to latencies	1894	The reason to use C<on_error> is that TCP connections, due to latencies
1670	and packets loss, might get closed quite violently with an error, when in	1895	and packets loss, might get closed quite violently with an error, when in
1671	fact, all data has been received.	1896	fact, all data has been received.
…		…
1687	$handle->on_drain (sub {	1912	$handle->on_drain (sub {
1688	warn "all data submitted to the kernel\n";	1913	warn "all data submitted to the kernel\n";
1689	undef $handle;	1914	undef $handle;
1690	});	1915	});
1691		1916
		1917	If you just want to queue some data and then signal EOF to the other side,
		1918	consider using C<< ->push_shutdown >> instead.
		1919
		1920	=item I want to contact a TLS/SSL server, I don't care about security.
		1921
		1922	If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS,
		1923	simply connect to it and then create the AnyEvent::Handle with the C<tls>
		1924	parameter:
		1925
		1926	tcp_connect $host, $port, sub {
		1927	my ($fh) = @_;
		1928
		1929	my $handle = new AnyEvent::Handle
		1930	fh => $fh,
		1931	tls => "connect",
		1932	on_error => sub { ... };
		1933
		1934	$handle->push_write (...);
		1935	};
		1936
		1937	=item I want to contact a TLS/SSL server, I do care about security.
		1938
		1939	Then you should additionally enable certificate verification, including
		1940	peername verification, if the protocol you use supports it (see
		1941	L<AnyEvent::TLS>, C<verify_peername>).
		1942
		1943	E.g. for HTTPS:
		1944
		1945	tcp_connect $host, $port, sub {
		1946	my ($fh) = @_;
		1947
		1948	my $handle = new AnyEvent::Handle
		1949	fh => $fh,
		1950	peername => $host,
		1951	tls => "connect",
		1952	tls_ctx => { verify => 1, verify_peername => "https" },
		1953	...
		1954
		1955	Note that you must specify the hostname you connected to (or whatever
		1956	"peername" the protocol needs) as the C<peername> argument, otherwise no
		1957	peername verification will be done.
		1958
		1959	The above will use the system-dependent default set of trusted CA
		1960	certificates. If you want to check against a specific CA, add the
		1961	C<ca_file> (or C<ca_cert>) arguments to C<tls_ctx>:
		1962
		1963	tls_ctx => {
		1964	verify => 1,
		1965	verify_peername => "https",
		1966	ca_file => "my-ca-cert.pem",
		1967	},
		1968
		1969	=item I want to create a TLS/SSL server, how do I do that?
		1970
		1971	Well, you first need to get a server certificate and key. You have
		1972	three options: a) ask a CA (buy one, use cacert.org etc.) b) create a
		1973	self-signed certificate (cheap. check the search engine of your choice,
		1974	there are many tutorials on the net) or c) make your own CA (tinyca2 is a
		1975	nice program for that purpose).
		1976
		1977	Then create a file with your private key (in PEM format, see
		1978	L<AnyEvent::TLS>), followed by the certificate (also in PEM format). The
		1979	file should then look like this:
		1980
		1981	-----BEGIN RSA PRIVATE KEY-----
		1982	...header data
		1983	... lots of base64'y-stuff
		1984	-----END RSA PRIVATE KEY-----
		1985
		1986	-----BEGIN CERTIFICATE-----
		1987	... lots of base64'y-stuff
		1988	-----END CERTIFICATE-----
		1989
		1990	The important bits are the "PRIVATE KEY" and "CERTIFICATE" parts. Then
		1991	specify this file as C<cert_file>:
		1992
		1993	tcp_server undef, $port, sub {
		1994	my ($fh) = @_;
		1995
		1996	my $handle = new AnyEvent::Handle
		1997	fh => $fh,
		1998	tls => "accept",
		1999	tls_ctx => { cert_file => "my-server-keycert.pem" },
		2000	...
		2001
		2002	When you have intermediate CA certificates that your clients might not
		2003	know about, just append them to the C<cert_file>.
		2004
1692	=back	2005	=back
1693		2006
1694		2007
1695	=head1 SUBCLASSING AnyEvent::Handle	2008	=head1 SUBCLASSING AnyEvent::Handle
1696		2009

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.134 by root, Fri Jul 3 00:09:04 2009 UTC vs. Revision 1.163 by root, Mon Jul 27 22:08:52 2009 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.134 by root, Fri Jul 3 00:09:04 2009 UTC vs.
Revision 1.163 by root, Mon Jul 27 22:08:52 2009 UTC