[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.202 by root, Sat Oct 16 02:01:54 2010 UTC

…		…
1	package AnyEvent::Handle;
2
3	use Scalar::Util ();
4	use Carp ();
5	use Errno qw(EAGAIN EINTR);
6
7	use AnyEvent (); BEGIN { AnyEvent::common_sense }
8	use AnyEvent::Util qw(WSAEWOULDBLOCK);
9
10	=head1 NAME	1	=head1 NAME
11		2
12	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent	3	AnyEvent::Handle - non-blocking I/O on streaming handles via AnyEvent
13
14	=cut
15
16	our $VERSION = 4.86;
17		4
18	=head1 SYNOPSIS	5	=head1 SYNOPSIS
19		6
20	use AnyEvent;	7	use AnyEvent;
21	use AnyEvent::Handle;	8	use AnyEvent::Handle;
27	on_error => sub {	14	on_error => sub {
28	my ($hdl, $fatal, $msg) = @_;	15	my ($hdl, $fatal, $msg) = @_;
29	warn "got error $msg\n";	16	warn "got error $msg\n";
30	$hdl->destroy;	17	$hdl->destroy;
31	$cv->send;	18	$cv->send;
32	);	19	};
33		20
34	# send some request line	21	# send some request line
35	$hdl->push_write ("getinfo\015\012");	22	$hdl->push_write ("getinfo\015\012");
36		23
37	# read the response line	24	# read the response line
…		…
43		30
44	$cv->recv;	31	$cv->recv;
45		32
46	=head1 DESCRIPTION	33	=head1 DESCRIPTION
47		34
48	This module is a helper module to make it easier to do event-based I/O on	35	This is a helper module to make it easier to do event-based I/O on
49	filehandles.	36	stream-based filehandles (sockets, pipes, and other stream things).
50		37
51	The L<AnyEvent::Intro> tutorial contains some well-documented	38	The L<AnyEvent::Intro> tutorial contains some well-documented
52	AnyEvent::Handle examples.	39	AnyEvent::Handle examples.
53		40
54	In the following, when the documentation refers to of "bytes" then this	41	In the following, where the documentation refers to "bytes", it means
55	means characters. As sysread and syswrite are used for all I/O, their	42	characters. As sysread and syswrite are used for all I/O, their
56	treatment of characters applies to this module as well.	43	treatment of characters applies to this module as well.
57		44
58	At the very minimum, you should specify C<fh> or C<connect>, and the	45	At the very minimum, you should specify C<fh> or C<connect>, and the
59	C<on_error> callback.	46	C<on_error> callback.
60		47
61	All callbacks will be invoked with the handle object as their first	48	All callbacks will be invoked with the handle object as their first
62	argument.	49	argument.
63		50
		51	=cut
		52
		53	package AnyEvent::Handle;
		54
		55	use Scalar::Util ();
		56	use List::Util ();
		57	use Carp ();
		58	use Errno qw(EAGAIN EINTR);
		59
		60	use AnyEvent (); BEGIN { AnyEvent::common_sense }
		61	use AnyEvent::Util qw(WSAEWOULDBLOCK);
		62
		63	our $VERSION = $AnyEvent::VERSION;
		64
		65	sub _load_func($) {
		66	my $func = $_[0];
		67
		68	unless (defined &$func) {
		69	my $pkg = $func;
		70	do {
		71	$pkg =~ s/::[^:]+$//
		72	or return;
		73	eval "require $pkg";
		74	} until defined &$func;
		75	}
		76
		77	\&$func
		78	}
		79
64	=head1 METHODS	80	=head1 METHODS
65		81
66	=over 4	82	=over 4
67		83
68	=item $handle = B<new> AnyEvent::TLS fh => $filehandle, key => value...	84	=item $handle = B<new> AnyEvent::Handle fh => $filehandle, key => value...
69		85
70	The constructor supports these arguments (all as C<< key => value >> pairs).	86	The constructor supports these arguments (all as C<< key => value >> pairs).
71		87
72	=over 4	88	=over 4
73		89
…		…
101	attempted, but after the file handle has been created. It could be used to	117	attempted, but after the file handle has been created. It could be used to
102	prepare the file handle with parameters required for the actual connect	118	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	119	(as opposed to settings that can be changed when the connection is already
104	established).	120	established).
105		121
		122	The return value of this callback should be the connect timeout value in
		123	seconds (or C<0>, or C<undef>, or the empty list, to indicate that the
		124	default timeout is to be used).
		125
106	=item on_connect => $cb->($handle, $host, $port, $retry->())	126	=item on_connect => $cb->($handle, $host, $port, $retry->())
107		127
108	This callback is called when a connection has been successfully established.	128	This callback is called when a connection has been successfully established.
109		129
110	The actual numeric host and port (the socket peername) are passed as	130	The peer's numeric host and port (the socket peername) are passed as
111	parameters, together with a retry callback.	131	parameters, together with a retry callback.
112		132
113	When, for some reason, the handle is not acceptable, then calling	133	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	134	will continue with the next connection target (in case of multi-homed
115	multi-homed hosts or SRV records there can be multiple connection	135	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,	136	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.	137	similar properties of the handle will have been reset.
118		138
119	In most cases, ignoring the C<$retry> parameter is the way to go.	139	In most cases, you should ignore the C<$retry> parameter.
120		140
121	=item on_connect_error => $cb->($handle, $message)	141	=item on_connect_error => $cb->($handle, $message)
122		142
123	This callback is called when the conenction could not be	143	This callback is called when the connection could not be
124	established. C<$!> will contain the relevant error code, and C<$message> a	144	established. C<$!> will contain the relevant error code, and C<$message> a
125	message describing it (usually the same as C<"$!">).	145	message describing it (usually the same as C<"$!">).
126		146
127	If this callback isn't specified, then C<on_error> will be called with a	147	If this callback isn't specified, then C<on_error> will be called with a
128	fatal error instead.	148	fatal error instead.
…		…
131		151
132	=item on_error => $cb->($handle, $fatal, $message)	152	=item on_error => $cb->($handle, $fatal, $message)
133		153
134	This is the error callback, which is called when, well, some error	154	This is the error callback, which is called when, well, some error
135	occured, such as not being able to resolve the hostname, failure to	155	occured, such as not being able to resolve the hostname, failure to
136	connect or a read error.	156	connect, or a read error.
137		157
138	Some errors are fatal (which is indicated by C<$fatal> being true). On	158	Some errors are fatal (which is indicated by C<$fatal> being true). On
139	fatal errors the handle object will be destroyed (by a call to C<< ->	159	fatal errors the handle object will be destroyed (by a call to C<< ->
140	destroy >>) after invoking the error callback (which means you are free to	160	destroy >>) after invoking the error callback (which means you are free to
141	examine the handle object). Examples of fatal errors are an EOF condition	161	examine the handle object). Examples of fatal errors are an EOF condition
142	with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors. In	162	with active (but unsatisifable) read watchers (C<EPIPE>) or I/O errors. In
143	cases where the other side can close the connection at their will it is	163	cases where the other side can close the connection at will, it is
144	often easiest to not report C<EPIPE> errors in this callback.	164	often easiest to not report C<EPIPE> errors in this callback.
145		165
146	AnyEvent::Handle tries to find an appropriate error code for you to check	166	AnyEvent::Handle tries to find an appropriate error code for you to check
147	against, but in some cases (TLS errors), this does not work well. It is	167	against, but in some cases (TLS errors), this does not work well. It is
148	recommended to always output the C<$message> argument in human-readable	168	recommended to always output the C<$message> argument in human-readable
149	error messages (it's usually the same as C<"$!">).	169	error messages (it's usually the same as C<"$!">).
150		170
151	Non-fatal errors can be retried by simply returning, but it is recommended	171	Non-fatal errors can be retried by returning, but it is recommended
152	to simply ignore this parameter and instead abondon the handle object	172	to simply ignore this parameter and instead abondon the handle object
153	when this callback is invoked. Examples of non-fatal errors are timeouts	173	when this callback is invoked. Examples of non-fatal errors are timeouts
154	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).	174	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
155		175
156	On callback entrance, the value of C<$!> contains the operating system	176	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	177	system error code (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT>, C<EBADMSG> or
158	C<EPROTO>).	178	C<EPROTO>).
159		179
160	While not mandatory, it is I<highly> recommended to set this callback, as	180	While not mandatory, it is I<highly> recommended to set this callback, as
161	you will not be notified of errors otherwise. The default simply calls	181	you will not be notified of errors otherwise. The default just calls
162	C<croak>.	182	C<croak>.
163		183
164	=item on_read => $cb->($handle)	184	=item on_read => $cb->($handle)
165		185
166	This sets the default read callback, which is called when data arrives	186	This sets the default read callback, which is called when data arrives
…		…
171	To access (and remove data from) the read buffer, use the C<< ->rbuf >>	191	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
172	method or access the C<< $handle->{rbuf} >> member directly. Note that you	192	method or access the C<< $handle->{rbuf} >> member directly. Note that you
173	must not enlarge or modify the read buffer, you can only remove data at	193	must not enlarge or modify the read buffer, you can only remove data at
174	the beginning from it.	194	the beginning from it.
175		195
		196	You can also call C<< ->push_read (...) >> or any other function that
		197	modifies the read queue. Or do both. Or ...
		198
176	When an EOF condition is detected then AnyEvent::Handle will first try to	199	When an EOF condition is detected, AnyEvent::Handle will first try to
177	feed all the remaining data to the queued callbacks and C<on_read> before	200	feed all the remaining data to the queued callbacks and C<on_read> before
178	calling the C<on_eof> callback. If no progress can be made, then a fatal	201	calling the C<on_eof> callback. If no progress can be made, then a fatal
179	error will be raised (with C<$!> set to C<EPIPE>).	202	error will be raised (with C<$!> set to C<EPIPE>).
180		203
181	Note that, unlike requests in the read queue, an C<on_read> callback	204	Note that, unlike requests in the read queue, an C<on_read> callback
…		…
200	set, then a fatal error will be raised with C<$!> set to <0>.	223	set, then a fatal error will be raised with C<$!> set to <0>.
201		224
202	=item on_drain => $cb->($handle)	225	=item on_drain => $cb->($handle)
203		226
204	This sets the callback that is called when the write buffer becomes empty	227	This sets the callback that is called when the write buffer becomes empty
205	(or when the callback is set and the buffer is empty already).	228	(or immediately if the buffer is empty already).
206		229
207	To append to the write buffer, use the C<< ->push_write >> method.	230	To append to the write buffer, use the C<< ->push_write >> method.
208		231
209	This callback is useful when you don't want to put all of your write data	232	This callback is useful when you don't want to put all of your write data
210	into the queue at once, for example, when you want to write the contents	233	into the queue at once, for example, when you want to write the contents
…		…
212	memory and push it into the queue, but instead only read more data from	235	memory and push it into the queue, but instead only read more data from
213	the file when the write queue becomes empty.	236	the file when the write queue becomes empty.
214		237
215	=item timeout => $fractional_seconds	238	=item timeout => $fractional_seconds
216		239
		240	=item rtimeout => $fractional_seconds
		241
		242	=item wtimeout => $fractional_seconds
		243
217	If non-zero, then this enables an "inactivity" timeout: whenever this many	244	If non-zero, then these enables an "inactivity" timeout: whenever this
218	seconds pass without a successful read or write on the underlying file	245	many seconds pass without a successful read or write on the underlying
219	handle, the C<on_timeout> callback will be invoked (and if that one is	246	file handle (or a call to C<timeout_reset>), the C<on_timeout> callback
220	missing, a non-fatal C<ETIMEDOUT> error will be raised).	247	will be invoked (and if that one is missing, a non-fatal C<ETIMEDOUT>
		248	error will be raised).
221		249
		250	There are three variants of the timeouts that work independently
		251	of each other, for both read and write, just read, and just write:
		252	C<timeout>, C<rtimeout> and C<wtimeout>, with corresponding callbacks
		253	C<on_timeout>, C<on_rtimeout> and C<on_wtimeout>, and reset functions
		254	C<timeout_reset>, C<rtimeout_reset>, and C<wtimeout_reset>.
		255
222	Note that timeout processing is also active when you currently do not have	256	Note that timeout processing is active even when you do not have
223	any outstanding read or write requests: If you plan to keep the connection	257	any outstanding read or write requests: If you plan to keep the connection
224	idle then you should disable the timout temporarily or ignore the timeout	258	idle then you should disable the timeout temporarily or ignore the timeout
225	in the C<on_timeout> callback, in which case AnyEvent::Handle will simply	259	in the C<on_timeout> callback, in which case AnyEvent::Handle will simply
226	restart the timeout.	260	restart the timeout.
227		261
228	Zero (the default) disables this timeout.	262	Zero (the default) disables this timeout.
229		263
…		…
245	amount of data without a callback ever being called as long as the line	279	amount of data without a callback ever being called as long as the line
246	isn't finished).	280	isn't finished).
247		281
248	=item autocork => <boolean>	282	=item autocork => <boolean>
249		283
250	When disabled (the default), then C<push_write> will try to immediately	284	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	285	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	286	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	287	be inefficient if you write multiple small chunks (on the wire, this
254	disadvantage is usually avoided by your kernel's nagle algorithm, see	288	disadvantage is usually avoided by your kernel's nagle algorithm, see
255	C<no_delay>, but this option can save costly syscalls).	289	C<no_delay>, but this option can save costly syscalls).
256		290
257	When enabled, then writes will always be queued till the next event loop	291	When enabled, writes will always be queued till the next event loop
258	iteration. This is efficient when you do many small writes per iteration,	292	iteration. This is efficient when you do many small writes per iteration,
259	but less efficient when you do a single write only per iteration (or when	293	but less efficient when you do a single write only per iteration (or when
260	the write buffer often is full). It also increases write latency.	294	the write buffer often is full). It also increases write latency.
261		295
262	=item no_delay => <boolean>	296	=item no_delay => <boolean>
…		…
266	the Nagle algorithm, and usually it is beneficial.	300	the Nagle algorithm, and usually it is beneficial.
267		301
268	In some situations you want as low a delay as possible, which can be	302	In some situations you want as low a delay as possible, which can be
269	accomplishd by setting this option to a true value.	303	accomplishd by setting this option to a true value.
270		304
271	The default is your opertaing system's default behaviour (most likely	305	The default is your operating system's default behaviour (most likely
272	enabled), this option explicitly enables or disables it, if possible.	306	enabled). This option explicitly enables or disables it, if possible.
		307
		308	=item keepalive => <boolean>
		309
		310	Enables (default disable) the SO_KEEPALIVE option on the stream socket:
		311	normally, TCP connections have no time-out once established, so TCP
		312	connections, once established, can stay alive forever even when the other
		313	side has long gone. TCP keepalives are a cheap way to take down long-lived
		314	TCP connections when the other side becomes unreachable. While the default
		315	is OS-dependent, TCP keepalives usually kick in after around two hours,
		316	and, if the other side doesn't reply, take down the TCP connection some 10
		317	to 15 minutes later.
		318
		319	It is harmless to specify this option for file handles that do not support
		320	keepalives, and enabling it on connections that are potentially long-lived
		321	is usually a good idea.
		322
		323	=item oobinline => <boolean>
		324
		325	BSD majorly fucked up the implementation of TCP urgent data. The result
		326	is that almost no OS implements TCP according to the specs, and every OS
		327	implements it slightly differently.
		328
		329	If you want to handle TCP urgent data, then setting this flag (the default
		330	is enabled) gives you the most portable way of getting urgent data, by
		331	putting it into the stream.
		332
		333	Since BSD emulation of OOB data on top of TCP's urgent data can have
		334	security implications, AnyEvent::Handle sets this flag automatically
		335	unless explicitly specified. Note that setting this flag after
		336	establishing a connection I<may> be a bit too late (data loss could
		337	already have occured on BSD systems), but at least it will protect you
		338	from most attacks.
273		339
274	=item read_size => <bytes>	340	=item read_size => <bytes>
275		341
276	The default read block size (the amount of bytes this module will	342	The default read block size (the number of bytes this module will
277	try to read during each loop iteration, which affects memory	343	try to read during each loop iteration, which affects memory
278	requirements). Default: C<8192>.	344	requirements). Default: C<8192>.
279		345
280	=item low_water_mark => <bytes>	346	=item low_water_mark => <bytes>
281		347
282	Sets the amount of bytes (default: C<0>) that make up an "empty" write	348	Sets the number of bytes (default: C<0>) that make up an "empty" write
283	buffer: If the write reaches this size or gets even samller it is	349	buffer: If the buffer reaches this size or gets even samller it is
284	considered empty.	350	considered empty.
285		351
286	Sometimes it can be beneficial (for performance reasons) to add data to	352	Sometimes it can be beneficial (for performance reasons) to add data to
287	the write buffer before it is fully drained, but this is a rare case, as	353	the write buffer before it is fully drained, but this is a rare case, as
288	the operating system kernel usually buffers data as well, so the default	354	the operating system kernel usually buffers data as well, so the default
289	is good in almost all cases.	355	is good in almost all cases.
290		356
291	=item linger => <seconds>	357	=item linger => <seconds>
292		358
293	If non-zero (default: C<3600>), then the destructor of the	359	If this is non-zero (default: C<3600>), the destructor of the
294	AnyEvent::Handle object will check whether there is still outstanding	360	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	361	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	362	socket. No errors will be reported (this mostly matches how the operating
297	system treats outstanding data at socket close time).	363	system treats outstanding data at socket close time).
298		364
…		…
305	A string used to identify the remote site - usually the DNS hostname	371	A string used to identify the remote site - usually the DNS hostname
306	(I<not> IDN!) used to create the connection, rarely the IP address.	372	(I<not> IDN!) used to create the connection, rarely the IP address.
307		373
308	Apart from being useful in error messages, this string is also used in TLS	374	Apart from being useful in error messages, this string is also used in TLS
309	peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This	375	peername verification (see C<verify_peername> in L<AnyEvent::TLS>). This
310	verification will be skipped when C<peername> is not specified or	376	verification will be skipped when C<peername> is not specified or is
311	C<undef>.	377	C<undef>.
312		378
313	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	379	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
314		380
315	When this parameter is given, it enables TLS (SSL) mode, that means	381	When this parameter is given, it enables TLS (SSL) mode, that means
316	AnyEvent will start a TLS handshake as soon as the conenction has been	382	AnyEvent will start a TLS handshake as soon as the connection has been
317	established and will transparently encrypt/decrypt data afterwards.	383	established and will transparently encrypt/decrypt data afterwards.
318		384
319	All TLS protocol errors will be signalled as C<EPROTO>, with an	385	All TLS protocol errors will be signalled as C<EPROTO>, with an
320	appropriate error message.	386	appropriate error message.
321		387
…		…
341	B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,	407	B<IMPORTANT:> since Net::SSLeay "objects" are really only integers,
342	passing in the wrong integer will lead to certain crash. This most often	408	passing in the wrong integer will lead to certain crash. This most often
343	happens when one uses a stylish C<< tls => 1 >> and is surprised about the	409	happens when one uses a stylish C<< tls => 1 >> and is surprised about the
344	segmentation fault.	410	segmentation fault.
345		411
346	See the C<< ->starttls >> method for when need to start TLS negotiation later.	412	Use the C<< ->starttls >> method if you need to start TLS negotiation later.
347		413
348	=item tls_ctx => $anyevent_tls	414	=item tls_ctx => $anyevent_tls
349		415
350	Use the given C<AnyEvent::TLS> object to create the new TLS connection	416	Use the given C<AnyEvent::TLS> object to create the new TLS connection
351	(unless a connection object was specified directly). If this parameter is	417	(unless a connection object was specified directly). If this parameter is
…		…
366		432
367	TLS handshake failures will not cause C<on_error> to be invoked when this	433	TLS handshake failures will not cause C<on_error> to be invoked when this
368	callback is in effect, instead, the error message will be passed to C<on_starttls>.	434	callback is in effect, instead, the error message will be passed to C<on_starttls>.
369		435
370	Without this callback, handshake failures lead to C<on_error> being	436	Without this callback, handshake failures lead to C<on_error> being
371	called, as normal.	437	called as usual.
372		438
373	Note that you cannot call C<starttls> right again in this callback. If you	439	Note that you cannot just call C<starttls> again in this callback. If you
374	need to do that, start an zero-second timer instead whose callback can	440	need to do that, start an zero-second timer instead whose callback can
375	then call C<< ->starttls >> again.	441	then call C<< ->starttls >> again.
376		442
377	=item on_stoptls => $cb->($handle)	443	=item on_stoptls => $cb->($handle)
378		444
…		…
434	delete $self->{_skip_drain_rbuf};	500	delete $self->{_skip_drain_rbuf};
435	$self->_start;	501	$self->_start;
436		502
437	$self->{on_connect}	503	$self->{on_connect}
438	and $self->{on_connect}($self, $host, $port, sub {	504	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)};	505	delete @$self{qw(fh _tw _rtw _wtw _ww _rw _eof _queue rbuf _wbuf tls _tls_rbuf _tls_wbuf)};
440	$self->{_skip_drain_rbuf} = 1;	506	$self->{_skip_drain_rbuf} = 1;
441	&$retry;	507	&$retry;
442	});	508	});
443		509
444	} else {	510	} else {
445	if ($self->{on_connect_error}) {	511	if ($self->{on_connect_error}) {
446	$self->{on_connect_error}($self, "$!");	512	$self->{on_connect_error}($self, "$!");
447	$self->destroy;	513	$self->destroy;
448	} else {	514	} else {
449	$self->fatal ($!, 1);	515	$self->_error ($!, 1);
450	}	516	}
451	}	517	}
452	},	518	},
453	sub {	519	sub {
454	local $self->{fh} = $_[0];	520	local $self->{fh} = $_[0];
455		521
		522	$self->{on_prepare}
456	$self->{on_prepare}->($self)	523	? $self->{on_prepare}->($self)
457	if $self->{on_prepare};	524	: ()
458	}	525	}
459	);	526	);
460	}	527	}
461		528
462	} else {	529	} else {
…		…
467	}	534	}
468		535
469	sub _start {	536	sub _start {
470	my ($self) = @_;	537	my ($self) = @_;
471		538
		539	# too many clueless people try to use udp and similar sockets
		540	# with AnyEvent::Handle, do them a favour.
		541	my $type = getsockopt $self->{fh}, Socket::SOL_SOCKET (), Socket::SO_TYPE ();
		542	Carp::croak "AnyEvent::Handle: only stream sockets supported, anything else will NOT work!"
		543	if Socket::SOCK_STREAM () != (unpack "I", $type) && defined $type;
		544
472	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	545	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
473		546
		547	$self->{_activity} =
		548	$self->{_ractivity} =
474	$self->{_activity} = AnyEvent->now;	549	$self->{_wactivity} = AE::now;
475	$self->_timeout;
476		550
		551	$self->timeout (delete $self->{timeout} ) if $self->{timeout};
		552	$self->rtimeout (delete $self->{rtimeout} ) if $self->{rtimeout};
		553	$self->wtimeout (delete $self->{wtimeout} ) if $self->{wtimeout};
		554
477	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};	555	$self->no_delay (delete $self->{no_delay} ) if exists $self->{no_delay} && $self->{no_delay};
		556	$self->keepalive (delete $self->{keepalive}) if exists $self->{keepalive} && $self->{keepalive};
478		557
		558	$self->oobinline (exists $self->{oobinline} ? delete $self->{oobinline} : 1);
		559
479	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})	560	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
480	if $self->{tls};	561	if $self->{tls};
481		562
482	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	563	$self->on_drain (delete $self->{on_drain} ) if $self->{on_drain};
483		564
484	$self->start_read	565	$self->start_read
485	if $self->{on_read} \|\| @{ $self->{_queue} };	566	if $self->{on_read} \|\| @{ $self->{_queue} };
486		567
487	$self->_drain_wbuf;	568	$self->_drain_wbuf;
488	}	569	}
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		570
499	sub _error {	571	sub _error {
500	my ($self, $errno, $fatal, $message) = @_;	572	my ($self, $errno, $fatal, $message) = @_;
501		573
502	$! = $errno;	574	$! = $errno;
503	$message \|\|= "$!";	575	$message \|\|= "$!";
504		576
505	if ($self->{on_error}) {	577	if ($self->{on_error}) {
506	$self->{on_error}($self, $fatal, $message);	578	$self->{on_error}($self, $fatal, $message);
507	$self->destroy if $fatal;	579	$self->destroy if $fatal;
508	} elsif ($self->{fh}) {	580	} elsif ($self->{fh} \|\| $self->{connect}) {
509	$self->destroy;	581	$self->destroy;
510	Carp::croak "AnyEvent::Handle uncaught error: $message";	582	Carp::croak "AnyEvent::Handle uncaught error: $message";
511	}	583	}
512	}	584	}
513		585
…		…
539	$_[0]{on_eof} = $_[1];	611	$_[0]{on_eof} = $_[1];
540	}	612	}
541		613
542	=item $handle->on_timeout ($cb)	614	=item $handle->on_timeout ($cb)
543		615
544	Replace the current C<on_timeout> callback, or disables the callback (but	616	=item $handle->on_rtimeout ($cb)
545	not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
546	argument and method.
547		617
548	=cut	618	=item $handle->on_wtimeout ($cb)
549		619
550	sub on_timeout {	620	Replace the current C<on_timeout>, C<on_rtimeout> or C<on_wtimeout>
551	$_[0]{on_timeout} = $_[1];	621	callback, or disables the callback (but not the timeout) if C<$cb> =
552	}	622	C<undef>. See the C<timeout> constructor argument and method.
		623
		624	=cut
		625
		626	# see below
553		627
554	=item $handle->autocork ($boolean)	628	=item $handle->autocork ($boolean)
555		629
556	Enables or disables the current autocork behaviour (see C<autocork>	630	Enables or disables the current autocork behaviour (see C<autocork>
557	constructor argument). Changes will only take effect on the next write.	631	constructor argument). Changes will only take effect on the next write.
…		…
570	=cut	644	=cut
571		645
572	sub no_delay {	646	sub no_delay {
573	$_[0]{no_delay} = $_[1];	647	$_[0]{no_delay} = $_[1];
574		648
		649	setsockopt $_[0]{fh}, Socket::IPPROTO_TCP (), Socket::TCP_NODELAY (), int $_[1]
		650	if $_[0]{fh};
		651	}
		652
		653	=item $handle->keepalive ($boolean)
		654
		655	Enables or disables the C<keepalive> setting (see constructor argument of
		656	the same name for details).
		657
		658	=cut
		659
		660	sub keepalive {
		661	$_[0]{keepalive} = $_[1];
		662
575	eval {	663	eval {
576	local $SIG{__DIE__};	664	local $SIG{__DIE__};
577	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1]	665	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
578	if $_[0]{fh};	666	if $_[0]{fh};
579	};	667	};
580	}	668	}
581		669
		670	=item $handle->oobinline ($boolean)
		671
		672	Enables or disables the C<oobinline> setting (see constructor argument of
		673	the same name for details).
		674
		675	=cut
		676
		677	sub oobinline {
		678	$_[0]{oobinline} = $_[1];
		679
		680	eval {
		681	local $SIG{__DIE__};
		682	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_OOBINLINE (), int $_[1]
		683	if $_[0]{fh};
		684	};
		685	}
		686
		687	=item $handle->keepalive ($boolean)
		688
		689	Enables or disables the C<keepalive> setting (see constructor argument of
		690	the same name for details).
		691
		692	=cut
		693
		694	sub keepalive {
		695	$_[0]{keepalive} = $_[1];
		696
		697	eval {
		698	local $SIG{__DIE__};
		699	setsockopt $_[0]{fh}, Socket::SOL_SOCKET (), Socket::SO_KEEPALIVE (), int $_[1]
		700	if $_[0]{fh};
		701	};
		702	}
		703
582	=item $handle->on_starttls ($cb)	704	=item $handle->on_starttls ($cb)
583		705
584	Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument).	706	Replace the current C<on_starttls> callback (see the C<on_starttls> constructor argument).
585		707
586	=cut	708	=cut
…		…
593		715
594	Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).	716	Replace the current C<on_stoptls> callback (see the C<on_stoptls> constructor argument).
595		717
596	=cut	718	=cut
597		719
598	sub on_starttls {	720	sub on_stoptls {
599	$_[0]{on_stoptls} = $_[1];	721	$_[0]{on_stoptls} = $_[1];
600	}	722	}
601		723
		724	=item $handle->rbuf_max ($max_octets)
		725
		726	Configures the C<rbuf_max> setting (C<undef> disables it).
		727
		728	=cut
		729
		730	sub rbuf_max {
		731	$_[0]{rbuf_max} = $_[1];
		732	}
		733
602	#############################################################################	734	#############################################################################
603		735
604	=item $handle->timeout ($seconds)	736	=item $handle->timeout ($seconds)
605		737
		738	=item $handle->rtimeout ($seconds)
		739
		740	=item $handle->wtimeout ($seconds)
		741
606	Configures (or disables) the inactivity timeout.	742	Configures (or disables) the inactivity timeout.
607		743
608	=cut	744	=item $handle->timeout_reset
609		745
610	sub timeout {	746	=item $handle->rtimeout_reset
		747
		748	=item $handle->wtimeout_reset
		749
		750	Reset the activity timeout, as if data was received or sent.
		751
		752	These methods are cheap to call.
		753
		754	=cut
		755
		756	for my $dir ("", "r", "w") {
		757	my $timeout = "${dir}timeout";
		758	my $tw = "_${dir}tw";
		759	my $on_timeout = "on_${dir}timeout";
		760	my $activity = "_${dir}activity";
		761	my $cb;
		762
		763	*$on_timeout = sub {
		764	$_[0]{$on_timeout} = $_[1];
		765	};
		766
		767	*$timeout = sub {
611	my ($self, $timeout) = @_;	768	my ($self, $new_value) = @_;
612		769
		770	$new_value >= 0
		771	or Carp::croak "AnyEvent::Handle->$timeout called with negative timeout ($new_value), caught";
		772
613	$self->{timeout} = $timeout;	773	$self->{$timeout} = $new_value;
614	$self->_timeout;	774	delete $self->{$tw}; &$cb;
615	}	775	};
616		776
		777	*{"${dir}timeout_reset"} = sub {
		778	$_[0]{$activity} = AE::now;
		779	};
		780
		781	# main workhorse:
617	# reset the timeout watcher, as neccessary	782	# reset the timeout watcher, as neccessary
618	# also check for time-outs	783	# also check for time-outs
619	sub _timeout {	784	$cb = sub {
620	my ($self) = @_;	785	my ($self) = @_;
621		786
622	if ($self->{timeout} && $self->{fh}) {	787	if ($self->{$timeout} && $self->{fh}) {
623	my $NOW = AnyEvent->now;	788	my $NOW = AE::now;
624		789
625	# when would the timeout trigger?	790	# when would the timeout trigger?
626	my $after = $self->{_activity} + $self->{timeout} - $NOW;	791	my $after = $self->{$activity} + $self->{$timeout} - $NOW;
627		792
628	# now or in the past already?	793	# now or in the past already?
629	if ($after <= 0) {	794	if ($after <= 0) {
630	$self->{_activity} = $NOW;	795	$self->{$activity} = $NOW;
631		796
632	if ($self->{on_timeout}) {	797	if ($self->{$on_timeout}) {
633	$self->{on_timeout}($self);	798	$self->{$on_timeout}($self);
634	} else {	799	} else {
635	$self->_error (Errno::ETIMEDOUT);	800	$self->_error (Errno::ETIMEDOUT);
		801	}
		802
		803	# callback could have changed timeout value, optimise
		804	return unless $self->{$timeout};
		805
		806	# calculate new after
		807	$after = $self->{$timeout};
636	}	808	}
637		809
638	# callback could have changed timeout value, optimise	810	Scalar::Util::weaken $self;
639	return unless $self->{timeout};	811	return unless $self; # ->error could have destroyed $self
640		812
641	# calculate new after	813	$self->{$tw} \|\|= AE::timer $after, 0, sub {
642	$after = $self->{timeout};	814	delete $self->{$tw};
		815	$cb->($self);
		816	};
		817	} else {
		818	delete $self->{$tw};
643	}	819	}
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	}	820	}
655	}	821	}
656		822
657	#############################################################################	823	#############################################################################
658		824
…		…
673		839
674	=item $handle->on_drain ($cb)	840	=item $handle->on_drain ($cb)
675		841
676	Sets the C<on_drain> callback or clears it (see the description of	842	Sets the C<on_drain> callback or clears it (see the description of
677	C<on_drain> in the constructor).	843	C<on_drain> in the constructor).
		844
		845	This method may invoke callbacks (and therefore the handle might be
		846	destroyed after it returns).
678		847
679	=cut	848	=cut
680		849
681	sub on_drain {	850	sub on_drain {
682	my ($self, $cb) = @_;	851	my ($self, $cb) = @_;
…		…
691		860
692	Queues the given scalar to be written. You can push as much data as you	861	Queues the given scalar to be written. You can push as much data as you
693	want (only limited by the available memory), as C<AnyEvent::Handle>	862	want (only limited by the available memory), as C<AnyEvent::Handle>
694	buffers it independently of the kernel.	863	buffers it independently of the kernel.
695		864
		865	This method may invoke callbacks (and therefore the handle might be
		866	destroyed after it returns).
		867
696	=cut	868	=cut
697		869
698	sub _drain_wbuf {	870	sub _drain_wbuf {
699	my ($self) = @_;	871	my ($self) = @_;
700		872
…		…
706	my $len = syswrite $self->{fh}, $self->{wbuf};	878	my $len = syswrite $self->{fh}, $self->{wbuf};
707		879
708	if (defined $len) {	880	if (defined $len) {
709	substr $self->{wbuf}, 0, $len, "";	881	substr $self->{wbuf}, 0, $len, "";
710		882
711	$self->{_activity} = AnyEvent->now;	883	$self->{_activity} = $self->{_wactivity} = AE::now;
712		884
713	$self->{on_drain}($self)	885	$self->{on_drain}($self)
714	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})	886	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
715	&& $self->{on_drain};	887	&& $self->{on_drain};
716		888
…		…
722		894
723	# try to write data immediately	895	# try to write data immediately
724	$cb->() unless $self->{autocork};	896	$cb->() unless $self->{autocork};
725		897
726	# if still data left in wbuf, we need to poll	898	# if still data left in wbuf, we need to poll
727	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	899	$self->{_ww} = AE::io $self->{fh}, 1, $cb
728	if length $self->{wbuf};	900	if length $self->{wbuf};
729	};	901	};
730	}	902	}
731		903
732	our %WH;	904	our %WH;
733		905
		906	# deprecated
734	sub register_write_type($$) {	907	sub register_write_type($$) {
735	$WH{$_[0]} = $_[1];	908	$WH{$_[0]} = $_[1];
736	}	909	}
737		910
738	sub push_write {	911	sub push_write {
739	my $self = shift;	912	my $self = shift;
740		913
741	if (@_ > 1) {	914	if (@_ > 1) {
742	my $type = shift;	915	my $type = shift;
743		916
		917	@_ = ($WH{$type} \|\|= _load_func "$type\::anyevent_write_type"
744	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	918	or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_write")
745	->($self, @_);	919	->($self, @_);
746	}	920	}
747		921
		922	# we downgrade here to avoid hard-to-track-down bugs,
		923	# and diagnose the problem earlier and better.
		924
748	if ($self->{tls}) {	925	if ($self->{tls}) {
749	$self->{_tls_wbuf} .= $_[0];	926	utf8::downgrade $self->{_tls_wbuf} .= $_[0];
750	&_dotls ($self) if $self->{fh};	927	&_dotls ($self) if $self->{fh};
751	} else {	928	} else {
752	$self->{wbuf} .= $_[0];	929	utf8::downgrade $self->{wbuf} .= $_[0];
753	$self->_drain_wbuf if $self->{fh};	930	$self->_drain_wbuf if $self->{fh};
754	}	931	}
755	}	932	}
756		933
757	=item $handle->push_write (type => @args)	934	=item $handle->push_write (type => @args)
758		935
759	Instead of formatting your data yourself, you can also let this module do	936	Instead of formatting your data yourself, you can also let this module
760	the job by specifying a type and type-specific arguments.	937	do the job by specifying a type and type-specific arguments. You
		938	can also specify the (fully qualified) name of a package, in which
		939	case AnyEvent tries to load the package and then expects to find the
		940	C<anyevent_write_type> function inside (see "custom write types", below).
761		941
762	Predefined types are (if you have ideas for additional types, feel free to	942	Predefined types are (if you have ideas for additional types, feel free to
763	drop by and tell us):	943	drop by and tell us):
764		944
765	=over 4	945	=over 4
…		…
822	Other languages could read single lines terminated by a newline and pass	1002	Other languages could read single lines terminated by a newline and pass
823	this line into their JSON decoder of choice.	1003	this line into their JSON decoder of choice.
824		1004
825	=cut	1005	=cut
826		1006
		1007	sub json_coder() {
		1008	eval { require JSON::XS; JSON::XS->new->utf8 }
		1009	\|\| do { require JSON; JSON->new->utf8 }
		1010	}
		1011
827	register_write_type json => sub {	1012	register_write_type json => sub {
828	my ($self, $ref) = @_;	1013	my ($self, $ref) = @_;
829		1014
830	require JSON;	1015	my $json = $self->{json} \|\|= json_coder;
831		1016
832	$self->{json} ? $self->{json}->encode ($ref)	1017	$json->encode ($ref)
833	: JSON::encode_json ($ref)
834	};	1018	};
835		1019
836	=item storable => $reference	1020	=item storable => $reference
837		1021
838	Freezes the given reference using L<Storable> and writes it to the	1022	Freezes the given reference using L<Storable> and writes it to the
…		…
864	the peer.	1048	the peer.
865		1049
866	You can rely on the normal read queue and C<on_eof> handling	1050	You can rely on the normal read queue and C<on_eof> handling
867	afterwards. This is the cleanest way to close a connection.	1051	afterwards. This is the cleanest way to close a connection.
868		1052
		1053	This method may invoke callbacks (and therefore the handle might be
		1054	destroyed after it returns).
		1055
869	=cut	1056	=cut
870		1057
871	sub push_shutdown {	1058	sub push_shutdown {
872	my ($self) = @_;	1059	my ($self) = @_;
873		1060
874	delete $self->{low_water_mark};	1061	delete $self->{low_water_mark};
875	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });	1062	$self->on_drain (sub { shutdown $_[0]{fh}, 1 });
876	}	1063	}
877		1064
878	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	1065	=item custom write types - Package::anyevent_write_type $handle, @args
879		1066
880	This function (not method) lets you add your own types to C<push_write>.	1067	Instead of one of the predefined types, you can also specify the name of
		1068	a package. AnyEvent will try to load the package and then expects to find
		1069	a function named C<anyevent_write_type> inside. If it isn't found, it
		1070	progressively tries to load the parent package until it either finds the
		1071	function (good) or runs out of packages (bad).
		1072
881	Whenever the given C<type> is used, C<push_write> will invoke the code	1073	Whenever the given C<type> is used, C<push_write> will the function with
882	reference with the handle object and the remaining arguments.	1074	the handle object and the remaining arguments.
883		1075
884	The code reference is supposed to return a single octet string that will	1076	The function is supposed to return a single octet string that will be
885	be appended to the write buffer.	1077	appended to the write buffer, so you cna mentally treat this function as a
		1078	"arguments to on-the-wire-format" converter.
886		1079
887	Note that this is a function, and all types registered this way will be	1080	Example: implement a custom write type C<join> that joins the remaining
888	global, so try to use unique names.	1081	arguments using the first one.
		1082
		1083	$handle->push_write (My::Type => " ", 1,2,3);
		1084
		1085	# uses the following package, which can be defined in the "My::Type" or in
		1086	# the "My" modules to be auto-loaded, or just about anywhere when the
		1087	# My::Type::anyevent_write_type is defined before invoking it.
		1088
		1089	package My::Type;
		1090
		1091	sub anyevent_write_type {
		1092	my ($handle, $delim, @args) = @_;
		1093
		1094	join $delim, @args
		1095	}
889		1096
890	=cut	1097	=cut
891		1098
892	#############################################################################	1099	#############################################################################
893		1100
…		…
902	ways, the "simple" way, using only C<on_read> and the "complex" way, using	1109	ways, the "simple" way, using only C<on_read> and the "complex" way, using
903	a queue.	1110	a queue.
904		1111
905	In the simple case, you just install an C<on_read> callback and whenever	1112	In the simple case, you just install an C<on_read> callback and whenever
906	new data arrives, it will be called. You can then remove some data (if	1113	new data arrives, it will be called. You can then remove some data (if
907	enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna	1114	enough is there) from the read buffer (C<< $handle->rbuf >>). Or you can
908	leave the data there if you want to accumulate more (e.g. when only a	1115	leave the data there if you want to accumulate more (e.g. when only a
909	partial message has been received so far).	1116	partial message has been received so far), or change the read queue with
		1117	e.g. C<push_read>.
910		1118
911	In the more complex case, you want to queue multiple callbacks. In this	1119	In the more complex case, you want to queue multiple callbacks. In this
912	case, AnyEvent::Handle will call the first queued callback each time new	1120	case, AnyEvent::Handle will call the first queued callback each time new
913	data arrives (also the first time it is queued) and removes it when it has	1121	data arrives (also the first time it is queued) and remove it when it has
914	done its job (see C<push_read>, below).	1122	done its job (see C<push_read>, below).
915		1123
916	This way you can, for example, push three line-reads, followed by reading	1124	This way you can, for example, push three line-reads, followed by reading
917	a chunk of data, and AnyEvent::Handle will execute them in order.	1125	a chunk of data, and AnyEvent::Handle will execute them in order.
918		1126
…		…
976		1184
977	sub _drain_rbuf {	1185	sub _drain_rbuf {
978	my ($self) = @_;	1186	my ($self) = @_;
979		1187
980	# avoid recursion	1188	# avoid recursion
981	return if exists $self->{_skip_drain_rbuf};	1189	return if $self->{_skip_drain_rbuf};
982	local $self->{_skip_drain_rbuf} = 1;	1190	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		1191
991	while () {	1192	while () {
992	# we need to use a separate tls read buffer, as we must not receive data while	1193	# we need to use a separate tls read buffer, as we must not receive data while
993	# we are draining the buffer, and this can only happen with TLS.	1194	# we are draining the buffer, and this can only happen with TLS.
994	$self->{rbuf} .= delete $self->{_tls_rbuf} if exists $self->{_tls_rbuf};	1195	$self->{rbuf} .= delete $self->{_tls_rbuf}
		1196	if exists $self->{_tls_rbuf};
995		1197
996	my $len = length $self->{rbuf};	1198	my $len = length $self->{rbuf};
997		1199
998	if (my $cb = shift @{ $self->{_queue} }) {	1200	if (my $cb = shift @{ $self->{_queue} }) {
999	unless ($cb->($self)) {	1201	unless ($cb->($self)) {
1000	if ($self->{_eof}) {	1202	# no progress can be made
1001	# no progress can be made (not enough data and no data forthcoming)	1203	# (not enough data and no data forthcoming)
1002	$self->_error (Errno::EPIPE, 1), return;	1204	$self->_error (Errno::EPIPE, 1), return
1003	}	1205	if $self->{_eof};
1004		1206
1005	unshift @{ $self->{_queue} }, $cb;	1207	unshift @{ $self->{_queue} }, $cb;
1006	last;	1208	last;
1007	}	1209	}
1008	} elsif ($self->{on_read}) {	1210	} elsif ($self->{on_read}) {
…		…
1028	last;	1230	last;
1029	}	1231	}
1030	}	1232	}
1031		1233
1032	if ($self->{_eof}) {	1234	if ($self->{_eof}) {
1033	if ($self->{on_eof}) {	1235	$self->{on_eof}
1034	$self->{on_eof}($self)	1236	? $self->{on_eof}($self)
1035	} else {
1036	$self->_error (0, 1, "Unexpected end-of-file");	1237	: $self->_error (0, 1, "Unexpected end-of-file");
1037	}	1238
		1239	return;
		1240	}
		1241
		1242	if (
		1243	defined $self->{rbuf_max}
		1244	&& $self->{rbuf_max} < length $self->{rbuf}
		1245	) {
		1246	$self->_error (Errno::ENOSPC, 1), return;
1038	}	1247	}
1039		1248
1040	# may need to restart read watcher	1249	# may need to restart read watcher
1041	unless ($self->{_rw}) {	1250	unless ($self->{_rw}) {
1042	$self->start_read	1251	$self->start_read
…		…
1048		1257
1049	This replaces the currently set C<on_read> callback, or clears it (when	1258	This replaces the currently set C<on_read> callback, or clears it (when
1050	the new callback is C<undef>). See the description of C<on_read> in the	1259	the new callback is C<undef>). See the description of C<on_read> in the
1051	constructor.	1260	constructor.
1052		1261
		1262	This method may invoke callbacks (and therefore the handle might be
		1263	destroyed after it returns).
		1264
1053	=cut	1265	=cut
1054		1266
1055	sub on_read {	1267	sub on_read {
1056	my ($self, $cb) = @_;	1268	my ($self, $cb) = @_;
1057		1269
…		…
1059	$self->_drain_rbuf if $cb;	1271	$self->_drain_rbuf if $cb;
1060	}	1272	}
1061		1273
1062	=item $handle->rbuf	1274	=item $handle->rbuf
1063		1275
1064	Returns the read buffer (as a modifiable lvalue).	1276	Returns the read buffer (as a modifiable lvalue). You can also access the
		1277	read buffer directly as the C<< ->{rbuf} >> member, if you want (this is
		1278	much faster, and no less clean).
1065		1279
1066	You can access the read buffer directly as the C<< ->{rbuf} >>	1280	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	1281	is removing data from its beginning. Otherwise modifying or appending to
1068	read buffer (apart from looking at it) is removing data from its	1282	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		1283
1072	NOTE: The read buffer should only be used or modified if the C<on_read>,	1284	NOTE: The read buffer should only be used or modified in the C<on_read>
1073	C<push_read> or C<unshift_read> methods are used. The other read methods	1285	callback or when C<push_read> or C<unshift_read> are used with a single
1074	automatically manage the read buffer.	1286	callback (i.e. untyped). Typed C<push_read> and C<unshift_read> methods
		1287	will manage the read buffer on their own.
1075		1288
1076	=cut	1289	=cut
1077		1290
1078	sub rbuf : lvalue {	1291	sub rbuf : lvalue {
1079	$_[0]{rbuf}	1292	$_[0]{rbuf}
…		…
1096		1309
1097	If enough data was available, then the callback must remove all data it is	1310	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	1311	interested in (which can be none at all) and return a true value. After returning
1099	true, it will be removed from the queue.	1312	true, it will be removed from the queue.
1100		1313
		1314	These methods may invoke callbacks (and therefore the handle might be
		1315	destroyed after it returns).
		1316
1101	=cut	1317	=cut
1102		1318
1103	our %RH;	1319	our %RH;
1104		1320
1105	sub register_read_type($$) {	1321	sub register_read_type($$) {
…		…
1111	my $cb = pop;	1327	my $cb = pop;
1112		1328
1113	if (@_) {	1329	if (@_) {
1114	my $type = shift;	1330	my $type = shift;
1115		1331
		1332	$cb = ($RH{$type} \|\|= _load_func "$type\::anyevent_read_type"
1116	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	1333	or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::push_read")
1117	->($self, $cb, @_);	1334	->($self, $cb, @_);
1118	}	1335	}
1119		1336
1120	push @{ $self->{_queue} }, $cb;	1337	push @{ $self->{_queue} }, $cb;
1121	$self->_drain_rbuf;	1338	$self->_drain_rbuf;
…		…
1126	my $cb = pop;	1343	my $cb = pop;
1127		1344
1128	if (@_) {	1345	if (@_) {
1129	my $type = shift;	1346	my $type = shift;
1130		1347
		1348	$cb = ($RH{$type} \|\|= _load_func "$type\::anyevent_read_type"
1131	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")	1349	or Carp::croak "unsupported/unloadable type '$type' passed to AnyEvent::Handle::unshift_read")
1132	->($self, $cb, @_);	1350	->($self, $cb, @_);
1133	}	1351	}
1134
1135		1352
1136	unshift @{ $self->{_queue} }, $cb;	1353	unshift @{ $self->{_queue} }, $cb;
1137	$self->_drain_rbuf;	1354	$self->_drain_rbuf;
1138	}	1355	}
1139		1356
…		…
1141		1358
1142	=item $handle->unshift_read (type => @args, $cb)	1359	=item $handle->unshift_read (type => @args, $cb)
1143		1360
1144	Instead of providing a callback that parses the data itself you can chose	1361	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	1362	between a number of predefined parsing formats, for chunks of data, lines
1146	etc.	1363	etc. You can also specify the (fully qualified) name of a package, in
		1364	which case AnyEvent tries to load the package and then expects to find the
		1365	C<anyevent_read_type> function inside (see "custom read types", below).
1147		1366
1148	Predefined types are (if you have ideas for additional types, feel free to	1367	Predefined types are (if you have ideas for additional types, feel free to
1149	drop by and tell us):	1368	drop by and tell us):
1150		1369
1151	=over 4	1370	=over 4
…		…
1243	the receive buffer when neither C<$accept> nor C<$reject> match,	1462	the receive buffer when neither C<$accept> nor C<$reject> match,
1244	and everything preceding and including the match will be accepted	1463	and everything preceding and including the match will be accepted
1245	unconditionally. This is useful to skip large amounts of data that you	1464	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	1465	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	1466	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.	1467	and is usually worth it only when you expect more than a few kilobytes.
1249		1468
1250	Example: expect a http header, which ends at C<\015\012\015\012>. Since we	1469	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	1470	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	1471	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	1472	it only accepts something not ending in either \015 or \012, as these are
1254	required for the accept regex.	1473	required for the accept regex.
1255		1474
1256	$handle->push_read (regex =>	1475	$handle->push_read (regex =>
…		…
1391	=cut	1610	=cut
1392		1611
1393	register_read_type json => sub {	1612	register_read_type json => sub {
1394	my ($self, $cb) = @_;	1613	my ($self, $cb) = @_;
1395		1614
1396	my $json = $self->{json} \|\|=	1615	my $json = $self->{json} \|\|= json_coder;
1397	eval { require JSON::XS; JSON::XS->new->utf8 }
1398	\|\| do { require JSON; JSON->new->utf8 };
1399		1616
1400	my $data;	1617	my $data;
1401	my $rbuf = \$self->{rbuf};	1618	my $rbuf = \$self->{rbuf};
1402		1619
1403	sub {	1620	sub {
…		…
1472	}	1689	}
1473	};	1690	};
1474		1691
1475	=back	1692	=back
1476		1693
1477	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)	1694	=item custom read types - Package::anyevent_read_type $handle, $cb, @args
1478		1695
1479	This function (not method) lets you add your own types to C<push_read>.	1696	Instead of one of the predefined types, you can also specify the name
		1697	of a package. AnyEvent will try to load the package and then expects to
		1698	find a function named C<anyevent_read_type> inside. If it isn't found, it
		1699	progressively tries to load the parent package until it either finds the
		1700	function (good) or runs out of packages (bad).
1480		1701
1481	Whenever the given C<type> is used, C<push_read> will invoke the code	1702	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	1703	handle object, the original callback and the remaining arguments.
1483	arguments.
1484		1704
1485	The code reference is supposed to return a callback (usually a closure)	1705	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) >>).	1706	works as a plain read callback (see C<< ->push_read ($cb) >>), so you can
		1707	mentally treat the function as a "configurable read type to read callback"
		1708	converter.
1487		1709
1488	It should invoke the passed callback when it is done reading (remember to	1710	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).	1711	to pass C<$handle> as first argument as all other callbacks do that,
		1712	although there is no strict requirement on this).
1490		1713
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>,	1714	For examples, see the source of this module (F<perldoc -m
1495	search for C<register_read_type>)).	1715	AnyEvent::Handle>, search for C<register_read_type>)).
1496		1716
1497	=item $handle->stop_read	1717	=item $handle->stop_read
1498		1718
1499	=item $handle->start_read	1719	=item $handle->start_read
1500		1720
…		…
1520	}	1740	}
1521		1741
1522	sub start_read {	1742	sub start_read {
1523	my ($self) = @_;	1743	my ($self) = @_;
1524		1744
1525	unless ($self->{_rw} \|\| $self->{_eof}) {	1745	unless ($self->{_rw} \|\| $self->{_eof} \|\| !$self->{fh}) {
1526	Scalar::Util::weaken $self;	1746	Scalar::Util::weaken $self;
1527		1747
1528	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1748	$self->{_rw} = AE::io $self->{fh}, 0, sub {
1529	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});	1749	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1530	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;	1750	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;
1531		1751
1532	if ($len > 0) {	1752	if ($len > 0) {
1533	$self->{_activity} = AnyEvent->now;	1753	$self->{_activity} = $self->{_ractivity} = AE::now;
1534		1754
1535	if ($self->{tls}) {	1755	if ($self->{tls}) {
1536	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);	1756	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1537		1757
1538	&_dotls ($self);	1758	&_dotls ($self);
…		…
1546	$self->_drain_rbuf;	1766	$self->_drain_rbuf;
1547		1767
1548	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	1768	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
1549	return $self->_error ($!, 1);	1769	return $self->_error ($!, 1);
1550	}	1770	}
1551	});	1771	};
1552	}	1772	}
1553	}	1773	}
1554		1774
1555	our $ERROR_SYSCALL;	1775	our $ERROR_SYSCALL;
1556	our $ERROR_WANT_READ;	1776	our $ERROR_WANT_READ;
…		…
1623	&& ($tmp != $ERROR_SYSCALL \|\| $!);	1843	&& ($tmp != $ERROR_SYSCALL \|\| $!);
1624		1844
1625	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1845	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1626	$self->{wbuf} .= $tmp;	1846	$self->{wbuf} .= $tmp;
1627	$self->_drain_wbuf;	1847	$self->_drain_wbuf;
		1848	$self->{tls} or return; # tls session might have gone away in callback
1628	}	1849	}
1629		1850
1630	$self->{_on_starttls}	1851	$self->{_on_starttls}
1631	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()	1852	and Net::SSLeay::state ($self->{tls}) == Net::SSLeay::ST_OK ()
1632	and (delete $self->{_on_starttls})->($self, 1, "TLS/SSL connection established");	1853	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	1875	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	1876	changed to your liking. Note that the handshake might have already started
1656	when this function returns.	1877	when this function returns.
1657		1878
1658	Due to bugs in OpenSSL, it might or might not be possible to do multiple	1879	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	1880	handshakes on the same stream. It is best to not attempt to use the
1660	stopping TLS.	1881	stream after stopping TLS.
		1882
		1883	This method may invoke callbacks (and therefore the handle might be
		1884	destroyed after it returns).
1661		1885
1662	=cut	1886	=cut
1663		1887
1664	our %TLS_CACHE; #TODO not yet documented, should we?	1888	our %TLS_CACHE; #TODO not yet documented, should we?
1665		1889
…		…
1677	require Net::SSLeay;	1901	require Net::SSLeay;
1678		1902
1679	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();	1903	$ERROR_SYSCALL = Net::SSLeay::ERROR_SYSCALL ();
1680	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();	1904	$ERROR_WANT_READ = Net::SSLeay::ERROR_WANT_READ ();
1681		1905
1682	$tls = $self->{tls};	1906	$tls = delete $self->{tls};
1683	$ctx = $self->{tls_ctx};	1907	$ctx = $self->{tls_ctx};
1684		1908
1685	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session	1909	local $Carp::CarpLevel = 1; # skip ourselves when creating a new context or session
1686		1910
1687	if ("HASH" eq ref $ctx) {	1911	if ("HASH" eq ref $ctx) {
…		…
1716	Net::SSLeay::CTX_set_mode ($tls, 1\|2);	1940	Net::SSLeay::CTX_set_mode ($tls, 1\|2);
1717		1941
1718	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1942	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1719	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1943	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1720		1944
		1945	Net::SSLeay::BIO_write ($self->{_rbio}, delete $self->{rbuf});
		1946
1721	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});	1947	Net::SSLeay::set_bio ($tls, $self->{_rbio}, $self->{_wbio});
1722		1948
1723	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }	1949	$self->{_on_starttls} = sub { $_[0]{on_starttls}(@_) }
1724	if $self->{on_starttls};	1950	if $self->{on_starttls};
1725		1951
…		…
1729		1955
1730	=item $handle->stoptls	1956	=item $handle->stoptls
1731		1957
1732	Shuts down the SSL connection - this makes a proper EOF handshake by	1958	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	1959	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	1960	support non-blocking shut downs, it is not guaranteed that you can re-use
1735	the stream afterwards.	1961	the stream afterwards.
		1962
		1963	This method may invoke callbacks (and therefore the handle might be
		1964	destroyed after it returns).
1736		1965
1737	=cut	1966	=cut
1738		1967
1739	sub stoptls {	1968	sub stoptls {
1740	my ($self) = @_;	1969	my ($self) = @_;
1741		1970
1742	if ($self->{tls}) {	1971	if ($self->{tls} && $self->{fh}) {
1743	Net::SSLeay::shutdown ($self->{tls});	1972	Net::SSLeay::shutdown ($self->{tls});
1744		1973
1745	&_dotls;	1974	&_dotls;
1746		1975
1747	# # we don't give a shit. no, we do, but we can't. no...#d#	1976	# # we don't give a shit. no, we do, but we can't. no...#d#
…		…
1754	my ($self) = @_;	1983	my ($self) = @_;
1755		1984
1756	return unless $self->{tls};	1985	return unless $self->{tls};
1757		1986
1758	$self->{tls_ctx}->_put_session (delete $self->{tls})	1987	$self->{tls_ctx}->_put_session (delete $self->{tls})
1759	if ref $self->{tls};	1988	if $self->{tls} > 0;
1760		1989
1761	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};	1990	delete @$self{qw(_rbio _wbio _tls_wbuf _on_starttls)};
1762	}	1991	}
1763		1992
1764	sub DESTROY {	1993	sub DESTROY {
…		…
1772	my $fh = delete $self->{fh};	2001	my $fh = delete $self->{fh};
1773	my $wbuf = delete $self->{wbuf};	2002	my $wbuf = delete $self->{wbuf};
1774		2003
1775	my @linger;	2004	my @linger;
1776		2005
1777	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {	2006	push @linger, AE::io $fh, 1, sub {
1778	my $len = syswrite $fh, $wbuf, length $wbuf;	2007	my $len = syswrite $fh, $wbuf, length $wbuf;
1779		2008
1780	if ($len > 0) {	2009	if ($len > 0) {
1781	substr $wbuf, 0, $len, "";	2010	substr $wbuf, 0, $len, "";
1782	} else {	2011	} elsif (defined $len \|\| ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK)) {
1783	@linger = (); # end	2012	@linger = (); # end
1784	}	2013	}
1785	});	2014	};
1786	push @linger, AnyEvent->timer (after => $linger, cb => sub {	2015	push @linger, AE::timer $linger, 0, sub {
1787	@linger = ();	2016	@linger = ();
1788	});	2017	};
1789	}	2018	}
1790	}	2019	}
1791		2020
1792	=item $handle->destroy	2021	=item $handle->destroy
1793		2022
1794	Shuts down the handle object as much as possible - this call ensures that	2023	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	2024	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.	2025	will be freed. Any method you will call on the handle object after
		2026	destroying it in this way will be silently ignored (and it will return the
		2027	empty list).
1797		2028
1798	Normally, you can just "forget" any references to an AnyEvent::Handle	2029	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	2030	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	2031	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	2032	callback, so when you want to destroy the AnyEvent::Handle object from
…		…
1815	sub destroy {	2046	sub destroy {
1816	my ($self) = @_;	2047	my ($self) = @_;
1817		2048
1818	$self->DESTROY;	2049	$self->DESTROY;
1819	%$self = ();	2050	%$self = ();
		2051	bless $self, "AnyEvent::Handle::destroyed";
1820	}	2052	}
		2053
		2054	sub AnyEvent::Handle::destroyed::AUTOLOAD {
		2055	#nop
		2056	}
		2057
		2058	=item $handle->destroyed
		2059
		2060	Returns false as long as the handle hasn't been destroyed by a call to C<<
		2061	->destroy >>, true otherwise.
		2062
		2063	Can be useful to decide whether the handle is still valid after some
		2064	callback possibly destroyed the handle. For example, C<< ->push_write >>,
		2065	C<< ->starttls >> and other methods can call user callbacks, which in turn
		2066	can destroy the handle, so work can be avoided by checking sometimes:
		2067
		2068	$hdl->starttls ("accept");
		2069	return if $hdl->destroyed;
		2070	$hdl->push_write (...
		2071
		2072	Note that the call to C<push_write> will silently be ignored if the handle
		2073	has been destroyed, so often you can just ignore the possibility of the
		2074	handle being destroyed.
		2075
		2076	=cut
		2077
		2078	sub destroyed { 0 }
		2079	sub AnyEvent::Handle::destroyed::destroyed { 1 }
1821		2080
1822	=item AnyEvent::Handle::TLS_CTX	2081	=item AnyEvent::Handle::TLS_CTX
1823		2082
1824	This function creates and returns the AnyEvent::TLS object used by default	2083	This function creates and returns the AnyEvent::TLS object used by default
1825	for TLS mode.	2084	for TLS mode.
…		…
1857		2116
1858	=item I get different callback invocations in TLS mode/Why can't I pause	2117	=item I get different callback invocations in TLS mode/Why can't I pause
1859	reading?	2118	reading?
1860		2119
1861	Unlike, say, TCP, TLS connections do not consist of two independent	2120	Unlike, say, TCP, TLS connections do not consist of two independent
1862	communication channels, one for each direction. Or put differently. The	2121	communication channels, one for each direction. Or put differently, the
1863	read and write directions are not independent of each other: you cannot	2122	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.	2123	write data unless you are also prepared to read, and vice versa.
1865		2124
1866	This can mean than, in TLS mode, you might get C<on_error> or C<on_eof>	2125	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	2126	callback invocations when you are not expecting any read data - the reason
1868	is that AnyEvent::Handle always reads in TLS mode.	2127	is that AnyEvent::Handle always reads in TLS mode.
1869		2128
1870	During the connection, you have to make sure that you always have a	2129	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	2130	non-empty read-queue, or an C<on_read> watcher. At the end of the
…		…
1885	my $data = delete $_[0]{rbuf};	2144	my $data = delete $_[0]{rbuf};
1886	});	2145	});
1887		2146
1888	The reason to use C<on_error> is that TCP connections, due to latencies	2147	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	2148	and packets loss, might get closed quite violently with an error, when in
1890	fact, all data has been received.	2149	fact all data has been received.
1891		2150
1892	It is usually better to use acknowledgements when transferring data,	2151	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	2152	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	2153	intact. This is also one reason why so many internet protocols have an
1895	explicit QUIT command.	2154	explicit QUIT command.
…		…
1912	consider using C<< ->push_shutdown >> instead.	2171	consider using C<< ->push_shutdown >> instead.
1913		2172
1914	=item I want to contact a TLS/SSL server, I don't care about security.	2173	=item I want to contact a TLS/SSL server, I don't care about security.
1915		2174
1916	If your TLS server is a pure TLS server (e.g. HTTPS) that only speaks TLS,	2175	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>	2176	connect to it and then create the AnyEvent::Handle with the C<tls>
1918	parameter:	2177	parameter:
1919		2178
1920	tcp_connect $host, $port, sub {	2179	tcp_connect $host, $port, sub {
1921	my ($fh) = @_;	2180	my ($fh) = @_;
1922		2181
…		…
2022		2281
2023	=item * all members not documented here and not prefixed with an underscore	2282	=item * all members not documented here and not prefixed with an underscore
2024	are free to use in subclasses.	2283	are free to use in subclasses.
2025		2284
2026	Of course, new versions of AnyEvent::Handle may introduce more "public"	2285	Of course, new versions of AnyEvent::Handle may introduce more "public"
2027	member variables, but thats just life, at least it is documented.	2286	member variables, but that's just life. At least it is documented.
2028		2287
2029	=back	2288	=back
2030		2289
2031	=head1 AUTHOR	2290	=head1 AUTHOR
2032		2291

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.202 by root, Sat Oct 16 02:01:54 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.202 by root, Sat Oct 16 02:01:54 2010 UTC