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.100 by root, Thu Oct 23 02:44:50 2008 UTC vs.
Revision 1.190 by root, Thu Nov 26 10:30:24 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.3;
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 {
32	$cv->broadcast;	15	my ($hdl, $fatal, $msg) = @_;
33	},	16	warn "got error $msg\n";
		17	$hdl->destroy;
		18	$cv->send;
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::TLS 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
82	=item on_eof => $cb->($handle)	114	=item on_prepare => $cb->($handle)
83		115
84	Set the callback to be called when an end-of-file condition is detected,	116	This (rarely used) callback is called before a new connection is
85	i.e. in the case of a socket, when the other side has closed the	117	attempted, but after the file handle has been created. It could be used to
86	connection cleanly.	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).
87		121
88	For sockets, this just means that the other side has stopped sending data,	122	The return value of this callback should be the connect timeout value in
89	you can still try to write data, and, in fact, one can return from the eof	123	seconds (or C<0>, or C<undef>, or the empty list, to indicate the default
90	callback and continue writing data, as only the read part has been shut	124	timeout is to be used).
91	down.
92		125
93	While not mandatory, it is I<highly> recommended to set an eof callback,	126	=item on_connect => $cb->($handle, $host, $port, $retry->())
94	otherwise you might end up with a closed socket while you are still
95	waiting for data.
96		127
97	If an EOF condition has been detected but no C<on_eof> callback has been	128	This callback is called when a connection has been successfully established.
98	set, then a fatal error will be raised with C<$!> set to <0>.
99		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
100	=item on_error => $cb->($handle, $fatal)	153	=item on_error => $cb->($handle, $fatal, $message)
101		154
102	This is the error callback, which is called when, well, some error	155	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	156	occured, such as not being able to resolve the hostname, failure to
104	connect or a read error.	157	connect or a read error.
105		158
106	Some errors are fatal (which is indicated by C<$fatal> being true). On	159	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	160	fatal errors the handle object will be destroyed (by a call to C<< ->
108	(but you are free to look at the current C<< ->rbuf >>). Examples of fatal	161	destroy >>) after invoking the error callback (which means you are free to
109	errors are an EOF condition with active (but unsatisifable) read watchers	162	examine the handle object). Examples of fatal errors are an EOF condition
110	(C<EPIPE>) or I/O errors.	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<"$!">).
111		171
112	Non-fatal errors can be retried by simply returning, but it is recommended	172	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	173	to simply ignore this parameter and instead abondon the handle object
114	when this callback is invoked. Examples of non-fatal errors are timeouts	174	when this callback is invoked. Examples of non-fatal errors are timeouts
115	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).	175	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
116		176
117	On callback entrance, the value of C<$!> contains the operating system	177	On callback entrance, the value of C<$!> contains the operating system
118	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).	178	error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
		179	C<EPROTO>).
119		180
120	While not mandatory, it is I<highly> recommended to set this callback, as	181	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	182	you will not be notified of errors otherwise. The default simply calls
122	C<croak>.	183	C<croak>.
123		184
…		…
127	and no read request is in the queue (unlike read queue callbacks, this	188	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	189	callback will only be called when at least one octet of data is in the
129	read buffer).	190	read buffer).
130		191
131	To access (and remove data from) the read buffer, use the C<< ->rbuf >>	192	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
132	method or access the C<$handle->{rbuf}> member directly.	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.
133		196
134	When an EOF condition is detected then AnyEvent::Handle will first try to	197	When an EOF condition is detected then AnyEvent::Handle will first try to
135	feed all the remaining data to the queued callbacks and C<on_read> before	198	feed all the remaining data to the queued callbacks and C<on_read> before
136	calling the C<on_eof> callback. If no progress can be made, then a fatal	199	calling the C<on_eof> callback. If no progress can be made, then a fatal
137	error will be raised (with C<$!> set to C<EPIPE>).	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
		207	=item on_eof => $cb->($handle)
		208
		209	Set the callback to be called when an end-of-file condition is detected,
		210	i.e. in the case of a socket, when the other side has closed the
		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).
		214
		215	For sockets, this just means that the other side has stopped sending data,
		216	you can still try to write data, and, in fact, one can return from the EOF
		217	callback and continue writing data, as only the read part has been shut
		218	down.
		219
		220	If an EOF condition has been detected but no C<on_eof> callback has been
		221	set, then a fatal error will be raised with C<$!> set to <0>.
138		222
139	=item on_drain => $cb->($handle)	223	=item on_drain => $cb->($handle)
140		224
141	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
142	(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).
…		…
149	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
150	the file when the write queue becomes empty.	234	the file when the write queue becomes empty.
151		235
152	=item timeout => $fractional_seconds	236	=item timeout => $fractional_seconds
153		237
		238	=item rtimeout => $fractional_seconds
		239
		240	=item wtimeout => $fractional_seconds
		241
154	If non-zero, then this enables an "inactivity" timeout: whenever this many	242	If non-zero, then these enables an "inactivity" timeout: whenever this
155	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
156	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
157	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>.
158		253
159	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
160	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
161	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
162	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
…		…
206	accomplishd by setting this option to a true value.	301	accomplishd by setting this option to a true value.
207		302
208	The default is your opertaing system's default behaviour (most likely	303	The default is your opertaing system's default behaviour (most likely
209	enabled), this option explicitly enables or disables it, if possible.	304	enabled), this option explicitly enables or disables it, if possible.
210		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
211	=item read_size => <bytes>	338	=item read_size => <bytes>
212		339
213	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
214	try to read during each loop iteration, which affects memory	341	try to read during each loop iteration, which affects memory
215	requirements). Default: C<8192>.	342	requirements). Default: C<8192>.
…		…
235		362
236	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
237	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
238	help.	365	help.
239		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
240	=item tls => "accept" | "connect" | Net::SSLeay::SSL object	377	=item tls => "accept" | "connect" | Net::SSLeay::SSL object
241		378
242	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
243	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
244	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.
245		385
246	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
247	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
248	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
249	to add the dependency yourself.	389	to add the dependency yourself.
…		…
253	mode.	393	mode.
254		394
255	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
256	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>
257	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
258	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.
		404
		405	B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,
		406	passing in the wrong integer will lead to certain crash. This most often
		407	happens when one uses a stylish C<< tls => 1 >> and is surprised about the
		408	segmentation fault.
259		409
260	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.
261		411
262	=item tls_ctx => $ssl_ctx	412	=item tls_ctx => $anyevent_tls
263		413
264	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
265	(unless a connection object was specified directly). If this parameter is	415	(unless a connection object was specified directly). If this parameter is
266	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.
267		453
268	=item json => JSON or JSON::XS object	454	=item json => JSON or JSON::XS object
269		455
270	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.
271		457
…		…
280		466
281	=cut	467	=cut
282		468
283	sub new {	469	sub new {
284	my $class = shift;	470	my $class = shift;
285
286	my $self = bless { @_ }, $class;	471	my $self = bless { @_ }, $class;
287		472
288	$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) = @_;
289		536
290	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	537	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
291		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
292	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})	552	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
293	if $self->{tls};	553	if $self->{tls};
294		554
295	$self->{_activity} = AnyEvent->now;
296	$self->_timeout;
297
298	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};	555	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
299	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
300		556
301	$self->start_read	557	$self->start_read
302	if $self->{on_read};	558	if $self->{on_read} || @{ $self->{_queue} };
303		559
304	$self	560	$self->_drain_wbuf;
305	}
306
307	sub _shutdown {
308	my ($self) = @_;
309
310	delete $self->{_tw};
311	delete $self->{_rw};
312	delete $self->{_ww};
313	delete $self->{fh};
314
315	&_freetls;
316
317	delete $self->{on_read};
318	delete $self->{_queue};
319	}	561	}
320		562
321	sub _error {	563	sub _error {
322	my ($self, $errno, $fatal) = @_;	564	my ($self, $errno, $fatal, $message) = @_;
323
324	$self->_shutdown
325	if $fatal;
326		565
327	$! = $errno;	566	$! = $errno;
		567	$message ||= "$!";
328		568
329	if ($self->{on_error}) {	569	if ($self->{on_error}) {
330	$self->{on_error}($self, $fatal);	570	$self->{on_error}($self, $fatal, $message);
331	} elsif ($self->{fh}) {	571	$self->destroy if $fatal;
		572	} elsif ($self->{fh} || $self->{connect}) {
		573	$self->destroy;
332	Carp::croak "AnyEvent::Handle uncaught error: $!";	574	Carp::croak "AnyEvent::Handle uncaught error: $message";
333	}	575	}
334	}	576	}
335		577
336	=item $fh = $handle->fh	578	=item $fh = $handle->fh
337		579
…		…
361	$_[0]{on_eof} = $_[1];	603	$_[0]{on_eof} = $_[1];
362	}	604	}
363		605
364	=item $handle->on_timeout ($cb)	606	=item $handle->on_timeout ($cb)
365		607
366	Replace the current C<on_timeout> callback, or disables the callback (but	608	=item $handle->on_rtimeout ($cb)
367	not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
368	argument and method.
369		609
370	=cut	610	=item $handle->on_wtimeout ($cb)
371		611
372	sub on_timeout {	612	Replace the current C<on_timeout>, C<on_rtimeout> or C<on_wtimeout>
373	$_[0]{on_timeout} = $_[1];	613	callback, or disables the callback (but not the timeout) if C<$cb> =
374	}	614	C<undef>. See the C<timeout> constructor argument and method.
		615
		616	=cut
		617
		618	# see below
375		619
376	=item $handle->autocork ($boolean)	620	=item $handle->autocork ($boolean)
377		621
378	Enables or disables the current autocork behaviour (see C<autocork>	622	Enables or disables the current autocork behaviour (see C<autocork>
379	constructor argument).	623	constructor argument). Changes will only take effect on the next write.
380		624
381	=cut	625	=cut
		626
		627	sub autocork {
		628	$_[0]{autocork} = $_[1];
		629	}
382		630
383	=item $handle->no_delay ($boolean)	631	=item $handle->no_delay ($boolean)
384		632
385	Enables or disables the C<no_delay> setting (see constructor argument of	633	Enables or disables the C<no_delay> setting (see constructor argument of
386	the same name for details).	634	the same name for details).
…		…
390	sub no_delay {	638	sub no_delay {
391	$_[0]{no_delay} = $_[1];	639	$_[0]{no_delay} = $_[1];
392		640
393	eval {	641	eval {
394	local $SIG{__DIE__};	642	local $SIG{__DIE__};
395	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};
396	};	645	};
397	}	646	}
398		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
399	#############################################################################	729	#############################################################################
400		730
401	=item $handle->timeout ($seconds)	731	=item $handle->timeout ($seconds)
402		732
		733	=item $handle->rtimeout ($seconds)
		734
		735	=item $handle->wtimeout ($seconds)
		736
403	Configures (or disables) the inactivity timeout.	737	Configures (or disables) the inactivity timeout.
404		738
405	=cut	739	=item $handle->timeout_reset
406		740
407	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 {
408	my ($self, $timeout) = @_;	763	my ($self, $new_value) = @_;
409		764
410	$self->{timeout} = $timeout;	765	$self->{$timeout} = $new_value;
411	$self->_timeout;	766	delete $self->{$tw}; &$cb;
412	}	767	};
413		768
		769	*{"${dir}timeout_reset"} = sub {
		770	$_[0]{$activity} = AE::now;
		771	};
		772
		773	# main workhorse:
414	# reset the timeout watcher, as neccessary	774	# reset the timeout watcher, as neccessary
415	# also check for time-outs	775	# also check for time-outs
416	sub _timeout {	776	$cb = sub {
417	my ($self) = @_;	777	my ($self) = @_;
418		778
419	if ($self->{timeout}) {	779	if ($self->{$timeout} && $self->{fh}) {
420	my $NOW = AnyEvent->now;	780	my $NOW = AE::now;
421		781
422	# when would the timeout trigger?	782	# when would the timeout trigger?
423	my $after = $self->{_activity} + $self->{timeout} - $NOW;	783	my $after = $self->{$activity} + $self->{$timeout} - $NOW;
424		784
425	# now or in the past already?	785	# now or in the past already?
426	if ($after <= 0) {	786	if ($after <= 0) {
427	$self->{_activity} = $NOW;	787	$self->{$activity} = $NOW;
428		788
429	if ($self->{on_timeout}) {	789	if ($self->{$on_timeout}) {
430	$self->{on_timeout}($self);	790	$self->{$on_timeout}($self);
431	} else {	791	} else {
432	$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};
433	}	800	}
434		801
435	# callback could have changed timeout value, optimise	802	Scalar::Util::weaken $self;
436	return unless $self->{timeout};	803	return unless $self; # ->error could have destroyed $self
437		804
438	# calculate new after	805	$self->{$tw} ||= AE::timer $after, 0, sub {
439	$after = $self->{timeout};	806	delete $self->{$tw};
		807	$cb->($self);
		808	};
		809	} else {
		810	delete $self->{$tw};
440	}	811	}
441
442	Scalar::Util::weaken $self;
443	return unless $self; # ->error could have destroyed $self
444
445	$self->{_tw} ||= AnyEvent->timer (after => $after, cb => sub {
446	delete $self->{_tw};
447	$self->_timeout;
448	});
449	} else {
450	delete $self->{_tw};
451	}	812	}
452	}	813	}
453		814
454	#############################################################################	815	#############################################################################
455		816
…		…
500	Scalar::Util::weaken $self;	861	Scalar::Util::weaken $self;
501		862
502	my $cb = sub {	863	my $cb = sub {
503	my $len = syswrite $self->{fh}, $self->{wbuf};	864	my $len = syswrite $self->{fh}, $self->{wbuf};
504		865
505	if ($len >= 0) {	866	if (defined $len) {
506	substr $self->{wbuf}, 0, $len, "";	867	substr $self->{wbuf}, 0, $len, "";
507		868
508	$self->{_activity} = AnyEvent->now;	869	$self->{_activity} = $self->{_wactivity} = AE::now;
509		870
510	$self->{on_drain}($self)	871	$self->{on_drain}($self)
511	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})	872	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
512	&& $self->{on_drain};	873	&& $self->{on_drain};
513		874
…		…
519		880
520	# try to write data immediately	881	# try to write data immediately
521	$cb->() unless $self->{autocork};	882	$cb->() unless $self->{autocork};
522		883
523	# if still data left in wbuf, we need to poll	884	# if still data left in wbuf, we need to poll
524	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	885	$self->{_ww} = AE::io $self->{fh}, 1, $cb
525	if length $self->{wbuf};	886	if length $self->{wbuf};
526	};	887	};
527	}	888	}
528		889
529	our %WH;	890	our %WH;
530		891
		892	# deprecated
531	sub register_write_type($$) {	893	sub register_write_type($$) {
532	$WH{$_[0]} = $_[1];	894	$WH{$_[0]} = $_[1];
533	}	895	}
534		896
535	sub push_write {	897	sub push_write {
536	my $self = shift;	898	my $self = shift;
537		899
538	if (@_ > 1) {	900	if (@_ > 1) {
539	my $type = shift;	901	my $type = shift;
540		902
		903	@_ = ($WH{$type} ||= _load_func "$type\::anyevent_write_type"
541	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	904	or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_write")
542	->($self, @_);	905	->($self, @_);
543	}	906	}
544		907
		908	# we downgrade here to avoid hard-to-track-down bugs,
		909	# and diagnose the problem earlier and better.
		910
545	if ($self->{tls}) {	911	if ($self->{tls}) {
546	$self->{_tls_wbuf} .= $_[0];	912	utf8::downgrade $self->{_tls_wbuf} .= $_[0];
547		913	&_dotls ($self) if $self->{fh};
548	&_dotls ($self);
549	} else {	914	} else {
550	$self->{wbuf} .= $_[0];	915	utf8::downgrade $self->{wbuf} .= $_[0];
551	$self->_drain_wbuf;	916	$self->_drain_wbuf if $self->{fh};
552	}	917	}
553	}	918	}
554		919
555	=item $handle->push_write (type => @args)	920	=item $handle->push_write (type => @args)
556		921
557	Instead of formatting your data yourself, you can also let this module do	922	Instead of formatting your data yourself, you can also let this module
558	the job by specifying a type and type-specific arguments.	923	do the job by specifying a type and type-specific arguments. You
		924	can also specify the (fully qualified) name of a package, in which
		925	case AnyEvent tries to load the package and then expects to find the
		926	C<anyevent_read_type> function inside (see "custom write types", below).
559		927
560	Predefined types are (if you have ideas for additional types, feel free to	928	Predefined types are (if you have ideas for additional types, feel free to
561	drop by and tell us):	929	drop by and tell us):
562		930
563	=over 4	931	=over 4
…		…
620	Other languages could read single lines terminated by a newline and pass	988	Other languages could read single lines terminated by a newline and pass
621	this line into their JSON decoder of choice.	989	this line into their JSON decoder of choice.
622		990
623	=cut	991	=cut
624		992
		993	sub json_coder() {
		994	eval { require JSON::XS; JSON::XS->new->utf8 }
		995	|| do { require JSON; JSON->new->utf8 }
		996	}
		997
625	register_write_type json => sub {	998	register_write_type json => sub {
626	my ($self, $ref) = @_;	999	my ($self, $ref) = @_;
627		1000
628	require JSON;	1001	my $json = $self->{json} ||= json_coder;
629		1002
630	$self->{json} ? $self->{json}->encode ($ref)	1003	$json->encode ($ref)
631	: JSON::encode_json ($ref)
632	};	1004	};
633		1005
634	=item storable => $reference	1006	=item storable => $reference
635		1007
636	Freezes the given reference using L<Storable> and writes it to the	1008	Freezes the given reference using L<Storable> and writes it to the
…		…
646	pack "w/a*", Storable::nfreeze ($ref)	1018	pack "w/a*", Storable::nfreeze ($ref)
647	};	1019	};
648		1020
649	=back	1021	=back
650		1022
651	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	1023	=item $handle->push_shutdown
652		1024
653	This function (not method) lets you add your own types to C<push_write>.	1025	Sometimes you know you want to close the socket after writing your data
		1026	before it was actually written. One way to do that is to replace your
		1027	C<on_drain> handler by a callback that shuts down the socket (and set
		1028	C<low_water_mark> to C<0>). This method is a shorthand for just that, and
		1029	replaces the C<on_drain> callback with:
		1030
		1031	sub { shutdown $_[0]{fh}, 1 } # for push_shutdown
		1032
		1033	This simply shuts down the write side and signals an EOF condition to the
		1034	the peer.
		1035
		1036	You can rely on the normal read queue and C<on_eof> handling
		1037	afterwards. This is the cleanest way to close a connection.
		1038
		1039	=cut
		1040
		1041	sub push_shutdown {
		1042	my ($self) = @_;
		1043
		1044	delete $self->{low_water_mark};
		1045	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });
		1046	}
		1047
		1048	=item custom write types - Package::anyevent_write_type $handle, @args
		1049
		1050	Instead of one of the predefined types, you can also specify the name of
		1051	a package. AnyEvent will try to load the package and then expects to find
		1052	a function named C<anyevent_write_type> inside. If it isn't found, it
		1053	progressively tries to load the parent package until it either finds the
		1054	function (good) or runs out of packages (bad).
		1055
654	Whenever the given C<type> is used, C<push_write> will invoke the code	1056	Whenever the given C<type> is used, C<push_write> will the function with
655	reference with the handle object and the remaining arguments.	1057	the handle object and the remaining arguments.
656		1058
657	The code reference is supposed to return a single octet string that will	1059	The function is supposed to return a single octet string that will be
658	be appended to the write buffer.	1060	appended to the write buffer, so you cna mentally treat this function as a
		1061	"arguments to on-the-wire-format" converter.
659		1062
660	Note that this is a function, and all types registered this way will be	1063	Example: implement a custom write type C<join> that joins the remaining
661	global, so try to use unique names.	1064	arguments using the first one.
		1065
		1066	$handle->push_write (My::Type => " ", 1,2,3);
		1067
		1068	# uses the following package, which can be defined in the "My::Type" or in
		1069	# the "My" modules to be auto-loaded, or just about anywhere when the
		1070	# My::Type::anyevent_write_type is defined before invoking it.
		1071
		1072	package My::Type;
		1073
		1074	sub anyevent_write_type {
		1075	my ($handle, $delim, @args) = @_;
		1076
		1077	join $delim, @args
		1078	}
662		1079
663	=cut	1080	=cut
664		1081
665	#############################################################################	1082	#############################################################################
666		1083
…		…
748	=cut	1165	=cut
749		1166
750	sub _drain_rbuf {	1167	sub _drain_rbuf {
751	my ($self) = @_;	1168	my ($self) = @_;
752		1169
		1170	# avoid recursion
		1171	return if $self->{_skip_drain_rbuf};
753	local $self->{_in_drain} = 1;	1172	local $self->{_skip_drain_rbuf} = 1;
754
755	if (
756	defined $self->{rbuf_max}
757	&& $self->{rbuf_max} < length $self->{rbuf}
758	) {
759	$self->_error (&Errno::ENOSPC, 1), return;
760	}
761		1173
762	while () {	1174	while () {
		1175	# we need to use a separate tls read buffer, as we must not receive data while
		1176	# we are draining the buffer, and this can only happen with TLS.
		1177	$self->{rbuf} .= delete $self->{_tls_rbuf}
		1178	if exists $self->{_tls_rbuf};
		1179
763	my $len = length $self->{rbuf};	1180	my $len = length $self->{rbuf};
764		1181
765	if (my $cb = shift @{ $self->{_queue} }) {	1182	if (my $cb = shift @{ $self->{_queue} }) {
766	unless ($cb->($self)) {	1183	unless ($cb->($self)) {
767	if ($self->{_eof}) {	1184	# no progress can be made
768	# no progress can be made (not enough data and no data forthcoming)	1185	# (not enough data and no data forthcoming)
769	$self->_error (&Errno::EPIPE, 1), return;	1186	$self->_error (Errno::EPIPE, 1), return
770	}	1187	if $self->{_eof};
771		1188
772	unshift @{ $self->{_queue} }, $cb;	1189	unshift @{ $self->{_queue} }, $cb;
773	last;	1190	last;
774	}	1191	}
775	} elsif ($self->{on_read}) {	1192	} elsif ($self->{on_read}) {
…		…
782	&& !@{ $self->{_queue} } # and the queue is still empty	1199	&& !@{ $self->{_queue} } # and the queue is still empty
783	&& $self->{on_read} # but we still have on_read	1200	&& $self->{on_read} # but we still have on_read
784	) {	1201	) {
785	# no further data will arrive	1202	# no further data will arrive
786	# so no progress can be made	1203	# so no progress can be made
787	$self->_error (&Errno::EPIPE, 1), return	1204	$self->_error (Errno::EPIPE, 1), return
788	if $self->{_eof};	1205	if $self->{_eof};
789		1206
790	last; # more data might arrive	1207	last; # more data might arrive
791	}	1208	}
792	} else {	1209	} else {
…		…
795	last;	1212	last;
796	}	1213	}
797	}	1214	}
798		1215
799	if ($self->{_eof}) {	1216	if ($self->{_eof}) {
800	if ($self->{on_eof}) {	1217	$self->{on_eof}
801	$self->{on_eof}($self)	1218	? $self->{on_eof}($self)
802	} else {	1219	: $self->_error (0, 1, "Unexpected end-of-file");
803	$self->_error (0, 1);	1220
804	}	1221	return;
		1222	}
		1223
		1224	if (
		1225	defined $self->{rbuf_max}
		1226	&& $self->{rbuf_max} < length $self->{rbuf}
		1227	) {
		1228	$self->_error (Errno::ENOSPC, 1), return;
805	}	1229	}
806		1230
807	# may need to restart read watcher	1231	# may need to restart read watcher
808	unless ($self->{_rw}) {	1232	unless ($self->{_rw}) {
809	$self->start_read	1233	$self->start_read
…		…
821		1245
822	sub on_read {	1246	sub on_read {
823	my ($self, $cb) = @_;	1247	my ($self, $cb) = @_;
824		1248
825	$self->{on_read} = $cb;	1249	$self->{on_read} = $cb;
826	$self->_drain_rbuf if $cb && !$self->{_in_drain};	1250	$self->_drain_rbuf if $cb;
827	}	1251	}
828		1252
829	=item $handle->rbuf	1253	=item $handle->rbuf
830		1254
831	Returns the read buffer (as a modifiable lvalue).	1255	Returns the read buffer (as a modifiable lvalue).
832		1256
833	You can access the read buffer directly as the C<< ->{rbuf} >> member, if	1257	You can access the read buffer directly as the C<< ->{rbuf} >>
834	you want.	1258	member, if you want. However, the only operation allowed on the
		1259	read buffer (apart from looking at it) is removing data from its
		1260	beginning. Otherwise modifying or appending to it is not allowed and will
		1261	lead to hard-to-track-down bugs.
835		1262
836	NOTE: The read buffer should only be used or modified if the C<on_read>,	1263	NOTE: The read buffer should only be used or modified if the C<on_read>,
837	C<push_read> or C<unshift_read> methods are used. The other read methods	1264	C<push_read> or C<unshift_read> methods are used. The other read methods
838	automatically manage the read buffer.	1265	automatically manage the read buffer.
839		1266
…		…
875	my $cb = pop;	1302	my $cb = pop;
876		1303
877	if (@_) {	1304	if (@_) {
878	my $type = shift;	1305	my $type = shift;
879		1306
		1307	$cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type"
880	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	1308	or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_read")
881	->($self, $cb, @_);	1309	->($self, $cb, @_);
882	}	1310	}
883		1311
884	push @{ $self->{_queue} }, $cb;	1312	push @{ $self->{_queue} }, $cb;
885	$self->_drain_rbuf unless $self->{_in_drain};	1313	$self->_drain_rbuf;
886	}	1314	}
887		1315
888	sub unshift_read {	1316	sub unshift_read {
889	my $self = shift;	1317	my $self = shift;
890	my $cb = pop;	1318	my $cb = pop;
…		…
894		1322
895	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")	1323	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")
896	->($self, $cb, @_);	1324	->($self, $cb, @_);
897	}	1325	}
898		1326
899
900	unshift @{ $self->{_queue} }, $cb;	1327	unshift @{ $self->{_queue} }, $cb;
901	$self->_drain_rbuf unless $self->{_in_drain};	1328	$self->_drain_rbuf;
902	}	1329	}
903		1330
904	=item $handle->push_read (type => @args, $cb)	1331	=item $handle->push_read (type => @args, $cb)
905		1332
906	=item $handle->unshift_read (type => @args, $cb)	1333	=item $handle->unshift_read (type => @args, $cb)
907		1334
908	Instead of providing a callback that parses the data itself you can chose	1335	Instead of providing a callback that parses the data itself you can chose
909	between a number of predefined parsing formats, for chunks of data, lines	1336	between a number of predefined parsing formats, for chunks of data, lines
910	etc.	1337	etc. You can also specify the (fully qualified) name of a package, in
		1338	which case AnyEvent tries to load the package and then expects to find the
		1339	C<anyevent_read_type> function inside (see "custom read types", below).
911		1340
912	Predefined types are (if you have ideas for additional types, feel free to	1341	Predefined types are (if you have ideas for additional types, feel free to
913	drop by and tell us):	1342	drop by and tell us):
914		1343
915	=over 4	1344	=over 4
…		…
1039	return 1;	1468	return 1;
1040	}	1469	}
1041		1470
1042	# reject	1471	# reject
1043	if ($reject && $$rbuf =~ $reject) {	1472	if ($reject && $$rbuf =~ $reject) {
1044	$self->_error (&Errno::EBADMSG);	1473	$self->_error (Errno::EBADMSG);
1045	}	1474	}
1046		1475
1047	# skip	1476	# skip
1048	if ($skip && $$rbuf =~ $skip) {	1477	if ($skip && $$rbuf =~ $skip) {
1049	$data .= substr $$rbuf, 0, $+[0], "";	1478	$data .= substr $$rbuf, 0, $+[0], "";
…		…
1065	my ($self, $cb) = @_;	1494	my ($self, $cb) = @_;
1066		1495
1067	sub {	1496	sub {
1068	unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {	1497	unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {
1069	if ($_[0]{rbuf} =~ /[^0-9]/) {	1498	if ($_[0]{rbuf} =~ /[^0-9]/) {
1070	$self->_error (&Errno::EBADMSG);	1499	$self->_error (Errno::EBADMSG);
1071	}	1500	}
1072	return;	1501	return;
1073	}	1502	}
1074		1503
1075	my $len = $1;	1504	my $len = $1;
…		…
1078	my $string = $_[1];	1507	my $string = $_[1];
1079	$_[0]->unshift_read (chunk => 1, sub {	1508	$_[0]->unshift_read (chunk => 1, sub {
1080	if ($_[1] eq ",") {	1509	if ($_[1] eq ",") {
1081	$cb->($_[0], $string);	1510	$cb->($_[0], $string);
1082	} else {	1511	} else {
1083	$self->_error (&Errno::EBADMSG);	1512	$self->_error (Errno::EBADMSG);
1084	}	1513	}
1085	});	1514	});
1086	});	1515	});
1087		1516
1088	1	1517	1
…		…
1135	}	1564	}
1136	};	1565	};
1137		1566
1138	=item json => $cb->($handle, $hash_or_arrayref)	1567	=item json => $cb->($handle, $hash_or_arrayref)
1139		1568
1140	Reads a JSON object or array, decodes it and passes it to the callback.	1569	Reads a JSON object or array, decodes it and passes it to the
		1570	callback. When a parse error occurs, an C<EBADMSG> error will be raised.
1141		1571
1142	If a C<json> object was passed to the constructor, then that will be used	1572	If a C<json> object was passed to the constructor, then that will be used
1143	for the final decode, otherwise it will create a JSON coder expecting UTF-8.	1573	for the final decode, otherwise it will create a JSON coder expecting UTF-8.
1144		1574
1145	This read type uses the incremental parser available with JSON version	1575	This read type uses the incremental parser available with JSON version
…		…
1154	=cut	1584	=cut
1155		1585
1156	register_read_type json => sub {	1586	register_read_type json => sub {
1157	my ($self, $cb) = @_;	1587	my ($self, $cb) = @_;
1158		1588
1159	require JSON;	1589	my $json = $self->{json} ||= json_coder;
1160		1590
1161	my $data;	1591	my $data;
1162	my $rbuf = \$self->{rbuf};	1592	my $rbuf = \$self->{rbuf};
1163		1593
1164	my $json = $self->{json} ||= JSON->new->utf8;
1165
1166	sub {	1594	sub {
1167	my $ref = $json->incr_parse ($self->{rbuf});	1595	my $ref = eval { $json->incr_parse ($self->{rbuf}) };
1168		1596
1169	if ($ref) {	1597	if ($ref) {
1170	$self->{rbuf} = $json->incr_text;	1598	$self->{rbuf} = $json->incr_text;
1171	$json->incr_text = "";	1599	$json->incr_text = "";
1172	$cb->($self, $ref);	1600	$cb->($self, $ref);
1173		1601
1174	1	1602	1
		1603	} elsif ($@) {
		1604	# error case
		1605	$json->incr_skip;
		1606
		1607	$self->{rbuf} = $json->incr_text;
		1608	$json->incr_text = "";
		1609
		1610	$self->_error (Errno::EBADMSG);
		1611
		1612	()
1175	} else {	1613	} else {
1176	$self->{rbuf} = "";	1614	$self->{rbuf} = "";
		1615
1177	()	1616	()
1178	}	1617	}
1179	}	1618	}
1180	};	1619	};
1181		1620
…		…
1213	# read remaining chunk	1652	# read remaining chunk
1214	$_[0]->unshift_read (chunk => $len, sub {	1653	$_[0]->unshift_read (chunk => $len, sub {
1215	if (my $ref = eval { Storable::thaw ($_[1]) }) {	1654	if (my $ref = eval { Storable::thaw ($_[1]) }) {
1216	$cb->($_[0], $ref);	1655	$cb->($_[0], $ref);
1217	} else {	1656	} else {
1218	$self->_error (&Errno::EBADMSG);	1657	$self->_error (Errno::EBADMSG);
1219	}	1658	}
1220	});	1659	});
1221	}	1660	}
1222		1661
1223	1	1662	1
1224	}	1663	}
1225	};	1664	};
1226		1665
1227	=back	1666	=back
1228		1667
1229	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)	1668	=item custom read types - Package::anyevent_read_type $handle, $cb, @args
1230		1669
1231	This function (not method) lets you add your own types to C<push_read>.	1670	Instead of one of the predefined types, you can also specify the name
		1671	of a package. AnyEvent will try to load the package and then expects to
		1672	find a function named C<anyevent_read_type> inside. If it isn't found, it
		1673	progressively tries to load the parent package until it either finds the
		1674	function (good) or runs out of packages (bad).
1232		1675
1233	Whenever the given C<type> is used, C<push_read> will invoke the code	1676	Whenever this type is used, C<push_read> will invoke the function with the
1234	reference with the handle object, the callback and the remaining	1677	handle object, the original callback and the remaining arguments.
1235	arguments.
1236		1678
1237	The code reference is supposed to return a callback (usually a closure)	1679	The function is supposed to return a callback (usually a closure) that
1238	that works as a plain read callback (see C<< ->push_read ($cb) >>).	1680	works as a plain read callback (see C<< ->push_read ($cb) >>), so you can
		1681	mentally treat the function as a "configurable read type to read callback"
		1682	converter.
1239		1683
1240	It should invoke the passed callback when it is done reading (remember to	1684	It should invoke the original callback when it is done reading (remember
1241	pass C<$handle> as first argument as all other callbacks do that).	1685	to pass C<$handle> as first argument as all other callbacks do that,
		1686	although there is no strict requirement on this).
1242		1687
1243	Note that this is a function, and all types registered this way will be
1244	global, so try to use unique names.
1245
1246	For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>,	1688	For examples, see the source of this module (F<perldoc -m
1247	search for C<register_read_type>)).	1689	AnyEvent::Handle>, search for C<register_read_type>)).
1248		1690
1249	=item $handle->stop_read	1691	=item $handle->stop_read
1250		1692
1251	=item $handle->start_read	1693	=item $handle->start_read
1252		1694
…		…
1275	my ($self) = @_;	1717	my ($self) = @_;
1276		1718
1277	unless ($self->{_rw} || $self->{_eof}) {	1719	unless ($self->{_rw} || $self->{_eof}) {
1278	Scalar::Util::weaken $self;	1720	Scalar::Util::weaken $self;
1279		1721
1280	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1722	$self->{_rw} = AE::io $self->{fh}, 0, sub {
1281	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});	1723	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1282	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf;	1724	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf;
1283		1725
1284	if ($len > 0) {	1726	if ($len > 0) {
1285	$self->{_activity} = AnyEvent->now;	1727	$self->{_activity} = $self->{_ractivity} = AE::now;
1286		1728
1287	if ($self->{tls}) {	1729	if ($self->{tls}) {
1288	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);	1730	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1289		1731
1290	&_dotls ($self);	1732	&_dotls ($self);
1291	} else {	1733	} else {
1292	$self->_drain_rbuf unless $self->{_in_drain};	1734	$self->_drain_rbuf;
1293	}	1735	}
1294		1736
1295	} elsif (defined $len) {	1737	} elsif (defined $len) {
1296	delete $self->{_rw};	1738	delete $self->{_rw};
1297	$self->{_eof} = 1;	1739	$self->{_eof} = 1;
1298	$self->_drain_rbuf unless $self->{_in_drain};	1740	$self->_drain_rbuf;
1299		1741
1300	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1742	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1301	return $self->_error ($!, 1);	1743	return $self->_error ($!, 1);
1302	}	1744	}
1303	});	1745	};
		1746	}
		1747	}
		1748
		1749	our $ERROR_SYSCALL;
		1750	our $ERROR_WANT_READ;
		1751
		1752	sub _tls_error {
		1753	my ($self, $err) = @_;
		1754
		1755	return $self->_error ($!, 1)
		1756	if $err == Net::SSLeay::ERROR_SYSCALL ();
		1757
		1758	my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());
		1759
		1760	# reduce error string to look less scary
		1761	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;
		1762
		1763	if ($self->{_on_starttls}) {
		1764	(delete $self->{_on_starttls})->($self, undef, $err);
		1765	&_freetls;
		1766	} else {
		1767	&_freetls;
		1768	$self->_error (Errno::EPROTO, 1, $err);
1304	}	1769	}
1305	}	1770	}
1306		1771
1307	# poll the write BIO and send the data if applicable	1772	# poll the write BIO and send the data if applicable
		1773	# also decode read data if possible
		1774	# this is basiclaly our TLS state machine
		1775	# more efficient implementations are possible with openssl,
		1776	# but not with the buggy and incomplete Net::SSLeay.
1308	sub _dotls {	1777	sub _dotls {
1309	my ($self) = @_;	1778	my ($self) = @_;
1310		1779
1311	my $tmp;	1780	my $tmp;
1312		1781
1313	if (length $self->{_tls_wbuf}) {	1782	if (length $self->{_tls_wbuf}) {
1314	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1783	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1315	substr $self->{_tls_wbuf}, 0, $tmp, "";	1784	substr $self->{_tls_wbuf}, 0, $tmp, "";
1316	}	1785	}
		1786
		1787	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);
		1788	return $self->_tls_error ($tmp)
		1789	if $tmp != $ERROR_WANT_READ
		1790	&& ($tmp != $ERROR_SYSCALL || $!);
1317	}	1791	}
1318		1792
1319	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {	1793	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
1320	unless (length $tmp) {	1794	unless (length $tmp) {
1321	# let's treat SSL-eof as we treat normal EOF	1795	$self->{_on_starttls}
1322	delete $self->{_rw};	1796	and (delete $self->{_on_starttls})->($self, undef, "EOF during handshake"); # ???
1323	$self->{_eof} = 1;
1324	&_freetls;	1797	&_freetls;
		1798
		1799	if ($self->{on_stoptls}) {
		1800	$self->{on_stoptls}($self);
		1801	return;
		1802	} else {
		1803	# let's treat SSL-eof as we treat normal EOF
		1804	delete $self->{_rw};
		1805	$self->{_eof} = 1;
		1806	}
1325	}	1807	}
1326		1808
1327	$self->{rbuf} .= $tmp;	1809	$self->{_tls_rbuf} .= $tmp;
1328	$self->_drain_rbuf unless $self->{_in_drain};	1810	$self->_drain_rbuf;
1329	$self->{tls} or return; # tls session might have gone away in callback	1811	$self->{tls} or return; # tls session might have gone away in callback
1330	}	1812	}
1331		1813
1332	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);	1814	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1333
1334	if ($tmp != Net::SSLeay::ERROR_WANT_READ ()) {
1335	if ($tmp == Net::SSLeay::ERROR_SYSCALL ()) {
1336	return $self->_error ($!, 1);	1815	return $self->_tls_error ($tmp)
1337	} elsif ($tmp == Net::SSLeay::ERROR_SSL ()) {	1816	if $tmp != $ERROR_WANT_READ
1338	return $self->_error (&Errno::EIO, 1);	1817	&& ($tmp != $ERROR_SYSCALL || $!);
1339	}
1340
1341	# all other errors are fine for our purposes
1342	}
1343		1818
1344	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1819	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1345	$self->{wbuf} .= $tmp;	1820	$self->{wbuf} .= $tmp;
1346	$self->_drain_wbuf;	1821	$self->_drain_wbuf;
1347	}	1822	}
		1823
		1824	$self->{_on_starttls}
		1825	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
		1826	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");
1348	}	1827	}
1349		1828
1350	=item $handle->starttls ($tls[, $tls_ctx])	1829	=item $handle->starttls ($tls[, $tls_ctx])
1351		1830
1352	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	1831	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
1353	object is created, you can also do that at a later time by calling	1832	object is created, you can also do that at a later time by calling
1354	C<starttls>.	1833	C<starttls>.
1355		1834
		1835	Starting TLS is currently an asynchronous operation - when you push some
		1836	write data and then call C<< ->starttls >> then TLS negotiation will start
		1837	immediately, after which the queued write data is then sent.
		1838
1356	The first argument is the same as the C<tls> constructor argument (either	1839	The first argument is the same as the C<tls> constructor argument (either
1357	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1840	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1358		1841
1359	The second argument is the optional C<Net::SSLeay::CTX> object that is	1842	The second argument is the optional C<AnyEvent::TLS> object that is used
1360	used when AnyEvent::Handle has to create its own TLS connection object.	1843	when AnyEvent::Handle has to create its own TLS connection object, or
		1844	a hash reference with C<< key => value >> pairs that will be used to
		1845	construct a new context.
1361		1846
1362	The TLS connection object will end up in C<< $handle->{tls} >> after this	1847	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS
1363	call and can be used or changed to your liking. Note that the handshake	1848	context in C<< $handle->{tls_ctx} >> after this call and can be used or
1364	might have already started when this function returns.	1849	changed to your liking. Note that the handshake might have already started
		1850	when this function returns.
1365		1851
1366	If it an error to start a TLS handshake more than once per	1852	Due to bugs in OpenSSL, it might or might not be possible to do multiple
1367	AnyEvent::Handle object (this is due to bugs in OpenSSL).	1853	handshakes on the same stream. Best do not attempt to use the stream after
		1854	stopping TLS.
1368		1855
1369	=cut	1856	=cut
		1857
		1858	our %TLS_CACHE; #TODO not yet documented, should we?
1370		1859
1371	sub starttls {	1860	sub starttls {
1372	my ($self, $ssl, $ctx) = @_;	1861	my ($self, $tls, $ctx) = @_;
		1862
		1863	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"
		1864	if $self->{tls};
		1865
		1866	$self->{tls} = $tls;
		1867	$self->{tls_ctx} = $ctx if @_ > 2;
		1868
		1869	return unless $self->{fh};
1373		1870
1374	require Net::SSLeay;	1871	require Net::SSLeay;
1375		1872
1376	Carp::croak "it is an error to call starttls more than once on an Anyevent::Handle object"	1873	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1377	if $self->{tls};	1874	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
		1875
		1876	$tls = delete $self->{tls};
		1877	$ctx = $self->{tls_ctx};
		1878
		1879	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
		1880
		1881	if ("HASH" eq ref $ctx) {
		1882	require AnyEvent::TLS;
		1883
		1884	if ($ctx->{cache}) {
		1885	my $key = $ctx+0;
		1886	$ctx = $TLS_CACHE{$key} ||= new AnyEvent::TLS %$ctx;
		1887	} else {
		1888	$ctx = new AnyEvent::TLS %$ctx;
		1889	}
		1890	}
1378		1891
1379	if ($ssl eq "accept") {	1892	$self->{tls_ctx} = $ctx || TLS_CTX ();
1380	$ssl = Net::SSLeay::new ($ctx || TLS_CTX ());	1893	$self->{tls} = $tls = $self->{tls_ctx}->_get_session ($tls, $self, $self->{peername});
1381	Net::SSLeay::set_accept_state ($ssl);
1382	} elsif ($ssl eq "connect") {
1383	$ssl = Net::SSLeay::new ($ctx || TLS_CTX ());
1384	Net::SSLeay::set_connect_state ($ssl);
1385	}
1386
1387	$self->{tls} = $ssl;
1388		1894
1389	# basically, this is deep magic (because SSL_read should have the same issues)	1895	# basically, this is deep magic (because SSL_read should have the same issues)
1390	# but the openssl maintainers basically said: "trust us, it just works".	1896	# but the openssl maintainers basically said: "trust us, it just works".
1391	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1897	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1392	# and mismaintained ssleay-module doesn't even offer them).	1898	# and mismaintained ssleay-module doesn't even offer them).
…		…
1396	#	1902	#
1397	# note that we do not try to keep the length constant between writes as we are required to do.	1903	# note that we do not try to keep the length constant between writes as we are required to do.
1398	# we assume that most (but not all) of this insanity only applies to non-blocking cases,	1904	# we assume that most (but not all) of this insanity only applies to non-blocking cases,
1399	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to	1905	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
1400	# have identity issues in that area.	1906	# have identity issues in that area.
1401	Net::SSLeay::CTX_set_mode ($self->{tls},	1907	# Net::SSLeay::CTX_set_mode ($ssl,
1402	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)	1908	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)
1403	| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));	1909	# | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));
		1910	Net::SSLeay::CTX_set_mode ($tls, 1|2);
1404		1911
1405	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1912	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1406	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1913	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1407		1914
		1915	Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf});
		1916
1408	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1917	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
		1918
		1919	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
		1920	if $self->{on_starttls};
1409		1921
1410	&_dotls; # need to trigger the initial handshake	1922	&_dotls; # need to trigger the initial handshake
1411	$self->start_read; # make sure we actually do read	1923	$self->start_read; # make sure we actually do read
1412	}	1924	}
1413		1925
1414	=item $handle->stoptls	1926	=item $handle->stoptls
1415		1927
1416	Shuts down the SSL connection - this makes a proper EOF handshake by	1928	Shuts down the SSL connection - this makes a proper EOF handshake by
1417	sending a close notify to the other side, but since OpenSSL doesn't	1929	sending a close notify to the other side, but since OpenSSL doesn't
1418	support non-blocking shut downs, it is not possible to re-use the stream	1930	support non-blocking shut downs, it is not guarenteed that you can re-use
1419	afterwards.	1931	the stream afterwards.
1420		1932
1421	=cut	1933	=cut
1422		1934
1423	sub stoptls {	1935	sub stoptls {
1424	my ($self) = @_;	1936	my ($self) = @_;
…		…
1426	if ($self->{tls}) {	1938	if ($self->{tls}) {
1427	Net::SSLeay::shutdown ($self->{tls});	1939	Net::SSLeay::shutdown ($self->{tls});
1428		1940
1429	&_dotls;	1941	&_dotls;
1430		1942
1431	# we don't give a shit. no, we do, but we can't. no...	1943	# # we don't give a shit. no, we do, but we can't. no...#d#
1432	# we, we... have to use openssl :/	1944	# # we, we... have to use openssl :/#d#
1433	&_freetls;	1945	# &_freetls;#d#
1434	}	1946	}
1435	}	1947	}
1436		1948
1437	sub _freetls {	1949	sub _freetls {
1438	my ($self) = @_;	1950	my ($self) = @_;
1439		1951
1440	return unless $self->{tls};	1952	return unless $self->{tls};
1441		1953
1442	Net::SSLeay::free (delete $self->{tls});	1954	$self->{tls_ctx}->_put_session (delete $self->{tls})
		1955	if $self->{tls} > 0;
1443		1956
1444	delete @$self{qw(_rbio _wbio _tls_wbuf)};	1957	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1445	}	1958	}
1446		1959
1447	sub DESTROY {	1960	sub DESTROY {
1448	my $self = shift;	1961	my ($self) = @_;
1449		1962
1450	&_freetls;	1963	&_freetls;
1451		1964
1452	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	1965	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1453		1966
1454	if ($linger && length $self->{wbuf}) {	1967	if ($linger && length $self->{wbuf} && $self->{fh}) {
1455	my $fh = delete $self->{fh};	1968	my $fh = delete $self->{fh};
1456	my $wbuf = delete $self->{wbuf};	1969	my $wbuf = delete $self->{wbuf};
1457		1970
1458	my @linger;	1971	my @linger;
1459		1972
1460	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {	1973	push @linger, AE::io $fh, 1, sub {
1461	my $len = syswrite $fh, $wbuf, length $wbuf;	1974	my $len = syswrite $fh, $wbuf, length $wbuf;
1462		1975
1463	if ($len > 0) {	1976	if ($len > 0) {
1464	substr $wbuf, 0, $len, "";	1977	substr $wbuf, 0, $len, "";
1465	} else {	1978	} else {
1466	@linger = (); # end	1979	@linger = (); # end
1467	}	1980	}
1468	});	1981	};
1469	push @linger, AnyEvent->timer (after => $linger, cb => sub {	1982	push @linger, AE::timer $linger, 0, sub {
1470	@linger = ();	1983	@linger = ();
1471	});	1984	};
1472	}	1985	}
1473	}	1986	}
1474		1987
1475	=item $handle->destroy	1988	=item $handle->destroy
1476		1989
1477	Shut's down the handle object as much as possible - this call ensures that	1990	Shuts down the handle object as much as possible - this call ensures that
1478	no further callbacks will be invoked and resources will be freed as much	1991	no further callbacks will be invoked and as many resources as possible
1479	as possible. You must not call any methods on the object afterwards.	1992	will be freed. Any method you will call on the handle object after
		1993	destroying it in this way will be silently ignored (and it will return the
		1994	empty list).
		1995
		1996	Normally, you can just "forget" any references to an AnyEvent::Handle
		1997	object and it will simply shut down. This works in fatal error and EOF
		1998	callbacks, as well as code outside. It does I<NOT> work in a read or write
		1999	callback, so when you want to destroy the AnyEvent::Handle object from
		2000	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
		2001	that case.
		2002
		2003	Destroying the handle object in this way has the advantage that callbacks
		2004	will be removed as well, so if those are the only reference holders (as
		2005	is common), then one doesn't need to do anything special to break any
		2006	reference cycles.
1480		2007
1481	The handle might still linger in the background and write out remaining	2008	The handle might still linger in the background and write out remaining
1482	data, as specified by the C<linger> option, however.	2009	data, as specified by the C<linger> option, however.
1483		2010
1484	=cut	2011	=cut
…		…
1486	sub destroy {	2013	sub destroy {
1487	my ($self) = @_;	2014	my ($self) = @_;
1488		2015
1489	$self->DESTROY;	2016	$self->DESTROY;
1490	%$self = ();	2017	%$self = ();
		2018	bless $self, "AnyEvent::Handle::destroyed";
		2019	}
		2020
		2021	sub AnyEvent::Handle::destroyed::AUTOLOAD {
		2022	#nop
1491	}	2023	}
1492		2024
1493	=item AnyEvent::Handle::TLS_CTX	2025	=item AnyEvent::Handle::TLS_CTX
1494		2026
1495	This function creates and returns the Net::SSLeay::CTX object used by	2027	This function creates and returns the AnyEvent::TLS object used by default
1496	default for TLS mode.	2028	for TLS mode.
1497		2029
1498	The context is created like this:	2030	The context is created by calling L<AnyEvent::TLS> without any arguments.
1499
1500	Net::SSLeay::load_error_strings;
1501	Net::SSLeay::SSLeay_add_ssl_algorithms;
1502	Net::SSLeay::randomize;
1503
1504	my $CTX = Net::SSLeay::CTX_new;
1505
1506	Net::SSLeay::CTX_set_options $CTX, Net::SSLeay::OP_ALL
1507		2031
1508	=cut	2032	=cut
1509		2033
1510	our $TLS_CTX;	2034	our $TLS_CTX;
1511		2035
1512	sub TLS_CTX() {	2036	sub TLS_CTX() {
1513	$TLS_CTX || do {	2037	$TLS_CTX ||= do {
1514	require Net::SSLeay;	2038	require AnyEvent::TLS;
1515		2039
1516	Net::SSLeay::load_error_strings ();	2040	new AnyEvent::TLS
1517	Net::SSLeay::SSLeay_add_ssl_algorithms ();
1518	Net::SSLeay::randomize ();
1519
1520	$TLS_CTX = Net::SSLeay::CTX_new ();
1521
1522	Net::SSLeay::CTX_set_options ($TLS_CTX, Net::SSLeay::OP_ALL ());
1523
1524	$TLS_CTX
1525	}	2041	}
1526	}	2042	}
1527		2043
1528	=back	2044	=back
1529		2045
1530		2046
1531	=head1 NONFREQUENTLY ASKED QUESTIONS	2047	=head1 NONFREQUENTLY ASKED QUESTIONS
1532		2048
1533	=over 4	2049	=over 4
		2050
		2051	=item I C<undef> the AnyEvent::Handle reference inside my callback and
		2052	still get further invocations!
		2053
		2054	That's because AnyEvent::Handle keeps a reference to itself when handling
		2055	read or write callbacks.
		2056
		2057	It is only safe to "forget" the reference inside EOF or error callbacks,
		2058	from within all other callbacks, you need to explicitly call the C<<
		2059	->destroy >> method.
		2060
		2061	=item I get different callback invocations in TLS mode/Why can't I pause
		2062	reading?
		2063
		2064	Unlike, say, TCP, TLS connections do not consist of two independent
		2065	communication channels, one for each direction. Or put differently. The
		2066	read and write directions are not independent of each other: you cannot
		2067	write data unless you are also prepared to read, and vice versa.
		2068
		2069	This can mean than, in TLS mode, you might get C<on_error> or C<on_eof>
		2070	callback invocations when you are not expecting any read data - the reason
		2071	is that AnyEvent::Handle always reads in TLS mode.
		2072
		2073	During the connection, you have to make sure that you always have a
		2074	non-empty read-queue, or an C<on_read> watcher. At the end of the
		2075	connection (or when you no longer want to use it) you can call the
		2076	C<destroy> method.
1534		2077
1535	=item How do I read data until the other side closes the connection?	2078	=item How do I read data until the other side closes the connection?
1536		2079
1537	If you just want to read your data into a perl scalar, the easiest way	2080	If you just want to read your data into a perl scalar, the easiest way
1538	to achieve this is by setting an C<on_read> callback that does nothing,	2081	to achieve this is by setting an C<on_read> callback that does nothing,
…		…
1541		2084
1542	$handle->on_read (sub { });	2085	$handle->on_read (sub { });
1543	$handle->on_eof (undef);	2086	$handle->on_eof (undef);
1544	$handle->on_error (sub {	2087	$handle->on_error (sub {
1545	my $data = delete $_[0]{rbuf};	2088	my $data = delete $_[0]{rbuf};
1546	undef $handle;
1547	});	2089	});
1548		2090
1549	The reason to use C<on_error> is that TCP connections, due to latencies	2091	The reason to use C<on_error> is that TCP connections, due to latencies
1550	and packets loss, might get closed quite violently with an error, when in	2092	and packets loss, might get closed quite violently with an error, when in
1551	fact, all data has been received.	2093	fact, all data has been received.
1552		2094
1553	It is usually better to use acknowledgements when transfering data,	2095	It is usually better to use acknowledgements when transferring data,
1554	to make sure the other side hasn't just died and you got the data	2096	to make sure the other side hasn't just died and you got the data
1555	intact. This is also one reason why so many internet protocols have an	2097	intact. This is also one reason why so many internet protocols have an
1556	explicit QUIT command.	2098	explicit QUIT command.
1557
1558		2099
1559	=item I don't want to destroy the handle too early - how do I wait until	2100	=item I don't want to destroy the handle too early - how do I wait until
1560	all data has been written?	2101	all data has been written?
1561		2102
1562	After writing your last bits of data, set the C<on_drain> callback	2103	After writing your last bits of data, set the C<on_drain> callback
…		…
1568	$handle->on_drain (sub {	2109	$handle->on_drain (sub {
1569	warn "all data submitted to the kernel\n";	2110	warn "all data submitted to the kernel\n";
1570	undef $handle;	2111	undef $handle;
1571	});	2112	});
1572		2113
1573	=item I get different callback invocations in TLS mode/Why can't I pause	2114	If you just want to queue some data and then signal EOF to the other side,
1574	reading?	2115	consider using C<< ->push_shutdown >> instead.
1575		2116
1576	Unlike, say, TCP, TLS conenctions do not consist of two independent	2117	=item I want to contact a TLS/SSL server, I don't care about security.
1577	communication channels, one for each direction. Or put differently. the
1578	read and write directions are not independent of each other: you cannot
1579	write data unless you are also prepared to read, and vice versa.
1580		2118
1581	This can mean than, in TLS mode, you might get C<on_error> or C<on_eof>	2119	If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS,
1582	callback invocations when you are not expecting any read data - the reason	2120	simply connect to it and then create the AnyEvent::Handle with the C<tls>
1583	is that AnyEvent::Handle always reads in TLS mode.	2121	parameter:
1584		2122
1585	During the connection, you have to make sure that you always have a	2123	tcp_connect $host, $port, sub {
1586	non-empty read-queue, or an C<on_read> watcher. At the end of the	2124	my ($fh) = @_;
1587	connection (or when you no longer want to use it) you can call the	2125
1588	C<destroy> method.	2126	my $handle = new AnyEvent::Handle
		2127	fh => $fh,
		2128	tls => "connect",
		2129	on_error => sub { ... };
		2130
		2131	$handle->push_write (...);
		2132	};
		2133
		2134	=item I want to contact a TLS/SSL server, I do care about security.
		2135
		2136	Then you should additionally enable certificate verification, including
		2137	peername verification, if the protocol you use supports it (see
		2138	L<AnyEvent::TLS>, C<verify_peername>).
		2139
		2140	E.g. for HTTPS:
		2141
		2142	tcp_connect $host, $port, sub {
		2143	my ($fh) = @_;
		2144
		2145	my $handle = new AnyEvent::Handle
		2146	fh => $fh,
		2147	peername => $host,
		2148	tls => "connect",
		2149	tls_ctx => { verify => 1, verify_peername => "https" },
		2150	...
		2151
		2152	Note that you must specify the hostname you connected to (or whatever
		2153	"peername" the protocol needs) as the C<peername> argument, otherwise no
		2154	peername verification will be done.
		2155
		2156	The above will use the system-dependent default set of trusted CA
		2157	certificates. If you want to check against a specific CA, add the
		2158	C<ca_file> (or C<ca_cert>) arguments to C<tls_ctx>:
		2159
		2160	tls_ctx => {
		2161	verify => 1,
		2162	verify_peername => "https",
		2163	ca_file => "my-ca-cert.pem",
		2164	},
		2165
		2166	=item I want to create a TLS/SSL server, how do I do that?
		2167
		2168	Well, you first need to get a server certificate and key. You have
		2169	three options: a) ask a CA (buy one, use cacert.org etc.) b) create a
		2170	self-signed certificate (cheap. check the search engine of your choice,
		2171	there are many tutorials on the net) or c) make your own CA (tinyca2 is a
		2172	nice program for that purpose).
		2173
		2174	Then create a file with your private key (in PEM format, see
		2175	L<AnyEvent::TLS>), followed by the certificate (also in PEM format). The
		2176	file should then look like this:
		2177
		2178	-----BEGIN RSA PRIVATE KEY-----
		2179	...header data
		2180	... lots of base64'y-stuff
		2181	-----END RSA PRIVATE KEY-----
		2182
		2183	-----BEGIN CERTIFICATE-----
		2184	... lots of base64'y-stuff
		2185	-----END CERTIFICATE-----
		2186
		2187	The important bits are the "PRIVATE KEY" and "CERTIFICATE" parts. Then
		2188	specify this file as C<cert_file>:
		2189
		2190	tcp_server undef, $port, sub {
		2191	my ($fh) = @_;
		2192
		2193	my $handle = new AnyEvent::Handle
		2194	fh => $fh,
		2195	tls => "accept",
		2196	tls_ctx => { cert_file => "my-server-keycert.pem" },
		2197	...
		2198
		2199	When you have intermediate CA certificates that your clients might not
		2200	know about, just append them to the C<cert_file>.
1589		2201
1590	=back	2202	=back
1591		2203
1592		2204
1593	=head1 SUBCLASSING AnyEvent::Handle	2205	=head1 SUBCLASSING AnyEvent::Handle

Diff Legend

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