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.52 by root, Mon Jun 2 09:10:38 2008 UTC vs.
Revision 1.238 by root, Tue Dec 10 15:54:51 2013 UTC

1	package AnyEvent::Handle;
2
3	no warnings;
4	use strict;
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.1;
20		4
21	=head1 SYNOPSIS	5	=head1 SYNOPSIS
22		6
23	use AnyEvent;	7	use AnyEvent;
24	use AnyEvent::Handle;	8	use AnyEvent::Handle;
25		9
26	my $cv = AnyEvent->condvar;	10	my $cv = AnyEvent->condvar;
27		11
28	my $handle =	12	my $hdl; $hdl = new AnyEvent::Handle
29	AnyEvent::Handle->new (
30	fh => \*STDIN,	13	fh => \*STDIN,
31	on_eof => sub {	14	on_error => sub {
32	$cv->broadcast;	15	my ($hdl, $fatal, $msg) = @_;
33	},	16	AE::log error => $msg;
		17	$hdl->destroy;
		18	$cv->send;
34	);	19	};
35		20
36	# send some request line	21	# send some request line
37	$handle->push_write ("getinfo\015\012");	22	$hdl->push_write ("getinfo\015\012");
38		23
39	# read the response line	24	# read the response line
40	$handle->push_read (line => sub {	25	$hdl->push_read (line => sub {
41	my ($handle, $line) = @_;	26	my ($hdl, $line) = @_;
42	warn "read line <$line>\n";	27	say "got line <$line>";
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 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, and other stream things).
52	on sockets see L<AnyEvent::Util>.
53		37
		38	The L<AnyEvent::Intro> tutorial contains some well-documented
		39	AnyEvent::Handle examples.
		40
54	In the following, when the documentation refers to of "bytes" then this	41	In the following, where the documentation refers to "bytes", it means
55	means characters. As sysread and syswrite are used for all I/O, their	42	characters. As sysread and syswrite are used for all I/O, their
56	treatment of characters applies to this module as well.	43	treatment of characters applies to this module as well.
		44
		45	At the very minimum, you should specify C<fh> or C<connect>, and the
		46	C<on_error> callback.
57		47
58	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
59	argument.	49	argument.
60		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
		80	sub MAX_READ_SIZE() { 131072 }
		81
61	=head1 METHODS	82	=head1 METHODS
62		83
63	=over 4	84	=over 4
64		85
65	=item B<new (%args)>	86	=item $handle = B<new> AnyEvent::Handle fh => $filehandle, key => value...
66		87
67	The constructor supports these arguments (all as key => value pairs).	88	The constructor supports these arguments (all as C<< key => value >> pairs).
68		89
69	=over 4	90	=over 4
70		91
71	=item fh => $filehandle [MANDATORY]	92	=item fh => $filehandle [C<fh> or C<connect> MANDATORY]
72		93
73	The filehandle this L<AnyEvent::Handle> object will operate on.	94	The filehandle this L<AnyEvent::Handle> object will operate on.
74
75	NOTE: The filehandle will be set to non-blocking (using	95	NOTE: The filehandle will be set to non-blocking mode (using
76	AnyEvent::Util::fh_nonblocking).	96	C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in
		97	that mode.
77		98
		99	=item connect => [$host, $service] [C<fh> or C<connect> MANDATORY]
		100
		101	Try to connect to the specified host and service (port), using
		102	C<AnyEvent::Socket::tcp_connect>. The C<$host> additionally becomes the
		103	default C<peername>.
		104
		105	You have to specify either this parameter, or C<fh>, above.
		106
		107	It is possible to push requests on the read and write queues, and modify
		108	properties of the stream, even while AnyEvent::Handle is connecting.
		109
		110	When this parameter is specified, then the C<on_prepare>,
		111	C<on_connect_error> and C<on_connect> callbacks will be called under the
		112	appropriate circumstances:
		113
		114	=over 4
		115
78	=item on_eof => $cb->($handle)	116	=item on_prepare => $cb->($handle)
79		117
80	Set the callback to be called when an end-of-file condition is detcted,	118	This (rarely used) callback is called before a new connection is
81	i.e. in the case of a socket, when the other side has closed the	119	attempted, but after the file handle has been created (you can access that
82	connection cleanly.	120	file handle via C<< $handle->{fh} >>). It could be used to prepare the
		121	file handle with parameters required for the actual connect (as opposed to
		122	settings that can be changed when the connection is already established).
83		123
84	While not mandatory, it is highly recommended to set an eof callback,	124	The return value of this callback should be the connect timeout value in
85	otherwise you might end up with a closed socket while you are still	125	seconds (or C<0>, or C<undef>, or the empty list, to indicate that the
86	waiting for data.	126	default timeout is to be used).
87		127
		128	=item on_connect => $cb->($handle, $host, $port, $retry->())
		129
		130	This callback is called when a connection has been successfully established.
		131
		132	The peer's numeric host and port (the socket peername) are passed as
		133	parameters, together with a retry callback. At the time it is called the
		134	read and write queues, EOF status, TLS status and similar properties of
		135	the handle will have been reset.
		136
		137	It is not allowed to use the read or write queues while the handle object
		138	is connecting.
		139
		140	If, for some reason, the handle is not acceptable, calling C<$retry> will
		141	continue with the next connection target (in case of multi-homed hosts or
		142	SRV records there can be multiple connection endpoints). The C<$retry>
		143	callback can be invoked after the connect callback returns, i.e. one can
		144	start a handshake and then decide to retry with the next host if the
		145	handshake fails.
		146
		147	In most cases, you should ignore the C<$retry> parameter.
		148
		149	=item on_connect_error => $cb->($handle, $message)
		150
		151	This callback is called when the connection could not be
		152	established. C<$!> will contain the relevant error code, and C<$message> a
		153	message describing it (usually the same as C<"$!">).
		154
		155	If this callback isn't specified, then C<on_error> will be called with a
		156	fatal error instead.
		157
		158	=back
		159
88	=item on_error => $cb->($handle, $fatal)	160	=item on_error => $cb->($handle, $fatal, $message)
89		161
90	This is the error callback, which is called when, well, some error	162	This is the error callback, which is called when, well, some error
91	occured, such as not being able to resolve the hostname, failure to	163	occured, such as not being able to resolve the hostname, failure to
92	connect or a read error.	164	connect, or a read error.
93		165
94	Some errors are fatal (which is indicated by C<$fatal> being true). On	166	Some errors are fatal (which is indicated by C<$fatal> being true). On
95	fatal errors the handle object will be shut down and will not be	167	fatal errors the handle object will be destroyed (by a call to C<< ->
		168	destroy >>) after invoking the error callback (which means you are free to
		169	examine the handle object). Examples of fatal errors are an EOF condition
		170	with active (but unsatisfiable) read watchers (C<EPIPE>) or I/O errors. In
		171	cases where the other side can close the connection at will, it is
		172	often easiest to not report C<EPIPE> errors in this callback.
		173
		174	AnyEvent::Handle tries to find an appropriate error code for you to check
		175	against, but in some cases (TLS errors), this does not work well.
		176
		177	If you report the error to the user, it is recommended to always output
		178	the C<$message> argument in human-readable error messages (you don't need
		179	to report C<"$!"> if you report C<$message>).
		180
		181	If you want to react programmatically to the error, then looking at C<$!>
		182	and comparing it against some of the documented C<Errno> values is usually
		183	better than looking at the C<$message>.
		184
96	usable. Non-fatal errors can be retried by simply returning, but it is	185	Non-fatal errors can be retried by returning, but it is recommended
97	recommended to simply ignore this parameter and instead abondon the handle	186	to simply ignore this parameter and instead abondon the handle object
98	object when this callback is invoked.	187	when this callback is invoked. Examples of non-fatal errors are timeouts
		188	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
99		189
100	On callback entrance, the value of C<$!> contains the operating system	190	On entry to the callback, the value of C<$!> contains the operating
101	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).	191	system error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
		192	C<EPROTO>).
102		193
103	While not mandatory, it is I<highly> recommended to set this callback, as	194	While not mandatory, it is I<highly> recommended to set this callback, as
104	you will not be notified of errors otherwise. The default simply calls	195	you will not be notified of errors otherwise. The default just calls
105	C<croak>.	196	C<croak>.
106		197
107	=item on_read => $cb->($handle)	198	=item on_read => $cb->($handle)
108		199
109	This sets the default read callback, which is called when data arrives	200	This sets the default read callback, which is called when data arrives
110	and no read request is in the queue.	201	and no read request is in the queue (unlike read queue callbacks, this
		202	callback will only be called when at least one octet of data is in the
		203	read buffer).
111		204
112	To access (and remove data from) the read buffer, use the C<< ->rbuf >>	205	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
113	method or access the C<$handle->{rbuf}> member directly.	206	method or access the C<< $handle->{rbuf} >> member directly. Note that you
		207	must not enlarge or modify the read buffer, you can only remove data at
		208	the beginning from it.
114		209
		210	You can also call C<< ->push_read (...) >> or any other function that
		211	modifies the read queue. Or do both. Or ...
		212
115	When an EOF condition is detected then AnyEvent::Handle will first try to	213	When an EOF condition is detected, AnyEvent::Handle will first try to
116	feed all the remaining data to the queued callbacks and C<on_read> before	214	feed all the remaining data to the queued callbacks and C<on_read> before
117	calling the C<on_eof> callback. If no progress can be made, then a fatal	215	calling the C<on_eof> callback. If no progress can be made, then a fatal
118	error will be raised (with C<$!> set to C<EPIPE>).	216	error will be raised (with C<$!> set to C<EPIPE>).
119		217
		218	Note that, unlike requests in the read queue, an C<on_read> callback
		219	doesn't mean you I<require> some data: if there is an EOF and there
		220	are outstanding read requests then an error will be flagged. With an
		221	C<on_read> callback, the C<on_eof> callback will be invoked.
		222
		223	=item on_eof => $cb->($handle)
		224
		225	Set the callback to be called when an end-of-file condition is detected,
		226	i.e. in the case of a socket, when the other side has closed the
		227	connection cleanly, and there are no outstanding read requests in the
		228	queue (if there are read requests, then an EOF counts as an unexpected
		229	connection close and will be flagged as an error).
		230
		231	For sockets, this just means that the other side has stopped sending data,
		232	you can still try to write data, and, in fact, one can return from the EOF
		233	callback and continue writing data, as only the read part has been shut
		234	down.
		235
		236	If an EOF condition has been detected but no C<on_eof> callback has been
		237	set, then a fatal error will be raised with C<$!> set to <0>.
		238
120	=item on_drain => $cb->($handle)	239	=item on_drain => $cb->($handle)
121		240
122	This sets the callback that is called when the write buffer becomes empty	241	This sets the callback that is called once when the write buffer becomes
123	(or when the callback is set and the buffer is empty already).	242	empty (and immediately when the handle object is created).
124		243
125	To append to the write buffer, use the C<< ->push_write >> method.	244	To append to the write buffer, use the C<< ->push_write >> method.
126		245
		246	This callback is useful when you don't want to put all of your write data
		247	into the queue at once, for example, when you want to write the contents
		248	of some file to the socket you might not want to read the whole file into
		249	memory and push it into the queue, but instead only read more data from
		250	the file when the write queue becomes empty.
		251
127	=item timeout => $fractional_seconds	252	=item timeout => $fractional_seconds
128		253
		254	=item rtimeout => $fractional_seconds
		255
		256	=item wtimeout => $fractional_seconds
		257
129	If non-zero, then this enables an "inactivity" timeout: whenever this many	258	If non-zero, then these enables an "inactivity" timeout: whenever this
130	seconds pass without a successful read or write on the underlying file	259	many seconds pass without a successful read or write on the underlying
131	handle, the C<on_timeout> callback will be invoked (and if that one is	260	file handle (or a call to C<timeout_reset>), the C<on_timeout> callback
132	missing, an C<ETIMEDOUT> error will be raised).	261	will be invoked (and if that one is missing, a non-fatal C<ETIMEDOUT>
		262	error will be raised).
133		263
		264	There are three variants of the timeouts that work independently of each
		265	other, for both read and write (triggered when nothing was read I<OR>
		266	written), just read (triggered when nothing was read), and just write:
		267	C<timeout>, C<rtimeout> and C<wtimeout>, with corresponding callbacks
		268	C<on_timeout>, C<on_rtimeout> and C<on_wtimeout>, and reset functions
		269	C<timeout_reset>, C<rtimeout_reset>, and C<wtimeout_reset>.
		270
134	Note that timeout processing is also active when you currently do not have	271	Note that timeout processing is active even when you do not have any
135	any outstanding read or write requests: If you plan to keep the connection	272	outstanding read or write requests: If you plan to keep the connection
136	idle then you should disable the timout temporarily or ignore the timeout	273	idle then you should disable the timeout temporarily or ignore the
137	in the C<on_timeout> callback.	274	timeout in the corresponding C<on_timeout> callback, in which case
		275	AnyEvent::Handle will simply restart the timeout.
138		276
139	Zero (the default) disables this timeout.	277	Zero (the default) disables the corresponding timeout.
140		278
141	=item on_timeout => $cb->($handle)	279	=item on_timeout => $cb->($handle)
		280
		281	=item on_rtimeout => $cb->($handle)
		282
		283	=item on_wtimeout => $cb->($handle)
142		284
143	Called whenever the inactivity timeout passes. If you return from this	285	Called whenever the inactivity timeout passes. If you return from this
144	callback, then the timeout will be reset as if some activity had happened,	286	callback, then the timeout will be reset as if some activity had happened,
145	so this condition is not fatal in any way.	287	so this condition is not fatal in any way.
146		288
147	=item rbuf_max => <bytes>	289	=item rbuf_max => <bytes>
148		290
149	If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)	291	If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)
150	when the read buffer ever (strictly) exceeds this size. This is useful to	292	when the read buffer ever (strictly) exceeds this size. This is useful to
151	avoid denial-of-service attacks.	293	avoid some forms of denial-of-service attacks.
152		294
153	For example, a server accepting connections from untrusted sources should	295	For example, a server accepting connections from untrusted sources should
154	be configured to accept only so-and-so much data that it cannot act on	296	be configured to accept only so-and-so much data that it cannot act on
155	(for example, when expecting a line, an attacker could send an unlimited	297	(for example, when expecting a line, an attacker could send an unlimited
156	amount of data without a callback ever being called as long as the line	298	amount of data without a callback ever being called as long as the line
157	isn't finished).	299	isn't finished).
158		300
		301	=item wbuf_max => <bytes>
		302
		303	If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)
		304	when the write buffer ever (strictly) exceeds this size. This is useful to
		305	avoid some forms of denial-of-service attacks.
		306
		307	Although the units of this parameter is bytes, this is the I<raw> number
		308	of bytes not yet accepted by the kernel. This can make a difference when
		309	you e.g. use TLS, as TLS typically makes your write data larger (but it
		310	can also make it smaller due to compression).
		311
		312	As an example of when this limit is useful, take a chat server that sends
		313	chat messages to a client. If the client does not read those in a timely
		314	manner then the send buffer in the server would grow unbounded.
		315
		316	=item autocork => <boolean>
		317
		318	When disabled (the default), C<push_write> will try to immediately
		319	write the data to the handle if possible. This avoids having to register
		320	a write watcher and wait for the next event loop iteration, but can
		321	be inefficient if you write multiple small chunks (on the wire, this
		322	disadvantage is usually avoided by your kernel's nagle algorithm, see
		323	C<no_delay>, but this option can save costly syscalls).
		324
		325	When enabled, writes will always be queued till the next event loop
		326	iteration. This is efficient when you do many small writes per iteration,
		327	but less efficient when you do a single write only per iteration (or when
		328	the write buffer often is full). It also increases write latency.
		329
		330	=item no_delay => <boolean>
		331
		332	When doing small writes on sockets, your operating system kernel might
		333	wait a bit for more data before actually sending it out. This is called
		334	the Nagle algorithm, and usually it is beneficial.
		335
		336	In some situations you want as low a delay as possible, which can be
		337	accomplishd by setting this option to a true value.
		338
		339	The default is your operating system's default behaviour (most likely
		340	enabled). This option explicitly enables or disables it, if possible.
		341
		342	=item keepalive => <boolean>
		343
		344	Enables (default disable) the SO_KEEPALIVE option on the stream socket:
		345	normally, TCP connections have no time-out once established, so TCP
		346	connections, once established, can stay alive forever even when the other
		347	side has long gone. TCP keepalives are a cheap way to take down long-lived
		348	TCP connections when the other side becomes unreachable. While the default
		349	is OS-dependent, TCP keepalives usually kick in after around two hours,
		350	and, if the other side doesn't reply, take down the TCP connection some 10
		351	to 15 minutes later.
		352
		353	It is harmless to specify this option for file handles that do not support
		354	keepalives, and enabling it on connections that are potentially long-lived
		355	is usually a good idea.
		356
		357	=item oobinline => <boolean>
		358
		359	BSD majorly fucked up the implementation of TCP urgent data. The result
		360	is that almost no OS implements TCP according to the specs, and every OS
		361	implements it slightly differently.
		362
		363	If you want to handle TCP urgent data, then setting this flag (the default
		364	is enabled) gives you the most portable way of getting urgent data, by
		365	putting it into the stream.
		366
		367	Since BSD emulation of OOB data on top of TCP's urgent data can have
		368	security implications, AnyEvent::Handle sets this flag automatically
		369	unless explicitly specified. Note that setting this flag after
		370	establishing a connection I<may> be a bit too late (data loss could
		371	already have occured on BSD systems), but at least it will protect you
		372	from most attacks.
		373
159	=item read_size => <bytes>	374	=item read_size => <bytes>
160		375
161	The default read block size (the amount of bytes this module will try to read	376	The initial read block size, the number of bytes this module will try
162	during each (loop iteration). Default: C<8192>.	377	to read during each loop iteration. Each handle object will consume
		378	at least this amount of memory for the read buffer as well, so when
		379	handling many connections watch out for memory requirements). See also
		380	C<max_read_size>. Default: C<2048>.
		381
		382	=item max_read_size => <bytes>
		383
		384	The maximum read buffer size used by the dynamic adjustment
		385	algorithm: Each time AnyEvent::Handle can read C<read_size> bytes in
		386	one go it will double C<read_size> up to the maximum given by this
		387	option. Default: C<131072> or C<read_size>, whichever is higher.
163		388
164	=item low_water_mark => <bytes>	389	=item low_water_mark => <bytes>
165		390
166	Sets the amount of bytes (default: C<0>) that make up an "empty" write	391	Sets the number of bytes (default: C<0>) that make up an "empty" write
167	buffer: If the write reaches this size or gets even samller it is	392	buffer: If the buffer reaches this size or gets even samller it is
168	considered empty.	393	considered empty.
169		394
		395	Sometimes it can be beneficial (for performance reasons) to add data to
		396	the write buffer before it is fully drained, but this is a rare case, as
		397	the operating system kernel usually buffers data as well, so the default
		398	is good in almost all cases.
		399
		400	=item linger => <seconds>
		401
		402	If this is non-zero (default: C<3600>), the destructor of the
		403	AnyEvent::Handle object will check whether there is still outstanding
		404	write data and will install a watcher that will write this data to the
		405	socket. No errors will be reported (this mostly matches how the operating
		406	system treats outstanding data at socket close time).
		407
		408	This will not work for partial TLS data that could not be encoded
		409	yet. This data will be lost. Calling the C<stoptls> method in time might
		410	help.
		411
		412	=item peername => $string
		413
		414	A string used to identify the remote site - usually the DNS hostname
		415	(I<not> IDN!) used to create the connection, rarely the IP address.
		416
		417	Apart from being useful in error messages, this string is also used in TLS
		418	peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This
		419	verification will be skipped when C<peername> is not specified or is
		420	C<undef>.
		421
170	=item tls => "accept" | "connect" | Net::SSLeay::SSL object	422	=item tls => "accept" | "connect" | Net::SSLeay::SSL object
171		423
172	When this parameter is given, it enables TLS (SSL) mode, that means it	424	When this parameter is given, it enables TLS (SSL) mode, that means
173	will start making tls handshake and will transparently encrypt/decrypt	425	AnyEvent will start a TLS handshake as soon as the connection has been
174	data.	426	established and will transparently encrypt/decrypt data afterwards.
		427
		428	All TLS protocol errors will be signalled as C<EPROTO>, with an
		429	appropriate error message.
175		430
176	TLS mode requires Net::SSLeay to be installed (it will be loaded	431	TLS mode requires Net::SSLeay to be installed (it will be loaded
177	automatically when you try to create a TLS handle).	432	automatically when you try to create a TLS handle): this module doesn't
		433	have a dependency on that module, so if your module requires it, you have
		434	to add the dependency yourself. If Net::SSLeay cannot be loaded or is too
		435	old, you get an C<EPROTO> error.
178		436
179	For the TLS server side, use C<accept>, and for the TLS client side of a	437	Unlike TCP, TLS has a server and client side: for the TLS server side, use
180	connection, use C<connect> mode.	438	C<accept>, and for the TLS client side of a connection, use C<connect>
		439	mode.
181		440
182	You can also provide your own TLS connection object, but you have	441	You can also provide your own TLS connection object, but you have
183	to make sure that you call either C<Net::SSLeay::set_connect_state>	442	to make sure that you call either C<Net::SSLeay::set_connect_state>
184	or C<Net::SSLeay::set_accept_state> on it before you pass it to	443	or C<Net::SSLeay::set_accept_state> on it before you pass it to
185	AnyEvent::Handle.	444	AnyEvent::Handle. Also, this module will take ownership of this connection
		445	object.
186		446
		447	At some future point, AnyEvent::Handle might switch to another TLS
		448	implementation, then the option to use your own session object will go
		449	away.
		450
		451	B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,
		452	passing in the wrong integer will lead to certain crash. This most often
		453	happens when one uses a stylish C<< tls => 1 >> and is surprised about the
		454	segmentation fault.
		455
187	See the C<starttls> method if you need to start TLs negotiation later.	456	Use the C<< ->starttls >> method if you need to start TLS negotiation later.
188		457
189	=item tls_ctx => $ssl_ctx	458	=item tls_ctx => $anyevent_tls
190		459
191	Use the given Net::SSLeay::CTX object to create the new TLS connection	460	Use the given C<AnyEvent::TLS> object to create the new TLS connection
192	(unless a connection object was specified directly). If this parameter is	461	(unless a connection object was specified directly). If this
193	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	462	parameter is missing (or C<undef>), then AnyEvent::Handle will use
		463	C<AnyEvent::Handle::TLS_CTX>.
194		464
		465	Instead of an object, you can also specify a hash reference with C<< key
		466	=> value >> pairs. Those will be passed to L<AnyEvent::TLS> to create a
		467	new TLS context object.
		468
		469	=item on_starttls => $cb->($handle, $success[, $error_message])
		470
		471	This callback will be invoked when the TLS/SSL handshake has finished. If
		472	C<$success> is true, then the TLS handshake succeeded, otherwise it failed
		473	(C<on_stoptls> will not be called in this case).
		474
		475	The session in C<< $handle->{tls} >> can still be examined in this
		476	callback, even when the handshake was not successful.
		477
		478	TLS handshake failures will not cause C<on_error> to be invoked when this
		479	callback is in effect, instead, the error message will be passed to C<on_starttls>.
		480
		481	Without this callback, handshake failures lead to C<on_error> being
		482	called as usual.
		483
		484	Note that you cannot just call C<starttls> again in this callback. If you
		485	need to do that, start an zero-second timer instead whose callback can
		486	then call C<< ->starttls >> again.
		487
		488	=item on_stoptls => $cb->($handle)
		489
		490	When a SSLv3/TLS shutdown/close notify/EOF is detected and this callback is
		491	set, then it will be invoked after freeing the TLS session. If it is not,
		492	then a TLS shutdown condition will be treated like a normal EOF condition
		493	on the handle.
		494
		495	The session in C<< $handle->{tls} >> can still be examined in this
		496	callback.
		497
		498	This callback will only be called on TLS shutdowns, not when the
		499	underlying handle signals EOF.
		500
195	=item json => JSON or JSON::XS object	501	=item json => L<JSON> or L<JSON::XS> object
196		502
197	This is the json coder object used by the C<json> read and write types.	503	This is the json coder object used by the C<json> read and write types.
198		504
199	If you don't supply it, then AnyEvent::Handle will create and use a	505	If you don't supply it, then AnyEvent::Handle will create and use a
200	suitable one, which will write and expect UTF-8 encoded JSON texts.	506	suitable one (on demand), which will write and expect UTF-8 encoded JSON
		507	texts.
201		508
202	Note that you are responsible to depend on the JSON module if you want to	509	Note that you are responsible to depend on the L<JSON> module if you want
203	use this functionality, as AnyEvent does not have a dependency itself.	510	to use this functionality, as AnyEvent does not have a dependency on it
		511	itself.
204		512
205	=item filter_r => $cb	513	=item cbor => L<CBOR::XS> object
206		514
207	=item filter_w => $cb	515	This is the cbor coder object used by the C<cbor> read and write types.
208		516
209	These exist, but are undocumented at this time.	517	If you don't supply it, then AnyEvent::Handle will create and use a
		518	suitable one (on demand), which will write CBOR without using extensions,
		519	if possible. texts.
		520
		521	Note that you are responsible to depend on the L<CBOR::XS> module if you
		522	want to use this functionality, as AnyEvent does not have a dependency on
		523	it itself.
210		524
211	=back	525	=back
212		526
213	=cut	527	=cut
214		528
215	sub new {	529	sub new {
216	my $class = shift;	530	my $class = shift;
217
218	my $self = bless { @_ }, $class;	531	my $self = bless { @_ }, $class;
219		532
220	$self->{fh} or Carp::croak "mandatory argument fh is missing";	533	if ($self->{fh}) {
		534	$self->_start;
		535	return unless $self->{fh}; # could be gone by now
		536
		537	} elsif ($self->{connect}) {
		538	require AnyEvent::Socket;
		539
		540	$self->{peername} = $self->{connect}[0]
		541	unless exists $self->{peername};
		542
		543	$self->{_skip_drain_rbuf} = 1;
		544
		545	{
		546	Scalar::Util::weaken (my $self = $self);
		547
		548	$self->{_connect} =
		549	AnyEvent::Socket::tcp_connect (
		550	$self->{connect}[0],
		551	$self->{connect}[1],
		552	sub {
		553	my ($fh, $host, $port, $retry) = @_;
		554
		555	delete $self->{_connect}; # no longer needed
		556
		557	if ($fh) {
		558	$self->{fh} = $fh;
		559
		560	delete $self->{_skip_drain_rbuf};
		561	$self->_start;
		562
		563	$self->{on_connect}
		564	and $self->{on_connect}($self, $host, $port, sub {
		565	delete @$self{qw(fh _tw _rtw _wtw _ww _rw _eof _queue rbuf _wbuf tls _tls_rbuf _tls_wbuf)};
		566	$self->{_skip_drain_rbuf} = 1;
		567	&$retry;
		568	});
		569
		570	} else {
		571	if ($self->{on_connect_error}) {
		572	$self->{on_connect_error}($self, "$!");
		573	$self->destroy if $self;
		574	} else {
		575	$self->_error ($!, 1);
		576	}
		577	}
		578	},
		579	sub {
		580	local $self->{fh} = $_[0];
		581
		582	$self->{on_prepare}
		583	? $self->{on_prepare}->($self)
		584	: ()
		585	}
		586	);
		587	}
		588
		589	} else {
		590	Carp::croak "AnyEvent::Handle: either an existing fh or the connect parameter must be specified";
		591	}
		592
		593	$self
		594	}
		595
		596	sub _start {
		597	my ($self) = @_;
		598
		599	# too many clueless people try to use udp and similar sockets
		600	# with AnyEvent::Handle, do them a favour.
		601	my $type = getsockopt $self->{fh}, Socket::SOL_SOCKET (), Socket::SO_TYPE ();
		602	Carp::croak "AnyEvent::Handle: only stream sockets supported, anything else will NOT work!"
		603	if Socket::SOCK_STREAM () != (unpack "I", $type) && defined $type;
221		604
222	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	605	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
223		606
224	if ($self->{tls}) {	607	$self->{_activity} =
225	require Net::SSLeay;	608	$self->{_ractivity} =
		609	$self->{_wactivity} = AE::now;
		610
		611	$self->{read_size} ||= 2048;
		612	$self->{max_read_size} = $self->{read_size}
		613	if $self->{read_size} > ($self->{max_read_size} || MAX_READ_SIZE);
		614
		615	$self->timeout (delete $self->{timeout} ) if $self->{timeout};
		616	$self->rtimeout (delete $self->{rtimeout} ) if $self->{rtimeout};
		617	$self->wtimeout (delete $self->{wtimeout} ) if $self->{wtimeout};
		618
		619	$self->no_delay (delete $self->{no_delay} ) if exists $self->{no_delay} && $self->{no_delay};
		620	$self->keepalive (delete $self->{keepalive}) if exists $self->{keepalive} && $self->{keepalive};
		621
		622	$self->oobinline (exists $self->{oobinline} ? delete $self->{oobinline} : 1);
		623
226	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});	624	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
227	}	625	if $self->{tls};
228		626
229	# $self->on_eof (delete $self->{on_eof} ) if $self->{on_eof}; # nop
230	# $self->on_error (delete $self->{on_error}) if $self->{on_error}; # nop
231	# $self->on_read (delete $self->{on_read} ) if $self->{on_read}; # nop
232	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	627	$self->on_drain (delete $self->{on_drain} ) if $self->{on_drain};
233		628
234	$self->{_activity} = AnyEvent->now;
235	$self->_timeout;
236
237	$self->start_read;	629	$self->start_read
		630	if $self->{on_read} || @{ $self->{_queue} };
238		631
239	$self	632	$self->_drain_wbuf;
240	}
241
242	sub _shutdown {
243	my ($self) = @_;
244
245	delete $self->{_tw};
246	delete $self->{_rw};
247	delete $self->{_ww};
248	delete $self->{fh};
249
250	$self->stoptls;
251	}	633	}
252		634
253	sub _error {	635	sub _error {
254	my ($self, $errno, $fatal) = @_;	636	my ($self, $errno, $fatal, $message) = @_;
255
256	$self->_shutdown
257	if $fatal;
258		637
259	$! = $errno;	638	$! = $errno;
		639	$message ||= "$!";
260		640
261	if ($self->{on_error}) {	641	if ($self->{on_error}) {
262	$self->{on_error}($self, $fatal);	642	$self->{on_error}($self, $fatal, $message);
263	} else {	643	$self->destroy if $fatal;
		644	} elsif ($self->{fh} || $self->{connect}) {
		645	$self->destroy;
264	Carp::croak "AnyEvent::Handle uncaught error: $!";	646	Carp::croak "AnyEvent::Handle uncaught error: $message";
265	}	647	}
266	}	648	}
267		649
268	=item $fh = $handle->fh	650	=item $fh = $handle->fh
269		651
270	This method returns the file handle of the L<AnyEvent::Handle> object.	652	This method returns the file handle used to create the L<AnyEvent::Handle> object.
271		653
272	=cut	654	=cut
273		655
274	sub fh { $_[0]{fh} }	656	sub fh { $_[0]{fh} }
275		657
…		…
293	$_[0]{on_eof} = $_[1];	675	$_[0]{on_eof} = $_[1];
294	}	676	}
295		677
296	=item $handle->on_timeout ($cb)	678	=item $handle->on_timeout ($cb)
297		679
298	Replace the current C<on_timeout> callback, or disables the callback	680	=item $handle->on_rtimeout ($cb)
299	(but not the timeout) if C<$cb> = C<undef>. See C<timeout> constructor
300	argument.
301		681
302	=cut	682	=item $handle->on_wtimeout ($cb)
303		683
		684	Replace the current C<on_timeout>, C<on_rtimeout> or C<on_wtimeout>
		685	callback, or disables the callback (but not the timeout) if C<$cb> =
		686	C<undef>. See the C<timeout> constructor argument and method.
		687
		688	=cut
		689
		690	# see below
		691
		692	=item $handle->autocork ($boolean)
		693
		694	Enables or disables the current autocork behaviour (see C<autocork>
		695	constructor argument). Changes will only take effect on the next write.
		696
		697	=cut
		698
		699	sub autocork {
		700	$_[0]{autocork} = $_[1];
		701	}
		702
		703	=item $handle->no_delay ($boolean)
		704
		705	Enables or disables the C<no_delay> setting (see constructor argument of
		706	the same name for details).
		707
		708	=cut
		709
		710	sub no_delay {
		711	$_[0]{no_delay} = $_[1];
		712
		713	setsockopt $_[0]{fh}, Socket::IPPROTO_TCP (), Socket::TCP_NODELAY (), int $_[1]
		714	if $_[0]{fh};
		715	}
		716
		717	=item $handle->keepalive ($boolean)
		718
		719	Enables or disables the C<keepalive> setting (see constructor argument of
		720	the same name for details).
		721
		722	=cut
		723
		724	sub keepalive {
		725	$_[0]{keepalive} = $_[1];
		726
		727	eval {
		728	local $SIG{__DIE__};
		729	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
		730	if $_[0]{fh};
		731	};
		732	}
		733
		734	=item $handle->oobinline ($boolean)
		735
		736	Enables or disables the C<oobinline> setting (see constructor argument of
		737	the same name for details).
		738
		739	=cut
		740
		741	sub oobinline {
		742	$_[0]{oobinline} = $_[1];
		743
		744	eval {
		745	local $SIG{__DIE__};
		746	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_OOBINLINE (), int $_[1]
		747	if $_[0]{fh};
		748	};
		749	}
		750
		751	=item $handle->keepalive ($boolean)
		752
		753	Enables or disables the C<keepalive> setting (see constructor argument of
		754	the same name for details).
		755
		756	=cut
		757
		758	sub keepalive {
		759	$_[0]{keepalive} = $_[1];
		760
		761	eval {
		762	local $SIG{__DIE__};
		763	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
		764	if $_[0]{fh};
		765	};
		766	}
		767
		768	=item $handle->on_starttls ($cb)
		769
		770	Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument).
		771
		772	=cut
		773
		774	sub on_starttls {
		775	$_[0]{on_starttls} = $_[1];
		776	}
		777
		778	=item $handle->on_stoptls ($cb)
		779
		780	Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).
		781
		782	=cut
		783
304	sub on_timeout {	784	sub on_stoptls {
305	$_[0]{on_timeout} = $_[1];	785	$_[0]{on_stoptls} = $_[1];
		786	}
		787
		788	=item $handle->rbuf_max ($max_octets)
		789
		790	Configures the C<rbuf_max> setting (C<undef> disables it).
		791
		792	=item $handle->wbuf_max ($max_octets)
		793
		794	Configures the C<wbuf_max> setting (C<undef> disables it).
		795
		796	=cut
		797
		798	sub rbuf_max {
		799	$_[0]{rbuf_max} = $_[1];
		800	}
		801
		802	sub wbuf_max {
		803	$_[0]{wbuf_max} = $_[1];
306	}	804	}
307		805
308	#############################################################################	806	#############################################################################
309		807
310	=item $handle->timeout ($seconds)	808	=item $handle->timeout ($seconds)
311		809
		810	=item $handle->rtimeout ($seconds)
		811
		812	=item $handle->wtimeout ($seconds)
		813
312	Configures (or disables) the inactivity timeout.	814	Configures (or disables) the inactivity timeout.
313		815
314	=cut	816	The timeout will be checked instantly, so this method might destroy the
		817	handle before it returns.
315		818
316	sub timeout {	819	=item $handle->timeout_reset
		820
		821	=item $handle->rtimeout_reset
		822
		823	=item $handle->wtimeout_reset
		824
		825	Reset the activity timeout, as if data was received or sent.
		826
		827	These methods are cheap to call.
		828
		829	=cut
		830
		831	for my $dir ("", "r", "w") {
		832	my $timeout = "${dir}timeout";
		833	my $tw = "_${dir}tw";
		834	my $on_timeout = "on_${dir}timeout";
		835	my $activity = "_${dir}activity";
		836	my $cb;
		837
		838	*$on_timeout = sub {
		839	$_[0]{$on_timeout} = $_[1];
		840	};
		841
		842	*$timeout = sub {
317	my ($self, $timeout) = @_;	843	my ($self, $new_value) = @_;
318		844
		845	$new_value >= 0
		846	or Carp::croak "AnyEvent::Handle->$timeout called with negative timeout ($new_value), caught";
		847
319	$self->{timeout} = $timeout;	848	$self->{$timeout} = $new_value;
320	$self->_timeout;	849	delete $self->{$tw}; &$cb;
321	}	850	};
322		851
		852	*{"${dir}timeout_reset"} = sub {
		853	$_[0]{$activity} = AE::now;
		854	};
		855
		856	# main workhorse:
323	# reset the timeout watcher, as neccessary	857	# reset the timeout watcher, as neccessary
324	# also check for time-outs	858	# also check for time-outs
325	sub _timeout {	859	$cb = sub {
326	my ($self) = @_;	860	my ($self) = @_;
327		861
328	if ($self->{timeout}) {	862	if ($self->{$timeout} && $self->{fh}) {
329	my $NOW = AnyEvent->now;	863	my $NOW = AE::now;
330		864
331	# when would the timeout trigger?	865	# when would the timeout trigger?
332	my $after = $self->{_activity} + $self->{timeout} - $NOW;	866	my $after = $self->{$activity} + $self->{$timeout} - $NOW;
333		867
334	# now or in the past already?	868	# now or in the past already?
335	if ($after <= 0) {	869	if ($after <= 0) {
336	$self->{_activity} = $NOW;	870	$self->{$activity} = $NOW;
337		871
338	if ($self->{on_timeout}) {	872	if ($self->{$on_timeout}) {
339	$self->{on_timeout}($self);	873	$self->{$on_timeout}($self);
340	} else {	874	} else {
341	$self->_error (&Errno::ETIMEDOUT);	875	$self->_error (Errno::ETIMEDOUT);
		876	}
		877
		878	# callback could have changed timeout value, optimise
		879	return unless $self->{$timeout};
		880
		881	# calculate new after
		882	$after = $self->{$timeout};
342	}	883	}
343		884
344	# callbakx could have changed timeout value, optimise	885	Scalar::Util::weaken $self;
345	return unless $self->{timeout};	886	return unless $self; # ->error could have destroyed $self
346		887
347	# calculate new after	888	$self->{$tw} ||= AE::timer $after, 0, sub {
348	$after = $self->{timeout};	889	delete $self->{$tw};
		890	$cb->($self);
		891	};
		892	} else {
		893	delete $self->{$tw};
349	}	894	}
350
351	Scalar::Util::weaken $self;
352
353	$self->{_tw} ||= AnyEvent->timer (after => $after, cb => sub {
354	delete $self->{_tw};
355	$self->_timeout;
356	});
357	} else {
358	delete $self->{_tw};
359	}	895	}
360	}	896	}
361		897
362	#############################################################################	898	#############################################################################
363		899
…		…
370		906
371	The write queue is very simple: you can add data to its end, and	907	The write queue is very simple: you can add data to its end, and
372	AnyEvent::Handle will automatically try to get rid of it for you.	908	AnyEvent::Handle will automatically try to get rid of it for you.
373		909
374	When data could be written and the write buffer is shorter then the low	910	When data could be written and the write buffer is shorter then the low
375	water mark, the C<on_drain> callback will be invoked.	911	water mark, the C<on_drain> callback will be invoked once.
376		912
377	=over 4	913	=over 4
378		914
379	=item $handle->on_drain ($cb)	915	=item $handle->on_drain ($cb)
380		916
381	Sets the C<on_drain> callback or clears it (see the description of	917	Sets the C<on_drain> callback or clears it (see the description of
382	C<on_drain> in the constructor).	918	C<on_drain> in the constructor).
383		919
		920	This method may invoke callbacks (and therefore the handle might be
		921	destroyed after it returns).
		922
384	=cut	923	=cut
385		924
386	sub on_drain {	925	sub on_drain {
387	my ($self, $cb) = @_;	926	my ($self, $cb) = @_;
388		927
389	$self->{on_drain} = $cb;	928	$self->{on_drain} = $cb;
390		929
391	$cb->($self)	930	$cb->($self)
392	if $cb && $self->{low_water_mark} >= length $self->{wbuf};	931	if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});
393	}	932	}
394		933
395	=item $handle->push_write ($data)	934	=item $handle->push_write ($data)
396		935
397	Queues the given scalar to be written. You can push as much data as you	936	Queues the given scalar to be written. You can push as much data as
398	want (only limited by the available memory), as C<AnyEvent::Handle>	937	you want (only limited by the available memory and C<wbuf_max>), as
399	buffers it independently of the kernel.	938	C<AnyEvent::Handle> buffers it independently of the kernel.
		939
		940	This method may invoke callbacks (and therefore the handle might be
		941	destroyed after it returns).
400		942
401	=cut	943	=cut
402		944
403	sub _drain_wbuf {	945	sub _drain_wbuf {
404	my ($self) = @_;	946	my ($self) = @_;
…		…
408	Scalar::Util::weaken $self;	950	Scalar::Util::weaken $self;
409		951
410	my $cb = sub {	952	my $cb = sub {
411	my $len = syswrite $self->{fh}, $self->{wbuf};	953	my $len = syswrite $self->{fh}, $self->{wbuf};
412		954
413	if ($len >= 0) {	955	if (defined $len) {
414	substr $self->{wbuf}, 0, $len, "";	956	substr $self->{wbuf}, 0, $len, "";
415		957
416	$self->{_activity} = AnyEvent->now;	958	$self->{_activity} = $self->{_wactivity} = AE::now;
417		959
418	$self->{on_drain}($self)	960	$self->{on_drain}($self)
419	if $self->{low_water_mark} >= length $self->{wbuf}	961	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
420	&& $self->{on_drain};	962	&& $self->{on_drain};
421		963
422	delete $self->{_ww} unless length $self->{wbuf};	964	delete $self->{_ww} unless length $self->{wbuf};
423	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	965	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
424	$self->_error ($!, 1);	966	$self->_error ($!, 1);
425	}	967	}
426	};	968	};
427		969
428	# try to write data immediately	970	# try to write data immediately
429	$cb->();	971	$cb->() unless $self->{autocork};
430		972
431	# if still data left in wbuf, we need to poll	973	# if still data left in wbuf, we need to poll
432	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	974	$self->{_ww} = AE::io $self->{fh}, 1, $cb
433	if length $self->{wbuf};	975	if length $self->{wbuf};
		976
		977	if (
		978	defined $self->{wbuf_max}
		979	&& $self->{wbuf_max} < length $self->{wbuf}
		980	) {
		981	$self->_error (Errno::ENOSPC, 1), return;
		982	}
434	};	983	};
435	}	984	}
436		985
437	our %WH;	986	our %WH;
438		987
		988	# deprecated
439	sub register_write_type($$) {	989	sub register_write_type($$) {
440	$WH{$_[0]} = $_[1];	990	$WH{$_[0]} = $_[1];
441	}	991	}
442		992
443	sub push_write {	993	sub push_write {
444	my $self = shift;	994	my $self = shift;
445		995
446	if (@_ > 1) {	996	if (@_ > 1) {
447	my $type = shift;	997	my $type = shift;
448		998
		999	@_ = ($WH{$type} ||= _load_func "$type\::anyevent_write_type"
449	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	1000	or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_write")
450	->($self, @_);	1001	->($self, @_);
451	}	1002	}
452		1003
		1004	# we downgrade here to avoid hard-to-track-down bugs,
		1005	# and diagnose the problem earlier and better.
		1006
453	if ($self->{filter_w}) {	1007	if ($self->{tls}) {
454	$self->{filter_w}($self, \$_[0]);	1008	utf8::downgrade $self->{_tls_wbuf} .= $_[0];
		1009	&_dotls ($self) if $self->{fh};
455	} else {	1010	} else {
456	$self->{wbuf} .= $_[0];	1011	utf8::downgrade $self->{wbuf} .= $_[0];
457	$self->_drain_wbuf;	1012	$self->_drain_wbuf if $self->{fh};
458	}	1013	}
459	}	1014	}
460		1015
461	=item $handle->push_write (type => @args)	1016	=item $handle->push_write (type => @args)
462		1017
463	Instead of formatting your data yourself, you can also let this module do	1018	Instead of formatting your data yourself, you can also let this module
464	the job by specifying a type and type-specific arguments.	1019	do the job by specifying a type and type-specific arguments. You
		1020	can also specify the (fully qualified) name of a package, in which
		1021	case AnyEvent tries to load the package and then expects to find the
		1022	C<anyevent_write_type> function inside (see "custom write types", below).
465		1023
466	Predefined types are (if you have ideas for additional types, feel free to	1024	Predefined types are (if you have ideas for additional types, feel free to
467	drop by and tell us):	1025	drop by and tell us):
468		1026
469	=over 4	1027	=over 4
…		…
476	=cut	1034	=cut
477		1035
478	register_write_type netstring => sub {	1036	register_write_type netstring => sub {
479	my ($self, $string) = @_;	1037	my ($self, $string) = @_;
480		1038
481	sprintf "%d:%s,", (length $string), $string	1039	(length $string) . ":$string,"
		1040	};
		1041
		1042	=item packstring => $format, $data
		1043
		1044	An octet string prefixed with an encoded length. The encoding C<$format>
		1045	uses the same format as a Perl C<pack> format, but must specify a single
		1046	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
		1047	optional C<!>, C<< < >> or C<< > >> modifier).
		1048
		1049	=cut
		1050
		1051	register_write_type packstring => sub {
		1052	my ($self, $format, $string) = @_;
		1053
		1054	pack "$format/a*", $string
482	};	1055	};
483		1056
484	=item json => $array_or_hashref	1057	=item json => $array_or_hashref
485		1058
486	Encodes the given hash or array reference into a JSON object. Unless you	1059	Encodes the given hash or array reference into a JSON object. Unless you
…		…
493		1066
494	The generated JSON text is guaranteed not to contain any newlines: While	1067	The generated JSON text is guaranteed not to contain any newlines: While
495	this module doesn't need delimiters after or between JSON texts to be	1068	this module doesn't need delimiters after or between JSON texts to be
496	able to read them, many other languages depend on that.	1069	able to read them, many other languages depend on that.
497		1070
498	A simple RPC protocol that interoperates easily with others is to send	1071	A simple RPC protocol that interoperates easily with other languages is
499	JSON arrays (or objects, although arrays are usually the better choice as	1072	to send JSON arrays (or objects, although arrays are usually the better
500	they mimic how function argument passing works) and a newline after each	1073	choice as they mimic how function argument passing works) and a newline
501	JSON text:	1074	after each JSON text:
502		1075
503	$handle->push_write (json => ["method", "arg1", "arg2"]); # whatever	1076	$handle->push_write (json => ["method", "arg1", "arg2"]); # whatever
504	$handle->push_write ("\012");	1077	$handle->push_write ("\012");
505		1078
506	An AnyEvent::Handle receiver would simply use the C<json> read type and	1079	An AnyEvent::Handle receiver would simply use the C<json> read type and
…		…
509	$handle->push_read (json => sub { my $array = $_[1]; ... });	1082	$handle->push_read (json => sub { my $array = $_[1]; ... });
510		1083
511	Other languages could read single lines terminated by a newline and pass	1084	Other languages could read single lines terminated by a newline and pass
512	this line into their JSON decoder of choice.	1085	this line into their JSON decoder of choice.
513		1086
		1087	=item cbor => $perl_scalar
		1088
		1089	Encodes the given scalar into a CBOR value. Unless you provide your own
		1090	L<CBOR::XS> object, this means it will be encoded to a CBOR string not
		1091	using any extensions, if possible.
		1092
		1093	CBOR values are self-delimiting, so you can write CBOR at one end of
		1094	a handle and read them at the other end without using any additional
		1095	framing.
		1096
		1097	A simple nd very very fast RPC protocol that interoperates with
		1098	other languages is to send CBOR and receive CBOR values (arrays are
		1099	recommended):
		1100
		1101	$handle->push_write (cbor => ["method", "arg1", "arg2"]); # whatever
		1102
		1103	An AnyEvent::Handle receiver would simply use the C<cbor> read type:
		1104
		1105	$handle->push_read (cbor => sub { my $array = $_[1]; ... });
		1106
514	=cut	1107	=cut
		1108
		1109	sub json_coder() {
		1110	eval { require JSON::XS; JSON::XS->new->utf8 }
		1111	|| do { require JSON; JSON->new->utf8 }
		1112	}
515		1113
516	register_write_type json => sub {	1114	register_write_type json => sub {
517	my ($self, $ref) = @_;	1115	my ($self, $ref) = @_;
518		1116
519	require JSON;	1117	($self->{json} ||= json_coder)
520		1118	->encode ($ref)
521	$self->{json} ? $self->{json}->encode ($ref)
522	: JSON::encode_json ($ref)
523	};	1119	};
524		1120
525	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	1121	sub cbor_coder() {
		1122	require CBOR::XS;
		1123	CBOR::XS->new
		1124	}
526		1125
527	This function (not method) lets you add your own types to C<push_write>.	1126	register_write_type cbor => sub {
528	Whenever the given C<type> is used, C<push_write> will invoke the code	1127	my ($self, $scalar) = @_;
529	reference with the handle object and the remaining arguments.
530		1128
531	The code reference is supposed to return a single octet string that will	1129	($self->{cbor} ||= cbor_coder)
532	be appended to the write buffer.	1130	->encode ($scalar)
		1131	};
533		1132
534	Note that this is a function, and all types registered this way will be	1133	=item storable => $reference
535	global, so try to use unique names.	1134
		1135	Freezes the given reference using L<Storable> and writes it to the
		1136	handle. Uses the C<nfreeze> format.
		1137
		1138	=cut
		1139
		1140	register_write_type storable => sub {
		1141	my ($self, $ref) = @_;
		1142
		1143	require Storable unless $Storable::VERSION;
		1144
		1145	pack "w/a*", Storable::nfreeze ($ref)
		1146	};
536		1147
537	=back	1148	=back
		1149
		1150	=item $handle->push_shutdown
		1151
		1152	Sometimes you know you want to close the socket after writing your data
		1153	before it was actually written. One way to do that is to replace your
		1154	C<on_drain> handler by a callback that shuts down the socket (and set
		1155	C<low_water_mark> to C<0>). This method is a shorthand for just that, and
		1156	replaces the C<on_drain> callback with:
		1157
		1158	sub { shutdown $_[0]{fh}, 1 }
		1159
		1160	This simply shuts down the write side and signals an EOF condition to the
		1161	the peer.
		1162
		1163	You can rely on the normal read queue and C<on_eof> handling
		1164	afterwards. This is the cleanest way to close a connection.
		1165
		1166	This method may invoke callbacks (and therefore the handle might be
		1167	destroyed after it returns).
		1168
		1169	=cut
		1170
		1171	sub push_shutdown {
		1172	my ($self) = @_;
		1173
		1174	delete $self->{low_water_mark};
		1175	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });
		1176	}
		1177
		1178	=item custom write types - Package::anyevent_write_type $handle, @args
		1179
		1180	Instead of one of the predefined types, you can also specify the name of
		1181	a package. AnyEvent will try to load the package and then expects to find
		1182	a function named C<anyevent_write_type> inside. If it isn't found, it
		1183	progressively tries to load the parent package until it either finds the
		1184	function (good) or runs out of packages (bad).
		1185
		1186	Whenever the given C<type> is used, C<push_write> will the function with
		1187	the handle object and the remaining arguments.
		1188
		1189	The function is supposed to return a single octet string that will be
		1190	appended to the write buffer, so you can mentally treat this function as a
		1191	"arguments to on-the-wire-format" converter.
		1192
		1193	Example: implement a custom write type C<join> that joins the remaining
		1194	arguments using the first one.
		1195
		1196	$handle->push_write (My::Type => " ", 1,2,3);
		1197
		1198	# uses the following package, which can be defined in the "My::Type" or in
		1199	# the "My" modules to be auto-loaded, or just about anywhere when the
		1200	# My::Type::anyevent_write_type is defined before invoking it.
		1201
		1202	package My::Type;
		1203
		1204	sub anyevent_write_type {
		1205	my ($handle, $delim, @args) = @_;
		1206
		1207	join $delim, @args
		1208	}
538		1209
539	=cut	1210	=cut
540		1211
541	#############################################################################	1212	#############################################################################
542		1213
…		…
551	ways, the "simple" way, using only C<on_read> and the "complex" way, using	1222	ways, the "simple" way, using only C<on_read> and the "complex" way, using
552	a queue.	1223	a queue.
553		1224
554	In the simple case, you just install an C<on_read> callback and whenever	1225	In the simple case, you just install an C<on_read> callback and whenever
555	new data arrives, it will be called. You can then remove some data (if	1226	new data arrives, it will be called. You can then remove some data (if
556	enough is there) from the read buffer (C<< $handle->rbuf >>) if you want	1227	enough is there) from the read buffer (C<< $handle->rbuf >>). Or you can
557	or not.	1228	leave the data there if you want to accumulate more (e.g. when only a
		1229	partial message has been received so far), or change the read queue with
		1230	e.g. C<push_read>.
558		1231
559	In the more complex case, you want to queue multiple callbacks. In this	1232	In the more complex case, you want to queue multiple callbacks. In this
560	case, AnyEvent::Handle will call the first queued callback each time new	1233	case, AnyEvent::Handle will call the first queued callback each time new
561	data arrives and removes it when it has done its job (see C<push_read>,	1234	data arrives (also the first time it is queued) and remove it when it has
562	below).	1235	done its job (see C<push_read>, below).
563		1236
564	This way you can, for example, push three line-reads, followed by reading	1237	This way you can, for example, push three line-reads, followed by reading
565	a chunk of data, and AnyEvent::Handle will execute them in order.	1238	a chunk of data, and AnyEvent::Handle will execute them in order.
566		1239
567	Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by	1240	Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by
…		…
580	# handle xml	1253	# handle xml
581	});	1254	});
582	});	1255	});
583	});	1256	});
584		1257
585	Example 2: Implement a client for a protocol that replies either with	1258	Example 2: Implement a client for a protocol that replies either with "OK"
586	"OK" and another line or "ERROR" for one request, and 64 bytes for the	1259	and another line or "ERROR" for the first request that is sent, and 64
587	second request. Due tot he availability of a full queue, we can just	1260	bytes for the second request. Due to the availability of a queue, we can
588	pipeline sending both requests and manipulate the queue as necessary in	1261	just pipeline sending both requests and manipulate the queue as necessary
589	the callbacks:	1262	in the callbacks.
590		1263
591	# request one	1264	When the first callback is called and sees an "OK" response, it will
		1265	C<unshift> another line-read. This line-read will be queued I<before> the
		1266	64-byte chunk callback.
		1267
		1268	# request one, returns either "OK + extra line" or "ERROR"
592	$handle->push_write ("request 1\015\012");	1269	$handle->push_write ("request 1\015\012");
593		1270
594	# we expect "ERROR" or "OK" as response, so push a line read	1271	# we expect "ERROR" or "OK" as response, so push a line read
595	$handle->push_read (line => sub {	1272	$handle->push_read (line => sub {
596	# if we got an "OK", we have to _prepend_ another line,	1273	# if we got an "OK", we have to _prepend_ another line,
…		…
603	...	1280	...
604	});	1281	});
605	}	1282	}
606	});	1283	});
607		1284
608	# request two	1285	# request two, simply returns 64 octets
609	$handle->push_write ("request 2\015\012");	1286	$handle->push_write ("request 2\015\012");
610		1287
611	# simply read 64 bytes, always	1288	# simply read 64 bytes, always
612	$handle->push_read (chunk => 64, sub {	1289	$handle->push_read (chunk => 64, sub {
613	my $response = $_[1];	1290	my $response = $_[1];
…		…
619	=cut	1296	=cut
620		1297
621	sub _drain_rbuf {	1298	sub _drain_rbuf {
622	my ($self) = @_;	1299	my ($self) = @_;
623		1300
		1301	# avoid recursion
		1302	return if $self->{_skip_drain_rbuf};
		1303	local $self->{_skip_drain_rbuf} = 1;
		1304
		1305	while () {
		1306	# we need to use a separate tls read buffer, as we must not receive data while
		1307	# we are draining the buffer, and this can only happen with TLS.
		1308	$self->{rbuf} .= delete $self->{_tls_rbuf}
		1309	if exists $self->{_tls_rbuf};
		1310
		1311	my $len = length $self->{rbuf};
		1312
		1313	if (my $cb = shift @{ $self->{_queue} }) {
		1314	unless ($cb->($self)) {
		1315	# no progress can be made
		1316	# (not enough data and no data forthcoming)
		1317	$self->_error (Errno::EPIPE, 1), return
		1318	if $self->{_eof};
		1319
		1320	unshift @{ $self->{_queue} }, $cb;
		1321	last;
		1322	}
		1323	} elsif ($self->{on_read}) {
		1324	last unless $len;
		1325
		1326	$self->{on_read}($self);
		1327
		1328	if (
		1329	$len == length $self->{rbuf} # if no data has been consumed
		1330	&& !@{ $self->{_queue} } # and the queue is still empty
		1331	&& $self->{on_read} # but we still have on_read
		1332	) {
		1333	# no further data will arrive
		1334	# so no progress can be made
		1335	$self->_error (Errno::EPIPE, 1), return
		1336	if $self->{_eof};
		1337
		1338	last; # more data might arrive
		1339	}
		1340	} else {
		1341	# read side becomes idle
		1342	delete $self->{_rw} unless $self->{tls};
		1343	last;
		1344	}
		1345	}
		1346
		1347	if ($self->{_eof}) {
		1348	$self->{on_eof}
		1349	? $self->{on_eof}($self)
		1350	: $self->_error (0, 1, "Unexpected end-of-file");
		1351
		1352	return;
		1353	}
		1354
624	if (	1355	if (
625	defined $self->{rbuf_max}	1356	defined $self->{rbuf_max}
626	&& $self->{rbuf_max} < length $self->{rbuf}	1357	&& $self->{rbuf_max} < length $self->{rbuf}
627	) {	1358	) {
628	return $self->_error (&Errno::ENOSPC, 1);	1359	$self->_error (Errno::ENOSPC, 1), return;
629	}	1360	}
630		1361
631	return if $self->{in_drain};	1362	# may need to restart read watcher
632	local $self->{in_drain} = 1;	1363	unless ($self->{_rw}) {
633		1364	$self->start_read
634	while (my $len = length $self->{rbuf}) {	1365	if $self->{on_read} || @{ $self->{_queue} };
635	no strict 'refs';
636	if (my $cb = shift @{ $self->{_queue} }) {
637	unless ($cb->($self)) {
638	if ($self->{_eof}) {
639	# no progress can be made (not enough data and no data forthcoming)
640	return $self->_error (&Errno::EPIPE, 1);
641	}
642
643	unshift @{ $self->{_queue} }, $cb;
644	return;
645	}
646	} elsif ($self->{on_read}) {
647	$self->{on_read}($self);
648
649	if (
650	$self->{_eof} # if no further data will arrive
651	&& $len == length $self->{rbuf} # and no data has been consumed
652	&& !@{ $self->{_queue} } # and the queue is still empty
653	&& $self->{on_read} # and we still want to read data
654	) {
655	# then no progress can be made
656	return $self->_error (&Errno::EPIPE, 1);
657	}
658	} else {
659	# read side becomes idle
660	delete $self->{_rw};
661	return;
662	}
663	}	1366	}
664
665	$self->{on_eof}($self)
666	if $self->{_eof} && $self->{on_eof};
667	}	1367	}
668		1368
669	=item $handle->on_read ($cb)	1369	=item $handle->on_read ($cb)
670		1370
671	This replaces the currently set C<on_read> callback, or clears it (when	1371	This replaces the currently set C<on_read> callback, or clears it (when
672	the new callback is C<undef>). See the description of C<on_read> in the	1372	the new callback is C<undef>). See the description of C<on_read> in the
673	constructor.	1373	constructor.
674		1374
		1375	This method may invoke callbacks (and therefore the handle might be
		1376	destroyed after it returns).
		1377
675	=cut	1378	=cut
676		1379
677	sub on_read {	1380	sub on_read {
678	my ($self, $cb) = @_;	1381	my ($self, $cb) = @_;
679		1382
680	$self->{on_read} = $cb;	1383	$self->{on_read} = $cb;
		1384	$self->_drain_rbuf if $cb;
681	}	1385	}
682		1386
683	=item $handle->rbuf	1387	=item $handle->rbuf
684		1388
685	Returns the read buffer (as a modifiable lvalue).	1389	Returns the read buffer (as a modifiable lvalue). You can also access the
		1390	read buffer directly as the C<< ->{rbuf} >> member, if you want (this is
		1391	much faster, and no less clean).
686		1392
687	You can access the read buffer directly as the C<< ->{rbuf} >> member, if	1393	The only operation allowed on the read buffer (apart from looking at it)
688	you want.	1394	is removing data from its beginning. Otherwise modifying or appending to
		1395	it is not allowed and will lead to hard-to-track-down bugs.
689		1396
690	NOTE: The read buffer should only be used or modified if the C<on_read>,	1397	NOTE: The read buffer should only be used or modified in the C<on_read>
691	C<push_read> or C<unshift_read> methods are used. The other read methods	1398	callback or when C<push_read> or C<unshift_read> are used with a single
692	automatically manage the read buffer.	1399	callback (i.e. untyped). Typed C<push_read> and C<unshift_read> methods
		1400	will manage the read buffer on their own.
693		1401
694	=cut	1402	=cut
695		1403
696	sub rbuf : lvalue {	1404	sub rbuf : lvalue {
697	$_[0]{rbuf}	1405	$_[0]{rbuf}
…		…
714		1422
715	If enough data was available, then the callback must remove all data it is	1423	If enough data was available, then the callback must remove all data it is
716	interested in (which can be none at all) and return a true value. After returning	1424	interested in (which can be none at all) and return a true value. After returning
717	true, it will be removed from the queue.	1425	true, it will be removed from the queue.
718		1426
		1427	These methods may invoke callbacks (and therefore the handle might be
		1428	destroyed after it returns).
		1429
719	=cut	1430	=cut
720		1431
721	our %RH;	1432	our %RH;
722		1433
723	sub register_read_type($$) {	1434	sub register_read_type($$) {
…		…
729	my $cb = pop;	1440	my $cb = pop;
730		1441
731	if (@_) {	1442	if (@_) {
732	my $type = shift;	1443	my $type = shift;
733		1444
		1445	$cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type"
734	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	1446	or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_read")
735	->($self, $cb, @_);	1447	->($self, $cb, @_);
736	}	1448	}
737		1449
738	push @{ $self->{_queue} }, $cb;	1450	push @{ $self->{_queue} }, $cb;
739	$self->_drain_rbuf;	1451	$self->_drain_rbuf;
…		…
744	my $cb = pop;	1456	my $cb = pop;
745		1457
746	if (@_) {	1458	if (@_) {
747	my $type = shift;	1459	my $type = shift;
748		1460
		1461	$cb = ($RH{$type} ||= _load_func "$type\::anyevent_read_type"
749	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")	1462	or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::unshift_read")
750	->($self, $cb, @_);	1463	->($self, $cb, @_);
751	}	1464	}
752
753		1465
754	unshift @{ $self->{_queue} }, $cb;	1466	unshift @{ $self->{_queue} }, $cb;
755	$self->_drain_rbuf;	1467	$self->_drain_rbuf;
756	}	1468	}
757		1469
…		…
759		1471
760	=item $handle->unshift_read (type => @args, $cb)	1472	=item $handle->unshift_read (type => @args, $cb)
761		1473
762	Instead of providing a callback that parses the data itself you can chose	1474	Instead of providing a callback that parses the data itself you can chose
763	between a number of predefined parsing formats, for chunks of data, lines	1475	between a number of predefined parsing formats, for chunks of data, lines
764	etc.	1476	etc. You can also specify the (fully qualified) name of a package, in
		1477	which case AnyEvent tries to load the package and then expects to find the
		1478	C<anyevent_read_type> function inside (see "custom read types", below).
765		1479
766	Predefined types are (if you have ideas for additional types, feel free to	1480	Predefined types are (if you have ideas for additional types, feel free to
767	drop by and tell us):	1481	drop by and tell us):
768		1482
769	=over 4	1483	=over 4
…		…
775	data.	1489	data.
776		1490
777	Example: read 2 bytes.	1491	Example: read 2 bytes.
778		1492
779	$handle->push_read (chunk => 2, sub {	1493	$handle->push_read (chunk => 2, sub {
780	warn "yay ", unpack "H*", $_[1];	1494	say "yay " . unpack "H*", $_[1];
781	});	1495	});
782		1496
783	=cut	1497	=cut
784		1498
785	register_read_type chunk => sub {	1499	register_read_type chunk => sub {
…		…
790	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");	1504	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");
791	1	1505	1
792	}	1506	}
793	};	1507	};
794		1508
795	# compatibility with older API
796	sub push_read_chunk {
797	$_[0]->push_read (chunk => $_[1], $_[2]);
798	}
799
800	sub unshift_read_chunk {
801	$_[0]->unshift_read (chunk => $_[1], $_[2]);
802	}
803
804	=item line => [$eol, ]$cb->($handle, $line, $eol)	1509	=item line => [$eol, ]$cb->($handle, $line, $eol)
805		1510
806	The callback will be called only once a full line (including the end of	1511	The callback will be called only once a full line (including the end of
807	line marker, C<$eol>) has been read. This line (excluding the end of line	1512	line marker, C<$eol>) has been read. This line (excluding the end of line
808	marker) will be passed to the callback as second argument (C<$line>), and	1513	marker) will be passed to the callback as second argument (C<$line>), and
…		…
823	=cut	1528	=cut
824		1529
825	register_read_type line => sub {	1530	register_read_type line => sub {
826	my ($self, $cb, $eol) = @_;	1531	my ($self, $cb, $eol) = @_;
827		1532
828	$eol = qr|(\015?\012)| if @_ < 3;	1533	if (@_ < 3) {
829	$eol = quotemeta $eol unless ref $eol;	1534	# this is faster then the generic code below
830	$eol = qr|^(.*?)($eol)|s;
831
832	sub {	1535	sub {
833	$_[0]{rbuf} =~ s/$eol// or return;	1536	(my $pos = index $_[0]{rbuf}, "\012") >= 0
		1537	or return;
834		1538
		1539	(my $str = substr $_[0]{rbuf}, 0, $pos + 1, "") =~ s/(\015?\012)\Z// or die;
835	$cb->($_[0], $1, $2);	1540	$cb->($_[0], $str, "$1");
836	1
837	}
838	};
839
840	# compatibility with older API
841	sub push_read_line {
842	my $self = shift;
843	$self->push_read (line => @_);
844	}
845
846	sub unshift_read_line {
847	my $self = shift;
848	$self->unshift_read (line => @_);
849	}
850
851	=item netstring => $cb->($handle, $string)
852
853	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
854
855	Throws an error with C<$!> set to EBADMSG on format violations.
856
857	=cut
858
859	register_read_type netstring => sub {
860	my ($self, $cb) = @_;
861
862	sub {
863	unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {
864	if ($_[0]{rbuf} =~ /[^0-9]/) {
865	$self->_error (&Errno::EBADMSG);
866	}	1541	1
867	return;
868	}	1542	}
		1543	} else {
		1544	$eol = quotemeta $eol unless ref $eol;
		1545	$eol = qr|^(.*?)($eol)|s;
869		1546
870	my $len = $1;	1547	sub {
		1548	$_[0]{rbuf} =~ s/$eol// or return;
871		1549
872	$self->unshift_read (chunk => $len, sub {	1550	$cb->($_[0], "$1", "$2");
873	my $string = $_[1];
874	$_[0]->unshift_read (chunk => 1, sub {
875	if ($_[1] eq ",") {
876	$cb->($_[0], $string);
877	} else {
878	$self->_error (&Errno::EBADMSG);
879	}
880	});	1551	1
881	});	1552	}
882
883	1
884	}	1553	}
885	};	1554	};
886		1555
887	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)	1556	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
888		1557
…		…
908	the receive buffer when neither C<$accept> nor C<$reject> match,	1577	the receive buffer when neither C<$accept> nor C<$reject> match,
909	and everything preceding and including the match will be accepted	1578	and everything preceding and including the match will be accepted
910	unconditionally. This is useful to skip large amounts of data that you	1579	unconditionally. This is useful to skip large amounts of data that you
911	know cannot be matched, so that the C<$accept> or C<$reject> regex do not	1580	know cannot be matched, so that the C<$accept> or C<$reject> regex do not
912	have to start matching from the beginning. This is purely an optimisation	1581	have to start matching from the beginning. This is purely an optimisation
913	and is usually worth only when you expect more than a few kilobytes.	1582	and is usually worth it only when you expect more than a few kilobytes.
914		1583
915	Example: expect a http header, which ends at C<\015\012\015\012>. Since we	1584	Example: expect a http header, which ends at C<\015\012\015\012>. Since we
916	expect the header to be very large (it isn't in practise, but...), we use	1585	expect the header to be very large (it isn't in practice, but...), we use
917	a skip regex to skip initial portions. The skip regex is tricky in that	1586	a skip regex to skip initial portions. The skip regex is tricky in that
918	it only accepts something not ending in either \015 or \012, as these are	1587	it only accepts something not ending in either \015 or \012, as these are
919	required for the accept regex.	1588	required for the accept regex.
920		1589
921	$handle->push_read (regex =>	1590	$handle->push_read (regex =>
…		…
934		1603
935	sub {	1604	sub {
936	# accept	1605	# accept
937	if ($$rbuf =~ $accept) {	1606	if ($$rbuf =~ $accept) {
938	$data .= substr $$rbuf, 0, $+[0], "";	1607	$data .= substr $$rbuf, 0, $+[0], "";
939	$cb->($self, $data);	1608	$cb->($_[0], $data);
940	return 1;	1609	return 1;
941	}	1610	}
942		1611
943	# reject	1612	# reject
944	if ($reject && $$rbuf =~ $reject) {	1613	if ($reject && $$rbuf =~ $reject) {
945	$self->_error (&Errno::EBADMSG);	1614	$_[0]->_error (Errno::EBADMSG);
946	}	1615	}
947		1616
948	# skip	1617	# skip
949	if ($skip && $$rbuf =~ $skip) {	1618	if ($skip && $$rbuf =~ $skip) {
950	$data .= substr $$rbuf, 0, $+[0], "";	1619	$data .= substr $$rbuf, 0, $+[0], "";
…		…
952		1621
953	()	1622	()
954	}	1623	}
955	};	1624	};
956		1625
		1626	=item netstring => $cb->($handle, $string)
		1627
		1628	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
		1629
		1630	Throws an error with C<$!> set to EBADMSG on format violations.
		1631
		1632	=cut
		1633
		1634	register_read_type netstring => sub {
		1635	my ($self, $cb) = @_;
		1636
		1637	sub {
		1638	unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {
		1639	if ($_[0]{rbuf} =~ /[^0-9]/) {
		1640	$_[0]->_error (Errno::EBADMSG);
		1641	}
		1642	return;
		1643	}
		1644
		1645	my $len = $1;
		1646
		1647	$_[0]->unshift_read (chunk => $len, sub {
		1648	my $string = $_[1];
		1649	$_[0]->unshift_read (chunk => 1, sub {
		1650	if ($_[1] eq ",") {
		1651	$cb->($_[0], $string);
		1652	} else {
		1653	$_[0]->_error (Errno::EBADMSG);
		1654	}
		1655	});
		1656	});
		1657
		1658	1
		1659	}
		1660	};
		1661
		1662	=item packstring => $format, $cb->($handle, $string)
		1663
		1664	An octet string prefixed with an encoded length. The encoding C<$format>
		1665	uses the same format as a Perl C<pack> format, but must specify a single
		1666	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
		1667	optional C<!>, C<< < >> or C<< > >> modifier).
		1668
		1669	For example, DNS over TCP uses a prefix of C<n> (2 octet network order),
		1670	EPP uses a prefix of C<N> (4 octtes).
		1671
		1672	Example: read a block of data prefixed by its length in BER-encoded
		1673	format (very efficient).
		1674
		1675	$handle->push_read (packstring => "w", sub {
		1676	my ($handle, $data) = @_;
		1677	});
		1678
		1679	=cut
		1680
		1681	register_read_type packstring => sub {
		1682	my ($self, $cb, $format) = @_;
		1683
		1684	sub {
		1685	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
		1686	defined (my $len = eval { unpack $format, $_[0]{rbuf} })
		1687	or return;
		1688
		1689	$format = length pack $format, $len;
		1690
		1691	# bypass unshift if we already have the remaining chunk
		1692	if ($format + $len <= length $_[0]{rbuf}) {
		1693	my $data = substr $_[0]{rbuf}, $format, $len;
		1694	substr $_[0]{rbuf}, 0, $format + $len, "";
		1695	$cb->($_[0], $data);
		1696	} else {
		1697	# remove prefix
		1698	substr $_[0]{rbuf}, 0, $format, "";
		1699
		1700	# read remaining chunk
		1701	$_[0]->unshift_read (chunk => $len, $cb);
		1702	}
		1703
		1704	1
		1705	}
		1706	};
		1707
957	=item json => $cb->($handle, $hash_or_arrayref)	1708	=item json => $cb->($handle, $hash_or_arrayref)
958		1709
959	Reads a JSON object or array, decodes it and passes it to the callback.	1710	Reads a JSON object or array, decodes it and passes it to the
		1711	callback. When a parse error occurs, an C<EBADMSG> error will be raised.
960		1712
961	If a C<json> object was passed to the constructor, then that will be used	1713	If a C<json> object was passed to the constructor, then that will be used
962	for the final decode, otherwise it will create a JSON coder expecting UTF-8.	1714	for the final decode, otherwise it will create a JSON coder expecting UTF-8.
963		1715
964	This read type uses the incremental parser available with JSON version	1716	This read type uses the incremental parser available with JSON version
…		…
971	the C<json> write type description, above, for an actual example.	1723	the C<json> write type description, above, for an actual example.
972		1724
973	=cut	1725	=cut
974		1726
975	register_read_type json => sub {	1727	register_read_type json => sub {
976	my ($self, $cb, $accept, $reject, $skip) = @_;	1728	my ($self, $cb) = @_;
977		1729
978	require JSON;	1730	my $json = $self->{json} ||= json_coder;
979		1731
980	my $data;	1732	my $data;
981	my $rbuf = \$self->{rbuf};
982
983	my $json = $self->{json} ||= JSON->new->utf8;
984		1733
985	sub {	1734	sub {
986	my $ref = $json->incr_parse ($self->{rbuf});	1735	my $ref = eval { $json->incr_parse ($_[0]{rbuf}) };
987		1736
988	if ($ref) {	1737	if ($ref) {
989	$self->{rbuf} = $json->incr_text;	1738	$_[0]{rbuf} = $json->incr_text;
990	$json->incr_text = "";	1739	$json->incr_text = "";
991	$cb->($self, $ref);	1740	$cb->($_[0], $ref);
992		1741
993	1	1742	1
		1743	} elsif ($@) {
		1744	# error case
		1745	$json->incr_skip;
		1746
		1747	$_[0]{rbuf} = $json->incr_text;
		1748	$json->incr_text = "";
		1749
		1750	$_[0]->_error (Errno::EBADMSG);
		1751
		1752	()
994	} else {	1753	} else {
995	$self->{rbuf} = "";	1754	$_[0]{rbuf} = "";
		1755
996	()	1756	()
997	}	1757	}
998	}	1758	}
999	};	1759	};
1000		1760
		1761	=item cbor => $cb->($handle, $scalar)
		1762
		1763	Reads a CBOR value, decodes it and passes it to the callback. When a parse
		1764	error occurs, an C<EBADMSG> error will be raised.
		1765
		1766	If a L<CBOR::XS> object was passed to the constructor, then that will be
		1767	used for the final decode, otherwise it will create a CBOR coder without
		1768	enabling any options.
		1769
		1770	You have to provide a dependency to L<CBOR::XS> on your own: this module
		1771	will load the L<CBOR::XS> module, but AnyEvent does not depend on it
		1772	itself.
		1773
		1774	Since CBOR values are fully self-delimiting, the C<cbor> read and write
		1775	types are an ideal simple RPC protocol: just exchange CBOR datagrams. See
		1776	the C<cbor> write type description, above, for an actual example.
		1777
		1778	=cut
		1779
		1780	register_read_type cbor => sub {
		1781	my ($self, $cb) = @_;
		1782
		1783	my $cbor = $self->{cbor} ||= cbor_coder;
		1784
		1785	my $data;
		1786
		1787	sub {
		1788	my (@value) = eval { $cbor->incr_parse ($_[0]{rbuf}) };
		1789
		1790	if (@value) {
		1791	$cb->($_[0], @value);
		1792
		1793	1
		1794	} elsif ($@) {
		1795	# error case
		1796	$cbor->incr_reset;
		1797
		1798	$_[0]->_error (Errno::EBADMSG);
		1799
		1800	()
		1801	} else {
		1802	()
		1803	}
		1804	}
		1805	};
		1806
		1807	=item storable => $cb->($handle, $ref)
		1808
		1809	Deserialises a L<Storable> frozen representation as written by the
		1810	C<storable> write type (BER-encoded length prefix followed by nfreeze'd
		1811	data).
		1812
		1813	Raises C<EBADMSG> error if the data could not be decoded.
		1814
		1815	=cut
		1816
		1817	register_read_type storable => sub {
		1818	my ($self, $cb) = @_;
		1819
		1820	require Storable unless $Storable::VERSION;
		1821
		1822	sub {
		1823	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
		1824	defined (my $len = eval { unpack "w", $_[0]{rbuf} })
		1825	or return;
		1826
		1827	my $format = length pack "w", $len;
		1828
		1829	# bypass unshift if we already have the remaining chunk
		1830	if ($format + $len <= length $_[0]{rbuf}) {
		1831	my $data = substr $_[0]{rbuf}, $format, $len;
		1832	substr $_[0]{rbuf}, 0, $format + $len, "";
		1833
		1834	eval { $cb->($_[0], Storable::thaw ($data)); 1 }
		1835	or return $_[0]->_error (Errno::EBADMSG);
		1836	} else {
		1837	# remove prefix
		1838	substr $_[0]{rbuf}, 0, $format, "";
		1839
		1840	# read remaining chunk
		1841	$_[0]->unshift_read (chunk => $len, sub {
		1842	eval { $cb->($_[0], Storable::thaw ($_[1])); 1 }
		1843	or $_[0]->_error (Errno::EBADMSG);
		1844	});
		1845	}
		1846
		1847	1
		1848	}
		1849	};
		1850
		1851	=item tls_detect => $cb->($handle, $detect, $major, $minor)
		1852
		1853	Checks the input stream for a valid SSL or TLS handshake TLSPaintext
		1854	record without consuming anything. Only SSL version 3 or higher
		1855	is handled, up to the fictituous protocol 4.x (but both SSL3+ and
		1856	SSL2-compatible framing is supported).
		1857
		1858	If it detects that the input data is likely TLS, it calls the callback
		1859	with a true value for C<$detect> and the (on-wire) TLS version as second
		1860	and third argument (C<$major> is C<3>, and C<$minor> is 0..3 for SSL
		1861	3.0, TLS 1.0, 1.1 and 1.2, respectively). If it detects the input to
		1862	be definitely not TLS, it calls the callback with a false value for
		1863	C<$detect>.
		1864
		1865	The callback could use this information to decide whether or not to start
		1866	TLS negotiation.
		1867
		1868	In all cases the data read so far is passed to the following read
		1869	handlers.
		1870
		1871	Usually you want to use the C<tls_autostart> read type instead.
		1872
		1873	If you want to design a protocol that works in the presence of TLS
		1874	dtection, make sure that any non-TLS data doesn't start with the octet 22
		1875	(ASCII SYN, 16 hex) or 128-255 (i.e. highest bit set). The checks this
		1876	read type does are a bit more strict, but might losen in the future to
		1877	accomodate protocol changes.
		1878
		1879	This read type does not rely on L<AnyEvent::TLS> (and thus, not on
		1880	L<Net::SSLeay>).
		1881
		1882	=item tls_autostart => $tls[, $tls_ctx]
		1883
		1884	Tries to detect a valid SSL or TLS handshake. If one is detected, it tries
		1885	to start tls by calling C<starttls> with the given arguments.
		1886
		1887	In practise, C<$tls> must be C<accept>, or a Net::SSLeay context that has
		1888	been configured to accept, as servers do not normally send a handshake on
		1889	their own and ths cannot be detected in this way.
		1890
		1891	See C<tls_detect> above for more details.
		1892
		1893	Example: give the client a chance to start TLS before accepting a text
		1894	line.
		1895
		1896	$hdl->push_read (tls_detect => "accept");
		1897	$hdl->push_read (line => sub {
		1898	print "received ", ($_[0]{tls} ? "encrypted" : "cleartext"), " <$_[1]>\n";
		1899	});
		1900
		1901	=cut
		1902
		1903	register_read_type tls_detect => sub {
		1904	my ($self, $cb) = @_;
		1905
		1906	sub {
		1907	# this regex matches a full or partial tls record
		1908	if (
		1909	# ssl3+: type(22=handshake) major(=3) minor(any) length_hi
		1910	$self->{rbuf} =~ /^(?:\z| \x16 (\z| [\x03\x04] (?:\z| . (?:\z| [\x00-\x40] ))))/xs
		1911	# ssl2 comapatible: len_hi len_lo type(1) major minor dummy(forlength)
		1912	or $self->{rbuf} =~ /^(?:\z| [\x80-\xff] (?:\z| . (?:\z| \x01 (\z| [\x03\x04] (?:\z| . (?:\z| . ))))))/xs
		1913	) {
		1914	return if 3 != length $1; # partial match, can't decide yet
		1915
		1916	# full match, valid TLS record
		1917	my ($major, $minor) = unpack "CC", $1;
		1918	$cb->($self, "accept", $major + $minor * 0.1);
		1919	} else {
		1920	# mismatch == guaranteed not TLS
		1921	$cb->($self, undef);
		1922	}
		1923
		1924	1
		1925	}
		1926	};
		1927
		1928	register_read_type tls_autostart => sub {
		1929	my ($self, @tls) = @_;
		1930
		1931	$RH{tls_detect}($self, sub {
		1932	return unless $_[1];
		1933	$_[0]->starttls (@tls);
		1934	})
		1935	};
		1936
1001	=back	1937	=back
1002		1938
1003	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)	1939	=item custom read types - Package::anyevent_read_type $handle, $cb, @args
1004		1940
1005	This function (not method) lets you add your own types to C<push_read>.	1941	Instead of one of the predefined types, you can also specify the name
		1942	of a package. AnyEvent will try to load the package and then expects to
		1943	find a function named C<anyevent_read_type> inside. If it isn't found, it
		1944	progressively tries to load the parent package until it either finds the
		1945	function (good) or runs out of packages (bad).
1006		1946
1007	Whenever the given C<type> is used, C<push_read> will invoke the code	1947	Whenever this type is used, C<push_read> will invoke the function with the
1008	reference with the handle object, the callback and the remaining	1948	handle object, the original callback and the remaining arguments.
1009	arguments.
1010		1949
1011	The code reference is supposed to return a callback (usually a closure)	1950	The function is supposed to return a callback (usually a closure) that
1012	that works as a plain read callback (see C<< ->push_read ($cb) >>).	1951	works as a plain read callback (see C<< ->push_read ($cb) >>), so you can
		1952	mentally treat the function as a "configurable read type to read callback"
		1953	converter.
1013		1954
1014	It should invoke the passed callback when it is done reading (remember to	1955	It should invoke the original callback when it is done reading (remember
1015	pass C<$handle> as first argument as all other callbacks do that).	1956	to pass C<$handle> as first argument as all other callbacks do that,
		1957	although there is no strict requirement on this).
1016		1958
1017	Note that this is a function, and all types registered this way will be
1018	global, so try to use unique names.
1019
1020	For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>,	1959	For examples, see the source of this module (F<perldoc -m
1021	search for C<register_read_type>)).	1960	AnyEvent::Handle>, search for C<register_read_type>)).
1022		1961
1023	=item $handle->stop_read	1962	=item $handle->stop_read
1024		1963
1025	=item $handle->start_read	1964	=item $handle->start_read
1026		1965
1027	In rare cases you actually do not want to read anything from the	1966	In rare cases you actually do not want to read anything from the
1028	socket. In this case you can call C<stop_read>. Neither C<on_read> no	1967	socket. In this case you can call C<stop_read>. Neither C<on_read> nor
1029	any queued callbacks will be executed then. To start reading again, call	1968	any queued callbacks will be executed then. To start reading again, call
1030	C<start_read>.	1969	C<start_read>.
1031		1970
		1971	Note that AnyEvent::Handle will automatically C<start_read> for you when
		1972	you change the C<on_read> callback or push/unshift a read callback, and it
		1973	will automatically C<stop_read> for you when neither C<on_read> is set nor
		1974	there are any read requests in the queue.
		1975
		1976	In older versions of this module (<= 5.3), these methods had no effect,
		1977	as TLS does not support half-duplex connections. In current versions they
		1978	work as expected, as this behaviour is required to avoid certain resource
		1979	attacks, where the program would be forced to read (and buffer) arbitrary
		1980	amounts of data before being able to send some data. The drawback is that
		1981	some readings of the the SSL/TLS specifications basically require this
		1982	attack to be working, as SSL/TLS implementations might stall sending data
		1983	during a rehandshake.
		1984
		1985	As a guideline, during the initial handshake, you should not stop reading,
		1986	and as a client, it might cause problems, depending on your application.
		1987
1032	=cut	1988	=cut
1033		1989
1034	sub stop_read {	1990	sub stop_read {
1035	my ($self) = @_;	1991	my ($self) = @_;
1036		1992
…		…
1038	}	1994	}
1039		1995
1040	sub start_read {	1996	sub start_read {
1041	my ($self) = @_;	1997	my ($self) = @_;
1042		1998
1043	unless ($self->{_rw} || $self->{_eof}) {	1999	unless ($self->{_rw} || $self->{_eof} || !$self->{fh}) {
1044	Scalar::Util::weaken $self;	2000	Scalar::Util::weaken $self;
1045		2001
1046	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	2002	$self->{_rw} = AE::io $self->{fh}, 0, sub {
1047	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	2003	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1048	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf;	2004	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size}, length $$rbuf;
1049		2005
1050	if ($len > 0) {	2006	if ($len > 0) {
1051	$self->{_activity} = AnyEvent->now;	2007	$self->{_activity} = $self->{_ractivity} = AE::now;
1052		2008
1053	$self->{filter_r}	2009	if ($self->{tls}) {
1054	? $self->{filter_r}($self, $rbuf)	2010	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
		2011
		2012	&_dotls ($self);
		2013	} else {
1055	: $self->_drain_rbuf;	2014	$self->_drain_rbuf;
		2015	}
		2016
		2017	if ($len == $self->{read_size}) {
		2018	$self->{read_size} *= 2;
		2019	$self->{read_size} = $self->{max_read_size} || MAX_READ_SIZE
		2020	if $self->{read_size} > ($self->{max_read_size} || MAX_READ_SIZE);
		2021	}
1056		2022
1057	} elsif (defined $len) {	2023	} elsif (defined $len) {
1058	delete $self->{_rw};	2024	delete $self->{_rw};
1059	$self->{_eof} = 1;	2025	$self->{_eof} = 1;
1060	$self->_drain_rbuf;	2026	$self->_drain_rbuf;
1061		2027
1062	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	2028	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1063	return $self->_error ($!, 1);	2029	return $self->_error ($!, 1);
1064	}	2030	}
1065	});	2031	};
1066	}	2032	}
1067	}	2033	}
1068		2034
		2035	our $ERROR_SYSCALL;
		2036	our $ERROR_WANT_READ;
		2037
		2038	sub _tls_error {
		2039	my ($self, $err) = @_;
		2040
		2041	return $self->_error ($!, 1)
		2042	if $err == Net::SSLeay::ERROR_SYSCALL ();
		2043
		2044	my $err = Net::SSLeay::ERR_error_string (Net::SSLeay::ERR_get_error ());
		2045
		2046	# reduce error string to look less scary
		2047	$err =~ s/^error:[0-9a-fA-F]{8}:[^:]+:([^:]+):/\L$1: /;
		2048
		2049	if ($self->{_on_starttls}) {
		2050	(delete $self->{_on_starttls})->($self, undef, $err);
		2051	&_freetls;
		2052	} else {
		2053	&_freetls;
		2054	$self->_error (Errno::EPROTO, 1, $err);
		2055	}
		2056	}
		2057
		2058	# poll the write BIO and send the data if applicable
		2059	# also decode read data if possible
		2060	# this is basiclaly our TLS state machine
		2061	# more efficient implementations are possible with openssl,
		2062	# but not with the buggy and incomplete Net::SSLeay.
1069	sub _dotls {	2063	sub _dotls {
1070	my ($self) = @_;	2064	my ($self) = @_;
1071		2065
		2066	my $tmp;
		2067
1072	if (length $self->{_tls_wbuf}) {	2068	if (length $self->{_tls_wbuf}) {
1073	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	2069	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1074	substr $self->{_tls_wbuf}, 0, $len, "";	2070	substr $self->{_tls_wbuf}, 0, $tmp, "";
1075	}	2071	}
1076	}
1077		2072
		2073	$tmp = Net::SSLeay::get_error ($self->{tls}, $tmp);
		2074	return $self->_tls_error ($tmp)
		2075	if $tmp != $ERROR_WANT_READ
		2076	&& ($tmp != $ERROR_SYSCALL || $!);
		2077	}
		2078
		2079	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
		2080	unless (length $tmp) {
		2081	$self->{_on_starttls}
		2082	and (delete $self->{_on_starttls})->($self, undef, "EOF during handshake"); # ???
		2083	&_freetls;
		2084
		2085	if ($self->{on_stoptls}) {
		2086	$self->{on_stoptls}($self);
		2087	return;
		2088	} else {
		2089	# let's treat SSL-eof as we treat normal EOF
		2090	delete $self->{_rw};
		2091	$self->{_eof} = 1;
		2092	}
		2093	}
		2094
		2095	$self->{_tls_rbuf} .= $tmp;
		2096	$self->_drain_rbuf;
		2097	$self->{tls} or return; # tls session might have gone away in callback
		2098	}
		2099
		2100	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
		2101	return $self->_tls_error ($tmp)
		2102	if $tmp != $ERROR_WANT_READ
		2103	&& ($tmp != $ERROR_SYSCALL || $!);
		2104
1078	if (defined (my $buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {	2105	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1079	$self->{wbuf} .= $buf;	2106	$self->{wbuf} .= $tmp;
1080	$self->_drain_wbuf;	2107	$self->_drain_wbuf;
		2108	$self->{tls} or return; # tls session might have gone away in callback
1081	}	2109	}
1082		2110
1083	while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) {	2111	$self->{_on_starttls}
1084	$self->{rbuf} .= $buf;	2112	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
1085	$self->_drain_rbuf;	2113	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");
1086	}
1087
1088	my $err = Net::SSLeay::get_error ($self->{tls}, -1);
1089
1090	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
1091	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {
1092	return $self->_error ($!, 1);
1093	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {
1094	return $self->_error (&Errno::EIO, 1);
1095	}
1096
1097	# all others are fine for our purposes
1098	}
1099	}	2114	}
1100		2115
1101	=item $handle->starttls ($tls[, $tls_ctx])	2116	=item $handle->starttls ($tls[, $tls_ctx])
1102		2117
1103	Instead of starting TLS negotiation immediately when the AnyEvent::Handle	2118	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
1104	object is created, you can also do that at a later time by calling	2119	object is created, you can also do that at a later time by calling
1105	C<starttls>.	2120	C<starttls>. See the C<tls> constructor argument for general info.
		2121
		2122	Starting TLS is currently an asynchronous operation - when you push some
		2123	write data and then call C<< ->starttls >> then TLS negotiation will start
		2124	immediately, after which the queued write data is then sent. This might
		2125	change in future versions, so best make sure you have no outstanding write
		2126	data when calling this method.
1106		2127
1107	The first argument is the same as the C<tls> constructor argument (either	2128	The first argument is the same as the C<tls> constructor argument (either
1108	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	2129	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
1109		2130
1110	The second argument is the optional C<Net::SSLeay::CTX> object that is	2131	The second argument is the optional C<AnyEvent::TLS> object that is used
1111	used when AnyEvent::Handle has to create its own TLS connection object.	2132	when AnyEvent::Handle has to create its own TLS connection object, or
		2133	a hash reference with C<< key => value >> pairs that will be used to
		2134	construct a new context.
1112		2135
1113	The TLS connection object will end up in C<< $handle->{tls} >> after this	2136	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS
1114	call and can be used or changed to your liking. Note that the handshake	2137	context in C<< $handle->{tls_ctx} >> after this call and can be used or
1115	might have already started when this function returns.	2138	changed to your liking. Note that the handshake might have already started
		2139	when this function returns.
1116		2140
		2141	Due to bugs in OpenSSL, it might or might not be possible to do multiple
		2142	handshakes on the same stream. It is best to not attempt to use the
		2143	stream after stopping TLS.
		2144
		2145	This method may invoke callbacks (and therefore the handle might be
		2146	destroyed after it returns).
		2147
1117	=cut	2148	=cut
		2149
		2150	our %TLS_CACHE; #TODO not yet documented, should we?
1118		2151
1119	sub starttls {	2152	sub starttls {
1120	my ($self, $ssl, $ctx) = @_;	2153	my ($self, $tls, $ctx) = @_;
1121		2154
1122	$self->stoptls;	2155	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"
		2156	if $self->{tls};
1123		2157
1124	if ($ssl eq "accept") {	2158	unless (defined $AnyEvent::TLS::VERSION) {
1125	$ssl = Net::SSLeay::new ($ctx || TLS_CTX ());	2159	eval {
1126	Net::SSLeay::set_accept_state ($ssl);	2160	require Net::SSLeay;
1127	} elsif ($ssl eq "connect") {	2161	require AnyEvent::TLS;
1128	$ssl = Net::SSLeay::new ($ctx || TLS_CTX ());	2162	1
1129	Net::SSLeay::set_connect_state ($ssl);	2163	} or return $self->_error (Errno::EPROTO, 1, "TLS support not available on this system");
		2164	}
		2165
		2166	$self->{tls} = $tls;
		2167	$self->{tls_ctx} = $ctx if @_ > 2;
		2168
		2169	return unless $self->{fh};
		2170
		2171	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
		2172	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
		2173
		2174	$tls = delete $self->{tls};
		2175	$ctx = $self->{tls_ctx};
		2176
		2177	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
		2178
		2179	if ("HASH" eq ref $ctx) {
		2180	if ($ctx->{cache}) {
		2181	my $key = $ctx+0;
		2182	$ctx = $TLS_CACHE{$key} ||= new AnyEvent::TLS %$ctx;
		2183	} else {
		2184	$ctx = new AnyEvent::TLS %$ctx;
		2185	}
		2186	}
1130	}	2187
1131		2188	$self->{tls_ctx} = $ctx || TLS_CTX ();
1132	$self->{tls} = $ssl;	2189	$self->{tls} = $tls = $self->{tls_ctx}->_get_session ($tls, $self, $self->{peername});
1133		2190
1134	# basically, this is deep magic (because SSL_read should have the same issues)	2191	# basically, this is deep magic (because SSL_read should have the same issues)
1135	# but the openssl maintainers basically said: "trust us, it just works".	2192	# but the openssl maintainers basically said: "trust us, it just works".
1136	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	2193	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1137	# and mismaintained ssleay-module doesn't even offer them).	2194	# and mismaintained ssleay-module doesn't even offer them).
1138	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html	2195	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
		2196	#
		2197	# in short: this is a mess.
		2198	#
		2199	# note that we do not try to keep the length constant between writes as we are required to do.
		2200	# we assume that most (but not all) of this insanity only applies to non-blocking cases,
		2201	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
		2202	# have identity issues in that area.
1139	Net::SSLeay::CTX_set_mode ($self->{tls},	2203	# Net::SSLeay::CTX_set_mode ($ssl,
1140	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)	2204	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)
1141	| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));	2205	# | (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));
		2206	Net::SSLeay::CTX_set_mode ($tls, 1|2);
1142		2207
1143	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	2208	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1144	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	2209	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1145		2210
		2211	Net::SSLeay::BIO_write ($self->{_rbio}, $self->{rbuf});
		2212	$self->{rbuf} = "";
		2213
1146	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	2214	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
1147		2215
1148	$self->{filter_w} = sub {	2216	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1149	$_[0]{_tls_wbuf} .= ${$_[1]};	2217	if $self->{on_starttls};
1150	&_dotls;	2218
1151	};	2219	&_dotls; # need to trigger the initial handshake
1152	$self->{filter_r} = sub {	2220	$self->start_read; # make sure we actually do read
1153	Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});
1154	&_dotls;
1155	};
1156	}	2221	}
1157		2222
1158	=item $handle->stoptls	2223	=item $handle->stoptls
1159		2224
1160	Destroys the SSL connection, if any. Partial read or write data will be	2225	Shuts down the SSL connection - this makes a proper EOF handshake by
1161	lost.	2226	sending a close notify to the other side, but since OpenSSL doesn't
		2227	support non-blocking shut downs, it is not guaranteed that you can re-use
		2228	the stream afterwards.
		2229
		2230	This method may invoke callbacks (and therefore the handle might be
		2231	destroyed after it returns).
1162		2232
1163	=cut	2233	=cut
1164		2234
1165	sub stoptls {	2235	sub stoptls {
1166	my ($self) = @_;	2236	my ($self) = @_;
1167		2237
1168	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};	2238	if ($self->{tls} && $self->{fh}) {
		2239	Net::SSLeay::shutdown ($self->{tls});
1169		2240
1170	delete $self->{_rbio};	2241	&_dotls;
1171	delete $self->{_wbio};	2242
1172	delete $self->{_tls_wbuf};	2243	# # we don't give a shit. no, we do, but we can't. no...#d#
1173	delete $self->{filter_r};	2244	# # we, we... have to use openssl :/#d#
1174	delete $self->{filter_w};	2245	# &_freetls;#d#
		2246	}
1175	}	2247	}
		2248
		2249	sub _freetls {
		2250	my ($self) = @_;
		2251
		2252	return unless $self->{tls};
		2253
		2254	$self->{tls_ctx}->_put_session (delete $self->{tls})
		2255	if $self->{tls} > 0;
		2256
		2257	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
		2258	}
		2259
		2260	=item $handle->resettls
		2261
		2262	This rarely-used method simply resets and TLS state on the handle, usually
		2263	causing data loss.
		2264
		2265	One case where it may be useful is when you want to skip over the data in
		2266	the stream but you are not interested in interpreting it, so data loss is
		2267	no concern.
		2268
		2269	=cut
		2270
		2271	*resettls = \&_freetls;
1176		2272
1177	sub DESTROY {	2273	sub DESTROY {
1178	my $self = shift;	2274	my ($self) = @_;
1179		2275
1180	$self->stoptls;	2276	&_freetls;
		2277
		2278	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
		2279
		2280	if ($linger && length $self->{wbuf} && $self->{fh}) {
		2281	my $fh = delete $self->{fh};
		2282	my $wbuf = delete $self->{wbuf};
		2283
		2284	my @linger;
		2285
		2286	push @linger, AE::io $fh, 1, sub {
		2287	my $len = syswrite $fh, $wbuf, length $wbuf;
		2288
		2289	if ($len > 0) {
		2290	substr $wbuf, 0, $len, "";
		2291	} elsif (defined $len || ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK)) {
		2292	@linger = (); # end
		2293	}
		2294	};
		2295	push @linger, AE::timer $linger, 0, sub {
		2296	@linger = ();
		2297	};
		2298	}
1181	}	2299	}
		2300
		2301	=item $handle->destroy
		2302
		2303	Shuts down the handle object as much as possible - this call ensures that
		2304	no further callbacks will be invoked and as many resources as possible
		2305	will be freed. Any method you will call on the handle object after
		2306	destroying it in this way will be silently ignored (and it will return the
		2307	empty list).
		2308
		2309	Normally, you can just "forget" any references to an AnyEvent::Handle
		2310	object and it will simply shut down. This works in fatal error and EOF
		2311	callbacks, as well as code outside. It does I<NOT> work in a read or write
		2312	callback, so when you want to destroy the AnyEvent::Handle object from
		2313	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
		2314	that case.
		2315
		2316	Destroying the handle object in this way has the advantage that callbacks
		2317	will be removed as well, so if those are the only reference holders (as
		2318	is common), then one doesn't need to do anything special to break any
		2319	reference cycles.
		2320
		2321	The handle might still linger in the background and write out remaining
		2322	data, as specified by the C<linger> option, however.
		2323
		2324	=cut
		2325
		2326	sub destroy {
		2327	my ($self) = @_;
		2328
		2329	$self->DESTROY;
		2330	%$self = ();
		2331	bless $self, "AnyEvent::Handle::destroyed";
		2332	}
		2333
		2334	sub AnyEvent::Handle::destroyed::AUTOLOAD {
		2335	#nop
		2336	}
		2337
		2338	=item $handle->destroyed
		2339
		2340	Returns false as long as the handle hasn't been destroyed by a call to C<<
		2341	->destroy >>, true otherwise.
		2342
		2343	Can be useful to decide whether the handle is still valid after some
		2344	callback possibly destroyed the handle. For example, C<< ->push_write >>,
		2345	C<< ->starttls >> and other methods can call user callbacks, which in turn
		2346	can destroy the handle, so work can be avoided by checking sometimes:
		2347
		2348	$hdl->starttls ("accept");
		2349	return if $hdl->destroyed;
		2350	$hdl->push_write (...
		2351
		2352	Note that the call to C<push_write> will silently be ignored if the handle
		2353	has been destroyed, so often you can just ignore the possibility of the
		2354	handle being destroyed.
		2355
		2356	=cut
		2357
		2358	sub destroyed { 0 }
		2359	sub AnyEvent::Handle::destroyed::destroyed { 1 }
1182		2360
1183	=item AnyEvent::Handle::TLS_CTX	2361	=item AnyEvent::Handle::TLS_CTX
1184		2362
1185	This function creates and returns the Net::SSLeay::CTX object used by	2363	This function creates and returns the AnyEvent::TLS object used by default
1186	default for TLS mode.	2364	for TLS mode.
1187		2365
1188	The context is created like this:	2366	The context is created by calling L<AnyEvent::TLS> without any arguments.
1189
1190	Net::SSLeay::load_error_strings;
1191	Net::SSLeay::SSLeay_add_ssl_algorithms;
1192	Net::SSLeay::randomize;
1193
1194	my $CTX = Net::SSLeay::CTX_new;
1195
1196	Net::SSLeay::CTX_set_options $CTX, Net::SSLeay::OP_ALL
1197		2367
1198	=cut	2368	=cut
1199		2369
1200	our $TLS_CTX;	2370	our $TLS_CTX;
1201		2371
1202	sub TLS_CTX() {	2372	sub TLS_CTX() {
1203	$TLS_CTX || do {	2373	$TLS_CTX ||= do {
1204	require Net::SSLeay;	2374	require AnyEvent::TLS;
1205		2375
1206	Net::SSLeay::load_error_strings ();	2376	new AnyEvent::TLS
1207	Net::SSLeay::SSLeay_add_ssl_algorithms ();	2377	}
1208	Net::SSLeay::randomize ();	2378	}
1209		2379
1210	$TLS_CTX = Net::SSLeay::CTX_new ();	2380	=back
1211		2381
1212	Net::SSLeay::CTX_set_options ($TLS_CTX, Net::SSLeay::OP_ALL ());
1213		2382
1214	$TLS_CTX	2383	=head1 NONFREQUENTLY ASKED QUESTIONS
		2384
		2385	=over 4
		2386
		2387	=item I C<undef> the AnyEvent::Handle reference inside my callback and
		2388	still get further invocations!
		2389
		2390	That's because AnyEvent::Handle keeps a reference to itself when handling
		2391	read or write callbacks.
		2392
		2393	It is only safe to "forget" the reference inside EOF or error callbacks,
		2394	from within all other callbacks, you need to explicitly call the C<<
		2395	->destroy >> method.
		2396
		2397	=item Why is my C<on_eof> callback never called?
		2398
		2399	Probably because your C<on_error> callback is being called instead: When
		2400	you have outstanding requests in your read queue, then an EOF is
		2401	considered an error as you clearly expected some data.
		2402
		2403	To avoid this, make sure you have an empty read queue whenever your handle
		2404	is supposed to be "idle" (i.e. connection closes are O.K.). You can set
		2405	an C<on_read> handler that simply pushes the first read requests in the
		2406	queue.
		2407
		2408	See also the next question, which explains this in a bit more detail.
		2409
		2410	=item How can I serve requests in a loop?
		2411
		2412	Most protocols consist of some setup phase (authentication for example)
		2413	followed by a request handling phase, where the server waits for requests
		2414	and handles them, in a loop.
		2415
		2416	There are two important variants: The first (traditional, better) variant
		2417	handles requests until the server gets some QUIT command, causing it to
		2418	close the connection first (highly desirable for a busy TCP server). A
		2419	client dropping the connection is an error, which means this variant can
		2420	detect an unexpected detection close.
		2421
		2422	To handle this case, always make sure you have a non-empty read queue, by
		2423	pushing the "read request start" handler on it:
		2424
		2425	# we assume a request starts with a single line
		2426	my @start_request; @start_request = (line => sub {
		2427	my ($hdl, $line) = @_;
		2428
		2429	... handle request
		2430
		2431	# push next request read, possibly from a nested callback
		2432	$hdl->push_read (@start_request);
		2433	});
		2434
		2435	# auth done, now go into request handling loop
		2436	# now push the first @start_request
		2437	$hdl->push_read (@start_request);
		2438
		2439	By always having an outstanding C<push_read>, the handle always expects
		2440	some data and raises the C<EPIPE> error when the connction is dropped
		2441	unexpectedly.
		2442
		2443	The second variant is a protocol where the client can drop the connection
		2444	at any time. For TCP, this means that the server machine may run out of
		2445	sockets easier, and in general, it means you cannot distinguish a protocl
		2446	failure/client crash from a normal connection close. Nevertheless, these
		2447	kinds of protocols are common (and sometimes even the best solution to the
		2448	problem).
		2449
		2450	Having an outstanding read request at all times is possible if you ignore
		2451	C<EPIPE> errors, but this doesn't help with when the client drops the
		2452	connection during a request, which would still be an error.
		2453
		2454	A better solution is to push the initial request read in an C<on_read>
		2455	callback. This avoids an error, as when the server doesn't expect data
		2456	(i.e. is idly waiting for the next request, an EOF will not raise an
		2457	error, but simply result in an C<on_eof> callback. It is also a bit slower
		2458	and simpler:
		2459
		2460	# auth done, now go into request handling loop
		2461	$hdl->on_read (sub {
		2462	my ($hdl) = @_;
		2463
		2464	# called each time we receive data but the read queue is empty
		2465	# simply start read the request
		2466
		2467	$hdl->push_read (line => sub {
		2468	my ($hdl, $line) = @_;
		2469
		2470	... handle request
		2471
		2472	# do nothing special when the request has been handled, just
		2473	# let the request queue go empty.
		2474	});
		2475	});
		2476
		2477	=item I get different callback invocations in TLS mode/Why can't I pause
		2478	reading?
		2479
		2480	Unlike, say, TCP, TLS connections do not consist of two independent
		2481	communication channels, one for each direction. Or put differently, the
		2482	read and write directions are not independent of each other: you cannot
		2483	write data unless you are also prepared to read, and vice versa.
		2484
		2485	This means that, in TLS mode, you might get C<on_error> or C<on_eof>
		2486	callback invocations when you are not expecting any read data - the reason
		2487	is that AnyEvent::Handle always reads in TLS mode.
		2488
		2489	During the connection, you have to make sure that you always have a
		2490	non-empty read-queue, or an C<on_read> watcher. At the end of the
		2491	connection (or when you no longer want to use it) you can call the
		2492	C<destroy> method.
		2493
		2494	=item How do I read data until the other side closes the connection?
		2495
		2496	If you just want to read your data into a perl scalar, the easiest way
		2497	to achieve this is by setting an C<on_read> callback that does nothing,
		2498	clearing the C<on_eof> callback and in the C<on_error> callback, the data
		2499	will be in C<$_[0]{rbuf}>:
		2500
		2501	$handle->on_read (sub { });
		2502	$handle->on_eof (undef);
		2503	$handle->on_error (sub {
		2504	my $data = delete $_[0]{rbuf};
		2505	});
		2506
		2507	Note that this example removes the C<rbuf> member from the handle object,
		2508	which is not normally allowed by the API. It is expressly permitted in
		2509	this case only, as the handle object needs to be destroyed afterwards.
		2510
		2511	The reason to use C<on_error> is that TCP connections, due to latencies
		2512	and packets loss, might get closed quite violently with an error, when in
		2513	fact all data has been received.
		2514
		2515	It is usually better to use acknowledgements when transferring data,
		2516	to make sure the other side hasn't just died and you got the data
		2517	intact. This is also one reason why so many internet protocols have an
		2518	explicit QUIT command.
		2519
		2520	=item I don't want to destroy the handle too early - how do I wait until
		2521	all data has been written?
		2522
		2523	After writing your last bits of data, set the C<on_drain> callback
		2524	and destroy the handle in there - with the default setting of
		2525	C<low_water_mark> this will be called precisely when all data has been
		2526	written to the socket:
		2527
		2528	$handle->push_write (...);
		2529	$handle->on_drain (sub {
		2530	AE::log debug => "All data submitted to the kernel.";
		2531	undef $handle;
		2532	});
		2533
		2534	If you just want to queue some data and then signal EOF to the other side,
		2535	consider using C<< ->push_shutdown >> instead.
		2536
		2537	=item I want to contact a TLS/SSL server, I don't care about security.
		2538
		2539	If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS,
		2540	connect to it and then create the AnyEvent::Handle with the C<tls>
		2541	parameter:
		2542
		2543	tcp_connect $host, $port, sub {
		2544	my ($fh) = @_;
		2545
		2546	my $handle = new AnyEvent::Handle
		2547	fh => $fh,
		2548	tls => "connect",
		2549	on_error => sub { ... };
		2550
		2551	$handle->push_write (...);
1215	}	2552	};
1216	}	2553
		2554	=item I want to contact a TLS/SSL server, I do care about security.
		2555
		2556	Then you should additionally enable certificate verification, including
		2557	peername verification, if the protocol you use supports it (see
		2558	L<AnyEvent::TLS>, C<verify_peername>).
		2559
		2560	E.g. for HTTPS:
		2561
		2562	tcp_connect $host, $port, sub {
		2563	my ($fh) = @_;
		2564
		2565	my $handle = new AnyEvent::Handle
		2566	fh => $fh,
		2567	peername => $host,
		2568	tls => "connect",
		2569	tls_ctx => { verify => 1, verify_peername => "https" },
		2570	...
		2571
		2572	Note that you must specify the hostname you connected to (or whatever
		2573	"peername" the protocol needs) as the C<peername> argument, otherwise no
		2574	peername verification will be done.
		2575
		2576	The above will use the system-dependent default set of trusted CA
		2577	certificates. If you want to check against a specific CA, add the
		2578	C<ca_file> (or C<ca_cert>) arguments to C<tls_ctx>:
		2579
		2580	tls_ctx => {
		2581	verify => 1,
		2582	verify_peername => "https",
		2583	ca_file => "my-ca-cert.pem",
		2584	},
		2585
		2586	=item I want to create a TLS/SSL server, how do I do that?
		2587
		2588	Well, you first need to get a server certificate and key. You have
		2589	three options: a) ask a CA (buy one, use cacert.org etc.) b) create a
		2590	self-signed certificate (cheap. check the search engine of your choice,
		2591	there are many tutorials on the net) or c) make your own CA (tinyca2 is a
		2592	nice program for that purpose).
		2593
		2594	Then create a file with your private key (in PEM format, see
		2595	L<AnyEvent::TLS>), followed by the certificate (also in PEM format). The
		2596	file should then look like this:
		2597
		2598	-----BEGIN RSA PRIVATE KEY-----
		2599	...header data
		2600	... lots of base64'y-stuff
		2601	-----END RSA PRIVATE KEY-----
		2602
		2603	-----BEGIN CERTIFICATE-----
		2604	... lots of base64'y-stuff
		2605	-----END CERTIFICATE-----
		2606
		2607	The important bits are the "PRIVATE KEY" and "CERTIFICATE" parts. Then
		2608	specify this file as C<cert_file>:
		2609
		2610	tcp_server undef, $port, sub {
		2611	my ($fh) = @_;
		2612
		2613	my $handle = new AnyEvent::Handle
		2614	fh => $fh,
		2615	tls => "accept",
		2616	tls_ctx => { cert_file => "my-server-keycert.pem" },
		2617	...
		2618
		2619	When you have intermediate CA certificates that your clients might not
		2620	know about, just append them to the C<cert_file>.
1217		2621
1218	=back	2622	=back
1219		2623
1220	=head1 SUBCLASSING AnyEvent::Handle	2624	=head1 SUBCLASSING AnyEvent::Handle
1221		2625
…		…
1227	=over 4	2631	=over 4
1228		2632
1229	=item * all constructor arguments become object members.	2633	=item * all constructor arguments become object members.
1230		2634
1231	At least initially, when you pass a C<tls>-argument to the constructor it	2635	At least initially, when you pass a C<tls>-argument to the constructor it
1232	will end up in C<< $handle->{tls} >>. Those members might be changes or	2636	will end up in C<< $handle->{tls} >>. Those members might be changed or
1233	mutated later on (for example C<tls> will hold the TLS connection object).	2637	mutated later on (for example C<tls> will hold the TLS connection object).
1234		2638
1235	=item * other object member names are prefixed with an C<_>.	2639	=item * other object member names are prefixed with an C<_>.
1236		2640
1237	All object members not explicitly documented (internal use) are prefixed	2641	All object members not explicitly documented (internal use) are prefixed
…		…
1240		2644
1241	=item * all members not documented here and not prefixed with an underscore	2645	=item * all members not documented here and not prefixed with an underscore
1242	are free to use in subclasses.	2646	are free to use in subclasses.
1243		2647
1244	Of course, new versions of AnyEvent::Handle may introduce more "public"	2648	Of course, new versions of AnyEvent::Handle may introduce more "public"
1245	member variables, but thats just life, at least it is documented.	2649	member variables, but that's just life. At least it is documented.
1246		2650
1247	=back	2651	=back
1248		2652
1249	=head1 AUTHOR	2653	=head1 AUTHOR
1250		2654
1251	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.	2655	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.
1252		2656
1253	=cut	2657	=cut
1254		2658
1255	1; # End of AnyEvent::Handle	2659	1
		2660

Diff Legend

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