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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.71 by root, Thu Jul 3 02:03:33 2008 UTC vs.
Revision 1.108 by root, Tue Jan 6 20:08:05 2009 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.160;	19	our $VERSION = 4.331;
20		20
21	=head1 SYNOPSIS	21	=head1 SYNOPSIS
22		22
23	use AnyEvent;	23	use AnyEvent;
24	use AnyEvent::Handle;	24	use AnyEvent::Handle;
…		…
27		27
28	my $handle =	28	my $handle =
29	AnyEvent::Handle->new (	29	AnyEvent::Handle->new (
30	fh => \*STDIN,	30	fh => \*STDIN,
31	on_eof => sub {	31	on_eof => sub {
32	$cv->broadcast;	32	$cv->send;
33	},	33	},
34	);	34	);
35		35
36	# send some request line	36	# send some request line
37	$handle->push_write ("getinfo\015\012");	37	$handle->push_write ("getinfo\015\012");
…		…
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
167	=item autocork => <boolean>	185	=item autocork => <boolean>
168		186
169	When disabled (the default), then C<push_write> will try to immediately	187	When disabled (the default), then C<push_write> will try to immediately
170	write the data to the handle if possible. This avoids having to register	188	write the data to the handle, if possible. This avoids having to register
171	a write watcher and wait for the next event loop iteration, but can be	189	a write watcher and wait for the next event loop iteration, but can
172	inefficient if you write multiple small chunks (this disadvantage is	190	be inefficient if you write multiple small chunks (on the wire, this
173	usually avoided by your kernel's nagle algorithm, see C<low_delay>).	191	disadvantage is usually avoided by your kernel's nagle algorithm, see
		192	C<no_delay>, but this option can save costly syscalls).
174		193
175	When enabled, then writes will always be queued till the next event loop	194	When enabled, then writes will always be queued till the next event loop
176	iteration. This is efficient when you do many small writes per iteration,	195	iteration. This is efficient when you do many small writes per iteration,
177	but less efficient when you do a single write only.	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.
178		198
179	=item no_delay => <boolean>	199	=item no_delay => <boolean>
180		200
181	When doing small writes on sockets, your operating system kernel might	201	When doing small writes on sockets, your operating system kernel might
182	wait a bit for more data before actually sending it out. This is called	202	wait a bit for more data before actually sending it out. This is called
183	the Nagle algorithm, and usually it is beneficial.	203	the Nagle algorithm, and usually it is beneficial.
184		204
185	In some situations you want as low a delay as possible, which cna be	205	In some situations you want as low a delay as possible, which can be
186	accomplishd by setting this option to true.	206	accomplishd by setting this option to a true value.
187		207
188	The default is your opertaing system's default behaviour, this option	208	The default is your opertaing system's default behaviour (most likely
189	explicitly enables or disables it, if possible.	209	enabled), this option explicitly enables or disables it, if possible.
190		210
191	=item read_size => <bytes>	211	=item read_size => <bytes>
192		212
193	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
194	during each (loop iteration). Default: C<8192>.	214	try to read during each loop iteration, which affects memory
		215	requirements). Default: C<8192>.
195		216
196	=item low_water_mark => <bytes>	217	=item low_water_mark => <bytes>
197		218
198	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
199	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
200	considered empty.	221	considered empty.
201		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
202	=item linger => <seconds>	228	=item linger => <seconds>
203		229
204	If non-zero (default: C<3600>), then the destructor of the	230	If non-zero (default: C<3600>), then the destructor of the
205	AnyEvent::Handle object will check wether there is still outstanding write	231	AnyEvent::Handle object will check whether there is still outstanding
206	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
207	will be reported (this mostly matches how the operating system treats	233	socket. No errors will be reported (this mostly matches how the operating
208	outstanding data at socket close time).	234	system treats outstanding data at socket close time).
209		235
210	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
211	encoded. This data will be lost.	237	yet. This data will be lost. Calling the C<stoptls> method in time might
		238	help.
212		239
213	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	240	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
214		241
215	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
216	will start making tls handshake and will transparently encrypt/decrypt	243	AnyEvent will start a TLS handshake as soon as the conenction has been
217	data.	244	established and will transparently encrypt/decrypt data afterwards.
218		245
219	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
220	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.
221		250
222	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
223	connection, use C<connect> mode.	252	C<accept>, and for the TLS client side of a connection, use C<connect>
		253	mode.
224		254
225	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
226	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>
227	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
228	AnyEvent::Handle.	258	AnyEvent::Handle.
229		259
230	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.
231		261
232	=item tls_ctx => $ssl_ctx	262	=item tls_ctx => $ssl_ctx
233		263
234	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
235	(unless a connection object was specified directly). If this parameter is	265	(unless a connection object was specified directly). If this parameter is
236	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	266	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
237		267
238	=item json => JSON or JSON::XS object	268	=item json => JSON or JSON::XS object
239		269
240	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.
241		271
242	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
243	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.
244		275
245	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
246	use this functionality, as AnyEvent does not have a dependency itself.	277	use this functionality, as AnyEvent does not have a dependency itself.
247		278
248	=item filter_r => $cb
249
250	=item filter_w => $cb
251
252	These exist, but are undocumented at this time.
253
254	=back	279	=back
255		280
256	=cut	281	=cut
257		282
258	sub new {	283	sub new {
…		…
262		287
263	$self->{fh} or Carp::croak "mandatory argument fh is missing";	288	$self->{fh} or Carp::croak "mandatory argument fh is missing";
264		289
265	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	290	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
266		291
267	if ($self->{tls}) {
268	require Net::SSLeay;
269	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});	292	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
270	}	293	if $self->{tls};
271		294
272	$self->{_activity} = AnyEvent->now;	295	$self->{_activity} = AnyEvent->now;
273	$self->_timeout;	296	$self->_timeout;
274		297
275	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};	298	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};
…		…
287	delete $self->{_tw};	310	delete $self->{_tw};
288	delete $self->{_rw};	311	delete $self->{_rw};
289	delete $self->{_ww};	312	delete $self->{_ww};
290	delete $self->{fh};	313	delete $self->{fh};
291		314
292	$self->stoptls;	315	&_freetls;
		316
		317	delete $self->{on_read};
		318	delete $self->{_queue};
293	}	319	}
294		320
295	sub _error {	321	sub _error {
296	my ($self, $errno, $fatal) = @_;	322	my ($self, $errno, $fatal) = @_;
297		323
…		…
300		326
301	$! = $errno;	327	$! = $errno;
302		328
303	if ($self->{on_error}) {	329	if ($self->{on_error}) {
304	$self->{on_error}($self, $fatal);	330	$self->{on_error}($self, $fatal);
305	} else {	331	} elsif ($self->{fh}) {
306	Carp::croak "AnyEvent::Handle uncaught error: $!";	332	Carp::croak "AnyEvent::Handle uncaught error: $!";
307	}	333	}
308	}	334	}
309		335
310	=item $fh = $handle->fh	336	=item $fh = $handle->fh
311		337
312	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.
313		339
314	=cut	340	=cut
315		341
316	sub fh { $_[0]{fh} }	342	sub fh { $_[0]{fh} }
317		343
…		…
335	$_[0]{on_eof} = $_[1];	361	$_[0]{on_eof} = $_[1];
336	}	362	}
337		363
338	=item $handle->on_timeout ($cb)	364	=item $handle->on_timeout ($cb)
339		365
340	Replace the current C<on_timeout> callback, or disables the callback	366	Replace the current C<on_timeout> callback, or disables the callback (but
341	(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
342	argument.	368	argument and method.
343		369
344	=cut	370	=cut
345		371
346	sub on_timeout {	372	sub on_timeout {
347	$_[0]{on_timeout} = $_[1];	373	$_[0]{on_timeout} = $_[1];
348	}	374	}
349		375
350	=item $handle->autocork ($boolean)	376	=item $handle->autocork ($boolean)
351		377
352	Enables or disables the current autocork behaviour (see C<autocork>	378	Enables or disables the current autocork behaviour (see C<autocork>
353	constructor argument).	379	constructor argument). Changes will only take effect on the next write.
354		380
355	=cut	381	=cut
		382
		383	sub autocork {
		384	$_[0]{autocork} = $_[1];
		385	}
356		386
357	=item $handle->no_delay ($boolean)	387	=item $handle->no_delay ($boolean)
358		388
359	Enables or disables the C<no_delay> setting (see constructor argument of	389	Enables or disables the C<no_delay> setting (see constructor argument of
360	the same name for details).	390	the same name for details).
…		…
453	my ($self, $cb) = @_;	483	my ($self, $cb) = @_;
454		484
455	$self->{on_drain} = $cb;	485	$self->{on_drain} = $cb;
456		486
457	$cb->($self)	487	$cb->($self)
458	if $cb && $self->{low_water_mark} >= length $self->{wbuf};	488	if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});
459	}	489	}
460		490
461	=item $handle->push_write ($data)	491	=item $handle->push_write ($data)
462		492
463	Queues the given scalar to be written. You can push as much data as you	493	Queues the given scalar to be written. You can push as much data as you
…		…
480	substr $self->{wbuf}, 0, $len, "";	510	substr $self->{wbuf}, 0, $len, "";
481		511
482	$self->{_activity} = AnyEvent->now;	512	$self->{_activity} = AnyEvent->now;
483		513
484	$self->{on_drain}($self)	514	$self->{on_drain}($self)
485	if $self->{low_water_mark} >= length $self->{wbuf}	515	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
486	&& $self->{on_drain};	516	&& $self->{on_drain};
487		517
488	delete $self->{_ww} unless length $self->{wbuf};	518	delete $self->{_ww} unless length $self->{wbuf};
489	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	519	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
490	$self->_error ($!, 1);	520	$self->_error ($!, 1);
…		…
514		544
515	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	545	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")
516	->($self, @_);	546	->($self, @_);
517	}	547	}
518		548
519	if ($self->{filter_w}) {	549	if ($self->{tls}) {
520	$self->{filter_w}($self, \$_[0]);	550	$self->{_tls_wbuf} .= $_[0];
		551
		552	&_dotls ($self);
521	} else {	553	} else {
522	$self->{wbuf} .= $_[0];	554	$self->{wbuf} .= $_[0];
523	$self->_drain_wbuf;	555	$self->_drain_wbuf;
524	}	556	}
525	}	557	}
…		…
542	=cut	574	=cut
543		575
544	register_write_type netstring => sub {	576	register_write_type netstring => sub {
545	my ($self, $string) = @_;	577	my ($self, $string) = @_;
546		578
547	sprintf "%d:%s,", (length $string), $string	579	(length $string) . ":$string,"
548	};	580	};
549		581
550	=item packstring => $format, $data	582	=item packstring => $format, $data
551		583
552	An octet string prefixed with an encoded length. The encoding C<$format>	584	An octet string prefixed with an encoded length. The encoding C<$format>
…		…
726		758
727	if (	759	if (
728	defined $self->{rbuf_max}	760	defined $self->{rbuf_max}
729	&& $self->{rbuf_max} < length $self->{rbuf}	761	&& $self->{rbuf_max} < length $self->{rbuf}
730	) {	762	) {
731	return $self->_error (&Errno::ENOSPC, 1);	763	$self->_error (&Errno::ENOSPC, 1), return;
732	}	764	}
733		765
734	while () {	766	while () {
735	no strict 'refs';
736
737	my $len = length $self->{rbuf};	767	my $len = length $self->{rbuf};
738		768
739	if (my $cb = shift @{ $self->{_queue} }) {	769	if (my $cb = shift @{ $self->{_queue} }) {
740	unless ($cb->($self)) {	770	unless ($cb->($self)) {
741	if ($self->{_eof}) {	771	if ($self->{_eof}) {
742	# no progress can be made (not enough data and no data forthcoming)	772	# no progress can be made (not enough data and no data forthcoming)
743	$self->_error (&Errno::EPIPE, 1), last;	773	$self->_error (&Errno::EPIPE, 1), return;
744	}	774	}
745		775
746	unshift @{ $self->{_queue} }, $cb;	776	unshift @{ $self->{_queue} }, $cb;
747	last;	777	last;
748	}	778	}
…		…
756	&& !@{ $self->{_queue} } # and the queue is still empty	786	&& !@{ $self->{_queue} } # and the queue is still empty
757	&& $self->{on_read} # but we still have on_read	787	&& $self->{on_read} # but we still have on_read
758	) {	788	) {
759	# no further data will arrive	789	# no further data will arrive
760	# so no progress can be made	790	# so no progress can be made
761	$self->_error (&Errno::EPIPE, 1), last	791	$self->_error (&Errno::EPIPE, 1), return
762	if $self->{_eof};	792	if $self->{_eof};
763		793
764	last; # more data might arrive	794	last; # more data might arrive
765	}	795	}
766	} else {	796	} else {
767	# read side becomes idle	797	# read side becomes idle
768	delete $self->{_rw};	798	delete $self->{_rw} unless $self->{tls};
769	last;	799	last;
770	}	800	}
771	}	801	}
772		802
		803	if ($self->{_eof}) {
		804	if ($self->{on_eof}) {
773	$self->{on_eof}($self)	805	$self->{on_eof}($self)
774	if $self->{_eof} && $self->{on_eof};	806	} else {
		807	$self->_error (0, 1);
		808	}
		809	}
775		810
776	# may need to restart read watcher	811	# may need to restart read watcher
777	unless ($self->{_rw}) {	812	unless ($self->{_rw}) {
778	$self->start_read	813	$self->start_read
779	if $self->{on_read} \|\| @{ $self->{_queue} };	814	if $self->{on_read} \|\| @{ $self->{_queue} };
…		…
905	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");	940	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");
906	1	941	1
907	}	942	}
908	};	943	};
909		944
910	# compatibility with older API
911	sub push_read_chunk {
912	$_[0]->push_read (chunk => $_[1], $_[2]);
913	}
914
915	sub unshift_read_chunk {
916	$_[0]->unshift_read (chunk => $_[1], $_[2]);
917	}
918
919	=item line => [$eol, ]$cb->($handle, $line, $eol)	945	=item line => [$eol, ]$cb->($handle, $line, $eol)
920		946
921	The callback will be called only once a full line (including the end of	947	The callback will be called only once a full line (including the end of
922	line marker, C<$eol>) has been read. This line (excluding the end of line	948	line marker, C<$eol>) has been read. This line (excluding the end of line
923	marker) will be passed to the callback as second argument (C<$line>), and	949	marker) will be passed to the callback as second argument (C<$line>), and
…		…
938	=cut	964	=cut
939		965
940	register_read_type line => sub {	966	register_read_type line => sub {
941	my ($self, $cb, $eol) = @_;	967	my ($self, $cb, $eol) = @_;
942		968
943	$eol = qr\|(\015?\012)\| if @_ < 3;	969	if (@_ < 3) {
		970	# this is more than twice as fast as the generic code below
		971	sub {
		972	$_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return;
		973
		974	$cb->($_[0], $1, $2);
		975	1
		976	}
		977	} else {
944	$eol = quotemeta $eol unless ref $eol;	978	$eol = quotemeta $eol unless ref $eol;
945	$eol = qr\|^(.*?)($eol)\|s;	979	$eol = qr\|^(.*?)($eol)\|s;
946		980
947	sub {	981	sub {
948	$_[0]{rbuf} =~ s/$eol// or return;	982	$_[0]{rbuf} =~ s/$eol// or return;
949		983
950	$cb->($_[0], $1, $2);	984	$cb->($_[0], $1, $2);
		985	1
951	1	986	}
952	}	987	}
953	};	988	};
954
955	# compatibility with older API
956	sub push_read_line {
957	my $self = shift;
958	$self->push_read (line => @_);
959	}
960
961	sub unshift_read_line {
962	my $self = shift;
963	$self->unshift_read (line => @_);
964	}
965		989
966	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)	990	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
967		991
968	Makes a regex match against the regex object C<$accept> and returns	992	Makes a regex match against the regex object C<$accept> and returns
969	everything up to and including the match.	993	everything up to and including the match.
…		…
1074	An octet string prefixed with an encoded length. The encoding C<$format>	1098	An octet string prefixed with an encoded length. The encoding C<$format>
1075	uses the same format as a Perl C<pack> format, but must specify a single	1099	uses the same format as a Perl C<pack> format, but must specify a single
1076	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an	1100	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
1077	optional C<!>, C<< < >> or C<< > >> modifier).	1101	optional C<!>, C<< < >> or C<< > >> modifier).
1078		1102
1079	DNS over TCP uses a prefix of C<n>, EPP uses a prefix of C<N>.	1103	For example, DNS over TCP uses a prefix of C<n> (2 octet network order),
		1104	EPP uses a prefix of C<N> (4 octtes).
1080		1105
1081	Example: read a block of data prefixed by its length in BER-encoded	1106	Example: read a block of data prefixed by its length in BER-encoded
1082	format (very efficient).	1107	format (very efficient).
1083		1108
1084	$handle->push_read (packstring => "w", sub {	1109	$handle->push_read (packstring => "w", sub {
…		…
1090	register_read_type packstring => sub {	1115	register_read_type packstring => sub {
1091	my ($self, $cb, $format) = @_;	1116	my ($self, $cb, $format) = @_;
1092		1117
1093	sub {	1118	sub {
1094	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method	1119	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
1095	defined (my $len = eval { unpack $format, $_[0]->{rbuf} })	1120	defined (my $len = eval { unpack $format, $_[0]{rbuf} })
1096	or return;	1121	or return;
1097		1122
		1123	$format = length pack $format, $len;
		1124
		1125	# bypass unshift if we already have the remaining chunk
		1126	if ($format + $len <= length $_[0]{rbuf}) {
		1127	my $data = substr $_[0]{rbuf}, $format, $len;
		1128	substr $_[0]{rbuf}, 0, $format + $len, "";
		1129	$cb->($_[0], $data);
		1130	} else {
1098	# remove prefix	1131	# remove prefix
1099	substr $_[0]->{rbuf}, 0, (length pack $format, $len), "";	1132	substr $_[0]{rbuf}, 0, $format, "";
1100		1133
1101	# read rest	1134	# read remaining chunk
1102	$_[0]->unshift_read (chunk => $len, $cb);	1135	$_[0]->unshift_read (chunk => $len, $cb);
		1136	}
1103		1137
1104	1	1138	1
1105	}	1139	}
1106	};	1140	};
1107		1141
…		…
1164		1198
1165	require Storable;	1199	require Storable;
1166		1200
1167	sub {	1201	sub {
1168	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method	1202	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
1169	defined (my $len = eval { unpack "w", $_[0]->{rbuf} })	1203	defined (my $len = eval { unpack "w", $_[0]{rbuf} })
1170	or return;	1204	or return;
1171		1205
		1206	my $format = length pack "w", $len;
		1207
		1208	# bypass unshift if we already have the remaining chunk
		1209	if ($format + $len <= length $_[0]{rbuf}) {
		1210	my $data = substr $_[0]{rbuf}, $format, $len;
		1211	substr $_[0]{rbuf}, 0, $format + $len, "";
		1212	$cb->($_[0], Storable::thaw ($data));
		1213	} else {
1172	# remove prefix	1214	# remove prefix
1173	substr $_[0]->{rbuf}, 0, (length pack "w", $len), "";	1215	substr $_[0]{rbuf}, 0, $format, "";
1174		1216
1175	# read rest	1217	# read remaining chunk
1176	$_[0]->unshift_read (chunk => $len, sub {	1218	$_[0]->unshift_read (chunk => $len, sub {
1177	if (my $ref = eval { Storable::thaw ($_[1]) }) {	1219	if (my $ref = eval { Storable::thaw ($_[1]) }) {
1178	$cb->($_[0], $ref);	1220	$cb->($_[0], $ref);
1179	} else {	1221	} else {
1180	$self->_error (&Errno::EBADMSG);	1222	$self->_error (&Errno::EBADMSG);
		1223	}
1181	}	1224	});
1182	});	1225	}
		1226
		1227	1
1183	}	1228	}
1184	};	1229	};
1185		1230
1186	=back	1231	=back
1187		1232
…		…
1217	Note that AnyEvent::Handle will automatically C<start_read> for you when	1262	Note that AnyEvent::Handle will automatically C<start_read> for you when
1218	you change the C<on_read> callback or push/unshift a read callback, and it	1263	you change the C<on_read> callback or push/unshift a read callback, and it
1219	will automatically C<stop_read> for you when neither C<on_read> is set nor	1264	will automatically C<stop_read> for you when neither C<on_read> is set nor
1220	there are any read requests in the queue.	1265	there are any read requests in the queue.
1221		1266
		1267	These methods will have no effect when in TLS mode (as TLS doesn't support
		1268	half-duplex connections).
		1269
1222	=cut	1270	=cut
1223		1271
1224	sub stop_read {	1272	sub stop_read {
1225	my ($self) = @_;	1273	my ($self) = @_;
1226		1274
1227	delete $self->{_rw};	1275	delete $self->{_rw} unless $self->{tls};
1228	}	1276	}
1229		1277
1230	sub start_read {	1278	sub start_read {
1231	my ($self) = @_;	1279	my ($self) = @_;
1232		1280
1233	unless ($self->{_rw} \|\| $self->{_eof}) {	1281	unless ($self->{_rw} \|\| $self->{_eof}) {
1234	Scalar::Util::weaken $self;	1282	Scalar::Util::weaken $self;
1235		1283
1236	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1284	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
1237	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1285	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1238	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;	1286	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;
1239		1287
1240	if ($len > 0) {	1288	if ($len > 0) {
1241	$self->{_activity} = AnyEvent->now;	1289	$self->{_activity} = AnyEvent->now;
1242		1290
1243	$self->{filter_r}	1291	if ($self->{tls}) {
1244	? $self->{filter_r}($self, $rbuf)	1292	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1245	: $self->{_in_drain} \|\| $self->_drain_rbuf;	1293
		1294	&_dotls ($self);
		1295	} else {
		1296	$self->_drain_rbuf unless $self->{_in_drain};
		1297	}
1246		1298
1247	} elsif (defined $len) {	1299	} elsif (defined $len) {
1248	delete $self->{_rw};	1300	delete $self->{_rw};
1249	$self->{_eof} = 1;	1301	$self->{_eof} = 1;
1250	$self->_drain_rbuf unless $self->{_in_drain};	1302	$self->_drain_rbuf unless $self->{_in_drain};
…		…
1254	}	1306	}
1255	});	1307	});
1256	}	1308	}
1257	}	1309	}
1258		1310
		1311	# poll the write BIO and send the data if applicable
1259	sub _dotls {	1312	sub _dotls {
1260	my ($self) = @_;	1313	my ($self) = @_;
1261		1314
1262	my $buf;	1315	my $tmp;
1263		1316
1264	if (length $self->{_tls_wbuf}) {	1317	if (length $self->{_tls_wbuf}) {
1265	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1318	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1266	substr $self->{_tls_wbuf}, 0, $len, "";	1319	substr $self->{_tls_wbuf}, 0, $tmp, "";
1267	}	1320	}
1268	}	1321	}
1269		1322
1270	if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1271	$self->{wbuf} .= $buf;
1272	$self->_drain_wbuf;
1273	}
1274
1275	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {	1323	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
1276	if (length $buf) {	1324	unless (length $tmp) {
1277	$self->{rbuf} .= $buf;
1278	$self->_drain_rbuf unless $self->{_in_drain};
1279	} else {
1280	# let's treat SSL-eof as we treat normal EOF	1325	# let's treat SSL-eof as we treat normal EOF
		1326	delete $self->{_rw};
1281	$self->{_eof} = 1;	1327	$self->{_eof} = 1;
1282	$self->_shutdown;	1328	&_freetls;
1283	return;
1284	}	1329	}
1285	}
1286		1330
		1331	$self->{rbuf} .= $tmp;
		1332	$self->_drain_rbuf unless $self->{_in_drain};
		1333	$self->{tls} or return; # tls session might have gone away in callback
		1334	}
		1335
1287	my $err = Net::SSLeay::get_error ($self->{tls}, -1);	1336	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1288		1337
1289	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {	1338	if ($tmp != Net::SSLeay::ERROR_WANT_READ ()) {
1290	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {	1339	if ($tmp == Net::SSLeay::ERROR_SYSCALL ()) {
1291	return $self->_error ($!, 1);	1340	return $self->_error ($!, 1);
1292	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {	1341	} elsif ($tmp == Net::SSLeay::ERROR_SSL ()) {
1293	return $self->_error (&Errno::EIO, 1);	1342	return $self->_error (&Errno::EIO, 1);
1294	}	1343	}
1295		1344
1296	# all others are fine for our purposes	1345	# all other errors are fine for our purposes
		1346	}
		1347
		1348	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
		1349	$self->{wbuf} .= $tmp;
		1350	$self->_drain_wbuf;
1297	}	1351	}
1298	}	1352	}
1299		1353
1300	=item $handle->starttls ($tls[, $tls_ctx])	1354	=item $handle->starttls ($tls[, $tls_ctx])
1301		1355
…		…
1311		1365
1312	The TLS connection object will end up in C<< $handle->{tls} >> after this	1366	The TLS connection object will end up in C<< $handle->{tls} >> after this
1313	call and can be used or changed to your liking. Note that the handshake	1367	call and can be used or changed to your liking. Note that the handshake
1314	might have already started when this function returns.	1368	might have already started when this function returns.
1315		1369
		1370	If it an error to start a TLS handshake more than once per
		1371	AnyEvent::Handle object (this is due to bugs in OpenSSL).
		1372
1316	=cut	1373	=cut
1317		1374
1318	sub starttls {	1375	sub starttls {
1319	my ($self, $ssl, $ctx) = @_;	1376	my ($self, $ssl, $ctx) = @_;
1320		1377
1321	$self->stoptls;	1378	require Net::SSLeay;
1322		1379
		1380	Carp::croak "it is an error to call starttls more than once on an AnyEvent::Handle object"
		1381	if $self->{tls};
		1382
1323	if ($ssl eq "accept") {	1383	if ($ssl eq "accept") {
1324	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1384	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());
1325	Net::SSLeay::set_accept_state ($ssl);	1385	Net::SSLeay::set_accept_state ($ssl);
1326	} elsif ($ssl eq "connect") {	1386	} elsif ($ssl eq "connect") {
1327	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1387	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());
…		…
1333	# basically, this is deep magic (because SSL_read should have the same issues)	1393	# basically, this is deep magic (because SSL_read should have the same issues)
1334	# but the openssl maintainers basically said: "trust us, it just works".	1394	# but the openssl maintainers basically said: "trust us, it just works".
1335	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1395	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1336	# and mismaintained ssleay-module doesn't even offer them).	1396	# and mismaintained ssleay-module doesn't even offer them).
1337	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html	1397	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
		1398	#
		1399	# in short: this is a mess.
		1400	#
		1401	# note that we do not try to keep the length constant between writes as we are required to do.
		1402	# we assume that most (but not all) of this insanity only applies to non-blocking cases,
		1403	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
		1404	# have identity issues in that area.
1338	Net::SSLeay::CTX_set_mode ($self->{tls},	1405	Net::SSLeay::CTX_set_mode ($self->{tls},
1339	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1406	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
1340	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));	1407	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
1341		1408
1342	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1409	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1343	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1410	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1344		1411
1345	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1412	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
1346		1413
1347	$self->{filter_w} = sub {	1414	&_dotls; # need to trigger the initial handshake
1348	$_[0]{_tls_wbuf} .= ${$_[1]};	1415	$self->start_read; # make sure we actually do read
1349	&_dotls;
1350	};
1351	$self->{filter_r} = sub {
1352	Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});
1353	&_dotls;
1354	};
1355	}	1416	}
1356		1417
1357	=item $handle->stoptls	1418	=item $handle->stoptls
1358		1419
1359	Destroys the SSL connection, if any. Partial read or write data will be	1420	Shuts down the SSL connection - this makes a proper EOF handshake by
1360	lost.	1421	sending a close notify to the other side, but since OpenSSL doesn't
		1422	support non-blocking shut downs, it is not possible to re-use the stream
		1423	afterwards.
1361		1424
1362	=cut	1425	=cut
1363		1426
1364	sub stoptls {	1427	sub stoptls {
1365	my ($self) = @_;	1428	my ($self) = @_;
1366		1429
		1430	if ($self->{tls}) {
		1431	Net::SSLeay::shutdown ($self->{tls});
		1432
		1433	&_dotls;
		1434
		1435	# we don't give a shit. no, we do, but we can't. no...
		1436	# we, we... have to use openssl :/
		1437	&_freetls;
		1438	}
		1439	}
		1440
		1441	sub _freetls {
		1442	my ($self) = @_;
		1443
		1444	return unless $self->{tls};
		1445
1367	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};	1446	Net::SSLeay::free (delete $self->{tls});
1368		1447
1369	delete $self->{_rbio};	1448	delete @$self{qw(_rbio _wbio _tls_wbuf)};
1370	delete $self->{_wbio};
1371	delete $self->{_tls_wbuf};
1372	delete $self->{filter_r};
1373	delete $self->{filter_w};
1374	}	1449	}
1375		1450
1376	sub DESTROY {	1451	sub DESTROY {
1377	my $self = shift;	1452	my $self = shift;
1378		1453
1379	$self->stoptls;	1454	&_freetls;
1380		1455
1381	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	1456	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1382		1457
1383	if ($linger && length $self->{wbuf}) {	1458	if ($linger && length $self->{wbuf}) {
1384	my $fh = delete $self->{fh};	1459	my $fh = delete $self->{fh};
…		…
1399	@linger = ();	1474	@linger = ();
1400	});	1475	});
1401	}	1476	}
1402	}	1477	}
1403		1478
		1479	=item $handle->destroy
		1480
		1481	Shuts down the handle object as much as possible - this call ensures that
		1482	no further callbacks will be invoked and resources will be freed as much
		1483	as possible. You must not call any methods on the object afterwards.
		1484
		1485	Normally, you can just "forget" any references to an AnyEvent::Handle
		1486	object and it will simply shut down. This works in fatal error and EOF
		1487	callbacks, as well as code outside. It does I<NOT> work in a read or write
		1488	callback, so when you want to destroy the AnyEvent::Handle object from
		1489	within such an callback. You I<MUST> call C<< ->destroy >> explicitly in
		1490	that case.
		1491
		1492	The handle might still linger in the background and write out remaining
		1493	data, as specified by the C<linger> option, however.
		1494
		1495	=cut
		1496
		1497	sub destroy {
		1498	my ($self) = @_;
		1499
		1500	$self->DESTROY;
		1501	%$self = ();
		1502	}
		1503
1404	=item AnyEvent::Handle::TLS_CTX	1504	=item AnyEvent::Handle::TLS_CTX
1405		1505
1406	This function creates and returns the Net::SSLeay::CTX object used by	1506	This function creates and returns the Net::SSLeay::CTX object used by
1407	default for TLS mode.	1507	default for TLS mode.
1408		1508
…		…
1436	}	1536	}
1437	}	1537	}
1438		1538
1439	=back	1539	=back
1440		1540
		1541
		1542	=head1 NONFREQUENTLY ASKED QUESTIONS
		1543
		1544	=over 4
		1545
		1546	=item I C<undef> the AnyEvent::Handle reference inside my callback and
		1547	still get further invocations!
		1548
		1549	That's because AnyEvent::Handle keeps a reference to itself when handling
		1550	read or write callbacks.
		1551
		1552	It is only safe to "forget" the reference inside EOF or error callbacks,
		1553	from within all other callbacks, you need to explicitly call the C<<
		1554	->destroy >> method.
		1555
		1556	=item I get different callback invocations in TLS mode/Why can't I pause
		1557	reading?
		1558
		1559	Unlike, say, TCP, TLS connections do not consist of two independent
		1560	communication channels, one for each direction. Or put differently. The
		1561	read and write directions are not independent of each other: you cannot
		1562	write data unless you are also prepared to read, and vice versa.
		1563
		1564	This can mean than, in TLS mode, you might get C<on_error> or C<on_eof>
		1565	callback invocations when you are not expecting any read data - the reason
		1566	is that AnyEvent::Handle always reads in TLS mode.
		1567
		1568	During the connection, you have to make sure that you always have a
		1569	non-empty read-queue, or an C<on_read> watcher. At the end of the
		1570	connection (or when you no longer want to use it) you can call the
		1571	C<destroy> method.
		1572
		1573	=item How do I read data until the other side closes the connection?
		1574
		1575	If you just want to read your data into a perl scalar, the easiest way
		1576	to achieve this is by setting an C<on_read> callback that does nothing,
		1577	clearing the C<on_eof> callback and in the C<on_error> callback, the data
		1578	will be in C<$_[0]{rbuf}>:
		1579
		1580	$handle->on_read (sub { });
		1581	$handle->on_eof (undef);
		1582	$handle->on_error (sub {
		1583	my $data = delete $_[0]{rbuf};
		1584	undef $handle;
		1585	});
		1586
		1587	The reason to use C<on_error> is that TCP connections, due to latencies
		1588	and packets loss, might get closed quite violently with an error, when in
		1589	fact, all data has been received.
		1590
		1591	It is usually better to use acknowledgements when transferring data,
		1592	to make sure the other side hasn't just died and you got the data
		1593	intact. This is also one reason why so many internet protocols have an
		1594	explicit QUIT command.
		1595
		1596	=item I don't want to destroy the handle too early - how do I wait until
		1597	all data has been written?
		1598
		1599	After writing your last bits of data, set the C<on_drain> callback
		1600	and destroy the handle in there - with the default setting of
		1601	C<low_water_mark> this will be called precisely when all data has been
		1602	written to the socket:
		1603
		1604	$handle->push_write (...);
		1605	$handle->on_drain (sub {
		1606	warn "all data submitted to the kernel\n";
		1607	undef $handle;
		1608	});
		1609
		1610	=back
		1611
		1612
1441	=head1 SUBCLASSING AnyEvent::Handle	1613	=head1 SUBCLASSING AnyEvent::Handle
1442		1614
1443	In many cases, you might want to subclass AnyEvent::Handle.	1615	In many cases, you might want to subclass AnyEvent::Handle.
1444		1616
1445	To make this easier, a given version of AnyEvent::Handle uses these	1617	To make this easier, a given version of AnyEvent::Handle uses these
…		…
1448	=over 4	1620	=over 4
1449		1621
1450	=item * all constructor arguments become object members.	1622	=item * all constructor arguments become object members.
1451		1623
1452	At least initially, when you pass a C<tls>-argument to the constructor it	1624	At least initially, when you pass a C<tls>-argument to the constructor it
1453	will end up in C<< $handle->{tls} >>. Those members might be changes or	1625	will end up in C<< $handle->{tls} >>. Those members might be changed or
1454	mutated later on (for example C<tls> will hold the TLS connection object).	1626	mutated later on (for example C<tls> will hold the TLS connection object).
1455		1627
1456	=item * other object member names are prefixed with an C<_>.	1628	=item * other object member names are prefixed with an C<_>.
1457		1629
1458	All object members not explicitly documented (internal use) are prefixed	1630	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.71 by root, Thu Jul 3 02:03:33 2008 UTC vs. Revision 1.108 by root, Tue Jan 6 20:08:05 2009 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.71 by root, Thu Jul 3 02:03:33 2008 UTC vs.
Revision 1.108 by root, Tue Jan 6 20:08:05 2009 UTC