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

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

…		…
1	package AnyEvent::Handle;
2
3	no warnings;
4	use strict qw(subs vars);
5
6	use AnyEvent ();
7	use AnyEvent::Util qw(WSAEWOULDBLOCK);
8	use Scalar::Util ();
9	use Carp ();
10	use Fcntl ();
11	use Errno qw(EAGAIN EINTR);
12
13	=head1 NAME	1	=head1 NAME
14		2
15	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent	3	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent
16
17	=cut
18
19	our $VERSION = 4.82;
20		4
21	=head1 SYNOPSIS	5	=head1 SYNOPSIS
22		6
23	use AnyEvent;	7	use AnyEvent;
24	use AnyEvent::Handle;	8	use AnyEvent::Handle;
26	my $cv = AnyEvent->condvar;	10	my $cv = AnyEvent->condvar;
27		11
28	my $hdl; $hdl = new AnyEvent::Handle	12	my $hdl; $hdl = new AnyEvent::Handle
29	fh => \*STDIN,	13	fh => \*STDIN,
30	on_error => sub {	14	on_error => sub {
		15	my ($hdl, $fatal, $msg) = @_;
31	warn "got error $_[2]\n";	16	warn "got error $msg\n";
		17	$hdl->destroy;
32	$cv->send;	18	$cv->send;
33	);	19	);
34		20
35	# send some request line	21	# send some request line
36	$hdl->push_write ("getinfo\015\012");	22	$hdl->push_write ("getinfo\015\012");
…		…
45	$cv->recv;	31	$cv->recv;
46		32
47	=head1 DESCRIPTION	33	=head1 DESCRIPTION
48		34
49	This module is a helper module to make it easier to do event-based I/O on	35	This module is a helper module to make it easier to do event-based I/O on
50	filehandles. For utility functions for doing non-blocking connects and accepts	36	filehandles.
51	on sockets see L<AnyEvent::Util>.
52		37
53	The L<AnyEvent::Intro> tutorial contains some well-documented	38	The L<AnyEvent::Intro> tutorial contains some well-documented
54	AnyEvent::Handle examples.	39	AnyEvent::Handle examples.
55		40
56	In the following, when the documentation refers to of "bytes" then this	41	In the following, when the documentation refers to of "bytes" then this
57	means characters. As sysread and syswrite are used for all I/O, their	42	means characters. As sysread and syswrite are used for all I/O, their
58	treatment of characters applies to this module as well.	43	treatment of characters applies to this module as well.
59		44
		45	At the very minimum, you should specify C<fh> or C<connect>, and the
		46	C<on_error> callback.
		47
60	All callbacks will be invoked with the handle object as their first	48	All callbacks will be invoked with the handle object as their first
61	argument.	49	argument.
62		50
		51	=cut
		52
		53	package AnyEvent::Handle;
		54
		55	use Scalar::Util ();
		56	use List::Util ();
		57	use Carp ();
		58	use Errno qw(EAGAIN EINTR);
		59
		60	use AnyEvent (); BEGIN { AnyEvent::common_sense }
		61	use AnyEvent::Util qw(WSAEWOULDBLOCK);
		62
		63	our $VERSION = $AnyEvent::VERSION;
		64
		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
63	=head1 METHODS	80	=head1 METHODS
64		81
65	=over 4	82	=over 4
66		83
67	=item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value...	84	=item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value...
68		85
69	The constructor supports these arguments (all as C<< key => value >> pairs).	86	The constructor supports these arguments (all as C<< key => value >> pairs).
70		87
71	=over 4	88	=over 4
72		89
73	=item fh => $filehandle [MANDATORY]	90	=item fh => $filehandle [C<fh> or C<connect> MANDATORY]
74		91
75	The filehandle this L<AnyEvent::Handle> object will operate on.	92	The filehandle this L<AnyEvent::Handle> object will operate on.
76
77	NOTE: The filehandle will be set to non-blocking mode (using	93	NOTE: The filehandle will be set to non-blocking mode (using
78	C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in	94	C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in
79	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.
80		206
81	=item on_eof => $cb->($handle)	207	=item on_eof => $cb->($handle)
82		208
83	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,
84	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
…		…
92	down.	218	down.
93		219
94	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
95	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>.
96		222
97	=item on_error => $cb->($handle, $fatal, $message)
98
99	This is the error callback, which is called when, well, some error
100	occured, such as not being able to resolve the hostname, failure to
101	connect or a read error.
102
103	Some errors are fatal (which is indicated by C<$fatal> being true). On
104	fatal errors the handle object will be destroyed (by a call to C<< ->
105	destroy >>) after invoking the error callback (which means you are free to
106	examine the handle object). Examples of fatal errors are an EOF condition
107	with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors.
108
109	AnyEvent::Handle tries to find an appropriate error code for you to check
110	against, but in some cases (TLS errors), this does not work well. It is
111	recommended to always output the C<$message> argument in human-readable
112	error messages (it's usually the same as C<"$!">).
113
114	Non-fatal errors can be retried by simply returning, but it is recommended
115	to simply ignore this parameter and instead abondon the handle object
116	when this callback is invoked. Examples of non-fatal errors are timeouts
117	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
118
119	On callback entrance, the value of C<$!> contains the operating system
120	error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
121	C<EPROTO>).
122
123	While not mandatory, it is I<highly> recommended to set this callback, as
124	you will not be notified of errors otherwise. The default simply calls
125	C<croak>.
126
127	=item on_read => $cb->($handle)
128
129	This sets the default read callback, which is called when data arrives
130	and no read request is in the queue (unlike read queue callbacks, this
131	callback will only be called when at least one octet of data is in the
132	read buffer).
133
134	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
135	method or access the C<< $handle->{rbuf} >> member directly. Note that you
136	must not enlarge or modify the read buffer, you can only remove data at
137	the beginning from it.
138
139	When an EOF condition is detected then AnyEvent::Handle will first try to
140	feed all the remaining data to the queued callbacks and C<on_read> before
141	calling the C<on_eof> callback. If no progress can be made, then a fatal
142	error will be raised (with C<$!> set to C<EPIPE>).
143
144	Note that, unlike requests in the read queue, an C<on_read> callback
145	doesn't mean you I<require> some data: if there is an EOF and there
146	are outstanding read requests then an error will be flagged. With an
147	C<on_read> callback, the C<on_eof> callback will be invoked.
148
149	=item on_drain => $cb->($handle)	223	=item on_drain => $cb->($handle)
150		224
151	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
152	(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).
153		227
…		…
159	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
160	the file when the write queue becomes empty.	234	the file when the write queue becomes empty.
161		235
162	=item timeout => $fractional_seconds	236	=item timeout => $fractional_seconds
163		237
		238	=item rtimeout => $fractional_seconds
		239
		240	=item wtimeout => $fractional_seconds
		241
164	If non-zero, then this enables an "inactivity" timeout: whenever this many	242	If non-zero, then these enables an "inactivity" timeout: whenever this
165	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
166	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
167	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>.
168		253
169	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
170	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
171	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
172	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
…		…
216	accomplishd by setting this option to a true value.	301	accomplishd by setting this option to a true value.
217		302
218	The default is your opertaing system's default behaviour (most likely	303	The default is your opertaing system's default behaviour (most likely
219	enabled), this option explicitly enables or disables it, if possible.	304	enabled), this option explicitly enables or disables it, if possible.
220		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
221	=item read_size => <bytes>	338	=item read_size => <bytes>
222		339
223	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
224	try to read during each loop iteration, which affects memory	341	try to read during each loop iteration, which affects memory
225	requirements). Default: C<8192>.	342	requirements). Default: C<8192>.
…		…
258	C<undef>.	375	C<undef>.
259		376
260	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	377	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
261		378
262	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
263	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
264	established and will transparently encrypt/decrypt data afterwards.	381	established and will transparently encrypt/decrypt data afterwards.
265		382
266	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
267	appropriate error message.	384	appropriate error message.
268		385
…		…
351		468
352	sub new {	469	sub new {
353	my $class = shift;	470	my $class = shift;
354	my $self = bless { @_ }, $class;	471	my $self = bless { @_ }, $class;
355		472
356	$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) = @_;
357		536
358	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	537	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
359		538
		539	$self->{_activity} =
		540	$self->{_ractivity} =
360	$self->{_activity} = AnyEvent->now;	541	$self->{_wactivity} = AE::now;
361	$self->_timeout;
362		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
363	$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};
364		549
		550	$self->oobinline (exists $self->{oobinline} ? delete $self->{oobinline} : 1);
		551
365	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})	552	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
366	if $self->{tls};	553	if $self->{tls};
367		554
368	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	555	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
369		556
370	$self->start_read	557	$self->start_read
371	if $self->{on_read};	558	if $self->{on_read} \|\| @{ $self->{_queue} };
372		559
373	$self->{fh} && $self	560	$self->_drain_wbuf;
374	}	561	}
375
376	#sub _shutdown {
377	# my ($self) = @_;
378	#
379	# delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)};
380	# $self->{_eof} = 1; # tell starttls et. al to stop trying
381	#
382	# &_freetls;
383	#}
384		562
385	sub _error {	563	sub _error {
386	my ($self, $errno, $fatal, $message) = @_;	564	my ($self, $errno, $fatal, $message) = @_;
387		565
388	$! = $errno;	566	$! = $errno;
389	$message \|\|= "$!";	567	$message \|\|= "$!";
390		568
391	if ($self->{on_error}) {	569	if ($self->{on_error}) {
392	$self->{on_error}($self, $fatal, $message);	570	$self->{on_error}($self, $fatal, $message);
393	$self->destroy;	571	$self->destroy if $fatal;
394	} elsif ($self->{fh}) {	572	} elsif ($self->{fh} \|\| $self->{connect}) {
395	$self->destroy;	573	$self->destroy;
396	Carp::croak "AnyEvent::Handle uncaught error: $message";	574	Carp::croak "AnyEvent::Handle uncaught error: $message";
397	}	575	}
398	}	576	}
399		577
…		…
425	$_[0]{on_eof} = $_[1];	603	$_[0]{on_eof} = $_[1];
426	}	604	}
427		605
428	=item $handle->on_timeout ($cb)	606	=item $handle->on_timeout ($cb)
429		607
430	Replace the current C<on_timeout> callback, or disables the callback (but	608	=item $handle->on_rtimeout ($cb)
431	not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
432	argument and method.
433		609
434	=cut	610	=item $handle->on_wtimeout ($cb)
435		611
436	sub on_timeout {	612	Replace the current C<on_timeout>, C<on_rtimeout> or C<on_wtimeout>
437	$_[0]{on_timeout} = $_[1];	613	callback, or disables the callback (but not the timeout) if C<$cb> =
438	}	614	C<undef>. See the C<timeout> constructor argument and method.
		615
		616	=cut
		617
		618	# see below
439		619
440	=item $handle->autocork ($boolean)	620	=item $handle->autocork ($boolean)
441		621
442	Enables or disables the current autocork behaviour (see C<autocork>	622	Enables or disables the current autocork behaviour (see C<autocork>
443	constructor argument). Changes will only take effect on the next write.	623	constructor argument). Changes will only take effect on the next write.
…		…
458	sub no_delay {	638	sub no_delay {
459	$_[0]{no_delay} = $_[1];	639	$_[0]{no_delay} = $_[1];
460		640
461	eval {	641	eval {
462	local $SIG{__DIE__};	642	local $SIG{__DIE__};
463	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};
464	};	696	};
465	}	697	}
466		698
467	=item $handle->on_starttls ($cb)	699	=item $handle->on_starttls ($cb)
468		700
…		…
482		714
483	sub on_starttls {	715	sub on_starttls {
484	$_[0]{on_stoptls} = $_[1];	716	$_[0]{on_stoptls} = $_[1];
485	}	717	}
486		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
487	#############################################################################	729	#############################################################################
488		730
489	=item $handle->timeout ($seconds)	731	=item $handle->timeout ($seconds)
490		732
		733	=item $handle->rtimeout ($seconds)
		734
		735	=item $handle->wtimeout ($seconds)
		736
491	Configures (or disables) the inactivity timeout.	737	Configures (or disables) the inactivity timeout.
492		738
493	=cut	739	=item $handle->timeout_reset
494		740
495	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 {
496	my ($self, $timeout) = @_;	763	my ($self, $new_value) = @_;
497		764
498	$self->{timeout} = $timeout;	765	$self->{$timeout} = $new_value;
499	$self->_timeout;	766	delete $self->{$tw}; &$cb;
500	}	767	};
501		768
		769	*{"${dir}timeout_reset"} = sub {
		770	$_[0]{$activity} = AE::now;
		771	};
		772
		773	# main workhorse:
502	# reset the timeout watcher, as neccessary	774	# reset the timeout watcher, as neccessary
503	# also check for time-outs	775	# also check for time-outs
504	sub _timeout {	776	$cb = sub {
505	my ($self) = @_;	777	my ($self) = @_;
506		778
507	if ($self->{timeout}) {	779	if ($self->{$timeout} && $self->{fh}) {
508	my $NOW = AnyEvent->now;	780	my $NOW = AE::now;
509		781
510	# when would the timeout trigger?	782	# when would the timeout trigger?
511	my $after = $self->{_activity} + $self->{timeout} - $NOW;	783	my $after = $self->{$activity} + $self->{$timeout} - $NOW;
512		784
513	# now or in the past already?	785	# now or in the past already?
514	if ($after <= 0) {	786	if ($after <= 0) {
515	$self->{_activity} = $NOW;	787	$self->{$activity} = $NOW;
516		788
517	if ($self->{on_timeout}) {	789	if ($self->{$on_timeout}) {
518	$self->{on_timeout}($self);	790	$self->{$on_timeout}($self);
519	} else {	791	} else {
520	$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};
521	}	800	}
522		801
523	# callback could have changed timeout value, optimise	802	Scalar::Util::weaken $self;
524	return unless $self->{timeout};	803	return unless $self; # ->error could have destroyed $self
525		804
526	# calculate new after	805	$self->{$tw} \|\|= AE::timer $after, 0, sub {
527	$after = $self->{timeout};	806	delete $self->{$tw};
		807	$cb->($self);
		808	};
		809	} else {
		810	delete $self->{$tw};
528	}	811	}
529
530	Scalar::Util::weaken $self;
531	return unless $self; # ->error could have destroyed $self
532
533	$self->{_tw} \|\|= AnyEvent->timer (after => $after, cb => sub {
534	delete $self->{_tw};
535	$self->_timeout;
536	});
537	} else {
538	delete $self->{_tw};
539	}	812	}
540	}	813	}
541		814
542	#############################################################################	815	#############################################################################
543		816
…		…
591	my $len = syswrite $self->{fh}, $self->{wbuf};	864	my $len = syswrite $self->{fh}, $self->{wbuf};
592		865
593	if (defined $len) {	866	if (defined $len) {
594	substr $self->{wbuf}, 0, $len, "";	867	substr $self->{wbuf}, 0, $len, "";
595		868
596	$self->{_activity} = AnyEvent->now;	869	$self->{_activity} = $self->{_wactivity} = AE::now;
597		870
598	$self->{on_drain}($self)	871	$self->{on_drain}($self)
599	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})
600	&& $self->{on_drain};	873	&& $self->{on_drain};
601		874
…		…
607		880
608	# try to write data immediately	881	# try to write data immediately
609	$cb->() unless $self->{autocork};	882	$cb->() unless $self->{autocork};
610		883
611	# if still data left in wbuf, we need to poll	884	# if still data left in wbuf, we need to poll
612	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	885	$self->{_ww} = AE::io $self->{fh}, 1, $cb
613	if length $self->{wbuf};	886	if length $self->{wbuf};
614	};	887	};
615	}	888	}
616		889
617	our %WH;	890	our %WH;
618		891
		892	# deprecated
619	sub register_write_type($$) {	893	sub register_write_type($$) {
620	$WH{$_[0]} = $_[1];	894	$WH{$_[0]} = $_[1];
621	}	895	}
622		896
623	sub push_write {	897	sub push_write {
624	my $self = shift;	898	my $self = shift;
625		899
626	if (@_ > 1) {	900	if (@_ > 1) {
627	my $type = shift;	901	my $type = shift;
628		902
		903	@_ = ($WH{$type} \|\|= _load_func "$type\::anyevent_write_type"
629	@_ = ($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")
630	->($self, @_);	905	->($self, @_);
631	}	906	}
632		907
633	if ($self->{tls}) {	908	if ($self->{tls}) {
634	$self->{_tls_wbuf} .= $_[0];	909	$self->{_tls_wbuf} .= $_[0];
635		910	&_dotls ($self) if $self->{fh};
636	&_dotls ($self);
637	} else {	911	} else {
638	$self->{wbuf} .= $_[0];	912	$self->{wbuf} .= $_[0];
639	$self->_drain_wbuf;	913	$self->_drain_wbuf if $self->{fh};
640	}	914	}
641	}	915	}
642		916
643	=item $handle->push_write (type => @args)	917	=item $handle->push_write (type => @args)
644		918
645	Instead of formatting your data yourself, you can also let this module do	919	Instead of formatting your data yourself, you can also let this module
646	the job by specifying a type and type-specific arguments.	920	do the job by specifying a type and type-specific arguments. You
		921	can also specify the (fully qualified) name of a package, in which
		922	case AnyEvent tries to load the package and then expects to find the
		923	C<anyevent_read_type> function inside (see "custom write types", below).
647		924
648	Predefined types are (if you have ideas for additional types, feel free to	925	Predefined types are (if you have ideas for additional types, feel free to
649	drop by and tell us):	926	drop by and tell us):
650		927
651	=over 4	928	=over 4
…		…
708	Other languages could read single lines terminated by a newline and pass	985	Other languages could read single lines terminated by a newline and pass
709	this line into their JSON decoder of choice.	986	this line into their JSON decoder of choice.
710		987
711	=cut	988	=cut
712		989
		990	sub json_coder() {
		991	eval { require JSON::XS; JSON::XS->new->utf8 }
		992	\|\| do { require JSON; JSON->new->utf8 }
		993	}
		994
713	register_write_type json => sub {	995	register_write_type json => sub {
714	my ($self, $ref) = @_;	996	my ($self, $ref) = @_;
715		997
716	require JSON;	998	my $json = $self->{json} \|\|= json_coder;
717		999
718	$self->{json} ? $self->{json}->encode ($ref)	1000	$json->encode ($ref)
719	: JSON::encode_json ($ref)
720	};	1001	};
721		1002
722	=item storable => $reference	1003	=item storable => $reference
723		1004
724	Freezes the given reference using L<Storable> and writes it to the	1005	Freezes the given reference using L<Storable> and writes it to the
…		…
759		1040
760	delete $self->{low_water_mark};	1041	delete $self->{low_water_mark};
761	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });	1042	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });
762	}	1043	}
763		1044
764	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	1045	=item custom write types - Package::anyevent_write_type $handle, @args
765		1046
766	This function (not method) lets you add your own types to C<push_write>.	1047	Instead of one of the predefined types, you can also specify the name of
		1048	a package. AnyEvent will try to load the package and then expects to find
		1049	a function named C<anyevent_write_type> inside. If it isn't found, it
		1050	progressively tries to load the parent package until it either finds the
		1051	function (good) or runs out of packages (bad).
		1052
767	Whenever the given C<type> is used, C<push_write> will invoke the code	1053	Whenever the given C<type> is used, C<push_write> will the function with
768	reference with the handle object and the remaining arguments.	1054	the handle object and the remaining arguments.
769		1055
770	The code reference is supposed to return a single octet string that will	1056	The function is supposed to return a single octet string that will be
771	be appended to the write buffer.	1057	appended to the write buffer, so you cna mentally treat this function as a
		1058	"arguments to on-the-wire-format" converter.
772		1059
773	Note that this is a function, and all types registered this way will be	1060	Example: implement a custom write type C<join> that joins the remaining
774	global, so try to use unique names.	1061	arguments using the first one.
		1062
		1063	$handle->push_write (My::Type => " ", 1,2,3);
		1064
		1065	# uses the following package, which can be defined in the "My::Type" or in
		1066	# the "My" modules to be auto-loaded, or just about anywhere when the
		1067	# My::Type::anyevent_write_type is defined before invoking it.
		1068
		1069	package My::Type;
		1070
		1071	sub anyevent_write_type {
		1072	my ($handle, $delim, @args) = @_;
		1073
		1074	join $delim, @args
		1075	}
775		1076
776	=cut	1077	=cut
777		1078
778	#############################################################################	1079	#############################################################################
779		1080
…		…
861	=cut	1162	=cut
862		1163
863	sub _drain_rbuf {	1164	sub _drain_rbuf {
864	my ($self) = @_;	1165	my ($self) = @_;
865		1166
		1167	# avoid recursion
		1168	return if $self->{_skip_drain_rbuf};
866	local $self->{_in_drain} = 1;	1169	local $self->{_skip_drain_rbuf} = 1;
867
868	if (
869	defined $self->{rbuf_max}
870	&& $self->{rbuf_max} < length $self->{rbuf}
871	) {
872	$self->_error (Errno::ENOSPC, 1), return;
873	}
874		1170
875	while () {	1171	while () {
876	# we need to use a separate tls read buffer, as we must not receive data while	1172	# we need to use a separate tls read buffer, as we must not receive data while
877	# we are draining the buffer, and this can only happen with TLS.	1173	# we are draining the buffer, and this can only happen with TLS.
878	$self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf};	1174	$self->{rbuf} .= delete $self->{_tls_rbuf}
		1175	if exists $self->{_tls_rbuf};
879		1176
880	my $len = length $self->{rbuf};	1177	my $len = length $self->{rbuf};
881		1178
882	if (my $cb = shift @{ $self->{_queue} }) {	1179	if (my $cb = shift @{ $self->{_queue} }) {
883	unless ($cb->($self)) {	1180	unless ($cb->($self)) {
884	if ($self->{_eof}) {	1181	# no progress can be made
885	# no progress can be made (not enough data and no data forthcoming)	1182	# (not enough data and no data forthcoming)
886	$self->_error (Errno::EPIPE, 1), return;	1183	$self->_error (Errno::EPIPE, 1), return
887	}	1184	if $self->{_eof};
888		1185
889	unshift @{ $self->{_queue} }, $cb;	1186	unshift @{ $self->{_queue} }, $cb;
890	last;	1187	last;
891	}	1188	}
892	} elsif ($self->{on_read}) {	1189	} elsif ($self->{on_read}) {
…		…
912	last;	1209	last;
913	}	1210	}
914	}	1211	}
915		1212
916	if ($self->{_eof}) {	1213	if ($self->{_eof}) {
917	if ($self->{on_eof}) {	1214	$self->{on_eof}
918	$self->{on_eof}($self)	1215	? $self->{on_eof}($self)
919	} else {
920	$self->_error (0, 1, "Unexpected end-of-file");	1216	: $self->_error (0, 1, "Unexpected end-of-file");
921	}	1217
		1218	return;
		1219	}
		1220
		1221	if (
		1222	defined $self->{rbuf_max}
		1223	&& $self->{rbuf_max} < length $self->{rbuf}
		1224	) {
		1225	$self->_error (Errno::ENOSPC, 1), return;
922	}	1226	}
923		1227
924	# may need to restart read watcher	1228	# may need to restart read watcher
925	unless ($self->{_rw}) {	1229	unless ($self->{_rw}) {
926	$self->start_read	1230	$self->start_read
…		…
938		1242
939	sub on_read {	1243	sub on_read {
940	my ($self, $cb) = @_;	1244	my ($self, $cb) = @_;
941		1245
942	$self->{on_read} = $cb;	1246	$self->{on_read} = $cb;
943	$self->_drain_rbuf if $cb && !$self->{_in_drain};	1247	$self->_drain_rbuf if $cb;
944	}	1248	}
945		1249
946	=item $handle->rbuf	1250	=item $handle->rbuf
947		1251
948	Returns the read buffer (as a modifiable lvalue).	1252	Returns the read buffer (as a modifiable lvalue).
…		…
995	my $cb = pop;	1299	my $cb = pop;
996		1300
997	if (@_) {	1301	if (@_) {
998	my $type = shift;	1302	my $type = shift;
999		1303
		1304	$cb = ($RH{$type} \|\|= _load_func "$type\::anyevent_read_type"
1000	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	1305	or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_read")
1001	->($self, $cb, @_);	1306	->($self, $cb, @_);
1002	}	1307	}
1003		1308
1004	push @{ $self->{_queue} }, $cb;	1309	push @{ $self->{_queue} }, $cb;
1005	$self->_drain_rbuf unless $self->{_in_drain};	1310	$self->_drain_rbuf;
1006	}	1311	}
1007		1312
1008	sub unshift_read {	1313	sub unshift_read {
1009	my $self = shift;	1314	my $self = shift;
1010	my $cb = pop;	1315	my $cb = pop;
…		…
1014		1319
1015	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")	1320	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")
1016	->($self, $cb, @_);	1321	->($self, $cb, @_);
1017	}	1322	}
1018		1323
1019
1020	unshift @{ $self->{_queue} }, $cb;	1324	unshift @{ $self->{_queue} }, $cb;
1021	$self->_drain_rbuf unless $self->{_in_drain};	1325	$self->_drain_rbuf;
1022	}	1326	}
1023		1327
1024	=item $handle->push_read (type => @args, $cb)	1328	=item $handle->push_read (type => @args, $cb)
1025		1329
1026	=item $handle->unshift_read (type => @args, $cb)	1330	=item $handle->unshift_read (type => @args, $cb)
1027		1331
1028	Instead of providing a callback that parses the data itself you can chose	1332	Instead of providing a callback that parses the data itself you can chose
1029	between a number of predefined parsing formats, for chunks of data, lines	1333	between a number of predefined parsing formats, for chunks of data, lines
1030	etc.	1334	etc. You can also specify the (fully qualified) name of a package, in
		1335	which case AnyEvent tries to load the package and then expects to find the
		1336	C<anyevent_read_type> function inside (see "custom read types", below).
1031		1337
1032	Predefined types are (if you have ideas for additional types, feel free to	1338	Predefined types are (if you have ideas for additional types, feel free to
1033	drop by and tell us):	1339	drop by and tell us):
1034		1340
1035	=over 4	1341	=over 4
…		…
1275	=cut	1581	=cut
1276		1582
1277	register_read_type json => sub {	1583	register_read_type json => sub {
1278	my ($self, $cb) = @_;	1584	my ($self, $cb) = @_;
1279		1585
1280	my $json = $self->{json} \|\|=	1586	my $json = $self->{json} \|\|= json_coder;
1281	eval { require JSON::XS; JSON::XS->new->utf8 }
1282	\|\| do { require JSON; JSON->new->utf8 };
1283		1587
1284	my $data;	1588	my $data;
1285	my $rbuf = \$self->{rbuf};	1589	my $rbuf = \$self->{rbuf};
1286		1590
1287	sub {	1591	sub {
…		…
1356	}	1660	}
1357	};	1661	};
1358		1662
1359	=back	1663	=back
1360		1664
1361	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)	1665	=item custom read types - Package::anyevent_read_type $handle, $cb, @args
1362		1666
1363	This function (not method) lets you add your own types to C<push_read>.	1667	Instead of one of the predefined types, you can also specify the name
		1668	of a package. AnyEvent will try to load the package and then expects to
		1669	find a function named C<anyevent_read_type> inside. If it isn't found, it
		1670	progressively tries to load the parent package until it either finds the
		1671	function (good) or runs out of packages (bad).
1364		1672
1365	Whenever the given C<type> is used, C<push_read> will invoke the code	1673	Whenever this type is used, C<push_read> will invoke the function with the
1366	reference with the handle object, the callback and the remaining	1674	handle object, the original callback and the remaining arguments.
1367	arguments.
1368		1675
1369	The code reference is supposed to return a callback (usually a closure)	1676	The function is supposed to return a callback (usually a closure) that
1370	that works as a plain read callback (see C<< ->push_read ($cb) >>).	1677	works as a plain read callback (see C<< ->push_read ($cb) >>), so you can
		1678	mentally treat the function as a "configurable read type to read callback"
		1679	converter.
1371		1680
1372	It should invoke the passed callback when it is done reading (remember to	1681	It should invoke the original callback when it is done reading (remember
1373	pass C<$handle> as first argument as all other callbacks do that).	1682	to pass C<$handle> as first argument as all other callbacks do that,
		1683	although there is no strict requirement on this).
1374		1684
1375	Note that this is a function, and all types registered this way will be
1376	global, so try to use unique names.
1377
1378	For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>,	1685	For examples, see the source of this module (F<perldoc -m
1379	search for C<register_read_type>)).	1686	AnyEvent::Handle>, search for C<register_read_type>)).
1380		1687
1381	=item $handle->stop_read	1688	=item $handle->stop_read
1382		1689
1383	=item $handle->start_read	1690	=item $handle->start_read
1384		1691
…		…
1407	my ($self) = @_;	1714	my ($self) = @_;
1408		1715
1409	unless ($self->{_rw} \|\| $self->{_eof}) {	1716	unless ($self->{_rw} \|\| $self->{_eof}) {
1410	Scalar::Util::weaken $self;	1717	Scalar::Util::weaken $self;
1411		1718
1412	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1719	$self->{_rw} = AE::io $self->{fh}, 0, sub {
1413	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});	1720	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1414	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;	1721	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;
1415		1722
1416	if ($len > 0) {	1723	if ($len > 0) {
1417	$self->{_activity} = AnyEvent->now;	1724	$self->{_activity} = $self->{_ractivity} = AE::now;
1418		1725
1419	if ($self->{tls}) {	1726	if ($self->{tls}) {
1420	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);	1727	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1421		1728
1422	&_dotls ($self);	1729	&_dotls ($self);
1423	} else {	1730	} else {
1424	$self->_drain_rbuf unless $self->{_in_drain};	1731	$self->_drain_rbuf;
1425	}	1732	}
1426		1733
1427	} elsif (defined $len) {	1734	} elsif (defined $len) {
1428	delete $self->{_rw};	1735	delete $self->{_rw};
1429	$self->{_eof} = 1;	1736	$self->{_eof} = 1;
1430	$self->_drain_rbuf unless $self->{_in_drain};	1737	$self->_drain_rbuf;
1431		1738
1432	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1739	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1433	return $self->_error ($!, 1);	1740	return $self->_error ($!, 1);
1434	}	1741	}
1435	});	1742	};
1436	}	1743	}
1437	}	1744	}
1438		1745
1439	our $ERROR_SYSCALL;	1746	our $ERROR_SYSCALL;
1440	our $ERROR_WANT_READ;	1747	our $ERROR_WANT_READ;
…		…
1495	$self->{_eof} = 1;	1802	$self->{_eof} = 1;
1496	}	1803	}
1497	}	1804	}
1498		1805
1499	$self->{_tls_rbuf} .= $tmp;	1806	$self->{_tls_rbuf} .= $tmp;
1500	$self->_drain_rbuf unless $self->{_in_drain};	1807	$self->_drain_rbuf;
1501	$self->{tls} or return; # tls session might have gone away in callback	1808	$self->{tls} or return; # tls session might have gone away in callback
1502	}	1809	}
1503		1810
1504	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);	1811	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1505	return $self->_tls_error ($tmp)	1812	return $self->_tls_error ($tmp)
…		…
1520		1827
1521	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	1828	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
1522	object is created, you can also do that at a later time by calling	1829	object is created, you can also do that at a later time by calling
1523	C<starttls>.	1830	C<starttls>.
1524		1831
		1832	Starting TLS is currently an asynchronous operation - when you push some
		1833	write data and then call C<< ->starttls >> then TLS negotiation will start
		1834	immediately, after which the queued write data is then sent.
		1835
1525	The first argument is the same as the C<tls> constructor argument (either	1836	The first argument is the same as the C<tls> constructor argument (either
1526	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1837	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1527		1838
1528	The second argument is the optional C<AnyEvent::TLS> object that is used	1839	The second argument is the optional C<AnyEvent::TLS> object that is used
1529	when AnyEvent::Handle has to create its own TLS connection object, or	1840	when AnyEvent::Handle has to create its own TLS connection object, or
…		…
1533	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS	1844	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS
1534	context in C<< $handle->{tls_ctx} >> after this call and can be used or	1845	context in C<< $handle->{tls_ctx} >> after this call and can be used or
1535	changed to your liking. Note that the handshake might have already started	1846	changed to your liking. Note that the handshake might have already started
1536	when this function returns.	1847	when this function returns.
1537		1848
1538	If it an error to start a TLS handshake more than once per	1849	Due to bugs in OpenSSL, it might or might not be possible to do multiple
1539	AnyEvent::Handle object (this is due to bugs in OpenSSL).	1850	handshakes on the same stream. Best do not attempt to use the stream after
		1851	stopping TLS.
1540		1852
1541	=cut	1853	=cut
1542		1854
1543	our %TLS_CACHE; #TODO not yet documented, should we?	1855	our %TLS_CACHE; #TODO not yet documented, should we?
1544		1856
1545	sub starttls {	1857	sub starttls {
1546	my ($self, $ssl, $ctx) = @_;	1858	my ($self, $tls, $ctx) = @_;
		1859
		1860	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"
		1861	if $self->{tls};
		1862
		1863	$self->{tls} = $tls;
		1864	$self->{tls_ctx} = $ctx if @_ > 2;
		1865
		1866	return unless $self->{fh};
1547		1867
1548	require Net::SSLeay;	1868	require Net::SSLeay;
1549
1550	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"
1551	if $self->{tls};
1552		1869
1553	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();	1870	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1554	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();	1871	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1555		1872
		1873	$tls = delete $self->{tls};
1556	$ctx \|\|= $self->{tls_ctx};	1874	$ctx = $self->{tls_ctx};
		1875
		1876	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
1557		1877
1558	if ("HASH" eq ref $ctx) {	1878	if ("HASH" eq ref $ctx) {
1559	require AnyEvent::TLS;	1879	require AnyEvent::TLS;
1560
1561	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context
1562		1880
1563	if ($ctx->{cache}) {	1881	if ($ctx->{cache}) {
1564	my $key = $ctx+0;	1882	my $key = $ctx+0;
1565	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;	1883	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;
1566	} else {	1884	} else {
1567	$ctx = new AnyEvent::TLS %$ctx;	1885	$ctx = new AnyEvent::TLS %$ctx;
1568	}	1886	}
1569	}	1887	}
1570		1888
1571	$self->{tls_ctx} = $ctx \|\| TLS_CTX ();	1889	$self->{tls_ctx} = $ctx \|\| TLS_CTX ();
1572	$self->{tls} = $ssl = $self->{tls_ctx}->_get_session ($ssl, $self, $self->{peername});	1890	$self->{tls} = $tls = $self->{tls_ctx}->_get_session ($tls, $self, $self->{peername});
1573		1891
1574	# basically, this is deep magic (because SSL_read should have the same issues)	1892	# basically, this is deep magic (because SSL_read should have the same issues)
1575	# but the openssl maintainers basically said: "trust us, it just works".	1893	# but the openssl maintainers basically said: "trust us, it just works".
1576	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1894	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1577	# and mismaintained ssleay-module doesn't even offer them).	1895	# and mismaintained ssleay-module doesn't even offer them).
…		…
1584	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to	1902	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
1585	# have identity issues in that area.	1903	# have identity issues in that area.
1586	# Net::SSLeay::CTX_set_mode ($ssl,	1904	# Net::SSLeay::CTX_set_mode ($ssl,
1587	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1905	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
1588	# \| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));	1906	# \| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
1589	Net::SSLeay::CTX_set_mode ($ssl, 1\|2);	1907	Net::SSLeay::CTX_set_mode ($tls, 1\|2);
1590		1908
1591	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1909	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1592	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1910	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1593		1911
		1912	Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf});
		1913
1594	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1914	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
1595		1915
1596	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }	1916	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1597	if $self->{on_starttls};	1917	if $self->{on_starttls};
1598		1918
1599	&_dotls; # need to trigger the initial handshake	1919	&_dotls; # need to trigger the initial handshake
…		…
1602		1922
1603	=item $handle->stoptls	1923	=item $handle->stoptls
1604		1924
1605	Shuts down the SSL connection - this makes a proper EOF handshake by	1925	Shuts down the SSL connection - this makes a proper EOF handshake by
1606	sending a close notify to the other side, but since OpenSSL doesn't	1926	sending a close notify to the other side, but since OpenSSL doesn't
1607	support non-blocking shut downs, it is not possible to re-use the stream	1927	support non-blocking shut downs, it is not guarenteed that you can re-use
1608	afterwards.	1928	the stream afterwards.
1609		1929
1610	=cut	1930	=cut
1611		1931
1612	sub stoptls {	1932	sub stoptls {
1613	my ($self) = @_;	1933	my ($self) = @_;
…		…
1626	sub _freetls {	1946	sub _freetls {
1627	my ($self) = @_;	1947	my ($self) = @_;
1628		1948
1629	return unless $self->{tls};	1949	return unless $self->{tls};
1630		1950
1631	$self->{tls_ctx}->_put_session (delete $self->{tls});	1951	$self->{tls_ctx}->_put_session (delete $self->{tls})
		1952	if $self->{tls} > 0;
1632		1953
1633	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};	1954	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1634	}	1955	}
1635		1956
1636	sub DESTROY {	1957	sub DESTROY {
…		…
1638		1959
1639	&_freetls;	1960	&_freetls;
1640		1961
1641	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	1962	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1642		1963
1643	if ($linger && length $self->{wbuf}) {	1964	if ($linger && length $self->{wbuf} && $self->{fh}) {
1644	my $fh = delete $self->{fh};	1965	my $fh = delete $self->{fh};
1645	my $wbuf = delete $self->{wbuf};	1966	my $wbuf = delete $self->{wbuf};
1646		1967
1647	my @linger;	1968	my @linger;
1648		1969
1649	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {	1970	push @linger, AE::io $fh, 1, sub {
1650	my $len = syswrite $fh, $wbuf, length $wbuf;	1971	my $len = syswrite $fh, $wbuf, length $wbuf;
1651		1972
1652	if ($len > 0) {	1973	if ($len > 0) {
1653	substr $wbuf, 0, $len, "";	1974	substr $wbuf, 0, $len, "";
1654	} else {	1975	} else {
1655	@linger = (); # end	1976	@linger = (); # end
1656	}	1977	}
1657	});	1978	};
1658	push @linger, AnyEvent->timer (after => $linger, cb => sub {	1979	push @linger, AE::timer $linger, 0, sub {
1659	@linger = ();	1980	@linger = ();
1660	});	1981	};
1661	}	1982	}
1662	}	1983	}
1663		1984
1664	=item $handle->destroy	1985	=item $handle->destroy
1665		1986
1666	Shuts down the handle object as much as possible - this call ensures that	1987	Shuts down the handle object as much as possible - this call ensures that
1667	no further callbacks will be invoked and as many resources as possible	1988	no further callbacks will be invoked and as many resources as possible
1668	will be freed. You must not call any methods on the object afterwards.	1989	will be freed. Any method you will call on the handle object after
		1990	destroying it in this way will be silently ignored (and it will return the
		1991	empty list).
1669		1992
1670	Normally, you can just "forget" any references to an AnyEvent::Handle	1993	Normally, you can just "forget" any references to an AnyEvent::Handle
1671	object and it will simply shut down. This works in fatal error and EOF	1994	object and it will simply shut down. This works in fatal error and EOF
1672	callbacks, as well as code outside. It does I<NOT> work in a read or write	1995	callbacks, as well as code outside. It does I<NOT> work in a read or write
1673	callback, so when you want to destroy the AnyEvent::Handle object from	1996	callback, so when you want to destroy the AnyEvent::Handle object from
…		…
1687	sub destroy {	2010	sub destroy {
1688	my ($self) = @_;	2011	my ($self) = @_;
1689		2012
1690	$self->DESTROY;	2013	$self->DESTROY;
1691	%$self = ();	2014	%$self = ();
		2015	bless $self, "AnyEvent::Handle::destroyed";
		2016	}
		2017
		2018	sub AnyEvent::Handle::destroyed::AUTOLOAD {
		2019	#nop
1692	}	2020	}
1693		2021
1694	=item AnyEvent::Handle::TLS_CTX	2022	=item AnyEvent::Handle::TLS_CTX
1695		2023
1696	This function creates and returns the AnyEvent::TLS object used by default	2024	This function creates and returns the AnyEvent::TLS object used by default

Diff Legend

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

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

Diff Legend

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