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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.141 by root, Mon Jul 6 01:03:09 2009 UTC vs.
Revision 1.160 by root, Fri Jul 24 22:47:04 2009 UTC

…		…
1	package AnyEvent::Handle;	1	package AnyEvent::Handle;
2		2
3	no warnings;
4	use strict qw(subs vars);
5
6	use AnyEvent ();
7	use AnyEvent::Util qw(WSAEWOULDBLOCK);
8	use Scalar::Util ();	3	use Scalar::Util ();
9	use Carp ();	4	use Carp ();
10	use Fcntl ();
11	use Errno qw(EAGAIN EINTR);	5	use Errno qw(EAGAIN EINTR);
12		6
		7	use AnyEvent (); BEGIN { AnyEvent::common_sense }
		8	use AnyEvent::Util qw(WSAEWOULDBLOCK);
		9
13	=head1 NAME	10	=head1 NAME
14		11
15	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent	12	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent
16		13
17	=cut	14	=cut
18		15
19	our $VERSION = 4.452;	16	our $VERSION = 4.86;
20		17
21	=head1 SYNOPSIS	18	=head1 SYNOPSIS
22		19
23	use AnyEvent;	20	use AnyEvent;
24	use AnyEvent::Handle;	21	use AnyEvent::Handle;
25		22
26	my $cv = AnyEvent->condvar;	23	my $cv = AnyEvent->condvar;
27		24
28	my $handle =	25	my $hdl; $hdl = new AnyEvent::Handle
29	AnyEvent::Handle->new (
30	fh => \*STDIN,	26	fh => \*STDIN,
31	on_eof => sub {	27	on_error => sub {
		28	my ($hdl, $fatal, $msg) = @_;
		29	warn "got error $msg\n";
		30	$hdl->destroy;
32	$cv->send;	31	$cv->send;
33	},
34	);	32	);
35		33
36	# send some request line	34	# send some request line
37	$handle->push_write ("getinfo\015\012");	35	$hdl->push_write ("getinfo\015\012");
38		36
39	# read the response line	37	# read the response line
40	$handle->push_read (line => sub {	38	$hdl->push_read (line => sub {
41	my ($handle, $line) = @_;	39	my ($hdl, $line) = @_;
42	warn "read line <$line>\n";	40	warn "got line <$line>\n";
43	$cv->send;	41	$cv->send;
44	});	42	});
45		43
46	$cv->recv;	44	$cv->recv;
47		45
48	=head1 DESCRIPTION	46	=head1 DESCRIPTION
49		47
50	This module is a helper module to make it easier to do event-based I/O on	48	This module is a helper module to make it easier to do event-based I/O on
51	filehandles. For utility functions for doing non-blocking connects and accepts	49	filehandles.
52	on sockets see L<AnyEvent::Util>.
53		50
54	The L<AnyEvent::Intro> tutorial contains some well-documented	51	The L<AnyEvent::Intro> tutorial contains some well-documented
55	AnyEvent::Handle examples.	52	AnyEvent::Handle examples.
56		53
57	In the following, when the documentation refers to of "bytes" then this	54	In the following, when the documentation refers to of "bytes" then this
58	means characters. As sysread and syswrite are used for all I/O, their	55	means characters. As sysread and syswrite are used for all I/O, their
59	treatment of characters applies to this module as well.	56	treatment of characters applies to this module as well.
60		57
		58	At the very minimum, you should specify C<fh> or C<connect>, and the
		59	C<on_error> callback.
		60
61	All callbacks will be invoked with the handle object as their first	61	All callbacks will be invoked with the handle object as their first
62	argument.	62	argument.
63		63
64	=head1 METHODS	64	=head1 METHODS
65		65
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	=item on_connect => $cb->($handle, $host, $port, $retry->())
		107
		108	This callback is called when a connection has been successfully established.
		109
		110	The actual numeric host and port (the socket peername) are passed as
		111	parameters, together with a retry callback.
		112
		113	When, for some reason, the handle is not acceptable, then calling
		114	C<$retry> will continue with the next conenction target (in case of
		115	multi-homed hosts or SRV records there can be multiple connection
		116	endpoints). When it is called then the read and write queues, eof status,
		117	tls status and similar properties of the handle are being reset.
		118
		119	In most cases, ignoring the C<$retry> parameter is the way to go.
		120
		121	=item on_connect_error => $cb->($handle, $message)
		122
		123	This callback is called when the conenction could not be
		124	established. C<$!> will contain the relevant error code, and C<$message> a
		125	message describing it (usually the same as C<"$!">).
		126
		127	If this callback isn't specified, then C<on_error> will be called with a
		128	fatal error instead.
		129
		130	=back
		131
		132	=item on_error => $cb->($handle, $fatal, $message)
		133
		134	This is the error callback, which is called when, well, some error
		135	occured, such as not being able to resolve the hostname, failure to
		136	connect or a read error.
		137
		138	Some errors are fatal (which is indicated by C<$fatal> being true). On
		139	fatal errors the handle object will be destroyed (by a call to C<< ->
		140	destroy >>) after invoking the error callback (which means you are free to
		141	examine the handle object). Examples of fatal errors are an EOF condition
		142	with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors. In
		143	cases where the other side can close the connection at their will it is
		144	often easiest to not report C<EPIPE> errors in this callback.
		145
		146	AnyEvent::Handle tries to find an appropriate error code for you to check
		147	against, but in some cases (TLS errors), this does not work well. It is
		148	recommended to always output the C<$message> argument in human-readable
		149	error messages (it's usually the same as C<"$!">).
		150
		151	Non-fatal errors can be retried by simply returning, but it is recommended
		152	to simply ignore this parameter and instead abondon the handle object
		153	when this callback is invoked. Examples of non-fatal errors are timeouts
		154	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
		155
		156	On callback entrance, the value of C<$!> contains the operating system
		157	error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
		158	C<EPROTO>).
		159
		160	While not mandatory, it is I<highly> recommended to set this callback, as
		161	you will not be notified of errors otherwise. The default simply calls
		162	C<croak>.
		163
		164	=item on_read => $cb->($handle)
		165
		166	This sets the default read callback, which is called when data arrives
		167	and no read request is in the queue (unlike read queue callbacks, this
		168	callback will only be called when at least one octet of data is in the
		169	read buffer).
		170
		171	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
		172	method or access the C<< $handle->{rbuf} >> member directly. Note that you
		173	must not enlarge or modify the read buffer, you can only remove data at
		174	the beginning from it.
		175
		176	When an EOF condition is detected then AnyEvent::Handle will first try to
		177	feed all the remaining data to the queued callbacks and C<on_read> before
		178	calling the C<on_eof> callback. If no progress can be made, then a fatal
		179	error will be raised (with C<$!> set to C<EPIPE>).
		180
		181	Note that, unlike requests in the read queue, an C<on_read> callback
		182	doesn't mean you I<require> some data: if there is an EOF and there
		183	are outstanding read requests then an error will be flagged. With an
		184	C<on_read> callback, the C<on_eof> callback will be invoked.
		185
82	=item on_eof => $cb->($handle)	186	=item on_eof => $cb->($handle)
83		187
84	Set the callback to be called when an end-of-file condition is detected,	188	Set the callback to be called when an end-of-file condition is detected,
85	i.e. in the case of a socket, when the other side has closed the	189	i.e. in the case of a socket, when the other side has closed the
86	connection cleanly.	190	connection cleanly, and there are no outstanding read requests in the
		191	queue (if there are read requests, then an EOF counts as an unexpected
		192	connection close and will be flagged as an error).
87		193
88	For sockets, this just means that the other side has stopped sending data,	194	For sockets, this just means that the other side has stopped sending data,
89	you can still try to write data, and, in fact, one can return from the EOF	195	you can still try to write data, and, in fact, one can return from the EOF
90	callback and continue writing data, as only the read part has been shut	196	callback and continue writing data, as only the read part has been shut
91	down.	197	down.
92		198
93	While not mandatory, it is I<highly> recommended to set an EOF callback,
94	otherwise you might end up with a closed socket while you are still
95	waiting for data.
96
97	If an EOF condition has been detected but no C<on_eof> callback has been	199	If an EOF condition has been detected but no C<on_eof> callback has been
98	set, then a fatal error will be raised with C<$!> set to <0>.	200	set, then a fatal error will be raised with C<$!> set to <0>.
99
100	=item on_error => $cb->($handle, $fatal, $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		201
147	=item on_drain => $cb->($handle)	202	=item on_drain => $cb->($handle)
148		203
149	This sets the callback that is called when the write buffer becomes empty	204	This sets the callback that is called when the write buffer becomes empty
150	(or when the callback is set and the buffer is empty already).	205	(or when the callback is set and the buffer is empty already).
…		…
249		304
250	A string used to identify the remote site - usually the DNS hostname	305	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.	306	(I<not> IDN!) used to create the connection, rarely the IP address.
252		307
253	Apart from being useful in error messages, this string is also used in TLS	308	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>).	309	peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This
		310	verification will be skipped when C<peername> is not specified or
		311	C<undef>.
255		312
256	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	313	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
257		314
258	When this parameter is given, it enables TLS (SSL) mode, that means	315	When this parameter is given, it enables TLS (SSL) mode, that means
259	AnyEvent will start a TLS handshake as soon as the conenction has been	316	AnyEvent will start a TLS handshake as soon as the conenction has been
…		…
296		353
297	Instead of an object, you can also specify a hash reference with C<< key	354	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	355	=> value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a
299	new TLS context object.	356	new TLS context object.
300		357
		358	=item on_starttls => $cb->($handle, $success[, $error_message])
		359
		360	This callback will be invoked when the TLS/SSL handshake has finished. If
		361	C<$success> is true, then the TLS handshake succeeded, otherwise it failed
		362	(C<on_stoptls> will not be called in this case).
		363
		364	The session in C<< $handle->{tls} >> can still be examined in this
		365	callback, even when the handshake was not successful.
		366
		367	TLS handshake failures will not cause C<on_error> to be invoked when this
		368	callback is in effect, instead, the error message will be passed to C<on_starttls>.
		369
		370	Without this callback, handshake failures lead to C<on_error> being
		371	called, as normal.
		372
		373	Note that you cannot call C<starttls> right again in this callback. If you
		374	need to do that, start an zero-second timer instead whose callback can
		375	then call C<< ->starttls >> again.
		376
		377	=item on_stoptls => $cb->($handle)
		378
		379	When a SSLv3/TLS shutdown/close notify/EOF is detected and this callback is
		380	set, then it will be invoked after freeing the TLS session. If it is not,
		381	then a TLS shutdown condition will be treated like a normal EOF condition
		382	on the handle.
		383
		384	The session in C<< $handle->{tls} >> can still be examined in this
		385	callback.
		386
		387	This callback will only be called on TLS shutdowns, not when the
		388	underlying handle signals EOF.
		389
301	=item json => JSON or JSON::XS object	390	=item json => JSON or JSON::XS object
302		391
303	This is the json coder object used by the C<json> read and write types.	392	This is the json coder object used by the C<json> read and write types.
304		393
305	If you don't supply it, then AnyEvent::Handle will create and use a	394	If you don't supply it, then AnyEvent::Handle will create and use a
…		…
315		404
316	sub new {	405	sub new {
317	my $class = shift;	406	my $class = shift;
318	my $self = bless { @_ }, $class;	407	my $self = bless { @_ }, $class;
319		408
320	$self->{fh} or Carp::croak "mandatory argument fh is missing";	409	if ($self->{fh}) {
		410	$self->_start;
		411	return unless $self->{fh}; # could be gone by now
		412
		413	} elsif ($self->{connect}) {
		414	require AnyEvent::Socket;
		415
		416	$self->{peername} = $self->{connect}[0]
		417	unless exists $self->{peername};
		418
		419	$self->{_skip_drain_rbuf} = 1;
		420
		421	{
		422	Scalar::Util::weaken (my $self = $self);
		423
		424	$self->{_connect} =
		425	AnyEvent::Socket::tcp_connect (
		426	$self->{connect}[0],
		427	$self->{connect}[1],
		428	sub {
		429	my ($fh, $host, $port, $retry) = @_;
		430
		431	if ($fh) {
		432	$self->{fh} = $fh;
		433
		434	delete $self->{_skip_drain_rbuf};
		435	$self->_start;
		436
		437	$self->{on_connect}
		438	and $self->{on_connect}($self, $host, $port, sub {
		439	delete @$self{qw(fh _tw _ww _rw _eof _queue rbuf _wbuf tls _tls_rbuf _tls_wbuf)};
		440	$self->{_skip_drain_rbuf} = 1;
		441	&$retry;
		442	});
		443
		444	} else {
		445	if ($self->{on_connect_error}) {
		446	$self->{on_connect_error}($self, "$!");
		447	$self->destroy;
		448	} else {
		449	$self->fatal ($!, 1);
		450	}
		451	}
		452	},
		453	sub {
		454	local $self->{fh} = $_[0];
		455
		456	$self->{on_prepare}->($self)
		457	if $self->{on_prepare};
		458	}
		459	);
		460	}
		461
		462	} else {
		463	Carp::croak "AnyEvent::Handle: either an existing fh or the connect parameter must be specified";
		464	}
		465
		466	$self
		467	}
		468
		469	sub _start {
		470	my ($self) = @_;
321		471
322	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	472	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
323		473
324	$self->{_activity} = AnyEvent->now;	474	$self->{_activity} = AnyEvent->now;
325	$self->_timeout;	475	$self->_timeout;
…		…
327	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};	477	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
328		478
329	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})	479	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
330	if $self->{tls};	480	if $self->{tls};
331		481
332	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};	482	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
333		483
334	$self->start_read	484	$self->start_read
335	if $self->{on_read};	485	if $self->{on_read} \|\| @{ $self->{_queue} };
336		486
337	$self->{fh} && $self	487	$self->_drain_wbuf;
338	}	488	}
339		489
340	sub _shutdown {	490	#sub _shutdown {
341	my ($self) = @_;	491	# my ($self) = @_;
342		492	#
343	delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)};	493	# delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)};
344	$self->{_eof} = 1; # tell starttls et. al to stop trying	494	# $self->{_eof} = 1; # tell starttls et. al to stop trying
345		495	#
346	&_freetls;	496	# &_freetls;
347	}	497	#}
348		498
349	sub _error {	499	sub _error {
350	my ($self, $errno, $fatal, $message) = @_;	500	my ($self, $errno, $fatal, $message) = @_;
351		501
352	$self->_shutdown
353	if $fatal;
354
355	$! = $errno;	502	$! = $errno;
356	$message \|\|= "$!";	503	$message \|\|= "$!";
357		504
358	if ($self->{on_error}) {	505	if ($self->{on_error}) {
359	$self->{on_error}($self, $fatal, $message);	506	$self->{on_error}($self, $fatal, $message);
		507	$self->destroy if $fatal;
360	} elsif ($self->{fh}) {	508	} elsif ($self->{fh}) {
		509	$self->destroy;
361	Carp::croak "AnyEvent::Handle uncaught error: $message";	510	Carp::croak "AnyEvent::Handle uncaught error: $message";
362	}	511	}
363	}	512	}
364		513
365	=item $fh = $handle->fh	514	=item $fh = $handle->fh
…		…
423	sub no_delay {	572	sub no_delay {
424	$_[0]{no_delay} = $_[1];	573	$_[0]{no_delay} = $_[1];
425		574
426	eval {	575	eval {
427	local $SIG{__DIE__};	576	local $SIG{__DIE__};
428	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];	577	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1]
		578	if $_[0]{fh};
429	};	579	};
		580	}
		581
		582	=item $handle->on_starttls ($cb)
		583
		584	Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument).
		585
		586	=cut
		587
		588	sub on_starttls {
		589	$_[0]{on_starttls} = $_[1];
		590	}
		591
		592	=item $handle->on_stoptls ($cb)
		593
		594	Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).
		595
		596	=cut
		597
		598	sub on_starttls {
		599	$_[0]{on_stoptls} = $_[1];
430	}	600	}
431		601
432	#############################################################################	602	#############################################################################
433		603
434	=item $handle->timeout ($seconds)	604	=item $handle->timeout ($seconds)
…		…
447	# reset the timeout watcher, as neccessary	617	# reset the timeout watcher, as neccessary
448	# also check for time-outs	618	# also check for time-outs
449	sub _timeout {	619	sub _timeout {
450	my ($self) = @_;	620	my ($self) = @_;
451		621
452	if ($self->{timeout}) {	622	if ($self->{timeout} && $self->{fh}) {
453	my $NOW = AnyEvent->now;	623	my $NOW = AnyEvent->now;
454		624
455	# when would the timeout trigger?	625	# when would the timeout trigger?
456	my $after = $self->{_activity} + $self->{timeout} - $NOW;	626	my $after = $self->{_activity} + $self->{timeout} - $NOW;
457		627
…		…
460	$self->{_activity} = $NOW;	630	$self->{_activity} = $NOW;
461		631
462	if ($self->{on_timeout}) {	632	if ($self->{on_timeout}) {
463	$self->{on_timeout}($self);	633	$self->{on_timeout}($self);
464	} else {	634	} else {
465	$self->_error (&Errno::ETIMEDOUT);	635	$self->_error (Errno::ETIMEDOUT);
466	}	636	}
467		637
468	# callback could have changed timeout value, optimise	638	# callback could have changed timeout value, optimise
469	return unless $self->{timeout};	639	return unless $self->{timeout};
470		640
…		…
533	Scalar::Util::weaken $self;	703	Scalar::Util::weaken $self;
534		704
535	my $cb = sub {	705	my $cb = sub {
536	my $len = syswrite $self->{fh}, $self->{wbuf};	706	my $len = syswrite $self->{fh}, $self->{wbuf};
537		707
538	if ($len >= 0) {	708	if (defined $len) {
539	substr $self->{wbuf}, 0, $len, "";	709	substr $self->{wbuf}, 0, $len, "";
540		710
541	$self->{_activity} = AnyEvent->now;	711	$self->{_activity} = AnyEvent->now;
542		712
543	$self->{on_drain}($self)	713	$self->{on_drain}($self)
…		…
575	->($self, @_);	745	->($self, @_);
576	}	746	}
577		747
578	if ($self->{tls}) {	748	if ($self->{tls}) {
579	$self->{_tls_wbuf} .= $_[0];	749	$self->{_tls_wbuf} .= $_[0];
580		750	&_dotls ($self) if $self->{fh};
581	&_dotls ($self);
582	} else {	751	} else {
583	$self->{wbuf} .= $_[0];	752	$self->{wbuf} .= $_[0];
584	$self->_drain_wbuf;	753	$self->_drain_wbuf if $self->{fh};
585	}	754	}
586	}	755	}
587		756
588	=item $handle->push_write (type => @args)	757	=item $handle->push_write (type => @args)
589		758
…		…
683		852
684	=item $handle->push_shutdown	853	=item $handle->push_shutdown
685		854
686	Sometimes you know you want to close the socket after writing your data	855	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	856	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	857	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:	858	C<low_water_mark> to C<0>). This method is a shorthand for just that, and
		859	replaces the C<on_drain> callback with:
690		860
691	sub { shutdown $_[0]{fh}, 1 } # for push_shutdown	861	sub { shutdown $_[0]{fh}, 1 } # for push_shutdown
692		862
693	This simply shuts down the write side and signals an EOF condition to the	863	This simply shuts down the write side and signals an EOF condition to the
694	the peer.	864	the peer.
…		…
697	afterwards. This is the cleanest way to close a connection.	867	afterwards. This is the cleanest way to close a connection.
698		868
699	=cut	869	=cut
700		870
701	sub push_shutdown {	871	sub push_shutdown {
		872	my ($self) = @_;
		873
		874	delete $self->{low_water_mark};
702	$_[0]->{on_drain} = sub { shutdown $_[0]{fh}, 1 };	875	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });
703	}	876	}
704		877
705	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	878	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
706		879
707	This function (not method) lets you add your own types to C<push_write>.	880	This function (not method) lets you add your own types to C<push_write>.
…		…
802	=cut	975	=cut
803		976
804	sub _drain_rbuf {	977	sub _drain_rbuf {
805	my ($self) = @_;	978	my ($self) = @_;
806		979
		980	# avoid recursion
		981	return if exists $self->{_skip_drain_rbuf};
807	local $self->{_in_drain} = 1;	982	local $self->{_skip_drain_rbuf} = 1;
808		983
809	if (	984	if (
810	defined $self->{rbuf_max}	985	defined $self->{rbuf_max}
811	&& $self->{rbuf_max} < length $self->{rbuf}	986	&& $self->{rbuf_max} < length $self->{rbuf}
812	) {	987	) {
813	$self->_error (&Errno::ENOSPC, 1), return;	988	$self->_error (Errno::ENOSPC, 1), return;
814	}	989	}
815		990
816	while () {	991	while () {
817	# we need to use a separate tls read buffer, as we must not receive data while	992	# we need to use a separate tls read buffer, as we must not receive data while
818	# we are draining the buffer, and this can only happen with TLS.	993	# we are draining the buffer, and this can only happen with TLS.
…		…
822		997
823	if (my $cb = shift @{ $self->{_queue} }) {	998	if (my $cb = shift @{ $self->{_queue} }) {
824	unless ($cb->($self)) {	999	unless ($cb->($self)) {
825	if ($self->{_eof}) {	1000	if ($self->{_eof}) {
826	# no progress can be made (not enough data and no data forthcoming)	1001	# no progress can be made (not enough data and no data forthcoming)
827	$self->_error (&Errno::EPIPE, 1), return;	1002	$self->_error (Errno::EPIPE, 1), return;
828	}	1003	}
829		1004
830	unshift @{ $self->{_queue} }, $cb;	1005	unshift @{ $self->{_queue} }, $cb;
831	last;	1006	last;
832	}	1007	}
…		…
840	&& !@{ $self->{_queue} } # and the queue is still empty	1015	&& !@{ $self->{_queue} } # and the queue is still empty
841	&& $self->{on_read} # but we still have on_read	1016	&& $self->{on_read} # but we still have on_read
842	) {	1017	) {
843	# no further data will arrive	1018	# no further data will arrive
844	# so no progress can be made	1019	# so no progress can be made
845	$self->_error (&Errno::EPIPE, 1), return	1020	$self->_error (Errno::EPIPE, 1), return
846	if $self->{_eof};	1021	if $self->{_eof};
847		1022
848	last; # more data might arrive	1023	last; # more data might arrive
849	}	1024	}
850	} else {	1025	} else {
…		…
879		1054
880	sub on_read {	1055	sub on_read {
881	my ($self, $cb) = @_;	1056	my ($self, $cb) = @_;
882		1057
883	$self->{on_read} = $cb;	1058	$self->{on_read} = $cb;
884	$self->_drain_rbuf if $cb && !$self->{_in_drain};	1059	$self->_drain_rbuf if $cb;
885	}	1060	}
886		1061
887	=item $handle->rbuf	1062	=item $handle->rbuf
888		1063
889	Returns the read buffer (as a modifiable lvalue).	1064	Returns the read buffer (as a modifiable lvalue).
…		…
941	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	1116	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
942	->($self, $cb, @_);	1117	->($self, $cb, @_);
943	}	1118	}
944		1119
945	push @{ $self->{_queue} }, $cb;	1120	push @{ $self->{_queue} }, $cb;
946	$self->_drain_rbuf unless $self->{_in_drain};	1121	$self->_drain_rbuf;
947	}	1122	}
948		1123
949	sub unshift_read {	1124	sub unshift_read {
950	my $self = shift;	1125	my $self = shift;
951	my $cb = pop;	1126	my $cb = pop;
…		…
957	->($self, $cb, @_);	1132	->($self, $cb, @_);
958	}	1133	}
959		1134
960		1135
961	unshift @{ $self->{_queue} }, $cb;	1136	unshift @{ $self->{_queue} }, $cb;
962	$self->_drain_rbuf unless $self->{_in_drain};	1137	$self->_drain_rbuf;
963	}	1138	}
964		1139
965	=item $handle->push_read (type => @args, $cb)	1140	=item $handle->push_read (type => @args, $cb)
966		1141
967	=item $handle->unshift_read (type => @args, $cb)	1142	=item $handle->unshift_read (type => @args, $cb)
…		…
1100	return 1;	1275	return 1;
1101	}	1276	}
1102		1277
1103	# reject	1278	# reject
1104	if ($reject && $$rbuf =~ $reject) {	1279	if ($reject && $$rbuf =~ $reject) {
1105	$self->_error (&Errno::EBADMSG);	1280	$self->_error (Errno::EBADMSG);
1106	}	1281	}
1107		1282
1108	# skip	1283	# skip
1109	if ($skip && $$rbuf =~ $skip) {	1284	if ($skip && $$rbuf =~ $skip) {
1110	$data .= substr $$rbuf, 0, $+[0], "";	1285	$data .= substr $$rbuf, 0, $+[0], "";
…		…
1126	my ($self, $cb) = @_;	1301	my ($self, $cb) = @_;
1127		1302
1128	sub {	1303	sub {
1129	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {	1304	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
1130	if ($_[0]{rbuf} =~ /[^0-9]/) {	1305	if ($_[0]{rbuf} =~ /[^0-9]/) {
1131	$self->_error (&Errno::EBADMSG);	1306	$self->_error (Errno::EBADMSG);
1132	}	1307	}
1133	return;	1308	return;
1134	}	1309	}
1135		1310
1136	my $len = $1;	1311	my $len = $1;
…		…
1139	my $string = $_[1];	1314	my $string = $_[1];
1140	$_[0]->unshift_read (chunk => 1, sub {	1315	$_[0]->unshift_read (chunk => 1, sub {
1141	if ($_[1] eq ",") {	1316	if ($_[1] eq ",") {
1142	$cb->($_[0], $string);	1317	$cb->($_[0], $string);
1143	} else {	1318	} else {
1144	$self->_error (&Errno::EBADMSG);	1319	$self->_error (Errno::EBADMSG);
1145	}	1320	}
1146	});	1321	});
1147	});	1322	});
1148		1323
1149	1	1324	1
…		…
1239	$json->incr_skip;	1414	$json->incr_skip;
1240		1415
1241	$self->{rbuf} = $json->incr_text;	1416	$self->{rbuf} = $json->incr_text;
1242	$json->incr_text = "";	1417	$json->incr_text = "";
1243		1418
1244	$self->_error (&Errno::EBADMSG);	1419	$self->_error (Errno::EBADMSG);
1245		1420
1246	()	1421	()
1247	} else {	1422	} else {
1248	$self->{rbuf} = "";	1423	$self->{rbuf} = "";
1249		1424
…		…
1286	# read remaining chunk	1461	# read remaining chunk
1287	$_[0]->unshift_read (chunk => $len, sub {	1462	$_[0]->unshift_read (chunk => $len, sub {
1288	if (my $ref = eval { Storable::thaw ($_[1]) }) {	1463	if (my $ref = eval { Storable::thaw ($_[1]) }) {
1289	$cb->($_[0], $ref);	1464	$cb->($_[0], $ref);
1290	} else {	1465	} else {
1291	$self->_error (&Errno::EBADMSG);	1466	$self->_error (Errno::EBADMSG);
1292	}	1467	}
1293	});	1468	});
1294	}	1469	}
1295		1470
1296	1	1471	1
…		…
1360	if ($self->{tls}) {	1535	if ($self->{tls}) {
1361	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);	1536	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1362		1537
1363	&_dotls ($self);	1538	&_dotls ($self);
1364	} else {	1539	} else {
1365	$self->_drain_rbuf unless $self->{_in_drain};	1540	$self->_drain_rbuf;
1366	}	1541	}
1367		1542
1368	} elsif (defined $len) {	1543	} elsif (defined $len) {
1369	delete $self->{_rw};	1544	delete $self->{_rw};
1370	$self->{_eof} = 1;	1545	$self->{_eof} = 1;
1371	$self->_drain_rbuf unless $self->{_in_drain};	1546	$self->_drain_rbuf;
1372		1547
1373	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1548	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1374	return $self->_error ($!, 1);	1549	return $self->_error ($!, 1);
1375	}	1550	}
1376	});	1551	});
1377	}	1552	}
1378	}	1553	}
1379		1554
1380	our $ERROR_SYSCALL;	1555	our $ERROR_SYSCALL;
1381	our $ERROR_WANT_READ;	1556	our $ERROR_WANT_READ;
1382	our $ERROR_ZERO_RETURN;
1383		1557
1384	sub _tls_error {	1558	sub _tls_error {
1385	my ($self, $err) = @_;	1559	my ($self, $err) = @_;
1386		1560
1387	return $self->_error ($!, 1)	1561	return $self->_error ($!, 1)
…		…
1390	my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());	1564	my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());
1391		1565
1392	# reduce error string to look less scary	1566	# reduce error string to look less scary
1393	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;	1567	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;
1394		1568
		1569	if ($self->{_on_starttls}) {
		1570	(delete $self->{_on_starttls})->($self, undef, $err);
		1571	&_freetls;
		1572	} else {
		1573	&_freetls;
1395	$self->_error (&Errno::EPROTO, 1, $err);	1574	$self->_error (Errno::EPROTO, 1, $err);
		1575	}
1396	}	1576	}
1397		1577
1398	# poll the write BIO and send the data if applicable	1578	# poll the write BIO and send the data if applicable
1399	# also decode read data if possible	1579	# also decode read data if possible
1400	# this is basiclaly our TLS state machine	1580	# this is basiclaly our TLS state machine
…		…
1411	}	1591	}
1412		1592
1413	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);	1593	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);
1414	return $self->_tls_error ($tmp)	1594	return $self->_tls_error ($tmp)
1415	if $tmp != $ERROR_WANT_READ	1595	if $tmp != $ERROR_WANT_READ
1416	&& ($tmp != $ERROR_SYSCALL \|\| $!)	1596	&& ($tmp != $ERROR_SYSCALL \|\| $!);
1417	&& $tmp != $ERROR_ZERO_RETURN;
1418	}	1597	}
1419		1598
1420	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {	1599	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
1421	unless (length $tmp) {	1600	unless (length $tmp) {
1422	# let's treat SSL-eof as we treat normal EOF	1601	$self->{_on_starttls}
1423	delete $self->{_rw};	1602	and (delete $self->{_on_starttls})->($self, undef, "EOF during handshake"); # ???
1424	$self->{_eof} = 1;
1425	&_freetls;	1603	&_freetls;
		1604
		1605	if ($self->{on_stoptls}) {
		1606	$self->{on_stoptls}($self);
		1607	return;
		1608	} else {
		1609	# let's treat SSL-eof as we treat normal EOF
		1610	delete $self->{_rw};
		1611	$self->{_eof} = 1;
		1612	}
1426	}	1613	}
1427		1614
1428	$self->{_tls_rbuf} .= $tmp;	1615	$self->{_tls_rbuf} .= $tmp;
1429	$self->_drain_rbuf unless $self->{_in_drain};	1616	$self->_drain_rbuf;
1430	$self->{tls} or return; # tls session might have gone away in callback	1617	$self->{tls} or return; # tls session might have gone away in callback
1431	}	1618	}
1432		1619
1433	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);	1620	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1434	return $self->_tls_error ($tmp)	1621	return $self->_tls_error ($tmp)
1435	if $tmp != $ERROR_WANT_READ	1622	if $tmp != $ERROR_WANT_READ
1436	&& ($tmp != $ERROR_SYSCALL \|\| $!)	1623	&& ($tmp != $ERROR_SYSCALL \|\| $!);
1437	&& $tmp != $ERROR_ZERO_RETURN;
1438		1624
1439	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1625	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1440	$self->{wbuf} .= $tmp;	1626	$self->{wbuf} .= $tmp;
1441	$self->_drain_wbuf;	1627	$self->_drain_wbuf;
1442	}	1628	}
		1629
		1630	$self->{_on_starttls}
		1631	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
		1632	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");
1443	}	1633	}
1444		1634
1445	=item $handle->starttls ($tls[, $tls_ctx])	1635	=item $handle->starttls ($tls[, $tls_ctx])
1446		1636
1447	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	1637	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	1638	object is created, you can also do that at a later time by calling
1449	C<starttls>.	1639	C<starttls>.
		1640
		1641	Starting TLS is currently an asynchronous operation - when you push some
		1642	write data and then call C<< ->starttls >> then TLS negotiation will start
		1643	immediately, after which the queued write data is then sent.
1450		1644
1451	The first argument is the same as the C<tls> constructor argument (either	1645	The first argument is the same as the C<tls> constructor argument (either
1452	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1646	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1453		1647
1454	The second argument is the optional C<AnyEvent::TLS> object that is used	1648	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	1653	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	1654	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	1655	changed to your liking. Note that the handshake might have already started
1462	when this function returns.	1656	when this function returns.
1463		1657
1464	If it an error to start a TLS handshake more than once per	1658	Due to bugs in OpenSSL, it might or might not be possible to do multiple
1465	AnyEvent::Handle object (this is due to bugs in OpenSSL).	1659	handshakes on the same stream. Best do not attempt to use the stream after
		1660	stopping TLS.
1466		1661
1467	=cut	1662	=cut
1468		1663
1469	our %TLS_CACHE; #TODO not yet documented, should we?	1664	our %TLS_CACHE; #TODO not yet documented, should we?
1470		1665
1471	sub starttls {	1666	sub starttls {
1472	my ($self, $ssl, $ctx) = @_;	1667	my ($self, $tls, $ctx) = @_;
		1668
		1669	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"
		1670	if $self->{tls};
		1671
		1672	$self->{tls} = $tls;
		1673	$self->{tls_ctx} = $ctx if @_ > 2;
		1674
		1675	return unless $self->{fh};
1473		1676
1474	require Net::SSLeay;	1677	require Net::SSLeay;
1475		1678
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 ();	1679	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1480	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();	1680	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1481	$ERROR_ZERO_RETURN = Net::SSLeay::ERROR_ZERO_RETURN ();
1482		1681
		1682	$tls = $self->{tls};
1483	$ctx \|\|= $self->{tls_ctx};	1683	$ctx = $self->{tls_ctx};
		1684
		1685	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
1484		1686
1485	if ("HASH" eq ref $ctx) {	1687	if ("HASH" eq ref $ctx) {
1486	require AnyEvent::TLS;	1688	require AnyEvent::TLS;
1487
1488	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context
1489		1689
1490	if ($ctx->{cache}) {	1690	if ($ctx->{cache}) {
1491	my $key = $ctx+0;	1691	my $key = $ctx+0;
1492	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;	1692	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;
1493	} else {	1693	} else {
1494	$ctx = new AnyEvent::TLS %$ctx;	1694	$ctx = new AnyEvent::TLS %$ctx;
1495	}	1695	}
1496	}	1696	}
1497		1697
1498	$self->{tls_ctx} = $ctx \|\| TLS_CTX ();	1698	$self->{tls_ctx} = $ctx \|\| TLS_CTX ();
1499	$self->{tls} = $ssl = $self->{tls_ctx}->_get_session ($ssl, $self, $self->{peername});	1699	$self->{tls} = $tls = $self->{tls_ctx}->_get_session ($tls, $self, $self->{peername});
1500		1700
1501	# basically, this is deep magic (because SSL_read should have the same issues)	1701	# basically, this is deep magic (because SSL_read should have the same issues)
1502	# but the openssl maintainers basically said: "trust us, it just works".	1702	# but the openssl maintainers basically said: "trust us, it just works".
1503	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1703	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1504	# and mismaintained ssleay-module doesn't even offer them).	1704	# 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	1711	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
1512	# have identity issues in that area.	1712	# have identity issues in that area.
1513	# Net::SSLeay::CTX_set_mode ($ssl,	1713	# Net::SSLeay::CTX_set_mode ($ssl,
1514	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1714	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
1515	# \| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));	1715	# \| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
1516	Net::SSLeay::CTX_set_mode ($ssl, 1\|2);	1716	Net::SSLeay::CTX_set_mode ($tls, 1\|2);
1517		1717
1518	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1718	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1519	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1719	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1520		1720
1521	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1721	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
		1722
		1723	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
		1724	if $self->{on_starttls};
1522		1725
1523	&_dotls; # need to trigger the initial handshake	1726	&_dotls; # need to trigger the initial handshake
1524	$self->start_read; # make sure we actually do read	1727	$self->start_read; # make sure we actually do read
1525	}	1728	}
1526		1729
1527	=item $handle->stoptls	1730	=item $handle->stoptls
1528		1731
1529	Shuts down the SSL connection - this makes a proper EOF handshake by	1732	Shuts down the SSL connection - this makes a proper EOF handshake by
1530	sending a close notify to the other side, but since OpenSSL doesn't	1733	sending a close notify to the other side, but since OpenSSL doesn't
1531	support non-blocking shut downs, it is not possible to re-use the stream	1734	support non-blocking shut downs, it is not guarenteed that you can re-use
1532	afterwards.	1735	the stream afterwards.
1533		1736
1534	=cut	1737	=cut
1535		1738
1536	sub stoptls {	1739	sub stoptls {
1537	my ($self) = @_;	1740	my ($self) = @_;
…		…
1539	if ($self->{tls}) {	1742	if ($self->{tls}) {
1540	Net::SSLeay::shutdown ($self->{tls});	1743	Net::SSLeay::shutdown ($self->{tls});
1541		1744
1542	&_dotls;	1745	&_dotls;
1543		1746
1544	# we don't give a shit. no, we do, but we can't. no...	1747	# # we don't give a shit. no, we do, but we can't. no...#d#
1545	# we, we... have to use openssl :/	1748	# # we, we... have to use openssl :/#d#
1546	&_freetls;	1749	# &_freetls;#d#
1547	}	1750	}
1548	}	1751	}
1549		1752
1550	sub _freetls {	1753	sub _freetls {
1551	my ($self) = @_;	1754	my ($self) = @_;
1552		1755
1553	return unless $self->{tls};	1756	return unless $self->{tls};
1554		1757
1555	$self->{tls_ctx}->_put_session (delete $self->{tls});	1758	$self->{tls_ctx}->_put_session (delete $self->{tls})
		1759	if ref $self->{tls};
1556		1760
1557	delete @$self{qw(_rbio _wbio _tls_wbuf)};	1761	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1558	}	1762	}
1559		1763
1560	sub DESTROY {	1764	sub DESTROY {
1561	my ($self) = @_;	1765	my ($self) = @_;
1562		1766
1563	&_freetls;	1767	&_freetls;
1564		1768
1565	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	1769	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1566		1770
1567	if ($linger && length $self->{wbuf}) {	1771	if ($linger && length $self->{wbuf} && $self->{fh}) {
1568	my $fh = delete $self->{fh};	1772	my $fh = delete $self->{fh};
1569	my $wbuf = delete $self->{wbuf};	1773	my $wbuf = delete $self->{wbuf};
1570		1774
1571	my @linger;	1775	my @linger;
1572		1776
…		…
1596	callbacks, as well as code outside. It does I<NOT> work in a read or write	1800	callbacks, as well as code outside. It does I<NOT> work in a read or write
1597	callback, so when you want to destroy the AnyEvent::Handle object from	1801	callback, so when you want to destroy the AnyEvent::Handle object from
1598	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in	1802	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
1599	that case.	1803	that case.
1600		1804
		1805	Destroying the handle object in this way has the advantage that callbacks
		1806	will be removed as well, so if those are the only reference holders (as
		1807	is common), then one doesn't need to do anything special to break any
		1808	reference cycles.
		1809
1601	The handle might still linger in the background and write out remaining	1810	The handle might still linger in the background and write out remaining
1602	data, as specified by the C<linger> option, however.	1811	data, as specified by the C<linger> option, however.
1603		1812
1604	=cut	1813	=cut
1605		1814
…		…
1672		1881
1673	$handle->on_read (sub { });	1882	$handle->on_read (sub { });
1674	$handle->on_eof (undef);	1883	$handle->on_eof (undef);
1675	$handle->on_error (sub {	1884	$handle->on_error (sub {
1676	my $data = delete $_[0]{rbuf};	1885	my $data = delete $_[0]{rbuf};
1677	undef $handle;
1678	});	1886	});
1679		1887
1680	The reason to use C<on_error> is that TCP connections, due to latencies	1888	The reason to use C<on_error> is that TCP connections, due to latencies
1681	and packets loss, might get closed quite violently with an error, when in	1889	and packets loss, might get closed quite violently with an error, when in
1682	fact, all data has been received.	1890	fact, all data has been received.
…		…
1698	$handle->on_drain (sub {	1906	$handle->on_drain (sub {
1699	warn "all data submitted to the kernel\n";	1907	warn "all data submitted to the kernel\n";
1700	undef $handle;	1908	undef $handle;
1701	});	1909	});
1702		1910
		1911	If you just want to queue some data and then signal EOF to the other side,
		1912	consider using C<< ->push_shutdown >> instead.
		1913
		1914	=item I want to contact a TLS/SSL server, I don't care about security.
		1915
		1916	If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS,
		1917	simply connect to it and then create the AnyEvent::Handle with the C<tls>
		1918	parameter:
		1919
		1920	tcp_connect $host, $port, sub {
		1921	my ($fh) = @_;
		1922
		1923	my $handle = new AnyEvent::Handle
		1924	fh => $fh,
		1925	tls => "connect",
		1926	on_error => sub { ... };
		1927
		1928	$handle->push_write (...);
		1929	};
		1930
		1931	=item I want to contact a TLS/SSL server, I do care about security.
		1932
		1933	Then you should additionally enable certificate verification, including
		1934	peername verification, if the protocol you use supports it (see
		1935	L<AnyEvent::TLS>, C<verify_peername>).
		1936
		1937	E.g. for HTTPS:
		1938
		1939	tcp_connect $host, $port, sub {
		1940	my ($fh) = @_;
		1941
		1942	my $handle = new AnyEvent::Handle
		1943	fh => $fh,
		1944	peername => $host,
		1945	tls => "connect",
		1946	tls_ctx => { verify => 1, verify_peername => "https" },
		1947	...
		1948
		1949	Note that you must specify the hostname you connected to (or whatever
		1950	"peername" the protocol needs) as the C<peername> argument, otherwise no
		1951	peername verification will be done.
		1952
		1953	The above will use the system-dependent default set of trusted CA
		1954	certificates. If you want to check against a specific CA, add the
		1955	C<ca_file> (or C<ca_cert>) arguments to C<tls_ctx>:
		1956
		1957	tls_ctx => {
		1958	verify => 1,
		1959	verify_peername => "https",
		1960	ca_file => "my-ca-cert.pem",
		1961	},
		1962
		1963	=item I want to create a TLS/SSL server, how do I do that?
		1964
		1965	Well, you first need to get a server certificate and key. You have
		1966	three options: a) ask a CA (buy one, use cacert.org etc.) b) create a
		1967	self-signed certificate (cheap. check the search engine of your choice,
		1968	there are many tutorials on the net) or c) make your own CA (tinyca2 is a
		1969	nice program for that purpose).
		1970
		1971	Then create a file with your private key (in PEM format, see
		1972	L<AnyEvent::TLS>), followed by the certificate (also in PEM format). The
		1973	file should then look like this:
		1974
		1975	-----BEGIN RSA PRIVATE KEY-----
		1976	...header data
		1977	... lots of base64'y-stuff
		1978	-----END RSA PRIVATE KEY-----
		1979
		1980	-----BEGIN CERTIFICATE-----
		1981	... lots of base64'y-stuff
		1982	-----END CERTIFICATE-----
		1983
		1984	The important bits are the "PRIVATE KEY" and "CERTIFICATE" parts. Then
		1985	specify this file as C<cert_file>:
		1986
		1987	tcp_server undef, $port, sub {
		1988	my ($fh) = @_;
		1989
		1990	my $handle = new AnyEvent::Handle
		1991	fh => $fh,
		1992	tls => "accept",
		1993	tls_ctx => { cert_file => "my-server-keycert.pem" },
		1994	...
		1995
		1996	When you have intermediate CA certificates that your clients might not
		1997	know about, just append them to the C<cert_file>.
		1998
1703	=back	1999	=back
1704		2000
1705		2001
1706	=head1 SUBCLASSING AnyEvent::Handle	2002	=head1 SUBCLASSING AnyEvent::Handle
1707		2003

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.141 by root, Mon Jul 6 01:03:09 2009 UTC vs. Revision 1.160 by root, Fri Jul 24 22:47:04 2009 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.141 by root, Mon Jul 6 01:03:09 2009 UTC vs.
Revision 1.160 by root, Fri Jul 24 22:47:04 2009 UTC