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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.40 by root, Tue May 27 05:36:27 2008 UTC vs.
Revision 1.79 by root, Sun Jul 27 08:37:56 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(WSAWOULDBLOCK);	7	use AnyEvent::Util qw(WSAEWOULDBLOCK);
8	use Scalar::Util ();	8	use Scalar::Util ();
9	use Carp ();	9	use Carp ();
10	use Fcntl ();	10	use Fcntl ();
11	use Errno qw/EAGAIN EINTR/;	11	use Errno qw(EAGAIN EINTR);
12		12
13	=head1 NAME	13	=head1 NAME
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 = '0.04';	19	our $VERSION = 4.22;
20		20
21	=head1 SYNOPSIS	21	=head1 SYNOPSIS
22		22
23	use AnyEvent;	23	use AnyEvent;
24	use AnyEvent::Handle;	24	use AnyEvent::Handle;
75	NOTE: The filehandle will be set to non-blocking (using	75	NOTE: The filehandle will be set to non-blocking (using
76	AnyEvent::Util::fh_nonblocking).	76	AnyEvent::Util::fh_nonblocking).
77		77
78	=item on_eof => $cb->($handle)	78	=item on_eof => $cb->($handle)
79		79
80	Set the callback to be called on EOF.	80	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
		82	connection cleanly.
81		83
82	While not mandatory, it is highly recommended to set an eof callback,	84	While not mandatory, it is highly recommended to set an eof callback,
83	otherwise you might end up with a closed socket while you are still	85	otherwise you might end up with a closed socket while you are still
84	waiting for data.	86	waiting for data.
85		87
86	=item on_error => $cb->($handle)	88	=item on_error => $cb->($handle, $fatal)
87		89
88	This is the fatal error callback, that is called when, well, a fatal error	90	This is the error callback, which is called when, well, some error
89	occurs, such as not being able to resolve the hostname, failure to connect	91	occured, such as not being able to resolve the hostname, failure to
90	or a read error.	92	connect or a read error.
91		93
92	The object will not be in a usable state when this callback has been	94	Some errors are fatal (which is indicated by C<$fatal> being true). On
93	called.	95	fatal errors the handle object will be shut down and will not be
		96	usable. Non-fatal errors can be retried by simply returning, but it is
		97	recommended to simply ignore this parameter and instead abondon the handle
		98	object when this callback is invoked.
94		99
95	On callback entrance, the value of C<$!> contains the operating system	100	On callback entrance, the value of C<$!> contains the operating system
96	error (or C<ENOSPC>, C<EPIPE> or C<EBADMSG>).	101	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).
97
98	The callback should throw an exception. If it returns, then
99	AnyEvent::Handle will C<croak> for you.
100		102
101	While not mandatory, it is I<highly> recommended to set this callback, as	103	While not mandatory, it is I<highly> recommended to set this callback, as
102	you will not be notified of errors otherwise. The default simply calls	104	you will not be notified of errors otherwise. The default simply calls
103	die.	105	C<croak>.
104		106
105	=item on_read => $cb->($handle)	107	=item on_read => $cb->($handle)
106		108
107	This sets the default read callback, which is called when data arrives	109	This sets the default read callback, which is called when data arrives
108	and no read request is in the queue.	110	and no read request is in the queue (unlike read queue callbacks, this
		111	callback will only be called when at least one octet of data is in the
		112	read buffer).
109		113
110	To access (and remove data from) the read buffer, use the C<< ->rbuf >>	114	To access (and remove data from) the read buffer, use the C<< ->rbuf >>
111	method or access the C<$handle->{rbuf}> member directly.	115	method or access the C<$handle->{rbuf}> member directly.
112		116
113	When an EOF condition is detected then AnyEvent::Handle will first try to	117	When an EOF condition is detected then AnyEvent::Handle will first try to
…		…
119		123
120	This sets the callback that is called when the write buffer becomes empty	124	This sets the callback that is called when the write buffer becomes empty
121	(or when the callback is set and the buffer is empty already).	125	(or when the callback is set and the buffer is empty already).
122		126
123	To append to the write buffer, use the C<< ->push_write >> method.	127	To append to the write buffer, use the C<< ->push_write >> method.
		128
		129	This callback is useful when you don't want to put all of your write data
		130	into the queue at once, for example, when you want to write the contents
		131	of some file to the socket you might not want to read the whole file into
		132	memory and push it into the queue, but instead only read more data from
		133	the file when the write queue becomes empty.
		134
		135	=item timeout => $fractional_seconds
		136
		137	If non-zero, then this enables an "inactivity" timeout: whenever this many
		138	seconds pass without a successful read or write on the underlying file
		139	handle, the C<on_timeout> callback will be invoked (and if that one is
		140	missing, an C<ETIMEDOUT> error will be raised).
		141
		142	Note that timeout processing is also active when you currently do not have
		143	any outstanding read or write requests: If you plan to keep the connection
		144	idle then you should disable the timout temporarily or ignore the timeout
		145	in the C<on_timeout> callback.
		146
		147	Zero (the default) disables this timeout.
		148
		149	=item on_timeout => $cb->($handle)
		150
		151	Called whenever the inactivity timeout passes. If you return from this
		152	callback, then the timeout will be reset as if some activity had happened,
		153	so this condition is not fatal in any way.
124		154
125	=item rbuf_max => <bytes>	155	=item rbuf_max => <bytes>
126		156
127	If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)	157	If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)
128	when the read buffer ever (strictly) exceeds this size. This is useful to	158	when the read buffer ever (strictly) exceeds this size. This is useful to
…		…
132	be configured to accept only so-and-so much data that it cannot act on	162	be configured to accept only so-and-so much data that it cannot act on
133	(for example, when expecting a line, an attacker could send an unlimited	163	(for example, when expecting a line, an attacker could send an unlimited
134	amount of data without a callback ever being called as long as the line	164	amount of data without a callback ever being called as long as the line
135	isn't finished).	165	isn't finished).
136		166
		167	=item autocork => <boolean>
		168
		169	When disabled (the default), then C<push_write> will try to immediately
		170	write the data to the handle if possible. This avoids having to register
		171	a write watcher and wait for the next event loop iteration, but can be
		172	inefficient if you write multiple small chunks (this disadvantage is
		173	usually avoided by your kernel's nagle algorithm, see C<low_delay>).
		174
		175	When enabled, then writes will always be queued till the next event loop
		176	iteration. This is efficient when you do many small writes per iteration,
		177	but less efficient when you do a single write only.
		178
		179	=item no_delay => <boolean>
		180
		181	When doing small writes on sockets, your operating system kernel might
		182	wait a bit for more data before actually sending it out. This is called
		183	the Nagle algorithm, and usually it is beneficial.
		184
		185	In some situations you want as low a delay as possible, which cna be
		186	accomplishd by setting this option to true.
		187
		188	The default is your opertaing system's default behaviour, this option
		189	explicitly enables or disables it, if possible.
		190
137	=item read_size => <bytes>	191	=item read_size => <bytes>
138		192
139	The default read block size (the amount of bytes this module will try to read	193	The default read block size (the amount of bytes this module will try to read
140	on each [loop iteration). Default: C<4096>.	194	during each (loop iteration). Default: C<8192>.
141		195
142	=item low_water_mark => <bytes>	196	=item low_water_mark => <bytes>
143		197
144	Sets the amount of bytes (default: C<0>) that make up an "empty" write	198	Sets the amount of bytes (default: C<0>) that make up an "empty" write
145	buffer: If the write reaches this size or gets even samller it is	199	buffer: If the write reaches this size or gets even samller it is
146	considered empty.	200	considered empty.
		201
		202	=item linger => <seconds>
		203
		204	If non-zero (default: C<3600>), then the destructor of the
		205	AnyEvent::Handle object will check wether there is still outstanding write
		206	data and will install a watcher that will write out this data. No errors
		207	will be reported (this mostly matches how the operating system treats
		208	outstanding data at socket close time).
		209
		210	This will not work for partial TLS data that could not yet been
		211	encoded. This data will be lost.
147		212
148	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	213	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
149		214
150	When this parameter is given, it enables TLS (SSL) mode, that means it	215	When this parameter is given, it enables TLS (SSL) mode, that means it
151	will start making tls handshake and will transparently encrypt/decrypt	216	will start making tls handshake and will transparently encrypt/decrypt
…		…
160	You can also provide your own TLS connection object, but you have	225	You can also provide your own TLS connection object, but you have
161	to make sure that you call either C<Net::SSLeay::set_connect_state>	226	to make sure that you call either C<Net::SSLeay::set_connect_state>
162	or C<Net::SSLeay::set_accept_state> on it before you pass it to	227	or C<Net::SSLeay::set_accept_state> on it before you pass it to
163	AnyEvent::Handle.	228	AnyEvent::Handle.
164		229
165	See the C<starttls> method if you need to start TLs negotiation later.	230	See the C<starttls> method if you need to start TLS negotiation later.
166		231
167	=item tls_ctx => $ssl_ctx	232	=item tls_ctx => $ssl_ctx
168		233
169	Use the given Net::SSLeay::CTX object to create the new TLS connection	234	Use the given Net::SSLeay::CTX object to create the new TLS connection
170	(unless a connection object was specified directly). If this parameter is	235	(unless a connection object was specified directly). If this parameter is
…		…
172		237
173	=item json => JSON or JSON::XS object	238	=item json => JSON or JSON::XS object
174		239
175	This is the json coder object used by the C<json> read and write types.	240	This is the json coder object used by the C<json> read and write types.
176		241
177	If you don't supply it, then AnyEvent::Handle will use C<encode_json> and	242	If you don't supply it, then AnyEvent::Handle will create and use a
178	C<decode_json>.	243	suitable one, which will write and expect UTF-8 encoded JSON texts.
179		244
180	Note that you are responsible to depend on the JSON module if you want to	245	Note that you are responsible to depend on the JSON module if you want to
181	use this functionality, as AnyEvent does not have a dependency itself.	246	use this functionality, as AnyEvent does not have a dependency itself.
182		247
183	=item filter_r => $cb	248	=item filter_r => $cb
…		…
202	if ($self->{tls}) {	267	if ($self->{tls}) {
203	require Net::SSLeay;	268	require Net::SSLeay;
204	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});	269	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});
205	}	270	}
206		271
207	$self->on_eof (delete $self->{on_eof} ) if $self->{on_eof};	272	$self->{_activity} = AnyEvent->now;
208	$self->on_error (delete $self->{on_error}) if $self->{on_error};	273	$self->_timeout;
		274
209	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	275	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};
210	$self->on_read (delete $self->{on_read} ) if $self->{on_read};	276	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
211		277
212	$self->start_read;	278	$self->start_read
		279	if $self->{on_read};
213		280
214	$self	281	$self
215	}	282	}
216		283
217	sub _shutdown {	284	sub _shutdown {
218	my ($self) = @_;	285	my ($self) = @_;
219		286
		287	delete $self->{_tw};
220	delete $self->{_rw};	288	delete $self->{_rw};
221	delete $self->{_ww};	289	delete $self->{_ww};
222	delete $self->{fh};	290	delete $self->{fh};
223	}
224		291
		292	$self->stoptls;
		293	}
		294
225	sub error {	295	sub _error {
226	my ($self) = @_;	296	my ($self, $errno, $fatal) = @_;
227		297
228	{
229	local $!;
230	$self->_shutdown;	298	$self->_shutdown
231	}	299	if $fatal;
232		300
233	$self->{on_error}($self)	301	$! = $errno;
		302
234	if $self->{on_error};	303	if ($self->{on_error}) {
235		304	$self->{on_error}($self, $fatal);
		305	} else {
236	Carp::croak "AnyEvent::Handle uncaught fatal error: $!";	306	Carp::croak "AnyEvent::Handle uncaught error: $!";
		307	}
237	}	308	}
238		309
239	=item $fh = $handle->fh	310	=item $fh = $handle->fh
240		311
241	This method returns the file handle of the L<AnyEvent::Handle> object.	312	This method returns the file handle of the L<AnyEvent::Handle> object.
…		…
260		331
261	=cut	332	=cut
262		333
263	sub on_eof {	334	sub on_eof {
264	$_[0]{on_eof} = $_[1];	335	$_[0]{on_eof} = $_[1];
		336	}
		337
		338	=item $handle->on_timeout ($cb)
		339
		340	Replace the current C<on_timeout> callback, or disables the callback
		341	(but not the timeout) if C<$cb> = C<undef>. See C<timeout> constructor
		342	argument.
		343
		344	=cut
		345
		346	sub on_timeout {
		347	$_[0]{on_timeout} = $_[1];
		348	}
		349
		350	=item $handle->autocork ($boolean)
		351
		352	Enables or disables the current autocork behaviour (see C<autocork>
		353	constructor argument).
		354
		355	=cut
		356
		357	=item $handle->no_delay ($boolean)
		358
		359	Enables or disables the C<no_delay> setting (see constructor argument of
		360	the same name for details).
		361
		362	=cut
		363
		364	sub no_delay {
		365	$_[0]{no_delay} = $_[1];
		366
		367	eval {
		368	local $SIG{__DIE__};
		369	setsockopt $_[0]{fh}, &Socket::IPPROTO_TCP, &Socket::TCP_NODELAY, int $_[1];
		370	};
		371	}
		372
		373	#############################################################################
		374
		375	=item $handle->timeout ($seconds)
		376
		377	Configures (or disables) the inactivity timeout.
		378
		379	=cut
		380
		381	sub timeout {
		382	my ($self, $timeout) = @_;
		383
		384	$self->{timeout} = $timeout;
		385	$self->_timeout;
		386	}
		387
		388	# reset the timeout watcher, as neccessary
		389	# also check for time-outs
		390	sub _timeout {
		391	my ($self) = @_;
		392
		393	if ($self->{timeout}) {
		394	my $NOW = AnyEvent->now;
		395
		396	# when would the timeout trigger?
		397	my $after = $self->{_activity} + $self->{timeout} - $NOW;
		398
		399	# now or in the past already?
		400	if ($after <= 0) {
		401	$self->{_activity} = $NOW;
		402
		403	if ($self->{on_timeout}) {
		404	$self->{on_timeout}($self);
		405	} else {
		406	$self->_error (&Errno::ETIMEDOUT);
		407	}
		408
		409	# callback could have changed timeout value, optimise
		410	return unless $self->{timeout};
		411
		412	# calculate new after
		413	$after = $self->{timeout};
		414	}
		415
		416	Scalar::Util::weaken $self;
		417	return unless $self; # ->error could have destroyed $self
		418
		419	$self->{_tw} \|\|= AnyEvent->timer (after => $after, cb => sub {
		420	delete $self->{_tw};
		421	$self->_timeout;
		422	});
		423	} else {
		424	delete $self->{_tw};
		425	}
265	}	426	}
266		427
267	#############################################################################	428	#############################################################################
268		429
269	=back	430	=back
…		…
316	my $len = syswrite $self->{fh}, $self->{wbuf};	477	my $len = syswrite $self->{fh}, $self->{wbuf};
317		478
318	if ($len >= 0) {	479	if ($len >= 0) {
319	substr $self->{wbuf}, 0, $len, "";	480	substr $self->{wbuf}, 0, $len, "";
320		481
		482	$self->{_activity} = AnyEvent->now;
		483
321	$self->{on_drain}($self)	484	$self->{on_drain}($self)
322	if $self->{low_water_mark} >= length $self->{wbuf}	485	if $self->{low_water_mark} >= length $self->{wbuf}
323	&& $self->{on_drain};	486	&& $self->{on_drain};
324		487
325	delete $self->{_ww} unless length $self->{wbuf};	488	delete $self->{_ww} unless length $self->{wbuf};
326	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAWOULDBLOCK) {	489	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
327	$self->error;	490	$self->_error ($!, 1);
328	}	491	}
329	};	492	};
330		493
331	# try to write data immediately	494	# try to write data immediately
332	$cb->();	495	$cb->() unless $self->{autocork};
333		496
334	# if still data left in wbuf, we need to poll	497	# if still data left in wbuf, we need to poll
335	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	498	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)
336	if length $self->{wbuf};	499	if length $self->{wbuf};
337	};	500	};
…		…
352	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	515	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")
353	->($self, @_);	516	->($self, @_);
354	}	517	}
355		518
356	if ($self->{filter_w}) {	519	if ($self->{filter_w}) {
357	$self->{filter_w}->($self, \$_[0]);	520	$self->{filter_w}($self, \$_[0]);
358	} else {	521	} else {
359	$self->{wbuf} .= $_[0];	522	$self->{wbuf} .= $_[0];
360	$self->_drain_wbuf;	523	$self->_drain_wbuf;
361	}	524	}
362	}	525	}
363		526
364	=item $handle->push_write (type => @args)	527	=item $handle->push_write (type => @args)
365		528
366	=item $handle->unshift_write (type => @args)
367
368	Instead of formatting your data yourself, you can also let this module do	529	Instead of formatting your data yourself, you can also let this module do
369	the job by specifying a type and type-specific arguments.	530	the job by specifying a type and type-specific arguments.
370		531
371	Predefined types are (if you have ideas for additional types, feel free to	532	Predefined types are (if you have ideas for additional types, feel free to
372	drop by and tell us):	533	drop by and tell us):
…		…
376	=item netstring => $string	537	=item netstring => $string
377		538
378	Formats the given value as netstring	539	Formats the given value as netstring
379	(http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them).	540	(http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them).
380		541
381	=back
382
383	=cut	542	=cut
384		543
385	register_write_type netstring => sub {	544	register_write_type netstring => sub {
386	my ($self, $string) = @_;	545	my ($self, $string) = @_;
387		546
388	sprintf "%d:%s,", (length $string), $string	547	sprintf "%d:%s,", (length $string), $string
		548	};
		549
		550	=item packstring => $format, $data
		551
		552	An octet string prefixed with an encoded length. The encoding C<$format>
		553	uses the same format as a Perl C<pack> format, but must specify a single
		554	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
		555	optional C<!>, C<< < >> or C<< > >> modifier).
		556
		557	=cut
		558
		559	register_write_type packstring => sub {
		560	my ($self, $format, $string) = @_;
		561
		562	pack "$format/a*", $string
389	};	563	};
390		564
391	=item json => $array_or_hashref	565	=item json => $array_or_hashref
392		566
393	Encodes the given hash or array reference into a JSON object. Unless you	567	Encodes the given hash or array reference into a JSON object. Unless you
…		…
396		570
397	JSON objects (and arrays) are self-delimiting, so you can write JSON at	571	JSON objects (and arrays) are self-delimiting, so you can write JSON at
398	one end of a handle and read them at the other end without using any	572	one end of a handle and read them at the other end without using any
399	additional framing.	573	additional framing.
400		574
		575	The generated JSON text is guaranteed not to contain any newlines: While
		576	this module doesn't need delimiters after or between JSON texts to be
		577	able to read them, many other languages depend on that.
		578
		579	A simple RPC protocol that interoperates easily with others is to send
		580	JSON arrays (or objects, although arrays are usually the better choice as
		581	they mimic how function argument passing works) and a newline after each
		582	JSON text:
		583
		584	$handle->push_write (json => ["method", "arg1", "arg2"]); # whatever
		585	$handle->push_write ("\012");
		586
		587	An AnyEvent::Handle receiver would simply use the C<json> read type and
		588	rely on the fact that the newline will be skipped as leading whitespace:
		589
		590	$handle->push_read (json => sub { my $array = $_[1]; ... });
		591
		592	Other languages could read single lines terminated by a newline and pass
		593	this line into their JSON decoder of choice.
		594
401	=cut	595	=cut
402		596
403	register_write_type json => sub {	597	register_write_type json => sub {
404	my ($self, $ref) = @_;	598	my ($self, $ref) = @_;
405		599
…		…
407		601
408	$self->{json} ? $self->{json}->encode ($ref)	602	$self->{json} ? $self->{json}->encode ($ref)
409	: JSON::encode_json ($ref)	603	: JSON::encode_json ($ref)
410	};	604	};
411		605
		606	=item storable => $reference
		607
		608	Freezes the given reference using L<Storable> and writes it to the
		609	handle. Uses the C<nfreeze> format.
		610
		611	=cut
		612
		613	register_write_type storable => sub {
		614	my ($self, $ref) = @_;
		615
		616	require Storable;
		617
		618	pack "w/a*", Storable::nfreeze ($ref)
		619	};
		620
		621	=back
		622
412	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)	623	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
413		624
414	This function (not method) lets you add your own types to C<push_write>.	625	This function (not method) lets you add your own types to C<push_write>.
415	Whenever the given C<type> is used, C<push_write> will invoke the code	626	Whenever the given C<type> is used, C<push_write> will invoke the code
416	reference with the handle object and the remaining arguments.	627	reference with the handle object and the remaining arguments.
…		…
436	ways, the "simple" way, using only C<on_read> and the "complex" way, using	647	ways, the "simple" way, using only C<on_read> and the "complex" way, using
437	a queue.	648	a queue.
438		649
439	In the simple case, you just install an C<on_read> callback and whenever	650	In the simple case, you just install an C<on_read> callback and whenever
440	new data arrives, it will be called. You can then remove some data (if	651	new data arrives, it will be called. You can then remove some data (if
441	enough is there) from the read buffer (C<< $handle->rbuf >>) if you want	652	enough is there) from the read buffer (C<< $handle->rbuf >>). Or you cna
442	or not.	653	leave the data there if you want to accumulate more (e.g. when only a
		654	partial message has been received so far).
443		655
444	In the more complex case, you want to queue multiple callbacks. In this	656	In the more complex case, you want to queue multiple callbacks. In this
445	case, AnyEvent::Handle will call the first queued callback each time new	657	case, AnyEvent::Handle will call the first queued callback each time new
446	data arrives and removes it when it has done its job (see C<push_read>,	658	data arrives (also the first time it is queued) and removes it when it has
447	below).	659	done its job (see C<push_read>, below).
448		660
449	This way you can, for example, push three line-reads, followed by reading	661	This way you can, for example, push three line-reads, followed by reading
450	a chunk of data, and AnyEvent::Handle will execute them in order.	662	a chunk of data, and AnyEvent::Handle will execute them in order.
451		663
452	Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by	664	Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by
453	the specified number of bytes which give an XML datagram.	665	the specified number of bytes which give an XML datagram.
454		666
455	# in the default state, expect some header bytes	667	# in the default state, expect some header bytes
456	$handle->on_read (sub {	668	$handle->on_read (sub {
457	# some data is here, now queue the length-header-read (4 octets)	669	# some data is here, now queue the length-header-read (4 octets)
458	shift->unshift_read_chunk (4, sub {	670	shift->unshift_read (chunk => 4, sub {
459	# header arrived, decode	671	# header arrived, decode
460	my $len = unpack "N", $_[1];	672	my $len = unpack "N", $_[1];
461		673
462	# now read the payload	674	# now read the payload
463	shift->unshift_read_chunk ($len, sub {	675	shift->unshift_read (chunk => $len, sub {
464	my $xml = $_[1];	676	my $xml = $_[1];
465	# handle xml	677	# handle xml
466	});	678	});
467	});	679	});
468	});	680	});
469		681
470	Example 2: Implement a client for a protocol that replies either with	682	Example 2: Implement a client for a protocol that replies either with "OK"
471	"OK" and another line or "ERROR" for one request, and 64 bytes for the	683	and another line or "ERROR" for the first request that is sent, and 64
472	second request. Due tot he availability of a full queue, we can just	684	bytes for the second request. Due to the availability of a queue, we can
473	pipeline sending both requests and manipulate the queue as necessary in	685	just pipeline sending both requests and manipulate the queue as necessary
474	the callbacks:	686	in the callbacks.
475		687
476	# request one	688	When the first callback is called and sees an "OK" response, it will
		689	C<unshift> another line-read. This line-read will be queued I<before> the
		690	64-byte chunk callback.
		691
		692	# request one, returns either "OK + extra line" or "ERROR"
477	$handle->push_write ("request 1\015\012");	693	$handle->push_write ("request 1\015\012");
478		694
479	# we expect "ERROR" or "OK" as response, so push a line read	695	# we expect "ERROR" or "OK" as response, so push a line read
480	$handle->push_read_line (sub {	696	$handle->push_read (line => sub {
481	# if we got an "OK", we have to _prepend_ another line,	697	# if we got an "OK", we have to _prepend_ another line,
482	# so it will be read before the second request reads its 64 bytes	698	# so it will be read before the second request reads its 64 bytes
483	# which are already in the queue when this callback is called	699	# which are already in the queue when this callback is called
484	# we don't do this in case we got an error	700	# we don't do this in case we got an error
485	if ($_[1] eq "OK") {	701	if ($_[1] eq "OK") {
486	$_[0]->unshift_read_line (sub {	702	$_[0]->unshift_read (line => sub {
487	my $response = $_[1];	703	my $response = $_[1];
488	...	704	...
489	});	705	});
490	}	706	}
491	});	707	});
492		708
493	# request two	709	# request two, simply returns 64 octets
494	$handle->push_write ("request 2\015\012");	710	$handle->push_write ("request 2\015\012");
495		711
496	# simply read 64 bytes, always	712	# simply read 64 bytes, always
497	$handle->push_read_chunk (64, sub {	713	$handle->push_read (chunk => 64, sub {
498	my $response = $_[1];	714	my $response = $_[1];
499	...	715	...
500	});	716	});
501		717
502	=over 4	718	=over 4
503		719
504	=cut	720	=cut
505		721
506	sub _drain_rbuf {	722	sub _drain_rbuf {
507	my ($self) = @_;	723	my ($self) = @_;
		724
		725	local $self->{_in_drain} = 1;
508		726
509	if (	727	if (
510	defined $self->{rbuf_max}	728	defined $self->{rbuf_max}
511	&& $self->{rbuf_max} < length $self->{rbuf}	729	&& $self->{rbuf_max} < length $self->{rbuf}
512	) {	730	) {
513	$! = &Errno::ENOSPC;	731	return $self->_error (&Errno::ENOSPC, 1);
514	$self->error;
515	}	732	}
516		733
517	return if $self->{in_drain};	734	while () {
518	local $self->{in_drain} = 1;
519
520	while (my $len = length $self->{rbuf}) {	735	my $len = length $self->{rbuf};
521	no strict 'refs';	736
522	if (my $cb = shift @{ $self->{_queue} }) {	737	if (my $cb = shift @{ $self->{_queue} }) {
523	unless ($cb->($self)) {	738	unless ($cb->($self)) {
524	if ($self->{_eof}) {	739	if ($self->{_eof}) {
525	# no progress can be made (not enough data and no data forthcoming)	740	# no progress can be made (not enough data and no data forthcoming)
526	$! = &Errno::EPIPE;	741	$self->_error (&Errno::EPIPE, 1), last;
527	$self->error;
528	}	742	}
529		743
530	unshift @{ $self->{_queue} }, $cb;	744	unshift @{ $self->{_queue} }, $cb;
531	return;	745	last;
532	}	746	}
533	} elsif ($self->{on_read}) {	747	} elsif ($self->{on_read}) {
		748	last unless $len;
		749
534	$self->{on_read}($self);	750	$self->{on_read}($self);
535		751
536	if (	752	if (
537	$self->{_eof} # if no further data will arrive
538	&& $len == length $self->{rbuf} # and no data has been consumed	753	$len == length $self->{rbuf} # if no data has been consumed
539	&& !@{ $self->{_queue} } # and the queue is still empty	754	&& !@{ $self->{_queue} } # and the queue is still empty
540	&& $self->{on_read} # and we still want to read data	755	&& $self->{on_read} # but we still have on_read
541	) {	756	) {
		757	# no further data will arrive
542	# then no progress can be made	758	# so no progress can be made
543	$! = &Errno::EPIPE;	759	$self->_error (&Errno::EPIPE, 1), last
544	$self->error;	760	if $self->{_eof};
		761
		762	last; # more data might arrive
545	}	763	}
546	} else {	764	} else {
547	# read side becomes idle	765	# read side becomes idle
548	delete $self->{_rw};	766	delete $self->{_rw};
549	return;	767	last;
550	}	768	}
551	}	769	}
552		770
553	if ($self->{_eof}) {
554	$self->_shutdown;
555	$self->{on_eof}($self)	771	$self->{on_eof}($self)
556	if $self->{on_eof};	772	if $self->{_eof} && $self->{on_eof};
		773
		774	# may need to restart read watcher
		775	unless ($self->{_rw}) {
		776	$self->start_read
		777	if $self->{on_read} \|\| @{ $self->{_queue} };
557	}	778	}
558	}	779	}
559		780
560	=item $handle->on_read ($cb)	781	=item $handle->on_read ($cb)
561		782
…		…
567		788
568	sub on_read {	789	sub on_read {
569	my ($self, $cb) = @_;	790	my ($self, $cb) = @_;
570		791
571	$self->{on_read} = $cb;	792	$self->{on_read} = $cb;
		793	$self->_drain_rbuf if $cb && !$self->{_in_drain};
572	}	794	}
573		795
574	=item $handle->rbuf	796	=item $handle->rbuf
575		797
576	Returns the read buffer (as a modifiable lvalue).	798	Returns the read buffer (as a modifiable lvalue).
…		…
625	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	847	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
626	->($self, $cb, @_);	848	->($self, $cb, @_);
627	}	849	}
628		850
629	push @{ $self->{_queue} }, $cb;	851	push @{ $self->{_queue} }, $cb;
630	$self->_drain_rbuf;	852	$self->_drain_rbuf unless $self->{_in_drain};
631	}	853	}
632		854
633	sub unshift_read {	855	sub unshift_read {
634	my $self = shift;	856	my $self = shift;
635	my $cb = pop;	857	my $cb = pop;
…		…
641	->($self, $cb, @_);	863	->($self, $cb, @_);
642	}	864	}
643		865
644		866
645	unshift @{ $self->{_queue} }, $cb;	867	unshift @{ $self->{_queue} }, $cb;
646	$self->_drain_rbuf;	868	$self->_drain_rbuf unless $self->{_in_drain};
647	}	869	}
648		870
649	=item $handle->push_read (type => @args, $cb)	871	=item $handle->push_read (type => @args, $cb)
650		872
651	=item $handle->unshift_read (type => @args, $cb)	873	=item $handle->unshift_read (type => @args, $cb)
…		…
681	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");	903	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");
682	1	904	1
683	}	905	}
684	};	906	};
685		907
686	# compatibility with older API
687	sub push_read_chunk {
688	$_[0]->push_read (chunk => $_[1], $_[2]);
689	}
690
691	sub unshift_read_chunk {
692	$_[0]->unshift_read (chunk => $_[1], $_[2]);
693	}
694
695	=item line => [$eol, ]$cb->($handle, $line, $eol)	908	=item line => [$eol, ]$cb->($handle, $line, $eol)
696		909
697	The callback will be called only once a full line (including the end of	910	The callback will be called only once a full line (including the end of
698	line marker, C<$eol>) has been read. This line (excluding the end of line	911	line marker, C<$eol>) has been read. This line (excluding the end of line
699	marker) will be passed to the callback as second argument (C<$line>), and	912	marker) will be passed to the callback as second argument (C<$line>), and
…		…
714	=cut	927	=cut
715		928
716	register_read_type line => sub {	929	register_read_type line => sub {
717	my ($self, $cb, $eol) = @_;	930	my ($self, $cb, $eol) = @_;
718		931
719	$eol = qr\|(\015?\012)\| if @_ < 3;	932	if (@_ < 3) {
720	$eol = quotemeta $eol unless ref $eol;	933	# this is more than twice as fast as the generic code below
721	$eol = qr\|^(.*?)($eol)\|s;
722
723	sub {	934	sub {
724	$_[0]{rbuf} =~ s/$eol// or return;	935	$_[0]{rbuf} =~ s/^([^\015\012]*)(\015?\012)// or return;
725		936
726	$cb->($_[0], $1, $2);	937	$cb->($_[0], $1, $2);
727	1
728	}
729	};
730
731	# compatibility with older API
732	sub push_read_line {
733	my $self = shift;
734	$self->push_read (line => @_);
735	}
736
737	sub unshift_read_line {
738	my $self = shift;
739	$self->unshift_read (line => @_);
740	}
741
742	=item netstring => $cb->($handle, $string)
743
744	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
745
746	Throws an error with C<$!> set to EBADMSG on format violations.
747
748	=cut
749
750	register_read_type netstring => sub {
751	my ($self, $cb) = @_;
752
753	sub {
754	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
755	if ($_[0]{rbuf} =~ /[^0-9]/) {
756	$! = &Errno::EBADMSG;
757	$self->error;
758	}	938	1
759	return;
760	}	939	}
		940	} else {
		941	$eol = quotemeta $eol unless ref $eol;
		942	$eol = qr\|^(.*?)($eol)\|s;
761		943
762	my $len = $1;	944	sub {
		945	$_[0]{rbuf} =~ s/$eol// or return;
763		946
764	$self->unshift_read (chunk => $len, sub {	947	$cb->($_[0], $1, $2);
765	my $string = $_[1];
766	$_[0]->unshift_read (chunk => 1, sub {
767	if ($_[1] eq ",") {
768	$cb->($_[0], $string);
769	} else {
770	$! = &Errno::EBADMSG;
771	$self->error;
772	}
773	});	948	1
774	});	949	}
775
776	1
777	}	950	}
778	};	951	};
779		952
780	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)	953	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
781		954
…		…
833	return 1;	1006	return 1;
834	}	1007	}
835		1008
836	# reject	1009	# reject
837	if ($reject && $$rbuf =~ $reject) {	1010	if ($reject && $$rbuf =~ $reject) {
838	$! = &Errno::EBADMSG;	1011	$self->_error (&Errno::EBADMSG);
839	$self->error;
840	}	1012	}
841		1013
842	# skip	1014	# skip
843	if ($skip && $$rbuf =~ $skip) {	1015	if ($skip && $$rbuf =~ $skip) {
844	$data .= substr $$rbuf, 0, $+[0], "";	1016	$data .= substr $$rbuf, 0, $+[0], "";
…		…
846		1018
847	()	1019	()
848	}	1020	}
849	};	1021	};
850		1022
		1023	=item netstring => $cb->($handle, $string)
		1024
		1025	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
		1026
		1027	Throws an error with C<$!> set to EBADMSG on format violations.
		1028
		1029	=cut
		1030
		1031	register_read_type netstring => sub {
		1032	my ($self, $cb) = @_;
		1033
		1034	sub {
		1035	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
		1036	if ($_[0]{rbuf} =~ /[^0-9]/) {
		1037	$self->_error (&Errno::EBADMSG);
		1038	}
		1039	return;
		1040	}
		1041
		1042	my $len = $1;
		1043
		1044	$self->unshift_read (chunk => $len, sub {
		1045	my $string = $_[1];
		1046	$_[0]->unshift_read (chunk => 1, sub {
		1047	if ($_[1] eq ",") {
		1048	$cb->($_[0], $string);
		1049	} else {
		1050	$self->_error (&Errno::EBADMSG);
		1051	}
		1052	});
		1053	});
		1054
		1055	1
		1056	}
		1057	};
		1058
		1059	=item packstring => $format, $cb->($handle, $string)
		1060
		1061	An octet string prefixed with an encoded length. The encoding C<$format>
		1062	uses the same format as a Perl C<pack> format, but must specify a single
		1063	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
		1064	optional C<!>, C<< < >> or C<< > >> modifier).
		1065
		1066	DNS over TCP uses a prefix of C<n>, EPP uses a prefix of C<N>.
		1067
		1068	Example: read a block of data prefixed by its length in BER-encoded
		1069	format (very efficient).
		1070
		1071	$handle->push_read (packstring => "w", sub {
		1072	my ($handle, $data) = @_;
		1073	});
		1074
		1075	=cut
		1076
		1077	register_read_type packstring => sub {
		1078	my ($self, $cb, $format) = @_;
		1079
		1080	sub {
		1081	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
		1082	defined (my $len = eval { unpack $format, $_[0]{rbuf} })
		1083	or return;
		1084
		1085	$format = length pack $format, $len;
		1086
		1087	# bypass unshift if we already have the remaining chunk
		1088	if ($format + $len <= length $_[0]{rbuf}) {
		1089	my $data = substr $_[0]{rbuf}, $format, $len;
		1090	substr $_[0]{rbuf}, 0, $format + $len, "";
		1091	$cb->($_[0], $data);
		1092	} else {
		1093	# remove prefix
		1094	substr $_[0]{rbuf}, 0, $format, "";
		1095
		1096	# read remaining chunk
		1097	$_[0]->unshift_read (chunk => $len, $cb);
		1098	}
		1099
		1100	1
		1101	}
		1102	};
		1103
851	=item json => $cb->($handle, $hash_or_arrayref)	1104	=item json => $cb->($handle, $hash_or_arrayref)
852		1105
853	Reads a JSON object or array, decodes it and passes it to the callback.	1106	Reads a JSON object or array, decodes it and passes it to the callback.
854		1107
855	If a C<json> object was passed to the constructor, then that will be used	1108	If a C<json> object was passed to the constructor, then that will be used
…		…
859	2.09 (and JSON::XS version 2.2) and above. You have to provide a	1112	2.09 (and JSON::XS version 2.2) and above. You have to provide a
860	dependency on your own: this module will load the JSON module, but	1113	dependency on your own: this module will load the JSON module, but
861	AnyEvent does not depend on it itself.	1114	AnyEvent does not depend on it itself.
862		1115
863	Since JSON texts are fully self-delimiting, the C<json> read and write	1116	Since JSON texts are fully self-delimiting, the C<json> read and write
864	types are an ideal simple RPC protocol: just exchange JSON datagrams.	1117	types are an ideal simple RPC protocol: just exchange JSON datagrams. See
		1118	the C<json> write type description, above, for an actual example.
865		1119
866	=cut	1120	=cut
867		1121
868	register_read_type json => sub {	1122	register_read_type json => sub {
869	my ($self, $cb, $accept, $reject, $skip) = @_;	1123	my ($self, $cb) = @_;
870		1124
871	require JSON;	1125	require JSON;
872		1126
873	my $data;	1127	my $data;
874	my $rbuf = \$self->{rbuf};	1128	my $rbuf = \$self->{rbuf};
875		1129
876	my $json = $self->{json} \|\|= JSON::XS->new->utf8;	1130	my $json = $self->{json} \|\|= JSON->new->utf8;
877		1131
878	sub {	1132	sub {
879	my $ref = $json->incr_parse ($self->{rbuf});	1133	my $ref = $json->incr_parse ($self->{rbuf});
880		1134
881	if ($ref) {	1135	if ($ref) {
…		…
889	()	1143	()
890	}	1144	}
891	}	1145	}
892	};	1146	};
893		1147
		1148	=item storable => $cb->($handle, $ref)
		1149
		1150	Deserialises a L<Storable> frozen representation as written by the
		1151	C<storable> write type (BER-encoded length prefix followed by nfreeze'd
		1152	data).
		1153
		1154	Raises C<EBADMSG> error if the data could not be decoded.
		1155
		1156	=cut
		1157
		1158	register_read_type storable => sub {
		1159	my ($self, $cb) = @_;
		1160
		1161	require Storable;
		1162
		1163	sub {
		1164	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
		1165	defined (my $len = eval { unpack "w", $_[0]{rbuf} })
		1166	or return;
		1167
		1168	my $format = length pack "w", $len;
		1169
		1170	# bypass unshift if we already have the remaining chunk
		1171	if ($format + $len <= length $_[0]{rbuf}) {
		1172	my $data = substr $_[0]{rbuf}, $format, $len;
		1173	substr $_[0]{rbuf}, 0, $format + $len, "";
		1174	$cb->($_[0], Storable::thaw ($data));
		1175	} else {
		1176	# remove prefix
		1177	substr $_[0]{rbuf}, 0, $format, "";
		1178
		1179	# read remaining chunk
		1180	$_[0]->unshift_read (chunk => $len, sub {
		1181	if (my $ref = eval { Storable::thaw ($_[1]) }) {
		1182	$cb->($_[0], $ref);
		1183	} else {
		1184	$self->_error (&Errno::EBADMSG);
		1185	}
		1186	});
		1187	}
		1188
		1189	1
		1190	}
		1191	};
		1192
894	=back	1193	=back
895		1194
896	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)	1195	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)
897		1196
898	This function (not method) lets you add your own types to C<push_read>.	1197	This function (not method) lets you add your own types to C<push_read>.
…		…
916	=item $handle->stop_read	1215	=item $handle->stop_read
917		1216
918	=item $handle->start_read	1217	=item $handle->start_read
919		1218
920	In rare cases you actually do not want to read anything from the	1219	In rare cases you actually do not want to read anything from the
921	socket. In this case you can call C<stop_read>. Neither C<on_read> no	1220	socket. In this case you can call C<stop_read>. Neither C<on_read> nor
922	any queued callbacks will be executed then. To start reading again, call	1221	any queued callbacks will be executed then. To start reading again, call
923	C<start_read>.	1222	C<start_read>.
		1223
		1224	Note that AnyEvent::Handle will automatically C<start_read> for you when
		1225	you change the C<on_read> callback or push/unshift a read callback, and it
		1226	will automatically C<stop_read> for you when neither C<on_read> is set nor
		1227	there are any read requests in the queue.
924		1228
925	=cut	1229	=cut
926		1230
927	sub stop_read {	1231	sub stop_read {
928	my ($self) = @_;	1232	my ($self) = @_;
…		…
939	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1243	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
940	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1244	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};
941	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;	1245	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;
942		1246
943	if ($len > 0) {	1247	if ($len > 0) {
		1248	$self->{_activity} = AnyEvent->now;
		1249
944	$self->{filter_r}	1250	$self->{filter_r}
945	? $self->{filter_r}->($self, $rbuf)	1251	? $self->{filter_r}($self, $rbuf)
946	: $self->_drain_rbuf;	1252	: $self->{_in_drain} \|\| $self->_drain_rbuf;
947		1253
948	} elsif (defined $len) {	1254	} elsif (defined $len) {
949	delete $self->{_rw};	1255	delete $self->{_rw};
950	$self->{_eof} = 1;	1256	$self->{_eof} = 1;
951	$self->_drain_rbuf;	1257	$self->_drain_rbuf unless $self->{_in_drain};
952		1258
953	} elsif ($! != EAGAIN && $! != EINTR && $! != &AnyEvent::Util::WSAWOULDBLOCK) {	1259	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
954	return $self->error;	1260	return $self->_error ($!, 1);
955	}	1261	}
956	});	1262	});
957	}	1263	}
958	}	1264	}
959		1265
960	sub _dotls {	1266	sub _dotls {
961	my ($self) = @_;	1267	my ($self) = @_;
		1268
		1269	my $buf;
962		1270
963	if (length $self->{_tls_wbuf}) {	1271	if (length $self->{_tls_wbuf}) {
964	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {	1272	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
965	substr $self->{_tls_wbuf}, 0, $len, "";	1273	substr $self->{_tls_wbuf}, 0, $len, "";
966	}	1274	}
967	}	1275	}
968		1276
969	if (defined (my $buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {	1277	if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {
970	$self->{wbuf} .= $buf;	1278	$self->{wbuf} .= $buf;
971	$self->_drain_wbuf;	1279	$self->_drain_wbuf;
972	}	1280	}
973		1281
974	while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) {	1282	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {
		1283	if (length $buf) {
975	$self->{rbuf} .= $buf;	1284	$self->{rbuf} .= $buf;
976	$self->_drain_rbuf;	1285	$self->_drain_rbuf unless $self->{_in_drain};
		1286	} else {
		1287	# let's treat SSL-eof as we treat normal EOF
		1288	$self->{_eof} = 1;
		1289	$self->_shutdown;
		1290	return;
		1291	}
977	}	1292	}
978		1293
979	my $err = Net::SSLeay::get_error ($self->{tls}, -1);	1294	my $err = Net::SSLeay::get_error ($self->{tls}, -1);
980		1295
981	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {	1296	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
982	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {	1297	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {
983	$self->error;	1298	return $self->_error ($!, 1);
984	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {	1299	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {
985	$! = &Errno::EIO;	1300	return $self->_error (&Errno::EIO, 1);
986	$self->error;
987	}	1301	}
988		1302
989	# all others are fine for our purposes	1303	# all others are fine for our purposes
990	}	1304	}
991	}	1305	}
…		…
1006	call and can be used or changed to your liking. Note that the handshake	1320	call and can be used or changed to your liking. Note that the handshake
1007	might have already started when this function returns.	1321	might have already started when this function returns.
1008		1322
1009	=cut	1323	=cut
1010		1324
1011	# TODO: maybe document...
1012	sub starttls {	1325	sub starttls {
1013	my ($self, $ssl, $ctx) = @_;	1326	my ($self, $ssl, $ctx) = @_;
1014		1327
1015	$self->stoptls;	1328	$self->stoptls;
1016		1329
…		…
1069		1382
1070	sub DESTROY {	1383	sub DESTROY {
1071	my $self = shift;	1384	my $self = shift;
1072		1385
1073	$self->stoptls;	1386	$self->stoptls;
		1387
		1388	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
		1389
		1390	if ($linger && length $self->{wbuf}) {
		1391	my $fh = delete $self->{fh};
		1392	my $wbuf = delete $self->{wbuf};
		1393
		1394	my @linger;
		1395
		1396	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {
		1397	my $len = syswrite $fh, $wbuf, length $wbuf;
		1398
		1399	if ($len > 0) {
		1400	substr $wbuf, 0, $len, "";
		1401	} else {
		1402	@linger = (); # end
		1403	}
		1404	});
		1405	push @linger, AnyEvent->timer (after => $linger, cb => sub {
		1406	@linger = ();
		1407	});
		1408	}
1074	}	1409	}
1075		1410
1076	=item AnyEvent::Handle::TLS_CTX	1411	=item AnyEvent::Handle::TLS_CTX
1077		1412
1078	This function creates and returns the Net::SSLeay::CTX object used by	1413	This function creates and returns the Net::SSLeay::CTX object used by
…		…
1120	=over 4	1455	=over 4
1121		1456
1122	=item * all constructor arguments become object members.	1457	=item * all constructor arguments become object members.
1123		1458
1124	At least initially, when you pass a C<tls>-argument to the constructor it	1459	At least initially, when you pass a C<tls>-argument to the constructor it
1125	will end up in C<< $handle->{tls} >>. Those members might be changes or	1460	will end up in C<< $handle->{tls} >>. Those members might be changed or
1126	mutated later on (for example C<tls> will hold the TLS connection object).	1461	mutated later on (for example C<tls> will hold the TLS connection object).
1127		1462
1128	=item * other object member names are prefixed with an C<_>.	1463	=item * other object member names are prefixed with an C<_>.
1129		1464
1130	All object members not explicitly documented (internal use) are prefixed	1465	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.40 by root, Tue May 27 05:36:27 2008 UTC vs. Revision 1.79 by root, Sun Jul 27 08:37:56 2008 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.40 by root, Tue May 27 05:36:27 2008 UTC vs.
Revision 1.79 by root, Sun Jul 27 08:37:56 2008 UTC