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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.146 by root, Wed Jul 8 13:46:46 2009 UTC vs.
Revision 1.176 by root, Sun Aug 9 00:20:35 2009 UTC

…		…
1	package AnyEvent::Handle;
2
3	no warnings;
4	use strict qw(subs vars);
5
6	use AnyEvent ();
7	use AnyEvent::Util qw(WSAEWOULDBLOCK);
8	use Scalar::Util ();
9	use Carp ();
10	use Fcntl ();
11	use Errno qw(EAGAIN EINTR);
12
13	=head1 NAME	1	=head1 NAME
14		2
15	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent	3	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent
16		4
17	=cut	5	=cut
18		6
19	our $VERSION = 4.8;	7	our $VERSION = 4.92;
20		8
21	=head1 SYNOPSIS	9	=head1 SYNOPSIS
22		10
23	use AnyEvent;	11	use AnyEvent;
24	use AnyEvent::Handle;	12	use AnyEvent::Handle;
25		13
26	my $cv = AnyEvent->condvar;	14	my $cv = AnyEvent->condvar;
27		15
28	my $handle =	16	my $hdl; $hdl = new AnyEvent::Handle
29	AnyEvent::Handle->new (
30	fh => \*STDIN,	17	fh => \*STDIN,
31	on_eof => sub {	18	on_error => sub {
		19	my ($hdl, $fatal, $msg) = @_;
		20	warn "got error $msg\n";
		21	$hdl->destroy;
32	$cv->send;	22	$cv->send;
33	},
34	);	23	);
35		24
36	# send some request line	25	# send some request line
37	$handle->push_write ("getinfo\015\012");	26	$hdl->push_write ("getinfo\015\012");
38		27
39	# read the response line	28	# read the response line
40	$handle->push_read (line => sub {	29	$hdl->push_read (line => sub {
41	my ($handle, $line) = @_;	30	my ($hdl, $line) = @_;
42	warn "read line <$line>\n";	31	warn "got line <$line>\n";
43	$cv->send;	32	$cv->send;
44	});	33	});
45		34
46	$cv->recv;	35	$cv->recv;
47		36
48	=head1 DESCRIPTION	37	=head1 DESCRIPTION
49		38
50	This module is a helper module to make it easier to do event-based I/O on	39	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	40	filehandles.
52	on sockets see L<AnyEvent::Util>.
53		41
54	The L<AnyEvent::Intro> tutorial contains some well-documented	42	The L<AnyEvent::Intro> tutorial contains some well-documented
55	AnyEvent::Handle examples.	43	AnyEvent::Handle examples.
56		44
57	In the following, when the documentation refers to of "bytes" then this	45	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	46	means characters. As sysread and syswrite are used for all I/O, their
59	treatment of characters applies to this module as well.	47	treatment of characters applies to this module as well.
60		48
		49	At the very minimum, you should specify C<fh> or C<connect>, and the
		50	C<on_error> callback.
		51
61	All callbacks will be invoked with the handle object as their first	52	All callbacks will be invoked with the handle object as their first
62	argument.	53	argument.
63		54
		55	=cut
		56
		57	package AnyEvent::Handle;
		58
		59	use Scalar::Util ();
		60	use List::Util ();
		61	use Carp ();
		62	use Errno qw(EAGAIN EINTR);
		63
		64	use AnyEvent (); BEGIN { AnyEvent::common_sense }
		65	use AnyEvent::Util qw(WSAEWOULDBLOCK);
		66
64	=head1 METHODS	67	=head1 METHODS
65		68
66	=over 4	69	=over 4
67		70
68	=item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value...	71	=item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value...
69		72
70	The constructor supports these arguments (all as C<< key => value >> pairs).	73	The constructor supports these arguments (all as C<< key => value >> pairs).
71		74
72	=over 4	75	=over 4
73		76
74	=item fh => $filehandle [MANDATORY]	77	=item fh => $filehandle [C<fh> or C<connect> MANDATORY]
75		78
76	The filehandle this L<AnyEvent::Handle> object will operate on.	79	The filehandle this L<AnyEvent::Handle> object will operate on.
77
78	NOTE: The filehandle will be set to non-blocking mode (using	80	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	81	C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in
80	that mode.	82	that mode.
81		83
		84	=item connect => [$host, $service] [C<fh> or C<connect> MANDATORY]
		85
		86	Try to connect to the specified host and service (port), using
		87	C<AnyEvent::Socket::tcp_connect>. The C<$host> additionally becomes the
		88	default C<peername>.
		89
		90	You have to specify either this parameter, or C<fh>, above.
		91
		92	It is possible to push requests on the read and write queues, and modify
		93	properties of the stream, even while AnyEvent::Handle is connecting.
		94
		95	When this parameter is specified, then the C<on_prepare>,
		96	C<on_connect_error> and C<on_connect> callbacks will be called under the
		97	appropriate circumstances:
		98
		99	=over 4
		100
		101	=item on_prepare => $cb->($handle)
		102
		103	This (rarely used) callback is called before a new connection is
		104	attempted, but after the file handle has been created. It could be used to
		105	prepare the file handle with parameters required for the actual connect
		106	(as opposed to settings that can be changed when the connection is already
		107	established).
		108
		109	The return value of this callback should be the connect timeout value in
		110	seconds (or C<0>, or C<undef>, or the empty list, to indicate the default
		111	timeout is to be used).
		112
		113	=item on_connect => $cb->($handle, $host, $port, $retry->())
		114
		115	This callback is called when a connection has been successfully established.
		116
		117	The actual numeric host and port (the socket peername) are passed as
		118	parameters, together with a retry callback.
		119
		120	When, for some reason, the handle is not acceptable, then calling
		121	C<$retry> will continue with the next conenction target (in case of
		122	multi-homed hosts or SRV records there can be multiple connection
		123	endpoints). When it is called then the read and write queues, eof status,
		124	tls status and similar properties of the handle are being reset.
		125
		126	In most cases, ignoring the C<$retry> parameter is the way to go.
		127
		128	=item on_connect_error => $cb->($handle, $message)
		129
		130	This callback is called when the conenction could not be
		131	established. C<$!> will contain the relevant error code, and C<$message> a
		132	message describing it (usually the same as C<"$!">).
		133
		134	If this callback isn't specified, then C<on_error> will be called with a
		135	fatal error instead.
		136
		137	=back
		138
		139	=item on_error => $cb->($handle, $fatal, $message)
		140
		141	This is the error callback, which is called when, well, some error
		142	occured, such as not being able to resolve the hostname, failure to
		143	connect or a read error.
		144
		145	Some errors are fatal (which is indicated by C<$fatal> being true). On
		146	fatal errors the handle object will be destroyed (by a call to C<< ->
		147	destroy >>) after invoking the error callback (which means you are free to
		148	examine the handle object). Examples of fatal errors are an EOF condition
		149	with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors. In
		150	cases where the other side can close the connection at their will it is
		151	often easiest to not report C<EPIPE> errors in this callback.
		152
		153	AnyEvent::Handle tries to find an appropriate error code for you to check
		154	against, but in some cases (TLS errors), this does not work well. It is
		155	recommended to always output the C<$message> argument in human-readable
		156	error messages (it's usually the same as C<"$!">).
		157
		158	Non-fatal errors can be retried by simply returning, but it is recommended
		159	to simply ignore this parameter and instead abondon the handle object
		160	when this callback is invoked. Examples of non-fatal errors are timeouts
		161	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
		162
		163	On callback entrance, the value of C<$!> contains the operating system
		164	error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
		165	C<EPROTO>).
		166
		167	While not mandatory, it is I<highly> recommended to set this callback, as
		168	you will not be notified of errors otherwise. The default simply calls
		169	C<croak>.
		170
		171	=item on_read => $cb->($handle)
		172
		173	This sets the default read callback, which is called when data arrives
		174	and no read request is in the queue (unlike read queue callbacks, this
		175	callback will only be called when at least one octet of data is in the
		176	read buffer).
		177
		178	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
		179	method or access the C<< $handle->{rbuf} >> member directly. Note that you
		180	must not enlarge or modify the read buffer, you can only remove data at
		181	the beginning from it.
		182
		183	When an EOF condition is detected then AnyEvent::Handle will first try to
		184	feed all the remaining data to the queued callbacks and C<on_read> before
		185	calling the C<on_eof> callback. If no progress can be made, then a fatal
		186	error will be raised (with C<$!> set to C<EPIPE>).
		187
		188	Note that, unlike requests in the read queue, an C<on_read> callback
		189	doesn't mean you I<require> some data: if there is an EOF and there
		190	are outstanding read requests then an error will be flagged. With an
		191	C<on_read> callback, the C<on_eof> callback will be invoked.
		192
82	=item on_eof => $cb->($handle)	193	=item on_eof => $cb->($handle)
83		194
84	Set the callback to be called when an end-of-file condition is detected,	195	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	196	i.e. in the case of a socket, when the other side has closed the
86	connection cleanly.	197	connection cleanly, and there are no outstanding read requests in the
		198	queue (if there are read requests, then an EOF counts as an unexpected
		199	connection close and will be flagged as an error).
87		200
88	For sockets, this just means that the other side has stopped sending data,	201	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	202	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	203	callback and continue writing data, as only the read part has been shut
91	down.	204	down.
92		205
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	206	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>.	207	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		208
147	=item on_drain => $cb->($handle)	209	=item on_drain => $cb->($handle)
148		210
149	This sets the callback that is called when the write buffer becomes empty	211	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).	212	(or when the callback is set and the buffer is empty already).
157	memory and push it into the queue, but instead only read more data from	219	memory and push it into the queue, but instead only read more data from
158	the file when the write queue becomes empty.	220	the file when the write queue becomes empty.
159		221
160	=item timeout => $fractional_seconds	222	=item timeout => $fractional_seconds
161		223
		224	=item rtimeout => $fractional_seconds
		225
		226	=item wtimeout => $fractional_seconds
		227
162	If non-zero, then this enables an "inactivity" timeout: whenever this many	228	If non-zero, then these enables an "inactivity" timeout: whenever this
163	seconds pass without a successful read or write on the underlying file	229	many seconds pass without a successful read or write on the underlying
164	handle, the C<on_timeout> callback will be invoked (and if that one is	230	file handle (or a call to C<timeout_reset>), the C<on_timeout> callback
165	missing, a non-fatal C<ETIMEDOUT> error will be raised).	231	will be invoked (and if that one is missing, a non-fatal C<ETIMEDOUT>
		232	error will be raised).
		233
		234	There are three variants of the timeouts that work fully independent
		235	of each other, for both read and write, just read, and just write:
		236	C<timeout>, C<rtimeout> and C<wtimeout>, with corresponding callbacks
		237	C<on_timeout>, C<on_rtimeout> and C<on_wtimeout>, and reset functions
		238	C<timeout_reset>, C<rtimeout_reset>, and C<wtimeout_reset>.
166		239
167	Note that timeout processing is also active when you currently do not have	240	Note that timeout processing is also active when you currently do not have
168	any outstanding read or write requests: If you plan to keep the connection	241	any outstanding read or write requests: If you plan to keep the connection
169	idle then you should disable the timout temporarily or ignore the timeout	242	idle then you should disable the timout temporarily or ignore the timeout
170	in the C<on_timeout> callback, in which case AnyEvent::Handle will simply	243	in the C<on_timeout> callback, in which case AnyEvent::Handle will simply
…		…
349		422
350	sub new {	423	sub new {
351	my $class = shift;	424	my $class = shift;
352	my $self = bless { @_ }, $class;	425	my $self = bless { @_ }, $class;
353		426
354	$self->{fh} or Carp::croak "mandatory argument fh is missing";	427	if ($self->{fh}) {
		428	$self->_start;
		429	return unless $self->{fh}; # could be gone by now
		430
		431	} elsif ($self->{connect}) {
		432	require AnyEvent::Socket;
		433
		434	$self->{peername} = $self->{connect}[0]
		435	unless exists $self->{peername};
		436
		437	$self->{_skip_drain_rbuf} = 1;
		438
		439	{
		440	Scalar::Util::weaken (my $self = $self);
		441
		442	$self->{_connect} =
		443	AnyEvent::Socket::tcp_connect (
		444	$self->{connect}[0],
		445	$self->{connect}[1],
		446	sub {
		447	my ($fh, $host, $port, $retry) = @_;
		448
		449	if ($fh) {
		450	$self->{fh} = $fh;
		451
		452	delete $self->{_skip_drain_rbuf};
		453	$self->_start;
		454
		455	$self->{on_connect}
		456	and $self->{on_connect}($self, $host, $port, sub {
		457	delete @$self{qw(fh _tw _ww _rw _eof _queue rbuf _wbuf tls _tls_rbuf _tls_wbuf)};
		458	$self->{_skip_drain_rbuf} = 1;
		459	&$retry;
		460	});
		461
		462	} else {
		463	if ($self->{on_connect_error}) {
		464	$self->{on_connect_error}($self, "$!");
		465	$self->destroy;
		466	} else {
		467	$self->_error ($!, 1);
		468	}
		469	}
		470	},
		471	sub {
		472	local $self->{fh} = $_[0];
		473
		474	$self->{on_prepare}
		475	? $self->{on_prepare}->($self)
		476	: ()
		477	}
		478	);
		479	}
		480
		481	} else {
		482	Carp::croak "AnyEvent::Handle: either an existing fh or the connect parameter must be specified";
		483	}
		484
		485	$self
		486	}
		487
		488	sub _start {
		489	my ($self) = @_;
355		490
356	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	491	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
357		492
		493	$self->{_activity} =
		494	$self->{_ractivity} =
358	$self->{_activity} = AnyEvent->now;	495	$self->{_wactivity} = AE::now;
359	$self->_timeout;	496
		497	$self->timeout (delete $self->{timeout} ) if $self->{timeout};
		498	$self->rtimeout (delete $self->{rtimeout}) if $self->{rtimeout};
		499	$self->wtimeout (delete $self->{wtimeout}) if $self->{wtimeout};
360		500
361	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};	501	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
362		502
363	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})	503	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
364	if $self->{tls};	504	if $self->{tls};
365		505
366	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	506	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
367		507
368	$self->start_read	508	$self->start_read
369	if $self->{on_read};	509	if $self->{on_read} \|\| @{ $self->{_queue} };
370		510
371	$self->{fh} && $self	511	$self->_drain_wbuf;
372	}	512	}
373		513
374	sub _shutdown {	514	#sub _shutdown {
375	my ($self) = @_;	515	# my ($self) = @_;
376		516	#
377	delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)};	517	# delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)};
378	$self->{_eof} = 1; # tell starttls et. al to stop trying	518	# $self->{_eof} = 1; # tell starttls et. al to stop trying
379		519	#
380	&_freetls;	520	# &_freetls;
381	}	521	#}
382		522
383	sub _error {	523	sub _error {
384	my ($self, $errno, $fatal, $message) = @_;	524	my ($self, $errno, $fatal, $message) = @_;
385		525
386	$self->_shutdown
387	if $fatal;
388
389	$! = $errno;	526	$! = $errno;
390	$message \|\|= "$!";	527	$message \|\|= "$!";
391		528
392	if ($self->{on_error}) {	529	if ($self->{on_error}) {
393	$self->{on_error}($self, $fatal, $message);	530	$self->{on_error}($self, $fatal, $message);
		531	$self->destroy if $fatal;
394	} elsif ($self->{fh}) {	532	} elsif ($self->{fh}) {
		533	$self->destroy;
395	Carp::croak "AnyEvent::Handle uncaught error: $message";	534	Carp::croak "AnyEvent::Handle uncaught error: $message";
396	}	535	}
397	}	536	}
398		537
399	=item $fh = $handle->fh	538	=item $fh = $handle->fh
…		…
424	$_[0]{on_eof} = $_[1];	563	$_[0]{on_eof} = $_[1];
425	}	564	}
426		565
427	=item $handle->on_timeout ($cb)	566	=item $handle->on_timeout ($cb)
428		567
429	Replace the current C<on_timeout> callback, or disables the callback (but	568	=item $handle->on_rtimeout ($cb)
430	not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
431	argument and method.
432		569
433	=cut	570	=item $handle->on_wtimeout ($cb)
434		571
435	sub on_timeout {	572	Replace the current C<on_timeout>, C<on_rtimeout> or C<on_wtimeout>
436	$_[0]{on_timeout} = $_[1];	573	callback, or disables the callback (but not the timeout) if C<$cb> =
437	}	574	C<undef>. See the C<timeout> constructor argument and method.
		575
		576	=cut
		577
		578	# see below
438		579
439	=item $handle->autocork ($boolean)	580	=item $handle->autocork ($boolean)
440		581
441	Enables or disables the current autocork behaviour (see C<autocork>	582	Enables or disables the current autocork behaviour (see C<autocork>
442	constructor argument). Changes will only take effect on the next write.	583	constructor argument). Changes will only take effect on the next write.
…		…
457	sub no_delay {	598	sub no_delay {
458	$_[0]{no_delay} = $_[1];	599	$_[0]{no_delay} = $_[1];
459		600
460	eval {	601	eval {
461	local $SIG{__DIE__};	602	local $SIG{__DIE__};
462	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];	603	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1]
		604	if $_[0]{fh};
463	};	605	};
464	}	606	}
465		607
466	=item $handle->on_starttls ($cb)	608	=item $handle->on_starttls ($cb)
467		609
…		…
481		623
482	sub on_starttls {	624	sub on_starttls {
483	$_[0]{on_stoptls} = $_[1];	625	$_[0]{on_stoptls} = $_[1];
484	}	626	}
485		627
		628	=item $handle->rbuf_max ($max_octets)
		629
		630	Configures the C<rbuf_max> setting (C<undef> disables it).
		631
		632	=cut
		633
		634	sub rbuf_max {
		635	$_[0]{rbuf_max} = $_[1];
		636	}
		637
486	#############################################################################	638	#############################################################################
487		639
488	=item $handle->timeout ($seconds)	640	=item $handle->timeout ($seconds)
489		641
		642	=item $handle->rtimeout ($seconds)
		643
		644	=item $handle->wtimeout ($seconds)
		645
490	Configures (or disables) the inactivity timeout.	646	Configures (or disables) the inactivity timeout.
491		647
492	=cut	648	=item $handle->timeout_reset
493		649
494	sub timeout {	650	=item $handle->rtimeout_reset
		651
		652	=item $handle->wtimeout_reset
		653
		654	Reset the activity timeout, as if data was received or sent.
		655
		656	These methods are cheap to call.
		657
		658	=cut
		659
		660	for my $dir ("", "r", "w") {
		661	my $timeout = "${dir}timeout";
		662	my $tw = "_${dir}tw";
		663	my $on_timeout = "on_${dir}timeout";
		664	my $activity = "_${dir}activity";
		665	my $cb;
		666
		667	*$on_timeout = sub {
		668	$_[0]{$on_timeout} = $_[1];
		669	};
		670
		671	*$timeout = sub {
495	my ($self, $timeout) = @_;	672	my ($self, $new_value) = @_;
496		673
497	$self->{timeout} = $timeout;	674	$self->{$timeout} = $new_value;
498	$self->_timeout;	675	delete $self->{$tw}; &$cb;
499	}	676	};
500		677
		678	*{"${dir}timeout_reset"} = sub {
		679	$_[0]{$activity} = AE::now;
		680	};
		681
		682	# main workhorse:
501	# reset the timeout watcher, as neccessary	683	# reset the timeout watcher, as neccessary
502	# also check for time-outs	684	# also check for time-outs
503	sub _timeout {	685	$cb = sub {
504	my ($self) = @_;	686	my ($self) = @_;
505		687
506	if ($self->{timeout}) {	688	if ($self->{$timeout} && $self->{fh}) {
507	my $NOW = AnyEvent->now;	689	my $NOW = AE::now;
508		690
509	# when would the timeout trigger?	691	# when would the timeout trigger?
510	my $after = $self->{_activity} + $self->{timeout} - $NOW;	692	my $after = $self->{$activity} + $self->{$timeout} - $NOW;
511		693
512	# now or in the past already?	694	# now or in the past already?
513	if ($after <= 0) {	695	if ($after <= 0) {
514	$self->{_activity} = $NOW;	696	$self->{$activity} = $NOW;
515		697
516	if ($self->{on_timeout}) {	698	if ($self->{$on_timeout}) {
517	$self->{on_timeout}($self);	699	$self->{$on_timeout}($self);
518	} else {	700	} else {
519	$self->_error (&Errno::ETIMEDOUT);	701	$self->_error (Errno::ETIMEDOUT);
		702	}
		703
		704	# callback could have changed timeout value, optimise
		705	return unless $self->{$timeout};
		706
		707	# calculate new after
		708	$after = $self->{$timeout};
520	}	709	}
521		710
522	# callback could have changed timeout value, optimise	711	Scalar::Util::weaken $self;
523	return unless $self->{timeout};	712	return unless $self; # ->error could have destroyed $self
524		713
525	# calculate new after	714	$self->{$tw} \|\|= AE::timer $after, 0, sub {
526	$after = $self->{timeout};	715	delete $self->{$tw};
		716	$cb->($self);
		717	};
		718	} else {
		719	delete $self->{$tw};
527	}	720	}
528
529	Scalar::Util::weaken $self;
530	return unless $self; # ->error could have destroyed $self
531
532	$self->{_tw} \|\|= AnyEvent->timer (after => $after, cb => sub {
533	delete $self->{_tw};
534	$self->_timeout;
535	});
536	} else {
537	delete $self->{_tw};
538	}	721	}
539	}	722	}
540		723
541	#############################################################################	724	#############################################################################
542		725
…		…
590	my $len = syswrite $self->{fh}, $self->{wbuf};	773	my $len = syswrite $self->{fh}, $self->{wbuf};
591		774
592	if (defined $len) {	775	if (defined $len) {
593	substr $self->{wbuf}, 0, $len, "";	776	substr $self->{wbuf}, 0, $len, "";
594		777
595	$self->{_activity} = AnyEvent->now;	778	$self->{_activity} = $self->{_wactivity} = AE::now;
596		779
597	$self->{on_drain}($self)	780	$self->{on_drain}($self)
598	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})	781	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
599	&& $self->{on_drain};	782	&& $self->{on_drain};
600		783
…		…
606		789
607	# try to write data immediately	790	# try to write data immediately
608	$cb->() unless $self->{autocork};	791	$cb->() unless $self->{autocork};
609		792
610	# if still data left in wbuf, we need to poll	793	# if still data left in wbuf, we need to poll
611	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	794	$self->{_ww} = AE::io $self->{fh}, 1, $cb
612	if length $self->{wbuf};	795	if length $self->{wbuf};
613	};	796	};
614	}	797	}
615		798
616	our %WH;	799	our %WH;
…		…
629	->($self, @_);	812	->($self, @_);
630	}	813	}
631		814
632	if ($self->{tls}) {	815	if ($self->{tls}) {
633	$self->{_tls_wbuf} .= $_[0];	816	$self->{_tls_wbuf} .= $_[0];
634		817	&_dotls ($self) if $self->{fh};
635	&_dotls ($self);
636	} else {	818	} else {
637	$self->{wbuf} .= $_[0];	819	$self->{wbuf} .= $_[0];
638	$self->_drain_wbuf;	820	$self->_drain_wbuf if $self->{fh};
639	}	821	}
640	}	822	}
641		823
642	=item $handle->push_write (type => @args)	824	=item $handle->push_write (type => @args)
643		825
…		…
860	=cut	1042	=cut
861		1043
862	sub _drain_rbuf {	1044	sub _drain_rbuf {
863	my ($self) = @_;	1045	my ($self) = @_;
864		1046
		1047	# avoid recursion
		1048	return if $self->{_skip_drain_rbuf};
865	local $self->{_in_drain} = 1;	1049	local $self->{_skip_drain_rbuf} = 1;
866
867	if (
868	defined $self->{rbuf_max}
869	&& $self->{rbuf_max} < length $self->{rbuf}
870	) {
871	$self->_error (&Errno::ENOSPC, 1), return;
872	}
873		1050
874	while () {	1051	while () {
875	# we need to use a separate tls read buffer, as we must not receive data while	1052	# we need to use a separate tls read buffer, as we must not receive data while
876	# we are draining the buffer, and this can only happen with TLS.	1053	# we are draining the buffer, and this can only happen with TLS.
877	$self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf};	1054	$self->{rbuf} .= delete $self->{_tls_rbuf}
		1055	if exists $self->{_tls_rbuf};
878		1056
879	my $len = length $self->{rbuf};	1057	my $len = length $self->{rbuf};
880		1058
881	if (my $cb = shift @{ $self->{_queue} }) {	1059	if (my $cb = shift @{ $self->{_queue} }) {
882	unless ($cb->($self)) {	1060	unless ($cb->($self)) {
883	if ($self->{_eof}) {	1061	# no progress can be made
884	# no progress can be made (not enough data and no data forthcoming)	1062	# (not enough data and no data forthcoming)
885	$self->_error (&Errno::EPIPE, 1), return;	1063	$self->_error (Errno::EPIPE, 1), return
886	}	1064	if $self->{_eof};
887		1065
888	unshift @{ $self->{_queue} }, $cb;	1066	unshift @{ $self->{_queue} }, $cb;
889	last;	1067	last;
890	}	1068	}
891	} elsif ($self->{on_read}) {	1069	} elsif ($self->{on_read}) {
…		…
898	&& !@{ $self->{_queue} } # and the queue is still empty	1076	&& !@{ $self->{_queue} } # and the queue is still empty
899	&& $self->{on_read} # but we still have on_read	1077	&& $self->{on_read} # but we still have on_read
900	) {	1078	) {
901	# no further data will arrive	1079	# no further data will arrive
902	# so no progress can be made	1080	# so no progress can be made
903	$self->_error (&Errno::EPIPE, 1), return	1081	$self->_error (Errno::EPIPE, 1), return
904	if $self->{_eof};	1082	if $self->{_eof};
905		1083
906	last; # more data might arrive	1084	last; # more data might arrive
907	}	1085	}
908	} else {	1086	} else {
…		…
911	last;	1089	last;
912	}	1090	}
913	}	1091	}
914		1092
915	if ($self->{_eof}) {	1093	if ($self->{_eof}) {
916	if ($self->{on_eof}) {	1094	$self->{on_eof}
917	$self->{on_eof}($self)	1095	? $self->{on_eof}($self)
918	} else {
919	$self->_error (0, 1, "Unexpected end-of-file");	1096	: $self->_error (0, 1, "Unexpected end-of-file");
920	}	1097
		1098	return;
		1099	}
		1100
		1101	if (
		1102	defined $self->{rbuf_max}
		1103	&& $self->{rbuf_max} < length $self->{rbuf}
		1104	) {
		1105	$self->_error (Errno::ENOSPC, 1), return;
921	}	1106	}
922		1107
923	# may need to restart read watcher	1108	# may need to restart read watcher
924	unless ($self->{_rw}) {	1109	unless ($self->{_rw}) {
925	$self->start_read	1110	$self->start_read
…		…
937		1122
938	sub on_read {	1123	sub on_read {
939	my ($self, $cb) = @_;	1124	my ($self, $cb) = @_;
940		1125
941	$self->{on_read} = $cb;	1126	$self->{on_read} = $cb;
942	$self->_drain_rbuf if $cb && !$self->{_in_drain};	1127	$self->_drain_rbuf if $cb;
943	}	1128	}
944		1129
945	=item $handle->rbuf	1130	=item $handle->rbuf
946		1131
947	Returns the read buffer (as a modifiable lvalue).	1132	Returns the read buffer (as a modifiable lvalue).
…		…
999	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	1184	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
1000	->($self, $cb, @_);	1185	->($self, $cb, @_);
1001	}	1186	}
1002		1187
1003	push @{ $self->{_queue} }, $cb;	1188	push @{ $self->{_queue} }, $cb;
1004	$self->_drain_rbuf unless $self->{_in_drain};	1189	$self->_drain_rbuf;
1005	}	1190	}
1006		1191
1007	sub unshift_read {	1192	sub unshift_read {
1008	my $self = shift;	1193	my $self = shift;
1009	my $cb = pop;	1194	my $cb = pop;
…		…
1015	->($self, $cb, @_);	1200	->($self, $cb, @_);
1016	}	1201	}
1017		1202
1018		1203
1019	unshift @{ $self->{_queue} }, $cb;	1204	unshift @{ $self->{_queue} }, $cb;
1020	$self->_drain_rbuf unless $self->{_in_drain};	1205	$self->_drain_rbuf;
1021	}	1206	}
1022		1207
1023	=item $handle->push_read (type => @args, $cb)	1208	=item $handle->push_read (type => @args, $cb)
1024		1209
1025	=item $handle->unshift_read (type => @args, $cb)	1210	=item $handle->unshift_read (type => @args, $cb)
…		…
1158	return 1;	1343	return 1;
1159	}	1344	}
1160		1345
1161	# reject	1346	# reject
1162	if ($reject && $$rbuf =~ $reject) {	1347	if ($reject && $$rbuf =~ $reject) {
1163	$self->_error (&Errno::EBADMSG);	1348	$self->_error (Errno::EBADMSG);
1164	}	1349	}
1165		1350
1166	# skip	1351	# skip
1167	if ($skip && $$rbuf =~ $skip) {	1352	if ($skip && $$rbuf =~ $skip) {
1168	$data .= substr $$rbuf, 0, $+[0], "";	1353	$data .= substr $$rbuf, 0, $+[0], "";
…		…
1184	my ($self, $cb) = @_;	1369	my ($self, $cb) = @_;
1185		1370
1186	sub {	1371	sub {
1187	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {	1372	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
1188	if ($_[0]{rbuf} =~ /[^0-9]/) {	1373	if ($_[0]{rbuf} =~ /[^0-9]/) {
1189	$self->_error (&Errno::EBADMSG);	1374	$self->_error (Errno::EBADMSG);
1190	}	1375	}
1191	return;	1376	return;
1192	}	1377	}
1193		1378
1194	my $len = $1;	1379	my $len = $1;
…		…
1197	my $string = $_[1];	1382	my $string = $_[1];
1198	$_[0]->unshift_read (chunk => 1, sub {	1383	$_[0]->unshift_read (chunk => 1, sub {
1199	if ($_[1] eq ",") {	1384	if ($_[1] eq ",") {
1200	$cb->($_[0], $string);	1385	$cb->($_[0], $string);
1201	} else {	1386	} else {
1202	$self->_error (&Errno::EBADMSG);	1387	$self->_error (Errno::EBADMSG);
1203	}	1388	}
1204	});	1389	});
1205	});	1390	});
1206		1391
1207	1	1392	1
…		…
1297	$json->incr_skip;	1482	$json->incr_skip;
1298		1483
1299	$self->{rbuf} = $json->incr_text;	1484	$self->{rbuf} = $json->incr_text;
1300	$json->incr_text = "";	1485	$json->incr_text = "";
1301		1486
1302	$self->_error (&Errno::EBADMSG);	1487	$self->_error (Errno::EBADMSG);
1303		1488
1304	()	1489	()
1305	} else {	1490	} else {
1306	$self->{rbuf} = "";	1491	$self->{rbuf} = "";
1307		1492
…		…
1344	# read remaining chunk	1529	# read remaining chunk
1345	$_[0]->unshift_read (chunk => $len, sub {	1530	$_[0]->unshift_read (chunk => $len, sub {
1346	if (my $ref = eval { Storable::thaw ($_[1]) }) {	1531	if (my $ref = eval { Storable::thaw ($_[1]) }) {
1347	$cb->($_[0], $ref);	1532	$cb->($_[0], $ref);
1348	} else {	1533	} else {
1349	$self->_error (&Errno::EBADMSG);	1534	$self->_error (Errno::EBADMSG);
1350	}	1535	}
1351	});	1536	});
1352	}	1537	}
1353		1538
1354	1	1539	1
…		…
1406	my ($self) = @_;	1591	my ($self) = @_;
1407		1592
1408	unless ($self->{_rw} \|\| $self->{_eof}) {	1593	unless ($self->{_rw} \|\| $self->{_eof}) {
1409	Scalar::Util::weaken $self;	1594	Scalar::Util::weaken $self;
1410		1595
1411	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1596	$self->{_rw} = AE::io $self->{fh}, 0, sub {
1412	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});	1597	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1413	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;	1598	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;
1414		1599
1415	if ($len > 0) {	1600	if ($len > 0) {
1416	$self->{_activity} = AnyEvent->now;	1601	$self->{_activity} = $self->{_ractivity} = AE::now;
1417		1602
1418	if ($self->{tls}) {	1603	if ($self->{tls}) {
1419	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);	1604	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1420		1605
1421	&_dotls ($self);	1606	&_dotls ($self);
1422	} else {	1607	} else {
1423	$self->_drain_rbuf unless $self->{_in_drain};	1608	$self->_drain_rbuf;
1424	}	1609	}
1425		1610
1426	} elsif (defined $len) {	1611	} elsif (defined $len) {
1427	delete $self->{_rw};	1612	delete $self->{_rw};
1428	$self->{_eof} = 1;	1613	$self->{_eof} = 1;
1429	$self->_drain_rbuf unless $self->{_in_drain};	1614	$self->_drain_rbuf;
1430		1615
1431	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1616	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1432	return $self->_error ($!, 1);	1617	return $self->_error ($!, 1);
1433	}	1618	}
1434	});	1619	};
1435	}	1620	}
1436	}	1621	}
1437		1622
1438	our $ERROR_SYSCALL;	1623	our $ERROR_SYSCALL;
1439	our $ERROR_WANT_READ;	1624	our $ERROR_WANT_READ;
…		…
1452	if ($self->{_on_starttls}) {	1637	if ($self->{_on_starttls}) {
1453	(delete $self->{_on_starttls})->($self, undef, $err);	1638	(delete $self->{_on_starttls})->($self, undef, $err);
1454	&_freetls;	1639	&_freetls;
1455	} else {	1640	} else {
1456	&_freetls;	1641	&_freetls;
1457	$self->_error (&Errno::EPROTO, 1, $err);	1642	$self->_error (Errno::EPROTO, 1, $err);
1458	}	1643	}
1459	}	1644	}
1460		1645
1461	# poll the write BIO and send the data if applicable	1646	# poll the write BIO and send the data if applicable
1462	# also decode read data if possible	1647	# also decode read data if possible
…		…
1494	$self->{_eof} = 1;	1679	$self->{_eof} = 1;
1495	}	1680	}
1496	}	1681	}
1497		1682
1498	$self->{_tls_rbuf} .= $tmp;	1683	$self->{_tls_rbuf} .= $tmp;
1499	$self->_drain_rbuf unless $self->{_in_drain};	1684	$self->_drain_rbuf;
1500	$self->{tls} or return; # tls session might have gone away in callback	1685	$self->{tls} or return; # tls session might have gone away in callback
1501	}	1686	}
1502		1687
1503	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);	1688	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1504	return $self->_tls_error ($tmp)	1689	return $self->_tls_error ($tmp)
…		…
1519		1704
1520	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	1705	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
1521	object is created, you can also do that at a later time by calling	1706	object is created, you can also do that at a later time by calling
1522	C<starttls>.	1707	C<starttls>.
1523		1708
		1709	Starting TLS is currently an asynchronous operation - when you push some
		1710	write data and then call C<< ->starttls >> then TLS negotiation will start
		1711	immediately, after which the queued write data is then sent.
		1712
1524	The first argument is the same as the C<tls> constructor argument (either	1713	The first argument is the same as the C<tls> constructor argument (either
1525	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1714	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1526		1715
1527	The second argument is the optional C<AnyEvent::TLS> object that is used	1716	The second argument is the optional C<AnyEvent::TLS> object that is used
1528	when AnyEvent::Handle has to create its own TLS connection object, or	1717	when AnyEvent::Handle has to create its own TLS connection object, or
…		…
1532	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS	1721	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS
1533	context in C<< $handle->{tls_ctx} >> after this call and can be used or	1722	context in C<< $handle->{tls_ctx} >> after this call and can be used or
1534	changed to your liking. Note that the handshake might have already started	1723	changed to your liking. Note that the handshake might have already started
1535	when this function returns.	1724	when this function returns.
1536		1725
1537	If it an error to start a TLS handshake more than once per	1726	Due to bugs in OpenSSL, it might or might not be possible to do multiple
1538	AnyEvent::Handle object (this is due to bugs in OpenSSL).	1727	handshakes on the same stream. Best do not attempt to use the stream after
		1728	stopping TLS.
1539		1729
1540	=cut	1730	=cut
1541		1731
1542	our %TLS_CACHE; #TODO not yet documented, should we?	1732	our %TLS_CACHE; #TODO not yet documented, should we?
1543		1733
1544	sub starttls {	1734	sub starttls {
1545	my ($self, $ssl, $ctx) = @_;	1735	my ($self, $tls, $ctx) = @_;
		1736
		1737	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"
		1738	if $self->{tls};
		1739
		1740	$self->{tls} = $tls;
		1741	$self->{tls_ctx} = $ctx if @_ > 2;
		1742
		1743	return unless $self->{fh};
1546		1744
1547	require Net::SSLeay;	1745	require Net::SSLeay;
1548
1549	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"
1550	if $self->{tls};
1551		1746
1552	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();	1747	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1553	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();	1748	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1554		1749
		1750	$tls = $self->{tls};
1555	$ctx \|\|= $self->{tls_ctx};	1751	$ctx = $self->{tls_ctx};
		1752
		1753	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
1556		1754
1557	if ("HASH" eq ref $ctx) {	1755	if ("HASH" eq ref $ctx) {
1558	require AnyEvent::TLS;	1756	require AnyEvent::TLS;
1559
1560	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context
1561		1757
1562	if ($ctx->{cache}) {	1758	if ($ctx->{cache}) {
1563	my $key = $ctx+0;	1759	my $key = $ctx+0;
1564	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;	1760	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;
1565	} else {	1761	} else {
1566	$ctx = new AnyEvent::TLS %$ctx;	1762	$ctx = new AnyEvent::TLS %$ctx;
1567	}	1763	}
1568	}	1764	}
1569		1765
1570	$self->{tls_ctx} = $ctx \|\| TLS_CTX ();	1766	$self->{tls_ctx} = $ctx \|\| TLS_CTX ();
1571	$self->{tls} = $ssl = $self->{tls_ctx}->_get_session ($ssl, $self, $self->{peername});	1767	$self->{tls} = $tls = $self->{tls_ctx}->_get_session ($tls, $self, $self->{peername});
1572		1768
1573	# basically, this is deep magic (because SSL_read should have the same issues)	1769	# basically, this is deep magic (because SSL_read should have the same issues)
1574	# but the openssl maintainers basically said: "trust us, it just works".	1770	# but the openssl maintainers basically said: "trust us, it just works".
1575	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1771	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1576	# and mismaintained ssleay-module doesn't even offer them).	1772	# and mismaintained ssleay-module doesn't even offer them).
…		…
1583	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to	1779	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
1584	# have identity issues in that area.	1780	# have identity issues in that area.
1585	# Net::SSLeay::CTX_set_mode ($ssl,	1781	# Net::SSLeay::CTX_set_mode ($ssl,
1586	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1782	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
1587	# \| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));	1783	# \| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
1588	Net::SSLeay::CTX_set_mode ($ssl, 1\|2);	1784	Net::SSLeay::CTX_set_mode ($tls, 1\|2);
1589		1785
1590	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1786	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1591	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1787	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1592		1788
		1789	Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf});
		1790
1593	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1791	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
1594		1792
1595	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }	1793	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1596	if $self->{on_starttls};	1794	if $self->{on_starttls};
1597		1795
1598	&_dotls; # need to trigger the initial handshake	1796	&_dotls; # need to trigger the initial handshake
…		…
1601		1799
1602	=item $handle->stoptls	1800	=item $handle->stoptls
1603		1801
1604	Shuts down the SSL connection - this makes a proper EOF handshake by	1802	Shuts down the SSL connection - this makes a proper EOF handshake by
1605	sending a close notify to the other side, but since OpenSSL doesn't	1803	sending a close notify to the other side, but since OpenSSL doesn't
1606	support non-blocking shut downs, it is not possible to re-use the stream	1804	support non-blocking shut downs, it is not guarenteed that you can re-use
1607	afterwards.	1805	the stream afterwards.
1608		1806
1609	=cut	1807	=cut
1610		1808
1611	sub stoptls {	1809	sub stoptls {
1612	my ($self) = @_;	1810	my ($self) = @_;
…		…
1625	sub _freetls {	1823	sub _freetls {
1626	my ($self) = @_;	1824	my ($self) = @_;
1627		1825
1628	return unless $self->{tls};	1826	return unless $self->{tls};
1629		1827
1630	$self->{tls_ctx}->_put_session (delete $self->{tls});	1828	$self->{tls_ctx}->_put_session (delete $self->{tls})
		1829	if $self->{tls} > 0;
1631		1830
1632	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};	1831	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1633	}	1832	}
1634		1833
1635	sub DESTROY {	1834	sub DESTROY {
…		…
1637		1836
1638	&_freetls;	1837	&_freetls;
1639		1838
1640	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	1839	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1641		1840
1642	if ($linger && length $self->{wbuf}) {	1841	if ($linger && length $self->{wbuf} && $self->{fh}) {
1643	my $fh = delete $self->{fh};	1842	my $fh = delete $self->{fh};
1644	my $wbuf = delete $self->{wbuf};	1843	my $wbuf = delete $self->{wbuf};
1645		1844
1646	my @linger;	1845	my @linger;
1647		1846
1648	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {	1847	push @linger, AE::io $fh, 1, sub {
1649	my $len = syswrite $fh, $wbuf, length $wbuf;	1848	my $len = syswrite $fh, $wbuf, length $wbuf;
1650		1849
1651	if ($len > 0) {	1850	if ($len > 0) {
1652	substr $wbuf, 0, $len, "";	1851	substr $wbuf, 0, $len, "";
1653	} else {	1852	} else {
1654	@linger = (); # end	1853	@linger = (); # end
1655	}	1854	}
1656	});	1855	};
1657	push @linger, AnyEvent->timer (after => $linger, cb => sub {	1856	push @linger, AE::timer $linger, 0, sub {
1658	@linger = ();	1857	@linger = ();
1659	});	1858	};
1660	}	1859	}
1661	}	1860	}
1662		1861
1663	=item $handle->destroy	1862	=item $handle->destroy
1664		1863
1665	Shuts down the handle object as much as possible - this call ensures that	1864	Shuts down the handle object as much as possible - this call ensures that
1666	no further callbacks will be invoked and as many resources as possible	1865	no further callbacks will be invoked and as many resources as possible
1667	will be freed. You must not call any methods on the object afterwards.	1866	will be freed. Any method you will call on the handle object after
		1867	destroying it in this way will be silently ignored (and it will return the
		1868	empty list).
1668		1869
1669	Normally, you can just "forget" any references to an AnyEvent::Handle	1870	Normally, you can just "forget" any references to an AnyEvent::Handle
1670	object and it will simply shut down. This works in fatal error and EOF	1871	object and it will simply shut down. This works in fatal error and EOF
1671	callbacks, as well as code outside. It does I<NOT> work in a read or write	1872	callbacks, as well as code outside. It does I<NOT> work in a read or write
1672	callback, so when you want to destroy the AnyEvent::Handle object from	1873	callback, so when you want to destroy the AnyEvent::Handle object from
1673	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in	1874	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
1674	that case.	1875	that case.
1675		1876
		1877	Destroying the handle object in this way has the advantage that callbacks
		1878	will be removed as well, so if those are the only reference holders (as
		1879	is common), then one doesn't need to do anything special to break any
		1880	reference cycles.
		1881
1676	The handle might still linger in the background and write out remaining	1882	The handle might still linger in the background and write out remaining
1677	data, as specified by the C<linger> option, however.	1883	data, as specified by the C<linger> option, however.
1678		1884
1679	=cut	1885	=cut
1680		1886
1681	sub destroy {	1887	sub destroy {
1682	my ($self) = @_;	1888	my ($self) = @_;
1683		1889
1684	$self->DESTROY;	1890	$self->DESTROY;
1685	%$self = ();	1891	%$self = ();
		1892	bless $self, "AnyEvent::Handle::destroyed";
		1893	}
		1894
		1895	sub AnyEvent::Handle::destroyed::AUTOLOAD {
		1896	#nop
1686	}	1897	}
1687		1898
1688	=item AnyEvent::Handle::TLS_CTX	1899	=item AnyEvent::Handle::TLS_CTX
1689		1900
1690	This function creates and returns the AnyEvent::TLS object used by default	1901	This function creates and returns the AnyEvent::TLS object used by default
…		…
1747		1958
1748	$handle->on_read (sub { });	1959	$handle->on_read (sub { });
1749	$handle->on_eof (undef);	1960	$handle->on_eof (undef);
1750	$handle->on_error (sub {	1961	$handle->on_error (sub {
1751	my $data = delete $_[0]{rbuf};	1962	my $data = delete $_[0]{rbuf};
1752	undef $handle;
1753	});	1963	});
1754		1964
1755	The reason to use C<on_error> is that TCP connections, due to latencies	1965	The reason to use C<on_error> is that TCP connections, due to latencies
1756	and packets loss, might get closed quite violently with an error, when in	1966	and packets loss, might get closed quite violently with an error, when in
1757	fact, all data has been received.	1967	fact, all data has been received.

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.146 by root, Wed Jul 8 13:46:46 2009 UTC vs. Revision 1.176 by root, Sun Aug 9 00:20:35 2009 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.146 by root, Wed Jul 8 13:46:46 2009 UTC vs.
Revision 1.176 by root, Sun Aug 9 00:20:35 2009 UTC