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