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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.69 by root, Sun Jun 15 21:44:56 2008 UTC vs.
Revision 1.103 by root, Thu Oct 30 03:43:14 2008 UTC

…		…
1	package AnyEvent::Handle;	1	package AnyEvent::Handle;
2		2
3	no warnings;	3	no warnings;
4	use strict;	4	use strict qw(subs vars);
5		5
6	use AnyEvent ();	6	use AnyEvent ();
7	use AnyEvent::Util qw(WSAEWOULDBLOCK);	7	use AnyEvent::Util qw(WSAEWOULDBLOCK);
8	use Scalar::Util ();	8	use Scalar::Util ();
9	use Carp ();	9	use Carp ();
14		14
15	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent	15	AnyEvent::Handle - non-blocking I/O on file handles via AnyEvent
16		16
17	=cut	17	=cut
18		18
19	our $VERSION = 4.151;	19	our $VERSION = 4.31;
20		20
21	=head1 SYNOPSIS	21	=head1 SYNOPSIS
22		22
23	use AnyEvent;	23	use AnyEvent;
24	use AnyEvent::Handle;	24	use AnyEvent::Handle;
…		…
49		49
50	This module is a helper module to make it easier to do event-based I/O on	50	This module is a helper module to make it easier to do event-based I/O on
51	filehandles. For utility functions for doing non-blocking connects and accepts	51	filehandles. For utility functions for doing non-blocking connects and accepts
52	on sockets see L<AnyEvent::Util>.	52	on sockets see L<AnyEvent::Util>.
53		53
		54	The L<AnyEvent::Intro> tutorial contains some well-documented
		55	AnyEvent::Handle examples.
		56
54	In the following, when the documentation refers to of "bytes" then this	57	In the following, when the documentation refers to of "bytes" then this
55	means characters. As sysread and syswrite are used for all I/O, their	58	means characters. As sysread and syswrite are used for all I/O, their
56	treatment of characters applies to this module as well.	59	treatment of characters applies to this module as well.
57		60
58	All callbacks will be invoked with the handle object as their first	61	All callbacks will be invoked with the handle object as their first
…		…
70		73
71	=item fh => $filehandle [MANDATORY]	74	=item fh => $filehandle [MANDATORY]
72		75
73	The filehandle this L<AnyEvent::Handle> object will operate on.	76	The filehandle this L<AnyEvent::Handle> object will operate on.
74		77
75	NOTE: The filehandle will be set to non-blocking (using	78	NOTE: The filehandle will be set to non-blocking mode (using
76	AnyEvent::Util::fh_nonblocking).	79	C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in
		80	that mode.
77		81
78	=item on_eof => $cb->($handle)	82	=item on_eof => $cb->($handle)
79		83
80	Set the callback to be called when an end-of-file condition is detcted,	84	Set the callback to be called when an end-of-file condition is detected,
81	i.e. in the case of a socket, when the other side has closed the	85	i.e. in the case of a socket, when the other side has closed the
82	connection cleanly.	86	connection cleanly.
83		87
		88	For sockets, this just means that the other side has stopped sending data,
		89	you can still try to write data, and, in fact, one can return from the EOF
		90	callback and continue writing data, as only the read part has been shut
		91	down.
		92
84	While not mandatory, it is highly recommended to set an eof callback,	93	While not mandatory, it is I<highly> recommended to set an EOF callback,
85	otherwise you might end up with a closed socket while you are still	94	otherwise you might end up with a closed socket while you are still
86	waiting for data.	95	waiting for data.
		96
		97	If an EOF condition has been detected but no C<on_eof> callback has been
		98	set, then a fatal error will be raised with C<$!> set to <0>.
87		99
88	=item on_error => $cb->($handle, $fatal)	100	=item on_error => $cb->($handle, $fatal)
89		101
90	This is the error callback, which is called when, well, some error	102	This is the error callback, which is called when, well, some error
91	occured, such as not being able to resolve the hostname, failure to	103	occured, such as not being able to resolve the hostname, failure to
92	connect or a read error.	104	connect or a read error.
93		105
94	Some errors are fatal (which is indicated by C<$fatal> being true). On	106	Some errors are fatal (which is indicated by C<$fatal> being true). On
95	fatal errors the handle object will be shut down and will not be	107	fatal errors the handle object will be shut down and will not be usable
		108	(but you are free to look at the current C<< ->rbuf >>). Examples of fatal
		109	errors are an EOF condition with active (but unsatisifable) read watchers
		110	(C<EPIPE>) or I/O errors.
		111
96	usable. Non-fatal errors can be retried by simply returning, but it is	112	Non-fatal errors can be retried by simply returning, but it is recommended
97	recommended to simply ignore this parameter and instead abondon the handle	113	to simply ignore this parameter and instead abondon the handle object
98	object when this callback is invoked.	114	when this callback is invoked. Examples of non-fatal errors are timeouts
		115	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
99		116
100	On callback entrance, the value of C<$!> contains the operating system	117	On callback entrance, the value of C<$!> contains the operating system
101	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).	118	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).
102		119
103	While not mandatory, it is I<highly> recommended to set this callback, as	120	While not mandatory, it is I<highly> recommended to set this callback, as
…		…
135	=item timeout => $fractional_seconds	152	=item timeout => $fractional_seconds
136		153
137	If non-zero, then this enables an "inactivity" timeout: whenever this many	154	If non-zero, then this enables an "inactivity" timeout: whenever this many
138	seconds pass without a successful read or write on the underlying file	155	seconds pass without a successful read or write on the underlying file
139	handle, the C<on_timeout> callback will be invoked (and if that one is	156	handle, the C<on_timeout> callback will be invoked (and if that one is
140	missing, an C<ETIMEDOUT> error will be raised).	157	missing, a non-fatal C<ETIMEDOUT> error will be raised).
141		158
142	Note that timeout processing is also active when you currently do not have	159	Note that timeout processing is also active when you currently do not have
143	any outstanding read or write requests: If you plan to keep the connection	160	any outstanding read or write requests: If you plan to keep the connection
144	idle then you should disable the timout temporarily or ignore the timeout	161	idle then you should disable the timout temporarily or ignore the timeout
145	in the C<on_timeout> callback.	162	in the C<on_timeout> callback, in which case AnyEvent::Handle will simply
		163	restart the timeout.
146		164
147	Zero (the default) disables this timeout.	165	Zero (the default) disables this timeout.
148		166
149	=item on_timeout => $cb->($handle)	167	=item on_timeout => $cb->($handle)
150		168
…		…
154		172
155	=item rbuf_max => <bytes>	173	=item rbuf_max => <bytes>
156		174
157	If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)	175	If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)
158	when the read buffer ever (strictly) exceeds this size. This is useful to	176	when the read buffer ever (strictly) exceeds this size. This is useful to
159	avoid denial-of-service attacks.	177	avoid some forms of denial-of-service attacks.
160		178
161	For example, a server accepting connections from untrusted sources should	179	For example, a server accepting connections from untrusted sources should
162	be configured to accept only so-and-so much data that it cannot act on	180	be configured to accept only so-and-so much data that it cannot act on
163	(for example, when expecting a line, an attacker could send an unlimited	181	(for example, when expecting a line, an attacker could send an unlimited
164	amount of data without a callback ever being called as long as the line	182	amount of data without a callback ever being called as long as the line
165	isn't finished).	183	isn't finished).
166		184
		185	=item autocork => <boolean>
		186
		187	When disabled (the default), then C<push_write> will try to immediately
		188	write the data to the handle, if possible. This avoids having to register
		189	a write watcher and wait for the next event loop iteration, but can
		190	be inefficient if you write multiple small chunks (on the wire, this
		191	disadvantage is usually avoided by your kernel's nagle algorithm, see
		192	C<no_delay>, but this option can save costly syscalls).
		193
		194	When enabled, then writes will always be queued till the next event loop
		195	iteration. This is efficient when you do many small writes per iteration,
		196	but less efficient when you do a single write only per iteration (or when
		197	the write buffer often is full). It also increases write latency.
		198
		199	=item no_delay => <boolean>
		200
		201	When doing small writes on sockets, your operating system kernel might
		202	wait a bit for more data before actually sending it out. This is called
		203	the Nagle algorithm, and usually it is beneficial.
		204
		205	In some situations you want as low a delay as possible, which can be
		206	accomplishd by setting this option to a true value.
		207
		208	The default is your opertaing system's default behaviour (most likely
		209	enabled), this option explicitly enables or disables it, if possible.
		210
167	=item read_size => <bytes>	211	=item read_size => <bytes>
168		212
169	The default read block size (the amount of bytes this module will try to read	213	The default read block size (the amount of bytes this module will
170	during each (loop iteration). Default: C<8192>.	214	try to read during each loop iteration, which affects memory
		215	requirements). Default: C<8192>.
171		216
172	=item low_water_mark => <bytes>	217	=item low_water_mark => <bytes>
173		218
174	Sets the amount of bytes (default: C<0>) that make up an "empty" write	219	Sets the amount of bytes (default: C<0>) that make up an "empty" write
175	buffer: If the write reaches this size or gets even samller it is	220	buffer: If the write reaches this size or gets even samller it is
176	considered empty.	221	considered empty.
177		222
		223	Sometimes it can be beneficial (for performance reasons) to add data to
		224	the write buffer before it is fully drained, but this is a rare case, as
		225	the operating system kernel usually buffers data as well, so the default
		226	is good in almost all cases.
		227
178	=item linger => <seconds>	228	=item linger => <seconds>
179		229
180	If non-zero (default: C<3600>), then the destructor of the	230	If non-zero (default: C<3600>), then the destructor of the
181	AnyEvent::Handle object will check wether there is still outstanding write	231	AnyEvent::Handle object will check whether there is still outstanding
182	data and will install a watcher that will write out this data. No errors	232	write data and will install a watcher that will write this data to the
183	will be reported (this mostly matches how the operating system treats	233	socket. No errors will be reported (this mostly matches how the operating
184	outstanding data at socket close time).	234	system treats outstanding data at socket close time).
185		235
186	This will not work for partial TLS data that could not yet been	236	This will not work for partial TLS data that could not be encoded
187	encoded. This data will be lost.	237	yet. This data will be lost. Calling the C<stoptls> method in time might
		238	help.
188		239
189	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	240	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
190		241
191	When this parameter is given, it enables TLS (SSL) mode, that means it	242	When this parameter is given, it enables TLS (SSL) mode, that means
192	will start making tls handshake and will transparently encrypt/decrypt	243	AnyEvent will start a TLS handshake as soon as the conenction has been
193	data.	244	established and will transparently encrypt/decrypt data afterwards.
194		245
195	TLS mode requires Net::SSLeay to be installed (it will be loaded	246	TLS mode requires Net::SSLeay to be installed (it will be loaded
196	automatically when you try to create a TLS handle).	247	automatically when you try to create a TLS handle): this module doesn't
		248	have a dependency on that module, so if your module requires it, you have
		249	to add the dependency yourself.
197		250
198	For the TLS server side, use C<accept>, and for the TLS client side of a	251	Unlike TCP, TLS has a server and client side: for the TLS server side, use
199	connection, use C<connect> mode.	252	C<accept>, and for the TLS client side of a connection, use C<connect>
		253	mode.
200		254
201	You can also provide your own TLS connection object, but you have	255	You can also provide your own TLS connection object, but you have
202	to make sure that you call either C<Net::SSLeay::set_connect_state>	256	to make sure that you call either C<Net::SSLeay::set_connect_state>
203	or C<Net::SSLeay::set_accept_state> on it before you pass it to	257	or C<Net::SSLeay::set_accept_state> on it before you pass it to
204	AnyEvent::Handle.	258	AnyEvent::Handle.
205		259
206	See the C<starttls> method if you need to start TLs negotiation later.	260	See the C<< ->starttls >> method for when need to start TLS negotiation later.
207		261
208	=item tls_ctx => $ssl_ctx	262	=item tls_ctx => $ssl_ctx
209		263
210	Use the given Net::SSLeay::CTX object to create the new TLS connection	264	Use the given C<Net::SSLeay::CTX> object to create the new TLS connection
211	(unless a connection object was specified directly). If this parameter is	265	(unless a connection object was specified directly). If this parameter is
212	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	266	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
213		267
214	=item json => JSON or JSON::XS object	268	=item json => JSON or JSON::XS object
215		269
216	This is the json coder object used by the C<json> read and write types.	270	This is the json coder object used by the C<json> read and write types.
217		271
218	If you don't supply it, then AnyEvent::Handle will create and use a	272	If you don't supply it, then AnyEvent::Handle will create and use a
219	suitable one, which will write and expect UTF-8 encoded JSON texts.	273	suitable one (on demand), which will write and expect UTF-8 encoded JSON
		274	texts.
220		275
221	Note that you are responsible to depend on the JSON module if you want to	276	Note that you are responsible to depend on the JSON module if you want to
222	use this functionality, as AnyEvent does not have a dependency itself.	277	use this functionality, as AnyEvent does not have a dependency itself.
223		278
224	=item filter_r => $cb
225
226	=item filter_w => $cb
227
228	These exist, but are undocumented at this time.
229
230	=back	279	=back
231		280
232	=cut	281	=cut
233		282
234	sub new {	283	sub new {
…		…
238		287
239	$self->{fh} or Carp::croak "mandatory argument fh is missing";	288	$self->{fh} or Carp::croak "mandatory argument fh is missing";
240		289
241	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	290	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
242		291
243	if ($self->{tls}) {
244	require Net::SSLeay;
245	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});	292	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
246	}	293	if $self->{tls};
247		294
248	$self->{_activity} = AnyEvent->now;	295	$self->{_activity} = AnyEvent->now;
249	$self->_timeout;	296	$self->_timeout;
250		297
251	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	298	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};
		299	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
252		300
253	$self->start_read	301	$self->start_read
254	if $self->{on_read};	302	if $self->{on_read};
255		303
256	$self	304	$self
…		…
262	delete $self->{_tw};	310	delete $self->{_tw};
263	delete $self->{_rw};	311	delete $self->{_rw};
264	delete $self->{_ww};	312	delete $self->{_ww};
265	delete $self->{fh};	313	delete $self->{fh};
266		314
267	$self->stoptls;	315	&_freetls;
		316
		317	delete $self->{on_read};
		318	delete $self->{_queue};
268	}	319	}
269		320
270	sub _error {	321	sub _error {
271	my ($self, $errno, $fatal) = @_;	322	my ($self, $errno, $fatal) = @_;
272		323
…		…
275		326
276	$! = $errno;	327	$! = $errno;
277		328
278	if ($self->{on_error}) {	329	if ($self->{on_error}) {
279	$self->{on_error}($self, $fatal);	330	$self->{on_error}($self, $fatal);
280	} else {	331	} elsif ($self->{fh}) {
281	Carp::croak "AnyEvent::Handle uncaught error: $!";	332	Carp::croak "AnyEvent::Handle uncaught error: $!";
282	}	333	}
283	}	334	}
284		335
285	=item $fh = $handle->fh	336	=item $fh = $handle->fh
286		337
287	This method returns the file handle of the L<AnyEvent::Handle> object.	338	This method returns the file handle used to create the L<AnyEvent::Handle> object.
288		339
289	=cut	340	=cut
290		341
291	sub fh { $_[0]{fh} }	342	sub fh { $_[0]{fh} }
292		343
…		…
310	$_[0]{on_eof} = $_[1];	361	$_[0]{on_eof} = $_[1];
311	}	362	}
312		363
313	=item $handle->on_timeout ($cb)	364	=item $handle->on_timeout ($cb)
314		365
315	Replace the current C<on_timeout> callback, or disables the callback	366	Replace the current C<on_timeout> callback, or disables the callback (but
316	(but not the timeout) if C<$cb> = C<undef>. See C<timeout> constructor	367	not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
317	argument.	368	argument and method.
318		369
319	=cut	370	=cut
320		371
321	sub on_timeout {	372	sub on_timeout {
322	$_[0]{on_timeout} = $_[1];	373	$_[0]{on_timeout} = $_[1];
		374	}
		375
		376	=item $handle->autocork ($boolean)
		377
		378	Enables or disables the current autocork behaviour (see C<autocork>
		379	constructor argument).
		380
		381	=cut
		382
		383	=item $handle->no_delay ($boolean)
		384
		385	Enables or disables the C<no_delay> setting (see constructor argument of
		386	the same name for details).
		387
		388	=cut
		389
		390	sub no_delay {
		391	$_[0]{no_delay} = $_[1];
		392
		393	eval {
		394	local $SIG{__DIE__};
		395	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];
		396	};
323	}	397	}
324		398
325	#############################################################################	399	#############################################################################
326		400
327	=item $handle->timeout ($seconds)	401	=item $handle->timeout ($seconds)
…		…
405	my ($self, $cb) = @_;	479	my ($self, $cb) = @_;
406		480
407	$self->{on_drain} = $cb;	481	$self->{on_drain} = $cb;
408		482
409	$cb->($self)	483	$cb->($self)
410	if $cb && $self->{low_water_mark} >= length $self->{wbuf};	484	if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});
411	}	485	}
412		486
413	=item $handle->push_write ($data)	487	=item $handle->push_write ($data)
414		488
415	Queues the given scalar to be written. You can push as much data as you	489	Queues the given scalar to be written. You can push as much data as you
…		…
432	substr $self->{wbuf}, 0, $len, "";	506	substr $self->{wbuf}, 0, $len, "";
433		507
434	$self->{_activity} = AnyEvent->now;	508	$self->{_activity} = AnyEvent->now;
435		509
436	$self->{on_drain}($self)	510	$self->{on_drain}($self)
437	if $self->{low_water_mark} >= length $self->{wbuf}	511	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
438	&& $self->{on_drain};	512	&& $self->{on_drain};
439		513
440	delete $self->{_ww} unless length $self->{wbuf};	514	delete $self->{_ww} unless length $self->{wbuf};
441	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	515	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
442	$self->_error ($!, 1);	516	$self->_error ($!, 1);
443	}	517	}
444	};	518	};
445		519
446	# try to write data immediately	520	# try to write data immediately
447	$cb->();	521	$cb->() unless $self->{autocork};
448		522
449	# if still data left in wbuf, we need to poll	523	# if still data left in wbuf, we need to poll
450	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	524	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)
451	if length $self->{wbuf};	525	if length $self->{wbuf};
452	};	526	};
…		…
466		540
467	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	541	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")
468	->($self, @_);	542	->($self, @_);
469	}	543	}
470		544
471	if ($self->{filter_w}) {	545	if ($self->{tls}) {
472	$self->{filter_w}($self, \$_[0]);	546	$self->{_tls_wbuf} .= $_[0];
		547
		548	&_dotls ($self);
473	} else {	549	} else {
474	$self->{wbuf} .= $_[0];	550	$self->{wbuf} .= $_[0];
475	$self->_drain_wbuf;	551	$self->_drain_wbuf;
476	}	552	}
477	}	553	}
…		…
494	=cut	570	=cut
495		571
496	register_write_type netstring => sub {	572	register_write_type netstring => sub {
497	my ($self, $string) = @_;	573	my ($self, $string) = @_;
498		574
499	sprintf "%d:%s,", (length $string), $string	575	(length $string) . ":$string,"
500	};	576	};
501		577
502	=item packstring => $format, $data	578	=item packstring => $format, $data
503		579
504	An octet string prefixed with an encoded length. The encoding C<$format>	580	An octet string prefixed with an encoded length. The encoding C<$format>
…		…
678		754
679	if (	755	if (
680	defined $self->{rbuf_max}	756	defined $self->{rbuf_max}
681	&& $self->{rbuf_max} < length $self->{rbuf}	757	&& $self->{rbuf_max} < length $self->{rbuf}
682	) {	758	) {
683	return $self->_error (&Errno::ENOSPC, 1);	759	$self->_error (&Errno::ENOSPC, 1), return;
684	}	760	}
685		761
686	while () {	762	while () {
687	no strict 'refs';
688
689	my $len = length $self->{rbuf};	763	my $len = length $self->{rbuf};
690		764
691	if (my $cb = shift @{ $self->{_queue} }) {	765	if (my $cb = shift @{ $self->{_queue} }) {
692	unless ($cb->($self)) {	766	unless ($cb->($self)) {
693	if ($self->{_eof}) {	767	if ($self->{_eof}) {
694	# no progress can be made (not enough data and no data forthcoming)	768	# no progress can be made (not enough data and no data forthcoming)
695	$self->_error (&Errno::EPIPE, 1), last;	769	$self->_error (&Errno::EPIPE, 1), return;
696	}	770	}
697		771
698	unshift @{ $self->{_queue} }, $cb;	772	unshift @{ $self->{_queue} }, $cb;
699	last;	773	last;
700	}	774	}
…		…
708	&& !@{ $self->{_queue} } # and the queue is still empty	782	&& !@{ $self->{_queue} } # and the queue is still empty
709	&& $self->{on_read} # but we still have on_read	783	&& $self->{on_read} # but we still have on_read
710	) {	784	) {
711	# no further data will arrive	785	# no further data will arrive
712	# so no progress can be made	786	# so no progress can be made
713	$self->_error (&Errno::EPIPE, 1), last	787	$self->_error (&Errno::EPIPE, 1), return
714	if $self->{_eof};	788	if $self->{_eof};
715		789
716	last; # more data might arrive	790	last; # more data might arrive
717	}	791	}
718	} else {	792	} else {
719	# read side becomes idle	793	# read side becomes idle
720	delete $self->{_rw};	794	delete $self->{_rw} unless $self->{tls};
721	last;	795	last;
722	}	796	}
723	}	797	}
724		798
		799	if ($self->{_eof}) {
		800	if ($self->{on_eof}) {
725	$self->{on_eof}($self)	801	$self->{on_eof}($self)
726	if $self->{_eof} && $self->{on_eof};	802	} else {
		803	$self->_error (0, 1);
		804	}
		805	}
727		806
728	# may need to restart read watcher	807	# may need to restart read watcher
729	unless ($self->{_rw}) {	808	unless ($self->{_rw}) {
730	$self->start_read	809	$self->start_read
731	if $self->{on_read} \|\| @{ $self->{_queue} };	810	if $self->{on_read} \|\| @{ $self->{_queue} };
…		…
857	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");	936	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");
858	1	937	1
859	}	938	}
860	};	939	};
861		940
862	# compatibility with older API
863	sub push_read_chunk {
864	$_[0]->push_read (chunk => $_[1], $_[2]);
865	}
866
867	sub unshift_read_chunk {
868	$_[0]->unshift_read (chunk => $_[1], $_[2]);
869	}
870
871	=item line => [$eol, ]$cb->($handle, $line, $eol)	941	=item line => [$eol, ]$cb->($handle, $line, $eol)
872		942
873	The callback will be called only once a full line (including the end of	943	The callback will be called only once a full line (including the end of
874	line marker, C<$eol>) has been read. This line (excluding the end of line	944	line marker, C<$eol>) has been read. This line (excluding the end of line
875	marker) will be passed to the callback as second argument (C<$line>), and	945	marker) will be passed to the callback as second argument (C<$line>), and
…		…
890	=cut	960	=cut
891		961
892	register_read_type line => sub {	962	register_read_type line => sub {
893	my ($self, $cb, $eol) = @_;	963	my ($self, $cb, $eol) = @_;
894		964
895	$eol = qr\|(\015?\012)\| if @_ < 3;	965	if (@_ < 3) {
		966	# this is more than twice as fast as the generic code below
		967	sub {
		968	$_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return;
		969
		970	$cb->($_[0], $1, $2);
		971	1
		972	}
		973	} else {
896	$eol = quotemeta $eol unless ref $eol;	974	$eol = quotemeta $eol unless ref $eol;
897	$eol = qr\|^(.*?)($eol)\|s;	975	$eol = qr\|^(.*?)($eol)\|s;
898		976
899	sub {	977	sub {
900	$_[0]{rbuf} =~ s/$eol// or return;	978	$_[0]{rbuf} =~ s/$eol// or return;
901		979
902	$cb->($_[0], $1, $2);	980	$cb->($_[0], $1, $2);
		981	1
903	1	982	}
904	}	983	}
905	};	984	};
906
907	# compatibility with older API
908	sub push_read_line {
909	my $self = shift;
910	$self->push_read (line => @_);
911	}
912
913	sub unshift_read_line {
914	my $self = shift;
915	$self->unshift_read (line => @_);
916	}
917		985
918	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)	986	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
919		987
920	Makes a regex match against the regex object C<$accept> and returns	988	Makes a regex match against the regex object C<$accept> and returns
921	everything up to and including the match.	989	everything up to and including the match.
…		…
1026	An octet string prefixed with an encoded length. The encoding C<$format>	1094	An octet string prefixed with an encoded length. The encoding C<$format>
1027	uses the same format as a Perl C<pack> format, but must specify a single	1095	uses the same format as a Perl C<pack> format, but must specify a single
1028	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an	1096	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
1029	optional C<!>, C<< < >> or C<< > >> modifier).	1097	optional C<!>, C<< < >> or C<< > >> modifier).
1030		1098
1031	DNS over TCP uses a prefix of C<n>, EPP uses a prefix of C<N>.	1099	For example, DNS over TCP uses a prefix of C<n> (2 octet network order),
		1100	EPP uses a prefix of C<N> (4 octtes).
1032		1101
1033	Example: read a block of data prefixed by its length in BER-encoded	1102	Example: read a block of data prefixed by its length in BER-encoded
1034	format (very efficient).	1103	format (very efficient).
1035		1104
1036	$handle->push_read (packstring => "w", sub {	1105	$handle->push_read (packstring => "w", sub {
…		…
1042	register_read_type packstring => sub {	1111	register_read_type packstring => sub {
1043	my ($self, $cb, $format) = @_;	1112	my ($self, $cb, $format) = @_;
1044		1113
1045	sub {	1114	sub {
1046	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method	1115	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
1047	defined (my $len = eval { unpack $format, $_[0]->{rbuf} })	1116	defined (my $len = eval { unpack $format, $_[0]{rbuf} })
1048	or return;	1117	or return;
1049		1118
		1119	$format = length pack $format, $len;
		1120
		1121	# bypass unshift if we already have the remaining chunk
		1122	if ($format + $len <= length $_[0]{rbuf}) {
		1123	my $data = substr $_[0]{rbuf}, $format, $len;
		1124	substr $_[0]{rbuf}, 0, $format + $len, "";
		1125	$cb->($_[0], $data);
		1126	} else {
1050	# remove prefix	1127	# remove prefix
1051	substr $_[0]->{rbuf}, 0, (length pack $format, $len), "";	1128	substr $_[0]{rbuf}, 0, $format, "";
1052		1129
1053	# read rest	1130	# read remaining chunk
1054	$_[0]->unshift_read (chunk => $len, $cb);	1131	$_[0]->unshift_read (chunk => $len, $cb);
		1132	}
1055		1133
1056	1	1134	1
1057	}	1135	}
1058	};	1136	};
1059		1137
…		…
1116		1194
1117	require Storable;	1195	require Storable;
1118		1196
1119	sub {	1197	sub {
1120	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method	1198	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
1121	defined (my $len = eval { unpack "w", $_[0]->{rbuf} })	1199	defined (my $len = eval { unpack "w", $_[0]{rbuf} })
1122	or return;	1200	or return;
1123		1201
		1202	my $format = length pack "w", $len;
		1203
		1204	# bypass unshift if we already have the remaining chunk
		1205	if ($format + $len <= length $_[0]{rbuf}) {
		1206	my $data = substr $_[0]{rbuf}, $format, $len;
		1207	substr $_[0]{rbuf}, 0, $format + $len, "";
		1208	$cb->($_[0], Storable::thaw ($data));
		1209	} else {
1124	# remove prefix	1210	# remove prefix
1125	substr $_[0]->{rbuf}, 0, (length pack "w", $len), "";	1211	substr $_[0]{rbuf}, 0, $format, "";
1126		1212
1127	# read rest	1213	# read remaining chunk
1128	$_[0]->unshift_read (chunk => $len, sub {	1214	$_[0]->unshift_read (chunk => $len, sub {
1129	if (my $ref = eval { Storable::thaw ($_[1]) }) {	1215	if (my $ref = eval { Storable::thaw ($_[1]) }) {
1130	$cb->($_[0], $ref);	1216	$cb->($_[0], $ref);
1131	} else {	1217	} else {
1132	$self->_error (&Errno::EBADMSG);	1218	$self->_error (&Errno::EBADMSG);
		1219	}
1133	}	1220	});
1134	});	1221	}
		1222
		1223	1
1135	}	1224	}
1136	};	1225	};
1137		1226
1138	=back	1227	=back
1139		1228
…		…
1169	Note that AnyEvent::Handle will automatically C<start_read> for you when	1258	Note that AnyEvent::Handle will automatically C<start_read> for you when
1170	you change the C<on_read> callback or push/unshift a read callback, and it	1259	you change the C<on_read> callback or push/unshift a read callback, and it
1171	will automatically C<stop_read> for you when neither C<on_read> is set nor	1260	will automatically C<stop_read> for you when neither C<on_read> is set nor
1172	there are any read requests in the queue.	1261	there are any read requests in the queue.
1173		1262
		1263	These methods will have no effect when in TLS mode (as TLS doesn't support
		1264	half-duplex connections).
		1265
1174	=cut	1266	=cut
1175		1267
1176	sub stop_read {	1268	sub stop_read {
1177	my ($self) = @_;	1269	my ($self) = @_;
1178		1270
1179	delete $self->{_rw};	1271	delete $self->{_rw} unless $self->{tls};
1180	}	1272	}
1181		1273
1182	sub start_read {	1274	sub start_read {
1183	my ($self) = @_;	1275	my ($self) = @_;
1184		1276
1185	unless ($self->{_rw} \|\| $self->{_eof}) {	1277	unless ($self->{_rw} \|\| $self->{_eof}) {
1186	Scalar::Util::weaken $self;	1278	Scalar::Util::weaken $self;
1187		1279
1188	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1280	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
1189	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1281	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1190	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;	1282	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;
1191		1283
1192	if ($len > 0) {	1284	if ($len > 0) {
1193	$self->{_activity} = AnyEvent->now;	1285	$self->{_activity} = AnyEvent->now;
1194		1286
1195	$self->{filter_r}	1287	if ($self->{tls}) {
1196	? $self->{filter_r}($self, $rbuf)	1288	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1197	: $self->{_in_drain} \|\| $self->_drain_rbuf;	1289
		1290	&_dotls ($self);
		1291	} else {
		1292	$self->_drain_rbuf unless $self->{_in_drain};
		1293	}
1198		1294
1199	} elsif (defined $len) {	1295	} elsif (defined $len) {
1200	delete $self->{_rw};	1296	delete $self->{_rw};
1201	$self->{_eof} = 1;	1297	$self->{_eof} = 1;
1202	$self->_drain_rbuf unless $self->{_in_drain};	1298	$self->_drain_rbuf unless $self->{_in_drain};
…		…
1206	}	1302	}
1207	});	1303	});
1208	}	1304	}
1209	}	1305	}
1210		1306
		1307	# poll the write BIO and send the data if applicable
1211	sub _dotls {	1308	sub _dotls {
1212	my ($self) = @_;	1309	my ($self) = @_;
1213		1310
1214	my $buf;	1311	my $tmp;
1215		1312
1216	if (length $self->{_tls_wbuf}) {	1313	if (length $self->{_tls_wbuf}) {
1217	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1314	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1218	substr $self->{_tls_wbuf}, 0, $len, "";	1315	substr $self->{_tls_wbuf}, 0, $tmp, "";
1219	}	1316	}
1220	}	1317	}
1221		1318
1222	if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1223	$self->{wbuf} .= $buf;
1224	$self->_drain_wbuf;
1225	}
1226
1227	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {	1319	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
1228	if (length $buf) {	1320	unless (length $tmp) {
1229	$self->{rbuf} .= $buf;
1230	$self->_drain_rbuf unless $self->{_in_drain};
1231	} else {
1232	# let's treat SSL-eof as we treat normal EOF	1321	# let's treat SSL-eof as we treat normal EOF
		1322	delete $self->{_rw};
1233	$self->{_eof} = 1;	1323	$self->{_eof} = 1;
1234	$self->_shutdown;	1324	&_freetls;
1235	return;
1236	}	1325	}
1237	}
1238		1326
		1327	$self->{rbuf} .= $tmp;
		1328	$self->_drain_rbuf unless $self->{_in_drain};
		1329	$self->{tls} or return; # tls session might have gone away in callback
		1330	}
		1331
1239	my $err = Net::SSLeay::get_error ($self->{tls}, -1);	1332	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1240		1333
1241	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {	1334	if ($tmp != Net::SSLeay::ERROR_WANT_READ ()) {
1242	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {	1335	if ($tmp == Net::SSLeay::ERROR_SYSCALL ()) {
1243	return $self->_error ($!, 1);	1336	return $self->_error ($!, 1);
1244	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {	1337	} elsif ($tmp == Net::SSLeay::ERROR_SSL ()) {
1245	return $self->_error (&Errno::EIO, 1);	1338	return $self->_error (&Errno::EIO, 1);
1246	}	1339	}
1247		1340
1248	# all others are fine for our purposes	1341	# all other errors are fine for our purposes
		1342	}
		1343
		1344	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
		1345	$self->{wbuf} .= $tmp;
		1346	$self->_drain_wbuf;
1249	}	1347	}
1250	}	1348	}
1251		1349
1252	=item $handle->starttls ($tls[, $tls_ctx])	1350	=item $handle->starttls ($tls[, $tls_ctx])
1253		1351
…		…
1263		1361
1264	The TLS connection object will end up in C<< $handle->{tls} >> after this	1362	The TLS connection object will end up in C<< $handle->{tls} >> after this
1265	call and can be used or changed to your liking. Note that the handshake	1363	call and can be used or changed to your liking. Note that the handshake
1266	might have already started when this function returns.	1364	might have already started when this function returns.
1267		1365
		1366	If it an error to start a TLS handshake more than once per
		1367	AnyEvent::Handle object (this is due to bugs in OpenSSL).
		1368
1268	=cut	1369	=cut
1269		1370
1270	sub starttls {	1371	sub starttls {
1271	my ($self, $ssl, $ctx) = @_;	1372	my ($self, $ssl, $ctx) = @_;
1272		1373
1273	$self->stoptls;	1374	require Net::SSLeay;
1274		1375
		1376	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"
		1377	if $self->{tls};
		1378
1275	if ($ssl eq "accept") {	1379	if ($ssl eq "accept") {
1276	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1380	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());
1277	Net::SSLeay::set_accept_state ($ssl);	1381	Net::SSLeay::set_accept_state ($ssl);
1278	} elsif ($ssl eq "connect") {	1382	} elsif ($ssl eq "connect") {
1279	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1383	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());
…		…
1285	# basically, this is deep magic (because SSL_read should have the same issues)	1389	# basically, this is deep magic (because SSL_read should have the same issues)
1286	# but the openssl maintainers basically said: "trust us, it just works".	1390	# but the openssl maintainers basically said: "trust us, it just works".
1287	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1391	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1288	# and mismaintained ssleay-module doesn't even offer them).	1392	# and mismaintained ssleay-module doesn't even offer them).
1289	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html	1393	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
		1394	#
		1395	# in short: this is a mess.
		1396	#
		1397	# note that we do not try to keep the length constant between writes as we are required to do.
		1398	# we assume that most (but not all) of this insanity only applies to non-blocking cases,
		1399	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
		1400	# have identity issues in that area.
1290	Net::SSLeay::CTX_set_mode ($self->{tls},	1401	Net::SSLeay::CTX_set_mode ($self->{tls},
1291	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1402	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
1292	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));	1403	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
1293		1404
1294	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1405	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1295	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1406	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1296		1407
1297	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1408	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
1298		1409
1299	$self->{filter_w} = sub {	1410	&_dotls; # need to trigger the initial handshake
1300	$_[0]{_tls_wbuf} .= ${$_[1]};	1411	$self->start_read; # make sure we actually do read
1301	&_dotls;
1302	};
1303	$self->{filter_r} = sub {
1304	Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});
1305	&_dotls;
1306	};
1307	}	1412	}
1308		1413
1309	=item $handle->stoptls	1414	=item $handle->stoptls
1310		1415
1311	Destroys the SSL connection, if any. Partial read or write data will be	1416	Shuts down the SSL connection - this makes a proper EOF handshake by
1312	lost.	1417	sending a close notify to the other side, but since OpenSSL doesn't
		1418	support non-blocking shut downs, it is not possible to re-use the stream
		1419	afterwards.
1313		1420
1314	=cut	1421	=cut
1315		1422
1316	sub stoptls {	1423	sub stoptls {
1317	my ($self) = @_;	1424	my ($self) = @_;
1318		1425
		1426	if ($self->{tls}) {
		1427	Net::SSLeay::shutdown ($self->{tls});
		1428
		1429	&_dotls;
		1430
		1431	# we don't give a shit. no, we do, but we can't. no...
		1432	# we, we... have to use openssl :/
		1433	&_freetls;
		1434	}
		1435	}
		1436
		1437	sub _freetls {
		1438	my ($self) = @_;
		1439
		1440	return unless $self->{tls};
		1441
1319	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};	1442	Net::SSLeay::free (delete $self->{tls});
1320		1443
1321	delete $self->{_rbio};	1444	delete @$self{qw(_rbio _wbio _tls_wbuf)};
1322	delete $self->{_wbio};
1323	delete $self->{_tls_wbuf};
1324	delete $self->{filter_r};
1325	delete $self->{filter_w};
1326	}	1445	}
1327		1446
1328	sub DESTROY {	1447	sub DESTROY {
1329	my $self = shift;	1448	my $self = shift;
1330		1449
1331	$self->stoptls;	1450	&_freetls;
1332		1451
1333	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	1452	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1334		1453
1335	if ($linger && length $self->{wbuf}) {	1454	if ($linger && length $self->{wbuf}) {
1336	my $fh = delete $self->{fh};	1455	my $fh = delete $self->{fh};
…		…
1351	@linger = ();	1470	@linger = ();
1352	});	1471	});
1353	}	1472	}
1354	}	1473	}
1355		1474
		1475	=item $handle->destroy
		1476
		1477	Shuts down the handle object as much as possible - this call ensures that
		1478	no further callbacks will be invoked and resources will be freed as much
		1479	as possible. You must not call any methods on the object afterwards.
		1480
		1481	Normally, you can just "forget" any references to an AnyEvent::Handle
		1482	object and it will simply shut down. This works in fatal error and EOF
		1483	callbacks, as well as code outside. It does I<NOT> work in a read or write
		1484	callback, so when you want to destroy the AnyEvent::Handle object from
		1485	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
		1486	that case.
		1487
		1488	The handle might still linger in the background and write out remaining
		1489	data, as specified by the C<linger> option, however.
		1490
		1491	=cut
		1492
		1493	sub destroy {
		1494	my ($self) = @_;
		1495
		1496	$self->DESTROY;
		1497	%$self = ();
		1498	}
		1499
1356	=item AnyEvent::Handle::TLS_CTX	1500	=item AnyEvent::Handle::TLS_CTX
1357		1501
1358	This function creates and returns the Net::SSLeay::CTX object used by	1502	This function creates and returns the Net::SSLeay::CTX object used by
1359	default for TLS mode.	1503	default for TLS mode.
1360		1504
…		…
1388	}	1532	}
1389	}	1533	}
1390		1534
1391	=back	1535	=back
1392		1536
		1537
		1538	=head1 NONFREQUENTLY ASKED QUESTIONS
		1539
		1540	=over 4
		1541
		1542	=item I C<undef> the AnyEvent::Handle reference inside my callback and
		1543	still get further invocations!
		1544
		1545	That's because AnyEvent::Handle keeps a reference to itself when handling
		1546	read or write callbacks.
		1547
		1548	It is only safe to "forget" the reference inside EOF or error callbacks,
		1549	from within all other callbacks, you need to explicitly call the C<<
		1550	->destroy >> method.
		1551
		1552	=item I get different callback invocations in TLS mode/Why can't I pause
		1553	reading?
		1554
		1555	Unlike, say, TCP, TLS connections do not consist of two independent
		1556	communication channels, one for each direction. Or put differently. The
		1557	read and write directions are not independent of each other: you cannot
		1558	write data unless you are also prepared to read, and vice versa.
		1559
		1560	This can mean than, in TLS mode, you might get C<on_error> or C<on_eof>
		1561	callback invocations when you are not expecting any read data - the reason
		1562	is that AnyEvent::Handle always reads in TLS mode.
		1563
		1564	During the connection, you have to make sure that you always have a
		1565	non-empty read-queue, or an C<on_read> watcher. At the end of the
		1566	connection (or when you no longer want to use it) you can call the
		1567	C<destroy> method.
		1568
		1569	=item How do I read data until the other side closes the connection?
		1570
		1571	If you just want to read your data into a perl scalar, the easiest way
		1572	to achieve this is by setting an C<on_read> callback that does nothing,
		1573	clearing the C<on_eof> callback and in the C<on_error> callback, the data
		1574	will be in C<$_[0]{rbuf}>:
		1575
		1576	$handle->on_read (sub { });
		1577	$handle->on_eof (undef);
		1578	$handle->on_error (sub {
		1579	my $data = delete $_[0]{rbuf};
		1580	undef $handle;
		1581	});
		1582
		1583	The reason to use C<on_error> is that TCP connections, due to latencies
		1584	and packets loss, might get closed quite violently with an error, when in
		1585	fact, all data has been received.
		1586
		1587	It is usually better to use acknowledgements when transferring data,
		1588	to make sure the other side hasn't just died and you got the data
		1589	intact. This is also one reason why so many internet protocols have an
		1590	explicit QUIT command.
		1591
		1592	=item I don't want to destroy the handle too early - how do I wait until
		1593	all data has been written?
		1594
		1595	After writing your last bits of data, set the C<on_drain> callback
		1596	and destroy the handle in there - with the default setting of
		1597	C<low_water_mark> this will be called precisely when all data has been
		1598	written to the socket:
		1599
		1600	$handle->push_write (...);
		1601	$handle->on_drain (sub {
		1602	warn "all data submitted to the kernel\n";
		1603	undef $handle;
		1604	});
		1605
		1606	=back
		1607
		1608
1393	=head1 SUBCLASSING AnyEvent::Handle	1609	=head1 SUBCLASSING AnyEvent::Handle
1394		1610
1395	In many cases, you might want to subclass AnyEvent::Handle.	1611	In many cases, you might want to subclass AnyEvent::Handle.
1396		1612
1397	To make this easier, a given version of AnyEvent::Handle uses these	1613	To make this easier, a given version of AnyEvent::Handle uses these
…		…
1400	=over 4	1616	=over 4
1401		1617
1402	=item * all constructor arguments become object members.	1618	=item * all constructor arguments become object members.
1403		1619
1404	At least initially, when you pass a C<tls>-argument to the constructor it	1620	At least initially, when you pass a C<tls>-argument to the constructor it
1405	will end up in C<< $handle->{tls} >>. Those members might be changes or	1621	will end up in C<< $handle->{tls} >>. Those members might be changed or
1406	mutated later on (for example C<tls> will hold the TLS connection object).	1622	mutated later on (for example C<tls> will hold the TLS connection object).
1407		1623
1408	=item * other object member names are prefixed with an C<_>.	1624	=item * other object member names are prefixed with an C<_>.
1409		1625
1410	All object members not explicitly documented (internal use) are prefixed	1626	All object members not explicitly documented (internal use) are prefixed

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.69 by root, Sun Jun 15 21:44:56 2008 UTC vs. Revision 1.103 by root, Thu Oct 30 03:43:14 2008 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.69 by root, Sun Jun 15 21:44:56 2008 UTC vs.
Revision 1.103 by root, Thu Oct 30 03:43:14 2008 UTC