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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.146 by root, Wed Jul 8 13:46:46 2009 UTC vs.
Revision 1.182 by root, Thu Sep 3 12:35:01 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.8;
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 gives you
		312	the most portable way of getting urgent data, by putting it into the
		313	stream.
		314
219	=item read_size => <bytes>	315	=item read_size => <bytes>
220		316
221	The default read block size (the amount of bytes this module will	317	The default read block size (the amount of bytes this module will
222	try to read during each loop iteration, which affects memory	318	try to read during each loop iteration, which affects memory
223	requirements). Default: C<8192>.	319	requirements). Default: C<8192>.
…		…
349		445
350	sub new {	446	sub new {
351	my $class = shift;	447	my $class = shift;
352	my $self = bless { @_ }, $class;	448	my $self = bless { @_ }, $class;
353		449
354	$self->{fh} or Carp::croak "mandatory argument fh is missing";	450	if ($self->{fh}) {
		451	$self->_start;
		452	return unless $self->{fh}; # could be gone by now
		453
		454	} elsif ($self->{connect}) {
		455	require AnyEvent::Socket;
		456
		457	$self->{peername} = $self->{connect}[0]
		458	unless exists $self->{peername};
		459
		460	$self->{_skip_drain_rbuf} = 1;
		461
		462	{
		463	Scalar::Util::weaken (my $self = $self);
		464
		465	$self->{_connect} =
		466	AnyEvent::Socket::tcp_connect (
		467	$self->{connect}[0],
		468	$self->{connect}[1],
		469	sub {
		470	my ($fh, $host, $port, $retry) = @_;
		471
		472	if ($fh) {
		473	$self->{fh} = $fh;
		474
		475	delete $self->{_skip_drain_rbuf};
		476	$self->_start;
		477
		478	$self->{on_connect}
		479	and $self->{on_connect}($self, $host, $port, sub {
		480	delete @$self{qw(fh _tw _rtw _wtw _ww _rw _eof _queue rbuf _wbuf tls _tls_rbuf _tls_wbuf)};
		481	$self->{_skip_drain_rbuf} = 1;
		482	&$retry;
		483	});
		484
		485	} else {
		486	if ($self->{on_connect_error}) {
		487	$self->{on_connect_error}($self, "$!");
		488	$self->destroy;
		489	} else {
		490	$self->_error ($!, 1);
		491	}
		492	}
		493	},
		494	sub {
		495	local $self->{fh} = $_[0];
		496
		497	$self->{on_prepare}
		498	? $self->{on_prepare}->($self)
		499	: ()
		500	}
		501	);
		502	}
		503
		504	} else {
		505	Carp::croak "AnyEvent::Handle: either an existing fh or the connect parameter must be specified";
		506	}
		507
		508	$self
		509	}
		510
		511	sub _start {
		512	my ($self) = @_;
355		513
356	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	514	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
357		515
		516	$self->{_activity} =
		517	$self->{_ractivity} =
358	$self->{_activity} = AnyEvent->now;	518	$self->{_wactivity} = AE::now;
359	$self->_timeout;
360		519
		520	$self->timeout (delete $self->{timeout} ) if $self->{timeout};
		521	$self->rtimeout (delete $self->{rtimeout} ) if $self->{rtimeout};
		522	$self->wtimeout (delete $self->{wtimeout} ) if $self->{wtimeout};
		523
361	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};	524	$self->no_delay (delete $self->{no_delay} ) if exists $self->{no_delay};
		525	$self->keepalive (delete $self->{keepalive}) if exists $self->{keepalive};
		526	$self->oobinline (delete $self->{oobinline}) if exists $self->{oobinline};
362		527
363	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})	528	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
364	if $self->{tls};	529	if $self->{tls};
365		530
366	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	531	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
367		532
368	$self->start_read	533	$self->start_read
369	if $self->{on_read};	534	if $self->{on_read} \|\| @{ $self->{_queue} };
370		535
371	$self->{fh} && $self	536	$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	}	537	}
382		538
383	sub _error {	539	sub _error {
384	my ($self, $errno, $fatal, $message) = @_;	540	my ($self, $errno, $fatal, $message) = @_;
385		541
386	$self->_shutdown
387	if $fatal;
388
389	$! = $errno;	542	$! = $errno;
390	$message \|\|= "$!";	543	$message \|\|= "$!";
391		544
392	if ($self->{on_error}) {	545	if ($self->{on_error}) {
393	$self->{on_error}($self, $fatal, $message);	546	$self->{on_error}($self, $fatal, $message);
		547	$self->destroy if $fatal;
394	} elsif ($self->{fh}) {	548	} elsif ($self->{fh}) {
		549	$self->destroy;
395	Carp::croak "AnyEvent::Handle uncaught error: $message";	550	Carp::croak "AnyEvent::Handle uncaught error: $message";
396	}	551	}
397	}	552	}
398		553
399	=item $fh = $handle->fh	554	=item $fh = $handle->fh
…		…
424	$_[0]{on_eof} = $_[1];	579	$_[0]{on_eof} = $_[1];
425	}	580	}
426		581
427	=item $handle->on_timeout ($cb)	582	=item $handle->on_timeout ($cb)
428		583
429	Replace the current C<on_timeout> callback, or disables the callback (but	584	=item $handle->on_rtimeout ($cb)
430	not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
431	argument and method.
432		585
433	=cut	586	=item $handle->on_wtimeout ($cb)
434		587
435	sub on_timeout {	588	Replace the current C<on_timeout>, C<on_rtimeout> or C<on_wtimeout>
436	$_[0]{on_timeout} = $_[1];	589	callback, or disables the callback (but not the timeout) if C<$cb> =
437	}	590	C<undef>. See the C<timeout> constructor argument and method.
		591
		592	=cut
		593
		594	# see below
438		595
439	=item $handle->autocork ($boolean)	596	=item $handle->autocork ($boolean)
440		597
441	Enables or disables the current autocork behaviour (see C<autocork>	598	Enables or disables the current autocork behaviour (see C<autocork>
442	constructor argument). Changes will only take effect on the next write.	599	constructor argument). Changes will only take effect on the next write.
…		…
457	sub no_delay {	614	sub no_delay {
458	$_[0]{no_delay} = $_[1];	615	$_[0]{no_delay} = $_[1];
459		616
460	eval {	617	eval {
461	local $SIG{__DIE__};	618	local $SIG{__DIE__};
462	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];	619	setsockopt $_[0]{fh}, Socket::IPPROTO_TCP (), Socket::TCP_NODELAY (), int $_[1]
		620	if $_[0]{fh};
		621	};
		622	}
		623
		624	=item $handle->keepalive ($boolean)
		625
		626	Enables or disables the C<keepalive> setting (see constructor argument of
		627	the same name for details).
		628
		629	=cut
		630
		631	sub keepalive {
		632	$_[0]{keepalive} = $_[1];
		633
		634	eval {
		635	local $SIG{__DIE__};
		636	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
		637	if $_[0]{fh};
		638	};
		639	}
		640
		641	=item $handle->oobinline ($boolean)
		642
		643	Enables or disables the C<oobinline> setting (see constructor argument of
		644	the same name for details).
		645
		646	=cut
		647
		648	sub oobinline {
		649	$_[0]{oobinline} = $_[1];
		650
		651	eval {
		652	local $SIG{__DIE__};
		653	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_OOBINLINE (), int $_[1]
		654	if $_[0]{fh};
		655	};
		656	}
		657
		658	=item $handle->keepalive ($boolean)
		659
		660	Enables or disables the C<keepalive> setting (see constructor argument of
		661	the same name for details).
		662
		663	=cut
		664
		665	sub keepalive {
		666	$_[0]{keepalive} = $_[1];
		667
		668	eval {
		669	local $SIG{__DIE__};
		670	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
		671	if $_[0]{fh};
463	};	672	};
464	}	673	}
465		674
466	=item $handle->on_starttls ($cb)	675	=item $handle->on_starttls ($cb)
467		676
…		…
481		690
482	sub on_starttls {	691	sub on_starttls {
483	$_[0]{on_stoptls} = $_[1];	692	$_[0]{on_stoptls} = $_[1];
484	}	693	}
485		694
		695	=item $handle->rbuf_max ($max_octets)
		696
		697	Configures the C<rbuf_max> setting (C<undef> disables it).
		698
		699	=cut
		700
		701	sub rbuf_max {
		702	$_[0]{rbuf_max} = $_[1];
		703	}
		704
486	#############################################################################	705	#############################################################################
487		706
488	=item $handle->timeout ($seconds)	707	=item $handle->timeout ($seconds)
489		708
		709	=item $handle->rtimeout ($seconds)
		710
		711	=item $handle->wtimeout ($seconds)
		712
490	Configures (or disables) the inactivity timeout.	713	Configures (or disables) the inactivity timeout.
491		714
492	=cut	715	=item $handle->timeout_reset
493		716
494	sub timeout {	717	=item $handle->rtimeout_reset
		718
		719	=item $handle->wtimeout_reset
		720
		721	Reset the activity timeout, as if data was received or sent.
		722
		723	These methods are cheap to call.
		724
		725	=cut
		726
		727	for my $dir ("", "r", "w") {
		728	my $timeout = "${dir}timeout";
		729	my $tw = "_${dir}tw";
		730	my $on_timeout = "on_${dir}timeout";
		731	my $activity = "_${dir}activity";
		732	my $cb;
		733
		734	*$on_timeout = sub {
		735	$_[0]{$on_timeout} = $_[1];
		736	};
		737
		738	*$timeout = sub {
495	my ($self, $timeout) = @_;	739	my ($self, $new_value) = @_;
496		740
497	$self->{timeout} = $timeout;	741	$self->{$timeout} = $new_value;
498	$self->_timeout;	742	delete $self->{$tw}; &$cb;
499	}	743	};
500		744
		745	*{"${dir}timeout_reset"} = sub {
		746	$_[0]{$activity} = AE::now;
		747	};
		748
		749	# main workhorse:
501	# reset the timeout watcher, as neccessary	750	# reset the timeout watcher, as neccessary
502	# also check for time-outs	751	# also check for time-outs
503	sub _timeout {	752	$cb = sub {
504	my ($self) = @_;	753	my ($self) = @_;
505		754
506	if ($self->{timeout}) {	755	if ($self->{$timeout} && $self->{fh}) {
507	my $NOW = AnyEvent->now;	756	my $NOW = AE::now;
508		757
509	# when would the timeout trigger?	758	# when would the timeout trigger?
510	my $after = $self->{_activity} + $self->{timeout} - $NOW;	759	my $after = $self->{$activity} + $self->{$timeout} - $NOW;
511		760
512	# now or in the past already?	761	# now or in the past already?
513	if ($after <= 0) {	762	if ($after <= 0) {
514	$self->{_activity} = $NOW;	763	$self->{$activity} = $NOW;
515		764
516	if ($self->{on_timeout}) {	765	if ($self->{$on_timeout}) {
517	$self->{on_timeout}($self);	766	$self->{$on_timeout}($self);
518	} else {	767	} else {
519	$self->_error (&Errno::ETIMEDOUT);	768	$self->_error (Errno::ETIMEDOUT);
		769	}
		770
		771	# callback could have changed timeout value, optimise
		772	return unless $self->{$timeout};
		773
		774	# calculate new after
		775	$after = $self->{$timeout};
520	}	776	}
521		777
522	# callback could have changed timeout value, optimise	778	Scalar::Util::weaken $self;
523	return unless $self->{timeout};	779	return unless $self; # ->error could have destroyed $self
524		780
525	# calculate new after	781	$self->{$tw} \|\|= AE::timer $after, 0, sub {
526	$after = $self->{timeout};	782	delete $self->{$tw};
		783	$cb->($self);
		784	};
		785	} else {
		786	delete $self->{$tw};
527	}	787	}
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	}	788	}
539	}	789	}
540		790
541	#############################################################################	791	#############################################################################
542		792
…		…
590	my $len = syswrite $self->{fh}, $self->{wbuf};	840	my $len = syswrite $self->{fh}, $self->{wbuf};
591		841
592	if (defined $len) {	842	if (defined $len) {
593	substr $self->{wbuf}, 0, $len, "";	843	substr $self->{wbuf}, 0, $len, "";
594		844
595	$self->{_activity} = AnyEvent->now;	845	$self->{_activity} = $self->{_wactivity} = AE::now;
596		846
597	$self->{on_drain}($self)	847	$self->{on_drain}($self)
598	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})	848	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
599	&& $self->{on_drain};	849	&& $self->{on_drain};
600		850
…		…
606		856
607	# try to write data immediately	857	# try to write data immediately
608	$cb->() unless $self->{autocork};	858	$cb->() unless $self->{autocork};
609		859
610	# if still data left in wbuf, we need to poll	860	# if still data left in wbuf, we need to poll
611	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	861	$self->{_ww} = AE::io $self->{fh}, 1, $cb
612	if length $self->{wbuf};	862	if length $self->{wbuf};
613	};	863	};
614	}	864	}
615		865
616	our %WH;	866	our %WH;
…		…
629	->($self, @_);	879	->($self, @_);
630	}	880	}
631		881
632	if ($self->{tls}) {	882	if ($self->{tls}) {
633	$self->{_tls_wbuf} .= $_[0];	883	$self->{_tls_wbuf} .= $_[0];
634		884	&_dotls ($self) if $self->{fh};
635	&_dotls ($self);
636	} else {	885	} else {
637	$self->{wbuf} .= $_[0];	886	$self->{wbuf} .= $_[0];
638	$self->_drain_wbuf;	887	$self->_drain_wbuf if $self->{fh};
639	}	888	}
640	}	889	}
641		890
642	=item $handle->push_write (type => @args)	891	=item $handle->push_write (type => @args)
643		892
…		…
707	Other languages could read single lines terminated by a newline and pass	956	Other languages could read single lines terminated by a newline and pass
708	this line into their JSON decoder of choice.	957	this line into their JSON decoder of choice.
709		958
710	=cut	959	=cut
711		960
		961	sub json_coder() {
		962	eval { require JSON::XS; JSON::XS->new->utf8 }
		963	\|\| do { require JSON; JSON->new->utf8 }
		964	}
		965
712	register_write_type json => sub {	966	register_write_type json => sub {
713	my ($self, $ref) = @_;	967	my ($self, $ref) = @_;
714		968
715	require JSON;	969	my $json = $self->{json} \|\|= json_coder;
716		970
717	$self->{json} ? $self->{json}->encode ($ref)	971	$json->encode ($ref)
718	: JSON::encode_json ($ref)
719	};	972	};
720		973
721	=item storable => $reference	974	=item storable => $reference
722		975
723	Freezes the given reference using L<Storable> and writes it to the	976	Freezes the given reference using L<Storable> and writes it to the
…		…
860	=cut	1113	=cut
861		1114
862	sub _drain_rbuf {	1115	sub _drain_rbuf {
863	my ($self) = @_;	1116	my ($self) = @_;
864		1117
		1118	# avoid recursion
		1119	return if $self->{_skip_drain_rbuf};
865	local $self->{_in_drain} = 1;	1120	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		1121
874	while () {	1122	while () {
875	# we need to use a separate tls read buffer, as we must not receive data while	1123	# 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.	1124	# we are draining the buffer, and this can only happen with TLS.
877	$self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf};	1125	$self->{rbuf} .= delete $self->{_tls_rbuf}
		1126	if exists $self->{_tls_rbuf};
878		1127
879	my $len = length $self->{rbuf};	1128	my $len = length $self->{rbuf};
880		1129
881	if (my $cb = shift @{ $self->{_queue} }) {	1130	if (my $cb = shift @{ $self->{_queue} }) {
882	unless ($cb->($self)) {	1131	unless ($cb->($self)) {
883	if ($self->{_eof}) {	1132	# no progress can be made
884	# no progress can be made (not enough data and no data forthcoming)	1133	# (not enough data and no data forthcoming)
885	$self->_error (&Errno::EPIPE, 1), return;	1134	$self->_error (Errno::EPIPE, 1), return
886	}	1135	if $self->{_eof};
887		1136
888	unshift @{ $self->{_queue} }, $cb;	1137	unshift @{ $self->{_queue} }, $cb;
889	last;	1138	last;
890	}	1139	}
891	} elsif ($self->{on_read}) {	1140	} elsif ($self->{on_read}) {
…		…
898	&& !@{ $self->{_queue} } # and the queue is still empty	1147	&& !@{ $self->{_queue} } # and the queue is still empty
899	&& $self->{on_read} # but we still have on_read	1148	&& $self->{on_read} # but we still have on_read
900	) {	1149	) {
901	# no further data will arrive	1150	# no further data will arrive
902	# so no progress can be made	1151	# so no progress can be made
903	$self->_error (&Errno::EPIPE, 1), return	1152	$self->_error (Errno::EPIPE, 1), return
904	if $self->{_eof};	1153	if $self->{_eof};
905		1154
906	last; # more data might arrive	1155	last; # more data might arrive
907	}	1156	}
908	} else {	1157	} else {
…		…
911	last;	1160	last;
912	}	1161	}
913	}	1162	}
914		1163
915	if ($self->{_eof}) {	1164	if ($self->{_eof}) {
916	if ($self->{on_eof}) {	1165	$self->{on_eof}
917	$self->{on_eof}($self)	1166	? $self->{on_eof}($self)
918	} else {
919	$self->_error (0, 1, "Unexpected end-of-file");	1167	: $self->_error (0, 1, "Unexpected end-of-file");
920	}	1168
		1169	return;
		1170	}
		1171
		1172	if (
		1173	defined $self->{rbuf_max}
		1174	&& $self->{rbuf_max} < length $self->{rbuf}
		1175	) {
		1176	$self->_error (Errno::ENOSPC, 1), return;
921	}	1177	}
922		1178
923	# may need to restart read watcher	1179	# may need to restart read watcher
924	unless ($self->{_rw}) {	1180	unless ($self->{_rw}) {
925	$self->start_read	1181	$self->start_read
…		…
937		1193
938	sub on_read {	1194	sub on_read {
939	my ($self, $cb) = @_;	1195	my ($self, $cb) = @_;
940		1196
941	$self->{on_read} = $cb;	1197	$self->{on_read} = $cb;
942	$self->_drain_rbuf if $cb && !$self->{_in_drain};	1198	$self->_drain_rbuf if $cb;
943	}	1199	}
944		1200
945	=item $handle->rbuf	1201	=item $handle->rbuf
946		1202
947	Returns the read buffer (as a modifiable lvalue).	1203	Returns the read buffer (as a modifiable lvalue).
…		…
999	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	1255	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
1000	->($self, $cb, @_);	1256	->($self, $cb, @_);
1001	}	1257	}
1002		1258
1003	push @{ $self->{_queue} }, $cb;	1259	push @{ $self->{_queue} }, $cb;
1004	$self->_drain_rbuf unless $self->{_in_drain};	1260	$self->_drain_rbuf;
1005	}	1261	}
1006		1262
1007	sub unshift_read {	1263	sub unshift_read {
1008	my $self = shift;	1264	my $self = shift;
1009	my $cb = pop;	1265	my $cb = pop;
…		…
1013		1269
1014	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")	1270	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")
1015	->($self, $cb, @_);	1271	->($self, $cb, @_);
1016	}	1272	}
1017		1273
1018
1019	unshift @{ $self->{_queue} }, $cb;	1274	unshift @{ $self->{_queue} }, $cb;
1020	$self->_drain_rbuf unless $self->{_in_drain};	1275	$self->_drain_rbuf;
1021	}	1276	}
1022		1277
1023	=item $handle->push_read (type => @args, $cb)	1278	=item $handle->push_read (type => @args, $cb)
1024		1279
1025	=item $handle->unshift_read (type => @args, $cb)	1280	=item $handle->unshift_read (type => @args, $cb)
…		…
1158	return 1;	1413	return 1;
1159	}	1414	}
1160		1415
1161	# reject	1416	# reject
1162	if ($reject && $$rbuf =~ $reject) {	1417	if ($reject && $$rbuf =~ $reject) {
1163	$self->_error (&Errno::EBADMSG);	1418	$self->_error (Errno::EBADMSG);
1164	}	1419	}
1165		1420
1166	# skip	1421	# skip
1167	if ($skip && $$rbuf =~ $skip) {	1422	if ($skip && $$rbuf =~ $skip) {
1168	$data .= substr $$rbuf, 0, $+[0], "";	1423	$data .= substr $$rbuf, 0, $+[0], "";
…		…
1184	my ($self, $cb) = @_;	1439	my ($self, $cb) = @_;
1185		1440
1186	sub {	1441	sub {
1187	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {	1442	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
1188	if ($_[0]{rbuf} =~ /[^0-9]/) {	1443	if ($_[0]{rbuf} =~ /[^0-9]/) {
1189	$self->_error (&Errno::EBADMSG);	1444	$self->_error (Errno::EBADMSG);
1190	}	1445	}
1191	return;	1446	return;
1192	}	1447	}
1193		1448
1194	my $len = $1;	1449	my $len = $1;
…		…
1197	my $string = $_[1];	1452	my $string = $_[1];
1198	$_[0]->unshift_read (chunk => 1, sub {	1453	$_[0]->unshift_read (chunk => 1, sub {
1199	if ($_[1] eq ",") {	1454	if ($_[1] eq ",") {
1200	$cb->($_[0], $string);	1455	$cb->($_[0], $string);
1201	} else {	1456	} else {
1202	$self->_error (&Errno::EBADMSG);	1457	$self->_error (Errno::EBADMSG);
1203	}	1458	}
1204	});	1459	});
1205	});	1460	});
1206		1461
1207	1	1462	1
…		…
1274	=cut	1529	=cut
1275		1530
1276	register_read_type json => sub {	1531	register_read_type json => sub {
1277	my ($self, $cb) = @_;	1532	my ($self, $cb) = @_;
1278		1533
1279	my $json = $self->{json} \|\|=	1534	my $json = $self->{json} \|\|= json_coder;
1280	eval { require JSON::XS; JSON::XS->new->utf8 }
1281	\|\| do { require JSON; JSON->new->utf8 };
1282		1535
1283	my $data;	1536	my $data;
1284	my $rbuf = \$self->{rbuf};	1537	my $rbuf = \$self->{rbuf};
1285		1538
1286	sub {	1539	sub {
…		…
1297	$json->incr_skip;	1550	$json->incr_skip;
1298		1551
1299	$self->{rbuf} = $json->incr_text;	1552	$self->{rbuf} = $json->incr_text;
1300	$json->incr_text = "";	1553	$json->incr_text = "";
1301		1554
1302	$self->_error (&Errno::EBADMSG);	1555	$self->_error (Errno::EBADMSG);
1303		1556
1304	()	1557	()
1305	} else {	1558	} else {
1306	$self->{rbuf} = "";	1559	$self->{rbuf} = "";
1307		1560
…		…
1344	# read remaining chunk	1597	# read remaining chunk
1345	$_[0]->unshift_read (chunk => $len, sub {	1598	$_[0]->unshift_read (chunk => $len, sub {
1346	if (my $ref = eval { Storable::thaw ($_[1]) }) {	1599	if (my $ref = eval { Storable::thaw ($_[1]) }) {
1347	$cb->($_[0], $ref);	1600	$cb->($_[0], $ref);
1348	} else {	1601	} else {
1349	$self->_error (&Errno::EBADMSG);	1602	$self->_error (Errno::EBADMSG);
1350	}	1603	}
1351	});	1604	});
1352	}	1605	}
1353		1606
1354	1	1607	1
…		…
1406	my ($self) = @_;	1659	my ($self) = @_;
1407		1660
1408	unless ($self->{_rw} \|\| $self->{_eof}) {	1661	unless ($self->{_rw} \|\| $self->{_eof}) {
1409	Scalar::Util::weaken $self;	1662	Scalar::Util::weaken $self;
1410		1663
1411	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1664	$self->{_rw} = AE::io $self->{fh}, 0, sub {
1412	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});	1665	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1413	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;	1666	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;
1414		1667
1415	if ($len > 0) {	1668	if ($len > 0) {
1416	$self->{_activity} = AnyEvent->now;	1669	$self->{_activity} = $self->{_ractivity} = AE::now;
1417		1670
1418	if ($self->{tls}) {	1671	if ($self->{tls}) {
1419	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);	1672	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1420		1673
1421	&_dotls ($self);	1674	&_dotls ($self);
1422	} else {	1675	} else {
1423	$self->_drain_rbuf unless $self->{_in_drain};	1676	$self->_drain_rbuf;
1424	}	1677	}
1425		1678
1426	} elsif (defined $len) {	1679	} elsif (defined $len) {
1427	delete $self->{_rw};	1680	delete $self->{_rw};
1428	$self->{_eof} = 1;	1681	$self->{_eof} = 1;
1429	$self->_drain_rbuf unless $self->{_in_drain};	1682	$self->_drain_rbuf;
1430		1683
1431	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1684	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1432	return $self->_error ($!, 1);	1685	return $self->_error ($!, 1);
1433	}	1686	}
1434	});	1687	};
1435	}	1688	}
1436	}	1689	}
1437		1690
1438	our $ERROR_SYSCALL;	1691	our $ERROR_SYSCALL;
1439	our $ERROR_WANT_READ;	1692	our $ERROR_WANT_READ;
…		…
1452	if ($self->{_on_starttls}) {	1705	if ($self->{_on_starttls}) {
1453	(delete $self->{_on_starttls})->($self, undef, $err);	1706	(delete $self->{_on_starttls})->($self, undef, $err);
1454	&_freetls;	1707	&_freetls;
1455	} else {	1708	} else {
1456	&_freetls;	1709	&_freetls;
1457	$self->_error (&Errno::EPROTO, 1, $err);	1710	$self->_error (Errno::EPROTO, 1, $err);
1458	}	1711	}
1459	}	1712	}
1460		1713
1461	# poll the write BIO and send the data if applicable	1714	# poll the write BIO and send the data if applicable
1462	# also decode read data if possible	1715	# also decode read data if possible
…		…
1494	$self->{_eof} = 1;	1747	$self->{_eof} = 1;
1495	}	1748	}
1496	}	1749	}
1497		1750
1498	$self->{_tls_rbuf} .= $tmp;	1751	$self->{_tls_rbuf} .= $tmp;
1499	$self->_drain_rbuf unless $self->{_in_drain};	1752	$self->_drain_rbuf;
1500	$self->{tls} or return; # tls session might have gone away in callback	1753	$self->{tls} or return; # tls session might have gone away in callback
1501	}	1754	}
1502		1755
1503	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);	1756	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1504	return $self->_tls_error ($tmp)	1757	return $self->_tls_error ($tmp)
…		…
1519		1772
1520	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	1773	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	1774	object is created, you can also do that at a later time by calling
1522	C<starttls>.	1775	C<starttls>.
1523		1776
		1777	Starting TLS is currently an asynchronous operation - when you push some
		1778	write data and then call C<< ->starttls >> then TLS negotiation will start
		1779	immediately, after which the queued write data is then sent.
		1780
1524	The first argument is the same as the C<tls> constructor argument (either	1781	The first argument is the same as the C<tls> constructor argument (either
1525	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1782	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1526		1783
1527	The second argument is the optional C<AnyEvent::TLS> object that is used	1784	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	1785	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	1789	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	1790	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	1791	changed to your liking. Note that the handshake might have already started
1535	when this function returns.	1792	when this function returns.
1536		1793
1537	If it an error to start a TLS handshake more than once per	1794	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).	1795	handshakes on the same stream. Best do not attempt to use the stream after
		1796	stopping TLS.
1539		1797
1540	=cut	1798	=cut
1541		1799
1542	our %TLS_CACHE; #TODO not yet documented, should we?	1800	our %TLS_CACHE; #TODO not yet documented, should we?
1543		1801
1544	sub starttls {	1802	sub starttls {
1545	my ($self, $ssl, $ctx) = @_;	1803	my ($self, $tls, $ctx) = @_;
		1804
		1805	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"
		1806	if $self->{tls};
		1807
		1808	$self->{tls} = $tls;
		1809	$self->{tls_ctx} = $ctx if @_ > 2;
		1810
		1811	return unless $self->{fh};
1546		1812
1547	require Net::SSLeay;	1813	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		1814
1552	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();	1815	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1553	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();	1816	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1554		1817
		1818	$tls = delete $self->{tls};
1555	$ctx \|\|= $self->{tls_ctx};	1819	$ctx = $self->{tls_ctx};
		1820
		1821	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
1556		1822
1557	if ("HASH" eq ref $ctx) {	1823	if ("HASH" eq ref $ctx) {
1558	require AnyEvent::TLS;	1824	require AnyEvent::TLS;
1559
1560	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context
1561		1825
1562	if ($ctx->{cache}) {	1826	if ($ctx->{cache}) {
1563	my $key = $ctx+0;	1827	my $key = $ctx+0;
1564	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;	1828	$ctx = $TLS_CACHE{$key} \|\|= new AnyEvent::TLS %$ctx;
1565	} else {	1829	} else {
1566	$ctx = new AnyEvent::TLS %$ctx;	1830	$ctx = new AnyEvent::TLS %$ctx;
1567	}	1831	}
1568	}	1832	}
1569		1833
1570	$self->{tls_ctx} = $ctx \|\| TLS_CTX ();	1834	$self->{tls_ctx} = $ctx \|\| TLS_CTX ();
1571	$self->{tls} = $ssl = $self->{tls_ctx}->_get_session ($ssl, $self, $self->{peername});	1835	$self->{tls} = $tls = $self->{tls_ctx}->_get_session ($tls, $self, $self->{peername});
1572		1836
1573	# basically, this is deep magic (because SSL_read should have the same issues)	1837	# 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".	1838	# but the openssl maintainers basically said: "trust us, it just works".
1575	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1839	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1576	# and mismaintained ssleay-module doesn't even offer them).	1840	# 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	1847	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
1584	# have identity issues in that area.	1848	# have identity issues in that area.
1585	# Net::SSLeay::CTX_set_mode ($ssl,	1849	# Net::SSLeay::CTX_set_mode ($ssl,
1586	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1850	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
1587	# \| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));	1851	# \| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
1588	Net::SSLeay::CTX_set_mode ($ssl, 1\|2);	1852	Net::SSLeay::CTX_set_mode ($tls, 1\|2);
1589		1853
1590	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1854	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1591	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1855	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1592		1856
		1857	Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf});
		1858
1593	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1859	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
1594		1860
1595	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }	1861	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1596	if $self->{on_starttls};	1862	if $self->{on_starttls};
1597		1863
1598	&_dotls; # need to trigger the initial handshake	1864	&_dotls; # need to trigger the initial handshake
…		…
1601		1867
1602	=item $handle->stoptls	1868	=item $handle->stoptls
1603		1869
1604	Shuts down the SSL connection - this makes a proper EOF handshake by	1870	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	1871	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	1872	support non-blocking shut downs, it is not guarenteed that you can re-use
1607	afterwards.	1873	the stream afterwards.
1608		1874
1609	=cut	1875	=cut
1610		1876
1611	sub stoptls {	1877	sub stoptls {
1612	my ($self) = @_;	1878	my ($self) = @_;
…		…
1625	sub _freetls {	1891	sub _freetls {
1626	my ($self) = @_;	1892	my ($self) = @_;
1627		1893
1628	return unless $self->{tls};	1894	return unless $self->{tls};
1629		1895
1630	$self->{tls_ctx}->_put_session (delete $self->{tls});	1896	$self->{tls_ctx}->_put_session (delete $self->{tls})
		1897	if $self->{tls} > 0;
1631		1898
1632	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};	1899	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1633	}	1900	}
1634		1901
1635	sub DESTROY {	1902	sub DESTROY {
…		…
1637		1904
1638	&_freetls;	1905	&_freetls;
1639		1906
1640	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	1907	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1641		1908
1642	if ($linger && length $self->{wbuf}) {	1909	if ($linger && length $self->{wbuf} && $self->{fh}) {
1643	my $fh = delete $self->{fh};	1910	my $fh = delete $self->{fh};
1644	my $wbuf = delete $self->{wbuf};	1911	my $wbuf = delete $self->{wbuf};
1645		1912
1646	my @linger;	1913	my @linger;
1647		1914
1648	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {	1915	push @linger, AE::io $fh, 1, sub {
1649	my $len = syswrite $fh, $wbuf, length $wbuf;	1916	my $len = syswrite $fh, $wbuf, length $wbuf;
1650		1917
1651	if ($len > 0) {	1918	if ($len > 0) {
1652	substr $wbuf, 0, $len, "";	1919	substr $wbuf, 0, $len, "";
1653	} else {	1920	} else {
1654	@linger = (); # end	1921	@linger = (); # end
1655	}	1922	}
1656	});	1923	};
1657	push @linger, AnyEvent->timer (after => $linger, cb => sub {	1924	push @linger, AE::timer $linger, 0, sub {
1658	@linger = ();	1925	@linger = ();
1659	});	1926	};
1660	}	1927	}
1661	}	1928	}
1662		1929
1663	=item $handle->destroy	1930	=item $handle->destroy
1664		1931
1665	Shuts down the handle object as much as possible - this call ensures that	1932	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	1933	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.	1934	will be freed. Any method you will call on the handle object after
		1935	destroying it in this way will be silently ignored (and it will return the
		1936	empty list).
1668		1937
1669	Normally, you can just "forget" any references to an AnyEvent::Handle	1938	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	1939	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	1940	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	1941	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	1942	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
1674	that case.	1943	that case.
1675		1944
		1945	Destroying the handle object in this way has the advantage that callbacks
		1946	will be removed as well, so if those are the only reference holders (as
		1947	is common), then one doesn't need to do anything special to break any
		1948	reference cycles.
		1949
1676	The handle might still linger in the background and write out remaining	1950	The handle might still linger in the background and write out remaining
1677	data, as specified by the C<linger> option, however.	1951	data, as specified by the C<linger> option, however.
1678		1952
1679	=cut	1953	=cut
1680		1954
1681	sub destroy {	1955	sub destroy {
1682	my ($self) = @_;	1956	my ($self) = @_;
1683		1957
1684	$self->DESTROY;	1958	$self->DESTROY;
1685	%$self = ();	1959	%$self = ();
		1960	bless $self, "AnyEvent::Handle::destroyed";
		1961	}
		1962
		1963	sub AnyEvent::Handle::destroyed::AUTOLOAD {
		1964	#nop
1686	}	1965	}
1687		1966
1688	=item AnyEvent::Handle::TLS_CTX	1967	=item AnyEvent::Handle::TLS_CTX
1689		1968
1690	This function creates and returns the AnyEvent::TLS object used by default	1969	This function creates and returns the AnyEvent::TLS object used by default
…		…
1747		2026
1748	$handle->on_read (sub { });	2027	$handle->on_read (sub { });
1749	$handle->on_eof (undef);	2028	$handle->on_eof (undef);
1750	$handle->on_error (sub {	2029	$handle->on_error (sub {
1751	my $data = delete $_[0]{rbuf};	2030	my $data = delete $_[0]{rbuf};
1752	undef $handle;
1753	});	2031	});
1754		2032
1755	The reason to use C<on_error> is that TCP connections, due to latencies	2033	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	2034	and packets loss, might get closed quite violently with an error, when in
1757	fact, all data has been received.	2035	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.146 by root, Wed Jul 8 13:46:46 2009 UTC vs. Revision 1.182 by root, Thu Sep 3 12:35:01 2009 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.146 by root, Wed Jul 8 13:46:46 2009 UTC vs.
Revision 1.182 by root, Thu Sep 3 12:35:01 2009 UTC