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

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

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.151 by root, Thu Jul 16 04:20:23 2009 UTC vs.
Revision 1.183 by root, Thu Sep 3 12:45:35 2009 UTC