[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.192 by root, Fri Mar 12 23:22:14 2010 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;
30	on_error => sub {	14	on_error => sub {
31	my ($hdl, $fatal, $msg) = @_;	15	my ($hdl, $fatal, $msg) = @_;
32	warn "got error $msg\n";	16	warn "got error $msg\n";
33	$hdl->destroy;	17	$hdl->destroy;
34	$cv->send;	18	$cv->send;
35	);	19	};
36		20
37	# send some request line	21	# send some request line
38	$hdl->push_write ("getinfo\015\012");	22	$hdl->push_write ("getinfo\015\012");
39		23
40	# read the response line	24	# read the response line
…		…
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	sub _load_func($) {
		66	my $func = $_[0];
		67
		68	unless (defined &$func) {
		69	my $pkg = $func;
		70	do {
		71	$pkg =~ s/::[^:]+$//
		72	or return;
		73	eval "require $pkg";
		74	} until defined &$func;
		75	}
		76
		77	\&$func
		78	}
		79
65	=head1 METHODS	80	=head1 METHODS
66		81
67	=over 4	82	=over 4
68		83
69	=item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value...	84	=item $handle = B<new> AnyEvent::Handle fh => $filehandle, key => value...
70		85
71	The constructor supports these arguments (all as C<< key => value >> pairs).	86	The constructor supports these arguments (all as C<< key => value >> pairs).
72		87
73	=over 4	88	=over 4
74		89
75	=item fh => $filehandle [MANDATORY]	90	=item fh => $filehandle [C<fh> or C<connect> MANDATORY]
76		91
77	The filehandle this L<AnyEvent::Handle> object will operate on.	92	The filehandle this L<AnyEvent::Handle> object will operate on.
78
79	NOTE: The filehandle will be set to non-blocking mode (using	93	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	94	C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in
81	that mode.	95	that mode.
		96
		97	=item connect => [$host, $service] [C<fh> or C<connect> MANDATORY]
		98
		99	Try to connect to the specified host and service (port), using
		100	C<AnyEvent::Socket::tcp_connect>. The C<$host> additionally becomes the
		101	default C<peername>.
		102
		103	You have to specify either this parameter, or C<fh>, above.
		104
		105	It is possible to push requests on the read and write queues, and modify
		106	properties of the stream, even while AnyEvent::Handle is connecting.
		107
		108	When this parameter is specified, then the C<on_prepare>,
		109	C<on_connect_error> and C<on_connect> callbacks will be called under the
		110	appropriate circumstances:
		111
		112	=over 4
		113
		114	=item on_prepare => $cb->($handle)
		115
		116	This (rarely used) callback is called before a new connection is
		117	attempted, but after the file handle has been created. It could be used to
		118	prepare the file handle with parameters required for the actual connect
		119	(as opposed to settings that can be changed when the connection is already
		120	established).
		121
		122	The return value of this callback should be the connect timeout value in
		123	seconds (or C<0>, or C<undef>, or the empty list, to indicate the default
		124	timeout is to be used).
		125
		126	=item on_connect => $cb->($handle, $host, $port, $retry->())
		127
		128	This callback is called when a connection has been successfully established.
		129
		130	The actual numeric host and port (the socket peername) are passed as
		131	parameters, together with a retry callback.
		132
		133	When, for some reason, the handle is not acceptable, then calling
		134	C<$retry> will continue with the next connection target (in case of
		135	multi-homed hosts or SRV records there can be multiple connection
		136	endpoints). At the time it is called the read and write queues, eof
		137	status, tls status and similar properties of the handle will have been
		138	reset.
		139
		140	In most cases, ignoring the C<$retry> parameter is the way to go.
		141
		142	=item on_connect_error => $cb->($handle, $message)
		143
		144	This callback is called when the connection could not be
		145	established. C<$!> will contain the relevant error code, and C<$message> a
		146	message describing it (usually the same as C<"$!">).
		147
		148	If this callback isn't specified, then C<on_error> will be called with a
		149	fatal error instead.
		150
		151	=back
		152
		153	=item on_error => $cb->($handle, $fatal, $message)
		154
		155	This is the error callback, which is called when, well, some error
		156	occured, such as not being able to resolve the hostname, failure to
		157	connect or a read error.
		158
		159	Some errors are fatal (which is indicated by C<$fatal> being true). On
		160	fatal errors the handle object will be destroyed (by a call to C<< ->
		161	destroy >>) after invoking the error callback (which means you are free to
		162	examine the handle object). Examples of fatal errors are an EOF condition
		163	with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors. In
		164	cases where the other side can close the connection at their will it is
		165	often easiest to not report C<EPIPE> errors in this callback.
		166
		167	AnyEvent::Handle tries to find an appropriate error code for you to check
		168	against, but in some cases (TLS errors), this does not work well. It is
		169	recommended to always output the C<$message> argument in human-readable
		170	error messages (it's usually the same as C<"$!">).
		171
		172	Non-fatal errors can be retried by simply returning, but it is recommended
		173	to simply ignore this parameter and instead abondon the handle object
		174	when this callback is invoked. Examples of non-fatal errors are timeouts
		175	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
		176
		177	On callback entrance, the value of C<$!> contains the operating system
		178	error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
		179	C<EPROTO>).
		180
		181	While not mandatory, it is I<highly> recommended to set this callback, as
		182	you will not be notified of errors otherwise. The default simply calls
		183	C<croak>.
		184
		185	=item on_read => $cb->($handle)
		186
		187	This sets the default read callback, which is called when data arrives
		188	and no read request is in the queue (unlike read queue callbacks, this
		189	callback will only be called when at least one octet of data is in the
		190	read buffer).
		191
		192	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
		193	method or access the C<< $handle->{rbuf} >> member directly. Note that you
		194	must not enlarge or modify the read buffer, you can only remove data at
		195	the beginning from it.
		196
		197	When an EOF condition is detected then AnyEvent::Handle will first try to
		198	feed all the remaining data to the queued callbacks and C<on_read> before
		199	calling the C<on_eof> callback. If no progress can be made, then a fatal
		200	error will be raised (with C<$!> set to C<EPIPE>).
		201
		202	Note that, unlike requests in the read queue, an C<on_read> callback
		203	doesn't mean you I<require> some data: if there is an EOF and there
		204	are outstanding read requests then an error will be flagged. With an
		205	C<on_read> callback, the C<on_eof> callback will be invoked.
82		206
83	=item on_eof => $cb->($handle)	207	=item on_eof => $cb->($handle)
84		208
85	Set the callback to be called when an end-of-file condition is detected,	209	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	210	i.e. in the case of a socket, when the other side has closed the
…		…
94	down.	218	down.
95		219
96	If an EOF condition has been detected but no C<on_eof> callback has been	220	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>.	221	set, then a fatal error will be raised with C<$!> set to <0>.
98		222
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)	223	=item on_drain => $cb->($handle)
152		224
153	This sets the callback that is called when the write buffer becomes empty	225	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).	226	(or when the callback is set and the buffer is empty already).
155		227
…		…
161	memory and push it into the queue, but instead only read more data from	233	memory and push it into the queue, but instead only read more data from
162	the file when the write queue becomes empty.	234	the file when the write queue becomes empty.
163		235
164	=item timeout => $fractional_seconds	236	=item timeout => $fractional_seconds
165		237
		238	=item rtimeout => $fractional_seconds
		239
		240	=item wtimeout => $fractional_seconds
		241
166	If non-zero, then this enables an "inactivity" timeout: whenever this many	242	If non-zero, then these enables an "inactivity" timeout: whenever this
167	seconds pass without a successful read or write on the underlying file	243	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	244	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).	245	will be invoked (and if that one is missing, a non-fatal C<ETIMEDOUT>
		246	error will be raised).
		247
		248	There are three variants of the timeouts that work fully independent
		249	of each other, for both read and write, just read, and just write:
		250	C<timeout>, C<rtimeout> and C<wtimeout>, with corresponding callbacks
		251	C<on_timeout>, C<on_rtimeout> and C<on_wtimeout>, and reset functions
		252	C<timeout_reset>, C<rtimeout_reset>, and C<wtimeout_reset>.
170		253
171	Note that timeout processing is also active when you currently do not have	254	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	255	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	256	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	257	in the C<on_timeout> callback, in which case AnyEvent::Handle will simply
…		…
218	accomplishd by setting this option to a true value.	301	accomplishd by setting this option to a true value.
219		302
220	The default is your opertaing system's default behaviour (most likely	303	The default is your opertaing system's default behaviour (most likely
221	enabled), this option explicitly enables or disables it, if possible.	304	enabled), this option explicitly enables or disables it, if possible.
222		305
		306	=item keepalive => <boolean>
		307
		308	Enables (default disable) the SO_KEEPALIVE option on the stream socket:
		309	normally, TCP connections have no time-out once established, so TCP
		310	connections, once established, can stay alive forever even when the other
		311	side has long gone. TCP keepalives are a cheap way to take down long-lived
		312	TCP connections whent he other side becomes unreachable. While the default
		313	is OS-dependent, TCP keepalives usually kick in after around two hours,
		314	and, if the other side doesn't reply, take down the TCP connection some 10
		315	to 15 minutes later.
		316
		317	It is harmless to specify this option for file handles that do not support
		318	keepalives, and enabling it on connections that are potentially long-lived
		319	is usually a good idea.
		320
		321	=item oobinline => <boolean>
		322
		323	BSD majorly fucked up the implementation of TCP urgent data. The result
		324	is that almost no OS implements TCP according to the specs, and every OS
		325	implements it slightly differently.
		326
		327	If you want to handle TCP urgent data, then setting this flag (the default
		328	is enabled) gives you the most portable way of getting urgent data, by
		329	putting it into the stream.
		330
		331	Since BSD emulation of OOB data on top of TCP's urgent data can have
		332	security implications, AnyEvent::Handle sets this flag automatically
		333	unless explicitly specified. Note that setting this flag after
		334	establishing a connection I<may> be a bit too late (data loss could
		335	already have occured on BSD systems), but at least it will protect you
		336	from most attacks.
		337
223	=item read_size => <bytes>	338	=item read_size => <bytes>
224		339
225	The default read block size (the amount of bytes this module will	340	The default read block size (the amount of bytes this module will
226	try to read during each loop iteration, which affects memory	341	try to read during each loop iteration, which affects memory
227	requirements). Default: C<8192>.	342	requirements). Default: C<8192>.
…		…
260	C<undef>.	375	C<undef>.
261		376
262	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	377	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
263		378
264	When this parameter is given, it enables TLS (SSL) mode, that means	379	When this parameter is given, it enables TLS (SSL) mode, that means
265	AnyEvent will start a TLS handshake as soon as the conenction has been	380	AnyEvent will start a TLS handshake as soon as the connection has been
266	established and will transparently encrypt/decrypt data afterwards.	381	established and will transparently encrypt/decrypt data afterwards.
267		382
268	All TLS protocol errors will be signalled as C<EPROTO>, with an	383	All TLS protocol errors will be signalled as C<EPROTO>, with an
269	appropriate error message.	384	appropriate error message.
270		385
…		…
353		468
354	sub new {	469	sub new {
355	my $class = shift;	470	my $class = shift;
356	my $self = bless { @_ }, $class;	471	my $self = bless { @_ }, $class;
357		472
358	$self->{fh} or Carp::croak "mandatory argument fh is missing";	473	if ($self->{fh}) {
		474	$self->_start;
		475	return unless $self->{fh}; # could be gone by now
		476
		477	} elsif ($self->{connect}) {
		478	require AnyEvent::Socket;
		479
		480	$self->{peername} = $self->{connect}[0]
		481	unless exists $self->{peername};
		482
		483	$self->{_skip_drain_rbuf} = 1;
		484
		485	{
		486	Scalar::Util::weaken (my $self = $self);
		487
		488	$self->{_connect} =
		489	AnyEvent::Socket::tcp_connect (
		490	$self->{connect}[0],
		491	$self->{connect}[1],
		492	sub {
		493	my ($fh, $host, $port, $retry) = @_;
		494
		495	if ($fh) {
		496	$self->{fh} = $fh;
		497
		498	delete $self->{_skip_drain_rbuf};
		499	$self->_start;
		500
		501	$self->{on_connect}
		502	and $self->{on_connect}($self, $host, $port, sub {
		503	delete @$self{qw(fh _tw _rtw _wtw _ww _rw _eof _queue rbuf _wbuf tls _tls_rbuf _tls_wbuf)};
		504	$self->{_skip_drain_rbuf} = 1;
		505	&$retry;
		506	});
		507
		508	} else {
		509	if ($self->{on_connect_error}) {
		510	$self->{on_connect_error}($self, "$!");
		511	$self->destroy;
		512	} else {
		513	$self->_error ($!, 1);
		514	}
		515	}
		516	},
		517	sub {
		518	local $self->{fh} = $_[0];
		519
		520	$self->{on_prepare}
		521	? $self->{on_prepare}->($self)
		522	: ()
		523	}
		524	);
		525	}
		526
		527	} else {
		528	Carp::croak "AnyEvent::Handle: either an existing fh or the connect parameter must be specified";
		529	}
		530
		531	$self
		532	}
		533
		534	sub _start {
		535	my ($self) = @_;
359		536
360	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	537	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
361		538
		539	$self->{_activity} =
		540	$self->{_ractivity} =
362	$self->{_activity} = AnyEvent->now;	541	$self->{_wactivity} = AE::now;
363	$self->_timeout;
364		542
		543	$self->timeout (delete $self->{timeout} ) if $self->{timeout};
		544	$self->rtimeout (delete $self->{rtimeout} ) if $self->{rtimeout};
		545	$self->wtimeout (delete $self->{wtimeout} ) if $self->{wtimeout};
		546
365	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};	547	$self->no_delay (delete $self->{no_delay} ) if exists $self->{no_delay} && $self->{no_delay};
		548	$self->keepalive (delete $self->{keepalive}) if exists $self->{keepalive} && $self->{keepalive};
366		549
		550	$self->oobinline (exists $self->{oobinline} ? delete $self->{oobinline} : 1);
		551
367	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})	552	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
368	if $self->{tls};	553	if $self->{tls};
369		554
370	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	555	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
371		556
372	$self->start_read	557	$self->start_read
373	if $self->{on_read};	558	if $self->{on_read} \|\| @{ $self->{_queue} };
374		559
375	$self->{fh} && $self	560	$self->_drain_wbuf;
376	}	561	}
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		562
387	sub _error {	563	sub _error {
388	my ($self, $errno, $fatal, $message) = @_;	564	my ($self, $errno, $fatal, $message) = @_;
389		565
390	$! = $errno;	566	$! = $errno;
391	$message \|\|= "$!";	567	$message \|\|= "$!";
392		568
393	if ($self->{on_error}) {	569	if ($self->{on_error}) {
394	$self->{on_error}($self, $fatal, $message);	570	$self->{on_error}($self, $fatal, $message);
395	$self->destroy if $fatal;	571	$self->destroy if $fatal;
396	} elsif ($self->{fh}) {	572	} elsif ($self->{fh} \|\| $self->{connect}) {
397	$self->destroy;	573	$self->destroy;
398	Carp::croak "AnyEvent::Handle uncaught error: $message";	574	Carp::croak "AnyEvent::Handle uncaught error: $message";
399	}	575	}
400	}	576	}
401		577
…		…
427	$_[0]{on_eof} = $_[1];	603	$_[0]{on_eof} = $_[1];
428	}	604	}
429		605
430	=item $handle->on_timeout ($cb)	606	=item $handle->on_timeout ($cb)
431		607
432	Replace the current C<on_timeout> callback, or disables the callback (but	608	=item $handle->on_rtimeout ($cb)
433	not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
434	argument and method.
435		609
436	=cut	610	=item $handle->on_wtimeout ($cb)
437		611
438	sub on_timeout {	612	Replace the current C<on_timeout>, C<on_rtimeout> or C<on_wtimeout>
439	$_[0]{on_timeout} = $_[1];	613	callback, or disables the callback (but not the timeout) if C<$cb> =
440	}	614	C<undef>. See the C<timeout> constructor argument and method.
		615
		616	=cut
		617
		618	# see below
441		619
442	=item $handle->autocork ($boolean)	620	=item $handle->autocork ($boolean)
443		621
444	Enables or disables the current autocork behaviour (see C<autocork>	622	Enables or disables the current autocork behaviour (see C<autocork>
445	constructor argument). Changes will only take effect on the next write.	623	constructor argument). Changes will only take effect on the next write.
…		…
460	sub no_delay {	638	sub no_delay {
461	$_[0]{no_delay} = $_[1];	639	$_[0]{no_delay} = $_[1];
462		640
463	eval {	641	eval {
464	local $SIG{__DIE__};	642	local $SIG{__DIE__};
465	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];	643	setsockopt $_[0]{fh}, Socket::IPPROTO_TCP (), Socket::TCP_NODELAY (), int $_[1]
		644	if $_[0]{fh};
		645	};
		646	}
		647
		648	=item $handle->keepalive ($boolean)
		649
		650	Enables or disables the C<keepalive> setting (see constructor argument of
		651	the same name for details).
		652
		653	=cut
		654
		655	sub keepalive {
		656	$_[0]{keepalive} = $_[1];
		657
		658	eval {
		659	local $SIG{__DIE__};
		660	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
		661	if $_[0]{fh};
		662	};
		663	}
		664
		665	=item $handle->oobinline ($boolean)
		666
		667	Enables or disables the C<oobinline> setting (see constructor argument of
		668	the same name for details).
		669
		670	=cut
		671
		672	sub oobinline {
		673	$_[0]{oobinline} = $_[1];
		674
		675	eval {
		676	local $SIG{__DIE__};
		677	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_OOBINLINE (), int $_[1]
		678	if $_[0]{fh};
		679	};
		680	}
		681
		682	=item $handle->keepalive ($boolean)
		683
		684	Enables or disables the C<keepalive> setting (see constructor argument of
		685	the same name for details).
		686
		687	=cut
		688
		689	sub keepalive {
		690	$_[0]{keepalive} = $_[1];
		691
		692	eval {
		693	local $SIG{__DIE__};
		694	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
		695	if $_[0]{fh};
466	};	696	};
467	}	697	}
468		698
469	=item $handle->on_starttls ($cb)	699	=item $handle->on_starttls ($cb)
470		700
…		…
480		710
481	Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).	711	Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).
482		712
483	=cut	713	=cut
484		714
485	sub on_starttls {	715	sub on_stoptls {
486	$_[0]{on_stoptls} = $_[1];	716	$_[0]{on_stoptls} = $_[1];
487	}	717	}
488		718
		719	=item $handle->rbuf_max ($max_octets)
		720
		721	Configures the C<rbuf_max> setting (C<undef> disables it).
		722
		723	=cut
		724
		725	sub rbuf_max {
		726	$_[0]{rbuf_max} = $_[1];
		727	}
		728
489	#############################################################################	729	#############################################################################
490		730
491	=item $handle->timeout ($seconds)	731	=item $handle->timeout ($seconds)
492		732
		733	=item $handle->rtimeout ($seconds)
		734
		735	=item $handle->wtimeout ($seconds)
		736
493	Configures (or disables) the inactivity timeout.	737	Configures (or disables) the inactivity timeout.
494		738
495	=cut	739	=item $handle->timeout_reset
496		740
497	sub timeout {	741	=item $handle->rtimeout_reset
		742
		743	=item $handle->wtimeout_reset
		744
		745	Reset the activity timeout, as if data was received or sent.
		746
		747	These methods are cheap to call.
		748
		749	=cut
		750
		751	for my $dir ("", "r", "w") {
		752	my $timeout = "${dir}timeout";
		753	my $tw = "_${dir}tw";
		754	my $on_timeout = "on_${dir}timeout";
		755	my $activity = "_${dir}activity";
		756	my $cb;
		757
		758	*$on_timeout = sub {
		759	$_[0]{$on_timeout} = $_[1];
		760	};
		761
		762	*$timeout = sub {
498	my ($self, $timeout) = @_;	763	my ($self, $new_value) = @_;
499		764
500	$self->{timeout} = $timeout;	765	$self->{$timeout} = $new_value;
501	$self->_timeout;	766	delete $self->{$tw}; &$cb;
502	}	767	};
503		768
		769	*{"${dir}timeout_reset"} = sub {
		770	$_[0]{$activity} = AE::now;
		771	};
		772
		773	# main workhorse:
504	# reset the timeout watcher, as neccessary	774	# reset the timeout watcher, as neccessary
505	# also check for time-outs	775	# also check for time-outs
506	sub _timeout {	776	$cb = sub {
507	my ($self) = @_;	777	my ($self) = @_;
508		778
509	if ($self->{timeout}) {	779	if ($self->{$timeout} && $self->{fh}) {
510	my $NOW = AnyEvent->now;	780	my $NOW = AE::now;
511		781
512	# when would the timeout trigger?	782	# when would the timeout trigger?
513	my $after = $self->{_activity} + $self->{timeout} - $NOW;	783	my $after = $self->{$activity} + $self->{$timeout} - $NOW;
514		784
515	# now or in the past already?	785	# now or in the past already?
516	if ($after <= 0) {	786	if ($after <= 0) {
517	$self->{_activity} = $NOW;	787	$self->{$activity} = $NOW;
518		788
519	if ($self->{on_timeout}) {	789	if ($self->{$on_timeout}) {
520	$self->{on_timeout}($self);	790	$self->{$on_timeout}($self);
521	} else {	791	} else {
522	$self->_error (Errno::ETIMEDOUT);	792	$self->_error (Errno::ETIMEDOUT);
		793	}
		794
		795	# callback could have changed timeout value, optimise
		796	return unless $self->{$timeout};
		797
		798	# calculate new after
		799	$after = $self->{$timeout};
523	}	800	}
524		801
525	# callback could have changed timeout value, optimise	802	Scalar::Util::weaken $self;
526	return unless $self->{timeout};	803	return unless $self; # ->error could have destroyed $self
527		804
528	# calculate new after	805	$self->{$tw} \|\|= AE::timer $after, 0, sub {
529	$after = $self->{timeout};	806	delete $self->{$tw};
		807	$cb->($self);
		808	};
		809	} else {
		810	delete $self->{$tw};
530	}	811	}
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	}	812	}
542	}	813	}
543		814
544	#############################################################################	815	#############################################################################
545		816
…		…
593	my $len = syswrite $self->{fh}, $self->{wbuf};	864	my $len = syswrite $self->{fh}, $self->{wbuf};
594		865
595	if (defined $len) {	866	if (defined $len) {
596	substr $self->{wbuf}, 0, $len, "";	867	substr $self->{wbuf}, 0, $len, "";
597		868
598	$self->{_activity} = AnyEvent->now;	869	$self->{_activity} = $self->{_wactivity} = AE::now;
599		870
600	$self->{on_drain}($self)	871	$self->{on_drain}($self)
601	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})	872	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
602	&& $self->{on_drain};	873	&& $self->{on_drain};
603		874
…		…
609		880
610	# try to write data immediately	881	# try to write data immediately
611	$cb->() unless $self->{autocork};	882	$cb->() unless $self->{autocork};
612		883
613	# if still data left in wbuf, we need to poll	884	# if still data left in wbuf, we need to poll
614	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	885	$self->{_ww} = AE::io $self->{fh}, 1, $cb
615	if length $self->{wbuf};	886	if length $self->{wbuf};
616	};	887	};
617	}	888	}
618		889
619	our %WH;	890	our %WH;
620		891
		892	# deprecated
621	sub register_write_type($$) {	893	sub register_write_type($$) {
622	$WH{$_[0]} = $_[1];	894	$WH{$_[0]} = $_[1];
623	}	895	}
624		896
625	sub push_write {	897	sub push_write {
626	my $self = shift;	898	my $self = shift;
627		899
628	if (@_ > 1) {	900	if (@_ > 1) {
629	my $type = shift;	901	my $type = shift;
630		902
		903	@_ = ($WH{$type} \|\|= _load_func "$type\::anyevent_write_type"
631	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	904	or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_write")
632	->($self, @_);	905	->($self, @_);
633	}	906	}
634		907
		908	# we downgrade here to avoid hard-to-track-down bugs,
		909	# and diagnose the problem earlier and better.
		910
635	if ($self->{tls}) {	911	if ($self->{tls}) {
636	$self->{_tls_wbuf} .= $_[0];	912	utf8::downgrade $self->{_tls_wbuf} .= $_[0];
637		913	&_dotls ($self) if $self->{fh};
638	&_dotls ($self);
639	} else {	914	} else {
640	$self->{wbuf} .= $_[0];	915	utf8::downgrade $self->{wbuf} .= $_[0];
641	$self->_drain_wbuf;	916	$self->_drain_wbuf if $self->{fh};
642	}	917	}
643	}	918	}
644		919
645	=item $handle->push_write (type => @args)	920	=item $handle->push_write (type => @args)
646		921
647	Instead of formatting your data yourself, you can also let this module do	922	Instead of formatting your data yourself, you can also let this module
648	the job by specifying a type and type-specific arguments.	923	do the job by specifying a type and type-specific arguments. You
		924	can also specify the (fully qualified) name of a package, in which
		925	case AnyEvent tries to load the package and then expects to find the
		926	C<anyevent_read_type> function inside (see "custom write types", below).
649		927
650	Predefined types are (if you have ideas for additional types, feel free to	928	Predefined types are (if you have ideas for additional types, feel free to
651	drop by and tell us):	929	drop by and tell us):
652		930
653	=over 4	931	=over 4
…		…
710	Other languages could read single lines terminated by a newline and pass	988	Other languages could read single lines terminated by a newline and pass
711	this line into their JSON decoder of choice.	989	this line into their JSON decoder of choice.
712		990
713	=cut	991	=cut
714		992
		993	sub json_coder() {
		994	eval { require JSON::XS; JSON::XS->new->utf8 }
		995	\|\| do { require JSON; JSON->new->utf8 }
		996	}
		997
715	register_write_type json => sub {	998	register_write_type json => sub {
716	my ($self, $ref) = @_;	999	my ($self, $ref) = @_;
717		1000
718	require JSON;	1001	my $json = $self->{json} \|\|= json_coder;
719		1002
720	$self->{json} ? $self->{json}->encode ($ref)	1003	$json->encode ($ref)
721	: JSON::encode_json ($ref)
722	};	1004	};
723		1005
724	=item storable => $reference	1006	=item storable => $reference
725		1007
726	Freezes the given reference using L<Storable> and writes it to the	1008	Freezes the given reference using L<Storable> and writes it to the
…		…
761		1043
762	delete $self->{low_water_mark};	1044	delete $self->{low_water_mark};
763	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });	1045	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });
764	}	1046	}
765		1047
766	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	1048	=item custom write types - Package::anyevent_write_type $handle, @args
767		1049
768	This function (not method) lets you add your own types to C<push_write>.	1050	Instead of one of the predefined types, you can also specify the name of
		1051	a package. AnyEvent will try to load the package and then expects to find
		1052	a function named C<anyevent_write_type> inside. If it isn't found, it
		1053	progressively tries to load the parent package until it either finds the
		1054	function (good) or runs out of packages (bad).
		1055
769	Whenever the given C<type> is used, C<push_write> will invoke the code	1056	Whenever the given C<type> is used, C<push_write> will the function with
770	reference with the handle object and the remaining arguments.	1057	the handle object and the remaining arguments.
771		1058
772	The code reference is supposed to return a single octet string that will	1059	The function is supposed to return a single octet string that will be
773	be appended to the write buffer.	1060	appended to the write buffer, so you cna mentally treat this function as a
		1061	"arguments to on-the-wire-format" converter.
774		1062
775	Note that this is a function, and all types registered this way will be	1063	Example: implement a custom write type C<join> that joins the remaining
776	global, so try to use unique names.	1064	arguments using the first one.
		1065
		1066	$handle->push_write (My::Type => " ", 1,2,3);
		1067
		1068	# uses the following package, which can be defined in the "My::Type" or in
		1069	# the "My" modules to be auto-loaded, or just about anywhere when the
		1070	# My::Type::anyevent_write_type is defined before invoking it.
		1071
		1072	package My::Type;
		1073
		1074	sub anyevent_write_type {
		1075	my ($handle, $delim, @args) = @_;
		1076
		1077	join $delim, @args
		1078	}
777		1079
778	=cut	1080	=cut
779		1081
780	#############################################################################	1082	#############################################################################
781		1083
…		…
863	=cut	1165	=cut
864		1166
865	sub _drain_rbuf {	1167	sub _drain_rbuf {
866	my ($self) = @_;	1168	my ($self) = @_;
867		1169
		1170	# avoid recursion
		1171	return if $self->{_skip_drain_rbuf};
868	local $self->{_in_drain} = 1;	1172	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		1173
877	while () {	1174	while () {
878	# we need to use a separate tls read buffer, as we must not receive data while	1175	# 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.	1176	# we are draining the buffer, and this can only happen with TLS.
880	$self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf};	1177	$self->{rbuf} .= delete $self->{_tls_rbuf}
		1178	if exists $self->{_tls_rbuf};
881		1179
882	my $len = length $self->{rbuf};	1180	my $len = length $self->{rbuf};
883		1181
884	if (my $cb = shift @{ $self->{_queue} }) {	1182	if (my $cb = shift @{ $self->{_queue} }) {
885	unless ($cb->($self)) {	1183	unless ($cb->($self)) {
886	if ($self->{_eof}) {	1184	# no progress can be made
887	# no progress can be made (not enough data and no data forthcoming)	1185	# (not enough data and no data forthcoming)
888	$self->_error (Errno::EPIPE, 1), return;	1186	$self->_error (Errno::EPIPE, 1), return
889	}	1187	if $self->{_eof};
890		1188
891	unshift @{ $self->{_queue} }, $cb;	1189	unshift @{ $self->{_queue} }, $cb;
892	last;	1190	last;
893	}	1191	}
894	} elsif ($self->{on_read}) {	1192	} elsif ($self->{on_read}) {
…		…
914	last;	1212	last;
915	}	1213	}
916	}	1214	}
917		1215
918	if ($self->{_eof}) {	1216	if ($self->{_eof}) {
919	if ($self->{on_eof}) {	1217	$self->{on_eof}
920	$self->{on_eof}($self)	1218	? $self->{on_eof}($self)
921	} else {
922	$self->_error (0, 1, "Unexpected end-of-file");	1219	: $self->_error (0, 1, "Unexpected end-of-file");
923	}	1220
		1221	return;
		1222	}
		1223
		1224	if (
		1225	defined $self->{rbuf_max}
		1226	&& $self->{rbuf_max} < length $self->{rbuf}
		1227	) {
		1228	$self->_error (Errno::ENOSPC, 1), return;
924	}	1229	}
925		1230
926	# may need to restart read watcher	1231	# may need to restart read watcher
927	unless ($self->{_rw}) {	1232	unless ($self->{_rw}) {
928	$self->start_read	1233	$self->start_read
…		…
940		1245
941	sub on_read {	1246	sub on_read {
942	my ($self, $cb) = @_;	1247	my ($self, $cb) = @_;
943		1248
944	$self->{on_read} = $cb;	1249	$self->{on_read} = $cb;
945	$self->_drain_rbuf if $cb && !$self->{_in_drain};	1250	$self->_drain_rbuf if $cb;
946	}	1251	}
947		1252
948	=item $handle->rbuf	1253	=item $handle->rbuf
949		1254
950	Returns the read buffer (as a modifiable lvalue).	1255	Returns the read buffer (as a modifiable lvalue).
…		…
997	my $cb = pop;	1302	my $cb = pop;
998		1303
999	if (@_) {	1304	if (@_) {
1000	my $type = shift;	1305	my $type = shift;
1001		1306
		1307	$cb = ($RH{$type} \|\|= _load_func "$type\::anyevent_read_type"
1002	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	1308	or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_read")
1003	->($self, $cb, @_);	1309	->($self, $cb, @_);
1004	}	1310	}
1005		1311
1006	push @{ $self->{_queue} }, $cb;	1312	push @{ $self->{_queue} }, $cb;
1007	$self->_drain_rbuf unless $self->{_in_drain};	1313	$self->_drain_rbuf;
1008	}	1314	}
1009		1315
1010	sub unshift_read {	1316	sub unshift_read {
1011	my $self = shift;	1317	my $self = shift;
1012	my $cb = pop;	1318	my $cb = pop;
…		…
1016		1322
1017	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")	1323	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")
1018	->($self, $cb, @_);	1324	->($self, $cb, @_);
1019	}	1325	}
1020		1326
1021
1022	unshift @{ $self->{_queue} }, $cb;	1327	unshift @{ $self->{_queue} }, $cb;
1023	$self->_drain_rbuf unless $self->{_in_drain};	1328	$self->_drain_rbuf;
1024	}	1329	}
1025		1330
1026	=item $handle->push_read (type => @args, $cb)	1331	=item $handle->push_read (type => @args, $cb)
1027		1332
1028	=item $handle->unshift_read (type => @args, $cb)	1333	=item $handle->unshift_read (type => @args, $cb)
1029		1334
1030	Instead of providing a callback that parses the data itself you can chose	1335	Instead of providing a callback that parses the data itself you can chose
1031	between a number of predefined parsing formats, for chunks of data, lines	1336	between a number of predefined parsing formats, for chunks of data, lines
1032	etc.	1337	etc. You can also specify the (fully qualified) name of a package, in
		1338	which case AnyEvent tries to load the package and then expects to find the
		1339	C<anyevent_read_type> function inside (see "custom read types", below).
1033		1340
1034	Predefined types are (if you have ideas for additional types, feel free to	1341	Predefined types are (if you have ideas for additional types, feel free to
1035	drop by and tell us):	1342	drop by and tell us):
1036		1343
1037	=over 4	1344	=over 4
…		…
1277	=cut	1584	=cut
1278		1585
1279	register_read_type json => sub {	1586	register_read_type json => sub {
1280	my ($self, $cb) = @_;	1587	my ($self, $cb) = @_;
1281		1588
1282	my $json = $self->{json} \|\|=	1589	my $json = $self->{json} \|\|= json_coder;
1283	eval { require JSON::XS; JSON::XS->new->utf8 }
1284	\|\| do { require JSON; JSON->new->utf8 };
1285		1590
1286	my $data;	1591	my $data;
1287	my $rbuf = \$self->{rbuf};	1592	my $rbuf = \$self->{rbuf};
1288		1593
1289	sub {	1594	sub {
…		…
1358	}	1663	}
1359	};	1664	};
1360		1665
1361	=back	1666	=back
1362		1667
1363	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)	1668	=item custom read types - Package::anyevent_read_type $handle, $cb, @args
1364		1669
1365	This function (not method) lets you add your own types to C<push_read>.	1670	Instead of one of the predefined types, you can also specify the name
		1671	of a package. AnyEvent will try to load the package and then expects to
		1672	find a function named C<anyevent_read_type> inside. If it isn't found, it
		1673	progressively tries to load the parent package until it either finds the
		1674	function (good) or runs out of packages (bad).
1366		1675
1367	Whenever the given C<type> is used, C<push_read> will invoke the code	1676	Whenever this type is used, C<push_read> will invoke the function with the
1368	reference with the handle object, the callback and the remaining	1677	handle object, the original callback and the remaining arguments.
1369	arguments.
1370		1678
1371	The code reference is supposed to return a callback (usually a closure)	1679	The function is supposed to return a callback (usually a closure) that
1372	that works as a plain read callback (see C<< ->push_read ($cb) >>).	1680	works as a plain read callback (see C<< ->push_read ($cb) >>), so you can
		1681	mentally treat the function as a "configurable read type to read callback"
		1682	converter.
1373		1683
1374	It should invoke the passed callback when it is done reading (remember to	1684	It should invoke the original callback when it is done reading (remember
1375	pass C<$handle> as first argument as all other callbacks do that).	1685	to pass C<$handle> as first argument as all other callbacks do that,
		1686	although there is no strict requirement on this).
1376		1687
1377	Note that this is a function, and all types registered this way will be
1378	global, so try to use unique names.
1379
1380	For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>,	1688	For examples, see the source of this module (F<perldoc -m
1381	search for C<register_read_type>)).	1689	AnyEvent::Handle>, search for C<register_read_type>)).
1382		1690
1383	=item $handle->stop_read	1691	=item $handle->stop_read
1384		1692
1385	=item $handle->start_read	1693	=item $handle->start_read
1386		1694
…		…
1406	}	1714	}
1407		1715
1408	sub start_read {	1716	sub start_read {
1409	my ($self) = @_;	1717	my ($self) = @_;
1410		1718
1411	unless ($self->{_rw} \|\| $self->{_eof}) {	1719	unless ($self->{_rw} \|\| $self->{_eof} \|\| !$self->{fh}) {
1412	Scalar::Util::weaken $self;	1720	Scalar::Util::weaken $self;
1413		1721
1414	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1722	$self->{_rw} = AE::io $self->{fh}, 0, sub {
1415	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});	1723	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1416	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;	1724	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;
1417		1725
1418	if ($len > 0) {	1726	if ($len > 0) {
1419	$self->{_activity} = AnyEvent->now;	1727	$self->{_activity} = $self->{_ractivity} = AE::now;
1420		1728
1421	if ($self->{tls}) {	1729	if ($self->{tls}) {
1422	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);	1730	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1423		1731
1424	&_dotls ($self);	1732	&_dotls ($self);
1425	} else {	1733	} else {
1426	$self->_drain_rbuf unless $self->{_in_drain};	1734	$self->_drain_rbuf;
1427	}	1735	}
1428		1736
1429	} elsif (defined $len) {	1737	} elsif (defined $len) {
1430	delete $self->{_rw};	1738	delete $self->{_rw};
1431	$self->{_eof} = 1;	1739	$self->{_eof} = 1;
1432	$self->_drain_rbuf unless $self->{_in_drain};	1740	$self->_drain_rbuf;
1433		1741
1434	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1742	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1435	return $self->_error ($!, 1);	1743	return $self->_error ($!, 1);
1436	}	1744	}
1437	});	1745	};
1438	}	1746	}
1439	}	1747	}
1440		1748
1441	our $ERROR_SYSCALL;	1749	our $ERROR_SYSCALL;
1442	our $ERROR_WANT_READ;	1750	our $ERROR_WANT_READ;
…		…
1497	$self->{_eof} = 1;	1805	$self->{_eof} = 1;
1498	}	1806	}
1499	}	1807	}
1500		1808
1501	$self->{_tls_rbuf} .= $tmp;	1809	$self->{_tls_rbuf} .= $tmp;
1502	$self->_drain_rbuf unless $self->{_in_drain};	1810	$self->_drain_rbuf;
1503	$self->{tls} or return; # tls session might have gone away in callback	1811	$self->{tls} or return; # tls session might have gone away in callback
1504	}	1812	}
1505		1813
1506	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);	1814	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1507	return $self->_tls_error ($tmp)	1815	return $self->_tls_error ($tmp)
…		…
1509	&& ($tmp != $ERROR_SYSCALL \|\| $!);	1817	&& ($tmp != $ERROR_SYSCALL \|\| $!);
1510		1818
1511	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1819	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1512	$self->{wbuf} .= $tmp;	1820	$self->{wbuf} .= $tmp;
1513	$self->_drain_wbuf;	1821	$self->_drain_wbuf;
		1822	$self->{tls} or return; # tls session might have gone away in callback
1514	}	1823	}
1515		1824
1516	$self->{_on_starttls}	1825	$self->{_on_starttls}
1517	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()	1826	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
1518	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");	1827	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");
…		…
1521	=item $handle->starttls ($tls[, $tls_ctx])	1830	=item $handle->starttls ($tls[, $tls_ctx])
1522		1831
1523	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	1832	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	1833	object is created, you can also do that at a later time by calling
1525	C<starttls>.	1834	C<starttls>.
		1835
		1836	Starting TLS is currently an asynchronous operation - when you push some
		1837	write data and then call C<< ->starttls >> then TLS negotiation will start
		1838	immediately, after which the queued write data is then sent.
1526		1839
1527	The first argument is the same as the C<tls> constructor argument (either	1840	The first argument is the same as the C<tls> constructor argument (either
1528	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1841	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1529		1842
1530	The second argument is the optional C<AnyEvent::TLS> object that is used	1843	The second argument is the optional C<AnyEvent::TLS> object that is used
…		…
1535	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS	1848	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	1849	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	1850	changed to your liking. Note that the handshake might have already started
1538	when this function returns.	1851	when this function returns.
1539		1852
1540	If it an error to start a TLS handshake more than once per	1853	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).	1854	handshakes on the same stream. Best do not attempt to use the stream after
		1855	stopping TLS.
1542		1856
1543	=cut	1857	=cut
1544		1858
1545	our %TLS_CACHE; #TODO not yet documented, should we?	1859	our %TLS_CACHE; #TODO not yet documented, should we?
1546		1860
1547	sub starttls {	1861	sub starttls {
1548	my ($self, $ssl, $ctx) = @_;	1862	my ($self, $tls, $ctx) = @_;
		1863
		1864	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"
		1865	if $self->{tls};
		1866
		1867	$self->{tls} = $tls;
		1868	$self->{tls_ctx} = $ctx if @_ > 2;
		1869
		1870	return unless $self->{fh};
1549		1871
1550	require Net::SSLeay;	1872	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		1873
1555	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();	1874	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1556	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();	1875	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1557		1876
		1877	$tls = delete $self->{tls};
1558	$ctx \|\|= $self->{tls_ctx};	1878	$ctx = $self->{tls_ctx};
		1879
		1880	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
1559		1881
1560	if ("HASH" eq ref $ctx) {	1882	if ("HASH" eq ref $ctx) {
1561	require AnyEvent::TLS;	1883	require AnyEvent::TLS;
1562
1563	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context
1564		1884
1565	if ($ctx->{cache}) {	1885	if ($ctx->{cache}) {
1566	my $key = $ctx+0;	1886	my $key = $ctx+0;
1567	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;	1887	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;
1568	} else {	1888	} else {
1569	$ctx = new AnyEvent::TLS %$ctx;	1889	$ctx = new AnyEvent::TLS %$ctx;
1570	}	1890	}
1571	}	1891	}
1572		1892
1573	$self->{tls_ctx} = $ctx \|\| TLS_CTX ();	1893	$self->{tls_ctx} = $ctx \|\| TLS_CTX ();
1574	$self->{tls} = $ssl = $self->{tls_ctx}->_get_session ($ssl, $self, $self->{peername});	1894	$self->{tls} = $tls = $self->{tls_ctx}->_get_session ($tls, $self, $self->{peername});
1575		1895
1576	# basically, this is deep magic (because SSL_read should have the same issues)	1896	# 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".	1897	# but the openssl maintainers basically said: "trust us, it just works".
1578	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1898	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1579	# and mismaintained ssleay-module doesn't even offer them).	1899	# 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	1906	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
1587	# have identity issues in that area.	1907	# have identity issues in that area.
1588	# Net::SSLeay::CTX_set_mode ($ssl,	1908	# Net::SSLeay::CTX_set_mode ($ssl,
1589	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1909	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
1590	# \| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));	1910	# \| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
1591	Net::SSLeay::CTX_set_mode ($ssl, 1\|2);	1911	Net::SSLeay::CTX_set_mode ($tls, 1\|2);
1592		1912
1593	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1913	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1594	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1914	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1595		1915
		1916	Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf});
		1917
1596	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1918	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
1597		1919
1598	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }	1920	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1599	if $self->{on_starttls};	1921	if $self->{on_starttls};
1600		1922
1601	&_dotls; # need to trigger the initial handshake	1923	&_dotls; # need to trigger the initial handshake
…		…
1604		1926
1605	=item $handle->stoptls	1927	=item $handle->stoptls
1606		1928
1607	Shuts down the SSL connection - this makes a proper EOF handshake by	1929	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	1930	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	1931	support non-blocking shut downs, it is not guaranteed that you can re-use
1610	afterwards.	1932	the stream afterwards.
1611		1933
1612	=cut	1934	=cut
1613		1935
1614	sub stoptls {	1936	sub stoptls {
1615	my ($self) = @_;	1937	my ($self) = @_;
1616		1938
1617	if ($self->{tls}) {	1939	if ($self->{tls} && $self->{fh}) {
1618	Net::SSLeay::shutdown ($self->{tls});	1940	Net::SSLeay::shutdown ($self->{tls});
1619		1941
1620	&_dotls;	1942	&_dotls;
1621		1943
1622	# # we don't give a shit. no, we do, but we can't. no...#d#	1944	# # we don't give a shit. no, we do, but we can't. no...#d#
…		…
1628	sub _freetls {	1950	sub _freetls {
1629	my ($self) = @_;	1951	my ($self) = @_;
1630		1952
1631	return unless $self->{tls};	1953	return unless $self->{tls};
1632		1954
1633	$self->{tls_ctx}->_put_session (delete $self->{tls});	1955	$self->{tls_ctx}->_put_session (delete $self->{tls})
		1956	if $self->{tls} > 0;
1634		1957
1635	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};	1958	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1636	}	1959	}
1637		1960
1638	sub DESTROY {	1961	sub DESTROY {
…		…
1640		1963
1641	&_freetls;	1964	&_freetls;
1642		1965
1643	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	1966	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1644		1967
1645	if ($linger && length $self->{wbuf}) {	1968	if ($linger && length $self->{wbuf} && $self->{fh}) {
1646	my $fh = delete $self->{fh};	1969	my $fh = delete $self->{fh};
1647	my $wbuf = delete $self->{wbuf};	1970	my $wbuf = delete $self->{wbuf};
1648		1971
1649	my @linger;	1972	my @linger;
1650		1973
1651	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {	1974	push @linger, AE::io $fh, 1, sub {
1652	my $len = syswrite $fh, $wbuf, length $wbuf;	1975	my $len = syswrite $fh, $wbuf, length $wbuf;
1653		1976
1654	if ($len > 0) {	1977	if ($len > 0) {
1655	substr $wbuf, 0, $len, "";	1978	substr $wbuf, 0, $len, "";
1656	} else {	1979	} else {
1657	@linger = (); # end	1980	@linger = (); # end
1658	}	1981	}
1659	});	1982	};
1660	push @linger, AnyEvent->timer (after => $linger, cb => sub {	1983	push @linger, AE::timer $linger, 0, sub {
1661	@linger = ();	1984	@linger = ();
1662	});	1985	};
1663	}	1986	}
1664	}	1987	}
1665		1988
1666	=item $handle->destroy	1989	=item $handle->destroy
1667		1990
1668	Shuts down the handle object as much as possible - this call ensures that	1991	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	1992	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.	1993	will be freed. Any method you will call on the handle object after
		1994	destroying it in this way will be silently ignored (and it will return the
		1995	empty list).
1671		1996
1672	Normally, you can just "forget" any references to an AnyEvent::Handle	1997	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	1998	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	1999	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	2000	callback, so when you want to destroy the AnyEvent::Handle object from
…		…
1689	sub destroy {	2014	sub destroy {
1690	my ($self) = @_;	2015	my ($self) = @_;
1691		2016
1692	$self->DESTROY;	2017	$self->DESTROY;
1693	%$self = ();	2018	%$self = ();
		2019	bless $self, "AnyEvent::Handle::destroyed";
1694	}	2020	}
		2021
		2022	sub AnyEvent::Handle::destroyed::AUTOLOAD {
		2023	#nop
		2024	}
		2025
		2026	=item $handle->destroyed
		2027
		2028	Returns false as long as the handle hasn't been destroyed by a call to C<<
		2029	->destroy >>, true otherwise.
		2030
		2031	Can be useful to decide whether the handle is still valid after some
		2032	callback possibly destroyed the handle. For example, C<< ->push_write >>,
		2033	C<< ->starttls >> and other methods can call user callbacks, which in turn
		2034	can destroy the handle, so work can be avoided by checking sometimes:
		2035
		2036	$hdl->starttls ("accept");
		2037	return if $hdl->destroyed;
		2038	$hdl->push_write (...
		2039
		2040	Note that the call to C<push_write> will silently be ignored if the handle
		2041	has been destroyed, so often you can just ignore the possibility of the
		2042	handle being destroyed.
		2043
		2044	=cut
		2045
		2046	sub destroyed { 0 }
		2047	sub AnyEvent::Handle::destroyed::destroyed { 1 }
1695		2048
1696	=item AnyEvent::Handle::TLS_CTX	2049	=item AnyEvent::Handle::TLS_CTX
1697		2050
1698	This function creates and returns the AnyEvent::TLS object used by default	2051	This function creates and returns the AnyEvent::TLS object used by default
1699	for TLS mode.	2052	for TLS mode.

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.192 by root, Fri Mar 12 23:22:14 2010 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.192 by root, Fri Mar 12 23:22:14 2010 UTC