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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.139 by root, Sun Jul 5 23:39:48 2009 UTC vs.
Revision 1.172 by root, Wed Aug 5 20:50:27 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.901;
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)
…		…
447	# reset the timeout watcher, as neccessary	632	# reset the timeout watcher, as neccessary
448	# also check for time-outs	633	# also check for time-outs
449	sub _timeout {	634	sub _timeout {
450	my ($self) = @_;	635	my ($self) = @_;
451		636
452	if ($self->{timeout}) {	637	if ($self->{timeout} && $self->{fh}) {
453	my $NOW = AnyEvent->now;	638	my $NOW = AnyEvent->now;
454		639
455	# when would the timeout trigger?	640	# when would the timeout trigger?
456	my $after = $self->{_activity} + $self->{timeout} - $NOW;	641	my $after = $self->{_activity} + $self->{timeout} - $NOW;
457		642
…		…
460	$self->{_activity} = $NOW;	645	$self->{_activity} = $NOW;
461		646
462	if ($self->{on_timeout}) {	647	if ($self->{on_timeout}) {
463	$self->{on_timeout}($self);	648	$self->{on_timeout}($self);
464	} else {	649	} else {
465	$self->_error (&Errno::ETIMEDOUT);	650	$self->_error (Errno::ETIMEDOUT);
466	}	651	}
467		652
468	# callback could have changed timeout value, optimise	653	# callback could have changed timeout value, optimise
469	return unless $self->{timeout};	654	return unless $self->{timeout};
470		655
…		…
533	Scalar::Util::weaken $self;	718	Scalar::Util::weaken $self;
534		719
535	my $cb = sub {	720	my $cb = sub {
536	my $len = syswrite $self->{fh}, $self->{wbuf};	721	my $len = syswrite $self->{fh}, $self->{wbuf};
537		722
538	if ($len >= 0) {	723	if (defined $len) {
539	substr $self->{wbuf}, 0, $len, "";	724	substr $self->{wbuf}, 0, $len, "";
540		725
541	$self->{_activity} = AnyEvent->now;	726	$self->{_activity} = AnyEvent->now;
542		727
543	$self->{on_drain}($self)	728	$self->{on_drain}($self)
…		…
575	->($self, @_);	760	->($self, @_);
576	}	761	}
577		762
578	if ($self->{tls}) {	763	if ($self->{tls}) {
579	$self->{_tls_wbuf} .= $_[0];	764	$self->{_tls_wbuf} .= $_[0];
580		765	&_dotls ($self) if $self->{fh};
581	&_dotls ($self);
582	} else {	766	} else {
583	$self->{wbuf} .= $_[0];	767	$self->{wbuf} .= $_[0];
584	$self->_drain_wbuf;	768	$self->_drain_wbuf if $self->{fh};
585	}	769	}
586	}	770	}
587		771
588	=item $handle->push_write (type => @args)	772	=item $handle->push_write (type => @args)
589		773
…		…
683		867
684	=item $handle->push_shutdown	868	=item $handle->push_shutdown
685		869
686	Sometimes you know you want to close the socket after writing your data	870	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	871	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	872	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:	873	C<low_water_mark> to C<0>). This method is a shorthand for just that, and
		874	replaces the C<on_drain> callback with:
690		875
691	sub { shutdown $_[0]{fh}, 1 } # for push_shutdown	876	sub { shutdown $_[0]{fh}, 1 } # for push_shutdown
692		877
693	This simply shuts down the write side and signals an EOF condition to the	878	This simply shuts down the write side and signals an EOF condition to the
694	the peer.	879	the peer.
…		…
697	afterwards. This is the cleanest way to close a connection.	882	afterwards. This is the cleanest way to close a connection.
698		883
699	=cut	884	=cut
700		885
701	sub push_shutdown {	886	sub push_shutdown {
		887	my ($self) = @_;
		888
		889	delete $self->{low_water_mark};
702	$_[0]->{on_drain} = sub { shutdown $_[0]{fh}, 1 };	890	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });
703	}	891	}
704		892
705	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	893	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
706		894
707	This function (not method) lets you add your own types to C<push_write>.	895	This function (not method) lets you add your own types to C<push_write>.
…		…
802	=cut	990	=cut
803		991
804	sub _drain_rbuf {	992	sub _drain_rbuf {
805	my ($self) = @_;	993	my ($self) = @_;
806		994
		995	# avoid recursion
		996	return if $self->{_skip_drain_rbuf};
807	local $self->{_in_drain} = 1;	997	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		998
816	while () {	999	while () {
817	# we need to use a separate tls read buffer, as we must not receive data while	1000	# 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.	1001	# we are draining the buffer, and this can only happen with TLS.
819	$self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf};	1002	$self->{rbuf} .= delete $self->{_tls_rbuf}
		1003	if exists $self->{_tls_rbuf};
820		1004
821	my $len = length $self->{rbuf};	1005	my $len = length $self->{rbuf};
822		1006
823	if (my $cb = shift @{ $self->{_queue} }) {	1007	if (my $cb = shift @{ $self->{_queue} }) {
824	unless ($cb->($self)) {	1008	unless ($cb->($self)) {
825	if ($self->{_eof}) {	1009	# no progress can be made
826	# no progress can be made (not enough data and no data forthcoming)	1010	# (not enough data and no data forthcoming)
827	$self->_error (&Errno::EPIPE, 1), return;	1011	$self->_error (Errno::EPIPE, 1), return
828	}	1012	if $self->{_eof};
829		1013
830	unshift @{ $self->{_queue} }, $cb;	1014	unshift @{ $self->{_queue} }, $cb;
831	last;	1015	last;
832	}	1016	}
833	} elsif ($self->{on_read}) {	1017	} elsif ($self->{on_read}) {
…		…
840	&& !@{ $self->{_queue} } # and the queue is still empty	1024	&& !@{ $self->{_queue} } # and the queue is still empty
841	&& $self->{on_read} # but we still have on_read	1025	&& $self->{on_read} # but we still have on_read
842	) {	1026	) {
843	# no further data will arrive	1027	# no further data will arrive
844	# so no progress can be made	1028	# so no progress can be made
845	$self->_error (&Errno::EPIPE, 1), return	1029	$self->_error (Errno::EPIPE, 1), return
846	if $self->{_eof};	1030	if $self->{_eof};
847		1031
848	last; # more data might arrive	1032	last; # more data might arrive
849	}	1033	}
850	} else {	1034	} else {
…		…
853	last;	1037	last;
854	}	1038	}
855	}	1039	}
856		1040
857	if ($self->{_eof}) {	1041	if ($self->{_eof}) {
858	if ($self->{on_eof}) {	1042	$self->{on_eof}
859	$self->{on_eof}($self)	1043	? $self->{on_eof}($self)
860	} else {	1044	: $self->_error (0, 1, "Unexpected end-of-file");
861	$self->_error (0, 1);	1045
862	}	1046	return;
		1047	}
		1048
		1049	if (
		1050	defined $self->{rbuf_max}
		1051	&& $self->{rbuf_max} < length $self->{rbuf}
		1052	) {
		1053	$self->_error (Errno::ENOSPC, 1), return;
863	}	1054	}
864		1055
865	# may need to restart read watcher	1056	# may need to restart read watcher
866	unless ($self->{_rw}) {	1057	unless ($self->{_rw}) {
867	$self->start_read	1058	$self->start_read
…		…
879		1070
880	sub on_read {	1071	sub on_read {
881	my ($self, $cb) = @_;	1072	my ($self, $cb) = @_;
882		1073
883	$self->{on_read} = $cb;	1074	$self->{on_read} = $cb;
884	$self->_drain_rbuf if $cb && !$self->{_in_drain};	1075	$self->_drain_rbuf if $cb;
885	}	1076	}
886		1077
887	=item $handle->rbuf	1078	=item $handle->rbuf
888		1079
889	Returns the read buffer (as a modifiable lvalue).	1080	Returns the read buffer (as a modifiable lvalue).
…		…
941	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	1132	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
942	->($self, $cb, @_);	1133	->($self, $cb, @_);
943	}	1134	}
944		1135
945	push @{ $self->{_queue} }, $cb;	1136	push @{ $self->{_queue} }, $cb;
946	$self->_drain_rbuf unless $self->{_in_drain};	1137	$self->_drain_rbuf;
947	}	1138	}
948		1139
949	sub unshift_read {	1140	sub unshift_read {
950	my $self = shift;	1141	my $self = shift;
951	my $cb = pop;	1142	my $cb = pop;
…		…
957	->($self, $cb, @_);	1148	->($self, $cb, @_);
958	}	1149	}
959		1150
960		1151
961	unshift @{ $self->{_queue} }, $cb;	1152	unshift @{ $self->{_queue} }, $cb;
962	$self->_drain_rbuf unless $self->{_in_drain};	1153	$self->_drain_rbuf;
963	}	1154	}
964		1155
965	=item $handle->push_read (type => @args, $cb)	1156	=item $handle->push_read (type => @args, $cb)
966		1157
967	=item $handle->unshift_read (type => @args, $cb)	1158	=item $handle->unshift_read (type => @args, $cb)
…		…
1100	return 1;	1291	return 1;
1101	}	1292	}
1102		1293
1103	# reject	1294	# reject
1104	if ($reject && $$rbuf =~ $reject) {	1295	if ($reject && $$rbuf =~ $reject) {
1105	$self->_error (&Errno::EBADMSG);	1296	$self->_error (Errno::EBADMSG);
1106	}	1297	}
1107		1298
1108	# skip	1299	# skip
1109	if ($skip && $$rbuf =~ $skip) {	1300	if ($skip && $$rbuf =~ $skip) {
1110	$data .= substr $$rbuf, 0, $+[0], "";	1301	$data .= substr $$rbuf, 0, $+[0], "";
…		…
1126	my ($self, $cb) = @_;	1317	my ($self, $cb) = @_;
1127		1318
1128	sub {	1319	sub {
1129	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {	1320	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
1130	if ($_[0]{rbuf} =~ /[^0-9]/) {	1321	if ($_[0]{rbuf} =~ /[^0-9]/) {
1131	$self->_error (&Errno::EBADMSG);	1322	$self->_error (Errno::EBADMSG);
1132	}	1323	}
1133	return;	1324	return;
1134	}	1325	}
1135		1326
1136	my $len = $1;	1327	my $len = $1;
…		…
1139	my $string = $_[1];	1330	my $string = $_[1];
1140	$_[0]->unshift_read (chunk => 1, sub {	1331	$_[0]->unshift_read (chunk => 1, sub {
1141	if ($_[1] eq ",") {	1332	if ($_[1] eq ",") {
1142	$cb->($_[0], $string);	1333	$cb->($_[0], $string);
1143	} else {	1334	} else {
1144	$self->_error (&Errno::EBADMSG);	1335	$self->_error (Errno::EBADMSG);
1145	}	1336	}
1146	});	1337	});
1147	});	1338	});
1148		1339
1149	1	1340	1
…		…
1239	$json->incr_skip;	1430	$json->incr_skip;
1240		1431
1241	$self->{rbuf} = $json->incr_text;	1432	$self->{rbuf} = $json->incr_text;
1242	$json->incr_text = "";	1433	$json->incr_text = "";
1243		1434
1244	$self->_error (&Errno::EBADMSG);	1435	$self->_error (Errno::EBADMSG);
1245		1436
1246	()	1437	()
1247	} else {	1438	} else {
1248	$self->{rbuf} = "";	1439	$self->{rbuf} = "";
1249		1440
…		…
1286	# read remaining chunk	1477	# read remaining chunk
1287	$_[0]->unshift_read (chunk => $len, sub {	1478	$_[0]->unshift_read (chunk => $len, sub {
1288	if (my $ref = eval { Storable::thaw ($_[1]) }) {	1479	if (my $ref = eval { Storable::thaw ($_[1]) }) {
1289	$cb->($_[0], $ref);	1480	$cb->($_[0], $ref);
1290	} else {	1481	} else {
1291	$self->_error (&Errno::EBADMSG);	1482	$self->_error (Errno::EBADMSG);
1292	}	1483	}
1293	});	1484	});
1294	}	1485	}
1295		1486
1296	1	1487	1
…		…
1360	if ($self->{tls}) {	1551	if ($self->{tls}) {
1361	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);	1552	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1362		1553
1363	&_dotls ($self);	1554	&_dotls ($self);
1364	} else {	1555	} else {
1365	$self->_drain_rbuf unless $self->{_in_drain};	1556	$self->_drain_rbuf;
1366	}	1557	}
1367		1558
1368	} elsif (defined $len) {	1559	} elsif (defined $len) {
1369	delete $self->{_rw};	1560	delete $self->{_rw};
1370	$self->{_eof} = 1;	1561	$self->{_eof} = 1;
1371	$self->_drain_rbuf unless $self->{_in_drain};	1562	$self->_drain_rbuf;
1372		1563
1373	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1564	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1374	return $self->_error ($!, 1);	1565	return $self->_error ($!, 1);
1375	}	1566	}
1376	});	1567	});
1377	}	1568	}
1378	}	1569	}
1379		1570
1380	our $ERROR_SYSCALL;	1571	our $ERROR_SYSCALL;
1381	our $ERROR_WANT_READ;	1572	our $ERROR_WANT_READ;
1382	our $ERROR_ZERO_RETURN;
1383		1573
1384	sub _tls_error {	1574	sub _tls_error {
1385	my ($self, $err) = @_;	1575	my ($self, $err) = @_;
1386		1576
1387	return $self->_error ($!, 1)	1577	return $self->_error ($!, 1)
…		…
1390	my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());	1580	my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());
1391		1581
1392	# reduce error string to look less scary	1582	# reduce error string to look less scary
1393	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;	1583	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;
1394		1584
		1585	if ($self->{_on_starttls}) {
		1586	(delete $self->{_on_starttls})->($self, undef, $err);
		1587	&_freetls;
		1588	} else {
		1589	&_freetls;
1395	$self->_error (&Errno::EPROTO, 1, $err);	1590	$self->_error (Errno::EPROTO, 1, $err);
		1591	}
1396	}	1592	}
1397		1593
1398	# poll the write BIO and send the data if applicable	1594	# poll the write BIO and send the data if applicable
1399	# also decode read data if possible	1595	# also decode read data if possible
1400	# this is basiclaly our TLS state machine	1596	# this is basiclaly our TLS state machine
…		…
1411	}	1607	}
1412		1608
1413	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);	1609	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);
1414	return $self->_tls_error ($tmp)	1610	return $self->_tls_error ($tmp)
1415	if $tmp != $ERROR_WANT_READ	1611	if $tmp != $ERROR_WANT_READ
1416	&& ($tmp != $ERROR_SYSCALL \|\| $!)	1612	&& ($tmp != $ERROR_SYSCALL \|\| $!);
1417	&& $tmp != $ERROR_ZERO_RETURN;
1418	}	1613	}
1419		1614
1420	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {	1615	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
1421	unless (length $tmp) {	1616	unless (length $tmp) {
1422	# let's treat SSL-eof as we treat normal EOF	1617	$self->{_on_starttls}
1423	delete $self->{_rw};	1618	and (delete $self->{_on_starttls})->($self, undef, "EOF during handshake"); # ???
1424	$self->{_eof} = 1;
1425	&_freetls;	1619	&_freetls;
		1620
		1621	if ($self->{on_stoptls}) {
		1622	$self->{on_stoptls}($self);
		1623	return;
		1624	} else {
		1625	# let's treat SSL-eof as we treat normal EOF
		1626	delete $self->{_rw};
		1627	$self->{_eof} = 1;
		1628	}
1426	}	1629	}
1427		1630
1428	$self->{_tls_rbuf} .= $tmp;	1631	$self->{_tls_rbuf} .= $tmp;
1429	$self->_drain_rbuf unless $self->{_in_drain};	1632	$self->_drain_rbuf;
1430	$self->{tls} or return; # tls session might have gone away in callback	1633	$self->{tls} or return; # tls session might have gone away in callback
1431	}	1634	}
1432		1635
1433	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);	1636	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1434	return $self->_tls_error ($tmp)	1637	return $self->_tls_error ($tmp)
1435	if $tmp != $ERROR_WANT_READ	1638	if $tmp != $ERROR_WANT_READ
1436	&& ($tmp != $ERROR_SYSCALL \|\| $!)	1639	&& ($tmp != $ERROR_SYSCALL \|\| $!);
1437	&& $tmp != $ERROR_ZERO_RETURN;
1438		1640
1439	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1641	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1440	$self->{wbuf} .= $tmp;	1642	$self->{wbuf} .= $tmp;
1441	$self->_drain_wbuf;	1643	$self->_drain_wbuf;
1442	}	1644	}
		1645
		1646	$self->{_on_starttls}
		1647	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
		1648	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");
1443	}	1649	}
1444		1650
1445	=item $handle->starttls ($tls[, $tls_ctx])	1651	=item $handle->starttls ($tls[, $tls_ctx])
1446		1652
1447	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	1653	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	1654	object is created, you can also do that at a later time by calling
1449	C<starttls>.	1655	C<starttls>.
		1656
		1657	Starting TLS is currently an asynchronous operation - when you push some
		1658	write data and then call C<< ->starttls >> then TLS negotiation will start
		1659	immediately, after which the queued write data is then sent.
1450		1660
1451	The first argument is the same as the C<tls> constructor argument (either	1661	The first argument is the same as the C<tls> constructor argument (either
1452	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1662	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1453		1663
1454	The second argument is the optional C<AnyEvent::TLS> object that is used	1664	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	1669	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	1670	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	1671	changed to your liking. Note that the handshake might have already started
1462	when this function returns.	1672	when this function returns.
1463		1673
1464	If it an error to start a TLS handshake more than once per	1674	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).	1675	handshakes on the same stream. Best do not attempt to use the stream after
		1676	stopping TLS.
1466		1677
1467	=cut	1678	=cut
1468		1679
1469	our %TLS_CACHE; #TODO not yet documented, should we?	1680	our %TLS_CACHE; #TODO not yet documented, should we?
1470		1681
1471	sub starttls {	1682	sub starttls {
1472	my ($self, $ssl, $ctx) = @_;	1683	my ($self, $tls, $ctx) = @_;
		1684
		1685	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"
		1686	if $self->{tls};
		1687
		1688	$self->{tls} = $tls;
		1689	$self->{tls_ctx} = $ctx if @_ > 2;
		1690
		1691	return unless $self->{fh};
1473		1692
1474	require Net::SSLeay;	1693	require Net::SSLeay;
1475		1694
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 ();	1695	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1480	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();	1696	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1481	$ERROR_ZERO_RETURN = Net::SSLeay::ERROR_ZERO_RETURN ();
1482		1697
		1698	$tls = $self->{tls};
1483	$ctx \|\|= $self->{tls_ctx};	1699	$ctx = $self->{tls_ctx};
		1700
		1701	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
1484		1702
1485	if ("HASH" eq ref $ctx) {	1703	if ("HASH" eq ref $ctx) {
1486	require AnyEvent::TLS;	1704	require AnyEvent::TLS;
1487
1488	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context
1489		1705
1490	if ($ctx->{cache}) {	1706	if ($ctx->{cache}) {
1491	my $key = $ctx+0;	1707	my $key = $ctx+0;
1492	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;	1708	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;
1493	} else {	1709	} else {
1494	$ctx = new AnyEvent::TLS %$ctx;	1710	$ctx = new AnyEvent::TLS %$ctx;
1495	}	1711	}
1496	}	1712	}
1497		1713
1498	$self->{tls_ctx} = $ctx \|\| TLS_CTX ();	1714	$self->{tls_ctx} = $ctx \|\| TLS_CTX ();
1499	$self->{tls} = $ssl = $self->{tls_ctx}->_get_session ($ssl, $self, $self->{peername});	1715	$self->{tls} = $tls = $self->{tls_ctx}->_get_session ($tls, $self, $self->{peername});
1500		1716
1501	# basically, this is deep magic (because SSL_read should have the same issues)	1717	# 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".	1718	# but the openssl maintainers basically said: "trust us, it just works".
1503	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1719	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1504	# and mismaintained ssleay-module doesn't even offer them).	1720	# 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	1727	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
1512	# have identity issues in that area.	1728	# have identity issues in that area.
1513	# Net::SSLeay::CTX_set_mode ($ssl,	1729	# Net::SSLeay::CTX_set_mode ($ssl,
1514	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1730	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
1515	# \| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));	1731	# \| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
1516	Net::SSLeay::CTX_set_mode ($ssl, 1\|2);	1732	Net::SSLeay::CTX_set_mode ($tls, 1\|2);
1517		1733
1518	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1734	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1519	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1735	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1520		1736
		1737	Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf});
		1738
1521	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1739	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
		1740
		1741	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
		1742	if $self->{on_starttls};
1522		1743
1523	&_dotls; # need to trigger the initial handshake	1744	&_dotls; # need to trigger the initial handshake
1524	$self->start_read; # make sure we actually do read	1745	$self->start_read; # make sure we actually do read
1525	}	1746	}
1526		1747
1527	=item $handle->stoptls	1748	=item $handle->stoptls
1528		1749
1529	Shuts down the SSL connection - this makes a proper EOF handshake by	1750	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	1751	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	1752	support non-blocking shut downs, it is not guarenteed that you can re-use
1532	afterwards.	1753	the stream afterwards.
1533		1754
1534	=cut	1755	=cut
1535		1756
1536	sub stoptls {	1757	sub stoptls {
1537	my ($self) = @_;	1758	my ($self) = @_;
…		…
1539	if ($self->{tls}) {	1760	if ($self->{tls}) {
1540	Net::SSLeay::shutdown ($self->{tls});	1761	Net::SSLeay::shutdown ($self->{tls});
1541		1762
1542	&_dotls;	1763	&_dotls;
1543		1764
1544	# we don't give a shit. no, we do, but we can't. no...	1765	# # we don't give a shit. no, we do, but we can't. no...#d#
1545	# we, we... have to use openssl :/	1766	# # we, we... have to use openssl :/#d#
1546	&_freetls;	1767	# &_freetls;#d#
1547	}	1768	}
1548	}	1769	}
1549		1770
1550	sub _freetls {	1771	sub _freetls {
1551	my ($self) = @_;	1772	my ($self) = @_;
1552		1773
1553	return unless $self->{tls};	1774	return unless $self->{tls};
1554		1775
1555	$self->{tls_ctx}->_put_session (delete $self->{tls});	1776	$self->{tls_ctx}->_put_session (delete $self->{tls})
		1777	if $self->{tls} > 0;
1556		1778
1557	delete @$self{qw(_rbio _wbio _tls_wbuf)};	1779	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1558	}	1780	}
1559		1781
1560	sub DESTROY {	1782	sub DESTROY {
1561	my ($self) = @_;	1783	my ($self) = @_;
1562		1784
1563	&_freetls;	1785	&_freetls;
1564		1786
1565	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	1787	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1566		1788
1567	if ($linger && length $self->{wbuf}) {	1789	if ($linger && length $self->{wbuf} && $self->{fh}) {
1568	my $fh = delete $self->{fh};	1790	my $fh = delete $self->{fh};
1569	my $wbuf = delete $self->{wbuf};	1791	my $wbuf = delete $self->{wbuf};
1570		1792
1571	my @linger;	1793	my @linger;
1572		1794
…		…
1586	}	1808	}
1587		1809
1588	=item $handle->destroy	1810	=item $handle->destroy
1589		1811
1590	Shuts down the handle object as much as possible - this call ensures that	1812	Shuts down the handle object as much as possible - this call ensures that
1591	no further callbacks will be invoked and resources will be freed as much	1813	no further callbacks will be invoked and as many resources as possible
1592	as possible. You must not call any methods on the object afterwards.	1814	will be freed. Any method you will call on the handle object after
		1815	destroying it in this way will be silently ignored (and it will return the
		1816	empty list).
1593		1817
1594	Normally, you can just "forget" any references to an AnyEvent::Handle	1818	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	1819	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	1820	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	1821	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	1822	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
1599	that case.	1823	that case.
1600		1824
		1825	Destroying the handle object in this way has the advantage that callbacks
		1826	will be removed as well, so if those are the only reference holders (as
		1827	is common), then one doesn't need to do anything special to break any
		1828	reference cycles.
		1829
1601	The handle might still linger in the background and write out remaining	1830	The handle might still linger in the background and write out remaining
1602	data, as specified by the C<linger> option, however.	1831	data, as specified by the C<linger> option, however.
1603		1832
1604	=cut	1833	=cut
1605		1834
1606	sub destroy {	1835	sub destroy {
1607	my ($self) = @_;	1836	my ($self) = @_;
1608		1837
1609	$self->DESTROY;	1838	$self->DESTROY;
1610	%$self = ();	1839	%$self = ();
		1840	bless $self, "AnyEvent::Handle::destroyed";
		1841	}
		1842
		1843	sub AnyEvent::Handle::destroyed::AUTOLOAD {
		1844	#nop
1611	}	1845	}
1612		1846
1613	=item AnyEvent::Handle::TLS_CTX	1847	=item AnyEvent::Handle::TLS_CTX
1614		1848
1615	This function creates and returns the AnyEvent::TLS object used by default	1849	This function creates and returns the AnyEvent::TLS object used by default
…		…
1672		1906
1673	$handle->on_read (sub { });	1907	$handle->on_read (sub { });
1674	$handle->on_eof (undef);	1908	$handle->on_eof (undef);
1675	$handle->on_error (sub {	1909	$handle->on_error (sub {
1676	my $data = delete $_[0]{rbuf};	1910	my $data = delete $_[0]{rbuf};
1677	undef $handle;
1678	});	1911	});
1679		1912
1680	The reason to use C<on_error> is that TCP connections, due to latencies	1913	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	1914	and packets loss, might get closed quite violently with an error, when in
1682	fact, all data has been received.	1915	fact, all data has been received.
…		…
1698	$handle->on_drain (sub {	1931	$handle->on_drain (sub {
1699	warn "all data submitted to the kernel\n";	1932	warn "all data submitted to the kernel\n";
1700	undef $handle;	1933	undef $handle;
1701	});	1934	});
1702		1935
		1936	If you just want to queue some data and then signal EOF to the other side,
		1937	consider using C<< ->push_shutdown >> instead.
		1938
		1939	=item I want to contact a TLS/SSL server, I don't care about security.
		1940
		1941	If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS,
		1942	simply connect to it and then create the AnyEvent::Handle with the C<tls>
		1943	parameter:
		1944
		1945	tcp_connect $host, $port, sub {
		1946	my ($fh) = @_;
		1947
		1948	my $handle = new AnyEvent::Handle
		1949	fh => $fh,
		1950	tls => "connect",
		1951	on_error => sub { ... };
		1952
		1953	$handle->push_write (...);
		1954	};
		1955
		1956	=item I want to contact a TLS/SSL server, I do care about security.
		1957
		1958	Then you should additionally enable certificate verification, including
		1959	peername verification, if the protocol you use supports it (see
		1960	L<AnyEvent::TLS>, C<verify_peername>).
		1961
		1962	E.g. for HTTPS:
		1963
		1964	tcp_connect $host, $port, sub {
		1965	my ($fh) = @_;
		1966
		1967	my $handle = new AnyEvent::Handle
		1968	fh => $fh,
		1969	peername => $host,
		1970	tls => "connect",
		1971	tls_ctx => { verify => 1, verify_peername => "https" },
		1972	...
		1973
		1974	Note that you must specify the hostname you connected to (or whatever
		1975	"peername" the protocol needs) as the C<peername> argument, otherwise no
		1976	peername verification will be done.
		1977
		1978	The above will use the system-dependent default set of trusted CA
		1979	certificates. If you want to check against a specific CA, add the
		1980	C<ca_file> (or C<ca_cert>) arguments to C<tls_ctx>:
		1981
		1982	tls_ctx => {
		1983	verify => 1,
		1984	verify_peername => "https",
		1985	ca_file => "my-ca-cert.pem",
		1986	},
		1987
		1988	=item I want to create a TLS/SSL server, how do I do that?
		1989
		1990	Well, you first need to get a server certificate and key. You have
		1991	three options: a) ask a CA (buy one, use cacert.org etc.) b) create a
		1992	self-signed certificate (cheap. check the search engine of your choice,
		1993	there are many tutorials on the net) or c) make your own CA (tinyca2 is a
		1994	nice program for that purpose).
		1995
		1996	Then create a file with your private key (in PEM format, see
		1997	L<AnyEvent::TLS>), followed by the certificate (also in PEM format). The
		1998	file should then look like this:
		1999
		2000	-----BEGIN RSA PRIVATE KEY-----
		2001	...header data
		2002	... lots of base64'y-stuff
		2003	-----END RSA PRIVATE KEY-----
		2004
		2005	-----BEGIN CERTIFICATE-----
		2006	... lots of base64'y-stuff
		2007	-----END CERTIFICATE-----
		2008
		2009	The important bits are the "PRIVATE KEY" and "CERTIFICATE" parts. Then
		2010	specify this file as C<cert_file>:
		2011
		2012	tcp_server undef, $port, sub {
		2013	my ($fh) = @_;
		2014
		2015	my $handle = new AnyEvent::Handle
		2016	fh => $fh,
		2017	tls => "accept",
		2018	tls_ctx => { cert_file => "my-server-keycert.pem" },
		2019	...
		2020
		2021	When you have intermediate CA certificates that your clients might not
		2022	know about, just append them to the C<cert_file>.
		2023
1703	=back	2024	=back
1704		2025
1705		2026
1706	=head1 SUBCLASSING AnyEvent::Handle	2027	=head1 SUBCLASSING AnyEvent::Handle
1707		2028

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.139 by root, Sun Jul 5 23:39:48 2009 UTC vs. Revision 1.172 by root, Wed Aug 5 20:50:27 2009 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.139 by root, Sun Jul 5 23:39:48 2009 UTC vs.
Revision 1.172 by root, Wed Aug 5 20:50:27 2009 UTC