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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.30 by root, Sat May 24 23:56:26 2008 UTC vs.
Revision 1.61 by root, Fri Jun 6 10:23:50 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 ();	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	This module is experimental.
18
19	=cut	17	=cut
20		18
21	our $VERSION = '0.04';	19	our $VERSION = 4.14;
22		20
23	=head1 SYNOPSIS	21	=head1 SYNOPSIS
24		22
25	use AnyEvent;	23	use AnyEvent;
26	use AnyEvent::Handle;	24	use AnyEvent::Handle;
27		25
28	my $cv = AnyEvent->condvar;	26	my $cv = AnyEvent->condvar;
29		27
30	my $ae_fh = AnyEvent::Handle->new (fh => \*STDIN);	28	my $handle =
31
32	#TODO
33
34	# or use the constructor to pass the callback:
35
36	my $ae_fh2 =
37	AnyEvent::Handle->new (	29	AnyEvent::Handle->new (
38	fh => \*STDIN,	30	fh => \*STDIN,
39	on_eof => sub {	31	on_eof => sub {
40	$cv->broadcast;	32	$cv->broadcast;
41	},	33	},
42	#TODO
43	);	34	);
44		35
45	$cv->wait;	36	# send some request line
		37	$handle->push_write ("getinfo\015\012");
		38
		39	# read the response line
		40	$handle->push_read (line => sub {
		41	my ($handle, $line) = @_;
		42	warn "read line <$line>\n";
		43	$cv->send;
		44	});
		45
		46	$cv->recv;
46		47
47	=head1 DESCRIPTION	48	=head1 DESCRIPTION
48		49
49	This module is a helper module to make it easier to do event-based I/O on	50	This module is a helper module to make it easier to do event-based I/O on
50	filehandles. For utility functions for doing non-blocking connects and accepts	51	filehandles. For utility functions for doing non-blocking connects and accepts
…		…
72	The filehandle this L<AnyEvent::Handle> object will operate on.	73	The filehandle this L<AnyEvent::Handle> object will operate on.
73		74
74	NOTE: The filehandle will be set to non-blocking (using	75	NOTE: The filehandle will be set to non-blocking (using
75	AnyEvent::Util::fh_nonblocking).	76	AnyEvent::Util::fh_nonblocking).
76		77
77	=item on_eof => $cb->($self)	78	=item on_eof => $cb->($handle)
78		79
79	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.
80		83
81	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,
82	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
83	waiting for data.	86	waiting for data.
84		87
85	=item on_error => $cb->($self)	88	=item on_error => $cb->($handle, $fatal)
86		89
87	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
88	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
89	or a read error.	92	connect or a read error.
90		93
91	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
92	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.
93		99
94	On callback entrance, the value of C<$!> contains the operating system	100	On callback entrance, the value of C<$!> contains the operating system
95	error (or C<ENOSPC>, C<EPIPE> or C<EBADMSG>).	101	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).
96		102
97	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
98	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
99	die.	105	C<croak>.
100		106
101	=item on_read => $cb->($self)	107	=item on_read => $cb->($handle)
102		108
103	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
104	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).
105		113
106	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 >>
107	method or access the C<$self->{rbuf}> member directly.	115	method or access the C<$handle->{rbuf}> member directly.
108		116
109	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
110	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
111	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
112	error will be raised (with C<$!> set to C<EPIPE>).	120	error will be raised (with C<$!> set to C<EPIPE>).
113		121
114	=item on_drain => $cb->()	122	=item on_drain => $cb->($handle)
115		123
116	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
117	(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).
118		126
119	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.
120		148
121	=item rbuf_max => <bytes>	149	=item rbuf_max => <bytes>
122		150
123	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>)
124	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
…		…
131	isn't finished).	159	isn't finished).
132		160
133	=item read_size => <bytes>	161	=item read_size => <bytes>
134		162
135	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
136	on each [loop iteration). Default: C<4096>.	164	during each (loop iteration). Default: C<8192>.
137		165
138	=item low_water_mark => <bytes>	166	=item low_water_mark => <bytes>
139		167
140	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
141	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
…		…
164		192
165	Use the given Net::SSLeay::CTX object to create the new TLS connection	193	Use the given Net::SSLeay::CTX object to create the new TLS connection
166	(unless a connection object was specified directly). If this parameter is	194	(unless a connection object was specified directly). If this parameter is
167	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.	195	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
168		196
		197	=item json => JSON or JSON::XS object
		198
		199	This is the json coder object used by the C<json> read and write types.
		200
		201	If you don't supply it, then AnyEvent::Handle will create and use a
		202	suitable one, which will write and expect UTF-8 encoded JSON texts.
		203
		204	Note that you are responsible to depend on the JSON module if you want to
		205	use this functionality, as AnyEvent does not have a dependency itself.
		206
		207	=item filter_r => $cb
		208
		209	=item filter_w => $cb
		210
		211	These exist, but are undocumented at this time.
		212
169	=back	213	=back
170		214
171	=cut	215	=cut
172		216
173	sub new {	217	sub new {
…		…
182	if ($self->{tls}) {	226	if ($self->{tls}) {
183	require Net::SSLeay;	227	require Net::SSLeay;
184	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});	228	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});
185	}	229	}
186		230
187	$self->on_eof (delete $self->{on_eof} ) if $self->{on_eof};	231	$self->{_activity} = AnyEvent->now;
188	$self->on_error (delete $self->{on_error}) if $self->{on_error};	232	$self->_timeout;
		233
189	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	234	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};
190	$self->on_read (delete $self->{on_read} ) if $self->{on_read};
191
192	$self->start_read;
193		235
194	$self	236	$self
195	}	237	}
196		238
197	sub _shutdown {	239	sub _shutdown {
198	my ($self) = @_;	240	my ($self) = @_;
199		241
		242	delete $self->{_tw};
200	delete $self->{rw};	243	delete $self->{_rw};
201	delete $self->{ww};	244	delete $self->{_ww};
202	delete $self->{fh};	245	delete $self->{fh};
203	}
204		246
		247	$self->stoptls;
		248	}
		249
205	sub error {	250	sub _error {
206	my ($self) = @_;	251	my ($self, $errno, $fatal) = @_;
207		252
208	{
209	local $!;
210	$self->_shutdown;	253	$self->_shutdown
211	}	254	if $fatal;
		255
		256	$! = $errno;
212		257
213	if ($self->{on_error}) {	258	if ($self->{on_error}) {
214	$self->{on_error}($self);	259	$self->{on_error}($self, $fatal);
215	} else {	260	} else {
216	Carp::croak "AnyEvent::Handle uncaught fatal error: $!";	261	Carp::croak "AnyEvent::Handle uncaught error: $!";
217	}	262	}
218	}	263	}
219		264
220	=item $fh = $handle->fh	265	=item $fh = $handle->fh
221		266
222	This method returns the file handle of the L<AnyEvent::Handle> object.	267	This method returns the file handle of the L<AnyEvent::Handle> object.
223		268
224	=cut	269	=cut
225		270
226	sub fh { $_[0]->{fh} }	271	sub fh { $_[0]{fh} }
227		272
228	=item $handle->on_error ($cb)	273	=item $handle->on_error ($cb)
229		274
230	Replace the current C<on_error> callback (see the C<on_error> constructor argument).	275	Replace the current C<on_error> callback (see the C<on_error> constructor argument).
231		276
…		…
241		286
242	=cut	287	=cut
243		288
244	sub on_eof {	289	sub on_eof {
245	$_[0]{on_eof} = $_[1];	290	$_[0]{on_eof} = $_[1];
		291	}
		292
		293	=item $handle->on_timeout ($cb)
		294
		295	Replace the current C<on_timeout> callback, or disables the callback
		296	(but not the timeout) if C<$cb> = C<undef>. See C<timeout> constructor
		297	argument.
		298
		299	=cut
		300
		301	sub on_timeout {
		302	$_[0]{on_timeout} = $_[1];
		303	}
		304
		305	#############################################################################
		306
		307	=item $handle->timeout ($seconds)
		308
		309	Configures (or disables) the inactivity timeout.
		310
		311	=cut
		312
		313	sub timeout {
		314	my ($self, $timeout) = @_;
		315
		316	$self->{timeout} = $timeout;
		317	$self->_timeout;
		318	}
		319
		320	# reset the timeout watcher, as neccessary
		321	# also check for time-outs
		322	sub _timeout {
		323	my ($self) = @_;
		324
		325	if ($self->{timeout}) {
		326	my $NOW = AnyEvent->now;
		327
		328	# when would the timeout trigger?
		329	my $after = $self->{_activity} + $self->{timeout} - $NOW;
		330
		331	# now or in the past already?
		332	if ($after <= 0) {
		333	$self->{_activity} = $NOW;
		334
		335	if ($self->{on_timeout}) {
		336	$self->{on_timeout}($self);
		337	} else {
		338	$self->_error (&Errno::ETIMEDOUT);
		339	}
		340
		341	# callback could have changed timeout value, optimise
		342	return unless $self->{timeout};
		343
		344	# calculate new after
		345	$after = $self->{timeout};
		346	}
		347
		348	Scalar::Util::weaken $self;
		349	return unless $self; # ->error could have destroyed $self
		350
		351	$self->{_tw} \|\|= AnyEvent->timer (after => $after, cb => sub {
		352	delete $self->{_tw};
		353	$self->_timeout;
		354	});
		355	} else {
		356	delete $self->{_tw};
		357	}
246	}	358	}
247		359
248	#############################################################################	360	#############################################################################
249		361
250	=back	362	=back
…		…
287	=cut	399	=cut
288		400
289	sub _drain_wbuf {	401	sub _drain_wbuf {
290	my ($self) = @_;	402	my ($self) = @_;
291		403
292	if (!$self->{ww} && length $self->{wbuf}) {	404	if (!$self->{_ww} && length $self->{wbuf}) {
		405
293	Scalar::Util::weaken $self;	406	Scalar::Util::weaken $self;
		407
294	my $cb = sub {	408	my $cb = sub {
295	my $len = syswrite $self->{fh}, $self->{wbuf};	409	my $len = syswrite $self->{fh}, $self->{wbuf};
296		410
297	if ($len >= 0) {	411	if ($len >= 0) {
298	substr $self->{wbuf}, 0, $len, "";	412	substr $self->{wbuf}, 0, $len, "";
		413
		414	$self->{_activity} = AnyEvent->now;
299		415
300	$self->{on_drain}($self)	416	$self->{on_drain}($self)
301	if $self->{low_water_mark} >= length $self->{wbuf}	417	if $self->{low_water_mark} >= length $self->{wbuf}
302	&& $self->{on_drain};	418	&& $self->{on_drain};
303		419
304	delete $self->{ww} unless length $self->{wbuf};	420	delete $self->{_ww} unless length $self->{wbuf};
305	} elsif ($! != EAGAIN && $! != EINTR) {	421	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
306	$self->error;	422	$self->_error ($!, 1);
307	}	423	}
308	};	424	};
309		425
		426	# try to write data immediately
		427	$cb->();
		428
		429	# if still data left in wbuf, we need to poll
310	$self->{ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb);	430	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)
311		431	if length $self->{wbuf};
312	$cb->($self);
313	};	432	};
314	}	433	}
315		434
316	our %WH;	435	our %WH;
317		436
…		…
328	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")	447	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")
329	->($self, @_);	448	->($self, @_);
330	}	449	}
331		450
332	if ($self->{filter_w}) {	451	if ($self->{filter_w}) {
333	$self->{filter_w}->($self, \$_[0]);	452	$self->{filter_w}($self, \$_[0]);
334	} else {	453	} else {
335	$self->{wbuf} .= $_[0];	454	$self->{wbuf} .= $_[0];
336	$self->_drain_wbuf;	455	$self->_drain_wbuf;
337	}	456	}
338	}	457	}
339		458
340	=item $handle->push_write (type => @args)	459	=item $handle->push_write (type => @args)
341		460
342	=item $handle->unshift_write (type => @args)
343
344	Instead of formatting your data yourself, you can also let this module do	461	Instead of formatting your data yourself, you can also let this module do
345	the job by specifying a type and type-specific arguments.	462	the job by specifying a type and type-specific arguments.
346		463
347	Predefined types are (if you have ideas for additional types, feel free to	464	Predefined types are (if you have ideas for additional types, feel free to
348	drop by and tell us):	465	drop by and tell us):
…		…
352	=item netstring => $string	469	=item netstring => $string
353		470
354	Formats the given value as netstring	471	Formats the given value as netstring
355	(http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them).	472	(http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them).
356		473
357	=back
358
359	=cut	474	=cut
360		475
361	register_write_type netstring => sub {	476	register_write_type netstring => sub {
362	my ($self, $string) = @_;	477	my ($self, $string) = @_;
363		478
364	sprintf "%d:%s,", (length $string), $string	479	sprintf "%d:%s,", (length $string), $string
365	};	480	};
366		481
		482	=item packstring => $format, $data
		483
		484	An octet string prefixed with an encoded length. The encoding C<$format>
		485	uses the same format as a Perl C<pack> format, but must specify a single
		486	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
		487	optional C<!>, C<< < >> or C<< > >> modifier).
		488
		489	=cut
		490
		491	register_write_type packstring => sub {
		492	my ($self, $format, $string) = @_;
		493
		494	pack "$format/a", $string
		495	};
		496
		497	=item json => $array_or_hashref
		498
		499	Encodes the given hash or array reference into a JSON object. Unless you
		500	provide your own JSON object, this means it will be encoded to JSON text
		501	in UTF-8.
		502
		503	JSON objects (and arrays) are self-delimiting, so you can write JSON at
		504	one end of a handle and read them at the other end without using any
		505	additional framing.
		506
		507	The generated JSON text is guaranteed not to contain any newlines: While
		508	this module doesn't need delimiters after or between JSON texts to be
		509	able to read them, many other languages depend on that.
		510
		511	A simple RPC protocol that interoperates easily with others is to send
		512	JSON arrays (or objects, although arrays are usually the better choice as
		513	they mimic how function argument passing works) and a newline after each
		514	JSON text:
		515
		516	$handle->push_write (json => ["method", "arg1", "arg2"]); # whatever
		517	$handle->push_write ("\012");
		518
		519	An AnyEvent::Handle receiver would simply use the C<json> read type and
		520	rely on the fact that the newline will be skipped as leading whitespace:
		521
		522	$handle->push_read (json => sub { my $array = $_[1]; ... });
		523
		524	Other languages could read single lines terminated by a newline and pass
		525	this line into their JSON decoder of choice.
		526
		527	=cut
		528
		529	register_write_type json => sub {
		530	my ($self, $ref) = @_;
		531
		532	require JSON;
		533
		534	$self->{json} ? $self->{json}->encode ($ref)
		535	: JSON::encode_json ($ref)
		536	};
		537
		538	=back
		539
367	=item AnyEvent::Handle::register_write_type type => $coderef->($self, @args)	540	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
368		541
369	This function (not method) lets you add your own types to C<push_write>.	542	This function (not method) lets you add your own types to C<push_write>.
370	Whenever the given C<type> is used, C<push_write> will invoke the code	543	Whenever the given C<type> is used, C<push_write> will invoke the code
371	reference with the handle object and the remaining arguments.	544	reference with the handle object and the remaining arguments.
372		545
…		…
396	enough is there) from the read buffer (C<< $handle->rbuf >>) if you want	569	enough is there) from the read buffer (C<< $handle->rbuf >>) if you want
397	or not.	570	or not.
398		571
399	In the more complex case, you want to queue multiple callbacks. In this	572	In the more complex case, you want to queue multiple callbacks. In this
400	case, AnyEvent::Handle will call the first queued callback each time new	573	case, AnyEvent::Handle will call the first queued callback each time new
401	data arrives and removes it when it has done its job (see C<push_read>,	574	data arrives (also the first time it is queued) and removes it when it has
402	below).	575	done its job (see C<push_read>, below).
403		576
404	This way you can, for example, push three line-reads, followed by reading	577	This way you can, for example, push three line-reads, followed by reading
405	a chunk of data, and AnyEvent::Handle will execute them in order.	578	a chunk of data, and AnyEvent::Handle will execute them in order.
406		579
407	Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by	580	Example 1: EPP protocol parser. EPP sends 4 byte length info, followed by
408	the specified number of bytes which give an XML datagram.	581	the specified number of bytes which give an XML datagram.
409		582
410	# in the default state, expect some header bytes	583	# in the default state, expect some header bytes
411	$handle->on_read (sub {	584	$handle->on_read (sub {
412	# some data is here, now queue the length-header-read (4 octets)	585	# some data is here, now queue the length-header-read (4 octets)
413	shift->unshift_read_chunk (4, sub {	586	shift->unshift_read (chunk => 4, sub {
414	# header arrived, decode	587	# header arrived, decode
415	my $len = unpack "N", $_[1];	588	my $len = unpack "N", $_[1];
416		589
417	# now read the payload	590	# now read the payload
418	shift->unshift_read_chunk ($len, sub {	591	shift->unshift_read (chunk => $len, sub {
419	my $xml = $_[1];	592	my $xml = $_[1];
420	# handle xml	593	# handle xml
421	});	594	});
422	});	595	});
423	});	596	});
…		…
430		603
431	# request one	604	# request one
432	$handle->push_write ("request 1\015\012");	605	$handle->push_write ("request 1\015\012");
433		606
434	# we expect "ERROR" or "OK" as response, so push a line read	607	# we expect "ERROR" or "OK" as response, so push a line read
435	$handle->push_read_line (sub {	608	$handle->push_read (line => sub {
436	# if we got an "OK", we have to _prepend_ another line,	609	# if we got an "OK", we have to _prepend_ another line,
437	# so it will be read before the second request reads its 64 bytes	610	# so it will be read before the second request reads its 64 bytes
438	# which are already in the queue when this callback is called	611	# which are already in the queue when this callback is called
439	# we don't do this in case we got an error	612	# we don't do this in case we got an error
440	if ($_[1] eq "OK") {	613	if ($_[1] eq "OK") {
441	$_[0]->unshift_read_line (sub {	614	$_[0]->unshift_read (line => sub {
442	my $response = $_[1];	615	my $response = $_[1];
443	...	616	...
444	});	617	});
445	}	618	}
446	});	619	});
447		620
448	# request two	621	# request two
449	$handle->push_write ("request 2\015\012");	622	$handle->push_write ("request 2\015\012");
450		623
451	# simply read 64 bytes, always	624	# simply read 64 bytes, always
452	$handle->push_read_chunk (64, sub {	625	$handle->push_read (chunk => 64, sub {
453	my $response = $_[1];	626	my $response = $_[1];
454	...	627	...
455	});	628	});
456		629
457	=over 4	630	=over 4
458		631
459	=cut	632	=cut
460		633
461	sub _drain_rbuf {	634	sub _drain_rbuf {
462	my ($self) = @_;	635	my ($self) = @_;
		636
		637	local $self->{_in_drain} = 1;
463		638
464	if (	639	if (
465	defined $self->{rbuf_max}	640	defined $self->{rbuf_max}
466	&& $self->{rbuf_max} < length $self->{rbuf}	641	&& $self->{rbuf_max} < length $self->{rbuf}
467	) {	642	) {
468	$! = &Errno::ENOSPC; return $self->error;	643	return $self->_error (&Errno::ENOSPC, 1);
469	}	644	}
470		645
471	return if $self->{in_drain};	646	while () {
472	local $self->{in_drain} = 1;
473
474	while (my $len = length $self->{rbuf}) {
475	no strict 'refs';	647	no strict 'refs';
		648
		649	my $len = length $self->{rbuf};
		650
476	if (my $cb = shift @{ $self->{queue} }) {	651	if (my $cb = shift @{ $self->{_queue} }) {
477	unless ($cb->($self)) {	652	unless ($cb->($self)) {
478	if ($self->{eof}) {	653	if ($self->{_eof}) {
479	# no progress can be made (not enough data and no data forthcoming)	654	# no progress can be made (not enough data and no data forthcoming)
480	$! = &Errno::EPIPE; return $self->error;	655	$self->_error (&Errno::EPIPE, 1), last;
481	}	656	}
482		657
483	unshift @{ $self->{queue} }, $cb;	658	unshift @{ $self->{_queue} }, $cb;
484	return;	659	last;
485	}	660	}
486	} elsif ($self->{on_read}) {	661	} elsif ($self->{on_read}) {
		662	last unless $len;
		663
487	$self->{on_read}($self);	664	$self->{on_read}($self);
488		665
489	if (	666	if (
490	$self->{eof} # if no further data will arrive
491	&& $len == length $self->{rbuf} # and no data has been consumed	667	$len == length $self->{rbuf} # if no data has been consumed
492	&& !@{ $self->{queue} } # and the queue is still empty	668	&& !@{ $self->{_queue} } # and the queue is still empty
493	&& $self->{on_read} # and we still want to read data	669	&& $self->{on_read} # but we still have on_read
494	) {	670	) {
		671	# no further data will arrive
495	# then no progress can be made	672	# so no progress can be made
496	$! = &Errno::EPIPE; return $self->error;	673	$self->_error (&Errno::EPIPE, 1), last
		674	if $self->{_eof};
		675
		676	last; # more data might arrive
497	}	677	}
498	} else {	678	} else {
499	# read side becomes idle	679	# read side becomes idle
500	delete $self->{rw};	680	delete $self->{_rw};
501	return;	681	last;
502	}	682	}
503	}	683	}
504		684
505	if ($self->{eof}) {
506	$self->_shutdown;
507	$self->{on_eof}($self)	685	$self->{on_eof}($self)
508	if $self->{on_eof};	686	if $self->{_eof} && $self->{on_eof};
		687
		688	# may need to restart read watcher
		689	unless ($self->{_rw}) {
		690	$self->start_read
		691	if $self->{on_read} \|\| @{ $self->{_queue} };
509	}	692	}
510	}	693	}
511		694
512	=item $handle->on_read ($cb)	695	=item $handle->on_read ($cb)
513		696
…		…
519		702
520	sub on_read {	703	sub on_read {
521	my ($self, $cb) = @_;	704	my ($self, $cb) = @_;
522		705
523	$self->{on_read} = $cb;	706	$self->{on_read} = $cb;
		707	$self->_drain_rbuf if $cb && !$self->{_in_drain};
524	}	708	}
525		709
526	=item $handle->rbuf	710	=item $handle->rbuf
527		711
528	Returns the read buffer (as a modifiable lvalue).	712	Returns the read buffer (as a modifiable lvalue).
…		…
576		760
577	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")	761	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
578	->($self, $cb, @_);	762	->($self, $cb, @_);
579	}	763	}
580		764
581	push @{ $self->{queue} }, $cb;	765	push @{ $self->{_queue} }, $cb;
582	$self->_drain_rbuf;	766	$self->_drain_rbuf unless $self->{_in_drain};
583	}	767	}
584		768
585	sub unshift_read {	769	sub unshift_read {
586	my $self = shift;	770	my $self = shift;
587	my $cb = pop;	771	my $cb = pop;
…		…
592	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")	776	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")
593	->($self, $cb, @_);	777	->($self, $cb, @_);
594	}	778	}
595		779
596		780
597	unshift @{ $self->{queue} }, $cb;	781	unshift @{ $self->{_queue} }, $cb;
598	$self->_drain_rbuf;	782	$self->_drain_rbuf unless $self->{_in_drain};
599	}	783	}
600		784
601	=item $handle->push_read (type => @args, $cb)	785	=item $handle->push_read (type => @args, $cb)
602		786
603	=item $handle->unshift_read (type => @args, $cb)	787	=item $handle->unshift_read (type => @args, $cb)
…		…
609	Predefined types are (if you have ideas for additional types, feel free to	793	Predefined types are (if you have ideas for additional types, feel free to
610	drop by and tell us):	794	drop by and tell us):
611		795
612	=over 4	796	=over 4
613		797
614	=item chunk => $octets, $cb->($self, $data)	798	=item chunk => $octets, $cb->($handle, $data)
615		799
616	Invoke the callback only once C<$octets> bytes have been read. Pass the	800	Invoke the callback only once C<$octets> bytes have been read. Pass the
617	data read to the callback. The callback will never be called with less	801	data read to the callback. The callback will never be called with less
618	data.	802	data.
619		803
…		…
642		826
643	sub unshift_read_chunk {	827	sub unshift_read_chunk {
644	$_[0]->unshift_read (chunk => $_[1], $_[2]);	828	$_[0]->unshift_read (chunk => $_[1], $_[2]);
645	}	829	}
646		830
647	=item line => [$eol, ]$cb->($self, $line, $eol)	831	=item line => [$eol, ]$cb->($handle, $line, $eol)
648		832
649	The callback will be called only once a full line (including the end of	833	The callback will be called only once a full line (including the end of
650	line marker, C<$eol>) has been read. This line (excluding the end of line	834	line marker, C<$eol>) has been read. This line (excluding the end of line
651	marker) will be passed to the callback as second argument (C<$line>), and	835	marker) will be passed to the callback as second argument (C<$line>), and
652	the end of line marker as the third argument (C<$eol>).	836	the end of line marker as the third argument (C<$eol>).
…		…
689	sub unshift_read_line {	873	sub unshift_read_line {
690	my $self = shift;	874	my $self = shift;
691	$self->unshift_read (line => @_);	875	$self->unshift_read (line => @_);
692	}	876	}
693		877
		878	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
		879
		880	Makes a regex match against the regex object C<$accept> and returns
		881	everything up to and including the match.
		882
		883	Example: read a single line terminated by '\n'.
		884
		885	$handle->push_read (regex => qr<\n>, sub { ... });
		886
		887	If C<$reject> is given and not undef, then it determines when the data is
		888	to be rejected: it is matched against the data when the C<$accept> regex
		889	does not match and generates an C<EBADMSG> error when it matches. This is
		890	useful to quickly reject wrong data (to avoid waiting for a timeout or a
		891	receive buffer overflow).
		892
		893	Example: expect a single decimal number followed by whitespace, reject
		894	anything else (not the use of an anchor).
		895
		896	$handle->push_read (regex => qr<^[0-9]+\s>, qr<[^0-9]>, sub { ... });
		897
		898	If C<$skip> is given and not C<undef>, then it will be matched against
		899	the receive buffer when neither C<$accept> nor C<$reject> match,
		900	and everything preceding and including the match will be accepted
		901	unconditionally. This is useful to skip large amounts of data that you
		902	know cannot be matched, so that the C<$accept> or C<$reject> regex do not
		903	have to start matching from the beginning. This is purely an optimisation
		904	and is usually worth only when you expect more than a few kilobytes.
		905
		906	Example: expect a http header, which ends at C<\015\012\015\012>. Since we
		907	expect the header to be very large (it isn't in practise, but...), we use
		908	a skip regex to skip initial portions. The skip regex is tricky in that
		909	it only accepts something not ending in either \015 or \012, as these are
		910	required for the accept regex.
		911
		912	$handle->push_read (regex =>
		913	qr<\015\012\015\012>,
		914	undef, # no reject
		915	qr<^.*[^\015\012]>,
		916	sub { ... });
		917
		918	=cut
		919
		920	register_read_type regex => sub {
		921	my ($self, $cb, $accept, $reject, $skip) = @_;
		922
		923	my $data;
		924	my $rbuf = \$self->{rbuf};
		925
		926	sub {
		927	# accept
		928	if ($$rbuf =~ $accept) {
		929	$data .= substr $$rbuf, 0, $+[0], "";
		930	$cb->($self, $data);
		931	return 1;
		932	}
		933
		934	# reject
		935	if ($reject && $$rbuf =~ $reject) {
		936	$self->_error (&Errno::EBADMSG);
		937	}
		938
		939	# skip
		940	if ($skip && $$rbuf =~ $skip) {
		941	$data .= substr $$rbuf, 0, $+[0], "";
		942	}
		943
		944	()
		945	}
		946	};
		947
694	=item netstring => $cb->($string)	948	=item netstring => $cb->($handle, $string)
695		949
696	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).	950	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
697		951
698	Throws an error with C<$!> set to EBADMSG on format violations.	952	Throws an error with C<$!> set to EBADMSG on format violations.
699		953
…		…
703	my ($self, $cb) = @_;	957	my ($self, $cb) = @_;
704		958
705	sub {	959	sub {
706	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {	960	unless ($_[0]{rbuf} =~ s/^(0\|[1-9][0-9]*)://) {
707	if ($_[0]{rbuf} =~ /[^0-9]/) {	961	if ($_[0]{rbuf} =~ /[^0-9]/) {
708	$! = &Errno::EBADMSG;	962	$self->_error (&Errno::EBADMSG);
709	$self->error;
710	}	963	}
711	return;	964	return;
712	}	965	}
713		966
714	my $len = $1;	967	my $len = $1;
…		…
717	my $string = $_[1];	970	my $string = $_[1];
718	$_[0]->unshift_read (chunk => 1, sub {	971	$_[0]->unshift_read (chunk => 1, sub {
719	if ($_[1] eq ",") {	972	if ($_[1] eq ",") {
720	$cb->($_[0], $string);	973	$cb->($_[0], $string);
721	} else {	974	} else {
722	$! = &Errno::EBADMSG;	975	$self->_error (&Errno::EBADMSG);
723	$self->error;
724	}	976	}
725	});	977	});
726	});	978	});
727		979
728	1	980	1
729	}	981	}
730	};	982	};
731		983
		984	=item packstring => $format, $cb->($handle, $string)
		985
		986	An octet string prefixed with an encoded length. The encoding C<$format>
		987	uses the same format as a Perl C<pack> format, but must specify a single
		988	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
		989	optional C<!>, C<< < >> or C<< > >> modifier).
		990
		991	DNS over TCP uses a prefix of C<n>, EPP uses a prefix of C<N>.
		992
		993	Example: read a block of data prefixed by its length in BER-encoded
		994	format (very efficient).
		995
		996	$handle->push_read (packstring => "w", sub {
		997	my ($handle, $data) = @_;
		998	});
		999
		1000	=cut
		1001
		1002	register_read_type packstring => sub {
		1003	my ($self, $cb, $format) = @_;
		1004
		1005	sub {
		1006	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
		1007	defined (my $len = eval { unpack $format, $_[0]->{rbuf} })
		1008	or return;
		1009
		1010	# remove prefix
		1011	substr $_[0]->{rbuf}, 0, (length pack $format, $len), "";
		1012
		1013	# read rest
		1014	$_[0]->unshift_read (chunk => $len, $cb);
		1015
		1016	1
		1017	}
		1018	};
		1019
		1020	=item json => $cb->($handle, $hash_or_arrayref)
		1021
		1022	Reads a JSON object or array, decodes it and passes it to the callback.
		1023
		1024	If a C<json> object was passed to the constructor, then that will be used
		1025	for the final decode, otherwise it will create a JSON coder expecting UTF-8.
		1026
		1027	This read type uses the incremental parser available with JSON version
		1028	2.09 (and JSON::XS version 2.2) and above. You have to provide a
		1029	dependency on your own: this module will load the JSON module, but
		1030	AnyEvent does not depend on it itself.
		1031
		1032	Since JSON texts are fully self-delimiting, the C<json> read and write
		1033	types are an ideal simple RPC protocol: just exchange JSON datagrams. See
		1034	the C<json> write type description, above, for an actual example.
		1035
		1036	=cut
		1037
		1038	register_read_type json => sub {
		1039	my ($self, $cb, $accept, $reject, $skip) = @_;
		1040
		1041	require JSON;
		1042
		1043	my $data;
		1044	my $rbuf = \$self->{rbuf};
		1045
		1046	my $json = $self->{json} \|\|= JSON->new->utf8;
		1047
		1048	sub {
		1049	my $ref = $json->incr_parse ($self->{rbuf});
		1050
		1051	if ($ref) {
		1052	$self->{rbuf} = $json->incr_text;
		1053	$json->incr_text = "";
		1054	$cb->($self, $ref);
		1055
		1056	1
		1057	} else {
		1058	$self->{rbuf} = "";
		1059	()
		1060	}
		1061	}
		1062	};
		1063
732	=back	1064	=back
733		1065
734	=item AnyEvent::Handle::register_read_type type => $coderef->($self, $cb, @args)	1066	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)
735		1067
736	This function (not method) lets you add your own types to C<push_read>.	1068	This function (not method) lets you add your own types to C<push_read>.
737		1069
738	Whenever the given C<type> is used, C<push_read> will invoke the code	1070	Whenever the given C<type> is used, C<push_read> will invoke the code
739	reference with the handle object, the callback and the remaining	1071	reference with the handle object, the callback and the remaining
…		…
741		1073
742	The code reference is supposed to return a callback (usually a closure)	1074	The code reference is supposed to return a callback (usually a closure)
743	that works as a plain read callback (see C<< ->push_read ($cb) >>).	1075	that works as a plain read callback (see C<< ->push_read ($cb) >>).
744		1076
745	It should invoke the passed callback when it is done reading (remember to	1077	It should invoke the passed callback when it is done reading (remember to
746	pass C<$self> as first argument as all other callbacks do that).	1078	pass C<$handle> as first argument as all other callbacks do that).
747		1079
748	Note that this is a function, and all types registered this way will be	1080	Note that this is a function, and all types registered this way will be
749	global, so try to use unique names.	1081	global, so try to use unique names.
750		1082
751	For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>,	1083	For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>,
…		…
754	=item $handle->stop_read	1086	=item $handle->stop_read
755		1087
756	=item $handle->start_read	1088	=item $handle->start_read
757		1089
758	In rare cases you actually do not want to read anything from the	1090	In rare cases you actually do not want to read anything from the
759	socket. In this case you can call C<stop_read>. Neither C<on_read> no	1091	socket. In this case you can call C<stop_read>. Neither C<on_read> nor
760	any queued callbacks will be executed then. To start reading again, call	1092	any queued callbacks will be executed then. To start reading again, call
761	C<start_read>.	1093	C<start_read>.
762		1094
		1095	Note that AnyEvent::Handle will automatically C<start_read> for you when
		1096	you change the C<on_read> callback or push/unshift a read callback, and it
		1097	will automatically C<stop_read> for you when neither C<on_read> is set nor
		1098	there are any read requests in the queue.
		1099
763	=cut	1100	=cut
764		1101
765	sub stop_read {	1102	sub stop_read {
766	my ($self) = @_;	1103	my ($self) = @_;
767		1104
768	delete $self->{rw};	1105	delete $self->{_rw};
769	}	1106	}
770		1107
771	sub start_read {	1108	sub start_read {
772	my ($self) = @_;	1109	my ($self) = @_;
773		1110
774	unless ($self->{rw} \|\| $self->{eof}) {	1111	unless ($self->{_rw} \|\| $self->{_eof}) {
775	Scalar::Util::weaken $self;	1112	Scalar::Util::weaken $self;
776		1113
777	$self->{rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1114	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
778	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};	1115	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};
779	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;	1116	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} \|\| 8192, length $$rbuf;
780		1117
781	if ($len > 0) {	1118	if ($len > 0) {
		1119	$self->{_activity} = AnyEvent->now;
		1120
782	$self->{filter_r}	1121	$self->{filter_r}
783	? $self->{filter_r}->($self, $rbuf)	1122	? $self->{filter_r}($self, $rbuf)
784	: $self->_drain_rbuf;	1123	: $self->{_in_drain} \|\| $self->_drain_rbuf;
785		1124
786	} elsif (defined $len) {	1125	} elsif (defined $len) {
787	delete $self->{rw};	1126	delete $self->{_rw};
788	$self->{eof} = 1;	1127	$self->{_eof} = 1;
789	$self->_drain_rbuf;	1128	$self->_drain_rbuf unless $self->{_in_drain};
790		1129
791	} elsif ($! != EAGAIN && $! != EINTR) {	1130	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
792	return $self->error;	1131	return $self->_error ($!, 1);
793	}	1132	}
794	});	1133	});
795	}	1134	}
796	}	1135	}
797		1136
798	sub _dotls {	1137	sub _dotls {
799	my ($self) = @_;	1138	my ($self) = @_;
800		1139
		1140	my $buf;
		1141
801	if (length $self->{tls_wbuf}) {	1142	if (length $self->{_tls_wbuf}) {
802	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{tls_wbuf})) > 0) {	1143	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
803	substr $self->{tls_wbuf}, 0, $len, "";	1144	substr $self->{_tls_wbuf}, 0, $len, "";
804	}	1145	}
805	}	1146	}
806		1147
807	if (defined (my $buf = Net::SSLeay::BIO_read ($self->{tls_wbio}))) {	1148	if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {
808	$self->{wbuf} .= $buf;	1149	$self->{wbuf} .= $buf;
809	$self->_drain_wbuf;	1150	$self->_drain_wbuf;
810	}	1151	}
811		1152
812	while (defined (my $buf = Net::SSLeay::read ($self->{tls}))) {	1153	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {
		1154	if (length $buf) {
813	$self->{rbuf} .= $buf;	1155	$self->{rbuf} .= $buf;
814	$self->_drain_rbuf;	1156	$self->_drain_rbuf unless $self->{_in_drain};
		1157	} else {
		1158	# let's treat SSL-eof as we treat normal EOF
		1159	$self->{_eof} = 1;
		1160	$self->_shutdown;
		1161	return;
		1162	}
815	}	1163	}
816		1164
817	my $err = Net::SSLeay::get_error ($self->{tls}, -1);	1165	my $err = Net::SSLeay::get_error ($self->{tls}, -1);
818		1166
819	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {	1167	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
820	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {	1168	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {
821	$self->error;	1169	return $self->_error ($!, 1);
822	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {	1170	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {
823	$! = &Errno::EIO;	1171	return $self->_error (&Errno::EIO, 1);
824	$self->error;
825	}	1172	}
826		1173
827	# all others are fine for our purposes	1174	# all others are fine for our purposes
828	}	1175	}
829	}	1176	}
…		…
838	C<"connect">, C<"accept"> or an existing Net::SSLeay object).	1185	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
839		1186
840	The second argument is the optional C<Net::SSLeay::CTX> object that is	1187	The second argument is the optional C<Net::SSLeay::CTX> object that is
841	used when AnyEvent::Handle has to create its own TLS connection object.	1188	used when AnyEvent::Handle has to create its own TLS connection object.
842		1189
843	=cut	1190	The TLS connection object will end up in C<< $handle->{tls} >> after this
		1191	call and can be used or changed to your liking. Note that the handshake
		1192	might have already started when this function returns.
844		1193
845	# TODO: maybe document...	1194	=cut
		1195
846	sub starttls {	1196	sub starttls {
847	my ($self, $ssl, $ctx) = @_;	1197	my ($self, $ssl, $ctx) = @_;
848		1198
849	$self->stoptls;	1199	$self->stoptls;
850		1200
…		…
862	# but the openssl maintainers basically said: "trust us, it just works".	1212	# but the openssl maintainers basically said: "trust us, it just works".
863	# (unfortunately, we have to hardcode constants because the abysmally misdesigned	1213	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
864	# and mismaintained ssleay-module doesn't even offer them).	1214	# and mismaintained ssleay-module doesn't even offer them).
865	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html	1215	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
866	Net::SSLeay::CTX_set_mode ($self->{tls},	1216	Net::SSLeay::CTX_set_mode ($self->{tls},
867	(eval { Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)	1217	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } \|\| 1)
868	\| (eval { Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));	1218	\| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } \|\| 2));
869		1219
870	$self->{tls_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1220	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
871	$self->{tls_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());	1221	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
872		1222
873	Net::SSLeay::set_bio ($ssl, $self->{tls_rbio}, $self->{tls_wbio});	1223	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
874		1224
875	$self->{filter_w} = sub {	1225	$self->{filter_w} = sub {
876	$_[0]{tls_wbuf} .= ${$_[1]};	1226	$_[0]{_tls_wbuf} .= ${$_[1]};
877	&_dotls;	1227	&_dotls;
878	};	1228	};
879	$self->{filter_r} = sub {	1229	$self->{filter_r} = sub {
880	Net::SSLeay::BIO_write ($_[0]{tls_rbio}, ${$_[1]});	1230	Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});
881	&_dotls;	1231	&_dotls;
882	};	1232	};
883	}	1233	}
884		1234
885	=item $handle->stoptls	1235	=item $handle->stoptls
…		…
891		1241
892	sub stoptls {	1242	sub stoptls {
893	my ($self) = @_;	1243	my ($self) = @_;
894		1244
895	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};	1245	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};
		1246
896	delete $self->{tls_rbio};	1247	delete $self->{_rbio};
897	delete $self->{tls_wbio};	1248	delete $self->{_wbio};
898	delete $self->{tls_wbuf};	1249	delete $self->{_tls_wbuf};
899	delete $self->{filter_r};	1250	delete $self->{filter_r};
900	delete $self->{filter_w};	1251	delete $self->{filter_w};
901	}	1252	}
902		1253
903	sub DESTROY {	1254	sub DESTROY {
…		…
941	}	1292	}
942	}	1293	}
943		1294
944	=back	1295	=back
945		1296
		1297	=head1 SUBCLASSING AnyEvent::Handle
		1298
		1299	In many cases, you might want to subclass AnyEvent::Handle.
		1300
		1301	To make this easier, a given version of AnyEvent::Handle uses these
		1302	conventions:
		1303
		1304	=over 4
		1305
		1306	=item * all constructor arguments become object members.
		1307
		1308	At least initially, when you pass a C<tls>-argument to the constructor it
		1309	will end up in C<< $handle->{tls} >>. Those members might be changes or
		1310	mutated later on (for example C<tls> will hold the TLS connection object).
		1311
		1312	=item * other object member names are prefixed with an C<_>.
		1313
		1314	All object members not explicitly documented (internal use) are prefixed
		1315	with an underscore character, so the remaining non-C<_>-namespace is free
		1316	for use for subclasses.
		1317
		1318	=item * all members not documented here and not prefixed with an underscore
		1319	are free to use in subclasses.
		1320
		1321	Of course, new versions of AnyEvent::Handle may introduce more "public"
		1322	member variables, but thats just life, at least it is documented.
		1323
		1324	=back
		1325
946	=head1 AUTHOR	1326	=head1 AUTHOR
947		1327
948	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.	1328	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.
949		1329
950	=cut	1330	=cut

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.30 by root, Sat May 24 23:56:26 2008 UTC vs. Revision 1.61 by root, Fri Jun 6 10:23:50 2008 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.30 by root, Sat May 24 23:56:26 2008 UTC vs.
Revision 1.61 by root, Fri Jun 6 10:23:50 2008 UTC