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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.34 by root, Mon May 26 03:27:52 2008 UTC vs.
Revision 1.77 by root, Sun Jul 27 07:25:39 2008 UTC

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

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents): Revision 1.34 by root, Mon May 26 03:27:52 2008 UTC vs. Revision 1.77 by root, Sun Jul 27 07:25:39 2008 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Handle.pm (file contents):
Revision 1.34 by root, Mon May 26 03:27:52 2008 UTC vs.
Revision 1.77 by root, Sun Jul 27 07:25:39 2008 UTC