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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.162 by root, Sun Jul 26 00:17:25 2009 UTC vs.
Revision 1.205 by root, Mon Nov 15 17:11:00 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.87;
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
…		…
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
106	The return value of this callback should be the connect timeout value in	124	The return value of this callback should be the connect timeout value in
107	seconds (or C<0>, or C<undef>, or the empty list, to indicate the default	125	seconds (or C<0>, or C<undef>, or the empty list, to indicate that the
108	timeout is to be used).	126	default timeout is to be used).
109		127
110	=item on_connect => $cb->($handle, $host, $port, $retry->())	128	=item on_connect => $cb->($handle, $host, $port, $retry->())
111		129
112	This callback is called when a connection has been successfully established.	130	This callback is called when a connection has been successfully established.
113		131
114	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
115	parameters, together with a retry callback.	133	parameters, together with a retry callback.
116		134
117	When, for some reason, the handle is not acceptable, then calling	135	If, for some reason, the handle is not acceptable, calling C<$retry>
118	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
119	multi-homed hosts or SRV records there can be multiple connection	137	hosts or SRV records there can be multiple connection endpoints). At the
120	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
121	tls status and similar properties of the handle are being reset.	139	similar properties of the handle will have been reset.
122		140
123	In most cases, ignoring the C<$retry> parameter is the way to go.	141	In most cases, you should ignore the C<$retry> parameter.
124		142
125	=item on_connect_error => $cb->($handle, $message)	143	=item on_connect_error => $cb->($handle, $message)
126		144
127	This callback is called when the conenction could not be	145	This callback is called when the connection could not be
128	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
129	message describing it (usually the same as C<"$!">).	147	message describing it (usually the same as C<"$!">).
130		148
131	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
132	fatal error instead.	150	fatal error instead.
…		…
135		153
136	=item on_error => $cb->($handle, $fatal, $message)	154	=item on_error => $cb->($handle, $fatal, $message)
137		155
138	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
139	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
140	connect or a read error.	158	connect, or a read error.
141		159
142	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
143	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<< ->
144	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
145	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
146	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
147	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
148	often easiest to not report C<EPIPE> errors in this callback.	166	often easiest to not report C<EPIPE> errors in this callback.
149		167
150	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
151	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
152	recommended to always output the C<$message> argument in human-readable	170	recommended to always output the C<$message> argument in human-readable
153	error messages (it's usually the same as C<"$!">).	171	error messages (it's usually the same as C<"$!">).
154		172
155	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
156	to simply ignore this parameter and instead abondon the handle object	174	to simply ignore this parameter and instead abondon the handle object
157	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
158	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).	176	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
159		177
160	On callback entrance, the value of C<$!> contains the operating system	178	On entry to the callback, the value of C<$!> contains the operating
161	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
162	C<EPROTO>).	180	C<EPROTO>).
163		181
164	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
165	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
166	C<croak>.	184	C<croak>.
167		185
168	=item on_read => $cb->($handle)	186	=item on_read => $cb->($handle)
169		187
170	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
…		…
175	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 >>
176	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
177	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
178	the beginning from it.	196	the beginning from it.
179		197
		198	You can also call C<< ->push_read (...) >> or any other function that
		199	modifies the read queue. Or do both. Or ...
		200
180	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
181	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
182	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
183	error will be raised (with C<$!> set to C<EPIPE>).	204	error will be raised (with C<$!> set to C<EPIPE>).
184		205
185	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
…		…
204	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>.
205		226
206	=item on_drain => $cb->($handle)	227	=item on_drain => $cb->($handle)
207		228
208	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
209	(or when the callback is set and the buffer is empty already).	230	(or immediately if the buffer is empty already).
210		231
211	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.
212		233
213	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
214	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
…		…
216	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
217	the file when the write queue becomes empty.	238	the file when the write queue becomes empty.
218		239
219	=item timeout => $fractional_seconds	240	=item timeout => $fractional_seconds
220		241
		242	=item rtimeout => $fractional_seconds
		243
		244	=item wtimeout => $fractional_seconds
		245
221	If non-zero, then this enables an "inactivity" timeout: whenever this many	246	If non-zero, then these enables an "inactivity" timeout: whenever this
222	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
223	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
224	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).
225		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
226	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
227	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
228	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
229	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
230	restart the timeout.	262	restart the timeout.
231		263
232	Zero (the default) disables this timeout.	264	Zero (the default) disables this timeout.
233		265
…		…
249	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
250	isn't finished).	282	isn't finished).
251		283
252	=item autocork => <boolean>	284	=item autocork => <boolean>
253		285
254	When disabled (the default), then C<push_write> will try to immediately	286	When disabled (the default), C<push_write> will try to immediately
255	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
256	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
257	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
258	disadvantage is usually avoided by your kernel's nagle algorithm, see	290	disadvantage is usually avoided by your kernel's nagle algorithm, see
259	C<no_delay>, but this option can save costly syscalls).	291	C<no_delay>, but this option can save costly syscalls).
260		292
261	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
262	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,
263	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
264	the write buffer often is full). It also increases write latency.	296	the write buffer often is full). It also increases write latency.
265		297
266	=item no_delay => <boolean>	298	=item no_delay => <boolean>
…		…
270	the Nagle algorithm, and usually it is beneficial.	302	the Nagle algorithm, and usually it is beneficial.
271		303
272	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
273	accomplishd by setting this option to a true value.	305	accomplishd by setting this option to a true value.
274		306
275	The default is your opertaing system's default behaviour (most likely	307	The default is your operating system's default behaviour (most likely
276	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.
277		341
278	=item read_size => <bytes>	342	=item read_size => <bytes>
279		343
280	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
281	try to read during each loop iteration, which affects memory	345	read during each loop iteration. Each handle object will consume at least
282	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.
283		355
284	=item low_water_mark => <bytes>	356	=item low_water_mark => <bytes>
285		357
286	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
287	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
288	considered empty.	360	considered empty.
289		361
290	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
291	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
292	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
293	is good in almost all cases.	365	is good in almost all cases.
294		366
295	=item linger => <seconds>	367	=item linger => <seconds>
296		368
297	If non-zero (default: C<3600>), then the destructor of the	369	If this is non-zero (default: C<3600>), the destructor of the
298	AnyEvent::Handle object will check whether there is still outstanding	370	AnyEvent::Handle object will check whether there is still outstanding
299	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
300	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
301	system treats outstanding data at socket close time).	373	system treats outstanding data at socket close time).
302		374
…		…
309	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
310	(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.
311		383
312	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
313	peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This	385	peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This
314	verification will be skipped when C<peername> is not specified or	386	verification will be skipped when C<peername> is not specified or is
315	C<undef>.	387	C<undef>.
316		388
317	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	389	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
318		390
319	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
320	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
321	established and will transparently encrypt/decrypt data afterwards.	393	established and will transparently encrypt/decrypt data afterwards.
322		394
323	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
324	appropriate error message.	396	appropriate error message.
325		397
…		…
345	B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,	417	B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,
346	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
347	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
348	segmentation fault.	420	segmentation fault.
349		421
350	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.
351		423
352	=item tls_ctx => $anyevent_tls	424	=item tls_ctx => $anyevent_tls
353		425
354	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
355	(unless a connection object was specified directly). If this parameter is	427	(unless a connection object was specified directly). If this parameter is
…		…
370		442
371	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
372	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>.
373		445
374	Without this callback, handshake failures lead to C<on_error> being	446	Without this callback, handshake failures lead to C<on_error> being
375	called, as normal.	447	called as usual.
376		448
377	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
378	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
379	then call C<< ->starttls >> again.	451	then call C<< ->starttls >> again.
380		452
381	=item on_stoptls => $cb->($handle)	453	=item on_stoptls => $cb->($handle)
382		454
…		…
430	$self->{connect}[0],	502	$self->{connect}[0],
431	$self->{connect}[1],	503	$self->{connect}[1],
432	sub {	504	sub {
433	my ($fh, $host, $port, $retry) = @_;	505	my ($fh, $host, $port, $retry) = @_;
434		506
		507	delete $self->{_connect};
		508
435	if ($fh) {	509	if ($fh) {
436	$self->{fh} = $fh;	510	$self->{fh} = $fh;
437		511
438	delete $self->{_skip_drain_rbuf};	512	delete $self->{_skip_drain_rbuf};
439	$self->_start;	513	$self->_start;
440		514
441	$self->{on_connect}	515	$self->{on_connect}
442	and $self->{on_connect}($self, $host, $port, sub {	516	and $self->{on_connect}($self, $host, $port, sub {
443	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)};
444	$self->{_skip_drain_rbuf} = 1;	518	$self->{_skip_drain_rbuf} = 1;
445	&$retry;	519	&$retry;
446	});	520	});
447		521
448	} else {	522	} else {
…		…
472	}	546	}
473		547
474	sub _start {	548	sub _start {
475	my ($self) = @_;	549	my ($self) = @_;
476		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
477	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	557	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
478		558
		559	$self->{_activity} =
		560	$self->{_ractivity} =
479	$self->{_activity} = AnyEvent->now;	561	$self->{_wactivity} = AE::now;
480	$self->_timeout;
481		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
482	$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};
483		573
		574	$self->oobinline (exists $self->{oobinline} ? delete $self->{oobinline} : 1);
		575
484	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})	576	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
485	if $self->{tls};	577	if $self->{tls};
486		578
487	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	579	$self->on_drain (delete $self->{on_drain} ) if $self->{on_drain};
488		580
489	$self->start_read	581	$self->start_read
490	if $self->{on_read} \|\| @{ $self->{_queue} };	582	if $self->{on_read} \|\| @{ $self->{_queue} };
491		583
492	$self->_drain_wbuf;	584	$self->_drain_wbuf;
493	}	585	}
494
495	#sub _shutdown {
496	# my ($self) = @_;
497	#
498	# delete @$self{qw(_tw _rw _ww fh wbuf on_read _queue)};
499	# $self->{_eof} = 1; # tell starttls et. al to stop trying
500	#
501	# &_freetls;
502	#}
503		586
504	sub _error {	587	sub _error {
505	my ($self, $errno, $fatal, $message) = @_;	588	my ($self, $errno, $fatal, $message) = @_;
506		589
507	$! = $errno;	590	$! = $errno;
508	$message \|\|= "$!";	591	$message \|\|= "$!";
509		592
510	if ($self->{on_error}) {	593	if ($self->{on_error}) {
511	$self->{on_error}($self, $fatal, $message);	594	$self->{on_error}($self, $fatal, $message);
512	$self->destroy if $fatal;	595	$self->destroy if $fatal;
513	} elsif ($self->{fh}) {	596	} elsif ($self->{fh} \|\| $self->{connect}) {
514	$self->destroy;	597	$self->destroy;
515	Carp::croak "AnyEvent::Handle uncaught error: $message";	598	Carp::croak "AnyEvent::Handle uncaught error: $message";
516	}	599	}
517	}	600	}
518		601
…		…
544	$_[0]{on_eof} = $_[1];	627	$_[0]{on_eof} = $_[1];
545	}	628	}
546		629
547	=item $handle->on_timeout ($cb)	630	=item $handle->on_timeout ($cb)
548		631
549	Replace the current C<on_timeout> callback, or disables the callback (but	632	=item $handle->on_rtimeout ($cb)
550	not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
551	argument and method.
552		633
553	=cut	634	=item $handle->on_wtimeout ($cb)
554		635
555	sub on_timeout {	636	Replace the current C<on_timeout>, C<on_rtimeout> or C<on_wtimeout>
556	$_[0]{on_timeout} = $_[1];	637	callback, or disables the callback (but not the timeout) if C<$cb> =
557	}	638	C<undef>. See the C<timeout> constructor argument and method.
		639
		640	=cut
		641
		642	# see below
558		643
559	=item $handle->autocork ($boolean)	644	=item $handle->autocork ($boolean)
560		645
561	Enables or disables the current autocork behaviour (see C<autocork>	646	Enables or disables the current autocork behaviour (see C<autocork>
562	constructor argument). Changes will only take effect on the next write.	647	constructor argument). Changes will only take effect on the next write.
…		…
575	=cut	660	=cut
576		661
577	sub no_delay {	662	sub no_delay {
578	$_[0]{no_delay} = $_[1];	663	$_[0]{no_delay} = $_[1];
579		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
580	eval {	679	eval {
581	local $SIG{__DIE__};	680	local $SIG{__DIE__};
582	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1]	681	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
583	if $_[0]{fh};	682	if $_[0]{fh};
584	};	683	};
585	}	684	}
586		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
587	=item $handle->on_starttls ($cb)	720	=item $handle->on_starttls ($cb)
588		721
589	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).
590		723
591	=cut	724	=cut
…		…
598		731
599	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).
600		733
601	=cut	734	=cut
602		735
603	sub on_starttls {	736	sub on_stoptls {
604	$_[0]{on_stoptls} = $_[1];	737	$_[0]{on_stoptls} = $_[1];
605	}	738	}
606		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
607	#############################################################################	750	#############################################################################
608		751
609	=item $handle->timeout ($seconds)	752	=item $handle->timeout ($seconds)
610		753
		754	=item $handle->rtimeout ($seconds)
		755
		756	=item $handle->wtimeout ($seconds)
		757
611	Configures (or disables) the inactivity timeout.	758	Configures (or disables) the inactivity timeout.
612		759
613	=cut	760	=item $handle->timeout_reset
614		761
615	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 {
616	my ($self, $timeout) = @_;	784	my ($self, $new_value) = @_;
617		785
		786	$new_value >= 0
		787	or Carp::croak "AnyEvent::Handle->$timeout called with negative timeout ($new_value), caught";
		788
618	$self->{timeout} = $timeout;	789	$self->{$timeout} = $new_value;
619	$self->_timeout;	790	delete $self->{$tw}; &$cb;
620	}	791	};
621		792
		793	*{"${dir}timeout_reset"} = sub {
		794	$_[0]{$activity} = AE::now;
		795	};
		796
		797	# main workhorse:
622	# reset the timeout watcher, as neccessary	798	# reset the timeout watcher, as neccessary
623	# also check for time-outs	799	# also check for time-outs
624	sub _timeout {	800	$cb = sub {
625	my ($self) = @_;	801	my ($self) = @_;
626		802
627	if ($self->{timeout} && $self->{fh}) {	803	if ($self->{$timeout} && $self->{fh}) {
628	my $NOW = AnyEvent->now;	804	my $NOW = AE::now;
629		805
630	# when would the timeout trigger?	806	# when would the timeout trigger?
631	my $after = $self->{_activity} + $self->{timeout} - $NOW;	807	my $after = $self->{$activity} + $self->{$timeout} - $NOW;
632		808
633	# now or in the past already?	809	# now or in the past already?
634	if ($after <= 0) {	810	if ($after <= 0) {
635	$self->{_activity} = $NOW;	811	$self->{$activity} = $NOW;
636		812
637	if ($self->{on_timeout}) {	813	if ($self->{$on_timeout}) {
638	$self->{on_timeout}($self);	814	$self->{$on_timeout}($self);
639	} else {	815	} else {
640	$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};
641	}	824	}
642		825
643	# callback could have changed timeout value, optimise	826	Scalar::Util::weaken $self;
644	return unless $self->{timeout};	827	return unless $self; # ->error could have destroyed $self
645		828
646	# calculate new after	829	$self->{$tw} \|\|= AE::timer $after, 0, sub {
647	$after = $self->{timeout};	830	delete $self->{$tw};
		831	$cb->($self);
		832	};
		833	} else {
		834	delete $self->{$tw};
648	}	835	}
649
650	Scalar::Util::weaken $self;
651	return unless $self; # ->error could have destroyed $self
652
653	$self->{_tw} \|\|= AnyEvent->timer (after => $after, cb => sub {
654	delete $self->{_tw};
655	$self->_timeout;
656	});
657	} else {
658	delete $self->{_tw};
659	}	836	}
660	}	837	}
661		838
662	#############################################################################	839	#############################################################################
663		840
…		…
678		855
679	=item $handle->on_drain ($cb)	856	=item $handle->on_drain ($cb)
680		857
681	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
682	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).
683		863
684	=cut	864	=cut
685		865
686	sub on_drain {	866	sub on_drain {
687	my ($self, $cb) = @_;	867	my ($self, $cb) = @_;
…		…
696		876
697	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
698	want (only limited by the available memory), as C<AnyEvent::Handle>	878	want (only limited by the available memory), as C<AnyEvent::Handle>
699	buffers it independently of the kernel.	879	buffers it independently of the kernel.
700		880
		881	This method may invoke callbacks (and therefore the handle might be
		882	destroyed after it returns).
		883
701	=cut	884	=cut
702		885
703	sub _drain_wbuf {	886	sub _drain_wbuf {
704	my ($self) = @_;	887	my ($self) = @_;
705		888
…		…
711	my $len = syswrite $self->{fh}, $self->{wbuf};	894	my $len = syswrite $self->{fh}, $self->{wbuf};
712		895
713	if (defined $len) {	896	if (defined $len) {
714	substr $self->{wbuf}, 0, $len, "";	897	substr $self->{wbuf}, 0, $len, "";
715		898
716	$self->{_activity} = AnyEvent->now;	899	$self->{_activity} = $self->{_wactivity} = AE::now;
717		900
718	$self->{on_drain}($self)	901	$self->{on_drain}($self)
719	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})
720	&& $self->{on_drain};	903	&& $self->{on_drain};
721		904
…		…
727		910
728	# try to write data immediately	911	# try to write data immediately
729	$cb->() unless $self->{autocork};	912	$cb->() unless $self->{autocork};
730		913
731	# if still data left in wbuf, we need to poll	914	# if still data left in wbuf, we need to poll
732	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	915	$self->{_ww} = AE::io $self->{fh}, 1, $cb
733	if length $self->{wbuf};	916	if length $self->{wbuf};
734	};	917	};
735	}	918	}
736		919
737	our %WH;	920	our %WH;
738		921
		922	# deprecated
739	sub register_write_type($$) {	923	sub register_write_type($$) {
740	$WH{$_[0]} = $_[1];	924	$WH{$_[0]} = $_[1];
741	}	925	}
742		926
743	sub push_write {	927	sub push_write {
744	my $self = shift;	928	my $self = shift;
745		929
746	if (@_ > 1) {	930	if (@_ > 1) {
747	my $type = shift;	931	my $type = shift;
748		932
		933	@_ = ($WH{$type} \|\|= _load_func "$type\::anyevent_write_type"
749	@_ = ($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")
750	->($self, @_);	935	->($self, @_);
751	}	936	}
752		937
		938	# we downgrade here to avoid hard-to-track-down bugs,
		939	# and diagnose the problem earlier and better.
		940
753	if ($self->{tls}) {	941	if ($self->{tls}) {
754	$self->{_tls_wbuf} .= $_[0];	942	utf8::downgrade $self->{_tls_wbuf} .= $_[0];
755	&_dotls ($self) if $self->{fh};	943	&_dotls ($self) if $self->{fh};
756	} else {	944	} else {
757	$self->{wbuf} .= $_[0];	945	utf8::downgrade $self->{wbuf} .= $_[0];
758	$self->_drain_wbuf if $self->{fh};	946	$self->_drain_wbuf if $self->{fh};
759	}	947	}
760	}	948	}
761		949
762	=item $handle->push_write (type => @args)	950	=item $handle->push_write (type => @args)
763		951
764	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
765	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).
766		957
767	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
768	drop by and tell us):	959	drop by and tell us):
769		960
770	=over 4	961	=over 4
…		…
827	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
828	this line into their JSON decoder of choice.	1019	this line into their JSON decoder of choice.
829		1020
830	=cut	1021	=cut
831		1022
		1023	sub json_coder() {
		1024	eval { require JSON::XS; JSON::XS->new->utf8 }
		1025	\|\| do { require JSON; JSON->new->utf8 }
		1026	}
		1027
832	register_write_type json => sub {	1028	register_write_type json => sub {
833	my ($self, $ref) = @_;	1029	my ($self, $ref) = @_;
834		1030
835	require JSON;	1031	my $json = $self->{json} \|\|= json_coder;
836		1032
837	$self->{json} ? $self->{json}->encode ($ref)	1033	$json->encode ($ref)
838	: JSON::encode_json ($ref)
839	};	1034	};
840		1035
841	=item storable => $reference	1036	=item storable => $reference
842		1037
843	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
…		…
869	the peer.	1064	the peer.
870		1065
871	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
872	afterwards. This is the cleanest way to close a connection.	1067	afterwards. This is the cleanest way to close a connection.
873		1068
		1069	This method may invoke callbacks (and therefore the handle might be
		1070	destroyed after it returns).
		1071
874	=cut	1072	=cut
875		1073
876	sub push_shutdown {	1074	sub push_shutdown {
877	my ($self) = @_;	1075	my ($self) = @_;
878		1076
879	delete $self->{low_water_mark};	1077	delete $self->{low_water_mark};
880	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });	1078	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });
881	}	1079	}
882		1080
883	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	1081	=item custom write types - Package::anyevent_write_type $handle, @args
884		1082
885	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
886	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
887	reference with the handle object and the remaining arguments.	1090	the handle object and the remaining arguments.
888		1091
889	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
890	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.
891		1095
892	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
893	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	}
894		1112
895	=cut	1113	=cut
896		1114
897	#############################################################################	1115	#############################################################################
898		1116
…		…
907	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
908	a queue.	1126	a queue.
909		1127
910	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
911	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
912	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
913	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
914	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>.
915		1134
916	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
917	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
918	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
919	done its job (see C<push_read>, below).	1138	done its job (see C<push_read>, below).
920		1139
921	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
922	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.
923		1142
…		…
981		1200
982	sub _drain_rbuf {	1201	sub _drain_rbuf {
983	my ($self) = @_;	1202	my ($self) = @_;
984		1203
985	# avoid recursion	1204	# avoid recursion
986	return if exists $self->{_skip_drain_rbuf};	1205	return if $self->{_skip_drain_rbuf};
987	local $self->{_skip_drain_rbuf} = 1;	1206	local $self->{_skip_drain_rbuf} = 1;
988
989	if (
990	defined $self->{rbuf_max}
991	&& $self->{rbuf_max} < length $self->{rbuf}
992	) {
993	$self->_error (Errno::ENOSPC, 1), return;
994	}
995		1207
996	while () {	1208	while () {
997	# 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
998	# 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.
999	$self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf};	1211	$self->{rbuf} .= delete $self->{_tls_rbuf}
		1212	if exists $self->{_tls_rbuf};
1000		1213
1001	my $len = length $self->{rbuf};	1214	my $len = length $self->{rbuf};
1002		1215
1003	if (my $cb = shift @{ $self->{_queue} }) {	1216	if (my $cb = shift @{ $self->{_queue} }) {
1004	unless ($cb->($self)) {	1217	unless ($cb->($self)) {
1005	if ($self->{_eof}) {	1218	# no progress can be made
1006	# no progress can be made (not enough data and no data forthcoming)	1219	# (not enough data and no data forthcoming)
1007	$self->_error (Errno::EPIPE, 1), return;	1220	$self->_error (Errno::EPIPE, 1), return
1008	}	1221	if $self->{_eof};
1009		1222
1010	unshift @{ $self->{_queue} }, $cb;	1223	unshift @{ $self->{_queue} }, $cb;
1011	last;	1224	last;
1012	}	1225	}
1013	} elsif ($self->{on_read}) {	1226	} elsif ($self->{on_read}) {
…		…
1033	last;	1246	last;
1034	}	1247	}
1035	}	1248	}
1036		1249
1037	if ($self->{_eof}) {	1250	if ($self->{_eof}) {
1038	if ($self->{on_eof}) {	1251	$self->{on_eof}
1039	$self->{on_eof}($self)	1252	? $self->{on_eof}($self)
1040	} else {
1041	$self->_error (0, 1, "Unexpected end-of-file");	1253	: $self->_error (0, 1, "Unexpected end-of-file");
1042	}	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;
1043	}	1263	}
1044		1264
1045	# may need to restart read watcher	1265	# may need to restart read watcher
1046	unless ($self->{_rw}) {	1266	unless ($self->{_rw}) {
1047	$self->start_read	1267	$self->start_read
…		…
1053		1273
1054	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
1055	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
1056	constructor.	1276	constructor.
1057		1277
		1278	This method may invoke callbacks (and therefore the handle might be
		1279	destroyed after it returns).
		1280
1058	=cut	1281	=cut
1059		1282
1060	sub on_read {	1283	sub on_read {
1061	my ($self, $cb) = @_;	1284	my ($self, $cb) = @_;
1062		1285
…		…
1064	$self->_drain_rbuf if $cb;	1287	$self->_drain_rbuf if $cb;
1065	}	1288	}
1066		1289
1067	=item $handle->rbuf	1290	=item $handle->rbuf
1068		1291
1069	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).
1070		1295
1071	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)
1072	member, if you want. However, the only operation allowed on the	1297	is removing data from its beginning. Otherwise modifying or appending to
1073	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.
1074	beginning. Otherwise modifying or appending to it is not allowed and will
1075	lead to hard-to-track-down bugs.
1076		1299
1077	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>
1078	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
1079	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.
1080		1304
1081	=cut	1305	=cut
1082		1306
1083	sub rbuf : lvalue {	1307	sub rbuf : lvalue {
1084	$_[0]{rbuf}	1308	$_[0]{rbuf}
…		…
1101		1325
1102	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
1103	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
1104	true, it will be removed from the queue.	1328	true, it will be removed from the queue.
1105		1329
		1330	These methods may invoke callbacks (and therefore the handle might be
		1331	destroyed after it returns).
		1332
1106	=cut	1333	=cut
1107		1334
1108	our %RH;	1335	our %RH;
1109		1336
1110	sub register_read_type($$) {	1337	sub register_read_type($$) {
…		…
1116	my $cb = pop;	1343	my $cb = pop;
1117		1344
1118	if (@_) {	1345	if (@_) {
1119	my $type = shift;	1346	my $type = shift;
1120		1347
		1348	$cb = ($RH{$type} \|\|= _load_func "$type\::anyevent_read_type"
1121	$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")
1122	->($self, $cb, @_);	1350	->($self, $cb, @_);
1123	}	1351	}
1124		1352
1125	push @{ $self->{_queue} }, $cb;	1353	push @{ $self->{_queue} }, $cb;
1126	$self->_drain_rbuf;	1354	$self->_drain_rbuf;
…		…
1131	my $cb = pop;	1359	my $cb = pop;
1132		1360
1133	if (@_) {	1361	if (@_) {
1134	my $type = shift;	1362	my $type = shift;
1135		1363
		1364	$cb = ($RH{$type} \|\|= _load_func "$type\::anyevent_read_type"
1136	$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")
1137	->($self, $cb, @_);	1366	->($self, $cb, @_);
1138	}	1367	}
1139
1140		1368
1141	unshift @{ $self->{_queue} }, $cb;	1369	unshift @{ $self->{_queue} }, $cb;
1142	$self->_drain_rbuf;	1370	$self->_drain_rbuf;
1143	}	1371	}
1144		1372
…		…
1146		1374
1147	=item $handle->unshift_read (type => @args, $cb)	1375	=item $handle->unshift_read (type => @args, $cb)
1148		1376
1149	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
1150	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
1151	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).
1152		1382
1153	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
1154	drop by and tell us):	1384	drop by and tell us):
1155		1385
1156	=over 4	1386	=over 4
…		…
1248	the receive buffer when neither C<$accept> nor C<$reject> match,	1478	the receive buffer when neither C<$accept> nor C<$reject> match,
1249	and everything preceding and including the match will be accepted	1479	and everything preceding and including the match will be accepted
1250	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
1251	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
1252	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
1253	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.
1254		1484
1255	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
1256	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
1257	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
1258	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
1259	required for the accept regex.	1489	required for the accept regex.
1260		1490
1261	$handle->push_read (regex =>	1491	$handle->push_read (regex =>
…		…
1396	=cut	1626	=cut
1397		1627
1398	register_read_type json => sub {	1628	register_read_type json => sub {
1399	my ($self, $cb) = @_;	1629	my ($self, $cb) = @_;
1400		1630
1401	my $json = $self->{json} \|\|=	1631	my $json = $self->{json} \|\|= json_coder;
1402	eval { require JSON::XS; JSON::XS->new->utf8 }
1403	\|\| do { require JSON; JSON->new->utf8 };
1404		1632
1405	my $data;	1633	my $data;
1406	my $rbuf = \$self->{rbuf};	1634	my $rbuf = \$self->{rbuf};
1407		1635
1408	sub {	1636	sub {
…		…
1477	}	1705	}
1478	};	1706	};
1479		1707
1480	=back	1708	=back
1481		1709
1482	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)	1710	=item custom read types - Package::anyevent_read_type $handle, $cb, @args
1483		1711
1484	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).
1485		1717
1486	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
1487	reference with the handle object, the callback and the remaining	1719	handle object, the original callback and the remaining arguments.
1488	arguments.
1489		1720
1490	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
1491	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.
1492		1725
1493	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
1494	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).
1495		1729
1496	Note that this is a function, and all types registered this way will be
1497	global, so try to use unique names.
1498
1499	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
1500	search for C<register_read_type>)).	1731	AnyEvent::Handle>, search for C<register_read_type>)).
1501		1732
1502	=item $handle->stop_read	1733	=item $handle->stop_read
1503		1734
1504	=item $handle->start_read	1735	=item $handle->start_read
1505		1736
…		…
1525	}	1756	}
1526		1757
1527	sub start_read {	1758	sub start_read {
1528	my ($self) = @_;	1759	my ($self) = @_;
1529		1760
1530	unless ($self->{_rw} \|\| $self->{_eof}) {	1761	unless ($self->{_rw} \|\| $self->{_eof} \|\| !$self->{fh}) {
1531	Scalar::Util::weaken $self;	1762	Scalar::Util::weaken $self;
1532		1763
1533	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1764	$self->{_rw} = AE::io $self->{fh}, 0, sub {
1534	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});	1765	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1535	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;	1766	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size}, length $$rbuf;
1536		1767
1537	if ($len > 0) {	1768	if ($len > 0) {
1538	$self->{_activity} = AnyEvent->now;	1769	$self->{_activity} = $self->{_ractivity} = AE::now;
1539		1770
1540	if ($self->{tls}) {	1771	if ($self->{tls}) {
1541	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);	1772	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1542		1773
1543	&_dotls ($self);	1774	&_dotls ($self);
1544	} else {	1775	} else {
1545	$self->_drain_rbuf;	1776	$self->_drain_rbuf;
1546	}	1777	}
1547		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
1548	} elsif (defined $len) {	1785	} elsif (defined $len) {
1549	delete $self->{_rw};	1786	delete $self->{_rw};
1550	$self->{_eof} = 1;	1787	$self->{_eof} = 1;
1551	$self->_drain_rbuf;	1788	$self->_drain_rbuf;
1552		1789
1553	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1790	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1554	return $self->_error ($!, 1);	1791	return $self->_error ($!, 1);
1555	}	1792	}
1556	});	1793	};
1557	}	1794	}
1558	}	1795	}
1559		1796
1560	our $ERROR_SYSCALL;	1797	our $ERROR_SYSCALL;
1561	our $ERROR_WANT_READ;	1798	our $ERROR_WANT_READ;
…		…
1628	&& ($tmp != $ERROR_SYSCALL \|\| $!);	1865	&& ($tmp != $ERROR_SYSCALL \|\| $!);
1629		1866
1630	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1867	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1631	$self->{wbuf} .= $tmp;	1868	$self->{wbuf} .= $tmp;
1632	$self->_drain_wbuf;	1869	$self->_drain_wbuf;
		1870	$self->{tls} or return; # tls session might have gone away in callback
1633	}	1871	}
1634		1872
1635	$self->{_on_starttls}	1873	$self->{_on_starttls}
1636	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()	1874	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
1637	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");	1875	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");
…		…
1659	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
1660	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
1661	when this function returns.	1899	when this function returns.
1662		1900
1663	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
1664	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
1665	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).
1666		1907
1667	=cut	1908	=cut
1668		1909
1669	our %TLS_CACHE; #TODO not yet documented, should we?	1910	our %TLS_CACHE; #TODO not yet documented, should we?
1670		1911
…		…
1682	require Net::SSLeay;	1923	require Net::SSLeay;
1683		1924
1684	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();	1925	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1685	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();	1926	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1686		1927
1687	$tls = $self->{tls};	1928	$tls = delete $self->{tls};
1688	$ctx = $self->{tls_ctx};	1929	$ctx = $self->{tls_ctx};
1689		1930
1690	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
1691		1932
1692	if ("HASH" eq ref $ctx) {	1933	if ("HASH" eq ref $ctx) {
…		…
1721	Net::SSLeay::CTX_set_mode ($tls, 1\|2);	1962	Net::SSLeay::CTX_set_mode ($tls, 1\|2);
1722		1963
1723	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1964	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1724	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1965	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1725		1966
		1967	Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf});
		1968
1726	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});	1969	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
1727		1970
1728	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }	1971	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1729	if $self->{on_starttls};	1972	if $self->{on_starttls};
1730		1973
…		…
1734		1977
1735	=item $handle->stoptls	1978	=item $handle->stoptls
1736		1979
1737	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
1738	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
1739	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
1740	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).
1741		1987
1742	=cut	1988	=cut
1743		1989
1744	sub stoptls {	1990	sub stoptls {
1745	my ($self) = @_;	1991	my ($self) = @_;
1746		1992
1747	if ($self->{tls}) {	1993	if ($self->{tls} && $self->{fh}) {
1748	Net::SSLeay::shutdown ($self->{tls});	1994	Net::SSLeay::shutdown ($self->{tls});
1749		1995
1750	&_dotls;	1996	&_dotls;
1751		1997
1752	# # 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#
…		…
1759	my ($self) = @_;	2005	my ($self) = @_;
1760		2006
1761	return unless $self->{tls};	2007	return unless $self->{tls};
1762		2008
1763	$self->{tls_ctx}->_put_session (delete $self->{tls})	2009	$self->{tls_ctx}->_put_session (delete $self->{tls})
1764	if ref $self->{tls};	2010	if $self->{tls} > 0;
1765		2011
1766	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};	2012	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1767	}	2013	}
1768		2014
1769	sub DESTROY {	2015	sub DESTROY {
…		…
1777	my $fh = delete $self->{fh};	2023	my $fh = delete $self->{fh};
1778	my $wbuf = delete $self->{wbuf};	2024	my $wbuf = delete $self->{wbuf};
1779		2025
1780	my @linger;	2026	my @linger;
1781		2027
1782	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {	2028	push @linger, AE::io $fh, 1, sub {
1783	my $len = syswrite $fh, $wbuf, length $wbuf;	2029	my $len = syswrite $fh, $wbuf, length $wbuf;
1784		2030
1785	if ($len > 0) {	2031	if ($len > 0) {
1786	substr $wbuf, 0, $len, "";	2032	substr $wbuf, 0, $len, "";
1787	} else {	2033	} elsif (defined $len \|\| ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK)) {
1788	@linger = (); # end	2034	@linger = (); # end
1789	}	2035	}
1790	});	2036	};
1791	push @linger, AnyEvent->timer (after => $linger, cb => sub {	2037	push @linger, AE::timer $linger, 0, sub {
1792	@linger = ();	2038	@linger = ();
1793	});	2039	};
1794	}	2040	}
1795	}	2041	}
1796		2042
1797	=item $handle->destroy	2043	=item $handle->destroy
1798		2044
1799	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
1800	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
1801	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).
1802		2050
1803	Normally, you can just "forget" any references to an AnyEvent::Handle	2051	Normally, you can just "forget" any references to an AnyEvent::Handle
1804	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
1805	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
1806	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
…		…
1820	sub destroy {	2068	sub destroy {
1821	my ($self) = @_;	2069	my ($self) = @_;
1822		2070
1823	$self->DESTROY;	2071	$self->DESTROY;
1824	%$self = ();	2072	%$self = ();
		2073	bless $self, "AnyEvent::Handle::destroyed";
1825	}	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 }
1826		2102
1827	=item AnyEvent::Handle::TLS_CTX	2103	=item AnyEvent::Handle::TLS_CTX
1828		2104
1829	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
1830	for TLS mode.	2106	for TLS mode.
…		…
1862		2138
1863	=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
1864	reading?	2140	reading?
1865		2141
1866	Unlike, say, TCP, TLS connections do not consist of two independent	2142	Unlike, say, TCP, TLS connections do not consist of two independent
1867	communication channels, one for each direction. Or put differently. The	2143	communication channels, one for each direction. Or put differently, the
1868	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
1869	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.
1870		2146
1871	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>
1872	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
1873	is that AnyEvent::Handle always reads in TLS mode.	2149	is that AnyEvent::Handle always reads in TLS mode.
1874		2150
1875	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
1876	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
…		…
1890	my $data = delete $_[0]{rbuf};	2166	my $data = delete $_[0]{rbuf};
1891	});	2167	});
1892		2168
1893	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
1894	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
1895	fact, all data has been received.	2171	fact all data has been received.
1896		2172
1897	It is usually better to use acknowledgements when transferring data,	2173	It is usually better to use acknowledgements when transferring data,
1898	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
1899	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
1900	explicit QUIT command.	2176	explicit QUIT command.
…		…
1917	consider using C<< ->push_shutdown >> instead.	2193	consider using C<< ->push_shutdown >> instead.
1918		2194
1919	=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.
1920		2196
1921	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,
1922	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>
1923	parameter:	2199	parameter:
1924		2200
1925	tcp_connect $host, $port, sub {	2201	tcp_connect $host, $port, sub {
1926	my ($fh) = @_;	2202	my ($fh) = @_;
1927		2203
…		…
2027		2303
2028	=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
2029	are free to use in subclasses.	2305	are free to use in subclasses.
2030		2306
2031	Of course, new versions of AnyEvent::Handle may introduce more "public"	2307	Of course, new versions of AnyEvent::Handle may introduce more "public"
2032	member variables, but thats just life, at least it is documented.	2308	member variables, but that's just life. At least it is documented.
2033		2309
2034	=back	2310	=back
2035		2311
2036	=head1 AUTHOR	2312	=head1 AUTHOR
2037		2313

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.162 by root, Sun Jul 26 00:17:25 2009 UTC vs. Revision 1.205 by root, Mon Nov 15 17:11:00 2010 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.162 by root, Sun Jul 26 00:17:25 2009 UTC vs.
Revision 1.205 by root, Mon Nov 15 17:11:00 2010 UTC