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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.144 by root, Mon Jul 6 21:38:25 2009 UTC vs.
Revision 1.183 by root, Thu Sep 3 12:45:35 2009 UTC

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

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.144 by root, Mon Jul 6 21:38:25 2009 UTC vs. Revision 1.183 by root, Thu Sep 3 12:45:35 2009 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.144 by root, Mon Jul 6 21:38:25 2009 UTC vs.
Revision 1.183 by root, Thu Sep 3 12:45:35 2009 UTC