[ViewVC] Diff of: cvs/AnyEvent/lib/AnyEvent/Handle.pm

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.159 by root, Fri Jul 24 12:35:58 2009 UTC vs.
Revision 1.198 by root, Tue Aug 31 01:03:37 2010 UTC

…		…
1	package AnyEvent::Handle;
2
3	use Scalar::Util ();
4	use Carp ();
5	use Errno qw(EAGAIN EINTR);
6
7	use AnyEvent (); BEGIN { AnyEvent::common_sense }
8	use AnyEvent::Util qw(WSAEWOULDBLOCK);
9
10	=head1 NAME	1	=head1 NAME
11		2
12	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent	3	AnyEvent::Handle - non-blocking I/O on streaming handles via AnyEvent
13
14	=cut
15
16	our $VERSION = 4.86;
17		4
18	=head1 SYNOPSIS	5	=head1 SYNOPSIS
19		6
20	use AnyEvent;	7	use AnyEvent;
21	use AnyEvent::Handle;	8	use AnyEvent::Handle;
27	on_error => sub {	14	on_error => sub {
28	my ($hdl, $fatal, $msg) = @_;	15	my ($hdl, $fatal, $msg) = @_;
29	warn "got error $msg\n";	16	warn "got error $msg\n";
30	$hdl->destroy;	17	$hdl->destroy;
31	$cv->send;	18	$cv->send;
32	);	19	};
33		20
34	# send some request line	21	# send some request line
35	$hdl->push_write ("getinfo\015\012");	22	$hdl->push_write ("getinfo\015\012");
36		23
37	# read the response line	24	# read the response line
…		…
43		30
44	$cv->recv;	31	$cv->recv;
45		32
46	=head1 DESCRIPTION	33	=head1 DESCRIPTION
47		34
48	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
49	filehandles.	36	stream-based filehandles (sockets, pipes, and other stream things).
50		37
51	The L<AnyEvent::Intro> tutorial contains some well-documented	38	The L<AnyEvent::Intro> tutorial contains some well-documented
52	AnyEvent::Handle examples.	39	AnyEvent::Handle examples.
53		40
54	In the following, when the documentation refers to of "bytes" then this	41	In the following, where the documentation refers to "bytes", it means
55	means characters. As sysread and syswrite are used for all I/O, their	42	characters. As sysread and syswrite are used for all I/O, their
56	treatment of characters applies to this module as well.	43	treatment of characters applies to this module as well.
57		44
58	At the very minimum, you should specify C<fh> or C<connect>, and the	45	At the very minimum, you should specify C<fh> or C<connect>, and the
59	C<on_error> callback.	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
		51	=cut
		52
		53	package AnyEvent::Handle;
		54
		55	use Scalar::Util ();
		56	use List::Util ();
		57	use Carp ();
		58	use Errno qw(EAGAIN EINTR);
		59
		60	use AnyEvent (); BEGIN { AnyEvent::common_sense }
		61	use AnyEvent::Util qw(WSAEWOULDBLOCK);
		62
		63	our $VERSION = $AnyEvent::VERSION;
		64
		65	sub _load_func($) {
		66	my $func = $_[0];
		67
		68	unless (defined &$func) {
		69	my $pkg = $func;
		70	do {
		71	$pkg =~ s/::[^:]+$//
		72	or return;
		73	eval "require $pkg";
		74	} until defined &$func;
		75	}
		76
		77	\&$func
		78	}
		79
64	=head1 METHODS	80	=head1 METHODS
65		81
66	=over 4	82	=over 4
67		83
68	=item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value...	84	=item $handle = B<new> AnyEvent::Handle fh => $filehandle, key => value...
69		85
70	The constructor supports these arguments (all as C<< key => value >> pairs).	86	The constructor supports these arguments (all as C<< key => value >> pairs).
71		87
72	=over 4	88	=over 4
73		89
…		…
83	Try to connect to the specified host and service (port), using	99	Try to connect to the specified host and service (port), using
84	C<AnyEvent::Socket::tcp_connect>. The C<$host> additionally becomes the	100	C<AnyEvent::Socket::tcp_connect>. The C<$host> additionally becomes the
85	default C<peername>.	101	default C<peername>.
86		102
87	You have to specify either this parameter, or C<fh>, above.	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.
88		107
89	When this parameter is specified, then the C<on_prepare>,	108	When this parameter is specified, then the C<on_prepare>,
90	C<on_connect_error> and C<on_connect> callbacks will be called under the	109	C<on_connect_error> and C<on_connect> callbacks will be called under the
91	appropriate circumstances:	110	appropriate circumstances:
92		111
…		…
98	attempted, but after the file handle has been created. It could be used to	117	attempted, but after the file handle has been created. It could be used to
99	prepare the file handle with parameters required for the actual connect	118	prepare the file handle with parameters required for the actual connect
100	(as opposed to settings that can be changed when the connection is already	119	(as opposed to settings that can be changed when the connection is already
101	established).	120	established).
102		121
		122	The return value of this callback should be the connect timeout value in
		123	seconds (or C<0>, or C<undef>, or the empty list, to indicate that the
		124	default timeout is to be used).
		125
103	=item on_connect => $cb->($handle, $host, $port, $retry->())	126	=item on_connect => $cb->($handle, $host, $port, $retry->())
104		127
105	This callback is called when a connection has been successfully established.	128	This callback is called when a connection has been successfully established.
106		129
107	The actual numeric host and port (the socket peername) are passed as	130	The peer's numeric host and port (the socket peername) are passed as
108	parameters, together with a retry callback.	131	parameters, together with a retry callback.
109		132
110	When, for some reason, the handle is not acceptable, then calling	133	If, for some reason, the handle is not acceptable, calling C<$retry>
111	C<$retry> will continue with the next conenction target (in case of	134	will continue with the next connection target (in case of multi-homed
112	multi-homed hosts or SRV records there can be multiple connection	135	hosts or SRV records there can be multiple connection endpoints). At the
113	endpoints). When it is called then the read and write queues, eof status,	136	time it is called the read and write queues, eof status, tls status and
114	tls status and similar properties of the handle are being reset.	137	similar properties of the handle will have been reset.
115		138
116	In most cases, ignoring the C<$retry> parameter is the way to go.	139	In most cases, you should ignore the C<$retry> parameter.
117		140
118	=item on_connect_error => $cb->($handle, $message)	141	=item on_connect_error => $cb->($handle, $message)
119		142
120	This callback is called when the conenction could not be	143	This callback is called when the connection could not be
121	established. C<$!> will contain the relevant error code, and C<$message> a	144	established. C<$!> will contain the relevant error code, and C<$message> a
122	message describing it (usually the same as C<"$!">).	145	message describing it (usually the same as C<"$!">).
123		146
124	If this callback isn't specified, then C<on_error> will be called with a	147	If this callback isn't specified, then C<on_error> will be called with a
125	fatal error instead.	148	fatal error instead.
…		…
128		151
129	=item on_error => $cb->($handle, $fatal, $message)	152	=item on_error => $cb->($handle, $fatal, $message)
130		153
131	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
132	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
133	connect or a read error.	156	connect, or a read error.
134		157
135	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
136	fatal errors the handle object will be destroyed (by a call to C<< ->	159	fatal errors the handle object will be destroyed (by a call to C<< ->
137	destroy >>) after invoking the error callback (which means you are free to	160	destroy >>) after invoking the error callback (which means you are free to
138	examine the handle object). Examples of fatal errors are an EOF condition	161	examine the handle object). Examples of fatal errors are an EOF condition
139	with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors. In	162	with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors. In
140	cases where the other side can close the connection at their will it is	163	cases where the other side can close the connection at will, it is
141	often easiest to not report C<EPIPE> errors in this callback.	164	often easiest to not report C<EPIPE> errors in this callback.
142		165
143	AnyEvent::Handle tries to find an appropriate error code for you to check	166	AnyEvent::Handle tries to find an appropriate error code for you to check
144	against, but in some cases (TLS errors), this does not work well. It is	167	against, but in some cases (TLS errors), this does not work well. It is
145	recommended to always output the C<$message> argument in human-readable	168	recommended to always output the C<$message> argument in human-readable
146	error messages (it's usually the same as C<"$!">).	169	error messages (it's usually the same as C<"$!">).
147		170
148	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
149	to simply ignore this parameter and instead abondon the handle object	172	to simply ignore this parameter and instead abondon the handle object
150	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
151	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).	174	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
152		175
153	On callback entrance, the value of C<$!> contains the operating system	176	On entry to the callback, the value of C<$!> contains the operating
154	error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or	177	system error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
155	C<EPROTO>).	178	C<EPROTO>).
156		179
157	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
158	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
159	C<croak>.	182	C<croak>.
160		183
161	=item on_read => $cb->($handle)	184	=item on_read => $cb->($handle)
162		185
163	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
…		…
168	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 >>
169	method or access the C<< $handle->{rbuf} >> member directly. Note that you	192	method or access the C<< $handle->{rbuf} >> member directly. Note that you
170	must not enlarge or modify the read buffer, you can only remove data at	193	must not enlarge or modify the read buffer, you can only remove data at
171	the beginning from it.	194	the beginning from it.
172		195
		196	You can also call C<< ->push_read (...) >> or any other function that
		197	modifies the read queue. Or do both. Or ...
		198
173	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
174	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
175	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
176	error will be raised (with C<$!> set to C<EPIPE>).	202	error will be raised (with C<$!> set to C<EPIPE>).
177		203
178	Note that, unlike requests in the read queue, an C<on_read> callback	204	Note that, unlike requests in the read queue, an C<on_read> callback
…		…
197	set, then a fatal error will be raised with C<$!> set to <0>.	223	set, then a fatal error will be raised with C<$!> set to <0>.
198		224
199	=item on_drain => $cb->($handle)	225	=item on_drain => $cb->($handle)
200		226
201	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
202	(or when the callback is set and the buffer is empty already).	228	(or immediately if the buffer is empty already).
203		229
204	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.
205		231
206	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
207	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
…		…
209	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
210	the file when the write queue becomes empty.	236	the file when the write queue becomes empty.
211		237
212	=item timeout => $fractional_seconds	238	=item timeout => $fractional_seconds
213		239
		240	=item rtimeout => $fractional_seconds
		241
		242	=item wtimeout => $fractional_seconds
		243
214	If non-zero, then this enables an "inactivity" timeout: whenever this many	244	If non-zero, then these enables an "inactivity" timeout: whenever this
215	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
216	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
217	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).
218		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
219	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
220	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
221	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
222	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
223	restart the timeout.	260	restart the timeout.
224		261
225	Zero (the default) disables this timeout.	262	Zero (the default) disables this timeout.
226		263
…		…
242	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
243	isn't finished).	280	isn't finished).
244		281
245	=item autocork => <boolean>	282	=item autocork => <boolean>
246		283
247	When disabled (the default), then C<push_write> will try to immediately	284	When disabled (the default), C<push_write> will try to immediately
248	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
249	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
250	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
251	disadvantage is usually avoided by your kernel's nagle algorithm, see	288	disadvantage is usually avoided by your kernel's nagle algorithm, see
252	C<no_delay>, but this option can save costly syscalls).	289	C<no_delay>, but this option can save costly syscalls).
253		290
254	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
255	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,
256	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
257	the write buffer often is full). It also increases write latency.	294	the write buffer often is full). It also increases write latency.
258		295
259	=item no_delay => <boolean>	296	=item no_delay => <boolean>
…		…
263	the Nagle algorithm, and usually it is beneficial.	300	the Nagle algorithm, and usually it is beneficial.
264		301
265	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
266	accomplishd by setting this option to a true value.	303	accomplishd by setting this option to a true value.
267		304
268	The default is your opertaing system's default behaviour (most likely	305	The default is your operating system's default behaviour (most likely
269	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.
270		339
271	=item read_size => <bytes>	340	=item read_size => <bytes>
272		341
273	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
274	try to read during each loop iteration, which affects memory	343	try to read during each loop iteration, which affects memory
275	requirements). Default: C<8192>.	344	requirements). Default: C<8192>.
276		345
277	=item low_water_mark => <bytes>	346	=item low_water_mark => <bytes>
278		347
279	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
280	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
281	considered empty.	350	considered empty.
282		351
283	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
284	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
285	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
286	is good in almost all cases.	355	is good in almost all cases.
287		356
288	=item linger => <seconds>	357	=item linger => <seconds>
289		358
290	If non-zero (default: C<3600>), then the destructor of the	359	If this is non-zero (default: C<3600>), the destructor of the
291	AnyEvent::Handle object will check whether there is still outstanding	360	AnyEvent::Handle object will check whether there is still outstanding
292	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
293	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
294	system treats outstanding data at socket close time).	363	system treats outstanding data at socket close time).
295		364
…		…
302	A string used to identify the remote site - usually the DNS hostname	371	A string used to identify the remote site - usually the DNS hostname
303	(I<not> IDN!) used to create the connection, rarely the IP address.	372	(I<not> IDN!) used to create the connection, rarely the IP address.
304		373
305	Apart from being useful in error messages, this string is also used in TLS	374	Apart from being useful in error messages, this string is also used in TLS
306	peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This	375	peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This
307	verification will be skipped when C<peername> is not specified or	376	verification will be skipped when C<peername> is not specified or is
308	C<undef>.	377	C<undef>.
309		378
310	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	379	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
311		380
312	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
313	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
314	established and will transparently encrypt/decrypt data afterwards.	383	established and will transparently encrypt/decrypt data afterwards.
315		384
316	All TLS protocol errors will be signalled as C<EPROTO>, with an	385	All TLS protocol errors will be signalled as C<EPROTO>, with an
317	appropriate error message.	386	appropriate error message.
318		387
…		…
338	B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,	407	B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,
339	passing in the wrong integer will lead to certain crash. This most often	408	passing in the wrong integer will lead to certain crash. This most often
340	happens when one uses a stylish C<< tls => 1 >> and is surprised about the	409	happens when one uses a stylish C<< tls => 1 >> and is surprised about the
341	segmentation fault.	410	segmentation fault.
342		411
343	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.
344		413
345	=item tls_ctx => $anyevent_tls	414	=item tls_ctx => $anyevent_tls
346		415
347	Use the given C<AnyEvent::TLS> object to create the new TLS connection	416	Use the given C<AnyEvent::TLS> object to create the new TLS connection
348	(unless a connection object was specified directly). If this parameter is	417	(unless a connection object was specified directly). If this parameter is
…		…
363		432
364	TLS handshake failures will not cause C<on_error> to be invoked when this	433	TLS handshake failures will not cause C<on_error> to be invoked when this
365	callback is in effect, instead, the error message will be passed to C<on_starttls>.	434	callback is in effect, instead, the error message will be passed to C<on_starttls>.
366		435
367	Without this callback, handshake failures lead to C<on_error> being	436	Without this callback, handshake failures lead to C<on_error> being
368	called, as normal.	437	called as usual.
369		438
370	Note that you cannot call C<starttls> right again in this callback. If you	439	Note that you cannot just call C<starttls> again in this callback. If you
371	need to do that, start an zero-second timer instead whose callback can	440	need to do that, start an zero-second timer instead whose callback can
372	then call C<< ->starttls >> again.	441	then call C<< ->starttls >> again.
373		442
374	=item on_stoptls => $cb->($handle)	443	=item on_stoptls => $cb->($handle)
375		444
…		…
431	delete $self->{_skip_drain_rbuf};	500	delete $self->{_skip_drain_rbuf};
432	$self->_start;	501	$self->_start;
433		502
434	$self->{on_connect}	503	$self->{on_connect}
435	and $self->{on_connect}($self, $host, $port, sub {	504	and $self->{on_connect}($self, $host, $port, sub {
436	delete @$self{qw(fh _tw _ww _rw _eof _queue rbuf _wbuf tls _tls_rbuf _tls_wbuf)};	505	delete @$self{qw(fh _tw _rtw _wtw _ww _rw _eof _queue rbuf _wbuf tls _tls_rbuf _tls_wbuf)};
437	$self->{_skip_drain_rbuf} = 1;	506	$self->{_skip_drain_rbuf} = 1;
438	&$retry;	507	&$retry;
439	});	508	});
440		509
441	} else {	510	} else {
442	if ($self->{on_connect_error}) {	511	if ($self->{on_connect_error}) {
443	$self->{on_connect_error}($self, "$!");	512	$self->{on_connect_error}($self, "$!");
444	$self->destroy;	513	$self->destroy;
445	} else {	514	} else {
446	$self->fatal ($!, 1);	515	$self->_error ($!, 1);
447	}	516	}
448	}	517	}
449	},	518	},
450	sub {	519	sub {
451	local $self->{fh} = $_[0];	520	local $self->{fh} = $_[0];
452		521
		522	$self->{on_prepare}
453	$self->{on_prepare}->($self)	523	? $self->{on_prepare}->($self)
454	if $self->{on_prepare};	524	: ()
455	}	525	}
456	);	526	);
457	}	527	}
458		528
459	} else {	529	} else {
…		…
464	}	534	}
465		535
466	sub _start {	536	sub _start {
467	my ($self) = @_;	537	my ($self) = @_;
468		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;
		544
469	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	545	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
470		546
		547	$self->{_activity} =
		548	$self->{_ractivity} =
471	$self->{_activity} = AnyEvent->now;	549	$self->{_wactivity} = AE::now;
472	$self->_timeout;
473		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
474	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};	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};
475		557
		558	$self->oobinline (exists $self->{oobinline} ? delete $self->{oobinline} : 1);
		559
476	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})	560	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
477	if $self->{tls};	561	if $self->{tls};
478		562
479	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	563	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
480		564
481	$self->start_read	565	$self->start_read
482	if $self->{on_read} \|\| @{ $self->{_queue} };	566	if $self->{on_read} \|\| @{ $self->{_queue} };
483	}
484		567
485	#sub _shutdown {	568	$self->_drain_wbuf;
486	# my ($self) = @_;	569	}
487	#
488	# delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)};
489	# $self->{_eof} = 1; # tell starttls et. al to stop trying
490	#
491	# &_freetls;
492	#}
493		570
494	sub _error {	571	sub _error {
495	my ($self, $errno, $fatal, $message) = @_;	572	my ($self, $errno, $fatal, $message) = @_;
496		573
497	$! = $errno;	574	$! = $errno;
498	$message \|\|= "$!";	575	$message \|\|= "$!";
499		576
500	if ($self->{on_error}) {	577	if ($self->{on_error}) {
501	$self->{on_error}($self, $fatal, $message);	578	$self->{on_error}($self, $fatal, $message);
502	$self->destroy if $fatal;	579	$self->destroy if $fatal;
503	} elsif ($self->{fh}) {	580	} elsif ($self->{fh} \|\| $self->{connect}) {
504	$self->destroy;	581	$self->destroy;
505	Carp::croak "AnyEvent::Handle uncaught error: $message";	582	Carp::croak "AnyEvent::Handle uncaught error: $message";
506	}	583	}
507	}	584	}
508		585
…		…
534	$_[0]{on_eof} = $_[1];	611	$_[0]{on_eof} = $_[1];
535	}	612	}
536		613
537	=item $handle->on_timeout ($cb)	614	=item $handle->on_timeout ($cb)
538		615
539	Replace the current C<on_timeout> callback, or disables the callback (but	616	=item $handle->on_rtimeout ($cb)
540	not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
541	argument and method.
542		617
543	=cut	618	=item $handle->on_wtimeout ($cb)
544		619
545	sub on_timeout {	620	Replace the current C<on_timeout>, C<on_rtimeout> or C<on_wtimeout>
546	$_[0]{on_timeout} = $_[1];	621	callback, or disables the callback (but not the timeout) if C<$cb> =
547	}	622	C<undef>. See the C<timeout> constructor argument and method.
		623
		624	=cut
		625
		626	# see below
548		627
549	=item $handle->autocork ($boolean)	628	=item $handle->autocork ($boolean)
550		629
551	Enables or disables the current autocork behaviour (see C<autocork>	630	Enables or disables the current autocork behaviour (see C<autocork>
552	constructor argument). Changes will only take effect on the next write.	631	constructor argument). Changes will only take effect on the next write.
…		…
567	sub no_delay {	646	sub no_delay {
568	$_[0]{no_delay} = $_[1];	647	$_[0]{no_delay} = $_[1];
569		648
570	eval {	649	eval {
571	local $SIG{__DIE__};	650	local $SIG{__DIE__};
572	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1]	651	setsockopt $_[0]{fh}, Socket::IPPROTO_TCP (), Socket::TCP_NODELAY (), int $_[1]
573	if $_[0]{fh};	652	if $_[0]{fh};
574	};	653	};
575	}	654	}
576		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
577	=item $handle->on_starttls ($cb)	707	=item $handle->on_starttls ($cb)
578		708
579	Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument).	709	Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument).
580		710
581	=cut	711	=cut
…		…
588		718
589	Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).	719	Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).
590		720
591	=cut	721	=cut
592		722
593	sub on_starttls {	723	sub on_stoptls {
594	$_[0]{on_stoptls} = $_[1];	724	$_[0]{on_stoptls} = $_[1];
595	}	725	}
596		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
597	#############################################################################	737	#############################################################################
598		738
599	=item $handle->timeout ($seconds)	739	=item $handle->timeout ($seconds)
600		740
		741	=item $handle->rtimeout ($seconds)
		742
		743	=item $handle->wtimeout ($seconds)
		744
601	Configures (or disables) the inactivity timeout.	745	Configures (or disables) the inactivity timeout.
602		746
603	=cut	747	=item $handle->timeout_reset
604		748
605	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 {
606	my ($self, $timeout) = @_;	771	my ($self, $new_value) = @_;
607		772
608	$self->{timeout} = $timeout;	773	$self->{$timeout} = $new_value;
609	$self->_timeout;	774	delete $self->{$tw}; &$cb;
610	}	775	};
611		776
		777	*{"${dir}timeout_reset"} = sub {
		778	$_[0]{$activity} = AE::now;
		779	};
		780
		781	# main workhorse:
612	# reset the timeout watcher, as neccessary	782	# reset the timeout watcher, as neccessary
613	# also check for time-outs	783	# also check for time-outs
614	sub _timeout {	784	$cb = sub {
615	my ($self) = @_;	785	my ($self) = @_;
616		786
617	if ($self->{timeout} && $self->{fh}) {	787	if ($self->{$timeout} && $self->{fh}) {
618	my $NOW = AnyEvent->now;	788	my $NOW = AE::now;
619		789
620	# when would the timeout trigger?	790	# when would the timeout trigger?
621	my $after = $self->{_activity} + $self->{timeout} - $NOW;	791	my $after = $self->{$activity} + $self->{$timeout} - $NOW;
622		792
623	# now or in the past already?	793	# now or in the past already?
624	if ($after <= 0) {	794	if ($after <= 0) {
625	$self->{_activity} = $NOW;	795	$self->{$activity} = $NOW;
626		796
627	if ($self->{on_timeout}) {	797	if ($self->{$on_timeout}) {
628	$self->{on_timeout}($self);	798	$self->{$on_timeout}($self);
629	} else {	799	} else {
630	$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};
631	}	808	}
632		809
633	# callback could have changed timeout value, optimise	810	Scalar::Util::weaken $self;
634	return unless $self->{timeout};	811	return unless $self; # ->error could have destroyed $self
635		812
636	# calculate new after	813	$self->{$tw} \|\|= AE::timer $after, 0, sub {
637	$after = $self->{timeout};	814	delete $self->{$tw};
		815	$cb->($self);
		816	};
		817	} else {
		818	delete $self->{$tw};
638	}	819	}
639
640	Scalar::Util::weaken $self;
641	return unless $self; # ->error could have destroyed $self
642
643	$self->{_tw} \|\|= AnyEvent->timer (after => $after, cb => sub {
644	delete $self->{_tw};
645	$self->_timeout;
646	});
647	} else {
648	delete $self->{_tw};
649	}	820	}
650	}	821	}
651		822
652	#############################################################################	823	#############################################################################
653		824
…		…
668		839
669	=item $handle->on_drain ($cb)	840	=item $handle->on_drain ($cb)
670		841
671	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
672	C<on_drain> in the constructor).	843	C<on_drain> in the constructor).
		844
		845	This method may invoke callbacks (and therefore the handle might be
		846	destroyed after it returns).
673		847
674	=cut	848	=cut
675		849
676	sub on_drain {	850	sub on_drain {
677	my ($self, $cb) = @_;	851	my ($self, $cb) = @_;
…		…
686		860
687	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
688	want (only limited by the available memory), as C<AnyEvent::Handle>	862	want (only limited by the available memory), as C<AnyEvent::Handle>
689	buffers it independently of the kernel.	863	buffers it independently of the kernel.
690		864
		865	This method may invoke callbacks (and therefore the handle might be
		866	destroyed after it returns).
		867
691	=cut	868	=cut
692		869
693	sub _drain_wbuf {	870	sub _drain_wbuf {
694	my ($self) = @_;	871	my ($self) = @_;
695		872
…		…
701	my $len = syswrite $self->{fh}, $self->{wbuf};	878	my $len = syswrite $self->{fh}, $self->{wbuf};
702		879
703	if (defined $len) {	880	if (defined $len) {
704	substr $self->{wbuf}, 0, $len, "";	881	substr $self->{wbuf}, 0, $len, "";
705		882
706	$self->{_activity} = AnyEvent->now;	883	$self->{_activity} = $self->{_wactivity} = AE::now;
707		884
708	$self->{on_drain}($self)	885	$self->{on_drain}($self)
709	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})	886	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
710	&& $self->{on_drain};	887	&& $self->{on_drain};
711		888
…		…
717		894
718	# try to write data immediately	895	# try to write data immediately
719	$cb->() unless $self->{autocork};	896	$cb->() unless $self->{autocork};
720		897
721	# if still data left in wbuf, we need to poll	898	# if still data left in wbuf, we need to poll
722	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	899	$self->{_ww} = AE::io $self->{fh}, 1, $cb
723	if length $self->{wbuf};	900	if length $self->{wbuf};
724	};	901	};
725	}	902	}
726		903
727	our %WH;	904	our %WH;
728		905
		906	# deprecated
729	sub register_write_type($$) {	907	sub register_write_type($$) {
730	$WH{$_[0]} = $_[1];	908	$WH{$_[0]} = $_[1];
731	}	909	}
732		910
733	sub push_write {	911	sub push_write {
734	my $self = shift;	912	my $self = shift;
735		913
736	if (@_ > 1) {	914	if (@_ > 1) {
737	my $type = shift;	915	my $type = shift;
738		916
		917	@_ = ($WH{$type} \|\|= _load_func "$type\::anyevent_write_type"
739	@_ = ($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")
740	->($self, @_);	919	->($self, @_);
741	}	920	}
742		921
		922	# we downgrade here to avoid hard-to-track-down bugs,
		923	# and diagnose the problem earlier and better.
		924
743	if ($self->{tls}) {	925	if ($self->{tls}) {
744	$self->{_tls_wbuf} .= $_[0];	926	utf8::downgrade $self->{_tls_wbuf} .= $_[0];
745		927	&_dotls ($self) if $self->{fh};
746	&_dotls ($self);
747	} else {	928	} else {
748	$self->{wbuf} .= $_[0];	929	utf8::downgrade $self->{wbuf} .= $_[0];
749	$self->_drain_wbuf if $self->{fh};	930	$self->_drain_wbuf if $self->{fh};
750	}	931	}
751	}	932	}
752		933
753	=item $handle->push_write (type => @args)	934	=item $handle->push_write (type => @args)
754		935
755	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
756	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).
757		941
758	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
759	drop by and tell us):	943	drop by and tell us):
760		944
761	=over 4	945	=over 4
…		…
818	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
819	this line into their JSON decoder of choice.	1003	this line into their JSON decoder of choice.
820		1004
821	=cut	1005	=cut
822		1006
		1007	sub json_coder() {
		1008	eval { require JSON::XS; JSON::XS->new->utf8 }
		1009	\|\| do { require JSON; JSON->new->utf8 }
		1010	}
		1011
823	register_write_type json => sub {	1012	register_write_type json => sub {
824	my ($self, $ref) = @_;	1013	my ($self, $ref) = @_;
825		1014
826	require JSON;	1015	my $json = $self->{json} \|\|= json_coder;
827		1016
828	$self->{json} ? $self->{json}->encode ($ref)	1017	$json->encode ($ref)
829	: JSON::encode_json ($ref)
830	};	1018	};
831		1019
832	=item storable => $reference	1020	=item storable => $reference
833		1021
834	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
…		…
860	the peer.	1048	the peer.
861		1049
862	You can rely on the normal read queue and C<on_eof> handling	1050	You can rely on the normal read queue and C<on_eof> handling
863	afterwards. This is the cleanest way to close a connection.	1051	afterwards. This is the cleanest way to close a connection.
864		1052
		1053	This method may invoke callbacks (and therefore the handle might be
		1054	destroyed after it returns).
		1055
865	=cut	1056	=cut
866		1057
867	sub push_shutdown {	1058	sub push_shutdown {
868	my ($self) = @_;	1059	my ($self) = @_;
869		1060
870	delete $self->{low_water_mark};	1061	delete $self->{low_water_mark};
871	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });	1062	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });
872	}	1063	}
873		1064
874	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	1065	=item custom write types - Package::anyevent_write_type $handle, @args
875		1066
876	This function (not method) lets you add your own types to C<push_write>.	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
877	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
878	reference with the handle object and the remaining arguments.	1074	the handle object and the remaining arguments.
879		1075
880	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
881	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.
882		1079
883	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
884	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	}
885		1096
886	=cut	1097	=cut
887		1098
888	#############################################################################	1099	#############################################################################
889		1100
…		…
898	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
899	a queue.	1110	a queue.
900		1111
901	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
902	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
903	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
904	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
905	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>.
906		1118
907	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
908	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
909	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
910	done its job (see C<push_read>, below).	1122	done its job (see C<push_read>, below).
911		1123
912	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
913	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.
914		1126
…		…
972		1184
973	sub _drain_rbuf {	1185	sub _drain_rbuf {
974	my ($self) = @_;	1186	my ($self) = @_;
975		1187
976	# avoid recursion	1188	# avoid recursion
977	return if exists $self->{_skip_drain_rbuf};	1189	return if $self->{_skip_drain_rbuf};
978	local $self->{_skip_drain_rbuf} = 1;	1190	local $self->{_skip_drain_rbuf} = 1;
979
980	if (
981	defined $self->{rbuf_max}
982	&& $self->{rbuf_max} < length $self->{rbuf}
983	) {
984	$self->_error (Errno::ENOSPC, 1), return;
985	}
986		1191
987	while () {	1192	while () {
988	# we need to use a separate tls read buffer, as we must not receive data while	1193	# we need to use a separate tls read buffer, as we must not receive data while
989	# we are draining the buffer, and this can only happen with TLS.	1194	# we are draining the buffer, and this can only happen with TLS.
990	$self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf};	1195	$self->{rbuf} .= delete $self->{_tls_rbuf}
		1196	if exists $self->{_tls_rbuf};
991		1197
992	my $len = length $self->{rbuf};	1198	my $len = length $self->{rbuf};
993		1199
994	if (my $cb = shift @{ $self->{_queue} }) {	1200	if (my $cb = shift @{ $self->{_queue} }) {
995	unless ($cb->($self)) {	1201	unless ($cb->($self)) {
996	if ($self->{_eof}) {	1202	# no progress can be made
997	# no progress can be made (not enough data and no data forthcoming)	1203	# (not enough data and no data forthcoming)
998	$self->_error (Errno::EPIPE, 1), return;	1204	$self->_error (Errno::EPIPE, 1), return
999	}	1205	if $self->{_eof};
1000		1206
1001	unshift @{ $self->{_queue} }, $cb;	1207	unshift @{ $self->{_queue} }, $cb;
1002	last;	1208	last;
1003	}	1209	}
1004	} elsif ($self->{on_read}) {	1210	} elsif ($self->{on_read}) {
…		…
1024	last;	1230	last;
1025	}	1231	}
1026	}	1232	}
1027		1233
1028	if ($self->{_eof}) {	1234	if ($self->{_eof}) {
1029	if ($self->{on_eof}) {	1235	$self->{on_eof}
1030	$self->{on_eof}($self)	1236	? $self->{on_eof}($self)
1031	} else {
1032	$self->_error (0, 1, "Unexpected end-of-file");	1237	: $self->_error (0, 1, "Unexpected end-of-file");
1033	}	1238
		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;
1034	}	1247	}
1035		1248
1036	# may need to restart read watcher	1249	# may need to restart read watcher
1037	unless ($self->{_rw}) {	1250	unless ($self->{_rw}) {
1038	$self->start_read	1251	$self->start_read
…		…
1043	=item $handle->on_read ($cb)	1256	=item $handle->on_read ($cb)
1044		1257
1045	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
1046	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
1047	constructor.	1260	constructor.
		1261
		1262	This method may invoke callbacks (and therefore the handle might be
		1263	destroyed after it returns).
1048		1264
1049	=cut	1265	=cut
1050		1266
1051	sub on_read {	1267	sub on_read {
1052	my ($self, $cb) = @_;	1268	my ($self, $cb) = @_;
…		…
1092		1308
1093	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
1094	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
1095	true, it will be removed from the queue.	1311	true, it will be removed from the queue.
1096		1312
		1313	These methods may invoke callbacks (and therefore the handle might be
		1314	destroyed after it returns).
		1315
1097	=cut	1316	=cut
1098		1317
1099	our %RH;	1318	our %RH;
1100		1319
1101	sub register_read_type($$) {	1320	sub register_read_type($$) {
…		…
1107	my $cb = pop;	1326	my $cb = pop;
1108		1327
1109	if (@_) {	1328	if (@_) {
1110	my $type = shift;	1329	my $type = shift;
1111		1330
		1331	$cb = ($RH{$type} \|\|= _load_func "$type\::anyevent_read_type"
1112	$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")
1113	->($self, $cb, @_);	1333	->($self, $cb, @_);
1114	}	1334	}
1115		1335
1116	push @{ $self->{_queue} }, $cb;	1336	push @{ $self->{_queue} }, $cb;
1117	$self->_drain_rbuf;	1337	$self->_drain_rbuf;
…		…
1126		1346
1127	$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")
1128	->($self, $cb, @_);	1348	->($self, $cb, @_);
1129	}	1349	}
1130		1350
1131
1132	unshift @{ $self->{_queue} }, $cb;	1351	unshift @{ $self->{_queue} }, $cb;
1133	$self->_drain_rbuf;	1352	$self->_drain_rbuf;
1134	}	1353	}
1135		1354
1136	=item $handle->push_read (type => @args, $cb)	1355	=item $handle->push_read (type => @args, $cb)
1137		1356
1138	=item $handle->unshift_read (type => @args, $cb)	1357	=item $handle->unshift_read (type => @args, $cb)
1139		1358
1140	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
1141	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
1142	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).
1143		1364
1144	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
1145	drop by and tell us):	1366	drop by and tell us):
1146		1367
1147	=over 4	1368	=over 4
…		…
1239	the receive buffer when neither C<$accept> nor C<$reject> match,	1460	the receive buffer when neither C<$accept> nor C<$reject> match,
1240	and everything preceding and including the match will be accepted	1461	and everything preceding and including the match will be accepted
1241	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
1242	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
1243	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
1244	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.
1245		1466
1246	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
1247	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
1248	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
1249	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
1250	required for the accept regex.	1471	required for the accept regex.
1251		1472
1252	$handle->push_read (regex =>	1473	$handle->push_read (regex =>
…		…
1387	=cut	1608	=cut
1388		1609
1389	register_read_type json => sub {	1610	register_read_type json => sub {
1390	my ($self, $cb) = @_;	1611	my ($self, $cb) = @_;
1391		1612
1392	my $json = $self->{json} \|\|=	1613	my $json = $self->{json} \|\|= json_coder;
1393	eval { require JSON::XS; JSON::XS->new->utf8 }
1394	\|\| do { require JSON; JSON->new->utf8 };
1395		1614
1396	my $data;	1615	my $data;
1397	my $rbuf = \$self->{rbuf};	1616	my $rbuf = \$self->{rbuf};
1398		1617
1399	sub {	1618	sub {
…		…
1468	}	1687	}
1469	};	1688	};
1470		1689
1471	=back	1690	=back
1472		1691
1473	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)	1692	=item custom read types - Package::anyevent_read_type $handle, $cb, @args
1474		1693
1475	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).
1476		1699
1477	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
1478	reference with the handle object, the callback and the remaining	1701	handle object, the original callback and the remaining arguments.
1479	arguments.
1480		1702
1481	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
1482	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.
1483		1707
1484	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
1485	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).
1486		1711
1487	Note that this is a function, and all types registered this way will be
1488	global, so try to use unique names.
1489
1490	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
1491	search for C<register_read_type>)).	1713	AnyEvent::Handle>, search for C<register_read_type>)).
1492		1714
1493	=item $handle->stop_read	1715	=item $handle->stop_read
1494		1716
1495	=item $handle->start_read	1717	=item $handle->start_read
1496		1718
…		…
1516	}	1738	}
1517		1739
1518	sub start_read {	1740	sub start_read {
1519	my ($self) = @_;	1741	my ($self) = @_;
1520		1742
1521	unless ($self->{_rw} \|\| $self->{_eof}) {	1743	unless ($self->{_rw} \|\| $self->{_eof} \|\| !$self->{fh}) {
1522	Scalar::Util::weaken $self;	1744	Scalar::Util::weaken $self;
1523		1745
1524	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1746	$self->{_rw} = AE::io $self->{fh}, 0, sub {
1525	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});	1747	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1526	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;
1527		1749
1528	if ($len > 0) {	1750	if ($len > 0) {
1529	$self->{_activity} = AnyEvent->now;	1751	$self->{_activity} = $self->{_ractivity} = AE::now;
1530		1752
1531	if ($self->{tls}) {	1753	if ($self->{tls}) {
1532	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);	1754	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1533		1755
1534	&_dotls ($self);	1756	&_dotls ($self);
…		…
1542	$self->_drain_rbuf;	1764	$self->_drain_rbuf;
1543		1765
1544	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1766	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1545	return $self->_error ($!, 1);	1767	return $self->_error ($!, 1);
1546	}	1768	}
1547	});	1769	};
1548	}	1770	}
1549	}	1771	}
1550		1772
1551	our $ERROR_SYSCALL;	1773	our $ERROR_SYSCALL;
1552	our $ERROR_WANT_READ;	1774	our $ERROR_WANT_READ;
…		…
1619	&& ($tmp != $ERROR_SYSCALL \|\| $!);	1841	&& ($tmp != $ERROR_SYSCALL \|\| $!);
1620		1842
1621	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1843	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1622	$self->{wbuf} .= $tmp;	1844	$self->{wbuf} .= $tmp;
1623	$self->_drain_wbuf;	1845	$self->_drain_wbuf;
		1846	$self->{tls} or return; # tls session might have gone away in callback
1624	}	1847	}
1625		1848
1626	$self->{_on_starttls}	1849	$self->{_on_starttls}
1627	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()	1850	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
1628	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");	1851	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");
…		…
1649	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS	1872	The TLS connection object will end up in C<< $handle->{tls} >>, the TLS
1650	context in C<< $handle->{tls_ctx} >> after this call and can be used or	1873	context in C<< $handle->{tls_ctx} >> after this call and can be used or
1651	changed to your liking. Note that the handshake might have already started	1874	changed to your liking. Note that the handshake might have already started
1652	when this function returns.	1875	when this function returns.
1653		1876
1654	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
1655	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.
		1880
		1881	This method may invoke callbacks (and therefore the handle might be
		1882	destroyed after it returns).
1656		1883
1657	=cut	1884	=cut
1658		1885
1659	our %TLS_CACHE; #TODO not yet documented, should we?	1886	our %TLS_CACHE; #TODO not yet documented, should we?
1660		1887
1661	sub starttls {	1888	sub starttls {
1662	my ($self, $ssl, $ctx) = @_;	1889	my ($self, $tls, $ctx) = @_;
		1890
		1891	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"
		1892	if $self->{tls};
		1893
		1894	$self->{tls} = $tls;
		1895	$self->{tls_ctx} = $ctx if @_ > 2;
		1896
		1897	return unless $self->{fh};
1663		1898
1664	require Net::SSLeay;	1899	require Net::SSLeay;
1665
1666	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"
1667	if $self->{tls};
1668		1900
1669	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();	1901	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1670	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();	1902	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1671		1903
		1904	$tls = delete $self->{tls};
1672	$ctx \|\|= $self->{tls_ctx};	1905	$ctx = $self->{tls_ctx};
1673		1906
1674	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session	1907	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
1675		1908
1676	if ("HASH" eq ref $ctx) {	1909	if ("HASH" eq ref $ctx) {
1677	require AnyEvent::TLS;	1910	require AnyEvent::TLS;
…		…
1683	$ctx = new AnyEvent::TLS %$ctx;	1916	$ctx = new AnyEvent::TLS %$ctx;
1684	}	1917	}
1685	}	1918	}
1686		1919
1687	$self->{tls_ctx} = $ctx \|\| TLS_CTX ();	1920	$self->{tls_ctx} = $ctx \|\| TLS_CTX ();
1688	$self->{tls} = $ssl = $self->{tls_ctx}->_get_session ($ssl, $self, $self->{peername});	1921	$self->{tls} = $tls = $self->{tls_ctx}->_get_session ($tls, $self, $self->{peername});
1689		1922
1690	# 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)
1691	# but the openssl maintainers basically said: "trust us, it just works".	1924	# but the openssl maintainers basically said: "trust us, it just works".
1692	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1925	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1693	# and mismaintained ssleay-module doesn't even offer them).	1926	# and mismaintained ssleay-module doesn't even offer them).
…		…
1700	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to	1933	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
1701	# have identity issues in that area.	1934	# have identity issues in that area.
1702	# Net::SSLeay::CTX_set_mode ($ssl,	1935	# Net::SSLeay::CTX_set_mode ($ssl,
1703	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1936	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
1704	# \| (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));
1705	Net::SSLeay::CTX_set_mode ($ssl, 1\|2);	1938	Net::SSLeay::CTX_set_mode ($tls, 1\|2);
1706		1939
1707	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1940	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1708	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1941	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1709		1942
		1943	Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf});
		1944
1710	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1945	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
1711		1946
1712	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }	1947	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1713	if $self->{on_starttls};	1948	if $self->{on_starttls};
1714		1949
1715	&_dotls; # need to trigger the initial handshake	1950	&_dotls; # need to trigger the initial handshake
…		…
1718		1953
1719	=item $handle->stoptls	1954	=item $handle->stoptls
1720		1955
1721	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
1722	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
1723	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
1724	afterwards.	1959	the stream afterwards.
		1960
		1961	This method may invoke callbacks (and therefore the handle might be
		1962	destroyed after it returns).
1725		1963
1726	=cut	1964	=cut
1727		1965
1728	sub stoptls {	1966	sub stoptls {
1729	my ($self) = @_;	1967	my ($self) = @_;
1730		1968
1731	if ($self->{tls}) {	1969	if ($self->{tls} && $self->{fh}) {
1732	Net::SSLeay::shutdown ($self->{tls});	1970	Net::SSLeay::shutdown ($self->{tls});
1733		1971
1734	&_dotls;	1972	&_dotls;
1735		1973
1736	# # we don't give a shit. no, we do, but we can't. no...#d#	1974	# # we don't give a shit. no, we do, but we can't. no...#d#
…		…
1742	sub _freetls {	1980	sub _freetls {
1743	my ($self) = @_;	1981	my ($self) = @_;
1744		1982
1745	return unless $self->{tls};	1983	return unless $self->{tls};
1746		1984
1747	$self->{tls_ctx}->_put_session (delete $self->{tls});	1985	$self->{tls_ctx}->_put_session (delete $self->{tls})
		1986	if $self->{tls} > 0;
1748		1987
1749	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};	1988	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1750	}	1989	}
1751		1990
1752	sub DESTROY {	1991	sub DESTROY {
…		…
1760	my $fh = delete $self->{fh};	1999	my $fh = delete $self->{fh};
1761	my $wbuf = delete $self->{wbuf};	2000	my $wbuf = delete $self->{wbuf};
1762		2001
1763	my @linger;	2002	my @linger;
1764		2003
1765	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {	2004	push @linger, AE::io $fh, 1, sub {
1766	my $len = syswrite $fh, $wbuf, length $wbuf;	2005	my $len = syswrite $fh, $wbuf, length $wbuf;
1767		2006
1768	if ($len > 0) {	2007	if ($len > 0) {
1769	substr $wbuf, 0, $len, "";	2008	substr $wbuf, 0, $len, "";
1770	} else {	2009	} else {
1771	@linger = (); # end	2010	@linger = (); # end
1772	}	2011	}
1773	});	2012	};
1774	push @linger, AnyEvent->timer (after => $linger, cb => sub {	2013	push @linger, AE::timer $linger, 0, sub {
1775	@linger = ();	2014	@linger = ();
1776	});	2015	};
1777	}	2016	}
1778	}	2017	}
1779		2018
1780	=item $handle->destroy	2019	=item $handle->destroy
1781		2020
1782	Shuts down the handle object as much as possible - this call ensures that	2021	Shuts down the handle object as much as possible - this call ensures that
1783	no further callbacks will be invoked and as many resources as possible	2022	no further callbacks will be invoked and as many resources as possible
1784	will be freed. You must not call any methods on the object afterwards.	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).
1785		2026
1786	Normally, you can just "forget" any references to an AnyEvent::Handle	2027	Normally, you can just "forget" any references to an AnyEvent::Handle
1787	object and it will simply shut down. This works in fatal error and EOF	2028	object and it will simply shut down. This works in fatal error and EOF
1788	callbacks, as well as code outside. It does I<NOT> work in a read or write	2029	callbacks, as well as code outside. It does I<NOT> work in a read or write
1789	callback, so when you want to destroy the AnyEvent::Handle object from	2030	callback, so when you want to destroy the AnyEvent::Handle object from
…		…
1803	sub destroy {	2044	sub destroy {
1804	my ($self) = @_;	2045	my ($self) = @_;
1805		2046
1806	$self->DESTROY;	2047	$self->DESTROY;
1807	%$self = ();	2048	%$self = ();
		2049	bless $self, "AnyEvent::Handle::destroyed";
1808	}	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 }
1809		2078
1810	=item AnyEvent::Handle::TLS_CTX	2079	=item AnyEvent::Handle::TLS_CTX
1811		2080
1812	This function creates and returns the AnyEvent::TLS object used by default	2081	This function creates and returns the AnyEvent::TLS object used by default
1813	for TLS mode.	2082	for TLS mode.
…		…
1845		2114
1846	=item I get different callback invocations in TLS mode/Why can't I pause	2115	=item I get different callback invocations in TLS mode/Why can't I pause
1847	reading?	2116	reading?
1848		2117
1849	Unlike, say, TCP, TLS connections do not consist of two independent	2118	Unlike, say, TCP, TLS connections do not consist of two independent
1850	communication channels, one for each direction. Or put differently. The	2119	communication channels, one for each direction. Or put differently, the
1851	read and write directions are not independent of each other: you cannot	2120	read and write directions are not independent of each other: you cannot
1852	write data unless you are also prepared to read, and vice versa.	2121	write data unless you are also prepared to read, and vice versa.
1853		2122
1854	This can mean than, in TLS mode, you might get C<on_error> or C<on_eof>	2123	This means that, in TLS mode, you might get C<on_error> or C<on_eof>
1855	callback invocations when you are not expecting any read data - the reason	2124	callback invocations when you are not expecting any read data - the reason
1856	is that AnyEvent::Handle always reads in TLS mode.	2125	is that AnyEvent::Handle always reads in TLS mode.
1857		2126
1858	During the connection, you have to make sure that you always have a	2127	During the connection, you have to make sure that you always have a
1859	non-empty read-queue, or an C<on_read> watcher. At the end of the	2128	non-empty read-queue, or an C<on_read> watcher. At the end of the
…		…
1873	my $data = delete $_[0]{rbuf};	2142	my $data = delete $_[0]{rbuf};
1874	});	2143	});
1875		2144
1876	The reason to use C<on_error> is that TCP connections, due to latencies	2145	The reason to use C<on_error> is that TCP connections, due to latencies
1877	and packets loss, might get closed quite violently with an error, when in	2146	and packets loss, might get closed quite violently with an error, when in
1878	fact, all data has been received.	2147	fact all data has been received.
1879		2148
1880	It is usually better to use acknowledgements when transferring data,	2149	It is usually better to use acknowledgements when transferring data,
1881	to make sure the other side hasn't just died and you got the data	2150	to make sure the other side hasn't just died and you got the data
1882	intact. This is also one reason why so many internet protocols have an	2151	intact. This is also one reason why so many internet protocols have an
1883	explicit QUIT command.	2152	explicit QUIT command.
…		…
1900	consider using C<< ->push_shutdown >> instead.	2169	consider using C<< ->push_shutdown >> instead.
1901		2170
1902	=item I want to contact a TLS/SSL server, I don't care about security.	2171	=item I want to contact a TLS/SSL server, I don't care about security.
1903		2172
1904	If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS,	2173	If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS,
1905	simply connect to it and then create the AnyEvent::Handle with the C<tls>	2174	connect to it and then create the AnyEvent::Handle with the C<tls>
1906	parameter:	2175	parameter:
1907		2176
1908	tcp_connect $host, $port, sub {	2177	tcp_connect $host, $port, sub {
1909	my ($fh) = @_;	2178	my ($fh) = @_;
1910		2179
…		…
2010		2279
2011	=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
2012	are free to use in subclasses.	2281	are free to use in subclasses.
2013		2282
2014	Of course, new versions of AnyEvent::Handle may introduce more "public"	2283	Of course, new versions of AnyEvent::Handle may introduce more "public"
2015	member variables, but thats just life, at least it is documented.	2284	member variables, but that's just life. At least it is documented.
2016		2285
2017	=back	2286	=back
2018		2287
2019	=head1 AUTHOR	2288	=head1 AUTHOR
2020		2289

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.159 by root, Fri Jul 24 12:35:58 2009 UTC vs. Revision 1.198 by root, Tue Aug 31 01:03:37 2010 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.159 by root, Fri Jul 24 12:35:58 2009 UTC vs.
Revision 1.198 by root, Tue Aug 31 01:03:37 2010 UTC