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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.150 by root, Thu Jul 16 04:16:25 2009 UTC vs.
Revision 1.182 by root, Thu Sep 3 12:35:01 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.82;
20		4
21	=head1 SYNOPSIS	5	=head1 SYNOPSIS
22		6
23	use AnyEvent;	7	use AnyEvent;
24	use AnyEvent::Handle;	8	use AnyEvent::Handle;
26	my $cv = AnyEvent->condvar;	10	my $cv = AnyEvent->condvar;
27		11
28	my $hdl; $hdl = new AnyEvent::Handle	12	my $hdl; $hdl = new AnyEvent::Handle
29	fh => \*STDIN,	13	fh => \*STDIN,
30	on_error => sub {	14	on_error => sub {
		15	my ($hdl, $fatal, $msg) = @_;
31	warn "got error $_[2]\n";	16	warn "got error $msg\n";
		17	$hdl->destroy;
32	$cv->send;	18	$cv->send;
33	);	19	);
34		20
35	# send some request line	21	# send some request line
36	$hdl->push_write ("getinfo\015\012");	22	$hdl->push_write ("getinfo\015\012");
…		…
45	$cv->recv;	31	$cv->recv;
46		32
47	=head1 DESCRIPTION	33	=head1 DESCRIPTION
48		34
49	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
50	filehandles. For utility functions for doing non-blocking connects and accepts	36	filehandles.
51	on sockets see L<AnyEvent::Util>.
52		37
53	The L<AnyEvent::Intro> tutorial contains some well-documented	38	The L<AnyEvent::Intro> tutorial contains some well-documented
54	AnyEvent::Handle examples.	39	AnyEvent::Handle examples.
55		40
56	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
57	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
58	treatment of characters applies to this module as well.	43	treatment of characters applies to this module as well.
59		44
		45	At the very minimum, you should specify C<fh> or C<connect>, and the
		46	C<on_error> callback.
		47
60	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
61	argument.	49	argument.
62		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
63	=head1 METHODS	65	=head1 METHODS
64		66
65	=over 4	67	=over 4
66		68
67	=item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value...	69	=item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value...
68		70
69	The constructor supports these arguments (all as C<< key => value >> pairs).	71	The constructor supports these arguments (all as C<< key => value >> pairs).
70		72
71	=over 4	73	=over 4
72		74
73	=item fh => $filehandle [MANDATORY]	75	=item fh => $filehandle [C<fh> or C<connect> MANDATORY]
74		76
75	The filehandle this L<AnyEvent::Handle> object will operate on.	77	The filehandle this L<AnyEvent::Handle> object will operate on.
76
77	NOTE: The filehandle will be set to non-blocking mode (using	78	NOTE: The filehandle will be set to non-blocking mode (using
78	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
79	that mode.	80	that mode.
		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.
80		190
81	=item on_eof => $cb->($handle)	191	=item on_eof => $cb->($handle)
82		192
83	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,
84	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
…		…
92	down.	202	down.
93		203
94	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
95	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>.
96		206
97	=item on_error => $cb->($handle, $fatal, $message)
98
99	This is the error callback, which is called when, well, some error
100	occured, such as not being able to resolve the hostname, failure to
101	connect or a read error.
102
103	Some errors are fatal (which is indicated by C<$fatal> being true). On
104	fatal errors the handle object will be destroyed (by a call to C<< ->
105	destroy >>) after invoking the error callback (which means you are free to
106	examine the handle object). Examples of fatal errors are an EOF condition
107	with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors.
108
109	AnyEvent::Handle tries to find an appropriate error code for you to check
110	against, but in some cases (TLS errors), this does not work well. It is
111	recommended to always output the C<$message> argument in human-readable
112	error messages (it's usually the same as C<"$!">).
113
114	Non-fatal errors can be retried by simply returning, but it is recommended
115	to simply ignore this parameter and instead abondon the handle object
116	when this callback is invoked. Examples of non-fatal errors are timeouts
117	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
118
119	On callback entrance, the value of C<$!> contains the operating system
120	error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
121	C<EPROTO>).
122
123	While not mandatory, it is I<highly> recommended to set this callback, as
124	you will not be notified of errors otherwise. The default simply calls
125	C<croak>.
126
127	=item on_read => $cb->($handle)
128
129	This sets the default read callback, which is called when data arrives
130	and no read request is in the queue (unlike read queue callbacks, this
131	callback will only be called when at least one octet of data is in the
132	read buffer).
133
134	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
135	method or access the C<< $handle->{rbuf} >> member directly. Note that you
136	must not enlarge or modify the read buffer, you can only remove data at
137	the beginning from it.
138
139	When an EOF condition is detected then AnyEvent::Handle will first try to
140	feed all the remaining data to the queued callbacks and C<on_read> before
141	calling the C<on_eof> callback. If no progress can be made, then a fatal
142	error will be raised (with C<$!> set to C<EPIPE>).
143
144	Note that, unlike requests in the read queue, an C<on_read> callback
145	doesn't mean you I<require> some data: if there is an EOF and there
146	are outstanding read requests then an error will be flagged. With an
147	C<on_read> callback, the C<on_eof> callback will be invoked.
148
149	=item on_drain => $cb->($handle)	207	=item on_drain => $cb->($handle)
150		208
151	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
152	(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).
153		211
…		…
159	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
160	the file when the write queue becomes empty.	218	the file when the write queue becomes empty.
161		219
162	=item timeout => $fractional_seconds	220	=item timeout => $fractional_seconds
163		221
		222	=item rtimeout => $fractional_seconds
		223
		224	=item wtimeout => $fractional_seconds
		225
164	If non-zero, then this enables an "inactivity" timeout: whenever this many	226	If non-zero, then these enables an "inactivity" timeout: whenever this
165	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
166	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
167	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>.
168		237
169	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
170	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
171	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
172	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
…		…
216	accomplishd by setting this option to a true value.	285	accomplishd by setting this option to a true value.
217		286
218	The default is your opertaing system's default behaviour (most likely	287	The default is your opertaing system's default behaviour (most likely
219	enabled), this option explicitly enables or disables it, if possible.	288	enabled), this option explicitly enables or disables it, if possible.
220		289
		290	=item keepalive => <boolean>
		291
		292	Enables (default disable) the SO_KEEPALIVE option on the stream socket:
		293	normally, TCP connections have no time-out once established, so TCP
		294	conenctions, once established, can stay alive forever even when the other
		295	side has long gone. TCP keepalives are a cheap way to take down long-lived
		296	TCP connections whent he other side becomes unreachable. While the default
		297	is OS-dependent, TCP keepalives usually kick in after around two hours,
		298	and, if the other side doesn't reply, take down the TCP connection some 10
		299	to 15 minutes later.
		300
		301	It is harmless to specify this option for file handles that do not support
		302	keepalives, and enabling it on connections that are potentially long-lived
		303	is usually a good idea.
		304
		305	=item oobinline => <boolean>
		306
		307	BSD majorly fucked up the implementation of TCP urgent data. The result
		308	is that almost no OS implements TCP according to the specs, and every OS
		309	implements it slightly differently.
		310
		311	If you want to handle TCP urgent data, then setting this flag gives you
		312	the most portable way of getting urgent data, by putting it into the
		313	stream.
		314
221	=item read_size => <bytes>	315	=item read_size => <bytes>
222		316
223	The default read block size (the amount of bytes this module will	317	The default read block size (the amount of bytes this module will
224	try to read during each loop iteration, which affects memory	318	try to read during each loop iteration, which affects memory
225	requirements). Default: C<8192>.	319	requirements). Default: C<8192>.
…		…
351		445
352	sub new {	446	sub new {
353	my $class = shift;	447	my $class = shift;
354	my $self = bless { @_ }, $class;	448	my $self = bless { @_ }, $class;
355		449
356	$self->{fh} or Carp::croak "mandatory argument fh is missing";	450	if ($self->{fh}) {
		451	$self->_start;
		452	return unless $self->{fh}; # could be gone by now
		453
		454	} elsif ($self->{connect}) {
		455	require AnyEvent::Socket;
		456
		457	$self->{peername} = $self->{connect}[0]
		458	unless exists $self->{peername};
		459
		460	$self->{_skip_drain_rbuf} = 1;
		461
		462	{
		463	Scalar::Util::weaken (my $self = $self);
		464
		465	$self->{_connect} =
		466	AnyEvent::Socket::tcp_connect (
		467	$self->{connect}[0],
		468	$self->{connect}[1],
		469	sub {
		470	my ($fh, $host, $port, $retry) = @_;
		471
		472	if ($fh) {
		473	$self->{fh} = $fh;
		474
		475	delete $self->{_skip_drain_rbuf};
		476	$self->_start;
		477
		478	$self->{on_connect}
		479	and $self->{on_connect}($self, $host, $port, sub {
		480	delete @$self{qw(fh _tw _rtw _wtw _ww _rw _eof _queue rbuf _wbuf tls _tls_rbuf _tls_wbuf)};
		481	$self->{_skip_drain_rbuf} = 1;
		482	&$retry;
		483	});
		484
		485	} else {
		486	if ($self->{on_connect_error}) {
		487	$self->{on_connect_error}($self, "$!");
		488	$self->destroy;
		489	} else {
		490	$self->_error ($!, 1);
		491	}
		492	}
		493	},
		494	sub {
		495	local $self->{fh} = $_[0];
		496
		497	$self->{on_prepare}
		498	? $self->{on_prepare}->($self)
		499	: ()
		500	}
		501	);
		502	}
		503
		504	} else {
		505	Carp::croak "AnyEvent::Handle: either an existing fh or the connect parameter must be specified";
		506	}
		507
		508	$self
		509	}
		510
		511	sub _start {
		512	my ($self) = @_;
357		513
358	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	514	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
359		515
		516	$self->{_activity} =
		517	$self->{_ractivity} =
360	$self->{_activity} = AnyEvent->now;	518	$self->{_wactivity} = AE::now;
361	$self->_timeout;
362		519
		520	$self->timeout (delete $self->{timeout} ) if $self->{timeout};
		521	$self->rtimeout (delete $self->{rtimeout} ) if $self->{rtimeout};
		522	$self->wtimeout (delete $self->{wtimeout} ) if $self->{wtimeout};
		523
363	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};	524	$self->no_delay (delete $self->{no_delay} ) if exists $self->{no_delay};
		525	$self->keepalive (delete $self->{keepalive}) if exists $self->{keepalive};
		526	$self->oobinline (delete $self->{oobinline}) if exists $self->{oobinline};
364		527
365	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})	528	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
366	if $self->{tls};	529	if $self->{tls};
367		530
368	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	531	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
369		532
370	$self->start_read	533	$self->start_read
371	if $self->{on_read};	534	if $self->{on_read} \|\| @{ $self->{_queue} };
372		535
373	$self->{fh} && $self	536	$self->_drain_wbuf;
374	}	537	}
375
376	#sub _shutdown {
377	# my ($self) = @_;
378	#
379	# delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)};
380	# $self->{_eof} = 1; # tell starttls et. al to stop trying
381	#
382	# &_freetls;
383	#}
384		538
385	sub _error {	539	sub _error {
386	my ($self, $errno, $fatal, $message) = @_;	540	my ($self, $errno, $fatal, $message) = @_;
387		541
388	$! = $errno;	542	$! = $errno;
389	$message \|\|= "$!";	543	$message \|\|= "$!";
390		544
391	if ($self->{on_error}) {	545	if ($self->{on_error}) {
392	$self->{on_error}($self, $fatal, $message);	546	$self->{on_error}($self, $fatal, $message);
393	$self->destroy;	547	$self->destroy if $fatal;
394	} elsif ($self->{fh}) {	548	} elsif ($self->{fh}) {
395	$self->destroy;	549	$self->destroy;
396	Carp::croak "AnyEvent::Handle uncaught error: $message";	550	Carp::croak "AnyEvent::Handle uncaught error: $message";
397	}	551	}
398	}	552	}
…		…
425	$_[0]{on_eof} = $_[1];	579	$_[0]{on_eof} = $_[1];
426	}	580	}
427		581
428	=item $handle->on_timeout ($cb)	582	=item $handle->on_timeout ($cb)
429		583
430	Replace the current C<on_timeout> callback, or disables the callback (but	584	=item $handle->on_rtimeout ($cb)
431	not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
432	argument and method.
433		585
434	=cut	586	=item $handle->on_wtimeout ($cb)
435		587
436	sub on_timeout {	588	Replace the current C<on_timeout>, C<on_rtimeout> or C<on_wtimeout>
437	$_[0]{on_timeout} = $_[1];	589	callback, or disables the callback (but not the timeout) if C<$cb> =
438	}	590	C<undef>. See the C<timeout> constructor argument and method.
		591
		592	=cut
		593
		594	# see below
439		595
440	=item $handle->autocork ($boolean)	596	=item $handle->autocork ($boolean)
441		597
442	Enables or disables the current autocork behaviour (see C<autocork>	598	Enables or disables the current autocork behaviour (see C<autocork>
443	constructor argument). Changes will only take effect on the next write.	599	constructor argument). Changes will only take effect on the next write.
…		…
458	sub no_delay {	614	sub no_delay {
459	$_[0]{no_delay} = $_[1];	615	$_[0]{no_delay} = $_[1];
460		616
461	eval {	617	eval {
462	local $SIG{__DIE__};	618	local $SIG{__DIE__};
463	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];	619	setsockopt $_[0]{fh}, Socket::IPPROTO_TCP (), Socket::TCP_NODELAY (), int $_[1]
		620	if $_[0]{fh};
		621	};
		622	}
		623
		624	=item $handle->keepalive ($boolean)
		625
		626	Enables or disables the C<keepalive> setting (see constructor argument of
		627	the same name for details).
		628
		629	=cut
		630
		631	sub keepalive {
		632	$_[0]{keepalive} = $_[1];
		633
		634	eval {
		635	local $SIG{__DIE__};
		636	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
		637	if $_[0]{fh};
		638	};
		639	}
		640
		641	=item $handle->oobinline ($boolean)
		642
		643	Enables or disables the C<oobinline> setting (see constructor argument of
		644	the same name for details).
		645
		646	=cut
		647
		648	sub oobinline {
		649	$_[0]{oobinline} = $_[1];
		650
		651	eval {
		652	local $SIG{__DIE__};
		653	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_OOBINLINE (), int $_[1]
		654	if $_[0]{fh};
		655	};
		656	}
		657
		658	=item $handle->keepalive ($boolean)
		659
		660	Enables or disables the C<keepalive> setting (see constructor argument of
		661	the same name for details).
		662
		663	=cut
		664
		665	sub keepalive {
		666	$_[0]{keepalive} = $_[1];
		667
		668	eval {
		669	local $SIG{__DIE__};
		670	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
		671	if $_[0]{fh};
464	};	672	};
465	}	673	}
466		674
467	=item $handle->on_starttls ($cb)	675	=item $handle->on_starttls ($cb)
468		676
…		…
482		690
483	sub on_starttls {	691	sub on_starttls {
484	$_[0]{on_stoptls} = $_[1];	692	$_[0]{on_stoptls} = $_[1];
485	}	693	}
486		694
		695	=item $handle->rbuf_max ($max_octets)
		696
		697	Configures the C<rbuf_max> setting (C<undef> disables it).
		698
		699	=cut
		700
		701	sub rbuf_max {
		702	$_[0]{rbuf_max} = $_[1];
		703	}
		704
487	#############################################################################	705	#############################################################################
488		706
489	=item $handle->timeout ($seconds)	707	=item $handle->timeout ($seconds)
490		708
		709	=item $handle->rtimeout ($seconds)
		710
		711	=item $handle->wtimeout ($seconds)
		712
491	Configures (or disables) the inactivity timeout.	713	Configures (or disables) the inactivity timeout.
492		714
493	=cut	715	=item $handle->timeout_reset
494		716
495	sub timeout {	717	=item $handle->rtimeout_reset
		718
		719	=item $handle->wtimeout_reset
		720
		721	Reset the activity timeout, as if data was received or sent.
		722
		723	These methods are cheap to call.
		724
		725	=cut
		726
		727	for my $dir ("", "r", "w") {
		728	my $timeout = "${dir}timeout";
		729	my $tw = "_${dir}tw";
		730	my $on_timeout = "on_${dir}timeout";
		731	my $activity = "_${dir}activity";
		732	my $cb;
		733
		734	*$on_timeout = sub {
		735	$_[0]{$on_timeout} = $_[1];
		736	};
		737
		738	*$timeout = sub {
496	my ($self, $timeout) = @_;	739	my ($self, $new_value) = @_;
497		740
498	$self->{timeout} = $timeout;	741	$self->{$timeout} = $new_value;
499	$self->_timeout;	742	delete $self->{$tw}; &$cb;
500	}	743	};
501		744
		745	*{"${dir}timeout_reset"} = sub {
		746	$_[0]{$activity} = AE::now;
		747	};
		748
		749	# main workhorse:
502	# reset the timeout watcher, as neccessary	750	# reset the timeout watcher, as neccessary
503	# also check for time-outs	751	# also check for time-outs
504	sub _timeout {	752	$cb = sub {
505	my ($self) = @_;	753	my ($self) = @_;
506		754
507	if ($self->{timeout}) {	755	if ($self->{$timeout} && $self->{fh}) {
508	my $NOW = AnyEvent->now;	756	my $NOW = AE::now;
509		757
510	# when would the timeout trigger?	758	# when would the timeout trigger?
511	my $after = $self->{_activity} + $self->{timeout} - $NOW;	759	my $after = $self->{$activity} + $self->{$timeout} - $NOW;
512		760
513	# now or in the past already?	761	# now or in the past already?
514	if ($after <= 0) {	762	if ($after <= 0) {
515	$self->{_activity} = $NOW;	763	$self->{$activity} = $NOW;
516		764
517	if ($self->{on_timeout}) {	765	if ($self->{$on_timeout}) {
518	$self->{on_timeout}($self);	766	$self->{$on_timeout}($self);
519	} else {	767	} else {
520	$self->_error (Errno::ETIMEDOUT);	768	$self->_error (Errno::ETIMEDOUT);
		769	}
		770
		771	# callback could have changed timeout value, optimise
		772	return unless $self->{$timeout};
		773
		774	# calculate new after
		775	$after = $self->{$timeout};
521	}	776	}
522		777
523	# callback could have changed timeout value, optimise	778	Scalar::Util::weaken $self;
524	return unless $self->{timeout};	779	return unless $self; # ->error could have destroyed $self
525		780
526	# calculate new after	781	$self->{$tw} \|\|= AE::timer $after, 0, sub {
527	$after = $self->{timeout};	782	delete $self->{$tw};
		783	$cb->($self);
		784	};
		785	} else {
		786	delete $self->{$tw};
528	}	787	}
529
530	Scalar::Util::weaken $self;
531	return unless $self; # ->error could have destroyed $self
532
533	$self->{_tw} \|\|= AnyEvent->timer (after => $after, cb => sub {
534	delete $self->{_tw};
535	$self->_timeout;
536	});
537	} else {
538	delete $self->{_tw};
539	}	788	}
540	}	789	}
541		790
542	#############################################################################	791	#############################################################################
543		792
…		…
591	my $len = syswrite $self->{fh}, $self->{wbuf};	840	my $len = syswrite $self->{fh}, $self->{wbuf};
592		841
593	if (defined $len) {	842	if (defined $len) {
594	substr $self->{wbuf}, 0, $len, "";	843	substr $self->{wbuf}, 0, $len, "";
595		844
596	$self->{_activity} = AnyEvent->now;	845	$self->{_activity} = $self->{_wactivity} = AE::now;
597		846
598	$self->{on_drain}($self)	847	$self->{on_drain}($self)
599	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})	848	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
600	&& $self->{on_drain};	849	&& $self->{on_drain};
601		850
…		…
607		856
608	# try to write data immediately	857	# try to write data immediately
609	$cb->() unless $self->{autocork};	858	$cb->() unless $self->{autocork};
610		859
611	# if still data left in wbuf, we need to poll	860	# if still data left in wbuf, we need to poll
612	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	861	$self->{_ww} = AE::io $self->{fh}, 1, $cb
613	if length $self->{wbuf};	862	if length $self->{wbuf};
614	};	863	};
615	}	864	}
616		865
617	our %WH;	866	our %WH;
…		…
630	->($self, @_);	879	->($self, @_);
631	}	880	}
632		881
633	if ($self->{tls}) {	882	if ($self->{tls}) {
634	$self->{_tls_wbuf} .= $_[0];	883	$self->{_tls_wbuf} .= $_[0];
635		884	&_dotls ($self) if $self->{fh};
636	&_dotls ($self);
637	} else {	885	} else {
638	$self->{wbuf} .= $_[0];	886	$self->{wbuf} .= $_[0];
639	$self->_drain_wbuf;	887	$self->_drain_wbuf if $self->{fh};
640	}	888	}
641	}	889	}
642		890
643	=item $handle->push_write (type => @args)	891	=item $handle->push_write (type => @args)
644		892
…		…
708	Other languages could read single lines terminated by a newline and pass	956	Other languages could read single lines terminated by a newline and pass
709	this line into their JSON decoder of choice.	957	this line into their JSON decoder of choice.
710		958
711	=cut	959	=cut
712		960
		961	sub json_coder() {
		962	eval { require JSON::XS; JSON::XS->new->utf8 }
		963	\|\| do { require JSON; JSON->new->utf8 }
		964	}
		965
713	register_write_type json => sub {	966	register_write_type json => sub {
714	my ($self, $ref) = @_;	967	my ($self, $ref) = @_;
715		968
716	require JSON;	969	my $json = $self->{json} \|\|= json_coder;
717		970
718	$self->{json} ? $self->{json}->encode ($ref)	971	$json->encode ($ref)
719	: JSON::encode_json ($ref)
720	};	972	};
721		973
722	=item storable => $reference	974	=item storable => $reference
723		975
724	Freezes the given reference using L<Storable> and writes it to the	976	Freezes the given reference using L<Storable> and writes it to the
…		…
861	=cut	1113	=cut
862		1114
863	sub _drain_rbuf {	1115	sub _drain_rbuf {
864	my ($self) = @_;	1116	my ($self) = @_;
865		1117
		1118	# avoid recursion
		1119	return if $self->{_skip_drain_rbuf};
866	local $self->{_in_drain} = 1;	1120	local $self->{_skip_drain_rbuf} = 1;
867
868	if (
869	defined $self->{rbuf_max}
870	&& $self->{rbuf_max} < length $self->{rbuf}
871	) {
872	$self->_error (Errno::ENOSPC, 1), return;
873	}
874		1121
875	while () {	1122	while () {
876	# we need to use a separate tls read buffer, as we must not receive data while	1123	# we need to use a separate tls read buffer, as we must not receive data while
877	# we are draining the buffer, and this can only happen with TLS.	1124	# we are draining the buffer, and this can only happen with TLS.
878	$self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf};	1125	$self->{rbuf} .= delete $self->{_tls_rbuf}
		1126	if exists $self->{_tls_rbuf};
879		1127
880	my $len = length $self->{rbuf};	1128	my $len = length $self->{rbuf};
881		1129
882	if (my $cb = shift @{ $self->{_queue} }) {	1130	if (my $cb = shift @{ $self->{_queue} }) {
883	unless ($cb->($self)) {	1131	unless ($cb->($self)) {
884	if ($self->{_eof}) {	1132	# no progress can be made
885	# no progress can be made (not enough data and no data forthcoming)	1133	# (not enough data and no data forthcoming)
886	$self->_error (Errno::EPIPE, 1), return;	1134	$self->_error (Errno::EPIPE, 1), return
887	}	1135	if $self->{_eof};
888		1136
889	unshift @{ $self->{_queue} }, $cb;	1137	unshift @{ $self->{_queue} }, $cb;
890	last;	1138	last;
891	}	1139	}
892	} elsif ($self->{on_read}) {	1140	} elsif ($self->{on_read}) {
…		…
912	last;	1160	last;
913	}	1161	}
914	}	1162	}
915		1163
916	if ($self->{_eof}) {	1164	if ($self->{_eof}) {
917	if ($self->{on_eof}) {	1165	$self->{on_eof}
918	$self->{on_eof}($self)	1166	? $self->{on_eof}($self)
919	} else {
920	$self->_error (0, 1, "Unexpected end-of-file");	1167	: $self->_error (0, 1, "Unexpected end-of-file");
921	}	1168
		1169	return;
		1170	}
		1171
		1172	if (
		1173	defined $self->{rbuf_max}
		1174	&& $self->{rbuf_max} < length $self->{rbuf}
		1175	) {
		1176	$self->_error (Errno::ENOSPC, 1), return;
922	}	1177	}
923		1178
924	# may need to restart read watcher	1179	# may need to restart read watcher
925	unless ($self->{_rw}) {	1180	unless ($self->{_rw}) {
926	$self->start_read	1181	$self->start_read
…		…
938		1193
939	sub on_read {	1194	sub on_read {
940	my ($self, $cb) = @_;	1195	my ($self, $cb) = @_;
941		1196
942	$self->{on_read} = $cb;	1197	$self->{on_read} = $cb;
943	$self->_drain_rbuf if $cb && !$self->{_in_drain};	1198	$self->_drain_rbuf if $cb;
944	}	1199	}
945		1200
946	=item $handle->rbuf	1201	=item $handle->rbuf
947		1202
948	Returns the read buffer (as a modifiable lvalue).	1203	Returns the read buffer (as a modifiable lvalue).
…		…
1000	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	1255	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
1001	->($self, $cb, @_);	1256	->($self, $cb, @_);
1002	}	1257	}
1003		1258
1004	push @{ $self->{_queue} }, $cb;	1259	push @{ $self->{_queue} }, $cb;
1005	$self->_drain_rbuf unless $self->{_in_drain};	1260	$self->_drain_rbuf;
1006	}	1261	}
1007		1262
1008	sub unshift_read {	1263	sub unshift_read {
1009	my $self = shift;	1264	my $self = shift;
1010	my $cb = pop;	1265	my $cb = pop;
…		…
1014		1269
1015	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")	1270	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")
1016	->($self, $cb, @_);	1271	->($self, $cb, @_);
1017	}	1272	}
1018		1273
1019
1020	unshift @{ $self->{_queue} }, $cb;	1274	unshift @{ $self->{_queue} }, $cb;
1021	$self->_drain_rbuf unless $self->{_in_drain};	1275	$self->_drain_rbuf;
1022	}	1276	}
1023		1277
1024	=item $handle->push_read (type => @args, $cb)	1278	=item $handle->push_read (type => @args, $cb)
1025		1279
1026	=item $handle->unshift_read (type => @args, $cb)	1280	=item $handle->unshift_read (type => @args, $cb)
…		…
1275	=cut	1529	=cut
1276		1530
1277	register_read_type json => sub {	1531	register_read_type json => sub {
1278	my ($self, $cb) = @_;	1532	my ($self, $cb) = @_;
1279		1533
1280	my $json = $self->{json} \|\|=	1534	my $json = $self->{json} \|\|= json_coder;
1281	eval { require JSON::XS; JSON::XS->new->utf8 }
1282	\|\| do { require JSON; JSON->new->utf8 };
1283		1535
1284	my $data;	1536	my $data;
1285	my $rbuf = \$self->{rbuf};	1537	my $rbuf = \$self->{rbuf};
1286		1538
1287	sub {	1539	sub {
…		…
1407	my ($self) = @_;	1659	my ($self) = @_;
1408		1660
1409	unless ($self->{_rw} \|\| $self->{_eof}) {	1661	unless ($self->{_rw} \|\| $self->{_eof}) {
1410	Scalar::Util::weaken $self;	1662	Scalar::Util::weaken $self;
1411		1663
1412	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1664	$self->{_rw} = AE::io $self->{fh}, 0, sub {
1413	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});	1665	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1414	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;	1666	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;
1415		1667
1416	if ($len > 0) {	1668	if ($len > 0) {
1417	$self->{_activity} = AnyEvent->now;	1669	$self->{_activity} = $self->{_ractivity} = AE::now;
1418		1670
1419	if ($self->{tls}) {	1671	if ($self->{tls}) {
1420	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);	1672	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1421		1673
1422	&_dotls ($self);	1674	&_dotls ($self);
1423	} else {	1675	} else {
1424	$self->_drain_rbuf unless $self->{_in_drain};	1676	$self->_drain_rbuf;
1425	}	1677	}
1426		1678
1427	} elsif (defined $len) {	1679	} elsif (defined $len) {
1428	delete $self->{_rw};	1680	delete $self->{_rw};
1429	$self->{_eof} = 1;	1681	$self->{_eof} = 1;
1430	$self->_drain_rbuf unless $self->{_in_drain};	1682	$self->_drain_rbuf;
1431		1683
1432	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1684	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1433	return $self->_error ($!, 1);	1685	return $self->_error ($!, 1);
1434	}	1686	}
1435	});	1687	};
1436	}	1688	}
1437	}	1689	}
1438		1690
1439	our $ERROR_SYSCALL;	1691	our $ERROR_SYSCALL;
1440	our $ERROR_WANT_READ;	1692	our $ERROR_WANT_READ;
…		…
1495	$self->{_eof} = 1;	1747	$self->{_eof} = 1;
1496	}	1748	}
1497	}	1749	}
1498		1750
1499	$self->{_tls_rbuf} .= $tmp;	1751	$self->{_tls_rbuf} .= $tmp;
1500	$self->_drain_rbuf unless $self->{_in_drain};	1752	$self->_drain_rbuf;
1501	$self->{tls} or return; # tls session might have gone away in callback	1753	$self->{tls} or return; # tls session might have gone away in callback
1502	}	1754	}
1503		1755
1504	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);	1756	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1505	return $self->_tls_error ($tmp)	1757	return $self->_tls_error ($tmp)
…		…
1520		1772
1521	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	1773	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
1522	object is created, you can also do that at a later time by calling	1774	object is created, you can also do that at a later time by calling
1523	C<starttls>.	1775	C<starttls>.
1524		1776
		1777	Starting TLS is currently an asynchronous operation - when you push some
		1778	write data and then call C<< ->starttls >> then TLS negotiation will start
		1779	immediately, after which the queued write data is then sent.
		1780
1525	The first argument is the same as the C<tls> constructor argument (either	1781	The first argument is the same as the C<tls> constructor argument (either
1526	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1782	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1527		1783
1528	The second argument is the optional C<AnyEvent::TLS> object that is used	1784	The second argument is the optional C<AnyEvent::TLS> object that is used
1529	when AnyEvent::Handle has to create its own TLS connection object, or	1785	when AnyEvent::Handle has to create its own TLS connection object, or
…		…
1533	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS	1789	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS
1534	context in C<< $handle->{tls_ctx} >> after this call and can be used or	1790	context in C<< $handle->{tls_ctx} >> after this call and can be used or
1535	changed to your liking. Note that the handshake might have already started	1791	changed to your liking. Note that the handshake might have already started
1536	when this function returns.	1792	when this function returns.
1537		1793
1538	If it an error to start a TLS handshake more than once per	1794	Due to bugs in OpenSSL, it might or might not be possible to do multiple
1539	AnyEvent::Handle object (this is due to bugs in OpenSSL).	1795	handshakes on the same stream. Best do not attempt to use the stream after
		1796	stopping TLS.
1540		1797
1541	=cut	1798	=cut
1542		1799
1543	our %TLS_CACHE; #TODO not yet documented, should we?	1800	our %TLS_CACHE; #TODO not yet documented, should we?
1544		1801
1545	sub starttls {	1802	sub starttls {
1546	my ($self, $ssl, $ctx) = @_;	1803	my ($self, $tls, $ctx) = @_;
		1804
		1805	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"
		1806	if $self->{tls};
		1807
		1808	$self->{tls} = $tls;
		1809	$self->{tls_ctx} = $ctx if @_ > 2;
		1810
		1811	return unless $self->{fh};
1547		1812
1548	require Net::SSLeay;	1813	require Net::SSLeay;
1549
1550	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"
1551	if $self->{tls};
1552		1814
1553	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();	1815	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1554	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();	1816	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1555		1817
		1818	$tls = delete $self->{tls};
1556	$ctx \|\|= $self->{tls_ctx};	1819	$ctx = $self->{tls_ctx};
		1820
		1821	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
1557		1822
1558	if ("HASH" eq ref $ctx) {	1823	if ("HASH" eq ref $ctx) {
1559	require AnyEvent::TLS;	1824	require AnyEvent::TLS;
1560
1561	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context
1562		1825
1563	if ($ctx->{cache}) {	1826	if ($ctx->{cache}) {
1564	my $key = $ctx+0;	1827	my $key = $ctx+0;
1565	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;	1828	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;
1566	} else {	1829	} else {
1567	$ctx = new AnyEvent::TLS %$ctx;	1830	$ctx = new AnyEvent::TLS %$ctx;
1568	}	1831	}
1569	}	1832	}
1570		1833
1571	$self->{tls_ctx} = $ctx \|\| TLS_CTX ();	1834	$self->{tls_ctx} = $ctx \|\| TLS_CTX ();
1572	$self->{tls} = $ssl = $self->{tls_ctx}->_get_session ($ssl, $self, $self->{peername});	1835	$self->{tls} = $tls = $self->{tls_ctx}->_get_session ($tls, $self, $self->{peername});
1573		1836
1574	# basically, this is deep magic (because SSL_read should have the same issues)	1837	# basically, this is deep magic (because SSL_read should have the same issues)
1575	# but the openssl maintainers basically said: "trust us, it just works".	1838	# but the openssl maintainers basically said: "trust us, it just works".
1576	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1839	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1577	# and mismaintained ssleay-module doesn't even offer them).	1840	# and mismaintained ssleay-module doesn't even offer them).
…		…
1584	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to	1847	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
1585	# have identity issues in that area.	1848	# have identity issues in that area.
1586	# Net::SSLeay::CTX_set_mode ($ssl,	1849	# Net::SSLeay::CTX_set_mode ($ssl,
1587	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1850	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
1588	# \| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));	1851	# \| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
1589	Net::SSLeay::CTX_set_mode ($ssl, 1\|2);	1852	Net::SSLeay::CTX_set_mode ($tls, 1\|2);
1590		1853
1591	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1854	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1592	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1855	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1593		1856
		1857	Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf});
		1858
1594	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1859	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
1595		1860
1596	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }	1861	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1597	if $self->{on_starttls};	1862	if $self->{on_starttls};
1598		1863
1599	&_dotls; # need to trigger the initial handshake	1864	&_dotls; # need to trigger the initial handshake
…		…
1602		1867
1603	=item $handle->stoptls	1868	=item $handle->stoptls
1604		1869
1605	Shuts down the SSL connection - this makes a proper EOF handshake by	1870	Shuts down the SSL connection - this makes a proper EOF handshake by
1606	sending a close notify to the other side, but since OpenSSL doesn't	1871	sending a close notify to the other side, but since OpenSSL doesn't
1607	support non-blocking shut downs, it is not possible to re-use the stream	1872	support non-blocking shut downs, it is not guarenteed that you can re-use
1608	afterwards.	1873	the stream afterwards.
1609		1874
1610	=cut	1875	=cut
1611		1876
1612	sub stoptls {	1877	sub stoptls {
1613	my ($self) = @_;	1878	my ($self) = @_;
…		…
1626	sub _freetls {	1891	sub _freetls {
1627	my ($self) = @_;	1892	my ($self) = @_;
1628		1893
1629	return unless $self->{tls};	1894	return unless $self->{tls};
1630		1895
1631	$self->{tls_ctx}->_put_session (delete $self->{tls});	1896	$self->{tls_ctx}->_put_session (delete $self->{tls})
		1897	if $self->{tls} > 0;
1632		1898
1633	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};	1899	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1634	}	1900	}
1635		1901
1636	sub DESTROY {	1902	sub DESTROY {
…		…
1638		1904
1639	&_freetls;	1905	&_freetls;
1640		1906
1641	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	1907	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1642		1908
1643	if ($linger && length $self->{wbuf}) {	1909	if ($linger && length $self->{wbuf} && $self->{fh}) {
1644	my $fh = delete $self->{fh};	1910	my $fh = delete $self->{fh};
1645	my $wbuf = delete $self->{wbuf};	1911	my $wbuf = delete $self->{wbuf};
1646		1912
1647	my @linger;	1913	my @linger;
1648		1914
1649	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {	1915	push @linger, AE::io $fh, 1, sub {
1650	my $len = syswrite $fh, $wbuf, length $wbuf;	1916	my $len = syswrite $fh, $wbuf, length $wbuf;
1651		1917
1652	if ($len > 0) {	1918	if ($len > 0) {
1653	substr $wbuf, 0, $len, "";	1919	substr $wbuf, 0, $len, "";
1654	} else {	1920	} else {
1655	@linger = (); # end	1921	@linger = (); # end
1656	}	1922	}
1657	});	1923	};
1658	push @linger, AnyEvent->timer (after => $linger, cb => sub {	1924	push @linger, AE::timer $linger, 0, sub {
1659	@linger = ();	1925	@linger = ();
1660	});	1926	};
1661	}	1927	}
1662	}	1928	}
1663		1929
1664	=item $handle->destroy	1930	=item $handle->destroy
1665		1931
1666	Shuts down the handle object as much as possible - this call ensures that	1932	Shuts down the handle object as much as possible - this call ensures that
1667	no further callbacks will be invoked and as many resources as possible	1933	no further callbacks will be invoked and as many resources as possible
1668	will be freed. You must not call any methods on the object afterwards.	1934	will be freed. Any method you will call on the handle object after
		1935	destroying it in this way will be silently ignored (and it will return the
		1936	empty list).
1669		1937
1670	Normally, you can just "forget" any references to an AnyEvent::Handle	1938	Normally, you can just "forget" any references to an AnyEvent::Handle
1671	object and it will simply shut down. This works in fatal error and EOF	1939	object and it will simply shut down. This works in fatal error and EOF
1672	callbacks, as well as code outside. It does I<NOT> work in a read or write	1940	callbacks, as well as code outside. It does I<NOT> work in a read or write
1673	callback, so when you want to destroy the AnyEvent::Handle object from	1941	callback, so when you want to destroy the AnyEvent::Handle object from
…		…
1687	sub destroy {	1955	sub destroy {
1688	my ($self) = @_;	1956	my ($self) = @_;
1689		1957
1690	$self->DESTROY;	1958	$self->DESTROY;
1691	%$self = ();	1959	%$self = ();
		1960	bless $self, "AnyEvent::Handle::destroyed";
		1961	}
		1962
		1963	sub AnyEvent::Handle::destroyed::AUTOLOAD {
		1964	#nop
1692	}	1965	}
1693		1966
1694	=item AnyEvent::Handle::TLS_CTX	1967	=item AnyEvent::Handle::TLS_CTX
1695		1968
1696	This function creates and returns the AnyEvent::TLS object used by default	1969	This function creates and returns the AnyEvent::TLS object used by default

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.150 by root, Thu Jul 16 04:16:25 2009 UTC vs. Revision 1.182 by root, Thu Sep 3 12:35:01 2009 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.150 by root, Thu Jul 16 04:16:25 2009 UTC vs.
Revision 1.182 by root, Thu Sep 3 12:35:01 2009 UTC