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.120 by root, Fri Mar 27 08:33:41 2009 UTC vs.
Revision 1.196 by root, Tue Jun 8 10:04:17 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 streaming handles via AnyEvent
16
17	=cut
18
19	our $VERSION = 4.341;
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	stream-based filehandles (sockets, pipes or other stream things).
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) = @_;
		536
		537	# too many clueless people try to use udp and similar sockets
		538	# with AnyEvent::Handle, do them a favour.
		539	my $type = getsockopt $self->{fh}, Socket::SOL_SOCKET (), Socket::SO_TYPE ();
		540	Carp::croak "AnyEvent::Handle: only stream sockets supported, anything else will NOT work!"
		541	if Socket::SOCK_STREAM () != (unpack "I", $type) && defined $type;
296		542
297	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	543	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
298		544
		545	$self->{_activity} =
		546	$self->{_ractivity} =
		547	$self->{_wactivity} = AE::now;
		548
		549	$self->timeout (delete $self->{timeout} ) if $self->{timeout};
		550	$self->rtimeout (delete $self->{rtimeout} ) if $self->{rtimeout};
		551	$self->wtimeout (delete $self->{wtimeout} ) if $self->{wtimeout};
		552
		553	$self->no_delay (delete $self->{no_delay} ) if exists $self->{no_delay} && $self->{no_delay};
		554	$self->keepalive (delete $self->{keepalive}) if exists $self->{keepalive} && $self->{keepalive};
		555
		556	$self->oobinline (exists $self->{oobinline} ? delete $self->{oobinline} : 1);
		557
299	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})	558	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
300	if $self->{tls};	559	if $self->{tls};
301		560
302	$self->{_activity} = AnyEvent->now;
303	$self->_timeout;
304
305	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};	561	$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		562
308	$self->start_read	563	$self->start_read
309	if $self->{on_read};	564	if $self->{on_read} || @{ $self->{_queue} };
310		565
311	$self	566	$self->_drain_wbuf;
312	}
313
314	sub _shutdown {
315	my ($self) = @_;
316
317	delete $self->{_tw};
318	delete $self->{_rw};
319	delete $self->{_ww};
320	delete $self->{fh};
321
322	&_freetls;
323
324	delete $self->{on_read};
325	delete $self->{_queue};
326	}	567	}
327		568
328	sub _error {	569	sub _error {
329	my ($self, $errno, $fatal) = @_;	570	my ($self, $errno, $fatal, $message) = @_;
330
331	$self->_shutdown
332	if $fatal;
333		571
334	$! = $errno;	572	$! = $errno;
		573	$message ||= "$!";
335		574
336	if ($self->{on_error}) {	575	if ($self->{on_error}) {
337	$self->{on_error}($self, $fatal);	576	$self->{on_error}($self, $fatal, $message);
338	} elsif ($self->{fh}) {	577	$self->destroy if $fatal;
		578	} elsif ($self->{fh} || $self->{connect}) {
		579	$self->destroy;
339	Carp::croak "AnyEvent::Handle uncaught error: $!";	580	Carp::croak "AnyEvent::Handle uncaught error: $message";
340	}	581	}
341	}	582	}
342		583
343	=item $fh = $handle->fh	584	=item $fh = $handle->fh
344		585
…		…
368	$_[0]{on_eof} = $_[1];	609	$_[0]{on_eof} = $_[1];
369	}	610	}
370		611
371	=item $handle->on_timeout ($cb)	612	=item $handle->on_timeout ($cb)
372		613
373	Replace the current C<on_timeout> callback, or disables the callback (but	614	=item $handle->on_rtimeout ($cb)
374	not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
375	argument and method.
376		615
377	=cut	616	=item $handle->on_wtimeout ($cb)
378		617
379	sub on_timeout {	618	Replace the current C<on_timeout>, C<on_rtimeout> or C<on_wtimeout>
380	$_[0]{on_timeout} = $_[1];	619	callback, or disables the callback (but not the timeout) if C<$cb> =
381	}	620	C<undef>. See the C<timeout> constructor argument and method.
		621
		622	=cut
		623
		624	# see below
382		625
383	=item $handle->autocork ($boolean)	626	=item $handle->autocork ($boolean)
384		627
385	Enables or disables the current autocork behaviour (see C<autocork>	628	Enables or disables the current autocork behaviour (see C<autocork>
386	constructor argument). Changes will only take effect on the next write.	629	constructor argument). Changes will only take effect on the next write.
…		…
401	sub no_delay {	644	sub no_delay {
402	$_[0]{no_delay} = $_[1];	645	$_[0]{no_delay} = $_[1];
403		646
404	eval {	647	eval {
405	local $SIG{__DIE__};	648	local $SIG{__DIE__};
406	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];	649	setsockopt $_[0]{fh}, Socket::IPPROTO_TCP (), Socket::TCP_NODELAY (), int $_[1]
		650	if $_[0]{fh};
407	};	651	};
408	}	652	}
409		653
		654	=item $handle->keepalive ($boolean)
		655
		656	Enables or disables the C<keepalive> setting (see constructor argument of
		657	the same name for details).
		658
		659	=cut
		660
		661	sub keepalive {
		662	$_[0]{keepalive} = $_[1];
		663
		664	eval {
		665	local $SIG{__DIE__};
		666	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
		667	if $_[0]{fh};
		668	};
		669	}
		670
		671	=item $handle->oobinline ($boolean)
		672
		673	Enables or disables the C<oobinline> setting (see constructor argument of
		674	the same name for details).
		675
		676	=cut
		677
		678	sub oobinline {
		679	$_[0]{oobinline} = $_[1];
		680
		681	eval {
		682	local $SIG{__DIE__};
		683	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_OOBINLINE (), int $_[1]
		684	if $_[0]{fh};
		685	};
		686	}
		687
		688	=item $handle->keepalive ($boolean)
		689
		690	Enables or disables the C<keepalive> setting (see constructor argument of
		691	the same name for details).
		692
		693	=cut
		694
		695	sub keepalive {
		696	$_[0]{keepalive} = $_[1];
		697
		698	eval {
		699	local $SIG{__DIE__};
		700	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
		701	if $_[0]{fh};
		702	};
		703	}
		704
		705	=item $handle->on_starttls ($cb)
		706
		707	Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument).
		708
		709	=cut
		710
		711	sub on_starttls {
		712	$_[0]{on_starttls} = $_[1];
		713	}
		714
		715	=item $handle->on_stoptls ($cb)
		716
		717	Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).
		718
		719	=cut
		720
		721	sub on_stoptls {
		722	$_[0]{on_stoptls} = $_[1];
		723	}
		724
		725	=item $handle->rbuf_max ($max_octets)
		726
		727	Configures the C<rbuf_max> setting (C<undef> disables it).
		728
		729	=cut
		730
		731	sub rbuf_max {
		732	$_[0]{rbuf_max} = $_[1];
		733	}
		734
410	#############################################################################	735	#############################################################################
411		736
412	=item $handle->timeout ($seconds)	737	=item $handle->timeout ($seconds)
413		738
		739	=item $handle->rtimeout ($seconds)
		740
		741	=item $handle->wtimeout ($seconds)
		742
414	Configures (or disables) the inactivity timeout.	743	Configures (or disables) the inactivity timeout.
415		744
416	=cut	745	=item $handle->timeout_reset
417		746
418	sub timeout {	747	=item $handle->rtimeout_reset
		748
		749	=item $handle->wtimeout_reset
		750
		751	Reset the activity timeout, as if data was received or sent.
		752
		753	These methods are cheap to call.
		754
		755	=cut
		756
		757	for my $dir ("", "r", "w") {
		758	my $timeout = "${dir}timeout";
		759	my $tw = "_${dir}tw";
		760	my $on_timeout = "on_${dir}timeout";
		761	my $activity = "_${dir}activity";
		762	my $cb;
		763
		764	*$on_timeout = sub {
		765	$_[0]{$on_timeout} = $_[1];
		766	};
		767
		768	*$timeout = sub {
419	my ($self, $timeout) = @_;	769	my ($self, $new_value) = @_;
420		770
421	$self->{timeout} = $timeout;	771	$self->{$timeout} = $new_value;
422	$self->_timeout;	772	delete $self->{$tw}; &$cb;
423	}	773	};
424		774
		775	*{"${dir}timeout_reset"} = sub {
		776	$_[0]{$activity} = AE::now;
		777	};
		778
		779	# main workhorse:
425	# reset the timeout watcher, as neccessary	780	# reset the timeout watcher, as neccessary
426	# also check for time-outs	781	# also check for time-outs
427	sub _timeout {	782	$cb = sub {
428	my ($self) = @_;	783	my ($self) = @_;
429		784
430	if ($self->{timeout}) {	785	if ($self->{$timeout} && $self->{fh}) {
431	my $NOW = AnyEvent->now;	786	my $NOW = AE::now;
432		787
433	# when would the timeout trigger?	788	# when would the timeout trigger?
434	my $after = $self->{_activity} + $self->{timeout} - $NOW;	789	my $after = $self->{$activity} + $self->{$timeout} - $NOW;
435		790
436	# now or in the past already?	791	# now or in the past already?
437	if ($after <= 0) {	792	if ($after <= 0) {
438	$self->{_activity} = $NOW;	793	$self->{$activity} = $NOW;
439		794
440	if ($self->{on_timeout}) {	795	if ($self->{$on_timeout}) {
441	$self->{on_timeout}($self);	796	$self->{$on_timeout}($self);
442	} else {	797	} else {
443	$self->_error (&Errno::ETIMEDOUT);	798	$self->_error (Errno::ETIMEDOUT);
		799	}
		800
		801	# callback could have changed timeout value, optimise
		802	return unless $self->{$timeout};
		803
		804	# calculate new after
		805	$after = $self->{$timeout};
444	}	806	}
445		807
446	# callback could have changed timeout value, optimise	808	Scalar::Util::weaken $self;
447	return unless $self->{timeout};	809	return unless $self; # ->error could have destroyed $self
448		810
449	# calculate new after	811	$self->{$tw} ||= AE::timer $after, 0, sub {
450	$after = $self->{timeout};	812	delete $self->{$tw};
		813	$cb->($self);
		814	};
		815	} else {
		816	delete $self->{$tw};
451	}	817	}
452
453	Scalar::Util::weaken $self;
454	return unless $self; # ->error could have destroyed $self
455
456	$self->{_tw} ||= AnyEvent->timer (after => $after, cb => sub {
457	delete $self->{_tw};
458	$self->_timeout;
459	});
460	} else {
461	delete $self->{_tw};
462	}	818	}
463	}	819	}
464		820
465	#############################################################################	821	#############################################################################
466		822
…		…
481		837
482	=item $handle->on_drain ($cb)	838	=item $handle->on_drain ($cb)
483		839
484	Sets the C<on_drain> callback or clears it (see the description of	840	Sets the C<on_drain> callback or clears it (see the description of
485	C<on_drain> in the constructor).	841	C<on_drain> in the constructor).
		842
		843	This method may invoke callbacks (and therefore the handle might be
		844	destroyed after it returns).
486		845
487	=cut	846	=cut
488		847
489	sub on_drain {	848	sub on_drain {
490	my ($self, $cb) = @_;	849	my ($self, $cb) = @_;
…		…
499		858
500	Queues the given scalar to be written. You can push as much data as you	859	Queues the given scalar to be written. You can push as much data as you
501	want (only limited by the available memory), as C<AnyEvent::Handle>	860	want (only limited by the available memory), as C<AnyEvent::Handle>
502	buffers it independently of the kernel.	861	buffers it independently of the kernel.
503		862
		863	This method may invoke callbacks (and therefore the handle might be
		864	destroyed after it returns).
		865
504	=cut	866	=cut
505		867
506	sub _drain_wbuf {	868	sub _drain_wbuf {
507	my ($self) = @_;	869	my ($self) = @_;
508		870
…		…
511	Scalar::Util::weaken $self;	873	Scalar::Util::weaken $self;
512		874
513	my $cb = sub {	875	my $cb = sub {
514	my $len = syswrite $self->{fh}, $self->{wbuf};	876	my $len = syswrite $self->{fh}, $self->{wbuf};
515		877
516	if ($len >= 0) {	878	if (defined $len) {
517	substr $self->{wbuf}, 0, $len, "";	879	substr $self->{wbuf}, 0, $len, "";
518		880
519	$self->{_activity} = AnyEvent->now;	881	$self->{_activity} = $self->{_wactivity} = AE::now;
520		882
521	$self->{on_drain}($self)	883	$self->{on_drain}($self)
522	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})	884	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
523	&& $self->{on_drain};	885	&& $self->{on_drain};
524		886
…		…
530		892
531	# try to write data immediately	893	# try to write data immediately
532	$cb->() unless $self->{autocork};	894	$cb->() unless $self->{autocork};
533		895
534	# if still data left in wbuf, we need to poll	896	# if still data left in wbuf, we need to poll
535	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	897	$self->{_ww} = AE::io $self->{fh}, 1, $cb
536	if length $self->{wbuf};	898	if length $self->{wbuf};
537	};	899	};
538	}	900	}
539		901
540	our %WH;	902	our %WH;
541		903
		904	# deprecated
542	sub register_write_type($$) {	905	sub register_write_type($$) {
543	$WH{$_[0]} = $_[1];	906	$WH{$_[0]} = $_[1];
544	}	907	}
545		908
546	sub push_write {	909	sub push_write {
547	my $self = shift;	910	my $self = shift;
548		911
549	if (@_ > 1) {	912	if (@_ > 1) {
550	my $type = shift;	913	my $type = shift;
551		914
		915	@_ = ($WH{$type} ||= _load_func "$type\::anyevent_write_type"
552	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	916	or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_write")
553	->($self, @_);	917	->($self, @_);
554	}	918	}
555		919
		920	# we downgrade here to avoid hard-to-track-down bugs,
		921	# and diagnose the problem earlier and better.
		922
556	if ($self->{tls}) {	923	if ($self->{tls}) {
557	$self->{_tls_wbuf} .= $_[0];	924	utf8::downgrade $self->{_tls_wbuf} .= $_[0];
558		925	&_dotls ($self) if $self->{fh};
559	&_dotls ($self);
560	} else {	926	} else {
561	$self->{wbuf} .= $_[0];	927	utf8::downgrade $self->{wbuf} .= $_[0];
562	$self->_drain_wbuf;	928	$self->_drain_wbuf if $self->{fh};
563	}	929	}
564	}	930	}
565		931
566	=item $handle->push_write (type => @args)	932	=item $handle->push_write (type => @args)
567		933
568	Instead of formatting your data yourself, you can also let this module do	934	Instead of formatting your data yourself, you can also let this module
569	the job by specifying a type and type-specific arguments.	935	do the job by specifying a type and type-specific arguments. You
		936	can also specify the (fully qualified) name of a package, in which
		937	case AnyEvent tries to load the package and then expects to find the
		938	C<anyevent_read_type> function inside (see "custom write types", below).
570		939
571	Predefined types are (if you have ideas for additional types, feel free to	940	Predefined types are (if you have ideas for additional types, feel free to
572	drop by and tell us):	941	drop by and tell us):
573		942
574	=over 4	943	=over 4
…		…
631	Other languages could read single lines terminated by a newline and pass	1000	Other languages could read single lines terminated by a newline and pass
632	this line into their JSON decoder of choice.	1001	this line into their JSON decoder of choice.
633		1002
634	=cut	1003	=cut
635		1004
		1005	sub json_coder() {
		1006	eval { require JSON::XS; JSON::XS->new->utf8 }
		1007	|| do { require JSON; JSON->new->utf8 }
		1008	}
		1009
636	register_write_type json => sub {	1010	register_write_type json => sub {
637	my ($self, $ref) = @_;	1011	my ($self, $ref) = @_;
638		1012
639	require JSON;	1013	my $json = $self->{json} ||= json_coder;
640		1014
641	$self->{json} ? $self->{json}->encode ($ref)	1015	$json->encode ($ref)
642	: JSON::encode_json ($ref)
643	};	1016	};
644		1017
645	=item storable => $reference	1018	=item storable => $reference
646		1019
647	Freezes the given reference using L<Storable> and writes it to the	1020	Freezes the given reference using L<Storable> and writes it to the
…		…
657	pack "w/a*", Storable::nfreeze ($ref)	1030	pack "w/a*", Storable::nfreeze ($ref)
658	};	1031	};
659		1032
660	=back	1033	=back
661		1034
662	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	1035	=item $handle->push_shutdown
663		1036
664	This function (not method) lets you add your own types to C<push_write>.	1037	Sometimes you know you want to close the socket after writing your data
		1038	before it was actually written. One way to do that is to replace your
		1039	C<on_drain> handler by a callback that shuts down the socket (and set
		1040	C<low_water_mark> to C<0>). This method is a shorthand for just that, and
		1041	replaces the C<on_drain> callback with:
		1042
		1043	sub { shutdown $_[0]{fh}, 1 } # for push_shutdown
		1044
		1045	This simply shuts down the write side and signals an EOF condition to the
		1046	the peer.
		1047
		1048	You can rely on the normal read queue and C<on_eof> handling
		1049	afterwards. This is the cleanest way to close a connection.
		1050
		1051	This method may invoke callbacks (and therefore the handle might be
		1052	destroyed after it returns).
		1053
		1054	=cut
		1055
		1056	sub push_shutdown {
		1057	my ($self) = @_;
		1058
		1059	delete $self->{low_water_mark};
		1060	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });
		1061	}
		1062
		1063	=item custom write types - Package::anyevent_write_type $handle, @args
		1064
		1065	Instead of one of the predefined types, you can also specify the name of
		1066	a package. AnyEvent will try to load the package and then expects to find
		1067	a function named C<anyevent_write_type> inside. If it isn't found, it
		1068	progressively tries to load the parent package until it either finds the
		1069	function (good) or runs out of packages (bad).
		1070
665	Whenever the given C<type> is used, C<push_write> will invoke the code	1071	Whenever the given C<type> is used, C<push_write> will the function with
666	reference with the handle object and the remaining arguments.	1072	the handle object and the remaining arguments.
667		1073
668	The code reference is supposed to return a single octet string that will	1074	The function is supposed to return a single octet string that will be
669	be appended to the write buffer.	1075	appended to the write buffer, so you cna mentally treat this function as a
		1076	"arguments to on-the-wire-format" converter.
670		1077
671	Note that this is a function, and all types registered this way will be	1078	Example: implement a custom write type C<join> that joins the remaining
672	global, so try to use unique names.	1079	arguments using the first one.
		1080
		1081	$handle->push_write (My::Type => " ", 1,2,3);
		1082
		1083	# uses the following package, which can be defined in the "My::Type" or in
		1084	# the "My" modules to be auto-loaded, or just about anywhere when the
		1085	# My::Type::anyevent_write_type is defined before invoking it.
		1086
		1087	package My::Type;
		1088
		1089	sub anyevent_write_type {
		1090	my ($handle, $delim, @args) = @_;
		1091
		1092	join $delim, @args
		1093	}
673		1094
674	=cut	1095	=cut
675		1096
676	#############################################################################	1097	#############################################################################
677		1098
…		…
759	=cut	1180	=cut
760		1181
761	sub _drain_rbuf {	1182	sub _drain_rbuf {
762	my ($self) = @_;	1183	my ($self) = @_;
763		1184
		1185	# avoid recursion
		1186	return if $self->{_skip_drain_rbuf};
764	local $self->{_in_drain} = 1;	1187	local $self->{_skip_drain_rbuf} = 1;
765
766	if (
767	defined $self->{rbuf_max}
768	&& $self->{rbuf_max} < length $self->{rbuf}
769	) {
770	$self->_error (&Errno::ENOSPC, 1), return;
771	}
772		1188
773	while () {	1189	while () {
774	# we need to use a separate tls read buffer, as we must not receive data while	1190	# we need to use a separate tls read buffer, as we must not receive data while
775	# we are draining the buffer, and this can only happen with TLS.	1191	# we are draining the buffer, and this can only happen with TLS.
776	$self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf};	1192	$self->{rbuf} .= delete $self->{_tls_rbuf}
		1193	if exists $self->{_tls_rbuf};
777		1194
778	my $len = length $self->{rbuf};	1195	my $len = length $self->{rbuf};
779		1196
780	if (my $cb = shift @{ $self->{_queue} }) {	1197	if (my $cb = shift @{ $self->{_queue} }) {
781	unless ($cb->($self)) {	1198	unless ($cb->($self)) {
782	if ($self->{_eof}) {	1199	# no progress can be made
783	# no progress can be made (not enough data and no data forthcoming)	1200	# (not enough data and no data forthcoming)
784	$self->_error (&Errno::EPIPE, 1), return;	1201	$self->_error (Errno::EPIPE, 1), return
785	}	1202	if $self->{_eof};
786		1203
787	unshift @{ $self->{_queue} }, $cb;	1204	unshift @{ $self->{_queue} }, $cb;
788	last;	1205	last;
789	}	1206	}
790	} elsif ($self->{on_read}) {	1207	} elsif ($self->{on_read}) {
…		…
797	&& !@{ $self->{_queue} } # and the queue is still empty	1214	&& !@{ $self->{_queue} } # and the queue is still empty
798	&& $self->{on_read} # but we still have on_read	1215	&& $self->{on_read} # but we still have on_read
799	) {	1216	) {
800	# no further data will arrive	1217	# no further data will arrive
801	# so no progress can be made	1218	# so no progress can be made
802	$self->_error (&Errno::EPIPE, 1), return	1219	$self->_error (Errno::EPIPE, 1), return
803	if $self->{_eof};	1220	if $self->{_eof};
804		1221
805	last; # more data might arrive	1222	last; # more data might arrive
806	}	1223	}
807	} else {	1224	} else {
…		…
810	last;	1227	last;
811	}	1228	}
812	}	1229	}
813		1230
814	if ($self->{_eof}) {	1231	if ($self->{_eof}) {
815	if ($self->{on_eof}) {	1232	$self->{on_eof}
816	$self->{on_eof}($self)	1233	? $self->{on_eof}($self)
817	} else {	1234	: $self->_error (0, 1, "Unexpected end-of-file");
818	$self->_error (0, 1);	1235
819	}	1236	return;
		1237	}
		1238
		1239	if (
		1240	defined $self->{rbuf_max}
		1241	&& $self->{rbuf_max} < length $self->{rbuf}
		1242	) {
		1243	$self->_error (Errno::ENOSPC, 1), return;
820	}	1244	}
821		1245
822	# may need to restart read watcher	1246	# may need to restart read watcher
823	unless ($self->{_rw}) {	1247	unless ($self->{_rw}) {
824	$self->start_read	1248	$self->start_read
…		…
830		1254
831	This replaces the currently set C<on_read> callback, or clears it (when	1255	This replaces the currently set C<on_read> callback, or clears it (when
832	the new callback is C<undef>). See the description of C<on_read> in the	1256	the new callback is C<undef>). See the description of C<on_read> in the
833	constructor.	1257	constructor.
834		1258
		1259	This method may invoke callbacks (and therefore the handle might be
		1260	destroyed after it returns).
		1261
835	=cut	1262	=cut
836		1263
837	sub on_read {	1264	sub on_read {
838	my ($self, $cb) = @_;	1265	my ($self, $cb) = @_;
839		1266
840	$self->{on_read} = $cb;	1267	$self->{on_read} = $cb;
841	$self->_drain_rbuf if $cb && !$self->{_in_drain};	1268	$self->_drain_rbuf if $cb;
842	}	1269	}
843		1270
844	=item $handle->rbuf	1271	=item $handle->rbuf
845		1272
846	Returns the read buffer (as a modifiable lvalue).	1273	Returns the read buffer (as a modifiable lvalue).
…		…
878		1305
879	If enough data was available, then the callback must remove all data it is	1306	If enough data was available, then the callback must remove all data it is
880	interested in (which can be none at all) and return a true value. After returning	1307	interested in (which can be none at all) and return a true value. After returning
881	true, it will be removed from the queue.	1308	true, it will be removed from the queue.
882		1309
		1310	These methods may invoke callbacks (and therefore the handle might be
		1311	destroyed after it returns).
		1312
883	=cut	1313	=cut
884		1314
885	our %RH;	1315	our %RH;
886		1316
887	sub register_read_type($$) {	1317	sub register_read_type($$) {
…		…
893	my $cb = pop;	1323	my $cb = pop;
894		1324
895	if (@_) {	1325	if (@_) {
896	my $type = shift;	1326	my $type = shift;
897		1327
		1328	$cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type"
898	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	1329	or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_read")
899	->($self, $cb, @_);	1330	->($self, $cb, @_);
900	}	1331	}
901		1332
902	push @{ $self->{_queue} }, $cb;	1333	push @{ $self->{_queue} }, $cb;
903	$self->_drain_rbuf unless $self->{_in_drain};	1334	$self->_drain_rbuf;
904	}	1335	}
905		1336
906	sub unshift_read {	1337	sub unshift_read {
907	my $self = shift;	1338	my $self = shift;
908	my $cb = pop;	1339	my $cb = pop;
…		…
912		1343
913	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")	1344	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")
914	->($self, $cb, @_);	1345	->($self, $cb, @_);
915	}	1346	}
916		1347
917
918	unshift @{ $self->{_queue} }, $cb;	1348	unshift @{ $self->{_queue} }, $cb;
919	$self->_drain_rbuf unless $self->{_in_drain};	1349	$self->_drain_rbuf;
920	}	1350	}
921		1351
922	=item $handle->push_read (type => @args, $cb)	1352	=item $handle->push_read (type => @args, $cb)
923		1353
924	=item $handle->unshift_read (type => @args, $cb)	1354	=item $handle->unshift_read (type => @args, $cb)
925		1355
926	Instead of providing a callback that parses the data itself you can chose	1356	Instead of providing a callback that parses the data itself you can chose
927	between a number of predefined parsing formats, for chunks of data, lines	1357	between a number of predefined parsing formats, for chunks of data, lines
928	etc.	1358	etc. You can also specify the (fully qualified) name of a package, in
		1359	which case AnyEvent tries to load the package and then expects to find the
		1360	C<anyevent_read_type> function inside (see "custom read types", below).
929		1361
930	Predefined types are (if you have ideas for additional types, feel free to	1362	Predefined types are (if you have ideas for additional types, feel free to
931	drop by and tell us):	1363	drop by and tell us):
932		1364
933	=over 4	1365	=over 4
…		…
1057	return 1;	1489	return 1;
1058	}	1490	}
1059		1491
1060	# reject	1492	# reject
1061	if ($reject && $$rbuf =~ $reject) {	1493	if ($reject && $$rbuf =~ $reject) {
1062	$self->_error (&Errno::EBADMSG);	1494	$self->_error (Errno::EBADMSG);
1063	}	1495	}
1064		1496
1065	# skip	1497	# skip
1066	if ($skip && $$rbuf =~ $skip) {	1498	if ($skip && $$rbuf =~ $skip) {
1067	$data .= substr $$rbuf, 0, $+[0], "";	1499	$data .= substr $$rbuf, 0, $+[0], "";
…		…
1083	my ($self, $cb) = @_;	1515	my ($self, $cb) = @_;
1084		1516
1085	sub {	1517	sub {
1086	unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {	1518	unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {
1087	if ($_[0]{rbuf} =~ /[^0-9]/) {	1519	if ($_[0]{rbuf} =~ /[^0-9]/) {
1088	$self->_error (&Errno::EBADMSG);	1520	$self->_error (Errno::EBADMSG);
1089	}	1521	}
1090	return;	1522	return;
1091	}	1523	}
1092		1524
1093	my $len = $1;	1525	my $len = $1;
…		…
1096	my $string = $_[1];	1528	my $string = $_[1];
1097	$_[0]->unshift_read (chunk => 1, sub {	1529	$_[0]->unshift_read (chunk => 1, sub {
1098	if ($_[1] eq ",") {	1530	if ($_[1] eq ",") {
1099	$cb->($_[0], $string);	1531	$cb->($_[0], $string);
1100	} else {	1532	} else {
1101	$self->_error (&Errno::EBADMSG);	1533	$self->_error (Errno::EBADMSG);
1102	}	1534	}
1103	});	1535	});
1104	});	1536	});
1105		1537
1106	1	1538	1
…		…
1173	=cut	1605	=cut
1174		1606
1175	register_read_type json => sub {	1607	register_read_type json => sub {
1176	my ($self, $cb) = @_;	1608	my ($self, $cb) = @_;
1177		1609
1178	require JSON;	1610	my $json = $self->{json} ||= json_coder;
1179		1611
1180	my $data;	1612	my $data;
1181	my $rbuf = \$self->{rbuf};	1613	my $rbuf = \$self->{rbuf};
1182
1183	my $json = $self->{json} ||= JSON->new->utf8;
1184		1614
1185	sub {	1615	sub {
1186	my $ref = eval { $json->incr_parse ($self->{rbuf}) };	1616	my $ref = eval { $json->incr_parse ($self->{rbuf}) };
1187		1617
1188	if ($ref) {	1618	if ($ref) {
…		…
1196	$json->incr_skip;	1626	$json->incr_skip;
1197		1627
1198	$self->{rbuf} = $json->incr_text;	1628	$self->{rbuf} = $json->incr_text;
1199	$json->incr_text = "";	1629	$json->incr_text = "";
1200		1630
1201	$self->_error (&Errno::EBADMSG);	1631	$self->_error (Errno::EBADMSG);
1202		1632
1203	()	1633	()
1204	} else {	1634	} else {
1205	$self->{rbuf} = "";	1635	$self->{rbuf} = "";
1206		1636
…		…
1243	# read remaining chunk	1673	# read remaining chunk
1244	$_[0]->unshift_read (chunk => $len, sub {	1674	$_[0]->unshift_read (chunk => $len, sub {
1245	if (my $ref = eval { Storable::thaw ($_[1]) }) {	1675	if (my $ref = eval { Storable::thaw ($_[1]) }) {
1246	$cb->($_[0], $ref);	1676	$cb->($_[0], $ref);
1247	} else {	1677	} else {
1248	$self->_error (&Errno::EBADMSG);	1678	$self->_error (Errno::EBADMSG);
1249	}	1679	}
1250	});	1680	});
1251	}	1681	}
1252		1682
1253	1	1683	1
1254	}	1684	}
1255	};	1685	};
1256		1686
1257	=back	1687	=back
1258		1688
1259	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)	1689	=item custom read types - Package::anyevent_read_type $handle, $cb, @args
1260		1690
1261	This function (not method) lets you add your own types to C<push_read>.	1691	Instead of one of the predefined types, you can also specify the name
		1692	of a package. AnyEvent will try to load the package and then expects to
		1693	find a function named C<anyevent_read_type> inside. If it isn't found, it
		1694	progressively tries to load the parent package until it either finds the
		1695	function (good) or runs out of packages (bad).
1262		1696
1263	Whenever the given C<type> is used, C<push_read> will invoke the code	1697	Whenever this type is used, C<push_read> will invoke the function with the
1264	reference with the handle object, the callback and the remaining	1698	handle object, the original callback and the remaining arguments.
1265	arguments.
1266		1699
1267	The code reference is supposed to return a callback (usually a closure)	1700	The function is supposed to return a callback (usually a closure) that
1268	that works as a plain read callback (see C<< ->push_read ($cb) >>).	1701	works as a plain read callback (see C<< ->push_read ($cb) >>), so you can
		1702	mentally treat the function as a "configurable read type to read callback"
		1703	converter.
1269		1704
1270	It should invoke the passed callback when it is done reading (remember to	1705	It should invoke the original callback when it is done reading (remember
1271	pass C<$handle> as first argument as all other callbacks do that).	1706	to pass C<$handle> as first argument as all other callbacks do that,
		1707	although there is no strict requirement on this).
1272		1708
1273	Note that this is a function, and all types registered this way will be
1274	global, so try to use unique names.
1275
1276	For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>,	1709	For examples, see the source of this module (F<perldoc -m
1277	search for C<register_read_type>)).	1710	AnyEvent::Handle>, search for C<register_read_type>)).
1278		1711
1279	=item $handle->stop_read	1712	=item $handle->stop_read
1280		1713
1281	=item $handle->start_read	1714	=item $handle->start_read
1282		1715
…		…
1302	}	1735	}
1303		1736
1304	sub start_read {	1737	sub start_read {
1305	my ($self) = @_;	1738	my ($self) = @_;
1306		1739
1307	unless ($self->{_rw} || $self->{_eof}) {	1740	unless ($self->{_rw} || $self->{_eof} || !$self->{fh}) {
1308	Scalar::Util::weaken $self;	1741	Scalar::Util::weaken $self;
1309		1742
1310	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1743	$self->{_rw} = AE::io $self->{fh}, 0, sub {
1311	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});	1744	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1312	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf;	1745	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf;
1313		1746
1314	if ($len > 0) {	1747	if ($len > 0) {
1315	$self->{_activity} = AnyEvent->now;	1748	$self->{_activity} = $self->{_ractivity} = AE::now;
1316		1749
1317	if ($self->{tls}) {	1750	if ($self->{tls}) {
1318	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);	1751	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1319		1752
1320	&_dotls ($self);	1753	&_dotls ($self);
1321	} else {	1754	} else {
1322	$self->_drain_rbuf unless $self->{_in_drain};	1755	$self->_drain_rbuf;
1323	}	1756	}
1324		1757
1325	} elsif (defined $len) {	1758	} elsif (defined $len) {
1326	delete $self->{_rw};	1759	delete $self->{_rw};
1327	$self->{_eof} = 1;	1760	$self->{_eof} = 1;
1328	$self->_drain_rbuf unless $self->{_in_drain};	1761	$self->_drain_rbuf;
1329		1762
1330	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1763	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1331	return $self->_error ($!, 1);	1764	return $self->_error ($!, 1);
1332	}	1765	}
1333	});	1766	};
		1767	}
		1768	}
		1769
		1770	our $ERROR_SYSCALL;
		1771	our $ERROR_WANT_READ;
		1772
		1773	sub _tls_error {
		1774	my ($self, $err) = @_;
		1775
		1776	return $self->_error ($!, 1)
		1777	if $err == Net::SSLeay::ERROR_SYSCALL ();
		1778
		1779	my $err =Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());
		1780
		1781	# reduce error string to look less scary
		1782	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;
		1783
		1784	if ($self->{_on_starttls}) {
		1785	(delete $self->{_on_starttls})->($self, undef, $err);
		1786	&_freetls;
		1787	} else {
		1788	&_freetls;
		1789	$self->_error (Errno::EPROTO, 1, $err);
1334	}	1790	}
1335	}	1791	}
1336		1792
1337	# poll the write BIO and send the data if applicable	1793	# poll the write BIO and send the data if applicable
		1794	# also decode read data if possible
		1795	# this is basiclaly our TLS state machine
		1796	# more efficient implementations are possible with openssl,
		1797	# but not with the buggy and incomplete Net::SSLeay.
1338	sub _dotls {	1798	sub _dotls {
1339	my ($self) = @_;	1799	my ($self) = @_;
1340		1800
1341	my $tmp;	1801	my $tmp;
1342		1802
1343	if (length $self->{_tls_wbuf}) {	1803	if (length $self->{_tls_wbuf}) {
1344	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1804	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1345	substr $self->{_tls_wbuf}, 0, $tmp, "";	1805	substr $self->{_tls_wbuf}, 0, $tmp, "";
1346	}	1806	}
		1807
		1808	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);
		1809	return $self->_tls_error ($tmp)
		1810	if $tmp != $ERROR_WANT_READ
		1811	&& ($tmp != $ERROR_SYSCALL || $!);
1347	}	1812	}
1348		1813
1349	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {	1814	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
1350	unless (length $tmp) {	1815	unless (length $tmp) {
1351	# let's treat SSL-eof as we treat normal EOF	1816	$self->{_on_starttls}
1352	delete $self->{_rw};	1817	and (delete $self->{_on_starttls})->($self, undef, "EOF during handshake"); # ???
1353	$self->{_eof} = 1;
1354	&_freetls;	1818	&_freetls;
		1819
		1820	if ($self->{on_stoptls}) {
		1821	$self->{on_stoptls}($self);
		1822	return;
		1823	} else {
		1824	# let's treat SSL-eof as we treat normal EOF
		1825	delete $self->{_rw};
		1826	$self->{_eof} = 1;
		1827	}
1355	}	1828	}
1356		1829
1357	$self->{_tls_rbuf} .= $tmp;	1830	$self->{_tls_rbuf} .= $tmp;
1358	$self->_drain_rbuf unless $self->{_in_drain};	1831	$self->_drain_rbuf;
1359	$self->{tls} or return; # tls session might have gone away in callback	1832	$self->{tls} or return; # tls session might have gone away in callback
1360	}	1833	}
1361		1834
1362	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);	1835	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1363
1364	if ($tmp != Net::SSLeay::ERROR_WANT_READ ()) {
1365	if ($tmp == Net::SSLeay::ERROR_SYSCALL ()) {
1366	return $self->_error ($!, 1);	1836	return $self->_tls_error ($tmp)
1367	} elsif ($tmp == Net::SSLeay::ERROR_SSL ()) {	1837	if $tmp != $ERROR_WANT_READ
1368	return $self->_error (&Errno::EIO, 1);	1838	&& ($tmp != $ERROR_SYSCALL || $!);
1369	}
1370
1371	# all other errors are fine for our purposes
1372	}
1373		1839
1374	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1840	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1375	$self->{wbuf} .= $tmp;	1841	$self->{wbuf} .= $tmp;
1376	$self->_drain_wbuf;	1842	$self->_drain_wbuf;
		1843	$self->{tls} or return; # tls session might have gone away in callback
1377	}	1844	}
		1845
		1846	$self->{_on_starttls}
		1847	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
		1848	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");
1378	}	1849	}
1379		1850
1380	=item $handle->starttls ($tls[, $tls_ctx])	1851	=item $handle->starttls ($tls[, $tls_ctx])
1381		1852
1382	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	1853	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
1383	object is created, you can also do that at a later time by calling	1854	object is created, you can also do that at a later time by calling
1384	C<starttls>.	1855	C<starttls>.
1385		1856
		1857	Starting TLS is currently an asynchronous operation - when you push some
		1858	write data and then call C<< ->starttls >> then TLS negotiation will start
		1859	immediately, after which the queued write data is then sent.
		1860
1386	The first argument is the same as the C<tls> constructor argument (either	1861	The first argument is the same as the C<tls> constructor argument (either
1387	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1862	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1388		1863
1389	The second argument is the optional C<Net::SSLeay::CTX> object that is	1864	The second argument is the optional C<AnyEvent::TLS> object that is used
1390	used when AnyEvent::Handle has to create its own TLS connection object.	1865	when AnyEvent::Handle has to create its own TLS connection object, or
		1866	a hash reference with C<< key => value >> pairs that will be used to
		1867	construct a new context.
1391		1868
1392	The TLS connection object will end up in C<< $handle->{tls} >> after this	1869	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS
1393	call and can be used or changed to your liking. Note that the handshake	1870	context in C<< $handle->{tls_ctx} >> after this call and can be used or
1394	might have already started when this function returns.	1871	changed to your liking. Note that the handshake might have already started
		1872	when this function returns.
1395		1873
1396	If it an error to start a TLS handshake more than once per	1874	Due to bugs in OpenSSL, it might or might not be possible to do multiple
1397	AnyEvent::Handle object (this is due to bugs in OpenSSL).	1875	handshakes on the same stream. Best do not attempt to use the stream after
		1876	stopping TLS.
1398		1877
		1878	This method may invoke callbacks (and therefore the handle might be
		1879	destroyed after it returns).
		1880
1399	=cut	1881	=cut
		1882
		1883	our %TLS_CACHE; #TODO not yet documented, should we?
1400		1884
1401	sub starttls {	1885	sub starttls {
1402	my ($self, $ssl, $ctx) = @_;	1886	my ($self, $tls, $ctx) = @_;
		1887
		1888	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"
		1889	if $self->{tls};
		1890
		1891	$self->{tls} = $tls;
		1892	$self->{tls_ctx} = $ctx if @_ > 2;
		1893
		1894	return unless $self->{fh};
1403		1895
1404	require Net::SSLeay;	1896	require Net::SSLeay;
1405		1897
1406	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"	1898	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1407	if $self->{tls};	1899	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
		1900
		1901	$tls = delete $self->{tls};
		1902	$ctx = $self->{tls_ctx};
		1903
		1904	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
		1905
		1906	if ("HASH" eq ref $ctx) {
		1907	require AnyEvent::TLS;
		1908
		1909	if ($ctx->{cache}) {
		1910	my $key = $ctx+0;
		1911	$ctx = $TLS_CACHE{$key} ||= new AnyEvent::TLS %$ctx;
		1912	} else {
		1913	$ctx = new AnyEvent::TLS %$ctx;
		1914	}
		1915	}
1408		1916
1409	if ($ssl eq "accept") {	1917	$self->{tls_ctx} = $ctx || TLS_CTX ();
1410	$ssl = Net::SSLeay::new ($ctx || TLS_CTX ());	1918	$self->{tls} = $tls = $self->{tls_ctx}->_get_session ($tls, $self, $self->{peername});
1411	Net::SSLeay::set_accept_state ($ssl);
1412	} elsif ($ssl eq "connect") {
1413	$ssl = Net::SSLeay::new ($ctx || TLS_CTX ());
1414	Net::SSLeay::set_connect_state ($ssl);
1415	}
1416
1417	$self->{tls} = $ssl;
1418		1919
1419	# basically, this is deep magic (because SSL_read should have the same issues)	1920	# basically, this is deep magic (because SSL_read should have the same issues)
1420	# but the openssl maintainers basically said: "trust us, it just works".	1921	# but the openssl maintainers basically said: "trust us, it just works".
1421	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1922	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1422	# and mismaintained ssleay-module doesn't even offer them).	1923	# and mismaintained ssleay-module doesn't even offer them).
…		…
1426	#	1927	#
1427	# note that we do not try to keep the length constant between writes as we are required to do.	1928	# note that we do not try to keep the length constant between writes as we are required to do.
1428	# we assume that most (but not all) of this insanity only applies to non-blocking cases,	1929	# we assume that most (but not all) of this insanity only applies to non-blocking cases,
1429	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to	1930	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
1430	# have identity issues in that area.	1931	# have identity issues in that area.
1431	Net::SSLeay::CTX_set_mode ($self->{tls},	1932	# Net::SSLeay::CTX_set_mode ($ssl,
1432	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)	1933	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)
1433	| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));	1934	# | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));
		1935	Net::SSLeay::CTX_set_mode ($tls, 1|2);
1434		1936
1435	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1937	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1436	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1938	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1437		1939
		1940	Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf});
		1941
1438	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1942	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
		1943
		1944	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
		1945	if $self->{on_starttls};
1439		1946
1440	&_dotls; # need to trigger the initial handshake	1947	&_dotls; # need to trigger the initial handshake
1441	$self->start_read; # make sure we actually do read	1948	$self->start_read; # make sure we actually do read
1442	}	1949	}
1443		1950
1444	=item $handle->stoptls	1951	=item $handle->stoptls
1445		1952
1446	Shuts down the SSL connection - this makes a proper EOF handshake by	1953	Shuts down the SSL connection - this makes a proper EOF handshake by
1447	sending a close notify to the other side, but since OpenSSL doesn't	1954	sending a close notify to the other side, but since OpenSSL doesn't
1448	support non-blocking shut downs, it is not possible to re-use the stream	1955	support non-blocking shut downs, it is not guaranteed that you can re-use
1449	afterwards.	1956	the stream afterwards.
		1957
		1958	This method may invoke callbacks (and therefore the handle might be
		1959	destroyed after it returns).
1450		1960
1451	=cut	1961	=cut
1452		1962
1453	sub stoptls {	1963	sub stoptls {
1454	my ($self) = @_;	1964	my ($self) = @_;
1455		1965
1456	if ($self->{tls}) {	1966	if ($self->{tls} && $self->{fh}) {
1457	Net::SSLeay::shutdown ($self->{tls});	1967	Net::SSLeay::shutdown ($self->{tls});
1458		1968
1459	&_dotls;	1969	&_dotls;
1460		1970
1461	# we don't give a shit. no, we do, but we can't. no...	1971	# # we don't give a shit. no, we do, but we can't. no...#d#
1462	# we, we... have to use openssl :/	1972	# # we, we... have to use openssl :/#d#
1463	&_freetls;	1973	# &_freetls;#d#
1464	}	1974	}
1465	}	1975	}
1466		1976
1467	sub _freetls {	1977	sub _freetls {
1468	my ($self) = @_;	1978	my ($self) = @_;
1469		1979
1470	return unless $self->{tls};	1980	return unless $self->{tls};
1471		1981
1472	Net::SSLeay::free (delete $self->{tls});	1982	$self->{tls_ctx}->_put_session (delete $self->{tls})
		1983	if $self->{tls} > 0;
1473		1984
1474	delete @$self{qw(_rbio _wbio _tls_wbuf)};	1985	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1475	}	1986	}
1476		1987
1477	sub DESTROY {	1988	sub DESTROY {
1478	my ($self) = @_;	1989	my ($self) = @_;
1479		1990
1480	&_freetls;	1991	&_freetls;
1481		1992
1482	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	1993	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1483		1994
1484	if ($linger && length $self->{wbuf}) {	1995	if ($linger && length $self->{wbuf} && $self->{fh}) {
1485	my $fh = delete $self->{fh};	1996	my $fh = delete $self->{fh};
1486	my $wbuf = delete $self->{wbuf};	1997	my $wbuf = delete $self->{wbuf};
1487		1998
1488	my @linger;	1999	my @linger;
1489		2000
1490	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {	2001	push @linger, AE::io $fh, 1, sub {
1491	my $len = syswrite $fh, $wbuf, length $wbuf;	2002	my $len = syswrite $fh, $wbuf, length $wbuf;
1492		2003
1493	if ($len > 0) {	2004	if ($len > 0) {
1494	substr $wbuf, 0, $len, "";	2005	substr $wbuf, 0, $len, "";
1495	} else {	2006	} else {
1496	@linger = (); # end	2007	@linger = (); # end
1497	}	2008	}
1498	});	2009	};
1499	push @linger, AnyEvent->timer (after => $linger, cb => sub {	2010	push @linger, AE::timer $linger, 0, sub {
1500	@linger = ();	2011	@linger = ();
1501	});	2012	};
1502	}	2013	}
1503	}	2014	}
1504		2015
1505	=item $handle->destroy	2016	=item $handle->destroy
1506		2017
1507	Shuts down the handle object as much as possible - this call ensures that	2018	Shuts down the handle object as much as possible - this call ensures that
1508	no further callbacks will be invoked and resources will be freed as much	2019	no further callbacks will be invoked and as many resources as possible
1509	as possible. You must not call any methods on the object afterwards.	2020	will be freed. Any method you will call on the handle object after
		2021	destroying it in this way will be silently ignored (and it will return the
		2022	empty list).
1510		2023
1511	Normally, you can just "forget" any references to an AnyEvent::Handle	2024	Normally, you can just "forget" any references to an AnyEvent::Handle
1512	object and it will simply shut down. This works in fatal error and EOF	2025	object and it will simply shut down. This works in fatal error and EOF
1513	callbacks, as well as code outside. It does I<NOT> work in a read or write	2026	callbacks, as well as code outside. It does I<NOT> work in a read or write
1514	callback, so when you want to destroy the AnyEvent::Handle object from	2027	callback, so when you want to destroy the AnyEvent::Handle object from
1515	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in	2028	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
1516	that case.	2029	that case.
1517		2030
		2031	Destroying the handle object in this way has the advantage that callbacks
		2032	will be removed as well, so if those are the only reference holders (as
		2033	is common), then one doesn't need to do anything special to break any
		2034	reference cycles.
		2035
1518	The handle might still linger in the background and write out remaining	2036	The handle might still linger in the background and write out remaining
1519	data, as specified by the C<linger> option, however.	2037	data, as specified by the C<linger> option, however.
1520		2038
1521	=cut	2039	=cut
1522		2040
1523	sub destroy {	2041	sub destroy {
1524	my ($self) = @_;	2042	my ($self) = @_;
1525		2043
1526	$self->DESTROY;	2044	$self->DESTROY;
1527	%$self = ();	2045	%$self = ();
		2046	bless $self, "AnyEvent::Handle::destroyed";
1528	}	2047	}
		2048
		2049	sub AnyEvent::Handle::destroyed::AUTOLOAD {
		2050	#nop
		2051	}
		2052
		2053	=item $handle->destroyed
		2054
		2055	Returns false as long as the handle hasn't been destroyed by a call to C<<
		2056	->destroy >>, true otherwise.
		2057
		2058	Can be useful to decide whether the handle is still valid after some
		2059	callback possibly destroyed the handle. For example, C<< ->push_write >>,
		2060	C<< ->starttls >> and other methods can call user callbacks, which in turn
		2061	can destroy the handle, so work can be avoided by checking sometimes:
		2062
		2063	$hdl->starttls ("accept");
		2064	return if $hdl->destroyed;
		2065	$hdl->push_write (...
		2066
		2067	Note that the call to C<push_write> will silently be ignored if the handle
		2068	has been destroyed, so often you can just ignore the possibility of the
		2069	handle being destroyed.
		2070
		2071	=cut
		2072
		2073	sub destroyed { 0 }
		2074	sub AnyEvent::Handle::destroyed::destroyed { 1 }
1529		2075
1530	=item AnyEvent::Handle::TLS_CTX	2076	=item AnyEvent::Handle::TLS_CTX
1531		2077
1532	This function creates and returns the Net::SSLeay::CTX object used by	2078	This function creates and returns the AnyEvent::TLS object used by default
1533	default for TLS mode.	2079	for TLS mode.
1534		2080
1535	The context is created like this:	2081	The context is created by calling L<AnyEvent::TLS> without any arguments.
1536
1537	Net::SSLeay::load_error_strings;
1538	Net::SSLeay::SSLeay_add_ssl_algorithms;
1539	Net::SSLeay::randomize;
1540
1541	my $CTX = Net::SSLeay::CTX_new;
1542
1543	Net::SSLeay::CTX_set_options $CTX, Net::SSLeay::OP_ALL
1544		2082
1545	=cut	2083	=cut
1546		2084
1547	our $TLS_CTX;	2085	our $TLS_CTX;
1548		2086
1549	sub TLS_CTX() {	2087	sub TLS_CTX() {
1550	$TLS_CTX || do {	2088	$TLS_CTX ||= do {
1551	require Net::SSLeay;	2089	require AnyEvent::TLS;
1552		2090
1553	Net::SSLeay::load_error_strings ();	2091	new AnyEvent::TLS
1554	Net::SSLeay::SSLeay_add_ssl_algorithms ();
1555	Net::SSLeay::randomize ();
1556
1557	$TLS_CTX = Net::SSLeay::CTX_new ();
1558
1559	Net::SSLeay::CTX_set_options ($TLS_CTX, Net::SSLeay::OP_ALL ());
1560
1561	$TLS_CTX
1562	}	2092	}
1563	}	2093	}
1564		2094
1565	=back	2095	=back
1566		2096
…		…
1605		2135
1606	$handle->on_read (sub { });	2136	$handle->on_read (sub { });
1607	$handle->on_eof (undef);	2137	$handle->on_eof (undef);
1608	$handle->on_error (sub {	2138	$handle->on_error (sub {
1609	my $data = delete $_[0]{rbuf};	2139	my $data = delete $_[0]{rbuf};
1610	undef $handle;
1611	});	2140	});
1612		2141
1613	The reason to use C<on_error> is that TCP connections, due to latencies	2142	The reason to use C<on_error> is that TCP connections, due to latencies
1614	and packets loss, might get closed quite violently with an error, when in	2143	and packets loss, might get closed quite violently with an error, when in
1615	fact, all data has been received.	2144	fact, all data has been received.
…		…
1631	$handle->on_drain (sub {	2160	$handle->on_drain (sub {
1632	warn "all data submitted to the kernel\n";	2161	warn "all data submitted to the kernel\n";
1633	undef $handle;	2162	undef $handle;
1634	});	2163	});
1635		2164
		2165	If you just want to queue some data and then signal EOF to the other side,
		2166	consider using C<< ->push_shutdown >> instead.
		2167
		2168	=item I want to contact a TLS/SSL server, I don't care about security.
		2169
		2170	If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS,
		2171	simply connect to it and then create the AnyEvent::Handle with the C<tls>
		2172	parameter:
		2173
		2174	tcp_connect $host, $port, sub {
		2175	my ($fh) = @_;
		2176
		2177	my $handle = new AnyEvent::Handle
		2178	fh => $fh,
		2179	tls => "connect",
		2180	on_error => sub { ... };
		2181
		2182	$handle->push_write (...);
		2183	};
		2184
		2185	=item I want to contact a TLS/SSL server, I do care about security.
		2186
		2187	Then you should additionally enable certificate verification, including
		2188	peername verification, if the protocol you use supports it (see
		2189	L<AnyEvent::TLS>, C<verify_peername>).
		2190
		2191	E.g. for HTTPS:
		2192
		2193	tcp_connect $host, $port, sub {
		2194	my ($fh) = @_;
		2195
		2196	my $handle = new AnyEvent::Handle
		2197	fh => $fh,
		2198	peername => $host,
		2199	tls => "connect",
		2200	tls_ctx => { verify => 1, verify_peername => "https" },
		2201	...
		2202
		2203	Note that you must specify the hostname you connected to (or whatever
		2204	"peername" the protocol needs) as the C<peername> argument, otherwise no
		2205	peername verification will be done.
		2206
		2207	The above will use the system-dependent default set of trusted CA
		2208	certificates. If you want to check against a specific CA, add the
		2209	C<ca_file> (or C<ca_cert>) arguments to C<tls_ctx>:
		2210
		2211	tls_ctx => {
		2212	verify => 1,
		2213	verify_peername => "https",
		2214	ca_file => "my-ca-cert.pem",
		2215	},
		2216
		2217	=item I want to create a TLS/SSL server, how do I do that?
		2218
		2219	Well, you first need to get a server certificate and key. You have
		2220	three options: a) ask a CA (buy one, use cacert.org etc.) b) create a
		2221	self-signed certificate (cheap. check the search engine of your choice,
		2222	there are many tutorials on the net) or c) make your own CA (tinyca2 is a
		2223	nice program for that purpose).
		2224
		2225	Then create a file with your private key (in PEM format, see
		2226	L<AnyEvent::TLS>), followed by the certificate (also in PEM format). The
		2227	file should then look like this:
		2228
		2229	-----BEGIN RSA PRIVATE KEY-----
		2230	...header data
		2231	... lots of base64'y-stuff
		2232	-----END RSA PRIVATE KEY-----
		2233
		2234	-----BEGIN CERTIFICATE-----
		2235	... lots of base64'y-stuff
		2236	-----END CERTIFICATE-----
		2237
		2238	The important bits are the "PRIVATE KEY" and "CERTIFICATE" parts. Then
		2239	specify this file as C<cert_file>:
		2240
		2241	tcp_server undef, $port, sub {
		2242	my ($fh) = @_;
		2243
		2244	my $handle = new AnyEvent::Handle
		2245	fh => $fh,
		2246	tls => "accept",
		2247	tls_ctx => { cert_file => "my-server-keycert.pem" },
		2248	...
		2249
		2250	When you have intermediate CA certificates that your clients might not
		2251	know about, just append them to the C<cert_file>.
		2252
1636	=back	2253	=back
1637		2254
1638		2255
1639	=head1 SUBCLASSING AnyEvent::Handle	2256	=head1 SUBCLASSING AnyEvent::Handle
1640		2257

Diff Legend

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