ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/AnyEvent/lib/AnyEvent/Handle.pm

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.130 by root, Mon Jun 29 21:00:32 2009 UTC vs.
Revision 1.193 by root, Mon Mar 15 18:51:30 2010 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.45;
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
		65	sub _load_func($) {
		66	my $func = $_[0];
		67
		68	unless (defined &$func) {
		69	my $pkg = $func;
		70	do {
		71	$pkg =~ s/::[^:]+$//
		72	or return;
		73	eval "require $pkg";
		74	} until defined &$func;
		75	}
		76
		77	\&$func
		78	}
		79
64	=head1 METHODS	80	=head1 METHODS
65		81
66	=over 4	82	=over 4
67		83
68	=item B<new (%args)>	84	=item $handle = B<new> AnyEvent::Handle fh => $filehandle, key => value...
69		85
70	The constructor supports these arguments (all as key => value pairs).	86	The constructor supports these arguments (all as C<< key => value >> pairs).
71		87
72	=over 4	88	=over 4
73		89
74	=item fh => $filehandle [MANDATORY]	90	=item fh => $filehandle [C<fh> or C<connect> MANDATORY]
75		91
76	The filehandle this L<AnyEvent::Handle> object will operate on.	92	The filehandle this L<AnyEvent::Handle> object will operate on.
77
78	NOTE: The filehandle will be set to non-blocking mode (using	93	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	94	C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in
80	that mode.	95	that mode.
81		96
		97	=item connect => [$host, $service] [C<fh> or C<connect> MANDATORY]
		98
		99	Try to connect to the specified host and service (port), using
		100	C<AnyEvent::Socket::tcp_connect>. The C<$host> additionally becomes the
		101	default C<peername>.
		102
		103	You have to specify either this parameter, or C<fh>, above.
		104
		105	It is possible to push requests on the read and write queues, and modify
		106	properties of the stream, even while AnyEvent::Handle is connecting.
		107
		108	When this parameter is specified, then the C<on_prepare>,
		109	C<on_connect_error> and C<on_connect> callbacks will be called under the
		110	appropriate circumstances:
		111
		112	=over 4
		113
		114	=item on_prepare => $cb->($handle)
		115
		116	This (rarely used) callback is called before a new connection is
		117	attempted, but after the file handle has been created. It could be used to
		118	prepare the file handle with parameters required for the actual connect
		119	(as opposed to settings that can be changed when the connection is already
		120	established).
		121
		122	The return value of this callback should be the connect timeout value in
		123	seconds (or C<0>, or C<undef>, or the empty list, to indicate the default
		124	timeout is to be used).
		125
		126	=item on_connect => $cb->($handle, $host, $port, $retry->())
		127
		128	This callback is called when a connection has been successfully established.
		129
		130	The actual numeric host and port (the socket peername) are passed as
		131	parameters, together with a retry callback.
		132
		133	When, for some reason, the handle is not acceptable, then calling
		134	C<$retry> will continue with the next connection target (in case of
		135	multi-homed hosts or SRV records there can be multiple connection
		136	endpoints). At the time it is called the read and write queues, eof
		137	status, tls status and similar properties of the handle will have been
		138	reset.
		139
		140	In most cases, ignoring the C<$retry> parameter is the way to go.
		141
		142	=item on_connect_error => $cb->($handle, $message)
		143
		144	This callback is called when the connection could not be
		145	established. C<$!> will contain the relevant error code, and C<$message> a
		146	message describing it (usually the same as C<"$!">).
		147
		148	If this callback isn't specified, then C<on_error> will be called with a
		149	fatal error instead.
		150
		151	=back
		152
		153	=item on_error => $cb->($handle, $fatal, $message)
		154
		155	This is the error callback, which is called when, well, some error
		156	occured, such as not being able to resolve the hostname, failure to
		157	connect or a read error.
		158
		159	Some errors are fatal (which is indicated by C<$fatal> being true). On
		160	fatal errors the handle object will be destroyed (by a call to C<< ->
		161	destroy >>) after invoking the error callback (which means you are free to
		162	examine the handle object). Examples of fatal errors are an EOF condition
		163	with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors. In
		164	cases where the other side can close the connection at their will it is
		165	often easiest to not report C<EPIPE> errors in this callback.
		166
		167	AnyEvent::Handle tries to find an appropriate error code for you to check
		168	against, but in some cases (TLS errors), this does not work well. It is
		169	recommended to always output the C<$message> argument in human-readable
		170	error messages (it's usually the same as C<"$!">).
		171
		172	Non-fatal errors can be retried by simply returning, but it is recommended
		173	to simply ignore this parameter and instead abondon the handle object
		174	when this callback is invoked. Examples of non-fatal errors are timeouts
		175	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
		176
		177	On callback entrance, the value of C<$!> contains the operating system
		178	error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
		179	C<EPROTO>).
		180
		181	While not mandatory, it is I<highly> recommended to set this callback, as
		182	you will not be notified of errors otherwise. The default simply calls
		183	C<croak>.
		184
		185	=item on_read => $cb->($handle)
		186
		187	This sets the default read callback, which is called when data arrives
		188	and no read request is in the queue (unlike read queue callbacks, this
		189	callback will only be called when at least one octet of data is in the
		190	read buffer).
		191
		192	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
		193	method or access the C<< $handle->{rbuf} >> member directly. Note that you
		194	must not enlarge or modify the read buffer, you can only remove data at
		195	the beginning from it.
		196
		197	When an EOF condition is detected then AnyEvent::Handle will first try to
		198	feed all the remaining data to the queued callbacks and C<on_read> before
		199	calling the C<on_eof> callback. If no progress can be made, then a fatal
		200	error will be raised (with C<$!> set to C<EPIPE>).
		201
		202	Note that, unlike requests in the read queue, an C<on_read> callback
		203	doesn't mean you I<require> some data: if there is an EOF and there
		204	are outstanding read requests then an error will be flagged. With an
		205	C<on_read> callback, the C<on_eof> callback will be invoked.
		206
82	=item on_eof => $cb->($handle)	207	=item on_eof => $cb->($handle)
83		208
84	Set the callback to be called when an end-of-file condition is detected,	209	Set the callback to be called when an end-of-file condition is detected,
85	i.e. in the case of a socket, when the other side has closed the	210	i.e. in the case of a socket, when the other side has closed the
86	connection cleanly.	211	connection cleanly, and there are no outstanding read requests in the
		212	queue (if there are read requests, then an EOF counts as an unexpected
		213	connection close and will be flagged as an error).
87		214
88	For sockets, this just means that the other side has stopped sending data,	215	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	216	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	217	callback and continue writing data, as only the read part has been shut
91	down.	218	down.
92		219
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	220	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>.	221	set, then a fatal error will be raised with C<$!> set to <0>.
99
100	=item on_error => $cb->($handle, $fatal)
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	Non-fatal errors can be retried by simply returning, but it is recommended
113	to simply ignore this parameter and instead abondon the handle object
114	when this callback is invoked. Examples of non-fatal errors are timeouts
115	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
116
117	On callback entrance, the value of C<$!> contains the operating system
118	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).
119
120	While not mandatory, it is I<highly> recommended to set this callback, as
121	you will not be notified of errors otherwise. The default simply calls
122	C<croak>.
123
124	=item on_read => $cb->($handle)
125
126	This sets the default read callback, which is called when data arrives
127	and no read request is in the queue (unlike read queue callbacks, this
128	callback will only be called when at least one octet of data is in the
129	read buffer).
130
131	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
132	method or access the C<$handle->{rbuf}> member directly. Note that you
133	must not enlarge or modify the read buffer, you can only remove data at
134	the beginning from it.
135
136	When an EOF condition is detected then AnyEvent::Handle will first try to
137	feed all the remaining data to the queued callbacks and C<on_read> before
138	calling the C<on_eof> callback. If no progress can be made, then a fatal
139	error will be raised (with C<$!> set to C<EPIPE>).
140		222
141	=item on_drain => $cb->($handle)	223	=item on_drain => $cb->($handle)
142		224
143	This sets the callback that is called when the write buffer becomes empty	225	This sets the callback that is called when the write buffer becomes empty
144	(or when the callback is set and the buffer is empty already).	226	(or when the callback is set and the buffer is empty already).
…		…
151	memory and push it into the queue, but instead only read more data from	233	memory and push it into the queue, but instead only read more data from
152	the file when the write queue becomes empty.	234	the file when the write queue becomes empty.
153		235
154	=item timeout => $fractional_seconds	236	=item timeout => $fractional_seconds
155		237
		238	=item rtimeout => $fractional_seconds
		239
		240	=item wtimeout => $fractional_seconds
		241
156	If non-zero, then this enables an "inactivity" timeout: whenever this many	242	If non-zero, then these enables an "inactivity" timeout: whenever this
157	seconds pass without a successful read or write on the underlying file	243	many seconds pass without a successful read or write on the underlying
158	handle, the C<on_timeout> callback will be invoked (and if that one is	244	file handle (or a call to C<timeout_reset>), the C<on_timeout> callback
159	missing, a non-fatal C<ETIMEDOUT> error will be raised).	245	will be invoked (and if that one is missing, a non-fatal C<ETIMEDOUT>
		246	error will be raised).
		247
		248	There are three variants of the timeouts that work fully independent
		249	of each other, for both read and write, just read, and just write:
		250	C<timeout>, C<rtimeout> and C<wtimeout>, with corresponding callbacks
		251	C<on_timeout>, C<on_rtimeout> and C<on_wtimeout>, and reset functions
		252	C<timeout_reset>, C<rtimeout_reset>, and C<wtimeout_reset>.
160		253
161	Note that timeout processing is also active when you currently do not have	254	Note that timeout processing is also active when you currently do not have
162	any outstanding read or write requests: If you plan to keep the connection	255	any outstanding read or write requests: If you plan to keep the connection
163	idle then you should disable the timout temporarily or ignore the timeout	256	idle then you should disable the timout temporarily or ignore the timeout
164	in the C<on_timeout> callback, in which case AnyEvent::Handle will simply	257	in the C<on_timeout> callback, in which case AnyEvent::Handle will simply
…		…
208	accomplishd by setting this option to a true value.	301	accomplishd by setting this option to a true value.
209		302
210	The default is your opertaing system's default behaviour (most likely	303	The default is your opertaing system's default behaviour (most likely
211	enabled), this option explicitly enables or disables it, if possible.	304	enabled), this option explicitly enables or disables it, if possible.
212		305
		306	=item keepalive => <boolean>
		307
		308	Enables (default disable) the SO_KEEPALIVE option on the stream socket:
		309	normally, TCP connections have no time-out once established, so TCP
		310	connections, once established, can stay alive forever even when the other
		311	side has long gone. TCP keepalives are a cheap way to take down long-lived
		312	TCP connections whent he other side becomes unreachable. While the default
		313	is OS-dependent, TCP keepalives usually kick in after around two hours,
		314	and, if the other side doesn't reply, take down the TCP connection some 10
		315	to 15 minutes later.
		316
		317	It is harmless to specify this option for file handles that do not support
		318	keepalives, and enabling it on connections that are potentially long-lived
		319	is usually a good idea.
		320
		321	=item oobinline => <boolean>
		322
		323	BSD majorly fucked up the implementation of TCP urgent data. The result
		324	is that almost no OS implements TCP according to the specs, and every OS
		325	implements it slightly differently.
		326
		327	If you want to handle TCP urgent data, then setting this flag (the default
		328	is enabled) gives you the most portable way of getting urgent data, by
		329	putting it into the stream.
		330
		331	Since BSD emulation of OOB data on top of TCP's urgent data can have
		332	security implications, AnyEvent::Handle sets this flag automatically
		333	unless explicitly specified. Note that setting this flag after
		334	establishing a connection I<may> be a bit too late (data loss could
		335	already have occured on BSD systems), but at least it will protect you
		336	from most attacks.
		337
213	=item read_size => <bytes>	338	=item read_size => <bytes>
214		339
215	The default read block size (the amount of bytes this module will	340	The default read block size (the amount of bytes this module will
216	try to read during each loop iteration, which affects memory	341	try to read during each loop iteration, which affects memory
217	requirements). Default: C<8192>.	342	requirements). Default: C<8192>.
…		…
237		362
238	This will not work for partial TLS data that could not be encoded	363	This will not work for partial TLS data that could not be encoded
239	yet. This data will be lost. Calling the C<stoptls> method in time might	364	yet. This data will be lost. Calling the C<stoptls> method in time might
240	help.	365	help.
241		366
		367	=item peername => $string
		368
		369	A string used to identify the remote site - usually the DNS hostname
		370	(I<not> IDN!) used to create the connection, rarely the IP address.
		371
		372	Apart from being useful in error messages, this string is also used in TLS
		373	peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This
		374	verification will be skipped when C<peername> is not specified or
		375	C<undef>.
		376
242	=item tls => "accept" | "connect" | Net::SSLeay::SSL object	377	=item tls => "accept" | "connect" | Net::SSLeay::SSL object
243		378
244	When this parameter is given, it enables TLS (SSL) mode, that means	379	When this parameter is given, it enables TLS (SSL) mode, that means
245	AnyEvent will start a TLS handshake as soon as the conenction has been	380	AnyEvent will start a TLS handshake as soon as the connection has been
246	established and will transparently encrypt/decrypt data afterwards.	381	established and will transparently encrypt/decrypt data afterwards.
		382
		383	All TLS protocol errors will be signalled as C<EPROTO>, with an
		384	appropriate error message.
247		385
248	TLS mode requires Net::SSLeay to be installed (it will be loaded	386	TLS mode requires Net::SSLeay to be installed (it will be loaded
249	automatically when you try to create a TLS handle): this module doesn't	387	automatically when you try to create a TLS handle): this module doesn't
250	have a dependency on that module, so if your module requires it, you have	388	have a dependency on that module, so if your module requires it, you have
251	to add the dependency yourself.	389	to add the dependency yourself.
…		…
255	mode.	393	mode.
256		394
257	You can also provide your own TLS connection object, but you have	395	You can also provide your own TLS connection object, but you have
258	to make sure that you call either C<Net::SSLeay::set_connect_state>	396	to make sure that you call either C<Net::SSLeay::set_connect_state>
259	or C<Net::SSLeay::set_accept_state> on it before you pass it to	397	or C<Net::SSLeay::set_accept_state> on it before you pass it to
260	AnyEvent::Handle.	398	AnyEvent::Handle. Also, this module will take ownership of this connection
		399	object.
		400
		401	At some future point, AnyEvent::Handle might switch to another TLS
		402	implementation, then the option to use your own session object will go
		403	away.
261		404
262	B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,	405	B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,
263	passing in the wrong integer will lead to certain crash. This most often	406	passing in the wrong integer will lead to certain crash. This most often
264	happens when one uses a stylish C<< tls => 1 >> and is surprised about the	407	happens when one uses a stylish C<< tls => 1 >> and is surprised about the
265	segmentation fault.	408	segmentation fault.
266		409
267	See the C<< ->starttls >> method for when need to start TLS negotiation later.	410	See the C<< ->starttls >> method for when need to start TLS negotiation later.
268		411
269	=item tls_ctx => $ssl_ctx	412	=item tls_ctx => $anyevent_tls
270		413
271	Use the given C<Net::SSLeay::CTX> object to create the new TLS connection	414	Use the given C<AnyEvent::TLS> object to create the new TLS connection
272	(unless a connection object was specified directly). If this parameter is	415	(unless a connection object was specified directly). If this parameter is
273	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	416	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
		417
		418	Instead of an object, you can also specify a hash reference with C<< key
		419	=> value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a
		420	new TLS context object.
		421
		422	=item on_starttls => $cb->($handle, $success[, $error_message])
		423
		424	This callback will be invoked when the TLS/SSL handshake has finished. If
		425	C<$success> is true, then the TLS handshake succeeded, otherwise it failed
		426	(C<on_stoptls> will not be called in this case).
		427
		428	The session in C<< $handle->{tls} >> can still be examined in this
		429	callback, even when the handshake was not successful.
		430
		431	TLS handshake failures will not cause C<on_error> to be invoked when this
		432	callback is in effect, instead, the error message will be passed to C<on_starttls>.
		433
		434	Without this callback, handshake failures lead to C<on_error> being
		435	called, as normal.
		436
		437	Note that you cannot call C<starttls> right again in this callback. If you
		438	need to do that, start an zero-second timer instead whose callback can
		439	then call C<< ->starttls >> again.
		440
		441	=item on_stoptls => $cb->($handle)
		442
		443	When a SSLv3/TLS shutdown/close notify/EOF is detected and this callback is
		444	set, then it will be invoked after freeing the TLS session. If it is not,
		445	then a TLS shutdown condition will be treated like a normal EOF condition
		446	on the handle.
		447
		448	The session in C<< $handle->{tls} >> can still be examined in this
		449	callback.
		450
		451	This callback will only be called on TLS shutdowns, not when the
		452	underlying handle signals EOF.
274		453
275	=item json => JSON or JSON::XS object	454	=item json => JSON or JSON::XS object
276		455
277	This is the json coder object used by the C<json> read and write types.	456	This is the json coder object used by the C<json> read and write types.
278		457
…		…
287		466
288	=cut	467	=cut
289		468
290	sub new {	469	sub new {
291	my $class = shift;	470	my $class = shift;
292
293	my $self = bless { @_ }, $class;	471	my $self = bless { @_ }, $class;
294		472
295	$self->{fh} or Carp::croak "mandatory argument fh is missing";	473	if ($self->{fh}) {
		474	$self->_start;
		475	return unless $self->{fh}; # could be gone by now
		476
		477	} elsif ($self->{connect}) {
		478	require AnyEvent::Socket;
		479
		480	$self->{peername} = $self->{connect}[0]
		481	unless exists $self->{peername};
		482
		483	$self->{_skip_drain_rbuf} = 1;
		484
		485	{
		486	Scalar::Util::weaken (my $self = $self);
		487
		488	$self->{_connect} =
		489	AnyEvent::Socket::tcp_connect (
		490	$self->{connect}[0],
		491	$self->{connect}[1],
		492	sub {
		493	my ($fh, $host, $port, $retry) = @_;
		494
		495	if ($fh) {
		496	$self->{fh} = $fh;
		497
		498	delete $self->{_skip_drain_rbuf};
		499	$self->_start;
		500
		501	$self->{on_connect}
		502	and $self->{on_connect}($self, $host, $port, sub {
		503	delete @$self{qw(fh _tw _rtw _wtw _ww _rw _eof _queue rbuf _wbuf tls _tls_rbuf _tls_wbuf)};
		504	$self->{_skip_drain_rbuf} = 1;
		505	&$retry;
		506	});
		507
		508	} else {
		509	if ($self->{on_connect_error}) {
		510	$self->{on_connect_error}($self, "$!");
		511	$self->destroy;
		512	} else {
		513	$self->_error ($!, 1);
		514	}
		515	}
		516	},
		517	sub {
		518	local $self->{fh} = $_[0];
		519
		520	$self->{on_prepare}
		521	? $self->{on_prepare}->($self)
		522	: ()
		523	}
		524	);
		525	}
		526
		527	} else {
		528	Carp::croak "AnyEvent::Handle: either an existing fh or the connect parameter must be specified";
		529	}
		530
		531	$self
		532	}
		533
		534	sub _start {
		535	my ($self) = @_;
296		536
297	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	537	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
298		538
		539	$self->{_activity} =
		540	$self->{_ractivity} =
		541	$self->{_wactivity} = AE::now;
		542
		543	$self->timeout (delete $self->{timeout} ) if $self->{timeout};
		544	$self->rtimeout (delete $self->{rtimeout} ) if $self->{rtimeout};
		545	$self->wtimeout (delete $self->{wtimeout} ) if $self->{wtimeout};
		546
		547	$self->no_delay (delete $self->{no_delay} ) if exists $self->{no_delay} && $self->{no_delay};
		548	$self->keepalive (delete $self->{keepalive}) if exists $self->{keepalive} && $self->{keepalive};
		549
		550	$self->oobinline (exists $self->{oobinline} ? delete $self->{oobinline} : 1);
		551
299	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})	552	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
300	if $self->{tls};	553	if $self->{tls};
301		554
302	$self->{_activity} = AnyEvent->now;
303	$self->_timeout;
304
305	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};	555	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
306	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
307		556
308	$self->start_read	557	$self->start_read
309	if $self->{on_read};	558	if $self->{on_read} || @{ $self->{_queue} };
310		559
311	$self	560	$self->_drain_wbuf;
312	}
313
314	sub _shutdown {
315	my ($self) = @_;
316
317	delete @$self{qw(_tw _rw _ww fh rbuf wbuf on_read _queue)};
318
319	&_freetls;
320	}	561	}
321		562
322	sub _error {	563	sub _error {
323	my ($self, $errno, $fatal) = @_;	564	my ($self, $errno, $fatal, $message) = @_;
324
325	$self->_shutdown
326	if $fatal;
327		565
328	$! = $errno;	566	$! = $errno;
		567	$message ||= "$!";
329		568
330	if ($self->{on_error}) {	569	if ($self->{on_error}) {
331	$self->{on_error}($self, $fatal);	570	$self->{on_error}($self, $fatal, $message);
332	} elsif ($self->{fh}) {	571	$self->destroy if $fatal;
		572	} elsif ($self->{fh} || $self->{connect}) {
		573	$self->destroy;
333	Carp::croak "AnyEvent::Handle uncaught error: $!";	574	Carp::croak "AnyEvent::Handle uncaught error: $message";
334	}	575	}
335	}	576	}
336		577
337	=item $fh = $handle->fh	578	=item $fh = $handle->fh
338		579
…		…
362	$_[0]{on_eof} = $_[1];	603	$_[0]{on_eof} = $_[1];
363	}	604	}
364		605
365	=item $handle->on_timeout ($cb)	606	=item $handle->on_timeout ($cb)
366		607
367	Replace the current C<on_timeout> callback, or disables the callback (but	608	=item $handle->on_rtimeout ($cb)
368	not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
369	argument and method.
370		609
371	=cut	610	=item $handle->on_wtimeout ($cb)
372		611
373	sub on_timeout {	612	Replace the current C<on_timeout>, C<on_rtimeout> or C<on_wtimeout>
374	$_[0]{on_timeout} = $_[1];	613	callback, or disables the callback (but not the timeout) if C<$cb> =
375	}	614	C<undef>. See the C<timeout> constructor argument and method.
		615
		616	=cut
		617
		618	# see below
376		619
377	=item $handle->autocork ($boolean)	620	=item $handle->autocork ($boolean)
378		621
379	Enables or disables the current autocork behaviour (see C<autocork>	622	Enables or disables the current autocork behaviour (see C<autocork>
380	constructor argument). Changes will only take effect on the next write.	623	constructor argument). Changes will only take effect on the next write.
…		…
395	sub no_delay {	638	sub no_delay {
396	$_[0]{no_delay} = $_[1];	639	$_[0]{no_delay} = $_[1];
397		640
398	eval {	641	eval {
399	local $SIG{__DIE__};	642	local $SIG{__DIE__};
400	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];	643	setsockopt $_[0]{fh}, Socket::IPPROTO_TCP (), Socket::TCP_NODELAY (), int $_[1]
		644	if $_[0]{fh};
401	};	645	};
402	}	646	}
403		647
		648	=item $handle->keepalive ($boolean)
		649
		650	Enables or disables the C<keepalive> setting (see constructor argument of
		651	the same name for details).
		652
		653	=cut
		654
		655	sub keepalive {
		656	$_[0]{keepalive} = $_[1];
		657
		658	eval {
		659	local $SIG{__DIE__};
		660	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
		661	if $_[0]{fh};
		662	};
		663	}
		664
		665	=item $handle->oobinline ($boolean)
		666
		667	Enables or disables the C<oobinline> setting (see constructor argument of
		668	the same name for details).
		669
		670	=cut
		671
		672	sub oobinline {
		673	$_[0]{oobinline} = $_[1];
		674
		675	eval {
		676	local $SIG{__DIE__};
		677	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_OOBINLINE (), int $_[1]
		678	if $_[0]{fh};
		679	};
		680	}
		681
		682	=item $handle->keepalive ($boolean)
		683
		684	Enables or disables the C<keepalive> setting (see constructor argument of
		685	the same name for details).
		686
		687	=cut
		688
		689	sub keepalive {
		690	$_[0]{keepalive} = $_[1];
		691
		692	eval {
		693	local $SIG{__DIE__};
		694	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
		695	if $_[0]{fh};
		696	};
		697	}
		698
		699	=item $handle->on_starttls ($cb)
		700
		701	Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument).
		702
		703	=cut
		704
		705	sub on_starttls {
		706	$_[0]{on_starttls} = $_[1];
		707	}
		708
		709	=item $handle->on_stoptls ($cb)
		710
		711	Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).
		712
		713	=cut
		714
		715	sub on_stoptls {
		716	$_[0]{on_stoptls} = $_[1];
		717	}
		718
		719	=item $handle->rbuf_max ($max_octets)
		720
		721	Configures the C<rbuf_max> setting (C<undef> disables it).
		722
		723	=cut
		724
		725	sub rbuf_max {
		726	$_[0]{rbuf_max} = $_[1];
		727	}
		728
404	#############################################################################	729	#############################################################################
405		730
406	=item $handle->timeout ($seconds)	731	=item $handle->timeout ($seconds)
407		732
		733	=item $handle->rtimeout ($seconds)
		734
		735	=item $handle->wtimeout ($seconds)
		736
408	Configures (or disables) the inactivity timeout.	737	Configures (or disables) the inactivity timeout.
409		738
410	=cut	739	=item $handle->timeout_reset
411		740
412	sub timeout {	741	=item $handle->rtimeout_reset
		742
		743	=item $handle->wtimeout_reset
		744
		745	Reset the activity timeout, as if data was received or sent.
		746
		747	These methods are cheap to call.
		748
		749	=cut
		750
		751	for my $dir ("", "r", "w") {
		752	my $timeout = "${dir}timeout";
		753	my $tw = "_${dir}tw";
		754	my $on_timeout = "on_${dir}timeout";
		755	my $activity = "_${dir}activity";
		756	my $cb;
		757
		758	*$on_timeout = sub {
		759	$_[0]{$on_timeout} = $_[1];
		760	};
		761
		762	*$timeout = sub {
413	my ($self, $timeout) = @_;	763	my ($self, $new_value) = @_;
414		764
415	$self->{timeout} = $timeout;	765	$self->{$timeout} = $new_value;
416	$self->_timeout;	766	delete $self->{$tw}; &$cb;
417	}	767	};
418		768
		769	*{"${dir}timeout_reset"} = sub {
		770	$_[0]{$activity} = AE::now;
		771	};
		772
		773	# main workhorse:
419	# reset the timeout watcher, as neccessary	774	# reset the timeout watcher, as neccessary
420	# also check for time-outs	775	# also check for time-outs
421	sub _timeout {	776	$cb = sub {
422	my ($self) = @_;	777	my ($self) = @_;
423		778
424	if ($self->{timeout}) {	779	if ($self->{$timeout} && $self->{fh}) {
425	my $NOW = AnyEvent->now;	780	my $NOW = AE::now;
426		781
427	# when would the timeout trigger?	782	# when would the timeout trigger?
428	my $after = $self->{_activity} + $self->{timeout} - $NOW;	783	my $after = $self->{$activity} + $self->{$timeout} - $NOW;
429		784
430	# now or in the past already?	785	# now or in the past already?
431	if ($after <= 0) {	786	if ($after <= 0) {
432	$self->{_activity} = $NOW;	787	$self->{$activity} = $NOW;
433		788
434	if ($self->{on_timeout}) {	789	if ($self->{$on_timeout}) {
435	$self->{on_timeout}($self);	790	$self->{$on_timeout}($self);
436	} else {	791	} else {
437	$self->_error (&Errno::ETIMEDOUT);	792	$self->_error (Errno::ETIMEDOUT);
		793	}
		794
		795	# callback could have changed timeout value, optimise
		796	return unless $self->{$timeout};
		797
		798	# calculate new after
		799	$after = $self->{$timeout};
438	}	800	}
439		801
440	# callback could have changed timeout value, optimise	802	Scalar::Util::weaken $self;
441	return unless $self->{timeout};	803	return unless $self; # ->error could have destroyed $self
442		804
443	# calculate new after	805	$self->{$tw} ||= AE::timer $after, 0, sub {
444	$after = $self->{timeout};	806	delete $self->{$tw};
		807	$cb->($self);
		808	};
		809	} else {
		810	delete $self->{$tw};
445	}	811	}
446
447	Scalar::Util::weaken $self;
448	return unless $self; # ->error could have destroyed $self
449
450	$self->{_tw} ||= AnyEvent->timer (after => $after, cb => sub {
451	delete $self->{_tw};
452	$self->_timeout;
453	});
454	} else {
455	delete $self->{_tw};
456	}	812	}
457	}	813	}
458		814
459	#############################################################################	815	#############################################################################
460		816
…		…
475		831
476	=item $handle->on_drain ($cb)	832	=item $handle->on_drain ($cb)
477		833
478	Sets the C<on_drain> callback or clears it (see the description of	834	Sets the C<on_drain> callback or clears it (see the description of
479	C<on_drain> in the constructor).	835	C<on_drain> in the constructor).
		836
		837	This method may invoke callbacks (and therefore the handle might be
		838	destroyed after it returns).
480		839
481	=cut	840	=cut
482		841
483	sub on_drain {	842	sub on_drain {
484	my ($self, $cb) = @_;	843	my ($self, $cb) = @_;
…		…
493		852
494	Queues the given scalar to be written. You can push as much data as you	853	Queues the given scalar to be written. You can push as much data as you
495	want (only limited by the available memory), as C<AnyEvent::Handle>	854	want (only limited by the available memory), as C<AnyEvent::Handle>
496	buffers it independently of the kernel.	855	buffers it independently of the kernel.
497		856
		857	This method may invoke callbacks (and therefore the handle might be
		858	destroyed after it returns).
		859
498	=cut	860	=cut
499		861
500	sub _drain_wbuf {	862	sub _drain_wbuf {
501	my ($self) = @_;	863	my ($self) = @_;
502		864
…		…
505	Scalar::Util::weaken $self;	867	Scalar::Util::weaken $self;
506		868
507	my $cb = sub {	869	my $cb = sub {
508	my $len = syswrite $self->{fh}, $self->{wbuf};	870	my $len = syswrite $self->{fh}, $self->{wbuf};
509		871
510	if ($len >= 0) {	872	if (defined $len) {
511	substr $self->{wbuf}, 0, $len, "";	873	substr $self->{wbuf}, 0, $len, "";
512		874
513	$self->{_activity} = AnyEvent->now;	875	$self->{_activity} = $self->{_wactivity} = AE::now;
514		876
515	$self->{on_drain}($self)	877	$self->{on_drain}($self)
516	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})	878	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
517	&& $self->{on_drain};	879	&& $self->{on_drain};
518		880
…		…
524		886
525	# try to write data immediately	887	# try to write data immediately
526	$cb->() unless $self->{autocork};	888	$cb->() unless $self->{autocork};
527		889
528	# if still data left in wbuf, we need to poll	890	# if still data left in wbuf, we need to poll
529	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	891	$self->{_ww} = AE::io $self->{fh}, 1, $cb
530	if length $self->{wbuf};	892	if length $self->{wbuf};
531	};	893	};
532	}	894	}
533		895
534	our %WH;	896	our %WH;
535		897
		898	# deprecated
536	sub register_write_type($$) {	899	sub register_write_type($$) {
537	$WH{$_[0]} = $_[1];	900	$WH{$_[0]} = $_[1];
538	}	901	}
539		902
540	sub push_write {	903	sub push_write {
541	my $self = shift;	904	my $self = shift;
542		905
543	if (@_ > 1) {	906	if (@_ > 1) {
544	my $type = shift;	907	my $type = shift;
545		908
		909	@_ = ($WH{$type} ||= _load_func "$type\::anyevent_write_type"
546	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	910	or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_write")
547	->($self, @_);	911	->($self, @_);
548	}	912	}
549		913
		914	# we downgrade here to avoid hard-to-track-down bugs,
		915	# and diagnose the problem earlier and better.
		916
550	if ($self->{tls}) {	917	if ($self->{tls}) {
551	$self->{_tls_wbuf} .= $_[0];	918	utf8::downgrade $self->{_tls_wbuf} .= $_[0];
552		919	&_dotls ($self) if $self->{fh};
553	&_dotls ($self);
554	} else {	920	} else {
555	$self->{wbuf} .= $_[0];	921	utf8::downgrade $self->{wbuf} .= $_[0];
556	$self->_drain_wbuf;	922	$self->_drain_wbuf if $self->{fh};
557	}	923	}
558	}	924	}
559		925
560	=item $handle->push_write (type => @args)	926	=item $handle->push_write (type => @args)
561		927
562	Instead of formatting your data yourself, you can also let this module do	928	Instead of formatting your data yourself, you can also let this module
563	the job by specifying a type and type-specific arguments.	929	do the job by specifying a type and type-specific arguments. You
		930	can also specify the (fully qualified) name of a package, in which
		931	case AnyEvent tries to load the package and then expects to find the
		932	C<anyevent_read_type> function inside (see "custom write types", below).
564		933
565	Predefined types are (if you have ideas for additional types, feel free to	934	Predefined types are (if you have ideas for additional types, feel free to
566	drop by and tell us):	935	drop by and tell us):
567		936
568	=over 4	937	=over 4
…		…
625	Other languages could read single lines terminated by a newline and pass	994	Other languages could read single lines terminated by a newline and pass
626	this line into their JSON decoder of choice.	995	this line into their JSON decoder of choice.
627		996
628	=cut	997	=cut
629		998
		999	sub json_coder() {
		1000	eval { require JSON::XS; JSON::XS->new->utf8 }
		1001	|| do { require JSON; JSON->new->utf8 }
		1002	}
		1003
630	register_write_type json => sub {	1004	register_write_type json => sub {
631	my ($self, $ref) = @_;	1005	my ($self, $ref) = @_;
632		1006
633	require JSON;	1007	my $json = $self->{json} ||= json_coder;
634		1008
635	$self->{json} ? $self->{json}->encode ($ref)	1009	$json->encode ($ref)
636	: JSON::encode_json ($ref)
637	};	1010	};
638		1011
639	=item storable => $reference	1012	=item storable => $reference
640		1013
641	Freezes the given reference using L<Storable> and writes it to the	1014	Freezes the given reference using L<Storable> and writes it to the
…		…
651	pack "w/a*", Storable::nfreeze ($ref)	1024	pack "w/a*", Storable::nfreeze ($ref)
652	};	1025	};
653		1026
654	=back	1027	=back
655		1028
656	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	1029	=item $handle->push_shutdown
657		1030
658	This function (not method) lets you add your own types to C<push_write>.	1031	Sometimes you know you want to close the socket after writing your data
		1032	before it was actually written. One way to do that is to replace your
		1033	C<on_drain> handler by a callback that shuts down the socket (and set
		1034	C<low_water_mark> to C<0>). This method is a shorthand for just that, and
		1035	replaces the C<on_drain> callback with:
		1036
		1037	sub { shutdown $_[0]{fh}, 1 } # for push_shutdown
		1038
		1039	This simply shuts down the write side and signals an EOF condition to the
		1040	the peer.
		1041
		1042	You can rely on the normal read queue and C<on_eof> handling
		1043	afterwards. This is the cleanest way to close a connection.
		1044
		1045	This method may invoke callbacks (and therefore the handle might be
		1046	destroyed after it returns).
		1047
		1048	=cut
		1049
		1050	sub push_shutdown {
		1051	my ($self) = @_;
		1052
		1053	delete $self->{low_water_mark};
		1054	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });
		1055	}
		1056
		1057	=item custom write types - Package::anyevent_write_type $handle, @args
		1058
		1059	Instead of one of the predefined types, you can also specify the name of
		1060	a package. AnyEvent will try to load the package and then expects to find
		1061	a function named C<anyevent_write_type> inside. If it isn't found, it
		1062	progressively tries to load the parent package until it either finds the
		1063	function (good) or runs out of packages (bad).
		1064
659	Whenever the given C<type> is used, C<push_write> will invoke the code	1065	Whenever the given C<type> is used, C<push_write> will the function with
660	reference with the handle object and the remaining arguments.	1066	the handle object and the remaining arguments.
661		1067
662	The code reference is supposed to return a single octet string that will	1068	The function is supposed to return a single octet string that will be
663	be appended to the write buffer.	1069	appended to the write buffer, so you cna mentally treat this function as a
		1070	"arguments to on-the-wire-format" converter.
664		1071
665	Note that this is a function, and all types registered this way will be	1072	Example: implement a custom write type C<join> that joins the remaining
666	global, so try to use unique names.	1073	arguments using the first one.
		1074
		1075	$handle->push_write (My::Type => " ", 1,2,3);
		1076
		1077	# uses the following package, which can be defined in the "My::Type" or in
		1078	# the "My" modules to be auto-loaded, or just about anywhere when the
		1079	# My::Type::anyevent_write_type is defined before invoking it.
		1080
		1081	package My::Type;
		1082
		1083	sub anyevent_write_type {
		1084	my ($handle, $delim, @args) = @_;
		1085
		1086	join $delim, @args
		1087	}
667		1088
668	=cut	1089	=cut
669		1090
670	#############################################################################	1091	#############################################################################
671		1092
…		…
753	=cut	1174	=cut
754		1175
755	sub _drain_rbuf {	1176	sub _drain_rbuf {
756	my ($self) = @_;	1177	my ($self) = @_;
757		1178
		1179	# avoid recursion
		1180	return if $self->{_skip_drain_rbuf};
758	local $self->{_in_drain} = 1;	1181	local $self->{_skip_drain_rbuf} = 1;
759
760	if (
761	defined $self->{rbuf_max}
762	&& $self->{rbuf_max} < length $self->{rbuf}
763	) {
764	$self->_error (&Errno::ENOSPC, 1), return;
765	}
766		1182
767	while () {	1183	while () {
768	# we need to use a separate tls read buffer, as we must not receive data while	1184	# we need to use a separate tls read buffer, as we must not receive data while
769	# we are draining the buffer, and this can only happen with TLS.	1185	# we are draining the buffer, and this can only happen with TLS.
770	$self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf};	1186	$self->{rbuf} .= delete $self->{_tls_rbuf}
		1187	if exists $self->{_tls_rbuf};
771		1188
772	my $len = length $self->{rbuf};	1189	my $len = length $self->{rbuf};
773		1190
774	if (my $cb = shift @{ $self->{_queue} }) {	1191	if (my $cb = shift @{ $self->{_queue} }) {
775	unless ($cb->($self)) {	1192	unless ($cb->($self)) {
776	if ($self->{_eof}) {	1193	# no progress can be made
777	# no progress can be made (not enough data and no data forthcoming)	1194	# (not enough data and no data forthcoming)
778	$self->_error (&Errno::EPIPE, 1), return;	1195	$self->_error (Errno::EPIPE, 1), return
779	}	1196	if $self->{_eof};
780		1197
781	unshift @{ $self->{_queue} }, $cb;	1198	unshift @{ $self->{_queue} }, $cb;
782	last;	1199	last;
783	}	1200	}
784	} elsif ($self->{on_read}) {	1201	} elsif ($self->{on_read}) {
…		…
791	&& !@{ $self->{_queue} } # and the queue is still empty	1208	&& !@{ $self->{_queue} } # and the queue is still empty
792	&& $self->{on_read} # but we still have on_read	1209	&& $self->{on_read} # but we still have on_read
793	) {	1210	) {
794	# no further data will arrive	1211	# no further data will arrive
795	# so no progress can be made	1212	# so no progress can be made
796	$self->_error (&Errno::EPIPE, 1), return	1213	$self->_error (Errno::EPIPE, 1), return
797	if $self->{_eof};	1214	if $self->{_eof};
798		1215
799	last; # more data might arrive	1216	last; # more data might arrive
800	}	1217	}
801	} else {	1218	} else {
…		…
804	last;	1221	last;
805	}	1222	}
806	}	1223	}
807		1224
808	if ($self->{_eof}) {	1225	if ($self->{_eof}) {
809	if ($self->{on_eof}) {	1226	$self->{on_eof}
810	$self->{on_eof}($self)	1227	? $self->{on_eof}($self)
811	} else {	1228	: $self->_error (0, 1, "Unexpected end-of-file");
812	$self->_error (0, 1);	1229
813	}	1230	return;
		1231	}
		1232
		1233	if (
		1234	defined $self->{rbuf_max}
		1235	&& $self->{rbuf_max} < length $self->{rbuf}
		1236	) {
		1237	$self->_error (Errno::ENOSPC, 1), return;
814	}	1238	}
815		1239
816	# may need to restart read watcher	1240	# may need to restart read watcher
817	unless ($self->{_rw}) {	1241	unless ($self->{_rw}) {
818	$self->start_read	1242	$self->start_read
…		…
824		1248
825	This replaces the currently set C<on_read> callback, or clears it (when	1249	This replaces the currently set C<on_read> callback, or clears it (when
826	the new callback is C<undef>). See the description of C<on_read> in the	1250	the new callback is C<undef>). See the description of C<on_read> in the
827	constructor.	1251	constructor.
828		1252
		1253	This method may invoke callbacks (and therefore the handle might be
		1254	destroyed after it returns).
		1255
829	=cut	1256	=cut
830		1257
831	sub on_read {	1258	sub on_read {
832	my ($self, $cb) = @_;	1259	my ($self, $cb) = @_;
833		1260
834	$self->{on_read} = $cb;	1261	$self->{on_read} = $cb;
835	$self->_drain_rbuf if $cb && !$self->{_in_drain};	1262	$self->_drain_rbuf if $cb;
836	}	1263	}
837		1264
838	=item $handle->rbuf	1265	=item $handle->rbuf
839		1266
840	Returns the read buffer (as a modifiable lvalue).	1267	Returns the read buffer (as a modifiable lvalue).
…		…
872		1299
873	If enough data was available, then the callback must remove all data it is	1300	If enough data was available, then the callback must remove all data it is
874	interested in (which can be none at all) and return a true value. After returning	1301	interested in (which can be none at all) and return a true value. After returning
875	true, it will be removed from the queue.	1302	true, it will be removed from the queue.
876		1303
		1304	These methods may invoke callbacks (and therefore the handle might be
		1305	destroyed after it returns).
		1306
877	=cut	1307	=cut
878		1308
879	our %RH;	1309	our %RH;
880		1310
881	sub register_read_type($$) {	1311	sub register_read_type($$) {
…		…
887	my $cb = pop;	1317	my $cb = pop;
888		1318
889	if (@_) {	1319	if (@_) {
890	my $type = shift;	1320	my $type = shift;
891		1321
		1322	$cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type"
892	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	1323	or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_read")
893	->($self, $cb, @_);	1324	->($self, $cb, @_);
894	}	1325	}
895		1326
896	push @{ $self->{_queue} }, $cb;	1327	push @{ $self->{_queue} }, $cb;
897	$self->_drain_rbuf unless $self->{_in_drain};	1328	$self->_drain_rbuf;
898	}	1329	}
899		1330
900	sub unshift_read {	1331	sub unshift_read {
901	my $self = shift;	1332	my $self = shift;
902	my $cb = pop;	1333	my $cb = pop;
…		…
906		1337
907	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")	1338	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")
908	->($self, $cb, @_);	1339	->($self, $cb, @_);
909	}	1340	}
910		1341
911
912	unshift @{ $self->{_queue} }, $cb;	1342	unshift @{ $self->{_queue} }, $cb;
913	$self->_drain_rbuf unless $self->{_in_drain};	1343	$self->_drain_rbuf;
914	}	1344	}
915		1345
916	=item $handle->push_read (type => @args, $cb)	1346	=item $handle->push_read (type => @args, $cb)
917		1347
918	=item $handle->unshift_read (type => @args, $cb)	1348	=item $handle->unshift_read (type => @args, $cb)
919		1349
920	Instead of providing a callback that parses the data itself you can chose	1350	Instead of providing a callback that parses the data itself you can chose
921	between a number of predefined parsing formats, for chunks of data, lines	1351	between a number of predefined parsing formats, for chunks of data, lines
922	etc.	1352	etc. You can also specify the (fully qualified) name of a package, in
		1353	which case AnyEvent tries to load the package and then expects to find the
		1354	C<anyevent_read_type> function inside (see "custom read types", below).
923		1355
924	Predefined types are (if you have ideas for additional types, feel free to	1356	Predefined types are (if you have ideas for additional types, feel free to
925	drop by and tell us):	1357	drop by and tell us):
926		1358
927	=over 4	1359	=over 4
…		…
1051	return 1;	1483	return 1;
1052	}	1484	}
1053		1485
1054	# reject	1486	# reject
1055	if ($reject && $$rbuf =~ $reject) {	1487	if ($reject && $$rbuf =~ $reject) {
1056	$self->_error (&Errno::EBADMSG);	1488	$self->_error (Errno::EBADMSG);
1057	}	1489	}
1058		1490
1059	# skip	1491	# skip
1060	if ($skip && $$rbuf =~ $skip) {	1492	if ($skip && $$rbuf =~ $skip) {
1061	$data .= substr $$rbuf, 0, $+[0], "";	1493	$data .= substr $$rbuf, 0, $+[0], "";
…		…
1077	my ($self, $cb) = @_;	1509	my ($self, $cb) = @_;
1078		1510
1079	sub {	1511	sub {
1080	unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {	1512	unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {
1081	if ($_[0]{rbuf} =~ /[^0-9]/) {	1513	if ($_[0]{rbuf} =~ /[^0-9]/) {
1082	$self->_error (&Errno::EBADMSG);	1514	$self->_error (Errno::EBADMSG);
1083	}	1515	}
1084	return;	1516	return;
1085	}	1517	}
1086		1518
1087	my $len = $1;	1519	my $len = $1;
…		…
1090	my $string = $_[1];	1522	my $string = $_[1];
1091	$_[0]->unshift_read (chunk => 1, sub {	1523	$_[0]->unshift_read (chunk => 1, sub {
1092	if ($_[1] eq ",") {	1524	if ($_[1] eq ",") {
1093	$cb->($_[0], $string);	1525	$cb->($_[0], $string);
1094	} else {	1526	} else {
1095	$self->_error (&Errno::EBADMSG);	1527	$self->_error (Errno::EBADMSG);
1096	}	1528	}
1097	});	1529	});
1098	});	1530	});
1099		1531
1100	1	1532	1
…		…
1167	=cut	1599	=cut
1168		1600
1169	register_read_type json => sub {	1601	register_read_type json => sub {
1170	my ($self, $cb) = @_;	1602	my ($self, $cb) = @_;
1171		1603
1172	require JSON;	1604	my $json = $self->{json} ||= json_coder;
1173		1605
1174	my $data;	1606	my $data;
1175	my $rbuf = \$self->{rbuf};	1607	my $rbuf = \$self->{rbuf};
1176
1177	my $json = $self->{json} ||= JSON->new->utf8;
1178		1608
1179	sub {	1609	sub {
1180	my $ref = eval { $json->incr_parse ($self->{rbuf}) };	1610	my $ref = eval { $json->incr_parse ($self->{rbuf}) };
1181		1611
1182	if ($ref) {	1612	if ($ref) {
…		…
1190	$json->incr_skip;	1620	$json->incr_skip;
1191		1621
1192	$self->{rbuf} = $json->incr_text;	1622	$self->{rbuf} = $json->incr_text;
1193	$json->incr_text = "";	1623	$json->incr_text = "";
1194		1624
1195	$self->_error (&Errno::EBADMSG);	1625	$self->_error (Errno::EBADMSG);
1196		1626
1197	()	1627	()
1198	} else {	1628	} else {
1199	$self->{rbuf} = "";	1629	$self->{rbuf} = "";
1200		1630
…		…
1237	# read remaining chunk	1667	# read remaining chunk
1238	$_[0]->unshift_read (chunk => $len, sub {	1668	$_[0]->unshift_read (chunk => $len, sub {
1239	if (my $ref = eval { Storable::thaw ($_[1]) }) {	1669	if (my $ref = eval { Storable::thaw ($_[1]) }) {
1240	$cb->($_[0], $ref);	1670	$cb->($_[0], $ref);
1241	} else {	1671	} else {
1242	$self->_error (&Errno::EBADMSG);	1672	$self->_error (Errno::EBADMSG);
1243	}	1673	}
1244	});	1674	});
1245	}	1675	}
1246		1676
1247	1	1677	1
1248	}	1678	}
1249	};	1679	};
1250		1680
1251	=back	1681	=back
1252		1682
1253	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)	1683	=item custom read types - Package::anyevent_read_type $handle, $cb, @args
1254		1684
1255	This function (not method) lets you add your own types to C<push_read>.	1685	Instead of one of the predefined types, you can also specify the name
		1686	of a package. AnyEvent will try to load the package and then expects to
		1687	find a function named C<anyevent_read_type> inside. If it isn't found, it
		1688	progressively tries to load the parent package until it either finds the
		1689	function (good) or runs out of packages (bad).
1256		1690
1257	Whenever the given C<type> is used, C<push_read> will invoke the code	1691	Whenever this type is used, C<push_read> will invoke the function with the
1258	reference with the handle object, the callback and the remaining	1692	handle object, the original callback and the remaining arguments.
1259	arguments.
1260		1693
1261	The code reference is supposed to return a callback (usually a closure)	1694	The function is supposed to return a callback (usually a closure) that
1262	that works as a plain read callback (see C<< ->push_read ($cb) >>).	1695	works as a plain read callback (see C<< ->push_read ($cb) >>), so you can
		1696	mentally treat the function as a "configurable read type to read callback"
		1697	converter.
1263		1698
1264	It should invoke the passed callback when it is done reading (remember to	1699	It should invoke the original callback when it is done reading (remember
1265	pass C<$handle> as first argument as all other callbacks do that).	1700	to pass C<$handle> as first argument as all other callbacks do that,
		1701	although there is no strict requirement on this).
1266		1702
1267	Note that this is a function, and all types registered this way will be
1268	global, so try to use unique names.
1269
1270	For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>,	1703	For examples, see the source of this module (F<perldoc -m
1271	search for C<register_read_type>)).	1704	AnyEvent::Handle>, search for C<register_read_type>)).
1272		1705
1273	=item $handle->stop_read	1706	=item $handle->stop_read
1274		1707
1275	=item $handle->start_read	1708	=item $handle->start_read
1276		1709
…		…
1296	}	1729	}
1297		1730
1298	sub start_read {	1731	sub start_read {
1299	my ($self) = @_;	1732	my ($self) = @_;
1300		1733
1301	unless ($self->{_rw} || $self->{_eof}) {	1734	unless ($self->{_rw} || $self->{_eof} || !$self->{fh}) {
1302	Scalar::Util::weaken $self;	1735	Scalar::Util::weaken $self;
1303		1736
1304	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1737	$self->{_rw} = AE::io $self->{fh}, 0, sub {
1305	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});	1738	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1306	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf;	1739	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf;
1307		1740
1308	if ($len > 0) {	1741	if ($len > 0) {
1309	$self->{_activity} = AnyEvent->now;	1742	$self->{_activity} = $self->{_ractivity} = AE::now;
1310		1743
1311	if ($self->{tls}) {	1744	if ($self->{tls}) {
1312	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);	1745	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1313		1746
1314	&_dotls ($self);	1747	&_dotls ($self);
1315	} else {	1748	} else {
1316	$self->_drain_rbuf unless $self->{_in_drain};	1749	$self->_drain_rbuf;
1317	}	1750	}
1318		1751
1319	} elsif (defined $len) {	1752	} elsif (defined $len) {
1320	delete $self->{_rw};	1753	delete $self->{_rw};
1321	$self->{_eof} = 1;	1754	$self->{_eof} = 1;
1322	$self->_drain_rbuf unless $self->{_in_drain};	1755	$self->_drain_rbuf;
1323		1756
1324	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1757	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1325	return $self->_error ($!, 1);	1758	return $self->_error ($!, 1);
1326	}	1759	}
1327	});	1760	};
		1761	}
		1762	}
		1763
		1764	our $ERROR_SYSCALL;
		1765	our $ERROR_WANT_READ;
		1766
		1767	sub _tls_error {
		1768	my ($self, $err) = @_;
		1769
		1770	return $self->_error ($!, 1)
		1771	if $err == Net::SSLeay::ERROR_SYSCALL ();
		1772
		1773	my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());
		1774
		1775	# reduce error string to look less scary
		1776	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;
		1777
		1778	if ($self->{_on_starttls}) {
		1779	(delete $self->{_on_starttls})->($self, undef, $err);
		1780	&_freetls;
		1781	} else {
		1782	&_freetls;
		1783	$self->_error (Errno::EPROTO, 1, $err);
1328	}	1784	}
1329	}	1785	}
1330		1786
1331	# poll the write BIO and send the data if applicable	1787	# poll the write BIO and send the data if applicable
		1788	# also decode read data if possible
		1789	# this is basiclaly our TLS state machine
		1790	# more efficient implementations are possible with openssl,
		1791	# but not with the buggy and incomplete Net::SSLeay.
1332	sub _dotls {	1792	sub _dotls {
1333	my ($self) = @_;	1793	my ($self) = @_;
1334		1794
1335	my $tmp;	1795	my $tmp;
1336		1796
1337	if (length $self->{_tls_wbuf}) {	1797	if (length $self->{_tls_wbuf}) {
1338	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1798	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1339	substr $self->{_tls_wbuf}, 0, $tmp, "";	1799	substr $self->{_tls_wbuf}, 0, $tmp, "";
1340	}	1800	}
		1801
		1802	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);
		1803	return $self->_tls_error ($tmp)
		1804	if $tmp != $ERROR_WANT_READ
		1805	&& ($tmp != $ERROR_SYSCALL || $!);
1341	}	1806	}
1342		1807
1343	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {	1808	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
1344	unless (length $tmp) {	1809	unless (length $tmp) {
1345	# let's treat SSL-eof as we treat normal EOF	1810	$self->{_on_starttls}
1346	delete $self->{_rw};	1811	and (delete $self->{_on_starttls})->($self, undef, "EOF during handshake"); # ???
1347	$self->{_eof} = 1;
1348	&_freetls;	1812	&_freetls;
		1813
		1814	if ($self->{on_stoptls}) {
		1815	$self->{on_stoptls}($self);
		1816	return;
		1817	} else {
		1818	# let's treat SSL-eof as we treat normal EOF
		1819	delete $self->{_rw};
		1820	$self->{_eof} = 1;
		1821	}
1349	}	1822	}
1350		1823
1351	$self->{_tls_rbuf} .= $tmp;	1824	$self->{_tls_rbuf} .= $tmp;
1352	$self->_drain_rbuf unless $self->{_in_drain};	1825	$self->_drain_rbuf;
1353	$self->{tls} or return; # tls session might have gone away in callback	1826	$self->{tls} or return; # tls session might have gone away in callback
1354	}	1827	}
1355		1828
1356	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);	1829	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1357
1358	if ($tmp != Net::SSLeay::ERROR_WANT_READ ()) {
1359	if ($tmp == Net::SSLeay::ERROR_SYSCALL ()) {
1360	return $self->_error ($!, 1);	1830	return $self->_tls_error ($tmp)
1361	} elsif ($tmp == Net::SSLeay::ERROR_SSL ()) {	1831	if $tmp != $ERROR_WANT_READ
1362	return $self->_error (&Errno::EIO, 1);	1832	&& ($tmp != $ERROR_SYSCALL || $!);
1363	}
1364
1365	# all other errors are fine for our purposes
1366	}
1367		1833
1368	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1834	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1369	$self->{wbuf} .= $tmp;	1835	$self->{wbuf} .= $tmp;
1370	$self->_drain_wbuf;	1836	$self->_drain_wbuf;
		1837	$self->{tls} or return; # tls session might have gone away in callback
1371	}	1838	}
		1839
		1840	$self->{_on_starttls}
		1841	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
		1842	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");
1372	}	1843	}
1373		1844
1374	=item $handle->starttls ($tls[, $tls_ctx])	1845	=item $handle->starttls ($tls[, $tls_ctx])
1375		1846
1376	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	1847	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
1377	object is created, you can also do that at a later time by calling	1848	object is created, you can also do that at a later time by calling
1378	C<starttls>.	1849	C<starttls>.
1379		1850
		1851	Starting TLS is currently an asynchronous operation - when you push some
		1852	write data and then call C<< ->starttls >> then TLS negotiation will start
		1853	immediately, after which the queued write data is then sent.
		1854
1380	The first argument is the same as the C<tls> constructor argument (either	1855	The first argument is the same as the C<tls> constructor argument (either
1381	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1856	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1382		1857
1383	The second argument is the optional C<Net::SSLeay::CTX> object that is	1858	The second argument is the optional C<AnyEvent::TLS> object that is used
1384	used when AnyEvent::Handle has to create its own TLS connection object.	1859	when AnyEvent::Handle has to create its own TLS connection object, or
		1860	a hash reference with C<< key => value >> pairs that will be used to
		1861	construct a new context.
1385		1862
1386	The TLS connection object will end up in C<< $handle->{tls} >> after this	1863	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS
1387	call and can be used or changed to your liking. Note that the handshake	1864	context in C<< $handle->{tls_ctx} >> after this call and can be used or
1388	might have already started when this function returns.	1865	changed to your liking. Note that the handshake might have already started
		1866	when this function returns.
1389		1867
1390	If it an error to start a TLS handshake more than once per	1868	Due to bugs in OpenSSL, it might or might not be possible to do multiple
1391	AnyEvent::Handle object (this is due to bugs in OpenSSL).	1869	handshakes on the same stream. Best do not attempt to use the stream after
		1870	stopping TLS.
1392		1871
		1872	This method may invoke callbacks (and therefore the handle might be
		1873	destroyed after it returns).
		1874
1393	=cut	1875	=cut
		1876
		1877	our %TLS_CACHE; #TODO not yet documented, should we?
1394		1878
1395	sub starttls {	1879	sub starttls {
1396	my ($self, $ssl, $ctx) = @_;	1880	my ($self, $tls, $ctx) = @_;
		1881
		1882	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"
		1883	if $self->{tls};
		1884
		1885	$self->{tls} = $tls;
		1886	$self->{tls_ctx} = $ctx if @_ > 2;
		1887
		1888	return unless $self->{fh};
1397		1889
1398	require Net::SSLeay;	1890	require Net::SSLeay;
1399		1891
1400	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"	1892	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1401	if $self->{tls};	1893	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
		1894
		1895	$tls = delete $self->{tls};
		1896	$ctx = $self->{tls_ctx};
		1897
		1898	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
		1899
		1900	if ("HASH" eq ref $ctx) {
		1901	require AnyEvent::TLS;
		1902
		1903	if ($ctx->{cache}) {
		1904	my $key = $ctx+0;
		1905	$ctx = $TLS_CACHE{$key} ||= new AnyEvent::TLS %$ctx;
		1906	} else {
		1907	$ctx = new AnyEvent::TLS %$ctx;
		1908	}
		1909	}
1402		1910
1403	if ($ssl eq "accept") {	1911	$self->{tls_ctx} = $ctx || TLS_CTX ();
1404	$ssl = Net::SSLeay::new ($ctx || TLS_CTX ());	1912	$self->{tls} = $tls = $self->{tls_ctx}->_get_session ($tls, $self, $self->{peername});
1405	Net::SSLeay::set_accept_state ($ssl);
1406	} elsif ($ssl eq "connect") {
1407	$ssl = Net::SSLeay::new ($ctx || TLS_CTX ());
1408	Net::SSLeay::set_connect_state ($ssl);
1409	}
1410
1411	$self->{tls} = $ssl;
1412		1913
1413	# basically, this is deep magic (because SSL_read should have the same issues)	1914	# basically, this is deep magic (because SSL_read should have the same issues)
1414	# but the openssl maintainers basically said: "trust us, it just works".	1915	# but the openssl maintainers basically said: "trust us, it just works".
1415	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1916	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1416	# and mismaintained ssleay-module doesn't even offer them).	1917	# and mismaintained ssleay-module doesn't even offer them).
…		…
1420	#	1921	#
1421	# note that we do not try to keep the length constant between writes as we are required to do.	1922	# note that we do not try to keep the length constant between writes as we are required to do.
1422	# we assume that most (but not all) of this insanity only applies to non-blocking cases,	1923	# we assume that most (but not all) of this insanity only applies to non-blocking cases,
1423	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to	1924	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
1424	# have identity issues in that area.	1925	# have identity issues in that area.
1425	Net::SSLeay::CTX_set_mode ($self->{tls},	1926	# Net::SSLeay::CTX_set_mode ($ssl,
1426	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)	1927	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)
1427	| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));	1928	# | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));
		1929	Net::SSLeay::CTX_set_mode ($tls, 1|2);
1428		1930
1429	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1931	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1430	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1932	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1431		1933
		1934	Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf});
		1935
1432	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1936	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
		1937
		1938	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
		1939	if $self->{on_starttls};
1433		1940
1434	&_dotls; # need to trigger the initial handshake	1941	&_dotls; # need to trigger the initial handshake
1435	$self->start_read; # make sure we actually do read	1942	$self->start_read; # make sure we actually do read
1436	}	1943	}
1437		1944
1438	=item $handle->stoptls	1945	=item $handle->stoptls
1439		1946
1440	Shuts down the SSL connection - this makes a proper EOF handshake by	1947	Shuts down the SSL connection - this makes a proper EOF handshake by
1441	sending a close notify to the other side, but since OpenSSL doesn't	1948	sending a close notify to the other side, but since OpenSSL doesn't
1442	support non-blocking shut downs, it is not possible to re-use the stream	1949	support non-blocking shut downs, it is not guaranteed that you can re-use
1443	afterwards.	1950	the stream afterwards.
		1951
		1952	This method may invoke callbacks (and therefore the handle might be
		1953	destroyed after it returns).
1444		1954
1445	=cut	1955	=cut
1446		1956
1447	sub stoptls {	1957	sub stoptls {
1448	my ($self) = @_;	1958	my ($self) = @_;
1449		1959
1450	if ($self->{tls}) {	1960	if ($self->{tls} && $self->{fh}) {
1451	Net::SSLeay::shutdown ($self->{tls});	1961	Net::SSLeay::shutdown ($self->{tls});
1452		1962
1453	&_dotls;	1963	&_dotls;
1454		1964
1455	# we don't give a shit. no, we do, but we can't. no...	1965	# # we don't give a shit. no, we do, but we can't. no...#d#
1456	# we, we... have to use openssl :/	1966	# # we, we... have to use openssl :/#d#
1457	&_freetls;	1967	# &_freetls;#d#
1458	}	1968	}
1459	}	1969	}
1460		1970
1461	sub _freetls {	1971	sub _freetls {
1462	my ($self) = @_;	1972	my ($self) = @_;
1463		1973
1464	return unless $self->{tls};	1974	return unless $self->{tls};
1465		1975
1466	Net::SSLeay::free (delete $self->{tls});	1976	$self->{tls_ctx}->_put_session (delete $self->{tls})
		1977	if $self->{tls} > 0;
1467		1978
1468	delete @$self{qw(_rbio _wbio _tls_wbuf)};	1979	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1469	}	1980	}
1470		1981
1471	sub DESTROY {	1982	sub DESTROY {
1472	my ($self) = @_;	1983	my ($self) = @_;
1473		1984
1474	&_freetls;	1985	&_freetls;
1475		1986
1476	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	1987	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1477		1988
1478	if ($linger && length $self->{wbuf}) {	1989	if ($linger && length $self->{wbuf} && $self->{fh}) {
1479	my $fh = delete $self->{fh};	1990	my $fh = delete $self->{fh};
1480	my $wbuf = delete $self->{wbuf};	1991	my $wbuf = delete $self->{wbuf};
1481		1992
1482	my @linger;	1993	my @linger;
1483		1994
1484	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {	1995	push @linger, AE::io $fh, 1, sub {
1485	my $len = syswrite $fh, $wbuf, length $wbuf;	1996	my $len = syswrite $fh, $wbuf, length $wbuf;
1486		1997
1487	if ($len > 0) {	1998	if ($len > 0) {
1488	substr $wbuf, 0, $len, "";	1999	substr $wbuf, 0, $len, "";
1489	} else {	2000	} else {
1490	@linger = (); # end	2001	@linger = (); # end
1491	}	2002	}
1492	});	2003	};
1493	push @linger, AnyEvent->timer (after => $linger, cb => sub {	2004	push @linger, AE::timer $linger, 0, sub {
1494	@linger = ();	2005	@linger = ();
1495	});	2006	};
1496	}	2007	}
1497	}	2008	}
1498		2009
1499	=item $handle->destroy	2010	=item $handle->destroy
1500		2011
1501	Shuts down the handle object as much as possible - this call ensures that	2012	Shuts down the handle object as much as possible - this call ensures that
1502	no further callbacks will be invoked and resources will be freed as much	2013	no further callbacks will be invoked and as many resources as possible
1503	as possible. You must not call any methods on the object afterwards.	2014	will be freed. Any method you will call on the handle object after
		2015	destroying it in this way will be silently ignored (and it will return the
		2016	empty list).
1504		2017
1505	Normally, you can just "forget" any references to an AnyEvent::Handle	2018	Normally, you can just "forget" any references to an AnyEvent::Handle
1506	object and it will simply shut down. This works in fatal error and EOF	2019	object and it will simply shut down. This works in fatal error and EOF
1507	callbacks, as well as code outside. It does I<NOT> work in a read or write	2020	callbacks, as well as code outside. It does I<NOT> work in a read or write
1508	callback, so when you want to destroy the AnyEvent::Handle object from	2021	callback, so when you want to destroy the AnyEvent::Handle object from
1509	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in	2022	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
1510	that case.	2023	that case.
1511		2024
		2025	Destroying the handle object in this way has the advantage that callbacks
		2026	will be removed as well, so if those are the only reference holders (as
		2027	is common), then one doesn't need to do anything special to break any
		2028	reference cycles.
		2029
1512	The handle might still linger in the background and write out remaining	2030	The handle might still linger in the background and write out remaining
1513	data, as specified by the C<linger> option, however.	2031	data, as specified by the C<linger> option, however.
1514		2032
1515	=cut	2033	=cut
1516		2034
1517	sub destroy {	2035	sub destroy {
1518	my ($self) = @_;	2036	my ($self) = @_;
1519		2037
1520	$self->DESTROY;	2038	$self->DESTROY;
1521	%$self = ();	2039	%$self = ();
		2040	bless $self, "AnyEvent::Handle::destroyed";
1522	}	2041	}
		2042
		2043	sub AnyEvent::Handle::destroyed::AUTOLOAD {
		2044	#nop
		2045	}
		2046
		2047	=item $handle->destroyed
		2048
		2049	Returns false as long as the handle hasn't been destroyed by a call to C<<
		2050	->destroy >>, true otherwise.
		2051
		2052	Can be useful to decide whether the handle is still valid after some
		2053	callback possibly destroyed the handle. For example, C<< ->push_write >>,
		2054	C<< ->starttls >> and other methods can call user callbacks, which in turn
		2055	can destroy the handle, so work can be avoided by checking sometimes:
		2056
		2057	$hdl->starttls ("accept");
		2058	return if $hdl->destroyed;
		2059	$hdl->push_write (...
		2060
		2061	Note that the call to C<push_write> will silently be ignored if the handle
		2062	has been destroyed, so often you can just ignore the possibility of the
		2063	handle being destroyed.
		2064
		2065	=cut
		2066
		2067	sub destroyed { 0 }
		2068	sub AnyEvent::Handle::destroyed::destroyed { 1 }
1523		2069
1524	=item AnyEvent::Handle::TLS_CTX	2070	=item AnyEvent::Handle::TLS_CTX
1525		2071
1526	This function creates and returns the Net::SSLeay::CTX object used by	2072	This function creates and returns the AnyEvent::TLS object used by default
1527	default for TLS mode.	2073	for TLS mode.
1528		2074
1529	The context is created like this:	2075	The context is created by calling L<AnyEvent::TLS> without any arguments.
1530
1531	Net::SSLeay::load_error_strings;
1532	Net::SSLeay::SSLeay_add_ssl_algorithms;
1533	Net::SSLeay::randomize;
1534
1535	my $CTX = Net::SSLeay::CTX_new;
1536
1537	Net::SSLeay::CTX_set_options $CTX, Net::SSLeay::OP_ALL
1538		2076
1539	=cut	2077	=cut
1540		2078
1541	our $TLS_CTX;	2079	our $TLS_CTX;
1542		2080
1543	sub TLS_CTX() {	2081	sub TLS_CTX() {
1544	$TLS_CTX || do {	2082	$TLS_CTX ||= do {
1545	require Net::SSLeay;	2083	require AnyEvent::TLS;
1546		2084
1547	Net::SSLeay::load_error_strings ();	2085	new AnyEvent::TLS
1548	Net::SSLeay::SSLeay_add_ssl_algorithms ();
1549	Net::SSLeay::randomize ();
1550
1551	$TLS_CTX = Net::SSLeay::CTX_new ();
1552
1553	Net::SSLeay::CTX_set_options ($TLS_CTX, Net::SSLeay::OP_ALL ());
1554
1555	$TLS_CTX
1556	}	2086	}
1557	}	2087	}
1558		2088
1559	=back	2089	=back
1560		2090
…		…
1599		2129
1600	$handle->on_read (sub { });	2130	$handle->on_read (sub { });
1601	$handle->on_eof (undef);	2131	$handle->on_eof (undef);
1602	$handle->on_error (sub {	2132	$handle->on_error (sub {
1603	my $data = delete $_[0]{rbuf};	2133	my $data = delete $_[0]{rbuf};
1604	undef $handle;
1605	});	2134	});
1606		2135
1607	The reason to use C<on_error> is that TCP connections, due to latencies	2136	The reason to use C<on_error> is that TCP connections, due to latencies
1608	and packets loss, might get closed quite violently with an error, when in	2137	and packets loss, might get closed quite violently with an error, when in
1609	fact, all data has been received.	2138	fact, all data has been received.
…		…
1625	$handle->on_drain (sub {	2154	$handle->on_drain (sub {
1626	warn "all data submitted to the kernel\n";	2155	warn "all data submitted to the kernel\n";
1627	undef $handle;	2156	undef $handle;
1628	});	2157	});
1629		2158
		2159	If you just want to queue some data and then signal EOF to the other side,
		2160	consider using C<< ->push_shutdown >> instead.
		2161
		2162	=item I want to contact a TLS/SSL server, I don't care about security.
		2163
		2164	If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS,
		2165	simply connect to it and then create the AnyEvent::Handle with the C<tls>
		2166	parameter:
		2167
		2168	tcp_connect $host, $port, sub {
		2169	my ($fh) = @_;
		2170
		2171	my $handle = new AnyEvent::Handle
		2172	fh => $fh,
		2173	tls => "connect",
		2174	on_error => sub { ... };
		2175
		2176	$handle->push_write (...);
		2177	};
		2178
		2179	=item I want to contact a TLS/SSL server, I do care about security.
		2180
		2181	Then you should additionally enable certificate verification, including
		2182	peername verification, if the protocol you use supports it (see
		2183	L<AnyEvent::TLS>, C<verify_peername>).
		2184
		2185	E.g. for HTTPS:
		2186
		2187	tcp_connect $host, $port, sub {
		2188	my ($fh) = @_;
		2189
		2190	my $handle = new AnyEvent::Handle
		2191	fh => $fh,
		2192	peername => $host,
		2193	tls => "connect",
		2194	tls_ctx => { verify => 1, verify_peername => "https" },
		2195	...
		2196
		2197	Note that you must specify the hostname you connected to (or whatever
		2198	"peername" the protocol needs) as the C<peername> argument, otherwise no
		2199	peername verification will be done.
		2200
		2201	The above will use the system-dependent default set of trusted CA
		2202	certificates. If you want to check against a specific CA, add the
		2203	C<ca_file> (or C<ca_cert>) arguments to C<tls_ctx>:
		2204
		2205	tls_ctx => {
		2206	verify => 1,
		2207	verify_peername => "https",
		2208	ca_file => "my-ca-cert.pem",
		2209	},
		2210
		2211	=item I want to create a TLS/SSL server, how do I do that?
		2212
		2213	Well, you first need to get a server certificate and key. You have
		2214	three options: a) ask a CA (buy one, use cacert.org etc.) b) create a
		2215	self-signed certificate (cheap. check the search engine of your choice,
		2216	there are many tutorials on the net) or c) make your own CA (tinyca2 is a
		2217	nice program for that purpose).
		2218
		2219	Then create a file with your private key (in PEM format, see
		2220	L<AnyEvent::TLS>), followed by the certificate (also in PEM format). The
		2221	file should then look like this:
		2222
		2223	-----BEGIN RSA PRIVATE KEY-----
		2224	...header data
		2225	... lots of base64'y-stuff
		2226	-----END RSA PRIVATE KEY-----
		2227
		2228	-----BEGIN CERTIFICATE-----
		2229	... lots of base64'y-stuff
		2230	-----END CERTIFICATE-----
		2231
		2232	The important bits are the "PRIVATE KEY" and "CERTIFICATE" parts. Then
		2233	specify this file as C<cert_file>:
		2234
		2235	tcp_server undef, $port, sub {
		2236	my ($fh) = @_;
		2237
		2238	my $handle = new AnyEvent::Handle
		2239	fh => $fh,
		2240	tls => "accept",
		2241	tls_ctx => { cert_file => "my-server-keycert.pem" },
		2242	...
		2243
		2244	When you have intermediate CA certificates that your clients might not
		2245	know about, just append them to the C<cert_file>.
		2246
1630	=back	2247	=back
1631		2248
1632		2249
1633	=head1 SUBCLASSING AnyEvent::Handle	2250	=head1 SUBCLASSING AnyEvent::Handle
1634		2251

Diff Legend

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