ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/AnyEvent/lib/AnyEvent/Handle.pm

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

Diff Legend

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