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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.149 by root, Thu Jul 16 03:48:33 2009 UTC vs.
Revision 1.184 by root, Thu Sep 3 13:14:38 2009 UTC

…		…
1	package AnyEvent::Handle;
2
3	no warnings;
4	use strict qw(subs vars);
5
6	use AnyEvent ();
7	use AnyEvent::Util qw(WSAEWOULDBLOCK);
8	use Scalar::Util ();
9	use Carp ();
10	use Fcntl ();
11	use Errno qw(EAGAIN EINTR);
12
13	=head1 NAME	1	=head1 NAME
14		2
15	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent	3	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent
16
17	=cut
18
19	our $VERSION = 4.82;
20		4
21	=head1 SYNOPSIS	5	=head1 SYNOPSIS
22		6
23	use AnyEvent;	7	use AnyEvent;
24	use AnyEvent::Handle;	8	use AnyEvent::Handle;
26	my $cv = AnyEvent->condvar;	10	my $cv = AnyEvent->condvar;
27		11
28	my $hdl; $hdl = new AnyEvent::Handle	12	my $hdl; $hdl = new AnyEvent::Handle
29	fh => \*STDIN,	13	fh => \*STDIN,
30	on_error => sub {	14	on_error => sub {
		15	my ($hdl, $fatal, $msg) = @_;
31	warn "got error $_[2]\n";	16	warn "got error $msg\n";
		17	$hdl->destroy;
32	$cv->send;	18	$cv->send;
33	);	19	);
34		20
35	# send some request line	21	# send some request line
36	$hdl->push_write ("getinfo\015\012");	22	$hdl->push_write ("getinfo\015\012");
…		…
45	$cv->recv;	31	$cv->recv;
46		32
47	=head1 DESCRIPTION	33	=head1 DESCRIPTION
48		34
49	This module is a helper module to make it easier to do event-based I/O on	35	This module is a helper module to make it easier to do event-based I/O on
50	filehandles. For utility functions for doing non-blocking connects and accepts	36	filehandles.
51	on sockets see L<AnyEvent::Util>.
52		37
53	The L<AnyEvent::Intro> tutorial contains some well-documented	38	The L<AnyEvent::Intro> tutorial contains some well-documented
54	AnyEvent::Handle examples.	39	AnyEvent::Handle examples.
55		40
56	In the following, when the documentation refers to of "bytes" then this	41	In the following, when the documentation refers to of "bytes" then this
57	means characters. As sysread and syswrite are used for all I/O, their	42	means characters. As sysread and syswrite are used for all I/O, their
58	treatment of characters applies to this module as well.	43	treatment of characters applies to this module as well.
59		44
		45	At the very minimum, you should specify C<fh> or C<connect>, and the
		46	C<on_error> callback.
		47
60	All callbacks will be invoked with the handle object as their first	48	All callbacks will be invoked with the handle object as their first
61	argument.	49	argument.
62		50
		51	=cut
		52
		53	package AnyEvent::Handle;
		54
		55	use Scalar::Util ();
		56	use List::Util ();
		57	use Carp ();
		58	use Errno qw(EAGAIN EINTR);
		59
		60	use AnyEvent (); BEGIN { AnyEvent::common_sense }
		61	use AnyEvent::Util qw(WSAEWOULDBLOCK);
		62
		63	our $VERSION = $AnyEvent::VERSION;
		64
63	=head1 METHODS	65	=head1 METHODS
64		66
65	=over 4	67	=over 4
66		68
67	=item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value...	69	=item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value...
68		70
69	The constructor supports these arguments (all as C<< key => value >> pairs).	71	The constructor supports these arguments (all as C<< key => value >> pairs).
70		72
71	=over 4	73	=over 4
72		74
73	=item fh => $filehandle [MANDATORY]	75	=item fh => $filehandle [C<fh> or C<connect> MANDATORY]
74		76
75	The filehandle this L<AnyEvent::Handle> object will operate on.	77	The filehandle this L<AnyEvent::Handle> object will operate on.
76
77	NOTE: The filehandle will be set to non-blocking mode (using	78	NOTE: The filehandle will be set to non-blocking mode (using
78	C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in	79	C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in
79	that mode.	80	that mode.
80		81
		82	=item connect => [$host, $service] [C<fh> or C<connect> MANDATORY]
		83
		84	Try to connect to the specified host and service (port), using
		85	C<AnyEvent::Socket::tcp_connect>. The C<$host> additionally becomes the
		86	default C<peername>.
		87
		88	You have to specify either this parameter, or C<fh>, above.
		89
		90	It is possible to push requests on the read and write queues, and modify
		91	properties of the stream, even while AnyEvent::Handle is connecting.
		92
		93	When this parameter is specified, then the C<on_prepare>,
		94	C<on_connect_error> and C<on_connect> callbacks will be called under the
		95	appropriate circumstances:
		96
		97	=over 4
		98
		99	=item on_prepare => $cb->($handle)
		100
		101	This (rarely used) callback is called before a new connection is
		102	attempted, but after the file handle has been created. It could be used to
		103	prepare the file handle with parameters required for the actual connect
		104	(as opposed to settings that can be changed when the connection is already
		105	established).
		106
		107	The return value of this callback should be the connect timeout value in
		108	seconds (or C<0>, or C<undef>, or the empty list, to indicate the default
		109	timeout is to be used).
		110
		111	=item on_connect => $cb->($handle, $host, $port, $retry->())
		112
		113	This callback is called when a connection has been successfully established.
		114
		115	The actual numeric host and port (the socket peername) are passed as
		116	parameters, together with a retry callback.
		117
		118	When, for some reason, the handle is not acceptable, then calling
		119	C<$retry> will continue with the next conenction target (in case of
		120	multi-homed hosts or SRV records there can be multiple connection
		121	endpoints). When it is called then the read and write queues, eof status,
		122	tls status and similar properties of the handle are being reset.
		123
		124	In most cases, ignoring the C<$retry> parameter is the way to go.
		125
		126	=item on_connect_error => $cb->($handle, $message)
		127
		128	This callback is called when the conenction could not be
		129	established. C<$!> will contain the relevant error code, and C<$message> a
		130	message describing it (usually the same as C<"$!">).
		131
		132	If this callback isn't specified, then C<on_error> will be called with a
		133	fatal error instead.
		134
		135	=back
		136
		137	=item on_error => $cb->($handle, $fatal, $message)
		138
		139	This is the error callback, which is called when, well, some error
		140	occured, such as not being able to resolve the hostname, failure to
		141	connect or a read error.
		142
		143	Some errors are fatal (which is indicated by C<$fatal> being true). On
		144	fatal errors the handle object will be destroyed (by a call to C<< ->
		145	destroy >>) after invoking the error callback (which means you are free to
		146	examine the handle object). Examples of fatal errors are an EOF condition
		147	with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors. In
		148	cases where the other side can close the connection at their will it is
		149	often easiest to not report C<EPIPE> errors in this callback.
		150
		151	AnyEvent::Handle tries to find an appropriate error code for you to check
		152	against, but in some cases (TLS errors), this does not work well. It is
		153	recommended to always output the C<$message> argument in human-readable
		154	error messages (it's usually the same as C<"$!">).
		155
		156	Non-fatal errors can be retried by simply returning, but it is recommended
		157	to simply ignore this parameter and instead abondon the handle object
		158	when this callback is invoked. Examples of non-fatal errors are timeouts
		159	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
		160
		161	On callback entrance, the value of C<$!> contains the operating system
		162	error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
		163	C<EPROTO>).
		164
		165	While not mandatory, it is I<highly> recommended to set this callback, as
		166	you will not be notified of errors otherwise. The default simply calls
		167	C<croak>.
		168
		169	=item on_read => $cb->($handle)
		170
		171	This sets the default read callback, which is called when data arrives
		172	and no read request is in the queue (unlike read queue callbacks, this
		173	callback will only be called when at least one octet of data is in the
		174	read buffer).
		175
		176	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
		177	method or access the C<< $handle->{rbuf} >> member directly. Note that you
		178	must not enlarge or modify the read buffer, you can only remove data at
		179	the beginning from it.
		180
		181	When an EOF condition is detected then AnyEvent::Handle will first try to
		182	feed all the remaining data to the queued callbacks and C<on_read> before
		183	calling the C<on_eof> callback. If no progress can be made, then a fatal
		184	error will be raised (with C<$!> set to C<EPIPE>).
		185
		186	Note that, unlike requests in the read queue, an C<on_read> callback
		187	doesn't mean you I<require> some data: if there is an EOF and there
		188	are outstanding read requests then an error will be flagged. With an
		189	C<on_read> callback, the C<on_eof> callback will be invoked.
		190
81	=item on_eof => $cb->($handle)	191	=item on_eof => $cb->($handle)
82		192
83	Set the callback to be called when an end-of-file condition is detected,	193	Set the callback to be called when an end-of-file condition is detected,
84	i.e. in the case of a socket, when the other side has closed the	194	i.e. in the case of a socket, when the other side has closed the
85	connection cleanly.	195	connection cleanly, and there are no outstanding read requests in the
		196	queue (if there are read requests, then an EOF counts as an unexpected
		197	connection close and will be flagged as an error).
86		198
87	For sockets, this just means that the other side has stopped sending data,	199	For sockets, this just means that the other side has stopped sending data,
88	you can still try to write data, and, in fact, one can return from the EOF	200	you can still try to write data, and, in fact, one can return from the EOF
89	callback and continue writing data, as only the read part has been shut	201	callback and continue writing data, as only the read part has been shut
90	down.	202	down.
91		203
92	While not mandatory, it is I<highly> recommended to set an EOF callback,
93	otherwise you might end up with a closed socket while you are still
94	waiting for data.
95
96	If an EOF condition has been detected but no C<on_eof> callback has been	204	If an EOF condition has been detected but no C<on_eof> callback has been
97	set, then a fatal error will be raised with C<$!> set to <0>.	205	set, then a fatal error will be raised with C<$!> set to <0>.
98
99	=item on_error => $cb->($handle, $fatal, $message)
100
101	This is the error callback, which is called when, well, some error
102	occured, such as not being able to resolve the hostname, failure to
103	connect or a read error.
104
105	Some errors are fatal (which is indicated by C<$fatal> being true). On
106	fatal errors the handle object will be destroyed (by a call to C<< ->
107	destroy >>) after invoking the error callback (which means you are free to
108	examine the handle object). Examples of fatal errors are an EOF condition
109	with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors.
110
111	AnyEvent::Handle tries to find an appropriate error code for you to check
112	against, but in some cases (TLS errors), this does not work well. It is
113	recommended to always output the C<$message> argument in human-readable
114	error messages (it's usually the same as C<"$!">).
115
116	Non-fatal errors can be retried by simply returning, but it is recommended
117	to simply ignore this parameter and instead abondon the handle object
118	when this callback is invoked. Examples of non-fatal errors are timeouts
119	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
120
121	On callback entrance, the value of C<$!> contains the operating system
122	error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
123	C<EPROTO>).
124
125	While not mandatory, it is I<highly> recommended to set this callback, as
126	you will not be notified of errors otherwise. The default simply calls
127	C<croak>.
128
129	=item on_read => $cb->($handle)
130
131	This sets the default read callback, which is called when data arrives
132	and no read request is in the queue (unlike read queue callbacks, this
133	callback will only be called when at least one octet of data is in the
134	read buffer).
135
136	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
137	method or access the C<< $handle->{rbuf} >> member directly. Note that you
138	must not enlarge or modify the read buffer, you can only remove data at
139	the beginning from it.
140
141	When an EOF condition is detected then AnyEvent::Handle will first try to
142	feed all the remaining data to the queued callbacks and C<on_read> before
143	calling the C<on_eof> callback. If no progress can be made, then a fatal
144	error will be raised (with C<$!> set to C<EPIPE>).
145		206
146	=item on_drain => $cb->($handle)	207	=item on_drain => $cb->($handle)
147		208
148	This sets the callback that is called when the write buffer becomes empty	209	This sets the callback that is called when the write buffer becomes empty
149	(or when the callback is set and the buffer is empty already).	210	(or when the callback is set and the buffer is empty already).
…		…
156	memory and push it into the queue, but instead only read more data from	217	memory and push it into the queue, but instead only read more data from
157	the file when the write queue becomes empty.	218	the file when the write queue becomes empty.
158		219
159	=item timeout => $fractional_seconds	220	=item timeout => $fractional_seconds
160		221
		222	=item rtimeout => $fractional_seconds
		223
		224	=item wtimeout => $fractional_seconds
		225
161	If non-zero, then this enables an "inactivity" timeout: whenever this many	226	If non-zero, then these enables an "inactivity" timeout: whenever this
162	seconds pass without a successful read or write on the underlying file	227	many seconds pass without a successful read or write on the underlying
163	handle, the C<on_timeout> callback will be invoked (and if that one is	228	file handle (or a call to C<timeout_reset>), the C<on_timeout> callback
164	missing, a non-fatal C<ETIMEDOUT> error will be raised).	229	will be invoked (and if that one is missing, a non-fatal C<ETIMEDOUT>
		230	error will be raised).
		231
		232	There are three variants of the timeouts that work fully independent
		233	of each other, for both read and write, just read, and just write:
		234	C<timeout>, C<rtimeout> and C<wtimeout>, with corresponding callbacks
		235	C<on_timeout>, C<on_rtimeout> and C<on_wtimeout>, and reset functions
		236	C<timeout_reset>, C<rtimeout_reset>, and C<wtimeout_reset>.
165		237
166	Note that timeout processing is also active when you currently do not have	238	Note that timeout processing is also active when you currently do not have
167	any outstanding read or write requests: If you plan to keep the connection	239	any outstanding read or write requests: If you plan to keep the connection
168	idle then you should disable the timout temporarily or ignore the timeout	240	idle then you should disable the timout temporarily or ignore the timeout
169	in the C<on_timeout> callback, in which case AnyEvent::Handle will simply	241	in the C<on_timeout> callback, in which case AnyEvent::Handle will simply
…		…
213	accomplishd by setting this option to a true value.	285	accomplishd by setting this option to a true value.
214		286
215	The default is your opertaing system's default behaviour (most likely	287	The default is your opertaing system's default behaviour (most likely
216	enabled), this option explicitly enables or disables it, if possible.	288	enabled), this option explicitly enables or disables it, if possible.
217		289
		290	=item keepalive => <boolean>
		291
		292	Enables (default disable) the SO_KEEPALIVE option on the stream socket:
		293	normally, TCP connections have no time-out once established, so TCP
		294	conenctions, once established, can stay alive forever even when the other
		295	side has long gone. TCP keepalives are a cheap way to take down long-lived
		296	TCP connections whent he other side becomes unreachable. While the default
		297	is OS-dependent, TCP keepalives usually kick in after around two hours,
		298	and, if the other side doesn't reply, take down the TCP connection some 10
		299	to 15 minutes later.
		300
		301	It is harmless to specify this option for file handles that do not support
		302	keepalives, and enabling it on connections that are potentially long-lived
		303	is usually a good idea.
		304
		305	=item oobinline => <boolean>
		306
		307	BSD majorly fucked up the implementation of TCP urgent data. The result
		308	is that almost no OS implements TCP according to the specs, and every OS
		309	implements it slightly differently.
		310
		311	If you want to handle TCP urgent data, then setting this flag (the default
		312	is enabled) gives you the most portable way of getting urgent data, by
		313	putting it into the stream.
		314
		315	Since BSD emulation of OOB data on top of TCP's urgent data can have
		316	security implications, AnyEvent::Handle sets this flag automatically
		317	unless explicitly specified. Note that setting this flag after
		318	establishing a connection I<may> be a bit too late (data loss could
		319	already have occured on BSD systems), but at least it will protect you
		320	from most attacks.
		321
218	=item read_size => <bytes>	322	=item read_size => <bytes>
219		323
220	The default read block size (the amount of bytes this module will	324	The default read block size (the amount of bytes this module will
221	try to read during each loop iteration, which affects memory	325	try to read during each loop iteration, which affects memory
222	requirements). Default: C<8192>.	326	requirements). Default: C<8192>.
…		…
348		452
349	sub new {	453	sub new {
350	my $class = shift;	454	my $class = shift;
351	my $self = bless { @_ }, $class;	455	my $self = bless { @_ }, $class;
352		456
353	$self->{fh} or Carp::croak "mandatory argument fh is missing";	457	if ($self->{fh}) {
		458	$self->_start;
		459	return unless $self->{fh}; # could be gone by now
		460
		461	} elsif ($self->{connect}) {
		462	require AnyEvent::Socket;
		463
		464	$self->{peername} = $self->{connect}[0]
		465	unless exists $self->{peername};
		466
		467	$self->{_skip_drain_rbuf} = 1;
		468
		469	{
		470	Scalar::Util::weaken (my $self = $self);
		471
		472	$self->{_connect} =
		473	AnyEvent::Socket::tcp_connect (
		474	$self->{connect}[0],
		475	$self->{connect}[1],
		476	sub {
		477	my ($fh, $host, $port, $retry) = @_;
		478
		479	if ($fh) {
		480	$self->{fh} = $fh;
		481
		482	delete $self->{_skip_drain_rbuf};
		483	$self->_start;
		484
		485	$self->{on_connect}
		486	and $self->{on_connect}($self, $host, $port, sub {
		487	delete @$self{qw(fh _tw _rtw _wtw _ww _rw _eof _queue rbuf _wbuf tls _tls_rbuf _tls_wbuf)};
		488	$self->{_skip_drain_rbuf} = 1;
		489	&$retry;
		490	});
		491
		492	} else {
		493	if ($self->{on_connect_error}) {
		494	$self->{on_connect_error}($self, "$!");
		495	$self->destroy;
		496	} else {
		497	$self->_error ($!, 1);
		498	}
		499	}
		500	},
		501	sub {
		502	local $self->{fh} = $_[0];
		503
		504	$self->{on_prepare}
		505	? $self->{on_prepare}->($self)
		506	: ()
		507	}
		508	);
		509	}
		510
		511	} else {
		512	Carp::croak "AnyEvent::Handle: either an existing fh or the connect parameter must be specified";
		513	}
		514
		515	$self
		516	}
		517
		518	sub _start {
		519	my ($self) = @_;
354		520
355	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	521	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
356		522
		523	$self->{_activity} =
		524	$self->{_ractivity} =
357	$self->{_activity} = AnyEvent->now;	525	$self->{_wactivity} = AE::now;
358	$self->_timeout;
359		526
		527	$self->timeout (delete $self->{timeout} ) if $self->{timeout};
		528	$self->rtimeout (delete $self->{rtimeout} ) if $self->{rtimeout};
		529	$self->wtimeout (delete $self->{wtimeout} ) if $self->{wtimeout};
		530
360	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};	531	$self->no_delay (delete $self->{no_delay} ) if exists $self->{no_delay} && $self->{no_delay};
		532	$self->keepalive (delete $self->{keepalive}) if exists $self->{keepalive} && $self->{keepalive};
361		533
		534	$self->oobinline (exists $self->{oobinline} ? delete $self->{oobinline} : 1);
		535
362	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})	536	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
363	if $self->{tls};	537	if $self->{tls};
364		538
365	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	539	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
366		540
367	$self->start_read	541	$self->start_read
368	if $self->{on_read};	542	if $self->{on_read} \|\| @{ $self->{_queue} };
369		543
370	$self->{fh} && $self	544	$self->_drain_wbuf;
371	}	545	}
372
373	#sub _shutdown {
374	# my ($self) = @_;
375	#
376	# delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)};
377	# $self->{_eof} = 1; # tell starttls et. al to stop trying
378	#
379	# &_freetls;
380	#}
381		546
382	sub _error {	547	sub _error {
383	my ($self, $errno, $fatal, $message) = @_;	548	my ($self, $errno, $fatal, $message) = @_;
384		549
385	$! = $errno;	550	$! = $errno;
386	$message \|\|= "$!";	551	$message \|\|= "$!";
387		552
388	if ($self->{on_error}) {	553	if ($self->{on_error}) {
389	$self->{on_error}($self, $fatal, $message);	554	$self->{on_error}($self, $fatal, $message);
390	$self->destroy;	555	$self->destroy if $fatal;
391	} elsif ($self->{fh}) {	556	} elsif ($self->{fh}) {
392	$self->destroy;	557	$self->destroy;
393	Carp::croak "AnyEvent::Handle uncaught error: $message";	558	Carp::croak "AnyEvent::Handle uncaught error: $message";
394	}	559	}
395	}	560	}
…		…
422	$_[0]{on_eof} = $_[1];	587	$_[0]{on_eof} = $_[1];
423	}	588	}
424		589
425	=item $handle->on_timeout ($cb)	590	=item $handle->on_timeout ($cb)
426		591
427	Replace the current C<on_timeout> callback, or disables the callback (but	592	=item $handle->on_rtimeout ($cb)
428	not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
429	argument and method.
430		593
431	=cut	594	=item $handle->on_wtimeout ($cb)
432		595
433	sub on_timeout {	596	Replace the current C<on_timeout>, C<on_rtimeout> or C<on_wtimeout>
434	$_[0]{on_timeout} = $_[1];	597	callback, or disables the callback (but not the timeout) if C<$cb> =
435	}	598	C<undef>. See the C<timeout> constructor argument and method.
		599
		600	=cut
		601
		602	# see below
436		603
437	=item $handle->autocork ($boolean)	604	=item $handle->autocork ($boolean)
438		605
439	Enables or disables the current autocork behaviour (see C<autocork>	606	Enables or disables the current autocork behaviour (see C<autocork>
440	constructor argument). Changes will only take effect on the next write.	607	constructor argument). Changes will only take effect on the next write.
…		…
455	sub no_delay {	622	sub no_delay {
456	$_[0]{no_delay} = $_[1];	623	$_[0]{no_delay} = $_[1];
457		624
458	eval {	625	eval {
459	local $SIG{__DIE__};	626	local $SIG{__DIE__};
460	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];	627	setsockopt $_[0]{fh}, Socket::IPPROTO_TCP (), Socket::TCP_NODELAY (), int $_[1]
		628	if $_[0]{fh};
		629	};
		630	}
		631
		632	=item $handle->keepalive ($boolean)
		633
		634	Enables or disables the C<keepalive> setting (see constructor argument of
		635	the same name for details).
		636
		637	=cut
		638
		639	sub keepalive {
		640	$_[0]{keepalive} = $_[1];
		641
		642	eval {
		643	local $SIG{__DIE__};
		644	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
		645	if $_[0]{fh};
		646	};
		647	}
		648
		649	=item $handle->oobinline ($boolean)
		650
		651	Enables or disables the C<oobinline> setting (see constructor argument of
		652	the same name for details).
		653
		654	=cut
		655
		656	sub oobinline {
		657	$_[0]{oobinline} = $_[1];
		658
		659	eval {
		660	local $SIG{__DIE__};
		661	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_OOBINLINE (), int $_[1]
		662	if $_[0]{fh};
		663	};
		664	}
		665
		666	=item $handle->keepalive ($boolean)
		667
		668	Enables or disables the C<keepalive> setting (see constructor argument of
		669	the same name for details).
		670
		671	=cut
		672
		673	sub keepalive {
		674	$_[0]{keepalive} = $_[1];
		675
		676	eval {
		677	local $SIG{__DIE__};
		678	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
		679	if $_[0]{fh};
461	};	680	};
462	}	681	}
463		682
464	=item $handle->on_starttls ($cb)	683	=item $handle->on_starttls ($cb)
465		684
…		…
479		698
480	sub on_starttls {	699	sub on_starttls {
481	$_[0]{on_stoptls} = $_[1];	700	$_[0]{on_stoptls} = $_[1];
482	}	701	}
483		702
		703	=item $handle->rbuf_max ($max_octets)
		704
		705	Configures the C<rbuf_max> setting (C<undef> disables it).
		706
		707	=cut
		708
		709	sub rbuf_max {
		710	$_[0]{rbuf_max} = $_[1];
		711	}
		712
484	#############################################################################	713	#############################################################################
485		714
486	=item $handle->timeout ($seconds)	715	=item $handle->timeout ($seconds)
487		716
		717	=item $handle->rtimeout ($seconds)
		718
		719	=item $handle->wtimeout ($seconds)
		720
488	Configures (or disables) the inactivity timeout.	721	Configures (or disables) the inactivity timeout.
489		722
490	=cut	723	=item $handle->timeout_reset
491		724
492	sub timeout {	725	=item $handle->rtimeout_reset
		726
		727	=item $handle->wtimeout_reset
		728
		729	Reset the activity timeout, as if data was received or sent.
		730
		731	These methods are cheap to call.
		732
		733	=cut
		734
		735	for my $dir ("", "r", "w") {
		736	my $timeout = "${dir}timeout";
		737	my $tw = "_${dir}tw";
		738	my $on_timeout = "on_${dir}timeout";
		739	my $activity = "_${dir}activity";
		740	my $cb;
		741
		742	*$on_timeout = sub {
		743	$_[0]{$on_timeout} = $_[1];
		744	};
		745
		746	*$timeout = sub {
493	my ($self, $timeout) = @_;	747	my ($self, $new_value) = @_;
494		748
495	$self->{timeout} = $timeout;	749	$self->{$timeout} = $new_value;
496	$self->_timeout;	750	delete $self->{$tw}; &$cb;
497	}	751	};
498		752
		753	*{"${dir}timeout_reset"} = sub {
		754	$_[0]{$activity} = AE::now;
		755	};
		756
		757	# main workhorse:
499	# reset the timeout watcher, as neccessary	758	# reset the timeout watcher, as neccessary
500	# also check for time-outs	759	# also check for time-outs
501	sub _timeout {	760	$cb = sub {
502	my ($self) = @_;	761	my ($self) = @_;
503		762
504	if ($self->{timeout}) {	763	if ($self->{$timeout} && $self->{fh}) {
505	my $NOW = AnyEvent->now;	764	my $NOW = AE::now;
506		765
507	# when would the timeout trigger?	766	# when would the timeout trigger?
508	my $after = $self->{_activity} + $self->{timeout} - $NOW;	767	my $after = $self->{$activity} + $self->{$timeout} - $NOW;
509		768
510	# now or in the past already?	769	# now or in the past already?
511	if ($after <= 0) {	770	if ($after <= 0) {
512	$self->{_activity} = $NOW;	771	$self->{$activity} = $NOW;
513		772
514	if ($self->{on_timeout}) {	773	if ($self->{$on_timeout}) {
515	$self->{on_timeout}($self);	774	$self->{$on_timeout}($self);
516	} else {	775	} else {
517	$self->_error (&Errno::ETIMEDOUT);	776	$self->_error (Errno::ETIMEDOUT);
		777	}
		778
		779	# callback could have changed timeout value, optimise
		780	return unless $self->{$timeout};
		781
		782	# calculate new after
		783	$after = $self->{$timeout};
518	}	784	}
519		785
520	# callback could have changed timeout value, optimise	786	Scalar::Util::weaken $self;
521	return unless $self->{timeout};	787	return unless $self; # ->error could have destroyed $self
522		788
523	# calculate new after	789	$self->{$tw} \|\|= AE::timer $after, 0, sub {
524	$after = $self->{timeout};	790	delete $self->{$tw};
		791	$cb->($self);
		792	};
		793	} else {
		794	delete $self->{$tw};
525	}	795	}
526
527	Scalar::Util::weaken $self;
528	return unless $self; # ->error could have destroyed $self
529
530	$self->{_tw} \|\|= AnyEvent->timer (after => $after, cb => sub {
531	delete $self->{_tw};
532	$self->_timeout;
533	});
534	} else {
535	delete $self->{_tw};
536	}	796	}
537	}	797	}
538		798
539	#############################################################################	799	#############################################################################
540		800
…		…
588	my $len = syswrite $self->{fh}, $self->{wbuf};	848	my $len = syswrite $self->{fh}, $self->{wbuf};
589		849
590	if (defined $len) {	850	if (defined $len) {
591	substr $self->{wbuf}, 0, $len, "";	851	substr $self->{wbuf}, 0, $len, "";
592		852
593	$self->{_activity} = AnyEvent->now;	853	$self->{_activity} = $self->{_wactivity} = AE::now;
594		854
595	$self->{on_drain}($self)	855	$self->{on_drain}($self)
596	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})	856	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
597	&& $self->{on_drain};	857	&& $self->{on_drain};
598		858
…		…
604		864
605	# try to write data immediately	865	# try to write data immediately
606	$cb->() unless $self->{autocork};	866	$cb->() unless $self->{autocork};
607		867
608	# if still data left in wbuf, we need to poll	868	# if still data left in wbuf, we need to poll
609	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	869	$self->{_ww} = AE::io $self->{fh}, 1, $cb
610	if length $self->{wbuf};	870	if length $self->{wbuf};
611	};	871	};
612	}	872	}
613		873
614	our %WH;	874	our %WH;
…		…
627	->($self, @_);	887	->($self, @_);
628	}	888	}
629		889
630	if ($self->{tls}) {	890	if ($self->{tls}) {
631	$self->{_tls_wbuf} .= $_[0];	891	$self->{_tls_wbuf} .= $_[0];
632		892	&_dotls ($self) if $self->{fh};
633	&_dotls ($self);
634	} else {	893	} else {
635	$self->{wbuf} .= $_[0];	894	$self->{wbuf} .= $_[0];
636	$self->_drain_wbuf;	895	$self->_drain_wbuf if $self->{fh};
637	}	896	}
638	}	897	}
639		898
640	=item $handle->push_write (type => @args)	899	=item $handle->push_write (type => @args)
641		900
…		…
705	Other languages could read single lines terminated by a newline and pass	964	Other languages could read single lines terminated by a newline and pass
706	this line into their JSON decoder of choice.	965	this line into their JSON decoder of choice.
707		966
708	=cut	967	=cut
709		968
		969	sub json_coder() {
		970	eval { require JSON::XS; JSON::XS->new->utf8 }
		971	\|\| do { require JSON; JSON->new->utf8 }
		972	}
		973
710	register_write_type json => sub {	974	register_write_type json => sub {
711	my ($self, $ref) = @_;	975	my ($self, $ref) = @_;
712		976
713	require JSON;	977	my $json = $self->{json} \|\|= json_coder;
714		978
715	$self->{json} ? $self->{json}->encode ($ref)	979	$json->encode ($ref)
716	: JSON::encode_json ($ref)
717	};	980	};
718		981
719	=item storable => $reference	982	=item storable => $reference
720		983
721	Freezes the given reference using L<Storable> and writes it to the	984	Freezes the given reference using L<Storable> and writes it to the
…		…
858	=cut	1121	=cut
859		1122
860	sub _drain_rbuf {	1123	sub _drain_rbuf {
861	my ($self) = @_;	1124	my ($self) = @_;
862		1125
		1126	# avoid recursion
		1127	return if $self->{_skip_drain_rbuf};
863	local $self->{_in_drain} = 1;	1128	local $self->{_skip_drain_rbuf} = 1;
864
865	if (
866	defined $self->{rbuf_max}
867	&& $self->{rbuf_max} < length $self->{rbuf}
868	) {
869	$self->_error (&Errno::ENOSPC, 1), return;
870	}
871		1129
872	while () {	1130	while () {
873	# we need to use a separate tls read buffer, as we must not receive data while	1131	# we need to use a separate tls read buffer, as we must not receive data while
874	# we are draining the buffer, and this can only happen with TLS.	1132	# we are draining the buffer, and this can only happen with TLS.
875	$self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf};	1133	$self->{rbuf} .= delete $self->{_tls_rbuf}
		1134	if exists $self->{_tls_rbuf};
876		1135
877	my $len = length $self->{rbuf};	1136	my $len = length $self->{rbuf};
878		1137
879	if (my $cb = shift @{ $self->{_queue} }) {	1138	if (my $cb = shift @{ $self->{_queue} }) {
880	unless ($cb->($self)) {	1139	unless ($cb->($self)) {
881	if ($self->{_eof}) {	1140	# no progress can be made
882	# no progress can be made (not enough data and no data forthcoming)	1141	# (not enough data and no data forthcoming)
883	$self->_error (&Errno::EPIPE, 1), return;	1142	$self->_error (Errno::EPIPE, 1), return
884	}	1143	if $self->{_eof};
885		1144
886	unshift @{ $self->{_queue} }, $cb;	1145	unshift @{ $self->{_queue} }, $cb;
887	last;	1146	last;
888	}	1147	}
889	} elsif ($self->{on_read}) {	1148	} elsif ($self->{on_read}) {
…		…
896	&& !@{ $self->{_queue} } # and the queue is still empty	1155	&& !@{ $self->{_queue} } # and the queue is still empty
897	&& $self->{on_read} # but we still have on_read	1156	&& $self->{on_read} # but we still have on_read
898	) {	1157	) {
899	# no further data will arrive	1158	# no further data will arrive
900	# so no progress can be made	1159	# so no progress can be made
901	$self->_error (&Errno::EPIPE, 1), return	1160	$self->_error (Errno::EPIPE, 1), return
902	if $self->{_eof};	1161	if $self->{_eof};
903		1162
904	last; # more data might arrive	1163	last; # more data might arrive
905	}	1164	}
906	} else {	1165	} else {
…		…
909	last;	1168	last;
910	}	1169	}
911	}	1170	}
912		1171
913	if ($self->{_eof}) {	1172	if ($self->{_eof}) {
914	if ($self->{on_eof}) {	1173	$self->{on_eof}
915	$self->{on_eof}($self)	1174	? $self->{on_eof}($self)
916	} else {
917	$self->_error (0, 1, "Unexpected end-of-file");	1175	: $self->_error (0, 1, "Unexpected end-of-file");
918	}	1176
		1177	return;
		1178	}
		1179
		1180	if (
		1181	defined $self->{rbuf_max}
		1182	&& $self->{rbuf_max} < length $self->{rbuf}
		1183	) {
		1184	$self->_error (Errno::ENOSPC, 1), return;
919	}	1185	}
920		1186
921	# may need to restart read watcher	1187	# may need to restart read watcher
922	unless ($self->{_rw}) {	1188	unless ($self->{_rw}) {
923	$self->start_read	1189	$self->start_read
…		…
935		1201
936	sub on_read {	1202	sub on_read {
937	my ($self, $cb) = @_;	1203	my ($self, $cb) = @_;
938		1204
939	$self->{on_read} = $cb;	1205	$self->{on_read} = $cb;
940	$self->_drain_rbuf if $cb && !$self->{_in_drain};	1206	$self->_drain_rbuf if $cb;
941	}	1207	}
942		1208
943	=item $handle->rbuf	1209	=item $handle->rbuf
944		1210
945	Returns the read buffer (as a modifiable lvalue).	1211	Returns the read buffer (as a modifiable lvalue).
…		…
997	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	1263	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
998	->($self, $cb, @_);	1264	->($self, $cb, @_);
999	}	1265	}
1000		1266
1001	push @{ $self->{_queue} }, $cb;	1267	push @{ $self->{_queue} }, $cb;
1002	$self->_drain_rbuf unless $self->{_in_drain};	1268	$self->_drain_rbuf;
1003	}	1269	}
1004		1270
1005	sub unshift_read {	1271	sub unshift_read {
1006	my $self = shift;	1272	my $self = shift;
1007	my $cb = pop;	1273	my $cb = pop;
…		…
1011		1277
1012	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")	1278	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")
1013	->($self, $cb, @_);	1279	->($self, $cb, @_);
1014	}	1280	}
1015		1281
1016
1017	unshift @{ $self->{_queue} }, $cb;	1282	unshift @{ $self->{_queue} }, $cb;
1018	$self->_drain_rbuf unless $self->{_in_drain};	1283	$self->_drain_rbuf;
1019	}	1284	}
1020		1285
1021	=item $handle->push_read (type => @args, $cb)	1286	=item $handle->push_read (type => @args, $cb)
1022		1287
1023	=item $handle->unshift_read (type => @args, $cb)	1288	=item $handle->unshift_read (type => @args, $cb)
…		…
1156	return 1;	1421	return 1;
1157	}	1422	}
1158		1423
1159	# reject	1424	# reject
1160	if ($reject && $$rbuf =~ $reject) {	1425	if ($reject && $$rbuf =~ $reject) {
1161	$self->_error (&Errno::EBADMSG);	1426	$self->_error (Errno::EBADMSG);
1162	}	1427	}
1163		1428
1164	# skip	1429	# skip
1165	if ($skip && $$rbuf =~ $skip) {	1430	if ($skip && $$rbuf =~ $skip) {
1166	$data .= substr $$rbuf, 0, $+[0], "";	1431	$data .= substr $$rbuf, 0, $+[0], "";
…		…
1182	my ($self, $cb) = @_;	1447	my ($self, $cb) = @_;
1183		1448
1184	sub {	1449	sub {
1185	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {	1450	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
1186	if ($_[0]{rbuf} =~ /[^0-9]/) {	1451	if ($_[0]{rbuf} =~ /[^0-9]/) {
1187	$self->_error (&Errno::EBADMSG);	1452	$self->_error (Errno::EBADMSG);
1188	}	1453	}
1189	return;	1454	return;
1190	}	1455	}
1191		1456
1192	my $len = $1;	1457	my $len = $1;
…		…
1195	my $string = $_[1];	1460	my $string = $_[1];
1196	$_[0]->unshift_read (chunk => 1, sub {	1461	$_[0]->unshift_read (chunk => 1, sub {
1197	if ($_[1] eq ",") {	1462	if ($_[1] eq ",") {
1198	$cb->($_[0], $string);	1463	$cb->($_[0], $string);
1199	} else {	1464	} else {
1200	$self->_error (&Errno::EBADMSG);	1465	$self->_error (Errno::EBADMSG);
1201	}	1466	}
1202	});	1467	});
1203	});	1468	});
1204		1469
1205	1	1470	1
…		…
1272	=cut	1537	=cut
1273		1538
1274	register_read_type json => sub {	1539	register_read_type json => sub {
1275	my ($self, $cb) = @_;	1540	my ($self, $cb) = @_;
1276		1541
1277	my $json = $self->{json} \|\|=	1542	my $json = $self->{json} \|\|= json_coder;
1278	eval { require JSON::XS; JSON::XS->new->utf8 }
1279	\|\| do { require JSON; JSON->new->utf8 };
1280		1543
1281	my $data;	1544	my $data;
1282	my $rbuf = \$self->{rbuf};	1545	my $rbuf = \$self->{rbuf};
1283		1546
1284	sub {	1547	sub {
…		…
1295	$json->incr_skip;	1558	$json->incr_skip;
1296		1559
1297	$self->{rbuf} = $json->incr_text;	1560	$self->{rbuf} = $json->incr_text;
1298	$json->incr_text = "";	1561	$json->incr_text = "";
1299		1562
1300	$self->_error (&Errno::EBADMSG);	1563	$self->_error (Errno::EBADMSG);
1301		1564
1302	()	1565	()
1303	} else {	1566	} else {
1304	$self->{rbuf} = "";	1567	$self->{rbuf} = "";
1305		1568
…		…
1342	# read remaining chunk	1605	# read remaining chunk
1343	$_[0]->unshift_read (chunk => $len, sub {	1606	$_[0]->unshift_read (chunk => $len, sub {
1344	if (my $ref = eval { Storable::thaw ($_[1]) }) {	1607	if (my $ref = eval { Storable::thaw ($_[1]) }) {
1345	$cb->($_[0], $ref);	1608	$cb->($_[0], $ref);
1346	} else {	1609	} else {
1347	$self->_error (&Errno::EBADMSG);	1610	$self->_error (Errno::EBADMSG);
1348	}	1611	}
1349	});	1612	});
1350	}	1613	}
1351		1614
1352	1	1615	1
…		…
1404	my ($self) = @_;	1667	my ($self) = @_;
1405		1668
1406	unless ($self->{_rw} \|\| $self->{_eof}) {	1669	unless ($self->{_rw} \|\| $self->{_eof}) {
1407	Scalar::Util::weaken $self;	1670	Scalar::Util::weaken $self;
1408		1671
1409	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1672	$self->{_rw} = AE::io $self->{fh}, 0, sub {
1410	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});	1673	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1411	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;	1674	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;
1412		1675
1413	if ($len > 0) {	1676	if ($len > 0) {
1414	$self->{_activity} = AnyEvent->now;	1677	$self->{_activity} = $self->{_ractivity} = AE::now;
1415		1678
1416	if ($self->{tls}) {	1679	if ($self->{tls}) {
1417	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);	1680	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1418		1681
1419	&_dotls ($self);	1682	&_dotls ($self);
1420	} else {	1683	} else {
1421	$self->_drain_rbuf unless $self->{_in_drain};	1684	$self->_drain_rbuf;
1422	}	1685	}
1423		1686
1424	} elsif (defined $len) {	1687	} elsif (defined $len) {
1425	delete $self->{_rw};	1688	delete $self->{_rw};
1426	$self->{_eof} = 1;	1689	$self->{_eof} = 1;
1427	$self->_drain_rbuf unless $self->{_in_drain};	1690	$self->_drain_rbuf;
1428		1691
1429	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1692	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1430	return $self->_error ($!, 1);	1693	return $self->_error ($!, 1);
1431	}	1694	}
1432	});	1695	};
1433	}	1696	}
1434	}	1697	}
1435		1698
1436	our $ERROR_SYSCALL;	1699	our $ERROR_SYSCALL;
1437	our $ERROR_WANT_READ;	1700	our $ERROR_WANT_READ;
…		…
1450	if ($self->{_on_starttls}) {	1713	if ($self->{_on_starttls}) {
1451	(delete $self->{_on_starttls})->($self, undef, $err);	1714	(delete $self->{_on_starttls})->($self, undef, $err);
1452	&_freetls;	1715	&_freetls;
1453	} else {	1716	} else {
1454	&_freetls;	1717	&_freetls;
1455	$self->_error (&Errno::EPROTO, 1, $err);	1718	$self->_error (Errno::EPROTO, 1, $err);
1456	}	1719	}
1457	}	1720	}
1458		1721
1459	# poll the write BIO and send the data if applicable	1722	# poll the write BIO and send the data if applicable
1460	# also decode read data if possible	1723	# also decode read data if possible
…		…
1492	$self->{_eof} = 1;	1755	$self->{_eof} = 1;
1493	}	1756	}
1494	}	1757	}
1495		1758
1496	$self->{_tls_rbuf} .= $tmp;	1759	$self->{_tls_rbuf} .= $tmp;
1497	$self->_drain_rbuf unless $self->{_in_drain};	1760	$self->_drain_rbuf;
1498	$self->{tls} or return; # tls session might have gone away in callback	1761	$self->{tls} or return; # tls session might have gone away in callback
1499	}	1762	}
1500		1763
1501	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);	1764	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1502	return $self->_tls_error ($tmp)	1765	return $self->_tls_error ($tmp)
…		…
1517		1780
1518	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	1781	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
1519	object is created, you can also do that at a later time by calling	1782	object is created, you can also do that at a later time by calling
1520	C<starttls>.	1783	C<starttls>.
1521		1784
		1785	Starting TLS is currently an asynchronous operation - when you push some
		1786	write data and then call C<< ->starttls >> then TLS negotiation will start
		1787	immediately, after which the queued write data is then sent.
		1788
1522	The first argument is the same as the C<tls> constructor argument (either	1789	The first argument is the same as the C<tls> constructor argument (either
1523	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1790	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1524		1791
1525	The second argument is the optional C<AnyEvent::TLS> object that is used	1792	The second argument is the optional C<AnyEvent::TLS> object that is used
1526	when AnyEvent::Handle has to create its own TLS connection object, or	1793	when AnyEvent::Handle has to create its own TLS connection object, or
…		…
1530	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS	1797	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS
1531	context in C<< $handle->{tls_ctx} >> after this call and can be used or	1798	context in C<< $handle->{tls_ctx} >> after this call and can be used or
1532	changed to your liking. Note that the handshake might have already started	1799	changed to your liking. Note that the handshake might have already started
1533	when this function returns.	1800	when this function returns.
1534		1801
1535	If it an error to start a TLS handshake more than once per	1802	Due to bugs in OpenSSL, it might or might not be possible to do multiple
1536	AnyEvent::Handle object (this is due to bugs in OpenSSL).	1803	handshakes on the same stream. Best do not attempt to use the stream after
		1804	stopping TLS.
1537		1805
1538	=cut	1806	=cut
1539		1807
1540	our %TLS_CACHE; #TODO not yet documented, should we?	1808	our %TLS_CACHE; #TODO not yet documented, should we?
1541		1809
1542	sub starttls {	1810	sub starttls {
1543	my ($self, $ssl, $ctx) = @_;	1811	my ($self, $tls, $ctx) = @_;
		1812
		1813	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"
		1814	if $self->{tls};
		1815
		1816	$self->{tls} = $tls;
		1817	$self->{tls_ctx} = $ctx if @_ > 2;
		1818
		1819	return unless $self->{fh};
1544		1820
1545	require Net::SSLeay;	1821	require Net::SSLeay;
1546
1547	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"
1548	if $self->{tls};
1549		1822
1550	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();	1823	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1551	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();	1824	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1552		1825
		1826	$tls = delete $self->{tls};
1553	$ctx \|\|= $self->{tls_ctx};	1827	$ctx = $self->{tls_ctx};
		1828
		1829	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
1554		1830
1555	if ("HASH" eq ref $ctx) {	1831	if ("HASH" eq ref $ctx) {
1556	require AnyEvent::TLS;	1832	require AnyEvent::TLS;
1557
1558	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context
1559		1833
1560	if ($ctx->{cache}) {	1834	if ($ctx->{cache}) {
1561	my $key = $ctx+0;	1835	my $key = $ctx+0;
1562	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;	1836	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;
1563	} else {	1837	} else {
1564	$ctx = new AnyEvent::TLS %$ctx;	1838	$ctx = new AnyEvent::TLS %$ctx;
1565	}	1839	}
1566	}	1840	}
1567		1841
1568	$self->{tls_ctx} = $ctx \|\| TLS_CTX ();	1842	$self->{tls_ctx} = $ctx \|\| TLS_CTX ();
1569	$self->{tls} = $ssl = $self->{tls_ctx}->_get_session ($ssl, $self, $self->{peername});	1843	$self->{tls} = $tls = $self->{tls_ctx}->_get_session ($tls, $self, $self->{peername});
1570		1844
1571	# basically, this is deep magic (because SSL_read should have the same issues)	1845	# basically, this is deep magic (because SSL_read should have the same issues)
1572	# but the openssl maintainers basically said: "trust us, it just works".	1846	# but the openssl maintainers basically said: "trust us, it just works".
1573	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1847	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1574	# and mismaintained ssleay-module doesn't even offer them).	1848	# and mismaintained ssleay-module doesn't even offer them).
…		…
1581	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to	1855	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
1582	# have identity issues in that area.	1856	# have identity issues in that area.
1583	# Net::SSLeay::CTX_set_mode ($ssl,	1857	# Net::SSLeay::CTX_set_mode ($ssl,
1584	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1858	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
1585	# \| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));	1859	# \| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
1586	Net::SSLeay::CTX_set_mode ($ssl, 1\|2);	1860	Net::SSLeay::CTX_set_mode ($tls, 1\|2);
1587		1861
1588	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1862	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1589	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1863	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1590		1864
		1865	Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf});
		1866
1591	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1867	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
1592		1868
1593	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }	1869	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1594	if $self->{on_starttls};	1870	if $self->{on_starttls};
1595		1871
1596	&_dotls; # need to trigger the initial handshake	1872	&_dotls; # need to trigger the initial handshake
…		…
1599		1875
1600	=item $handle->stoptls	1876	=item $handle->stoptls
1601		1877
1602	Shuts down the SSL connection - this makes a proper EOF handshake by	1878	Shuts down the SSL connection - this makes a proper EOF handshake by
1603	sending a close notify to the other side, but since OpenSSL doesn't	1879	sending a close notify to the other side, but since OpenSSL doesn't
1604	support non-blocking shut downs, it is not possible to re-use the stream	1880	support non-blocking shut downs, it is not guarenteed that you can re-use
1605	afterwards.	1881	the stream afterwards.
1606		1882
1607	=cut	1883	=cut
1608		1884
1609	sub stoptls {	1885	sub stoptls {
1610	my ($self) = @_;	1886	my ($self) = @_;
…		…
1623	sub _freetls {	1899	sub _freetls {
1624	my ($self) = @_;	1900	my ($self) = @_;
1625		1901
1626	return unless $self->{tls};	1902	return unless $self->{tls};
1627		1903
1628	$self->{tls_ctx}->_put_session (delete $self->{tls});	1904	$self->{tls_ctx}->_put_session (delete $self->{tls})
		1905	if $self->{tls} > 0;
1629		1906
1630	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};	1907	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1631	}	1908	}
1632		1909
1633	sub DESTROY {	1910	sub DESTROY {
…		…
1635		1912
1636	&_freetls;	1913	&_freetls;
1637		1914
1638	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	1915	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1639		1916
1640	if ($linger && length $self->{wbuf}) {	1917	if ($linger && length $self->{wbuf} && $self->{fh}) {
1641	my $fh = delete $self->{fh};	1918	my $fh = delete $self->{fh};
1642	my $wbuf = delete $self->{wbuf};	1919	my $wbuf = delete $self->{wbuf};
1643		1920
1644	my @linger;	1921	my @linger;
1645		1922
1646	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {	1923	push @linger, AE::io $fh, 1, sub {
1647	my $len = syswrite $fh, $wbuf, length $wbuf;	1924	my $len = syswrite $fh, $wbuf, length $wbuf;
1648		1925
1649	if ($len > 0) {	1926	if ($len > 0) {
1650	substr $wbuf, 0, $len, "";	1927	substr $wbuf, 0, $len, "";
1651	} else {	1928	} else {
1652	@linger = (); # end	1929	@linger = (); # end
1653	}	1930	}
1654	});	1931	};
1655	push @linger, AnyEvent->timer (after => $linger, cb => sub {	1932	push @linger, AE::timer $linger, 0, sub {
1656	@linger = ();	1933	@linger = ();
1657	});	1934	};
1658	}	1935	}
1659	}	1936	}
1660		1937
1661	=item $handle->destroy	1938	=item $handle->destroy
1662		1939
1663	Shuts down the handle object as much as possible - this call ensures that	1940	Shuts down the handle object as much as possible - this call ensures that
1664	no further callbacks will be invoked and as many resources as possible	1941	no further callbacks will be invoked and as many resources as possible
1665	will be freed. You must not call any methods on the object afterwards.	1942	will be freed. Any method you will call on the handle object after
		1943	destroying it in this way will be silently ignored (and it will return the
		1944	empty list).
1666		1945
1667	Normally, you can just "forget" any references to an AnyEvent::Handle	1946	Normally, you can just "forget" any references to an AnyEvent::Handle
1668	object and it will simply shut down. This works in fatal error and EOF	1947	object and it will simply shut down. This works in fatal error and EOF
1669	callbacks, as well as code outside. It does I<NOT> work in a read or write	1948	callbacks, as well as code outside. It does I<NOT> work in a read or write
1670	callback, so when you want to destroy the AnyEvent::Handle object from	1949	callback, so when you want to destroy the AnyEvent::Handle object from
…		…
1684	sub destroy {	1963	sub destroy {
1685	my ($self) = @_;	1964	my ($self) = @_;
1686		1965
1687	$self->DESTROY;	1966	$self->DESTROY;
1688	%$self = ();	1967	%$self = ();
		1968	bless $self, "AnyEvent::Handle::destroyed";
		1969	}
		1970
		1971	sub AnyEvent::Handle::destroyed::AUTOLOAD {
		1972	#nop
1689	}	1973	}
1690		1974
1691	=item AnyEvent::Handle::TLS_CTX	1975	=item AnyEvent::Handle::TLS_CTX
1692		1976
1693	This function creates and returns the AnyEvent::TLS object used by default	1977	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.149 by root, Thu Jul 16 03:48:33 2009 UTC vs. Revision 1.184 by root, Thu Sep 3 13:14:38 2009 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.149 by root, Thu Jul 16 03:48:33 2009 UTC vs.
Revision 1.184 by root, Thu Sep 3 13:14:38 2009 UTC