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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.61 by root, Fri Jun 6 10:23:50 2008 UTC vs.
Revision 1.97 by root, Thu Oct 2 11:07:59 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
59	argument.	62	argument.
60		63
		64	=head2 SIGPIPE is not handled by this module
		65
		66	SIGPIPE is not handled by this module, so one of the practical
		67	requirements of using it is to ignore SIGPIPE (C<$SIG{PIPE} =
		68	'IGNORE'>). At least, this is highly recommend in a networked program: If
		69	you use AnyEvent::Handle in a filter program (like sort), exiting on
		70	SIGPIPE is probably the right thing to do.
		71
61	=head1 METHODS	72	=head1 METHODS
62		73
63	=over 4	74	=over 4
64		75
65	=item B<new (%args)>	76	=item B<new (%args)>
…		…
70		81
71	=item fh => $filehandle [MANDATORY]	82	=item fh => $filehandle [MANDATORY]
72		83
73	The filehandle this L<AnyEvent::Handle> object will operate on.	84	The filehandle this L<AnyEvent::Handle> object will operate on.
74		85
75	NOTE: The filehandle will be set to non-blocking (using	86	NOTE: The filehandle will be set to non-blocking mode (using
76	AnyEvent::Util::fh_nonblocking).	87	C<AnyEvent::Util::fh_nonblocking>) by the constructor and needs to stay in
		88	that mode.
77		89
78	=item on_eof => $cb->($handle)	90	=item on_eof => $cb->($handle)
79		91
80	Set the callback to be called when an end-of-file condition is detcted,	92	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	93	i.e. in the case of a socket, when the other side has closed the
82	connection cleanly.	94	connection cleanly.
83		95
		96	For sockets, this just means that the other side has stopped sending data,
		97	you can still try to write data, and, in fact, one can return from the eof
		98	callback and continue writing data, as only the read part has been shut
		99	down.
		100
84	While not mandatory, it is highly recommended to set an eof callback,	101	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	102	otherwise you might end up with a closed socket while you are still
86	waiting for data.	103	waiting for data.
		104
		105	If an EOF condition has been detected but no C<on_eof> callback has been
		106	set, then a fatal error will be raised with C<$!> set to <0>.
87		107
88	=item on_error => $cb->($handle, $fatal)	108	=item on_error => $cb->($handle, $fatal)
89		109
90	This is the error callback, which is called when, well, some error	110	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	111	occured, such as not being able to resolve the hostname, failure to
92	connect or a read error.	112	connect or a read error.
93		113
94	Some errors are fatal (which is indicated by C<$fatal> being true). On	114	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	115	fatal errors the handle object will be shut down and will not be usable
		116	(but you are free to look at the current C<< ->rbuf >>). Examples of fatal
		117	errors are an EOF condition with active (but unsatisifable) read watchers
		118	(C<EPIPE>) or I/O errors.
		119
96	usable. Non-fatal errors can be retried by simply returning, but it is	120	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	121	to simply ignore this parameter and instead abondon the handle object
98	object when this callback is invoked.	122	when this callback is invoked. Examples of non-fatal errors are timeouts
		123	C<ETIMEDOUT>) or badly-formatted data (C<EBADMSG>).
99		124
100	On callback entrance, the value of C<$!> contains the operating system	125	On callback entrance, the value of C<$!> contains the operating system
101	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).	126	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).
102		127
103	While not mandatory, it is I<highly> recommended to set this callback, as	128	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	149	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).	150	(or when the callback is set and the buffer is empty already).
126		151
127	To append to the write buffer, use the C<< ->push_write >> method.	152	To append to the write buffer, use the C<< ->push_write >> method.
128		153
		154	This callback is useful when you don't want to put all of your write data
		155	into the queue at once, for example, when you want to write the contents
		156	of some file to the socket you might not want to read the whole file into
		157	memory and push it into the queue, but instead only read more data from
		158	the file when the write queue becomes empty.
		159
129	=item timeout => $fractional_seconds	160	=item timeout => $fractional_seconds
130		161
131	If non-zero, then this enables an "inactivity" timeout: whenever this many	162	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	163	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	164	handle, the C<on_timeout> callback will be invoked (and if that one is
134	missing, an C<ETIMEDOUT> error will be raised).	165	missing, a non-fatal C<ETIMEDOUT> error will be raised).
135		166
136	Note that timeout processing is also active when you currently do not have	167	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	168	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	169	idle then you should disable the timout temporarily or ignore the timeout
139	in the C<on_timeout> callback.	170	in the C<on_timeout> callback, in which case AnyEvent::Handle will simply
		171	restart the timeout.
140		172
141	Zero (the default) disables this timeout.	173	Zero (the default) disables this timeout.
142		174
143	=item on_timeout => $cb->($handle)	175	=item on_timeout => $cb->($handle)
144		176
…		…
148		180
149	=item rbuf_max => <bytes>	181	=item rbuf_max => <bytes>
150		182
151	If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)	183	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	184	when the read buffer ever (strictly) exceeds this size. This is useful to
153	avoid denial-of-service attacks.	185	avoid some forms of denial-of-service attacks.
154		186
155	For example, a server accepting connections from untrusted sources should	187	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	188	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	189	(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	190	amount of data without a callback ever being called as long as the line
159	isn't finished).	191	isn't finished).
160		192
		193	=item autocork => <boolean>
		194
		195	When disabled (the default), then C<push_write> will try to immediately
		196	write the data to the handle, if possible. This avoids having to register
		197	a write watcher and wait for the next event loop iteration, but can
		198	be inefficient if you write multiple small chunks (on the wire, this
		199	disadvantage is usually avoided by your kernel's nagle algorithm, see
		200	C<no_delay>, but this option can save costly syscalls).
		201
		202	When enabled, then writes will always be queued till the next event loop
		203	iteration. This is efficient when you do many small writes per iteration,
		204	but less efficient when you do a single write only per iteration (or when
		205	the write buffer often is full). It also increases write latency.
		206
		207	=item no_delay => <boolean>
		208
		209	When doing small writes on sockets, your operating system kernel might
		210	wait a bit for more data before actually sending it out. This is called
		211	the Nagle algorithm, and usually it is beneficial.
		212
		213	In some situations you want as low a delay as possible, which can be
		214	accomplishd by setting this option to a true value.
		215
		216	The default is your opertaing system's default behaviour (most likely
		217	enabled), this option explicitly enables or disables it, if possible.
		218
161	=item read_size => <bytes>	219	=item read_size => <bytes>
162		220
163	The default read block size (the amount of bytes this module will try to read	221	The default read block size (the amount of bytes this module will
164	during each (loop iteration). Default: C<8192>.	222	try to read during each loop iteration, which affects memory
		223	requirements). Default: C<8192>.
165		224
166	=item low_water_mark => <bytes>	225	=item low_water_mark => <bytes>
167		226
168	Sets the amount of bytes (default: C<0>) that make up an "empty" write	227	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	228	buffer: If the write reaches this size or gets even samller it is
170	considered empty.	229	considered empty.
171		230
		231	Sometimes it can be beneficial (for performance reasons) to add data to
		232	the write buffer before it is fully drained, but this is a rare case, as
		233	the operating system kernel usually buffers data as well, so the default
		234	is good in almost all cases.
		235
		236	=item linger => <seconds>
		237
		238	If non-zero (default: C<3600>), then the destructor of the
		239	AnyEvent::Handle object will check whether there is still outstanding
		240	write data and will install a watcher that will write this data to the
		241	socket. No errors will be reported (this mostly matches how the operating
		242	system treats outstanding data at socket close time).
		243
		244	This will not work for partial TLS data that could not be encoded
		245	yet. This data will be lost. Calling the C<stoptls> method in time might
		246	help.
		247
172	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	248	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
173		249
174	When this parameter is given, it enables TLS (SSL) mode, that means it	250	When this parameter is given, it enables TLS (SSL) mode, that means
175	will start making tls handshake and will transparently encrypt/decrypt	251	AnyEvent will start a TLS handshake as soon as the conenction has been
176	data.	252	established and will transparently encrypt/decrypt data afterwards.
177		253
178	TLS mode requires Net::SSLeay to be installed (it will be loaded	254	TLS mode requires Net::SSLeay to be installed (it will be loaded
179	automatically when you try to create a TLS handle).	255	automatically when you try to create a TLS handle): this module doesn't
		256	have a dependency on that module, so if your module requires it, you have
		257	to add the dependency yourself.
180		258
181	For the TLS server side, use C<accept>, and for the TLS client side of a	259	Unlike TCP, TLS has a server and client side: for the TLS server side, use
182	connection, use C<connect> mode.	260	C<accept>, and for the TLS client side of a connection, use C<connect>
		261	mode.
183		262
184	You can also provide your own TLS connection object, but you have	263	You can also provide your own TLS connection object, but you have
185	to make sure that you call either C<Net::SSLeay::set_connect_state>	264	to make sure that you call either C<Net::SSLeay::set_connect_state>
186	or C<Net::SSLeay::set_accept_state> on it before you pass it to	265	or C<Net::SSLeay::set_accept_state> on it before you pass it to
187	AnyEvent::Handle.	266	AnyEvent::Handle.
188		267
189	See the C<starttls> method if you need to start TLs negotiation later.	268	See the C<< ->starttls >> method for when need to start TLS negotiation later.
190		269
191	=item tls_ctx => $ssl_ctx	270	=item tls_ctx => $ssl_ctx
192		271
193	Use the given Net::SSLeay::CTX object to create the new TLS connection	272	Use the given C<Net::SSLeay::CTX> object to create the new TLS connection
194	(unless a connection object was specified directly). If this parameter is	273	(unless a connection object was specified directly). If this parameter is
195	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	274	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
196		275
197	=item json => JSON or JSON::XS object	276	=item json => JSON or JSON::XS object
198		277
199	This is the json coder object used by the C<json> read and write types.	278	This is the json coder object used by the C<json> read and write types.
200		279
201	If you don't supply it, then AnyEvent::Handle will create and use a	280	If you don't supply it, then AnyEvent::Handle will create and use a
202	suitable one, which will write and expect UTF-8 encoded JSON texts.	281	suitable one (on demand), which will write and expect UTF-8 encoded JSON
		282	texts.
203		283
204	Note that you are responsible to depend on the JSON module if you want to	284	Note that you are responsible to depend on the JSON module if you want to
205	use this functionality, as AnyEvent does not have a dependency itself.	285	use this functionality, as AnyEvent does not have a dependency itself.
206		286
207	=item filter_r => $cb
208
209	=item filter_w => $cb
210
211	These exist, but are undocumented at this time.
212
213	=back	287	=back
214		288
215	=cut	289	=cut
216		290
217	sub new {	291	sub new {
…		…
221		295
222	$self->{fh} or Carp::croak "mandatory argument fh is missing";	296	$self->{fh} or Carp::croak "mandatory argument fh is missing";
223		297
224	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	298	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
225		299
226	if ($self->{tls}) {
227	require Net::SSLeay;
228	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});	300	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx})
229	}	301	if $self->{tls};
230		302
231	$self->{_activity} = AnyEvent->now;	303	$self->{_activity} = AnyEvent->now;
232	$self->_timeout;	304	$self->_timeout;
233		305
234	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	306	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};
		307	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
		308
		309	$self->start_read
		310	if $self->{on_read};
235		311
236	$self	312	$self
237	}	313	}
238		314
239	sub _shutdown {	315	sub _shutdown {
…		…
242	delete $self->{_tw};	318	delete $self->{_tw};
243	delete $self->{_rw};	319	delete $self->{_rw};
244	delete $self->{_ww};	320	delete $self->{_ww};
245	delete $self->{fh};	321	delete $self->{fh};
246		322
247	$self->stoptls;	323	&_freetls;
		324
		325	delete $self->{on_read};
		326	delete $self->{_queue};
248	}	327	}
249		328
250	sub _error {	329	sub _error {
251	my ($self, $errno, $fatal) = @_;	330	my ($self, $errno, $fatal) = @_;
252		331
…		…
262	}	341	}
263	}	342	}
264		343
265	=item $fh = $handle->fh	344	=item $fh = $handle->fh
266		345
267	This method returns the file handle of the L<AnyEvent::Handle> object.	346	This method returns the file handle used to create the L<AnyEvent::Handle> object.
268		347
269	=cut	348	=cut
270		349
271	sub fh { $_[0]{fh} }	350	sub fh { $_[0]{fh} }
272		351
…		…
290	$_[0]{on_eof} = $_[1];	369	$_[0]{on_eof} = $_[1];
291	}	370	}
292		371
293	=item $handle->on_timeout ($cb)	372	=item $handle->on_timeout ($cb)
294		373
295	Replace the current C<on_timeout> callback, or disables the callback	374	Replace the current C<on_timeout> callback, or disables the callback (but
296	(but not the timeout) if C<$cb> = C<undef>. See C<timeout> constructor	375	not the timeout) if C<$cb> = C<undef>. See the C<timeout> constructor
297	argument.	376	argument and method.
298		377
299	=cut	378	=cut
300		379
301	sub on_timeout {	380	sub on_timeout {
302	$_[0]{on_timeout} = $_[1];	381	$_[0]{on_timeout} = $_[1];
		382	}
		383
		384	=item $handle->autocork ($boolean)
		385
		386	Enables or disables the current autocork behaviour (see C<autocork>
		387	constructor argument).
		388
		389	=cut
		390
		391	=item $handle->no_delay ($boolean)
		392
		393	Enables or disables the C<no_delay> setting (see constructor argument of
		394	the same name for details).
		395
		396	=cut
		397
		398	sub no_delay {
		399	$_[0]{no_delay} = $_[1];
		400
		401	eval {
		402	local $SIG{__DIE__};
		403	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];
		404	};
303	}	405	}
304		406
305	#############################################################################	407	#############################################################################
306		408
307	=item $handle->timeout ($seconds)	409	=item $handle->timeout ($seconds)
…		…
385	my ($self, $cb) = @_;	487	my ($self, $cb) = @_;
386		488
387	$self->{on_drain} = $cb;	489	$self->{on_drain} = $cb;
388		490
389	$cb->($self)	491	$cb->($self)
390	if $cb && $self->{low_water_mark} >= length $self->{wbuf};	492	if $cb && $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf});
391	}	493	}
392		494
393	=item $handle->push_write ($data)	495	=item $handle->push_write ($data)
394		496
395	Queues the given scalar to be written. You can push as much data as you	497	Queues the given scalar to be written. You can push as much data as you
…		…
412	substr $self->{wbuf}, 0, $len, "";	514	substr $self->{wbuf}, 0, $len, "";
413		515
414	$self->{_activity} = AnyEvent->now;	516	$self->{_activity} = AnyEvent->now;
415		517
416	$self->{on_drain}($self)	518	$self->{on_drain}($self)
417	if $self->{low_water_mark} >= length $self->{wbuf}	519	if $self->{low_water_mark} >= (length $self->{wbuf}) + (length $self->{_tls_wbuf})
418	&& $self->{on_drain};	520	&& $self->{on_drain};
419		521
420	delete $self->{_ww} unless length $self->{wbuf};	522	delete $self->{_ww} unless length $self->{wbuf};
421	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {	523	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
422	$self->_error ($!, 1);	524	$self->_error ($!, 1);
423	}	525	}
424	};	526	};
425		527
426	# try to write data immediately	528	# try to write data immediately
427	$cb->();	529	$cb->() unless $self->{autocork};
428		530
429	# if still data left in wbuf, we need to poll	531	# if still data left in wbuf, we need to poll
430	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	532	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)
431	if length $self->{wbuf};	533	if length $self->{wbuf};
432	};	534	};
…		…
446		548
447	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	549	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")
448	->($self, @_);	550	->($self, @_);
449	}	551	}
450		552
451	if ($self->{filter_w}) {	553	if ($self->{tls}) {
452	$self->{filter_w}($self, \$_[0]);	554	$self->{_tls_wbuf} .= $_[0];
		555
		556	&_dotls ($self);
453	} else {	557	} else {
454	$self->{wbuf} .= $_[0];	558	$self->{wbuf} .= $_[0];
455	$self->_drain_wbuf;	559	$self->_drain_wbuf;
456	}	560	}
457	}	561	}
…		…
474	=cut	578	=cut
475		579
476	register_write_type netstring => sub {	580	register_write_type netstring => sub {
477	my ($self, $string) = @_;	581	my ($self, $string) = @_;
478		582
479	sprintf "%d:%s,", (length $string), $string	583	(length $string) . ":$string,"
480	};	584	};
481		585
482	=item packstring => $format, $data	586	=item packstring => $format, $data
483		587
484	An octet string prefixed with an encoded length. The encoding C<$format>	588	An octet string prefixed with an encoded length. The encoding C<$format>
…		…
489	=cut	593	=cut
490		594
491	register_write_type packstring => sub {	595	register_write_type packstring => sub {
492	my ($self, $format, $string) = @_;	596	my ($self, $format, $string) = @_;
493		597
494	pack "$format/a", $string	598	pack "$format/a*", $string
495	};	599	};
496		600
497	=item json => $array_or_hashref	601	=item json => $array_or_hashref
498		602
499	Encodes the given hash or array reference into a JSON object. Unless you	603	Encodes the given hash or array reference into a JSON object. Unless you
…		…
533		637
534	$self->{json} ? $self->{json}->encode ($ref)	638	$self->{json} ? $self->{json}->encode ($ref)
535	: JSON::encode_json ($ref)	639	: JSON::encode_json ($ref)
536	};	640	};
537		641
		642	=item storable => $reference
		643
		644	Freezes the given reference using L<Storable> and writes it to the
		645	handle. Uses the C<nfreeze> format.
		646
		647	=cut
		648
		649	register_write_type storable => sub {
		650	my ($self, $ref) = @_;
		651
		652	require Storable;
		653
		654	pack "w/a*", Storable::nfreeze ($ref)
		655	};
		656
538	=back	657	=back
539		658
540	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	659	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
541		660
542	This function (not method) lets you add your own types to C<push_write>.	661	This function (not method) lets you add your own types to C<push_write>.
…		…
564	ways, the "simple" way, using only C<on_read> and the "complex" way, using	683	ways, the "simple" way, using only C<on_read> and the "complex" way, using
565	a queue.	684	a queue.
566		685
567	In the simple case, you just install an C<on_read> callback and whenever	686	In the simple case, you just install an C<on_read> callback and whenever
568	new data arrives, it will be called. You can then remove some data (if	687	new data arrives, it will be called. You can then remove some data (if
569	enough is there) from the read buffer (C<< $handle->rbuf >>) if you want	688	enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna
570	or not.	689	leave the data there if you want to accumulate more (e.g. when only a
		690	partial message has been received so far).
571		691
572	In the more complex case, you want to queue multiple callbacks. In this	692	In the more complex case, you want to queue multiple callbacks. In this
573	case, AnyEvent::Handle will call the first queued callback each time new	693	case, AnyEvent::Handle will call the first queued callback each time new
574	data arrives (also the first time it is queued) and removes it when it has	694	data arrives (also the first time it is queued) and removes it when it has
575	done its job (see C<push_read>, below).	695	done its job (see C<push_read>, below).
…		…
593	# handle xml	713	# handle xml
594	});	714	});
595	});	715	});
596	});	716	});
597		717
598	Example 2: Implement a client for a protocol that replies either with	718	Example 2: Implement a client for a protocol that replies either with "OK"
599	"OK" and another line or "ERROR" for one request, and 64 bytes for the	719	and another line or "ERROR" for the first request that is sent, and 64
600	second request. Due tot he availability of a full queue, we can just	720	bytes for the second request. Due to the availability of a queue, we can
601	pipeline sending both requests and manipulate the queue as necessary in	721	just pipeline sending both requests and manipulate the queue as necessary
602	the callbacks:	722	in the callbacks.
603		723
604	# request one	724	When the first callback is called and sees an "OK" response, it will
		725	C<unshift> another line-read. This line-read will be queued I<before> the
		726	64-byte chunk callback.
		727
		728	# request one, returns either "OK + extra line" or "ERROR"
605	$handle->push_write ("request 1\015\012");	729	$handle->push_write ("request 1\015\012");
606		730
607	# we expect "ERROR" or "OK" as response, so push a line read	731	# we expect "ERROR" or "OK" as response, so push a line read
608	$handle->push_read (line => sub {	732	$handle->push_read (line => sub {
609	# if we got an "OK", we have to _prepend_ another line,	733	# if we got an "OK", we have to _prepend_ another line,
…		…
616	...	740	...
617	});	741	});
618	}	742	}
619	});	743	});
620		744
621	# request two	745	# request two, simply returns 64 octets
622	$handle->push_write ("request 2\015\012");	746	$handle->push_write ("request 2\015\012");
623		747
624	# simply read 64 bytes, always	748	# simply read 64 bytes, always
625	$handle->push_read (chunk => 64, sub {	749	$handle->push_read (chunk => 64, sub {
626	my $response = $_[1];	750	my $response = $_[1];
…		…
638		762
639	if (	763	if (
640	defined $self->{rbuf_max}	764	defined $self->{rbuf_max}
641	&& $self->{rbuf_max} < length $self->{rbuf}	765	&& $self->{rbuf_max} < length $self->{rbuf}
642	) {	766	) {
643	return $self->_error (&Errno::ENOSPC, 1);	767	$self->_error (&Errno::ENOSPC, 1), return;
644	}	768	}
645		769
646	while () {	770	while () {
647	no strict 'refs';
648
649	my $len = length $self->{rbuf};	771	my $len = length $self->{rbuf};
650		772
651	if (my $cb = shift @{ $self->{_queue} }) {	773	if (my $cb = shift @{ $self->{_queue} }) {
652	unless ($cb->($self)) {	774	unless ($cb->($self)) {
653	if ($self->{_eof}) {	775	if ($self->{_eof}) {
654	# no progress can be made (not enough data and no data forthcoming)	776	# no progress can be made (not enough data and no data forthcoming)
655	$self->_error (&Errno::EPIPE, 1), last;	777	$self->_error (&Errno::EPIPE, 1), return;
656	}	778	}
657		779
658	unshift @{ $self->{_queue} }, $cb;	780	unshift @{ $self->{_queue} }, $cb;
659	last;	781	last;
660	}	782	}
…		…
668	&& !@{ $self->{_queue} } # and the queue is still empty	790	&& !@{ $self->{_queue} } # and the queue is still empty
669	&& $self->{on_read} # but we still have on_read	791	&& $self->{on_read} # but we still have on_read
670	) {	792	) {
671	# no further data will arrive	793	# no further data will arrive
672	# so no progress can be made	794	# so no progress can be made
673	$self->_error (&Errno::EPIPE, 1), last	795	$self->_error (&Errno::EPIPE, 1), return
674	if $self->{_eof};	796	if $self->{_eof};
675		797
676	last; # more data might arrive	798	last; # more data might arrive
677	}	799	}
678	} else {	800	} else {
679	# read side becomes idle	801	# read side becomes idle
680	delete $self->{_rw};	802	delete $self->{_rw} unless $self->{tls};
681	last;	803	last;
682	}	804	}
683	}	805	}
684		806
		807	if ($self->{_eof}) {
		808	if ($self->{on_eof}) {
685	$self->{on_eof}($self)	809	$self->{on_eof}($self)
686	if $self->{_eof} && $self->{on_eof};	810	} else {
		811	$self->_error (0, 1);
		812	}
		813	}
687		814
688	# may need to restart read watcher	815	# may need to restart read watcher
689	unless ($self->{_rw}) {	816	unless ($self->{_rw}) {
690	$self->start_read	817	$self->start_read
691	if $self->{on_read} \|\| @{ $self->{_queue} };	818	if $self->{on_read} \|\| @{ $self->{_queue} };
…		…
817	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");	944	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");
818	1	945	1
819	}	946	}
820	};	947	};
821		948
822	# compatibility with older API
823	sub push_read_chunk {
824	$_[0]->push_read (chunk => $_[1], $_[2]);
825	}
826
827	sub unshift_read_chunk {
828	$_[0]->unshift_read (chunk => $_[1], $_[2]);
829	}
830
831	=item line => [$eol, ]$cb->($handle, $line, $eol)	949	=item line => [$eol, ]$cb->($handle, $line, $eol)
832		950
833	The callback will be called only once a full line (including the end of	951	The callback will be called only once a full line (including the end of
834	line marker, C<$eol>) has been read. This line (excluding the end of line	952	line marker, C<$eol>) has been read. This line (excluding the end of line
835	marker) will be passed to the callback as second argument (C<$line>), and	953	marker) will be passed to the callback as second argument (C<$line>), and
…		…
850	=cut	968	=cut
851		969
852	register_read_type line => sub {	970	register_read_type line => sub {
853	my ($self, $cb, $eol) = @_;	971	my ($self, $cb, $eol) = @_;
854		972
855	$eol = qr\|(\015?\012)\| if @_ < 3;	973	if (@_ < 3) {
		974	# this is more than twice as fast as the generic code below
		975	sub {
		976	$_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return;
		977
		978	$cb->($_[0], $1, $2);
		979	1
		980	}
		981	} else {
856	$eol = quotemeta $eol unless ref $eol;	982	$eol = quotemeta $eol unless ref $eol;
857	$eol = qr\|^(.*?)($eol)\|s;	983	$eol = qr\|^(.*?)($eol)\|s;
858		984
859	sub {	985	sub {
860	$_[0]{rbuf} =~ s/$eol// or return;	986	$_[0]{rbuf} =~ s/$eol// or return;
861		987
862	$cb->($_[0], $1, $2);	988	$cb->($_[0], $1, $2);
		989	1
863	1	990	}
864	}	991	}
865	};	992	};
866
867	# compatibility with older API
868	sub push_read_line {
869	my $self = shift;
870	$self->push_read (line => @_);
871	}
872
873	sub unshift_read_line {
874	my $self = shift;
875	$self->unshift_read (line => @_);
876	}
877		993
878	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)	994	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
879		995
880	Makes a regex match against the regex object C<$accept> and returns	996	Makes a regex match against the regex object C<$accept> and returns
881	everything up to and including the match.	997	everything up to and including the match.
…		…
986	An octet string prefixed with an encoded length. The encoding C<$format>	1102	An octet string prefixed with an encoded length. The encoding C<$format>
987	uses the same format as a Perl C<pack> format, but must specify a single	1103	uses the same format as a Perl C<pack> format, but must specify a single
988	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an	1104	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
989	optional C<!>, C<< < >> or C<< > >> modifier).	1105	optional C<!>, C<< < >> or C<< > >> modifier).
990		1106
991	DNS over TCP uses a prefix of C<n>, EPP uses a prefix of C<N>.	1107	For example, DNS over TCP uses a prefix of C<n> (2 octet network order),
		1108	EPP uses a prefix of C<N> (4 octtes).
992		1109
993	Example: read a block of data prefixed by its length in BER-encoded	1110	Example: read a block of data prefixed by its length in BER-encoded
994	format (very efficient).	1111	format (very efficient).
995		1112
996	$handle->push_read (packstring => "w", sub {	1113	$handle->push_read (packstring => "w", sub {
…		…
1002	register_read_type packstring => sub {	1119	register_read_type packstring => sub {
1003	my ($self, $cb, $format) = @_;	1120	my ($self, $cb, $format) = @_;
1004		1121
1005	sub {	1122	sub {
1006	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method	1123	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
1007	defined (my $len = eval { unpack $format, $_[0]->{rbuf} })	1124	defined (my $len = eval { unpack $format, $_[0]{rbuf} })
1008	or return;	1125	or return;
1009		1126
		1127	$format = length pack $format, $len;
		1128
		1129	# bypass unshift if we already have the remaining chunk
		1130	if ($format + $len <= length $_[0]{rbuf}) {
		1131	my $data = substr $_[0]{rbuf}, $format, $len;
		1132	substr $_[0]{rbuf}, 0, $format + $len, "";
		1133	$cb->($_[0], $data);
		1134	} else {
1010	# remove prefix	1135	# remove prefix
1011	substr $_[0]->{rbuf}, 0, (length pack $format, $len), "";	1136	substr $_[0]{rbuf}, 0, $format, "";
1012		1137
1013	# read rest	1138	# read remaining chunk
1014	$_[0]->unshift_read (chunk => $len, $cb);	1139	$_[0]->unshift_read (chunk => $len, $cb);
		1140	}
1015		1141
1016	1	1142	1
1017	}	1143	}
1018	};	1144	};
1019		1145
…		…
1034	the C<json> write type description, above, for an actual example.	1160	the C<json> write type description, above, for an actual example.
1035		1161
1036	=cut	1162	=cut
1037		1163
1038	register_read_type json => sub {	1164	register_read_type json => sub {
1039	my ($self, $cb, $accept, $reject, $skip) = @_;	1165	my ($self, $cb) = @_;
1040		1166
1041	require JSON;	1167	require JSON;
1042		1168
1043	my $data;	1169	my $data;
1044	my $rbuf = \$self->{rbuf};	1170	my $rbuf = \$self->{rbuf};
…		…
1059	()	1185	()
1060	}	1186	}
1061	}	1187	}
1062	};	1188	};
1063		1189
		1190	=item storable => $cb->($handle, $ref)
		1191
		1192	Deserialises a L<Storable> frozen representation as written by the
		1193	C<storable> write type (BER-encoded length prefix followed by nfreeze'd
		1194	data).
		1195
		1196	Raises C<EBADMSG> error if the data could not be decoded.
		1197
		1198	=cut
		1199
		1200	register_read_type storable => sub {
		1201	my ($self, $cb) = @_;
		1202
		1203	require Storable;
		1204
		1205	sub {
		1206	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
		1207	defined (my $len = eval { unpack "w", $_[0]{rbuf} })
		1208	or return;
		1209
		1210	my $format = length pack "w", $len;
		1211
		1212	# bypass unshift if we already have the remaining chunk
		1213	if ($format + $len <= length $_[0]{rbuf}) {
		1214	my $data = substr $_[0]{rbuf}, $format, $len;
		1215	substr $_[0]{rbuf}, 0, $format + $len, "";
		1216	$cb->($_[0], Storable::thaw ($data));
		1217	} else {
		1218	# remove prefix
		1219	substr $_[0]{rbuf}, 0, $format, "";
		1220
		1221	# read remaining chunk
		1222	$_[0]->unshift_read (chunk => $len, sub {
		1223	if (my $ref = eval { Storable::thaw ($_[1]) }) {
		1224	$cb->($_[0], $ref);
		1225	} else {
		1226	$self->_error (&Errno::EBADMSG);
		1227	}
		1228	});
		1229	}
		1230
		1231	1
		1232	}
		1233	};
		1234
1064	=back	1235	=back
1065		1236
1066	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)	1237	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)
1067		1238
1068	This function (not method) lets you add your own types to C<push_read>.	1239	This function (not method) lets you add your own types to C<push_read>.
…		…
1095	Note that AnyEvent::Handle will automatically C<start_read> for you when	1266	Note that AnyEvent::Handle will automatically C<start_read> for you when
1096	you change the C<on_read> callback or push/unshift a read callback, and it	1267	you change the C<on_read> callback or push/unshift a read callback, and it
1097	will automatically C<stop_read> for you when neither C<on_read> is set nor	1268	will automatically C<stop_read> for you when neither C<on_read> is set nor
1098	there are any read requests in the queue.	1269	there are any read requests in the queue.
1099		1270
		1271	These methods will have no effect when in TLS mode (as TLS doesn't support
		1272	half-duplex connections).
		1273
1100	=cut	1274	=cut
1101		1275
1102	sub stop_read {	1276	sub stop_read {
1103	my ($self) = @_;	1277	my ($self) = @_;
1104		1278
1105	delete $self->{_rw};	1279	delete $self->{_rw} unless $self->{tls};
1106	}	1280	}
1107		1281
1108	sub start_read {	1282	sub start_read {
1109	my ($self) = @_;	1283	my ($self) = @_;
1110		1284
1111	unless ($self->{_rw} \|\| $self->{_eof}) {	1285	unless ($self->{_rw} \|\| $self->{_eof}) {
1112	Scalar::Util::weaken $self;	1286	Scalar::Util::weaken $self;
1113		1287
1114	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1288	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
1115	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1289	my $rbuf = \($self->{tls} ? my $buf : $self->{rbuf});
1116	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;	1290	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;
1117		1291
1118	if ($len > 0) {	1292	if ($len > 0) {
1119	$self->{_activity} = AnyEvent->now;	1293	$self->{_activity} = AnyEvent->now;
1120		1294
1121	$self->{filter_r}	1295	if ($self->{tls}) {
1122	? $self->{filter_r}($self, $rbuf)	1296	Net::SSLeay::BIO_write ($self->{_rbio}, $$rbuf);
1123	: $self->{_in_drain} \|\| $self->_drain_rbuf;	1297
		1298	&_dotls ($self);
		1299	} else {
		1300	$self->_drain_rbuf unless $self->{_in_drain};
		1301	}
1124		1302
1125	} elsif (defined $len) {	1303	} elsif (defined $len) {
1126	delete $self->{_rw};	1304	delete $self->{_rw};
1127	$self->{_eof} = 1;	1305	$self->{_eof} = 1;
1128	$self->_drain_rbuf unless $self->{_in_drain};	1306	$self->_drain_rbuf unless $self->{_in_drain};
…		…
1132	}	1310	}
1133	});	1311	});
1134	}	1312	}
1135	}	1313	}
1136		1314
		1315	# poll the write BIO and send the data if applicable
1137	sub _dotls {	1316	sub _dotls {
1138	my ($self) = @_;	1317	my ($self) = @_;
1139		1318
1140	my $buf;	1319	my $tmp;
1141		1320
1142	if (length $self->{_tls_wbuf}) {	1321	if (length $self->{_tls_wbuf}) {
1143	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1322	while (($tmp = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
1144	substr $self->{_tls_wbuf}, 0, $len, "";	1323	substr $self->{_tls_wbuf}, 0, $tmp, "";
1145	}	1324	}
1146	}	1325	}
1147		1326
1148	if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {
1149	$self->{wbuf} .= $buf;
1150	$self->_drain_wbuf;
1151	}
1152
1153	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {	1327	while (defined ($tmp = Net::SSLeay::read ($self->{tls}))) {
1154	if (length $buf) {	1328	unless (length $tmp) {
1155	$self->{rbuf} .= $buf;
1156	$self->_drain_rbuf unless $self->{_in_drain};
1157	} else {
1158	# let's treat SSL-eof as we treat normal EOF	1329	# let's treat SSL-eof as we treat normal EOF
		1330	delete $self->{_rw};
1159	$self->{_eof} = 1;	1331	$self->{_eof} = 1;
1160	$self->_shutdown;	1332	&_freetls;
1161	return;
1162	}	1333	}
1163	}
1164		1334
		1335	$self->{rbuf} .= $tmp;
		1336	$self->_drain_rbuf unless $self->{_in_drain};
		1337	$self->{tls} or return; # tls session might have gone away in callback
		1338	}
		1339
1165	my $err = Net::SSLeay::get_error ($self->{tls}, -1);	1340	$tmp = Net::SSLeay::get_error ($self->{tls}, -1);
1166		1341
1167	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {	1342	if ($tmp != Net::SSLeay::ERROR_WANT_READ ()) {
1168	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {	1343	if ($tmp == Net::SSLeay::ERROR_SYSCALL ()) {
1169	return $self->_error ($!, 1);	1344	return $self->_error ($!, 1);
1170	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {	1345	} elsif ($tmp == Net::SSLeay::ERROR_SSL ()) {
1171	return $self->_error (&Errno::EIO, 1);	1346	return $self->_error (&Errno::EIO, 1);
1172	}	1347	}
1173		1348
1174	# all others are fine for our purposes	1349	# all other errors are fine for our purposes
		1350	}
		1351
		1352	while (length ($tmp = Net::SSLeay::BIO_read ($self->{_wbio}))) {
		1353	$self->{wbuf} .= $tmp;
		1354	$self->_drain_wbuf;
1175	}	1355	}
1176	}	1356	}
1177		1357
1178	=item $handle->starttls ($tls[, $tls_ctx])	1358	=item $handle->starttls ($tls[, $tls_ctx])
1179		1359
…		…
1189		1369
1190	The TLS connection object will end up in C<< $handle->{tls} >> after this	1370	The TLS connection object will end up in C<< $handle->{tls} >> after this
1191	call and can be used or changed to your liking. Note that the handshake	1371	call and can be used or changed to your liking. Note that the handshake
1192	might have already started when this function returns.	1372	might have already started when this function returns.
1193		1373
		1374	If it an error to start a TLS handshake more than once per
		1375	AnyEvent::Handle object (this is due to bugs in OpenSSL).
		1376
1194	=cut	1377	=cut
1195		1378
1196	sub starttls {	1379	sub starttls {
1197	my ($self, $ssl, $ctx) = @_;	1380	my ($self, $ssl, $ctx) = @_;
1198		1381
1199	$self->stoptls;	1382	require Net::SSLeay;
1200		1383
		1384	Carp::croak "it is an error to call starttls more than once on an Anyevent::Handle object"
		1385	if $self->{tls};
		1386
1201	if ($ssl eq "accept") {	1387	if ($ssl eq "accept") {
1202	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1388	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());
1203	Net::SSLeay::set_accept_state ($ssl);	1389	Net::SSLeay::set_accept_state ($ssl);
1204	} elsif ($ssl eq "connect") {	1390	} elsif ($ssl eq "connect") {
1205	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());	1391	$ssl = Net::SSLeay::new ($ctx \|\| TLS_CTX ());
…		…
1211	# basically, this is deep magic (because SSL_read should have the same issues)	1397	# basically, this is deep magic (because SSL_read should have the same issues)
1212	# but the openssl maintainers basically said: "trust us, it just works".	1398	# but the openssl maintainers basically said: "trust us, it just works".
1213	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1399	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
1214	# and mismaintained ssleay-module doesn't even offer them).	1400	# and mismaintained ssleay-module doesn't even offer them).
1215	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html	1401	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
		1402	#
		1403	# in short: this is a mess.
		1404	#
		1405	# note that we do not try to keep the length constant between writes as we are required to do.
		1406	# we assume that most (but not all) of this insanity only applies to non-blocking cases,
		1407	# and we drive openssl fully in blocking mode here. Or maybe we don't - openssl seems to
		1408	# have identity issues in that area.
1216	Net::SSLeay::CTX_set_mode ($self->{tls},	1409	Net::SSLeay::CTX_set_mode ($self->{tls},
1217	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1410	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
1218	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));	1411	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
1219		1412
1220	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1413	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1221	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1414	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
1222		1415
1223	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});	1416	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
1224		1417
1225	$self->{filter_w} = sub {	1418	&_dotls; # need to trigger the initial handshake
1226	$_[0]{_tls_wbuf} .= ${$_[1]};	1419	$self->start_read; # make sure we actually do read
1227	&_dotls;
1228	};
1229	$self->{filter_r} = sub {
1230	Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});
1231	&_dotls;
1232	};
1233	}	1420	}
1234		1421
1235	=item $handle->stoptls	1422	=item $handle->stoptls
1236		1423
1237	Destroys the SSL connection, if any. Partial read or write data will be	1424	Shuts down the SSL connection - this makes a proper EOF handshake by
1238	lost.	1425	sending a close notify to the other side, but since OpenSSL doesn't
		1426	support non-blocking shut downs, it is not possible to re-use the stream
		1427	afterwards.
1239		1428
1240	=cut	1429	=cut
1241		1430
1242	sub stoptls {	1431	sub stoptls {
1243	my ($self) = @_;	1432	my ($self) = @_;
1244		1433
		1434	if ($self->{tls}) {
		1435	Net::SSLeay::shutdown ($self->{tls});
		1436
		1437	&_dotls;
		1438
		1439	# we don't give a shit. no, we do, but we can't. no...
		1440	# we, we... have to use openssl :/
		1441	&_freetls;
		1442	}
		1443	}
		1444
		1445	sub _freetls {
		1446	my ($self) = @_;
		1447
		1448	return unless $self->{tls};
		1449
1245	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};	1450	Net::SSLeay::free (delete $self->{tls});
1246		1451
1247	delete $self->{_rbio};	1452	delete @$self{qw(_rbio _wbio _tls_wbuf)};
1248	delete $self->{_wbio};
1249	delete $self->{_tls_wbuf};
1250	delete $self->{filter_r};
1251	delete $self->{filter_w};
1252	}	1453	}
1253		1454
1254	sub DESTROY {	1455	sub DESTROY {
1255	my $self = shift;	1456	my $self = shift;
1256		1457
1257	$self->stoptls;	1458	&_freetls;
		1459
		1460	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
		1461
		1462	if ($linger && length $self->{wbuf}) {
		1463	my $fh = delete $self->{fh};
		1464	my $wbuf = delete $self->{wbuf};
		1465
		1466	my @linger;
		1467
		1468	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {
		1469	my $len = syswrite $fh, $wbuf, length $wbuf;
		1470
		1471	if ($len > 0) {
		1472	substr $wbuf, 0, $len, "";
		1473	} else {
		1474	@linger = (); # end
		1475	}
		1476	});
		1477	push @linger, AnyEvent->timer (after => $linger, cb => sub {
		1478	@linger = ();
		1479	});
		1480	}
1258	}	1481	}
1259		1482
1260	=item AnyEvent::Handle::TLS_CTX	1483	=item AnyEvent::Handle::TLS_CTX
1261		1484
1262	This function creates and returns the Net::SSLeay::CTX object used by	1485	This function creates and returns the Net::SSLeay::CTX object used by
…		…
1292	}	1515	}
1293	}	1516	}
1294		1517
1295	=back	1518	=back
1296		1519
		1520
		1521	=head1 NONFREQUENTLY ASKED QUESTIONS
		1522
		1523	=over 4
		1524
		1525	=item How do I read data until the other side closes the connection?
		1526
		1527	If you just want to read your data into a perl scalar, the easiest way
		1528	to achieve this is by setting an C<on_read> callback that does nothing,
		1529	clearing the C<on_eof> callback and in the C<on_error> callback, the data
		1530	will be in C<$_[0]{rbuf}>:
		1531
		1532	$handle->on_read (sub { });
		1533	$handle->on_eof (undef);
		1534	$handle->on_error (sub {
		1535	my $data = delete $_[0]{rbuf};
		1536	undef $handle;
		1537	});
		1538
		1539	The reason to use C<on_error> is that TCP connections, due to latencies
		1540	and packets loss, might get closed quite violently with an error, when in
		1541	fact, all data has been received.
		1542
		1543	It is usually better to use acknowledgements when transfering data,
		1544	to make sure the other side hasn't just died and you got the data
		1545	intact. This is also one reason why so many internet protocols have an
		1546	explicit QUIT command.
		1547
		1548
		1549	=item I don't want to destroy the handle too early - how do I wait until
		1550	all data has been written?
		1551
		1552	After writing your last bits of data, set the C<on_drain> callback
		1553	and destroy the handle in there - with the default setting of
		1554	C<low_water_mark> this will be called precisely when all data has been
		1555	written to the socket:
		1556
		1557	$handle->push_write (...);
		1558	$handle->on_drain (sub {
		1559	warn "all data submitted to the kernel\n";
		1560	undef $handle;
		1561	});
		1562
		1563	=back
		1564
		1565
1297	=head1 SUBCLASSING AnyEvent::Handle	1566	=head1 SUBCLASSING AnyEvent::Handle
1298		1567
1299	In many cases, you might want to subclass AnyEvent::Handle.	1568	In many cases, you might want to subclass AnyEvent::Handle.
1300		1569
1301	To make this easier, a given version of AnyEvent::Handle uses these	1570	To make this easier, a given version of AnyEvent::Handle uses these
…		…
1304	=over 4	1573	=over 4
1305		1574
1306	=item * all constructor arguments become object members.	1575	=item * all constructor arguments become object members.
1307		1576
1308	At least initially, when you pass a C<tls>-argument to the constructor it	1577	At least initially, when you pass a C<tls>-argument to the constructor it
1309	will end up in C<< $handle->{tls} >>. Those members might be changes or	1578	will end up in C<< $handle->{tls} >>. Those members might be changed or
1310	mutated later on (for example C<tls> will hold the TLS connection object).	1579	mutated later on (for example C<tls> will hold the TLS connection object).
1311		1580
1312	=item * other object member names are prefixed with an C<_>.	1581	=item * other object member names are prefixed with an C<_>.
1313		1582
1314	All object members not explicitly documented (internal use) are prefixed	1583	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.61 by root, Fri Jun 6 10:23:50 2008 UTC vs. Revision 1.97 by root, Thu Oct 2 11:07:59 2008 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.61 by root, Fri Jun 6 10:23:50 2008 UTC vs.
Revision 1.97 by root, Thu Oct 2 11:07:59 2008 UTC