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