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

Diff Legend

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