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.11 by root, Sun May 11 17:54:13 2008 UTC vs.
Revision 1.74 by root, Fri Jul 18 01:29:58 2008 UTC

…		…
2		2
3	no warnings;	3	no warnings;
4	use strict;	4	use strict;
5		5
6	use AnyEvent ();	6	use AnyEvent ();
7	use AnyEvent::Util ();	7	use AnyEvent::Util qw(WSAEWOULDBLOCK);
8	use Scalar::Util ();	8	use Scalar::Util ();
9	use Carp ();	9	use Carp ();
10	use Fcntl ();	10	use Fcntl ();
11	use Errno qw/EAGAIN EINTR/;	11	use Errno qw(EAGAIN EINTR);
12		12
13	=head1 NAME	13	=head1 NAME
14		14
15	AnyEvent::Handle - non-blocking I/O on filehandles 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.02';	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;
25		25
26	my $cv = AnyEvent->condvar;	26	my $cv = AnyEvent->condvar;
27		27
28	my $ae_fh = AnyEvent::Handle->new (fh => \*STDIN);	28	my $handle =
29
30	#TODO
31
32	# or use the constructor to pass the callback:
33
34	my $ae_fh2 =
35	AnyEvent::Handle->new (	29	AnyEvent::Handle->new (
36	fh => \*STDIN,	30	fh => \*STDIN,
37	on_eof => sub {	31	on_eof => sub {
38	$cv->broadcast;	32	$cv->broadcast;
39	},	33	},
40	#TODO
41	);	34	);
42		35
43	$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;
44		47
45	=head1 DESCRIPTION	48	=head1 DESCRIPTION
46		49
47	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
48	filehandles (and sockets, see L<AnyEvent::Socket> for an easy way to make	51	filehandles. For utility functions for doing non-blocking connects and accepts
49	non-blocking resolves and connects).	52	on sockets see L<AnyEvent::Util>.
50		53
51	In the following, when the documentation refers to of "bytes" then this	54	In the following, when the documentation refers to of "bytes" then this
52	means characters. As sysread and syswrite are used for all I/O, their	55	means characters. As sysread and syswrite are used for all I/O, their
53	treatment of characters applies to this module as well.	56	treatment of characters applies to this module as well.
54		57
…		…
70	The filehandle this L<AnyEvent::Handle> object will operate on.	73	The filehandle this L<AnyEvent::Handle> object will operate on.
71		74
72	NOTE: The filehandle will be set to non-blocking (using	75	NOTE: The filehandle will be set to non-blocking (using
73	AnyEvent::Util::fh_nonblocking).	76	AnyEvent::Util::fh_nonblocking).
74		77
75	=item on_eof => $cb->($self) [MANDATORY]
76
77	Set the callback to be called on EOF.
78
79	=item on_error => $cb->($self)	78	=item on_eof => $cb->($handle)
80		79
		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.
		83
		84	While not mandatory, it is highly recommended to set an eof callback,
		85	otherwise you might end up with a closed socket while you are still
		86	waiting for data.
		87
		88	=item on_error => $cb->($handle, $fatal)
		89
81	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
82	ocurs, 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
83	or a read error.	92	connect or a read error.
84		93
85	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
86	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.
87		99
88	On callback entrance, the value of C<$!> contains the operating system	100	On callback entrance, the value of C<$!> contains the operating system
89	error (or C<ENOSPC> or C<EPIPE>).	101	error (or C<ENOSPC>, C<EPIPE>, C<ETIMEDOUT> or C<EBADMSG>).
90		102
91	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
92	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
93	die.	105	C<croak>.
94		106
95	=item on_read => $cb->($self)	107	=item on_read => $cb->($handle)
96		108
97	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
98	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).
99		113
100	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 >>
101	method or acces sthe C<$self->{rbuf}> member directly.	115	method or access the C<$handle->{rbuf}> member directly.
102		116
103	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
104	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
105	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
106	error will be raised (with C<$!> set to C<EPIPE>).	120	error will be raised (with C<$!> set to C<EPIPE>).
107		121
108	=item on_drain => $cb->()	122	=item on_drain => $cb->($handle)
109		123
110	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
111	(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).
112		126
113	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.
114		154
115	=item rbuf_max => <bytes>	155	=item rbuf_max => <bytes>
116		156
117	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>)
118	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
…		…
122	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
123	(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
124	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
125	isn't finished).	165	isn't finished).
126		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
127	=item read_size => <bytes>	191	=item read_size => <bytes>
128		192
129	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
130	on each [loop iteration). Default: C<4096>.	194	during each (loop iteration). Default: C<8192>.
131		195
132	=item low_water_mark => <bytes>	196	=item low_water_mark => <bytes>
133		197
134	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
135	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
136	considered empty.	200	considered empty.
137		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.
		212
		213	=item tls => "accept" | "connect" | Net::SSLeay::SSL object
		214
		215	When this parameter is given, it enables TLS (SSL) mode, that means it
		216	will start making tls handshake and will transparently encrypt/decrypt
		217	data.
		218
		219	TLS mode requires Net::SSLeay to be installed (it will be loaded
		220	automatically when you try to create a TLS handle).
		221
		222	For the TLS server side, use C<accept>, and for the TLS client side of a
		223	connection, use C<connect> mode.
		224
		225	You can also provide your own TLS connection object, but you have
		226	to make sure that you call either C<Net::SSLeay::set_connect_state>
		227	or C<Net::SSLeay::set_accept_state> on it before you pass it to
		228	AnyEvent::Handle.
		229
		230	See the C<starttls> method if you need to start TLs negotiation later.
		231
		232	=item tls_ctx => $ssl_ctx
		233
		234	Use the given Net::SSLeay::CTX object to create the new TLS connection
		235	(unless a connection object was specified directly). If this parameter is
		236	missing, then AnyEvent::Handle will use C<AnyEvent::Handle::TLS_CTX>.
		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
138	=back	254	=back
139		255
140	=cut	256	=cut
141		257
142	sub new {	258	sub new {
…		…
146		262
147	$self->{fh} or Carp::croak "mandatory argument fh is missing";	263	$self->{fh} or Carp::croak "mandatory argument fh is missing";
148		264
149	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;	265	AnyEvent::Util::fh_nonblocking $self->{fh}, 1;
150		266
151	$self->on_eof ((delete $self->{on_eof} ) or Carp::croak "mandatory argument on_eof is missing");	267	if ($self->{tls}) {
		268	require Net::SSLeay;
		269	$self->starttls (delete $self->{tls}, delete $self->{tls_ctx});
		270	}
152		271
153	$self->on_error (delete $self->{on_error}) if $self->{on_error};	272	$self->{_activity} = AnyEvent->now;
		273	$self->_timeout;
		274
154	$self->on_drain (delete $self->{on_drain}) if $self->{on_drain};	275	$self->on_drain (delete $self->{on_drain}) if exists $self->{on_drain};
155	$self->on_read (delete $self->{on_read} ) if $self->{on_read};	276	$self->no_delay (delete $self->{no_delay}) if exists $self->{no_delay};
156		277
157	$self->start_read;	278	$self->start_read
		279	if $self->{on_read};
158		280
159	$self	281	$self
160	}	282	}
161		283
162	sub _shutdown {	284	sub _shutdown {
163	my ($self) = @_;	285	my ($self) = @_;
164		286
		287	delete $self->{_tw};
165	delete $self->{rw};	288	delete $self->{_rw};
166	delete $self->{ww};	289	delete $self->{_ww};
167	delete $self->{fh};	290	delete $self->{fh};
168	}
169		291
		292	$self->stoptls;
		293	}
		294
170	sub error {	295	sub _error {
171	my ($self) = @_;	296	my ($self, $errno, $fatal) = @_;
172		297
173	{
174	local $!;
175	$self->_shutdown;	298	$self->_shutdown
176	}	299	if $fatal;
		300
		301	$! = $errno;
177		302
178	if ($self->{on_error}) {	303	if ($self->{on_error}) {
179	$self->{on_error}($self);	304	$self->{on_error}($self, $fatal);
180	} else {	305	} else {
181	die "AnyEvent::Handle uncaught fatal error: $!";	306	Carp::croak "AnyEvent::Handle uncaught error: $!";
182	}	307	}
183	}	308	}
184		309
185	=item $fh = $handle->fh	310	=item $fh = $handle->fh
186		311
187	This method returns the filehandle of the L<AnyEvent::Handle> object.	312	This method returns the file handle of the L<AnyEvent::Handle> object.
188		313
189	=cut	314	=cut
190		315
191	sub fh { $_[0]->{fh} }	316	sub fh { $_[0]{fh} }
192		317
193	=item $handle->on_error ($cb)	318	=item $handle->on_error ($cb)
194		319
195	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).
196		321
…		…
208		333
209	sub on_eof {	334	sub on_eof {
210	$_[0]{on_eof} = $_[1];	335	$_[0]{on_eof} = $_[1];
211	}	336	}
212		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	}
		426	}
		427
213	#############################################################################	428	#############################################################################
214		429
215	=back	430	=back
216		431
217	=head2 WRITE QUEUE	432	=head2 WRITE QUEUE
…		…
220	for reading.	435	for reading.
221		436
222	The write queue is very simple: you can add data to its end, and	437	The write queue is very simple: you can add data to its end, and
223	AnyEvent::Handle will automatically try to get rid of it for you.	438	AnyEvent::Handle will automatically try to get rid of it for you.
224		439
225	When data could be writtena nd the write buffer is shorter then the low	440	When data could be written and the write buffer is shorter then the low
226	water mark, the C<on_drain> callback will be invoked.	441	water mark, the C<on_drain> callback will be invoked.
227		442
228	=over 4	443	=over 4
229		444
230	=item $handle->on_drain ($cb)	445	=item $handle->on_drain ($cb)
…		…
249	want (only limited by the available memory), as C<AnyEvent::Handle>	464	want (only limited by the available memory), as C<AnyEvent::Handle>
250	buffers it independently of the kernel.	465	buffers it independently of the kernel.
251		466
252	=cut	467	=cut
253		468
254	sub push_write {	469	sub _drain_wbuf {
255	my ($self, $data) = @_;	470	my ($self) = @_;
256		471
257	$self->{wbuf} .= $data;	472	if (!$self->{_ww} && length $self->{wbuf}) {
258		473
259	unless ($self->{ww}) {
260	Scalar::Util::weaken $self;	474	Scalar::Util::weaken $self;
		475
261	my $cb = sub {	476	my $cb = sub {
262	my $len = syswrite $self->{fh}, $self->{wbuf};	477	my $len = syswrite $self->{fh}, $self->{wbuf};
263		478
264	if ($len > 0) {	479	if ($len >= 0) {
265	substr $self->{wbuf}, 0, $len, "";	480	substr $self->{wbuf}, 0, $len, "";
266		481
		482	$self->{_activity} = AnyEvent->now;
267		483
268	$self->{on_drain}($self)	484	$self->{on_drain}($self)
269	if $self->{low_water_mark} >= length $self->{wbuf}	485	if $self->{low_water_mark} >= length $self->{wbuf}
270	&& $self->{on_drain};	486	&& $self->{on_drain};
271		487
272	delete $self->{ww} unless length $self->{wbuf};	488	delete $self->{_ww} unless length $self->{wbuf};
273	} elsif ($! != EAGAIN && $! != EINTR) {	489	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
274	$self->error;	490	$self->_error ($!, 1);
275	}	491	}
276	};	492	};
277		493
		494	# try to write data immediately
		495	$cb->() unless $self->{autocork};
		496
		497	# if still data left in wbuf, we need to poll
278	$self->{ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb);	498	$self->{_ww} = AnyEvent->io (fh => $self->{fh}, poll => "w", cb => $cb)
279		499	if length $self->{wbuf};
280	$cb->($self);
281	};	500	};
282	}	501	}
		502
		503	our %WH;
		504
		505	sub register_write_type($$) {
		506	$WH{$_[0]} = $_[1];
		507	}
		508
		509	sub push_write {
		510	my $self = shift;
		511
		512	if (@_ > 1) {
		513	my $type = shift;
		514
		515	@_ = ($WH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_write")
		516	->($self, @_);
		517	}
		518
		519	if ($self->{filter_w}) {
		520	$self->{filter_w}($self, \$_[0]);
		521	} else {
		522	$self->{wbuf} .= $_[0];
		523	$self->_drain_wbuf;
		524	}
		525	}
		526
		527	=item $handle->push_write (type => @args)
		528
		529	Instead of formatting your data yourself, you can also let this module do
		530	the job by specifying a type and type-specific arguments.
		531
		532	Predefined types are (if you have ideas for additional types, feel free to
		533	drop by and tell us):
		534
		535	=over 4
		536
		537	=item netstring => $string
		538
		539	Formats the given value as netstring
		540	(http://cr.yp.to/proto/netstrings.txt, this is not a recommendation to use them).
		541
		542	=cut
		543
		544	register_write_type netstring => sub {
		545	my ($self, $string) = @_;
		546
		547	sprintf "%d:%s,", (length $string), $string
		548	};
		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
		623	=item AnyEvent::Handle::register_write_type type => $coderef->($handle, @args)
		624
		625	This function (not method) lets you add your own types to C<push_write>.
		626	Whenever the given C<type> is used, C<push_write> will invoke the code
		627	reference with the handle object and the remaining arguments.
		628
		629	The code reference is supposed to return a single octet string that will
		630	be appended to the write buffer.
		631
		632	Note that this is a function, and all types registered this way will be
		633	global, so try to use unique names.
		634
		635	=cut
283		636
284	#############################################################################	637	#############################################################################
285		638
286	=back	639	=back
287		640
…		…
294	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
295	a queue.	648	a queue.
296		649
297	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
298	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
299	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
300	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).
301		655
302	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
303	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
304	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
305	below).	659	done its job (see C<push_read>, below).
306		660
307	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
308	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.
309		663
310	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
311	the specified number of bytes which give an XML datagram.	665	the specified number of bytes which give an XML datagram.
312		666
313	# in the default state, expect some header bytes	667	# in the default state, expect some header bytes
314	$handle->on_read (sub {	668	$handle->on_read (sub {
315	# 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)
316	shift->unshift_read_chunk (4, sub {	670	shift->unshift_read (chunk => 4, sub {
317	# header arrived, decode	671	# header arrived, decode
318	my $len = unpack "N", $_[1];	672	my $len = unpack "N", $_[1];
319		673
320	# now read the payload	674	# now read the payload
321	shift->unshift_read_chunk ($len, sub {	675	shift->unshift_read (chunk => $len, sub {
322	my $xml = $_[1];	676	my $xml = $_[1];
323	# handle xml	677	# handle xml
324	});	678	});
325	});	679	});
326	});	680	});
327		681
328	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"
329	"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
330	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
331	pipeline sending both requests and manipulate the queue as necessary in	685	just pipeline sending both requests and manipulate the queue as necessary
332	the callbacks:	686	in the callbacks.
333		687
334	# 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"
335	$handle->push_write ("request 1\015\012");	693	$handle->push_write ("request 1\015\012");
336		694
337	# 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
338	$handle->push_read_line (sub {	696	$handle->push_read (line => sub {
339	# if we got an "OK", we have to _prepend_ another line,	697	# if we got an "OK", we have to _prepend_ another line,
340	# 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
341	# which are already in the queue when this callback is called	699	# which are already in the queue when this callback is called
342	# we don't do this in case we got an error	700	# we don't do this in case we got an error
343	if ($_[1] eq "OK") {	701	if ($_[1] eq "OK") {
344	$_[0]->unshift_read_line (sub {	702	$_[0]->unshift_read (line => sub {
345	my $response = $_[1];	703	my $response = $_[1];
346	...	704	...
347	});	705	});
348	}	706	}
349	});	707	});
350		708
351	# request two	709	# request two, simply returns 64 octets
352	$handle->push_write ("request 2\015\012");	710	$handle->push_write ("request 2\015\012");
353		711
354	# simply read 64 bytes, always	712	# simply read 64 bytes, always
355	$handle->push_read_chunk (64, sub {	713	$handle->push_read (chunk => 64, sub {
356	my $response = $_[1];	714	my $response = $_[1];
357	...	715	...
358	});	716	});
359		717
360	=over 4	718	=over 4
…		…
362	=cut	720	=cut
363		721
364	sub _drain_rbuf {	722	sub _drain_rbuf {
365	my ($self) = @_;	723	my ($self) = @_;
366		724
367	return if $self->{in_drain};
368	local $self->{in_drain} = 1;	725	local $self->{_in_drain} = 1;
369		726
370	while (my $len = length $self->{rbuf}) {	727	if (
		728	defined $self->{rbuf_max}
		729	&& $self->{rbuf_max} < length $self->{rbuf}
		730	) {
		731	return $self->_error (&Errno::ENOSPC, 1);
		732	}
		733
		734	while () {
371	no strict 'refs';	735	no strict 'refs';
		736
		737	my $len = length $self->{rbuf};
		738
372	if (my $cb = shift @{ $self->{queue} }) {	739	if (my $cb = shift @{ $self->{_queue} }) {
373	if (!$cb->($self)) {	740	unless ($cb->($self)) {
374	if ($self->{eof}) {	741	if ($self->{_eof}) {
375	# 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)
376	$! = &Errno::EPIPE; return $self->error;	743	$self->_error (&Errno::EPIPE, 1), last;
377	}	744	}
378		745
379	unshift @{ $self->{queue} }, $cb;	746	unshift @{ $self->{_queue} }, $cb;
380	return;	747	last;
381	}	748	}
382	} elsif ($self->{on_read}) {	749	} elsif ($self->{on_read}) {
		750	last unless $len;
		751
383	$self->{on_read}($self);	752	$self->{on_read}($self);
384		753
385	if (	754	if (
386	$self->{eof} # if no further data will arrive
387	&& $len == length $self->{rbuf} # and no data has been consumed	755	$len == length $self->{rbuf} # if no data has been consumed
388	&& !@{ $self->{queue} } # and the queue is still empty	756	&& !@{ $self->{_queue} } # and the queue is still empty
389	&& $self->{on_read} # and we still want to read data	757	&& $self->{on_read} # but we still have on_read
390	) {	758	) {
		759	# no further data will arrive
391	# then no progress can be made	760	# so no progress can be made
392	$! = &Errno::EPIPE; return $self->error;	761	$self->_error (&Errno::EPIPE, 1), last
		762	if $self->{_eof};
		763
		764	last; # more data might arrive
393	}	765	}
394	} else {	766	} else {
395	# read side becomes idle	767	# read side becomes idle
396	delete $self->{rw};	768	delete $self->{_rw};
397	return;	769	last;
398	}	770	}
399	}	771	}
400		772
401	if ($self->{eof}) {
402	$self->_shutdown;
403	$self->{on_eof}($self);	773	$self->{on_eof}($self)
		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} };
404	}	780	}
405	}	781	}
406		782
407	=item $handle->on_read ($cb)	783	=item $handle->on_read ($cb)
408		784
…		…
414		790
415	sub on_read {	791	sub on_read {
416	my ($self, $cb) = @_;	792	my ($self, $cb) = @_;
417		793
418	$self->{on_read} = $cb;	794	$self->{on_read} = $cb;
		795	$self->_drain_rbuf if $cb && !$self->{_in_drain};
419	}	796	}
420		797
421	=item $handle->rbuf	798	=item $handle->rbuf
422		799
423	Returns the read buffer (as a modifiable lvalue).	800	Returns the read buffer (as a modifiable lvalue).
…		…
442	Append the given callback to the end of the queue (C<push_read>) or	819	Append the given callback to the end of the queue (C<push_read>) or
443	prepend it (C<unshift_read>).	820	prepend it (C<unshift_read>).
444		821
445	The callback is called each time some additional read data arrives.	822	The callback is called each time some additional read data arrives.
446		823
447	It must check wether enough data is in the read buffer already.	824	It must check whether enough data is in the read buffer already.
448		825
449	If not enough data is available, it must return the empty list or a false	826	If not enough data is available, it must return the empty list or a false
450	value, in which case it will be called repeatedly until enough data is	827	value, in which case it will be called repeatedly until enough data is
451	available (or an error condition is detected).	828	available (or an error condition is detected).
452		829
…		…
454	interested in (which can be none at all) and return a true value. After returning	831	interested in (which can be none at all) and return a true value. After returning
455	true, it will be removed from the queue.	832	true, it will be removed from the queue.
456		833
457	=cut	834	=cut
458		835
		836	our %RH;
		837
		838	sub register_read_type($$) {
		839	$RH{$_[0]} = $_[1];
		840	}
		841
459	sub push_read {	842	sub push_read {
460	my ($self, $cb) = @_;	843	my $self = shift;
		844	my $cb = pop;
461		845
		846	if (@_) {
		847	my $type = shift;
		848
		849	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::push_read")
		850	->($self, $cb, @_);
		851	}
		852
462	push @{ $self->{queue} }, $cb;	853	push @{ $self->{_queue} }, $cb;
463	$self->_drain_rbuf;	854	$self->_drain_rbuf unless $self->{_in_drain};
464	}	855	}
465		856
466	sub unshift_read {	857	sub unshift_read {
467	my ($self, $cb) = @_;	858	my $self = shift;
		859	my $cb = pop;
468		860
		861	if (@_) {
		862	my $type = shift;
		863
		864	$cb = ($RH{$type} or Carp::croak "unsupported type passed to AnyEvent::Handle::unshift_read")
		865	->($self, $cb, @_);
		866	}
		867
		868
469	push @{ $self->{queue} }, $cb;	869	unshift @{ $self->{_queue} }, $cb;
470	$self->_drain_rbuf;	870	$self->_drain_rbuf unless $self->{_in_drain};
471	}	871	}
472		872
473	=item $handle->push_read_chunk ($len, $cb->($self, $data))	873	=item $handle->push_read (type => @args, $cb)
474		874
475	=item $handle->unshift_read_chunk ($len, $cb->($self, $data))	875	=item $handle->unshift_read (type => @args, $cb)
476		876
477	Append the given callback to the end of the queue (C<push_read_chunk>) or	877	Instead of providing a callback that parses the data itself you can chose
478	prepend it (C<unshift_read_chunk>).	878	between a number of predefined parsing formats, for chunks of data, lines
		879	etc.
479		880
480	The callback will be called only once C<$len> bytes have been read, and	881	Predefined types are (if you have ideas for additional types, feel free to
481	these C<$len> bytes will be passed to the callback.	882	drop by and tell us):
482		883
483	=cut	884	=over 4
484		885
485	sub _read_chunk($$) {	886	=item chunk => $octets, $cb->($handle, $data)
		887
		888	Invoke the callback only once C<$octets> bytes have been read. Pass the
		889	data read to the callback. The callback will never be called with less
		890	data.
		891
		892	Example: read 2 bytes.
		893
		894	$handle->push_read (chunk => 2, sub {
		895	warn "yay ", unpack "H*", $_[1];
		896	});
		897
		898	=cut
		899
		900	register_read_type chunk => sub {
486	my ($self, $len, $cb) = @_;	901	my ($self, $cb, $len) = @_;
487		902
488	sub {	903	sub {
489	$len <= length $_[0]{rbuf} or return;	904	$len <= length $_[0]{rbuf} or return;
490	$cb->($self, $_[0], substr $_[0]{rbuf}, 0, $len, "");	905	$cb->($_[0], substr $_[0]{rbuf}, 0, $len, "");
491	1	906	1
492	}	907	}
493	}	908	};
494		909
		910	# compatibility with older API
495	sub push_read_chunk {	911	sub push_read_chunk {
496	$_[0]->push_read (&_read_chunk);	912	$_[0]->push_read (chunk => $_[1], $_[2]);
497	}	913	}
498
499		914
500	sub unshift_read_chunk {	915	sub unshift_read_chunk {
501	$_[0]->unshift_read (&_read_chunk);	916	$_[0]->unshift_read (chunk => $_[1], $_[2]);
502	}	917	}
503		918
504	=item $handle->push_read_line ([$eol, ]$cb->($self, $line, $eol))	919	=item line => [$eol, ]$cb->($handle, $line, $eol)
505
506	=item $handle->unshift_read_line ([$eol, ]$cb->($self, $line, $eol))
507
508	Append the given callback to the end of the queue (C<push_read_line>) or
509	prepend it (C<unshift_read_line>).
510		920
511	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
512	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
513	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
514	the end of line marker as the third argument (C<$eol>).	924	the end of line marker as the third argument (C<$eol>).
…		…
525	Partial lines at the end of the stream will never be returned, as they are	935	Partial lines at the end of the stream will never be returned, as they are
526	not marked by the end of line marker.	936	not marked by the end of line marker.
527		937
528	=cut	938	=cut
529		939
530	sub _read_line($$) {	940	register_read_type line => sub {
531	my $self = shift;	941	my ($self, $cb, $eol) = @_;
532	my $cb = pop;
533	my $eol = @_ ? shift : qr|(\015?\012)|;
534	my $pos;
535		942
		943	$eol = qr|(\015?\012)| if @_ < 3;
536	$eol = qr|(\Q$eol\E)| unless ref $eol;	944	$eol = quotemeta $eol unless ref $eol;
537	$eol = qr|^(.*?)($eol)|;	945	$eol = qr|^(.*?)($eol)|s;
538		946
539	sub {	947	sub {
540	$_[0]{rbuf} =~ s/$eol// or return;	948	$_[0]{rbuf} =~ s/$eol// or return;
541		949
542	$cb->($self, $1, $2);	950	$cb->($_[0], $1, $2);
543	1	951	1
544	}	952	}
545	}	953	};
546		954
		955	# compatibility with older API
547	sub push_read_line {	956	sub push_read_line {
548	$_[0]->push_read (&_read_line);	957	my $self = shift;
		958	$self->push_read (line => @_);
549	}	959	}
550		960
551	sub unshift_read_line {	961	sub unshift_read_line {
552	$_[0]->unshift_read (&_read_line);	962	my $self = shift;
		963	$self->unshift_read (line => @_);
553	}	964	}
		965
		966	=item regex => $accept[, $reject[, $skip], $cb->($handle, $data)
		967
		968	Makes a regex match against the regex object C<$accept> and returns
		969	everything up to and including the match.
		970
		971	Example: read a single line terminated by '\n'.
		972
		973	$handle->push_read (regex => qr<\n>, sub { ... });
		974
		975	If C<$reject> is given and not undef, then it determines when the data is
		976	to be rejected: it is matched against the data when the C<$accept> regex
		977	does not match and generates an C<EBADMSG> error when it matches. This is
		978	useful to quickly reject wrong data (to avoid waiting for a timeout or a
		979	receive buffer overflow).
		980
		981	Example: expect a single decimal number followed by whitespace, reject
		982	anything else (not the use of an anchor).
		983
		984	$handle->push_read (regex => qr<^[0-9]+\s>, qr<[^0-9]>, sub { ... });
		985
		986	If C<$skip> is given and not C<undef>, then it will be matched against
		987	the receive buffer when neither C<$accept> nor C<$reject> match,
		988	and everything preceding and including the match will be accepted
		989	unconditionally. This is useful to skip large amounts of data that you
		990	know cannot be matched, so that the C<$accept> or C<$reject> regex do not
		991	have to start matching from the beginning. This is purely an optimisation
		992	and is usually worth only when you expect more than a few kilobytes.
		993
		994	Example: expect a http header, which ends at C<\015\012\015\012>. Since we
		995	expect the header to be very large (it isn't in practise, but...), we use
		996	a skip regex to skip initial portions. The skip regex is tricky in that
		997	it only accepts something not ending in either \015 or \012, as these are
		998	required for the accept regex.
		999
		1000	$handle->push_read (regex =>
		1001	qr<\015\012\015\012>,
		1002	undef, # no reject
		1003	qr<^.*[^\015\012]>,
		1004	sub { ... });
		1005
		1006	=cut
		1007
		1008	register_read_type regex => sub {
		1009	my ($self, $cb, $accept, $reject, $skip) = @_;
		1010
		1011	my $data;
		1012	my $rbuf = \$self->{rbuf};
		1013
		1014	sub {
		1015	# accept
		1016	if ($$rbuf =~ $accept) {
		1017	$data .= substr $$rbuf, 0, $+[0], "";
		1018	$cb->($self, $data);
		1019	return 1;
		1020	}
		1021
		1022	# reject
		1023	if ($reject && $$rbuf =~ $reject) {
		1024	$self->_error (&Errno::EBADMSG);
		1025	}
		1026
		1027	# skip
		1028	if ($skip && $$rbuf =~ $skip) {
		1029	$data .= substr $$rbuf, 0, $+[0], "";
		1030	}
		1031
		1032	()
		1033	}
		1034	};
		1035
		1036	=item netstring => $cb->($handle, $string)
		1037
		1038	A netstring (http://cr.yp.to/proto/netstrings.txt, this is not an endorsement).
		1039
		1040	Throws an error with C<$!> set to EBADMSG on format violations.
		1041
		1042	=cut
		1043
		1044	register_read_type netstring => sub {
		1045	my ($self, $cb) = @_;
		1046
		1047	sub {
		1048	unless ($_[0]{rbuf} =~ s/^(0|[1-9][0-9]*)://) {
		1049	if ($_[0]{rbuf} =~ /[^0-9]/) {
		1050	$self->_error (&Errno::EBADMSG);
		1051	}
		1052	return;
		1053	}
		1054
		1055	my $len = $1;
		1056
		1057	$self->unshift_read (chunk => $len, sub {
		1058	my $string = $_[1];
		1059	$_[0]->unshift_read (chunk => 1, sub {
		1060	if ($_[1] eq ",") {
		1061	$cb->($_[0], $string);
		1062	} else {
		1063	$self->_error (&Errno::EBADMSG);
		1064	}
		1065	});
		1066	});
		1067
		1068	1
		1069	}
		1070	};
		1071
		1072	=item packstring => $format, $cb->($handle, $string)
		1073
		1074	An octet string prefixed with an encoded length. The encoding C<$format>
		1075	uses the same format as a Perl C<pack> format, but must specify a single
		1076	integer only (only one of C<cCsSlLqQiInNvVjJw> is allowed, plus an
		1077	optional C<!>, C<< < >> or C<< > >> modifier).
		1078
		1079	DNS over TCP uses a prefix of C<n>, EPP uses a prefix of C<N>.
		1080
		1081	Example: read a block of data prefixed by its length in BER-encoded
		1082	format (very efficient).
		1083
		1084	$handle->push_read (packstring => "w", sub {
		1085	my ($handle, $data) = @_;
		1086	});
		1087
		1088	=cut
		1089
		1090	register_read_type packstring => sub {
		1091	my ($self, $cb, $format) = @_;
		1092
		1093	sub {
		1094	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
		1095	defined (my $len = eval { unpack $format, $_[0]->{rbuf} })
		1096	or return;
		1097
		1098	# remove prefix
		1099	substr $_[0]->{rbuf}, 0, (length pack $format, $len), "";
		1100
		1101	# read rest
		1102	$_[0]->unshift_read (chunk => $len, $cb);
		1103
		1104	1
		1105	}
		1106	};
		1107
		1108	=item json => $cb->($handle, $hash_or_arrayref)
		1109
		1110	Reads a JSON object or array, decodes it and passes it to the callback.
		1111
		1112	If a C<json> object was passed to the constructor, then that will be used
		1113	for the final decode, otherwise it will create a JSON coder expecting UTF-8.
		1114
		1115	This read type uses the incremental parser available with JSON version
		1116	2.09 (and JSON::XS version 2.2) and above. You have to provide a
		1117	dependency on your own: this module will load the JSON module, but
		1118	AnyEvent does not depend on it itself.
		1119
		1120	Since JSON texts are fully self-delimiting, the C<json> read and write
		1121	types are an ideal simple RPC protocol: just exchange JSON datagrams. See
		1122	the C<json> write type description, above, for an actual example.
		1123
		1124	=cut
		1125
		1126	register_read_type json => sub {
		1127	my ($self, $cb) = @_;
		1128
		1129	require JSON;
		1130
		1131	my $data;
		1132	my $rbuf = \$self->{rbuf};
		1133
		1134	my $json = $self->{json} ||= JSON->new->utf8;
		1135
		1136	sub {
		1137	my $ref = $json->incr_parse ($self->{rbuf});
		1138
		1139	if ($ref) {
		1140	$self->{rbuf} = $json->incr_text;
		1141	$json->incr_text = "";
		1142	$cb->($self, $ref);
		1143
		1144	1
		1145	} else {
		1146	$self->{rbuf} = "";
		1147	()
		1148	}
		1149	}
		1150	};
		1151
		1152	=item storable => $cb->($handle, $ref)
		1153
		1154	Deserialises a L<Storable> frozen representation as written by the
		1155	C<storable> write type (BER-encoded length prefix followed by nfreeze'd
		1156	data).
		1157
		1158	Raises C<EBADMSG> error if the data could not be decoded.
		1159
		1160	=cut
		1161
		1162	register_read_type storable => sub {
		1163	my ($self, $cb) = @_;
		1164
		1165	require Storable;
		1166
		1167	sub {
		1168	# when we can use 5.10 we can use ".", but for 5.8 we use the re-pack method
		1169	defined (my $len = eval { unpack "w", $_[0]->{rbuf} })
		1170	or return;
		1171
		1172	# remove prefix
		1173	substr $_[0]->{rbuf}, 0, (length pack "w", $len), "";
		1174
		1175	# read rest
		1176	$_[0]->unshift_read (chunk => $len, sub {
		1177	if (my $ref = eval { Storable::thaw ($_[1]) }) {
		1178	$cb->($_[0], $ref);
		1179	} else {
		1180	$self->_error (&Errno::EBADMSG);
		1181	}
		1182	});
		1183	}
		1184	};
		1185
		1186	=back
		1187
		1188	=item AnyEvent::Handle::register_read_type type => $coderef->($handle, $cb, @args)
		1189
		1190	This function (not method) lets you add your own types to C<push_read>.
		1191
		1192	Whenever the given C<type> is used, C<push_read> will invoke the code
		1193	reference with the handle object, the callback and the remaining
		1194	arguments.
		1195
		1196	The code reference is supposed to return a callback (usually a closure)
		1197	that works as a plain read callback (see C<< ->push_read ($cb) >>).
		1198
		1199	It should invoke the passed callback when it is done reading (remember to
		1200	pass C<$handle> as first argument as all other callbacks do that).
		1201
		1202	Note that this is a function, and all types registered this way will be
		1203	global, so try to use unique names.
		1204
		1205	For examples, see the source of this module (F<perldoc -m AnyEvent::Handle>,
		1206	search for C<register_read_type>)).
554		1207
555	=item $handle->stop_read	1208	=item $handle->stop_read
556		1209
557	=item $handle->start_read	1210	=item $handle->start_read
558		1211
559	In rare cases you actually do not want to read anything form the	1212	In rare cases you actually do not want to read anything from the
560	socket. In this case you can call C<stop_read>. Neither C<on_read> no	1213	socket. In this case you can call C<stop_read>. Neither C<on_read> nor
561	any queued callbacks will be executed then. To start readign again, call	1214	any queued callbacks will be executed then. To start reading again, call
562	C<start_read>.	1215	C<start_read>.
		1216
		1217	Note that AnyEvent::Handle will automatically C<start_read> for you when
		1218	you change the C<on_read> callback or push/unshift a read callback, and it
		1219	will automatically C<stop_read> for you when neither C<on_read> is set nor
		1220	there are any read requests in the queue.
563		1221
564	=cut	1222	=cut
565		1223
566	sub stop_read {	1224	sub stop_read {
567	my ($self) = @_;	1225	my ($self) = @_;
568		1226
569	delete $self->{rw};	1227	delete $self->{_rw};
570	}	1228	}
571		1229
572	sub start_read {	1230	sub start_read {
573	my ($self) = @_;	1231	my ($self) = @_;
574		1232
575	unless ($self->{rw} || $self->{eof}) {	1233	unless ($self->{_rw} || $self->{_eof}) {
576	Scalar::Util::weaken $self;	1234	Scalar::Util::weaken $self;
577		1235
578	$self->{rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {	1236	$self->{_rw} = AnyEvent->io (fh => $self->{fh}, poll => "r", cb => sub {
		1237	my $rbuf = $self->{filter_r} ? \my $buf : \$self->{rbuf};
579	my $len = sysread $self->{fh}, $self->{rbuf}, $self->{read_size} || 8192, length $self->{rbuf};	1238	my $len = sysread $self->{fh}, $$rbuf, $self->{read_size} || 8192, length $$rbuf;
580		1239
581	if ($len > 0) {	1240	if ($len > 0) {
582	if (defined $self->{rbuf_max}) {	1241	$self->{_activity} = AnyEvent->now;
583	if ($self->{rbuf_max} < length $self->{rbuf}) {	1242
584	$! = &Errno::ENOSPC; return $self->error;	1243	$self->{filter_r}
585	}	1244	? $self->{filter_r}($self, $rbuf)
586	}	1245	: $self->{_in_drain} || $self->_drain_rbuf;
587		1246
588	} elsif (defined $len) {	1247	} elsif (defined $len) {
589	$self->{eof} = 1;
590	delete $self->{rw};	1248	delete $self->{_rw};
		1249	$self->{_eof} = 1;
		1250	$self->_drain_rbuf unless $self->{_in_drain};
591		1251
592	} elsif ($! != EAGAIN && $! != EINTR) {	1252	} elsif ($! != EAGAIN && $! != EINTR && $! != WSAEWOULDBLOCK) {
593	return $self->error;	1253	return $self->_error ($!, 1);
594	}	1254	}
595
596	$self->_drain_rbuf;
597	});	1255	});
598	}	1256	}
599	}	1257	}
600		1258
		1259	sub _dotls {
		1260	my ($self) = @_;
		1261
		1262	my $buf;
		1263
		1264	if (length $self->{_tls_wbuf}) {
		1265	while ((my $len = Net::SSLeay::write ($self->{tls}, $self->{_tls_wbuf})) > 0) {
		1266	substr $self->{_tls_wbuf}, 0, $len, "";
		1267	}
		1268	}
		1269
		1270	if (length ($buf = Net::SSLeay::BIO_read ($self->{_wbio}))) {
		1271	$self->{wbuf} .= $buf;
		1272	$self->_drain_wbuf;
		1273	}
		1274
		1275	while (defined ($buf = Net::SSLeay::read ($self->{tls}))) {
		1276	if (length $buf) {
		1277	$self->{rbuf} .= $buf;
		1278	$self->_drain_rbuf unless $self->{_in_drain};
		1279	} else {
		1280	# let's treat SSL-eof as we treat normal EOF
		1281	$self->{_eof} = 1;
		1282	$self->_shutdown;
		1283	return;
		1284	}
		1285	}
		1286
		1287	my $err = Net::SSLeay::get_error ($self->{tls}, -1);
		1288
		1289	if ($err!= Net::SSLeay::ERROR_WANT_READ ()) {
		1290	if ($err == Net::SSLeay::ERROR_SYSCALL ()) {
		1291	return $self->_error ($!, 1);
		1292	} elsif ($err == Net::SSLeay::ERROR_SSL ()) {
		1293	return $self->_error (&Errno::EIO, 1);
		1294	}
		1295
		1296	# all others are fine for our purposes
		1297	}
		1298	}
		1299
		1300	=item $handle->starttls ($tls[, $tls_ctx])
		1301
		1302	Instead of starting TLS negotiation immediately when the AnyEvent::Handle
		1303	object is created, you can also do that at a later time by calling
		1304	C<starttls>.
		1305
		1306	The first argument is the same as the C<tls> constructor argument (either
		1307	C<"connect">, C<"accept"> or an existing Net::SSLeay object).
		1308
		1309	The second argument is the optional C<Net::SSLeay::CTX> object that is
		1310	used when AnyEvent::Handle has to create its own TLS connection object.
		1311
		1312	The TLS connection object will end up in C<< $handle->{tls} >> after this
		1313	call and can be used or changed to your liking. Note that the handshake
		1314	might have already started when this function returns.
		1315
		1316	=cut
		1317
		1318	sub starttls {
		1319	my ($self, $ssl, $ctx) = @_;
		1320
		1321	$self->stoptls;
		1322
		1323	if ($ssl eq "accept") {
		1324	$ssl = Net::SSLeay::new ($ctx || TLS_CTX ());
		1325	Net::SSLeay::set_accept_state ($ssl);
		1326	} elsif ($ssl eq "connect") {
		1327	$ssl = Net::SSLeay::new ($ctx || TLS_CTX ());
		1328	Net::SSLeay::set_connect_state ($ssl);
		1329	}
		1330
		1331	$self->{tls} = $ssl;
		1332
		1333	# basically, this is deep magic (because SSL_read should have the same issues)
		1334	# but the openssl maintainers basically said: "trust us, it just works".
		1335	# (unfortunately, we have to hardcode constants because the abysmally misdesigned
		1336	# and mismaintained ssleay-module doesn't even offer them).
		1337	# http://www.mail-archive.com/openssl-dev@openssl.org/msg22420.html
		1338	Net::SSLeay::CTX_set_mode ($self->{tls},
		1339	(eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ENABLE_PARTIAL_WRITE () } || 1)
		1340	| (eval { local $SIG{__DIE__}; Net::SSLeay::MODE_ACCEPT_MOVING_WRITE_BUFFER () } || 2));
		1341
		1342	$self->{_rbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
		1343	$self->{_wbio} = Net::SSLeay::BIO_new (Net::SSLeay::BIO_s_mem ());
		1344
		1345	Net::SSLeay::set_bio ($ssl, $self->{_rbio}, $self->{_wbio});
		1346
		1347	$self->{filter_w} = sub {
		1348	$_[0]{_tls_wbuf} .= ${$_[1]};
		1349	&_dotls;
		1350	};
		1351	$self->{filter_r} = sub {
		1352	Net::SSLeay::BIO_write ($_[0]{_rbio}, ${$_[1]});
		1353	&_dotls;
		1354	};
		1355	}
		1356
		1357	=item $handle->stoptls
		1358
		1359	Destroys the SSL connection, if any. Partial read or write data will be
		1360	lost.
		1361
		1362	=cut
		1363
		1364	sub stoptls {
		1365	my ($self) = @_;
		1366
		1367	Net::SSLeay::free (delete $self->{tls}) if $self->{tls};
		1368
		1369	delete $self->{_rbio};
		1370	delete $self->{_wbio};
		1371	delete $self->{_tls_wbuf};
		1372	delete $self->{filter_r};
		1373	delete $self->{filter_w};
		1374	}
		1375
		1376	sub DESTROY {
		1377	my $self = shift;
		1378
		1379	$self->stoptls;
		1380
		1381	my $linger = exists $self->{linger} ? $self->{linger} : 3600;
		1382
		1383	if ($linger && length $self->{wbuf}) {
		1384	my $fh = delete $self->{fh};
		1385	my $wbuf = delete $self->{wbuf};
		1386
		1387	my @linger;
		1388
		1389	push @linger, AnyEvent->io (fh => $fh, poll => "w", cb => sub {
		1390	my $len = syswrite $fh, $wbuf, length $wbuf;
		1391
		1392	if ($len > 0) {
		1393	substr $wbuf, 0, $len, "";
		1394	} else {
		1395	@linger = (); # end
		1396	}
		1397	});
		1398	push @linger, AnyEvent->timer (after => $linger, cb => sub {
		1399	@linger = ();
		1400	});
		1401	}
		1402	}
		1403
		1404	=item AnyEvent::Handle::TLS_CTX
		1405
		1406	This function creates and returns the Net::SSLeay::CTX object used by
		1407	default for TLS mode.
		1408
		1409	The context is created like this:
		1410
		1411	Net::SSLeay::load_error_strings;
		1412	Net::SSLeay::SSLeay_add_ssl_algorithms;
		1413	Net::SSLeay::randomize;
		1414
		1415	my $CTX = Net::SSLeay::CTX_new;
		1416
		1417	Net::SSLeay::CTX_set_options $CTX, Net::SSLeay::OP_ALL
		1418
		1419	=cut
		1420
		1421	our $TLS_CTX;
		1422
		1423	sub TLS_CTX() {
		1424	$TLS_CTX || do {
		1425	require Net::SSLeay;
		1426
		1427	Net::SSLeay::load_error_strings ();
		1428	Net::SSLeay::SSLeay_add_ssl_algorithms ();
		1429	Net::SSLeay::randomize ();
		1430
		1431	$TLS_CTX = Net::SSLeay::CTX_new ();
		1432
		1433	Net::SSLeay::CTX_set_options ($TLS_CTX, Net::SSLeay::OP_ALL ());
		1434
		1435	$TLS_CTX
		1436	}
		1437	}
		1438
601	=back	1439	=back
602		1440
		1441	=head1 SUBCLASSING AnyEvent::Handle
		1442
		1443	In many cases, you might want to subclass AnyEvent::Handle.
		1444
		1445	To make this easier, a given version of AnyEvent::Handle uses these
		1446	conventions:
		1447
		1448	=over 4
		1449
		1450	=item * all constructor arguments become object members.
		1451
		1452	At least initially, when you pass a C<tls>-argument to the constructor it
		1453	will end up in C<< $handle->{tls} >>. Those members might be changes or
		1454	mutated later on (for example C<tls> will hold the TLS connection object).
		1455
		1456	=item * other object member names are prefixed with an C<_>.
		1457
		1458	All object members not explicitly documented (internal use) are prefixed
		1459	with an underscore character, so the remaining non-C<_>-namespace is free
		1460	for use for subclasses.
		1461
		1462	=item * all members not documented here and not prefixed with an underscore
		1463	are free to use in subclasses.
		1464
		1465	Of course, new versions of AnyEvent::Handle may introduce more "public"
		1466	member variables, but thats just life, at least it is documented.
		1467
		1468	=back
		1469
603	=head1 AUTHOR	1470	=head1 AUTHOR
604		1471
605	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.	1472	Robin Redeker C<< <elmex at ta-sa.org> >>, Marc Lehmann <schmorp@schmorp.de>.
606		1473
607	=cut	1474	=cut

Diff Legend

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