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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.160 by root, Fri Jul 24 22:47:04 2009 UTC vs.
Revision 1.206 by root, Mon Nov 15 19:49:31 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
…		…
101	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
102	prepare the file handle with parameters required for the actual connect	120	prepare the file handle with parameters required for the actual connect
103	(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
104	established).	122	established).
105		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
106	=item on_connect => $cb->($handle, $host, $port, $retry->())	128	=item on_connect => $cb->($handle, $host, $port, $retry->())
107		129
108	This callback is called when a connection has been successfully established.	130	This callback is called when a connection has been successfully established.
109		131
110	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
111	parameters, together with a retry callback.	133	parameters, together with a retry callback.
112		134
113	When, for some reason, the handle is not acceptable, then calling	135	If, for some reason, the handle is not acceptable, calling C<$retry>
114	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
115	multi-homed hosts or SRV records there can be multiple connection	137	hosts or SRV records there can be multiple connection endpoints). At the
116	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
117	tls status and similar properties of the handle are being reset.	139	similar properties of the handle will have been reset.
118		140
119	In most cases, ignoring the C<$retry> parameter is the way to go.	141	In most cases, you should ignore the C<$retry> parameter.
120		142
121	=item on_connect_error => $cb->($handle, $message)	143	=item on_connect_error => $cb->($handle, $message)
122		144
123	This callback is called when the conenction could not be	145	This callback is called when the connection could not be
124	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
125	message describing it (usually the same as C<"$!">).	147	message describing it (usually the same as C<"$!">).
126		148
127	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
128	fatal error instead.	150	fatal error instead.
…		…
131		153
132	=item on_error => $cb->($handle, $fatal, $message)	154	=item on_error => $cb->($handle, $fatal, $message)
133		155
134	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
135	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
136	connect or a read error.	158	connect, or a read error.
137		159
138	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
139	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<< ->
140	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
141	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
142	with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors. In	164	with active (but unsatisfiable) read watchers (C<EPIPE>) or I/O errors. In
143	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
144	often easiest to not report C<EPIPE> errors in this callback.	166	often easiest to not report C<EPIPE> errors in this callback.
145		167
146	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
147	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
148	recommended to always output the C<$message> argument in human-readable	170	recommended to always output the C<$message> argument in human-readable
149	error messages (it's usually the same as C<"$!">).	171	error messages (it's usually the same as C<"$!">).
150		172
151	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
152	to simply ignore this parameter and instead abondon the handle object	174	to simply ignore this parameter and instead abondon the handle object
153	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
154	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).	176	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
155		177
156	On callback entrance, the value of C<$!> contains the operating system	178	On entry to the callback, the value of C<$!> contains the operating
157	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
158	C<EPROTO>).	180	C<EPROTO>).
159		181
160	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
161	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
162	C<croak>.	184	C<croak>.
163		185
164	=item on_read => $cb->($handle)	186	=item on_read => $cb->($handle)
165		187
166	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
…		…
171	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 >>
172	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
173	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
174	the beginning from it.	196	the beginning from it.
175		197
		198	You can also call C<< ->push_read (...) >> or any other function that
		199	modifies the read queue. Or do both. Or ...
		200
176	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
177	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
178	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
179	error will be raised (with C<$!> set to C<EPIPE>).	204	error will be raised (with C<$!> set to C<EPIPE>).
180		205
181	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
…		…
200	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>.
201		226
202	=item on_drain => $cb->($handle)	227	=item on_drain => $cb->($handle)
203		228
204	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
205	(or when the callback is set and the buffer is empty already).	230	(or immediately if the buffer is empty already).
206		231
207	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.
208		233
209	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
210	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
…		…
212	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
213	the file when the write queue becomes empty.	238	the file when the write queue becomes empty.
214		239
215	=item timeout => $fractional_seconds	240	=item timeout => $fractional_seconds
216		241
		242	=item rtimeout => $fractional_seconds
		243
		244	=item wtimeout => $fractional_seconds
		245
217	If non-zero, then this enables an "inactivity" timeout: whenever this many	246	If non-zero, then these enables an "inactivity" timeout: whenever this
218	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
219	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
220	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).
221		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
222	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
223	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
224	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
225	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
226	restart the timeout.	262	restart the timeout.
227		263
228	Zero (the default) disables this timeout.	264	Zero (the default) disables this timeout.
229		265
…		…
245	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
246	isn't finished).	282	isn't finished).
247		283
248	=item autocork => <boolean>	284	=item autocork => <boolean>
249		285
250	When disabled (the default), then C<push_write> will try to immediately	286	When disabled (the default), C<push_write> will try to immediately
251	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
252	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
253	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
254	disadvantage is usually avoided by your kernel's nagle algorithm, see	290	disadvantage is usually avoided by your kernel's nagle algorithm, see
255	C<no_delay>, but this option can save costly syscalls).	291	C<no_delay>, but this option can save costly syscalls).
256		292
257	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
258	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,
259	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
260	the write buffer often is full). It also increases write latency.	296	the write buffer often is full). It also increases write latency.
261		297
262	=item no_delay => <boolean>	298	=item no_delay => <boolean>
…		…
266	the Nagle algorithm, and usually it is beneficial.	302	the Nagle algorithm, and usually it is beneficial.
267		303
268	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
269	accomplishd by setting this option to a true value.	305	accomplishd by setting this option to a true value.
270		306
271	The default is your opertaing system's default behaviour (most likely	307	The default is your operating system's default behaviour (most likely
272	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.
273		341
274	=item read_size => <bytes>	342	=item read_size => <bytes>
275		343
276	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
277	try to read during each loop iteration, which affects memory	345	read during each loop iteration. Each handle object will consume at least
278	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.
279		355
280	=item low_water_mark => <bytes>	356	=item low_water_mark => <bytes>
281		357
282	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
283	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
284	considered empty.	360	considered empty.
285		361
286	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
287	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
288	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
289	is good in almost all cases.	365	is good in almost all cases.
290		366
291	=item linger => <seconds>	367	=item linger => <seconds>
292		368
293	If non-zero (default: C<3600>), then the destructor of the	369	If this is non-zero (default: C<3600>), the destructor of the
294	AnyEvent::Handle object will check whether there is still outstanding	370	AnyEvent::Handle object will check whether there is still outstanding
295	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
296	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
297	system treats outstanding data at socket close time).	373	system treats outstanding data at socket close time).
298		374
…		…
305	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
306	(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.
307		383
308	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
309	peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This	385	peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This
310	verification will be skipped when C<peername> is not specified or	386	verification will be skipped when C<peername> is not specified or is
311	C<undef>.	387	C<undef>.
312		388
313	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	389	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
314		390
315	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
316	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
317	established and will transparently encrypt/decrypt data afterwards.	393	established and will transparently encrypt/decrypt data afterwards.
318		394
319	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
320	appropriate error message.	396	appropriate error message.
321		397
…		…
341	B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,	417	B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,
342	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
343	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
344	segmentation fault.	420	segmentation fault.
345		421
346	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.
347		423
348	=item tls_ctx => $anyevent_tls	424	=item tls_ctx => $anyevent_tls
349		425
350	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
351	(unless a connection object was specified directly). If this parameter is	427	(unless a connection object was specified directly). If this parameter is
…		…
366		442
367	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
368	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>.
369		445
370	Without this callback, handshake failures lead to C<on_error> being	446	Without this callback, handshake failures lead to C<on_error> being
371	called, as normal.	447	called as usual.
372		448
373	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
374	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
375	then call C<< ->starttls >> again.	451	then call C<< ->starttls >> again.
376		452
377	=item on_stoptls => $cb->($handle)	453	=item on_stoptls => $cb->($handle)
378		454
…		…
426	$self->{connect}[0],	502	$self->{connect}[0],
427	$self->{connect}[1],	503	$self->{connect}[1],
428	sub {	504	sub {
429	my ($fh, $host, $port, $retry) = @_;	505	my ($fh, $host, $port, $retry) = @_;
430		506
		507	delete $self->{_connect}; # no longer needed
		508
431	if ($fh) {	509	if ($fh) {
432	$self->{fh} = $fh;	510	$self->{fh} = $fh;
433		511
434	delete $self->{_skip_drain_rbuf};	512	delete $self->{_skip_drain_rbuf};
435	$self->_start;	513	$self->_start;
436		514
437	$self->{on_connect}	515	$self->{on_connect}
438	and $self->{on_connect}($self, $host, $port, sub {	516	and $self->{on_connect}($self, $host, $port, sub {
439	delete @$self{qw(fh _tw _ww _rw _eof _queue rbuf _wbuf tls _tls_rbuf _tls_wbuf)};	517	delete @$self{qw(fh _tw _rtw _wtw _ww _rw _eof _queue rbuf _wbuf tls _tls_rbuf _tls_wbuf)};
440	$self->{_skip_drain_rbuf} = 1;	518	$self->{_skip_drain_rbuf} = 1;
441	&$retry;	519	&$retry;
442	});	520	});
443		521
444	} else {	522	} else {
445	if ($self->{on_connect_error}) {	523	if ($self->{on_connect_error}) {
446	$self->{on_connect_error}($self, "$!");	524	$self->{on_connect_error}($self, "$!");
447	$self->destroy;	525	$self->destroy;
448	} else {	526	} else {
449	$self->fatal ($!, 1);	527	$self->_error ($!, 1);
450	}	528	}
451	}	529	}
452	},	530	},
453	sub {	531	sub {
454	local $self->{fh} = $_[0];	532	local $self->{fh} = $_[0];
455		533
		534	$self->{on_prepare}
456	$self->{on_prepare}->($self)	535	? $self->{on_prepare}->($self)
457	if $self->{on_prepare};	536	: ()
458	}	537	}
459	);	538	);
460	}	539	}
461		540
462	} else {	541	} else {
…		…
467	}	546	}
468		547
469	sub _start {	548	sub _start {
470	my ($self) = @_;	549	my ($self) = @_;
471		550
		551	# too many clueless people try to use udp and similar sockets
		552	# with AnyEvent::Handle, do them a favour.
		553	my $type = getsockopt $self->{fh}, Socket::SOL_SOCKET (), Socket::SO_TYPE ();
		554	Carp::croak "AnyEvent::Handle: only stream sockets supported, anything else will NOT work!"
		555	if Socket::SOCK_STREAM () != (unpack "I", $type) && defined $type;
		556
472	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	557	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
473		558
		559	$self->{_activity} =
		560	$self->{_ractivity} =
474	$self->{_activity} = AnyEvent->now;	561	$self->{_wactivity} = AE::now;
475	$self->_timeout;
476		562
		563	$self->{read_size} \|\|= 2048;
		564	$self->{max_read_size} = $self->{read_size}
		565	if $self->{read_size} > ($self->{max_read_size} \|\| MAX_READ_SIZE);
		566
		567	$self->timeout (delete $self->{timeout} ) if $self->{timeout};
		568	$self->rtimeout (delete $self->{rtimeout} ) if $self->{rtimeout};
		569	$self->wtimeout (delete $self->{wtimeout} ) if $self->{wtimeout};
		570
477	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};	571	$self->no_delay (delete $self->{no_delay} ) if exists $self->{no_delay} && $self->{no_delay};
		572	$self->keepalive (delete $self->{keepalive}) if exists $self->{keepalive} && $self->{keepalive};
478		573
		574	$self->oobinline (exists $self->{oobinline} ? delete $self->{oobinline} : 1);
		575
479	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})	576	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
480	if $self->{tls};	577	if $self->{tls};
481		578
482	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	579	$self->on_drain (delete $self->{on_drain} ) if $self->{on_drain};
483		580
484	$self->start_read	581	$self->start_read
485	if $self->{on_read} \|\| @{ $self->{_queue} };	582	if $self->{on_read} \|\| @{ $self->{_queue} };
486		583
487	$self->_drain_wbuf;	584	$self->_drain_wbuf;
488	}	585	}
489
490	#sub _shutdown {
491	# my ($self) = @_;
492	#
493	# delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)};
494	# $self->{_eof} = 1; # tell starttls et. al to stop trying
495	#
496	# &_freetls;
497	#}
498		586
499	sub _error {	587	sub _error {
500	my ($self, $errno, $fatal, $message) = @_;	588	my ($self, $errno, $fatal, $message) = @_;
501		589
502	$! = $errno;	590	$! = $errno;
503	$message \|\|= "$!";	591	$message \|\|= "$!";
504		592
505	if ($self->{on_error}) {	593	if ($self->{on_error}) {
506	$self->{on_error}($self, $fatal, $message);	594	$self->{on_error}($self, $fatal, $message);
507	$self->destroy if $fatal;	595	$self->destroy if $fatal;
508	} elsif ($self->{fh}) {	596	} elsif ($self->{fh} \|\| $self->{connect}) {
509	$self->destroy;	597	$self->destroy;
510	Carp::croak "AnyEvent::Handle uncaught error: $message";	598	Carp::croak "AnyEvent::Handle uncaught error: $message";
511	}	599	}
512	}	600	}
513		601
…		…
539	$_[0]{on_eof} = $_[1];	627	$_[0]{on_eof} = $_[1];
540	}	628	}
541		629
542	=item $handle->on_timeout ($cb)	630	=item $handle->on_timeout ($cb)
543		631
544	Replace the current C<on_timeout> callback, or disables the callback (but	632	=item $handle->on_rtimeout ($cb)
545	not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
546	argument and method.
547		633
548	=cut	634	=item $handle->on_wtimeout ($cb)
549		635
550	sub on_timeout {	636	Replace the current C<on_timeout>, C<on_rtimeout> or C<on_wtimeout>
551	$_[0]{on_timeout} = $_[1];	637	callback, or disables the callback (but not the timeout) if C<$cb> =
552	}	638	C<undef>. See the C<timeout> constructor argument and method.
		639
		640	=cut
		641
		642	# see below
553		643
554	=item $handle->autocork ($boolean)	644	=item $handle->autocork ($boolean)
555		645
556	Enables or disables the current autocork behaviour (see C<autocork>	646	Enables or disables the current autocork behaviour (see C<autocork>
557	constructor argument). Changes will only take effect on the next write.	647	constructor argument). Changes will only take effect on the next write.
…		…
570	=cut	660	=cut
571		661
572	sub no_delay {	662	sub no_delay {
573	$_[0]{no_delay} = $_[1];	663	$_[0]{no_delay} = $_[1];
574		664
		665	setsockopt $_[0]{fh}, Socket::IPPROTO_TCP (), Socket::TCP_NODELAY (), int $_[1]
		666	if $_[0]{fh};
		667	}
		668
		669	=item $handle->keepalive ($boolean)
		670
		671	Enables or disables the C<keepalive> setting (see constructor argument of
		672	the same name for details).
		673
		674	=cut
		675
		676	sub keepalive {
		677	$_[0]{keepalive} = $_[1];
		678
575	eval {	679	eval {
576	local $SIG{__DIE__};	680	local $SIG{__DIE__};
577	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1]	681	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
578	if $_[0]{fh};	682	if $_[0]{fh};
579	};	683	};
580	}	684	}
581		685
		686	=item $handle->oobinline ($boolean)
		687
		688	Enables or disables the C<oobinline> setting (see constructor argument of
		689	the same name for details).
		690
		691	=cut
		692
		693	sub oobinline {
		694	$_[0]{oobinline} = $_[1];
		695
		696	eval {
		697	local $SIG{__DIE__};
		698	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_OOBINLINE (), int $_[1]
		699	if $_[0]{fh};
		700	};
		701	}
		702
		703	=item $handle->keepalive ($boolean)
		704
		705	Enables or disables the C<keepalive> setting (see constructor argument of
		706	the same name for details).
		707
		708	=cut
		709
		710	sub keepalive {
		711	$_[0]{keepalive} = $_[1];
		712
		713	eval {
		714	local $SIG{__DIE__};
		715	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
		716	if $_[0]{fh};
		717	};
		718	}
		719
582	=item $handle->on_starttls ($cb)	720	=item $handle->on_starttls ($cb)
583		721
584	Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument).	722	Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument).
585		723
586	=cut	724	=cut
…		…
593		731
594	Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).	732	Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).
595		733
596	=cut	734	=cut
597		735
598	sub on_starttls {	736	sub on_stoptls {
599	$_[0]{on_stoptls} = $_[1];	737	$_[0]{on_stoptls} = $_[1];
600	}	738	}
601		739
		740	=item $handle->rbuf_max ($max_octets)
		741
		742	Configures the C<rbuf_max> setting (C<undef> disables it).
		743
		744	=cut
		745
		746	sub rbuf_max {
		747	$_[0]{rbuf_max} = $_[1];
		748	}
		749
602	#############################################################################	750	#############################################################################
603		751
604	=item $handle->timeout ($seconds)	752	=item $handle->timeout ($seconds)
605		753
		754	=item $handle->rtimeout ($seconds)
		755
		756	=item $handle->wtimeout ($seconds)
		757
606	Configures (or disables) the inactivity timeout.	758	Configures (or disables) the inactivity timeout.
607		759
608	=cut	760	=item $handle->timeout_reset
609		761
610	sub timeout {	762	=item $handle->rtimeout_reset
		763
		764	=item $handle->wtimeout_reset
		765
		766	Reset the activity timeout, as if data was received or sent.
		767
		768	These methods are cheap to call.
		769
		770	=cut
		771
		772	for my $dir ("", "r", "w") {
		773	my $timeout = "${dir}timeout";
		774	my $tw = "_${dir}tw";
		775	my $on_timeout = "on_${dir}timeout";
		776	my $activity = "_${dir}activity";
		777	my $cb;
		778
		779	*$on_timeout = sub {
		780	$_[0]{$on_timeout} = $_[1];
		781	};
		782
		783	*$timeout = sub {
611	my ($self, $timeout) = @_;	784	my ($self, $new_value) = @_;
612		785
		786	$new_value >= 0
		787	or Carp::croak "AnyEvent::Handle->$timeout called with negative timeout ($new_value), caught";
		788
613	$self->{timeout} = $timeout;	789	$self->{$timeout} = $new_value;
614	$self->_timeout;	790	delete $self->{$tw}; &$cb;
615	}	791	};
616		792
		793	*{"${dir}timeout_reset"} = sub {
		794	$_[0]{$activity} = AE::now;
		795	};
		796
		797	# main workhorse:
617	# reset the timeout watcher, as neccessary	798	# reset the timeout watcher, as neccessary
618	# also check for time-outs	799	# also check for time-outs
619	sub _timeout {	800	$cb = sub {
620	my ($self) = @_;	801	my ($self) = @_;
621		802
622	if ($self->{timeout} && $self->{fh}) {	803	if ($self->{$timeout} && $self->{fh}) {
623	my $NOW = AnyEvent->now;	804	my $NOW = AE::now;
624		805
625	# when would the timeout trigger?	806	# when would the timeout trigger?
626	my $after = $self->{_activity} + $self->{timeout} - $NOW;	807	my $after = $self->{$activity} + $self->{$timeout} - $NOW;
627		808
628	# now or in the past already?	809	# now or in the past already?
629	if ($after <= 0) {	810	if ($after <= 0) {
630	$self->{_activity} = $NOW;	811	$self->{$activity} = $NOW;
631		812
632	if ($self->{on_timeout}) {	813	if ($self->{$on_timeout}) {
633	$self->{on_timeout}($self);	814	$self->{$on_timeout}($self);
634	} else {	815	} else {
635	$self->_error (Errno::ETIMEDOUT);	816	$self->_error (Errno::ETIMEDOUT);
		817	}
		818
		819	# callback could have changed timeout value, optimise
		820	return unless $self->{$timeout};
		821
		822	# calculate new after
		823	$after = $self->{$timeout};
636	}	824	}
637		825
638	# callback could have changed timeout value, optimise	826	Scalar::Util::weaken $self;
639	return unless $self->{timeout};	827	return unless $self; # ->error could have destroyed $self
640		828
641	# calculate new after	829	$self->{$tw} \|\|= AE::timer $after, 0, sub {
642	$after = $self->{timeout};	830	delete $self->{$tw};
		831	$cb->($self);
		832	};
		833	} else {
		834	delete $self->{$tw};
643	}	835	}
644
645	Scalar::Util::weaken $self;
646	return unless $self; # ->error could have destroyed $self
647
648	$self->{_tw} \|\|= AnyEvent->timer (after => $after, cb => sub {
649	delete $self->{_tw};
650	$self->_timeout;
651	});
652	} else {
653	delete $self->{_tw};
654	}	836	}
655	}	837	}
656		838
657	#############################################################################	839	#############################################################################
658		840
…		…
673		855
674	=item $handle->on_drain ($cb)	856	=item $handle->on_drain ($cb)
675		857
676	Sets the C<on_drain> callback or clears it (see the description of	858	Sets the C<on_drain> callback or clears it (see the description of
677	C<on_drain> in the constructor).	859	C<on_drain> in the constructor).
		860
		861	This method may invoke callbacks (and therefore the handle might be
		862	destroyed after it returns).
678		863
679	=cut	864	=cut
680		865
681	sub on_drain {	866	sub on_drain {
682	my ($self, $cb) = @_;	867	my ($self, $cb) = @_;
…		…
691		876
692	Queues the given scalar to be written. You can push as much data as you	877	Queues the given scalar to be written. You can push as much data as you
693	want (only limited by the available memory), as C<AnyEvent::Handle>	878	want (only limited by the available memory), as C<AnyEvent::Handle>
694	buffers it independently of the kernel.	879	buffers it independently of the kernel.
695		880
		881	This method may invoke callbacks (and therefore the handle might be
		882	destroyed after it returns).
		883
696	=cut	884	=cut
697		885
698	sub _drain_wbuf {	886	sub _drain_wbuf {
699	my ($self) = @_;	887	my ($self) = @_;
700		888
…		…
706	my $len = syswrite $self->{fh}, $self->{wbuf};	894	my $len = syswrite $self->{fh}, $self->{wbuf};
707		895
708	if (defined $len) {	896	if (defined $len) {
709	substr $self->{wbuf}, 0, $len, "";	897	substr $self->{wbuf}, 0, $len, "";
710		898
711	$self->{_activity} = AnyEvent->now;	899	$self->{_activity} = $self->{_wactivity} = AE::now;
712		900
713	$self->{on_drain}($self)	901	$self->{on_drain}($self)
714	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})	902	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
715	&& $self->{on_drain};	903	&& $self->{on_drain};
716		904
…		…
722		910
723	# try to write data immediately	911	# try to write data immediately
724	$cb->() unless $self->{autocork};	912	$cb->() unless $self->{autocork};
725		913
726	# if still data left in wbuf, we need to poll	914	# if still data left in wbuf, we need to poll
727	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	915	$self->{_ww} = AE::io $self->{fh}, 1, $cb
728	if length $self->{wbuf};	916	if length $self->{wbuf};
729	};	917	};
730	}	918	}
731		919
732	our %WH;	920	our %WH;
733		921
		922	# deprecated
734	sub register_write_type($$) {	923	sub register_write_type($$) {
735	$WH{$_[0]} = $_[1];	924	$WH{$_[0]} = $_[1];
736	}	925	}
737		926
738	sub push_write {	927	sub push_write {
739	my $self = shift;	928	my $self = shift;
740		929
741	if (@_ > 1) {	930	if (@_ > 1) {
742	my $type = shift;	931	my $type = shift;
743		932
		933	@_ = ($WH{$type} \|\|= _load_func "$type\::anyevent_write_type"
744	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	934	or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_write")
745	->($self, @_);	935	->($self, @_);
746	}	936	}
747		937
		938	# we downgrade here to avoid hard-to-track-down bugs,
		939	# and diagnose the problem earlier and better.
		940
748	if ($self->{tls}) {	941	if ($self->{tls}) {
749	$self->{_tls_wbuf} .= $_[0];	942	utf8::downgrade $self->{_tls_wbuf} .= $_[0];
750	&_dotls ($self) if $self->{fh};	943	&_dotls ($self) if $self->{fh};
751	} else {	944	} else {
752	$self->{wbuf} .= $_[0];	945	utf8::downgrade $self->{wbuf} .= $_[0];
753	$self->_drain_wbuf if $self->{fh};	946	$self->_drain_wbuf if $self->{fh};
754	}	947	}
755	}	948	}
756		949
757	=item $handle->push_write (type => @args)	950	=item $handle->push_write (type => @args)
758		951
759	Instead of formatting your data yourself, you can also let this module do	952	Instead of formatting your data yourself, you can also let this module
760	the job by specifying a type and type-specific arguments.	953	do the job by specifying a type and type-specific arguments. You
		954	can also specify the (fully qualified) name of a package, in which
		955	case AnyEvent tries to load the package and then expects to find the
		956	C<anyevent_write_type> function inside (see "custom write types", below).
761		957
762	Predefined types are (if you have ideas for additional types, feel free to	958	Predefined types are (if you have ideas for additional types, feel free to
763	drop by and tell us):	959	drop by and tell us):
764		960
765	=over 4	961	=over 4
…		…
822	Other languages could read single lines terminated by a newline and pass	1018	Other languages could read single lines terminated by a newline and pass
823	this line into their JSON decoder of choice.	1019	this line into their JSON decoder of choice.
824		1020
825	=cut	1021	=cut
826		1022
		1023	sub json_coder() {
		1024	eval { require JSON::XS; JSON::XS->new->utf8 }
		1025	\|\| do { require JSON; JSON->new->utf8 }
		1026	}
		1027
827	register_write_type json => sub {	1028	register_write_type json => sub {
828	my ($self, $ref) = @_;	1029	my ($self, $ref) = @_;
829		1030
830	require JSON;	1031	my $json = $self->{json} \|\|= json_coder;
831		1032
832	$self->{json} ? $self->{json}->encode ($ref)	1033	$json->encode ($ref)
833	: JSON::encode_json ($ref)
834	};	1034	};
835		1035
836	=item storable => $reference	1036	=item storable => $reference
837		1037
838	Freezes the given reference using L<Storable> and writes it to the	1038	Freezes the given reference using L<Storable> and writes it to the
…		…
864	the peer.	1064	the peer.
865		1065
866	You can rely on the normal read queue and C<on_eof> handling	1066	You can rely on the normal read queue and C<on_eof> handling
867	afterwards. This is the cleanest way to close a connection.	1067	afterwards. This is the cleanest way to close a connection.
868		1068
		1069	This method may invoke callbacks (and therefore the handle might be
		1070	destroyed after it returns).
		1071
869	=cut	1072	=cut
870		1073
871	sub push_shutdown {	1074	sub push_shutdown {
872	my ($self) = @_;	1075	my ($self) = @_;
873		1076
874	delete $self->{low_water_mark};	1077	delete $self->{low_water_mark};
875	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });	1078	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });
876	}	1079	}
877		1080
878	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	1081	=item custom write types - Package::anyevent_write_type $handle, @args
879		1082
880	This function (not method) lets you add your own types to C<push_write>.	1083	Instead of one of the predefined types, you can also specify the name of
		1084	a package. AnyEvent will try to load the package and then expects to find
		1085	a function named C<anyevent_write_type> inside. If it isn't found, it
		1086	progressively tries to load the parent package until it either finds the
		1087	function (good) or runs out of packages (bad).
		1088
881	Whenever the given C<type> is used, C<push_write> will invoke the code	1089	Whenever the given C<type> is used, C<push_write> will the function with
882	reference with the handle object and the remaining arguments.	1090	the handle object and the remaining arguments.
883		1091
884	The code reference is supposed to return a single octet string that will	1092	The function is supposed to return a single octet string that will be
885	be appended to the write buffer.	1093	appended to the write buffer, so you cna mentally treat this function as a
		1094	"arguments to on-the-wire-format" converter.
886		1095
887	Note that this is a function, and all types registered this way will be	1096	Example: implement a custom write type C<join> that joins the remaining
888	global, so try to use unique names.	1097	arguments using the first one.
		1098
		1099	$handle->push_write (My::Type => " ", 1,2,3);
		1100
		1101	# uses the following package, which can be defined in the "My::Type" or in
		1102	# the "My" modules to be auto-loaded, or just about anywhere when the
		1103	# My::Type::anyevent_write_type is defined before invoking it.
		1104
		1105	package My::Type;
		1106
		1107	sub anyevent_write_type {
		1108	my ($handle, $delim, @args) = @_;
		1109
		1110	join $delim, @args
		1111	}
889		1112
890	=cut	1113	=cut
891		1114
892	#############################################################################	1115	#############################################################################
893		1116
…		…
902	ways, the "simple" way, using only C<on_read> and the "complex" way, using	1125	ways, the "simple" way, using only C<on_read> and the "complex" way, using
903	a queue.	1126	a queue.
904		1127
905	In the simple case, you just install an C<on_read> callback and whenever	1128	In the simple case, you just install an C<on_read> callback and whenever
906	new data arrives, it will be called. You can then remove some data (if	1129	new data arrives, it will be called. You can then remove some data (if
907	enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna	1130	enough is there) from the read buffer (C<< $handle->rbuf >>). Or you can
908	leave the data there if you want to accumulate more (e.g. when only a	1131	leave the data there if you want to accumulate more (e.g. when only a
909	partial message has been received so far).	1132	partial message has been received so far), or change the read queue with
		1133	e.g. C<push_read>.
910		1134
911	In the more complex case, you want to queue multiple callbacks. In this	1135	In the more complex case, you want to queue multiple callbacks. In this
912	case, AnyEvent::Handle will call the first queued callback each time new	1136	case, AnyEvent::Handle will call the first queued callback each time new
913	data arrives (also the first time it is queued) and removes it when it has	1137	data arrives (also the first time it is queued) and remove it when it has
914	done its job (see C<push_read>, below).	1138	done its job (see C<push_read>, below).
915		1139
916	This way you can, for example, push three line-reads, followed by reading	1140	This way you can, for example, push three line-reads, followed by reading
917	a chunk of data, and AnyEvent::Handle will execute them in order.	1141	a chunk of data, and AnyEvent::Handle will execute them in order.
918		1142
…		…
976		1200
977	sub _drain_rbuf {	1201	sub _drain_rbuf {
978	my ($self) = @_;	1202	my ($self) = @_;
979		1203
980	# avoid recursion	1204	# avoid recursion
981	return if exists $self->{_skip_drain_rbuf};	1205	return if $self->{_skip_drain_rbuf};
982	local $self->{_skip_drain_rbuf} = 1;	1206	local $self->{_skip_drain_rbuf} = 1;
983
984	if (
985	defined $self->{rbuf_max}
986	&& $self->{rbuf_max} < length $self->{rbuf}
987	) {
988	$self->_error (Errno::ENOSPC, 1), return;
989	}
990		1207
991	while () {	1208	while () {
992	# we need to use a separate tls read buffer, as we must not receive data while	1209	# we need to use a separate tls read buffer, as we must not receive data while
993	# we are draining the buffer, and this can only happen with TLS.	1210	# we are draining the buffer, and this can only happen with TLS.
994	$self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf};	1211	$self->{rbuf} .= delete $self->{_tls_rbuf}
		1212	if exists $self->{_tls_rbuf};
995		1213
996	my $len = length $self->{rbuf};	1214	my $len = length $self->{rbuf};
997		1215
998	if (my $cb = shift @{ $self->{_queue} }) {	1216	if (my $cb = shift @{ $self->{_queue} }) {
999	unless ($cb->($self)) {	1217	unless ($cb->($self)) {
1000	if ($self->{_eof}) {	1218	# no progress can be made
1001	# no progress can be made (not enough data and no data forthcoming)	1219	# (not enough data and no data forthcoming)
1002	$self->_error (Errno::EPIPE, 1), return;	1220	$self->_error (Errno::EPIPE, 1), return
1003	}	1221	if $self->{_eof};
1004		1222
1005	unshift @{ $self->{_queue} }, $cb;	1223	unshift @{ $self->{_queue} }, $cb;
1006	last;	1224	last;
1007	}	1225	}
1008	} elsif ($self->{on_read}) {	1226	} elsif ($self->{on_read}) {
…		…
1028	last;	1246	last;
1029	}	1247	}
1030	}	1248	}
1031		1249
1032	if ($self->{_eof}) {	1250	if ($self->{_eof}) {
1033	if ($self->{on_eof}) {	1251	$self->{on_eof}
1034	$self->{on_eof}($self)	1252	? $self->{on_eof}($self)
1035	} else {
1036	$self->_error (0, 1, "Unexpected end-of-file");	1253	: $self->_error (0, 1, "Unexpected end-of-file");
1037	}	1254
		1255	return;
		1256	}
		1257
		1258	if (
		1259	defined $self->{rbuf_max}
		1260	&& $self->{rbuf_max} < length $self->{rbuf}
		1261	) {
		1262	$self->_error (Errno::ENOSPC, 1), return;
1038	}	1263	}
1039		1264
1040	# may need to restart read watcher	1265	# may need to restart read watcher
1041	unless ($self->{_rw}) {	1266	unless ($self->{_rw}) {
1042	$self->start_read	1267	$self->start_read
…		…
1048		1273
1049	This replaces the currently set C<on_read> callback, or clears it (when	1274	This replaces the currently set C<on_read> callback, or clears it (when
1050	the new callback is C<undef>). See the description of C<on_read> in the	1275	the new callback is C<undef>). See the description of C<on_read> in the
1051	constructor.	1276	constructor.
1052		1277
		1278	This method may invoke callbacks (and therefore the handle might be
		1279	destroyed after it returns).
		1280
1053	=cut	1281	=cut
1054		1282
1055	sub on_read {	1283	sub on_read {
1056	my ($self, $cb) = @_;	1284	my ($self, $cb) = @_;
1057		1285
…		…
1059	$self->_drain_rbuf if $cb;	1287	$self->_drain_rbuf if $cb;
1060	}	1288	}
1061		1289
1062	=item $handle->rbuf	1290	=item $handle->rbuf
1063		1291
1064	Returns the read buffer (as a modifiable lvalue).	1292	Returns the read buffer (as a modifiable lvalue). You can also access the
		1293	read buffer directly as the C<< ->{rbuf} >> member, if you want (this is
		1294	much faster, and no less clean).
1065		1295
1066	You can access the read buffer directly as the C<< ->{rbuf} >>	1296	The only operation allowed on the read buffer (apart from looking at it)
1067	member, if you want. However, the only operation allowed on the	1297	is removing data from its beginning. Otherwise modifying or appending to
1068	read buffer (apart from looking at it) is removing data from its	1298	it is not allowed and will lead to hard-to-track-down bugs.
1069	beginning. Otherwise modifying or appending to it is not allowed and will
1070	lead to hard-to-track-down bugs.
1071		1299
1072	NOTE: The read buffer should only be used or modified if the C<on_read>,	1300	NOTE: The read buffer should only be used or modified in the C<on_read>
1073	C<push_read> or C<unshift_read> methods are used. The other read methods	1301	callback or when C<push_read> or C<unshift_read> are used with a single
1074	automatically manage the read buffer.	1302	callback (i.e. untyped). Typed C<push_read> and C<unshift_read> methods
		1303	will manage the read buffer on their own.
1075		1304
1076	=cut	1305	=cut
1077		1306
1078	sub rbuf : lvalue {	1307	sub rbuf : lvalue {
1079	$_[0]{rbuf}	1308	$_[0]{rbuf}
…		…
1096		1325
1097	If enough data was available, then the callback must remove all data it is	1326	If enough data was available, then the callback must remove all data it is
1098	interested in (which can be none at all) and return a true value. After returning	1327	interested in (which can be none at all) and return a true value. After returning
1099	true, it will be removed from the queue.	1328	true, it will be removed from the queue.
1100		1329
		1330	These methods may invoke callbacks (and therefore the handle might be
		1331	destroyed after it returns).
		1332
1101	=cut	1333	=cut
1102		1334
1103	our %RH;	1335	our %RH;
1104		1336
1105	sub register_read_type($$) {	1337	sub register_read_type($$) {
…		…
1111	my $cb = pop;	1343	my $cb = pop;
1112		1344
1113	if (@_) {	1345	if (@_) {
1114	my $type = shift;	1346	my $type = shift;
1115		1347
		1348	$cb = ($RH{$type} \|\|= _load_func "$type\::anyevent_read_type"
1116	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	1349	or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_read")
1117	->($self, $cb, @_);	1350	->($self, $cb, @_);
1118	}	1351	}
1119		1352
1120	push @{ $self->{_queue} }, $cb;	1353	push @{ $self->{_queue} }, $cb;
1121	$self->_drain_rbuf;	1354	$self->_drain_rbuf;
…		…
1126	my $cb = pop;	1359	my $cb = pop;
1127		1360
1128	if (@_) {	1361	if (@_) {
1129	my $type = shift;	1362	my $type = shift;
1130		1363
		1364	$cb = ($RH{$type} \|\|= _load_func "$type\::anyevent_read_type"
1131	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")	1365	or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::unshift_read")
1132	->($self, $cb, @_);	1366	->($self, $cb, @_);
1133	}	1367	}
1134
1135		1368
1136	unshift @{ $self->{_queue} }, $cb;	1369	unshift @{ $self->{_queue} }, $cb;
1137	$self->_drain_rbuf;	1370	$self->_drain_rbuf;
1138	}	1371	}
1139		1372
…		…
1141		1374
1142	=item $handle->unshift_read (type => @args, $cb)	1375	=item $handle->unshift_read (type => @args, $cb)
1143		1376
1144	Instead of providing a callback that parses the data itself you can chose	1377	Instead of providing a callback that parses the data itself you can chose
1145	between a number of predefined parsing formats, for chunks of data, lines	1378	between a number of predefined parsing formats, for chunks of data, lines
1146	etc.	1379	etc. You can also specify the (fully qualified) name of a package, in
		1380	which case AnyEvent tries to load the package and then expects to find the
		1381	C<anyevent_read_type> function inside (see "custom read types", below).
1147		1382
1148	Predefined types are (if you have ideas for additional types, feel free to	1383	Predefined types are (if you have ideas for additional types, feel free to
1149	drop by and tell us):	1384	drop by and tell us):
1150		1385
1151	=over 4	1386	=over 4
…		…
1243	the receive buffer when neither C<$accept> nor C<$reject> match,	1478	the receive buffer when neither C<$accept> nor C<$reject> match,
1244	and everything preceding and including the match will be accepted	1479	and everything preceding and including the match will be accepted
1245	unconditionally. This is useful to skip large amounts of data that you	1480	unconditionally. This is useful to skip large amounts of data that you
1246	know cannot be matched, so that the C<$accept> or C<$reject> regex do not	1481	know cannot be matched, so that the C<$accept> or C<$reject> regex do not
1247	have to start matching from the beginning. This is purely an optimisation	1482	have to start matching from the beginning. This is purely an optimisation
1248	and is usually worth only when you expect more than a few kilobytes.	1483	and is usually worth it only when you expect more than a few kilobytes.
1249		1484
1250	Example: expect a http header, which ends at C<\015\012\015\012>. Since we	1485	Example: expect a http header, which ends at C<\015\012\015\012>. Since we
1251	expect the header to be very large (it isn't in practise, but...), we use	1486	expect the header to be very large (it isn't in practice, but...), we use
1252	a skip regex to skip initial portions. The skip regex is tricky in that	1487	a skip regex to skip initial portions. The skip regex is tricky in that
1253	it only accepts something not ending in either \015 or \012, as these are	1488	it only accepts something not ending in either \015 or \012, as these are
1254	required for the accept regex.	1489	required for the accept regex.
1255		1490
1256	$handle->push_read (regex =>	1491	$handle->push_read (regex =>
…		…
1391	=cut	1626	=cut
1392		1627
1393	register_read_type json => sub {	1628	register_read_type json => sub {
1394	my ($self, $cb) = @_;	1629	my ($self, $cb) = @_;
1395		1630
1396	my $json = $self->{json} \|\|=	1631	my $json = $self->{json} \|\|= json_coder;
1397	eval { require JSON::XS; JSON::XS->new->utf8 }
1398	\|\| do { require JSON; JSON->new->utf8 };
1399		1632
1400	my $data;	1633	my $data;
1401	my $rbuf = \$self->{rbuf};	1634	my $rbuf = \$self->{rbuf};
1402		1635
1403	sub {	1636	sub {
…		…
1472	}	1705	}
1473	};	1706	};
1474		1707
1475	=back	1708	=back
1476		1709
1477	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)	1710	=item custom read types - Package::anyevent_read_type $handle, $cb, @args
1478		1711
1479	This function (not method) lets you add your own types to C<push_read>.	1712	Instead of one of the predefined types, you can also specify the name
		1713	of a package. AnyEvent will try to load the package and then expects to
		1714	find a function named C<anyevent_read_type> inside. If it isn't found, it
		1715	progressively tries to load the parent package until it either finds the
		1716	function (good) or runs out of packages (bad).
1480		1717
1481	Whenever the given C<type> is used, C<push_read> will invoke the code	1718	Whenever this type is used, C<push_read> will invoke the function with the
1482	reference with the handle object, the callback and the remaining	1719	handle object, the original callback and the remaining arguments.
1483	arguments.
1484		1720
1485	The code reference is supposed to return a callback (usually a closure)	1721	The function is supposed to return a callback (usually a closure) that
1486	that works as a plain read callback (see C<< ->push_read ($cb) >>).	1722	works as a plain read callback (see C<< ->push_read ($cb) >>), so you can
		1723	mentally treat the function as a "configurable read type to read callback"
		1724	converter.
1487		1725
1488	It should invoke the passed callback when it is done reading (remember to	1726	It should invoke the original callback when it is done reading (remember
1489	pass C<$handle> as first argument as all other callbacks do that).	1727	to pass C<$handle> as first argument as all other callbacks do that,
		1728	although there is no strict requirement on this).
1490		1729
1491	Note that this is a function, and all types registered this way will be
1492	global, so try to use unique names.
1493
1494	For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>,	1730	For examples, see the source of this module (F<perldoc -m
1495	search for C<register_read_type>)).	1731	AnyEvent::Handle>, search for C<register_read_type>)).
1496		1732
1497	=item $handle->stop_read	1733	=item $handle->stop_read
1498		1734
1499	=item $handle->start_read	1735	=item $handle->start_read
1500		1736
…		…
1520	}	1756	}
1521		1757
1522	sub start_read {	1758	sub start_read {
1523	my ($self) = @_;	1759	my ($self) = @_;
1524		1760
1525	unless ($self->{_rw} \|\| $self->{_eof}) {	1761	unless ($self->{_rw} \|\| $self->{_eof} \|\| !$self->{fh}) {
1526	Scalar::Util::weaken $self;	1762	Scalar::Util::weaken $self;
1527		1763
1528	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1764	$self->{_rw} = AE::io $self->{fh}, 0, sub {
1529	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});	1765	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1530	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;	1766	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size}, length $$rbuf;
1531		1767
1532	if ($len > 0) {	1768	if ($len > 0) {
1533	$self->{_activity} = AnyEvent->now;	1769	$self->{_activity} = $self->{_ractivity} = AE::now;
1534		1770
1535	if ($self->{tls}) {	1771	if ($self->{tls}) {
1536	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);	1772	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1537		1773
1538	&_dotls ($self);	1774	&_dotls ($self);
1539	} else {	1775	} else {
1540	$self->_drain_rbuf;	1776	$self->_drain_rbuf;
1541	}	1777	}
1542		1778
		1779	if ($len == $self->{read_size}) {
		1780	$self->{read_size} *= 2;
		1781	$self->{read_size} = $self->{max_read_size} \|\| MAX_READ_SIZE
		1782	if $self->{read_size} > ($self->{max_read_size} \|\| MAX_READ_SIZE);
		1783	}
		1784
1543	} elsif (defined $len) {	1785	} elsif (defined $len) {
1544	delete $self->{_rw};	1786	delete $self->{_rw};
1545	$self->{_eof} = 1;	1787	$self->{_eof} = 1;
1546	$self->_drain_rbuf;	1788	$self->_drain_rbuf;
1547		1789
1548	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1790	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1549	return $self->_error ($!, 1);	1791	return $self->_error ($!, 1);
1550	}	1792	}
1551	});	1793	};
1552	}	1794	}
1553	}	1795	}
1554		1796
1555	our $ERROR_SYSCALL;	1797	our $ERROR_SYSCALL;
1556	our $ERROR_WANT_READ;	1798	our $ERROR_WANT_READ;
…		…
1623	&& ($tmp != $ERROR_SYSCALL \|\| $!);	1865	&& ($tmp != $ERROR_SYSCALL \|\| $!);
1624		1866
1625	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1867	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1626	$self->{wbuf} .= $tmp;	1868	$self->{wbuf} .= $tmp;
1627	$self->_drain_wbuf;	1869	$self->_drain_wbuf;
		1870	$self->{tls} or return; # tls session might have gone away in callback
1628	}	1871	}
1629		1872
1630	$self->{_on_starttls}	1873	$self->{_on_starttls}
1631	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()	1874	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
1632	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");	1875	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");
…		…
1654	context in C<< $handle->{tls_ctx} >> after this call and can be used or	1897	context in C<< $handle->{tls_ctx} >> after this call and can be used or
1655	changed to your liking. Note that the handshake might have already started	1898	changed to your liking. Note that the handshake might have already started
1656	when this function returns.	1899	when this function returns.
1657		1900
1658	Due to bugs in OpenSSL, it might or might not be possible to do multiple	1901	Due to bugs in OpenSSL, it might or might not be possible to do multiple
1659	handshakes on the same stream. Best do not attempt to use the stream after	1902	handshakes on the same stream. It is best to not attempt to use the
1660	stopping TLS.	1903	stream after stopping TLS.
		1904
		1905	This method may invoke callbacks (and therefore the handle might be
		1906	destroyed after it returns).
1661		1907
1662	=cut	1908	=cut
1663		1909
1664	our %TLS_CACHE; #TODO not yet documented, should we?	1910	our %TLS_CACHE; #TODO not yet documented, should we?
1665		1911
…		…
1677	require Net::SSLeay;	1923	require Net::SSLeay;
1678		1924
1679	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();	1925	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1680	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();	1926	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1681		1927
1682	$tls = $self->{tls};	1928	$tls = delete $self->{tls};
1683	$ctx = $self->{tls_ctx};	1929	$ctx = $self->{tls_ctx};
1684		1930
1685	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session	1931	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
1686		1932
1687	if ("HASH" eq ref $ctx) {	1933	if ("HASH" eq ref $ctx) {
…		…
1716	Net::SSLeay::CTX_set_mode ($tls, 1\|2);	1962	Net::SSLeay::CTX_set_mode ($tls, 1\|2);
1717		1963
1718	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1964	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1719	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1965	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1720		1966
		1967	Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf});
		1968
1721	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});	1969	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
1722		1970
1723	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }	1971	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1724	if $self->{on_starttls};	1972	if $self->{on_starttls};
1725		1973
…		…
1729		1977
1730	=item $handle->stoptls	1978	=item $handle->stoptls
1731		1979
1732	Shuts down the SSL connection - this makes a proper EOF handshake by	1980	Shuts down the SSL connection - this makes a proper EOF handshake by
1733	sending a close notify to the other side, but since OpenSSL doesn't	1981	sending a close notify to the other side, but since OpenSSL doesn't
1734	support non-blocking shut downs, it is not guarenteed that you can re-use	1982	support non-blocking shut downs, it is not guaranteed that you can re-use
1735	the stream afterwards.	1983	the stream afterwards.
		1984
		1985	This method may invoke callbacks (and therefore the handle might be
		1986	destroyed after it returns).
1736		1987
1737	=cut	1988	=cut
1738		1989
1739	sub stoptls {	1990	sub stoptls {
1740	my ($self) = @_;	1991	my ($self) = @_;
1741		1992
1742	if ($self->{tls}) {	1993	if ($self->{tls} && $self->{fh}) {
1743	Net::SSLeay::shutdown ($self->{tls});	1994	Net::SSLeay::shutdown ($self->{tls});
1744		1995
1745	&_dotls;	1996	&_dotls;
1746		1997
1747	# # we don't give a shit. no, we do, but we can't. no...#d#	1998	# # we don't give a shit. no, we do, but we can't. no...#d#
…		…
1754	my ($self) = @_;	2005	my ($self) = @_;
1755		2006
1756	return unless $self->{tls};	2007	return unless $self->{tls};
1757		2008
1758	$self->{tls_ctx}->_put_session (delete $self->{tls})	2009	$self->{tls_ctx}->_put_session (delete $self->{tls})
1759	if ref $self->{tls};	2010	if $self->{tls} > 0;
1760		2011
1761	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};	2012	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1762	}	2013	}
1763		2014
1764	sub DESTROY {	2015	sub DESTROY {
…		…
1772	my $fh = delete $self->{fh};	2023	my $fh = delete $self->{fh};
1773	my $wbuf = delete $self->{wbuf};	2024	my $wbuf = delete $self->{wbuf};
1774		2025
1775	my @linger;	2026	my @linger;
1776		2027
1777	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {	2028	push @linger, AE::io $fh, 1, sub {
1778	my $len = syswrite $fh, $wbuf, length $wbuf;	2029	my $len = syswrite $fh, $wbuf, length $wbuf;
1779		2030
1780	if ($len > 0) {	2031	if ($len > 0) {
1781	substr $wbuf, 0, $len, "";	2032	substr $wbuf, 0, $len, "";
1782	} else {	2033	} elsif (defined $len \|\| ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK)) {
1783	@linger = (); # end	2034	@linger = (); # end
1784	}	2035	}
1785	});	2036	};
1786	push @linger, AnyEvent->timer (after => $linger, cb => sub {	2037	push @linger, AE::timer $linger, 0, sub {
1787	@linger = ();	2038	@linger = ();
1788	});	2039	};
1789	}	2040	}
1790	}	2041	}
1791		2042
1792	=item $handle->destroy	2043	=item $handle->destroy
1793		2044
1794	Shuts down the handle object as much as possible - this call ensures that	2045	Shuts down the handle object as much as possible - this call ensures that
1795	no further callbacks will be invoked and as many resources as possible	2046	no further callbacks will be invoked and as many resources as possible
1796	will be freed. You must not call any methods on the object afterwards.	2047	will be freed. Any method you will call on the handle object after
		2048	destroying it in this way will be silently ignored (and it will return the
		2049	empty list).
1797		2050
1798	Normally, you can just "forget" any references to an AnyEvent::Handle	2051	Normally, you can just "forget" any references to an AnyEvent::Handle
1799	object and it will simply shut down. This works in fatal error and EOF	2052	object and it will simply shut down. This works in fatal error and EOF
1800	callbacks, as well as code outside. It does I<NOT> work in a read or write	2053	callbacks, as well as code outside. It does I<NOT> work in a read or write
1801	callback, so when you want to destroy the AnyEvent::Handle object from	2054	callback, so when you want to destroy the AnyEvent::Handle object from
…		…
1815	sub destroy {	2068	sub destroy {
1816	my ($self) = @_;	2069	my ($self) = @_;
1817		2070
1818	$self->DESTROY;	2071	$self->DESTROY;
1819	%$self = ();	2072	%$self = ();
		2073	bless $self, "AnyEvent::Handle::destroyed";
1820	}	2074	}
		2075
		2076	sub AnyEvent::Handle::destroyed::AUTOLOAD {
		2077	#nop
		2078	}
		2079
		2080	=item $handle->destroyed
		2081
		2082	Returns false as long as the handle hasn't been destroyed by a call to C<<
		2083	->destroy >>, true otherwise.
		2084
		2085	Can be useful to decide whether the handle is still valid after some
		2086	callback possibly destroyed the handle. For example, C<< ->push_write >>,
		2087	C<< ->starttls >> and other methods can call user callbacks, which in turn
		2088	can destroy the handle, so work can be avoided by checking sometimes:
		2089
		2090	$hdl->starttls ("accept");
		2091	return if $hdl->destroyed;
		2092	$hdl->push_write (...
		2093
		2094	Note that the call to C<push_write> will silently be ignored if the handle
		2095	has been destroyed, so often you can just ignore the possibility of the
		2096	handle being destroyed.
		2097
		2098	=cut
		2099
		2100	sub destroyed { 0 }
		2101	sub AnyEvent::Handle::destroyed::destroyed { 1 }
1821		2102
1822	=item AnyEvent::Handle::TLS_CTX	2103	=item AnyEvent::Handle::TLS_CTX
1823		2104
1824	This function creates and returns the AnyEvent::TLS object used by default	2105	This function creates and returns the AnyEvent::TLS object used by default
1825	for TLS mode.	2106	for TLS mode.
…		…
1857		2138
1858	=item I get different callback invocations in TLS mode/Why can't I pause	2139	=item I get different callback invocations in TLS mode/Why can't I pause
1859	reading?	2140	reading?
1860		2141
1861	Unlike, say, TCP, TLS connections do not consist of two independent	2142	Unlike, say, TCP, TLS connections do not consist of two independent
1862	communication channels, one for each direction. Or put differently. The	2143	communication channels, one for each direction. Or put differently, the
1863	read and write directions are not independent of each other: you cannot	2144	read and write directions are not independent of each other: you cannot
1864	write data unless you are also prepared to read, and vice versa.	2145	write data unless you are also prepared to read, and vice versa.
1865		2146
1866	This can mean than, in TLS mode, you might get C<on_error> or C<on_eof>	2147	This means that, in TLS mode, you might get C<on_error> or C<on_eof>
1867	callback invocations when you are not expecting any read data - the reason	2148	callback invocations when you are not expecting any read data - the reason
1868	is that AnyEvent::Handle always reads in TLS mode.	2149	is that AnyEvent::Handle always reads in TLS mode.
1869		2150
1870	During the connection, you have to make sure that you always have a	2151	During the connection, you have to make sure that you always have a
1871	non-empty read-queue, or an C<on_read> watcher. At the end of the	2152	non-empty read-queue, or an C<on_read> watcher. At the end of the
…		…
1885	my $data = delete $_[0]{rbuf};	2166	my $data = delete $_[0]{rbuf};
1886	});	2167	});
1887		2168
1888	The reason to use C<on_error> is that TCP connections, due to latencies	2169	The reason to use C<on_error> is that TCP connections, due to latencies
1889	and packets loss, might get closed quite violently with an error, when in	2170	and packets loss, might get closed quite violently with an error, when in
1890	fact, all data has been received.	2171	fact all data has been received.
1891		2172
1892	It is usually better to use acknowledgements when transferring data,	2173	It is usually better to use acknowledgements when transferring data,
1893	to make sure the other side hasn't just died and you got the data	2174	to make sure the other side hasn't just died and you got the data
1894	intact. This is also one reason why so many internet protocols have an	2175	intact. This is also one reason why so many internet protocols have an
1895	explicit QUIT command.	2176	explicit QUIT command.
…		…
1912	consider using C<< ->push_shutdown >> instead.	2193	consider using C<< ->push_shutdown >> instead.
1913		2194
1914	=item I want to contact a TLS/SSL server, I don't care about security.	2195	=item I want to contact a TLS/SSL server, I don't care about security.
1915		2196
1916	If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS,	2197	If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS,
1917	simply connect to it and then create the AnyEvent::Handle with the C<tls>	2198	connect to it and then create the AnyEvent::Handle with the C<tls>
1918	parameter:	2199	parameter:
1919		2200
1920	tcp_connect $host, $port, sub {	2201	tcp_connect $host, $port, sub {
1921	my ($fh) = @_;	2202	my ($fh) = @_;
1922		2203
…		…
2022		2303
2023	=item * all members not documented here and not prefixed with an underscore	2304	=item * all members not documented here and not prefixed with an underscore
2024	are free to use in subclasses.	2305	are free to use in subclasses.
2025		2306
2026	Of course, new versions of AnyEvent::Handle may introduce more "public"	2307	Of course, new versions of AnyEvent::Handle may introduce more "public"
2027	member variables, but thats just life, at least it is documented.	2308	member variables, but that's just life. At least it is documented.
2028		2309
2029	=back	2310	=back
2030		2311
2031	=head1 AUTHOR	2312	=head1 AUTHOR
2032		2313

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.160 by root, Fri Jul 24 22:47:04 2009 UTC vs. Revision 1.206 by root, Mon Nov 15 19:49:31 2010 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.160 by root, Fri Jul 24 22:47:04 2009 UTC vs.
Revision 1.206 by root, Mon Nov 15 19:49:31 2010 UTC