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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.62 by root, Fri Jun 6 10:49:20 2008 UTC vs.
Revision 1.98 by root, Thu Oct 2 15:11:01 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.14;	19	our $VERSION = 4.3;
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
…		…
124	This sets the callback that is called when the write buffer becomes empty	141	This sets the callback that is called when the write buffer becomes empty
125	(or when the callback is set and the buffer is empty already).	142	(or when the callback is set and the buffer is empty already).
126		143
127	To append to the write buffer, use the C<< ->push_write >> method.	144	To append to the write buffer, use the C<< ->push_write >> method.
128		145
		146	This callback is useful when you don't want to put all of your write data
		147	into the queue at once, for example, when you want to write the contents
		148	of some file to the socket you might not want to read the whole file into
		149	memory and push it into the queue, but instead only read more data from
		150	the file when the write queue becomes empty.
		151
129	=item timeout => $fractional_seconds	152	=item timeout => $fractional_seconds
130		153
131	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
132	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
133	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
134	missing, an C<ETIMEDOUT> error will be raised).	157	missing, a non-fatal C<ETIMEDOUT> error will be raised).
135		158
136	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
137	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
138	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
139	in the C<on_timeout> callback.	162	in the C<on_timeout> callback, in which case AnyEvent::Handle will simply
		163	restart the timeout.
140		164
141	Zero (the default) disables this timeout.	165	Zero (the default) disables this timeout.
142		166
143	=item on_timeout => $cb->($handle)	167	=item on_timeout => $cb->($handle)
144		168
…		…
148		172
149	=item rbuf_max => <bytes>	173	=item rbuf_max => <bytes>
150		174
151	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>)
152	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
153	avoid denial-of-service attacks.	177	avoid some forms of denial-of-service attacks.
154		178
155	For example, a server accepting connections from untrusted sources should	179	For example, a server accepting connections from untrusted sources should
156	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
157	(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
158	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
159	isn't finished).	183	isn't finished).
160		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
161	=item read_size => <bytes>	211	=item read_size => <bytes>
162		212
163	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
164	during each (loop iteration). Default: C<8192>.	214	try to read during each loop iteration, which affects memory
		215	requirements). Default: C<8192>.
165		216
166	=item low_water_mark => <bytes>	217	=item low_water_mark => <bytes>
167		218
168	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
169	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
170	considered empty.	221	considered empty.
171		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
172	=item linger => <seconds>	228	=item linger => <seconds>
173		229
174	If non-zero (default: C<3600>), then the destructor of the	230	If non-zero (default: C<3600>), then the destructor of the
175	AnyEvent::Handle object will check wether there is still outstanding write	231	AnyEvent::Handle object will check whether there is still outstanding
176	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
177	will be reported (this mostly matches how the operating system treats	233	socket. No errors will be reported (this mostly matches how the operating
178	outstanding data at socket close time).	234	system treats outstanding data at socket close time).
179		235
180	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
181	encoded. This data will be lost.	237	yet. This data will be lost. Calling the C<stoptls> method in time might
		238	help.
182		239
183	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	240	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
184		241
185	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
186	will start making tls handshake and will transparently encrypt/decrypt	243	AnyEvent will start a TLS handshake as soon as the conenction has been
187	data.	244	established and will transparently encrypt/decrypt data afterwards.
188		245
189	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
190	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.
191		250
192	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
193	connection, use C<connect> mode.	252	C<accept>, and for the TLS client side of a connection, use C<connect>
		253	mode.
194		254
195	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
196	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>
197	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
198	AnyEvent::Handle.	258	AnyEvent::Handle.
199		259
200	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.
201		261
202	=item tls_ctx => $ssl_ctx	262	=item tls_ctx => $ssl_ctx
203		263
204	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
205	(unless a connection object was specified directly). If this parameter is	265	(unless a connection object was specified directly). If this parameter is
206	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	266	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
207		267
208	=item json => JSON or JSON::XS object	268	=item json => JSON or JSON::XS object
209		269
210	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.
211		271
212	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
213	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.
214		275
215	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
216	use this functionality, as AnyEvent does not have a dependency itself.	277	use this functionality, as AnyEvent does not have a dependency itself.
217		278
218	=item filter_r => $cb
219
220	=item filter_w => $cb
221
222	These exist, but are undocumented at this time.
223
224	=back	279	=back
225		280
226	=cut	281	=cut
227		282
228	sub new {	283	sub new {
…		…
232		287
233	$self->{fh} or Carp::croak "mandatory argument fh is missing";	288	$self->{fh} or Carp::croak "mandatory argument fh is missing";
234		289
235	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	290	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
236		291
237	if ($self->{tls}) {
238	require Net::SSLeay;
239	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});	292	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
240	}	293	if $self->{tls};
241		294
242	$self->{_activity} = AnyEvent->now;	295	$self->{_activity} = AnyEvent->now;
243	$self->_timeout;	296	$self->_timeout;
244		297
245	$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};
		300
		301	$self->start_read
		302	if $self->{on_read};
246		303
247	$self	304	$self
248	}	305	}
249		306
250	sub _shutdown {	307	sub _shutdown {
…		…
253	delete $self->{_tw};	310	delete $self->{_tw};
254	delete $self->{_rw};	311	delete $self->{_rw};
255	delete $self->{_ww};	312	delete $self->{_ww};
256	delete $self->{fh};	313	delete $self->{fh};
257		314
258	$self->stoptls;	315	&_freetls;
		316
		317	delete $self->{on_read};
		318	delete $self->{_queue};
259	}	319	}
260		320
261	sub _error {	321	sub _error {
262	my ($self, $errno, $fatal) = @_;	322	my ($self, $errno, $fatal) = @_;
263		323
…		…
273	}	333	}
274	}	334	}
275		335
276	=item $fh = $handle->fh	336	=item $fh = $handle->fh
277		337
278	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.
279		339
280	=cut	340	=cut
281		341
282	sub fh { $_[0]{fh} }	342	sub fh { $_[0]{fh} }
283		343
…		…
301	$_[0]{on_eof} = $_[1];	361	$_[0]{on_eof} = $_[1];
302	}	362	}
303		363
304	=item $handle->on_timeout ($cb)	364	=item $handle->on_timeout ($cb)
305		365
306	Replace the current C<on_timeout> callback, or disables the callback	366	Replace the current C<on_timeout> callback, or disables the callback (but
307	(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
308	argument.	368	argument and method.
309		369
310	=cut	370	=cut
311		371
312	sub on_timeout {	372	sub on_timeout {
313	$_[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	};
314	}	397	}
315		398
316	#############################################################################	399	#############################################################################
317		400
318	=item $handle->timeout ($seconds)	401	=item $handle->timeout ($seconds)
…		…
396	my ($self, $cb) = @_;	479	my ($self, $cb) = @_;
397		480
398	$self->{on_drain} = $cb;	481	$self->{on_drain} = $cb;
399		482
400	$cb->($self)	483	$cb->($self)
401	if $cb && $self->{low_water_mark} >= length $self->{wbuf};	484	if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});
402	}	485	}
403		486
404	=item $handle->push_write ($data)	487	=item $handle->push_write ($data)
405		488
406	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
…		…
423	substr $self->{wbuf}, 0, $len, "";	506	substr $self->{wbuf}, 0, $len, "";
424		507
425	$self->{_activity} = AnyEvent->now;	508	$self->{_activity} = AnyEvent->now;
426		509
427	$self->{on_drain}($self)	510	$self->{on_drain}($self)
428	if $self->{low_water_mark} >= length $self->{wbuf}	511	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
429	&& $self->{on_drain};	512	&& $self->{on_drain};
430		513
431	delete $self->{_ww} unless length $self->{wbuf};	514	delete $self->{_ww} unless length $self->{wbuf};
432	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	515	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
433	$self->_error ($!, 1);	516	$self->_error ($!, 1);
434	}	517	}
435	};	518	};
436		519
437	# try to write data immediately	520	# try to write data immediately
438	$cb->();	521	$cb->() unless $self->{autocork};
439		522
440	# if still data left in wbuf, we need to poll	523	# if still data left in wbuf, we need to poll
441	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	524	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)
442	if length $self->{wbuf};	525	if length $self->{wbuf};
443	};	526	};
…		…
457		540
458	@_ = ($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")
459	->($self, @_);	542	->($self, @_);
460	}	543	}
461		544
462	if ($self->{filter_w}) {	545	if ($self->{tls}) {
463	$self->{filter_w}($self, \$_[0]);	546	$self->{_tls_wbuf} .= $_[0];
		547
		548	&_dotls ($self);
464	} else {	549	} else {
465	$self->{wbuf} .= $_[0];	550	$self->{wbuf} .= $_[0];
466	$self->_drain_wbuf;	551	$self->_drain_wbuf;
467	}	552	}
468	}	553	}
…		…
485	=cut	570	=cut
486		571
487	register_write_type netstring => sub {	572	register_write_type netstring => sub {
488	my ($self, $string) = @_;	573	my ($self, $string) = @_;
489		574
490	sprintf "%d:%s,", (length $string), $string	575	(length $string) . ":$string,"
491	};	576	};
492		577
493	=item packstring => $format, $data	578	=item packstring => $format, $data
494		579
495	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>
…		…
500	=cut	585	=cut
501		586
502	register_write_type packstring => sub {	587	register_write_type packstring => sub {
503	my ($self, $format, $string) = @_;	588	my ($self, $format, $string) = @_;
504		589
505	pack "$format/a", $string	590	pack "$format/a*", $string
506	};	591	};
507		592
508	=item json => $array_or_hashref	593	=item json => $array_or_hashref
509		594
510	Encodes the given hash or array reference into a JSON object. Unless you	595	Encodes the given hash or array reference into a JSON object. Unless you
…		…
544		629
545	$self->{json} ? $self->{json}->encode ($ref)	630	$self->{json} ? $self->{json}->encode ($ref)
546	: JSON::encode_json ($ref)	631	: JSON::encode_json ($ref)
547	};	632	};
548		633
		634	=item storable => $reference
		635
		636	Freezes the given reference using L<Storable> and writes it to the
		637	handle. Uses the C<nfreeze> format.
		638
		639	=cut
		640
		641	register_write_type storable => sub {
		642	my ($self, $ref) = @_;
		643
		644	require Storable;
		645
		646	pack "w/a*", Storable::nfreeze ($ref)
		647	};
		648
549	=back	649	=back
550		650
551	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	651	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
552		652
553	This function (not method) lets you add your own types to C<push_write>.	653	This function (not method) lets you add your own types to C<push_write>.
…		…
575	ways, the "simple" way, using only C<on_read> and the "complex" way, using	675	ways, the "simple" way, using only C<on_read> and the "complex" way, using
576	a queue.	676	a queue.
577		677
578	In the simple case, you just install an C<on_read> callback and whenever	678	In the simple case, you just install an C<on_read> callback and whenever
579	new data arrives, it will be called. You can then remove some data (if	679	new data arrives, it will be called. You can then remove some data (if
580	enough is there) from the read buffer (C<< $handle->rbuf >>) if you want	680	enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna
581	or not.	681	leave the data there if you want to accumulate more (e.g. when only a
		682	partial message has been received so far).
582		683
583	In the more complex case, you want to queue multiple callbacks. In this	684	In the more complex case, you want to queue multiple callbacks. In this
584	case, AnyEvent::Handle will call the first queued callback each time new	685	case, AnyEvent::Handle will call the first queued callback each time new
585	data arrives (also the first time it is queued) and removes it when it has	686	data arrives (also the first time it is queued) and removes it when it has
586	done its job (see C<push_read>, below).	687	done its job (see C<push_read>, below).
…		…
604	# handle xml	705	# handle xml
605	});	706	});
606	});	707	});
607	});	708	});
608		709
609	Example 2: Implement a client for a protocol that replies either with	710	Example 2: Implement a client for a protocol that replies either with "OK"
610	"OK" and another line or "ERROR" for one request, and 64 bytes for the	711	and another line or "ERROR" for the first request that is sent, and 64
611	second request. Due tot he availability of a full queue, we can just	712	bytes for the second request. Due to the availability of a queue, we can
612	pipeline sending both requests and manipulate the queue as necessary in	713	just pipeline sending both requests and manipulate the queue as necessary
613	the callbacks:	714	in the callbacks.
614		715
615	# request one	716	When the first callback is called and sees an "OK" response, it will
		717	C<unshift> another line-read. This line-read will be queued I<before> the
		718	64-byte chunk callback.
		719
		720	# request one, returns either "OK + extra line" or "ERROR"
616	$handle->push_write ("request 1\015\012");	721	$handle->push_write ("request 1\015\012");
617		722
618	# we expect "ERROR" or "OK" as response, so push a line read	723	# we expect "ERROR" or "OK" as response, so push a line read
619	$handle->push_read (line => sub {	724	$handle->push_read (line => sub {
620	# if we got an "OK", we have to _prepend_ another line,	725	# if we got an "OK", we have to _prepend_ another line,
…		…
627	...	732	...
628	});	733	});
629	}	734	}
630	});	735	});
631		736
632	# request two	737	# request two, simply returns 64 octets
633	$handle->push_write ("request 2\015\012");	738	$handle->push_write ("request 2\015\012");
634		739
635	# simply read 64 bytes, always	740	# simply read 64 bytes, always
636	$handle->push_read (chunk => 64, sub {	741	$handle->push_read (chunk => 64, sub {
637	my $response = $_[1];	742	my $response = $_[1];
…		…
649		754
650	if (	755	if (
651	defined $self->{rbuf_max}	756	defined $self->{rbuf_max}
652	&& $self->{rbuf_max} < length $self->{rbuf}	757	&& $self->{rbuf_max} < length $self->{rbuf}
653	) {	758	) {
654	return $self->_error (&Errno::ENOSPC, 1);	759	$self->_error (&Errno::ENOSPC, 1), return;
655	}	760	}
656		761
657	while () {	762	while () {
658	no strict 'refs';
659
660	my $len = length $self->{rbuf};	763	my $len = length $self->{rbuf};
661		764
662	if (my $cb = shift @{ $self->{_queue} }) {	765	if (my $cb = shift @{ $self->{_queue} }) {
663	unless ($cb->($self)) {	766	unless ($cb->($self)) {
664	if ($self->{_eof}) {	767	if ($self->{_eof}) {
665	# 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)
666	$self->_error (&Errno::EPIPE, 1), last;	769	$self->_error (&Errno::EPIPE, 1), return;
667	}	770	}
668		771
669	unshift @{ $self->{_queue} }, $cb;	772	unshift @{ $self->{_queue} }, $cb;
670	last;	773	last;
671	}	774	}
…		…
679	&& !@{ $self->{_queue} } # and the queue is still empty	782	&& !@{ $self->{_queue} } # and the queue is still empty
680	&& $self->{on_read} # but we still have on_read	783	&& $self->{on_read} # but we still have on_read
681	) {	784	) {
682	# no further data will arrive	785	# no further data will arrive
683	# so no progress can be made	786	# so no progress can be made
684	$self->_error (&Errno::EPIPE, 1), last	787	$self->_error (&Errno::EPIPE, 1), return
685	if $self->{_eof};	788	if $self->{_eof};
686		789
687	last; # more data might arrive	790	last; # more data might arrive
688	}	791	}
689	} else {	792	} else {
690	# read side becomes idle	793	# read side becomes idle
691	delete $self->{_rw};	794	delete $self->{_rw} unless $self->{tls};
692	last;	795	last;
693	}	796	}
694	}	797	}
695		798
		799	if ($self->{_eof}) {
		800	if ($self->{on_eof}) {
696	$self->{on_eof}($self)	801	$self->{on_eof}($self)
697	if $self->{_eof} && $self->{on_eof};	802	} else {
		803	$self->_error (0, 1);
		804	}
		805	}
698		806
699	# may need to restart read watcher	807	# may need to restart read watcher
700	unless ($self->{_rw}) {	808	unless ($self->{_rw}) {
701	$self->start_read	809	$self->start_read
702	if $self->{on_read} \|\| @{ $self->{_queue} };	810	if $self->{on_read} \|\| @{ $self->{_queue} };
…		…
828	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");	936	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");
829	1	937	1
830	}	938	}
831	};	939	};
832		940
833	# compatibility with older API
834	sub push_read_chunk {
835	$_[0]->push_read (chunk => $_[1], $_[2]);
836	}
837
838	sub unshift_read_chunk {
839	$_[0]->unshift_read (chunk => $_[1], $_[2]);
840	}
841
842	=item line => [$eol, ]$cb->($handle, $line, $eol)	941	=item line => [$eol, ]$cb->($handle, $line, $eol)
843		942
844	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
845	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
846	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
…		…
861	=cut	960	=cut
862		961
863	register_read_type line => sub {	962	register_read_type line => sub {
864	my ($self, $cb, $eol) = @_;	963	my ($self, $cb, $eol) = @_;
865		964
866	$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 {
867	$eol = quotemeta $eol unless ref $eol;	974	$eol = quotemeta $eol unless ref $eol;
868	$eol = qr\|^(.*?)($eol)\|s;	975	$eol = qr\|^(.*?)($eol)\|s;
869		976
870	sub {	977	sub {
871	$_[0]{rbuf} =~ s/$eol// or return;	978	$_[0]{rbuf} =~ s/$eol// or return;
872		979
873	$cb->($_[0], $1, $2);	980	$cb->($_[0], $1, $2);
		981	1
874	1	982	}
875	}	983	}
876	};	984	};
877
878	# compatibility with older API
879	sub push_read_line {
880	my $self = shift;
881	$self->push_read (line => @_);
882	}
883
884	sub unshift_read_line {
885	my $self = shift;
886	$self->unshift_read (line => @_);
887	}
888		985
889	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)	986	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
890		987
891	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
892	everything up to and including the match.	989	everything up to and including the match.
…		…
997	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>
998	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
999	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an	1096	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
1000	optional C<!>, C<< < >> or C<< > >> modifier).	1097	optional C<!>, C<< < >> or C<< > >> modifier).
1001		1098
1002	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).
1003		1101
1004	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
1005	format (very efficient).	1103	format (very efficient).
1006		1104
1007	$handle->push_read (packstring => "w", sub {	1105	$handle->push_read (packstring => "w", sub {
…		…
1013	register_read_type packstring => sub {	1111	register_read_type packstring => sub {
1014	my ($self, $cb, $format) = @_;	1112	my ($self, $cb, $format) = @_;
1015		1113
1016	sub {	1114	sub {
1017	# 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
1018	defined (my $len = eval { unpack $format, $_[0]->{rbuf} })	1116	defined (my $len = eval { unpack $format, $_[0]{rbuf} })
1019	or return;	1117	or return;
1020		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 {
1021	# remove prefix	1127	# remove prefix
1022	substr $_[0]->{rbuf}, 0, (length pack $format, $len), "";	1128	substr $_[0]{rbuf}, 0, $format, "";
1023		1129
1024	# read rest	1130	# read remaining chunk
1025	$_[0]->unshift_read (chunk => $len, $cb);	1131	$_[0]->unshift_read (chunk => $len, $cb);
		1132	}
1026		1133
1027	1	1134	1
1028	}	1135	}
1029	};	1136	};
1030		1137
…		…
1045	the C<json> write type description, above, for an actual example.	1152	the C<json> write type description, above, for an actual example.
1046		1153
1047	=cut	1154	=cut
1048		1155
1049	register_read_type json => sub {	1156	register_read_type json => sub {
1050	my ($self, $cb, $accept, $reject, $skip) = @_;	1157	my ($self, $cb) = @_;
1051		1158
1052	require JSON;	1159	require JSON;
1053		1160
1054	my $data;	1161	my $data;
1055	my $rbuf = \$self->{rbuf};	1162	my $rbuf = \$self->{rbuf};
…		…
1070	()	1177	()
1071	}	1178	}
1072	}	1179	}
1073	};	1180	};
1074		1181
		1182	=item storable => $cb->($handle, $ref)
		1183
		1184	Deserialises a L<Storable> frozen representation as written by the
		1185	C<storable> write type (BER-encoded length prefix followed by nfreeze'd
		1186	data).
		1187
		1188	Raises C<EBADMSG> error if the data could not be decoded.
		1189
		1190	=cut
		1191
		1192	register_read_type storable => sub {
		1193	my ($self, $cb) = @_;
		1194
		1195	require Storable;
		1196
		1197	sub {
		1198	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
		1199	defined (my $len = eval { unpack "w", $_[0]{rbuf} })
		1200	or return;
		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 {
		1210	# remove prefix
		1211	substr $_[0]{rbuf}, 0, $format, "";
		1212
		1213	# read remaining chunk
		1214	$_[0]->unshift_read (chunk => $len, sub {
		1215	if (my $ref = eval { Storable::thaw ($_[1]) }) {
		1216	$cb->($_[0], $ref);
		1217	} else {
		1218	$self->_error (&Errno::EBADMSG);
		1219	}
		1220	});
		1221	}
		1222
		1223	1
		1224	}
		1225	};
		1226
1075	=back	1227	=back
1076		1228
1077	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)	1229	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)
1078		1230
1079	This function (not method) lets you add your own types to C<push_read>.	1231	This function (not method) lets you add your own types to C<push_read>.
…		…
1106	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
1107	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
1108	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
1109	there are any read requests in the queue.	1261	there are any read requests in the queue.
1110		1262
		1263	These methods will have no effect when in TLS mode (as TLS doesn't support
		1264	half-duplex connections).
		1265
1111	=cut	1266	=cut
1112		1267
1113	sub stop_read {	1268	sub stop_read {
1114	my ($self) = @_;	1269	my ($self) = @_;
1115		1270
1116	delete $self->{_rw};	1271	delete $self->{_rw} unless $self->{tls};
1117	}	1272	}
1118		1273
1119	sub start_read {	1274	sub start_read {
1120	my ($self) = @_;	1275	my ($self) = @_;
1121		1276
1122	unless ($self->{_rw} \|\| $self->{_eof}) {	1277	unless ($self->{_rw} \|\| $self->{_eof}) {
1123	Scalar::Util::weaken $self;	1278	Scalar::Util::weaken $self;
1124		1279
1125	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1280	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
1126	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1281	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1127	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;
1128		1283
1129	if ($len > 0) {	1284	if ($len > 0) {
1130	$self->{_activity} = AnyEvent->now;	1285	$self->{_activity} = AnyEvent->now;
1131		1286
1132	$self->{filter_r}	1287	if ($self->{tls}) {
1133	? $self->{filter_r}($self, $rbuf)	1288	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1134	: $self->{_in_drain} \|\| $self->_drain_rbuf;	1289
		1290	&_dotls ($self);
		1291	} else {
		1292	$self->_drain_rbuf unless $self->{_in_drain};
		1293	}
1135		1294
1136	} elsif (defined $len) {	1295	} elsif (defined $len) {
1137	delete $self->{_rw};	1296	delete $self->{_rw};
1138	$self->{_eof} = 1;	1297	$self->{_eof} = 1;
1139	$self->_drain_rbuf unless $self->{_in_drain};	1298	$self->_drain_rbuf unless $self->{_in_drain};
…		…
1143	}	1302	}
1144	});	1303	});
1145	}	1304	}
1146	}	1305	}
1147		1306
		1307	# poll the write BIO and send the data if applicable
1148	sub _dotls {	1308	sub _dotls {
1149	my ($self) = @_;	1309	my ($self) = @_;
1150		1310
1151	my $buf;	1311	my $tmp;
1152		1312
1153	if (length $self->{_tls_wbuf}) {	1313	if (length $self->{_tls_wbuf}) {
1154	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1314	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1155	substr $self->{_tls_wbuf}, 0, $len, "";	1315	substr $self->{_tls_wbuf}, 0, $tmp, "";
1156	}	1316	}
1157	}	1317	}
1158		1318
1159	if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1160	$self->{wbuf} .= $buf;
1161	$self->_drain_wbuf;
1162	}
1163
1164	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {	1319	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
1165	if (length $buf) {	1320	unless (length $tmp) {
1166	$self->{rbuf} .= $buf;
1167	$self->_drain_rbuf unless $self->{_in_drain};
1168	} else {
1169	# 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};
1170	$self->{_eof} = 1;	1323	$self->{_eof} = 1;
1171	$self->_shutdown;	1324	&_freetls;
1172	return;
1173	}	1325	}
1174	}
1175		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
1176	my $err = Net::SSLeay::get_error ($self->{tls}, -1);	1332	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1177		1333
1178	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {	1334	if ($tmp != Net::SSLeay::ERROR_WANT_READ ()) {
1179	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {	1335	if ($tmp == Net::SSLeay::ERROR_SYSCALL ()) {
1180	return $self->_error ($!, 1);	1336	return $self->_error ($!, 1);
1181	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {	1337	} elsif ($tmp == Net::SSLeay::ERROR_SSL ()) {
1182	return $self->_error (&Errno::EIO, 1);	1338	return $self->_error (&Errno::EIO, 1);
1183	}	1339	}
1184		1340
1185	# 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;
1186	}	1347	}
1187	}	1348	}
1188		1349
1189	=item $handle->starttls ($tls[, $tls_ctx])	1350	=item $handle->starttls ($tls[, $tls_ctx])
1190		1351
…		…
1200		1361
1201	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
1202	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
1203	might have already started when this function returns.	1364	might have already started when this function returns.
1204		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
1205	=cut	1369	=cut
1206		1370
1207	sub starttls {	1371	sub starttls {
1208	my ($self, $ssl, $ctx) = @_;	1372	my ($self, $ssl, $ctx) = @_;
1209		1373
1210	$self->stoptls;	1374	require Net::SSLeay;
1211		1375
		1376	Carp::croak "it is an error to call starttls more than once on an Anyevent::Handle object"
		1377	if $self->{tls};
		1378
1212	if ($ssl eq "accept") {	1379	if ($ssl eq "accept") {
1213	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1380	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());
1214	Net::SSLeay::set_accept_state ($ssl);	1381	Net::SSLeay::set_accept_state ($ssl);
1215	} elsif ($ssl eq "connect") {	1382	} elsif ($ssl eq "connect") {
1216	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1383	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());
…		…
1222	# 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)
1223	# but the openssl maintainers basically said: "trust us, it just works".	1390	# but the openssl maintainers basically said: "trust us, it just works".
1224	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1391	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1225	# and mismaintained ssleay-module doesn't even offer them).	1392	# and mismaintained ssleay-module doesn't even offer them).
1226	# 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.
1227	Net::SSLeay::CTX_set_mode ($self->{tls},	1401	Net::SSLeay::CTX_set_mode ($self->{tls},
1228	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1402	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
1229	\| (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));
1230		1404
1231	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1405	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1232	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1406	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1233		1407
1234	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1408	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
1235		1409
1236	$self->{filter_w} = sub {	1410	&_dotls; # need to trigger the initial handshake
1237	$_[0]{_tls_wbuf} .= ${$_[1]};	1411	$self->start_read; # make sure we actually do read
1238	&_dotls;
1239	};
1240	$self->{filter_r} = sub {
1241	Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});
1242	&_dotls;
1243	};
1244	}	1412	}
1245		1413
1246	=item $handle->stoptls	1414	=item $handle->stoptls
1247		1415
1248	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
1249	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.
1250		1420
1251	=cut	1421	=cut
1252		1422
1253	sub stoptls {	1423	sub stoptls {
1254	my ($self) = @_;	1424	my ($self) = @_;
1255		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
1256	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};	1442	Net::SSLeay::free (delete $self->{tls});
1257		1443
1258	delete $self->{_rbio};	1444	delete @$self{qw(_rbio _wbio _tls_wbuf)};
1259	delete $self->{_wbio};
1260	delete $self->{_tls_wbuf};
1261	delete $self->{filter_r};
1262	delete $self->{filter_w};
1263	}	1445	}
1264		1446
1265	sub DESTROY {	1447	sub DESTROY {
1266	my $self = shift;	1448	my $self = shift;
1267		1449
1268	$self->stoptls;	1450	&_freetls;
1269		1451
1270	my $linger = exists $self->{linger} ? $self->{linger} : 3600;	1452	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
1271		1453
1272	if ($linger && length $self->{wbuf}) {	1454	if ($linger && length $self->{wbuf}) {
1273	my $fh = delete $self->{fh};	1455	my $fh = delete $self->{fh};
…		…
1325	}	1507	}
1326	}	1508	}
1327		1509
1328	=back	1510	=back
1329		1511
		1512
		1513	=head1 NONFREQUENTLY ASKED QUESTIONS
		1514
		1515	=over 4
		1516
		1517	=item How do I read data until the other side closes the connection?
		1518
		1519	If you just want to read your data into a perl scalar, the easiest way
		1520	to achieve this is by setting an C<on_read> callback that does nothing,
		1521	clearing the C<on_eof> callback and in the C<on_error> callback, the data
		1522	will be in C<$_[0]{rbuf}>:
		1523
		1524	$handle->on_read (sub { });
		1525	$handle->on_eof (undef);
		1526	$handle->on_error (sub {
		1527	my $data = delete $_[0]{rbuf};
		1528	undef $handle;
		1529	});
		1530
		1531	The reason to use C<on_error> is that TCP connections, due to latencies
		1532	and packets loss, might get closed quite violently with an error, when in
		1533	fact, all data has been received.
		1534
		1535	It is usually better to use acknowledgements when transfering data,
		1536	to make sure the other side hasn't just died and you got the data
		1537	intact. This is also one reason why so many internet protocols have an
		1538	explicit QUIT command.
		1539
		1540
		1541	=item I don't want to destroy the handle too early - how do I wait until
		1542	all data has been written?
		1543
		1544	After writing your last bits of data, set the C<on_drain> callback
		1545	and destroy the handle in there - with the default setting of
		1546	C<low_water_mark> this will be called precisely when all data has been
		1547	written to the socket:
		1548
		1549	$handle->push_write (...);
		1550	$handle->on_drain (sub {
		1551	warn "all data submitted to the kernel\n";
		1552	undef $handle;
		1553	});
		1554
		1555	=back
		1556
		1557
1330	=head1 SUBCLASSING AnyEvent::Handle	1558	=head1 SUBCLASSING AnyEvent::Handle
1331		1559
1332	In many cases, you might want to subclass AnyEvent::Handle.	1560	In many cases, you might want to subclass AnyEvent::Handle.
1333		1561
1334	To make this easier, a given version of AnyEvent::Handle uses these	1562	To make this easier, a given version of AnyEvent::Handle uses these
…		…
1337	=over 4	1565	=over 4
1338		1566
1339	=item * all constructor arguments become object members.	1567	=item * all constructor arguments become object members.
1340		1568
1341	At least initially, when you pass a C<tls>-argument to the constructor it	1569	At least initially, when you pass a C<tls>-argument to the constructor it
1342	will end up in C<< $handle->{tls} >>. Those members might be changes or	1570	will end up in C<< $handle->{tls} >>. Those members might be changed or
1343	mutated later on (for example C<tls> will hold the TLS connection object).	1571	mutated later on (for example C<tls> will hold the TLS connection object).
1344		1572
1345	=item * other object member names are prefixed with an C<_>.	1573	=item * other object member names are prefixed with an C<_>.
1346		1574
1347	All object members not explicitly documented (internal use) are prefixed	1575	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.62 by root, Fri Jun 6 10:49:20 2008 UTC vs. Revision 1.98 by root, Thu Oct 2 15:11:01 2008 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.62 by root, Fri Jun 6 10:49:20 2008 UTC vs.
Revision 1.98 by root, Thu Oct 2 15:11:01 2008 UTC