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.92 by root, Wed Oct 1 08:52:06 2008 UTC vs.
Revision 1.198 by root, Tue Aug 31 01:03:37 2010 UTC

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

Diff Legend

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