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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.37 by root, Mon May 26 20:02:22 2008 UTC vs.
Revision 1.66 by root, Fri Jun 6 15:32:54 2008 UTC

…		…
2		2
3	no warnings;	3	no warnings;
4	use strict;	4	use strict;
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.15;
20		20
21	=head1 SYNOPSIS	21	=head1 SYNOPSIS
22		22
23	use AnyEvent;	23	use AnyEvent;
24	use AnyEvent::Handle;	24	use AnyEvent::Handle;
…		…
73	The filehandle this L<AnyEvent::Handle> object will operate on.	73	The filehandle this L<AnyEvent::Handle> object will operate on.
74		74
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->($self)	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 detcted,
		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->($self)	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 callbakc 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->($self)	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<$self->{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
114	feed all the remaining data to the queued callbacks and C<on_read> before	118	feed all the remaining data to the queued callbacks and C<on_read> before
115	calling the C<on_eof> callback. If no progress can be made, then a fatal	119	calling the C<on_eof> callback. If no progress can be made, then a fatal
116	error will be raised (with C<$!> set to C<EPIPE>).	120	error will be raised (with C<$!> set to C<EPIPE>).
117		121
118	=item on_drain => $cb->()	122	=item on_drain => $cb->($handle)
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	=item timeout => $fractional_seconds
		130
		131	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
		133	handle, the C<on_timeout> callback will be invoked (and if that one is
		134	missing, an C<ETIMEDOUT> error will be raised).
		135
		136	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
		138	idle then you should disable the timout temporarily or ignore the timeout
		139	in the C<on_timeout> callback.
		140
		141	Zero (the default) disables this timeout.
		142
		143	=item on_timeout => $cb->($handle)
		144
		145	Called whenever the inactivity timeout passes. If you return from this
		146	callback, then the timeout will be reset as if some activity had happened,
		147	so this condition is not fatal in any way.
124		148
125	=item rbuf_max => <bytes>	149	=item rbuf_max => <bytes>
126		150
127	If defined, then a fatal error will be raised (with C<$!> set to C<ENOSPC>)	151	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	152	when the read buffer ever (strictly) exceeds this size. This is useful to
…		…
135	isn't finished).	159	isn't finished).
136		160
137	=item read_size => <bytes>	161	=item read_size => <bytes>
138		162
139	The default read block size (the amount of bytes this module will try to read	163	The default read block size (the amount of bytes this module will try to read
140	on each [loop iteration). Default: C<4096>.	164	during each (loop iteration). Default: C<8192>.
141		165
142	=item low_water_mark => <bytes>	166	=item low_water_mark => <bytes>
143		167
144	Sets the amount of bytes (default: C<0>) that make up an "empty" write	168	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	169	buffer: If the write reaches this size or gets even samller it is
146	considered empty.	170	considered empty.
		171
		172	=item linger => <seconds>
		173
		174	If non-zero (default: C<3600>), then the destructor of the
		175	AnyEvent::Handle object will check wether there is still outstanding write
		176	data and will install a watcher that will write out this data. No errors
		177	will be reported (this mostly matches how the operating system treats
		178	outstanding data at socket close time).
		179
		180	This will not work for partial TLS data that could not yet been
		181	encoded. This data will be lost.
147		182
148	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object	183	=item tls => "accept" \| "connect" \| Net::SSLeay::SSL object
149		184
150	When this parameter is given, it enables TLS (SSL) mode, that means it	185	When this parameter is given, it enables TLS (SSL) mode, that means it
151	will start making tls handshake and will transparently encrypt/decrypt	186	will start making tls handshake and will transparently encrypt/decrypt
…		…
168		203
169	Use the given Net::SSLeay::CTX object to create the new TLS connection	204	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	205	(unless a connection object was specified directly). If this parameter is
171	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	206	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
172		207
		208	=item json => JSON or JSON::XS object
		209
		210	This is the json coder object used by the C<json> read and write types.
		211
		212	If you don't supply it, then AnyEvent::Handle will create and use a
		213	suitable one, which will write and expect UTF-8 encoded JSON texts.
		214
		215	Note that you are responsible to depend on the JSON module if you want to
		216	use this functionality, as AnyEvent does not have a dependency itself.
		217
		218	=item filter_r => $cb
		219
		220	=item filter_w => $cb
		221
		222	These exist, but are undocumented at this time.
		223
173	=back	224	=back
174		225
175	=cut	226	=cut
176		227
177	sub new {	228	sub new {
…		…
186	if ($self->{tls}) {	237	if ($self->{tls}) {
187	require Net::SSLeay;	238	require Net::SSLeay;
188	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});	239	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});
189	}	240	}
190		241
191	$self->on_eof (delete $self->{on_eof} ) if $self->{on_eof};	242	$self->{_activity} = AnyEvent->now;
192	$self->on_error (delete $self->{on_error}) if $self->{on_error};	243	$self->_timeout;
		244
193	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	245	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
194	$self->on_read (delete $self->{on_read} ) if $self->{on_read};
195		246
196	$self->start_read;	247	$self->start_read
		248	if $self->{on_read} \|\| @{ $self->{_queue} };
197		249
198	$self	250	$self
199	}	251	}
200		252
201	sub _shutdown {	253	sub _shutdown {
202	my ($self) = @_;	254	my ($self) = @_;
203		255
		256	delete $self->{_tw};
204	delete $self->{rw};	257	delete $self->{_rw};
205	delete $self->{ww};	258	delete $self->{_ww};
206	delete $self->{fh};	259	delete $self->{fh};
207	}
208		260
		261	$self->stoptls;
		262	}
		263
209	sub error {	264	sub _error {
210	my ($self) = @_;	265	my ($self, $errno, $fatal) = @_;
211		266
212	{
213	local $!;
214	$self->_shutdown;	267	$self->_shutdown
215	}	268	if $fatal;
216		269
217	$self->{on_error}($self)	270	$! = $errno;
		271
218	if $self->{on_error};	272	if ($self->{on_error}) {
219		273	$self->{on_error}($self, $fatal);
		274	} else {
220	Carp::croak "AnyEvent::Handle uncaught fatal error: $!";	275	Carp::croak "AnyEvent::Handle uncaught error: $!";
		276	}
221	}	277	}
222		278
223	=item $fh = $handle->fh	279	=item $fh = $handle->fh
224		280
225	This method returns the file handle of the L<AnyEvent::Handle> object.	281	This method returns the file handle of the L<AnyEvent::Handle> object.
226		282
227	=cut	283	=cut
228		284
229	sub fh { $_[0]->{fh} }	285	sub fh { $_[0]{fh} }
230		286
231	=item $handle->on_error ($cb)	287	=item $handle->on_error ($cb)
232		288
233	Replace the current C<on_error> callback (see the C<on_error> constructor argument).	289	Replace the current C<on_error> callback (see the C<on_error> constructor argument).
234		290
…		…
244		300
245	=cut	301	=cut
246		302
247	sub on_eof {	303	sub on_eof {
248	$_[0]{on_eof} = $_[1];	304	$_[0]{on_eof} = $_[1];
		305	}
		306
		307	=item $handle->on_timeout ($cb)
		308
		309	Replace the current C<on_timeout> callback, or disables the callback
		310	(but not the timeout) if C<$cb> = C<undef>. See C<timeout> constructor
		311	argument.
		312
		313	=cut
		314
		315	sub on_timeout {
		316	$_[0]{on_timeout} = $_[1];
		317	}
		318
		319	#############################################################################
		320
		321	=item $handle->timeout ($seconds)
		322
		323	Configures (or disables) the inactivity timeout.
		324
		325	=cut
		326
		327	sub timeout {
		328	my ($self, $timeout) = @_;
		329
		330	$self->{timeout} = $timeout;
		331	$self->_timeout;
		332	}
		333
		334	# reset the timeout watcher, as neccessary
		335	# also check for time-outs
		336	sub _timeout {
		337	my ($self) = @_;
		338
		339	if ($self->{timeout}) {
		340	my $NOW = AnyEvent->now;
		341
		342	# when would the timeout trigger?
		343	my $after = $self->{_activity} + $self->{timeout} - $NOW;
		344
		345	# now or in the past already?
		346	if ($after <= 0) {
		347	$self->{_activity} = $NOW;
		348
		349	if ($self->{on_timeout}) {
		350	$self->{on_timeout}($self);
		351	} else {
		352	$self->_error (&Errno::ETIMEDOUT);
		353	}
		354
		355	# callback could have changed timeout value, optimise
		356	return unless $self->{timeout};
		357
		358	# calculate new after
		359	$after = $self->{timeout};
		360	}
		361
		362	Scalar::Util::weaken $self;
		363	return unless $self; # ->error could have destroyed $self
		364
		365	$self->{_tw} \|\|= AnyEvent->timer (after => $after, cb => sub {
		366	delete $self->{_tw};
		367	$self->_timeout;
		368	});
		369	} else {
		370	delete $self->{_tw};
		371	}
249	}	372	}
250		373
251	#############################################################################	374	#############################################################################
252		375
253	=back	376	=back
…		…
290	=cut	413	=cut
291		414
292	sub _drain_wbuf {	415	sub _drain_wbuf {
293	my ($self) = @_;	416	my ($self) = @_;
294		417
295	if (!$self->{ww} && length $self->{wbuf}) {	418	if (!$self->{_ww} && length $self->{wbuf}) {
296		419
297	Scalar::Util::weaken $self;	420	Scalar::Util::weaken $self;
298		421
299	my $cb = sub {	422	my $cb = sub {
300	my $len = syswrite $self->{fh}, $self->{wbuf};	423	my $len = syswrite $self->{fh}, $self->{wbuf};
301		424
302	if ($len >= 0) {	425	if ($len >= 0) {
303	substr $self->{wbuf}, 0, $len, "";	426	substr $self->{wbuf}, 0, $len, "";
		427
		428	$self->{_activity} = AnyEvent->now;
304		429
305	$self->{on_drain}($self)	430	$self->{on_drain}($self)
306	if $self->{low_water_mark} >= length $self->{wbuf}	431	if $self->{low_water_mark} >= length $self->{wbuf}
307	&& $self->{on_drain};	432	&& $self->{on_drain};
308		433
309	delete $self->{ww} unless length $self->{wbuf};	434	delete $self->{_ww} unless length $self->{wbuf};
310	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAWOULDBLOCK) {	435	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
311	$self->error;	436	$self->_error ($!, 1);
312	}	437	}
313	};	438	};
314		439
315	# try to write data immediately	440	# try to write data immediately
316	$cb->();	441	$cb->();
317		442
318	# if still data left in wbuf, we need to poll	443	# if still data left in wbuf, we need to poll
319	$self->{ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)	444	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)
320	if length $self->{wbuf};	445	if length $self->{wbuf};
321	};	446	};
322	}	447	}
323		448
324	our %WH;	449	our %WH;
…		…
336	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	461	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")
337	->($self, @_);	462	->($self, @_);
338	}	463	}
339		464
340	if ($self->{filter_w}) {	465	if ($self->{filter_w}) {
341	$self->{filter_w}->($self, \$_[0]);	466	$self->{filter_w}($self, \$_[0]);
342	} else {	467	} else {
343	$self->{wbuf} .= $_[0];	468	$self->{wbuf} .= $_[0];
344	$self->_drain_wbuf;	469	$self->_drain_wbuf;
345	}	470	}
346	}	471	}
347		472
348	=item $handle->push_write (type => @args)	473	=item $handle->push_write (type => @args)
349		474
350	=item $handle->unshift_write (type => @args)
351
352	Instead of formatting your data yourself, you can also let this module do	475	Instead of formatting your data yourself, you can also let this module do
353	the job by specifying a type and type-specific arguments.	476	the job by specifying a type and type-specific arguments.
354		477
355	Predefined types are (if you have ideas for additional types, feel free to	478	Predefined types are (if you have ideas for additional types, feel free to
356	drop by and tell us):	479	drop by and tell us):
…		…
360	=item netstring => $string	483	=item netstring => $string
361		484
362	Formats the given value as netstring	485	Formats the given value as netstring
363	(http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them).	486	(http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them).
364		487
365	=back
366
367	=cut	488	=cut
368		489
369	register_write_type netstring => sub {	490	register_write_type netstring => sub {
370	my ($self, $string) = @_;	491	my ($self, $string) = @_;
371		492
372	sprintf "%d:%s,", (length $string), $string	493	sprintf "%d:%s,", (length $string), $string
373	};	494	};
374		495
		496	=item packstring => $format, $data
		497
		498	An octet string prefixed with an encoded length. The encoding C<$format>
		499	uses the same format as a Perl C<pack> format, but must specify a single
		500	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
		501	optional C<!>, C<< < >> or C<< > >> modifier).
		502
		503	=cut
		504
		505	register_write_type packstring => sub {
		506	my ($self, $format, $string) = @_;
		507
		508	pack "$format/a*", $string
		509	};
		510
		511	=item json => $array_or_hashref
		512
		513	Encodes the given hash or array reference into a JSON object. Unless you
		514	provide your own JSON object, this means it will be encoded to JSON text
		515	in UTF-8.
		516
		517	JSON objects (and arrays) are self-delimiting, so you can write JSON at
		518	one end of a handle and read them at the other end without using any
		519	additional framing.
		520
		521	The generated JSON text is guaranteed not to contain any newlines: While
		522	this module doesn't need delimiters after or between JSON texts to be
		523	able to read them, many other languages depend on that.
		524
		525	A simple RPC protocol that interoperates easily with others is to send
		526	JSON arrays (or objects, although arrays are usually the better choice as
		527	they mimic how function argument passing works) and a newline after each
		528	JSON text:
		529
		530	$handle->push_write (json => ["method", "arg1", "arg2"]); # whatever
		531	$handle->push_write ("\012");
		532
		533	An AnyEvent::Handle receiver would simply use the C<json> read type and
		534	rely on the fact that the newline will be skipped as leading whitespace:
		535
		536	$handle->push_read (json => sub { my $array = $_[1]; ... });
		537
		538	Other languages could read single lines terminated by a newline and pass
		539	this line into their JSON decoder of choice.
		540
		541	=cut
		542
		543	register_write_type json => sub {
		544	my ($self, $ref) = @_;
		545
		546	require JSON;
		547
		548	$self->{json} ? $self->{json}->encode ($ref)
		549	: JSON::encode_json ($ref)
		550	};
		551
		552	=item storable => $reference
		553
		554	Freezes the given reference using L<Storable> and writes it to the
		555	handle. Uses the C<nfreeze> format.
		556
		557	=cut
		558
		559	register_write_type storable => sub {
		560	my ($self, $ref) = @_;
		561
		562	require Storable;
		563
		564	pack "w/a*", Storable::nfreeze ($ref)
		565	};
		566
		567	=back
		568
375	=item AnyEvent::Handle::register_write_type type => $coderef->($self, @args)	569	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
376		570
377	This function (not method) lets you add your own types to C<push_write>.	571	This function (not method) lets you add your own types to C<push_write>.
378	Whenever the given C<type> is used, C<push_write> will invoke the code	572	Whenever the given C<type> is used, C<push_write> will invoke the code
379	reference with the handle object and the remaining arguments.	573	reference with the handle object and the remaining arguments.
380		574
…		…
404	enough is there) from the read buffer (C<< $handle->rbuf >>) if you want	598	enough is there) from the read buffer (C<< $handle->rbuf >>) if you want
405	or not.	599	or not.
406		600
407	In the more complex case, you want to queue multiple callbacks. In this	601	In the more complex case, you want to queue multiple callbacks. In this
408	case, AnyEvent::Handle will call the first queued callback each time new	602	case, AnyEvent::Handle will call the first queued callback each time new
409	data arrives and removes it when it has done its job (see C<push_read>,	603	data arrives (also the first time it is queued) and removes it when it has
410	below).	604	done its job (see C<push_read>, below).
411		605
412	This way you can, for example, push three line-reads, followed by reading	606	This way you can, for example, push three line-reads, followed by reading
413	a chunk of data, and AnyEvent::Handle will execute them in order.	607	a chunk of data, and AnyEvent::Handle will execute them in order.
414		608
415	Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by	609	Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by
416	the specified number of bytes which give an XML datagram.	610	the specified number of bytes which give an XML datagram.
417		611
418	# in the default state, expect some header bytes	612	# in the default state, expect some header bytes
419	$handle->on_read (sub {	613	$handle->on_read (sub {
420	# some data is here, now queue the length-header-read (4 octets)	614	# some data is here, now queue the length-header-read (4 octets)
421	shift->unshift_read_chunk (4, sub {	615	shift->unshift_read (chunk => 4, sub {
422	# header arrived, decode	616	# header arrived, decode
423	my $len = unpack "N", $_[1];	617	my $len = unpack "N", $_[1];
424		618
425	# now read the payload	619	# now read the payload
426	shift->unshift_read_chunk ($len, sub {	620	shift->unshift_read (chunk => $len, sub {
427	my $xml = $_[1];	621	my $xml = $_[1];
428	# handle xml	622	# handle xml
429	});	623	});
430	});	624	});
431	});	625	});
…		…
438		632
439	# request one	633	# request one
440	$handle->push_write ("request 1\015\012");	634	$handle->push_write ("request 1\015\012");
441		635
442	# we expect "ERROR" or "OK" as response, so push a line read	636	# we expect "ERROR" or "OK" as response, so push a line read
443	$handle->push_read_line (sub {	637	$handle->push_read (line => sub {
444	# if we got an "OK", we have to _prepend_ another line,	638	# if we got an "OK", we have to _prepend_ another line,
445	# so it will be read before the second request reads its 64 bytes	639	# so it will be read before the second request reads its 64 bytes
446	# which are already in the queue when this callback is called	640	# which are already in the queue when this callback is called
447	# we don't do this in case we got an error	641	# we don't do this in case we got an error
448	if ($_[1] eq "OK") {	642	if ($_[1] eq "OK") {
449	$_[0]->unshift_read_line (sub {	643	$_[0]->unshift_read (line => sub {
450	my $response = $_[1];	644	my $response = $_[1];
451	...	645	...
452	});	646	});
453	}	647	}
454	});	648	});
455		649
456	# request two	650	# request two
457	$handle->push_write ("request 2\015\012");	651	$handle->push_write ("request 2\015\012");
458		652
459	# simply read 64 bytes, always	653	# simply read 64 bytes, always
460	$handle->push_read_chunk (64, sub {	654	$handle->push_read (chunk => 64, sub {
461	my $response = $_[1];	655	my $response = $_[1];
462	...	656	...
463	});	657	});
464		658
465	=over 4	659	=over 4
466		660
467	=cut	661	=cut
468		662
469	sub _drain_rbuf {	663	sub _drain_rbuf {
470	my ($self) = @_;	664	my ($self) = @_;
		665
		666	local $self->{_in_drain} = 1;
471		667
472	if (	668	if (
473	defined $self->{rbuf_max}	669	defined $self->{rbuf_max}
474	&& $self->{rbuf_max} < length $self->{rbuf}	670	&& $self->{rbuf_max} < length $self->{rbuf}
475	) {	671	) {
476	$! = &Errno::ENOSPC;	672	return $self->_error (&Errno::ENOSPC, 1);
477	$self->error;
478	}	673	}
479		674
480	return if $self->{in_drain};	675	while () {
481	local $self->{in_drain} = 1;
482
483	while (my $len = length $self->{rbuf}) {
484	no strict 'refs';	676	no strict 'refs';
		677
		678	my $len = length $self->{rbuf};
		679
485	if (my $cb = shift @{ $self->{queue} }) {	680	if (my $cb = shift @{ $self->{_queue} }) {
486	unless ($cb->($self)) {	681	unless ($cb->($self)) {
487	if ($self->{eof}) {	682	if ($self->{_eof}) {
488	# no progress can be made (not enough data and no data forthcoming)	683	# no progress can be made (not enough data and no data forthcoming)
489	$! = &Errno::EPIPE;	684	$self->_error (&Errno::EPIPE, 1), last;
490	$self->error;
491	}	685	}
492		686
493	unshift @{ $self->{queue} }, $cb;	687	unshift @{ $self->{_queue} }, $cb;
494	return;	688	last;
495	}	689	}
496	} elsif ($self->{on_read}) {	690	} elsif ($self->{on_read}) {
		691	last unless $len;
		692
497	$self->{on_read}($self);	693	$self->{on_read}($self);
498		694
499	if (	695	if (
500	$self->{eof} # if no further data will arrive
501	&& $len == length $self->{rbuf} # and no data has been consumed	696	$len == length $self->{rbuf} # if no data has been consumed
502	&& !@{ $self->{queue} } # and the queue is still empty	697	&& !@{ $self->{_queue} } # and the queue is still empty
503	&& $self->{on_read} # and we still want to read data	698	&& $self->{on_read} # but we still have on_read
504	) {	699	) {
		700	# no further data will arrive
505	# then no progress can be made	701	# so no progress can be made
506	$! = &Errno::EPIPE;	702	$self->_error (&Errno::EPIPE, 1), last
507	$self->error;	703	if $self->{_eof};
		704
		705	last; # more data might arrive
508	}	706	}
509	} else {	707	} else {
510	# read side becomes idle	708	# read side becomes idle
511	delete $self->{rw};	709	delete $self->{_rw};
512	return;	710	last;
513	}	711	}
514	}	712	}
515		713
516	if ($self->{eof}) {
517	$self->_shutdown;
518	$self->{on_eof}($self)	714	$self->{on_eof}($self)
519	if $self->{on_eof};	715	if $self->{_eof} && $self->{on_eof};
		716
		717	# may need to restart read watcher
		718	unless ($self->{_rw}) {
		719	$self->start_read
		720	if $self->{on_read} \|\| @{ $self->{_queue} };
520	}	721	}
521	}	722	}
522		723
523	=item $handle->on_read ($cb)	724	=item $handle->on_read ($cb)
524		725
…		…
530		731
531	sub on_read {	732	sub on_read {
532	my ($self, $cb) = @_;	733	my ($self, $cb) = @_;
533		734
534	$self->{on_read} = $cb;	735	$self->{on_read} = $cb;
		736	$self->_drain_rbuf if $cb && !$self->{_in_drain};
535	}	737	}
536		738
537	=item $handle->rbuf	739	=item $handle->rbuf
538		740
539	Returns the read buffer (as a modifiable lvalue).	741	Returns the read buffer (as a modifiable lvalue).
…		…
587		789
588	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	790	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
589	->($self, $cb, @_);	791	->($self, $cb, @_);
590	}	792	}
591		793
592	push @{ $self->{queue} }, $cb;	794	push @{ $self->{_queue} }, $cb;
593	$self->_drain_rbuf;	795	$self->_drain_rbuf unless $self->{_in_drain};
594	}	796	}
595		797
596	sub unshift_read {	798	sub unshift_read {
597	my $self = shift;	799	my $self = shift;
598	my $cb = pop;	800	my $cb = pop;
…		…
603	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")	805	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")
604	->($self, $cb, @_);	806	->($self, $cb, @_);
605	}	807	}
606		808
607		809
608	unshift @{ $self->{queue} }, $cb;	810	unshift @{ $self->{_queue} }, $cb;
609	$self->_drain_rbuf;	811	$self->_drain_rbuf unless $self->{_in_drain};
610	}	812	}
611		813
612	=item $handle->push_read (type => @args, $cb)	814	=item $handle->push_read (type => @args, $cb)
613		815
614	=item $handle->unshift_read (type => @args, $cb)	816	=item $handle->unshift_read (type => @args, $cb)
…		…
620	Predefined types are (if you have ideas for additional types, feel free to	822	Predefined types are (if you have ideas for additional types, feel free to
621	drop by and tell us):	823	drop by and tell us):
622		824
623	=over 4	825	=over 4
624		826
625	=item chunk => $octets, $cb->($self, $data)	827	=item chunk => $octets, $cb->($handle, $data)
626		828
627	Invoke the callback only once C<$octets> bytes have been read. Pass the	829	Invoke the callback only once C<$octets> bytes have been read. Pass the
628	data read to the callback. The callback will never be called with less	830	data read to the callback. The callback will never be called with less
629	data.	831	data.
630		832
…		…
653		855
654	sub unshift_read_chunk {	856	sub unshift_read_chunk {
655	$_[0]->unshift_read (chunk => $_[1], $_[2]);	857	$_[0]->unshift_read (chunk => $_[1], $_[2]);
656	}	858	}
657		859
658	=item line => [$eol, ]$cb->($self, $line, $eol)	860	=item line => [$eol, ]$cb->($handle, $line, $eol)
659		861
660	The callback will be called only once a full line (including the end of	862	The callback will be called only once a full line (including the end of
661	line marker, C<$eol>) has been read. This line (excluding the end of line	863	line marker, C<$eol>) has been read. This line (excluding the end of line
662	marker) will be passed to the callback as second argument (C<$line>), and	864	marker) will be passed to the callback as second argument (C<$line>), and
663	the end of line marker as the third argument (C<$eol>).	865	the end of line marker as the third argument (C<$eol>).
…		…
700	sub unshift_read_line {	902	sub unshift_read_line {
701	my $self = shift;	903	my $self = shift;
702	$self->unshift_read (line => @_);	904	$self->unshift_read (line => @_);
703	}	905	}
704		906
705	=item netstring => $cb->($string)
706
707	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
708
709	Throws an error with C<$!> set to EBADMSG on format violations.
710
711	=cut
712
713	register_read_type netstring => sub {
714	my ($self, $cb) = @_;
715
716	sub {
717	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
718	if ($_[0]{rbuf} =~ /[^0-9]/) {
719	$! = &Errno::EBADMSG;
720	$self->error;
721	}
722	return;
723	}
724
725	my $len = $1;
726
727	$self->unshift_read (chunk => $len, sub {
728	my $string = $_[1];
729	$_[0]->unshift_read (chunk => 1, sub {
730	if ($_[1] eq ",") {
731	$cb->($_[0], $string);
732	} else {
733	$! = &Errno::EBADMSG;
734	$self->error;
735	}
736	});
737	});
738
739	1
740	}
741	};
742
743	=item regex => $accept[, $reject[, $skip], $cb->($data)	907	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
744		908
745	Makes a regex match against the regex object C<$accept> and returns	909	Makes a regex match against the regex object C<$accept> and returns
746	everything up to and including the match.	910	everything up to and including the match.
747		911
748	Example: read a single line terminated by '\n'.	912	Example: read a single line terminated by '\n'.
…		…
796	return 1;	960	return 1;
797	}	961	}
798		962
799	# reject	963	# reject
800	if ($reject && $$rbuf =~ $reject) {	964	if ($reject && $$rbuf =~ $reject) {
801	$! = &Errno::EBADMSG;	965	$self->_error (&Errno::EBADMSG);
802	$self->error;
803	}	966	}
804		967
805	# skip	968	# skip
806	if ($skip && $$rbuf =~ $skip) {	969	if ($skip && $$rbuf =~ $skip) {
807	$data .= substr $$rbuf, 0, $+[0], "";	970	$data .= substr $$rbuf, 0, $+[0], "";
…		…
809		972
810	()	973	()
811	}	974	}
812	};	975	};
813		976
		977	=item netstring => $cb->($handle, $string)
		978
		979	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
		980
		981	Throws an error with C<$!> set to EBADMSG on format violations.
		982
		983	=cut
		984
		985	register_read_type netstring => sub {
		986	my ($self, $cb) = @_;
		987
		988	sub {
		989	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
		990	if ($_[0]{rbuf} =~ /[^0-9]/) {
		991	$self->_error (&Errno::EBADMSG);
		992	}
		993	return;
		994	}
		995
		996	my $len = $1;
		997
		998	$self->unshift_read (chunk => $len, sub {
		999	my $string = $_[1];
		1000	$_[0]->unshift_read (chunk => 1, sub {
		1001	if ($_[1] eq ",") {
		1002	$cb->($_[0], $string);
		1003	} else {
		1004	$self->_error (&Errno::EBADMSG);
		1005	}
		1006	});
		1007	});
		1008
		1009	1
		1010	}
		1011	};
		1012
		1013	=item packstring => $format, $cb->($handle, $string)
		1014
		1015	An octet string prefixed with an encoded length. The encoding C<$format>
		1016	uses the same format as a Perl C<pack> format, but must specify a single
		1017	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
		1018	optional C<!>, C<< < >> or C<< > >> modifier).
		1019
		1020	DNS over TCP uses a prefix of C<n>, EPP uses a prefix of C<N>.
		1021
		1022	Example: read a block of data prefixed by its length in BER-encoded
		1023	format (very efficient).
		1024
		1025	$handle->push_read (packstring => "w", sub {
		1026	my ($handle, $data) = @_;
		1027	});
		1028
		1029	=cut
		1030
		1031	register_read_type packstring => sub {
		1032	my ($self, $cb, $format) = @_;
		1033
		1034	sub {
		1035	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
		1036	defined (my $len = eval { unpack $format, $_[0]->{rbuf} })
		1037	or return;
		1038
		1039	# remove prefix
		1040	substr $_[0]->{rbuf}, 0, (length pack $format, $len), "";
		1041
		1042	# read rest
		1043	$_[0]->unshift_read (chunk => $len, $cb);
		1044
		1045	1
		1046	}
		1047	};
		1048
		1049	=item json => $cb->($handle, $hash_or_arrayref)
		1050
		1051	Reads a JSON object or array, decodes it and passes it to the callback.
		1052
		1053	If a C<json> object was passed to the constructor, then that will be used
		1054	for the final decode, otherwise it will create a JSON coder expecting UTF-8.
		1055
		1056	This read type uses the incremental parser available with JSON version
		1057	2.09 (and JSON::XS version 2.2) and above. You have to provide a
		1058	dependency on your own: this module will load the JSON module, but
		1059	AnyEvent does not depend on it itself.
		1060
		1061	Since JSON texts are fully self-delimiting, the C<json> read and write
		1062	types are an ideal simple RPC protocol: just exchange JSON datagrams. See
		1063	the C<json> write type description, above, for an actual example.
		1064
		1065	=cut
		1066
		1067	register_read_type json => sub {
		1068	my ($self, $cb) = @_;
		1069
		1070	require JSON;
		1071
		1072	my $data;
		1073	my $rbuf = \$self->{rbuf};
		1074
		1075	my $json = $self->{json} \|\|= JSON->new->utf8;
		1076
		1077	sub {
		1078	my $ref = $json->incr_parse ($self->{rbuf});
		1079
		1080	if ($ref) {
		1081	$self->{rbuf} = $json->incr_text;
		1082	$json->incr_text = "";
		1083	$cb->($self, $ref);
		1084
		1085	1
		1086	} else {
		1087	$self->{rbuf} = "";
		1088	()
		1089	}
		1090	}
		1091	};
		1092
		1093	=item storable => $cb->($handle, $ref)
		1094
		1095	Deserialises a L<Storable> frozen representation as written by the
		1096	C<storable> write type (BER-encoded length prefix followed by nfreeze'd
		1097	data).
		1098
		1099	Raises C<EBADMSG> error if the data could not be decoded.
		1100
		1101	=cut
		1102
		1103	register_read_type storable => sub {
		1104	my ($self, $cb) = @_;
		1105
		1106	require Storable;
		1107
		1108	sub {
		1109	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
		1110	defined (my $len = eval { unpack "w", $_[0]->{rbuf} })
		1111	or return;
		1112
		1113	# remove prefix
		1114	substr $_[0]->{rbuf}, 0, (length pack "w", $len), "";
		1115
		1116	# read rest
		1117	$_[0]->unshift_read (chunk => $len, sub {
		1118	if (my $ref = eval { Storable::thaw ($_[1]) }) {
		1119	$cb->($_[0], $ref);
		1120	} else {
		1121	$self->_error (&Errno::EBADMSG);
		1122	}
		1123	});
		1124	}
		1125	};
		1126
814	=back	1127	=back
815		1128
816	=item AnyEvent::Handle::register_read_type type => $coderef->($self, $cb, @args)	1129	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)
817		1130
818	This function (not method) lets you add your own types to C<push_read>.	1131	This function (not method) lets you add your own types to C<push_read>.
819		1132
820	Whenever the given C<type> is used, C<push_read> will invoke the code	1133	Whenever the given C<type> is used, C<push_read> will invoke the code
821	reference with the handle object, the callback and the remaining	1134	reference with the handle object, the callback and the remaining
…		…
823		1136
824	The code reference is supposed to return a callback (usually a closure)	1137	The code reference is supposed to return a callback (usually a closure)
825	that works as a plain read callback (see C<< ->push_read ($cb) >>).	1138	that works as a plain read callback (see C<< ->push_read ($cb) >>).
826		1139
827	It should invoke the passed callback when it is done reading (remember to	1140	It should invoke the passed callback when it is done reading (remember to
828	pass C<$self> as first argument as all other callbacks do that).	1141	pass C<$handle> as first argument as all other callbacks do that).
829		1142
830	Note that this is a function, and all types registered this way will be	1143	Note that this is a function, and all types registered this way will be
831	global, so try to use unique names.	1144	global, so try to use unique names.
832		1145
833	For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>,	1146	For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>,
…		…
836	=item $handle->stop_read	1149	=item $handle->stop_read
837		1150
838	=item $handle->start_read	1151	=item $handle->start_read
839		1152
840	In rare cases you actually do not want to read anything from the	1153	In rare cases you actually do not want to read anything from the
841	socket. In this case you can call C<stop_read>. Neither C<on_read> no	1154	socket. In this case you can call C<stop_read>. Neither C<on_read> nor
842	any queued callbacks will be executed then. To start reading again, call	1155	any queued callbacks will be executed then. To start reading again, call
843	C<start_read>.	1156	C<start_read>.
844		1157
		1158	Note that AnyEvent::Handle will automatically C<start_read> for you when
		1159	you change the C<on_read> callback or push/unshift a read callback, and it
		1160	will automatically C<stop_read> for you when neither C<on_read> is set nor
		1161	there are any read requests in the queue.
		1162
845	=cut	1163	=cut
846		1164
847	sub stop_read {	1165	sub stop_read {
848	my ($self) = @_;	1166	my ($self) = @_;
849		1167
850	delete $self->{rw};	1168	delete $self->{_rw};
851	}	1169	}
852		1170
853	sub start_read {	1171	sub start_read {
854	my ($self) = @_;	1172	my ($self) = @_;
855		1173
856	unless ($self->{rw} \|\| $self->{eof}) {	1174	unless ($self->{_rw} \|\| $self->{_eof}) {
857	Scalar::Util::weaken $self;	1175	Scalar::Util::weaken $self;
858		1176
859	$self->{rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1177	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
860	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1178	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};
861	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;	1179	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;
862		1180
863	if ($len > 0) {	1181	if ($len > 0) {
		1182	$self->{_activity} = AnyEvent->now;
		1183
864	$self->{filter_r}	1184	$self->{filter_r}
865	? $self->{filter_r}->($self, $rbuf)	1185	? $self->{filter_r}($self, $rbuf)
866	: $self->_drain_rbuf;	1186	: $self->{_in_drain} \|\| $self->_drain_rbuf;
867		1187
868	} elsif (defined $len) {	1188	} elsif (defined $len) {
869	delete $self->{rw};	1189	delete $self->{_rw};
870	$self->{eof} = 1;	1190	$self->{_eof} = 1;
871	$self->_drain_rbuf;	1191	$self->_drain_rbuf unless $self->{_in_drain};
872		1192
873	} elsif ($! != EAGAIN && $! != EINTR && $! != &AnyEvent::Util::WSAWOULDBLOCK) {	1193	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
874	return $self->error;	1194	return $self->_error ($!, 1);
875	}	1195	}
876	});	1196	});
877	}	1197	}
878	}	1198	}
879		1199
880	sub _dotls {	1200	sub _dotls {
881	my ($self) = @_;	1201	my ($self) = @_;
882		1202
		1203	my $buf;
		1204
883	if (length $self->{tls_wbuf}) {	1205	if (length $self->{_tls_wbuf}) {
884	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{tls_wbuf})) > 0) {	1206	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
885	substr $self->{tls_wbuf}, 0, $len, "";	1207	substr $self->{_tls_wbuf}, 0, $len, "";
886	}	1208	}
887	}	1209	}
888		1210
889	if (defined (my $buf = Net::SSLeay::BIO_read ($self->{tls_wbio}))) {	1211	if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {
890	$self->{wbuf} .= $buf;	1212	$self->{wbuf} .= $buf;
891	$self->_drain_wbuf;	1213	$self->_drain_wbuf;
892	}	1214	}
893		1215
894	while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) {	1216	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {
		1217	if (length $buf) {
895	$self->{rbuf} .= $buf;	1218	$self->{rbuf} .= $buf;
896	$self->_drain_rbuf;	1219	$self->_drain_rbuf unless $self->{_in_drain};
		1220	} else {
		1221	# let's treat SSL-eof as we treat normal EOF
		1222	$self->{_eof} = 1;
		1223	$self->_shutdown;
		1224	return;
		1225	}
897	}	1226	}
898		1227
899	my $err = Net::SSLeay::get_error ($self->{tls}, -1);	1228	my $err = Net::SSLeay::get_error ($self->{tls}, -1);
900		1229
901	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {	1230	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
902	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {	1231	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {
903	$self->error;	1232	return $self->_error ($!, 1);
904	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {	1233	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {
905	$! = &Errno::EIO;	1234	return $self->_error (&Errno::EIO, 1);
906	$self->error;
907	}	1235	}
908		1236
909	# all others are fine for our purposes	1237	# all others are fine for our purposes
910	}	1238	}
911	}	1239	}
…		…
920	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1248	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
921		1249
922	The second argument is the optional C<Net::SSLeay::CTX> object that is	1250	The second argument is the optional C<Net::SSLeay::CTX> object that is
923	used when AnyEvent::Handle has to create its own TLS connection object.	1251	used when AnyEvent::Handle has to create its own TLS connection object.
924		1252
925	=cut	1253	The TLS connection object will end up in C<< $handle->{tls} >> after this
		1254	call and can be used or changed to your liking. Note that the handshake
		1255	might have already started when this function returns.
926		1256
927	# TODO: maybe document...	1257	=cut
		1258
928	sub starttls {	1259	sub starttls {
929	my ($self, $ssl, $ctx) = @_;	1260	my ($self, $ssl, $ctx) = @_;
930		1261
931	$self->stoptls;	1262	$self->stoptls;
932		1263
…		…
947	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html	1278	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
948	Net::SSLeay::CTX_set_mode ($self->{tls},	1279	Net::SSLeay::CTX_set_mode ($self->{tls},
949	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1280	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
950	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));	1281	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
951		1282
952	$self->{tls_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1283	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
953	$self->{tls_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1284	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
954		1285
955	Net::SSLeay::set_bio ($ssl, $self->{tls_rbio}, $self->{tls_wbio});	1286	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
956		1287
957	$self->{filter_w} = sub {	1288	$self->{filter_w} = sub {
958	$_[0]{tls_wbuf} .= ${$_[1]};	1289	$_[0]{_tls_wbuf} .= ${$_[1]};
959	&_dotls;	1290	&_dotls;
960	};	1291	};
961	$self->{filter_r} = sub {	1292	$self->{filter_r} = sub {
962	Net::SSLeay::BIO_write ($_[0]{tls_rbio}, ${$_[1]});	1293	Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});
963	&_dotls;	1294	&_dotls;
964	};	1295	};
965	}	1296	}
966		1297
967	=item $handle->stoptls	1298	=item $handle->stoptls
…		…
973		1304
974	sub stoptls {	1305	sub stoptls {
975	my ($self) = @_;	1306	my ($self) = @_;
976		1307
977	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};	1308	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};
		1309
978	delete $self->{tls_rbio};	1310	delete $self->{_rbio};
979	delete $self->{tls_wbio};	1311	delete $self->{_wbio};
980	delete $self->{tls_wbuf};	1312	delete $self->{_tls_wbuf};
981	delete $self->{filter_r};	1313	delete $self->{filter_r};
982	delete $self->{filter_w};	1314	delete $self->{filter_w};
983	}	1315	}
984		1316
985	sub DESTROY {	1317	sub DESTROY {
986	my $self = shift;	1318	my $self = shift;
987		1319
988	$self->stoptls;	1320	$self->stoptls;
		1321
		1322	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
		1323
		1324	if ($linger && length $self->{wbuf}) {
		1325	my $fh = delete $self->{fh};
		1326	my $wbuf = delete $self->{wbuf};
		1327
		1328	my @linger;
		1329
		1330	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {
		1331	my $len = syswrite $fh, $wbuf, length $wbuf;
		1332
		1333	if ($len > 0) {
		1334	substr $wbuf, 0, $len, "";
		1335	} else {
		1336	@linger = (); # end
		1337	}
		1338	});
		1339	push @linger, AnyEvent->timer (after => $linger, cb => sub {
		1340	@linger = ();
		1341	});
		1342	}
989	}	1343	}
990		1344
991	=item AnyEvent::Handle::TLS_CTX	1345	=item AnyEvent::Handle::TLS_CTX
992		1346
993	This function creates and returns the Net::SSLeay::CTX object used by	1347	This function creates and returns the Net::SSLeay::CTX object used by
…		…
1023	}	1377	}
1024	}	1378	}
1025		1379
1026	=back	1380	=back
1027		1381
		1382	=head1 SUBCLASSING AnyEvent::Handle
		1383
		1384	In many cases, you might want to subclass AnyEvent::Handle.
		1385
		1386	To make this easier, a given version of AnyEvent::Handle uses these
		1387	conventions:
		1388
		1389	=over 4
		1390
		1391	=item * all constructor arguments become object members.
		1392
		1393	At least initially, when you pass a C<tls>-argument to the constructor it
		1394	will end up in C<< $handle->{tls} >>. Those members might be changes or
		1395	mutated later on (for example C<tls> will hold the TLS connection object).
		1396
		1397	=item * other object member names are prefixed with an C<_>.
		1398
		1399	All object members not explicitly documented (internal use) are prefixed
		1400	with an underscore character, so the remaining non-C<_>-namespace is free
		1401	for use for subclasses.
		1402
		1403	=item * all members not documented here and not prefixed with an underscore
		1404	are free to use in subclasses.
		1405
		1406	Of course, new versions of AnyEvent::Handle may introduce more "public"
		1407	member variables, but thats just life, at least it is documented.
		1408
		1409	=back
		1410
1028	=head1 AUTHOR	1411	=head1 AUTHOR
1029		1412
1030	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.	1413	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.
1031		1414
1032	=cut	1415	=cut

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.37 by root, Mon May 26 20:02:22 2008 UTC vs. Revision 1.66 by root, Fri Jun 6 15:32:54 2008 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.37 by root, Mon May 26 20:02:22 2008 UTC vs.
Revision 1.66 by root, Fri Jun 6 15:32:54 2008 UTC