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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.158 by root, Fri Jul 24 08:40:35 2009 UTC vs.
Revision 1.187 by root, Tue Sep 8 00:01:12 2009 UTC

…		…
1	package AnyEvent::Handle;
2
3	use Scalar::Util ();
4	use Carp ();
5	use Errno qw(EAGAIN EINTR);
6
7	use AnyEvent (); BEGIN { AnyEvent::common_sense }
8	use AnyEvent::Util qw(WSAEWOULDBLOCK);
9
10	=head1 NAME	1	=head1 NAME
11		2
12	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent	3	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent
13
14	=cut
15
16	our $VERSION = 4.86;
17		4
18	=head1 SYNOPSIS	5	=head1 SYNOPSIS
19		6
20	use AnyEvent;	7	use AnyEvent;
21	use AnyEvent::Handle;	8	use AnyEvent::Handle;
44	$cv->recv;	31	$cv->recv;
45		32
46	=head1 DESCRIPTION	33	=head1 DESCRIPTION
47		34
48	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
49	filehandles. For utility functions for doing non-blocking connects and accepts	36	filehandles.
50	on sockets see L<AnyEvent::Util>.
51		37
52	The L<AnyEvent::Intro> tutorial contains some well-documented	38	The L<AnyEvent::Intro> tutorial contains some well-documented
53	AnyEvent::Handle examples.	39	AnyEvent::Handle examples.
54		40
55	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
56	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
57	treatment of characters applies to this module as well.	43	treatment of characters applies to this module as well.
58		44
		45	At the very minimum, you should specify C<fh> or C<connect>, and the
		46	C<on_error> callback.
		47
59	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
60	argument.	49	argument.
61		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
62	=head1 METHODS	80	=head1 METHODS
63		81
64	=over 4	82	=over 4
65		83
66	=item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value...	84	=item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value...
67		85
68	The constructor supports these arguments (all as C<< key => value >> pairs).	86	The constructor supports these arguments (all as C<< key => value >> pairs).
69		87
70	=over 4	88	=over 4
71		89
72	=item fh => $filehandle [MANDATORY]
73
74	#=item fh => $filehandle [C<fh> or C<connect> MANDATORY]	90	=item fh => $filehandle [C<fh> or C<connect> MANDATORY]
75		91
76	The filehandle this L<AnyEvent::Handle> object will operate on.	92	The filehandle this L<AnyEvent::Handle> object will operate on.
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.
80		96
81	#=item connect => [$host, $service]	97	=item connect => [$host, $service] [C<fh> or C<connect> MANDATORY]
82	#	98
83	# You have to specify either this parameter, or C<connect>, below.
84	#Try to connect to the specified host and service (port), using	99	Try to connect to the specified host and service (port), using
85	#C<AnyEvent::Socket::tcp_connect>.	100	C<AnyEvent::Socket::tcp_connect>. The C<$host> additionally becomes the
86	#	101	default C<peername>.
87	#When this	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.
88		206
89	=item on_eof => $cb->($handle)	207	=item on_eof => $cb->($handle)
90		208
91	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,
92	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
…		…
100	down.	218	down.
101		219
102	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
103	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>.
104		222
105	=item on_error => $cb->($handle, $fatal, $message)
106
107	This is the error callback, which is called when, well, some error
108	occured, such as not being able to resolve the hostname, failure to
109	connect or a read error.
110
111	Some errors are fatal (which is indicated by C<$fatal> being true). On
112	fatal errors the handle object will be destroyed (by a call to C<< ->
113	destroy >>) after invoking the error callback (which means you are free to
114	examine the handle object). Examples of fatal errors are an EOF condition
115	with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors.
116
117	AnyEvent::Handle tries to find an appropriate error code for you to check
118	against, but in some cases (TLS errors), this does not work well. It is
119	recommended to always output the C<$message> argument in human-readable
120	error messages (it's usually the same as C<"$!">).
121
122	Non-fatal errors can be retried by simply returning, but it is recommended
123	to simply ignore this parameter and instead abondon the handle object
124	when this callback is invoked. Examples of non-fatal errors are timeouts
125	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
126
127	On callback entrance, the value of C<$!> contains the operating system
128	error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
129	C<EPROTO>).
130
131	While not mandatory, it is I<highly> recommended to set this callback, as
132	you will not be notified of errors otherwise. The default simply calls
133	C<croak>.
134
135	=item on_read => $cb->($handle)
136
137	This sets the default read callback, which is called when data arrives
138	and no read request is in the queue (unlike read queue callbacks, this
139	callback will only be called when at least one octet of data is in the
140	read buffer).
141
142	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
143	method or access the C<< $handle->{rbuf} >> member directly. Note that you
144	must not enlarge or modify the read buffer, you can only remove data at
145	the beginning from it.
146
147	When an EOF condition is detected then AnyEvent::Handle will first try to
148	feed all the remaining data to the queued callbacks and C<on_read> before
149	calling the C<on_eof> callback. If no progress can be made, then a fatal
150	error will be raised (with C<$!> set to C<EPIPE>).
151
152	Note that, unlike requests in the read queue, an C<on_read> callback
153	doesn't mean you I<require> some data: if there is an EOF and there
154	are outstanding read requests then an error will be flagged. With an
155	C<on_read> callback, the C<on_eof> callback will be invoked.
156
157	=item on_drain => $cb->($handle)	223	=item on_drain => $cb->($handle)
158		224
159	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
160	(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).
161		227
…		…
167	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
168	the file when the write queue becomes empty.	234	the file when the write queue becomes empty.
169		235
170	=item timeout => $fractional_seconds	236	=item timeout => $fractional_seconds
171		237
		238	=item rtimeout => $fractional_seconds
		239
		240	=item wtimeout => $fractional_seconds
		241
172	If non-zero, then this enables an "inactivity" timeout: whenever this many	242	If non-zero, then these enables an "inactivity" timeout: whenever this
173	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
174	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
175	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>.
176		253
177	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
178	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
179	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
180	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
…		…
224	accomplishd by setting this option to a true value.	301	accomplishd by setting this option to a true value.
225		302
226	The default is your opertaing system's default behaviour (most likely	303	The default is your opertaing system's default behaviour (most likely
227	enabled), this option explicitly enables or disables it, if possible.	304	enabled), this option explicitly enables or disables it, if possible.
228		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
229	=item read_size => <bytes>	338	=item read_size => <bytes>
230		339
231	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
232	try to read during each loop iteration, which affects memory	341	try to read during each loop iteration, which affects memory
233	requirements). Default: C<8192>.	342	requirements). Default: C<8192>.
…		…
266	C<undef>.	375	C<undef>.
267		376
268	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	377	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
269		378
270	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
271	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
272	established and will transparently encrypt/decrypt data afterwards.	381	established and will transparently encrypt/decrypt data afterwards.
273		382
274	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
275	appropriate error message.	384	appropriate error message.
276		385
…		…
359		468
360	sub new {	469	sub new {
361	my $class = shift;	470	my $class = shift;
362	my $self = bless { @_ }, $class;	471	my $self = bless { @_ }, $class;
363		472
364	$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) = @_;
365		536
366	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	537	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
367		538
		539	$self->{_activity} =
		540	$self->{_ractivity} =
368	$self->{_activity} = AnyEvent->now;	541	$self->{_wactivity} = AE::now;
369	$self->_timeout;
370		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
371	$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};
372		549
		550	$self->oobinline (exists $self->{oobinline} ? delete $self->{oobinline} : 1);
		551
373	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})	552	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
374	if $self->{tls};	553	if $self->{tls};
375		554
376	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	555	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
377		556
378	$self->start_read	557	$self->start_read
379	if $self->{on_read};	558	if $self->{on_read} \|\| @{ $self->{_queue} };
380		559
381	$self->{fh} && $self	560	$self->_drain_wbuf;
382	}	561	}
383
384	#sub _shutdown {
385	# my ($self) = @_;
386	#
387	# delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)};
388	# $self->{_eof} = 1; # tell starttls et. al to stop trying
389	#
390	# &_freetls;
391	#}
392		562
393	sub _error {	563	sub _error {
394	my ($self, $errno, $fatal, $message) = @_;	564	my ($self, $errno, $fatal, $message) = @_;
395		565
396	$! = $errno;	566	$! = $errno;
397	$message \|\|= "$!";	567	$message \|\|= "$!";
398		568
399	if ($self->{on_error}) {	569	if ($self->{on_error}) {
400	$self->{on_error}($self, $fatal, $message);	570	$self->{on_error}($self, $fatal, $message);
401	$self->destroy if $fatal;	571	$self->destroy if $fatal;
402	} elsif ($self->{fh}) {	572	} elsif ($self->{fh} \|\| $self->{connect}) {
403	$self->destroy;	573	$self->destroy;
404	Carp::croak "AnyEvent::Handle uncaught error: $message";	574	Carp::croak "AnyEvent::Handle uncaught error: $message";
405	}	575	}
406	}	576	}
407		577
…		…
433	$_[0]{on_eof} = $_[1];	603	$_[0]{on_eof} = $_[1];
434	}	604	}
435		605
436	=item $handle->on_timeout ($cb)	606	=item $handle->on_timeout ($cb)
437		607
438	Replace the current C<on_timeout> callback, or disables the callback (but	608	=item $handle->on_rtimeout ($cb)
439	not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
440	argument and method.
441		609
442	=cut	610	=item $handle->on_wtimeout ($cb)
443		611
444	sub on_timeout {	612	Replace the current C<on_timeout>, C<on_rtimeout> or C<on_wtimeout>
445	$_[0]{on_timeout} = $_[1];	613	callback, or disables the callback (but not the timeout) if C<$cb> =
446	}	614	C<undef>. See the C<timeout> constructor argument and method.
		615
		616	=cut
		617
		618	# see below
447		619
448	=item $handle->autocork ($boolean)	620	=item $handle->autocork ($boolean)
449		621
450	Enables or disables the current autocork behaviour (see C<autocork>	622	Enables or disables the current autocork behaviour (see C<autocork>
451	constructor argument). Changes will only take effect on the next write.	623	constructor argument). Changes will only take effect on the next write.
…		…
466	sub no_delay {	638	sub no_delay {
467	$_[0]{no_delay} = $_[1];	639	$_[0]{no_delay} = $_[1];
468		640
469	eval {	641	eval {
470	local $SIG{__DIE__};	642	local $SIG{__DIE__};
471	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};
472	};	696	};
473	}	697	}
474		698
475	=item $handle->on_starttls ($cb)	699	=item $handle->on_starttls ($cb)
476		700
…		…
490		714
491	sub on_starttls {	715	sub on_starttls {
492	$_[0]{on_stoptls} = $_[1];	716	$_[0]{on_stoptls} = $_[1];
493	}	717	}
494		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
495	#############################################################################	729	#############################################################################
496		730
497	=item $handle->timeout ($seconds)	731	=item $handle->timeout ($seconds)
498		732
		733	=item $handle->rtimeout ($seconds)
		734
		735	=item $handle->wtimeout ($seconds)
		736
499	Configures (or disables) the inactivity timeout.	737	Configures (or disables) the inactivity timeout.
500		738
501	=cut	739	=item $handle->timeout_reset
502		740
503	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 {
504	my ($self, $timeout) = @_;	763	my ($self, $new_value) = @_;
505		764
506	$self->{timeout} = $timeout;	765	$self->{$timeout} = $new_value;
507	$self->_timeout;	766	delete $self->{$tw}; &$cb;
508	}	767	};
509		768
		769	*{"${dir}timeout_reset"} = sub {
		770	$_[0]{$activity} = AE::now;
		771	};
		772
		773	# main workhorse:
510	# reset the timeout watcher, as neccessary	774	# reset the timeout watcher, as neccessary
511	# also check for time-outs	775	# also check for time-outs
512	sub _timeout {	776	$cb = sub {
513	my ($self) = @_;	777	my ($self) = @_;
514		778
515	if ($self->{timeout}) {	779	if ($self->{$timeout} && $self->{fh}) {
516	my $NOW = AnyEvent->now;	780	my $NOW = AE::now;
517		781
518	# when would the timeout trigger?	782	# when would the timeout trigger?
519	my $after = $self->{_activity} + $self->{timeout} - $NOW;	783	my $after = $self->{$activity} + $self->{$timeout} - $NOW;
520		784
521	# now or in the past already?	785	# now or in the past already?
522	if ($after <= 0) {	786	if ($after <= 0) {
523	$self->{_activity} = $NOW;	787	$self->{$activity} = $NOW;
524		788
525	if ($self->{on_timeout}) {	789	if ($self->{$on_timeout}) {
526	$self->{on_timeout}($self);	790	$self->{$on_timeout}($self);
527	} else {	791	} else {
528	$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};
529	}	800	}
530		801
531	# callback could have changed timeout value, optimise	802	Scalar::Util::weaken $self;
532	return unless $self->{timeout};	803	return unless $self; # ->error could have destroyed $self
533		804
534	# calculate new after	805	$self->{$tw} \|\|= AE::timer $after, 0, sub {
535	$after = $self->{timeout};	806	delete $self->{$tw};
		807	$cb->($self);
		808	};
		809	} else {
		810	delete $self->{$tw};
536	}	811	}
537
538	Scalar::Util::weaken $self;
539	return unless $self; # ->error could have destroyed $self
540
541	$self->{_tw} \|\|= AnyEvent->timer (after => $after, cb => sub {
542	delete $self->{_tw};
543	$self->_timeout;
544	});
545	} else {
546	delete $self->{_tw};
547	}	812	}
548	}	813	}
549		814
550	#############################################################################	815	#############################################################################
551		816
…		…
599	my $len = syswrite $self->{fh}, $self->{wbuf};	864	my $len = syswrite $self->{fh}, $self->{wbuf};
600		865
601	if (defined $len) {	866	if (defined $len) {
602	substr $self->{wbuf}, 0, $len, "";	867	substr $self->{wbuf}, 0, $len, "";
603		868
604	$self->{_activity} = AnyEvent->now;	869	$self->{_activity} = $self->{_wactivity} = AE::now;
605		870
606	$self->{on_drain}($self)	871	$self->{on_drain}($self)
607	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})
608	&& $self->{on_drain};	873	&& $self->{on_drain};
609		874
…		…
615		880
616	# try to write data immediately	881	# try to write data immediately
617	$cb->() unless $self->{autocork};	882	$cb->() unless $self->{autocork};
618		883
619	# if still data left in wbuf, we need to poll	884	# if still data left in wbuf, we need to poll
620	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	885	$self->{_ww} = AE::io $self->{fh}, 1, $cb
621	if length $self->{wbuf};	886	if length $self->{wbuf};
622	};	887	};
623	}	888	}
624		889
625	our %WH;	890	our %WH;
626		891
		892	# deprecated
627	sub register_write_type($$) {	893	sub register_write_type($$) {
628	$WH{$_[0]} = $_[1];	894	$WH{$_[0]} = $_[1];
629	}	895	}
630		896
631	sub push_write {	897	sub push_write {
632	my $self = shift;	898	my $self = shift;
633		899
634	if (@_ > 1) {	900	if (@_ > 1) {
635	my $type = shift;	901	my $type = shift;
636		902
		903	@_ = ($WH{$type} \|\|= _load_func "$type\::anyevent_write_type"
637	@_ = ($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")
638	->($self, @_);	905	->($self, @_);
639	}	906	}
640		907
641	if ($self->{tls}) {	908	if ($self->{tls}) {
642	$self->{_tls_wbuf} .= $_[0];	909	$self->{_tls_wbuf} .= $_[0];
643		910	&_dotls ($self) if $self->{fh};
644	&_dotls ($self);
645	} else {	911	} else {
646	$self->{wbuf} .= $_[0];	912	$self->{wbuf} .= $_[0];
647	$self->_drain_wbuf;	913	$self->_drain_wbuf if $self->{fh};
648	}	914	}
649	}	915	}
650		916
651	=item $handle->push_write (type => @args)	917	=item $handle->push_write (type => @args)
652		918
653	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
654	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).
655		924
656	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
657	drop by and tell us):	926	drop by and tell us):
658		927
659	=over 4	928	=over 4
…		…
716	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
717	this line into their JSON decoder of choice.	986	this line into their JSON decoder of choice.
718		987
719	=cut	988	=cut
720		989
		990	sub json_coder() {
		991	eval { require JSON::XS; JSON::XS->new->utf8 }
		992	\|\| do { require JSON; JSON->new->utf8 }
		993	}
		994
721	register_write_type json => sub {	995	register_write_type json => sub {
722	my ($self, $ref) = @_;	996	my ($self, $ref) = @_;
723		997
724	require JSON;	998	my $json = $self->{json} \|\|= json_coder;
725		999
726	$self->{json} ? $self->{json}->encode ($ref)	1000	$json->encode ($ref)
727	: JSON::encode_json ($ref)
728	};	1001	};
729		1002
730	=item storable => $reference	1003	=item storable => $reference
731		1004
732	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
…		…
767		1040
768	delete $self->{low_water_mark};	1041	delete $self->{low_water_mark};
769	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });	1042	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });
770	}	1043	}
771		1044
772	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	1045	=item custom write types - Package::anyevent_write_type $handle, @args
773		1046
774	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
775	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
776	reference with the handle object and the remaining arguments.	1054	the handle object and the remaining arguments.
777		1055
778	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
779	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.
780		1059
781	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
782	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	}
783		1076
784	=cut	1077	=cut
785		1078
786	#############################################################################	1079	#############################################################################
787		1080
…		…
869	=cut	1162	=cut
870		1163
871	sub _drain_rbuf {	1164	sub _drain_rbuf {
872	my ($self) = @_;	1165	my ($self) = @_;
873		1166
		1167	# avoid recursion
		1168	return if $self->{_skip_drain_rbuf};
874	local $self->{_in_drain} = 1;	1169	local $self->{_skip_drain_rbuf} = 1;
875
876	if (
877	defined $self->{rbuf_max}
878	&& $self->{rbuf_max} < length $self->{rbuf}
879	) {
880	$self->_error (Errno::ENOSPC, 1), return;
881	}
882		1170
883	while () {	1171	while () {
884	# 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
885	# 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.
886	$self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf};	1174	$self->{rbuf} .= delete $self->{_tls_rbuf}
		1175	if exists $self->{_tls_rbuf};
887		1176
888	my $len = length $self->{rbuf};	1177	my $len = length $self->{rbuf};
889		1178
890	if (my $cb = shift @{ $self->{_queue} }) {	1179	if (my $cb = shift @{ $self->{_queue} }) {
891	unless ($cb->($self)) {	1180	unless ($cb->($self)) {
892	if ($self->{_eof}) {	1181	# no progress can be made
893	# no progress can be made (not enough data and no data forthcoming)	1182	# (not enough data and no data forthcoming)
894	$self->_error (Errno::EPIPE, 1), return;	1183	$self->_error (Errno::EPIPE, 1), return
895	}	1184	if $self->{_eof};
896		1185
897	unshift @{ $self->{_queue} }, $cb;	1186	unshift @{ $self->{_queue} }, $cb;
898	last;	1187	last;
899	}	1188	}
900	} elsif ($self->{on_read}) {	1189	} elsif ($self->{on_read}) {
…		…
920	last;	1209	last;
921	}	1210	}
922	}	1211	}
923		1212
924	if ($self->{_eof}) {	1213	if ($self->{_eof}) {
925	if ($self->{on_eof}) {	1214	$self->{on_eof}
926	$self->{on_eof}($self)	1215	? $self->{on_eof}($self)
927	} else {
928	$self->_error (0, 1, "Unexpected end-of-file");	1216	: $self->_error (0, 1, "Unexpected end-of-file");
929	}	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;
930	}	1226	}
931		1227
932	# may need to restart read watcher	1228	# may need to restart read watcher
933	unless ($self->{_rw}) {	1229	unless ($self->{_rw}) {
934	$self->start_read	1230	$self->start_read
…		…
946		1242
947	sub on_read {	1243	sub on_read {
948	my ($self, $cb) = @_;	1244	my ($self, $cb) = @_;
949		1245
950	$self->{on_read} = $cb;	1246	$self->{on_read} = $cb;
951	$self->_drain_rbuf if $cb && !$self->{_in_drain};	1247	$self->_drain_rbuf if $cb;
952	}	1248	}
953		1249
954	=item $handle->rbuf	1250	=item $handle->rbuf
955		1251
956	Returns the read buffer (as a modifiable lvalue).	1252	Returns the read buffer (as a modifiable lvalue).
…		…
1003	my $cb = pop;	1299	my $cb = pop;
1004		1300
1005	if (@_) {	1301	if (@_) {
1006	my $type = shift;	1302	my $type = shift;
1007		1303
		1304	$cb = ($RH{$type} \|\|= _load_func "$type\::anyevent_read_type"
1008	$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")
1009	->($self, $cb, @_);	1306	->($self, $cb, @_);
1010	}	1307	}
1011		1308
1012	push @{ $self->{_queue} }, $cb;	1309	push @{ $self->{_queue} }, $cb;
1013	$self->_drain_rbuf unless $self->{_in_drain};	1310	$self->_drain_rbuf;
1014	}	1311	}
1015		1312
1016	sub unshift_read {	1313	sub unshift_read {
1017	my $self = shift;	1314	my $self = shift;
1018	my $cb = pop;	1315	my $cb = pop;
…		…
1022		1319
1023	$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")
1024	->($self, $cb, @_);	1321	->($self, $cb, @_);
1025	}	1322	}
1026		1323
1027
1028	unshift @{ $self->{_queue} }, $cb;	1324	unshift @{ $self->{_queue} }, $cb;
1029	$self->_drain_rbuf unless $self->{_in_drain};	1325	$self->_drain_rbuf;
1030	}	1326	}
1031		1327
1032	=item $handle->push_read (type => @args, $cb)	1328	=item $handle->push_read (type => @args, $cb)
1033		1329
1034	=item $handle->unshift_read (type => @args, $cb)	1330	=item $handle->unshift_read (type => @args, $cb)
1035		1331
1036	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
1037	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
1038	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).
1039		1337
1040	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
1041	drop by and tell us):	1339	drop by and tell us):
1042		1340
1043	=over 4	1341	=over 4
…		…
1283	=cut	1581	=cut
1284		1582
1285	register_read_type json => sub {	1583	register_read_type json => sub {
1286	my ($self, $cb) = @_;	1584	my ($self, $cb) = @_;
1287		1585
1288	my $json = $self->{json} \|\|=	1586	my $json = $self->{json} \|\|= json_coder;
1289	eval { require JSON::XS; JSON::XS->new->utf8 }
1290	\|\| do { require JSON; JSON->new->utf8 };
1291		1587
1292	my $data;	1588	my $data;
1293	my $rbuf = \$self->{rbuf};	1589	my $rbuf = \$self->{rbuf};
1294		1590
1295	sub {	1591	sub {
…		…
1364	}	1660	}
1365	};	1661	};
1366		1662
1367	=back	1663	=back
1368		1664
1369	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)	1665	=item custom read types - Package::anyevent_read_type $handle, $cb, @args
1370		1666
1371	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).
1372		1672
1373	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
1374	reference with the handle object, the callback and the remaining	1674	handle object, the original callback and the remaining arguments.
1375	arguments.
1376		1675
1377	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
1378	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.
1379		1680
1380	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
1381	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).
1382		1684
1383	Note that this is a function, and all types registered this way will be
1384	global, so try to use unique names.
1385
1386	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
1387	search for C<register_read_type>)).	1686	AnyEvent::Handle>, search for C<register_read_type>)).
1388		1687
1389	=item $handle->stop_read	1688	=item $handle->stop_read
1390		1689
1391	=item $handle->start_read	1690	=item $handle->start_read
1392		1691
…		…
1415	my ($self) = @_;	1714	my ($self) = @_;
1416		1715
1417	unless ($self->{_rw} \|\| $self->{_eof}) {	1716	unless ($self->{_rw} \|\| $self->{_eof}) {
1418	Scalar::Util::weaken $self;	1717	Scalar::Util::weaken $self;
1419		1718
1420	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1719	$self->{_rw} = AE::io $self->{fh}, 0, sub {
1421	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});	1720	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1422	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;
1423		1722
1424	if ($len > 0) {	1723	if ($len > 0) {
1425	$self->{_activity} = AnyEvent->now;	1724	$self->{_activity} = $self->{_ractivity} = AE::now;
1426		1725
1427	if ($self->{tls}) {	1726	if ($self->{tls}) {
1428	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);	1727	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1429		1728
1430	&_dotls ($self);	1729	&_dotls ($self);
1431	} else {	1730	} else {
1432	$self->_drain_rbuf unless $self->{_in_drain};	1731	$self->_drain_rbuf;
1433	}	1732	}
1434		1733
1435	} elsif (defined $len) {	1734	} elsif (defined $len) {
1436	delete $self->{_rw};	1735	delete $self->{_rw};
1437	$self->{_eof} = 1;	1736	$self->{_eof} = 1;
1438	$self->_drain_rbuf unless $self->{_in_drain};	1737	$self->_drain_rbuf;
1439		1738
1440	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1739	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1441	return $self->_error ($!, 1);	1740	return $self->_error ($!, 1);
1442	}	1741	}
1443	});	1742	};
1444	}	1743	}
1445	}	1744	}
1446		1745
1447	our $ERROR_SYSCALL;	1746	our $ERROR_SYSCALL;
1448	our $ERROR_WANT_READ;	1747	our $ERROR_WANT_READ;
…		…
1503	$self->{_eof} = 1;	1802	$self->{_eof} = 1;
1504	}	1803	}
1505	}	1804	}
1506		1805
1507	$self->{_tls_rbuf} .= $tmp;	1806	$self->{_tls_rbuf} .= $tmp;
1508	$self->_drain_rbuf unless $self->{_in_drain};	1807	$self->_drain_rbuf;
1509	$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
1510	}	1809	}
1511		1810
1512	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);	1811	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1513	return $self->_tls_error ($tmp)	1812	return $self->_tls_error ($tmp)
…		…
1545	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
1546	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
1547	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
1548	when this function returns.	1847	when this function returns.
1549		1848
1550	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
1551	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.
1552		1852
1553	=cut	1853	=cut
1554		1854
1555	our %TLS_CACHE; #TODO not yet documented, should we?	1855	our %TLS_CACHE; #TODO not yet documented, should we?
1556		1856
1557	sub starttls {	1857	sub starttls {
1558	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};
1559		1867
1560	require Net::SSLeay;	1868	require Net::SSLeay;
1561
1562	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"
1563	if $self->{tls};
1564		1869
1565	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();	1870	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1566	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();	1871	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1567		1872
		1873	$tls = delete $self->{tls};
1568	$ctx \|\|= $self->{tls_ctx};	1874	$ctx = $self->{tls_ctx};
1569		1875
1570	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session	1876	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
1571		1877
1572	if ("HASH" eq ref $ctx) {	1878	if ("HASH" eq ref $ctx) {
1573	require AnyEvent::TLS;	1879	require AnyEvent::TLS;
…		…
1579	$ctx = new AnyEvent::TLS %$ctx;	1885	$ctx = new AnyEvent::TLS %$ctx;
1580	}	1886	}
1581	}	1887	}
1582		1888
1583	$self->{tls_ctx} = $ctx \|\| TLS_CTX ();	1889	$self->{tls_ctx} = $ctx \|\| TLS_CTX ();
1584	$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});
1585		1891
1586	# 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)
1587	# but the openssl maintainers basically said: "trust us, it just works".	1893	# but the openssl maintainers basically said: "trust us, it just works".
1588	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1894	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1589	# and mismaintained ssleay-module doesn't even offer them).	1895	# and mismaintained ssleay-module doesn't even offer them).
…		…
1596	# 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
1597	# have identity issues in that area.	1903	# have identity issues in that area.
1598	# Net::SSLeay::CTX_set_mode ($ssl,	1904	# Net::SSLeay::CTX_set_mode ($ssl,
1599	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1905	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
1600	# \| (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));
1601	Net::SSLeay::CTX_set_mode ($ssl, 1\|2);	1907	Net::SSLeay::CTX_set_mode ($tls, 1\|2);
1602		1908
1603	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1909	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1604	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1910	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1605		1911
		1912	Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf});
		1913
1606	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1914	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
1607		1915
1608	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }	1916	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1609	if $self->{on_starttls};	1917	if $self->{on_starttls};
1610		1918
1611	&_dotls; # need to trigger the initial handshake	1919	&_dotls; # need to trigger the initial handshake
…		…
1614		1922
1615	=item $handle->stoptls	1923	=item $handle->stoptls
1616		1924
1617	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
1618	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
1619	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
1620	afterwards.	1928	the stream afterwards.
1621		1929
1622	=cut	1930	=cut
1623		1931
1624	sub stoptls {	1932	sub stoptls {
1625	my ($self) = @_;	1933	my ($self) = @_;
…		…
1638	sub _freetls {	1946	sub _freetls {
1639	my ($self) = @_;	1947	my ($self) = @_;
1640		1948
1641	return unless $self->{tls};	1949	return unless $self->{tls};
1642		1950
1643	$self->{tls_ctx}->_put_session (delete $self->{tls});	1951	$self->{tls_ctx}->_put_session (delete $self->{tls})
		1952	if $self->{tls} > 0;
1644		1953
1645	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};	1954	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1646	}	1955	}
1647		1956
1648	sub DESTROY {	1957	sub DESTROY {
…		…
1656	my $fh = delete $self->{fh};	1965	my $fh = delete $self->{fh};
1657	my $wbuf = delete $self->{wbuf};	1966	my $wbuf = delete $self->{wbuf};
1658		1967
1659	my @linger;	1968	my @linger;
1660		1969
1661	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {	1970	push @linger, AE::io $fh, 1, sub {
1662	my $len = syswrite $fh, $wbuf, length $wbuf;	1971	my $len = syswrite $fh, $wbuf, length $wbuf;
1663		1972
1664	if ($len > 0) {	1973	if ($len > 0) {
1665	substr $wbuf, 0, $len, "";	1974	substr $wbuf, 0, $len, "";
1666	} else {	1975	} else {
1667	@linger = (); # end	1976	@linger = (); # end
1668	}	1977	}
1669	});	1978	};
1670	push @linger, AnyEvent->timer (after => $linger, cb => sub {	1979	push @linger, AE::timer $linger, 0, sub {
1671	@linger = ();	1980	@linger = ();
1672	});	1981	};
1673	}	1982	}
1674	}	1983	}
1675		1984
1676	=item $handle->destroy	1985	=item $handle->destroy
1677		1986
1678	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
1679	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
1680	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).
1681		1992
1682	Normally, you can just "forget" any references to an AnyEvent::Handle	1993	Normally, you can just "forget" any references to an AnyEvent::Handle
1683	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
1684	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
1685	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
…		…
1699	sub destroy {	2010	sub destroy {
1700	my ($self) = @_;	2011	my ($self) = @_;
1701		2012
1702	$self->DESTROY;	2013	$self->DESTROY;
1703	%$self = ();	2014	%$self = ();
		2015	bless $self, "AnyEvent::Handle::destroyed";
		2016	}
		2017
		2018	sub AnyEvent::Handle::destroyed::AUTOLOAD {
		2019	#nop
1704	}	2020	}
1705		2021
1706	=item AnyEvent::Handle::TLS_CTX	2022	=item AnyEvent::Handle::TLS_CTX
1707		2023
1708	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.158 by root, Fri Jul 24 08:40:35 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.158 by root, Fri Jul 24 08:40:35 2009 UTC vs.
Revision 1.187 by root, Tue Sep 8 00:01:12 2009 UTC