[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.203 by root, Sat Oct 16 03:22:10 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
		80	sub MAX_READ_SIZE() { 131072 }
		81
64	=head1 METHODS	82	=head1 METHODS
65		83
66	=over 4	84	=over 4
67		85
68	=item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value...	86	=item $handle = B<new> AnyEvent::Handle fh => $filehandle, key => value...
69		87
70	The constructor supports these arguments (all as C<< key => value >> pairs).	88	The constructor supports these arguments (all as C<< key => value >> pairs).
71		89
72	=over 4	90	=over 4
73		91
…		…
83	Try to connect to the specified host and service (port), using	101	Try to connect to the specified host and service (port), using
84	C<AnyEvent::Socket::tcp_connect>. The C<$host> additionally becomes the	102	C<AnyEvent::Socket::tcp_connect>. The C<$host> additionally becomes the
85	default C<peername>.	103	default C<peername>.
86		104
87	You have to specify either this parameter, or C<fh>, above.	105	You have to specify either this parameter, or C<fh>, above.
		106
		107	It is possible to push requests on the read and write queues, and modify
		108	properties of the stream, even while AnyEvent::Handle is connecting.
88		109
89	When this parameter is specified, then the C<on_prepare>,	110	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	111	C<on_connect_error> and C<on_connect> callbacks will be called under the
91	appropriate circumstances:	112	appropriate circumstances:
92		113
…		…
98	attempted, but after the file handle has been created. It could be used to	119	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	120	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	121	(as opposed to settings that can be changed when the connection is already
101	established).	122	established).
102		123
		124	The return value of this callback should be the connect timeout value in
		125	seconds (or C<0>, or C<undef>, or the empty list, to indicate that the
		126	default timeout is to be used).
		127
103	=item on_connect => $cb->($handle, $host, $port, $retry->())	128	=item on_connect => $cb->($handle, $host, $port, $retry->())
104		129
105	This callback is called when a connection has been successfully established.	130	This callback is called when a connection has been successfully established.
106		131
107	The actual numeric host and port (the socket peername) are passed as	132	The peer's numeric host and port (the socket peername) are passed as
108	parameters, together with a retry callback.	133	parameters, together with a retry callback.
109		134
110	When, for some reason, the handle is not acceptable, then calling	135	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	136	will continue with the next connection target (in case of multi-homed
112	multi-homed hosts or SRV records there can be multiple connection	137	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,	138	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.	139	similar properties of the handle will have been reset.
115		140
116	In most cases, ignoring the C<$retry> parameter is the way to go.	141	In most cases, you should ignore the C<$retry> parameter.
117		142
118	=item on_connect_error => $cb->($handle, $message)	143	=item on_connect_error => $cb->($handle, $message)
119		144
120	This callback is called when the conenction could not be	145	This callback is called when the connection could not be
121	established. C<$!> will contain the relevant error code, and C<$message> a	146	established. C<$!> will contain the relevant error code, and C<$message> a
122	message describing it (usually the same as C<"$!">).	147	message describing it (usually the same as C<"$!">).
123		148
124	If this callback isn't specified, then C<on_error> will be called with a	149	If this callback isn't specified, then C<on_error> will be called with a
125	fatal error instead.	150	fatal error instead.
…		…
128		153
129	=item on_error => $cb->($handle, $fatal, $message)	154	=item on_error => $cb->($handle, $fatal, $message)
130		155
131	This is the error callback, which is called when, well, some error	156	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	157	occured, such as not being able to resolve the hostname, failure to
133	connect or a read error.	158	connect, or a read error.
134		159
135	Some errors are fatal (which is indicated by C<$fatal> being true). On	160	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<< ->	161	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	162	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	163	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	164	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	165	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.	166	often easiest to not report C<EPIPE> errors in this callback.
142		167
143	AnyEvent::Handle tries to find an appropriate error code for you to check	168	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	169	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	170	recommended to always output the C<$message> argument in human-readable
146	error messages (it's usually the same as C<"$!">).	171	error messages (it's usually the same as C<"$!">).
147		172
148	Non-fatal errors can be retried by simply returning, but it is recommended	173	Non-fatal errors can be retried by returning, but it is recommended
149	to simply ignore this parameter and instead abondon the handle object	174	to simply ignore this parameter and instead abondon the handle object
150	when this callback is invoked. Examples of non-fatal errors are timeouts	175	when this callback is invoked. Examples of non-fatal errors are timeouts
151	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).	176	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
152		177
153	On callback entrance, the value of C<$!> contains the operating system	178	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	179	system error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
155	C<EPROTO>).	180	C<EPROTO>).
156		181
157	While not mandatory, it is I<highly> recommended to set this callback, as	182	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	183	you will not be notified of errors otherwise. The default just calls
159	C<croak>.	184	C<croak>.
160		185
161	=item on_read => $cb->($handle)	186	=item on_read => $cb->($handle)
162		187
163	This sets the default read callback, which is called when data arrives	188	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 >>	193	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	194	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	195	must not enlarge or modify the read buffer, you can only remove data at
171	the beginning from it.	196	the beginning from it.
172		197
		198	You can also call C<< ->push_read (...) >> or any other function that
		199	modifies the read queue. Or do both. Or ...
		200
173	When an EOF condition is detected then AnyEvent::Handle will first try to	201	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	202	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	203	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>).	204	error will be raised (with C<$!> set to C<EPIPE>).
177		205
178	Note that, unlike requests in the read queue, an C<on_read> callback	206	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>.	225	set, then a fatal error will be raised with C<$!> set to <0>.
198		226
199	=item on_drain => $cb->($handle)	227	=item on_drain => $cb->($handle)
200		228
201	This sets the callback that is called when the write buffer becomes empty	229	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).	230	(or immediately if the buffer is empty already).
203		231
204	To append to the write buffer, use the C<< ->push_write >> method.	232	To append to the write buffer, use the C<< ->push_write >> method.
205		233
206	This callback is useful when you don't want to put all of your write data	234	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	235	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	237	memory and push it into the queue, but instead only read more data from
210	the file when the write queue becomes empty.	238	the file when the write queue becomes empty.
211		239
212	=item timeout => $fractional_seconds	240	=item timeout => $fractional_seconds
213		241
		242	=item rtimeout => $fractional_seconds
		243
		244	=item wtimeout => $fractional_seconds
		245
214	If non-zero, then this enables an "inactivity" timeout: whenever this many	246	If non-zero, then these enables an "inactivity" timeout: whenever this
215	seconds pass without a successful read or write on the underlying file	247	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	248	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).	249	will be invoked (and if that one is missing, a non-fatal C<ETIMEDOUT>
		250	error will be raised).
218		251
		252	There are three variants of the timeouts that work independently
		253	of each other, for both read and write, just read, and just write:
		254	C<timeout>, C<rtimeout> and C<wtimeout>, with corresponding callbacks
		255	C<on_timeout>, C<on_rtimeout> and C<on_wtimeout>, and reset functions
		256	C<timeout_reset>, C<rtimeout_reset>, and C<wtimeout_reset>.
		257
219	Note that timeout processing is also active when you currently do not have	258	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	259	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	260	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	261	in the C<on_timeout> callback, in which case AnyEvent::Handle will simply
223	restart the timeout.	262	restart the timeout.
224		263
225	Zero (the default) disables this timeout.	264	Zero (the default) disables this timeout.
226		265
…		…
242	amount of data without a callback ever being called as long as the line	281	amount of data without a callback ever being called as long as the line
243	isn't finished).	282	isn't finished).
244		283
245	=item autocork => <boolean>	284	=item autocork => <boolean>
246		285
247	When disabled (the default), then C<push_write> will try to immediately	286	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	287	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	288	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	289	be inefficient if you write multiple small chunks (on the wire, this
251	disadvantage is usually avoided by your kernel's nagle algorithm, see	290	disadvantage is usually avoided by your kernel's nagle algorithm, see
252	C<no_delay>, but this option can save costly syscalls).	291	C<no_delay>, but this option can save costly syscalls).
253		292
254	When enabled, then writes will always be queued till the next event loop	293	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,	294	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	295	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.	296	the write buffer often is full). It also increases write latency.
258		297
259	=item no_delay => <boolean>	298	=item no_delay => <boolean>
…		…
263	the Nagle algorithm, and usually it is beneficial.	302	the Nagle algorithm, and usually it is beneficial.
264		303
265	In some situations you want as low a delay as possible, which can be	304	In some situations you want as low a delay as possible, which can be
266	accomplishd by setting this option to a true value.	305	accomplishd by setting this option to a true value.
267		306
268	The default is your opertaing system's default behaviour (most likely	307	The default is your operating system's default behaviour (most likely
269	enabled), this option explicitly enables or disables it, if possible.	308	enabled). This option explicitly enables or disables it, if possible.
		309
		310	=item keepalive => <boolean>
		311
		312	Enables (default disable) the SO_KEEPALIVE option on the stream socket:
		313	normally, TCP connections have no time-out once established, so TCP
		314	connections, once established, can stay alive forever even when the other
		315	side has long gone. TCP keepalives are a cheap way to take down long-lived
		316	TCP connections when the other side becomes unreachable. While the default
		317	is OS-dependent, TCP keepalives usually kick in after around two hours,
		318	and, if the other side doesn't reply, take down the TCP connection some 10
		319	to 15 minutes later.
		320
		321	It is harmless to specify this option for file handles that do not support
		322	keepalives, and enabling it on connections that are potentially long-lived
		323	is usually a good idea.
		324
		325	=item oobinline => <boolean>
		326
		327	BSD majorly fucked up the implementation of TCP urgent data. The result
		328	is that almost no OS implements TCP according to the specs, and every OS
		329	implements it slightly differently.
		330
		331	If you want to handle TCP urgent data, then setting this flag (the default
		332	is enabled) gives you the most portable way of getting urgent data, by
		333	putting it into the stream.
		334
		335	Since BSD emulation of OOB data on top of TCP's urgent data can have
		336	security implications, AnyEvent::Handle sets this flag automatically
		337	unless explicitly specified. Note that setting this flag after
		338	establishing a connection I<may> be a bit too late (data loss could
		339	already have occured on BSD systems), but at least it will protect you
		340	from most attacks.
270		341
271	=item read_size => <bytes>	342	=item read_size => <bytes>
272		343
273	The default read block size (the amount of bytes this module will	344	The initial read block size, the number of bytes this module will try to
274	try to read during each loop iteration, which affects memory	345	read during each loop iteration. Each handle object will consume at least
275	requirements). Default: C<8192>.	346	this amount of memory for the read buffer as well, so when handling many
		347	connections requirements). See also C<max_read_size>. Default: C<2048>.
		348
		349	=item max_read_size => <bytes>
		350
		351	The maximum read buffer size used by the dynamic adjustment
		352	algorithm: Each time AnyEvent::Handle can read C<read_size> bytes in
		353	one go it will double C<read_size> up to the maximum given by this
		354	option. Default: C<131072> or C<read_size>, whichever is higher.
276		355
277	=item low_water_mark => <bytes>	356	=item low_water_mark => <bytes>
278		357
279	Sets the amount of bytes (default: C<0>) that make up an "empty" write	358	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	359	buffer: If the buffer reaches this size or gets even samller it is
281	considered empty.	360	considered empty.
282		361
283	Sometimes it can be beneficial (for performance reasons) to add data to	362	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	363	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	364	the operating system kernel usually buffers data as well, so the default
286	is good in almost all cases.	365	is good in almost all cases.
287		366
288	=item linger => <seconds>	367	=item linger => <seconds>
289		368
290	If non-zero (default: C<3600>), then the destructor of the	369	If this is non-zero (default: C<3600>), the destructor of the
291	AnyEvent::Handle object will check whether there is still outstanding	370	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	371	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	372	socket. No errors will be reported (this mostly matches how the operating
294	system treats outstanding data at socket close time).	373	system treats outstanding data at socket close time).
295		374
…		…
302	A string used to identify the remote site - usually the DNS hostname	381	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.	382	(I<not> IDN!) used to create the connection, rarely the IP address.
304		383
305	Apart from being useful in error messages, this string is also used in TLS	384	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	385	peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This
307	verification will be skipped when C<peername> is not specified or	386	verification will be skipped when C<peername> is not specified or is
308	C<undef>.	387	C<undef>.
309		388
310	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	389	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
311		390
312	When this parameter is given, it enables TLS (SSL) mode, that means	391	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	392	AnyEvent will start a TLS handshake as soon as the connection has been
314	established and will transparently encrypt/decrypt data afterwards.	393	established and will transparently encrypt/decrypt data afterwards.
315		394
316	All TLS protocol errors will be signalled as C<EPROTO>, with an	395	All TLS protocol errors will be signalled as C<EPROTO>, with an
317	appropriate error message.	396	appropriate error message.
318		397
…		…
338	B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,	417	B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,
339	passing in the wrong integer will lead to certain crash. This most often	418	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	419	happens when one uses a stylish C<< tls => 1 >> and is surprised about the
341	segmentation fault.	420	segmentation fault.
342		421
343	See the C<< ->starttls >> method for when need to start TLS negotiation later.	422	Use the C<< ->starttls >> method if you need to start TLS negotiation later.
344		423
345	=item tls_ctx => $anyevent_tls	424	=item tls_ctx => $anyevent_tls
346		425
347	Use the given C<AnyEvent::TLS> object to create the new TLS connection	426	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	427	(unless a connection object was specified directly). If this parameter is
…		…
363		442
364	TLS handshake failures will not cause C<on_error> to be invoked when this	443	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>.	444	callback is in effect, instead, the error message will be passed to C<on_starttls>.
366		445
367	Without this callback, handshake failures lead to C<on_error> being	446	Without this callback, handshake failures lead to C<on_error> being
368	called, as normal.	447	called as usual.
369		448
370	Note that you cannot call C<starttls> right again in this callback. If you	449	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	450	need to do that, start an zero-second timer instead whose callback can
372	then call C<< ->starttls >> again.	451	then call C<< ->starttls >> again.
373		452
374	=item on_stoptls => $cb->($handle)	453	=item on_stoptls => $cb->($handle)
375		454
…		…
431	delete $self->{_skip_drain_rbuf};	510	delete $self->{_skip_drain_rbuf};
432	$self->_start;	511	$self->_start;
433		512
434	$self->{on_connect}	513	$self->{on_connect}
435	and $self->{on_connect}($self, $host, $port, sub {	514	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)};	515	delete @$self{qw(fh _tw _rtw _wtw _ww _rw _eof _queue rbuf _wbuf tls _tls_rbuf _tls_wbuf)};
437	$self->{_skip_drain_rbuf} = 1;	516	$self->{_skip_drain_rbuf} = 1;
438	&$retry;	517	&$retry;
439	});	518	});
440		519
441	} else {	520	} else {
442	if ($self->{on_connect_error}) {	521	if ($self->{on_connect_error}) {
443	$self->{on_connect_error}($self, "$!");	522	$self->{on_connect_error}($self, "$!");
444	$self->destroy;	523	$self->destroy;
445	} else {	524	} else {
446	$self->fatal ($!, 1);	525	$self->_error ($!, 1);
447	}	526	}
448	}	527	}
449	},	528	},
450	sub {	529	sub {
451	local $self->{fh} = $_[0];	530	local $self->{fh} = $_[0];
452		531
		532	$self->{on_prepare}
453	$self->{on_prepare}->($self)	533	? $self->{on_prepare}->($self)
454	if $self->{on_prepare};	534	: ()
455	}	535	}
456	);	536	);
457	}	537	}
458		538
459	} else {	539	} else {
…		…
464	}	544	}
465		545
466	sub _start {	546	sub _start {
467	my ($self) = @_;	547	my ($self) = @_;
468		548
		549	# too many clueless people try to use udp and similar sockets
		550	# with AnyEvent::Handle, do them a favour.
		551	my $type = getsockopt $self->{fh}, Socket::SOL_SOCKET (), Socket::SO_TYPE ();
		552	Carp::croak "AnyEvent::Handle: only stream sockets supported, anything else will NOT work!"
		553	if Socket::SOCK_STREAM () != (unpack "I", $type) && defined $type;
		554
469	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	555	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
470		556
		557	$self->{_activity} =
		558	$self->{_ractivity} =
471	$self->{_activity} = AnyEvent->now;	559	$self->{_wactivity} = AE::now;
472	$self->_timeout;
473		560
		561	$self->{read_size} \|\|= 2048;
		562	$self->{max_read_size} = $self->{read_size}
		563	if $self->{read_size} > ($self->{max_read_size} \|\| MAX_READ_SIZE);
		564
		565	$self->timeout (delete $self->{timeout} ) if $self->{timeout};
		566	$self->rtimeout (delete $self->{rtimeout} ) if $self->{rtimeout};
		567	$self->wtimeout (delete $self->{wtimeout} ) if $self->{wtimeout};
		568
474	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};	569	$self->no_delay (delete $self->{no_delay} ) if exists $self->{no_delay} && $self->{no_delay};
		570	$self->keepalive (delete $self->{keepalive}) if exists $self->{keepalive} && $self->{keepalive};
475		571
		572	$self->oobinline (exists $self->{oobinline} ? delete $self->{oobinline} : 1);
		573
476	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})	574	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
477	if $self->{tls};	575	if $self->{tls};
478		576
479	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	577	$self->on_drain (delete $self->{on_drain} ) if $self->{on_drain};
480		578
481	$self->start_read	579	$self->start_read
482	if $self->{on_read} \|\| @{ $self->{_queue} };	580	if $self->{on_read} \|\| @{ $self->{_queue} };
483	}
484		581
485	#sub _shutdown {	582	$self->_drain_wbuf;
486	# my ($self) = @_;	583	}
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		584
494	sub _error {	585	sub _error {
495	my ($self, $errno, $fatal, $message) = @_;	586	my ($self, $errno, $fatal, $message) = @_;
496		587
497	$! = $errno;	588	$! = $errno;
498	$message \|\|= "$!";	589	$message \|\|= "$!";
499		590
500	if ($self->{on_error}) {	591	if ($self->{on_error}) {
501	$self->{on_error}($self, $fatal, $message);	592	$self->{on_error}($self, $fatal, $message);
502	$self->destroy if $fatal;	593	$self->destroy if $fatal;
503	} elsif ($self->{fh}) {	594	} elsif ($self->{fh} \|\| $self->{connect}) {
504	$self->destroy;	595	$self->destroy;
505	Carp::croak "AnyEvent::Handle uncaught error: $message";	596	Carp::croak "AnyEvent::Handle uncaught error: $message";
506	}	597	}
507	}	598	}
508		599
…		…
534	$_[0]{on_eof} = $_[1];	625	$_[0]{on_eof} = $_[1];
535	}	626	}
536		627
537	=item $handle->on_timeout ($cb)	628	=item $handle->on_timeout ($cb)
538		629
539	Replace the current C<on_timeout> callback, or disables the callback (but	630	=item $handle->on_rtimeout ($cb)
540	not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
541	argument and method.
542		631
543	=cut	632	=item $handle->on_wtimeout ($cb)
544		633
545	sub on_timeout {	634	Replace the current C<on_timeout>, C<on_rtimeout> or C<on_wtimeout>
546	$_[0]{on_timeout} = $_[1];	635	callback, or disables the callback (but not the timeout) if C<$cb> =
547	}	636	C<undef>. See the C<timeout> constructor argument and method.
		637
		638	=cut
		639
		640	# see below
548		641
549	=item $handle->autocork ($boolean)	642	=item $handle->autocork ($boolean)
550		643
551	Enables or disables the current autocork behaviour (see C<autocork>	644	Enables or disables the current autocork behaviour (see C<autocork>
552	constructor argument). Changes will only take effect on the next write.	645	constructor argument). Changes will only take effect on the next write.
…		…
565	=cut	658	=cut
566		659
567	sub no_delay {	660	sub no_delay {
568	$_[0]{no_delay} = $_[1];	661	$_[0]{no_delay} = $_[1];
569		662
		663	setsockopt $_[0]{fh}, Socket::IPPROTO_TCP (), Socket::TCP_NODELAY (), int $_[1]
		664	if $_[0]{fh};
		665	}
		666
		667	=item $handle->keepalive ($boolean)
		668
		669	Enables or disables the C<keepalive> setting (see constructor argument of
		670	the same name for details).
		671
		672	=cut
		673
		674	sub keepalive {
		675	$_[0]{keepalive} = $_[1];
		676
570	eval {	677	eval {
571	local $SIG{__DIE__};	678	local $SIG{__DIE__};
572	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1]	679	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
573	if $_[0]{fh};	680	if $_[0]{fh};
574	};	681	};
575	}	682	}
576		683
		684	=item $handle->oobinline ($boolean)
		685
		686	Enables or disables the C<oobinline> setting (see constructor argument of
		687	the same name for details).
		688
		689	=cut
		690
		691	sub oobinline {
		692	$_[0]{oobinline} = $_[1];
		693
		694	eval {
		695	local $SIG{__DIE__};
		696	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_OOBINLINE (), int $_[1]
		697	if $_[0]{fh};
		698	};
		699	}
		700
		701	=item $handle->keepalive ($boolean)
		702
		703	Enables or disables the C<keepalive> setting (see constructor argument of
		704	the same name for details).
		705
		706	=cut
		707
		708	sub keepalive {
		709	$_[0]{keepalive} = $_[1];
		710
		711	eval {
		712	local $SIG{__DIE__};
		713	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
		714	if $_[0]{fh};
		715	};
		716	}
		717
577	=item $handle->on_starttls ($cb)	718	=item $handle->on_starttls ($cb)
578		719
579	Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument).	720	Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument).
580		721
581	=cut	722	=cut
…		…
588		729
589	Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).	730	Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).
590		731
591	=cut	732	=cut
592		733
593	sub on_starttls {	734	sub on_stoptls {
594	$_[0]{on_stoptls} = $_[1];	735	$_[0]{on_stoptls} = $_[1];
595	}	736	}
596		737
		738	=item $handle->rbuf_max ($max_octets)
		739
		740	Configures the C<rbuf_max> setting (C<undef> disables it).
		741
		742	=cut
		743
		744	sub rbuf_max {
		745	$_[0]{rbuf_max} = $_[1];
		746	}
		747
597	#############################################################################	748	#############################################################################
598		749
599	=item $handle->timeout ($seconds)	750	=item $handle->timeout ($seconds)
600		751
		752	=item $handle->rtimeout ($seconds)
		753
		754	=item $handle->wtimeout ($seconds)
		755
601	Configures (or disables) the inactivity timeout.	756	Configures (or disables) the inactivity timeout.
602		757
603	=cut	758	=item $handle->timeout_reset
604		759
605	sub timeout {	760	=item $handle->rtimeout_reset
		761
		762	=item $handle->wtimeout_reset
		763
		764	Reset the activity timeout, as if data was received or sent.
		765
		766	These methods are cheap to call.
		767
		768	=cut
		769
		770	for my $dir ("", "r", "w") {
		771	my $timeout = "${dir}timeout";
		772	my $tw = "_${dir}tw";
		773	my $on_timeout = "on_${dir}timeout";
		774	my $activity = "_${dir}activity";
		775	my $cb;
		776
		777	*$on_timeout = sub {
		778	$_[0]{$on_timeout} = $_[1];
		779	};
		780
		781	*$timeout = sub {
606	my ($self, $timeout) = @_;	782	my ($self, $new_value) = @_;
607		783
		784	$new_value >= 0
		785	or Carp::croak "AnyEvent::Handle->$timeout called with negative timeout ($new_value), caught";
		786
608	$self->{timeout} = $timeout;	787	$self->{$timeout} = $new_value;
609	$self->_timeout;	788	delete $self->{$tw}; &$cb;
610	}	789	};
611		790
		791	*{"${dir}timeout_reset"} = sub {
		792	$_[0]{$activity} = AE::now;
		793	};
		794
		795	# main workhorse:
612	# reset the timeout watcher, as neccessary	796	# reset the timeout watcher, as neccessary
613	# also check for time-outs	797	# also check for time-outs
614	sub _timeout {	798	$cb = sub {
615	my ($self) = @_;	799	my ($self) = @_;
616		800
617	if ($self->{timeout} && $self->{fh}) {	801	if ($self->{$timeout} && $self->{fh}) {
618	my $NOW = AnyEvent->now;	802	my $NOW = AE::now;
619		803
620	# when would the timeout trigger?	804	# when would the timeout trigger?
621	my $after = $self->{_activity} + $self->{timeout} - $NOW;	805	my $after = $self->{$activity} + $self->{$timeout} - $NOW;
622		806
623	# now or in the past already?	807	# now or in the past already?
624	if ($after <= 0) {	808	if ($after <= 0) {
625	$self->{_activity} = $NOW;	809	$self->{$activity} = $NOW;
626		810
627	if ($self->{on_timeout}) {	811	if ($self->{$on_timeout}) {
628	$self->{on_timeout}($self);	812	$self->{$on_timeout}($self);
629	} else {	813	} else {
630	$self->_error (Errno::ETIMEDOUT);	814	$self->_error (Errno::ETIMEDOUT);
		815	}
		816
		817	# callback could have changed timeout value, optimise
		818	return unless $self->{$timeout};
		819
		820	# calculate new after
		821	$after = $self->{$timeout};
631	}	822	}
632		823
633	# callback could have changed timeout value, optimise	824	Scalar::Util::weaken $self;
634	return unless $self->{timeout};	825	return unless $self; # ->error could have destroyed $self
635		826
636	# calculate new after	827	$self->{$tw} \|\|= AE::timer $after, 0, sub {
637	$after = $self->{timeout};	828	delete $self->{$tw};
		829	$cb->($self);
		830	};
		831	} else {
		832	delete $self->{$tw};
638	}	833	}
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	}	834	}
650	}	835	}
651		836
652	#############################################################################	837	#############################################################################
653		838
…		…
668		853
669	=item $handle->on_drain ($cb)	854	=item $handle->on_drain ($cb)
670		855
671	Sets the C<on_drain> callback or clears it (see the description of	856	Sets the C<on_drain> callback or clears it (see the description of
672	C<on_drain> in the constructor).	857	C<on_drain> in the constructor).
		858
		859	This method may invoke callbacks (and therefore the handle might be
		860	destroyed after it returns).
673		861
674	=cut	862	=cut
675		863
676	sub on_drain {	864	sub on_drain {
677	my ($self, $cb) = @_;	865	my ($self, $cb) = @_;
…		…
686		874
687	Queues the given scalar to be written. You can push as much data as you	875	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>	876	want (only limited by the available memory), as C<AnyEvent::Handle>
689	buffers it independently of the kernel.	877	buffers it independently of the kernel.
690		878
		879	This method may invoke callbacks (and therefore the handle might be
		880	destroyed after it returns).
		881
691	=cut	882	=cut
692		883
693	sub _drain_wbuf {	884	sub _drain_wbuf {
694	my ($self) = @_;	885	my ($self) = @_;
695		886
…		…
701	my $len = syswrite $self->{fh}, $self->{wbuf};	892	my $len = syswrite $self->{fh}, $self->{wbuf};
702		893
703	if (defined $len) {	894	if (defined $len) {
704	substr $self->{wbuf}, 0, $len, "";	895	substr $self->{wbuf}, 0, $len, "";
705		896
706	$self->{_activity} = AnyEvent->now;	897	$self->{_activity} = $self->{_wactivity} = AE::now;
707		898
708	$self->{on_drain}($self)	899	$self->{on_drain}($self)
709	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})	900	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
710	&& $self->{on_drain};	901	&& $self->{on_drain};
711		902
…		…
717		908
718	# try to write data immediately	909	# try to write data immediately
719	$cb->() unless $self->{autocork};	910	$cb->() unless $self->{autocork};
720		911
721	# if still data left in wbuf, we need to poll	912	# if still data left in wbuf, we need to poll
722	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	913	$self->{_ww} = AE::io $self->{fh}, 1, $cb
723	if length $self->{wbuf};	914	if length $self->{wbuf};
724	};	915	};
725	}	916	}
726		917
727	our %WH;	918	our %WH;
728		919
		920	# deprecated
729	sub register_write_type($$) {	921	sub register_write_type($$) {
730	$WH{$_[0]} = $_[1];	922	$WH{$_[0]} = $_[1];
731	}	923	}
732		924
733	sub push_write {	925	sub push_write {
734	my $self = shift;	926	my $self = shift;
735		927
736	if (@_ > 1) {	928	if (@_ > 1) {
737	my $type = shift;	929	my $type = shift;
738		930
		931	@_ = ($WH{$type} \|\|= _load_func "$type\::anyevent_write_type"
739	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	932	or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_write")
740	->($self, @_);	933	->($self, @_);
741	}	934	}
742		935
		936	# we downgrade here to avoid hard-to-track-down bugs,
		937	# and diagnose the problem earlier and better.
		938
743	if ($self->{tls}) {	939	if ($self->{tls}) {
744	$self->{_tls_wbuf} .= $_[0];	940	utf8::downgrade $self->{_tls_wbuf} .= $_[0];
745		941	&_dotls ($self) if $self->{fh};
746	&_dotls ($self);
747	} else {	942	} else {
748	$self->{wbuf} .= $_[0];	943	utf8::downgrade $self->{wbuf} .= $_[0];
749	$self->_drain_wbuf if $self->{fh};	944	$self->_drain_wbuf if $self->{fh};
750	}	945	}
751	}	946	}
752		947
753	=item $handle->push_write (type => @args)	948	=item $handle->push_write (type => @args)
754		949
755	Instead of formatting your data yourself, you can also let this module do	950	Instead of formatting your data yourself, you can also let this module
756	the job by specifying a type and type-specific arguments.	951	do the job by specifying a type and type-specific arguments. You
		952	can also specify the (fully qualified) name of a package, in which
		953	case AnyEvent tries to load the package and then expects to find the
		954	C<anyevent_write_type> function inside (see "custom write types", below).
757		955
758	Predefined types are (if you have ideas for additional types, feel free to	956	Predefined types are (if you have ideas for additional types, feel free to
759	drop by and tell us):	957	drop by and tell us):
760		958
761	=over 4	959	=over 4
…		…
818	Other languages could read single lines terminated by a newline and pass	1016	Other languages could read single lines terminated by a newline and pass
819	this line into their JSON decoder of choice.	1017	this line into their JSON decoder of choice.
820		1018
821	=cut	1019	=cut
822		1020
		1021	sub json_coder() {
		1022	eval { require JSON::XS; JSON::XS->new->utf8 }
		1023	\|\| do { require JSON; JSON->new->utf8 }
		1024	}
		1025
823	register_write_type json => sub {	1026	register_write_type json => sub {
824	my ($self, $ref) = @_;	1027	my ($self, $ref) = @_;
825		1028
826	require JSON;	1029	my $json = $self->{json} \|\|= json_coder;
827		1030
828	$self->{json} ? $self->{json}->encode ($ref)	1031	$json->encode ($ref)
829	: JSON::encode_json ($ref)
830	};	1032	};
831		1033
832	=item storable => $reference	1034	=item storable => $reference
833		1035
834	Freezes the given reference using L<Storable> and writes it to the	1036	Freezes the given reference using L<Storable> and writes it to the
…		…
860	the peer.	1062	the peer.
861		1063
862	You can rely on the normal read queue and C<on_eof> handling	1064	You can rely on the normal read queue and C<on_eof> handling
863	afterwards. This is the cleanest way to close a connection.	1065	afterwards. This is the cleanest way to close a connection.
864		1066
		1067	This method may invoke callbacks (and therefore the handle might be
		1068	destroyed after it returns).
		1069
865	=cut	1070	=cut
866		1071
867	sub push_shutdown {	1072	sub push_shutdown {
868	my ($self) = @_;	1073	my ($self) = @_;
869		1074
870	delete $self->{low_water_mark};	1075	delete $self->{low_water_mark};
871	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });	1076	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });
872	}	1077	}
873		1078
874	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	1079	=item custom write types - Package::anyevent_write_type $handle, @args
875		1080
876	This function (not method) lets you add your own types to C<push_write>.	1081	Instead of one of the predefined types, you can also specify the name of
		1082	a package. AnyEvent will try to load the package and then expects to find
		1083	a function named C<anyevent_write_type> inside. If it isn't found, it
		1084	progressively tries to load the parent package until it either finds the
		1085	function (good) or runs out of packages (bad).
		1086
877	Whenever the given C<type> is used, C<push_write> will invoke the code	1087	Whenever the given C<type> is used, C<push_write> will the function with
878	reference with the handle object and the remaining arguments.	1088	the handle object and the remaining arguments.
879		1089
880	The code reference is supposed to return a single octet string that will	1090	The function is supposed to return a single octet string that will be
881	be appended to the write buffer.	1091	appended to the write buffer, so you cna mentally treat this function as a
		1092	"arguments to on-the-wire-format" converter.
882		1093
883	Note that this is a function, and all types registered this way will be	1094	Example: implement a custom write type C<join> that joins the remaining
884	global, so try to use unique names.	1095	arguments using the first one.
		1096
		1097	$handle->push_write (My::Type => " ", 1,2,3);
		1098
		1099	# uses the following package, which can be defined in the "My::Type" or in
		1100	# the "My" modules to be auto-loaded, or just about anywhere when the
		1101	# My::Type::anyevent_write_type is defined before invoking it.
		1102
		1103	package My::Type;
		1104
		1105	sub anyevent_write_type {
		1106	my ($handle, $delim, @args) = @_;
		1107
		1108	join $delim, @args
		1109	}
885		1110
886	=cut	1111	=cut
887		1112
888	#############################################################################	1113	#############################################################################
889		1114
…		…
898	ways, the "simple" way, using only C<on_read> and the "complex" way, using	1123	ways, the "simple" way, using only C<on_read> and the "complex" way, using
899	a queue.	1124	a queue.
900		1125
901	In the simple case, you just install an C<on_read> callback and whenever	1126	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	1127	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	1128	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	1129	leave the data there if you want to accumulate more (e.g. when only a
905	partial message has been received so far).	1130	partial message has been received so far), or change the read queue with
		1131	e.g. C<push_read>.
906		1132
907	In the more complex case, you want to queue multiple callbacks. In this	1133	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	1134	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	1135	data arrives (also the first time it is queued) and remove it when it has
910	done its job (see C<push_read>, below).	1136	done its job (see C<push_read>, below).
911		1137
912	This way you can, for example, push three line-reads, followed by reading	1138	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.	1139	a chunk of data, and AnyEvent::Handle will execute them in order.
914		1140
…		…
972		1198
973	sub _drain_rbuf {	1199	sub _drain_rbuf {
974	my ($self) = @_;	1200	my ($self) = @_;
975		1201
976	# avoid recursion	1202	# avoid recursion
977	return if exists $self->{_skip_drain_rbuf};	1203	return if $self->{_skip_drain_rbuf};
978	local $self->{_skip_drain_rbuf} = 1;	1204	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		1205
987	while () {	1206	while () {
988	# we need to use a separate tls read buffer, as we must not receive data while	1207	# 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.	1208	# we are draining the buffer, and this can only happen with TLS.
990	$self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf};	1209	$self->{rbuf} .= delete $self->{_tls_rbuf}
		1210	if exists $self->{_tls_rbuf};
991		1211
992	my $len = length $self->{rbuf};	1212	my $len = length $self->{rbuf};
993		1213
994	if (my $cb = shift @{ $self->{_queue} }) {	1214	if (my $cb = shift @{ $self->{_queue} }) {
995	unless ($cb->($self)) {	1215	unless ($cb->($self)) {
996	if ($self->{_eof}) {	1216	# no progress can be made
997	# no progress can be made (not enough data and no data forthcoming)	1217	# (not enough data and no data forthcoming)
998	$self->_error (Errno::EPIPE, 1), return;	1218	$self->_error (Errno::EPIPE, 1), return
999	}	1219	if $self->{_eof};
1000		1220
1001	unshift @{ $self->{_queue} }, $cb;	1221	unshift @{ $self->{_queue} }, $cb;
1002	last;	1222	last;
1003	}	1223	}
1004	} elsif ($self->{on_read}) {	1224	} elsif ($self->{on_read}) {
…		…
1024	last;	1244	last;
1025	}	1245	}
1026	}	1246	}
1027		1247
1028	if ($self->{_eof}) {	1248	if ($self->{_eof}) {
1029	if ($self->{on_eof}) {	1249	$self->{on_eof}
1030	$self->{on_eof}($self)	1250	? $self->{on_eof}($self)
1031	} else {
1032	$self->_error (0, 1, "Unexpected end-of-file");	1251	: $self->_error (0, 1, "Unexpected end-of-file");
1033	}	1252
		1253	return;
		1254	}
		1255
		1256	if (
		1257	defined $self->{rbuf_max}
		1258	&& $self->{rbuf_max} < length $self->{rbuf}
		1259	) {
		1260	$self->_error (Errno::ENOSPC, 1), return;
1034	}	1261	}
1035		1262
1036	# may need to restart read watcher	1263	# may need to restart read watcher
1037	unless ($self->{_rw}) {	1264	unless ($self->{_rw}) {
1038	$self->start_read	1265	$self->start_read
…		…
1044		1271
1045	This replaces the currently set C<on_read> callback, or clears it (when	1272	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	1273	the new callback is C<undef>). See the description of C<on_read> in the
1047	constructor.	1274	constructor.
1048		1275
		1276	This method may invoke callbacks (and therefore the handle might be
		1277	destroyed after it returns).
		1278
1049	=cut	1279	=cut
1050		1280
1051	sub on_read {	1281	sub on_read {
1052	my ($self, $cb) = @_;	1282	my ($self, $cb) = @_;
1053		1283
…		…
1055	$self->_drain_rbuf if $cb;	1285	$self->_drain_rbuf if $cb;
1056	}	1286	}
1057		1287
1058	=item $handle->rbuf	1288	=item $handle->rbuf
1059		1289
1060	Returns the read buffer (as a modifiable lvalue).	1290	Returns the read buffer (as a modifiable lvalue). You can also access the
		1291	read buffer directly as the C<< ->{rbuf} >> member, if you want (this is
		1292	much faster, and no less clean).
1061		1293
1062	You can access the read buffer directly as the C<< ->{rbuf} >>	1294	The only operation allowed on the read buffer (apart from looking at it)
1063	member, if you want. However, the only operation allowed on the	1295	is removing data from its beginning. Otherwise modifying or appending to
1064	read buffer (apart from looking at it) is removing data from its	1296	it is not allowed and will lead to hard-to-track-down bugs.
1065	beginning. Otherwise modifying or appending to it is not allowed and will
1066	lead to hard-to-track-down bugs.
1067		1297
1068	NOTE: The read buffer should only be used or modified if the C<on_read>,	1298	NOTE: The read buffer should only be used or modified in the C<on_read>
1069	C<push_read> or C<unshift_read> methods are used. The other read methods	1299	callback or when C<push_read> or C<unshift_read> are used with a single
1070	automatically manage the read buffer.	1300	callback (i.e. untyped). Typed C<push_read> and C<unshift_read> methods
		1301	will manage the read buffer on their own.
1071		1302
1072	=cut	1303	=cut
1073		1304
1074	sub rbuf : lvalue {	1305	sub rbuf : lvalue {
1075	$_[0]{rbuf}	1306	$_[0]{rbuf}
…		…
1092		1323
1093	If enough data was available, then the callback must remove all data it is	1324	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	1325	interested in (which can be none at all) and return a true value. After returning
1095	true, it will be removed from the queue.	1326	true, it will be removed from the queue.
1096		1327
		1328	These methods may invoke callbacks (and therefore the handle might be
		1329	destroyed after it returns).
		1330
1097	=cut	1331	=cut
1098		1332
1099	our %RH;	1333	our %RH;
1100		1334
1101	sub register_read_type($$) {	1335	sub register_read_type($$) {
…		…
1107	my $cb = pop;	1341	my $cb = pop;
1108		1342
1109	if (@_) {	1343	if (@_) {
1110	my $type = shift;	1344	my $type = shift;
1111		1345
		1346	$cb = ($RH{$type} \|\|= _load_func "$type\::anyevent_read_type"
1112	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	1347	or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_read")
1113	->($self, $cb, @_);	1348	->($self, $cb, @_);
1114	}	1349	}
1115		1350
1116	push @{ $self->{_queue} }, $cb;	1351	push @{ $self->{_queue} }, $cb;
1117	$self->_drain_rbuf;	1352	$self->_drain_rbuf;
…		…
1122	my $cb = pop;	1357	my $cb = pop;
1123		1358
1124	if (@_) {	1359	if (@_) {
1125	my $type = shift;	1360	my $type = shift;
1126		1361
		1362	$cb = ($RH{$type} \|\|= _load_func "$type\::anyevent_read_type"
1127	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")	1363	or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::unshift_read")
1128	->($self, $cb, @_);	1364	->($self, $cb, @_);
1129	}	1365	}
1130
1131		1366
1132	unshift @{ $self->{_queue} }, $cb;	1367	unshift @{ $self->{_queue} }, $cb;
1133	$self->_drain_rbuf;	1368	$self->_drain_rbuf;
1134	}	1369	}
1135		1370
…		…
1137		1372
1138	=item $handle->unshift_read (type => @args, $cb)	1373	=item $handle->unshift_read (type => @args, $cb)
1139		1374
1140	Instead of providing a callback that parses the data itself you can chose	1375	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	1376	between a number of predefined parsing formats, for chunks of data, lines
1142	etc.	1377	etc. You can also specify the (fully qualified) name of a package, in
		1378	which case AnyEvent tries to load the package and then expects to find the
		1379	C<anyevent_read_type> function inside (see "custom read types", below).
1143		1380
1144	Predefined types are (if you have ideas for additional types, feel free to	1381	Predefined types are (if you have ideas for additional types, feel free to
1145	drop by and tell us):	1382	drop by and tell us):
1146		1383
1147	=over 4	1384	=over 4
…		…
1239	the receive buffer when neither C<$accept> nor C<$reject> match,	1476	the receive buffer when neither C<$accept> nor C<$reject> match,
1240	and everything preceding and including the match will be accepted	1477	and everything preceding and including the match will be accepted
1241	unconditionally. This is useful to skip large amounts of data that you	1478	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	1479	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	1480	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.	1481	and is usually worth it only when you expect more than a few kilobytes.
1245		1482
1246	Example: expect a http header, which ends at C<\015\012\015\012>. Since we	1483	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	1484	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	1485	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	1486	it only accepts something not ending in either \015 or \012, as these are
1250	required for the accept regex.	1487	required for the accept regex.
1251		1488
1252	$handle->push_read (regex =>	1489	$handle->push_read (regex =>
…		…
1387	=cut	1624	=cut
1388		1625
1389	register_read_type json => sub {	1626	register_read_type json => sub {
1390	my ($self, $cb) = @_;	1627	my ($self, $cb) = @_;
1391		1628
1392	my $json = $self->{json} \|\|=	1629	my $json = $self->{json} \|\|= json_coder;
1393	eval { require JSON::XS; JSON::XS->new->utf8 }
1394	\|\| do { require JSON; JSON->new->utf8 };
1395		1630
1396	my $data;	1631	my $data;
1397	my $rbuf = \$self->{rbuf};	1632	my $rbuf = \$self->{rbuf};
1398		1633
1399	sub {	1634	sub {
…		…
1468	}	1703	}
1469	};	1704	};
1470		1705
1471	=back	1706	=back
1472		1707
1473	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)	1708	=item custom read types - Package::anyevent_read_type $handle, $cb, @args
1474		1709
1475	This function (not method) lets you add your own types to C<push_read>.	1710	Instead of one of the predefined types, you can also specify the name
		1711	of a package. AnyEvent will try to load the package and then expects to
		1712	find a function named C<anyevent_read_type> inside. If it isn't found, it
		1713	progressively tries to load the parent package until it either finds the
		1714	function (good) or runs out of packages (bad).
1476		1715
1477	Whenever the given C<type> is used, C<push_read> will invoke the code	1716	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	1717	handle object, the original callback and the remaining arguments.
1479	arguments.
1480		1718
1481	The code reference is supposed to return a callback (usually a closure)	1719	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) >>).	1720	works as a plain read callback (see C<< ->push_read ($cb) >>), so you can
		1721	mentally treat the function as a "configurable read type to read callback"
		1722	converter.
1483		1723
1484	It should invoke the passed callback when it is done reading (remember to	1724	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).	1725	to pass C<$handle> as first argument as all other callbacks do that,
		1726	although there is no strict requirement on this).
1486		1727
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>,	1728	For examples, see the source of this module (F<perldoc -m
1491	search for C<register_read_type>)).	1729	AnyEvent::Handle>, search for C<register_read_type>)).
1492		1730
1493	=item $handle->stop_read	1731	=item $handle->stop_read
1494		1732
1495	=item $handle->start_read	1733	=item $handle->start_read
1496		1734
…		…
1516	}	1754	}
1517		1755
1518	sub start_read {	1756	sub start_read {
1519	my ($self) = @_;	1757	my ($self) = @_;
1520		1758
1521	unless ($self->{_rw} \|\| $self->{_eof}) {	1759	unless ($self->{_rw} \|\| $self->{_eof} \|\| !$self->{fh}) {
1522	Scalar::Util::weaken $self;	1760	Scalar::Util::weaken $self;
1523		1761
1524	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1762	$self->{_rw} = AE::io $self->{fh}, 0, sub {
1525	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});	1763	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1526	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;	1764	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size}, length $$rbuf;
1527		1765
1528	if ($len > 0) {	1766	if ($len > 0) {
1529	$self->{_activity} = AnyEvent->now;	1767	$self->{_activity} = $self->{_ractivity} = AE::now;
1530		1768
1531	if ($self->{tls}) {	1769	if ($self->{tls}) {
1532	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);	1770	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1533		1771
1534	&_dotls ($self);	1772	&_dotls ($self);
1535	} else {	1773	} else {
1536	$self->_drain_rbuf;	1774	$self->_drain_rbuf;
1537	}	1775	}
1538		1776
		1777	if ($len == $self->{read_size}) {
		1778	$self->{read_size} *= 2;
		1779	$self->{read_size} = $self->{max_read_size} \|\| MAX_READ_SIZE
		1780	if $self->{read_size} > ($self->{max_read_size} \|\| MAX_READ_SIZE);
		1781	}
		1782
1539	} elsif (defined $len) {	1783	} elsif (defined $len) {
1540	delete $self->{_rw};	1784	delete $self->{_rw};
1541	$self->{_eof} = 1;	1785	$self->{_eof} = 1;
1542	$self->_drain_rbuf;	1786	$self->_drain_rbuf;
1543		1787
1544	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1788	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1545	return $self->_error ($!, 1);	1789	return $self->_error ($!, 1);
1546	}	1790	}
1547	});	1791	};
1548	}	1792	}
1549	}	1793	}
1550		1794
1551	our $ERROR_SYSCALL;	1795	our $ERROR_SYSCALL;
1552	our $ERROR_WANT_READ;	1796	our $ERROR_WANT_READ;
…		…
1619	&& ($tmp != $ERROR_SYSCALL \|\| $!);	1863	&& ($tmp != $ERROR_SYSCALL \|\| $!);
1620		1864
1621	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1865	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1622	$self->{wbuf} .= $tmp;	1866	$self->{wbuf} .= $tmp;
1623	$self->_drain_wbuf;	1867	$self->_drain_wbuf;
		1868	$self->{tls} or return; # tls session might have gone away in callback
1624	}	1869	}
1625		1870
1626	$self->{_on_starttls}	1871	$self->{_on_starttls}
1627	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()	1872	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
1628	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");	1873	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	1894	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	1895	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	1896	changed to your liking. Note that the handshake might have already started
1652	when this function returns.	1897	when this function returns.
1653		1898
1654	If it an error to start a TLS handshake more than once per	1899	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).	1900	handshakes on the same stream. It is best to not attempt to use the
		1901	stream after stopping TLS.
		1902
		1903	This method may invoke callbacks (and therefore the handle might be
		1904	destroyed after it returns).
1656		1905
1657	=cut	1906	=cut
1658		1907
1659	our %TLS_CACHE; #TODO not yet documented, should we?	1908	our %TLS_CACHE; #TODO not yet documented, should we?
1660		1909
1661	sub starttls {	1910	sub starttls {
1662	my ($self, $ssl, $ctx) = @_;	1911	my ($self, $tls, $ctx) = @_;
		1912
		1913	Carp::croak "It is an error to call starttls on an AnyEvent::Handle object while TLS is already active, caught"
		1914	if $self->{tls};
		1915
		1916	$self->{tls} = $tls;
		1917	$self->{tls_ctx} = $ctx if @_ > 2;
		1918
		1919	return unless $self->{fh};
1663		1920
1664	require Net::SSLeay;	1921	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		1922
1669	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();	1923	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1670	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();	1924	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1671		1925
		1926	$tls = delete $self->{tls};
1672	$ctx \|\|= $self->{tls_ctx};	1927	$ctx = $self->{tls_ctx};
1673		1928
1674	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session	1929	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
1675		1930
1676	if ("HASH" eq ref $ctx) {	1931	if ("HASH" eq ref $ctx) {
1677	require AnyEvent::TLS;	1932	require AnyEvent::TLS;
…		…
1683	$ctx = new AnyEvent::TLS %$ctx;	1938	$ctx = new AnyEvent::TLS %$ctx;
1684	}	1939	}
1685	}	1940	}
1686		1941
1687	$self->{tls_ctx} = $ctx \|\| TLS_CTX ();	1942	$self->{tls_ctx} = $ctx \|\| TLS_CTX ();
1688	$self->{tls} = $ssl = $self->{tls_ctx}->_get_session ($ssl, $self, $self->{peername});	1943	$self->{tls} = $tls = $self->{tls_ctx}->_get_session ($tls, $self, $self->{peername});
1689		1944
1690	# basically, this is deep magic (because SSL_read should have the same issues)	1945	# 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".	1946	# but the openssl maintainers basically said: "trust us, it just works".
1692	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1947	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1693	# and mismaintained ssleay-module doesn't even offer them).	1948	# 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	1955	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
1701	# have identity issues in that area.	1956	# have identity issues in that area.
1702	# Net::SSLeay::CTX_set_mode ($ssl,	1957	# Net::SSLeay::CTX_set_mode ($ssl,
1703	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1958	# (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
1704	# \| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));	1959	# \| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
1705	Net::SSLeay::CTX_set_mode ($ssl, 1\|2);	1960	Net::SSLeay::CTX_set_mode ($tls, 1\|2);
1706		1961
1707	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1962	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1708	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1963	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1709		1964
		1965	Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf});
		1966
1710	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1967	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
1711		1968
1712	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }	1969	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1713	if $self->{on_starttls};	1970	if $self->{on_starttls};
1714		1971
1715	&_dotls; # need to trigger the initial handshake	1972	&_dotls; # need to trigger the initial handshake
…		…
1718		1975
1719	=item $handle->stoptls	1976	=item $handle->stoptls
1720		1977
1721	Shuts down the SSL connection - this makes a proper EOF handshake by	1978	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	1979	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	1980	support non-blocking shut downs, it is not guaranteed that you can re-use
1724	afterwards.	1981	the stream afterwards.
		1982
		1983	This method may invoke callbacks (and therefore the handle might be
		1984	destroyed after it returns).
1725		1985
1726	=cut	1986	=cut
1727		1987
1728	sub stoptls {	1988	sub stoptls {
1729	my ($self) = @_;	1989	my ($self) = @_;
1730		1990
1731	if ($self->{tls}) {	1991	if ($self->{tls} && $self->{fh}) {
1732	Net::SSLeay::shutdown ($self->{tls});	1992	Net::SSLeay::shutdown ($self->{tls});
1733		1993
1734	&_dotls;	1994	&_dotls;
1735		1995
1736	# # we don't give a shit. no, we do, but we can't. no...#d#	1996	# # we don't give a shit. no, we do, but we can't. no...#d#
…		…
1742	sub _freetls {	2002	sub _freetls {
1743	my ($self) = @_;	2003	my ($self) = @_;
1744		2004
1745	return unless $self->{tls};	2005	return unless $self->{tls};
1746		2006
1747	$self->{tls_ctx}->_put_session (delete $self->{tls});	2007	$self->{tls_ctx}->_put_session (delete $self->{tls})
		2008	if $self->{tls} > 0;
1748		2009
1749	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};	2010	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1750	}	2011	}
1751		2012
1752	sub DESTROY {	2013	sub DESTROY {
…		…
1760	my $fh = delete $self->{fh};	2021	my $fh = delete $self->{fh};
1761	my $wbuf = delete $self->{wbuf};	2022	my $wbuf = delete $self->{wbuf};
1762		2023
1763	my @linger;	2024	my @linger;
1764		2025
1765	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {	2026	push @linger, AE::io $fh, 1, sub {
1766	my $len = syswrite $fh, $wbuf, length $wbuf;	2027	my $len = syswrite $fh, $wbuf, length $wbuf;
1767		2028
1768	if ($len > 0) {	2029	if ($len > 0) {
1769	substr $wbuf, 0, $len, "";	2030	substr $wbuf, 0, $len, "";
1770	} else {	2031	} elsif (defined $len \|\| ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK)) {
1771	@linger = (); # end	2032	@linger = (); # end
1772	}	2033	}
1773	});	2034	};
1774	push @linger, AnyEvent->timer (after => $linger, cb => sub {	2035	push @linger, AE::timer $linger, 0, sub {
1775	@linger = ();	2036	@linger = ();
1776	});	2037	};
1777	}	2038	}
1778	}	2039	}
1779		2040
1780	=item $handle->destroy	2041	=item $handle->destroy
1781		2042
1782	Shuts down the handle object as much as possible - this call ensures that	2043	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	2044	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.	2045	will be freed. Any method you will call on the handle object after
		2046	destroying it in this way will be silently ignored (and it will return the
		2047	empty list).
1785		2048
1786	Normally, you can just "forget" any references to an AnyEvent::Handle	2049	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	2050	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	2051	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	2052	callback, so when you want to destroy the AnyEvent::Handle object from
…		…
1803	sub destroy {	2066	sub destroy {
1804	my ($self) = @_;	2067	my ($self) = @_;
1805		2068
1806	$self->DESTROY;	2069	$self->DESTROY;
1807	%$self = ();	2070	%$self = ();
		2071	bless $self, "AnyEvent::Handle::destroyed";
1808	}	2072	}
		2073
		2074	sub AnyEvent::Handle::destroyed::AUTOLOAD {
		2075	#nop
		2076	}
		2077
		2078	=item $handle->destroyed
		2079
		2080	Returns false as long as the handle hasn't been destroyed by a call to C<<
		2081	->destroy >>, true otherwise.
		2082
		2083	Can be useful to decide whether the handle is still valid after some
		2084	callback possibly destroyed the handle. For example, C<< ->push_write >>,
		2085	C<< ->starttls >> and other methods can call user callbacks, which in turn
		2086	can destroy the handle, so work can be avoided by checking sometimes:
		2087
		2088	$hdl->starttls ("accept");
		2089	return if $hdl->destroyed;
		2090	$hdl->push_write (...
		2091
		2092	Note that the call to C<push_write> will silently be ignored if the handle
		2093	has been destroyed, so often you can just ignore the possibility of the
		2094	handle being destroyed.
		2095
		2096	=cut
		2097
		2098	sub destroyed { 0 }
		2099	sub AnyEvent::Handle::destroyed::destroyed { 1 }
1809		2100
1810	=item AnyEvent::Handle::TLS_CTX	2101	=item AnyEvent::Handle::TLS_CTX
1811		2102
1812	This function creates and returns the AnyEvent::TLS object used by default	2103	This function creates and returns the AnyEvent::TLS object used by default
1813	for TLS mode.	2104	for TLS mode.
…		…
1845		2136
1846	=item I get different callback invocations in TLS mode/Why can't I pause	2137	=item I get different callback invocations in TLS mode/Why can't I pause
1847	reading?	2138	reading?
1848		2139
1849	Unlike, say, TCP, TLS connections do not consist of two independent	2140	Unlike, say, TCP, TLS connections do not consist of two independent
1850	communication channels, one for each direction. Or put differently. The	2141	communication channels, one for each direction. Or put differently, the
1851	read and write directions are not independent of each other: you cannot	2142	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.	2143	write data unless you are also prepared to read, and vice versa.
1853		2144
1854	This can mean than, in TLS mode, you might get C<on_error> or C<on_eof>	2145	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	2146	callback invocations when you are not expecting any read data - the reason
1856	is that AnyEvent::Handle always reads in TLS mode.	2147	is that AnyEvent::Handle always reads in TLS mode.
1857		2148
1858	During the connection, you have to make sure that you always have a	2149	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	2150	non-empty read-queue, or an C<on_read> watcher. At the end of the
…		…
1873	my $data = delete $_[0]{rbuf};	2164	my $data = delete $_[0]{rbuf};
1874	});	2165	});
1875		2166
1876	The reason to use C<on_error> is that TCP connections, due to latencies	2167	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	2168	and packets loss, might get closed quite violently with an error, when in
1878	fact, all data has been received.	2169	fact all data has been received.
1879		2170
1880	It is usually better to use acknowledgements when transferring data,	2171	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	2172	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	2173	intact. This is also one reason why so many internet protocols have an
1883	explicit QUIT command.	2174	explicit QUIT command.
…		…
1900	consider using C<< ->push_shutdown >> instead.	2191	consider using C<< ->push_shutdown >> instead.
1901		2192
1902	=item I want to contact a TLS/SSL server, I don't care about security.	2193	=item I want to contact a TLS/SSL server, I don't care about security.
1903		2194
1904	If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS,	2195	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>	2196	connect to it and then create the AnyEvent::Handle with the C<tls>
1906	parameter:	2197	parameter:
1907		2198
1908	tcp_connect $host, $port, sub {	2199	tcp_connect $host, $port, sub {
1909	my ($fh) = @_;	2200	my ($fh) = @_;
1910		2201
…		…
2010		2301
2011	=item * all members not documented here and not prefixed with an underscore	2302	=item * all members not documented here and not prefixed with an underscore
2012	are free to use in subclasses.	2303	are free to use in subclasses.
2013		2304
2014	Of course, new versions of AnyEvent::Handle may introduce more "public"	2305	Of course, new versions of AnyEvent::Handle may introduce more "public"
2015	member variables, but thats just life, at least it is documented.	2306	member variables, but that's just life. At least it is documented.
2016		2307
2017	=back	2308	=back
2018		2309
2019	=head1 AUTHOR	2310	=head1 AUTHOR
2020		2311

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.203 by root, Sat Oct 16 03:22:10 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.203 by root, Sat Oct 16 03:22:10 2010 UTC