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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.39 by root, Tue May 27 04:59:51 2008 UTC vs.
Revision 1.82 by root, Thu Aug 21 18:45:16 2008 UTC

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

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.39 by root, Tue May 27 04:59:51 2008 UTC vs. Revision 1.82 by root, Thu Aug 21 18:45:16 2008 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.39 by root, Tue May 27 04:59:51 2008 UTC vs.
Revision 1.82 by root, Thu Aug 21 18:45:16 2008 UTC